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 long long int modified; /* Time of last modification. */
111 uint16_t idle_timeout; /* In seconds from time of last use. */
112 uint16_t hard_timeout; /* In seconds from last modification. */
113 uint8_t table_id; /* Index in ofproto's 'tables' array. */
114 bool send_flow_removed; /* Send a flow removed message? */
116 union ofp_action *actions; /* OpenFlow actions. */
117 int n_actions; /* Number of elements in actions[]. */
120 static inline struct rule *
121 rule_from_cls_rule(const struct cls_rule *cls_rule)
123 return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
126 void ofproto_rule_expire(struct rule *, uint8_t reason);
127 void ofproto_rule_destroy(struct rule *);
129 void ofoperation_complete(struct ofoperation *, int status);
130 struct rule *ofoperation_get_victim(struct ofoperation *);
132 /* ofproto class structure, to be defined by each ofproto implementation.
138 * These functions work primarily with three different kinds of data
141 * - "struct ofproto", which represents an OpenFlow switch.
143 * - "struct ofport", which represents a port within an ofproto.
145 * - "struct rule", which represents an OpenFlow flow within an ofproto.
147 * Each of these data structures contains all of the implementation-independent
148 * generic state for the respective concept, called the "base" state. None of
149 * them contains any extra space for ofproto implementations to use. Instead,
150 * each implementation is expected to declare its own data structure that
151 * contains an instance of the generic data structure plus additional
152 * implementation-specific members, called the "derived" state. The
153 * implementation can use casts or (preferably) the CONTAINER_OF macro to
154 * obtain access to derived state given only a pointer to the embedded generic
161 * Four stylized functions accompany each of these data structures:
163 * "alloc" "construct" "destruct" "dealloc"
164 * ------------ ---------------- --------------- --------------
165 * ofproto ->alloc ->construct ->destruct ->dealloc
166 * ofport ->port_alloc ->port_construct ->port_destruct ->port_dealloc
167 * rule ->rule_alloc ->rule_construct ->rule_destruct ->rule_dealloc
169 * Any instance of a given data structure goes through the following life
172 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
173 * fails, skip all the other steps.
175 * 2. The client initializes all of the data structure's base state. If this
176 * fails, skip to step 7.
178 * 3. The client calls the "construct" function. The implementation
179 * initializes derived state. It may refer to the already-initialized
180 * base state. If "construct" fails, skip to step 6.
182 * 4. The data structure is now initialized and in use.
184 * 5. When the data structure is no longer needed, the client calls the
185 * "destruct" function. The implementation uninitializes derived state.
186 * The base state has not been uninitialized yet, so the implementation
187 * may still refer to it.
189 * 6. The client uninitializes all of the data structure's base state.
191 * 7. The client calls the "dealloc" to free the raw memory. The
192 * implementation must not refer to base or derived state in the data
193 * structure, because it has already been uninitialized.
195 * Each "alloc" function allocates and returns a new instance of the respective
196 * data structure. The "alloc" function is not given any information about the
197 * use of the new data structure, so it cannot perform much initialization.
198 * Its purpose is just to ensure that the new data structure has enough room
199 * for base and derived state. It may return a null pointer if memory is not
200 * available, in which case none of the other functions is called.
202 * Each "construct" function initializes derived state in its respective data
203 * structure. When "construct" is called, all of the base state has already
204 * been initialized, so the "construct" function may refer to it. The
205 * "construct" function is allowed to fail, in which case the client calls the
206 * "dealloc" function (but not the "destruct" function).
208 * Each "destruct" function uninitializes and frees derived state in its
209 * respective data structure. When "destruct" is called, the base state has
210 * not yet been uninitialized, so the "destruct" function may refer to it. The
211 * "destruct" function is not allowed to fail.
213 * Each "dealloc" function frees raw memory that was allocated by the the
214 * "alloc" function. The memory's base and derived members might not have ever
215 * been initialized (but if "construct" returned successfully, then it has been
216 * "destruct"ed already). The "dealloc" function is not allowed to fail.
222 * Most of these functions return 0 if they are successful or a positive error
223 * code on failure. Depending on the function, valid error codes are either
224 * errno values or OpenFlow error codes constructed with ofp_mkerr().
226 * Most of these functions are expected to execute synchronously, that is, to
227 * block as necessary to obtain a result. Thus, these functions may return
228 * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
229 * explicitly say those errors are a possibility. We may relax this
230 * requirement in the future if and when we encounter performance problems. */
231 struct ofproto_class {
232 /* ## ----------------- ## */
233 /* ## Factory Functions ## */
234 /* ## ----------------- ## */
236 /* Enumerates the types of all support ofproto types into 'types'. The
237 * caller has already initialized 'types' and other ofproto classes might
238 * already have added names to it. */
239 void (*enumerate_types)(struct sset *types);
241 /* Enumerates the names of all existing datapath of the specified 'type'
242 * into 'names' 'all_dps'. The caller has already initialized 'names' as
245 * 'type' is one of the types enumerated by ->enumerate_types().
247 * Returns 0 if successful, otherwise a positive errno value.
249 int (*enumerate_names)(const char *type, struct sset *names);
251 /* Deletes the datapath with the specified 'type' and 'name'. The caller
252 * should have closed any open ofproto with this 'type' and 'name'; this
253 * function is allowed to fail if that is not the case.
255 * 'type' is one of the types enumerated by ->enumerate_types().
256 * 'name' is one of the names enumerated by ->enumerate_names() for 'type'.
258 * Returns 0 if successful, otherwise a positive errno value.
260 int (*del)(const char *type, const char *name);
262 /* ## --------------------------- ## */
263 /* ## Top-Level ofproto Functions ## */
264 /* ## --------------------------- ## */
266 /* Life-cycle functions for an "ofproto" (see "Life Cycle" above).
272 * ->construct() should not modify any base members of the ofproto. The
273 * client will initialize the ofproto's 'ports' and 'tables' members after
274 * construction is complete.
276 * When ->construct() is called, the client does not yet know how many flow
277 * tables the datapath supports, so ofproto->n_tables will be 0 and
278 * ofproto->tables will be NULL. ->construct() should store the number of
279 * flow tables supported by the datapath (between 1 and 255, inclusive)
280 * into '*n_tables'. After a successful return, the client will initialize
281 * the base 'n_tables' member to '*n_tables' and allocate and initialize
282 * the base 'tables' member as the specified number of empty flow tables.
283 * Each flow table will be initially empty, so ->construct() should delete
284 * flows from the underlying datapath, if necessary, rather than populating
287 * Only one ofproto instance needs to be supported for any given datapath.
288 * If a datapath is already open as part of one "ofproto", then another
289 * attempt to "construct" the same datapath as part of another ofproto is
290 * allowed to fail with an error.
292 * ->construct() returns 0 if successful, otherwise a positive errno
299 * If 'ofproto' has any pending asynchronous operations, ->destruct()
300 * must complete all of them by calling ofoperation_complete().
302 * ->destruct() must also destroy all remaining rules in the ofproto's
303 * tables, by passing each remaining rule to ofproto_rule_destroy(). The
304 * client will destroy the flow tables themselves after ->destruct()
307 struct ofproto *(*alloc)(void);
308 int (*construct)(struct ofproto *ofproto, int *n_tables);
309 void (*destruct)(struct ofproto *ofproto);
310 void (*dealloc)(struct ofproto *ofproto);
312 /* Performs any periodic activity required by 'ofproto'. It should:
314 * - Call connmgr_send_packet_in() for each received packet that missed
315 * in the OpenFlow flow table or that had a OFPP_CONTROLLER output
318 * - Call ofproto_rule_expire() for each OpenFlow flow that has reached
319 * its hard_timeout or idle_timeout, to expire the flow.
321 * Returns 0 if successful, otherwise a positive errno value. The ENODEV
322 * return value specifically means that the datapath underlying 'ofproto'
323 * has been destroyed (externally, e.g. by an admin running ovs-dpctl).
325 int (*run)(struct ofproto *ofproto);
327 /* Causes the poll loop to wake up when 'ofproto''s 'run' function needs to
328 * be called, e.g. by calling the timer or fd waiting functions in
330 void (*wait)(struct ofproto *ofproto);
332 /* Every "struct rule" in 'ofproto' is about to be deleted, one by one.
333 * This function may prepare for that, for example by clearing state in
334 * advance. It should *not* actually delete any "struct rule"s from
335 * 'ofproto', only prepare for it.
337 * This function is optional; it's really just for optimization in case
338 * it's cheaper to delete all the flows from your hardware in a single pass
339 * than to do it one by one. */
340 void (*flush)(struct ofproto *ofproto);
342 /* Helper for the OpenFlow OFPT_FEATURES_REQUEST request.
344 * The implementation should store true in '*arp_match_ip' if the switch
345 * supports matching IP addresses inside ARP requests and replies, false
348 * The implementation should store in '*actions' a bitmap of the supported
349 * OpenFlow actions: the bit with value (1 << n) should be set to 1 if the
350 * implementation supports the action with value 'n', and to 0 otherwise.
351 * For example, if the implementation supports the OFPAT_OUTPUT and
352 * OFPAT_ENQUEUE actions, but no others, it would set '*actions' to (1 <<
353 * OFPAT_OUTPUT) | (1 << OFPAT_ENQUEUE). Vendor actions are not included
355 void (*get_features)(struct ofproto *ofproto,
356 bool *arp_match_ip, uint32_t *actions);
358 /* Helper for the OpenFlow OFPST_TABLE statistics request.
360 * The 'ots' array contains 'ofproto->n_tables' elements. Each element is
363 * - 'table_id' to the array index.
365 * - 'name' to "table#" where # is the table ID.
367 * - 'wildcards' to OFPFW_ALL.
369 * - 'max_entries' to 1,000,000.
371 * - 'active_count' to the classifier_count() for the table.
373 * - 'lookup_count' and 'matched_count' to 0.
375 * The implementation should update any members in each element for which
376 * it has better values:
378 * - 'name' to a more meaningful name.
380 * - 'wildcards' to the set of wildcards actually supported by the table
381 * (if it doesn't support all OpenFlow wildcards).
383 * - 'max_entries' to the maximum number of flows actually supported by
386 * - 'lookup_count' to the number of packets looked up in this flow table
389 * - 'matched_count' to the number of packets looked up in this flow
390 * table so far that matched one of the flow entries.
392 * Keep in mind that all of the members of struct ofp_table_stats are in
393 * network byte order.
395 void (*get_tables)(struct ofproto *ofproto, struct ofp_table_stats *ots);
397 /* ## ---------------- ## */
398 /* ## ofport Functions ## */
399 /* ## ---------------- ## */
401 /* Life-cycle functions for a "struct ofport" (see "Life Cycle" above).
403 * ->port_construct() should not modify any base members of the ofport.
405 * ofports are managed by the base ofproto code. The ofproto
406 * implementation should only create and destroy them in response to calls
407 * to these functions. The base ofproto code will create and destroy
408 * ofports in the following situations:
410 * - Just after the ->construct() function is called, the base ofproto
411 * iterates over all of the implementation's ports, using
412 * ->port_dump_start() and related functions, and constructs an ofport
413 * for each dumped port.
415 * - If ->port_poll() reports that a specific port has changed, then the
416 * base ofproto will query that port with ->port_query_by_name() and
417 * construct or destruct ofports as necessary to reflect the updated
420 * - If ->port_poll() returns ENOBUFS to report an unspecified port set
421 * change, then the base ofproto will iterate over all of the
422 * implementation's ports, in the same way as at ofproto
423 * initialization, and construct and destruct ofports to reflect all of
426 * ->port_construct() returns 0 if successful, otherwise a positive errno
429 struct ofport *(*port_alloc)(void);
430 int (*port_construct)(struct ofport *ofport);
431 void (*port_destruct)(struct ofport *ofport);
432 void (*port_dealloc)(struct ofport *ofport);
434 /* Called after 'ofport->netdev' is replaced by a new netdev object. If
435 * the ofproto implementation uses the ofport's netdev internally, then it
436 * should switch to using the new one. The old one has been closed.
438 * An ofproto implementation that doesn't need to do anything in this
439 * function may use a null pointer. */
440 void (*port_modified)(struct ofport *ofport);
442 /* Called after an OpenFlow OFPT_PORT_MOD request changes a port's
443 * configuration. 'ofport->opp.config' contains the new configuration.
444 * 'old_config' contains the previous configuration.
446 * The caller implements OFPPC_PORT_DOWN using netdev functions to turn
447 * NETDEV_UP on and off, so this function doesn't have to do anything for
448 * that bit (and it won't be called if that is the only bit that
450 void (*port_reconfigured)(struct ofport *ofport, ovs_be32 old_config);
452 /* Looks up a port named 'devname' in 'ofproto'. On success, initializes
453 * '*port' appropriately.
455 * The caller owns the data in 'port' and must free it with
456 * ofproto_port_destroy() when it is no longer needed. */
457 int (*port_query_by_name)(const struct ofproto *ofproto,
458 const char *devname, struct ofproto_port *port);
460 /* Attempts to add 'netdev' as a port on 'ofproto'. Returns 0 if
461 * successful, otherwise a positive errno value. If successful, sets
462 * '*ofp_portp' to the new port's port number.
464 * It doesn't matter whether the new port will be returned by a later call
465 * to ->port_poll(); the implementation may do whatever is more
467 int (*port_add)(struct ofproto *ofproto, struct netdev *netdev,
468 uint16_t *ofp_portp);
470 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'. Returns
471 * 0 if successful, otherwise a positive errno value.
473 * It doesn't matter whether the new port will be returned by a later call
474 * to ->port_poll(); the implementation may do whatever is more
476 int (*port_del)(struct ofproto *ofproto, uint16_t ofp_port);
478 /* Port iteration functions.
480 * The client might not be entirely in control of the ports within an
481 * ofproto. Some hardware implementations, for example, might have a fixed
482 * set of ports in a datapath, and the Linux datapath allows the system
483 * administrator to externally add and remove ports with ovs-dpctl. For
484 * this reason, the client needs a way to iterate through all the ports
485 * that are actually in a datapath. These functions provide that
488 * The 'state' pointer provides the implementation a place to
489 * keep track of its position. Its format is opaque to the caller.
491 * The ofproto provider retains ownership of the data that it stores into
492 * ->port_dump_next()'s 'port' argument. The data must remain valid until
493 * at least the next call to ->port_dump_next() or ->port_dump_done() for
494 * 'state'. The caller will not modify or free it.
499 * ->port_dump_start() attempts to begin dumping the ports in 'ofproto'.
500 * On success, it should return 0 and initialize '*statep' with any data
501 * needed for iteration. On failure, returns a positive errno value, and
502 * the client will not call ->port_dump_next() or ->port_dump_done().
504 * ->port_dump_next() attempts to retrieve another port from 'ofproto' for
505 * 'state'. If there is another port, it should store the port's
506 * information into 'port' and return 0. It should return EOF if all ports
507 * have already been iterated. Otherwise, on error, it should return a
508 * positive errno value. This function will not be called again once it
509 * returns nonzero once for a given iteration (but the 'port_dump_done'
510 * function will be called afterward).
512 * ->port_dump_done() allows the implementation to release resources used
513 * for iteration. The caller might decide to stop iteration in the middle
514 * by calling this function before ->port_dump_next() returns nonzero.
522 * error = ofproto->ofproto_class->port_dump_start(ofproto, &state);
525 * struct ofproto_port port;
527 * error = ofproto->ofproto_class->port_dump_next(
528 * ofproto, state, &port);
532 * // Do something with 'port' here (without modifying or freeing
533 * // any of its data).
535 * ofproto->ofproto_class->port_dump_done(ofproto, state);
537 * // 'error' is now EOF (success) or a positive errno value (failure).
539 int (*port_dump_start)(const struct ofproto *ofproto, void **statep);
540 int (*port_dump_next)(const struct ofproto *ofproto, void *state,
541 struct ofproto_port *port);
542 int (*port_dump_done)(const struct ofproto *ofproto, void *state);
544 /* Polls for changes in the set of ports in 'ofproto'. If the set of ports
545 * in 'ofproto' has changed, then this function should do one of the
548 * - Preferably: store the name of the device that was added to or deleted
549 * from 'ofproto' in '*devnamep' and return 0. The caller is responsible
550 * for freeing '*devnamep' (with free()) when it no longer needs it.
552 * - Alternatively: return ENOBUFS, without indicating the device that was
555 * Occasional 'false positives', in which the function returns 0 while
556 * indicating a device that was not actually added or deleted or returns
557 * ENOBUFS without any change, are acceptable.
559 * The purpose of 'port_poll' is to let 'ofproto' know about changes made
560 * externally to the 'ofproto' object, e.g. by a system administrator via
561 * ovs-dpctl. Therefore, it's OK, and even preferable, for port_poll() to
562 * not report changes made through calls to 'port_add' or 'port_del' on the
563 * same 'ofproto' object. (But it's OK for it to report them too, just
564 * slightly less efficient.)
566 * If the set of ports in 'ofproto' has not changed, returns EAGAIN. May
567 * also return other positive errno values to indicate that something has
570 * If the set of ports in a datapath is fixed, or if the only way that the
571 * set of ports in a datapath can change is through ->port_add() and
572 * ->port_del(), then this function may be a null pointer.
574 int (*port_poll)(const struct ofproto *ofproto, char **devnamep);
576 /* Arranges for the poll loop to wake up when ->port_poll() will return a
577 * value other than EAGAIN.
579 * If the set of ports in a datapath is fixed, or if the only way that the
580 * set of ports in a datapath can change is through ->port_add() and
581 * ->port_del(), or if the poll loop will always wake up anyway when
582 * ->port_poll() will return a value other than EAGAIN, then this function
583 * may be a null pointer.
585 void (*port_poll_wait)(const struct ofproto *ofproto);
587 /* Checks the status of LACP negotiation for 'port'. Returns 1 if LACP
588 * partner information for 'port' is up-to-date, 0 if LACP partner
589 * information is not current (generally indicating a connectivity
590 * problem), or -1 if LACP is not enabled on 'port'.
592 * This function may be a null pointer if the ofproto implementation does
593 * not support LACP. */
594 int (*port_is_lacp_current)(const struct ofport *port);
596 /* ## ----------------------- ## */
597 /* ## OpenFlow Rule Functions ## */
598 /* ## ----------------------- ## */
602 /* Chooses an appropriate table for 'cls_rule' within 'ofproto'. On
603 * success, stores the table ID into '*table_idp' and returns 0. On
604 * failure, returns an OpenFlow error code (as returned by ofp_mkerr()).
606 * The choice of table should be a function of 'cls_rule' and 'ofproto''s
607 * datapath capabilities. It should not depend on the flows already in
608 * 'ofproto''s flow tables. Failure implies that an OpenFlow rule with
609 * 'cls_rule' as its matching condition can never be inserted into
610 * 'ofproto', even starting from an empty flow table.
612 * If multiple tables are candidates for inserting the flow, the function
613 * should choose one arbitrarily (but deterministically).
615 * If this function is NULL then table 0 is always chosen. */
616 int (*rule_choose_table)(const struct ofproto *ofproto,
617 const struct cls_rule *cls_rule,
620 /* Life-cycle functions for a "struct rule" (see "Life Cycle" above).
623 * Asynchronous Operation Support
624 * ==============================
626 * The life-cycle operations on rules can operate asynchronously, meaning
627 * that ->rule_construct() and ->rule_destruct() only need to initiate
628 * their respective operations and do not need to wait for them to complete
629 * before they return. ->rule_modify_actions() also operates
632 * An ofproto implementation reports the success or failure of an
633 * asynchronous operation on a rule using the rule's 'pending' member,
634 * which points to a opaque "struct ofoperation" that represents the
635 * ongoing opreation. When the operation completes, the ofproto
636 * implementation calls ofoperation_complete(), passing the ofoperation and
637 * an error indication.
639 * Only the following contexts may call ofoperation_complete():
641 * - The function called to initiate the operation,
642 * e.g. ->rule_construct() or ->rule_destruct(). This is the best
643 * choice if the operation completes quickly.
645 * - The implementation's ->run() function.
647 * - The implementation's ->destruct() function.
649 * The ofproto base code updates the flow table optimistically, assuming
650 * that the operation will probably succeed:
652 * - ofproto adds or replaces the rule in the flow table before calling
653 * ->rule_construct().
655 * - ofproto updates the rule's actions before calling
656 * ->rule_modify_actions().
658 * - ofproto removes the rule before calling ->rule_destruct().
660 * With one exception, when an asynchronous operation completes with an
661 * error, ofoperation_complete() backs out the already applied changes:
663 * - If adding or replacing a rule in the flow table fails, ofproto
664 * removes the new rule or restores the original rule.
666 * - If modifying a rule's actions fails, ofproto restores the original
669 * - Removing a rule is not allowed to fail. It must always succeed.
671 * The ofproto base code serializes operations: if any operation is in
672 * progress on a given rule, ofproto postpones initiating any new operation
673 * on that rule until the pending operation completes. Therefore, every
674 * operation must eventually complete through a call to
675 * ofoperation_complete() to avoid delaying new operations indefinitely
676 * (including any OpenFlow request that affects the rule in question, even
677 * just to query its statistics).
683 * When ->rule_construct() is called, the caller has already inserted
684 * 'rule' into 'rule->ofproto''s flow table numbered 'rule->table_id'.
685 * There are two cases:
687 * - 'rule' is a new rule in its flow table. In this case,
688 * ofoperation_get_victim(rule) returns NULL.
690 * - 'rule' is replacing an existing rule in its flow table that had the
691 * same matching criteria and priority. In this case,
692 * ofoperation_get_victim(rule) returns the rule being replaced (the
695 * ->rule_construct() should set the following in motion:
697 * - Validate that the matching rule in 'rule->cr' is supported by the
698 * datapath. For example, if the rule's table does not support
699 * registers, then it is an error if 'rule->cr' does not wildcard all
702 * - Validate that 'rule->actions' and 'rule->n_actions' are well-formed
703 * OpenFlow actions that the datapath can correctly implement. The
704 * validate_actions() function (in ofp-util.c) can be useful as a model
705 * for action validation, but it accepts all of the OpenFlow actions
706 * that OVS understands. If your ofproto implementation only
707 * implements a subset of those, then you should implement your own
710 * - If the rule is valid, update the datapath flow table, adding the new
711 * rule or replacing the existing one.
713 * - If 'rule' is replacing an existing rule, uninitialize any derived
714 * state for the victim rule, as in step 5 in the "Life Cycle"
717 * (On failure, the ofproto code will roll back the insertion from the flow
718 * table, either removing 'rule' or replacing it by the victim rule if
721 * ->rule_construct() must act in one of the following ways:
723 * - If it succeeds, it must call ofoperation_complete() and return 0.
725 * - If it fails, it must act in one of the following ways:
727 * * Call ofoperation_complete() and return 0.
729 * * Return an OpenFlow error code (as returned by ofp_mkerr()). (Do
730 * not call ofoperation_complete() in this case.)
732 * Either way, ->rule_destruct() will not be called for 'rule', but
733 * ->rule_dealloc() will be.
735 * - If the operation is only partially complete, then it must return 0.
736 * Later, when the operation is complete, the ->run() or ->destruct()
737 * function must call ofoperation_complete() to report success or
740 * ->rule_construct() should not modify any base members of struct rule.
746 * When ->rule_destruct() is called, the caller has already removed 'rule'
747 * from 'rule->ofproto''s flow table. ->rule_destruct() should set in
748 * motion removing 'rule' from the datapath flow table. If removal
749 * completes synchronously, it should call ofoperation_complete().
750 * Otherwise, the ->run() or ->destruct() function must later call
751 * ofoperation_complete() after the operation completes.
753 * Rule destruction must not fail. */
754 struct rule *(*rule_alloc)(void);
755 int (*rule_construct)(struct rule *rule);
756 void (*rule_destruct)(struct rule *rule);
757 void (*rule_dealloc)(struct rule *rule);
759 /* Obtains statistics for 'rule', storing the number of packets that have
760 * matched it in '*packet_count' and the number of bytes in those packets
761 * in '*byte_count'. UINT64_MAX indicates that the packet count or byte
762 * count is unknown. */
763 void (*rule_get_stats)(struct rule *rule, uint64_t *packet_count,
764 uint64_t *byte_count);
766 /* Applies the actions in 'rule' to 'packet'. (This implements sending
767 * buffered packets for OpenFlow OFPT_FLOW_MOD commands.)
769 * Takes ownership of 'packet' (so it should eventually free it, with
772 * 'flow' reflects the flow information for 'packet'. All of the
773 * information in 'flow' is extracted from 'packet', except for
774 * flow->tun_id and flow->in_port, which are assigned the correct values
775 * for the incoming packet. The register values are zeroed.
777 * The statistics for 'packet' should be included in 'rule'.
779 * Returns 0 if successful, otherwise an OpenFlow error code (as returned
780 * by ofp_mkerr()). */
781 int (*rule_execute)(struct rule *rule, struct flow *flow,
782 struct ofpbuf *packet);
784 /* When ->rule_modify_actions() is called, the caller has already replaced
785 * the OpenFlow actions in 'rule' by a new set. (The original actions are
786 * in rule->pending->actions.)
788 * ->rule_modify_actions() should set the following in motion:
790 * - Validate that the actions now in 'rule' are well-formed OpenFlow
791 * actions that the datapath can correctly implement.
793 * - Update the datapath flow table with the new actions.
795 * If the operation synchronously completes, ->rule_modify_actions() may
796 * call ofoperation_complete() before it returns. Otherwise, ->run()
797 * should call ofoperation_complete() later, after the operation does
800 * If the operation fails, then the base ofproto code will restore the
801 * original 'actions' and 'n_actions' of 'rule'.
803 * ->rule_modify_actions() should not modify any base members of struct
805 void (*rule_modify_actions)(struct rule *rule);
807 /* These functions implement the OpenFlow IP fragment handling policy. By
808 * default ('drop_frags' == false), an OpenFlow switch should treat IP
809 * fragments the same way as other packets (although TCP and UDP port
810 * numbers cannot be determined). With 'drop_frags' == true, the switch
811 * should drop all IP fragments without passing them through the flow
813 bool (*get_drop_frags)(struct ofproto *ofproto);
814 void (*set_drop_frags)(struct ofproto *ofproto, bool drop_frags);
816 /* Implements the OpenFlow OFPT_PACKET_OUT command. The datapath should
817 * execute the 'n_actions' in the 'actions' array on 'packet'.
819 * The caller retains ownership of 'packet', so ->packet_out() should not
822 * This function must validate that the 'n_actions' elements in 'actions'
823 * are well-formed OpenFlow actions that can be correctly implemented by
824 * the datapath. If not, then it should return an OpenFlow error code (as
825 * returned by ofp_mkerr()).
827 * 'flow' reflects the flow information for 'packet'. All of the
828 * information in 'flow' is extracted from 'packet', except for
829 * flow->in_port, which is taken from the OFPT_PACKET_OUT message.
830 * flow->tun_id and its register values are zeroed.
832 * 'packet' is not matched against the OpenFlow flow table, so its
833 * statistics should not be included in OpenFlow flow statistics.
835 * Returns 0 if successful, otherwise an OpenFlow error code (as returned
836 * by ofp_mkerr()). */
837 int (*packet_out)(struct ofproto *ofproto, struct ofpbuf *packet,
838 const struct flow *flow,
839 const union ofp_action *actions,
842 /* ## ------------------------- ## */
843 /* ## OFPP_NORMAL configuration ## */
844 /* ## ------------------------- ## */
846 /* Configures NetFlow on 'ofproto' according to the options in
847 * 'netflow_options', or turns off NetFlow if 'netflow_options' is NULL.
849 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
850 * NetFlow, as does a null pointer. */
851 int (*set_netflow)(struct ofproto *ofproto,
852 const struct netflow_options *netflow_options);
854 void (*get_netflow_ids)(const struct ofproto *ofproto,
855 uint8_t *engine_type, uint8_t *engine_id);
857 /* Configures sFlow on 'ofproto' according to the options in
858 * 'sflow_options', or turns off sFlow if 'sflow_options' is NULL.
860 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
861 * sFlow, as does a null pointer. */
862 int (*set_sflow)(struct ofproto *ofproto,
863 const struct ofproto_sflow_options *sflow_options);
865 /* Configures connectivity fault management on 'ofport'.
867 * If 'cfm_settings' is nonnull, configures CFM according to its members.
869 * If 'cfm_settings' is null, removes any connectivity fault management
870 * configuration from 'ofport'.
872 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
873 * support CFM, as does a null pointer. */
874 int (*set_cfm)(struct ofport *ofport, const struct cfm_settings *s);
876 /* Checks the fault status of CFM configured on 'ofport'. Returns 1 if CFM
877 * is faulted (generally indicating a connectivity problem), 0 if CFM is
878 * not faulted, or -1 if CFM is not enabled on 'port'
880 * This function may be a null pointer if the ofproto implementation does
881 * not support CFM. */
882 int (*get_cfm_fault)(const struct ofport *ofport);
884 /* Gets the MPIDs of the remote maintenance points broadcasting to
885 * 'ofport'. Populates 'rmps' with a provider owned array of MPIDs, and
886 * 'n_rmps' with the number of MPIDs in 'rmps'. Returns a number less than
887 * 0 if CFM is not enabled of 'ofport'.
889 * This function may be a null pointer if the ofproto implementation does
890 * not support CFM. */
891 int (*get_cfm_remote_mpids)(const struct ofport *ofport,
892 const uint64_t **rmps, size_t *n_rmps);
894 /* If 's' is nonnull, this function registers a "bundle" associated with
895 * client data pointer 'aux' in 'ofproto'. A bundle is the same concept as
896 * a Port in OVSDB, that is, it consists of one or more "slave" devices
897 * (Interfaces, in OVSDB) along with VLAN and LACP configuration and, if
898 * there is more than one slave, a bonding configuration. If 'aux' is
899 * already registered then this function updates its configuration to 's'.
900 * Otherwise, this function registers a new bundle.
902 * If 's' is NULL, this function unregisters the bundle registered on
903 * 'ofproto' associated with client data pointer 'aux'. If no such bundle
904 * has been registered, this has no effect.
906 * This function affects only the behavior of the NXAST_AUTOPATH action and
907 * output to the OFPP_NORMAL port. An implementation that does not support
908 * it at all may set it to NULL or return EOPNOTSUPP. An implementation
909 * that supports only a subset of the functionality should implement what
910 * it can and return 0. */
911 int (*bundle_set)(struct ofproto *ofproto, void *aux,
912 const struct ofproto_bundle_settings *s);
914 /* If 'port' is part of any bundle, removes it from that bundle. If the
915 * bundle now has no ports, deletes the bundle. If the bundle now has only
916 * one port, deconfigures the bundle's bonding configuration. */
917 void (*bundle_remove)(struct ofport *ofport);
919 /* If 's' is nonnull, this function registers a mirror associated with
920 * client data pointer 'aux' in 'ofproto'. A mirror is the same concept as
921 * a Mirror in OVSDB. If 'aux' is already registered then this function
922 * updates its configuration to 's'. Otherwise, this function registers a
925 * If 's' is NULL, this function unregisters the mirror registered on
926 * 'ofproto' associated with client data pointer 'aux'. If no such mirror
927 * has been registered, this has no effect.
929 * This function affects only the behavior of the OFPP_NORMAL action. An
930 * implementation that does not support it at all may set it to NULL or
931 * return EOPNOTSUPP. An implementation that supports only a subset of the
932 * functionality should implement what it can and return 0. */
933 int (*mirror_set)(struct ofproto *ofproto, void *aux,
934 const struct ofproto_mirror_settings *s);
936 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs
937 * on which all packets are flooded, instead of using MAC learning. If
938 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
940 * This function affects only the behavior of the OFPP_NORMAL action. An
941 * implementation that does not support it may set it to NULL or return
943 int (*set_flood_vlans)(struct ofproto *ofproto,
944 unsigned long *flood_vlans);
946 /* Returns true if 'aux' is a registered bundle that is currently in use as
947 * the output for a mirror. */
948 bool (*is_mirror_output_bundle)(struct ofproto *ofproto, void *aux);
950 /* When the configuration option of forward_bpdu changes, this function
951 * will be invoked. */
952 void (*forward_bpdu_changed)(struct ofproto *ofproto);
955 extern const struct ofproto_class ofproto_dpif_class;
957 int ofproto_class_register(const struct ofproto_class *);
958 int ofproto_class_unregister(const struct ofproto_class *);
960 void ofproto_add_flow(struct ofproto *, const struct cls_rule *,
961 const union ofp_action *, size_t n_actions);
962 bool ofproto_delete_flow(struct ofproto *, const struct cls_rule *);
963 void ofproto_flush_flows(struct ofproto *);
965 #endif /* ofproto/ofproto-provider.h */