]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
9aad5a5a | 2 | * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Nicira, Inc. |
064af421 | 3 | * |
a14bc59f BP |
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: | |
064af421 | 7 | * |
a14bc59f BP |
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. | |
064af421 BP |
15 | */ |
16 | ||
17 | #ifndef OFPROTO_H | |
18 | #define OFPROTO_H 1 | |
19 | ||
d2ede7bc BP |
20 | #include <sys/types.h> |
21 | #include <netinet/in.h> | |
064af421 BP |
22 | #include <stdbool.h> |
23 | #include <stddef.h> | |
24 | #include <stdint.h> | |
1de11730 | 25 | #include "cfm.h" |
13751fd8 | 26 | #include "classifier.h" |
064af421 | 27 | #include "flow.h" |
064d7f84 | 28 | #include "openvswitch/meta-flow.h" |
0193b2af | 29 | #include "netflow.h" |
9efd308e | 30 | #include "rstp.h" |
f5ad2e5f | 31 | #include "smap.h" |
81e2083f | 32 | #include "sset.h" |
21f7563c | 33 | #include "stp.h" |
50b9699f | 34 | #include "lacp.h" |
064af421 | 35 | |
03292c46 JG |
36 | #ifdef __cplusplus |
37 | extern "C" { | |
38 | #endif | |
39 | ||
ccc09689 EJ |
40 | struct bfd_cfg; |
41 | struct cfm_settings; | |
cf3fad8a | 42 | struct cls_rule; |
b5827b24 | 43 | struct netdev; |
202a4b17 | 44 | struct netdev_stats; |
6527c598 | 45 | struct ofport; |
202a4b17 | 46 | struct ofproto; |
bffc0589 | 47 | struct shash; |
0d085684 | 48 | struct simap; |
0477baa9 DF |
49 | struct smap; |
50 | struct netdev_stats; | |
51 | struct ovs_list; | |
52 | struct lldp_status; | |
53 | struct aa_settings; | |
54 | struct aa_mapping_settings; | |
064af421 | 55 | |
afae68b1 JR |
56 | /* Needed for the lock annotations. */ |
57 | extern struct ovs_mutex ofproto_mutex; | |
58 | ||
bffc0589 AE |
59 | struct ofproto_controller_info { |
60 | bool is_connected; | |
f4f1ea7e | 61 | enum ofp12_controller_role role; |
f5ad2e5f | 62 | struct smap pairs; |
bffc0589 AE |
63 | }; |
64 | ||
72b06300 | 65 | struct ofproto_sflow_options { |
81e2083f | 66 | struct sset targets; |
72b06300 BP |
67 | uint32_t sampling_rate; |
68 | uint32_t polling_interval; | |
69 | uint32_t header_len; | |
70 | uint32_t sub_id; | |
71 | char *agent_device; | |
72 | char *control_ip; | |
73 | }; | |
74 | ||
29089a54 RL |
75 | struct ofproto_ipfix_bridge_exporter_options { |
76 | struct sset targets; | |
77 | uint32_t sampling_rate; | |
78 | uint32_t obs_domain_id; /* Bridge-wide Observation Domain ID. */ | |
79 | uint32_t obs_point_id; /* Bridge-wide Observation Point ID. */ | |
978427a5 RL |
80 | uint32_t cache_active_timeout; |
81 | uint32_t cache_max_flows; | |
8b7ea2d4 WZ |
82 | bool enable_tunnel_sampling; |
83 | bool enable_input_sampling; | |
84 | bool enable_output_sampling; | |
c97320eb | 85 | char *virtual_obs_id; |
29089a54 RL |
86 | }; |
87 | ||
88 | struct ofproto_ipfix_flow_exporter_options { | |
89 | uint32_t collector_set_id; | |
90 | struct sset targets; | |
978427a5 RL |
91 | uint32_t cache_active_timeout; |
92 | uint32_t cache_max_flows; | |
f69f713b | 93 | bool enable_tunnel_sampling; |
c97320eb | 94 | char *virtual_obs_id; |
29089a54 RL |
95 | }; |
96 | ||
9efd308e DV |
97 | struct ofproto_rstp_status { |
98 | bool enabled; /* If false, ignore other members. */ | |
99 | rstp_identifier root_id; | |
100 | rstp_identifier bridge_id; | |
101 | rstp_identifier designated_id; | |
102 | uint32_t root_path_cost; | |
103 | uint16_t designated_port_id; | |
104 | uint16_t bridge_port_id; | |
105 | }; | |
106 | ||
107 | struct ofproto_rstp_settings { | |
108 | rstp_identifier address; | |
109 | uint16_t priority; | |
110 | uint32_t ageing_time; | |
111 | enum rstp_force_protocol_version force_protocol_version; | |
112 | uint16_t bridge_forward_delay; | |
113 | uint16_t bridge_max_age; | |
114 | uint16_t transmit_hold_count; | |
115 | }; | |
116 | ||
117 | struct ofproto_port_rstp_status { | |
118 | bool enabled; /* If false, ignore other members. */ | |
119 | uint16_t port_id; | |
120 | enum rstp_port_role role; | |
121 | enum rstp_state state; | |
9c64e6b8 JR |
122 | rstp_identifier designated_bridge_id; |
123 | uint16_t designated_port_id; | |
124 | uint32_t designated_path_cost; | |
9efd308e DV |
125 | int tx_count; /* Number of BPDUs transmitted. */ |
126 | int rx_count; /* Number of valid BPDUs received. */ | |
127 | int error_count; /* Number of bad BPDUs received. */ | |
128 | int uptime; | |
129 | }; | |
130 | ||
131 | struct ofproto_port_rstp_settings { | |
132 | bool enable; | |
133 | uint16_t port_num; /* In the range 1-4095, inclusive. */ | |
134 | uint8_t priority; | |
135 | uint32_t path_cost; | |
136 | bool admin_edge_port; | |
137 | bool auto_edge; | |
138 | bool mcheck; | |
67e8c1ac JR |
139 | uint8_t admin_p2p_mac_state; |
140 | bool admin_port_state; | |
9efd308e DV |
141 | }; |
142 | ||
21f7563c JP |
143 | struct ofproto_stp_settings { |
144 | stp_identifier system_id; | |
145 | uint16_t priority; | |
146 | uint16_t hello_time; | |
147 | uint16_t max_age; | |
148 | uint16_t fwd_delay; | |
149 | }; | |
150 | ||
151 | struct ofproto_stp_status { | |
152 | bool enabled; /* If false, ignore other members. */ | |
153 | stp_identifier bridge_id; | |
154 | stp_identifier designated_root; | |
155 | int root_path_cost; | |
156 | }; | |
157 | ||
158 | struct ofproto_port_stp_settings { | |
159 | bool enable; | |
160 | uint8_t port_num; /* In the range 1-255, inclusive. */ | |
161 | uint8_t priority; | |
162 | uint16_t path_cost; | |
163 | }; | |
164 | ||
165 | struct ofproto_port_stp_status { | |
166 | bool enabled; /* If false, ignore other members. */ | |
167 | int port_id; | |
168 | enum stp_state state; | |
169 | unsigned int sec_in_state; | |
170 | enum stp_role role; | |
fd28ce3a JS |
171 | }; |
172 | ||
173 | struct ofproto_port_stp_stats { | |
174 | bool enabled; /* If false, ignore other members. */ | |
80740385 JP |
175 | int tx_count; /* Number of BPDUs transmitted. */ |
176 | int rx_count; /* Number of valid BPDUs received. */ | |
177 | int error_count; /* Number of bad BPDUs received. */ | |
21f7563c JP |
178 | }; |
179 | ||
8b36f51e EJ |
180 | struct ofproto_port_queue { |
181 | uint32_t queue; /* Queue ID. */ | |
182 | uint8_t dscp; /* DSCP bits (e.g. [0, 63]). */ | |
183 | }; | |
184 | ||
7c38d0a5 FL |
185 | struct ofproto_mcast_snooping_settings { |
186 | bool flood_unreg; /* If true, flood unregistered packets to all | |
187 | all ports. If false, send only to ports | |
188 | connected to multicast routers. */ | |
189 | unsigned int idle_time; /* Entry is removed after the idle time | |
190 | * in seconds. */ | |
191 | unsigned int max_entries; /* Size of the multicast snooping table. */ | |
192 | }; | |
193 | ||
8e04a33f FL |
194 | struct ofproto_mcast_snooping_port_settings { |
195 | bool flood; /* If true, flood multicast traffic */ | |
196 | bool flood_reports; /* If true, flood Reports traffic */ | |
197 | }; | |
198 | ||
79c9f2ee BP |
199 | /* How the switch should act if the controller cannot be contacted. */ |
200 | enum ofproto_fail_mode { | |
201 | OFPROTO_FAIL_SECURE, /* Preserve flow table. */ | |
202 | OFPROTO_FAIL_STANDALONE /* Act as a standalone switch. */ | |
203 | }; | |
204 | ||
205 | enum ofproto_band { | |
206 | OFPROTO_IN_BAND, /* In-band connection to controller. */ | |
207 | OFPROTO_OUT_OF_BAND /* Out-of-band connection to controller. */ | |
208 | }; | |
209 | ||
c66be90b BP |
210 | /* ofproto supports two kinds of OpenFlow connections: |
211 | * | |
212 | * - "Primary" connections to ordinary OpenFlow controllers. ofproto | |
213 | * maintains persistent connections to these controllers and by default | |
214 | * sends them asynchronous messages such as packet-ins. | |
215 | * | |
216 | * - "Service" connections, e.g. from ovs-ofctl. When these connections | |
217 | * drop, it is the other side's responsibility to reconnect them if | |
218 | * necessary. ofproto does not send them asynchronous messages by default. | |
219 | */ | |
220 | enum ofconn_type { | |
221 | OFCONN_PRIMARY, /* An ordinary OpenFlow controller. */ | |
222 | OFCONN_SERVICE /* A service connection, e.g. "ovs-ofctl". */ | |
223 | }; | |
224 | const char *ofconn_type_to_string(enum ofconn_type); | |
225 | ||
226 | /* Configuration for an OpenFlow controller. */ | |
79c9f2ee | 227 | struct ofproto_controller { |
c66be90b | 228 | enum ofconn_type type; /* Primary or service controller. */ |
79c9f2ee BP |
229 | int max_backoff; /* Maximum reconnection backoff, in seconds. */ |
230 | int probe_interval; /* Max idle time before probing, in seconds. */ | |
9886b662 BP |
231 | enum ofproto_band band; /* In-band or out-of-band? */ |
232 | bool enable_async_msgs; /* Initially enable asynchronous messages? */ | |
af26093a BP |
233 | uint32_t allowed_versions; /* OpenFlow protocol versions that may |
234 | * be negotiated for a session. */ | |
79c9f2ee | 235 | |
79c9f2ee | 236 | /* OpenFlow packet-in rate-limiting. */ |
3dabc687 | 237 | int max_pktq_size; /* Maximum number of packet-in to be queued. */ |
79c9f2ee BP |
238 | int rate_limit; /* Max packet-in rate in packets per second. */ |
239 | int burst_limit; /* Limit on accumulating packet credits. */ | |
f125905c MM |
240 | |
241 | uint8_t dscp; /* DSCP value for controller connection. */ | |
79c9f2ee BP |
242 | }; |
243 | ||
f79e673f BP |
244 | void ofproto_enumerate_types(struct sset *types); |
245 | const char *ofproto_normalize_type(const char *); | |
246 | ||
247 | int ofproto_enumerate_names(const char *type, struct sset *names); | |
63d347ce BP |
248 | void ofproto_parse_name(const char *name, char **dp_name, char **dp_type); |
249 | ||
b0408fca JP |
250 | /* An interface hint element, which is used by ofproto_init() to |
251 | * describe the caller's understanding of the startup state. */ | |
252 | struct iface_hint { | |
253 | char *br_name; /* Name of owning bridge. */ | |
254 | char *br_type; /* Type of owning bridge. */ | |
4e022ec0 | 255 | ofp_port_t ofp_port; /* OpenFlow port number. */ |
b0408fca JP |
256 | }; |
257 | ||
258 | void ofproto_init(const struct shash *iface_hints); | |
259 | ||
11a574a7 | 260 | int ofproto_type_run(const char *datapath_type); |
11a574a7 JP |
261 | void ofproto_type_wait(const char *datapath_type); |
262 | ||
1a6f1e2a | 263 | int ofproto_create(const char *datapath, const char *datapath_type, |
25010c68 JR |
264 | struct ofproto **ofprotop) |
265 | OVS_EXCLUDED(ofproto_mutex); | |
9aad5a5a | 266 | void ofproto_destroy(struct ofproto *, bool del); |
f79e673f BP |
267 | int ofproto_delete(const char *name, const char *type); |
268 | ||
064af421 | 269 | int ofproto_run(struct ofproto *); |
064af421 BP |
270 | void ofproto_wait(struct ofproto *); |
271 | bool ofproto_is_alive(const struct ofproto *); | |
272 | ||
0d085684 | 273 | void ofproto_get_memory_usage(const struct ofproto *, struct simap *); |
1c030aa5 | 274 | void ofproto_type_get_memory_usage(const char *datapath_type, struct simap *); |
0d085684 | 275 | |
b5827b24 BP |
276 | /* A port within an OpenFlow switch. |
277 | * | |
278 | * 'name' and 'type' are suitable for passing to netdev_open(). */ | |
279 | struct ofproto_port { | |
280 | char *name; /* Network device name, e.g. "eth0". */ | |
281 | char *type; /* Network device type, e.g. "system". */ | |
4e022ec0 | 282 | ofp_port_t ofp_port; /* OpenFlow port number. */ |
b5827b24 BP |
283 | }; |
284 | void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *); | |
285 | void ofproto_port_destroy(struct ofproto_port *); | |
286 | ||
287 | struct ofproto_port_dump { | |
288 | const struct ofproto *ofproto; | |
289 | int error; | |
290 | void *state; | |
291 | }; | |
292 | void ofproto_port_dump_start(struct ofproto_port_dump *, | |
293 | const struct ofproto *); | |
294 | bool ofproto_port_dump_next(struct ofproto_port_dump *, struct ofproto_port *); | |
295 | int ofproto_port_dump_done(struct ofproto_port_dump *); | |
296 | ||
892815f5 | 297 | /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state. |
b5827b24 BP |
298 | * |
299 | * Arguments all have pointer type. | |
300 | * | |
301 | * If you break out of the loop, then you need to free the dump structure by | |
302 | * hand using ofproto_port_dump_done(). */ | |
303 | #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO) \ | |
304 | for (ofproto_port_dump_start(DUMP, OFPROTO); \ | |
305 | (ofproto_port_dump_next(DUMP, OFPROTO_PORT) \ | |
306 | ? true \ | |
307 | : (ofproto_port_dump_done(DUMP), false)); \ | |
308 | ) | |
309 | ||
e79a6c83 | 310 | #define OFPROTO_FLOW_LIMIT_DEFAULT 200000 |
b2a4692c | 311 | #define OFPROTO_MAX_IDLE_DEFAULT 10000 /* ms */ |
b6bdc3cd | 312 | #define OFPROTO_MAX_REVALIDATOR_DEFAULT 500 /* ms */ |
e31ecf58 | 313 | #define OFPROTO_MIN_REVALIDATE_PPS_DEFAULT 5 |
084f5290 | 314 | |
c381bca5 | 315 | const char *ofproto_port_open_type(const struct ofproto *, |
0aeaabc8 | 316 | const char *port_type); |
4e022ec0 AW |
317 | int ofproto_port_add(struct ofproto *, struct netdev *, ofp_port_t *ofp_portp); |
318 | int ofproto_port_del(struct ofproto *, ofp_port_t ofp_port); | |
91364d18 IM |
319 | void ofproto_port_set_config(struct ofproto *, ofp_port_t ofp_port, |
320 | const struct smap *cfg); | |
6527c598 | 321 | int ofproto_port_get_stats(const struct ofport *, struct netdev_stats *stats); |
3a6ccc8c | 322 | |
723b6ab2 IM |
323 | int ofproto_vport_get_status(const struct ofproto *, ofp_port_t ofp_port, |
324 | char **errp); | |
325 | ||
b5827b24 BP |
326 | int ofproto_port_query_by_name(const struct ofproto *, const char *devname, |
327 | struct ofproto_port *); | |
328 | ||
e7934396 | 329 | /* Top-level configuration. */ |
e825ace2 | 330 | uint64_t ofproto_get_datapath_id(const struct ofproto *); |
064af421 | 331 | void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id); |
af26093a | 332 | void ofproto_set_controllers(struct ofproto *, struct shash *controllers); |
31681a5d | 333 | void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode); |
fa05809b | 334 | void ofproto_reconnect_controllers(struct ofproto *); |
917e50e1 BP |
335 | void ofproto_set_extra_in_band_remotes(struct ofproto *, |
336 | const struct sockaddr_in *, size_t n); | |
b1da6250 | 337 | void ofproto_set_in_band_queue(struct ofproto *, int queue_id); |
7fdd2082 | 338 | void ofproto_set_bundle_idle_timeout(unsigned timeout); |
e79a6c83 | 339 | void ofproto_set_flow_limit(unsigned limit); |
72310b04 | 340 | void ofproto_set_max_idle(unsigned max_idle); |
b6bdc3cd | 341 | void ofproto_set_max_revalidator(unsigned max_revalidator); |
e31ecf58 | 342 | void ofproto_set_min_revalidate_pps(unsigned min_revalidate_pps); |
8402c74b | 343 | void ofproto_set_forward_bpdu(struct ofproto *, bool forward_bpdu); |
c4069512 BP |
344 | void ofproto_set_mac_table_config(struct ofproto *, unsigned idle_time, |
345 | size_t max_entries); | |
7c38d0a5 FL |
346 | int ofproto_set_mcast_snooping(struct ofproto *ofproto, |
347 | const struct ofproto_mcast_snooping_settings *s); | |
348 | int ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux, | |
8e04a33f | 349 | const struct ofproto_mcast_snooping_port_settings *s); |
30ea0da7 | 350 | void ofproto_set_threads(int n_handlers, int n_revalidators); |
d4f6865c DDP |
351 | void ofproto_type_set_config(const char *type, |
352 | const struct smap *other_config); | |
8b6ff729 | 353 | void ofproto_set_dp_desc(struct ofproto *, const char *dp_desc); |
81e2083f | 354 | int ofproto_set_snoops(struct ofproto *, const struct sset *snoops); |
0193b2af JG |
355 | int ofproto_set_netflow(struct ofproto *, |
356 | const struct netflow_options *nf_options); | |
abe529af | 357 | int ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *); |
29089a54 RL |
358 | int ofproto_set_ipfix(struct ofproto *, |
359 | const struct ofproto_ipfix_bridge_exporter_options *, | |
360 | const struct ofproto_ipfix_flow_exporter_options *, | |
361 | size_t); | |
40358701 GS |
362 | void ofproto_set_flow_restore_wait(bool flow_restore_wait_db); |
363 | bool ofproto_get_flow_restore_wait(void); | |
21f7563c JP |
364 | int ofproto_set_stp(struct ofproto *, const struct ofproto_stp_settings *); |
365 | int ofproto_get_stp_status(struct ofproto *, struct ofproto_stp_status *); | |
064af421 | 366 | |
9efd308e DV |
367 | int ofproto_set_rstp(struct ofproto *, const struct ofproto_rstp_settings *); |
368 | int ofproto_get_rstp_status(struct ofproto *, struct ofproto_rstp_status *); | |
f0fb825a | 369 | void ofproto_set_vlan_limit(int vlan_limit); |
993cae67 YHW |
370 | void ofproto_ct_set_zone_timeout_policy(const char *datapath_type, |
371 | uint16_t zone, | |
372 | struct simap *timeout_policy); | |
373 | void ofproto_ct_del_zone_timeout_policy(const char *datapath_type, | |
374 | uint16_t zone); | |
27501802 WT |
375 | void ofproto_get_datapath_cap(const char *datapath_type, |
376 | struct smap *dp_cap); | |
9efd308e | 377 | |
fa066f01 | 378 | /* Configuration of ports. */ |
4e022ec0 | 379 | void ofproto_port_unregister(struct ofproto *, ofp_port_t ofp_port); |
fa066f01 | 380 | |
4e022ec0 AW |
381 | void ofproto_port_clear_cfm(struct ofproto *, ofp_port_t ofp_port); |
382 | void ofproto_port_set_cfm(struct ofproto *, ofp_port_t ofp_port, | |
a5610457 | 383 | const struct cfm_settings *); |
4e022ec0 | 384 | void ofproto_port_set_bfd(struct ofproto *, ofp_port_t ofp_port, |
ccc09689 | 385 | const struct smap *cfg); |
8f5514fe | 386 | bool ofproto_port_bfd_status_changed(struct ofproto *, ofp_port_t ofp_port); |
4e022ec0 | 387 | int ofproto_port_get_bfd_status(struct ofproto *, ofp_port_t ofp_port, |
ccc09689 | 388 | struct smap *); |
4e022ec0 | 389 | int ofproto_port_is_lacp_current(struct ofproto *, ofp_port_t ofp_port); |
50b9699f | 390 | int ofproto_port_get_lacp_stats(const struct ofport *, struct lacp_slave_stats *); |
4e022ec0 | 391 | int ofproto_port_set_stp(struct ofproto *, ofp_port_t ofp_port, |
21f7563c | 392 | const struct ofproto_port_stp_settings *); |
4e022ec0 | 393 | int ofproto_port_get_stp_status(struct ofproto *, ofp_port_t ofp_port, |
21f7563c | 394 | struct ofproto_port_stp_status *); |
fd28ce3a JS |
395 | int ofproto_port_get_stp_stats(struct ofproto *, ofp_port_t ofp_port, |
396 | struct ofproto_port_stp_stats *); | |
4e022ec0 | 397 | int ofproto_port_set_queues(struct ofproto *, ofp_port_t ofp_port, |
8b36f51e EJ |
398 | const struct ofproto_port_queue *, |
399 | size_t n_queues); | |
9efd308e DV |
400 | int ofproto_port_get_rstp_status(struct ofproto *, ofp_port_t ofp_port, |
401 | struct ofproto_port_rstp_status *); | |
402 | ||
403 | int ofproto_port_set_rstp(struct ofproto *, ofp_port_t ofp_port, | |
404 | const struct ofproto_port_rstp_settings *); | |
fa066f01 | 405 | |
ecac4ebf BP |
406 | /* The behaviour of the port regarding VLAN handling */ |
407 | enum port_vlan_mode { | |
408 | /* This port is an access port. 'vlan' is the VLAN ID. 'trunks' is | |
409 | * ignored. */ | |
410 | PORT_VLAN_ACCESS, | |
411 | ||
412 | /* This port is a trunk. 'trunks' is the set of trunks. 'vlan' is | |
413 | * ignored. */ | |
414 | PORT_VLAN_TRUNK, | |
415 | ||
416 | /* Untagged incoming packets are part of 'vlan', as are incoming packets | |
417 | * tagged with 'vlan'. Outgoing packets tagged with 'vlan' stay tagged. | |
418 | * Other VLANs in 'trunks' are trunked. */ | |
419 | PORT_VLAN_NATIVE_TAGGED, | |
420 | ||
421 | /* Untagged incoming packets are part of 'vlan', as are incoming packets | |
422 | * tagged with 'vlan'. Outgoing packets tagged with 'vlan' are untagged. | |
423 | * Other VLANs in 'trunks' are trunked. */ | |
fed8962a EG |
424 | PORT_VLAN_NATIVE_UNTAGGED, |
425 | ||
426 | /* 802.1q tunnel port. Incoming packets are added an outer vlan tag | |
427 | * 'vlan'. If 'cvlans' is set, only allows VLANs in 'cvlans'. */ | |
428 | PORT_VLAN_DOT1Q_TUNNEL | |
ecac4ebf BP |
429 | }; |
430 | ||
88f52d7f EB |
431 | /* The behaviour of the port regarding priority tags */ |
432 | enum port_priority_tags_mode { | |
433 | PORT_PRIORITY_TAGS_NEVER = 0, | |
434 | PORT_PRIORITY_TAGS_IF_NONZERO, | |
ffbe41db | 435 | PORT_PRIORITY_TAGS_ALWAYS, |
88f52d7f EB |
436 | }; |
437 | ||
438 | /* The behaviour of the port regarding priority tags */ | |
fa066f01 BP |
439 | /* Configuration of bundles. */ |
440 | struct ofproto_bundle_settings { | |
441 | char *name; /* For use in log messages. */ | |
442 | ||
4e022ec0 | 443 | ofp_port_t *slaves; /* OpenFlow port numbers for slaves. */ |
fa066f01 BP |
444 | size_t n_slaves; |
445 | ||
ecac4ebf | 446 | enum port_vlan_mode vlan_mode; /* Selects mode for vlan and trunks */ |
fed8962a | 447 | uint16_t qinq_ethtype; |
ecac4ebf BP |
448 | int vlan; /* VLAN VID, except for PORT_VLAN_TRUNK. */ |
449 | unsigned long *trunks; /* vlan_bitmap, except for PORT_VLAN_ACCESS. */ | |
fed8962a | 450 | unsigned long *cvlans; |
88f52d7f EB |
451 | enum port_priority_tags_mode use_priority_tags; |
452 | /* Use 802.1p tag for frames in VLAN 0? */ | |
fa066f01 BP |
453 | |
454 | struct bond_settings *bond; /* Must be nonnull iff if n_slaves > 1. */ | |
455 | ||
456 | struct lacp_settings *lacp; /* Nonnull to enable LACP. */ | |
457 | struct lacp_slave_settings *lacp_slaves; /* Array of n_slaves elements. */ | |
c005f976 BK |
458 | |
459 | bool protected; /* Protected port mode */ | |
fa066f01 BP |
460 | }; |
461 | ||
abe529af BP |
462 | int ofproto_bundle_register(struct ofproto *, void *aux, |
463 | const struct ofproto_bundle_settings *); | |
464 | int ofproto_bundle_unregister(struct ofproto *, void *aux); | |
fa066f01 BP |
465 | |
466 | /* Configuration of mirrors. */ | |
467 | struct ofproto_mirror_settings { | |
468 | /* Name for log messages. */ | |
469 | char *name; | |
470 | ||
471 | /* Bundles that select packets for mirroring upon ingress. */ | |
472 | void **srcs; /* A set of registered ofbundle handles. */ | |
473 | size_t n_srcs; | |
474 | ||
475 | /* Bundles that select packets for mirroring upon egress. */ | |
476 | void **dsts; /* A set of registered ofbundle handles. */ | |
477 | size_t n_dsts; | |
478 | ||
479 | /* VLANs of packets to select for mirroring. */ | |
480 | unsigned long *src_vlans; /* vlan_bitmap, NULL selects all VLANs. */ | |
481 | ||
482 | /* Output (mutually exclusive). */ | |
483 | void *out_bundle; /* A registered ofbundle handle or NULL. */ | |
484 | uint16_t out_vlan; /* Output VLAN, only if out_bundle is NULL. */ | |
1356dbd1 WT |
485 | uint16_t snaplen; /* Max packet size of a mirrored packet |
486 | in byte, set to 0 equals 65535. */ | |
fa066f01 BP |
487 | }; |
488 | ||
abe529af BP |
489 | int ofproto_mirror_register(struct ofproto *, void *aux, |
490 | const struct ofproto_mirror_settings *); | |
491 | int ofproto_mirror_unregister(struct ofproto *, void *aux); | |
9d24de3b JP |
492 | int ofproto_mirror_get_stats(struct ofproto *, void *aux, |
493 | uint64_t *packets, uint64_t *bytes); | |
fa066f01 | 494 | |
0477baa9 DF |
495 | void ofproto_port_set_lldp(struct ofproto *ofproto, ofp_port_t ofp_port, |
496 | const struct smap *cfg); | |
497 | int ofproto_set_aa(struct ofproto *ofproto, void *aux, | |
498 | const struct aa_settings *s); | |
499 | int ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux, | |
500 | const struct aa_mapping_settings *s); | |
501 | int ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux); | |
502 | int ofproto_aa_vlan_get_queued(struct ofproto *ofproto, struct ovs_list *list); | |
503 | unsigned int ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto); | |
504 | ||
abe529af | 505 | int ofproto_set_flood_vlans(struct ofproto *, unsigned long *flood_vlans); |
b4affc74 | 506 | bool ofproto_is_mirror_output_bundle(const struct ofproto *, void *aux); |
e7934396 | 507 | |
254750ce BP |
508 | /* Configuration of OpenFlow tables. */ |
509 | struct ofproto_table_settings { | |
510 | char *name; /* Name exported via OpenFlow or NULL. */ | |
511 | unsigned int max_flows; /* Maximum number of flows or UINT_MAX. */ | |
512 | ||
82c22d34 BP |
513 | /* These members, together with OpenFlow OFPT_TABLE_MOD, determine the |
514 | * handling of an attempt to add a flow that would cause the table to have | |
515 | * more than 'max_flows' flows: | |
254750ce | 516 | * |
82c22d34 BP |
517 | * - If 'enable_eviction' is false and OFPT_TABLE_MOD does not enable |
518 | * eviction, overflows will be rejected with an error. | |
254750ce | 519 | * |
82c22d34 BP |
520 | * - If 'enable_eviction' is true or OFPT_TABLE_MOD enables eviction, an |
521 | * overflow will cause a flow to be removed. The flow to be removed | |
522 | * is chosen to give fairness among groups distinguished by different | |
523 | * values for the 'n_groups' subfields within 'groups'. */ | |
524 | bool enable_eviction; | |
254750ce BP |
525 | struct mf_subfield *groups; |
526 | size_t n_groups; | |
13751fd8 JR |
527 | |
528 | /* | |
529 | * Fields for which prefix trie lookup is maintained. | |
530 | */ | |
531 | unsigned int n_prefix_fields; | |
532 | enum mf_field_id prefix_fields[CLS_MAX_TRIES]; | |
254750ce BP |
533 | }; |
534 | ||
f017d986 JR |
535 | extern const enum mf_field_id default_prefix_fields[2]; |
536 | BUILD_ASSERT_DECL(ARRAY_SIZE(default_prefix_fields) <= CLS_MAX_TRIES); | |
537 | ||
254750ce | 538 | int ofproto_get_n_tables(const struct ofproto *); |
adcf00ba | 539 | uint8_t ofproto_get_n_visible_tables(const struct ofproto *); |
254750ce BP |
540 | void ofproto_configure_table(struct ofproto *, int table_id, |
541 | const struct ofproto_table_settings *); | |
542 | ||
064af421 | 543 | /* Configuration querying. */ |
81e2083f BP |
544 | bool ofproto_has_snoops(const struct ofproto *); |
545 | void ofproto_get_snoops(const struct ofproto *, struct sset *); | |
4f2cad2c | 546 | void ofproto_get_all_flows(struct ofproto *p, struct ds *); |
b5827b24 BP |
547 | void ofproto_get_netflow_ids(const struct ofproto *, |
548 | uint8_t *engine_type, uint8_t *engine_id); | |
9a9e3786 | 549 | |
bffc0589 AE |
550 | void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *); |
551 | void ofproto_free_ofproto_controller_info(struct shash *); | |
9a9e3786 | 552 | |
8f5514fe AW |
553 | bool ofproto_port_cfm_status_changed(struct ofproto *, ofp_port_t ofp_port); |
554 | ||
88bf179a AW |
555 | int ofproto_port_get_cfm_status(const struct ofproto *, |
556 | ofp_port_t ofp_port, | |
685acfd9 | 557 | struct cfm_status *); |
52a90c29 | 558 | \f |
6d328fa2 SH |
559 | /* Table configuration */ |
560 | ||
3c1bb396 BP |
561 | enum ofputil_table_miss ofproto_table_get_miss_config(const struct ofproto *, |
562 | uint8_t table_id); | |
bffc0589 | 563 | |
03292c46 JG |
564 | #ifdef __cplusplus |
565 | } | |
566 | #endif | |
567 | ||
064af421 | 568 | #endif /* ofproto.h */ |