]> git.proxmox.com Git - ovs.git/blob - ofproto/ofproto-provider.h
Implement OFPT_TABLE_STATUS Message.
[ovs.git] / ofproto / ofproto-provider.h
1 /*
2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Nicira, Inc.
3 *
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:
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
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.
15 */
16
17 #ifndef OFPROTO_OFPROTO_PROVIDER_H
18 #define OFPROTO_OFPROTO_PROVIDER_H 1
19
20 /* Definitions for use within ofproto.
21 *
22 *
23 * Thread-safety
24 * =============
25 *
26 * Lots of ofproto data structures are only accessed from a single thread.
27 * Those data structures are generally not thread-safe.
28 *
29 * The ofproto-dpif ofproto implementation accesses the flow table from
30 * multiple threads, including modifying the flow table from multiple threads
31 * via the "learn" action, so the flow table and various structures that index
32 * it have been made thread-safe. Refer to comments on individual data
33 * structures for details.
34 */
35
36 #include "cfm.h"
37 #include "classifier.h"
38 #include "guarded-list.h"
39 #include "heap.h"
40 #include "hindex.h"
41 #include "list.h"
42 #include "ofp-actions.h"
43 #include "ofp-errors.h"
44 #include "ofp-util.h"
45 #include "ofproto/ofproto.h"
46 #include "ovs-atomic.h"
47 #include "ovs-rcu.h"
48 #include "ovs-thread.h"
49 #include "shash.h"
50 #include "simap.h"
51 #include "timeval.h"
52
53 struct match;
54 struct ofputil_flow_mod;
55 struct bfd_cfg;
56 struct meter;
57 struct ofoperation;
58
59 extern struct ovs_mutex ofproto_mutex;
60
61 /* An OpenFlow switch.
62 *
63 * With few exceptions, ofproto implementations may look at these fields but
64 * should not modify them. */
65 struct ofproto {
66 struct hmap_node hmap_node; /* In global 'all_ofprotos' hmap. */
67 const struct ofproto_class *ofproto_class;
68 char *type; /* Datapath type. */
69 char *name; /* Datapath name. */
70
71 /* Settings. */
72 uint64_t fallback_dpid; /* Datapath ID if no better choice found. */
73 uint64_t datapath_id; /* Datapath ID. */
74 bool forward_bpdu; /* Option to allow forwarding of BPDU frames
75 * when NORMAL action is invoked. */
76 char *mfr_desc; /* Manufacturer (NULL for default). */
77 char *hw_desc; /* Hardware (NULL for default). */
78 char *sw_desc; /* Software version (NULL for default). */
79 char *serial_desc; /* Serial number (NULL for default). */
80 char *dp_desc; /* Datapath description (NULL for default). */
81 enum ofputil_frag_handling frag_handling;
82
83 /* Datapath. */
84 struct hmap ports; /* Contains "struct ofport"s. */
85 struct shash port_by_name;
86 struct simap ofp_requests; /* OpenFlow port number requests. */
87 uint16_t alloc_port_no; /* Last allocated OpenFlow port number. */
88 uint16_t max_ports; /* Max possible OpenFlow port num, plus one. */
89 struct hmap ofport_usage; /* Map ofport to last used time. */
90 uint64_t change_seq; /* Change sequence for netdev status. */
91
92 /* Flow tables. */
93 long long int eviction_group_timer; /* For rate limited reheapification. */
94 struct oftable *tables;
95 int n_tables;
96 cls_version_t tables_version; /* Controls which rules are visible to
97 * table lookups. */
98
99 /* Rules indexed on their cookie values, in all flow tables. */
100 struct hindex cookies OVS_GUARDED_BY(ofproto_mutex);
101 struct hmap learned_cookies OVS_GUARDED_BY(ofproto_mutex);
102
103 /* List of expirable flows, in all flow tables. */
104 struct ovs_list expirable OVS_GUARDED_BY(ofproto_mutex);
105
106 /* Meter table.
107 * OpenFlow meters start at 1. To avoid confusion we leave the first
108 * pointer in the array un-used, and index directly with the OpenFlow
109 * meter_id. */
110 struct ofputil_meter_features meter_features;
111 struct meter **meters; /* 'meter_features.max_meter' + 1 pointers. */
112
113 /* OpenFlow connections. */
114 struct connmgr *connmgr;
115
116 /* Delayed rule executions.
117 *
118 * We delay calls to ->ofproto_class->rule_execute() past releasing
119 * ofproto_mutex during a flow_mod, because otherwise a "learn" action
120 * triggered by the executing the packet would try to recursively modify
121 * the flow table and reacquire the global lock. */
122 struct guarded_list rule_executes; /* Contains "struct rule_execute"s. */
123
124 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
125 *
126 * This is deprecated. It is only for compatibility with broken device
127 * drivers in old versions of Linux that do not properly support VLANs when
128 * VLAN devices are not used. When broken device drivers are no longer in
129 * widespread use, we will delete these interfaces. */
130 unsigned long int *vlan_bitmap; /* 4096-bit bitmap of in-use VLANs. */
131 bool vlans_changed; /* True if new VLANs are in use. */
132 int min_mtu; /* Current MTU of non-internal ports. */
133
134 /* Groups. */
135 struct ovs_rwlock groups_rwlock;
136 struct hmap groups OVS_GUARDED; /* Contains "struct ofgroup"s. */
137 uint32_t n_groups[4] OVS_GUARDED; /* # of existing groups of each type. */
138 struct ofputil_group_features ogf;
139 };
140
141 void ofproto_init_tables(struct ofproto *, int n_tables);
142 void ofproto_init_max_ports(struct ofproto *, uint16_t max_ports);
143
144 struct ofproto *ofproto_lookup(const char *name);
145 struct ofport *ofproto_get_port(const struct ofproto *, ofp_port_t ofp_port);
146
147 /* An OpenFlow port within a "struct ofproto".
148 *
149 * The port's name is netdev_get_name(port->netdev).
150 *
151 * With few exceptions, ofproto implementations may look at these fields but
152 * should not modify them. */
153 struct ofport {
154 struct hmap_node hmap_node; /* In struct ofproto's "ports" hmap. */
155 struct ofproto *ofproto; /* The ofproto that contains this port. */
156 struct netdev *netdev;
157 struct ofputil_phy_port pp;
158 ofp_port_t ofp_port; /* OpenFlow port number. */
159 uint64_t change_seq;
160 long long int created; /* Time created, in msec. */
161 int mtu;
162 };
163
164 void ofproto_port_set_state(struct ofport *, enum ofputil_port_state);
165
166 /* OpenFlow table flags:
167 *
168 * - "Hidden" tables are not included in OpenFlow operations that operate on
169 * "all tables". For example, a request for flow stats on all tables will
170 * omit flows in hidden tables, table stats requests will omit the table
171 * entirely, and the switch features reply will not count the hidden table.
172 *
173 * However, operations that specifically name the particular table still
174 * operate on it. For example, flow_mods and flow stats requests on a
175 * hidden table work.
176 *
177 * To avoid gaps in table IDs (which have unclear validity in OpenFlow),
178 * hidden tables must be the highest-numbered tables that a provider
179 * implements.
180 *
181 * - "Read-only" tables can't be changed through OpenFlow operations. (At
182 * the moment all flow table operations go effectively through OpenFlow, so
183 * this means that read-only tables can't be changed at all after the
184 * read-only flag is set.)
185 *
186 * The generic ofproto layer never sets these flags. An ofproto provider can
187 * set them if it is appropriate.
188 */
189 enum oftable_flags {
190 OFTABLE_HIDDEN = 1 << 0, /* Hide from most OpenFlow operations. */
191 OFTABLE_READONLY = 1 << 1 /* Don't allow OpenFlow controller to change
192 this table. */
193 };
194
195 /* A flow table within a "struct ofproto".
196 *
197 *
198 * Thread-safety
199 * =============
200 *
201 * Adding or removing rules requires holding ofproto_mutex.
202 *
203 * Rules in 'cls' are RCU protected. For extended access to a rule, try
204 * incrementing its ref_count with ofproto_rule_try_ref(), or
205 * ofproto_rule_ref(), if the rule is still known to be in 'cls'. A rule
206 * will be freed using ovsrcu_postpone() once its 'ref_count' reaches zero.
207 *
208 * Modifying a rule requires the rule's own mutex.
209 *
210 * Freeing a rule requires ofproto_mutex. After removing the rule from the
211 * classifier, release a ref_count from the rule ('cls''s reference to the
212 * rule).
213 *
214 * Refer to the thread-safety notes on struct rule for more information.*/
215 struct oftable {
216 enum oftable_flags flags;
217 struct classifier cls; /* Contains "struct rule"s. */
218 char *name; /* Table name exposed via OpenFlow, or NULL. */
219
220 /* Maximum number of flows or UINT_MAX if there is no limit besides any
221 * limit imposed by resource limitations. */
222 unsigned int max_flows;
223 /* Current number of flows, not counting temporary duplicates nor deferred
224 * deletions. */
225 unsigned int n_flows;
226
227 /* These members determine the handling of an attempt to add a flow that
228 * would cause the table to have more than 'max_flows' flows.
229 *
230 * If 'eviction_fields' is NULL, overflows will be rejected with an error.
231 *
232 * If 'eviction_fields' is nonnull (regardless of whether n_eviction_fields
233 * is nonzero), an overflow will cause a flow to be removed. The flow to
234 * be removed is chosen to give fairness among groups distinguished by
235 * different values for the subfields within 'groups'. */
236 struct mf_subfield *eviction_fields;
237 size_t n_eviction_fields;
238
239 /* Eviction groups.
240 *
241 * When a flow is added that would cause the table to have more than
242 * 'max_flows' flows, and 'eviction_fields' is nonnull, these groups are
243 * used to decide which rule to evict: the rule is chosen from the eviction
244 * group that contains the greatest number of rules.*/
245 uint32_t eviction_group_id_basis;
246 struct hmap eviction_groups_by_id;
247 struct heap eviction_groups_by_size;
248
249 /* Flow table miss handling configuration. */
250 ATOMIC(enum ofputil_table_miss) miss_config;
251
252 /* Eviction is enabled if either the client (vswitchd) enables it or an
253 * OpenFlow controller enables it; thus, a nonzero value indicates that
254 * eviction is enabled. */
255 #define EVICTION_CLIENT (1 << 0) /* Set to 1 if client enables eviction. */
256 #define EVICTION_OPENFLOW (1 << 1) /* Set to 1 if OpenFlow enables eviction. */
257 unsigned int eviction;
258
259 /* If zero, vacancy events are disabled. If nonzero, this is the type of
260 vacancy event that is enabled: either OFPTR_VACANCY_DOWN or
261 OFPTR_VACANCY_UP. Only one type of vacancy event can be enabled at a
262 time. */
263 enum ofp14_table_reason vacancy_event;
264
265 /* Non-zero values for vacancy_up and vacancy_down indicates that vacancy
266 * is enabled by table-mod, else these values are set to zero when
267 * vacancy is disabled */
268 uint8_t vacancy_down; /* Vacancy threshold when space decreases (%). */
269 uint8_t vacancy_up; /* Vacancy threshold when space increases (%). */
270
271 atomic_ulong n_matched;
272 atomic_ulong n_missed;
273 };
274
275 /* Assigns TABLE to each oftable, in turn, in OFPROTO.
276 *
277 * All parameters are evaluated multiple times. */
278 #define OFPROTO_FOR_EACH_TABLE(TABLE, OFPROTO) \
279 for ((TABLE) = (OFPROTO)->tables; \
280 (TABLE) < &(OFPROTO)->tables[(OFPROTO)->n_tables]; \
281 (TABLE)++)
282
283 /* An OpenFlow flow within a "struct ofproto".
284 *
285 * With few exceptions, ofproto implementations may look at these fields but
286 * should not modify them.
287 *
288 *
289 * Thread-safety
290 * =============
291 *
292 * Except near the beginning or ending of its lifespan, rule 'rule' belongs to
293 * the classifier rule->ofproto->tables[rule->table_id].cls. The text below
294 * calls this classifier 'cls'.
295 *
296 * Motivation
297 * ----------
298 *
299 * The thread safety rules described here for "struct rule" are motivated by
300 * two goals:
301 *
302 * - Prevent threads that read members of "struct rule" from reading bad
303 * data due to changes by some thread concurrently modifying those
304 * members.
305 *
306 * - Prevent two threads making changes to members of a given "struct rule"
307 * from interfering with each other.
308 *
309 *
310 * Rules
311 * -----
312 *
313 * A rule 'rule' may be accessed without a risk of being freed by a thread
314 * until the thread quiesces (i.e., rules are RCU protected and destructed
315 * using ovsrcu_postpone()). Code that needs to hold onto a rule for a
316 * while should increment 'rule->ref_count' either with ofproto_rule_ref()
317 * (if 'ofproto_mutex' is held), or with ofproto_rule_try_ref() (when some
318 * other thread might remove the rule from 'cls'). ofproto_rule_try_ref()
319 * will fail if the rule has already been scheduled for destruction.
320 *
321 * 'rule->ref_count' protects 'rule' from being freed. It doesn't protect the
322 * rule from being deleted from 'cls' (that's 'ofproto_mutex') and it doesn't
323 * protect members of 'rule' from modification (that's 'rule->mutex').
324 *
325 * 'rule->mutex' protects the members of 'rule' from modification. It doesn't
326 * protect the rule from being deleted from 'cls' (that's 'ofproto_mutex') and
327 * it doesn't prevent the rule from being freed (that's 'rule->ref_count').
328 *
329 * Regarding thread safety, the members of a rule fall into the following
330 * categories:
331 *
332 * - Immutable. These members are marked 'const'.
333 *
334 * - Members that may be safely read or written only by code holding
335 * ofproto_mutex. These are marked OVS_GUARDED_BY(ofproto_mutex).
336 *
337 * - Members that may be safely read only by code holding ofproto_mutex or
338 * 'rule->mutex', and safely written only by coding holding ofproto_mutex
339 * AND 'rule->mutex'. These are marked OVS_GUARDED.
340 */
341 struct rule {
342 /* Where this rule resides in an OpenFlow switch.
343 *
344 * These are immutable once the rule is constructed, hence 'const'. */
345 struct ofproto *const ofproto; /* The ofproto that contains this rule. */
346 const struct cls_rule cr; /* In owning ofproto's classifier. */
347 const uint8_t table_id; /* Index in ofproto's 'tables' array. */
348 bool removed; /* Rule has been removed from the ofproto
349 * data structures. */
350
351 /* Protects members marked OVS_GUARDED.
352 * Readers only need to hold this mutex.
353 * Writers must hold both this mutex AND ofproto_mutex.
354 * By implication writers can read *without* taking this mutex while they
355 * hold ofproto_mutex. */
356 struct ovs_mutex mutex OVS_ACQ_AFTER(ofproto_mutex);
357
358 /* Number of references.
359 * The classifier owns one reference.
360 * Any thread trying to keep a rule from being freed should hold its own
361 * reference. */
362 struct ovs_refcount ref_count;
363
364 /* A "flow cookie" is the OpenFlow name for a 64-bit value associated with
365 * a flow.. */
366 ovs_be64 flow_cookie OVS_GUARDED;
367 struct hindex_node cookie_node OVS_GUARDED_BY(ofproto_mutex);
368
369 enum ofputil_flow_mod_flags flags OVS_GUARDED;
370
371 /* Timeouts. */
372 uint16_t hard_timeout OVS_GUARDED; /* In seconds from ->modified. */
373 uint16_t idle_timeout OVS_GUARDED; /* In seconds from ->used. */
374
375 /* Eviction precedence. */
376 const uint16_t importance;
377
378 /* Removal reason for sending flow removed message.
379 * Used only if 'flags' has OFPUTIL_FF_SEND_FLOW_REM set and if the
380 * value is not OVS_OFPRR_NONE. */
381 uint8_t removed_reason;
382
383 /* Eviction groups (see comment on struct eviction_group for explanation) .
384 *
385 * 'eviction_group' is this rule's eviction group, or NULL if it is not in
386 * any eviction group. When 'eviction_group' is nonnull, 'evg_node' is in
387 * the ->eviction_group->rules hmap. */
388 struct eviction_group *eviction_group OVS_GUARDED_BY(ofproto_mutex);
389 struct heap_node evg_node OVS_GUARDED_BY(ofproto_mutex);
390
391 /* OpenFlow actions. See struct rule_actions for more thread-safety
392 * notes. */
393 const struct rule_actions * const actions;
394
395 /* In owning meter's 'rules' list. An empty list if there is no meter. */
396 struct ovs_list meter_list_node OVS_GUARDED_BY(ofproto_mutex);
397
398 /* Flow monitors (e.g. for NXST_FLOW_MONITOR, related to struct ofmonitor).
399 *
400 * 'add_seqno' is the sequence number when this rule was created.
401 * 'modify_seqno' is the sequence number when this rule was last modified.
402 * See 'monitor_seqno' in connmgr.c for more information. */
403 enum nx_flow_monitor_flags monitor_flags OVS_GUARDED_BY(ofproto_mutex);
404 uint64_t add_seqno OVS_GUARDED_BY(ofproto_mutex);
405 uint64_t modify_seqno OVS_GUARDED_BY(ofproto_mutex);
406
407 /* Optimisation for flow expiry. In ofproto's 'expirable' list if this
408 * rule is expirable, otherwise empty. */
409 struct ovs_list expirable OVS_GUARDED_BY(ofproto_mutex);
410
411 /* Times. Last so that they are more likely close to the stats managed
412 * by the provider. */
413 long long int created OVS_GUARDED; /* Creation time. */
414
415 /* Must hold 'mutex' for both read/write, 'ofproto_mutex' not needed. */
416 long long int modified OVS_GUARDED; /* Time of last modification. */
417 };
418
419 void ofproto_rule_ref(struct rule *);
420 bool ofproto_rule_try_ref(struct rule *);
421 void ofproto_rule_unref(struct rule *);
422
423 static inline const struct rule_actions * rule_get_actions(const struct rule *);
424 static inline bool rule_is_table_miss(const struct rule *);
425 static inline bool rule_is_hidden(const struct rule *);
426
427 /* A set of actions within a "struct rule".
428 *
429 *
430 * Thread-safety
431 * =============
432 *
433 * A struct rule_actions may be accessed without a risk of being freed by
434 * code that holds 'rule->mutex' (where 'rule' is the rule for which
435 * 'rule->actions == actions') or during the RCU active period.
436 *
437 * All members are immutable: they do not change during the rule's
438 * lifetime. */
439 struct rule_actions {
440 /* Flags.
441 *
442 * 'has_meter' is true if 'ofpacts' contains an OFPACT_METER action.
443 *
444 * 'has_learn_with_delete' is true if 'ofpacts' contains an OFPACT_LEARN
445 * action whose flags include NX_LEARN_F_DELETE_LEARNED. */
446 bool has_meter;
447 bool has_learn_with_delete;
448
449 /* Actions. */
450 uint32_t ofpacts_len; /* Size of 'ofpacts', in bytes. */
451 struct ofpact ofpacts[]; /* Sequence of "struct ofpacts". */
452 };
453 BUILD_ASSERT_DECL(offsetof(struct rule_actions, ofpacts) % OFPACT_ALIGNTO == 0);
454
455 const struct rule_actions *rule_actions_create(const struct ofpact *, size_t);
456 void rule_actions_destroy(const struct rule_actions *);
457 bool ofproto_rule_has_out_port(const struct rule *, ofp_port_t port)
458 OVS_REQUIRES(ofproto_mutex);
459
460 /* A set of rules to which an OpenFlow operation applies. */
461 struct rule_collection {
462 struct rule **rules; /* The rules. */
463 size_t n; /* Number of rules collected. */
464
465 size_t capacity; /* Number of rules that will fit in 'rules'. */
466 struct rule *stub[64]; /* Preallocated rules to avoid malloc(). */
467 };
468
469 void rule_collection_init(struct rule_collection *);
470 void rule_collection_add(struct rule_collection *, struct rule *);
471 void rule_collection_ref(struct rule_collection *) OVS_REQUIRES(ofproto_mutex);
472 void rule_collection_unref(struct rule_collection *);
473 void rule_collection_destroy(struct rule_collection *);
474
475 /* Limits the number of flows allowed in the datapath. Only affects the
476 * ofproto-dpif implementation. */
477 extern unsigned ofproto_flow_limit;
478
479 /* Maximum idle time (in ms) for flows to be cached in the datapath.
480 * Revalidators may expire flows more quickly than the configured value based
481 * on system load and other factors. This variable is subject to change. */
482 extern unsigned ofproto_max_idle;
483
484 /* Number of upcall handler and revalidator threads. Only affects the
485 * ofproto-dpif implementation. */
486 extern size_t n_handlers, n_revalidators;
487
488 /* Cpu mask for pmd threads. */
489 extern char *pmd_cpu_mask;
490
491 static inline struct rule *rule_from_cls_rule(const struct cls_rule *);
492
493 void ofproto_rule_expire(struct rule *rule, uint8_t reason)
494 OVS_REQUIRES(ofproto_mutex);
495 void ofproto_rule_delete(struct ofproto *, struct rule *)
496 OVS_EXCLUDED(ofproto_mutex);
497 void ofproto_rule_reduce_timeouts(struct rule *rule, uint16_t idle_timeout,
498 uint16_t hard_timeout)
499 OVS_EXCLUDED(ofproto_mutex);
500
501 /* A group within a "struct ofproto".
502 *
503 * With few exceptions, ofproto implementations may look at these fields but
504 * should not modify them. */
505 struct ofgroup {
506 struct hmap_node hmap_node OVS_GUARDED; /* In ofproto's "groups" hmap. */
507
508 /* Number of references.
509 *
510 * This is needed to keep track of references to the group in the xlate
511 * module.
512 *
513 * If the main thread removes the group from an ofproto, we need to
514 * guarantee that the group remains accessible to users of
515 * xlate_group_actions and the xlate_cache, as the xlate_cache will not be
516 * cleaned up until the corresponding datapath flows are revalidated. */
517 struct ovs_refcount ref_count;
518
519 /* No lock is needed to protect the fields below since they are not
520 * modified after construction. */
521 const struct ofproto *ofproto; /* The ofproto that contains this group. */
522 const uint32_t group_id;
523 const enum ofp11_group_type type; /* One of OFPGT_*. */
524
525 const long long int created; /* Creation time. */
526 const long long int modified; /* Time of last modification. */
527
528 struct ovs_list buckets; /* Contains "struct ofputil_bucket"s. */
529 const uint32_t n_buckets;
530
531 const struct ofputil_group_props props;
532 };
533
534 bool ofproto_group_lookup(const struct ofproto *ofproto, uint32_t group_id,
535 struct ofgroup **group);
536
537 void ofproto_group_ref(struct ofgroup *);
538 void ofproto_group_unref(struct ofgroup *);
539
540 void ofproto_group_delete_all(struct ofproto *);
541
542 /* ofproto class structure, to be defined by each ofproto implementation.
543 *
544 *
545 * Data Structures
546 * ===============
547 *
548 * These functions work primarily with four different kinds of data
549 * structures:
550 *
551 * - "struct ofproto", which represents an OpenFlow switch.
552 *
553 * - "struct ofport", which represents a port within an ofproto.
554 *
555 * - "struct rule", which represents an OpenFlow flow within an ofproto.
556 *
557 * - "struct ofgroup", which represents an OpenFlow 1.1+ group within an
558 * ofproto.
559 *
560 * Each of these data structures contains all of the implementation-independent
561 * generic state for the respective concept, called the "base" state. None of
562 * them contains any extra space for ofproto implementations to use. Instead,
563 * each implementation is expected to declare its own data structure that
564 * contains an instance of the generic data structure plus additional
565 * implementation-specific members, called the "derived" state. The
566 * implementation can use casts or (preferably) the CONTAINER_OF macro to
567 * obtain access to derived state given only a pointer to the embedded generic
568 * data structure.
569 *
570 *
571 * Life Cycle
572 * ==========
573 *
574 * Four stylized functions accompany each of these data structures:
575 *
576 * "alloc" "construct" "destruct" "dealloc"
577 * ------------ ---------------- --------------- --------------
578 * ofproto ->alloc ->construct ->destruct ->dealloc
579 * ofport ->port_alloc ->port_construct ->port_destruct ->port_dealloc
580 * rule ->rule_alloc ->rule_construct ->rule_destruct ->rule_dealloc
581 * group ->group_alloc ->group_construct ->group_destruct ->group_dealloc
582 *
583 * "ofproto", "ofport", and "group" have this exact life cycle. The "rule"
584 * data structure also follow this life cycle with some additional elaborations
585 * described under "Rule Life Cycle" below.
586 *
587 * Any instance of a given data structure goes through the following life
588 * cycle:
589 *
590 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
591 * fails, skip all the other steps.
592 *
593 * 2. The client initializes all of the data structure's base state. If this
594 * fails, skip to step 7.
595 *
596 * 3. The client calls the "construct" function. The implementation
597 * initializes derived state. It may refer to the already-initialized
598 * base state. If "construct" fails, skip to step 6.
599 *
600 * 4. The data structure is now initialized and in use.
601 *
602 * 5. When the data structure is no longer needed, the client calls the
603 * "destruct" function. The implementation uninitializes derived state.
604 * The base state has not been uninitialized yet, so the implementation
605 * may still refer to it.
606 *
607 * 6. The client uninitializes all of the data structure's base state.
608 *
609 * 7. The client calls the "dealloc" to free the raw memory. The
610 * implementation must not refer to base or derived state in the data
611 * structure, because it has already been uninitialized.
612 *
613 * Each "alloc" function allocates and returns a new instance of the respective
614 * data structure. The "alloc" function is not given any information about the
615 * use of the new data structure, so it cannot perform much initialization.
616 * Its purpose is just to ensure that the new data structure has enough room
617 * for base and derived state. It may return a null pointer if memory is not
618 * available, in which case none of the other functions is called.
619 *
620 * Each "construct" function initializes derived state in its respective data
621 * structure. When "construct" is called, all of the base state has already
622 * been initialized, so the "construct" function may refer to it. The
623 * "construct" function is allowed to fail, in which case the client calls the
624 * "dealloc" function (but not the "destruct" function).
625 *
626 * Each "destruct" function uninitializes and frees derived state in its
627 * respective data structure. When "destruct" is called, the base state has
628 * not yet been uninitialized, so the "destruct" function may refer to it. The
629 * "destruct" function is not allowed to fail.
630 *
631 * Each "dealloc" function frees raw memory that was allocated by the
632 * "alloc" function. The memory's base and derived members might not have ever
633 * been initialized (but if "construct" returned successfully, then it has been
634 * "destruct"ed already). The "dealloc" function is not allowed to fail.
635 *
636 *
637 * Conventions
638 * ===========
639 *
640 * Most of these functions return 0 if they are successful or a positive error
641 * code on failure. Depending on the function, valid error codes are either
642 * errno values or OFPERR_* OpenFlow error codes.
643 *
644 * Most of these functions are expected to execute synchronously, that is, to
645 * block as necessary to obtain a result. Thus, these functions may return
646 * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
647 * explicitly say those errors are a possibility. We may relax this
648 * requirement in the future if and when we encounter performance problems. */
649 struct ofproto_class {
650 /* ## ----------------- ## */
651 /* ## Factory Functions ## */
652 /* ## ----------------- ## */
653
654 /* Initializes provider. The caller may pass in 'iface_hints',
655 * which contains an shash of "struct iface_hint" elements indexed
656 * by the interface's name. The provider may use these hints to
657 * describe the startup configuration in order to reinitialize its
658 * state. The caller owns the provided data, so a provider must
659 * make copies of anything required. An ofproto provider must
660 * remove any existing state that is not described by the hint, and
661 * may choose to remove it all. */
662 void (*init)(const struct shash *iface_hints);
663
664 /* Enumerates the types of all supported ofproto types into 'types'. The
665 * caller has already initialized 'types'. The implementation should add
666 * its own types to 'types' but not remove any existing ones, because other
667 * ofproto classes might already have added names to it. */
668 void (*enumerate_types)(struct sset *types);
669
670 /* Enumerates the names of all existing datapath of the specified 'type'
671 * into 'names' 'all_dps'. The caller has already initialized 'names' as
672 * an empty sset.
673 *
674 * 'type' is one of the types enumerated by ->enumerate_types().
675 *
676 * Returns 0 if successful, otherwise a positive errno value.
677 */
678 int (*enumerate_names)(const char *type, struct sset *names);
679
680 /* Deletes the datapath with the specified 'type' and 'name'. The caller
681 * should have closed any open ofproto with this 'type' and 'name'; this
682 * function is allowed to fail if that is not the case.
683 *
684 * 'type' is one of the types enumerated by ->enumerate_types().
685 * 'name' is one of the names enumerated by ->enumerate_names() for 'type'.
686 *
687 * Returns 0 if successful, otherwise a positive errno value.
688 */
689 int (*del)(const char *type, const char *name);
690
691 /* Returns the type to pass to netdev_open() when a datapath of type
692 * 'datapath_type' has a port of type 'port_type', for a few special
693 * cases when a netdev type differs from a port type. For example,
694 * when using the userspace datapath, a port of type "internal"
695 * needs to be opened as "tap".
696 *
697 * Returns either 'type' itself or a string literal, which must not
698 * be freed. */
699 const char *(*port_open_type)(const char *datapath_type,
700 const char *port_type);
701
702 /* ## ------------------------ ## */
703 /* ## Top-Level type Functions ## */
704 /* ## ------------------------ ## */
705
706 /* Performs any periodic activity required on ofprotos of type
707 * 'type'.
708 *
709 * An ofproto provider may implement it or not, depending on whether
710 * it needs type-level maintenance.
711 *
712 * Returns 0 if successful, otherwise a positive errno value. */
713 int (*type_run)(const char *type);
714
715 /* Causes the poll loop to wake up when a type 'type''s 'run'
716 * function needs to be called, e.g. by calling the timer or fd
717 * waiting functions in poll-loop.h.
718 *
719 * An ofproto provider may implement it or not, depending on whether
720 * it needs type-level maintenance. */
721 void (*type_wait)(const char *type);
722
723 /* ## --------------------------- ## */
724 /* ## Top-Level ofproto Functions ## */
725 /* ## --------------------------- ## */
726
727 /* Life-cycle functions for an "ofproto" (see "Life Cycle" above).
728 *
729 *
730 * Construction
731 * ============
732 *
733 * ->construct() should not modify any base members of the ofproto. The
734 * client will initialize the ofproto's 'ports' and 'tables' members after
735 * construction is complete.
736 *
737 * When ->construct() is called, the client does not yet know how many flow
738 * tables the datapath supports, so ofproto->n_tables will be 0 and
739 * ofproto->tables will be NULL. ->construct() should call
740 * ofproto_init_tables() to allocate and initialize ofproto->n_tables and
741 * ofproto->tables. Each flow table will be initially empty, so
742 * ->construct() should delete flows from the underlying datapath, if
743 * necessary, rather than populating the tables.
744 *
745 * If the ofproto knows the maximum port number that the datapath can have,
746 * then it can call ofproto_init_max_ports(). If it does so, then the
747 * client will ensure that the actions it allows to be used through
748 * OpenFlow do not refer to ports above that maximum number.
749 *
750 * Only one ofproto instance needs to be supported for any given datapath.
751 * If a datapath is already open as part of one "ofproto", then another
752 * attempt to "construct" the same datapath as part of another ofproto is
753 * allowed to fail with an error.
754 *
755 * ->construct() returns 0 if successful, otherwise a positive errno
756 * value.
757 *
758 *
759 * Destruction
760 * ===========
761 *
762 * ->destruct() must also destroy all remaining rules in the ofproto's
763 * tables, by passing each remaining rule to ofproto_rule_delete(), then
764 * destroy all remaining groups by calling ofproto_group_delete_all().
765 *
766 * The client will destroy the flow tables themselves after ->destruct()
767 * returns.
768 */
769 struct ofproto *(*alloc)(void);
770 int (*construct)(struct ofproto *ofproto);
771 void (*destruct)(struct ofproto *ofproto);
772 void (*dealloc)(struct ofproto *ofproto);
773
774 /* Performs any periodic activity required by 'ofproto'. It should:
775 *
776 * - Call connmgr_send_packet_in() for each received packet that missed
777 * in the OpenFlow flow table or that had a OFPP_CONTROLLER output
778 * action.
779 *
780 * - Call ofproto_rule_expire() for each OpenFlow flow that has reached
781 * its hard_timeout or idle_timeout, to expire the flow.
782 *
783 * Returns 0 if successful, otherwise a positive errno value. */
784 int (*run)(struct ofproto *ofproto);
785
786 /* Causes the poll loop to wake up when 'ofproto''s 'run' function needs to
787 * be called, e.g. by calling the timer or fd waiting functions in
788 * poll-loop.h. */
789 void (*wait)(struct ofproto *ofproto);
790
791 /* Adds some memory usage statistics for the implementation of 'ofproto'
792 * into 'usage', for use with memory_report().
793 *
794 * This function is optional. */
795 void (*get_memory_usage)(const struct ofproto *ofproto,
796 struct simap *usage);
797
798 /* Adds some memory usage statistics for the implementation of 'type'
799 * into 'usage', for use with memory_report().
800 *
801 * This function is optional. */
802 void (*type_get_memory_usage)(const char *type, struct simap *usage);
803
804 /* Every "struct rule" in 'ofproto' is about to be deleted, one by one.
805 * This function may prepare for that, for example by clearing state in
806 * advance. It should *not* actually delete any "struct rule"s from
807 * 'ofproto', only prepare for it.
808 *
809 * This function is optional; it's really just for optimization in case
810 * it's cheaper to delete all the flows from your hardware in a single pass
811 * than to do it one by one. */
812 void (*flush)(struct ofproto *ofproto);
813
814 /* Helper for the OpenFlow OFPT_TABLE_FEATURES request.
815 *
816 * The 'features' array contains 'ofproto->n_tables' elements. Each
817 * element is initialized as:
818 *
819 * - 'table_id' to the array index.
820 *
821 * - 'name' to "table#" where # is the table ID.
822 *
823 * - 'metadata_match' and 'metadata_write' to OVS_BE64_MAX.
824 *
825 * - 'config' to the table miss configuration.
826 *
827 * - 'max_entries' to 1,000,000.
828 *
829 * - Both 'nonmiss' and 'miss' to:
830 *
831 * * 'next' to all 1-bits for all later tables.
832 *
833 * * 'instructions' to all instructions.
834 *
835 * * 'write' and 'apply' both to:
836 *
837 * - 'ofpacts': All actions.
838 *
839 * - 'set_fields': All fields.
840 *
841 * - 'match', 'mask', and 'wildcard' to all fields.
842 *
843 * If 'stats' is nonnull, it also contains 'ofproto->n_tables' elements.
844 * Each element is initialized as:
845 *
846 * - 'table_id' to the array index.
847 *
848 * - 'active_count' to the 'n_flows' of struct ofproto for the table.
849 *
850 * - 'lookup_count' and 'matched_count' to 0.
851 *
852 * The implementation should update any members in each element for which
853 * it has better values:
854 *
855 * - Any member of 'features' to better describe the implementation's
856 * capabilities.
857 *
858 * - 'lookup_count' to the number of packets looked up in this flow table
859 * so far.
860 *
861 * - 'matched_count' to the number of packets looked up in this flow
862 * table so far that matched one of the flow entries.
863 */
864 void (*query_tables)(struct ofproto *ofproto,
865 struct ofputil_table_features *features,
866 struct ofputil_table_stats *stats);
867
868 /* Sets the current tables version the provider should use for classifier
869 * lookups. */
870 void (*set_tables_version)(struct ofproto *ofproto, cls_version_t version);
871 /* ## ---------------- ## */
872 /* ## ofport Functions ## */
873 /* ## ---------------- ## */
874
875 /* Life-cycle functions for a "struct ofport" (see "Life Cycle" above).
876 *
877 * ->port_construct() should not modify any base members of the ofport.
878 * An ofproto implementation should use the 'ofp_port' member of
879 * "struct ofport" as the OpenFlow port number.
880 *
881 * ofports are managed by the base ofproto code. The ofproto
882 * implementation should only create and destroy them in response to calls
883 * to these functions. The base ofproto code will create and destroy
884 * ofports in the following situations:
885 *
886 * - Just after the ->construct() function is called, the base ofproto
887 * iterates over all of the implementation's ports, using
888 * ->port_dump_start() and related functions, and constructs an ofport
889 * for each dumped port.
890 *
891 * - If ->port_poll() reports that a specific port has changed, then the
892 * base ofproto will query that port with ->port_query_by_name() and
893 * construct or destruct ofports as necessary to reflect the updated
894 * set of ports.
895 *
896 * - If ->port_poll() returns ENOBUFS to report an unspecified port set
897 * change, then the base ofproto will iterate over all of the
898 * implementation's ports, in the same way as at ofproto
899 * initialization, and construct and destruct ofports to reflect all of
900 * the changes.
901 *
902 * - On graceful shutdown, the base ofproto code will destruct all
903 * the ports.
904 *
905 * ->port_construct() returns 0 if successful, otherwise a positive errno
906 * value.
907 *
908 *
909 * ->port_destruct()
910 * =================
911 *
912 * ->port_destruct() takes a 'del' parameter. If the provider implements
913 * the datapath itself (e.g. dpif-netdev, it can ignore 'del'. On the
914 * other hand, if the provider is an interface to an external datapath
915 * (e.g. to a kernel module that implement the datapath) then 'del' should
916 * influence destruction behavior in the following way:
917 *
918 * - If 'del' is true, it should remove the port from the underlying
919 * implementation. This is the common case.
920 *
921 * - If 'del' is false, it should leave the port in the underlying
922 * implementation. This is used when Open vSwitch is performing a
923 * graceful shutdown and ensures that, across Open vSwitch restarts,
924 * the underlying ports are not removed and recreated. That makes an
925 * important difference for, e.g., "internal" ports that have
926 * configured IP addresses; without this distinction, the IP address
927 * and other configured state for the port is lost.
928 */
929 struct ofport *(*port_alloc)(void);
930 int (*port_construct)(struct ofport *ofport);
931 void (*port_destruct)(struct ofport *ofport, bool del);
932 void (*port_dealloc)(struct ofport *ofport);
933
934 /* Called after 'ofport->netdev' is replaced by a new netdev object. If
935 * the ofproto implementation uses the ofport's netdev internally, then it
936 * should switch to using the new one. The old one has been closed.
937 *
938 * An ofproto implementation that doesn't need to do anything in this
939 * function may use a null pointer. */
940 void (*port_modified)(struct ofport *ofport);
941
942 /* Called after an OpenFlow request changes a port's configuration.
943 * 'ofport->pp.config' contains the new configuration. 'old_config'
944 * contains the previous configuration.
945 *
946 * The caller implements OFPUTIL_PC_PORT_DOWN using netdev functions to
947 * turn NETDEV_UP on and off, so this function doesn't have to do anything
948 * for that bit (and it won't be called if that is the only bit that
949 * changes). */
950 void (*port_reconfigured)(struct ofport *ofport,
951 enum ofputil_port_config old_config);
952
953 /* Looks up a port named 'devname' in 'ofproto'. On success, returns 0 and
954 * initializes '*port' appropriately. Otherwise, returns a positive errno
955 * value.
956 *
957 * The caller owns the data in 'port' and must free it with
958 * ofproto_port_destroy() when it is no longer needed. */
959 int (*port_query_by_name)(const struct ofproto *ofproto,
960 const char *devname, struct ofproto_port *port);
961
962 /* Attempts to add 'netdev' as a port on 'ofproto'. Returns 0 if
963 * successful, otherwise a positive errno value. The caller should
964 * inform the implementation of the OpenFlow port through the
965 * ->port_construct() method.
966 *
967 * It doesn't matter whether the new port will be returned by a later call
968 * to ->port_poll(); the implementation may do whatever is more
969 * convenient. */
970 int (*port_add)(struct ofproto *ofproto, struct netdev *netdev);
971
972 /* Deletes port number 'ofp_port' from the datapath for 'ofproto'. Returns
973 * 0 if successful, otherwise a positive errno value.
974 *
975 * It doesn't matter whether the new port will be returned by a later call
976 * to ->port_poll(); the implementation may do whatever is more
977 * convenient. */
978 int (*port_del)(struct ofproto *ofproto, ofp_port_t ofp_port);
979
980 /* Get port stats */
981 int (*port_get_stats)(const struct ofport *port,
982 struct netdev_stats *stats);
983
984 /* Port iteration functions.
985 *
986 * The client might not be entirely in control of the ports within an
987 * ofproto. Some hardware implementations, for example, might have a fixed
988 * set of ports in a datapath. For this reason, the client needs a way to
989 * iterate through all the ports that are actually in a datapath. These
990 * functions provide that functionality.
991 *
992 * The 'state' pointer provides the implementation a place to
993 * keep track of its position. Its format is opaque to the caller.
994 *
995 * The ofproto provider retains ownership of the data that it stores into
996 * ->port_dump_next()'s 'port' argument. The data must remain valid until
997 * at least the next call to ->port_dump_next() or ->port_dump_done() for
998 * 'state'. The caller will not modify or free it.
999 *
1000 * Details
1001 * =======
1002 *
1003 * ->port_dump_start() attempts to begin dumping the ports in 'ofproto'.
1004 * On success, it should return 0 and initialize '*statep' with any data
1005 * needed for iteration. On failure, returns a positive errno value, and
1006 * the client will not call ->port_dump_next() or ->port_dump_done().
1007 *
1008 * ->port_dump_next() attempts to retrieve another port from 'ofproto' for
1009 * 'state'. If there is another port, it should store the port's
1010 * information into 'port' and return 0. It should return EOF if all ports
1011 * have already been iterated. Otherwise, on error, it should return a
1012 * positive errno value. This function will not be called again once it
1013 * returns nonzero once for a given iteration (but the 'port_dump_done'
1014 * function will be called afterward).
1015 *
1016 * ->port_dump_done() allows the implementation to release resources used
1017 * for iteration. The caller might decide to stop iteration in the middle
1018 * by calling this function before ->port_dump_next() returns nonzero.
1019 *
1020 * Usage Example
1021 * =============
1022 *
1023 * int error;
1024 * void *state;
1025 *
1026 * error = ofproto->ofproto_class->port_dump_start(ofproto, &state);
1027 * if (!error) {
1028 * for (;;) {
1029 * struct ofproto_port port;
1030 *
1031 * error = ofproto->ofproto_class->port_dump_next(
1032 * ofproto, state, &port);
1033 * if (error) {
1034 * break;
1035 * }
1036 * // Do something with 'port' here (without modifying or freeing
1037 * // any of its data).
1038 * }
1039 * ofproto->ofproto_class->port_dump_done(ofproto, state);
1040 * }
1041 * // 'error' is now EOF (success) or a positive errno value (failure).
1042 */
1043 int (*port_dump_start)(const struct ofproto *ofproto, void **statep);
1044 int (*port_dump_next)(const struct ofproto *ofproto, void *state,
1045 struct ofproto_port *port);
1046 int (*port_dump_done)(const struct ofproto *ofproto, void *state);
1047
1048 /* Polls for changes in the set of ports in 'ofproto'. If the set of ports
1049 * in 'ofproto' has changed, then this function should do one of the
1050 * following:
1051 *
1052 * - Preferably: store the name of the device that was added to or deleted
1053 * from 'ofproto' in '*devnamep' and return 0. The caller is responsible
1054 * for freeing '*devnamep' (with free()) when it no longer needs it.
1055 *
1056 * - Alternatively: return ENOBUFS, without indicating the device that was
1057 * added or deleted.
1058 *
1059 * Occasional 'false positives', in which the function returns 0 while
1060 * indicating a device that was not actually added or deleted or returns
1061 * ENOBUFS without any change, are acceptable.
1062 *
1063 * The purpose of 'port_poll' is to let 'ofproto' know about changes made
1064 * externally to the 'ofproto' object, e.g. by a system administrator via
1065 * ovs-dpctl. Therefore, it's OK, and even preferable, for port_poll() to
1066 * not report changes made through calls to 'port_add' or 'port_del' on the
1067 * same 'ofproto' object. (But it's OK for it to report them too, just
1068 * slightly less efficient.)
1069 *
1070 * If the set of ports in 'ofproto' has not changed, returns EAGAIN. May
1071 * also return other positive errno values to indicate that something has
1072 * gone wrong.
1073 *
1074 * If the set of ports in a datapath is fixed, or if the only way that the
1075 * set of ports in a datapath can change is through ->port_add() and
1076 * ->port_del(), then this function may be a null pointer.
1077 */
1078 int (*port_poll)(const struct ofproto *ofproto, char **devnamep);
1079
1080 /* Arranges for the poll loop to wake up when ->port_poll() will return a
1081 * value other than EAGAIN.
1082 *
1083 * If the set of ports in a datapath is fixed, or if the only way that the
1084 * set of ports in a datapath can change is through ->port_add() and
1085 * ->port_del(), or if the poll loop will always wake up anyway when
1086 * ->port_poll() will return a value other than EAGAIN, then this function
1087 * may be a null pointer.
1088 */
1089 void (*port_poll_wait)(const struct ofproto *ofproto);
1090
1091 /* Checks the status of LACP negotiation for 'port'. Returns 1 if LACP
1092 * partner information for 'port' is up-to-date, 0 if LACP partner
1093 * information is not current (generally indicating a connectivity
1094 * problem), or -1 if LACP is not enabled on 'port'.
1095 *
1096 * This function may be a null pointer if the ofproto implementation does
1097 * not support LACP.
1098 */
1099 int (*port_is_lacp_current)(const struct ofport *port);
1100
1101 /* Get LACP port stats. Returns -1 if LACP is not enabled on 'port'.
1102 *
1103 * This function may be a null pointer if the ofproto implementation does
1104 * not support LACP.
1105 */
1106 int (*port_get_lacp_stats)(const struct ofport *port,
1107 struct lacp_slave_stats *stats);
1108
1109 /* ## ----------------------- ## */
1110 /* ## OpenFlow Rule Functions ## */
1111 /* ## ----------------------- ## */
1112
1113 /* Chooses an appropriate table for 'match' within 'ofproto'. On
1114 * success, stores the table ID into '*table_idp' and returns 0. On
1115 * failure, returns an OpenFlow error code.
1116 *
1117 * The choice of table should be a function of 'match' and 'ofproto''s
1118 * datapath capabilities. It should not depend on the flows already in
1119 * 'ofproto''s flow tables. Failure implies that an OpenFlow rule with
1120 * 'match' as its matching condition can never be inserted into 'ofproto',
1121 * even starting from an empty flow table.
1122 *
1123 * If multiple tables are candidates for inserting the flow, the function
1124 * should choose one arbitrarily (but deterministically).
1125 *
1126 * If this function is NULL then table 0 is always chosen. */
1127 enum ofperr (*rule_choose_table)(const struct ofproto *ofproto,
1128 const struct match *match,
1129 uint8_t *table_idp);
1130
1131 /* Life-cycle functions for a "struct rule".
1132 *
1133 *
1134 * Rule Life Cycle
1135 * ===============
1136 *
1137 * The life cycle of a struct rule is an elaboration of the basic life
1138 * cycle described above under "Life Cycle".
1139 *
1140 * After a rule is successfully constructed, it is then inserted. If
1141 * insertion is successful, then before it is later destructed, it is
1142 * deleted.
1143 *
1144 * You can think of a rule as having the following extra steps inserted
1145 * between "Life Cycle" steps 4 and 5:
1146 *
1147 * 4.1. The client inserts the rule into the flow table, making it
1148 * visible in flow table lookups.
1149 *
1150 * 4.2. The client calls "rule_insert" to insert the flow. The
1151 * implementation attempts to install the flow in the underlying
1152 * hardware and returns an error code indicate success or failure.
1153 * On failure, go to step 5.
1154 *
1155 * 4.3. The rule is now installed in the flow table. Eventually it will
1156 * be deleted.
1157 *
1158 * 4.4. The client removes the rule from the flow table. It is no longer
1159 * visible in flow table lookups.
1160 *
1161 * 4.5. The client calls "rule_delete". The implementation uninstalls
1162 * the flow from the underlying hardware. Deletion is not allowed
1163 * to fail.
1164 *
1165 *
1166 * Construction
1167 * ============
1168 *
1169 * When ->rule_construct() is called, 'rule' is a new rule that is not yet
1170 * inserted into a flow table. ->rule_construct() should initialize enough
1171 * of the rule's derived state for 'rule' to be suitable for inserting into
1172 * a flow table. ->rule_construct() should not modify any base members of
1173 * struct rule.
1174 *
1175 * If ->rule_construct() fails (as indicated by returning a nonzero
1176 * OpenFlow error code), the ofproto base code will uninitialize and
1177 * deallocate 'rule'. See "Rule Life Cycle" above for more details.
1178 *
1179 * ->rule_construct() must also:
1180 *
1181 * - Validate that the datapath supports the matching rule in 'rule->cr'
1182 * datapath. For example, if the rule's table does not support
1183 * registers, then it is an error if 'rule->cr' does not wildcard all
1184 * registers.
1185 *
1186 * - Validate that the datapath can correctly implement 'rule->ofpacts'.
1187 *
1188 * After a successful construction the rest of the rule life cycle calls
1189 * may not fail, so ->rule_construct() must also make sure that the rule
1190 * can be inserted in to the datapath.
1191 *
1192 *
1193 * Insertion
1194 * =========
1195 *
1196 * Following successful construction, the ofproto base case inserts 'rule'
1197 * into its flow table, then it calls ->rule_insert(). ->rule_insert()
1198 * must add the new rule to the datapath flow table and return only after
1199 * this is complete. The 'new_rule' may be a duplicate of an 'old_rule'.
1200 * In this case the 'old_rule' is non-null, and the implementation should
1201 * forward rule statistics from the 'old_rule' to the 'new_rule' if
1202 * 'forward_stats' is 'true'. This may not fail.
1203 *
1204 *
1205 * Deletion
1206 * ========
1207 *
1208 * The ofproto base code removes 'rule' from its flow table before it calls
1209 * ->rule_delete(). ->rule_delete() must remove 'rule' from the datapath
1210 * flow table and return only after this has completed successfully.
1211 *
1212 * Rule deletion must not fail.
1213 *
1214 *
1215 * Destruction
1216 * ===========
1217 *
1218 * ->rule_destruct() must uninitialize derived state.
1219 *
1220 * Rule destruction must not fail. */
1221 struct rule *(*rule_alloc)(void);
1222 enum ofperr (*rule_construct)(struct rule *rule)
1223 /* OVS_REQUIRES(ofproto_mutex) */;
1224 void (*rule_insert)(struct rule *rule, struct rule *old_rule,
1225 bool forward_stats)
1226 /* OVS_REQUIRES(ofproto_mutex) */;
1227 void (*rule_delete)(struct rule *rule) /* OVS_REQUIRES(ofproto_mutex) */;
1228 void (*rule_destruct)(struct rule *rule);
1229 void (*rule_dealloc)(struct rule *rule);
1230
1231 /* Obtains statistics for 'rule', storing the number of packets that have
1232 * matched it in '*packet_count' and the number of bytes in those packets
1233 * in '*byte_count'. UINT64_MAX indicates that the packet count or byte
1234 * count is unknown. */
1235 void (*rule_get_stats)(struct rule *rule, uint64_t *packet_count,
1236 uint64_t *byte_count, long long int *used)
1237 /* OVS_EXCLUDED(ofproto_mutex) */;
1238
1239 /* Applies the actions in 'rule' to 'packet'. (This implements sending
1240 * buffered packets for OpenFlow OFPT_FLOW_MOD commands.)
1241 *
1242 * Takes ownership of 'packet' (so it should eventually free it, with
1243 * ofpbuf_delete()).
1244 *
1245 * 'flow' reflects the flow information for 'packet'. All of the
1246 * information in 'flow' is extracted from 'packet', except for
1247 * flow->tunnel and flow->in_port, which are assigned the correct values
1248 * for the incoming packet. The register values are zeroed. 'packet''s
1249 * header pointers and offsets (e.g. packet->l3) are appropriately
1250 * initialized. packet->l3 is aligned on a 32-bit boundary.
1251 *
1252 * The implementation should add the statistics for 'packet' into 'rule'.
1253 *
1254 * Returns 0 if successful, otherwise an OpenFlow error code. */
1255 enum ofperr (*rule_execute)(struct rule *rule, const struct flow *flow,
1256 struct dp_packet *packet);
1257
1258 /* Changes the OpenFlow IP fragment handling policy to 'frag_handling',
1259 * which takes one of the following values, with the corresponding
1260 * meanings:
1261 *
1262 * - OFPUTIL_FRAG_NORMAL: The switch should treat IP fragments the same
1263 * way as other packets, omitting TCP and UDP port numbers (always
1264 * setting them to 0).
1265 *
1266 * - OFPUTIL_FRAG_DROP: The switch should drop all IP fragments without
1267 * passing them through the flow table.
1268 *
1269 * - OFPUTIL_FRAG_REASM: The switch should reassemble IP fragments before
1270 * passing packets through the flow table.
1271 *
1272 * - OFPUTIL_FRAG_NX_MATCH (a Nicira extension): Similar to
1273 * OFPUTIL_FRAG_NORMAL, except that TCP and UDP port numbers should be
1274 * included in fragments with offset 0.
1275 *
1276 * Implementations are not required to support every mode.
1277 * OFPUTIL_FRAG_NORMAL is the default mode when an ofproto is created.
1278 *
1279 * At the time of the call to ->set_frag_handling(), the current mode is
1280 * available in 'ofproto->frag_handling'. ->set_frag_handling() returns
1281 * true if the requested mode was set, false if it is not supported.
1282 *
1283 * Upon successful return, the caller changes 'ofproto->frag_handling' to
1284 * reflect the new mode.
1285 */
1286 bool (*set_frag_handling)(struct ofproto *ofproto,
1287 enum ofputil_frag_handling frag_handling);
1288
1289 /* Implements the OpenFlow OFPT_PACKET_OUT command. The datapath should
1290 * execute the 'ofpacts_len' bytes of "struct ofpacts" in 'ofpacts'.
1291 *
1292 * The caller retains ownership of 'packet' and of 'ofpacts', so
1293 * ->packet_out() should not modify or free them.
1294 *
1295 * This function must validate that it can correctly implement 'ofpacts'.
1296 * If not, then it should return an OpenFlow error code.
1297 *
1298 * 'flow' reflects the flow information for 'packet'. All of the
1299 * information in 'flow' is extracted from 'packet', except for
1300 * flow->in_port (see below). flow->tunnel and its register values are
1301 * zeroed.
1302 *
1303 * flow->in_port comes from the OpenFlow OFPT_PACKET_OUT message. The
1304 * implementation should reject invalid flow->in_port values by returning
1305 * OFPERR_OFPBRC_BAD_PORT. (If the implementation called
1306 * ofproto_init_max_ports(), then the client will reject these ports
1307 * itself.) For consistency, the implementation should consider valid for
1308 * flow->in_port any value that could possibly be seen in a packet that it
1309 * passes to connmgr_send_packet_in(). Ideally, even an implementation
1310 * that never generates packet-ins (e.g. due to hardware limitations)
1311 * should still allow flow->in_port values for every possible physical port
1312 * and OFPP_LOCAL. The only virtual ports (those above OFPP_MAX) that the
1313 * caller will ever pass in as flow->in_port, other than OFPP_LOCAL, are
1314 * OFPP_NONE and OFPP_CONTROLLER. The implementation should allow both of
1315 * these, treating each of them as packets generated by the controller as
1316 * opposed to packets originating from some switch port.
1317 *
1318 * (Ordinarily the only effect of flow->in_port is on output actions that
1319 * involve the input port, such as actions that output to OFPP_IN_PORT,
1320 * OFPP_FLOOD, or OFPP_ALL. flow->in_port can also affect Nicira extension
1321 * "resubmit" actions.)
1322 *
1323 * 'packet' is not matched against the OpenFlow flow table, so its
1324 * statistics should not be included in OpenFlow flow statistics.
1325 *
1326 * Returns 0 if successful, otherwise an OpenFlow error code. */
1327 enum ofperr (*packet_out)(struct ofproto *ofproto, struct dp_packet *packet,
1328 const struct flow *flow,
1329 const struct ofpact *ofpacts,
1330 size_t ofpacts_len);
1331
1332 enum ofperr (*nxt_resume)(struct ofproto *ofproto,
1333 const struct ofputil_packet_in_private *);
1334
1335 /* ## ------------------------- ## */
1336 /* ## OFPP_NORMAL configuration ## */
1337 /* ## ------------------------- ## */
1338
1339 /* Configures NetFlow on 'ofproto' according to the options in
1340 * 'netflow_options', or turns off NetFlow if 'netflow_options' is NULL.
1341 *
1342 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1343 * NetFlow, as does a null pointer. */
1344 int (*set_netflow)(struct ofproto *ofproto,
1345 const struct netflow_options *netflow_options);
1346
1347 void (*get_netflow_ids)(const struct ofproto *ofproto,
1348 uint8_t *engine_type, uint8_t *engine_id);
1349
1350 /* Configures sFlow on 'ofproto' according to the options in
1351 * 'sflow_options', or turns off sFlow if 'sflow_options' is NULL.
1352 *
1353 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1354 * sFlow, as does a null pointer. */
1355 int (*set_sflow)(struct ofproto *ofproto,
1356 const struct ofproto_sflow_options *sflow_options);
1357
1358 /* Configures IPFIX on 'ofproto' according to the options in
1359 * 'bridge_exporter_options' and the 'flow_exporters_options'
1360 * array, or turns off IPFIX if 'bridge_exporter_options' and
1361 * 'flow_exporters_options' is NULL.
1362 *
1363 * EOPNOTSUPP as a return value indicates that 'ofproto' does not support
1364 * IPFIX, as does a null pointer. */
1365 int (*set_ipfix)(
1366 struct ofproto *ofproto,
1367 const struct ofproto_ipfix_bridge_exporter_options
1368 *bridge_exporter_options,
1369 const struct ofproto_ipfix_flow_exporter_options
1370 *flow_exporters_options, size_t n_flow_exporters_options);
1371
1372 /* Configures connectivity fault management on 'ofport'.
1373 *
1374 * If 'cfm_settings' is nonnull, configures CFM according to its members.
1375 *
1376 * If 'cfm_settings' is null, removes any connectivity fault management
1377 * configuration from 'ofport'.
1378 *
1379 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1380 * support CFM, as does a null pointer. */
1381 int (*set_cfm)(struct ofport *ofport, const struct cfm_settings *s);
1382
1383 /* Checks the status change of CFM on 'ofport'. Returns true if
1384 * there is status change since last call or if CFM is not specified. */
1385 bool (*cfm_status_changed)(struct ofport *ofport);
1386
1387 /* Populates 'smap' with the status of CFM on 'ofport'. Returns 0 on
1388 * success, or a positive errno. EOPNOTSUPP as a return value indicates
1389 * that this ofproto_class does not support CFM, as does a null pointer.
1390 *
1391 * The caller must provide and own '*status', and it must free the array
1392 * returned in 'status->rmps'. '*status' is indeterminate if the return
1393 * value is non-zero. */
1394 int (*get_cfm_status)(const struct ofport *ofport,
1395 struct cfm_status *status);
1396
1397 /* Configures LLDP on 'ofport'.
1398 *
1399 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1400 * support LLDP, as does a null pointer. */
1401 int (*set_lldp)(struct ofport *ofport, const struct smap *cfg);
1402
1403 /* Checks the status of LLDP configured on 'ofport'. Returns true if the
1404 * port's LLDP status was successfully stored into '*status'. Returns
1405 * false if the port did not have LLDP configured, in which case '*status'
1406 * is indeterminate.
1407 *
1408 * The caller must provide and own '*status'. '*status' is indeterminate
1409 * if the return value is non-zero. */
1410 bool (*get_lldp_status)(const struct ofport *ofport,
1411 struct lldp_status *status);
1412
1413 /* Configures Auto Attach.
1414 *
1415 * If 's' is nonnull, configures Auto Attach according to its members.
1416 *
1417 * If 's' is null, removes any Auto Attach configuration.
1418 */
1419 int (*set_aa)(struct ofproto *ofproto,
1420 const struct aa_settings *s);
1421
1422 /* If 's' is nonnull, this function registers a mapping associated with
1423 * client data pointer 'aux' in 'ofproto'. If 'aux' is already registered
1424 * then this function updates its configuration to 's'. Otherwise, this
1425 * function registers a new mapping.
1426 *
1427 * An implementation that does not support mapping at all may set
1428 * it to NULL or return EOPNOTSUPP. An implementation that supports
1429 * only a subset of the functionality should implement what it can
1430 * and return 0.
1431 */
1432 int (*aa_mapping_set)(struct ofproto *ofproto, void *aux,
1433 const struct aa_mapping_settings *s);
1434
1435 /* If 's' is nonnull, this function unregisters a mapping associated with
1436 * client data pointer 'aux' in 'ofproto'. If 'aux' is already registered
1437 * then this function updates its configuration to 's'. Otherwise, this
1438 * function unregisters a new mapping.
1439 *
1440 * An implementation that does not support mapping at all may set
1441 * it to NULL or return EOPNOTSUPP. An implementation that supports
1442 * only a subset of the functionality should implement what it can
1443 * and return 0.
1444 */
1445 int (*aa_mapping_unset)(struct ofproto *ofproto, void *aux);
1446
1447 /*
1448 * Returns the a list of AutoAttach VLAN operations. When Auto Attach is
1449 * enabled, the VLAN associated with an I-SID/VLAN mapping is first
1450 * negotiated with an Auto Attach Server. Once an I-SID VLAN mapping
1451 * becomes active, the corresponding VLAN needs to be communicated to the
1452 * bridge in order to add the VLAN to the trunk port linking the Auto
1453 * Attach Client (in this case openvswitch) and the Auto Attach Server.
1454 *
1455 * The list entries are of type "struct bridge_aa_vlan". Each entry
1456 * specifies the operation (add or remove), the interface on which to
1457 * execute the operation and the VLAN.
1458 */
1459 int (*aa_vlan_get_queued)(struct ofproto *ofproto, struct ovs_list *list);
1460
1461 /*
1462 * Returns the current number of entries in the list of VLAN operations
1463 * in the Auto Attach Client (see previous function description
1464 * aa_vlan_get_queued). Returns 0 if Auto Attach is disabled.
1465 */
1466 unsigned int (*aa_vlan_get_queue_size)(struct ofproto *ofproto);
1467
1468 /* Configures BFD on 'ofport'.
1469 *
1470 * If 'cfg' is NULL, or 'cfg' does not contain the key value pair
1471 * "enable=true", removes BFD from 'ofport'. Otherwise, configures BFD
1472 * according to 'cfg'.
1473 *
1474 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1475 * support BFD, as does a null pointer. */
1476 int (*set_bfd)(struct ofport *ofport, const struct smap *cfg);
1477
1478 /* Checks the status change of BFD on 'ofport'. Returns true if there
1479 * is status change since last call or if BFD is not specified. */
1480 bool (*bfd_status_changed)(struct ofport *ofport);
1481
1482 /* Populates 'smap' with the status of BFD on 'ofport'. Returns 0 on
1483 * success, or a positive errno. EOPNOTSUPP as a return value indicates
1484 * that this ofproto_class does not support BFD, as does a null pointer. */
1485 int (*get_bfd_status)(struct ofport *ofport, struct smap *smap);
1486
1487 /* Configures spanning tree protocol (STP) on 'ofproto' using the
1488 * settings defined in 's'.
1489 *
1490 * If 's' is nonnull, configures STP according to its members.
1491 *
1492 * If 's' is null, removes any STP configuration from 'ofproto'.
1493 *
1494 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1495 * support STP, as does a null pointer. */
1496 int (*set_stp)(struct ofproto *ofproto,
1497 const struct ofproto_stp_settings *s);
1498
1499 /* Retrieves state of spanning tree protocol (STP) on 'ofproto'.
1500 *
1501 * Stores STP state for 'ofproto' in 's'. If the 'enabled' member
1502 * is false, the other member values are not meaningful.
1503 *
1504 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1505 * support STP, as does a null pointer. */
1506 int (*get_stp_status)(struct ofproto *ofproto,
1507 struct ofproto_stp_status *s);
1508
1509 /* Configures spanning tree protocol (STP) on 'ofport' using the
1510 * settings defined in 's'.
1511 *
1512 * If 's' is nonnull, configures STP according to its members. The
1513 * caller is responsible for assigning STP port numbers (using the
1514 * 'port_num' member in the range of 1 through 255, inclusive) and
1515 * ensuring there are no duplicates.
1516 *
1517 * If 's' is null, removes any STP configuration from 'ofport'.
1518 *
1519 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1520 * support STP, as does a null pointer. */
1521 int (*set_stp_port)(struct ofport *ofport,
1522 const struct ofproto_port_stp_settings *s);
1523
1524 /* Retrieves spanning tree protocol (STP) port status of 'ofport'.
1525 *
1526 * Stores STP state for 'ofport' in 's'. If the 'enabled' member is
1527 * false, the other member values are not meaningful.
1528 *
1529 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1530 * support STP, as does a null pointer. */
1531 int (*get_stp_port_status)(struct ofport *ofport,
1532 struct ofproto_port_stp_status *s);
1533
1534 /* Retrieves spanning tree protocol (STP) port statistics of 'ofport'.
1535 *
1536 * Stores STP state for 'ofport' in 's'. If the 'enabled' member is
1537 * false, the other member values are not meaningful.
1538 *
1539 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1540 * support STP, as does a null pointer. */
1541 int (*get_stp_port_stats)(struct ofport *ofport,
1542 struct ofproto_port_stp_stats *s);
1543
1544 /* Configures Rapid Spanning Tree Protocol (RSTP) on 'ofproto' using the
1545 * settings defined in 's'.
1546 *
1547 * If 's' is nonnull, configures RSTP according to its members.
1548 *
1549 * If 's' is null, removes any RSTP configuration from 'ofproto'.
1550 *
1551 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1552 * support RSTP, as does a null pointer. */
1553 void (*set_rstp)(struct ofproto *ofproto,
1554 const struct ofproto_rstp_settings *s);
1555
1556 /* Retrieves state of Rapid Spanning Tree Protocol (RSTP) on 'ofproto'.
1557 *
1558 * Stores RSTP state for 'ofproto' in 's'. If the 'enabled' member
1559 * is false, the other member values are not meaningful.
1560 *
1561 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1562 * support RSTP, as does a null pointer. */
1563 void (*get_rstp_status)(struct ofproto *ofproto,
1564 struct ofproto_rstp_status *s);
1565
1566 /* Configures Rapid Spanning Tree Protocol (RSTP) on 'ofport' using the
1567 * settings defined in 's'.
1568 *
1569 * If 's' is nonnull, configures RSTP according to its members. The
1570 * caller is responsible for assigning RSTP port numbers (using the
1571 * 'port_num' member in the range of 1 through 255, inclusive) and
1572 * ensuring there are no duplicates.
1573 *
1574 * If 's' is null, removes any RSTP configuration from 'ofport'.
1575 *
1576 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1577 * support STP, as does a null pointer. */
1578 void (*set_rstp_port)(struct ofport *ofport,
1579 const struct ofproto_port_rstp_settings *s);
1580
1581 /* Retrieves Rapid Spanning Tree Protocol (RSTP) port status of 'ofport'.
1582 *
1583 * Stores RSTP state for 'ofport' in 's'. If the 'enabled' member is
1584 * false, the other member values are not meaningful.
1585 *
1586 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1587 * support RSTP, as does a null pointer. */
1588 void (*get_rstp_port_status)(struct ofport *ofport,
1589 struct ofproto_port_rstp_status *s);
1590
1591 /* Registers meta-data associated with the 'n_qdscp' Qualities of Service
1592 * 'queues' attached to 'ofport'. This data is not intended to be
1593 * sufficient to implement QoS. Instead, providers may use this
1594 * information to implement features which require knowledge of what queues
1595 * exist on a port, and some basic information about them.
1596 *
1597 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1598 * support QoS, as does a null pointer. */
1599 int (*set_queues)(struct ofport *ofport,
1600 const struct ofproto_port_queue *queues, size_t n_qdscp);
1601
1602 /* If 's' is nonnull, this function registers a "bundle" associated with
1603 * client data pointer 'aux' in 'ofproto'. A bundle is the same concept as
1604 * a Port in OVSDB, that is, it consists of one or more "slave" devices
1605 * (Interfaces, in OVSDB) along with VLAN and LACP configuration and, if
1606 * there is more than one slave, a bonding configuration. If 'aux' is
1607 * already registered then this function updates its configuration to 's'.
1608 * Otherwise, this function registers a new bundle.
1609 *
1610 * If 's' is NULL, this function unregisters the bundle registered on
1611 * 'ofproto' associated with client data pointer 'aux'. If no such bundle
1612 * has been registered, this has no effect.
1613 *
1614 * This function affects only the behavior of the NXAST_AUTOPATH action and
1615 * output to the OFPP_NORMAL port. An implementation that does not support
1616 * it at all may set it to NULL or return EOPNOTSUPP. An implementation
1617 * that supports only a subset of the functionality should implement what
1618 * it can and return 0. */
1619 int (*bundle_set)(struct ofproto *ofproto, void *aux,
1620 const struct ofproto_bundle_settings *s);
1621
1622 /* If 'port' is part of any bundle, removes it from that bundle. If the
1623 * bundle now has no ports, deletes the bundle. If the bundle now has only
1624 * one port, deconfigures the bundle's bonding configuration. */
1625 void (*bundle_remove)(struct ofport *ofport);
1626
1627 /* If 's' is nonnull, this function registers a mirror associated with
1628 * client data pointer 'aux' in 'ofproto'. A mirror is the same concept as
1629 * a Mirror in OVSDB. If 'aux' is already registered then this function
1630 * updates its configuration to 's'. Otherwise, this function registers a
1631 * new mirror.
1632 *
1633 * If 's' is NULL, this function unregisters the mirror registered on
1634 * 'ofproto' associated with client data pointer 'aux'. If no such mirror
1635 * has been registered, this has no effect.
1636 *
1637 * An implementation that does not support mirroring at all may set
1638 * it to NULL or return EOPNOTSUPP. An implementation that supports
1639 * only a subset of the functionality should implement what it can
1640 * and return 0. */
1641 int (*mirror_set)(struct ofproto *ofproto, void *aux,
1642 const struct ofproto_mirror_settings *s);
1643
1644 /* Retrieves statistics from mirror associated with client data
1645 * pointer 'aux' in 'ofproto'. Stores packet and byte counts in
1646 * 'packets' and 'bytes', respectively. If a particular counter is
1647 * not supported, the appropriate argument is set to UINT64_MAX.
1648 *
1649 * EOPNOTSUPP as a return value indicates that this ofproto_class does not
1650 * support retrieving mirror statistics. */
1651 int (*mirror_get_stats)(struct ofproto *ofproto, void *aux,
1652 uint64_t *packets, uint64_t *bytes);
1653
1654 /* Configures the VLANs whose bits are set to 1 in 'flood_vlans' as VLANs
1655 * on which all packets are flooded, instead of using MAC learning. If
1656 * 'flood_vlans' is NULL, then MAC learning applies to all VLANs.
1657 *
1658 * This function affects only the behavior of the OFPP_NORMAL action. An
1659 * implementation that does not support it may set it to NULL or return
1660 * EOPNOTSUPP. */
1661 int (*set_flood_vlans)(struct ofproto *ofproto,
1662 unsigned long *flood_vlans);
1663
1664 /* Returns true if 'aux' is a registered bundle that is currently in use as
1665 * the output for a mirror. */
1666 bool (*is_mirror_output_bundle)(const struct ofproto *ofproto, void *aux);
1667
1668 /* When the configuration option of forward_bpdu changes, this function
1669 * will be invoked. */
1670 void (*forward_bpdu_changed)(struct ofproto *ofproto);
1671
1672 /* Sets the MAC aging timeout for the OFPP_NORMAL action to 'idle_time', in
1673 * seconds, and the maximum number of MAC table entries to
1674 * 'max_entries'.
1675 *
1676 * An implementation that doesn't support configuring these features may
1677 * set this function to NULL or implement it as a no-op. */
1678 void (*set_mac_table_config)(struct ofproto *ofproto,
1679 unsigned int idle_time, size_t max_entries);
1680
1681 /* Configures multicast snooping on 'ofport' using the settings
1682 * defined in 's'.
1683 *
1684 * If 's' is nonnull, this function updates multicast snooping
1685 * configuration to 's' in 'ofproto'.
1686 *
1687 * If 's' is NULL, this function disables multicast snooping
1688 * on 'ofproto'.
1689 *
1690 * An implementation that does not support multicast snooping may set
1691 * it to NULL or return EOPNOTSUPP. */
1692 int (*set_mcast_snooping)(struct ofproto *ofproto,
1693 const struct ofproto_mcast_snooping_settings *s);
1694
1695 /* Configures multicast snooping port's flood setting on 'ofproto'.
1696 *
1697 * If 's' is nonnull, this function updates multicast snooping
1698 * configuration to 's' in 'ofproto'.
1699 *
1700 * If 's' is NULL, this function doesn't change anything.
1701 *
1702 * An implementation that does not support multicast snooping may set
1703 * it to NULL or return EOPNOTSUPP. */
1704 int (*set_mcast_snooping_port)(struct ofproto *ofproto_, void *aux,
1705 const struct ofproto_mcast_snooping_port_settings *s);
1706
1707 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
1708 *
1709 * This is deprecated. It is only for compatibility with broken device drivers
1710 * in old versions of Linux that do not properly support VLANs when VLAN
1711 * devices are not used. When broken device drivers are no longer in
1712 * widespread use, we will delete these interfaces. */
1713
1714 /* If 'realdev_ofp_port' is nonzero, then this function configures 'ofport'
1715 * as a VLAN splinter port for VLAN 'vid', associated with the real device
1716 * that has OpenFlow port number 'realdev_ofp_port'.
1717 *
1718 * If 'realdev_ofp_port' is zero, then this function deconfigures 'ofport'
1719 * as a VLAN splinter port.
1720 *
1721 * This function should be NULL if an implementation does not support it.
1722 */
1723 int (*set_realdev)(struct ofport *ofport,
1724 ofp_port_t realdev_ofp_port, int vid);
1725
1726 /* ## ------------------------ ## */
1727 /* ## OpenFlow meter functions ## */
1728 /* ## ------------------------ ## */
1729
1730 /* These functions should be NULL if an implementation does not support
1731 * them. They must be all null or all non-null.. */
1732
1733 /* Initializes 'features' to describe the metering features supported by
1734 * 'ofproto'. */
1735 void (*meter_get_features)(const struct ofproto *ofproto,
1736 struct ofputil_meter_features *features);
1737
1738 /* If '*id' is UINT32_MAX, adds a new meter with the given 'config'. On
1739 * success the function must store a provider meter ID other than
1740 * UINT32_MAX in '*id'. All further references to the meter will be made
1741 * with the returned provider meter id rather than the OpenFlow meter id.
1742 * The caller does not try to interpret the provider meter id, giving the
1743 * implementation the freedom to either use the OpenFlow meter_id value
1744 * provided in the meter configuration, or any other value suitable for the
1745 * implementation.
1746 *
1747 * If '*id' is a value other than UINT32_MAX, modifies the existing meter
1748 * with that meter provider ID to have configuration 'config', while
1749 * leaving '*id' unchanged. On failure, the existing meter configuration
1750 * is left intact. */
1751 enum ofperr (*meter_set)(struct ofproto *ofproto, ofproto_meter_id *id,
1752 const struct ofputil_meter_config *config);
1753
1754 /* Gets the meter and meter band packet and byte counts for maximum of
1755 * 'stats->n_bands' bands for the meter with provider ID 'id' within
1756 * 'ofproto'. The caller fills in the other stats values. The band stats
1757 * are copied to memory at 'stats->bands' provided by the caller. The
1758 * number of returned band stats is returned in 'stats->n_bands'. */
1759 enum ofperr (*meter_get)(const struct ofproto *ofproto,
1760 ofproto_meter_id id,
1761 struct ofputil_meter_stats *stats);
1762
1763 /* Deletes a meter, making the 'ofproto_meter_id' invalid for any
1764 * further calls. */
1765 void (*meter_del)(struct ofproto *, ofproto_meter_id);
1766
1767
1768 /* ## -------------------- ## */
1769 /* ## OpenFlow 1.1+ groups ## */
1770 /* ## -------------------- ## */
1771
1772 struct ofgroup *(*group_alloc)(void);
1773 enum ofperr (*group_construct)(struct ofgroup *);
1774 void (*group_destruct)(struct ofgroup *);
1775 void (*group_dealloc)(struct ofgroup *);
1776
1777 enum ofperr (*group_modify)(struct ofgroup *);
1778
1779 enum ofperr (*group_get_stats)(const struct ofgroup *,
1780 struct ofputil_group_stats *);
1781
1782 /* ## --------------------- ## */
1783 /* ## Datapath information ## */
1784 /* ## --------------------- ## */
1785 /* Retrieve the version string of the datapath. The version
1786 * string can be NULL if it can not be determined.
1787 *
1788 * The version retuned is read only. The caller should not
1789 * free it.
1790 *
1791 * This function should be NULL if an implementation does not support it.
1792 */
1793 const char *(*get_datapath_version)(const struct ofproto *);
1794 };
1795
1796 extern const struct ofproto_class ofproto_dpif_class;
1797
1798 int ofproto_class_register(const struct ofproto_class *);
1799 int ofproto_class_unregister(const struct ofproto_class *);
1800
1801 /* flow_mod with execution context. */
1802 struct ofproto_flow_mod {
1803 struct ofputil_flow_mod fm;
1804
1805 cls_version_t version; /* Version in which changes take
1806 * effect. */
1807 struct rule_collection old_rules; /* Affected rules. */
1808 struct rule_collection new_rules; /* Replacement rules. */
1809 };
1810
1811 /* port_mod with execution context. */
1812 struct ofproto_port_mod {
1813 struct ofputil_port_mod pm;
1814 struct ofport *port; /* Affected port. */
1815 };
1816
1817 enum ofperr ofproto_flow_mod(struct ofproto *, struct ofproto_flow_mod *)
1818 OVS_EXCLUDED(ofproto_mutex);
1819 void ofproto_add_flow(struct ofproto *, const struct match *, int priority,
1820 const struct ofpact *ofpacts, size_t ofpacts_len)
1821 OVS_EXCLUDED(ofproto_mutex);
1822 void ofproto_delete_flow(struct ofproto *, const struct match *, int priority)
1823 OVS_EXCLUDED(ofproto_mutex);
1824 void ofproto_flush_flows(struct ofproto *);
1825
1826 enum ofperr ofproto_check_ofpacts(struct ofproto *,
1827 const struct ofpact ofpacts[],
1828 size_t ofpacts_len);
1829 \f
1830 static inline const struct rule_actions *
1831 rule_get_actions(const struct rule *rule)
1832 {
1833 return rule->actions;
1834 }
1835
1836 /* Returns true if 'rule' is an OpenFlow 1.3 "table-miss" rule, false
1837 * otherwise.
1838 *
1839 * ("Table-miss" rules are special because a packet_in generated through one
1840 * uses OFPR_NO_MATCH as its reason, whereas packet_ins generated by any other
1841 * rule use OFPR_ACTION.) */
1842 static inline bool
1843 rule_is_table_miss(const struct rule *rule)
1844 {
1845 return rule->cr.priority == 0 && cls_rule_is_catchall(&rule->cr);
1846 }
1847
1848 /* Returns true if 'rule' should be hidden from the controller.
1849 *
1850 * Rules with priority higher than UINT16_MAX are set up by ofproto itself
1851 * (e.g. by in-band control) and are intentionally hidden from the
1852 * controller. */
1853 static inline bool
1854 rule_is_hidden(const struct rule *rule)
1855 {
1856 return rule->cr.priority > UINT16_MAX;
1857 }
1858
1859 static inline struct rule *
1860 rule_from_cls_rule(const struct cls_rule *cls_rule)
1861 {
1862 return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
1863 }
1864
1865 #endif /* ofproto/ofproto-provider.h */