]> git.proxmox.com Git - mirror_ovs.git/blob - ofproto/ofproto.h
50208d481862a3a4f8f3ba51c46e2ffdbedc191b
[mirror_ovs.git] / ofproto / ofproto.h
1 /*
2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Nicira, Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 #ifndef OFPROTO_H
18 #define OFPROTO_H 1
19
20 #include <sys/types.h>
21 #include <netinet/in.h>
22 #include <stdbool.h>
23 #include <stddef.h>
24 #include <stdint.h>
25 #include "cfm.h"
26 #include "classifier.h"
27 #include "flow.h"
28 #include "openvswitch/meta-flow.h"
29 #include "netflow.h"
30 #include "rstp.h"
31 #include "smap.h"
32 #include "sset.h"
33 #include "stp.h"
34 #include "lacp.h"
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 struct bfd_cfg;
41 struct cfm_settings;
42 struct cls_rule;
43 struct netdev;
44 struct netdev_stats;
45 struct ofport;
46 struct ofproto;
47 struct shash;
48 struct simap;
49 struct smap;
50 struct netdev_stats;
51 struct ovs_list;
52 struct lldp_status;
53 struct aa_settings;
54 struct aa_mapping_settings;
55
56 /* Needed for the lock annotations. */
57 extern struct ovs_mutex ofproto_mutex;
58
59 struct ofproto_controller_info {
60 bool is_connected;
61 enum ofp12_controller_role role;
62 struct smap pairs;
63 };
64
65 struct ofproto_sflow_options {
66 struct sset targets;
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
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. */
80 uint32_t cache_active_timeout;
81 uint32_t cache_max_flows;
82 bool enable_tunnel_sampling;
83 bool enable_input_sampling;
84 bool enable_output_sampling;
85 char *virtual_obs_id;
86 };
87
88 struct ofproto_ipfix_flow_exporter_options {
89 uint32_t collector_set_id;
90 struct sset targets;
91 uint32_t cache_active_timeout;
92 uint32_t cache_max_flows;
93 bool enable_tunnel_sampling;
94 char *virtual_obs_id;
95 };
96
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;
122 rstp_identifier designated_bridge_id;
123 uint16_t designated_port_id;
124 uint32_t designated_path_cost;
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;
139 uint8_t admin_p2p_mac_state;
140 bool admin_port_state;
141 };
142
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;
171 };
172
173 struct ofproto_port_stp_stats {
174 bool enabled; /* If false, ignore other members. */
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. */
178 };
179
180 struct ofproto_port_queue {
181 uint32_t queue; /* Queue ID. */
182 uint8_t dscp; /* DSCP bits (e.g. [0, 63]). */
183 };
184
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
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
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
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. */
227 struct ofproto_controller {
228 enum ofconn_type type; /* Primary or service controller. */
229 int max_backoff; /* Maximum reconnection backoff, in seconds. */
230 int probe_interval; /* Max idle time before probing, in seconds. */
231 enum ofproto_band band; /* In-band or out-of-band? */
232 bool enable_async_msgs; /* Initially enable asynchronous messages? */
233 uint32_t allowed_versions; /* OpenFlow protocol versions that may
234 * be negotiated for a session. */
235
236 /* OpenFlow packet-in rate-limiting. */
237 int rate_limit; /* Max packet-in rate in packets per second. */
238 int burst_limit; /* Limit on accumulating packet credits. */
239
240 uint8_t dscp; /* DSCP value for controller connection. */
241 };
242
243 void ofproto_enumerate_types(struct sset *types);
244 const char *ofproto_normalize_type(const char *);
245
246 int ofproto_enumerate_names(const char *type, struct sset *names);
247 void ofproto_parse_name(const char *name, char **dp_name, char **dp_type);
248
249 /* An interface hint element, which is used by ofproto_init() to
250 * describe the caller's understanding of the startup state. */
251 struct iface_hint {
252 char *br_name; /* Name of owning bridge. */
253 char *br_type; /* Type of owning bridge. */
254 ofp_port_t ofp_port; /* OpenFlow port number. */
255 };
256
257 void ofproto_init(const struct shash *iface_hints);
258
259 int ofproto_type_run(const char *datapath_type);
260 void ofproto_type_wait(const char *datapath_type);
261
262 int ofproto_create(const char *datapath, const char *datapath_type,
263 struct ofproto **ofprotop)
264 OVS_EXCLUDED(ofproto_mutex);
265 void ofproto_destroy(struct ofproto *, bool del);
266 int ofproto_delete(const char *name, const char *type);
267
268 int ofproto_run(struct ofproto *);
269 void ofproto_wait(struct ofproto *);
270 bool ofproto_is_alive(const struct ofproto *);
271
272 void ofproto_get_memory_usage(const struct ofproto *, struct simap *);
273 void ofproto_type_get_memory_usage(const char *datapath_type, struct simap *);
274
275 /* A port within an OpenFlow switch.
276 *
277 * 'name' and 'type' are suitable for passing to netdev_open(). */
278 struct ofproto_port {
279 char *name; /* Network device name, e.g. "eth0". */
280 char *type; /* Network device type, e.g. "system". */
281 ofp_port_t ofp_port; /* OpenFlow port number. */
282 };
283 void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *);
284 void ofproto_port_destroy(struct ofproto_port *);
285
286 struct ofproto_port_dump {
287 const struct ofproto *ofproto;
288 int error;
289 void *state;
290 };
291 void ofproto_port_dump_start(struct ofproto_port_dump *,
292 const struct ofproto *);
293 bool ofproto_port_dump_next(struct ofproto_port_dump *, struct ofproto_port *);
294 int ofproto_port_dump_done(struct ofproto_port_dump *);
295
296 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
297 *
298 * Arguments all have pointer type.
299 *
300 * If you break out of the loop, then you need to free the dump structure by
301 * hand using ofproto_port_dump_done(). */
302 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO) \
303 for (ofproto_port_dump_start(DUMP, OFPROTO); \
304 (ofproto_port_dump_next(DUMP, OFPROTO_PORT) \
305 ? true \
306 : (ofproto_port_dump_done(DUMP), false)); \
307 )
308
309 #define OFPROTO_FLOW_LIMIT_DEFAULT 200000
310 #define OFPROTO_MAX_IDLE_DEFAULT 10000 /* ms */
311
312 const char *ofproto_port_open_type(const struct ofproto *,
313 const char *port_type);
314 int ofproto_port_add(struct ofproto *, struct netdev *, ofp_port_t *ofp_portp);
315 int ofproto_port_del(struct ofproto *, ofp_port_t ofp_port);
316 void ofproto_port_set_config(struct ofproto *, ofp_port_t ofp_port,
317 const struct smap *cfg);
318 int ofproto_port_get_stats(const struct ofport *, struct netdev_stats *stats);
319
320 int ofproto_port_query_by_name(const struct ofproto *, const char *devname,
321 struct ofproto_port *);
322
323 /* Top-level configuration. */
324 uint64_t ofproto_get_datapath_id(const struct ofproto *);
325 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
326 void ofproto_set_controllers(struct ofproto *, struct shash *controllers);
327 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
328 void ofproto_reconnect_controllers(struct ofproto *);
329 void ofproto_set_extra_in_band_remotes(struct ofproto *,
330 const struct sockaddr_in *, size_t n);
331 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
332 void ofproto_set_bundle_idle_timeout(unsigned timeout);
333 void ofproto_set_flow_limit(unsigned limit);
334 void ofproto_set_max_idle(unsigned max_idle);
335 void ofproto_set_forward_bpdu(struct ofproto *, bool forward_bpdu);
336 void ofproto_set_mac_table_config(struct ofproto *, unsigned idle_time,
337 size_t max_entries);
338 int ofproto_set_mcast_snooping(struct ofproto *ofproto,
339 const struct ofproto_mcast_snooping_settings *s);
340 int ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
341 const struct ofproto_mcast_snooping_port_settings *s);
342 void ofproto_set_threads(int n_handlers, int n_revalidators);
343 void ofproto_type_set_config(const char *type,
344 const struct smap *other_config);
345 void ofproto_set_dp_desc(struct ofproto *, const char *dp_desc);
346 int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
347 int ofproto_set_netflow(struct ofproto *,
348 const struct netflow_options *nf_options);
349 int ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
350 int ofproto_set_ipfix(struct ofproto *,
351 const struct ofproto_ipfix_bridge_exporter_options *,
352 const struct ofproto_ipfix_flow_exporter_options *,
353 size_t);
354 void ofproto_set_flow_restore_wait(bool flow_restore_wait_db);
355 bool ofproto_get_flow_restore_wait(void);
356 int ofproto_set_stp(struct ofproto *, const struct ofproto_stp_settings *);
357 int ofproto_get_stp_status(struct ofproto *, struct ofproto_stp_status *);
358
359 int ofproto_set_rstp(struct ofproto *, const struct ofproto_rstp_settings *);
360 int ofproto_get_rstp_status(struct ofproto *, struct ofproto_rstp_status *);
361 void ofproto_set_vlan_limit(int vlan_limit);
362
363 /* Configuration of ports. */
364 void ofproto_port_unregister(struct ofproto *, ofp_port_t ofp_port);
365
366 void ofproto_port_clear_cfm(struct ofproto *, ofp_port_t ofp_port);
367 void ofproto_port_set_cfm(struct ofproto *, ofp_port_t ofp_port,
368 const struct cfm_settings *);
369 void ofproto_port_set_bfd(struct ofproto *, ofp_port_t ofp_port,
370 const struct smap *cfg);
371 bool ofproto_port_bfd_status_changed(struct ofproto *, ofp_port_t ofp_port);
372 int ofproto_port_get_bfd_status(struct ofproto *, ofp_port_t ofp_port,
373 struct smap *);
374 int ofproto_port_is_lacp_current(struct ofproto *, ofp_port_t ofp_port);
375 int ofproto_port_get_lacp_stats(const struct ofport *, struct lacp_slave_stats *);
376 int ofproto_port_set_stp(struct ofproto *, ofp_port_t ofp_port,
377 const struct ofproto_port_stp_settings *);
378 int ofproto_port_get_stp_status(struct ofproto *, ofp_port_t ofp_port,
379 struct ofproto_port_stp_status *);
380 int ofproto_port_get_stp_stats(struct ofproto *, ofp_port_t ofp_port,
381 struct ofproto_port_stp_stats *);
382 int ofproto_port_set_queues(struct ofproto *, ofp_port_t ofp_port,
383 const struct ofproto_port_queue *,
384 size_t n_queues);
385 int ofproto_port_get_rstp_status(struct ofproto *, ofp_port_t ofp_port,
386 struct ofproto_port_rstp_status *);
387
388 int ofproto_port_set_rstp(struct ofproto *, ofp_port_t ofp_port,
389 const struct ofproto_port_rstp_settings *);
390
391 /* The behaviour of the port regarding VLAN handling */
392 enum port_vlan_mode {
393 /* This port is an access port. 'vlan' is the VLAN ID. 'trunks' is
394 * ignored. */
395 PORT_VLAN_ACCESS,
396
397 /* This port is a trunk. 'trunks' is the set of trunks. 'vlan' is
398 * ignored. */
399 PORT_VLAN_TRUNK,
400
401 /* Untagged incoming packets are part of 'vlan', as are incoming packets
402 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' stay tagged.
403 * Other VLANs in 'trunks' are trunked. */
404 PORT_VLAN_NATIVE_TAGGED,
405
406 /* Untagged incoming packets are part of 'vlan', as are incoming packets
407 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' are untagged.
408 * Other VLANs in 'trunks' are trunked. */
409 PORT_VLAN_NATIVE_UNTAGGED,
410
411 /* 802.1q tunnel port. Incoming packets are added an outer vlan tag
412 * 'vlan'. If 'cvlans' is set, only allows VLANs in 'cvlans'. */
413 PORT_VLAN_DOT1Q_TUNNEL
414 };
415
416 /* Configuration of bundles. */
417 struct ofproto_bundle_settings {
418 char *name; /* For use in log messages. */
419
420 ofp_port_t *slaves; /* OpenFlow port numbers for slaves. */
421 size_t n_slaves;
422
423 enum port_vlan_mode vlan_mode; /* Selects mode for vlan and trunks */
424 uint16_t qinq_ethtype;
425 int vlan; /* VLAN VID, except for PORT_VLAN_TRUNK. */
426 unsigned long *trunks; /* vlan_bitmap, except for PORT_VLAN_ACCESS. */
427 unsigned long *cvlans;
428 bool use_priority_tags; /* Use 802.1p tag for frames in VLAN 0? */
429
430 struct bond_settings *bond; /* Must be nonnull iff if n_slaves > 1. */
431
432 struct lacp_settings *lacp; /* Nonnull to enable LACP. */
433 struct lacp_slave_settings *lacp_slaves; /* Array of n_slaves elements. */
434
435 bool protected; /* Protected port mode */
436 };
437
438 int ofproto_bundle_register(struct ofproto *, void *aux,
439 const struct ofproto_bundle_settings *);
440 int ofproto_bundle_unregister(struct ofproto *, void *aux);
441
442 /* Configuration of mirrors. */
443 struct ofproto_mirror_settings {
444 /* Name for log messages. */
445 char *name;
446
447 /* Bundles that select packets for mirroring upon ingress. */
448 void **srcs; /* A set of registered ofbundle handles. */
449 size_t n_srcs;
450
451 /* Bundles that select packets for mirroring upon egress. */
452 void **dsts; /* A set of registered ofbundle handles. */
453 size_t n_dsts;
454
455 /* VLANs of packets to select for mirroring. */
456 unsigned long *src_vlans; /* vlan_bitmap, NULL selects all VLANs. */
457
458 /* Output (mutually exclusive). */
459 void *out_bundle; /* A registered ofbundle handle or NULL. */
460 uint16_t out_vlan; /* Output VLAN, only if out_bundle is NULL. */
461 uint16_t snaplen; /* Max packet size of a mirrored packet
462 in byte, set to 0 equals 65535. */
463 };
464
465 int ofproto_mirror_register(struct ofproto *, void *aux,
466 const struct ofproto_mirror_settings *);
467 int ofproto_mirror_unregister(struct ofproto *, void *aux);
468 int ofproto_mirror_get_stats(struct ofproto *, void *aux,
469 uint64_t *packets, uint64_t *bytes);
470
471 void ofproto_port_set_lldp(struct ofproto *ofproto, ofp_port_t ofp_port,
472 const struct smap *cfg);
473 int ofproto_set_aa(struct ofproto *ofproto, void *aux,
474 const struct aa_settings *s);
475 int ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux,
476 const struct aa_mapping_settings *s);
477 int ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux);
478 int ofproto_aa_vlan_get_queued(struct ofproto *ofproto, struct ovs_list *list);
479 unsigned int ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto);
480
481 int ofproto_set_flood_vlans(struct ofproto *, unsigned long *flood_vlans);
482 bool ofproto_is_mirror_output_bundle(const struct ofproto *, void *aux);
483
484 /* Configuration of OpenFlow tables. */
485 struct ofproto_table_settings {
486 char *name; /* Name exported via OpenFlow or NULL. */
487 unsigned int max_flows; /* Maximum number of flows or UINT_MAX. */
488
489 /* These members, together with OpenFlow OFPT_TABLE_MOD, determine the
490 * handling of an attempt to add a flow that would cause the table to have
491 * more than 'max_flows' flows:
492 *
493 * - If 'enable_eviction' is false and OFPT_TABLE_MOD does not enable
494 * eviction, overflows will be rejected with an error.
495 *
496 * - If 'enable_eviction' is true or OFPT_TABLE_MOD enables eviction, an
497 * overflow will cause a flow to be removed. The flow to be removed
498 * is chosen to give fairness among groups distinguished by different
499 * values for the 'n_groups' subfields within 'groups'. */
500 bool enable_eviction;
501 struct mf_subfield *groups;
502 size_t n_groups;
503
504 /*
505 * Fields for which prefix trie lookup is maintained.
506 */
507 unsigned int n_prefix_fields;
508 enum mf_field_id prefix_fields[CLS_MAX_TRIES];
509 };
510
511 extern const enum mf_field_id default_prefix_fields[2];
512 BUILD_ASSERT_DECL(ARRAY_SIZE(default_prefix_fields) <= CLS_MAX_TRIES);
513
514 int ofproto_get_n_tables(const struct ofproto *);
515 uint8_t ofproto_get_n_visible_tables(const struct ofproto *);
516 void ofproto_configure_table(struct ofproto *, int table_id,
517 const struct ofproto_table_settings *);
518
519 /* Configuration querying. */
520 bool ofproto_has_snoops(const struct ofproto *);
521 void ofproto_get_snoops(const struct ofproto *, struct sset *);
522 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
523 void ofproto_get_netflow_ids(const struct ofproto *,
524 uint8_t *engine_type, uint8_t *engine_id);
525
526 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
527 void ofproto_free_ofproto_controller_info(struct shash *);
528
529 bool ofproto_port_cfm_status_changed(struct ofproto *, ofp_port_t ofp_port);
530
531 int ofproto_port_get_cfm_status(const struct ofproto *,
532 ofp_port_t ofp_port,
533 struct cfm_status *);
534 \f
535 /* Table configuration */
536
537 enum ofputil_table_miss ofproto_table_get_miss_config(const struct ofproto *,
538 uint8_t table_id);
539
540 #ifdef __cplusplus
541 }
542 #endif
543
544 #endif /* ofproto.h */