2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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 "openvswitch/meta-flow.h"
54 struct aa_mapping_settings
;
56 /* Needed for the lock annotations. */
57 extern struct ovs_mutex ofproto_mutex
;
59 struct ofproto_controller_info
{
61 enum ofp12_controller_role role
;
65 struct ofproto_sflow_options
{
67 uint32_t sampling_rate
;
68 uint32_t polling_interval
;
75 struct ofproto_ipfix_bridge_exporter_options
{
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
;
88 struct ofproto_ipfix_flow_exporter_options
{
89 uint32_t collector_set_id
;
91 uint32_t cache_active_timeout
;
92 uint32_t cache_max_flows
;
93 bool enable_tunnel_sampling
;
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
;
107 struct ofproto_rstp_settings
{
108 rstp_identifier address
;
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
;
117 struct ofproto_port_rstp_status
{
118 bool enabled
; /* If false, ignore other members. */
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. */
131 struct ofproto_port_rstp_settings
{
133 uint16_t port_num
; /* In the range 1-4095, inclusive. */
136 bool admin_edge_port
;
139 uint8_t admin_p2p_mac_state
;
140 bool admin_port_state
;
143 struct ofproto_stp_settings
{
144 stp_identifier system_id
;
151 struct ofproto_stp_status
{
152 bool enabled
; /* If false, ignore other members. */
153 stp_identifier bridge_id
;
154 stp_identifier designated_root
;
158 struct ofproto_port_stp_settings
{
160 uint8_t port_num
; /* In the range 1-255, inclusive. */
165 struct ofproto_port_stp_status
{
166 bool enabled
; /* If false, ignore other members. */
168 enum stp_state state
;
169 unsigned int sec_in_state
;
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. */
180 struct ofproto_port_queue
{
181 uint32_t queue
; /* Queue ID. */
182 uint8_t dscp
; /* DSCP bits (e.g. [0, 63]). */
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
191 unsigned int max_entries
; /* Size of the multicast snooping table. */
194 struct ofproto_mcast_snooping_port_settings
{
195 bool flood
; /* If true, flood multicast traffic */
196 bool flood_reports
; /* If true, flood Reports traffic */
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. */
206 OFPROTO_IN_BAND
, /* In-band connection to controller. */
207 OFPROTO_OUT_OF_BAND
/* Out-of-band connection to controller. */
210 struct ofproto_controller
{
211 char *target
; /* e.g. "tcp:127.0.0.1" */
212 int max_backoff
; /* Maximum reconnection backoff, in seconds. */
213 int probe_interval
; /* Max idle time before probing, in seconds. */
214 enum ofproto_band band
; /* In-band or out-of-band? */
215 bool enable_async_msgs
; /* Initially enable asynchronous messages? */
217 /* OpenFlow packet-in rate-limiting. */
218 int rate_limit
; /* Max packet-in rate in packets per second. */
219 int burst_limit
; /* Limit on accumulating packet credits. */
221 uint8_t dscp
; /* DSCP value for controller connection. */
224 void ofproto_enumerate_types(struct sset
*types
);
225 const char *ofproto_normalize_type(const char *);
227 int ofproto_enumerate_names(const char *type
, struct sset
*names
);
228 void ofproto_parse_name(const char *name
, char **dp_name
, char **dp_type
);
230 /* An interface hint element, which is used by ofproto_init() to
231 * describe the caller's understanding of the startup state. */
233 char *br_name
; /* Name of owning bridge. */
234 char *br_type
; /* Type of owning bridge. */
235 ofp_port_t ofp_port
; /* OpenFlow port number. */
238 void ofproto_init(const struct shash
*iface_hints
);
240 int ofproto_type_run(const char *datapath_type
);
241 void ofproto_type_wait(const char *datapath_type
);
243 int ofproto_create(const char *datapath
, const char *datapath_type
,
244 struct ofproto
**ofprotop
)
245 OVS_EXCLUDED(ofproto_mutex
);
246 void ofproto_destroy(struct ofproto
*, bool del
);
247 int ofproto_delete(const char *name
, const char *type
);
249 int ofproto_run(struct ofproto
*);
250 void ofproto_wait(struct ofproto
*);
251 bool ofproto_is_alive(const struct ofproto
*);
253 void ofproto_get_memory_usage(const struct ofproto
*, struct simap
*);
254 void ofproto_type_get_memory_usage(const char *datapath_type
, struct simap
*);
256 /* A port within an OpenFlow switch.
258 * 'name' and 'type' are suitable for passing to netdev_open(). */
259 struct ofproto_port
{
260 char *name
; /* Network device name, e.g. "eth0". */
261 char *type
; /* Network device type, e.g. "system". */
262 ofp_port_t ofp_port
; /* OpenFlow port number. */
264 void ofproto_port_clone(struct ofproto_port
*, const struct ofproto_port
*);
265 void ofproto_port_destroy(struct ofproto_port
*);
267 struct ofproto_port_dump
{
268 const struct ofproto
*ofproto
;
272 void ofproto_port_dump_start(struct ofproto_port_dump
*,
273 const struct ofproto
*);
274 bool ofproto_port_dump_next(struct ofproto_port_dump
*, struct ofproto_port
*);
275 int ofproto_port_dump_done(struct ofproto_port_dump
*);
277 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
279 * Arguments all have pointer type.
281 * If you break out of the loop, then you need to free the dump structure by
282 * hand using ofproto_port_dump_done(). */
283 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO) \
284 for (ofproto_port_dump_start(DUMP, OFPROTO); \
285 (ofproto_port_dump_next(DUMP, OFPROTO_PORT) \
287 : (ofproto_port_dump_done(DUMP), false)); \
290 #define OFPROTO_FLOW_LIMIT_DEFAULT 200000
291 #define OFPROTO_MAX_IDLE_DEFAULT 10000 /* ms */
293 const char *ofproto_port_open_type(const char *datapath_type
,
294 const char *port_type
);
295 int ofproto_port_add(struct ofproto
*, struct netdev
*, ofp_port_t
*ofp_portp
);
296 int ofproto_port_del(struct ofproto
*, ofp_port_t ofp_port
);
297 void ofproto_port_set_config(struct ofproto
*, ofp_port_t ofp_port
,
298 const struct smap
*cfg
);
299 int ofproto_port_get_stats(const struct ofport
*, struct netdev_stats
*stats
);
301 int ofproto_port_query_by_name(const struct ofproto
*, const char *devname
,
302 struct ofproto_port
*);
304 /* Top-level configuration. */
305 uint64_t ofproto_get_datapath_id(const struct ofproto
*);
306 void ofproto_set_datapath_id(struct ofproto
*, uint64_t datapath_id
);
307 void ofproto_set_controllers(struct ofproto
*,
308 const struct ofproto_controller
*, size_t n
,
309 uint32_t allowed_versions
);
310 void ofproto_set_fail_mode(struct ofproto
*, enum ofproto_fail_mode fail_mode
);
311 void ofproto_reconnect_controllers(struct ofproto
*);
312 void ofproto_set_extra_in_band_remotes(struct ofproto
*,
313 const struct sockaddr_in
*, size_t n
);
314 void ofproto_set_in_band_queue(struct ofproto
*, int queue_id
);
315 void ofproto_set_flow_limit(unsigned limit
);
316 void ofproto_set_max_idle(unsigned max_idle
);
317 void ofproto_set_forward_bpdu(struct ofproto
*, bool forward_bpdu
);
318 void ofproto_set_mac_table_config(struct ofproto
*, unsigned idle_time
,
320 int ofproto_set_mcast_snooping(struct ofproto
*ofproto
,
321 const struct ofproto_mcast_snooping_settings
*s
);
322 int ofproto_port_set_mcast_snooping(struct ofproto
*ofproto
, void *aux
,
323 const struct ofproto_mcast_snooping_port_settings
*s
);
324 void ofproto_set_threads(int n_handlers
, int n_revalidators
);
325 void ofproto_type_set_config(const char *type
,
326 const struct smap
*other_config
);
327 void ofproto_set_dp_desc(struct ofproto
*, const char *dp_desc
);
328 int ofproto_set_snoops(struct ofproto
*, const struct sset
*snoops
);
329 int ofproto_set_netflow(struct ofproto
*,
330 const struct netflow_options
*nf_options
);
331 int ofproto_set_sflow(struct ofproto
*, const struct ofproto_sflow_options
*);
332 int ofproto_set_ipfix(struct ofproto
*,
333 const struct ofproto_ipfix_bridge_exporter_options
*,
334 const struct ofproto_ipfix_flow_exporter_options
*,
336 void ofproto_set_flow_restore_wait(bool flow_restore_wait_db
);
337 bool ofproto_get_flow_restore_wait(void);
338 int ofproto_set_stp(struct ofproto
*, const struct ofproto_stp_settings
*);
339 int ofproto_get_stp_status(struct ofproto
*, struct ofproto_stp_status
*);
341 int ofproto_set_rstp(struct ofproto
*, const struct ofproto_rstp_settings
*);
342 int ofproto_get_rstp_status(struct ofproto
*, struct ofproto_rstp_status
*);
343 void ofproto_set_vlan_limit(int vlan_limit
);
345 /* Configuration of ports. */
346 void ofproto_port_unregister(struct ofproto
*, ofp_port_t ofp_port
);
348 void ofproto_port_clear_cfm(struct ofproto
*, ofp_port_t ofp_port
);
349 void ofproto_port_set_cfm(struct ofproto
*, ofp_port_t ofp_port
,
350 const struct cfm_settings
*);
351 void ofproto_port_set_bfd(struct ofproto
*, ofp_port_t ofp_port
,
352 const struct smap
*cfg
);
353 bool ofproto_port_bfd_status_changed(struct ofproto
*, ofp_port_t ofp_port
);
354 int ofproto_port_get_bfd_status(struct ofproto
*, ofp_port_t ofp_port
,
356 int ofproto_port_is_lacp_current(struct ofproto
*, ofp_port_t ofp_port
);
357 int ofproto_port_get_lacp_stats(const struct ofport
*, struct lacp_slave_stats
*);
358 int ofproto_port_set_stp(struct ofproto
*, ofp_port_t ofp_port
,
359 const struct ofproto_port_stp_settings
*);
360 int ofproto_port_get_stp_status(struct ofproto
*, ofp_port_t ofp_port
,
361 struct ofproto_port_stp_status
*);
362 int ofproto_port_get_stp_stats(struct ofproto
*, ofp_port_t ofp_port
,
363 struct ofproto_port_stp_stats
*);
364 int ofproto_port_set_queues(struct ofproto
*, ofp_port_t ofp_port
,
365 const struct ofproto_port_queue
*,
367 int ofproto_port_get_rstp_status(struct ofproto
*, ofp_port_t ofp_port
,
368 struct ofproto_port_rstp_status
*);
370 int ofproto_port_set_rstp(struct ofproto
*, ofp_port_t ofp_port
,
371 const struct ofproto_port_rstp_settings
*);
373 /* The behaviour of the port regarding VLAN handling */
374 enum port_vlan_mode
{
375 /* This port is an access port. 'vlan' is the VLAN ID. 'trunks' is
379 /* This port is a trunk. 'trunks' is the set of trunks. 'vlan' is
383 /* Untagged incoming packets are part of 'vlan', as are incoming packets
384 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' stay tagged.
385 * Other VLANs in 'trunks' are trunked. */
386 PORT_VLAN_NATIVE_TAGGED
,
388 /* Untagged incoming packets are part of 'vlan', as are incoming packets
389 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' are untagged.
390 * Other VLANs in 'trunks' are trunked. */
391 PORT_VLAN_NATIVE_UNTAGGED
,
393 /* 802.1q tunnel port. Incoming packets are added an outer vlan tag
394 * 'vlan'. If 'cvlans' is set, only allows VLANs in 'cvlans'. */
395 PORT_VLAN_DOT1Q_TUNNEL
398 /* Configuration of bundles. */
399 struct ofproto_bundle_settings
{
400 char *name
; /* For use in log messages. */
402 ofp_port_t
*slaves
; /* OpenFlow port numbers for slaves. */
405 enum port_vlan_mode vlan_mode
; /* Selects mode for vlan and trunks */
406 uint16_t qinq_ethtype
;
407 int vlan
; /* VLAN VID, except for PORT_VLAN_TRUNK. */
408 unsigned long *trunks
; /* vlan_bitmap, except for PORT_VLAN_ACCESS. */
409 unsigned long *cvlans
;
410 bool use_priority_tags
; /* Use 802.1p tag for frames in VLAN 0? */
412 struct bond_settings
*bond
; /* Must be nonnull iff if n_slaves > 1. */
414 struct lacp_settings
*lacp
; /* Nonnull to enable LACP. */
415 struct lacp_slave_settings
*lacp_slaves
; /* Array of n_slaves elements. */
417 bool protected; /* Protected port mode */
420 int ofproto_bundle_register(struct ofproto
*, void *aux
,
421 const struct ofproto_bundle_settings
*);
422 int ofproto_bundle_unregister(struct ofproto
*, void *aux
);
424 /* Configuration of mirrors. */
425 struct ofproto_mirror_settings
{
426 /* Name for log messages. */
429 /* Bundles that select packets for mirroring upon ingress. */
430 void **srcs
; /* A set of registered ofbundle handles. */
433 /* Bundles that select packets for mirroring upon egress. */
434 void **dsts
; /* A set of registered ofbundle handles. */
437 /* VLANs of packets to select for mirroring. */
438 unsigned long *src_vlans
; /* vlan_bitmap, NULL selects all VLANs. */
440 /* Output (mutually exclusive). */
441 void *out_bundle
; /* A registered ofbundle handle or NULL. */
442 uint16_t out_vlan
; /* Output VLAN, only if out_bundle is NULL. */
443 uint16_t snaplen
; /* Max packet size of a mirrored packet
444 in byte, set to 0 equals 65535. */
447 int ofproto_mirror_register(struct ofproto
*, void *aux
,
448 const struct ofproto_mirror_settings
*);
449 int ofproto_mirror_unregister(struct ofproto
*, void *aux
);
450 int ofproto_mirror_get_stats(struct ofproto
*, void *aux
,
451 uint64_t *packets
, uint64_t *bytes
);
453 void ofproto_port_set_lldp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
454 const struct smap
*cfg
);
455 int ofproto_set_aa(struct ofproto
*ofproto
, void *aux
,
456 const struct aa_settings
*s
);
457 int ofproto_aa_mapping_register(struct ofproto
*ofproto
, void *aux
,
458 const struct aa_mapping_settings
*s
);
459 int ofproto_aa_mapping_unregister(struct ofproto
*ofproto
, void *aux
);
460 int ofproto_aa_vlan_get_queued(struct ofproto
*ofproto
, struct ovs_list
*list
);
461 unsigned int ofproto_aa_vlan_get_queue_size(struct ofproto
*ofproto
);
463 int ofproto_set_flood_vlans(struct ofproto
*, unsigned long *flood_vlans
);
464 bool ofproto_is_mirror_output_bundle(const struct ofproto
*, void *aux
);
466 /* Configuration of OpenFlow tables. */
467 struct ofproto_table_settings
{
468 char *name
; /* Name exported via OpenFlow or NULL. */
469 unsigned int max_flows
; /* Maximum number of flows or UINT_MAX. */
471 /* These members, together with OpenFlow OFPT_TABLE_MOD, determine the
472 * handling of an attempt to add a flow that would cause the table to have
473 * more than 'max_flows' flows:
475 * - If 'enable_eviction' is false and OFPT_TABLE_MOD does not enable
476 * eviction, overflows will be rejected with an error.
478 * - If 'enable_eviction' is true or OFPT_TABLE_MOD enables eviction, an
479 * overflow will cause a flow to be removed. The flow to be removed
480 * is chosen to give fairness among groups distinguished by different
481 * values for the 'n_groups' subfields within 'groups'. */
482 bool enable_eviction
;
483 struct mf_subfield
*groups
;
487 * Fields for which prefix trie lookup is maintained.
489 unsigned int n_prefix_fields
;
490 enum mf_field_id prefix_fields
[CLS_MAX_TRIES
];
493 extern const enum mf_field_id default_prefix_fields
[2];
494 BUILD_ASSERT_DECL(ARRAY_SIZE(default_prefix_fields
) <= CLS_MAX_TRIES
);
496 int ofproto_get_n_tables(const struct ofproto
*);
497 uint8_t ofproto_get_n_visible_tables(const struct ofproto
*);
498 void ofproto_configure_table(struct ofproto
*, int table_id
,
499 const struct ofproto_table_settings
*);
501 /* Configuration querying. */
502 bool ofproto_has_snoops(const struct ofproto
*);
503 void ofproto_get_snoops(const struct ofproto
*, struct sset
*);
504 void ofproto_get_all_flows(struct ofproto
*p
, struct ds
*);
505 void ofproto_get_netflow_ids(const struct ofproto
*,
506 uint8_t *engine_type
, uint8_t *engine_id
);
508 void ofproto_get_ofproto_controller_info(const struct ofproto
*, struct shash
*);
509 void ofproto_free_ofproto_controller_info(struct shash
*);
511 bool ofproto_port_cfm_status_changed(struct ofproto
*, ofp_port_t ofp_port
);
513 int ofproto_port_get_cfm_status(const struct ofproto
*,
515 struct cfm_status
*);
517 /* Table configuration */
519 enum ofputil_table_miss
ofproto_table_get_miss_config(const struct ofproto
*,
526 #endif /* ofproto.h */