2 * Copyright (c) 2009, 2010, 2011, 2012 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>
45 struct ofproto_controller_info
{
50 const char *values
[4];
57 uint64_t packet_count
; /* Packets from subrules. */
58 uint64_t byte_count
; /* Bytes from subrules. */
59 long long int used
; /* Last-used time (0 if never used). */
62 struct ofproto_sflow_options
{
64 uint32_t sampling_rate
;
65 uint32_t polling_interval
;
72 struct ofproto_stp_settings
{
73 stp_identifier system_id
;
80 struct ofproto_stp_status
{
81 bool enabled
; /* If false, ignore other members. */
82 stp_identifier bridge_id
;
83 stp_identifier designated_root
;
87 struct ofproto_port_stp_settings
{
89 uint8_t port_num
; /* In the range 1-255, inclusive. */
94 struct ofproto_port_stp_status
{
95 bool enabled
; /* If false, ignore other members. */
98 unsigned int sec_in_state
;
100 int tx_count
; /* Number of BPDUs transmitted. */
101 int rx_count
; /* Number of valid BPDUs received. */
102 int error_count
; /* Number of bad BPDUs received. */
105 struct ofproto_port_queue
{
106 uint32_t queue
; /* Queue ID. */
107 uint8_t dscp
; /* DSCP bits (e.g. [0, 63]). */
110 /* How the switch should act if the controller cannot be contacted. */
111 enum ofproto_fail_mode
{
112 OFPROTO_FAIL_SECURE
, /* Preserve flow table. */
113 OFPROTO_FAIL_STANDALONE
/* Act as a standalone switch. */
117 OFPROTO_IN_BAND
, /* In-band connection to controller. */
118 OFPROTO_OUT_OF_BAND
/* Out-of-band connection to controller. */
121 struct ofproto_controller
{
122 char *target
; /* e.g. "tcp:127.0.0.1" */
123 int max_backoff
; /* Maximum reconnection backoff, in seconds. */
124 int probe_interval
; /* Max idle time before probing, in seconds. */
125 enum ofproto_band band
; /* In-band or out-of-band? */
126 bool enable_async_msgs
; /* Initially enable asynchronous messages? */
128 /* OpenFlow packet-in rate-limiting. */
129 int rate_limit
; /* Max packet-in rate in packets per second. */
130 int burst_limit
; /* Limit on accumulating packet credits. */
132 uint8_t dscp
; /* DSCP value for controller connection. */
135 #define DEFAULT_MFR_DESC "Nicira, Inc."
136 #define DEFAULT_HW_DESC "Open vSwitch"
137 #define DEFAULT_SW_DESC VERSION
138 #define DEFAULT_SERIAL_DESC "None"
139 #define DEFAULT_DP_DESC "None"
141 void ofproto_enumerate_types(struct sset
*types
);
142 const char *ofproto_normalize_type(const char *);
144 int ofproto_enumerate_names(const char *type
, struct sset
*names
);
145 void ofproto_parse_name(const char *name
, char **dp_name
, char **dp_type
);
147 /* An interface hint element, which is used by ofproto_init() to
148 * describe the caller's understanding of the startup state. */
150 char *br_name
; /* Name of owning bridge. */
151 char *br_type
; /* Type of owning bridge. */
152 uint16_t ofp_port
; /* OpenFlow port number. */
155 void ofproto_init(const struct shash
*iface_hints
);
157 int ofproto_create(const char *datapath
, const char *datapath_type
,
158 struct ofproto
**ofprotop
);
159 void ofproto_destroy(struct ofproto
*);
160 int ofproto_delete(const char *name
, const char *type
);
162 int ofproto_run(struct ofproto
*);
163 int ofproto_run_fast(struct ofproto
*);
164 void ofproto_wait(struct ofproto
*);
165 bool ofproto_is_alive(const struct ofproto
*);
167 void ofproto_get_memory_usage(const struct ofproto
*, struct simap
*);
169 /* A port within an OpenFlow switch.
171 * 'name' and 'type' are suitable for passing to netdev_open(). */
172 struct ofproto_port
{
173 char *name
; /* Network device name, e.g. "eth0". */
174 char *type
; /* Network device type, e.g. "system". */
175 uint16_t ofp_port
; /* OpenFlow port number. */
177 void ofproto_port_clone(struct ofproto_port
*, const struct ofproto_port
*);
178 void ofproto_port_destroy(struct ofproto_port
*);
180 struct ofproto_port_dump
{
181 const struct ofproto
*ofproto
;
185 void ofproto_port_dump_start(struct ofproto_port_dump
*,
186 const struct ofproto
*);
187 bool ofproto_port_dump_next(struct ofproto_port_dump
*, struct ofproto_port
*);
188 int ofproto_port_dump_done(struct ofproto_port_dump
*);
190 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
192 * Arguments all have pointer type.
194 * If you break out of the loop, then you need to free the dump structure by
195 * hand using ofproto_port_dump_done(). */
196 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO) \
197 for (ofproto_port_dump_start(DUMP, OFPROTO); \
198 (ofproto_port_dump_next(DUMP, OFPROTO_PORT) \
200 : (ofproto_port_dump_done(DUMP), false)); \
203 #define OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT 1000
204 #define OFPROTO_FLOW_EVICTION_THRESHOLD_MIN 100
206 int ofproto_port_add(struct ofproto
*, struct netdev
*, uint16_t *ofp_portp
);
207 int ofproto_port_del(struct ofproto
*, uint16_t ofp_port
);
208 int ofproto_port_get_stats(const struct ofport
*, struct netdev_stats
*stats
);
210 int ofproto_port_query_by_name(const struct ofproto
*, const char *devname
,
211 struct ofproto_port
*);
213 /* Top-level configuration. */
214 uint64_t ofproto_get_datapath_id(const struct ofproto
*);
215 void ofproto_set_datapath_id(struct ofproto
*, uint64_t datapath_id
);
216 void ofproto_set_controllers(struct ofproto
*,
217 const struct ofproto_controller
*, size_t n
);
218 void ofproto_set_fail_mode(struct ofproto
*, enum ofproto_fail_mode fail_mode
);
219 void ofproto_reconnect_controllers(struct ofproto
*);
220 void ofproto_set_extra_in_band_remotes(struct ofproto
*,
221 const struct sockaddr_in
*, size_t n
);
222 void ofproto_set_in_band_queue(struct ofproto
*, int queue_id
);
223 void ofproto_set_flow_eviction_threshold(struct ofproto
*, unsigned threshold
);
224 void ofproto_set_forward_bpdu(struct ofproto
*, bool forward_bpdu
);
225 void ofproto_set_mac_idle_time(struct ofproto
*, unsigned idle_time
);
226 void ofproto_set_desc(struct ofproto
*,
227 const char *mfr_desc
, const char *hw_desc
,
228 const char *sw_desc
, const char *serial_desc
,
229 const char *dp_desc
);
230 int ofproto_set_snoops(struct ofproto
*, const struct sset
*snoops
);
231 int ofproto_set_netflow(struct ofproto
*,
232 const struct netflow_options
*nf_options
);
233 int ofproto_set_sflow(struct ofproto
*, const struct ofproto_sflow_options
*);
234 int ofproto_set_stp(struct ofproto
*, const struct ofproto_stp_settings
*);
235 int ofproto_get_stp_status(struct ofproto
*, struct ofproto_stp_status
*);
237 /* Configuration of ports. */
238 void ofproto_port_unregister(struct ofproto
*, uint16_t ofp_port
);
240 void ofproto_port_clear_cfm(struct ofproto
*, uint16_t ofp_port
);
241 void ofproto_port_set_cfm(struct ofproto
*, uint16_t ofp_port
,
242 const struct cfm_settings
*);
243 int ofproto_port_is_lacp_current(struct ofproto
*, uint16_t ofp_port
);
244 int ofproto_port_set_stp(struct ofproto
*, uint16_t ofp_port
,
245 const struct ofproto_port_stp_settings
*);
246 int ofproto_port_get_stp_status(struct ofproto
*, uint16_t ofp_port
,
247 struct ofproto_port_stp_status
*);
248 int ofproto_port_set_queues(struct ofproto
*, uint16_t ofp_port
,
249 const struct ofproto_port_queue
*,
252 /* The behaviour of the port regarding VLAN handling */
253 enum port_vlan_mode
{
254 /* This port is an access port. 'vlan' is the VLAN ID. 'trunks' is
258 /* This port is a trunk. 'trunks' is the set of trunks. 'vlan' is
262 /* Untagged incoming packets are part of 'vlan', as are incoming packets
263 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' stay tagged.
264 * Other VLANs in 'trunks' are trunked. */
265 PORT_VLAN_NATIVE_TAGGED
,
267 /* Untagged incoming packets are part of 'vlan', as are incoming packets
268 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' are untagged.
269 * Other VLANs in 'trunks' are trunked. */
270 PORT_VLAN_NATIVE_UNTAGGED
273 /* Configuration of bundles. */
274 struct ofproto_bundle_settings
{
275 char *name
; /* For use in log messages. */
277 uint16_t *slaves
; /* OpenFlow port numbers for slaves. */
280 enum port_vlan_mode vlan_mode
; /* Selects mode for vlan and trunks */
281 int vlan
; /* VLAN VID, except for PORT_VLAN_TRUNK. */
282 unsigned long *trunks
; /* vlan_bitmap, except for PORT_VLAN_ACCESS. */
283 bool use_priority_tags
; /* Use 802.1p tag for frames in VLAN 0? */
285 struct bond_settings
*bond
; /* Must be nonnull iff if n_slaves > 1. */
286 uint32_t *bond_stable_ids
; /* Array of n_slaves elements. */
288 struct lacp_settings
*lacp
; /* Nonnull to enable LACP. */
289 struct lacp_slave_settings
*lacp_slaves
; /* Array of n_slaves elements. */
291 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
293 * This is deprecated. It is only for compatibility with broken device
294 * drivers in old versions of Linux that do not properly support VLANs when
295 * VLAN devices are not used. When broken device drivers are no longer in
296 * widespread use, we will delete these interfaces. */
297 uint16_t realdev_ofp_port
; /* OpenFlow port number of real device. */
300 int ofproto_bundle_register(struct ofproto
*, void *aux
,
301 const struct ofproto_bundle_settings
*);
302 int ofproto_bundle_unregister(struct ofproto
*, void *aux
);
304 /* Configuration of mirrors. */
305 struct ofproto_mirror_settings
{
306 /* Name for log messages. */
309 /* Bundles that select packets for mirroring upon ingress. */
310 void **srcs
; /* A set of registered ofbundle handles. */
313 /* Bundles that select packets for mirroring upon egress. */
314 void **dsts
; /* A set of registered ofbundle handles. */
317 /* VLANs of packets to select for mirroring. */
318 unsigned long *src_vlans
; /* vlan_bitmap, NULL selects all VLANs. */
320 /* Output (mutually exclusive). */
321 void *out_bundle
; /* A registered ofbundle handle or NULL. */
322 uint16_t out_vlan
; /* Output VLAN, only if out_bundle is NULL. */
325 int ofproto_mirror_register(struct ofproto
*, void *aux
,
326 const struct ofproto_mirror_settings
*);
327 int ofproto_mirror_unregister(struct ofproto
*, void *aux
);
328 int ofproto_mirror_get_stats(struct ofproto
*, void *aux
,
329 uint64_t *packets
, uint64_t *bytes
);
331 int ofproto_set_flood_vlans(struct ofproto
*, unsigned long *flood_vlans
);
332 bool ofproto_is_mirror_output_bundle(const struct ofproto
*, void *aux
);
334 /* Configuration of OpenFlow tables. */
335 struct ofproto_table_settings
{
336 char *name
; /* Name exported via OpenFlow or NULL. */
337 unsigned int max_flows
; /* Maximum number of flows or UINT_MAX. */
339 /* These members determine the handling of an attempt to add a flow that
340 * would cause the table to have more than 'max_flows' flows.
342 * If 'groups' is NULL, overflows will be rejected with an error.
344 * If 'groups' is nonnull, an overflow will cause a flow to be removed.
345 * The flow to be removed is chosen to give fairness among groups
346 * distinguished by different values for the subfields within 'groups'. */
347 struct mf_subfield
*groups
;
351 int ofproto_get_n_tables(const struct ofproto
*);
352 void ofproto_configure_table(struct ofproto
*, int table_id
,
353 const struct ofproto_table_settings
*);
355 /* Configuration querying. */
356 bool ofproto_has_snoops(const struct ofproto
*);
357 void ofproto_get_snoops(const struct ofproto
*, struct sset
*);
358 void ofproto_get_all_flows(struct ofproto
*p
, struct ds
*);
359 void ofproto_get_netflow_ids(const struct ofproto
*,
360 uint8_t *engine_type
, uint8_t *engine_id
);
361 int ofproto_port_get_cfm_fault(const struct ofproto
*, uint16_t ofp_port
);
362 int ofproto_port_get_cfm_opup(const struct ofproto
*, uint16_t ofp_port
);
363 int ofproto_port_get_cfm_remote_mpids(const struct ofproto
*,
364 uint16_t ofp_port
, const uint64_t **rmps
,
366 int ofproto_port_get_cfm_health(const struct ofproto
*ofproto
,
368 void ofproto_get_ofproto_controller_info(const struct ofproto
*, struct shash
*);
369 void ofproto_free_ofproto_controller_info(struct shash
*);
371 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
373 * This is deprecated. It is only for compatibility with broken device drivers
374 * in old versions of Linux that do not properly support VLANs when VLAN
375 * devices are not used. When broken device drivers are no longer in
376 * widespread use, we will delete these interfaces. */
378 void ofproto_get_vlan_usage(struct ofproto
*, unsigned long int *vlan_bitmap
);
379 bool ofproto_has_vlan_usage_changed(const struct ofproto
*);
380 int ofproto_port_set_realdev(struct ofproto
*, uint16_t vlandev_ofp_port
,
381 uint16_t realdev_ofp_port
, int vid
);
387 #endif /* ofproto.h */