8908dc069a8363e6e1b86c2946cc986a0dd604da
[openvswitch] / ofproto-provider.h
1 /*
2  * Copyright (c) 2009, 2010, 2011 Nicira Networks.
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 "list.h"
26 #include "shash.h"
27 #include "timeval.h"
28
29 struct ofputil_flow_mod;
30
31 /* An OpenFlow switch.
32  *
33  * With few exceptions, ofproto implementations may look at these fields but
34  * should not modify them. */
35 struct ofproto {
36     const struct ofproto_class *ofproto_class;
37     char *type;                 /* Datapath type. */
38     char *name;                 /* Datapath name. */
39     struct hmap_node hmap_node; /* In global 'all_ofprotos' hmap. */
40
41     /* Settings. */
42     uint64_t fallback_dpid;     /* Datapath ID if no better choice found. */
43     uint64_t datapath_id;       /* Datapath ID. */
44     unsigned flow_eviction_threshold; /* Threshold at which to begin flow
45                                        * table eviction. Only affects the
46                                        * ofproto-dpif implementation */
47     bool forward_bpdu;          /* Option to allow forwarding of BPDU frames
48                                  * when NORMAL action is invoked. */
49     char *mfr_desc;             /* Manufacturer. */
50     char *hw_desc;              /* Hardware. */
51     char *sw_desc;              /* Software version. */
52     char *serial_desc;          /* Serial number. */
53     char *dp_desc;              /* Datapath description. */
54     enum ofp_config_flags frag_handling; /* One of OFPC_*.  */
55
56     /* Datapath. */
57     struct hmap ports;          /* Contains "struct ofport"s. */
58     struct shash port_by_name;
59
60     /* Flow tables. */
61     struct classifier *tables;  /* Each classifier contains "struct rule"s. */
62     int n_tables;
63
64     /* OpenFlow connections. */
65     struct connmgr *connmgr;
66
67     /* Flow table operation tracking. */
68     int state;                  /* Internal state. */
69     struct list pending;        /* List of "struct ofopgroup"s. */
70     unsigned int n_pending;     /* list_size(&pending). */
71     struct hmap deletions;      /* All OFOPERATION_DELETE "ofoperation"s. */
72 };
73
74 struct ofproto *ofproto_lookup(const char *name);
75 struct ofport *ofproto_get_port(const struct ofproto *, uint16_t ofp_port);
76
77 /* Assigns CLS to each classifier table, in turn, in OFPROTO.
78  *
79  * All parameters are evaluated multiple times. */
80 #define OFPROTO_FOR_EACH_TABLE(CLS, OFPROTO)                \
81     for ((CLS) = (OFPROTO)->tables;                         \
82          (CLS) < &(OFPROTO)->tables[(OFPROTO)->n_tables];   \
83          (CLS)++)
84
85 /* An OpenFlow port within a "struct ofproto".
86  *
87  * With few exceptions, ofproto implementations may look at these fields but
88  * should not modify them. */
89 struct ofport {
90     struct ofproto *ofproto;    /* The ofproto that contains this port. */
91     struct hmap_node hmap_node; /* In struct ofproto's "ports" hmap. */
92     struct netdev *netdev;
93     struct ofp_phy_port opp;
94     uint16_t ofp_port;          /* OpenFlow port number. */
95     unsigned int change_seq;
96     int mtu;
97 };
98
99 void ofproto_port_set_state(struct ofport *, ovs_be32 state);
100
101 /* An OpenFlow flow within a "struct ofproto".
102  *
103  * With few exceptions, ofproto implementations may look at these fields but
104  * should not modify them. */
105 struct rule {
106     struct ofproto *ofproto;     /* The ofproto that contains this rule. */
107     struct list ofproto_node;    /* Owned by ofproto base code. */
108     struct cls_rule cr;          /* In owning ofproto's classifier. */
109
110     struct ofoperation *pending; /* Operation now in progress, if nonnull. */
111
112     ovs_be64 flow_cookie;        /* Controller-issued identifier. */
113
114     long long int created;       /* Creation time. */
115     long long int modified;      /* Time of last modification. */
116     uint16_t idle_timeout;       /* In seconds from time of last use. */
117     uint16_t hard_timeout;       /* In seconds from last modification. */
118     uint8_t table_id;            /* Index in ofproto's 'tables' array. */
119     bool send_flow_removed;      /* Send a flow removed message? */
120
121     union ofp_action *actions;   /* OpenFlow actions. */
122     int n_actions;               /* Number of elements in actions[]. */
123 };
124
125 static inline struct rule *
126 rule_from_cls_rule(const struct cls_rule *cls_rule)
127 {
128     return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
129 }
130
131 void ofproto_rule_expire(struct rule *, uint8_t reason);
132 void ofproto_rule_destroy(struct rule *);
133
134 void ofoperation_complete(struct ofoperation *, int status);
135 struct rule *ofoperation_get_victim(struct ofoperation *);
136
137 /* ofproto class structure, to be defined by each ofproto implementation.
138  *
139  *
140  * Data Structures
141  * ===============
142  *
143  * These functions work primarily with three different kinds of data
144  * structures:
145  *
146  *   - "struct ofproto", which represents an OpenFlow switch.
147  *
148  *   - "struct ofport", which represents a port within an ofproto.
149  *
150  *   - "struct rule", which represents an OpenFlow flow within an ofproto.
151  *
152  * Each of these data structures contains all of the implementation-independent
153  * generic state for the respective concept, called the "base" state.  None of
154  * them contains any extra space for ofproto implementations to use.  Instead,
155  * each implementation is expected to declare its own data structure that
156  * contains an instance of the generic data structure plus additional
157  * implementation-specific members, called the "derived" state.  The
158  * implementation can use casts or (preferably) the CONTAINER_OF macro to
159  * obtain access to derived state given only a pointer to the embedded generic
160  * data structure.
161  *
162  *
163  * Life Cycle
164  * ==========
165  *
166  * Four stylized functions accompany each of these data structures:
167  *
168  *            "alloc"       "construct"       "destruct"       "dealloc"
169  *            ------------  ----------------  ---------------  --------------
170  *   ofproto  ->alloc       ->construct       ->destruct       ->dealloc
171  *   ofport   ->port_alloc  ->port_construct  ->port_destruct  ->port_dealloc
172  *   rule     ->rule_alloc  ->rule_construct  ->rule_destruct  ->rule_dealloc
173  *
174  * Any instance of a given data structure goes through the following life
175  * cycle:
176  *
177  *   1. The client calls the "alloc" function to obtain raw memory.  If "alloc"
178  *      fails, skip all the other steps.
179  *
180  *   2. The client initializes all of the data structure's base state.  If this
181  *      fails, skip to step 7.
182  *
183  *   3. The client calls the "construct" function.  The implementation
184  *      initializes derived state.  It may refer to the already-initialized
185  *      base state.  If "construct" fails, skip to step 6.
186  *
187  *   4. The data structure is now initialized and in use.
188  *
189  *   5. When the data structure is no longer needed, the client calls the
190  *      "destruct" function.  The implementation uninitializes derived state.
191  *      The base state has not been uninitialized yet, so the implementation
192  *      may still refer to it.
193  *
194  *   6. The client uninitializes all of the data structure's base state.
195  *
196  *   7. The client calls the "dealloc" to free the raw memory.  The
197  *      implementation must not refer to base or derived state in the data
198  *      structure, because it has already been uninitialized.
199  *
200  * Each "alloc" function allocates and returns a new instance of the respective
201  * data structure.  The "alloc" function is not given any information about the
202  * use of the new data structure, so it cannot perform much initialization.
203  * Its purpose is just to ensure that the new data structure has enough room
204  * for base and derived state.  It may return a null pointer if memory is not
205  * available, in which case none of the other functions is called.
206  *
207  * Each "construct" function initializes derived state in its respective data
208  * structure.  When "construct" is called, all of the base state has already
209  * been initialized, so the "construct" function may refer to it.  The
210  * "construct" function is allowed to fail, in which case the client calls the
211  * "dealloc" function (but not the "destruct" function).
212  *
213  * Each "destruct" function uninitializes and frees derived state in its
214  * respective data structure.  When "destruct" is called, the base state has
215  * not yet been uninitialized, so the "destruct" function may refer to it.  The
216  * "destruct" function is not allowed to fail.
217  *
218  * Each "dealloc" function frees raw memory that was allocated by the the
219  * "alloc" function.  The memory's base and derived members might not have ever
220  * been initialized (but if "construct" returned successfully, then it has been
221  * "destruct"ed already).  The "dealloc" function is not allowed to fail.
222  *
223  *
224  * Conventions
225  * ===========
226  *
227  * Most of these functions return 0 if they are successful or a positive error
228  * code on failure.  Depending on the function, valid error codes are either
229  * errno values or OpenFlow error codes constructed with ofp_mkerr().
230  *
231  * Most of these functions are expected to execute synchronously, that is, to
232  * block as necessary to obtain a result.  Thus, these functions may return
233  * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
234  * explicitly say those errors are a possibility.  We may relax this
235  * requirement in the future if and when we encounter performance problems. */
236 struct ofproto_class {
237 /* ## ----------------- ## */
238 /* ## Factory Functions ## */
239 /* ## ----------------- ## */
240
241     /* Enumerates the types of all support ofproto types into 'types'.  The
242      * caller has already initialized 'types' and other ofproto classes might
243      * already have added names to it. */
244     void (*enumerate_types)(struct sset *types);
245
246     /* Enumerates the names of all existing datapath of the specified 'type'
247      * into 'names' 'all_dps'.  The caller has already initialized 'names' as
248      * an empty sset.
249      *
250      * 'type' is one of the types enumerated by ->enumerate_types().
251      *
252      * Returns 0 if successful, otherwise a positive errno value.
253      */
254     int (*enumerate_names)(const char *type, struct sset *names);
255
256     /* Deletes the datapath with the specified 'type' and 'name'.  The caller
257      * should have closed any open ofproto with this 'type' and 'name'; this
258      * function is allowed to fail if that is not the case.
259      *
260      * 'type' is one of the types enumerated by ->enumerate_types().
261      * 'name' is one of the names enumerated by ->enumerate_names() for 'type'.
262      *
263      * Returns 0 if successful, otherwise a positive errno value.
264      */
265     int (*del)(const char *type, const char *name);
266
267 /* ## --------------------------- ## */
268 /* ## Top-Level ofproto Functions ## */
269 /* ## --------------------------- ## */
270
271     /* Life-cycle functions for an "ofproto" (see "Life Cycle" above).
272      *
273      *
274      * Construction
275      * ============
276      *
277      * ->construct() should not modify any base members of the ofproto.  The
278      * client will initialize the ofproto's 'ports' and 'tables' members after
279      * construction is complete.
280      *
281      * When ->construct() is called, the client does not yet know how many flow
282      * tables the datapath supports, so ofproto->n_tables will be 0 and
283      * ofproto->tables will be NULL.  ->construct() should store the number of
284      * flow tables supported by the datapath (between 1 and 255, inclusive)
285      * into '*n_tables'.  After a successful return, the client will initialize
286      * the base 'n_tables' member to '*n_tables' and allocate and initialize
287      * the base 'tables' member as the specified number of empty flow tables.
288      * Each flow table will be initially empty, so ->construct() should delete
289      * flows from the underlying datapath, if necessary, rather than populating
290      * the tables.
291      *
292      * Only one ofproto instance needs to be supported for any given datapath.
293      * If a datapath is already open as part of one "ofproto", then another
294      * attempt to "construct" the same datapath as part of another ofproto is
295      * allowed to fail with an error.
296      *
297      * ->construct() returns 0 if successful, otherwise a positive errno
298      * value.
299      *
300      *
301      * Destruction
302      * ===========
303      *
304      * If 'ofproto' has any pending asynchronous operations, ->destruct()
305      * must complete all of them by calling ofoperation_complete().
306      *
307      * ->destruct() must also destroy all remaining rules in the ofproto's
308      * tables, by passing each remaining rule to ofproto_rule_destroy().  The
309      * client will destroy the flow tables themselves after ->destruct()
310      * returns.
311      */
312     struct ofproto *(*alloc)(void);
313     int (*construct)(struct ofproto *ofproto, int *n_tables);
314     void (*destruct)(struct ofproto *ofproto);
315     void (*dealloc)(struct ofproto *ofproto);
316
317     /* Performs any periodic activity required by 'ofproto'.  It should:
318      *
319      *   - Call connmgr_send_packet_in() for each received packet that missed
320      *     in the OpenFlow flow table or that had a OFPP_CONTROLLER output
321      *     action.
322      *
323      *   - Call ofproto_rule_expire() for each OpenFlow flow that has reached
324      *     its hard_timeout or idle_timeout, to expire the flow.
325      *
326      * Returns 0 if successful, otherwise a positive errno value.  The ENODEV
327      * return value specifically means that the datapath underlying 'ofproto'
328      * has been destroyed (externally, e.g. by an admin running ovs-dpctl).
329      */
330     int (*run)(struct ofproto *ofproto);
331
332     /* Causes the poll loop to wake up when 'ofproto''s 'run' function needs to
333      * be called, e.g. by calling the timer or fd waiting functions in
334      * poll-loop.h.  */
335     void (*wait)(struct ofproto *ofproto);
336
337     /* Every "struct rule" in 'ofproto' is about to be deleted, one by one.
338      * This function may prepare for that, for example by clearing state in
339      * advance.  It should *not* actually delete any "struct rule"s from
340      * 'ofproto', only prepare for it.
341      *
342      * This function is optional; it's really just for optimization in case
343      * it's cheaper to delete all the flows from your hardware in a single pass
344      * than to do it one by one. */
345     void (*flush)(struct ofproto *ofproto);
346
347     /* Helper for the OpenFlow OFPT_FEATURES_REQUEST request.
348      *
349      * The implementation should store true in '*arp_match_ip' if the switch
350      * supports matching IP addresses inside ARP requests and replies, false
351      * otherwise.
352      *
353      * The implementation should store in '*actions' a bitmap of the supported
354      * OpenFlow actions: the bit with value (1 << n) should be set to 1 if the
355      * implementation supports the action with value 'n', and to 0 otherwise.
356      * For example, if the implementation supports the OFPAT_OUTPUT and
357      * OFPAT_ENQUEUE actions, but no others, it would set '*actions' to (1 <<
358      * OFPAT_OUTPUT) | (1 << OFPAT_ENQUEUE).  Vendor actions are not included
359      * in '*actions'. */
360     void (*get_features)(struct ofproto *ofproto,
361                          bool *arp_match_ip, uint32_t *actions);
362
363     /* Helper for the OpenFlow OFPST_TABLE statistics request.
364      *
365      * The 'ots' array contains 'ofproto->n_tables' elements.  Each element is
366      * initialized as:
367      *
368      *   - 'table_id' to the array index.
369      *
370      *   - 'name' to "table#" where # is the table ID.
371      *
372      *   - 'wildcards' to OFPFW_ALL.
373      *
374      *   - 'max_entries' to 1,000,000.
375      *
376      *   - 'active_count' to the classifier_count() for the table.
377      *
378      *   - 'lookup_count' and 'matched_count' to 0.
379      *
380      * The implementation should update any members in each element for which
381      * it has better values:
382      *
383      *   - 'name' to a more meaningful name.
384      *
385      *   - 'wildcards' to the set of wildcards actually supported by the table
386      *     (if it doesn't support all OpenFlow wildcards).
387      *
388      *   - 'max_entries' to the maximum number of flows actually supported by
389      *     the hardware.
390      *
391      *   - 'lookup_count' to the number of packets looked up in this flow table
392      *     so far.
393      *
394      *   - 'matched_count' to the number of packets looked up in this flow
395      *     table so far that matched one of the flow entries.
396      *
397      * Keep in mind that all of the members of struct ofp_table_stats are in
398      * network byte order.
399      */
400     void (*get_tables)(struct ofproto *ofproto, struct ofp_table_stats *ots);
401
402 /* ## ---------------- ## */
403 /* ## ofport Functions ## */
404 /* ## ---------------- ## */
405
406     /* Life-cycle functions for a "struct ofport" (see "Life Cycle" above).
407      *
408      * ->port_construct() should not modify any base members of the ofport.
409      *
410      * ofports are managed by the base ofproto code.  The ofproto
411      * implementation should only create and destroy them in response to calls
412      * to these functions.  The base ofproto code will create and destroy
413      * ofports in the following situations:
414      *
415      *   - Just after the ->construct() function is called, the base ofproto
416      *     iterates over all of the implementation's ports, using
417      *     ->port_dump_start() and related functions, and constructs an ofport
418      *     for each dumped port.
419      *
420      *   - If ->port_poll() reports that a specific port has changed, then the
421      *     base ofproto will query that port with ->port_query_by_name() and
422      *     construct or destruct ofports as necessary to reflect the updated
423      *     set of ports.
424      *
425      *   - If ->port_poll() returns ENOBUFS to report an unspecified port set
426      *     change, then the base ofproto will iterate over all of the
427      *     implementation's ports, in the same way as at ofproto
428      *     initialization, and construct and destruct ofports to reflect all of
429      *     the changes.
430      *
431      * ->port_construct() returns 0 if successful, otherwise a positive errno
432      * value.
433      */
434     struct ofport *(*port_alloc)(void);
435     int (*port_construct)(struct ofport *ofport);
436     void (*port_destruct)(struct ofport *ofport);
437     void (*port_dealloc)(struct ofport *ofport);
438
439     /* Called after 'ofport->netdev' is replaced by a new netdev object.  If
440      * the ofproto implementation uses the ofport's netdev internally, then it
441      * should switch to using the new one.  The old one has been closed.
442      *
443      * An ofproto implementation that doesn't need to do anything in this
444      * function may use a null pointer. */
445     void (*port_modified)(struct ofport *ofport);
446
447     /* Called after an OpenFlow OFPT_PORT_MOD request changes a port's
448      * configuration.  'ofport->opp.config' contains the new configuration.
449      * 'old_config' contains the previous configuration.
450      *
451      * The caller implements OFPPC_PORT_DOWN using netdev functions to turn
452      * NETDEV_UP on and off, so this function doesn't have to do anything for
453      * that bit (and it won't be called if that is the only bit that
454      * changes). */
455     void (*port_reconfigured)(struct ofport *ofport, ovs_be32 old_config);
456
457     /* Looks up a port named 'devname' in 'ofproto'.  On success, initializes
458      * '*port' appropriately.
459      *
460      * The caller owns the data in 'port' and must free it with
461      * ofproto_port_destroy() when it is no longer needed. */
462     int (*port_query_by_name)(const struct ofproto *ofproto,
463                               const char *devname, struct ofproto_port *port);
464
465     /* Attempts to add 'netdev' as a port on 'ofproto'.  Returns 0 if
466      * successful, otherwise a positive errno value.  If successful, sets
467      * '*ofp_portp' to the new port's port number.
468      *
469      * It doesn't matter whether the new port will be returned by a later call
470      * to ->port_poll(); the implementation may do whatever is more
471      * convenient. */
472     int (*port_add)(struct ofproto *ofproto, struct netdev *netdev,
473                     uint16_t *ofp_portp);
474
475     /* Deletes port number 'ofp_port' from the datapath for 'ofproto'.  Returns
476      * 0 if successful, otherwise a positive errno value.
477      *
478      * It doesn't matter whether the new port will be returned by a later call
479      * to ->port_poll(); the implementation may do whatever is more
480      * convenient. */
481     int (*port_del)(struct ofproto *ofproto, uint16_t ofp_port);
482
483     /* Port iteration functions.
484      *
485      * The client might not be entirely in control of the ports within an
486      * ofproto.  Some hardware implementations, for example, might have a fixed
487      * set of ports in a datapath, and the Linux datapath allows the system
488      * administrator to externally add and remove ports with ovs-dpctl.  For
489      * this reason, the client needs a way to iterate through all the ports
490      * that are actually in a datapath.  These functions provide that
491      * functionality.
492      *
493      * The 'state' pointer provides the implementation a place to
494      * keep track of its position.  Its format is opaque to the caller.
495      *
496      * The ofproto provider retains ownership of the data that it stores into
497      * ->port_dump_next()'s 'port' argument.  The data must remain valid until
498      * at least the next call to ->port_dump_next() or ->port_dump_done() for
499      * 'state'.  The caller will not modify or free it.
500      *
501      * Details
502      * =======
503      *
504      * ->port_dump_start() attempts to begin dumping the ports in 'ofproto'.
505      * On success, it should return 0 and initialize '*statep' with any data
506      * needed for iteration.  On failure, returns a positive errno value, and
507      * the client will not call ->port_dump_next() or ->port_dump_done().
508      *
509      * ->port_dump_next() attempts to retrieve another port from 'ofproto' for
510      * 'state'.  If there is another port, it should store the port's
511      * information into 'port' and return 0.  It should return EOF if all ports
512      * have already been iterated.  Otherwise, on error, it should return a
513      * positive errno value.  This function will not be called again once it
514      * returns nonzero once for a given iteration (but the 'port_dump_done'
515      * function will be called afterward).
516      *
517      * ->port_dump_done() allows the implementation to release resources used
518      * for iteration.  The caller might decide to stop iteration in the middle
519      * by calling this function before ->port_dump_next() returns nonzero.
520      *
521      * Usage Example
522      * =============
523      *
524      * int error;
525      * void *state;
526      *
527      * error = ofproto->ofproto_class->port_dump_start(ofproto, &state);
528      * if (!error) {
529      *     for (;;) {
530      *         struct ofproto_port port;
531      *
532      *         error = ofproto->ofproto_class->port_dump_next(
533      *                     ofproto, state, &port);
534      *         if (error) {
535      *             break;
536      *         }
537      *         // Do something with 'port' here (without modifying or freeing
538      *         // any of its data).
539      *     }
540      *     ofproto->ofproto_class->port_dump_done(ofproto, state);
541      * }
542      * // 'error' is now EOF (success) or a positive errno value (failure).
543      */
544     int (*port_dump_start)(const struct ofproto *ofproto, void **statep);
545     int (*port_dump_next)(const struct ofproto *ofproto, void *state,
546                           struct ofproto_port *port);
547     int (*port_dump_done)(const struct ofproto *ofproto, void *state);
548
549     /* Polls for changes in the set of ports in 'ofproto'.  If the set of ports
550      * in 'ofproto' has changed, then this function should do one of the
551      * following:
552      *
553      * - Preferably: store the name of the device that was added to or deleted
554      *   from 'ofproto' in '*devnamep' and return 0.  The caller is responsible
555      *   for freeing '*devnamep' (with free()) when it no longer needs it.
556      *
557      * - Alternatively: return ENOBUFS, without indicating the device that was
558      *   added or deleted.
559      *
560      * Occasional 'false positives', in which the function returns 0 while
561      * indicating a device that was not actually added or deleted or returns
562      * ENOBUFS without any change, are acceptable.
563      *
564      * The purpose of 'port_poll' is to let 'ofproto' know about changes made
565      * externally to the 'ofproto' object, e.g. by a system administrator via
566      * ovs-dpctl.  Therefore, it's OK, and even preferable, for port_poll() to
567      * not report changes made through calls to 'port_add' or 'port_del' on the
568      * same 'ofproto' object.  (But it's OK for it to report them too, just
569      * slightly less efficient.)
570      *
571      * If the set of ports in 'ofproto' has not changed, returns EAGAIN.  May
572      * also return other positive errno values to indicate that something has
573      * gone wrong.
574      *
575      * If the set of ports in a datapath is fixed, or if the only way that the
576      * set of ports in a datapath can change is through ->port_add() and
577      * ->port_del(), then this function may be a null pointer.
578      */
579     int (*port_poll)(const struct ofproto *ofproto, char **devnamep);
580
581     /* Arranges for the poll loop to wake up when ->port_poll() will return a
582      * value other than EAGAIN.
583      *
584      * If the set of ports in a datapath is fixed, or if the only way that the
585      * set of ports in a datapath can change is through ->port_add() and
586      * ->port_del(), or if the poll loop will always wake up anyway when
587      * ->port_poll() will return a value other than EAGAIN, then this function
588      * may be a null pointer.
589      */
590     void (*port_poll_wait)(const struct ofproto *ofproto);
591
592     /* Checks the status of LACP negotiation for 'port'.  Returns 1 if LACP
593      * partner information for 'port' is up-to-date, 0 if LACP partner
594      * information is not current (generally indicating a connectivity
595      * problem), or -1 if LACP is not enabled on 'port'.
596      *
597      * This function may be a null pointer if the ofproto implementation does
598      * not support LACP. */
599     int (*port_is_lacp_current)(const struct ofport *port);
600
601 /* ## ----------------------- ## */
602 /* ## OpenFlow Rule Functions ## */
603 /* ## ----------------------- ## */
604
605
606
607     /* Chooses an appropriate table for 'cls_rule' within 'ofproto'.  On
608      * success, stores the table ID into '*table_idp' and returns 0.  On
609      * failure, returns an OpenFlow error code (as returned by ofp_mkerr()).
610      *
611      * The choice of table should be a function of 'cls_rule' and 'ofproto''s
612      * datapath capabilities.  It should not depend on the flows already in
613      * 'ofproto''s flow tables.  Failure implies that an OpenFlow rule with
614      * 'cls_rule' as its matching condition can never be inserted into
615      * 'ofproto', even starting from an empty flow table.
616      *
617      * If multiple tables are candidates for inserting the flow, the function
618      * should choose one arbitrarily (but deterministically).
619      *
620      * If this function is NULL then table 0 is always chosen. */
621     int (*rule_choose_table)(const struct ofproto *ofproto,
622                              const struct cls_rule *cls_rule,
623                              uint8_t *table_idp);
624
625     /* Life-cycle functions for a "struct rule" (see "Life Cycle" above).
626      *
627      *
628      * Asynchronous Operation Support
629      * ==============================
630      *
631      * The life-cycle operations on rules can operate asynchronously, meaning
632      * that ->rule_construct() and ->rule_destruct() only need to initiate
633      * their respective operations and do not need to wait for them to complete
634      * before they return.  ->rule_modify_actions() also operates
635      * asynchronously.
636      *
637      * An ofproto implementation reports the success or failure of an
638      * asynchronous operation on a rule using the rule's 'pending' member,
639      * which points to a opaque "struct ofoperation" that represents the
640      * ongoing opreation.  When the operation completes, the ofproto
641      * implementation calls ofoperation_complete(), passing the ofoperation and
642      * an error indication.
643      *
644      * Only the following contexts may call ofoperation_complete():
645      *
646      *   - The function called to initiate the operation,
647      *     e.g. ->rule_construct() or ->rule_destruct().  This is the best
648      *     choice if the operation completes quickly.
649      *
650      *   - The implementation's ->run() function.
651      *
652      *   - The implementation's ->destruct() function.
653      *
654      * The ofproto base code updates the flow table optimistically, assuming
655      * that the operation will probably succeed:
656      *
657      *   - ofproto adds or replaces the rule in the flow table before calling
658      *     ->rule_construct().
659      *
660      *   - ofproto updates the rule's actions before calling
661      *     ->rule_modify_actions().
662      *
663      *   - ofproto removes the rule before calling ->rule_destruct().
664      *
665      * With one exception, when an asynchronous operation completes with an
666      * error, ofoperation_complete() backs out the already applied changes:
667      *
668      *   - If adding or replacing a rule in the flow table fails, ofproto
669      *     removes the new rule or restores the original rule.
670      *
671      *   - If modifying a rule's actions fails, ofproto restores the original
672      *     actions.
673      *
674      *   - Removing a rule is not allowed to fail.  It must always succeed.
675      *
676      * The ofproto base code serializes operations: if any operation is in
677      * progress on a given rule, ofproto postpones initiating any new operation
678      * on that rule until the pending operation completes.  Therefore, every
679      * operation must eventually complete through a call to
680      * ofoperation_complete() to avoid delaying new operations indefinitely
681      * (including any OpenFlow request that affects the rule in question, even
682      * just to query its statistics).
683      *
684      *
685      * Construction
686      * ============
687      *
688      * When ->rule_construct() is called, the caller has already inserted
689      * 'rule' into 'rule->ofproto''s flow table numbered 'rule->table_id'.
690      * There are two cases:
691      *
692      *   - 'rule' is a new rule in its flow table.  In this case,
693      *     ofoperation_get_victim(rule) returns NULL.
694      *
695      *   - 'rule' is replacing an existing rule in its flow table that had the
696      *     same matching criteria and priority.  In this case,
697      *     ofoperation_get_victim(rule) returns the rule being replaced (the
698      *     "victim" rule).
699      *
700      * ->rule_construct() should set the following in motion:
701      *
702      *   - Validate that the matching rule in 'rule->cr' is supported by the
703      *     datapath.  For example, if the rule's table does not support
704      *     registers, then it is an error if 'rule->cr' does not wildcard all
705      *     registers.
706      *
707      *   - Validate that 'rule->actions' and 'rule->n_actions' are well-formed
708      *     OpenFlow actions that the datapath can correctly implement.  The
709      *     validate_actions() function (in ofp-util.c) can be useful as a model
710      *     for action validation, but it accepts all of the OpenFlow actions
711      *     that OVS understands.  If your ofproto implementation only
712      *     implements a subset of those, then you should implement your own
713      *     action validation.
714      *
715      *   - If the rule is valid, update the datapath flow table, adding the new
716      *     rule or replacing the existing one.
717      *
718      *   - If 'rule' is replacing an existing rule, uninitialize any derived
719      *     state for the victim rule, as in step 5 in the "Life Cycle"
720      *     described above.
721      *
722      * (On failure, the ofproto code will roll back the insertion from the flow
723      * table, either removing 'rule' or replacing it by the victim rule if
724      * there is one.)
725      *
726      * ->rule_construct() must act in one of the following ways:
727      *
728      *   - If it succeeds, it must call ofoperation_complete() and return 0.
729      *
730      *   - If it fails, it must act in one of the following ways:
731      *
732      *       * Call ofoperation_complete() and return 0.
733      *
734      *       * Return an OpenFlow error code (as returned by ofp_mkerr()).  (Do
735      *         not call ofoperation_complete() in this case.)
736      *
737      *     Either way, ->rule_destruct() will not be called for 'rule', but
738      *     ->rule_dealloc() will be.
739      *
740      *   - If the operation is only partially complete, then it must return 0.
741      *     Later, when the operation is complete, the ->run() or ->destruct()
742      *     function must call ofoperation_complete() to report success or
743      *     failure.
744      *
745      * ->rule_construct() should not modify any base members of struct rule.
746      *
747      *
748      * Destruction
749      * ===========
750      *
751      * When ->rule_destruct() is called, the caller has already removed 'rule'
752      * from 'rule->ofproto''s flow table.  ->rule_destruct() should set in
753      * motion removing 'rule' from the datapath flow table.  If removal
754      * completes synchronously, it should call ofoperation_complete().
755      * Otherwise, the ->run() or ->destruct() function must later call
756      * ofoperation_complete() after the operation completes.
757      *
758      * Rule destruction must not fail. */
759     struct rule *(*rule_alloc)(void);
760     int (*rule_construct)(struct rule *rule);
761     void (*rule_destruct)(struct rule *rule);
762     void (*rule_dealloc)(struct rule *rule);
763
764     /* Obtains statistics for 'rule', storing the number of packets that have
765      * matched it in '*packet_count' and the number of bytes in those packets
766      * in '*byte_count'.  UINT64_MAX indicates that the packet count or byte
767      * count is unknown. */
768     void (*rule_get_stats)(struct rule *rule, uint64_t *packet_count,
769                            uint64_t *byte_count);
770
771     /* Applies the actions in 'rule' to 'packet'.  (This implements sending
772      * buffered packets for OpenFlow OFPT_FLOW_MOD commands.)
773      *
774      * Takes ownership of 'packet' (so it should eventually free it, with
775      * ofpbuf_delete()).
776      *
777      * 'flow' reflects the flow information for 'packet'.  All of the
778      * information in 'flow' is extracted from 'packet', except for
779      * flow->tun_id and flow->in_port, which are assigned the correct values
780      * for the incoming packet.  The register values are zeroed.
781      *
782      * The statistics for 'packet' should be included in 'rule'.
783      *
784      * Returns 0 if successful, otherwise an OpenFlow error code (as returned
785      * by ofp_mkerr()). */
786     int (*rule_execute)(struct rule *rule, struct flow *flow,
787                         struct ofpbuf *packet);
788
789     /* When ->rule_modify_actions() is called, the caller has already replaced
790      * the OpenFlow actions in 'rule' by a new set.  (The original actions are
791      * in rule->pending->actions.)
792      *
793      * ->rule_modify_actions() should set the following in motion:
794      *
795      *   - Validate that the actions now in 'rule' are well-formed OpenFlow
796      *     actions that the datapath can correctly implement.
797      *
798      *   - Update the datapath flow table with the new actions.
799      *
800      * If the operation synchronously completes, ->rule_modify_actions() may
801      * call ofoperation_complete() before it returns.  Otherwise, ->run()
802      * should call ofoperation_complete() later, after the operation does
803      * complete.
804      *
805      * If the operation fails, then the base ofproto code will restore the
806      * original 'actions' and 'n_actions' of 'rule'.
807      *
808      * ->rule_modify_actions() should not modify any base members of struct
809      * rule. */
810     void (*rule_modify_actions)(struct rule *rule);
811
812     /* Changes the OpenFlow IP fragment handling policy to 'frag_handling',
813      * which takes one of the following values, with the corresponding
814      * meanings:
815      *
816      *  - OFPC_FRAG_NORMAL: The switch should treat IP fragments the same way
817      *    as other packets, omitting TCP and UDP port numbers (always setting
818      *    them to 0).
819      *
820      *  - OFPC_FRAG_DROP: The switch should drop all IP fragments without
821      *    passing them through the flow table.
822      *
823      *  - OFPC_FRAG_REASM: The switch should reassemble IP fragments before
824      *    passing packets through the flow table.
825      *
826      *  - OFPC_FRAG_NX_MATCH (a Nicira extension): Similar to OFPC_FRAG_NORMAL,
827      *    except that TCP and UDP port numbers should be included in fragments
828      *    with offset 0.
829      *
830      * Implementations are not required to support every mode.
831      * OFPC_FRAG_NORMAL is the default mode when an ofproto is created.
832      *
833      * At the time of the call to ->set_frag_handling(), the current mode is
834      * available in 'ofproto->frag_handling'.  ->set_frag_handling() returns
835      * true if the requested mode was set, false if it is not supported.
836      *
837      * Upon successful return, the caller changes 'ofproto->frag_handling' to
838      * reflect the new mode.
839      */
840     bool (*set_frag_handling)(struct ofproto *ofproto,
841                               enum ofp_config_flags frag_handling);
842
843     /* Implements the OpenFlow OFPT_PACKET_OUT command.  The datapath should
844      * execute the 'n_actions' in the 'actions' array on 'packet'.
845      *
846      * The caller retains ownership of 'packet', so ->packet_out() should not
847      * modify or free it.
848      *
849      * This function must validate that the 'n_actions' elements in 'actions'
850      * are well-formed OpenFlow actions that can be correctly implemented by
851      * the datapath.  If not, then it should return an OpenFlow error code (as
852      * returned by ofp_mkerr()).
853      *
854      * 'flow' reflects the flow information for 'packet'.  All of the
855      * information in 'flow' is extracted from 'packet', except for
856      * flow->in_port, which is taken from the OFPT_PACKET_OUT message.
857      * flow->tun_id and its register values are zeroed.
858      *
859      * 'packet' is not matched against the OpenFlow flow table, so its
860      * statistics should not be included in OpenFlow flow statistics.
861      *
862      * Returns 0 if successful, otherwise an OpenFlow error code (as returned
863      * by ofp_mkerr()). */
864     int (*packet_out)(struct ofproto *ofproto, struct ofpbuf *packet,
865                       const struct flow *flow,
866                       const union ofp_action *actions,
867                       size_t n_actions);
868
869 /* ## ------------------------- ## */
870 /* ## OFPP_NORMAL configuration ## */
871 /* ## ------------------------- ## */
872
873     /* Configures NetFlow on 'ofproto' according to the options in
874      * 'netflow_options', or turns off NetFlow if 'netflow_options' is NULL.
875      *
876      * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
877      * NetFlow, as does a null pointer. */
878     int (*set_netflow)(struct ofproto *ofproto,
879                        const struct netflow_options *netflow_options);
880
881     void (*get_netflow_ids)(const struct ofproto *ofproto,
882                             uint8_t *engine_type, uint8_t *engine_id);
883
884     /* Configures sFlow on 'ofproto' according to the options in
885      * 'sflow_options', or turns off sFlow if 'sflow_options' is NULL.
886      *
887      * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
888      * sFlow, as does a null pointer. */
889     int (*set_sflow)(struct ofproto *ofproto,
890                      const struct ofproto_sflow_options *sflow_options);
891
892     /* Configures connectivity fault management on 'ofport'.
893      *
894      * If 'cfm_settings' is nonnull, configures CFM according to its members.
895      *
896      * If 'cfm_settings' is null, removes any connectivity fault management
897      * configuration from 'ofport'.
898      *
899      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
900      * support CFM, as does a null pointer. */
901     int (*set_cfm)(struct ofport *ofport, const struct cfm_settings *s);
902
903     /* Checks the fault status of CFM configured on 'ofport'.  Returns 1 if CFM
904      * is faulted (generally indicating a connectivity problem), 0 if CFM is
905      * not faulted, or -1 if CFM is not enabled on 'port'
906      *
907      * This function may be a null pointer if the ofproto implementation does
908      * not support CFM. */
909     int (*get_cfm_fault)(const struct ofport *ofport);
910
911     /* Gets the MPIDs of the remote maintenance points broadcasting to
912      * 'ofport'.  Populates 'rmps' with a provider owned array of MPIDs, and
913      * 'n_rmps' with the number of MPIDs in 'rmps'. Returns a number less than
914      * 0 if CFM is not enabled of 'ofport'.
915      *
916      * This function may be a null pointer if the ofproto implementation does
917      * not support CFM. */
918     int (*get_cfm_remote_mpids)(const struct ofport *ofport,
919                                 const uint64_t **rmps, size_t *n_rmps);
920
921     /* Configures spanning tree protocol (STP) on 'ofproto' using the
922      * settings defined in 's'.
923      *
924      * If 's' is nonnull, configures STP according to its members.
925      *
926      * If 's' is null, removes any STP configuration from 'ofproto'.
927      *
928      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
929      * support STP, as does a null pointer. */
930     int (*set_stp)(struct ofproto *ofproto,
931                    const struct ofproto_stp_settings *s);
932
933     /* Retrieves state of spanning tree protocol (STP) on 'ofproto'.
934      *
935      * Stores STP state for 'ofproto' in 's'.  If the 'enabled' member
936      * is false, the other member values are not meaningful.
937      *
938      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
939      * support STP, as does a null pointer. */
940     int (*get_stp_status)(struct ofproto *ofproto,
941                           struct ofproto_stp_status *s);
942
943     /* Configures spanning tree protocol (STP) on 'ofport' using the
944      * settings defined in 's'.
945      *
946      * If 's' is nonnull, configures STP according to its members.  The
947      * caller is responsible for assigning STP port numbers (using the
948      * 'port_num' member in the range of 1 through 255, inclusive) and
949      * ensuring there are no duplicates.
950      *
951      * If 's' is null, removes any STP configuration from 'ofport'.
952      *
953      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
954      * support STP, as does a null pointer. */
955     int (*set_stp_port)(struct ofport *ofport,
956                         const struct ofproto_port_stp_settings *s);
957
958     /* Retrieves spanning tree protocol (STP) port status of 'ofport'.
959      *
960      * Stores STP state for 'ofport' in 's'.  If the 'enabled' member is
961      * false, the other member values are not meaningful.
962      *
963      * EOPNOTSUPP as a return value indicates that this ofproto_class does not
964      * support STP, as does a null pointer. */
965     int (*get_stp_port_status)(struct ofport *ofport,
966                                struct ofproto_port_stp_status *s);
967
968     /* If 's' is nonnull, this function registers a "bundle" associated with
969      * client data pointer 'aux' in 'ofproto'.  A bundle is the same concept as
970      * a Port in OVSDB, that is, it consists of one or more "slave" devices
971      * (Interfaces, in OVSDB) along with VLAN and LACP configuration and, if
972      * there is more than one slave, a bonding configuration.  If 'aux' is
973      * already registered then this function updates its configuration to 's'.
974      * Otherwise, this function registers a new bundle.
975      *
976      * If 's' is NULL, this function unregisters the bundle registered on
977      * 'ofproto' associated with client data pointer 'aux'.  If no such bundle
978      * has been registered, this has no effect.
979      *
980      * This function affects only the behavior of the NXAST_AUTOPATH action and
981      * output to the OFPP_NORMAL port.  An implementation that does not support
982      * it at all may set it to NULL or return EOPNOTSUPP.  An implementation
983      * that supports only a subset of the functionality should implement what
984      * it can and return 0. */
985     int (*bundle_set)(struct ofproto *ofproto, void *aux,
986                       const struct ofproto_bundle_settings *s);
987
988     /* If 'port' is part of any bundle, removes it from that bundle.  If the
989      * bundle now has no ports, deletes the bundle.  If the bundle now has only
990      * one port, deconfigures the bundle's bonding configuration. */
991     void (*bundle_remove)(struct ofport *ofport);
992
993     /* If 's' is nonnull, this function registers a mirror associated with
994      * client data pointer 'aux' in 'ofproto'.  A mirror is the same concept as
995      * a Mirror in OVSDB.  If 'aux' is already registered then this function
996      * updates its configuration to 's'.  Otherwise, this function registers a
997      * new mirror.
998      *
999      * If 's' is NULL, this function unregisters the mirror registered on
1000      * 'ofproto' associated with client data pointer 'aux'.  If no such mirror
1001      * has been registered, this has no effect.
1002      *
1003      * This function affects only the behavior of the OFPP_NORMAL action.  An
1004      * implementation that does not support it at all may set it to NULL or
1005      * return EOPNOTSUPP.  An implementation that supports only a subset of the
1006      * functionality should implement what it can and return 0. */
1007     int (*mirror_set)(struct ofproto *ofproto, void *aux,
1008                       const struct ofproto_mirror_settings *s);
1009
1010     /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs
1011      * on which all packets are flooded, instead of using MAC learning.  If
1012      * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1013      *
1014      * This function affects only the behavior of the OFPP_NORMAL action.  An
1015      * implementation that does not support it may set it to NULL or return
1016      * EOPNOTSUPP. */
1017     int (*set_flood_vlans)(struct ofproto *ofproto,
1018                            unsigned long *flood_vlans);
1019
1020     /* Returns true if 'aux' is a registered bundle that is currently in use as
1021      * the output for a mirror. */
1022     bool (*is_mirror_output_bundle)(const struct ofproto *ofproto, void *aux);
1023
1024     /* When the configuration option of forward_bpdu changes, this function
1025      * will be invoked. */
1026     void (*forward_bpdu_changed)(struct ofproto *ofproto);
1027 };
1028
1029 extern const struct ofproto_class ofproto_dpif_class;
1030
1031 int ofproto_class_register(const struct ofproto_class *);
1032 int ofproto_class_unregister(const struct ofproto_class *);
1033
1034 /* ofproto_flow_mod() returns this value if the flow_mod could not be processed
1035  * because it overlaps with an ongoing flow table operation that has not yet
1036  * completed.  The caller should retry the operation later.
1037  *
1038  * ofproto.c also uses this value internally for additional (similar) purposes.
1039  *
1040  * This particular value is a good choice because it is negative (so it won't
1041  * collide with any errno value or any value returned by ofp_mkerr()) and large
1042  * (so it won't accidentally collide with EOF or a negative errno value). */
1043 enum { OFPROTO_POSTPONE = -100000 };
1044
1045 int ofproto_flow_mod(struct ofproto *, const struct ofputil_flow_mod *);
1046 void ofproto_add_flow(struct ofproto *, const struct cls_rule *,
1047                       const union ofp_action *, size_t n_actions);
1048 bool ofproto_delete_flow(struct ofproto *, const struct cls_rule *);
1049 void ofproto_flush_flows(struct ofproto *);
1050
1051 #endif /* ofproto/ofproto-provider.h */