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 /* An OpenFlow switch.
31 * With few exceptions, ofproto implementations may look at these fields but
32 * should not modify them. */
34 const struct ofproto_class *ofproto_class;
35 char *type; /* Datapath type. */
36 char *name; /* Datapath name. */
37 struct hmap_node hmap_node; /* In global 'all_ofprotos' hmap. */
40 uint64_t fallback_dpid; /* Datapath ID if no better choice found. */
41 uint64_t datapath_id; /* Datapath ID. */
42 unsigned flow_eviction_threshold; /* Threshold at which to begin flow
43 * table eviction. Only affects the
44 * ofproto-dpif implementation */
45 bool forward_bpdu; /* Option to allow forwarding of BPDU frames
46 * when NORMAL action is invoked. */
47 char *mfr_desc; /* Manufacturer. */
48 char *hw_desc; /* Hardware. */
49 char *sw_desc; /* Software version. */
50 char *serial_desc; /* Serial number. */
51 char *dp_desc; /* Datapath description. */
54 struct hmap ports; /* Contains "struct ofport"s. */
55 struct shash port_by_name;
58 struct classifier *tables; /* Each classifier contains "struct rule"s. */
61 /* OpenFlow connections. */
62 struct connmgr *connmgr;
64 /* Flow table operation tracking. */
65 int state; /* Internal state. */
66 struct list pending; /* List of "struct ofopgroup"s. */
67 unsigned int n_pending; /* list_size(&pending). */
68 struct hmap deletions; /* All OFOPERATION_DELETE "ofoperation"s. */
71 struct ofproto *ofproto_lookup(const char *name);
72 struct ofport *ofproto_get_port(const struct ofproto *, uint16_t ofp_port);
74 /* Assigns CLS to each classifier table, in turn, in OFPROTO.
76 * All parameters are evaluated multiple times. */
77 #define OFPROTO_FOR_EACH_TABLE(CLS, OFPROTO) \
78 for ((CLS) = (OFPROTO)->tables; \
79 (CLS) < &(OFPROTO)->tables[(OFPROTO)->n_tables]; \
83 /* An OpenFlow port within a "struct ofproto".
85 * With few exceptions, ofproto implementations may look at these fields but
86 * should not modify them. */
88 struct ofproto *ofproto; /* The ofproto that contains this port. */
89 struct hmap_node hmap_node; /* In struct ofproto's "ports" hmap. */
90 struct netdev *netdev;
91 struct ofp_phy_port opp;
92 uint16_t ofp_port; /* OpenFlow port number. */
93 unsigned int change_seq;
96 /* An OpenFlow flow within a "struct ofproto".
98 * With few exceptions, ofproto implementations may look at these fields but
99 * should not modify them. */
101 struct ofproto *ofproto; /* The ofproto that contains this rule. */
102 struct list ofproto_node; /* Owned by ofproto base code. */
103 struct cls_rule cr; /* In owning ofproto's classifier. */
105 struct ofoperation *pending; /* Operation now in progress, if nonnull. */
107 ovs_be64 flow_cookie; /* Controller-issued identifier. */
109 long long int created; /* Creation time. */
110 uint16_t idle_timeout; /* In seconds from time of last use. */
111 uint16_t hard_timeout; /* In seconds from time of creation. */
112 uint8_t table_id; /* Index in ofproto's 'tables' array. */
113 bool send_flow_removed; /* Send a flow removed message? */
115 union ofp_action *actions; /* OpenFlow actions. */
116 int n_actions; /* Number of elements in actions[]. */
119 static inline struct rule *
120 rule_from_cls_rule(const struct cls_rule *cls_rule)
122 return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
125 void ofproto_rule_expire(struct rule *, uint8_t reason);
126 void ofproto_rule_destroy(struct rule *);
128 void ofoperation_complete(struct ofoperation *, int status);
129 struct rule *ofoperation_get_victim(struct ofoperation *);
131 /* ofproto class structure, to be defined by each ofproto implementation.
137 * These functions work primarily with three different kinds of data
140 * - "struct ofproto", which represents an OpenFlow switch.
142 * - "struct ofport", which represents a port within an ofproto.
144 * - "struct rule", which represents an OpenFlow flow within an ofproto.
146 * Each of these data structures contains all of the implementation-independent
147 * generic state for the respective concept, called the "base" state. None of
148 * them contains any extra space for ofproto implementations to use. Instead,
149 * each implementation is expected to declare its own data structure that
150 * contains an instance of the generic data structure plus additional
151 * implementation-specific members, called the "derived" state. The
152 * implementation can use casts or (preferably) the CONTAINER_OF macro to
153 * obtain access to derived state given only a pointer to the embedded generic
160 * Four stylized functions accompany each of these data structures:
162 * "alloc" "construct" "destruct" "dealloc"
163 * ------------ ---------------- --------------- --------------
164 * ofproto ->alloc ->construct ->destruct ->dealloc
165 * ofport ->port_alloc ->port_construct ->port_destruct ->port_dealloc
166 * rule ->rule_alloc ->rule_construct ->rule_destruct ->rule_dealloc
168 * Any instance of a given data structure goes through the following life
171 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
172 * fails, skip all the other steps.
174 * 2. The client initializes all of the data structure's base state. If this
175 * fails, skip to step 7.
177 * 3. The client calls the "construct" function. The implementation
178 * initializes derived state. It may refer to the already-initialized
179 * base state. If "construct" fails, skip to step 6.
181 * 4. The data structure is now initialized and in use.
183 * 5. When the data structure is no longer needed, the client calls the
184 * "destruct" function. The implementation uninitializes derived state.
185 * The base state has not been uninitialized yet, so the implementation
186 * may still refer to it.
188 * 6. The client uninitializes all of the data structure's base state.
190 * 7. The client calls the "dealloc" to free the raw memory. The
191 * implementation must not refer to base or derived state in the data
192 * structure, because it has already been uninitialized.
194 * Each "alloc" function allocates and returns a new instance of the respective
195 * data structure. The "alloc" function is not given any information about the
196 * use of the new data structure, so it cannot perform much initialization.
197 * Its purpose is just to ensure that the new data structure has enough room
198 * for base and derived state. It may return a null pointer if memory is not
199 * available, in which case none of the other functions is called.
201 * Each "construct" function initializes derived state in its respective data
202 * structure. When "construct" is called, all of the base state has already
203 * been initialized, so the "construct" function may refer to it. The
204 * "construct" function is allowed to fail, in which case the client calls the
205 * "dealloc" function (but not the "destruct" function).
207 * Each "destruct" function uninitializes and frees derived state in its
208 * respective data structure. When "destruct" is called, the base state has
209 * not yet been uninitialized, so the "destruct" function may refer to it. The
210 * "destruct" function is not allowed to fail.
212 * Each "dealloc" function frees raw memory that was allocated by the the
213 * "alloc" function. The memory's base and derived members might not have ever
214 * been initialized (but if "construct" returned successfully, then it has been
215 * "destruct"ed already). The "dealloc" function is not allowed to fail.
221 * Most of these functions return 0 if they are successful or a positive error
222 * code on failure. Depending on the function, valid error codes are either
223 * errno values or OpenFlow error codes constructed with ofp_mkerr().
225 * Most of these functions are expected to execute synchronously, that is, to
226 * block as necessary to obtain a result. Thus, these functions may return
227 * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
228 * explicitly say those errors are a possibility. We may relax this
229 * requirement in the future if and when we encounter performance problems. */
230 struct ofproto_class {
231 /* ## ----------------- ## */
232 /* ## Factory Functions ## */
233 /* ## ----------------- ## */
235 /* Enumerates the types of all support ofproto types into 'types'. The
236 * caller has already initialized 'types' and other ofproto classes might
237 * already have added names to it. */
238 void (*enumerate_types)(struct sset *types);
240 /* Enumerates the names of all existing datapath of the specified 'type'
241 * into 'names' 'all_dps'. The caller has already initialized 'names' as
244 * 'type' is one of the types enumerated by ->enumerate_types().
246 * Returns 0 if successful, otherwise a positive errno value.
248 int (*enumerate_names)(const char *type, struct sset *names);
250 /* Deletes the datapath with the specified 'type' and 'name'. The caller
251 * should have closed any open ofproto with this 'type' and 'name'; this
252 * function is allowed to fail if that is not the case.
254 * 'type' is one of the types enumerated by ->enumerate_types().
255 * 'name' is one of the names enumerated by ->enumerate_names() for 'type'.
257 * Returns 0 if successful, otherwise a positive errno value.
259 int (*del)(const char *type, const char *name);
261 /* ## --------------------------- ## */
262 /* ## Top-Level ofproto Functions ## */
263 /* ## --------------------------- ## */
265 /* Life-cycle functions for an "ofproto" (see "Life Cycle" above).
271 * ->construct() should not modify any base members of the ofproto. The
272 * client will initialize the ofproto's 'ports' and 'tables' members after
273 * construction is complete.
275 * When ->construct() is called, the client does not yet know how many flow
276 * tables the datapath supports, so ofproto->n_tables will be 0 and
277 * ofproto->tables will be NULL. ->construct() should store the number of
278 * flow tables supported by the datapath (between 1 and 255, inclusive)
279 * into '*n_tables'. After a successful return, the client will initialize
280 * the base 'n_tables' member to '*n_tables' and allocate and initialize
281 * the base 'tables' member as the specified number of empty flow tables.
282 * Each flow table will be initially empty, so ->construct() should delete
283 * flows from the underlying datapath, if necessary, rather than populating
286 * Only one ofproto instance needs to be supported for any given datapath.
287 * If a datapath is already open as part of one "ofproto", then another
288 * attempt to "construct" the same datapath as part of another ofproto is
289 * allowed to fail with an error.
291 * ->construct() returns 0 if successful, otherwise a positive errno
298 * If 'ofproto' has any pending asynchronous operations, ->destruct()
299 * must complete all of them by calling ofoperation_complete().
301 * ->destruct() must also destroy all remaining rules in the ofproto's
302 * tables, by passing each remaining rule to ofproto_rule_destroy(). The
303 * client will destroy the flow tables themselves after ->destruct()
306 struct ofproto *(*alloc)(void);
307 int (*construct)(struct ofproto *ofproto, int *n_tables);
308 void (*destruct)(struct ofproto *ofproto);
309 void (*dealloc)(struct ofproto *ofproto);
311 /* Performs any periodic activity required by 'ofproto'. It should:
313 * - Call connmgr_send_packet_in() for each received packet that missed
314 * in the OpenFlow flow table or that had a OFPP_CONTROLLER output
317 * - Call ofproto_rule_expire() for each OpenFlow flow that has reached
318 * its hard_timeout or idle_timeout, to expire the flow.
320 * Returns 0 if successful, otherwise a positive errno value. The ENODEV
321 * return value specifically means that the datapath underlying 'ofproto'
322 * has been destroyed (externally, e.g. by an admin running ovs-dpctl).
324 int (*run)(struct ofproto *ofproto);
326 /* Causes the poll loop to wake up when 'ofproto''s 'run' function needs to
327 * be called, e.g. by calling the timer or fd waiting functions in
329 void (*wait)(struct ofproto *ofproto);
331 /* Every "struct rule" in 'ofproto' is about to be deleted, one by one.
332 * This function may prepare for that, for example by clearing state in
333 * advance. It should *not* actually delete any "struct rule"s from
334 * 'ofproto', only prepare for it.
336 * This function is optional; it's really just for optimization in case
337 * it's cheaper to delete all the flows from your hardware in a single pass
338 * than to do it one by one. */
339 void (*flush)(struct ofproto *ofproto);
341 /* Helper for the OpenFlow OFPT_FEATURES_REQUEST request.
343 * The implementation should store true in '*arp_match_ip' if the switch
344 * supports matching IP addresses inside ARP requests and replies, false
347 * The implementation should store in '*actions' a bitmap of the supported
348 * OpenFlow actions: the bit with value (1 << n) should be set to 1 if the
349 * implementation supports the action with value 'n', and to 0 otherwise.
350 * For example, if the implementation supports the OFPAT_OUTPUT and
351 * OFPAT_ENQUEUE actions, but no others, it would set '*actions' to (1 <<
352 * OFPAT_OUTPUT) | (1 << OFPAT_ENQUEUE). Vendor actions are not included
354 void (*get_features)(struct ofproto *ofproto,
355 bool *arp_match_ip, uint32_t *actions);
357 /* Helper for the OpenFlow OFPST_TABLE statistics request.
359 * The 'ots' array contains 'ofproto->n_tables' elements. Each element is
362 * - 'table_id' to the array index.
364 * - 'name' to "table#" where # is the table ID.
366 * - 'wildcards' to OFPFW_ALL.
368 * - 'max_entries' to 1,000,000.
370 * - 'active_count' to the classifier_count() for the table.
372 * - 'lookup_count' and 'matched_count' to 0.
374 * The implementation should update any members in each element for which
375 * it has better values:
377 * - 'name' to a more meaningful name.
379 * - 'wildcards' to the set of wildcards actually supported by the table
380 * (if it doesn't support all OpenFlow wildcards).
382 * - 'max_entries' to the maximum number of flows actually supported by
385 * - 'lookup_count' to the number of packets looked up in this flow table
388 * - 'matched_count' to the number of packets looked up in this flow
389 * table so far that matched one of the flow entries.
391 * Keep in mind that all of the members of struct ofp_table_stats are in
392 * network byte order.
394 void (*get_tables)(struct ofproto *ofproto, struct ofp_table_stats *ots);
396 /* ## ---------------- ## */
397 /* ## ofport Functions ## */
398 /* ## ---------------- ## */
400 /* Life-cycle functions for a "struct ofport" (see "Life Cycle" above).
402 * ->port_construct() should not modify any base members of the ofport.
404 * ofports are managed by the base ofproto code. The ofproto
405 * implementation should only create and destroy them in response to calls
406 * to these functions. The base ofproto code will create and destroy
407 * ofports in the following situations:
409 * - Just after the ->construct() function is called, the base ofproto
410 * iterates over all of the implementation's ports, using
411 * ->port_dump_start() and related functions, and constructs an ofport
412 * for each dumped port.
414 * - If ->port_poll() reports that a specific port has changed, then the
415 * base ofproto will query that port with ->port_query_by_name() and
416 * construct or destruct ofports as necessary to reflect the updated
419 * - If ->port_poll() returns ENOBUFS to report an unspecified port set
420 * change, then the base ofproto will iterate over all of the
421 * implementation's ports, in the same way as at ofproto
422 * initialization, and construct and destruct ofports to reflect all of
425 * ->port_construct() returns 0 if successful, otherwise a positive errno
428 struct ofport *(*port_alloc)(void);
429 int (*port_construct)(struct ofport *ofport);
430 void (*port_destruct)(struct ofport *ofport);
431 void (*port_dealloc)(struct ofport *ofport);
433 /* Called after 'ofport->netdev' is replaced by a new netdev object. If
434 * the ofproto implementation uses the ofport's netdev internally, then it
435 * should switch to using the new one. The old one has been closed.
437 * An ofproto implementation that doesn't need to do anything in this
438 * function may use a null pointer. */
439 void (*port_modified)(struct ofport *ofport);
441 /* Called after an OpenFlow OFPT_PORT_MOD request changes a port's
442 * configuration. 'ofport->opp.config' contains the new configuration.
443 * 'old_config' contains the previous configuration.
445 * The caller implements OFPPC_PORT_DOWN using netdev functions to turn
446 * NETDEV_UP on and off, so this function doesn't have to do anything for
447 * that bit (and it won't be called if that is the only bit that
449 void (*port_reconfigured)(struct ofport *ofport, ovs_be32 old_config);
451 /* Looks up a port named 'devname' in 'ofproto'. On success, initializes
452 * '*port' appropriately.
454 * The caller owns the data in 'port' and must free it with
455 * ofproto_port_destroy() when it is no longer needed. */
456 int (*port_query_by_name)(const struct ofproto *ofproto,
457 const char *devname, struct ofproto_port *port);
459 /* Attempts to add 'netdev' as a port on 'ofproto'. Returns 0 if
460 * successful, otherwise a positive errno value. If successful, sets
461 * '*ofp_portp' to the new port's port number.
463 * It doesn't matter whether the new port will be returned by a later call
464 * to ->port_poll(); the implementation may do whatever is more
466 int (*port_add)(struct ofproto *ofproto, struct netdev *netdev,
467 uint16_t *ofp_portp);
469 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'. Returns
470 * 0 if successful, otherwise a positive errno value.
472 * It doesn't matter whether the new port will be returned by a later call
473 * to ->port_poll(); the implementation may do whatever is more
475 int (*port_del)(struct ofproto *ofproto, uint16_t ofp_port);
477 /* Port iteration functions.
479 * The client might not be entirely in control of the ports within an
480 * ofproto. Some hardware implementations, for example, might have a fixed
481 * set of ports in a datapath, and the Linux datapath allows the system
482 * administrator to externally add and remove ports with ovs-dpctl. For
483 * this reason, the client needs a way to iterate through all the ports
484 * that are actually in a datapath. These functions provide that
487 * The 'state' pointer provides the implementation a place to
488 * keep track of its position. Its format is opaque to the caller.
490 * The ofproto provider retains ownership of the data that it stores into
491 * ->port_dump_next()'s 'port' argument. The data must remain valid until
492 * at least the next call to ->port_dump_next() or ->port_dump_done() for
493 * 'state'. The caller will not modify or free it.
498 * ->port_dump_start() attempts to begin dumping the ports in 'ofproto'.
499 * On success, it should return 0 and initialize '*statep' with any data
500 * needed for iteration. On failure, returns a positive errno value, and
501 * the client will not call ->port_dump_next() or ->port_dump_done().
503 * ->port_dump_next() attempts to retrieve another port from 'ofproto' for
504 * 'state'. If there is another port, it should store the port's
505 * information into 'port' and return 0. It should return EOF if all ports
506 * have already been iterated. Otherwise, on error, it should return a
507 * positive errno value. This function will not be called again once it
508 * returns nonzero once for a given iteration (but the 'port_dump_done'
509 * function will be called afterward).
511 * ->port_dump_done() allows the implementation to release resources used
512 * for iteration. The caller might decide to stop iteration in the middle
513 * by calling this function before ->port_dump_next() returns nonzero.
521 * error = ofproto->ofproto_class->port_dump_start(ofproto, &state);
524 * struct ofproto_port port;
526 * error = ofproto->ofproto_class->port_dump_next(
527 * ofproto, state, &port);
531 * // Do something with 'port' here (without modifying or freeing
532 * // any of its data).
534 * ofproto->ofproto_class->port_dump_done(ofproto, state);
536 * // 'error' is now EOF (success) or a positive errno value (failure).
538 int (*port_dump_start)(const struct ofproto *ofproto, void **statep);
539 int (*port_dump_next)(const struct ofproto *ofproto, void *state,
540 struct ofproto_port *port);
541 int (*port_dump_done)(const struct ofproto *ofproto, void *state);
543 /* Polls for changes in the set of ports in 'ofproto'. If the set of ports
544 * in 'ofproto' has changed, then this function should do one of the
547 * - Preferably: store the name of the device that was added to or deleted
548 * from 'ofproto' in '*devnamep' and return 0. The caller is responsible
549 * for freeing '*devnamep' (with free()) when it no longer needs it.
551 * - Alternatively: return ENOBUFS, without indicating the device that was
554 * Occasional 'false positives', in which the function returns 0 while
555 * indicating a device that was not actually added or deleted or returns
556 * ENOBUFS without any change, are acceptable.
558 * The purpose of 'port_poll' is to let 'ofproto' know about changes made
559 * externally to the 'ofproto' object, e.g. by a system administrator via
560 * ovs-dpctl. Therefore, it's OK, and even preferable, for port_poll() to
561 * not report changes made through calls to 'port_add' or 'port_del' on the
562 * same 'ofproto' object. (But it's OK for it to report them too, just
563 * slightly less efficient.)
565 * If the set of ports in 'ofproto' has not changed, returns EAGAIN. May
566 * also return other positive errno values to indicate that something has
569 * If the set of ports in a datapath is fixed, or if the only way that the
570 * set of ports in a datapath can change is through ->port_add() and
571 * ->port_del(), then this function may be a null pointer.
573 int (*port_poll)(const struct ofproto *ofproto, char **devnamep);
575 /* Arranges for the poll loop to wake up when ->port_poll() will return a
576 * value other than EAGAIN.
578 * If the set of ports in a datapath is fixed, or if the only way that the
579 * set of ports in a datapath can change is through ->port_add() and
580 * ->port_del(), or if the poll loop will always wake up anyway when
581 * ->port_poll() will return a value other than EAGAIN, then this function
582 * may be a null pointer.
584 void (*port_poll_wait)(const struct ofproto *ofproto);
586 /* Checks the status of LACP negotiation for 'port'. Returns 1 if LACP
587 * partner information for 'port' is up-to-date, 0 if LACP partner
588 * information is not current (generally indicating a connectivity
589 * problem), or -1 if LACP is not enabled on 'port'.
591 * This function may be a null pointer if the ofproto implementation does
592 * not support LACP. */
593 int (*port_is_lacp_current)(const struct ofport *port);
595 /* ## ----------------------- ## */
596 /* ## OpenFlow Rule Functions ## */
597 /* ## ----------------------- ## */
601 /* Chooses an appropriate table for 'cls_rule' within 'ofproto'. On
602 * success, stores the table ID into '*table_idp' and returns 0. On
603 * failure, returns an OpenFlow error code (as returned by ofp_mkerr()).
605 * The choice of table should be a function of 'cls_rule' and 'ofproto''s
606 * datapath capabilities. It should not depend on the flows already in
607 * 'ofproto''s flow tables. Failure implies that an OpenFlow rule with
608 * 'cls_rule' as its matching condition can never be inserted into
609 * 'ofproto', even starting from an empty flow table.
611 * If multiple tables are candidates for inserting the flow, the function
612 * should choose one arbitrarily (but deterministically).
614 * If this function is NULL then table 0 is always chosen. */
615 int (*rule_choose_table)(const struct ofproto *ofproto,
616 const struct cls_rule *cls_rule,
619 /* Life-cycle functions for a "struct rule" (see "Life Cycle" above).
622 * Asynchronous Operation Support
623 * ==============================
625 * The life-cycle operations on rules can operate asynchronously, meaning
626 * that ->rule_construct() and ->rule_destruct() only need to initiate
627 * their respective operations and do not need to wait for them to complete
628 * before they return. ->rule_modify_actions() also operates
631 * An ofproto implementation reports the success or failure of an
632 * asynchronous operation on a rule using the rule's 'pending' member,
633 * which points to a opaque "struct ofoperation" that represents the
634 * ongoing opreation. When the operation completes, the ofproto
635 * implementation calls ofoperation_complete(), passing the ofoperation and
636 * an error indication.
638 * Only the following contexts may call ofoperation_complete():
640 * - The function called to initiate the operation,
641 * e.g. ->rule_construct() or ->rule_destruct(). This is the best
642 * choice if the operation completes quickly.
644 * - The implementation's ->run() function.
646 * - The implementation's ->destruct() function.
648 * The ofproto base code updates the flow table optimistically, assuming
649 * that the operation will probably succeed:
651 * - ofproto adds or replaces the rule in the flow table before calling
652 * ->rule_construct().
654 * - ofproto updates the rule's actions before calling
655 * ->rule_modify_actions().
657 * - ofproto removes the rule before calling ->rule_destruct().
659 * With one exception, when an asynchronous operation completes with an
660 * error, ofoperation_complete() backs out the already applied changes:
662 * - If adding or replacing a rule in the flow table fails, ofproto
663 * removes the new rule or restores the original rule.
665 * - If modifying a rule's actions fails, ofproto restores the original
668 * - Removing a rule is not allowed to fail. It must always succeed.
670 * The ofproto base code serializes operations: if any operation is in
671 * progress on a given rule, ofproto postpones initiating any new operation
672 * on that rule until the pending operation completes. Therefore, every
673 * operation must eventually complete through a call to
674 * ofoperation_complete() to avoid delaying new operations indefinitely
675 * (including any OpenFlow request that affects the rule in question, even
676 * just to query its statistics).
682 * When ->rule_construct() is called, the caller has already inserted
683 * 'rule' into 'rule->ofproto''s flow table numbered 'rule->table_id'.
684 * There are two cases:
686 * - 'rule' is a new rule in its flow table. In this case,
687 * ofoperation_get_victim(rule) returns NULL.
689 * - 'rule' is replacing an existing rule in its flow table that had the
690 * same matching criteria and priority. In this case,
691 * ofoperation_get_victim(rule) returns the rule being replaced (the
694 * ->rule_construct() should set the following in motion:
696 * - Validate that the matching rule in 'rule->cr' is supported by the
697 * datapath. For example, if the rule's table does not support
698 * registers, then it is an error if 'rule->cr' does not wildcard all
701 * - Validate that 'rule->actions' and 'rule->n_actions' are well-formed
702 * OpenFlow actions that the datapath can correctly implement. The
703 * validate_actions() function (in ofp-util.c) can be useful as a model
704 * for action validation, but it accepts all of the OpenFlow actions
705 * that OVS understands. If your ofproto implementation only
706 * implements a subset of those, then you should implement your own
709 * - If the rule is valid, update the datapath flow table, adding the new
710 * rule or replacing the existing one.
712 * - If 'rule' is replacing an existing rule, uninitialize any derived
713 * state for the victim rule, as in step 5 in the "Life Cycle"
716 * (On failure, the ofproto code will roll back the insertion from the flow
717 * table, either removing 'rule' or replacing it by the victim rule if
720 * ->rule_construct() must act in one of the following ways:
722 * - If it succeeds, it must call ofoperation_complete() and return 0.
724 * - If it fails, it must act in one of the following ways:
726 * * Call ofoperation_complete() and return 0.
728 * * Return an OpenFlow error code (as returned by ofp_mkerr()). (Do
729 * not call ofoperation_complete() in this case.)
731 * Either way, ->rule_destruct() will not be called for 'rule', but
732 * ->rule_dealloc() will be.
734 * - If the operation is only partially complete, then it must return 0.
735 * Later, when the operation is complete, the ->run() or ->destruct()
736 * function must call ofoperation_complete() to report success or
739 * ->rule_construct() should not modify any base members of struct rule.
745 * When ->rule_destruct() is called, the caller has already removed 'rule'
746 * from 'rule->ofproto''s flow table. ->rule_destruct() should set in
747 * motion removing 'rule' from the datapath flow table. If removal
748 * completes synchronously, it should call ofoperation_complete().
749 * Otherwise, the ->run() or ->destruct() function must later call
750 * ofoperation_complete() after the operation completes.
752 * Rule destruction must not fail. */
753 struct rule *(*rule_alloc)(void);
754 int (*rule_construct)(struct rule *rule);
755 void (*rule_destruct)(struct rule *rule);
756 void (*rule_dealloc)(struct rule *rule);
758 /* Obtains statistics for 'rule', storing the number of packets that have
759 * matched it in '*packet_count' and the number of bytes in those packets
760 * in '*byte_count'. UINT64_MAX indicates that the packet count or byte
761 * count is unknown. */
762 void (*rule_get_stats)(struct rule *rule, uint64_t *packet_count,
763 uint64_t *byte_count);
765 /* Applies the actions in 'rule' to 'packet'. (This implements sending
766 * buffered packets for OpenFlow OFPT_FLOW_MOD commands.)
768 * Takes ownership of 'packet' (so it should eventually free it, with
771 * 'flow' reflects the flow information for 'packet'. All of the
772 * information in 'flow' is extracted from 'packet', except for
773 * flow->tun_id and flow->in_port, which are assigned the correct values
774 * for the incoming packet. The register values are zeroed.
776 * The statistics for 'packet' should be included in 'rule'.
778 * Returns 0 if successful, otherwise an OpenFlow error code (as returned
779 * by ofp_mkerr()). */
780 int (*rule_execute)(struct rule *rule, struct flow *flow,
781 struct ofpbuf *packet);
783 /* When ->rule_modify_actions() is called, the caller has already replaced
784 * the OpenFlow actions in 'rule' by a new set. (The original actions are
785 * in rule->pending->actions.)
787 * ->rule_modify_actions() should set the following in motion:
789 * - Validate that the actions now in 'rule' are well-formed OpenFlow
790 * actions that the datapath can correctly implement.
792 * - Update the datapath flow table with the new actions.
794 * If the operation synchronously completes, ->rule_modify_actions() may
795 * call ofoperation_complete() before it returns. Otherwise, ->run()
796 * should call ofoperation_complete() later, after the operation does
799 * If the operation fails, then the base ofproto code will restore the
800 * original 'actions' and 'n_actions' of 'rule'.
802 * ->rule_modify_actions() should not modify any base members of struct
804 void (*rule_modify_actions)(struct rule *rule);
806 /* These functions implement the OpenFlow IP fragment handling policy. By
807 * default ('drop_frags' == false), an OpenFlow switch should treat IP
808 * fragments the same way as other packets (although TCP and UDP port
809 * numbers cannot be determined). With 'drop_frags' == true, the switch
810 * should drop all IP fragments without passing them through the flow
812 bool (*get_drop_frags)(struct ofproto *ofproto);
813 void (*set_drop_frags)(struct ofproto *ofproto, bool drop_frags);
815 /* Implements the OpenFlow OFPT_PACKET_OUT command. The datapath should
816 * execute the 'n_actions' in the 'actions' array on 'packet'.
818 * The caller retains ownership of 'packet', so ->packet_out() should not
821 * This function must validate that the 'n_actions' elements in 'actions'
822 * are well-formed OpenFlow actions that can be correctly implemented by
823 * the datapath. If not, then it should return an OpenFlow error code (as
824 * returned by ofp_mkerr()).
826 * 'flow' reflects the flow information for 'packet'. All of the
827 * information in 'flow' is extracted from 'packet', except for
828 * flow->in_port, which is taken from the OFPT_PACKET_OUT message.
829 * flow->tun_id and its register values are zeroed.
831 * 'packet' is not matched against the OpenFlow flow table, so its
832 * statistics should not be included in OpenFlow flow statistics.
834 * Returns 0 if successful, otherwise an OpenFlow error code (as returned
835 * by ofp_mkerr()). */
836 int (*packet_out)(struct ofproto *ofproto, struct ofpbuf *packet,
837 const struct flow *flow,
838 const union ofp_action *actions,
841 /* ## ------------------------- ## */
842 /* ## OFPP_NORMAL configuration ## */
843 /* ## ------------------------- ## */
845 /* Configures NetFlow on 'ofproto' according to the options in
846 * 'netflow_options', or turns off NetFlow if 'netflow_options' is NULL.
848 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
849 * NetFlow, as does a null pointer. */
850 int (*set_netflow)(struct ofproto *ofproto,
851 const struct netflow_options *netflow_options);
853 void (*get_netflow_ids)(const struct ofproto *ofproto,
854 uint8_t *engine_type, uint8_t *engine_id);
856 /* Configures sFlow on 'ofproto' according to the options in
857 * 'sflow_options', or turns off sFlow if 'sflow_options' is NULL.
859 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
860 * sFlow, as does a null pointer. */
861 int (*set_sflow)(struct ofproto *ofproto,
862 const struct ofproto_sflow_options *sflow_options);
864 /* Configures connectivity fault management on 'ofport'.
866 * If 'cfm_settings' is nonnull, configures CFM according to its members.
868 * If 'cfm_settings' is null, removes any connectivity fault management
869 * configuration from 'ofport'.
871 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
872 * support CFM, as does a null pointer. */
873 int (*set_cfm)(struct ofport *ofport, const struct cfm_settings *s);
875 /* Checks the fault status of CFM configured on 'ofport'. Returns 1 if CFM
876 * is faulted (generally indicating a connectivity problem), 0 if CFM is
877 * not faulted, or -1 if CFM is not enabled on 'port'
879 * This function may be a null pointer if the ofproto implementation does
880 * not support CFM. */
881 int (*get_cfm_fault)(const struct ofport *ofport);
883 /* Gets the MPIDs of the remote maintenance points broadcasting to
884 * 'ofport'. Populates 'rmps' with a provider owned array of MPIDs, and
885 * 'n_rmps' with the number of MPIDs in 'rmps'. Returns a number less than
886 * 0 if CFM is not enabled of 'ofport'.
888 * This function may be a null pointer if the ofproto implementation does
889 * not support CFM. */
890 int (*get_cfm_remote_mpids)(const struct ofport *ofport,
891 const uint64_t **rmps, size_t *n_rmps);
893 /* If 's' is nonnull, this function registers a "bundle" associated with
894 * client data pointer 'aux' in 'ofproto'. A bundle is the same concept as
895 * a Port in OVSDB, that is, it consists of one or more "slave" devices
896 * (Interfaces, in OVSDB) along with VLAN and LACP configuration and, if
897 * there is more than one slave, a bonding configuration. If 'aux' is
898 * already registered then this function updates its configuration to 's'.
899 * Otherwise, this function registers a new bundle.
901 * If 's' is NULL, this function unregisters the bundle registered on
902 * 'ofproto' associated with client data pointer 'aux'. If no such bundle
903 * has been registered, this has no effect.
905 * This function affects only the behavior of the NXAST_AUTOPATH action and
906 * output to the OFPP_NORMAL port. An implementation that does not support
907 * it at all may set it to NULL or return EOPNOTSUPP. An implementation
908 * that supports only a subset of the functionality should implement what
909 * it can and return 0. */
910 int (*bundle_set)(struct ofproto *ofproto, void *aux,
911 const struct ofproto_bundle_settings *s);
913 /* If 'port' is part of any bundle, removes it from that bundle. If the
914 * bundle now has no ports, deletes the bundle. If the bundle now has only
915 * one port, deconfigures the bundle's bonding configuration. */
916 void (*bundle_remove)(struct ofport *ofport);
918 /* If 's' is nonnull, this function registers a mirror associated with
919 * client data pointer 'aux' in 'ofproto'. A mirror is the same concept as
920 * a Mirror in OVSDB. If 'aux' is already registered then this function
921 * updates its configuration to 's'. Otherwise, this function registers a
924 * If 's' is NULL, this function unregisters the mirror registered on
925 * 'ofproto' associated with client data pointer 'aux'. If no such mirror
926 * has been registered, this has no effect.
928 * This function affects only the behavior of the OFPP_NORMAL action. An
929 * implementation that does not support it at all may set it to NULL or
930 * return EOPNOTSUPP. An implementation that supports only a subset of the
931 * functionality should implement what it can and return 0. */
932 int (*mirror_set)(struct ofproto *ofproto, void *aux,
933 const struct ofproto_mirror_settings *s);
935 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs
936 * on which all packets are flooded, instead of using MAC learning. If
937 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
939 * This function affects only the behavior of the OFPP_NORMAL action. An
940 * implementation that does not support it may set it to NULL or return
942 int (*set_flood_vlans)(struct ofproto *ofproto,
943 unsigned long *flood_vlans);
945 /* Returns true if 'aux' is a registered bundle that is currently in use as
946 * the output for a mirror. */
947 bool (*is_mirror_output_bundle)(struct ofproto *ofproto, void *aux);
949 /* When the configuration option of forward_bpdu changes, this function
950 * will be invoked. */
951 void (*forward_bpdu_changed)(struct ofproto *ofproto);
954 extern const struct ofproto_class ofproto_dpif_class;
956 int ofproto_class_register(const struct ofproto_class *);
957 int ofproto_class_unregister(const struct ofproto_class *);
959 void ofproto_add_flow(struct ofproto *, const struct cls_rule *,
960 const union ofp_action *, size_t n_actions);
961 bool ofproto_delete_flow(struct ofproto *, const struct cls_rule *);
962 void ofproto_flush_flows(struct ofproto *);
964 #endif /* ofproto/ofproto-provider.h */