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;
99 /* An OpenFlow flow within a "struct ofproto".
101 * With few exceptions, ofproto implementations may look at these fields but
102 * should not modify them. */
104 struct ofproto *ofproto; /* The ofproto that contains this rule. */
105 struct list ofproto_node; /* Owned by ofproto base code. */
106 struct cls_rule cr; /* In owning ofproto's classifier. */
108 struct ofoperation *pending; /* Operation now in progress, if nonnull. */
110 ovs_be64 flow_cookie; /* Controller-issued identifier. */
112 long long int created; /* Creation time. */
113 long long int modified; /* Time of last modification. */
114 uint16_t idle_timeout; /* In seconds from time of last use. */
115 uint16_t hard_timeout; /* In seconds from last modification. */
116 uint8_t table_id; /* Index in ofproto's 'tables' array. */
117 bool send_flow_removed; /* Send a flow removed message? */
119 union ofp_action *actions; /* OpenFlow actions. */
120 int n_actions; /* Number of elements in actions[]. */
123 static inline struct rule *
124 rule_from_cls_rule(const struct cls_rule *cls_rule)
126 return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
129 void ofproto_rule_expire(struct rule *, uint8_t reason);
130 void ofproto_rule_destroy(struct rule *);
132 void ofoperation_complete(struct ofoperation *, int status);
133 struct rule *ofoperation_get_victim(struct ofoperation *);
135 /* ofproto class structure, to be defined by each ofproto implementation.
141 * These functions work primarily with three different kinds of data
144 * - "struct ofproto", which represents an OpenFlow switch.
146 * - "struct ofport", which represents a port within an ofproto.
148 * - "struct rule", which represents an OpenFlow flow within an ofproto.
150 * Each of these data structures contains all of the implementation-independent
151 * generic state for the respective concept, called the "base" state. None of
152 * them contains any extra space for ofproto implementations to use. Instead,
153 * each implementation is expected to declare its own data structure that
154 * contains an instance of the generic data structure plus additional
155 * implementation-specific members, called the "derived" state. The
156 * implementation can use casts or (preferably) the CONTAINER_OF macro to
157 * obtain access to derived state given only a pointer to the embedded generic
164 * Four stylized functions accompany each of these data structures:
166 * "alloc" "construct" "destruct" "dealloc"
167 * ------------ ---------------- --------------- --------------
168 * ofproto ->alloc ->construct ->destruct ->dealloc
169 * ofport ->port_alloc ->port_construct ->port_destruct ->port_dealloc
170 * rule ->rule_alloc ->rule_construct ->rule_destruct ->rule_dealloc
172 * Any instance of a given data structure goes through the following life
175 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
176 * fails, skip all the other steps.
178 * 2. The client initializes all of the data structure's base state. If this
179 * fails, skip to step 7.
181 * 3. The client calls the "construct" function. The implementation
182 * initializes derived state. It may refer to the already-initialized
183 * base state. If "construct" fails, skip to step 6.
185 * 4. The data structure is now initialized and in use.
187 * 5. When the data structure is no longer needed, the client calls the
188 * "destruct" function. The implementation uninitializes derived state.
189 * The base state has not been uninitialized yet, so the implementation
190 * may still refer to it.
192 * 6. The client uninitializes all of the data structure's base state.
194 * 7. The client calls the "dealloc" to free the raw memory. The
195 * implementation must not refer to base or derived state in the data
196 * structure, because it has already been uninitialized.
198 * Each "alloc" function allocates and returns a new instance of the respective
199 * data structure. The "alloc" function is not given any information about the
200 * use of the new data structure, so it cannot perform much initialization.
201 * Its purpose is just to ensure that the new data structure has enough room
202 * for base and derived state. It may return a null pointer if memory is not
203 * available, in which case none of the other functions is called.
205 * Each "construct" function initializes derived state in its respective data
206 * structure. When "construct" is called, all of the base state has already
207 * been initialized, so the "construct" function may refer to it. The
208 * "construct" function is allowed to fail, in which case the client calls the
209 * "dealloc" function (but not the "destruct" function).
211 * Each "destruct" function uninitializes and frees derived state in its
212 * respective data structure. When "destruct" is called, the base state has
213 * not yet been uninitialized, so the "destruct" function may refer to it. The
214 * "destruct" function is not allowed to fail.
216 * Each "dealloc" function frees raw memory that was allocated by the the
217 * "alloc" function. The memory's base and derived members might not have ever
218 * been initialized (but if "construct" returned successfully, then it has been
219 * "destruct"ed already). The "dealloc" function is not allowed to fail.
225 * Most of these functions return 0 if they are successful or a positive error
226 * code on failure. Depending on the function, valid error codes are either
227 * errno values or OpenFlow error codes constructed with ofp_mkerr().
229 * Most of these functions are expected to execute synchronously, that is, to
230 * block as necessary to obtain a result. Thus, these functions may return
231 * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
232 * explicitly say those errors are a possibility. We may relax this
233 * requirement in the future if and when we encounter performance problems. */
234 struct ofproto_class {
235 /* ## ----------------- ## */
236 /* ## Factory Functions ## */
237 /* ## ----------------- ## */
239 /* Enumerates the types of all support ofproto types into 'types'. The
240 * caller has already initialized 'types' and other ofproto classes might
241 * already have added names to it. */
242 void (*enumerate_types)(struct sset *types);
244 /* Enumerates the names of all existing datapath of the specified 'type'
245 * into 'names' 'all_dps'. The caller has already initialized 'names' as
248 * 'type' is one of the types enumerated by ->enumerate_types().
250 * Returns 0 if successful, otherwise a positive errno value.
252 int (*enumerate_names)(const char *type, struct sset *names);
254 /* Deletes the datapath with the specified 'type' and 'name'. The caller
255 * should have closed any open ofproto with this 'type' and 'name'; this
256 * function is allowed to fail if that is not the case.
258 * 'type' is one of the types enumerated by ->enumerate_types().
259 * 'name' is one of the names enumerated by ->enumerate_names() for 'type'.
261 * Returns 0 if successful, otherwise a positive errno value.
263 int (*del)(const char *type, const char *name);
265 /* ## --------------------------- ## */
266 /* ## Top-Level ofproto Functions ## */
267 /* ## --------------------------- ## */
269 /* Life-cycle functions for an "ofproto" (see "Life Cycle" above).
275 * ->construct() should not modify any base members of the ofproto. The
276 * client will initialize the ofproto's 'ports' and 'tables' members after
277 * construction is complete.
279 * When ->construct() is called, the client does not yet know how many flow
280 * tables the datapath supports, so ofproto->n_tables will be 0 and
281 * ofproto->tables will be NULL. ->construct() should store the number of
282 * flow tables supported by the datapath (between 1 and 255, inclusive)
283 * into '*n_tables'. After a successful return, the client will initialize
284 * the base 'n_tables' member to '*n_tables' and allocate and initialize
285 * the base 'tables' member as the specified number of empty flow tables.
286 * Each flow table will be initially empty, so ->construct() should delete
287 * flows from the underlying datapath, if necessary, rather than populating
290 * Only one ofproto instance needs to be supported for any given datapath.
291 * If a datapath is already open as part of one "ofproto", then another
292 * attempt to "construct" the same datapath as part of another ofproto is
293 * allowed to fail with an error.
295 * ->construct() returns 0 if successful, otherwise a positive errno
302 * If 'ofproto' has any pending asynchronous operations, ->destruct()
303 * must complete all of them by calling ofoperation_complete().
305 * ->destruct() must also destroy all remaining rules in the ofproto's
306 * tables, by passing each remaining rule to ofproto_rule_destroy(). The
307 * client will destroy the flow tables themselves after ->destruct()
310 struct ofproto *(*alloc)(void);
311 int (*construct)(struct ofproto *ofproto, int *n_tables);
312 void (*destruct)(struct ofproto *ofproto);
313 void (*dealloc)(struct ofproto *ofproto);
315 /* Performs any periodic activity required by 'ofproto'. It should:
317 * - Call connmgr_send_packet_in() for each received packet that missed
318 * in the OpenFlow flow table or that had a OFPP_CONTROLLER output
321 * - Call ofproto_rule_expire() for each OpenFlow flow that has reached
322 * its hard_timeout or idle_timeout, to expire the flow.
324 * Returns 0 if successful, otherwise a positive errno value. The ENODEV
325 * return value specifically means that the datapath underlying 'ofproto'
326 * has been destroyed (externally, e.g. by an admin running ovs-dpctl).
328 int (*run)(struct ofproto *ofproto);
330 /* Causes the poll loop to wake up when 'ofproto''s 'run' function needs to
331 * be called, e.g. by calling the timer or fd waiting functions in
333 void (*wait)(struct ofproto *ofproto);
335 /* Every "struct rule" in 'ofproto' is about to be deleted, one by one.
336 * This function may prepare for that, for example by clearing state in
337 * advance. It should *not* actually delete any "struct rule"s from
338 * 'ofproto', only prepare for it.
340 * This function is optional; it's really just for optimization in case
341 * it's cheaper to delete all the flows from your hardware in a single pass
342 * than to do it one by one. */
343 void (*flush)(struct ofproto *ofproto);
345 /* Helper for the OpenFlow OFPT_FEATURES_REQUEST request.
347 * The implementation should store true in '*arp_match_ip' if the switch
348 * supports matching IP addresses inside ARP requests and replies, false
351 * The implementation should store in '*actions' a bitmap of the supported
352 * OpenFlow actions: the bit with value (1 << n) should be set to 1 if the
353 * implementation supports the action with value 'n', and to 0 otherwise.
354 * For example, if the implementation supports the OFPAT_OUTPUT and
355 * OFPAT_ENQUEUE actions, but no others, it would set '*actions' to (1 <<
356 * OFPAT_OUTPUT) | (1 << OFPAT_ENQUEUE). Vendor actions are not included
358 void (*get_features)(struct ofproto *ofproto,
359 bool *arp_match_ip, uint32_t *actions);
361 /* Helper for the OpenFlow OFPST_TABLE statistics request.
363 * The 'ots' array contains 'ofproto->n_tables' elements. Each element is
366 * - 'table_id' to the array index.
368 * - 'name' to "table#" where # is the table ID.
370 * - 'wildcards' to OFPFW_ALL.
372 * - 'max_entries' to 1,000,000.
374 * - 'active_count' to the classifier_count() for the table.
376 * - 'lookup_count' and 'matched_count' to 0.
378 * The implementation should update any members in each element for which
379 * it has better values:
381 * - 'name' to a more meaningful name.
383 * - 'wildcards' to the set of wildcards actually supported by the table
384 * (if it doesn't support all OpenFlow wildcards).
386 * - 'max_entries' to the maximum number of flows actually supported by
389 * - 'lookup_count' to the number of packets looked up in this flow table
392 * - 'matched_count' to the number of packets looked up in this flow
393 * table so far that matched one of the flow entries.
395 * Keep in mind that all of the members of struct ofp_table_stats are in
396 * network byte order.
398 void (*get_tables)(struct ofproto *ofproto, struct ofp_table_stats *ots);
400 /* ## ---------------- ## */
401 /* ## ofport Functions ## */
402 /* ## ---------------- ## */
404 /* Life-cycle functions for a "struct ofport" (see "Life Cycle" above).
406 * ->port_construct() should not modify any base members of the ofport.
408 * ofports are managed by the base ofproto code. The ofproto
409 * implementation should only create and destroy them in response to calls
410 * to these functions. The base ofproto code will create and destroy
411 * ofports in the following situations:
413 * - Just after the ->construct() function is called, the base ofproto
414 * iterates over all of the implementation's ports, using
415 * ->port_dump_start() and related functions, and constructs an ofport
416 * for each dumped port.
418 * - If ->port_poll() reports that a specific port has changed, then the
419 * base ofproto will query that port with ->port_query_by_name() and
420 * construct or destruct ofports as necessary to reflect the updated
423 * - If ->port_poll() returns ENOBUFS to report an unspecified port set
424 * change, then the base ofproto will iterate over all of the
425 * implementation's ports, in the same way as at ofproto
426 * initialization, and construct and destruct ofports to reflect all of
429 * ->port_construct() returns 0 if successful, otherwise a positive errno
432 struct ofport *(*port_alloc)(void);
433 int (*port_construct)(struct ofport *ofport);
434 void (*port_destruct)(struct ofport *ofport);
435 void (*port_dealloc)(struct ofport *ofport);
437 /* Called after 'ofport->netdev' is replaced by a new netdev object. If
438 * the ofproto implementation uses the ofport's netdev internally, then it
439 * should switch to using the new one. The old one has been closed.
441 * An ofproto implementation that doesn't need to do anything in this
442 * function may use a null pointer. */
443 void (*port_modified)(struct ofport *ofport);
445 /* Called after an OpenFlow OFPT_PORT_MOD request changes a port's
446 * configuration. 'ofport->opp.config' contains the new configuration.
447 * 'old_config' contains the previous configuration.
449 * The caller implements OFPPC_PORT_DOWN using netdev functions to turn
450 * NETDEV_UP on and off, so this function doesn't have to do anything for
451 * that bit (and it won't be called if that is the only bit that
453 void (*port_reconfigured)(struct ofport *ofport, ovs_be32 old_config);
455 /* Looks up a port named 'devname' in 'ofproto'. On success, initializes
456 * '*port' appropriately.
458 * The caller owns the data in 'port' and must free it with
459 * ofproto_port_destroy() when it is no longer needed. */
460 int (*port_query_by_name)(const struct ofproto *ofproto,
461 const char *devname, struct ofproto_port *port);
463 /* Attempts to add 'netdev' as a port on 'ofproto'. Returns 0 if
464 * successful, otherwise a positive errno value. If successful, sets
465 * '*ofp_portp' to the new port's port number.
467 * It doesn't matter whether the new port will be returned by a later call
468 * to ->port_poll(); the implementation may do whatever is more
470 int (*port_add)(struct ofproto *ofproto, struct netdev *netdev,
471 uint16_t *ofp_portp);
473 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'. Returns
474 * 0 if successful, otherwise a positive errno value.
476 * It doesn't matter whether the new port will be returned by a later call
477 * to ->port_poll(); the implementation may do whatever is more
479 int (*port_del)(struct ofproto *ofproto, uint16_t ofp_port);
481 /* Port iteration functions.
483 * The client might not be entirely in control of the ports within an
484 * ofproto. Some hardware implementations, for example, might have a fixed
485 * set of ports in a datapath, and the Linux datapath allows the system
486 * administrator to externally add and remove ports with ovs-dpctl. For
487 * this reason, the client needs a way to iterate through all the ports
488 * that are actually in a datapath. These functions provide that
491 * The 'state' pointer provides the implementation a place to
492 * keep track of its position. Its format is opaque to the caller.
494 * The ofproto provider retains ownership of the data that it stores into
495 * ->port_dump_next()'s 'port' argument. The data must remain valid until
496 * at least the next call to ->port_dump_next() or ->port_dump_done() for
497 * 'state'. The caller will not modify or free it.
502 * ->port_dump_start() attempts to begin dumping the ports in 'ofproto'.
503 * On success, it should return 0 and initialize '*statep' with any data
504 * needed for iteration. On failure, returns a positive errno value, and
505 * the client will not call ->port_dump_next() or ->port_dump_done().
507 * ->port_dump_next() attempts to retrieve another port from 'ofproto' for
508 * 'state'. If there is another port, it should store the port's
509 * information into 'port' and return 0. It should return EOF if all ports
510 * have already been iterated. Otherwise, on error, it should return a
511 * positive errno value. This function will not be called again once it
512 * returns nonzero once for a given iteration (but the 'port_dump_done'
513 * function will be called afterward).
515 * ->port_dump_done() allows the implementation to release resources used
516 * for iteration. The caller might decide to stop iteration in the middle
517 * by calling this function before ->port_dump_next() returns nonzero.
525 * error = ofproto->ofproto_class->port_dump_start(ofproto, &state);
528 * struct ofproto_port port;
530 * error = ofproto->ofproto_class->port_dump_next(
531 * ofproto, state, &port);
535 * // Do something with 'port' here (without modifying or freeing
536 * // any of its data).
538 * ofproto->ofproto_class->port_dump_done(ofproto, state);
540 * // 'error' is now EOF (success) or a positive errno value (failure).
542 int (*port_dump_start)(const struct ofproto *ofproto, void **statep);
543 int (*port_dump_next)(const struct ofproto *ofproto, void *state,
544 struct ofproto_port *port);
545 int (*port_dump_done)(const struct ofproto *ofproto, void *state);
547 /* Polls for changes in the set of ports in 'ofproto'. If the set of ports
548 * in 'ofproto' has changed, then this function should do one of the
551 * - Preferably: store the name of the device that was added to or deleted
552 * from 'ofproto' in '*devnamep' and return 0. The caller is responsible
553 * for freeing '*devnamep' (with free()) when it no longer needs it.
555 * - Alternatively: return ENOBUFS, without indicating the device that was
558 * Occasional 'false positives', in which the function returns 0 while
559 * indicating a device that was not actually added or deleted or returns
560 * ENOBUFS without any change, are acceptable.
562 * The purpose of 'port_poll' is to let 'ofproto' know about changes made
563 * externally to the 'ofproto' object, e.g. by a system administrator via
564 * ovs-dpctl. Therefore, it's OK, and even preferable, for port_poll() to
565 * not report changes made through calls to 'port_add' or 'port_del' on the
566 * same 'ofproto' object. (But it's OK for it to report them too, just
567 * slightly less efficient.)
569 * If the set of ports in 'ofproto' has not changed, returns EAGAIN. May
570 * also return other positive errno values to indicate that something has
573 * If the set of ports in a datapath is fixed, or if the only way that the
574 * set of ports in a datapath can change is through ->port_add() and
575 * ->port_del(), then this function may be a null pointer.
577 int (*port_poll)(const struct ofproto *ofproto, char **devnamep);
579 /* Arranges for the poll loop to wake up when ->port_poll() will return a
580 * value other than EAGAIN.
582 * If the set of ports in a datapath is fixed, or if the only way that the
583 * set of ports in a datapath can change is through ->port_add() and
584 * ->port_del(), or if the poll loop will always wake up anyway when
585 * ->port_poll() will return a value other than EAGAIN, then this function
586 * may be a null pointer.
588 void (*port_poll_wait)(const struct ofproto *ofproto);
590 /* Checks the status of LACP negotiation for 'port'. Returns 1 if LACP
591 * partner information for 'port' is up-to-date, 0 if LACP partner
592 * information is not current (generally indicating a connectivity
593 * problem), or -1 if LACP is not enabled on 'port'.
595 * This function may be a null pointer if the ofproto implementation does
596 * not support LACP. */
597 int (*port_is_lacp_current)(const struct ofport *port);
599 /* ## ----------------------- ## */
600 /* ## OpenFlow Rule Functions ## */
601 /* ## ----------------------- ## */
605 /* Chooses an appropriate table for 'cls_rule' within 'ofproto'. On
606 * success, stores the table ID into '*table_idp' and returns 0. On
607 * failure, returns an OpenFlow error code (as returned by ofp_mkerr()).
609 * The choice of table should be a function of 'cls_rule' and 'ofproto''s
610 * datapath capabilities. It should not depend on the flows already in
611 * 'ofproto''s flow tables. Failure implies that an OpenFlow rule with
612 * 'cls_rule' as its matching condition can never be inserted into
613 * 'ofproto', even starting from an empty flow table.
615 * If multiple tables are candidates for inserting the flow, the function
616 * should choose one arbitrarily (but deterministically).
618 * If this function is NULL then table 0 is always chosen. */
619 int (*rule_choose_table)(const struct ofproto *ofproto,
620 const struct cls_rule *cls_rule,
623 /* Life-cycle functions for a "struct rule" (see "Life Cycle" above).
626 * Asynchronous Operation Support
627 * ==============================
629 * The life-cycle operations on rules can operate asynchronously, meaning
630 * that ->rule_construct() and ->rule_destruct() only need to initiate
631 * their respective operations and do not need to wait for them to complete
632 * before they return. ->rule_modify_actions() also operates
635 * An ofproto implementation reports the success or failure of an
636 * asynchronous operation on a rule using the rule's 'pending' member,
637 * which points to a opaque "struct ofoperation" that represents the
638 * ongoing opreation. When the operation completes, the ofproto
639 * implementation calls ofoperation_complete(), passing the ofoperation and
640 * an error indication.
642 * Only the following contexts may call ofoperation_complete():
644 * - The function called to initiate the operation,
645 * e.g. ->rule_construct() or ->rule_destruct(). This is the best
646 * choice if the operation completes quickly.
648 * - The implementation's ->run() function.
650 * - The implementation's ->destruct() function.
652 * The ofproto base code updates the flow table optimistically, assuming
653 * that the operation will probably succeed:
655 * - ofproto adds or replaces the rule in the flow table before calling
656 * ->rule_construct().
658 * - ofproto updates the rule's actions before calling
659 * ->rule_modify_actions().
661 * - ofproto removes the rule before calling ->rule_destruct().
663 * With one exception, when an asynchronous operation completes with an
664 * error, ofoperation_complete() backs out the already applied changes:
666 * - If adding or replacing a rule in the flow table fails, ofproto
667 * removes the new rule or restores the original rule.
669 * - If modifying a rule's actions fails, ofproto restores the original
672 * - Removing a rule is not allowed to fail. It must always succeed.
674 * The ofproto base code serializes operations: if any operation is in
675 * progress on a given rule, ofproto postpones initiating any new operation
676 * on that rule until the pending operation completes. Therefore, every
677 * operation must eventually complete through a call to
678 * ofoperation_complete() to avoid delaying new operations indefinitely
679 * (including any OpenFlow request that affects the rule in question, even
680 * just to query its statistics).
686 * When ->rule_construct() is called, the caller has already inserted
687 * 'rule' into 'rule->ofproto''s flow table numbered 'rule->table_id'.
688 * There are two cases:
690 * - 'rule' is a new rule in its flow table. In this case,
691 * ofoperation_get_victim(rule) returns NULL.
693 * - 'rule' is replacing an existing rule in its flow table that had the
694 * same matching criteria and priority. In this case,
695 * ofoperation_get_victim(rule) returns the rule being replaced (the
698 * ->rule_construct() should set the following in motion:
700 * - Validate that the matching rule in 'rule->cr' is supported by the
701 * datapath. For example, if the rule's table does not support
702 * registers, then it is an error if 'rule->cr' does not wildcard all
705 * - Validate that 'rule->actions' and 'rule->n_actions' are well-formed
706 * OpenFlow actions that the datapath can correctly implement. The
707 * validate_actions() function (in ofp-util.c) can be useful as a model
708 * for action validation, but it accepts all of the OpenFlow actions
709 * that OVS understands. If your ofproto implementation only
710 * implements a subset of those, then you should implement your own
713 * - If the rule is valid, update the datapath flow table, adding the new
714 * rule or replacing the existing one.
716 * - If 'rule' is replacing an existing rule, uninitialize any derived
717 * state for the victim rule, as in step 5 in the "Life Cycle"
720 * (On failure, the ofproto code will roll back the insertion from the flow
721 * table, either removing 'rule' or replacing it by the victim rule if
724 * ->rule_construct() must act in one of the following ways:
726 * - If it succeeds, it must call ofoperation_complete() and return 0.
728 * - If it fails, it must act in one of the following ways:
730 * * Call ofoperation_complete() and return 0.
732 * * Return an OpenFlow error code (as returned by ofp_mkerr()). (Do
733 * not call ofoperation_complete() in this case.)
735 * Either way, ->rule_destruct() will not be called for 'rule', but
736 * ->rule_dealloc() will be.
738 * - If the operation is only partially complete, then it must return 0.
739 * Later, when the operation is complete, the ->run() or ->destruct()
740 * function must call ofoperation_complete() to report success or
743 * ->rule_construct() should not modify any base members of struct rule.
749 * When ->rule_destruct() is called, the caller has already removed 'rule'
750 * from 'rule->ofproto''s flow table. ->rule_destruct() should set in
751 * motion removing 'rule' from the datapath flow table. If removal
752 * completes synchronously, it should call ofoperation_complete().
753 * Otherwise, the ->run() or ->destruct() function must later call
754 * ofoperation_complete() after the operation completes.
756 * Rule destruction must not fail. */
757 struct rule *(*rule_alloc)(void);
758 int (*rule_construct)(struct rule *rule);
759 void (*rule_destruct)(struct rule *rule);
760 void (*rule_dealloc)(struct rule *rule);
762 /* Obtains statistics for 'rule', storing the number of packets that have
763 * matched it in '*packet_count' and the number of bytes in those packets
764 * in '*byte_count'. UINT64_MAX indicates that the packet count or byte
765 * count is unknown. */
766 void (*rule_get_stats)(struct rule *rule, uint64_t *packet_count,
767 uint64_t *byte_count);
769 /* Applies the actions in 'rule' to 'packet'. (This implements sending
770 * buffered packets for OpenFlow OFPT_FLOW_MOD commands.)
772 * Takes ownership of 'packet' (so it should eventually free it, with
775 * 'flow' reflects the flow information for 'packet'. All of the
776 * information in 'flow' is extracted from 'packet', except for
777 * flow->tun_id and flow->in_port, which are assigned the correct values
778 * for the incoming packet. The register values are zeroed.
780 * The statistics for 'packet' should be included in 'rule'.
782 * Returns 0 if successful, otherwise an OpenFlow error code (as returned
783 * by ofp_mkerr()). */
784 int (*rule_execute)(struct rule *rule, struct flow *flow,
785 struct ofpbuf *packet);
787 /* When ->rule_modify_actions() is called, the caller has already replaced
788 * the OpenFlow actions in 'rule' by a new set. (The original actions are
789 * in rule->pending->actions.)
791 * ->rule_modify_actions() should set the following in motion:
793 * - Validate that the actions now in 'rule' are well-formed OpenFlow
794 * actions that the datapath can correctly implement.
796 * - Update the datapath flow table with the new actions.
798 * If the operation synchronously completes, ->rule_modify_actions() may
799 * call ofoperation_complete() before it returns. Otherwise, ->run()
800 * should call ofoperation_complete() later, after the operation does
803 * If the operation fails, then the base ofproto code will restore the
804 * original 'actions' and 'n_actions' of 'rule'.
806 * ->rule_modify_actions() should not modify any base members of struct
808 void (*rule_modify_actions)(struct rule *rule);
810 /* These functions implement the OpenFlow IP fragment handling policy. By
811 * default ('drop_frags' == false), an OpenFlow switch should treat IP
812 * fragments the same way as other packets (although TCP and UDP port
813 * numbers cannot be determined). With 'drop_frags' == true, the switch
814 * should drop all IP fragments without passing them through the flow
816 bool (*get_drop_frags)(struct ofproto *ofproto);
817 void (*set_drop_frags)(struct ofproto *ofproto, bool drop_frags);
819 /* Implements the OpenFlow OFPT_PACKET_OUT command. The datapath should
820 * execute the 'n_actions' in the 'actions' array on 'packet'.
822 * The caller retains ownership of 'packet', so ->packet_out() should not
825 * This function must validate that the 'n_actions' elements in 'actions'
826 * are well-formed OpenFlow actions that can be correctly implemented by
827 * the datapath. If not, then it should return an OpenFlow error code (as
828 * returned by ofp_mkerr()).
830 * 'flow' reflects the flow information for 'packet'. All of the
831 * information in 'flow' is extracted from 'packet', except for
832 * flow->in_port, which is taken from the OFPT_PACKET_OUT message.
833 * flow->tun_id and its register values are zeroed.
835 * 'packet' is not matched against the OpenFlow flow table, so its
836 * statistics should not be included in OpenFlow flow statistics.
838 * Returns 0 if successful, otherwise an OpenFlow error code (as returned
839 * by ofp_mkerr()). */
840 int (*packet_out)(struct ofproto *ofproto, struct ofpbuf *packet,
841 const struct flow *flow,
842 const union ofp_action *actions,
845 /* ## ------------------------- ## */
846 /* ## OFPP_NORMAL configuration ## */
847 /* ## ------------------------- ## */
849 /* Configures NetFlow on 'ofproto' according to the options in
850 * 'netflow_options', or turns off NetFlow if 'netflow_options' is NULL.
852 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
853 * NetFlow, as does a null pointer. */
854 int (*set_netflow)(struct ofproto *ofproto,
855 const struct netflow_options *netflow_options);
857 void (*get_netflow_ids)(const struct ofproto *ofproto,
858 uint8_t *engine_type, uint8_t *engine_id);
860 /* Configures sFlow on 'ofproto' according to the options in
861 * 'sflow_options', or turns off sFlow if 'sflow_options' is NULL.
863 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
864 * sFlow, as does a null pointer. */
865 int (*set_sflow)(struct ofproto *ofproto,
866 const struct ofproto_sflow_options *sflow_options);
868 /* Configures connectivity fault management on 'ofport'.
870 * If 'cfm_settings' is nonnull, configures CFM according to its members.
872 * If 'cfm_settings' is null, removes any connectivity fault management
873 * configuration from 'ofport'.
875 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
876 * support CFM, as does a null pointer. */
877 int (*set_cfm)(struct ofport *ofport, const struct cfm_settings *s);
879 /* Checks the fault status of CFM configured on 'ofport'. Returns 1 if CFM
880 * is faulted (generally indicating a connectivity problem), 0 if CFM is
881 * not faulted, or -1 if CFM is not enabled on 'port'
883 * This function may be a null pointer if the ofproto implementation does
884 * not support CFM. */
885 int (*get_cfm_fault)(const struct ofport *ofport);
887 /* Gets the MPIDs of the remote maintenance points broadcasting to
888 * 'ofport'. Populates 'rmps' with a provider owned array of MPIDs, and
889 * 'n_rmps' with the number of MPIDs in 'rmps'. Returns a number less than
890 * 0 if CFM is not enabled of 'ofport'.
892 * This function may be a null pointer if the ofproto implementation does
893 * not support CFM. */
894 int (*get_cfm_remote_mpids)(const struct ofport *ofport,
895 const uint64_t **rmps, size_t *n_rmps);
897 /* If 's' is nonnull, this function registers a "bundle" associated with
898 * client data pointer 'aux' in 'ofproto'. A bundle is the same concept as
899 * a Port in OVSDB, that is, it consists of one or more "slave" devices
900 * (Interfaces, in OVSDB) along with VLAN and LACP configuration and, if
901 * there is more than one slave, a bonding configuration. If 'aux' is
902 * already registered then this function updates its configuration to 's'.
903 * Otherwise, this function registers a new bundle.
905 * If 's' is NULL, this function unregisters the bundle registered on
906 * 'ofproto' associated with client data pointer 'aux'. If no such bundle
907 * has been registered, this has no effect.
909 * This function affects only the behavior of the NXAST_AUTOPATH action and
910 * output to the OFPP_NORMAL port. An implementation that does not support
911 * it at all may set it to NULL or return EOPNOTSUPP. An implementation
912 * that supports only a subset of the functionality should implement what
913 * it can and return 0. */
914 int (*bundle_set)(struct ofproto *ofproto, void *aux,
915 const struct ofproto_bundle_settings *s);
917 /* If 'port' is part of any bundle, removes it from that bundle. If the
918 * bundle now has no ports, deletes the bundle. If the bundle now has only
919 * one port, deconfigures the bundle's bonding configuration. */
920 void (*bundle_remove)(struct ofport *ofport);
922 /* If 's' is nonnull, this function registers a mirror associated with
923 * client data pointer 'aux' in 'ofproto'. A mirror is the same concept as
924 * a Mirror in OVSDB. If 'aux' is already registered then this function
925 * updates its configuration to 's'. Otherwise, this function registers a
928 * If 's' is NULL, this function unregisters the mirror registered on
929 * 'ofproto' associated with client data pointer 'aux'. If no such mirror
930 * has been registered, this has no effect.
932 * This function affects only the behavior of the OFPP_NORMAL action. An
933 * implementation that does not support it at all may set it to NULL or
934 * return EOPNOTSUPP. An implementation that supports only a subset of the
935 * functionality should implement what it can and return 0. */
936 int (*mirror_set)(struct ofproto *ofproto, void *aux,
937 const struct ofproto_mirror_settings *s);
939 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs
940 * on which all packets are flooded, instead of using MAC learning. If
941 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
943 * This function affects only the behavior of the OFPP_NORMAL action. An
944 * implementation that does not support it may set it to NULL or return
946 int (*set_flood_vlans)(struct ofproto *ofproto,
947 unsigned long *flood_vlans);
949 /* Returns true if 'aux' is a registered bundle that is currently in use as
950 * the output for a mirror. */
951 bool (*is_mirror_output_bundle)(struct ofproto *ofproto, void *aux);
953 /* When the configuration option of forward_bpdu changes, this function
954 * will be invoked. */
955 void (*forward_bpdu_changed)(struct ofproto *ofproto);
958 extern const struct ofproto_class ofproto_dpif_class;
960 int ofproto_class_register(const struct ofproto_class *);
961 int ofproto_class_unregister(const struct ofproto_class *);
963 /* ofproto_flow_mod() returns this value if the flow_mod could not be processed
964 * because it overlaps with an ongoing flow table operation that has not yet
965 * completed. The caller should retry the operation later.
967 * ofproto.c also uses this value internally for additional (similar) purposes.
969 * This particular value is a good choice because it is negative (so it won't
970 * collide with any errno value or any value returned by ofp_mkerr()) and large
971 * (so it won't accidentally collide with EOF or a negative errno value). */
972 enum { OFPROTO_POSTPONE = -100000 };
974 int ofproto_flow_mod(struct ofproto *, const struct ofputil_flow_mod *);
975 void ofproto_add_flow(struct ofproto *, const struct cls_rule *,
976 const union ofp_action *, size_t n_actions);
977 bool ofproto_delete_flow(struct ofproto *, const struct cls_rule *);
978 void ofproto_flush_flows(struct ofproto *);
980 #endif /* ofproto/ofproto-provider.h */