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