2 * Copyright (c) 2009, 2010, 2011 Nicira Networks.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #ifndef OFPROTO_OFPROTO_PROVIDER_H
18 #define OFPROTO_OFPROTO_PROVIDER_H 1
20 /* Definitions for use within ofproto. */
22 #include "ofproto/ofproto.h"
24 #include "classifier.h"
29 struct ofputil_flow_mod;
31 /* An OpenFlow switch.
33 * With few exceptions, ofproto implementations may look at these fields but
34 * should not modify them. */
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. */
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. */
56 struct hmap ports; /* Contains "struct ofport"s. */
57 struct shash port_by_name;
60 struct classifier *tables; /* Each classifier contains "struct rule"s. */
63 /* OpenFlow connections. */
64 struct connmgr *connmgr;
66 /* Flow table operation tracking. */
67 int state; /* Internal state. */
68 struct list pending; /* List of "struct ofopgroup"s. */
69 unsigned int n_pending; /* list_size(&pending). */
70 struct hmap deletions; /* All OFOPERATION_DELETE "ofoperation"s. */
73 struct ofproto *ofproto_lookup(const char *name);
74 struct ofport *ofproto_get_port(const struct ofproto *, uint16_t ofp_port);
76 /* Assigns CLS to each classifier table, in turn, in OFPROTO.
78 * All parameters are evaluated multiple times. */
79 #define OFPROTO_FOR_EACH_TABLE(CLS, OFPROTO) \
80 for ((CLS) = (OFPROTO)->tables; \
81 (CLS) < &(OFPROTO)->tables[(OFPROTO)->n_tables]; \
85 /* An OpenFlow port within a "struct ofproto".
87 * With few exceptions, ofproto implementations may look at these fields but
88 * should not modify them. */
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;
98 /* An OpenFlow flow within a "struct ofproto".
100 * With few exceptions, ofproto implementations may look at these fields but
101 * should not modify them. */
103 struct ofproto *ofproto; /* The ofproto that contains this rule. */
104 struct list ofproto_node; /* Owned by ofproto base code. */
105 struct cls_rule cr; /* In owning ofproto's classifier. */
107 struct ofoperation *pending; /* Operation now in progress, if nonnull. */
109 ovs_be64 flow_cookie; /* Controller-issued identifier. */
111 long long int created; /* Creation time. */
112 long long int modified; /* Time of last modification. */
113 uint16_t idle_timeout; /* In seconds from time of last use. */
114 uint16_t hard_timeout; /* In seconds from last modification. */
115 uint8_t table_id; /* Index in ofproto's 'tables' array. */
116 bool send_flow_removed; /* Send a flow removed message? */
118 union ofp_action *actions; /* OpenFlow actions. */
119 int n_actions; /* Number of elements in actions[]. */
122 static inline struct rule *
123 rule_from_cls_rule(const struct cls_rule *cls_rule)
125 return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
128 void ofproto_rule_expire(struct rule *, uint8_t reason);
129 void ofproto_rule_destroy(struct rule *);
131 void ofoperation_complete(struct ofoperation *, int status);
132 struct rule *ofoperation_get_victim(struct ofoperation *);
134 /* ofproto class structure, to be defined by each ofproto implementation.
140 * These functions work primarily with three different kinds of data
143 * - "struct ofproto", which represents an OpenFlow switch.
145 * - "struct ofport", which represents a port within an ofproto.
147 * - "struct rule", which represents an OpenFlow flow within an ofproto.
149 * Each of these data structures contains all of the implementation-independent
150 * generic state for the respective concept, called the "base" state. None of
151 * them contains any extra space for ofproto implementations to use. Instead,
152 * each implementation is expected to declare its own data structure that
153 * contains an instance of the generic data structure plus additional
154 * implementation-specific members, called the "derived" state. The
155 * implementation can use casts or (preferably) the CONTAINER_OF macro to
156 * obtain access to derived state given only a pointer to the embedded generic
163 * Four stylized functions accompany each of these data structures:
165 * "alloc" "construct" "destruct" "dealloc"
166 * ------------ ---------------- --------------- --------------
167 * ofproto ->alloc ->construct ->destruct ->dealloc
168 * ofport ->port_alloc ->port_construct ->port_destruct ->port_dealloc
169 * rule ->rule_alloc ->rule_construct ->rule_destruct ->rule_dealloc
171 * Any instance of a given data structure goes through the following life
174 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
175 * fails, skip all the other steps.
177 * 2. The client initializes all of the data structure's base state. If this
178 * fails, skip to step 7.
180 * 3. The client calls the "construct" function. The implementation
181 * initializes derived state. It may refer to the already-initialized
182 * base state. If "construct" fails, skip to step 6.
184 * 4. The data structure is now initialized and in use.
186 * 5. When the data structure is no longer needed, the client calls the
187 * "destruct" function. The implementation uninitializes derived state.
188 * The base state has not been uninitialized yet, so the implementation
189 * may still refer to it.
191 * 6. The client uninitializes all of the data structure's base state.
193 * 7. The client calls the "dealloc" to free the raw memory. The
194 * implementation must not refer to base or derived state in the data
195 * structure, because it has already been uninitialized.
197 * Each "alloc" function allocates and returns a new instance of the respective
198 * data structure. The "alloc" function is not given any information about the
199 * use of the new data structure, so it cannot perform much initialization.
200 * Its purpose is just to ensure that the new data structure has enough room
201 * for base and derived state. It may return a null pointer if memory is not
202 * available, in which case none of the other functions is called.
204 * Each "construct" function initializes derived state in its respective data
205 * structure. When "construct" is called, all of the base state has already
206 * been initialized, so the "construct" function may refer to it. The
207 * "construct" function is allowed to fail, in which case the client calls the
208 * "dealloc" function (but not the "destruct" function).
210 * Each "destruct" function uninitializes and frees derived state in its
211 * respective data structure. When "destruct" is called, the base state has
212 * not yet been uninitialized, so the "destruct" function may refer to it. The
213 * "destruct" function is not allowed to fail.
215 * Each "dealloc" function frees raw memory that was allocated by the the
216 * "alloc" function. The memory's base and derived members might not have ever
217 * been initialized (but if "construct" returned successfully, then it has been
218 * "destruct"ed already). The "dealloc" function is not allowed to fail.
224 * Most of these functions return 0 if they are successful or a positive error
225 * code on failure. Depending on the function, valid error codes are either
226 * errno values or OpenFlow error codes constructed with ofp_mkerr().
228 * Most of these functions are expected to execute synchronously, that is, to
229 * block as necessary to obtain a result. Thus, these functions may return
230 * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
231 * explicitly say those errors are a possibility. We may relax this
232 * requirement in the future if and when we encounter performance problems. */
233 struct ofproto_class {
234 /* ## ----------------- ## */
235 /* ## Factory Functions ## */
236 /* ## ----------------- ## */
238 /* Enumerates the types of all support ofproto types into 'types'. The
239 * caller has already initialized 'types' and other ofproto classes might
240 * already have added names to it. */
241 void (*enumerate_types)(struct sset *types);
243 /* Enumerates the names of all existing datapath of the specified 'type'
244 * into 'names' 'all_dps'. The caller has already initialized 'names' as
247 * 'type' is one of the types enumerated by ->enumerate_types().
249 * Returns 0 if successful, otherwise a positive errno value.
251 int (*enumerate_names)(const char *type, struct sset *names);
253 /* Deletes the datapath with the specified 'type' and 'name'. The caller
254 * should have closed any open ofproto with this 'type' and 'name'; this
255 * function is allowed to fail if that is not the case.
257 * 'type' is one of the types enumerated by ->enumerate_types().
258 * 'name' is one of the names enumerated by ->enumerate_names() for 'type'.
260 * Returns 0 if successful, otherwise a positive errno value.
262 int (*del)(const char *type, const char *name);
264 /* ## --------------------------- ## */
265 /* ## Top-Level ofproto Functions ## */
266 /* ## --------------------------- ## */
268 /* Life-cycle functions for an "ofproto" (see "Life Cycle" above).
274 * ->construct() should not modify any base members of the ofproto. The
275 * client will initialize the ofproto's 'ports' and 'tables' members after
276 * construction is complete.
278 * When ->construct() is called, the client does not yet know how many flow
279 * tables the datapath supports, so ofproto->n_tables will be 0 and
280 * ofproto->tables will be NULL. ->construct() should store the number of
281 * flow tables supported by the datapath (between 1 and 255, inclusive)
282 * into '*n_tables'. After a successful return, the client will initialize
283 * the base 'n_tables' member to '*n_tables' and allocate and initialize
284 * the base 'tables' member as the specified number of empty flow tables.
285 * Each flow table will be initially empty, so ->construct() should delete
286 * flows from the underlying datapath, if necessary, rather than populating
289 * Only one ofproto instance needs to be supported for any given datapath.
290 * If a datapath is already open as part of one "ofproto", then another
291 * attempt to "construct" the same datapath as part of another ofproto is
292 * allowed to fail with an error.
294 * ->construct() returns 0 if successful, otherwise a positive errno
301 * If 'ofproto' has any pending asynchronous operations, ->destruct()
302 * must complete all of them by calling ofoperation_complete().
304 * ->destruct() must also destroy all remaining rules in the ofproto's
305 * tables, by passing each remaining rule to ofproto_rule_destroy(). The
306 * client will destroy the flow tables themselves after ->destruct()
309 struct ofproto *(*alloc)(void);
310 int (*construct)(struct ofproto *ofproto, int *n_tables);
311 void (*destruct)(struct ofproto *ofproto);
312 void (*dealloc)(struct ofproto *ofproto);
314 /* Performs any periodic activity required by 'ofproto'. It should:
316 * - Call connmgr_send_packet_in() for each received packet that missed
317 * in the OpenFlow flow table or that had a OFPP_CONTROLLER output
320 * - Call ofproto_rule_expire() for each OpenFlow flow that has reached
321 * its hard_timeout or idle_timeout, to expire the flow.
323 * Returns 0 if successful, otherwise a positive errno value. The ENODEV
324 * return value specifically means that the datapath underlying 'ofproto'
325 * has been destroyed (externally, e.g. by an admin running ovs-dpctl).
327 int (*run)(struct ofproto *ofproto);
329 /* Causes the poll loop to wake up when 'ofproto''s 'run' function needs to
330 * be called, e.g. by calling the timer or fd waiting functions in
332 void (*wait)(struct ofproto *ofproto);
334 /* Every "struct rule" in 'ofproto' is about to be deleted, one by one.
335 * This function may prepare for that, for example by clearing state in
336 * advance. It should *not* actually delete any "struct rule"s from
337 * 'ofproto', only prepare for it.
339 * This function is optional; it's really just for optimization in case
340 * it's cheaper to delete all the flows from your hardware in a single pass
341 * than to do it one by one. */
342 void (*flush)(struct ofproto *ofproto);
344 /* Helper for the OpenFlow OFPT_FEATURES_REQUEST request.
346 * The implementation should store true in '*arp_match_ip' if the switch
347 * supports matching IP addresses inside ARP requests and replies, false
350 * The implementation should store in '*actions' a bitmap of the supported
351 * OpenFlow actions: the bit with value (1 << n) should be set to 1 if the
352 * implementation supports the action with value 'n', and to 0 otherwise.
353 * For example, if the implementation supports the OFPAT_OUTPUT and
354 * OFPAT_ENQUEUE actions, but no others, it would set '*actions' to (1 <<
355 * OFPAT_OUTPUT) | (1 << OFPAT_ENQUEUE). Vendor actions are not included
357 void (*get_features)(struct ofproto *ofproto,
358 bool *arp_match_ip, uint32_t *actions);
360 /* Helper for the OpenFlow OFPST_TABLE statistics request.
362 * The 'ots' array contains 'ofproto->n_tables' elements. Each element is
365 * - 'table_id' to the array index.
367 * - 'name' to "table#" where # is the table ID.
369 * - 'wildcards' to OFPFW_ALL.
371 * - 'max_entries' to 1,000,000.
373 * - 'active_count' to the classifier_count() for the table.
375 * - 'lookup_count' and 'matched_count' to 0.
377 * The implementation should update any members in each element for which
378 * it has better values:
380 * - 'name' to a more meaningful name.
382 * - 'wildcards' to the set of wildcards actually supported by the table
383 * (if it doesn't support all OpenFlow wildcards).
385 * - 'max_entries' to the maximum number of flows actually supported by
388 * - 'lookup_count' to the number of packets looked up in this flow table
391 * - 'matched_count' to the number of packets looked up in this flow
392 * table so far that matched one of the flow entries.
394 * Keep in mind that all of the members of struct ofp_table_stats are in
395 * network byte order.
397 void (*get_tables)(struct ofproto *ofproto, struct ofp_table_stats *ots);
399 /* ## ---------------- ## */
400 /* ## ofport Functions ## */
401 /* ## ---------------- ## */
403 /* Life-cycle functions for a "struct ofport" (see "Life Cycle" above).
405 * ->port_construct() should not modify any base members of the ofport.
407 * ofports are managed by the base ofproto code. The ofproto
408 * implementation should only create and destroy them in response to calls
409 * to these functions. The base ofproto code will create and destroy
410 * ofports in the following situations:
412 * - Just after the ->construct() function is called, the base ofproto
413 * iterates over all of the implementation's ports, using
414 * ->port_dump_start() and related functions, and constructs an ofport
415 * for each dumped port.
417 * - If ->port_poll() reports that a specific port has changed, then the
418 * base ofproto will query that port with ->port_query_by_name() and
419 * construct or destruct ofports as necessary to reflect the updated
422 * - If ->port_poll() returns ENOBUFS to report an unspecified port set
423 * change, then the base ofproto will iterate over all of the
424 * implementation's ports, in the same way as at ofproto
425 * initialization, and construct and destruct ofports to reflect all of
428 * ->port_construct() returns 0 if successful, otherwise a positive errno
431 struct ofport *(*port_alloc)(void);
432 int (*port_construct)(struct ofport *ofport);
433 void (*port_destruct)(struct ofport *ofport);
434 void (*port_dealloc)(struct ofport *ofport);
436 /* Called after 'ofport->netdev' is replaced by a new netdev object. If
437 * the ofproto implementation uses the ofport's netdev internally, then it
438 * should switch to using the new one. The old one has been closed.
440 * An ofproto implementation that doesn't need to do anything in this
441 * function may use a null pointer. */
442 void (*port_modified)(struct ofport *ofport);
444 /* Called after an OpenFlow OFPT_PORT_MOD request changes a port's
445 * configuration. 'ofport->opp.config' contains the new configuration.
446 * 'old_config' contains the previous configuration.
448 * The caller implements OFPPC_PORT_DOWN using netdev functions to turn
449 * NETDEV_UP on and off, so this function doesn't have to do anything for
450 * that bit (and it won't be called if that is the only bit that
452 void (*port_reconfigured)(struct ofport *ofport, ovs_be32 old_config);
454 /* Looks up a port named 'devname' in 'ofproto'. On success, initializes
455 * '*port' appropriately.
457 * The caller owns the data in 'port' and must free it with
458 * ofproto_port_destroy() when it is no longer needed. */
459 int (*port_query_by_name)(const struct ofproto *ofproto,
460 const char *devname, struct ofproto_port *port);
462 /* Attempts to add 'netdev' as a port on 'ofproto'. Returns 0 if
463 * successful, otherwise a positive errno value. If successful, sets
464 * '*ofp_portp' to the new port's port number.
466 * It doesn't matter whether the new port will be returned by a later call
467 * to ->port_poll(); the implementation may do whatever is more
469 int (*port_add)(struct ofproto *ofproto, struct netdev *netdev,
470 uint16_t *ofp_portp);
472 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'. Returns
473 * 0 if successful, otherwise a positive errno value.
475 * It doesn't matter whether the new port will be returned by a later call
476 * to ->port_poll(); the implementation may do whatever is more
478 int (*port_del)(struct ofproto *ofproto, uint16_t ofp_port);
480 /* Port iteration functions.
482 * The client might not be entirely in control of the ports within an
483 * ofproto. Some hardware implementations, for example, might have a fixed
484 * set of ports in a datapath, and the Linux datapath allows the system
485 * administrator to externally add and remove ports with ovs-dpctl. For
486 * this reason, the client needs a way to iterate through all the ports
487 * that are actually in a datapath. These functions provide that
490 * The 'state' pointer provides the implementation a place to
491 * keep track of its position. Its format is opaque to the caller.
493 * The ofproto provider retains ownership of the data that it stores into
494 * ->port_dump_next()'s 'port' argument. The data must remain valid until
495 * at least the next call to ->port_dump_next() or ->port_dump_done() for
496 * 'state'. The caller will not modify or free it.
501 * ->port_dump_start() attempts to begin dumping the ports in 'ofproto'.
502 * On success, it should return 0 and initialize '*statep' with any data
503 * needed for iteration. On failure, returns a positive errno value, and
504 * the client will not call ->port_dump_next() or ->port_dump_done().
506 * ->port_dump_next() attempts to retrieve another port from 'ofproto' for
507 * 'state'. If there is another port, it should store the port's
508 * information into 'port' and return 0. It should return EOF if all ports
509 * have already been iterated. Otherwise, on error, it should return a
510 * positive errno value. This function will not be called again once it
511 * returns nonzero once for a given iteration (but the 'port_dump_done'
512 * function will be called afterward).
514 * ->port_dump_done() allows the implementation to release resources used
515 * for iteration. The caller might decide to stop iteration in the middle
516 * by calling this function before ->port_dump_next() returns nonzero.
524 * error = ofproto->ofproto_class->port_dump_start(ofproto, &state);
527 * struct ofproto_port port;
529 * error = ofproto->ofproto_class->port_dump_next(
530 * ofproto, state, &port);
534 * // Do something with 'port' here (without modifying or freeing
535 * // any of its data).
537 * ofproto->ofproto_class->port_dump_done(ofproto, state);
539 * // 'error' is now EOF (success) or a positive errno value (failure).
541 int (*port_dump_start)(const struct ofproto *ofproto, void **statep);
542 int (*port_dump_next)(const struct ofproto *ofproto, void *state,
543 struct ofproto_port *port);
544 int (*port_dump_done)(const struct ofproto *ofproto, void *state);
546 /* Polls for changes in the set of ports in 'ofproto'. If the set of ports
547 * in 'ofproto' has changed, then this function should do one of the
550 * - Preferably: store the name of the device that was added to or deleted
551 * from 'ofproto' in '*devnamep' and return 0. The caller is responsible
552 * for freeing '*devnamep' (with free()) when it no longer needs it.
554 * - Alternatively: return ENOBUFS, without indicating the device that was
557 * Occasional 'false positives', in which the function returns 0 while
558 * indicating a device that was not actually added or deleted or returns
559 * ENOBUFS without any change, are acceptable.
561 * The purpose of 'port_poll' is to let 'ofproto' know about changes made
562 * externally to the 'ofproto' object, e.g. by a system administrator via
563 * ovs-dpctl. Therefore, it's OK, and even preferable, for port_poll() to
564 * not report changes made through calls to 'port_add' or 'port_del' on the
565 * same 'ofproto' object. (But it's OK for it to report them too, just
566 * slightly less efficient.)
568 * If the set of ports in 'ofproto' has not changed, returns EAGAIN. May
569 * also return other positive errno values to indicate that something has
572 * If the set of ports in a datapath is fixed, or if the only way that the
573 * set of ports in a datapath can change is through ->port_add() and
574 * ->port_del(), then this function may be a null pointer.
576 int (*port_poll)(const struct ofproto *ofproto, char **devnamep);
578 /* Arranges for the poll loop to wake up when ->port_poll() will return a
579 * value other than EAGAIN.
581 * If the set of ports in a datapath is fixed, or if the only way that the
582 * set of ports in a datapath can change is through ->port_add() and
583 * ->port_del(), or if the poll loop will always wake up anyway when
584 * ->port_poll() will return a value other than EAGAIN, then this function
585 * may be a null pointer.
587 void (*port_poll_wait)(const struct ofproto *ofproto);
589 /* Checks the status of LACP negotiation for 'port'. Returns 1 if LACP
590 * partner information for 'port' is up-to-date, 0 if LACP partner
591 * information is not current (generally indicating a connectivity
592 * problem), or -1 if LACP is not enabled on 'port'.
594 * This function may be a null pointer if the ofproto implementation does
595 * not support LACP. */
596 int (*port_is_lacp_current)(const struct ofport *port);
598 /* ## ----------------------- ## */
599 /* ## OpenFlow Rule Functions ## */
600 /* ## ----------------------- ## */
604 /* Chooses an appropriate table for 'cls_rule' within 'ofproto'. On
605 * success, stores the table ID into '*table_idp' and returns 0. On
606 * failure, returns an OpenFlow error code (as returned by ofp_mkerr()).
608 * The choice of table should be a function of 'cls_rule' and 'ofproto''s
609 * datapath capabilities. It should not depend on the flows already in
610 * 'ofproto''s flow tables. Failure implies that an OpenFlow rule with
611 * 'cls_rule' as its matching condition can never be inserted into
612 * 'ofproto', even starting from an empty flow table.
614 * If multiple tables are candidates for inserting the flow, the function
615 * should choose one arbitrarily (but deterministically).
617 * If this function is NULL then table 0 is always chosen. */
618 int (*rule_choose_table)(const struct ofproto *ofproto,
619 const struct cls_rule *cls_rule,
622 /* Life-cycle functions for a "struct rule" (see "Life Cycle" above).
625 * Asynchronous Operation Support
626 * ==============================
628 * The life-cycle operations on rules can operate asynchronously, meaning
629 * that ->rule_construct() and ->rule_destruct() only need to initiate
630 * their respective operations and do not need to wait for them to complete
631 * before they return. ->rule_modify_actions() also operates
634 * An ofproto implementation reports the success or failure of an
635 * asynchronous operation on a rule using the rule's 'pending' member,
636 * which points to a opaque "struct ofoperation" that represents the
637 * ongoing opreation. When the operation completes, the ofproto
638 * implementation calls ofoperation_complete(), passing the ofoperation and
639 * an error indication.
641 * Only the following contexts may call ofoperation_complete():
643 * - The function called to initiate the operation,
644 * e.g. ->rule_construct() or ->rule_destruct(). This is the best
645 * choice if the operation completes quickly.
647 * - The implementation's ->run() function.
649 * - The implementation's ->destruct() function.
651 * The ofproto base code updates the flow table optimistically, assuming
652 * that the operation will probably succeed:
654 * - ofproto adds or replaces the rule in the flow table before calling
655 * ->rule_construct().
657 * - ofproto updates the rule's actions before calling
658 * ->rule_modify_actions().
660 * - ofproto removes the rule before calling ->rule_destruct().
662 * With one exception, when an asynchronous operation completes with an
663 * error, ofoperation_complete() backs out the already applied changes:
665 * - If adding or replacing a rule in the flow table fails, ofproto
666 * removes the new rule or restores the original rule.
668 * - If modifying a rule's actions fails, ofproto restores the original
671 * - Removing a rule is not allowed to fail. It must always succeed.
673 * The ofproto base code serializes operations: if any operation is in
674 * progress on a given rule, ofproto postpones initiating any new operation
675 * on that rule until the pending operation completes. Therefore, every
676 * operation must eventually complete through a call to
677 * ofoperation_complete() to avoid delaying new operations indefinitely
678 * (including any OpenFlow request that affects the rule in question, even
679 * just to query its statistics).
685 * When ->rule_construct() is called, the caller has already inserted
686 * 'rule' into 'rule->ofproto''s flow table numbered 'rule->table_id'.
687 * There are two cases:
689 * - 'rule' is a new rule in its flow table. In this case,
690 * ofoperation_get_victim(rule) returns NULL.
692 * - 'rule' is replacing an existing rule in its flow table that had the
693 * same matching criteria and priority. In this case,
694 * ofoperation_get_victim(rule) returns the rule being replaced (the
697 * ->rule_construct() should set the following in motion:
699 * - Validate that the matching rule in 'rule->cr' is supported by the
700 * datapath. For example, if the rule's table does not support
701 * registers, then it is an error if 'rule->cr' does not wildcard all
704 * - Validate that 'rule->actions' and 'rule->n_actions' are well-formed
705 * OpenFlow actions that the datapath can correctly implement. The
706 * validate_actions() function (in ofp-util.c) can be useful as a model
707 * for action validation, but it accepts all of the OpenFlow actions
708 * that OVS understands. If your ofproto implementation only
709 * implements a subset of those, then you should implement your own
712 * - If the rule is valid, update the datapath flow table, adding the new
713 * rule or replacing the existing one.
715 * - If 'rule' is replacing an existing rule, uninitialize any derived
716 * state for the victim rule, as in step 5 in the "Life Cycle"
719 * (On failure, the ofproto code will roll back the insertion from the flow
720 * table, either removing 'rule' or replacing it by the victim rule if
723 * ->rule_construct() must act in one of the following ways:
725 * - If it succeeds, it must call ofoperation_complete() and return 0.
727 * - If it fails, it must act in one of the following ways:
729 * * Call ofoperation_complete() and return 0.
731 * * Return an OpenFlow error code (as returned by ofp_mkerr()). (Do
732 * not call ofoperation_complete() in this case.)
734 * Either way, ->rule_destruct() will not be called for 'rule', but
735 * ->rule_dealloc() will be.
737 * - If the operation is only partially complete, then it must return 0.
738 * Later, when the operation is complete, the ->run() or ->destruct()
739 * function must call ofoperation_complete() to report success or
742 * ->rule_construct() should not modify any base members of struct rule.
748 * When ->rule_destruct() is called, the caller has already removed 'rule'
749 * from 'rule->ofproto''s flow table. ->rule_destruct() should set in
750 * motion removing 'rule' from the datapath flow table. If removal
751 * completes synchronously, it should call ofoperation_complete().
752 * Otherwise, the ->run() or ->destruct() function must later call
753 * ofoperation_complete() after the operation completes.
755 * Rule destruction must not fail. */
756 struct rule *(*rule_alloc)(void);
757 int (*rule_construct)(struct rule *rule);
758 void (*rule_destruct)(struct rule *rule);
759 void (*rule_dealloc)(struct rule *rule);
761 /* Obtains statistics for 'rule', storing the number of packets that have
762 * matched it in '*packet_count' and the number of bytes in those packets
763 * in '*byte_count'. UINT64_MAX indicates that the packet count or byte
764 * count is unknown. */
765 void (*rule_get_stats)(struct rule *rule, uint64_t *packet_count,
766 uint64_t *byte_count);
768 /* Applies the actions in 'rule' to 'packet'. (This implements sending
769 * buffered packets for OpenFlow OFPT_FLOW_MOD commands.)
771 * Takes ownership of 'packet' (so it should eventually free it, with
774 * 'flow' reflects the flow information for 'packet'. All of the
775 * information in 'flow' is extracted from 'packet', except for
776 * flow->tun_id and flow->in_port, which are assigned the correct values
777 * for the incoming packet. The register values are zeroed.
779 * The statistics for 'packet' should be included in 'rule'.
781 * Returns 0 if successful, otherwise an OpenFlow error code (as returned
782 * by ofp_mkerr()). */
783 int (*rule_execute)(struct rule *rule, struct flow *flow,
784 struct ofpbuf *packet);
786 /* When ->rule_modify_actions() is called, the caller has already replaced
787 * the OpenFlow actions in 'rule' by a new set. (The original actions are
788 * in rule->pending->actions.)
790 * ->rule_modify_actions() should set the following in motion:
792 * - Validate that the actions now in 'rule' are well-formed OpenFlow
793 * actions that the datapath can correctly implement.
795 * - Update the datapath flow table with the new actions.
797 * If the operation synchronously completes, ->rule_modify_actions() may
798 * call ofoperation_complete() before it returns. Otherwise, ->run()
799 * should call ofoperation_complete() later, after the operation does
802 * If the operation fails, then the base ofproto code will restore the
803 * original 'actions' and 'n_actions' of 'rule'.
805 * ->rule_modify_actions() should not modify any base members of struct
807 void (*rule_modify_actions)(struct rule *rule);
809 /* These functions implement the OpenFlow IP fragment handling policy. By
810 * default ('drop_frags' == false), an OpenFlow switch should treat IP
811 * fragments the same way as other packets (although TCP and UDP port
812 * numbers cannot be determined). With 'drop_frags' == true, the switch
813 * should drop all IP fragments without passing them through the flow
815 bool (*get_drop_frags)(struct ofproto *ofproto);
816 void (*set_drop_frags)(struct ofproto *ofproto, bool drop_frags);
818 /* Implements the OpenFlow OFPT_PACKET_OUT command. The datapath should
819 * execute the 'n_actions' in the 'actions' array on 'packet'.
821 * The caller retains ownership of 'packet', so ->packet_out() should not
824 * This function must validate that the 'n_actions' elements in 'actions'
825 * are well-formed OpenFlow actions that can be correctly implemented by
826 * the datapath. If not, then it should return an OpenFlow error code (as
827 * returned by ofp_mkerr()).
829 * 'flow' reflects the flow information for 'packet'. All of the
830 * information in 'flow' is extracted from 'packet', except for
831 * flow->in_port, which is taken from the OFPT_PACKET_OUT message.
832 * flow->tun_id and its register values are zeroed.
834 * 'packet' is not matched against the OpenFlow flow table, so its
835 * statistics should not be included in OpenFlow flow statistics.
837 * Returns 0 if successful, otherwise an OpenFlow error code (as returned
838 * by ofp_mkerr()). */
839 int (*packet_out)(struct ofproto *ofproto, struct ofpbuf *packet,
840 const struct flow *flow,
841 const union ofp_action *actions,
844 /* ## ------------------------- ## */
845 /* ## OFPP_NORMAL configuration ## */
846 /* ## ------------------------- ## */
848 /* Configures NetFlow on 'ofproto' according to the options in
849 * 'netflow_options', or turns off NetFlow if 'netflow_options' is NULL.
851 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
852 * NetFlow, as does a null pointer. */
853 int (*set_netflow)(struct ofproto *ofproto,
854 const struct netflow_options *netflow_options);
856 void (*get_netflow_ids)(const struct ofproto *ofproto,
857 uint8_t *engine_type, uint8_t *engine_id);
859 /* Configures sFlow on 'ofproto' according to the options in
860 * 'sflow_options', or turns off sFlow if 'sflow_options' is NULL.
862 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
863 * sFlow, as does a null pointer. */
864 int (*set_sflow)(struct ofproto *ofproto,
865 const struct ofproto_sflow_options *sflow_options);
867 /* Configures connectivity fault management on 'ofport'.
869 * If 'cfm_settings' is nonnull, configures CFM according to its members.
871 * If 'cfm_settings' is null, removes any connectivity fault management
872 * configuration from 'ofport'.
874 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
875 * support CFM, as does a null pointer. */
876 int (*set_cfm)(struct ofport *ofport, const struct cfm_settings *s);
878 /* Checks the fault status of CFM configured on 'ofport'. Returns 1 if CFM
879 * is faulted (generally indicating a connectivity problem), 0 if CFM is
880 * not faulted, or -1 if CFM is not enabled on 'port'
882 * This function may be a null pointer if the ofproto implementation does
883 * not support CFM. */
884 int (*get_cfm_fault)(const struct ofport *ofport);
886 /* Gets the MPIDs of the remote maintenance points broadcasting to
887 * 'ofport'. Populates 'rmps' with a provider owned array of MPIDs, and
888 * 'n_rmps' with the number of MPIDs in 'rmps'. Returns a number less than
889 * 0 if CFM is not enabled of 'ofport'.
891 * This function may be a null pointer if the ofproto implementation does
892 * not support CFM. */
893 int (*get_cfm_remote_mpids)(const struct ofport *ofport,
894 const uint64_t **rmps, size_t *n_rmps);
896 /* If 's' is nonnull, this function registers a "bundle" associated with
897 * client data pointer 'aux' in 'ofproto'. A bundle is the same concept as
898 * a Port in OVSDB, that is, it consists of one or more "slave" devices
899 * (Interfaces, in OVSDB) along with VLAN and LACP configuration and, if
900 * there is more than one slave, a bonding configuration. If 'aux' is
901 * already registered then this function updates its configuration to 's'.
902 * Otherwise, this function registers a new bundle.
904 * If 's' is NULL, this function unregisters the bundle registered on
905 * 'ofproto' associated with client data pointer 'aux'. If no such bundle
906 * has been registered, this has no effect.
908 * This function affects only the behavior of the NXAST_AUTOPATH action and
909 * output to the OFPP_NORMAL port. An implementation that does not support
910 * it at all may set it to NULL or return EOPNOTSUPP. An implementation
911 * that supports only a subset of the functionality should implement what
912 * it can and return 0. */
913 int (*bundle_set)(struct ofproto *ofproto, void *aux,
914 const struct ofproto_bundle_settings *s);
916 /* If 'port' is part of any bundle, removes it from that bundle. If the
917 * bundle now has no ports, deletes the bundle. If the bundle now has only
918 * one port, deconfigures the bundle's bonding configuration. */
919 void (*bundle_remove)(struct ofport *ofport);
921 /* If 's' is nonnull, this function registers a mirror associated with
922 * client data pointer 'aux' in 'ofproto'. A mirror is the same concept as
923 * a Mirror in OVSDB. If 'aux' is already registered then this function
924 * updates its configuration to 's'. Otherwise, this function registers a
927 * If 's' is NULL, this function unregisters the mirror registered on
928 * 'ofproto' associated with client data pointer 'aux'. If no such mirror
929 * has been registered, this has no effect.
931 * This function affects only the behavior of the OFPP_NORMAL action. An
932 * implementation that does not support it at all may set it to NULL or
933 * return EOPNOTSUPP. An implementation that supports only a subset of the
934 * functionality should implement what it can and return 0. */
935 int (*mirror_set)(struct ofproto *ofproto, void *aux,
936 const struct ofproto_mirror_settings *s);
938 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs
939 * on which all packets are flooded, instead of using MAC learning. If
940 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
942 * This function affects only the behavior of the OFPP_NORMAL action. An
943 * implementation that does not support it may set it to NULL or return
945 int (*set_flood_vlans)(struct ofproto *ofproto,
946 unsigned long *flood_vlans);
948 /* Returns true if 'aux' is a registered bundle that is currently in use as
949 * the output for a mirror. */
950 bool (*is_mirror_output_bundle)(struct ofproto *ofproto, void *aux);
952 /* When the configuration option of forward_bpdu changes, this function
953 * will be invoked. */
954 void (*forward_bpdu_changed)(struct ofproto *ofproto);
957 extern const struct ofproto_class ofproto_dpif_class;
959 int ofproto_class_register(const struct ofproto_class *);
960 int ofproto_class_unregister(const struct ofproto_class *);
962 /* ofproto_flow_mod() returns this value if the flow_mod could not be processed
963 * because it overlaps with an ongoing flow table operation that has not yet
964 * completed. The caller should retry the operation later.
966 * ofproto.c also uses this value internally for additional (similar) purposes.
968 * This particular value is a good choice because it is negative (so it won't
969 * collide with any errno value or any value returned by ofp_mkerr()) and large
970 * (so it won't accidentally collide with EOF or a negative errno value). */
971 enum { OFPROTO_POSTPONE = -100000 };
973 int ofproto_flow_mod(struct ofproto *, const struct ofputil_flow_mod *);
974 void ofproto_add_flow(struct ofproto *, const struct cls_rule *,
975 const union ofp_action *, size_t n_actions);
976 bool ofproto_delete_flow(struct ofproto *, const struct cls_rule *);
977 void ofproto_flush_flows(struct ofproto *);
979 #endif /* ofproto/ofproto-provider.h */