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 rstp_identifier designated_bridge_id;
114 uint16_t designated_port_id;
115 uint32_t designated_path_cost;
116 int tx_count; /* Number of BPDUs transmitted. */
117 int rx_count; /* Number of valid BPDUs received. */
118 int error_count; /* Number of bad BPDUs received. */
122 struct ofproto_port_rstp_settings {
124 uint16_t port_num; /* In the range 1-4095, inclusive. */
127 bool admin_edge_port;
130 uint8_t admin_p2p_mac_state;
131 bool admin_port_state;
134 struct ofproto_stp_settings {
135 stp_identifier system_id;
142 struct ofproto_stp_status {
143 bool enabled; /* If false, ignore other members. */
144 stp_identifier bridge_id;
145 stp_identifier designated_root;
149 struct ofproto_port_stp_settings {
151 uint8_t port_num; /* In the range 1-255, inclusive. */
156 struct ofproto_port_stp_status {
157 bool enabled; /* If false, ignore other members. */
159 enum stp_state state;
160 unsigned int sec_in_state;
164 struct ofproto_port_stp_stats {
165 bool enabled; /* If false, ignore other members. */
166 int tx_count; /* Number of BPDUs transmitted. */
167 int rx_count; /* Number of valid BPDUs received. */
168 int error_count; /* Number of bad BPDUs received. */
171 struct ofproto_port_queue {
172 uint32_t queue; /* Queue ID. */
173 uint8_t dscp; /* DSCP bits (e.g. [0, 63]). */
176 struct ofproto_mcast_snooping_settings {
177 bool flood_unreg; /* If true, flood unregistered packets to all
178 all ports. If false, send only to ports
179 connected to multicast routers. */
180 unsigned int idle_time; /* Entry is removed after the idle time
182 unsigned int max_entries; /* Size of the multicast snooping table. */
185 /* How the switch should act if the controller cannot be contacted. */
186 enum ofproto_fail_mode {
187 OFPROTO_FAIL_SECURE, /* Preserve flow table. */
188 OFPROTO_FAIL_STANDALONE /* Act as a standalone switch. */
192 OFPROTO_IN_BAND, /* In-band connection to controller. */
193 OFPROTO_OUT_OF_BAND /* Out-of-band connection to controller. */
196 struct ofproto_controller {
197 char *target; /* e.g. "tcp:127.0.0.1" */
198 int max_backoff; /* Maximum reconnection backoff, in seconds. */
199 int probe_interval; /* Max idle time before probing, in seconds. */
200 enum ofproto_band band; /* In-band or out-of-band? */
201 bool enable_async_msgs; /* Initially enable asynchronous messages? */
203 /* OpenFlow packet-in rate-limiting. */
204 int rate_limit; /* Max packet-in rate in packets per second. */
205 int burst_limit; /* Limit on accumulating packet credits. */
207 uint8_t dscp; /* DSCP value for controller connection. */
210 void ofproto_enumerate_types(struct sset *types);
211 const char *ofproto_normalize_type(const char *);
213 int ofproto_enumerate_names(const char *type, struct sset *names);
214 void ofproto_parse_name(const char *name, char **dp_name, char **dp_type);
216 /* An interface hint element, which is used by ofproto_init() to
217 * describe the caller's understanding of the startup state. */
219 char *br_name; /* Name of owning bridge. */
220 char *br_type; /* Type of owning bridge. */
221 ofp_port_t ofp_port; /* OpenFlow port number. */
224 void ofproto_init(const struct shash *iface_hints);
226 int ofproto_type_run(const char *datapath_type);
227 void ofproto_type_wait(const char *datapath_type);
229 int ofproto_create(const char *datapath, const char *datapath_type,
230 struct ofproto **ofprotop);
231 void ofproto_destroy(struct ofproto *);
232 int ofproto_delete(const char *name, const char *type);
234 int ofproto_run(struct ofproto *);
235 void ofproto_wait(struct ofproto *);
236 bool ofproto_is_alive(const struct ofproto *);
238 void ofproto_get_memory_usage(const struct ofproto *, struct simap *);
239 void ofproto_type_get_memory_usage(const char *datapath_type, struct simap *);
241 /* A port within an OpenFlow switch.
243 * 'name' and 'type' are suitable for passing to netdev_open(). */
244 struct ofproto_port {
245 char *name; /* Network device name, e.g. "eth0". */
246 char *type; /* Network device type, e.g. "system". */
247 ofp_port_t ofp_port; /* OpenFlow port number. */
249 void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *);
250 void ofproto_port_destroy(struct ofproto_port *);
252 struct ofproto_port_dump {
253 const struct ofproto *ofproto;
257 void ofproto_port_dump_start(struct ofproto_port_dump *,
258 const struct ofproto *);
259 bool ofproto_port_dump_next(struct ofproto_port_dump *, struct ofproto_port *);
260 int ofproto_port_dump_done(struct ofproto_port_dump *);
262 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
264 * Arguments all have pointer type.
266 * If you break out of the loop, then you need to free the dump structure by
267 * hand using ofproto_port_dump_done(). */
268 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO) \
269 for (ofproto_port_dump_start(DUMP, OFPROTO); \
270 (ofproto_port_dump_next(DUMP, OFPROTO_PORT) \
272 : (ofproto_port_dump_done(DUMP), false)); \
275 #define OFPROTO_FLOW_LIMIT_DEFAULT 200000
276 #define OFPROTO_MAX_IDLE_DEFAULT 10000 /* ms */
278 const char *ofproto_port_open_type(const char *datapath_type,
279 const char *port_type);
280 int ofproto_port_add(struct ofproto *, struct netdev *, ofp_port_t *ofp_portp);
281 int ofproto_port_del(struct ofproto *, ofp_port_t ofp_port);
282 int ofproto_port_get_stats(const struct ofport *, struct netdev_stats *stats);
284 int ofproto_port_query_by_name(const struct ofproto *, const char *devname,
285 struct ofproto_port *);
287 /* Top-level configuration. */
288 uint64_t ofproto_get_datapath_id(const struct ofproto *);
289 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
290 void ofproto_set_controllers(struct ofproto *,
291 const struct ofproto_controller *, size_t n,
292 uint32_t allowed_versions);
293 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
294 void ofproto_reconnect_controllers(struct ofproto *);
295 void ofproto_set_extra_in_band_remotes(struct ofproto *,
296 const struct sockaddr_in *, size_t n);
297 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
298 void ofproto_set_flow_limit(unsigned limit);
299 void ofproto_set_max_idle(unsigned max_idle);
300 void ofproto_set_forward_bpdu(struct ofproto *, bool forward_bpdu);
301 void ofproto_set_mac_table_config(struct ofproto *, unsigned idle_time,
303 int ofproto_set_mcast_snooping(struct ofproto *ofproto,
304 const struct ofproto_mcast_snooping_settings *s);
305 int ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
307 void ofproto_set_threads(int n_handlers, int n_revalidators);
308 void ofproto_set_n_dpdk_rxqs(int n_rxqs);
309 void ofproto_set_cpu_mask(const char *cmask);
310 void ofproto_set_dp_desc(struct ofproto *, const char *dp_desc);
311 int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
312 int ofproto_set_netflow(struct ofproto *,
313 const struct netflow_options *nf_options);
314 int ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
315 int ofproto_set_ipfix(struct ofproto *,
316 const struct ofproto_ipfix_bridge_exporter_options *,
317 const struct ofproto_ipfix_flow_exporter_options *,
319 void ofproto_set_flow_restore_wait(bool flow_restore_wait_db);
320 bool ofproto_get_flow_restore_wait(void);
321 int ofproto_set_stp(struct ofproto *, const struct ofproto_stp_settings *);
322 int ofproto_get_stp_status(struct ofproto *, struct ofproto_stp_status *);
324 int ofproto_set_rstp(struct ofproto *, const struct ofproto_rstp_settings *);
325 int ofproto_get_rstp_status(struct ofproto *, struct ofproto_rstp_status *);
327 /* Configuration of ports. */
328 void ofproto_port_unregister(struct ofproto *, ofp_port_t ofp_port);
330 void ofproto_port_clear_cfm(struct ofproto *, ofp_port_t ofp_port);
331 void ofproto_port_set_cfm(struct ofproto *, ofp_port_t ofp_port,
332 const struct cfm_settings *);
333 void ofproto_port_set_bfd(struct ofproto *, ofp_port_t ofp_port,
334 const struct smap *cfg);
335 bool ofproto_port_bfd_status_changed(struct ofproto *, ofp_port_t ofp_port);
336 int ofproto_port_get_bfd_status(struct ofproto *, ofp_port_t ofp_port,
338 int ofproto_port_is_lacp_current(struct ofproto *, ofp_port_t ofp_port);
339 int ofproto_port_get_lacp_stats(const struct ofport *, struct lacp_slave_stats *);
340 int ofproto_port_set_stp(struct ofproto *, ofp_port_t ofp_port,
341 const struct ofproto_port_stp_settings *);
342 int ofproto_port_get_stp_status(struct ofproto *, ofp_port_t ofp_port,
343 struct ofproto_port_stp_status *);
344 int ofproto_port_get_stp_stats(struct ofproto *, ofp_port_t ofp_port,
345 struct ofproto_port_stp_stats *);
346 int ofproto_port_set_queues(struct ofproto *, ofp_port_t ofp_port,
347 const struct ofproto_port_queue *,
349 int ofproto_port_get_rstp_status(struct ofproto *, ofp_port_t ofp_port,
350 struct ofproto_port_rstp_status *);
352 int ofproto_port_set_rstp(struct ofproto *, ofp_port_t ofp_port,
353 const struct ofproto_port_rstp_settings *);
355 /* The behaviour of the port regarding VLAN handling */
356 enum port_vlan_mode {
357 /* This port is an access port. 'vlan' is the VLAN ID. 'trunks' is
361 /* This port is a trunk. 'trunks' is the set of trunks. 'vlan' is
365 /* Untagged incoming packets are part of 'vlan', as are incoming packets
366 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' stay tagged.
367 * Other VLANs in 'trunks' are trunked. */
368 PORT_VLAN_NATIVE_TAGGED,
370 /* Untagged incoming packets are part of 'vlan', as are incoming packets
371 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' are untagged.
372 * Other VLANs in 'trunks' are trunked. */
373 PORT_VLAN_NATIVE_UNTAGGED
376 /* Configuration of bundles. */
377 struct ofproto_bundle_settings {
378 char *name; /* For use in log messages. */
380 ofp_port_t *slaves; /* OpenFlow port numbers for slaves. */
383 enum port_vlan_mode vlan_mode; /* Selects mode for vlan and trunks */
384 int vlan; /* VLAN VID, except for PORT_VLAN_TRUNK. */
385 unsigned long *trunks; /* vlan_bitmap, except for PORT_VLAN_ACCESS. */
386 bool use_priority_tags; /* Use 802.1p tag for frames in VLAN 0? */
388 struct bond_settings *bond; /* Must be nonnull iff if n_slaves > 1. */
390 struct lacp_settings *lacp; /* Nonnull to enable LACP. */
391 struct lacp_slave_settings *lacp_slaves; /* Array of n_slaves elements. */
393 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
395 * This is deprecated. It is only for compatibility with broken device
396 * drivers in old versions of Linux that do not properly support VLANs when
397 * VLAN devices are not used. When broken device drivers are no longer in
398 * widespread use, we will delete these interfaces. */
399 ofp_port_t realdev_ofp_port;/* OpenFlow port number of real device. */
402 int ofproto_bundle_register(struct ofproto *, void *aux,
403 const struct ofproto_bundle_settings *);
404 int ofproto_bundle_unregister(struct ofproto *, void *aux);
406 /* Configuration of mirrors. */
407 struct ofproto_mirror_settings {
408 /* Name for log messages. */
411 /* Bundles that select packets for mirroring upon ingress. */
412 void **srcs; /* A set of registered ofbundle handles. */
415 /* Bundles that select packets for mirroring upon egress. */
416 void **dsts; /* A set of registered ofbundle handles. */
419 /* VLANs of packets to select for mirroring. */
420 unsigned long *src_vlans; /* vlan_bitmap, NULL selects all VLANs. */
422 /* Output (mutually exclusive). */
423 void *out_bundle; /* A registered ofbundle handle or NULL. */
424 uint16_t out_vlan; /* Output VLAN, only if out_bundle is NULL. */
427 int ofproto_mirror_register(struct ofproto *, void *aux,
428 const struct ofproto_mirror_settings *);
429 int ofproto_mirror_unregister(struct ofproto *, void *aux);
430 int ofproto_mirror_get_stats(struct ofproto *, void *aux,
431 uint64_t *packets, uint64_t *bytes);
433 int ofproto_set_flood_vlans(struct ofproto *, unsigned long *flood_vlans);
434 bool ofproto_is_mirror_output_bundle(const struct ofproto *, void *aux);
436 /* Configuration of OpenFlow tables. */
437 struct ofproto_table_settings {
438 char *name; /* Name exported via OpenFlow or NULL. */
439 unsigned int max_flows; /* Maximum number of flows or UINT_MAX. */
441 /* These members determine the handling of an attempt to add a flow that
442 * would cause the table to have more than 'max_flows' flows.
444 * If 'groups' is NULL, overflows will be rejected with an error.
446 * If 'groups' is nonnull, an overflow will cause a flow to be removed.
447 * The flow to be removed is chosen to give fairness among groups
448 * distinguished by different values for the subfields within 'groups'. */
449 struct mf_subfield *groups;
453 * Fields for which prefix trie lookup is maintained.
455 unsigned int n_prefix_fields;
456 enum mf_field_id prefix_fields[CLS_MAX_TRIES];
459 extern const enum mf_field_id default_prefix_fields[2];
460 BUILD_ASSERT_DECL(ARRAY_SIZE(default_prefix_fields) <= CLS_MAX_TRIES);
462 int ofproto_get_n_tables(const struct ofproto *);
463 uint8_t ofproto_get_n_visible_tables(const struct ofproto *);
464 void ofproto_configure_table(struct ofproto *, int table_id,
465 const struct ofproto_table_settings *);
467 /* Configuration querying. */
468 bool ofproto_has_snoops(const struct ofproto *);
469 void ofproto_get_snoops(const struct ofproto *, struct sset *);
470 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
471 void ofproto_get_netflow_ids(const struct ofproto *,
472 uint8_t *engine_type, uint8_t *engine_id);
474 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
475 void ofproto_free_ofproto_controller_info(struct shash *);
477 bool ofproto_port_cfm_status_changed(struct ofproto *, ofp_port_t ofp_port);
479 int ofproto_port_get_cfm_status(const struct ofproto *,
481 struct cfm_status *);
483 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
485 * This is deprecated. It is only for compatibility with broken device drivers
486 * in old versions of Linux that do not properly support VLANs when VLAN
487 * devices are not used. When broken device drivers are no longer in
488 * widespread use, we will delete these interfaces. */
490 void ofproto_get_vlan_usage(struct ofproto *, unsigned long int *vlan_bitmap);
491 bool ofproto_has_vlan_usage_changed(const struct ofproto *);
492 int ofproto_port_set_realdev(struct ofproto *, ofp_port_t vlandev_ofp_port,
493 ofp_port_t realdev_ofp_port, int vid);
495 /* Table configuration */
497 enum ofputil_table_miss ofproto_table_get_miss_config(const struct ofproto *,
504 #endif /* ofproto.h */