2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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"
28 #include "ofp-errors.h"
36 struct ofputil_flow_mod;
40 /* An OpenFlow switch.
42 * With few exceptions, ofproto implementations may look at these fields but
43 * should not modify them. */
45 struct hmap_node hmap_node; /* In global 'all_ofprotos' hmap. */
46 const struct ofproto_class *ofproto_class;
47 char *type; /* Datapath type. */
48 char *name; /* Datapath name. */
51 uint64_t fallback_dpid; /* Datapath ID if no better choice found. */
52 uint64_t datapath_id; /* Datapath ID. */
53 bool forward_bpdu; /* Option to allow forwarding of BPDU frames
54 * when NORMAL action is invoked. */
55 char *mfr_desc; /* Manufacturer (NULL for default)b. */
56 char *hw_desc; /* Hardware (NULL for default). */
57 char *sw_desc; /* Software version (NULL for default). */
58 char *serial_desc; /* Serial number (NULL for default). */
59 char *dp_desc; /* Datapath description (NULL for default). */
60 enum ofp_config_flags frag_handling; /* One of OFPC_*. */
63 struct hmap ports; /* Contains "struct ofport"s. */
64 struct shash port_by_name;
65 unsigned long *ofp_port_ids;/* Bitmap of used OpenFlow port numbers. */
66 struct simap ofp_requests; /* OpenFlow port number requests. */
67 ofp_port_t alloc_port_no; /* Last allocated OpenFlow port number. */
68 ofp_port_t max_ports; /* Max possible OpenFlow port num, plus one. */
71 struct oftable *tables;
74 struct hindex cookies; /* Rules indexed on their cookie values. */
76 /* Optimisation for flow expiry.
77 * These flows should all be present in tables. */
78 struct list expirable; /* Expirable 'struct rule"s in all tables. */
81 * OpenFlow meters start at 1. To avoid confusion we leave the first
82 * pointer in the array un-used, and index directly with the OpenFlow
84 struct ofputil_meter_features meter_features;
85 struct meter **meters; /* 'meter_features.max_meter' + 1 pointers. */
87 /* OpenFlow connections. */
88 struct connmgr *connmgr;
90 /* Flow table operation tracking. */
91 int state; /* Internal state. */
92 struct list pending; /* List of "struct ofopgroup"s. */
93 unsigned int n_pending; /* list_size(&pending). */
94 struct hmap deletions; /* All OFOPERATION_DELETE "ofoperation"s. */
96 /* Flow table operation logging. */
97 int n_add, n_delete, n_modify; /* Number of unreported ops of each kind. */
98 long long int first_op, last_op; /* Range of times for unreported ops. */
99 long long int next_op_report; /* Time to report ops, or LLONG_MAX. */
100 long long int op_backoff; /* Earliest time to report ops again. */
102 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
104 * This is deprecated. It is only for compatibility with broken device
105 * drivers in old versions of Linux that do not properly support VLANs when
106 * VLAN devices are not used. When broken device drivers are no longer in
107 * widespread use, we will delete these interfaces. */
108 unsigned long int *vlan_bitmap; /* 4096-bit bitmap of in-use VLANs. */
109 bool vlans_changed; /* True if new VLANs are in use. */
110 int min_mtu; /* Current MTU of non-internal ports. */
113 void ofproto_init_tables(struct ofproto *, int n_tables);
114 void ofproto_init_max_ports(struct ofproto *, ofp_port_t max_ports);
116 struct ofproto *ofproto_lookup(const char *name);
117 struct ofport *ofproto_get_port(const struct ofproto *, ofp_port_t ofp_port);
119 /* An OpenFlow port within a "struct ofproto".
121 * With few exceptions, ofproto implementations may look at these fields but
122 * should not modify them. */
124 struct hmap_node hmap_node; /* In struct ofproto's "ports" hmap. */
125 struct ofproto *ofproto; /* The ofproto that contains this port. */
126 struct netdev *netdev;
127 struct ofputil_phy_port pp;
128 ofp_port_t ofp_port; /* OpenFlow port number. */
129 unsigned int change_seq;
130 long long int created; /* Time created, in msec. */
134 void ofproto_port_set_state(struct ofport *, enum ofputil_port_state);
136 /* OpenFlow table flags:
138 * - "Hidden" tables are not included in OpenFlow operations that operate on
139 * "all tables". For example, a request for flow stats on all tables will
140 * omit flows in hidden tables, table stats requests will omit the table
141 * entirely, and the switch features reply will not count the hidden table.
143 * However, operations that specifically name the particular table still
144 * operate on it. For example, flow_mods and flow stats requests on a
147 * To avoid gaps in table IDs (which have unclear validity in OpenFlow),
148 * hidden tables must be the highest-numbered tables that a provider
151 * - "Read-only" tables can't be changed through OpenFlow operations. (At
152 * the moment all flow table operations go effectively through OpenFlow, so
153 * this means that read-only tables can't be changed at all after the
154 * read-only flag is set.)
156 * The generic ofproto layer never sets these flags. An ofproto provider can
157 * set them if it is appropriate.
160 OFTABLE_HIDDEN = 1 << 0, /* Hide from most OpenFlow operations. */
161 OFTABLE_READONLY = 1 << 1 /* Don't allow OpenFlow to change this table. */
164 /* A flow table within a "struct ofproto". */
166 enum oftable_flags flags;
167 struct classifier cls; /* Contains "struct rule"s. */
168 char *name; /* Table name exposed via OpenFlow, or NULL. */
170 /* Maximum number of flows or UINT_MAX if there is no limit besides any
171 * limit imposed by resource limitations. */
172 unsigned int max_flows;
174 /* These members determine the handling of an attempt to add a flow that
175 * would cause the table to have more than 'max_flows' flows.
177 * If 'eviction_fields' is NULL, overflows will be rejected with an error.
179 * If 'eviction_fields' is nonnull (regardless of whether n_eviction_fields
180 * is nonzero), an overflow will cause a flow to be removed. The flow to
181 * be removed is chosen to give fairness among groups distinguished by
182 * different values for the subfields within 'groups'. */
183 struct mf_subfield *eviction_fields;
184 size_t n_eviction_fields;
188 * When a flow is added that would cause the table to have more than
189 * 'max_flows' flows, and 'eviction_fields' is nonnull, these groups are
190 * used to decide which rule to evict: the rule is chosen from the eviction
191 * group that contains the greatest number of rules.*/
192 uint32_t eviction_group_id_basis;
193 struct hmap eviction_groups_by_id;
194 struct heap eviction_groups_by_size;
197 /* Assigns TABLE to each oftable, in turn, in OFPROTO.
199 * All parameters are evaluated multiple times. */
200 #define OFPROTO_FOR_EACH_TABLE(TABLE, OFPROTO) \
201 for ((TABLE) = (OFPROTO)->tables; \
202 (TABLE) < &(OFPROTO)->tables[(OFPROTO)->n_tables]; \
205 /* An OpenFlow flow within a "struct ofproto".
207 * With few exceptions, ofproto implementations may look at these fields but
208 * should not modify them. */
210 struct list ofproto_node; /* Owned by ofproto base code. */
211 struct ofproto *ofproto; /* The ofproto that contains this rule. */
212 struct cls_rule cr; /* In owning ofproto's classifier. */
214 struct ofoperation *pending; /* Operation now in progress, if nonnull. */
216 ovs_be64 flow_cookie; /* Controller-issued identifier. */
217 struct hindex_node cookie_node; /* In owning ofproto's 'cookies' index. */
219 long long int created; /* Creation time. */
220 long long int modified; /* Time of last modification. */
221 long long int used; /* Last use; time created if never used. */
222 uint16_t hard_timeout; /* In seconds from ->modified. */
223 uint16_t idle_timeout; /* In seconds from ->used. */
224 uint8_t table_id; /* Index in ofproto's 'tables' array. */
225 bool send_flow_removed; /* Send a flow removed message? */
227 /* Eviction groups. */
228 bool evictable; /* If false, prevents eviction. */
229 struct heap_node evg_node; /* In eviction_group's "rules" heap. */
230 struct eviction_group *eviction_group; /* NULL if not in any group. */
232 struct ofpact *ofpacts; /* Sequence of "struct ofpacts". */
233 unsigned int ofpacts_len; /* Size of 'ofpacts', in bytes. */
235 uint32_t meter_id; /* Non-zero OF meter_id, or zero. */
236 struct list meter_list_node; /* In owning meter's 'rules' list. */
239 enum nx_flow_monitor_flags monitor_flags;
240 uint64_t add_seqno; /* Sequence number when added. */
241 uint64_t modify_seqno; /* Sequence number when changed. */
243 /* Optimisation for flow expiry. */
244 struct list expirable; /* In ofproto's 'expirable' list if this rule
245 * is expirable, otherwise empty. */
248 /* Threshold at which to begin flow table eviction. Only affects the
249 * ofproto-dpif implementation */
250 extern unsigned flow_eviction_threshold;
252 /* Determines which model to use for handling misses in the ofproto-dpif
254 extern enum ofproto_flow_miss_model flow_miss_model;
256 static inline struct rule *
257 rule_from_cls_rule(const struct cls_rule *cls_rule)
259 return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
262 void ofproto_rule_update_used(struct rule *, long long int used);
263 void ofproto_rule_expire(struct rule *, uint8_t reason);
264 void ofproto_rule_destroy(struct rule *);
266 bool ofproto_rule_has_out_port(const struct rule *, ofp_port_t out_port);
268 void ofoperation_complete(struct ofoperation *, enum ofperr);
269 struct rule *ofoperation_get_victim(struct ofoperation *);
271 bool ofoperation_has_out_port(const struct ofoperation *, ofp_port_t out_port);
273 bool ofproto_rule_is_hidden(const struct rule *);
275 /* ofproto class structure, to be defined by each ofproto implementation.
281 * These functions work primarily with three different kinds of data
284 * - "struct ofproto", which represents an OpenFlow switch.
286 * - "struct ofport", which represents a port within an ofproto.
288 * - "struct rule", which represents an OpenFlow flow within an ofproto.
290 * Each of these data structures contains all of the implementation-independent
291 * generic state for the respective concept, called the "base" state. None of
292 * them contains any extra space for ofproto implementations to use. Instead,
293 * each implementation is expected to declare its own data structure that
294 * contains an instance of the generic data structure plus additional
295 * implementation-specific members, called the "derived" state. The
296 * implementation can use casts or (preferably) the CONTAINER_OF macro to
297 * obtain access to derived state given only a pointer to the embedded generic
304 * Four stylized functions accompany each of these data structures:
306 * "alloc" "construct" "destruct" "dealloc"
307 * ------------ ---------------- --------------- --------------
308 * ofproto ->alloc ->construct ->destruct ->dealloc
309 * ofport ->port_alloc ->port_construct ->port_destruct ->port_dealloc
310 * rule ->rule_alloc ->rule_construct ->rule_destruct ->rule_dealloc
312 * Any instance of a given data structure goes through the following life
315 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
316 * fails, skip all the other steps.
318 * 2. The client initializes all of the data structure's base state. If this
319 * fails, skip to step 7.
321 * 3. The client calls the "construct" function. The implementation
322 * initializes derived state. It may refer to the already-initialized
323 * base state. If "construct" fails, skip to step 6.
325 * 4. The data structure is now initialized and in use.
327 * 5. When the data structure is no longer needed, the client calls the
328 * "destruct" function. The implementation uninitializes derived state.
329 * The base state has not been uninitialized yet, so the implementation
330 * may still refer to it.
332 * 6. The client uninitializes all of the data structure's base state.
334 * 7. The client calls the "dealloc" to free the raw memory. The
335 * implementation must not refer to base or derived state in the data
336 * structure, because it has already been uninitialized.
338 * Each "alloc" function allocates and returns a new instance of the respective
339 * data structure. The "alloc" function is not given any information about the
340 * use of the new data structure, so it cannot perform much initialization.
341 * Its purpose is just to ensure that the new data structure has enough room
342 * for base and derived state. It may return a null pointer if memory is not
343 * available, in which case none of the other functions is called.
345 * Each "construct" function initializes derived state in its respective data
346 * structure. When "construct" is called, all of the base state has already
347 * been initialized, so the "construct" function may refer to it. The
348 * "construct" function is allowed to fail, in which case the client calls the
349 * "dealloc" function (but not the "destruct" function).
351 * Each "destruct" function uninitializes and frees derived state in its
352 * respective data structure. When "destruct" is called, the base state has
353 * not yet been uninitialized, so the "destruct" function may refer to it. The
354 * "destruct" function is not allowed to fail.
356 * Each "dealloc" function frees raw memory that was allocated by the the
357 * "alloc" function. The memory's base and derived members might not have ever
358 * been initialized (but if "construct" returned successfully, then it has been
359 * "destruct"ed already). The "dealloc" function is not allowed to fail.
365 * Most of these functions return 0 if they are successful or a positive error
366 * code on failure. Depending on the function, valid error codes are either
367 * errno values or OFPERR_* OpenFlow error codes.
369 * Most of these functions are expected to execute synchronously, that is, to
370 * block as necessary to obtain a result. Thus, these functions may return
371 * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
372 * explicitly say those errors are a possibility. We may relax this
373 * requirement in the future if and when we encounter performance problems. */
374 struct ofproto_class {
375 /* ## ----------------- ## */
376 /* ## Factory Functions ## */
377 /* ## ----------------- ## */
379 /* Initializes provider. The caller may pass in 'iface_hints',
380 * which contains an shash of "struct iface_hint" elements indexed
381 * by the interface's name. The provider may use these hints to
382 * describe the startup configuration in order to reinitialize its
383 * state. The caller owns the provided data, so a provider must
384 * make copies of anything required. An ofproto provider must
385 * remove any existing state that is not described by the hint, and
386 * may choose to remove it all. */
387 void (*init)(const struct shash *iface_hints);
389 /* Enumerates the types of all support ofproto types into 'types'. The
390 * caller has already initialized 'types' and other ofproto classes might
391 * already have added names to it. */
392 void (*enumerate_types)(struct sset *types);
394 /* Enumerates the names of all existing datapath of the specified 'type'
395 * into 'names' 'all_dps'. The caller has already initialized 'names' as
398 * 'type' is one of the types enumerated by ->enumerate_types().
400 * Returns 0 if successful, otherwise a positive errno value.
402 int (*enumerate_names)(const char *type, struct sset *names);
404 /* Deletes the datapath with the specified 'type' and 'name'. The caller
405 * should have closed any open ofproto with this 'type' and 'name'; this
406 * function is allowed to fail if that is not the case.
408 * 'type' is one of the types enumerated by ->enumerate_types().
409 * 'name' is one of the names enumerated by ->enumerate_names() for 'type'.
411 * Returns 0 if successful, otherwise a positive errno value.
413 int (*del)(const char *type, const char *name);
415 /* Returns the type to pass to netdev_open() when a datapath of type
416 * 'datapath_type' has a port of type 'port_type', for a few special
417 * cases when a netdev type differs from a port type. For example,
418 * when using the userspace datapath, a port of type "internal"
419 * needs to be opened as "tap".
421 * Returns either 'type' itself or a string literal, which must not
423 const char *(*port_open_type)(const char *datapath_type,
424 const char *port_type);
426 /* ## ------------------------ ## */
427 /* ## Top-Level type Functions ## */
428 /* ## ------------------------ ## */
430 /* Performs any periodic activity required on ofprotos of type
433 * An ofproto provider may implement it or not, depending on whether
434 * it needs type-level maintenance.
436 * Returns 0 if successful, otherwise a positive errno value. */
437 int (*type_run)(const char *type);
439 /* Performs periodic activity required on ofprotos of type 'type'
440 * that needs to be done with the least possible latency.
442 * This is run multiple times per main loop. An ofproto provider may
443 * implement it or not, according to whether it provides a performance
444 * boost for that ofproto implementation.
446 * Returns 0 if successful, otherwise a positive errno value. */
447 int (*type_run_fast)(const char *type);
449 /* Causes the poll loop to wake up when a type 'type''s 'run'
450 * function needs to be called, e.g. by calling the timer or fd
451 * waiting functions in poll-loop.h.
453 * An ofproto provider may implement it or not, depending on whether
454 * it needs type-level maintenance. */
455 void (*type_wait)(const char *type);
457 /* ## --------------------------- ## */
458 /* ## Top-Level ofproto Functions ## */
459 /* ## --------------------------- ## */
461 /* Life-cycle functions for an "ofproto" (see "Life Cycle" above).
467 * ->construct() should not modify any base members of the ofproto. The
468 * client will initialize the ofproto's 'ports' and 'tables' members after
469 * construction is complete.
471 * When ->construct() is called, the client does not yet know how many flow
472 * tables the datapath supports, so ofproto->n_tables will be 0 and
473 * ofproto->tables will be NULL. ->construct() should call
474 * ofproto_init_tables() to allocate and initialize ofproto->n_tables and
475 * ofproto->tables. Each flow table will be initially empty, so
476 * ->construct() should delete flows from the underlying datapath, if
477 * necessary, rather than populating the tables.
479 * If the ofproto knows the maximum port number that the datapath can have,
480 * then it can call ofproto_init_max_ports(). If it does so, then the
481 * client will ensure that the actions it allows to be used through
482 * OpenFlow do not refer to ports above that maximum number.
484 * Only one ofproto instance needs to be supported for any given datapath.
485 * If a datapath is already open as part of one "ofproto", then another
486 * attempt to "construct" the same datapath as part of another ofproto is
487 * allowed to fail with an error.
489 * ->construct() returns 0 if successful, otherwise a positive errno
496 * If 'ofproto' has any pending asynchronous operations, ->destruct()
497 * must complete all of them by calling ofoperation_complete().
499 * ->destruct() must also destroy all remaining rules in the ofproto's
500 * tables, by passing each remaining rule to ofproto_rule_destroy(). The
501 * client will destroy the flow tables themselves after ->destruct()
504 struct ofproto *(*alloc)(void);
505 int (*construct)(struct ofproto *ofproto);
506 void (*destruct)(struct ofproto *ofproto);
507 void (*dealloc)(struct ofproto *ofproto);
509 /* Performs any periodic activity required by 'ofproto'. It should:
511 * - Call connmgr_send_packet_in() for each received packet that missed
512 * in the OpenFlow flow table or that had a OFPP_CONTROLLER output
515 * - Call ofproto_rule_expire() for each OpenFlow flow that has reached
516 * its hard_timeout or idle_timeout, to expire the flow.
518 * (But rules that are part of a pending operation, e.g. rules for
519 * which ->pending is true, may not expire.)
521 * Returns 0 if successful, otherwise a positive errno value. */
522 int (*run)(struct ofproto *ofproto);
524 /* Performs periodic activity required by 'ofproto' that needs to be done
525 * with the least possible latency.
527 * This is run multiple times per main loop. An ofproto provider may
528 * implement it or not, according to whether it provides a performance
529 * boost for that ofproto implementation. */
530 int (*run_fast)(struct ofproto *ofproto);
532 /* Causes the poll loop to wake up when 'ofproto''s 'run' function needs to
533 * be called, e.g. by calling the timer or fd waiting functions in
535 void (*wait)(struct ofproto *ofproto);
537 /* Adds some memory usage statistics for the implementation of 'ofproto'
538 * into 'usage', for use with memory_report().
540 * This function is optional. */
541 void (*get_memory_usage)(const struct ofproto *ofproto,
542 struct simap *usage);
544 /* Every "struct rule" in 'ofproto' is about to be deleted, one by one.
545 * This function may prepare for that, for example by clearing state in
546 * advance. It should *not* actually delete any "struct rule"s from
547 * 'ofproto', only prepare for it.
549 * This function is optional; it's really just for optimization in case
550 * it's cheaper to delete all the flows from your hardware in a single pass
551 * than to do it one by one. */
552 void (*flush)(struct ofproto *ofproto);
554 /* Helper for the OpenFlow OFPT_FEATURES_REQUEST request.
556 * The implementation should store true in '*arp_match_ip' if the switch
557 * supports matching IP addresses inside ARP requests and replies, false
560 * The implementation should store in '*actions' a bitmap of the supported
561 * OpenFlow actions. Vendor actions are not included in '*actions'. */
562 void (*get_features)(struct ofproto *ofproto,
564 enum ofputil_action_bitmap *actions);
566 /* Helper for the OpenFlow OFPST_TABLE statistics request.
568 * The 'ots' array contains 'ofproto->n_tables' elements. Each element is
571 * - 'table_id' to the array index.
573 * - 'name' to "table#" where # is the table ID.
575 * - 'match' and 'wildcards' to OFPXMT12_MASK.
577 * - 'write_actions' and 'apply_actions' to OFPAT12_OUTPUT.
579 * - 'write_setfields' and 'apply_setfields' to OFPXMT12_MASK.
581 * - 'metadata_match' and 'metadata_write' to UINT64_MAX.
583 * - 'instructions' to OFPIT11_ALL.
585 * - 'config' to OFPTC11_TABLE_MISS_MASK.
587 * - 'max_entries' to 1,000,000.
589 * - 'active_count' to the classifier_count() for the table.
591 * - 'lookup_count' and 'matched_count' to 0.
593 * The implementation should update any members in each element for which
594 * it has better values:
596 * - 'name' to a more meaningful name.
598 * - 'wildcards' to the set of wildcards actually supported by the table
599 * (if it doesn't support all OpenFlow wildcards).
601 * - 'instructions' to set the instructions actually supported by
604 * - 'write_actions' to set the write actions actually supported by
605 * the table (if it doesn't support all OpenFlow actions).
607 * - 'apply_actions' to set the apply actions actually supported by
608 * the table (if it doesn't support all OpenFlow actions).
610 * - 'write_setfields' to set the write setfields actually supported by
613 * - 'apply_setfields' to set the apply setfields actually supported by
616 * - 'max_entries' to the maximum number of flows actually supported by
619 * - 'lookup_count' to the number of packets looked up in this flow table
622 * - 'matched_count' to the number of packets looked up in this flow
623 * table so far that matched one of the flow entries.
625 * All of the members of struct ofp12_table_stats are in network byte
628 void (*get_tables)(struct ofproto *ofproto, struct ofp12_table_stats *ots);
630 /* ## ---------------- ## */
631 /* ## ofport Functions ## */
632 /* ## ---------------- ## */
634 /* Life-cycle functions for a "struct ofport" (see "Life Cycle" above).
636 * ->port_construct() should not modify any base members of the ofport.
637 * An ofproto implementation should use the 'ofp_port' member of
638 * "struct ofport" as the OpenFlow port number.
640 * ofports are managed by the base ofproto code. The ofproto
641 * implementation should only create and destroy them in response to calls
642 * to these functions. The base ofproto code will create and destroy
643 * ofports in the following situations:
645 * - Just after the ->construct() function is called, the base ofproto
646 * iterates over all of the implementation's ports, using
647 * ->port_dump_start() and related functions, and constructs an ofport
648 * for each dumped port.
650 * - If ->port_poll() reports that a specific port has changed, then the
651 * base ofproto will query that port with ->port_query_by_name() and
652 * construct or destruct ofports as necessary to reflect the updated
655 * - If ->port_poll() returns ENOBUFS to report an unspecified port set
656 * change, then the base ofproto will iterate over all of the
657 * implementation's ports, in the same way as at ofproto
658 * initialization, and construct and destruct ofports to reflect all of
661 * ->port_construct() returns 0 if successful, otherwise a positive errno
664 struct ofport *(*port_alloc)(void);
665 int (*port_construct)(struct ofport *ofport);
666 void (*port_destruct)(struct ofport *ofport);
667 void (*port_dealloc)(struct ofport *ofport);
669 /* Called after 'ofport->netdev' is replaced by a new netdev object. If
670 * the ofproto implementation uses the ofport's netdev internally, then it
671 * should switch to using the new one. The old one has been closed.
673 * An ofproto implementation that doesn't need to do anything in this
674 * function may use a null pointer. */
675 void (*port_modified)(struct ofport *ofport);
677 /* Called after an OpenFlow request changes a port's configuration.
678 * 'ofport->pp.config' contains the new configuration. 'old_config'
679 * contains the previous configuration.
681 * The caller implements OFPUTIL_PC_PORT_DOWN using netdev functions to
682 * turn NETDEV_UP on and off, so this function doesn't have to do anything
683 * for that bit (and it won't be called if that is the only bit that
685 void (*port_reconfigured)(struct ofport *ofport,
686 enum ofputil_port_config old_config);
688 /* Looks up a port named 'devname' in 'ofproto'. On success, initializes
689 * '*port' appropriately.
691 * The caller owns the data in 'port' and must free it with
692 * ofproto_port_destroy() when it is no longer needed. */
693 int (*port_query_by_name)(const struct ofproto *ofproto,
694 const char *devname, struct ofproto_port *port);
696 /* Attempts to add 'netdev' as a port on 'ofproto'. Returns 0 if
697 * successful, otherwise a positive errno value. The caller should
698 * inform the implementation of the OpenFlow port through the
699 * ->port_construct() method.
701 * It doesn't matter whether the new port will be returned by a later call
702 * to ->port_poll(); the implementation may do whatever is more
704 int (*port_add)(struct ofproto *ofproto, struct netdev *netdev);
706 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'. Returns
707 * 0 if successful, otherwise a positive errno value.
709 * It doesn't matter whether the new port will be returned by a later call
710 * to ->port_poll(); the implementation may do whatever is more
712 int (*port_del)(struct ofproto *ofproto, ofp_port_t ofp_port);
715 int (*port_get_stats)(const struct ofport *port,
716 struct netdev_stats *stats);
718 /* Port iteration functions.
720 * The client might not be entirely in control of the ports within an
721 * ofproto. Some hardware implementations, for example, might have a fixed
722 * set of ports in a datapath. For this reason, the client needs a way to
723 * iterate through all the ports that are actually in a datapath. These
724 * functions provide that functionality.
726 * The 'state' pointer provides the implementation a place to
727 * keep track of its position. Its format is opaque to the caller.
729 * The ofproto provider retains ownership of the data that it stores into
730 * ->port_dump_next()'s 'port' argument. The data must remain valid until
731 * at least the next call to ->port_dump_next() or ->port_dump_done() for
732 * 'state'. The caller will not modify or free it.
737 * ->port_dump_start() attempts to begin dumping the ports in 'ofproto'.
738 * On success, it should return 0 and initialize '*statep' with any data
739 * needed for iteration. On failure, returns a positive errno value, and
740 * the client will not call ->port_dump_next() or ->port_dump_done().
742 * ->port_dump_next() attempts to retrieve another port from 'ofproto' for
743 * 'state'. If there is another port, it should store the port's
744 * information into 'port' and return 0. It should return EOF if all ports
745 * have already been iterated. Otherwise, on error, it should return a
746 * positive errno value. This function will not be called again once it
747 * returns nonzero once for a given iteration (but the 'port_dump_done'
748 * function will be called afterward).
750 * ->port_dump_done() allows the implementation to release resources used
751 * for iteration. The caller might decide to stop iteration in the middle
752 * by calling this function before ->port_dump_next() returns nonzero.
760 * error = ofproto->ofproto_class->port_dump_start(ofproto, &state);
763 * struct ofproto_port port;
765 * error = ofproto->ofproto_class->port_dump_next(
766 * ofproto, state, &port);
770 * // Do something with 'port' here (without modifying or freeing
771 * // any of its data).
773 * ofproto->ofproto_class->port_dump_done(ofproto, state);
775 * // 'error' is now EOF (success) or a positive errno value (failure).
777 int (*port_dump_start)(const struct ofproto *ofproto, void **statep);
778 int (*port_dump_next)(const struct ofproto *ofproto, void *state,
779 struct ofproto_port *port);
780 int (*port_dump_done)(const struct ofproto *ofproto, void *state);
782 /* Polls for changes in the set of ports in 'ofproto'. If the set of ports
783 * in 'ofproto' has changed, then this function should do one of the
786 * - Preferably: store the name of the device that was added to or deleted
787 * from 'ofproto' in '*devnamep' and return 0. The caller is responsible
788 * for freeing '*devnamep' (with free()) when it no longer needs it.
790 * - Alternatively: return ENOBUFS, without indicating the device that was
793 * Occasional 'false positives', in which the function returns 0 while
794 * indicating a device that was not actually added or deleted or returns
795 * ENOBUFS without any change, are acceptable.
797 * The purpose of 'port_poll' is to let 'ofproto' know about changes made
798 * externally to the 'ofproto' object, e.g. by a system administrator via
799 * ovs-dpctl. Therefore, it's OK, and even preferable, for port_poll() to
800 * not report changes made through calls to 'port_add' or 'port_del' on the
801 * same 'ofproto' object. (But it's OK for it to report them too, just
802 * slightly less efficient.)
804 * If the set of ports in 'ofproto' has not changed, returns EAGAIN. May
805 * also return other positive errno values to indicate that something has
808 * If the set of ports in a datapath is fixed, or if the only way that the
809 * set of ports in a datapath can change is through ->port_add() and
810 * ->port_del(), then this function may be a null pointer.
812 int (*port_poll)(const struct ofproto *ofproto, char **devnamep);
814 /* Arranges for the poll loop to wake up when ->port_poll() will return a
815 * value other than EAGAIN.
817 * If the set of ports in a datapath is fixed, or if the only way that the
818 * set of ports in a datapath can change is through ->port_add() and
819 * ->port_del(), or if the poll loop will always wake up anyway when
820 * ->port_poll() will return a value other than EAGAIN, then this function
821 * may be a null pointer.
823 void (*port_poll_wait)(const struct ofproto *ofproto);
825 /* Checks the status of LACP negotiation for 'port'. Returns 1 if LACP
826 * partner information for 'port' is up-to-date, 0 if LACP partner
827 * information is not current (generally indicating a connectivity
828 * problem), or -1 if LACP is not enabled on 'port'.
830 * This function may be a null pointer if the ofproto implementation does
831 * not support LACP. */
832 int (*port_is_lacp_current)(const struct ofport *port);
834 /* ## ----------------------- ## */
835 /* ## OpenFlow Rule Functions ## */
836 /* ## ----------------------- ## */
838 /* Chooses an appropriate table for 'match' within 'ofproto'. On
839 * success, stores the table ID into '*table_idp' and returns 0. On
840 * failure, returns an OpenFlow error code.
842 * The choice of table should be a function of 'match' and 'ofproto''s
843 * datapath capabilities. It should not depend on the flows already in
844 * 'ofproto''s flow tables. Failure implies that an OpenFlow rule with
845 * 'match' as its matching condition can never be inserted into 'ofproto',
846 * even starting from an empty flow table.
848 * If multiple tables are candidates for inserting the flow, the function
849 * should choose one arbitrarily (but deterministically).
851 * If this function is NULL then table 0 is always chosen. */
852 enum ofperr (*rule_choose_table)(const struct ofproto *ofproto,
853 const struct match *match,
856 /* Life-cycle functions for a "struct rule" (see "Life Cycle" above).
859 * Asynchronous Operation Support
860 * ==============================
862 * The life-cycle operations on rules can operate asynchronously, meaning
863 * that ->rule_construct() and ->rule_destruct() only need to initiate
864 * their respective operations and do not need to wait for them to complete
865 * before they return. ->rule_modify_actions() also operates
868 * An ofproto implementation reports the success or failure of an
869 * asynchronous operation on a rule using the rule's 'pending' member,
870 * which points to a opaque "struct ofoperation" that represents the
871 * ongoing opreation. When the operation completes, the ofproto
872 * implementation calls ofoperation_complete(), passing the ofoperation and
873 * an error indication.
875 * Only the following contexts may call ofoperation_complete():
877 * - The function called to initiate the operation,
878 * e.g. ->rule_construct() or ->rule_destruct(). This is the best
879 * choice if the operation completes quickly.
881 * - The implementation's ->run() function.
883 * - The implementation's ->destruct() function.
885 * The ofproto base code updates the flow table optimistically, assuming
886 * that the operation will probably succeed:
888 * - ofproto adds or replaces the rule in the flow table before calling
889 * ->rule_construct().
891 * - ofproto updates the rule's actions before calling
892 * ->rule_modify_actions().
894 * - ofproto removes the rule before calling ->rule_destruct().
896 * With one exception, when an asynchronous operation completes with an
897 * error, ofoperation_complete() backs out the already applied changes:
899 * - If adding or replacing a rule in the flow table fails, ofproto
900 * removes the new rule or restores the original rule.
902 * - If modifying a rule's actions fails, ofproto restores the original
905 * - Removing a rule is not allowed to fail. It must always succeed.
907 * The ofproto base code serializes operations: if any operation is in
908 * progress on a given rule, ofproto postpones initiating any new operation
909 * on that rule until the pending operation completes. Therefore, every
910 * operation must eventually complete through a call to
911 * ofoperation_complete() to avoid delaying new operations indefinitely
912 * (including any OpenFlow request that affects the rule in question, even
913 * just to query its statistics).
919 * When ->rule_construct() is called, the caller has already inserted
920 * 'rule' into 'rule->ofproto''s flow table numbered 'rule->table_id'.
921 * There are two cases:
923 * - 'rule' is a new rule in its flow table. In this case,
924 * ofoperation_get_victim(rule) returns NULL.
926 * - 'rule' is replacing an existing rule in its flow table that had the
927 * same matching criteria and priority. In this case,
928 * ofoperation_get_victim(rule) returns the rule being replaced (the
931 * ->rule_construct() should set the following in motion:
933 * - Validate that the matching rule in 'rule->cr' is supported by the
934 * datapath. For example, if the rule's table does not support
935 * registers, then it is an error if 'rule->cr' does not wildcard all
938 * - Validate that the datapath can correctly implement 'rule->ofpacts'.
940 * - If the rule is valid, update the datapath flow table, adding the new
941 * rule or replacing the existing one.
943 * - If 'rule' is replacing an existing rule, uninitialize any derived
944 * state for the victim rule, as in step 5 in the "Life Cycle"
947 * (On failure, the ofproto code will roll back the insertion from the flow
948 * table, either removing 'rule' or replacing it by the victim rule if
951 * ->rule_construct() must act in one of the following ways:
953 * - If it succeeds, it must call ofoperation_complete() and return 0.
955 * - If it fails, it must act in one of the following ways:
957 * * Call ofoperation_complete() and return 0.
959 * * Return an OpenFlow error code. (Do not call
960 * ofoperation_complete() in this case.)
962 * Either way, ->rule_destruct() will not be called for 'rule', but
963 * ->rule_dealloc() will be.
965 * - If the operation is only partially complete, then it must return 0.
966 * Later, when the operation is complete, the ->run() or ->destruct()
967 * function must call ofoperation_complete() to report success or
970 * ->rule_construct() should not modify any base members of struct rule.
976 * When ->rule_destruct() is called, the caller has already removed 'rule'
977 * from 'rule->ofproto''s flow table. ->rule_destruct() should set in
978 * motion removing 'rule' from the datapath flow table. If removal
979 * completes synchronously, it should call ofoperation_complete().
980 * Otherwise, the ->run() or ->destruct() function must later call
981 * ofoperation_complete() after the operation completes.
983 * Rule destruction must not fail. */
984 struct rule *(*rule_alloc)(void);
985 enum ofperr (*rule_construct)(struct rule *rule);
986 void (*rule_destruct)(struct rule *rule);
987 void (*rule_dealloc)(struct rule *rule);
989 /* Obtains statistics for 'rule', storing the number of packets that have
990 * matched it in '*packet_count' and the number of bytes in those packets
991 * in '*byte_count'. UINT64_MAX indicates that the packet count or byte
992 * count is unknown. */
993 void (*rule_get_stats)(struct rule *rule, uint64_t *packet_count,
994 uint64_t *byte_count);
996 /* Applies the actions in 'rule' to 'packet'. (This implements sending
997 * buffered packets for OpenFlow OFPT_FLOW_MOD commands.)
999 * Takes ownership of 'packet' (so it should eventually free it, with
1002 * 'flow' reflects the flow information for 'packet'. All of the
1003 * information in 'flow' is extracted from 'packet', except for
1004 * flow->tunnel and flow->in_port, which are assigned the correct values
1005 * for the incoming packet. The register values are zeroed. 'packet''s
1006 * header pointers (e.g. packet->l3) are appropriately initialized.
1008 * The implementation should add the statistics for 'packet' into 'rule'.
1010 * Returns 0 if successful, otherwise an OpenFlow error code. */
1011 enum ofperr (*rule_execute)(struct rule *rule, const struct flow *flow,
1012 struct ofpbuf *packet);
1014 /* When ->rule_modify_actions() is called, the caller has already replaced
1015 * the OpenFlow actions in 'rule' by a new set. (The original actions are
1016 * in rule->pending->actions.)
1018 * ->rule_modify_actions() should set the following in motion:
1020 * - Validate that the datapath can correctly implement the actions now
1023 * - Update the datapath flow table with the new actions.
1025 * If the operation synchronously completes, ->rule_modify_actions() may
1026 * call ofoperation_complete() before it returns. Otherwise, ->run()
1027 * should call ofoperation_complete() later, after the operation does
1030 * If the operation fails, then the base ofproto code will restore the
1031 * original 'actions' and 'n_actions' of 'rule'.
1033 * ->rule_modify_actions() should not modify any base members of struct
1035 void (*rule_modify_actions)(struct rule *rule);
1037 /* Changes the OpenFlow IP fragment handling policy to 'frag_handling',
1038 * which takes one of the following values, with the corresponding
1041 * - OFPC_FRAG_NORMAL: The switch should treat IP fragments the same way
1042 * as other packets, omitting TCP and UDP port numbers (always setting
1045 * - OFPC_FRAG_DROP: The switch should drop all IP fragments without
1046 * passing them through the flow table.
1048 * - OFPC_FRAG_REASM: The switch should reassemble IP fragments before
1049 * passing packets through the flow table.
1051 * - OFPC_FRAG_NX_MATCH (a Nicira extension): Similar to OFPC_FRAG_NORMAL,
1052 * except that TCP and UDP port numbers should be included in fragments
1055 * Implementations are not required to support every mode.
1056 * OFPC_FRAG_NORMAL is the default mode when an ofproto is created.
1058 * At the time of the call to ->set_frag_handling(), the current mode is
1059 * available in 'ofproto->frag_handling'. ->set_frag_handling() returns
1060 * true if the requested mode was set, false if it is not supported.
1062 * Upon successful return, the caller changes 'ofproto->frag_handling' to
1063 * reflect the new mode.
1065 bool (*set_frag_handling)(struct ofproto *ofproto,
1066 enum ofp_config_flags frag_handling);
1068 /* Implements the OpenFlow OFPT_PACKET_OUT command. The datapath should
1069 * execute the 'ofpacts_len' bytes of "struct ofpacts" in 'ofpacts'.
1071 * The caller retains ownership of 'packet' and of 'ofpacts', so
1072 * ->packet_out() should not modify or free them.
1074 * This function must validate that it can correctly implement 'ofpacts'.
1075 * If not, then it should return an OpenFlow error code.
1077 * 'flow' reflects the flow information for 'packet'. All of the
1078 * information in 'flow' is extracted from 'packet', except for
1079 * flow->in_port (see below). flow->tunnel and its register values are
1082 * flow->in_port comes from the OpenFlow OFPT_PACKET_OUT message. The
1083 * implementation should reject invalid flow->in_port values by returning
1084 * OFPERR_OFPBRC_BAD_PORT. (If the implementation called
1085 * ofproto_init_max_ports(), then the client will reject these ports
1086 * itself.) For consistency, the implementation should consider valid for
1087 * flow->in_port any value that could possibly be seen in a packet that it
1088 * passes to connmgr_send_packet_in(). Ideally, even an implementation
1089 * that never generates packet-ins (e.g. due to hardware limitations)
1090 * should still allow flow->in_port values for every possible physical port
1091 * and OFPP_LOCAL. The only virtual ports (those above OFPP_MAX) that the
1092 * caller will ever pass in as flow->in_port, other than OFPP_LOCAL, are
1093 * OFPP_NONE and OFPP_CONTROLLER. The implementation should allow both of
1094 * these, treating each of them as packets generated by the controller as
1095 * opposed to packets originating from some switch port.
1097 * (Ordinarily the only effect of flow->in_port is on output actions that
1098 * involve the input port, such as actions that output to OFPP_IN_PORT,
1099 * OFPP_FLOOD, or OFPP_ALL. flow->in_port can also affect Nicira extension
1100 * "resubmit" actions.)
1102 * 'packet' is not matched against the OpenFlow flow table, so its
1103 * statistics should not be included in OpenFlow flow statistics.
1105 * Returns 0 if successful, otherwise an OpenFlow error code. */
1106 enum ofperr (*packet_out)(struct ofproto *ofproto, struct ofpbuf *packet,
1107 const struct flow *flow,
1108 const struct ofpact *ofpacts,
1109 size_t ofpacts_len);
1111 /* ## ------------------------- ## */
1112 /* ## OFPP_NORMAL configuration ## */
1113 /* ## ------------------------- ## */
1115 /* Configures NetFlow on 'ofproto' according to the options in
1116 * 'netflow_options', or turns off NetFlow if 'netflow_options' is NULL.
1118 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1119 * NetFlow, as does a null pointer. */
1120 int (*set_netflow)(struct ofproto *ofproto,
1121 const struct netflow_options *netflow_options);
1123 void (*get_netflow_ids)(const struct ofproto *ofproto,
1124 uint8_t *engine_type, uint8_t *engine_id);
1126 /* Configures sFlow on 'ofproto' according to the options in
1127 * 'sflow_options', or turns off sFlow if 'sflow_options' is NULL.
1129 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1130 * sFlow, as does a null pointer. */
1131 int (*set_sflow)(struct ofproto *ofproto,
1132 const struct ofproto_sflow_options *sflow_options);
1134 /* Configures IPFIX on 'ofproto' according to the options in
1135 * 'bridge_exporter_options' and the 'flow_exporters_options'
1136 * array, or turns off IPFIX if 'bridge_exporter_options' and
1137 * 'flow_exporters_options' is NULL.
1139 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1140 * IPFIX, as does a null pointer. */
1142 struct ofproto *ofproto,
1143 const struct ofproto_ipfix_bridge_exporter_options
1144 *bridge_exporter_options,
1145 const struct ofproto_ipfix_flow_exporter_options
1146 *flow_exporters_options, size_t n_flow_exporters_options);
1148 /* Configures connectivity fault management on 'ofport'.
1150 * If 'cfm_settings' is nonnull, configures CFM according to its members.
1152 * If 'cfm_settings' is null, removes any connectivity fault management
1153 * configuration from 'ofport'.
1155 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1156 * support CFM, as does a null pointer. */
1157 int (*set_cfm)(struct ofport *ofport, const struct cfm_settings *s);
1159 /* Checks the status of CFM configured on 'ofport'. Returns true if the
1160 * port's CFM status was successfully stored into '*status'. Returns false
1161 * if the port did not have CFM configured, in which case '*status' is
1164 * The caller must provide and owns '*status', but it does not own and must
1165 * not modify or free the array returned in 'status->rmps'. */
1166 bool (*get_cfm_status)(const struct ofport *ofport,
1167 struct ofproto_cfm_status *status);
1169 /* Configures BFD on 'ofport'.
1171 * If 'cfg' is NULL, or 'cfg' does not contain the key value pair
1172 * "enable=true", removes BFD from 'ofport'. Otherwise, configures BFD
1173 * according to 'cfg'.
1175 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1176 * support BFD, as does a null pointer. */
1177 int (*set_bfd)(struct ofport *ofport, const struct smap *cfg);
1179 /* Populates 'smap' with the status of BFD on 'ofport'. Returns 0 on
1180 * success, or a positive errno. EOPNOTSUPP as a return value indicates
1181 * that this ofproto_class does not support BFD, as does a null pointer. */
1182 int (*get_bfd_status)(struct ofport *ofport, struct smap *smap);
1184 /* Configures spanning tree protocol (STP) on 'ofproto' using the
1185 * settings defined in 's'.
1187 * If 's' is nonnull, configures STP according to its members.
1189 * If 's' is null, removes any STP configuration from 'ofproto'.
1191 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1192 * support STP, as does a null pointer. */
1193 int (*set_stp)(struct ofproto *ofproto,
1194 const struct ofproto_stp_settings *s);
1196 /* Retrieves state of spanning tree protocol (STP) on 'ofproto'.
1198 * Stores STP state for 'ofproto' in 's'. If the 'enabled' member
1199 * is false, the other member values are not meaningful.
1201 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1202 * support STP, as does a null pointer. */
1203 int (*get_stp_status)(struct ofproto *ofproto,
1204 struct ofproto_stp_status *s);
1206 /* Configures spanning tree protocol (STP) on 'ofport' using the
1207 * settings defined in 's'.
1209 * If 's' is nonnull, configures STP according to its members. The
1210 * caller is responsible for assigning STP port numbers (using the
1211 * 'port_num' member in the range of 1 through 255, inclusive) and
1212 * ensuring there are no duplicates.
1214 * If 's' is null, removes any STP configuration from 'ofport'.
1216 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1217 * support STP, as does a null pointer. */
1218 int (*set_stp_port)(struct ofport *ofport,
1219 const struct ofproto_port_stp_settings *s);
1221 /* Retrieves spanning tree protocol (STP) port status of 'ofport'.
1223 * Stores STP state for 'ofport' in 's'. If the 'enabled' member is
1224 * false, the other member values are not meaningful.
1226 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1227 * support STP, as does a null pointer. */
1228 int (*get_stp_port_status)(struct ofport *ofport,
1229 struct ofproto_port_stp_status *s);
1231 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1232 * 'queues' attached to 'ofport'. This data is not intended to be
1233 * sufficient to implement QoS. Instead, providers may use this
1234 * information to implement features which require knowledge of what queues
1235 * exist on a port, and some basic information about them.
1237 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1238 * support QoS, as does a null pointer. */
1239 int (*set_queues)(struct ofport *ofport,
1240 const struct ofproto_port_queue *queues, size_t n_qdscp);
1242 /* If 's' is nonnull, this function registers a "bundle" associated with
1243 * client data pointer 'aux' in 'ofproto'. A bundle is the same concept as
1244 * a Port in OVSDB, that is, it consists of one or more "slave" devices
1245 * (Interfaces, in OVSDB) along with VLAN and LACP configuration and, if
1246 * there is more than one slave, a bonding configuration. If 'aux' is
1247 * already registered then this function updates its configuration to 's'.
1248 * Otherwise, this function registers a new bundle.
1250 * If 's' is NULL, this function unregisters the bundle registered on
1251 * 'ofproto' associated with client data pointer 'aux'. If no such bundle
1252 * has been registered, this has no effect.
1254 * This function affects only the behavior of the NXAST_AUTOPATH action and
1255 * output to the OFPP_NORMAL port. An implementation that does not support
1256 * it at all may set it to NULL or return EOPNOTSUPP. An implementation
1257 * that supports only a subset of the functionality should implement what
1258 * it can and return 0. */
1259 int (*bundle_set)(struct ofproto *ofproto, void *aux,
1260 const struct ofproto_bundle_settings *s);
1262 /* If 'port' is part of any bundle, removes it from that bundle. If the
1263 * bundle now has no ports, deletes the bundle. If the bundle now has only
1264 * one port, deconfigures the bundle's bonding configuration. */
1265 void (*bundle_remove)(struct ofport *ofport);
1267 /* If 's' is nonnull, this function registers a mirror associated with
1268 * client data pointer 'aux' in 'ofproto'. A mirror is the same concept as
1269 * a Mirror in OVSDB. If 'aux' is already registered then this function
1270 * updates its configuration to 's'. Otherwise, this function registers a
1273 * If 's' is NULL, this function unregisters the mirror registered on
1274 * 'ofproto' associated with client data pointer 'aux'. If no such mirror
1275 * has been registered, this has no effect.
1277 * An implementation that does not support mirroring at all may set
1278 * it to NULL or return EOPNOTSUPP. An implementation that supports
1279 * only a subset of the functionality should implement what it can
1281 int (*mirror_set)(struct ofproto *ofproto, void *aux,
1282 const struct ofproto_mirror_settings *s);
1284 /* Retrieves statistics from mirror associated with client data
1285 * pointer 'aux' in 'ofproto'. Stores packet and byte counts in
1286 * 'packets' and 'bytes', respectively. If a particular counter is
1287 * not supported, the appropriate argument is set to UINT64_MAX.
1289 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1290 * support retrieving mirror statistics. */
1291 int (*mirror_get_stats)(struct ofproto *ofproto, void *aux,
1292 uint64_t *packets, uint64_t *bytes);
1294 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs
1295 * on which all packets are flooded, instead of using MAC learning. If
1296 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1298 * This function affects only the behavior of the OFPP_NORMAL action. An
1299 * implementation that does not support it may set it to NULL or return
1301 int (*set_flood_vlans)(struct ofproto *ofproto,
1302 unsigned long *flood_vlans);
1304 /* Returns true if 'aux' is a registered bundle that is currently in use as
1305 * the output for a mirror. */
1306 bool (*is_mirror_output_bundle)(const struct ofproto *ofproto, void *aux);
1308 /* When the configuration option of forward_bpdu changes, this function
1309 * will be invoked. */
1310 void (*forward_bpdu_changed)(struct ofproto *ofproto);
1312 /* Sets the MAC aging timeout for the OFPP_NORMAL action to 'idle_time', in
1313 * seconds, and the maximum number of MAC table entries to
1316 * An implementation that doesn't support configuring these features may
1317 * set this function to NULL or implement it as a no-op. */
1318 void (*set_mac_table_config)(struct ofproto *ofproto,
1319 unsigned int idle_time, size_t max_entries);
1321 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
1323 * This is deprecated. It is only for compatibility with broken device drivers
1324 * in old versions of Linux that do not properly support VLANs when VLAN
1325 * devices are not used. When broken device drivers are no longer in
1326 * widespread use, we will delete these interfaces. */
1328 /* If 'realdev_ofp_port' is nonzero, then this function configures 'ofport'
1329 * as a VLAN splinter port for VLAN 'vid', associated with the real device
1330 * that has OpenFlow port number 'realdev_ofp_port'.
1332 * If 'realdev_ofp_port' is zero, then this function deconfigures 'ofport'
1333 * as a VLAN splinter port.
1335 * This function should be NULL if an implementation does not support it.
1337 int (*set_realdev)(struct ofport *ofport,
1338 ofp_port_t realdev_ofp_port, int vid);
1340 /* ## ------------------------ ## */
1341 /* ## OpenFlow meter functions ## */
1342 /* ## ------------------------ ## */
1344 /* These functions should be NULL if an implementation does not support
1345 * them. They must be all null or all non-null.. */
1347 /* Initializes 'features' to describe the metering features supported by
1349 void (*meter_get_features)(const struct ofproto *ofproto,
1350 struct ofputil_meter_features *features);
1352 /* If '*id' is UINT32_MAX, adds a new meter with the given 'config'. On
1353 * success the function must store a provider meter ID other than
1354 * UINT32_MAX in '*id'. All further references to the meter will be made
1355 * with the returned provider meter id rather than the OpenFlow meter id.
1356 * The caller does not try to interpret the provider meter id, giving the
1357 * implementation the freedom to either use the OpenFlow meter_id value
1358 * provided in the meter configuration, or any other value suitable for the
1361 * If '*id' is a value other than UINT32_MAX, modifies the existing meter
1362 * with that meter provider ID to have configuration 'config'. On failure,
1363 * the existing meter configuration is left intact. Regardless of success,
1364 * any change to '*id' updates the provider meter id used for this
1366 enum ofperr (*meter_set)(struct ofproto *ofproto, ofproto_meter_id *id,
1367 const struct ofputil_meter_config *config);
1369 /* Gets the meter and meter band packet and byte counts for maximum of
1370 * 'stats->n_bands' bands for the meter with provider ID 'id' within
1371 * 'ofproto'. The caller fills in the other stats values. The band stats
1372 * are copied to memory at 'stats->bands' provided by the caller. The
1373 * number of returned band stats is returned in 'stats->n_bands'. */
1374 enum ofperr (*meter_get)(const struct ofproto *ofproto,
1375 ofproto_meter_id id,
1376 struct ofputil_meter_stats *stats);
1378 /* Deletes a meter, making the 'ofproto_meter_id' invalid for any
1380 void (*meter_del)(struct ofproto *, ofproto_meter_id);
1383 extern const struct ofproto_class ofproto_dpif_class;
1385 int ofproto_class_register(const struct ofproto_class *);
1386 int ofproto_class_unregister(const struct ofproto_class *);
1388 /* ofproto_flow_mod() returns this value if the flow_mod could not be processed
1389 * because it overlaps with an ongoing flow table operation that has not yet
1390 * completed. The caller should retry the operation later.
1392 * ofproto.c also uses this value internally for additional (similar) purposes.
1394 * This particular value is a good choice because it is large, so that it does
1395 * not collide with any errno value, but not large enough to collide with an
1396 * OFPERR_* value. */
1397 enum { OFPROTO_POSTPONE = 1 << 16 };
1398 BUILD_ASSERT_DECL(OFPROTO_POSTPONE < OFPERR_OFS);
1400 int ofproto_flow_mod(struct ofproto *, struct ofputil_flow_mod *);
1401 void ofproto_add_flow(struct ofproto *, const struct match *,
1402 unsigned int priority,
1403 const struct ofpact *ofpacts, size_t ofpacts_len);
1404 bool ofproto_delete_flow(struct ofproto *,
1405 const struct match *, unsigned int priority);
1406 void ofproto_flush_flows(struct ofproto *);
1408 #endif /* ofproto/ofproto-provider.h */