2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 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>
46 struct ofproto_controller_info
{
48 enum ofp12_controller_role role
;
51 const char *values
[4];
58 uint64_t packet_count
; /* Packets from subrules. */
59 uint64_t byte_count
; /* Bytes from subrules. */
60 long long int used
; /* Last-used time (0 if never used). */
63 struct ofproto_sflow_options
{
65 uint32_t sampling_rate
;
66 uint32_t polling_interval
;
74 struct ofproto_ipfix_bridge_exporter_options
{
76 uint32_t sampling_rate
;
77 uint32_t obs_domain_id
; /* Bridge-wide Observation Domain ID. */
78 uint32_t obs_point_id
; /* Bridge-wide Observation Point ID. */
79 uint32_t cache_active_timeout
;
80 uint32_t cache_max_flows
;
83 struct ofproto_ipfix_flow_exporter_options
{
84 uint32_t collector_set_id
;
86 uint32_t cache_active_timeout
;
87 uint32_t cache_max_flows
;
90 struct ofproto_stp_settings
{
91 stp_identifier system_id
;
98 struct ofproto_stp_status
{
99 bool enabled
; /* If false, ignore other members. */
100 stp_identifier bridge_id
;
101 stp_identifier designated_root
;
105 struct ofproto_port_stp_settings
{
107 uint8_t port_num
; /* In the range 1-255, inclusive. */
112 struct ofproto_port_stp_status
{
113 bool enabled
; /* If false, ignore other members. */
115 enum stp_state state
;
116 unsigned int sec_in_state
;
118 int tx_count
; /* Number of BPDUs transmitted. */
119 int rx_count
; /* Number of valid BPDUs received. */
120 int error_count
; /* Number of bad BPDUs received. */
123 struct ofproto_port_queue
{
124 uint32_t queue
; /* Queue ID. */
125 uint8_t dscp
; /* DSCP bits (e.g. [0, 63]). */
128 /* How the switch should act if the controller cannot be contacted. */
129 enum ofproto_fail_mode
{
130 OFPROTO_FAIL_SECURE
, /* Preserve flow table. */
131 OFPROTO_FAIL_STANDALONE
/* Act as a standalone switch. */
135 OFPROTO_IN_BAND
, /* In-band connection to controller. */
136 OFPROTO_OUT_OF_BAND
/* Out-of-band connection to controller. */
139 struct ofproto_controller
{
140 char *target
; /* e.g. "tcp:127.0.0.1" */
141 int max_backoff
; /* Maximum reconnection backoff, in seconds. */
142 int probe_interval
; /* Max idle time before probing, in seconds. */
143 enum ofproto_band band
; /* In-band or out-of-band? */
144 bool enable_async_msgs
; /* Initially enable asynchronous messages? */
146 /* OpenFlow packet-in rate-limiting. */
147 int rate_limit
; /* Max packet-in rate in packets per second. */
148 int burst_limit
; /* Limit on accumulating packet credits. */
150 uint8_t dscp
; /* DSCP value for controller connection. */
153 void ofproto_enumerate_types(struct sset
*types
);
154 const char *ofproto_normalize_type(const char *);
156 int ofproto_enumerate_names(const char *type
, struct sset
*names
);
157 void ofproto_parse_name(const char *name
, char **dp_name
, char **dp_type
);
159 /* An interface hint element, which is used by ofproto_init() to
160 * describe the caller's understanding of the startup state. */
162 char *br_name
; /* Name of owning bridge. */
163 char *br_type
; /* Type of owning bridge. */
164 ofp_port_t ofp_port
; /* OpenFlow port number. */
167 void ofproto_init(const struct shash
*iface_hints
);
169 int ofproto_type_run(const char *datapath_type
);
170 int ofproto_type_run_fast(const char *datapath_type
);
171 void ofproto_type_wait(const char *datapath_type
);
173 int ofproto_create(const char *datapath
, const char *datapath_type
,
174 struct ofproto
**ofprotop
);
175 void ofproto_destroy(struct ofproto
*);
176 int ofproto_delete(const char *name
, const char *type
);
178 int ofproto_run(struct ofproto
*);
179 int ofproto_run_fast(struct ofproto
*);
180 void ofproto_wait(struct ofproto
*);
181 bool ofproto_is_alive(const struct ofproto
*);
183 void ofproto_get_memory_usage(const struct ofproto
*, struct simap
*);
185 /* A port within an OpenFlow switch.
187 * 'name' and 'type' are suitable for passing to netdev_open(). */
188 struct ofproto_port
{
189 char *name
; /* Network device name, e.g. "eth0". */
190 char *type
; /* Network device type, e.g. "system". */
191 ofp_port_t ofp_port
; /* OpenFlow port number. */
193 void ofproto_port_clone(struct ofproto_port
*, const struct ofproto_port
*);
194 void ofproto_port_destroy(struct ofproto_port
*);
196 struct ofproto_port_dump
{
197 const struct ofproto
*ofproto
;
201 void ofproto_port_dump_start(struct ofproto_port_dump
*,
202 const struct ofproto
*);
203 bool ofproto_port_dump_next(struct ofproto_port_dump
*, struct ofproto_port
*);
204 int ofproto_port_dump_done(struct ofproto_port_dump
*);
206 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
208 * Arguments all have pointer type.
210 * If you break out of the loop, then you need to free the dump structure by
211 * hand using ofproto_port_dump_done(). */
212 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO) \
213 for (ofproto_port_dump_start(DUMP, OFPROTO); \
214 (ofproto_port_dump_next(DUMP, OFPROTO_PORT) \
216 : (ofproto_port_dump_done(DUMP), false)); \
219 #define OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT 2500
220 #define OFPROTO_FLOW_EVICTION_THRESHOLD_MIN 100
222 /* How flow misses should be handled in ofproto-dpif */
223 enum ofproto_flow_miss_model
{
224 OFPROTO_HANDLE_MISS_AUTO
, /* Based on flow eviction threshold. */
225 OFPROTO_HANDLE_MISS_WITH_FACETS
, /* Always create facets. */
226 OFPROTO_HANDLE_MISS_WITHOUT_FACETS
/* Always handle without facets.*/
229 const char *ofproto_port_open_type(const char *datapath_type
,
230 const char *port_type
);
231 int ofproto_port_add(struct ofproto
*, struct netdev
*, ofp_port_t
*ofp_portp
);
232 int ofproto_port_del(struct ofproto
*, ofp_port_t ofp_port
);
233 int ofproto_port_get_stats(const struct ofport
*, struct netdev_stats
*stats
);
235 int ofproto_port_query_by_name(const struct ofproto
*, const char *devname
,
236 struct ofproto_port
*);
238 /* Top-level configuration. */
239 uint64_t ofproto_get_datapath_id(const struct ofproto
*);
240 void ofproto_set_datapath_id(struct ofproto
*, uint64_t datapath_id
);
241 void ofproto_set_controllers(struct ofproto
*,
242 const struct ofproto_controller
*, size_t n
,
243 uint32_t allowed_versions
);
244 void ofproto_set_fail_mode(struct ofproto
*, enum ofproto_fail_mode fail_mode
);
245 void ofproto_reconnect_controllers(struct ofproto
*);
246 void ofproto_set_extra_in_band_remotes(struct ofproto
*,
247 const struct sockaddr_in
*, size_t n
);
248 void ofproto_set_in_band_queue(struct ofproto
*, int queue_id
);
249 void ofproto_set_flow_eviction_threshold(unsigned threshold
);
250 void ofproto_set_flow_miss_model(unsigned model
);
251 void ofproto_set_forward_bpdu(struct ofproto
*, bool forward_bpdu
);
252 void ofproto_set_mac_table_config(struct ofproto
*, unsigned idle_time
,
254 void ofproto_set_n_handler_threads(unsigned limit
);
255 void ofproto_set_dp_desc(struct ofproto
*, const char *dp_desc
);
256 int ofproto_set_snoops(struct ofproto
*, const struct sset
*snoops
);
257 int ofproto_set_netflow(struct ofproto
*,
258 const struct netflow_options
*nf_options
);
259 int ofproto_set_sflow(struct ofproto
*, const struct ofproto_sflow_options
*);
260 int ofproto_set_ipfix(struct ofproto
*,
261 const struct ofproto_ipfix_bridge_exporter_options
*,
262 const struct ofproto_ipfix_flow_exporter_options
*,
264 void ofproto_set_flow_restore_wait(bool flow_restore_wait_db
);
265 bool ofproto_get_flow_restore_wait(void);
266 int ofproto_set_stp(struct ofproto
*, const struct ofproto_stp_settings
*);
267 int ofproto_get_stp_status(struct ofproto
*, struct ofproto_stp_status
*);
269 /* Configuration of ports. */
270 void ofproto_port_unregister(struct ofproto
*, ofp_port_t ofp_port
);
272 void ofproto_port_clear_cfm(struct ofproto
*, ofp_port_t ofp_port
);
273 void ofproto_port_set_cfm(struct ofproto
*, ofp_port_t ofp_port
,
274 const struct cfm_settings
*);
275 void ofproto_port_set_bfd(struct ofproto
*, ofp_port_t ofp_port
,
276 const struct smap
*cfg
);
277 int ofproto_port_get_bfd_status(struct ofproto
*, ofp_port_t ofp_port
,
279 int ofproto_port_is_lacp_current(struct ofproto
*, ofp_port_t ofp_port
);
280 int ofproto_port_set_stp(struct ofproto
*, ofp_port_t ofp_port
,
281 const struct ofproto_port_stp_settings
*);
282 int ofproto_port_get_stp_status(struct ofproto
*, ofp_port_t ofp_port
,
283 struct ofproto_port_stp_status
*);
284 int ofproto_port_set_queues(struct ofproto
*, ofp_port_t ofp_port
,
285 const struct ofproto_port_queue
*,
288 /* The behaviour of the port regarding VLAN handling */
289 enum port_vlan_mode
{
290 /* This port is an access port. 'vlan' is the VLAN ID. 'trunks' is
294 /* This port is a trunk. 'trunks' is the set of trunks. 'vlan' is
298 /* Untagged incoming packets are part of 'vlan', as are incoming packets
299 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' stay tagged.
300 * Other VLANs in 'trunks' are trunked. */
301 PORT_VLAN_NATIVE_TAGGED
,
303 /* Untagged incoming packets are part of 'vlan', as are incoming packets
304 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' are untagged.
305 * Other VLANs in 'trunks' are trunked. */
306 PORT_VLAN_NATIVE_UNTAGGED
309 /* Configuration of bundles. */
310 struct ofproto_bundle_settings
{
311 char *name
; /* For use in log messages. */
313 ofp_port_t
*slaves
; /* OpenFlow port numbers for slaves. */
316 enum port_vlan_mode vlan_mode
; /* Selects mode for vlan and trunks */
317 int vlan
; /* VLAN VID, except for PORT_VLAN_TRUNK. */
318 unsigned long *trunks
; /* vlan_bitmap, except for PORT_VLAN_ACCESS. */
319 bool use_priority_tags
; /* Use 802.1p tag for frames in VLAN 0? */
321 struct bond_settings
*bond
; /* Must be nonnull iff if n_slaves > 1. */
323 struct lacp_settings
*lacp
; /* Nonnull to enable LACP. */
324 struct lacp_slave_settings
*lacp_slaves
; /* Array of n_slaves elements. */
326 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
328 * This is deprecated. It is only for compatibility with broken device
329 * drivers in old versions of Linux that do not properly support VLANs when
330 * VLAN devices are not used. When broken device drivers are no longer in
331 * widespread use, we will delete these interfaces. */
332 ofp_port_t realdev_ofp_port
;/* OpenFlow port number of real device. */
335 int ofproto_bundle_register(struct ofproto
*, void *aux
,
336 const struct ofproto_bundle_settings
*);
337 int ofproto_bundle_unregister(struct ofproto
*, void *aux
);
339 /* Configuration of mirrors. */
340 struct ofproto_mirror_settings
{
341 /* Name for log messages. */
344 /* Bundles that select packets for mirroring upon ingress. */
345 void **srcs
; /* A set of registered ofbundle handles. */
348 /* Bundles that select packets for mirroring upon egress. */
349 void **dsts
; /* A set of registered ofbundle handles. */
352 /* VLANs of packets to select for mirroring. */
353 unsigned long *src_vlans
; /* vlan_bitmap, NULL selects all VLANs. */
355 /* Output (mutually exclusive). */
356 void *out_bundle
; /* A registered ofbundle handle or NULL. */
357 uint16_t out_vlan
; /* Output VLAN, only if out_bundle is NULL. */
360 int ofproto_mirror_register(struct ofproto
*, void *aux
,
361 const struct ofproto_mirror_settings
*);
362 int ofproto_mirror_unregister(struct ofproto
*, void *aux
);
363 int ofproto_mirror_get_stats(struct ofproto
*, void *aux
,
364 uint64_t *packets
, uint64_t *bytes
);
366 int ofproto_set_flood_vlans(struct ofproto
*, unsigned long *flood_vlans
);
367 bool ofproto_is_mirror_output_bundle(const struct ofproto
*, void *aux
);
369 /* Configuration of OpenFlow tables. */
370 struct ofproto_table_settings
{
371 char *name
; /* Name exported via OpenFlow or NULL. */
372 unsigned int max_flows
; /* Maximum number of flows or UINT_MAX. */
374 /* These members determine the handling of an attempt to add a flow that
375 * would cause the table to have more than 'max_flows' flows.
377 * If 'groups' is NULL, overflows will be rejected with an error.
379 * If 'groups' is nonnull, an overflow will cause a flow to be removed.
380 * The flow to be removed is chosen to give fairness among groups
381 * distinguished by different values for the subfields within 'groups'. */
382 struct mf_subfield
*groups
;
386 int ofproto_get_n_tables(const struct ofproto
*);
387 void ofproto_configure_table(struct ofproto
*, int table_id
,
388 const struct ofproto_table_settings
*);
390 /* Configuration querying. */
391 bool ofproto_has_snoops(const struct ofproto
*);
392 void ofproto_get_snoops(const struct ofproto
*, struct sset
*);
393 void ofproto_get_all_flows(struct ofproto
*p
, struct ds
*);
394 void ofproto_get_netflow_ids(const struct ofproto
*,
395 uint8_t *engine_type
, uint8_t *engine_id
);
397 void ofproto_get_ofproto_controller_info(const struct ofproto
*, struct shash
*);
398 void ofproto_free_ofproto_controller_info(struct shash
*);
400 /* CFM status query. */
401 struct ofproto_cfm_status
{
402 /* 0 if not faulted, otherwise a combination of one or more reasons. */
403 enum cfm_fault_reason faults
;
405 /* 0 if the remote CFM endpoint is operationally down,
406 * 1 if the remote CFM endpoint is operationally up,
407 * -1 if we don't know because the remote CFM endpoint is not in extended
413 /* Ordinarily a "health status" in the range 0...100 inclusive, with 0
414 * being worst and 100 being best, or -1 if the health status is not
418 /* MPIDs of remote maintenance points whose CCMs have been received. */
423 bool ofproto_port_get_cfm_status(const struct ofproto
*,
425 struct ofproto_cfm_status
*);
427 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
429 * This is deprecated. It is only for compatibility with broken device drivers
430 * in old versions of Linux that do not properly support VLANs when VLAN
431 * devices are not used. When broken device drivers are no longer in
432 * widespread use, we will delete these interfaces. */
434 void ofproto_get_vlan_usage(struct ofproto
*, unsigned long int *vlan_bitmap
);
435 bool ofproto_has_vlan_usage_changed(const struct ofproto
*);
436 int ofproto_port_set_realdev(struct ofproto
*, ofp_port_t vlandev_ofp_port
,
437 ofp_port_t realdev_ofp_port
, int vid
);
443 #endif /* ofproto.h */