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 /* ofproto supports two kinds of OpenFlow connections:
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.
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.
221 OFCONN_PRIMARY
, /* An ordinary OpenFlow controller. */
222 OFCONN_SERVICE
/* A service connection, e.g. "ovs-ofctl". */
224 const char *ofconn_type_to_string(enum ofconn_type
);
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. */
236 /* OpenFlow packet-in rate-limiting. */
237 int max_pktq_size
; /* Maximum number of packet-in to be queued. */
238 int rate_limit
; /* Max packet-in rate in packets per second. */
239 int burst_limit
; /* Limit on accumulating packet credits. */
241 uint8_t dscp
; /* DSCP value for controller connection. */
244 void ofproto_enumerate_types(struct sset
*types
);
245 const char *ofproto_normalize_type(const char *);
247 int ofproto_enumerate_names(const char *type
, struct sset
*names
);
248 void ofproto_parse_name(const char *name
, char **dp_name
, char **dp_type
);
250 /* An interface hint element, which is used by ofproto_init() to
251 * describe the caller's understanding of the startup state. */
253 char *br_name
; /* Name of owning bridge. */
254 char *br_type
; /* Type of owning bridge. */
255 ofp_port_t ofp_port
; /* OpenFlow port number. */
258 void ofproto_init(const struct shash
*iface_hints
);
260 int ofproto_type_run(const char *datapath_type
);
261 void ofproto_type_wait(const char *datapath_type
);
263 int ofproto_create(const char *datapath
, const char *datapath_type
,
264 struct ofproto
**ofprotop
)
265 OVS_EXCLUDED(ofproto_mutex
);
266 void ofproto_destroy(struct ofproto
*, bool del
);
267 int ofproto_delete(const char *name
, const char *type
);
269 int ofproto_run(struct ofproto
*);
270 void ofproto_wait(struct ofproto
*);
271 bool ofproto_is_alive(const struct ofproto
*);
273 void ofproto_get_memory_usage(const struct ofproto
*, struct simap
*);
274 void ofproto_type_get_memory_usage(const char *datapath_type
, struct simap
*);
276 /* A port within an OpenFlow switch.
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". */
282 ofp_port_t ofp_port
; /* OpenFlow port number. */
284 void ofproto_port_clone(struct ofproto_port
*, const struct ofproto_port
*);
285 void ofproto_port_destroy(struct ofproto_port
*);
287 struct ofproto_port_dump
{
288 const struct ofproto
*ofproto
;
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
*);
297 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
299 * Arguments all have pointer type.
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) \
307 : (ofproto_port_dump_done(DUMP), false)); \
310 #define OFPROTO_FLOW_LIMIT_DEFAULT 200000
311 #define OFPROTO_MAX_IDLE_DEFAULT 10000 /* ms */
312 #define OFPROTO_MAX_REVALIDATOR_DEFAULT 500 /* ms */
313 #define OFPROTO_MIN_REVALIDATE_PPS_DEFAULT 5
315 const char *ofproto_port_open_type(const struct ofproto
*,
316 const char *port_type
);
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
);
319 void ofproto_port_set_config(struct ofproto
*, ofp_port_t ofp_port
,
320 const struct smap
*cfg
);
321 int ofproto_port_get_stats(const struct ofport
*, struct netdev_stats
*stats
);
323 int ofproto_vport_get_status(const struct ofproto
*, ofp_port_t ofp_port
,
326 int ofproto_port_query_by_name(const struct ofproto
*, const char *devname
,
327 struct ofproto_port
*);
329 /* Top-level configuration. */
330 uint64_t ofproto_get_datapath_id(const struct ofproto
*);
331 void ofproto_set_datapath_id(struct ofproto
*, uint64_t datapath_id
);
332 void ofproto_set_controllers(struct ofproto
*, struct shash
*controllers
);
333 void ofproto_set_fail_mode(struct ofproto
*, enum ofproto_fail_mode fail_mode
);
334 void ofproto_reconnect_controllers(struct ofproto
*);
335 void ofproto_set_extra_in_band_remotes(struct ofproto
*,
336 const struct sockaddr_in
*, size_t n
);
337 void ofproto_set_in_band_queue(struct ofproto
*, int queue_id
);
338 void ofproto_set_bundle_idle_timeout(unsigned timeout
);
339 void ofproto_set_flow_limit(unsigned limit
);
340 void ofproto_set_max_idle(unsigned max_idle
);
341 void ofproto_set_max_revalidator(unsigned max_revalidator
);
342 void ofproto_set_min_revalidate_pps(unsigned min_revalidate_pps
);
343 void ofproto_set_forward_bpdu(struct ofproto
*, bool forward_bpdu
);
344 void ofproto_set_mac_table_config(struct ofproto
*, unsigned idle_time
,
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
,
349 const struct ofproto_mcast_snooping_port_settings
*s
);
350 void ofproto_set_threads(int n_handlers
, int n_revalidators
);
351 void ofproto_type_set_config(const char *type
,
352 const struct smap
*other_config
);
353 void ofproto_set_dp_desc(struct ofproto
*, const char *dp_desc
);
354 int ofproto_set_snoops(struct ofproto
*, const struct sset
*snoops
);
355 int ofproto_set_netflow(struct ofproto
*,
356 const struct netflow_options
*nf_options
);
357 int ofproto_set_sflow(struct ofproto
*, const struct ofproto_sflow_options
*);
358 int ofproto_set_ipfix(struct ofproto
*,
359 const struct ofproto_ipfix_bridge_exporter_options
*,
360 const struct ofproto_ipfix_flow_exporter_options
*,
362 void ofproto_set_flow_restore_wait(bool flow_restore_wait_db
);
363 bool ofproto_get_flow_restore_wait(void);
364 int ofproto_set_stp(struct ofproto
*, const struct ofproto_stp_settings
*);
365 int ofproto_get_stp_status(struct ofproto
*, struct ofproto_stp_status
*);
367 int ofproto_set_rstp(struct ofproto
*, const struct ofproto_rstp_settings
*);
368 int ofproto_get_rstp_status(struct ofproto
*, struct ofproto_rstp_status
*);
369 void ofproto_set_vlan_limit(int vlan_limit
);
371 /* Configuration of ports. */
372 void ofproto_port_unregister(struct ofproto
*, ofp_port_t ofp_port
);
374 void ofproto_port_clear_cfm(struct ofproto
*, ofp_port_t ofp_port
);
375 void ofproto_port_set_cfm(struct ofproto
*, ofp_port_t ofp_port
,
376 const struct cfm_settings
*);
377 void ofproto_port_set_bfd(struct ofproto
*, ofp_port_t ofp_port
,
378 const struct smap
*cfg
);
379 bool ofproto_port_bfd_status_changed(struct ofproto
*, ofp_port_t ofp_port
);
380 int ofproto_port_get_bfd_status(struct ofproto
*, ofp_port_t ofp_port
,
382 int ofproto_port_is_lacp_current(struct ofproto
*, ofp_port_t ofp_port
);
383 int ofproto_port_get_lacp_stats(const struct ofport
*, struct lacp_slave_stats
*);
384 int ofproto_port_set_stp(struct ofproto
*, ofp_port_t ofp_port
,
385 const struct ofproto_port_stp_settings
*);
386 int ofproto_port_get_stp_status(struct ofproto
*, ofp_port_t ofp_port
,
387 struct ofproto_port_stp_status
*);
388 int ofproto_port_get_stp_stats(struct ofproto
*, ofp_port_t ofp_port
,
389 struct ofproto_port_stp_stats
*);
390 int ofproto_port_set_queues(struct ofproto
*, ofp_port_t ofp_port
,
391 const struct ofproto_port_queue
*,
393 int ofproto_port_get_rstp_status(struct ofproto
*, ofp_port_t ofp_port
,
394 struct ofproto_port_rstp_status
*);
396 int ofproto_port_set_rstp(struct ofproto
*, ofp_port_t ofp_port
,
397 const struct ofproto_port_rstp_settings
*);
399 /* The behaviour of the port regarding VLAN handling */
400 enum port_vlan_mode
{
401 /* This port is an access port. 'vlan' is the VLAN ID. 'trunks' is
405 /* This port is a trunk. 'trunks' is the set of trunks. 'vlan' is
409 /* Untagged incoming packets are part of 'vlan', as are incoming packets
410 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' stay tagged.
411 * Other VLANs in 'trunks' are trunked. */
412 PORT_VLAN_NATIVE_TAGGED
,
414 /* Untagged incoming packets are part of 'vlan', as are incoming packets
415 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' are untagged.
416 * Other VLANs in 'trunks' are trunked. */
417 PORT_VLAN_NATIVE_UNTAGGED
,
419 /* 802.1q tunnel port. Incoming packets are added an outer vlan tag
420 * 'vlan'. If 'cvlans' is set, only allows VLANs in 'cvlans'. */
421 PORT_VLAN_DOT1Q_TUNNEL
424 /* The behaviour of the port regarding priority tags */
425 enum port_priority_tags_mode
{
426 PORT_PRIORITY_TAGS_NEVER
= 0,
427 PORT_PRIORITY_TAGS_IF_NONZERO
,
428 PORT_PRIORITY_TAGS_ALWAYS
,
431 /* The behaviour of the port regarding priority tags */
432 /* Configuration of bundles. */
433 struct ofproto_bundle_settings
{
434 char *name
; /* For use in log messages. */
436 ofp_port_t
*slaves
; /* OpenFlow port numbers for slaves. */
439 enum port_vlan_mode vlan_mode
; /* Selects mode for vlan and trunks */
440 uint16_t qinq_ethtype
;
441 int vlan
; /* VLAN VID, except for PORT_VLAN_TRUNK. */
442 unsigned long *trunks
; /* vlan_bitmap, except for PORT_VLAN_ACCESS. */
443 unsigned long *cvlans
;
444 enum port_priority_tags_mode use_priority_tags
;
445 /* Use 802.1p tag for frames in VLAN 0? */
447 struct bond_settings
*bond
; /* Must be nonnull iff if n_slaves > 1. */
449 struct lacp_settings
*lacp
; /* Nonnull to enable LACP. */
450 struct lacp_slave_settings
*lacp_slaves
; /* Array of n_slaves elements. */
452 bool protected; /* Protected port mode */
455 int ofproto_bundle_register(struct ofproto
*, void *aux
,
456 const struct ofproto_bundle_settings
*);
457 int ofproto_bundle_unregister(struct ofproto
*, void *aux
);
459 /* Configuration of mirrors. */
460 struct ofproto_mirror_settings
{
461 /* Name for log messages. */
464 /* Bundles that select packets for mirroring upon ingress. */
465 void **srcs
; /* A set of registered ofbundle handles. */
468 /* Bundles that select packets for mirroring upon egress. */
469 void **dsts
; /* A set of registered ofbundle handles. */
472 /* VLANs of packets to select for mirroring. */
473 unsigned long *src_vlans
; /* vlan_bitmap, NULL selects all VLANs. */
475 /* Output (mutually exclusive). */
476 void *out_bundle
; /* A registered ofbundle handle or NULL. */
477 uint16_t out_vlan
; /* Output VLAN, only if out_bundle is NULL. */
478 uint16_t snaplen
; /* Max packet size of a mirrored packet
479 in byte, set to 0 equals 65535. */
482 int ofproto_mirror_register(struct ofproto
*, void *aux
,
483 const struct ofproto_mirror_settings
*);
484 int ofproto_mirror_unregister(struct ofproto
*, void *aux
);
485 int ofproto_mirror_get_stats(struct ofproto
*, void *aux
,
486 uint64_t *packets
, uint64_t *bytes
);
488 void ofproto_port_set_lldp(struct ofproto
*ofproto
, ofp_port_t ofp_port
,
489 const struct smap
*cfg
);
490 int ofproto_set_aa(struct ofproto
*ofproto
, void *aux
,
491 const struct aa_settings
*s
);
492 int ofproto_aa_mapping_register(struct ofproto
*ofproto
, void *aux
,
493 const struct aa_mapping_settings
*s
);
494 int ofproto_aa_mapping_unregister(struct ofproto
*ofproto
, void *aux
);
495 int ofproto_aa_vlan_get_queued(struct ofproto
*ofproto
, struct ovs_list
*list
);
496 unsigned int ofproto_aa_vlan_get_queue_size(struct ofproto
*ofproto
);
498 int ofproto_set_flood_vlans(struct ofproto
*, unsigned long *flood_vlans
);
499 bool ofproto_is_mirror_output_bundle(const struct ofproto
*, void *aux
);
501 /* Configuration of OpenFlow tables. */
502 struct ofproto_table_settings
{
503 char *name
; /* Name exported via OpenFlow or NULL. */
504 unsigned int max_flows
; /* Maximum number of flows or UINT_MAX. */
506 /* These members, together with OpenFlow OFPT_TABLE_MOD, determine the
507 * handling of an attempt to add a flow that would cause the table to have
508 * more than 'max_flows' flows:
510 * - If 'enable_eviction' is false and OFPT_TABLE_MOD does not enable
511 * eviction, overflows will be rejected with an error.
513 * - If 'enable_eviction' is true or OFPT_TABLE_MOD enables eviction, an
514 * overflow will cause a flow to be removed. The flow to be removed
515 * is chosen to give fairness among groups distinguished by different
516 * values for the 'n_groups' subfields within 'groups'. */
517 bool enable_eviction
;
518 struct mf_subfield
*groups
;
522 * Fields for which prefix trie lookup is maintained.
524 unsigned int n_prefix_fields
;
525 enum mf_field_id prefix_fields
[CLS_MAX_TRIES
];
528 extern const enum mf_field_id default_prefix_fields
[2];
529 BUILD_ASSERT_DECL(ARRAY_SIZE(default_prefix_fields
) <= CLS_MAX_TRIES
);
531 int ofproto_get_n_tables(const struct ofproto
*);
532 uint8_t ofproto_get_n_visible_tables(const struct ofproto
*);
533 void ofproto_configure_table(struct ofproto
*, int table_id
,
534 const struct ofproto_table_settings
*);
536 /* Configuration querying. */
537 bool ofproto_has_snoops(const struct ofproto
*);
538 void ofproto_get_snoops(const struct ofproto
*, struct sset
*);
539 void ofproto_get_all_flows(struct ofproto
*p
, struct ds
*);
540 void ofproto_get_netflow_ids(const struct ofproto
*,
541 uint8_t *engine_type
, uint8_t *engine_id
);
543 void ofproto_get_ofproto_controller_info(const struct ofproto
*, struct shash
*);
544 void ofproto_free_ofproto_controller_info(struct shash
*);
546 bool ofproto_port_cfm_status_changed(struct ofproto
*, ofp_port_t ofp_port
);
548 int ofproto_port_get_cfm_status(const struct ofproto
*,
550 struct cfm_status
*);
552 /* Table configuration */
554 enum ofputil_table_miss
ofproto_table_get_miss_config(const struct ofproto
*,
561 #endif /* ofproto.h */