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 void ofproto_destroy(struct ofproto *, bool del);
246 int ofproto_delete(const char *name, const char *type);
248 int ofproto_run(struct ofproto *);
249 void ofproto_wait(struct ofproto *);
250 bool ofproto_is_alive(const struct ofproto *);
252 void ofproto_get_memory_usage(const struct ofproto *, struct simap *);
253 void ofproto_type_get_memory_usage(const char *datapath_type, struct simap *);
255 /* A port within an OpenFlow switch.
257 * 'name' and 'type' are suitable for passing to netdev_open(). */
258 struct ofproto_port {
259 char *name; /* Network device name, e.g. "eth0". */
260 char *type; /* Network device type, e.g. "system". */
261 ofp_port_t ofp_port; /* OpenFlow port number. */
263 void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *);
264 void ofproto_port_destroy(struct ofproto_port *);
266 struct ofproto_port_dump {
267 const struct ofproto *ofproto;
271 void ofproto_port_dump_start(struct ofproto_port_dump *,
272 const struct ofproto *);
273 bool ofproto_port_dump_next(struct ofproto_port_dump *, struct ofproto_port *);
274 int ofproto_port_dump_done(struct ofproto_port_dump *);
276 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
278 * Arguments all have pointer type.
280 * If you break out of the loop, then you need to free the dump structure by
281 * hand using ofproto_port_dump_done(). */
282 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO) \
283 for (ofproto_port_dump_start(DUMP, OFPROTO); \
284 (ofproto_port_dump_next(DUMP, OFPROTO_PORT) \
286 : (ofproto_port_dump_done(DUMP), false)); \
289 #define OFPROTO_FLOW_LIMIT_DEFAULT 200000
290 #define OFPROTO_MAX_IDLE_DEFAULT 10000 /* ms */
292 const char *ofproto_port_open_type(const char *datapath_type,
293 const char *port_type);
294 int ofproto_port_add(struct ofproto *, struct netdev *, ofp_port_t *ofp_portp);
295 int ofproto_port_del(struct ofproto *, ofp_port_t ofp_port);
296 int ofproto_port_get_stats(const struct ofport *, struct netdev_stats *stats);
298 int ofproto_port_query_by_name(const struct ofproto *, const char *devname,
299 struct ofproto_port *);
301 /* Top-level configuration. */
302 uint64_t ofproto_get_datapath_id(const struct ofproto *);
303 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
304 void ofproto_set_controllers(struct ofproto *,
305 const struct ofproto_controller *, size_t n,
306 uint32_t allowed_versions);
307 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
308 void ofproto_reconnect_controllers(struct ofproto *);
309 void ofproto_set_extra_in_band_remotes(struct ofproto *,
310 const struct sockaddr_in *, size_t n);
311 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
312 void ofproto_set_flow_limit(unsigned limit);
313 void ofproto_set_max_idle(unsigned max_idle);
314 void ofproto_set_forward_bpdu(struct ofproto *, bool forward_bpdu);
315 void ofproto_set_mac_table_config(struct ofproto *, unsigned idle_time,
317 int ofproto_set_mcast_snooping(struct ofproto *ofproto,
318 const struct ofproto_mcast_snooping_settings *s);
319 int ofproto_port_set_mcast_snooping(struct ofproto *ofproto, void *aux,
320 const struct ofproto_mcast_snooping_port_settings *s);
321 void ofproto_set_threads(int n_handlers, int n_revalidators);
322 void ofproto_set_cpu_mask(const char *cmask);
323 void ofproto_set_dp_desc(struct ofproto *, const char *dp_desc);
324 int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
325 int ofproto_set_netflow(struct ofproto *,
326 const struct netflow_options *nf_options);
327 int ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
328 int ofproto_set_ipfix(struct ofproto *,
329 const struct ofproto_ipfix_bridge_exporter_options *,
330 const struct ofproto_ipfix_flow_exporter_options *,
332 void ofproto_set_flow_restore_wait(bool flow_restore_wait_db);
333 bool ofproto_get_flow_restore_wait(void);
334 int ofproto_set_stp(struct ofproto *, const struct ofproto_stp_settings *);
335 int ofproto_get_stp_status(struct ofproto *, struct ofproto_stp_status *);
337 int ofproto_set_rstp(struct ofproto *, const struct ofproto_rstp_settings *);
338 int ofproto_get_rstp_status(struct ofproto *, struct ofproto_rstp_status *);
340 /* Configuration of ports. */
341 void ofproto_port_unregister(struct ofproto *, ofp_port_t ofp_port);
343 void ofproto_port_clear_cfm(struct ofproto *, ofp_port_t ofp_port);
344 void ofproto_port_set_cfm(struct ofproto *, ofp_port_t ofp_port,
345 const struct cfm_settings *);
346 void ofproto_port_set_bfd(struct ofproto *, ofp_port_t ofp_port,
347 const struct smap *cfg);
348 bool ofproto_port_bfd_status_changed(struct ofproto *, ofp_port_t ofp_port);
349 int ofproto_port_get_bfd_status(struct ofproto *, ofp_port_t ofp_port,
351 int ofproto_port_is_lacp_current(struct ofproto *, ofp_port_t ofp_port);
352 int ofproto_port_get_lacp_stats(const struct ofport *, struct lacp_slave_stats *);
353 int ofproto_port_set_stp(struct ofproto *, ofp_port_t ofp_port,
354 const struct ofproto_port_stp_settings *);
355 int ofproto_port_get_stp_status(struct ofproto *, ofp_port_t ofp_port,
356 struct ofproto_port_stp_status *);
357 int ofproto_port_get_stp_stats(struct ofproto *, ofp_port_t ofp_port,
358 struct ofproto_port_stp_stats *);
359 int ofproto_port_set_queues(struct ofproto *, ofp_port_t ofp_port,
360 const struct ofproto_port_queue *,
362 int ofproto_port_get_rstp_status(struct ofproto *, ofp_port_t ofp_port,
363 struct ofproto_port_rstp_status *);
365 int ofproto_port_set_rstp(struct ofproto *, ofp_port_t ofp_port,
366 const struct ofproto_port_rstp_settings *);
368 /* The behaviour of the port regarding VLAN handling */
369 enum port_vlan_mode {
370 /* This port is an access port. 'vlan' is the VLAN ID. 'trunks' is
374 /* This port is a trunk. 'trunks' is the set of trunks. 'vlan' is
378 /* Untagged incoming packets are part of 'vlan', as are incoming packets
379 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' stay tagged.
380 * Other VLANs in 'trunks' are trunked. */
381 PORT_VLAN_NATIVE_TAGGED,
383 /* Untagged incoming packets are part of 'vlan', as are incoming packets
384 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' are untagged.
385 * Other VLANs in 'trunks' are trunked. */
386 PORT_VLAN_NATIVE_UNTAGGED
389 /* Configuration of bundles. */
390 struct ofproto_bundle_settings {
391 char *name; /* For use in log messages. */
393 ofp_port_t *slaves; /* OpenFlow port numbers for slaves. */
396 enum port_vlan_mode vlan_mode; /* Selects mode for vlan and trunks */
397 int vlan; /* VLAN VID, except for PORT_VLAN_TRUNK. */
398 unsigned long *trunks; /* vlan_bitmap, except for PORT_VLAN_ACCESS. */
399 bool use_priority_tags; /* Use 802.1p tag for frames in VLAN 0? */
401 struct bond_settings *bond; /* Must be nonnull iff if n_slaves > 1. */
403 struct lacp_settings *lacp; /* Nonnull to enable LACP. */
404 struct lacp_slave_settings *lacp_slaves; /* Array of n_slaves elements. */
407 int ofproto_bundle_register(struct ofproto *, void *aux,
408 const struct ofproto_bundle_settings *);
409 int ofproto_bundle_unregister(struct ofproto *, void *aux);
411 /* Configuration of mirrors. */
412 struct ofproto_mirror_settings {
413 /* Name for log messages. */
416 /* Bundles that select packets for mirroring upon ingress. */
417 void **srcs; /* A set of registered ofbundle handles. */
420 /* Bundles that select packets for mirroring upon egress. */
421 void **dsts; /* A set of registered ofbundle handles. */
424 /* VLANs of packets to select for mirroring. */
425 unsigned long *src_vlans; /* vlan_bitmap, NULL selects all VLANs. */
427 /* Output (mutually exclusive). */
428 void *out_bundle; /* A registered ofbundle handle or NULL. */
429 uint16_t out_vlan; /* Output VLAN, only if out_bundle is NULL. */
430 uint16_t snaplen; /* Max packet size of a mirrored packet
431 in byte, set to 0 equals 65535. */
434 int ofproto_mirror_register(struct ofproto *, void *aux,
435 const struct ofproto_mirror_settings *);
436 int ofproto_mirror_unregister(struct ofproto *, void *aux);
437 int ofproto_mirror_get_stats(struct ofproto *, void *aux,
438 uint64_t *packets, uint64_t *bytes);
440 void ofproto_port_set_lldp(struct ofproto *ofproto, ofp_port_t ofp_port,
441 const struct smap *cfg);
442 int ofproto_set_aa(struct ofproto *ofproto, void *aux,
443 const struct aa_settings *s);
444 int ofproto_aa_mapping_register(struct ofproto *ofproto, void *aux,
445 const struct aa_mapping_settings *s);
446 int ofproto_aa_mapping_unregister(struct ofproto *ofproto, void *aux);
447 int ofproto_aa_vlan_get_queued(struct ofproto *ofproto, struct ovs_list *list);
448 unsigned int ofproto_aa_vlan_get_queue_size(struct ofproto *ofproto);
450 int ofproto_set_flood_vlans(struct ofproto *, unsigned long *flood_vlans);
451 bool ofproto_is_mirror_output_bundle(const struct ofproto *, void *aux);
453 /* Configuration of OpenFlow tables. */
454 struct ofproto_table_settings {
455 char *name; /* Name exported via OpenFlow or NULL. */
456 unsigned int max_flows; /* Maximum number of flows or UINT_MAX. */
458 /* These members, together with OpenFlow OFPT_TABLE_MOD, determine the
459 * handling of an attempt to add a flow that would cause the table to have
460 * more than 'max_flows' flows:
462 * - If 'enable_eviction' is false and OFPT_TABLE_MOD does not enable
463 * eviction, overflows will be rejected with an error.
465 * - If 'enable_eviction' is true or OFPT_TABLE_MOD enables eviction, an
466 * overflow will cause a flow to be removed. The flow to be removed
467 * is chosen to give fairness among groups distinguished by different
468 * values for the 'n_groups' subfields within 'groups'. */
469 bool enable_eviction;
470 struct mf_subfield *groups;
474 * Fields for which prefix trie lookup is maintained.
476 unsigned int n_prefix_fields;
477 enum mf_field_id prefix_fields[CLS_MAX_TRIES];
480 extern const enum mf_field_id default_prefix_fields[2];
481 BUILD_ASSERT_DECL(ARRAY_SIZE(default_prefix_fields) <= CLS_MAX_TRIES);
483 int ofproto_get_n_tables(const struct ofproto *);
484 uint8_t ofproto_get_n_visible_tables(const struct ofproto *);
485 void ofproto_configure_table(struct ofproto *, int table_id,
486 const struct ofproto_table_settings *);
488 /* Configuration querying. */
489 bool ofproto_has_snoops(const struct ofproto *);
490 void ofproto_get_snoops(const struct ofproto *, struct sset *);
491 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
492 void ofproto_get_netflow_ids(const struct ofproto *,
493 uint8_t *engine_type, uint8_t *engine_id);
495 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
496 void ofproto_free_ofproto_controller_info(struct shash *);
498 bool ofproto_port_cfm_status_changed(struct ofproto *, ofp_port_t ofp_port);
500 int ofproto_port_get_cfm_status(const struct ofproto *,
502 struct cfm_status *);
504 /* Table configuration */
506 enum ofputil_table_miss ofproto_table_get_miss_config(const struct ofproto *,
513 #endif /* ofproto.h */