2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
20 #include <sys/types.h>
21 #include <netinet/in.h>
26 #include "classifier.h"
28 #include "meta-flow.h"
50 /* Needed for the lock annotations. */
51 extern struct ovs_mutex ofproto_mutex;
53 struct ofproto_controller_info {
55 enum ofp12_controller_role role;
59 struct ofproto_sflow_options {
61 uint32_t sampling_rate;
62 uint32_t polling_interval;
69 struct ofproto_ipfix_bridge_exporter_options {
71 uint32_t sampling_rate;
72 uint32_t obs_domain_id; /* Bridge-wide Observation Domain ID. */
73 uint32_t obs_point_id; /* Bridge-wide Observation Point ID. */
74 uint32_t cache_active_timeout;
75 uint32_t cache_max_flows;
76 bool enable_tunnel_sampling;
77 bool enable_input_sampling;
78 bool enable_output_sampling;
81 struct ofproto_ipfix_flow_exporter_options {
82 uint32_t collector_set_id;
84 uint32_t cache_active_timeout;
85 uint32_t cache_max_flows;
88 struct ofproto_rstp_status {
89 bool enabled; /* If false, ignore other members. */
90 rstp_identifier root_id;
91 rstp_identifier bridge_id;
92 rstp_identifier designated_id;
93 uint32_t root_path_cost;
94 uint16_t designated_port_id;
95 uint16_t bridge_port_id;
98 struct ofproto_rstp_settings {
99 rstp_identifier address;
101 uint32_t ageing_time;
102 enum rstp_force_protocol_version force_protocol_version;
103 uint16_t bridge_forward_delay;
104 uint16_t bridge_max_age;
105 uint16_t transmit_hold_count;
108 struct ofproto_port_rstp_status {
109 bool enabled; /* If false, ignore other members. */
111 enum rstp_port_role role;
112 enum rstp_state state;
113 int tx_count; /* Number of BPDUs transmitted. */
114 int rx_count; /* Number of valid BPDUs received. */
115 int error_count; /* Number of bad BPDUs received. */
119 struct ofproto_port_rstp_settings {
121 uint16_t port_num; /* In the range 1-4095, inclusive. */
124 bool admin_edge_port;
129 struct ofproto_stp_settings {
130 stp_identifier system_id;
137 struct ofproto_stp_status {
138 bool enabled; /* If false, ignore other members. */
139 stp_identifier bridge_id;
140 stp_identifier designated_root;
144 struct ofproto_port_stp_settings {
146 uint8_t port_num; /* In the range 1-255, inclusive. */
151 struct ofproto_port_stp_status {
152 bool enabled; /* If false, ignore other members. */
154 enum stp_state state;
155 unsigned int sec_in_state;
159 struct ofproto_port_stp_stats {
160 bool enabled; /* If false, ignore other members. */
161 int tx_count; /* Number of BPDUs transmitted. */
162 int rx_count; /* Number of valid BPDUs received. */
163 int error_count; /* Number of bad BPDUs received. */
166 struct ofproto_port_queue {
167 uint32_t queue; /* Queue ID. */
168 uint8_t dscp; /* DSCP bits (e.g. [0, 63]). */
171 struct ofproto_mcast_snooping_settings {
172 bool flood_unreg; /* If true, flood unregistered packets to all
173 all ports. If false, send only to ports
174 connected to multicast routers. */
175 unsigned int idle_time; /* Entry is removed after the idle time
177 unsigned int max_entries; /* Size of the multicast snooping table. */
180 /* How the switch should act if the controller cannot be contacted. */
181 enum ofproto_fail_mode {
182 OFPROTO_FAIL_SECURE, /* Preserve flow table. */
183 OFPROTO_FAIL_STANDALONE /* Act as a standalone switch. */
187 OFPROTO_IN_BAND, /* In-band connection to controller. */
188 OFPROTO_OUT_OF_BAND /* Out-of-band connection to controller. */
191 struct ofproto_controller {
192 char *target; /* e.g. "tcp:127.0.0.1" */
193 int max_backoff; /* Maximum reconnection backoff, in seconds. */
194 int probe_interval; /* Max idle time before probing, in seconds. */
195 enum ofproto_band band; /* In-band or out-of-band? */
196 bool enable_async_msgs; /* Initially enable asynchronous messages? */
198 /* OpenFlow packet-in rate-limiting. */
199 int rate_limit; /* Max packet-in rate in packets per second. */
200 int burst_limit; /* Limit on accumulating packet credits. */
202 uint8_t dscp; /* DSCP value for controller connection. */
205 void ofproto_enumerate_types(struct sset *types);
206 const char *ofproto_normalize_type(const char *);
208 int ofproto_enumerate_names(const char *type, struct sset *names);
209 void ofproto_parse_name(const char *name, char **dp_name, char **dp_type);
211 /* An interface hint element, which is used by ofproto_init() to
212 * describe the caller's understanding of the startup state. */
214 char *br_name; /* Name of owning bridge. */
215 char *br_type; /* Type of owning bridge. */
216 ofp_port_t ofp_port; /* OpenFlow port number. */
219 void ofproto_init(const struct shash *iface_hints);
221 int ofproto_type_run(const char *datapath_type);
222 void ofproto_type_wait(const char *datapath_type);
224 int ofproto_create(const char *datapath, const char *datapath_type,
225 struct ofproto **ofprotop);
226 void ofproto_destroy(struct ofproto *);
227 int ofproto_delete(const char *name, const char *type);
229 int ofproto_run(struct ofproto *);
230 void ofproto_wait(struct ofproto *);
231 bool ofproto_is_alive(const struct ofproto *);
233 void ofproto_get_memory_usage(const struct ofproto *, struct simap *);
234 void ofproto_type_get_memory_usage(const char *datapath_type, struct simap *);
236 /* A port within an OpenFlow switch.
238 * 'name' and 'type' are suitable for passing to netdev_open(). */
239 struct ofproto_port {
240 char *name; /* Network device name, e.g. "eth0". */
241 char *type; /* Network device type, e.g. "system". */
242 ofp_port_t ofp_port; /* OpenFlow port number. */
244 void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *);
245 void ofproto_port_destroy(struct ofproto_port *);
247 struct ofproto_port_dump {
248 const struct ofproto *ofproto;
252 void ofproto_port_dump_start(struct ofproto_port_dump *,
253 const struct ofproto *);
254 bool ofproto_port_dump_next(struct ofproto_port_dump *, struct ofproto_port *);
255 int ofproto_port_dump_done(struct ofproto_port_dump *);
257 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
259 * Arguments all have pointer type.
261 * If you break out of the loop, then you need to free the dump structure by
262 * hand using ofproto_port_dump_done(). */
263 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO) \
264 for (ofproto_port_dump_start(DUMP, OFPROTO); \
265 (ofproto_port_dump_next(DUMP, OFPROTO_PORT) \
267 : (ofproto_port_dump_done(DUMP), false)); \
270 #define OFPROTO_FLOW_LIMIT_DEFAULT 200000
271 #define OFPROTO_MAX_IDLE_DEFAULT 10000 /* ms */
273 const char *ofproto_port_open_type(const char *datapath_type,
274 const char *port_type);
275 int ofproto_port_add(struct ofproto *, struct netdev *, ofp_port_t *ofp_portp);
276 int ofproto_port_del(struct ofproto *, ofp_port_t ofp_port);
277 int ofproto_port_get_stats(const struct ofport *, struct netdev_stats *stats);
279 int ofproto_port_query_by_name(const struct ofproto *, const char *devname,
280 struct ofproto_port *);
282 /* Top-level configuration. */
283 uint64_t ofproto_get_datapath_id(const struct ofproto *);
284 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
285 void ofproto_set_controllers(struct ofproto *,
286 const struct ofproto_controller *, size_t n,
287 uint32_t allowed_versions);
288 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
289 void ofproto_reconnect_controllers(struct ofproto *);
290 void ofproto_set_extra_in_band_remotes(struct ofproto *,
291 const struct sockaddr_in *, size_t n);
292 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
293 void ofproto_set_flow_limit(unsigned limit);
294 void ofproto_set_max_idle(unsigned max_idle);
295 void ofproto_set_forward_bpdu(struct ofproto *, bool forward_bpdu);
296 void ofproto_set_mac_table_config(struct ofproto *, unsigned idle_time,
298 int ofproto_set_mcast_snooping(struct ofproto *ofproto,
299 const struct ofproto_mcast_snooping_settings *s);
300 int ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
302 void ofproto_set_threads(int n_handlers, int n_revalidators);
303 void ofproto_set_n_dpdk_rxqs(int n_rxqs);
304 void ofproto_set_cpu_mask(const char *cmask);
305 void ofproto_set_dp_desc(struct ofproto *, const char *dp_desc);
306 int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
307 int ofproto_set_netflow(struct ofproto *,
308 const struct netflow_options *nf_options);
309 int ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
310 int ofproto_set_ipfix(struct ofproto *,
311 const struct ofproto_ipfix_bridge_exporter_options *,
312 const struct ofproto_ipfix_flow_exporter_options *,
314 void ofproto_set_flow_restore_wait(bool flow_restore_wait_db);
315 bool ofproto_get_flow_restore_wait(void);
316 int ofproto_set_stp(struct ofproto *, const struct ofproto_stp_settings *);
317 int ofproto_get_stp_status(struct ofproto *, struct ofproto_stp_status *);
319 int ofproto_set_rstp(struct ofproto *, const struct ofproto_rstp_settings *);
320 int ofproto_get_rstp_status(struct ofproto *, struct ofproto_rstp_status *);
322 /* Configuration of ports. */
323 void ofproto_port_unregister(struct ofproto *, ofp_port_t ofp_port);
325 void ofproto_port_clear_cfm(struct ofproto *, ofp_port_t ofp_port);
326 void ofproto_port_set_cfm(struct ofproto *, ofp_port_t ofp_port,
327 const struct cfm_settings *);
328 void ofproto_port_set_bfd(struct ofproto *, ofp_port_t ofp_port,
329 const struct smap *cfg);
330 bool ofproto_port_bfd_status_changed(struct ofproto *, ofp_port_t ofp_port);
331 int ofproto_port_get_bfd_status(struct ofproto *, ofp_port_t ofp_port,
333 int ofproto_port_is_lacp_current(struct ofproto *, ofp_port_t ofp_port);
334 int ofproto_port_get_lacp_stats(const struct ofport *, struct lacp_slave_stats *);
335 int ofproto_port_set_stp(struct ofproto *, ofp_port_t ofp_port,
336 const struct ofproto_port_stp_settings *);
337 int ofproto_port_get_stp_status(struct ofproto *, ofp_port_t ofp_port,
338 struct ofproto_port_stp_status *);
339 int ofproto_port_get_stp_stats(struct ofproto *, ofp_port_t ofp_port,
340 struct ofproto_port_stp_stats *);
341 int ofproto_port_set_queues(struct ofproto *, ofp_port_t ofp_port,
342 const struct ofproto_port_queue *,
344 int ofproto_port_get_rstp_status(struct ofproto *, ofp_port_t ofp_port,
345 struct ofproto_port_rstp_status *);
347 int ofproto_port_set_rstp(struct ofproto *, ofp_port_t ofp_port,
348 const struct ofproto_port_rstp_settings *);
350 /* The behaviour of the port regarding VLAN handling */
351 enum port_vlan_mode {
352 /* This port is an access port. 'vlan' is the VLAN ID. 'trunks' is
356 /* This port is a trunk. 'trunks' is the set of trunks. 'vlan' is
360 /* Untagged incoming packets are part of 'vlan', as are incoming packets
361 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' stay tagged.
362 * Other VLANs in 'trunks' are trunked. */
363 PORT_VLAN_NATIVE_TAGGED,
365 /* Untagged incoming packets are part of 'vlan', as are incoming packets
366 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' are untagged.
367 * Other VLANs in 'trunks' are trunked. */
368 PORT_VLAN_NATIVE_UNTAGGED
371 /* Configuration of bundles. */
372 struct ofproto_bundle_settings {
373 char *name; /* For use in log messages. */
375 ofp_port_t *slaves; /* OpenFlow port numbers for slaves. */
378 enum port_vlan_mode vlan_mode; /* Selects mode for vlan and trunks */
379 int vlan; /* VLAN VID, except for PORT_VLAN_TRUNK. */
380 unsigned long *trunks; /* vlan_bitmap, except for PORT_VLAN_ACCESS. */
381 bool use_priority_tags; /* Use 802.1p tag for frames in VLAN 0? */
383 struct bond_settings *bond; /* Must be nonnull iff if n_slaves > 1. */
385 struct lacp_settings *lacp; /* Nonnull to enable LACP. */
386 struct lacp_slave_settings *lacp_slaves; /* Array of n_slaves elements. */
388 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
390 * This is deprecated. It is only for compatibility with broken device
391 * drivers in old versions of Linux that do not properly support VLANs when
392 * VLAN devices are not used. When broken device drivers are no longer in
393 * widespread use, we will delete these interfaces. */
394 ofp_port_t realdev_ofp_port;/* OpenFlow port number of real device. */
397 int ofproto_bundle_register(struct ofproto *, void *aux,
398 const struct ofproto_bundle_settings *);
399 int ofproto_bundle_unregister(struct ofproto *, void *aux);
401 /* Configuration of mirrors. */
402 struct ofproto_mirror_settings {
403 /* Name for log messages. */
406 /* Bundles that select packets for mirroring upon ingress. */
407 void **srcs; /* A set of registered ofbundle handles. */
410 /* Bundles that select packets for mirroring upon egress. */
411 void **dsts; /* A set of registered ofbundle handles. */
414 /* VLANs of packets to select for mirroring. */
415 unsigned long *src_vlans; /* vlan_bitmap, NULL selects all VLANs. */
417 /* Output (mutually exclusive). */
418 void *out_bundle; /* A registered ofbundle handle or NULL. */
419 uint16_t out_vlan; /* Output VLAN, only if out_bundle is NULL. */
422 int ofproto_mirror_register(struct ofproto *, void *aux,
423 const struct ofproto_mirror_settings *);
424 int ofproto_mirror_unregister(struct ofproto *, void *aux);
425 int ofproto_mirror_get_stats(struct ofproto *, void *aux,
426 uint64_t *packets, uint64_t *bytes);
428 int ofproto_set_flood_vlans(struct ofproto *, unsigned long *flood_vlans);
429 bool ofproto_is_mirror_output_bundle(const struct ofproto *, void *aux);
431 /* Configuration of OpenFlow tables. */
432 struct ofproto_table_settings {
433 char *name; /* Name exported via OpenFlow or NULL. */
434 unsigned int max_flows; /* Maximum number of flows or UINT_MAX. */
436 /* These members determine the handling of an attempt to add a flow that
437 * would cause the table to have more than 'max_flows' flows.
439 * If 'groups' is NULL, overflows will be rejected with an error.
441 * If 'groups' is nonnull, an overflow will cause a flow to be removed.
442 * The flow to be removed is chosen to give fairness among groups
443 * distinguished by different values for the subfields within 'groups'. */
444 struct mf_subfield *groups;
448 * Fields for which prefix trie lookup is maintained.
450 unsigned int n_prefix_fields;
451 enum mf_field_id prefix_fields[CLS_MAX_TRIES];
454 extern const enum mf_field_id default_prefix_fields[2];
455 BUILD_ASSERT_DECL(ARRAY_SIZE(default_prefix_fields) <= CLS_MAX_TRIES);
457 int ofproto_get_n_tables(const struct ofproto *);
458 uint8_t ofproto_get_n_visible_tables(const struct ofproto *);
459 void ofproto_configure_table(struct ofproto *, int table_id,
460 const struct ofproto_table_settings *);
462 /* Configuration querying. */
463 bool ofproto_has_snoops(const struct ofproto *);
464 void ofproto_get_snoops(const struct ofproto *, struct sset *);
465 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
466 void ofproto_get_netflow_ids(const struct ofproto *,
467 uint8_t *engine_type, uint8_t *engine_id);
469 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
470 void ofproto_free_ofproto_controller_info(struct shash *);
472 bool ofproto_port_cfm_status_changed(struct ofproto *, ofp_port_t ofp_port);
474 int ofproto_port_get_cfm_status(const struct ofproto *,
476 struct cfm_status *);
478 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
480 * This is deprecated. It is only for compatibility with broken device drivers
481 * in old versions of Linux that do not properly support VLANs when VLAN
482 * devices are not used. When broken device drivers are no longer in
483 * widespread use, we will delete these interfaces. */
485 void ofproto_get_vlan_usage(struct ofproto *, unsigned long int *vlan_bitmap);
486 bool ofproto_has_vlan_usage_changed(const struct ofproto *);
487 int ofproto_port_set_realdev(struct ofproto *, ofp_port_t vlandev_ofp_port,
488 ofp_port_t realdev_ofp_port, int vid);
490 /* Table configuration */
492 enum ofputil_table_miss ofproto_table_get_miss_config(const struct ofproto *,
499 #endif /* ofproto.h */