2 * Copyright (c) 2009, 2010, 2011 Nicira Networks.
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>
42 struct ofproto_controller_info
{
47 const char *values
[4];
54 uint64_t packet_count
; /* Packets from subrules. */
55 uint64_t byte_count
; /* Bytes from subrules. */
56 long long int used
; /* Last-used time (0 if never used). */
59 struct ofproto_sflow_options
{
61 uint32_t sampling_rate
;
62 uint32_t polling_interval
;
69 struct ofproto_stp_settings
{
70 stp_identifier system_id
;
77 struct ofproto_stp_status
{
78 bool enabled
; /* If false, ignore other members. */
79 stp_identifier bridge_id
;
80 stp_identifier designated_root
;
84 struct ofproto_port_stp_settings
{
86 uint8_t port_num
; /* In the range 1-255, inclusive. */
91 struct ofproto_port_stp_status
{
92 bool enabled
; /* If false, ignore other members. */
95 unsigned int sec_in_state
;
97 int tx_count
; /* Number of BPDUs transmitted. */
98 int rx_count
; /* Number of valid BPDUs received. */
99 int error_count
; /* Number of bad BPDUs received. */
102 struct ofproto_port_queue
{
103 uint32_t queue
; /* Queue ID. */
104 uint8_t dscp
; /* DSCP bits (e.g. [0, 63]). */
107 /* How the switch should act if the controller cannot be contacted. */
108 enum ofproto_fail_mode
{
109 OFPROTO_FAIL_SECURE
, /* Preserve flow table. */
110 OFPROTO_FAIL_STANDALONE
/* Act as a standalone switch. */
114 OFPROTO_IN_BAND
, /* In-band connection to controller. */
115 OFPROTO_OUT_OF_BAND
/* Out-of-band connection to controller. */
118 struct ofproto_controller
{
119 char *target
; /* e.g. "tcp:127.0.0.1" */
120 int max_backoff
; /* Maximum reconnection backoff, in seconds. */
121 int probe_interval
; /* Max idle time before probing, in seconds. */
122 enum ofproto_band band
; /* In-band or out-of-band? */
124 /* OpenFlow packet-in rate-limiting. */
125 int rate_limit
; /* Max packet-in rate in packets per second. */
126 int burst_limit
; /* Limit on accumulating packet credits. */
129 #define DEFAULT_MFR_DESC "Nicira Networks, Inc."
130 #define DEFAULT_HW_DESC "Open vSwitch"
131 #define DEFAULT_SW_DESC VERSION BUILDNR
132 #define DEFAULT_SERIAL_DESC "None"
133 #define DEFAULT_DP_DESC "None"
135 void ofproto_enumerate_types(struct sset
*types
);
136 const char *ofproto_normalize_type(const char *);
138 int ofproto_enumerate_names(const char *type
, struct sset
*names
);
139 void ofproto_parse_name(const char *name
, char **dp_name
, char **dp_type
);
141 int ofproto_create(const char *datapath
, const char *datapath_type
,
142 struct ofproto
**ofprotop
);
143 void ofproto_destroy(struct ofproto
*);
144 int ofproto_delete(const char *name
, const char *type
);
146 int ofproto_run(struct ofproto
*);
147 void ofproto_wait(struct ofproto
*);
148 bool ofproto_is_alive(const struct ofproto
*);
150 /* A port within an OpenFlow switch.
152 * 'name' and 'type' are suitable for passing to netdev_open(). */
153 struct ofproto_port
{
154 char *name
; /* Network device name, e.g. "eth0". */
155 char *type
; /* Network device type, e.g. "system". */
156 uint16_t ofp_port
; /* OpenFlow port number. */
158 void ofproto_port_clone(struct ofproto_port
*, const struct ofproto_port
*);
159 void ofproto_port_destroy(struct ofproto_port
*);
161 struct ofproto_port_dump
{
162 const struct ofproto
*ofproto
;
166 void ofproto_port_dump_start(struct ofproto_port_dump
*,
167 const struct ofproto
*);
168 bool ofproto_port_dump_next(struct ofproto_port_dump
*, struct ofproto_port
*);
169 int ofproto_port_dump_done(struct ofproto_port_dump
*);
171 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
173 * Arguments all have pointer type.
175 * If you break out of the loop, then you need to free the dump structure by
176 * hand using ofproto_port_dump_done(). */
177 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO) \
178 for (ofproto_port_dump_start(DUMP, OFPROTO); \
179 (ofproto_port_dump_next(DUMP, OFPROTO_PORT) \
181 : (ofproto_port_dump_done(DUMP), false)); \
184 #define OFPROTO_FLOW_EVICTON_THRESHOLD_DEFAULT 1000
185 #define OFPROTO_FLOW_EVICTION_THRESHOLD_MIN 100
187 int ofproto_port_add(struct ofproto
*, struct netdev
*, uint16_t *ofp_portp
);
188 int ofproto_port_del(struct ofproto
*, uint16_t ofp_port
);
190 int ofproto_port_query_by_name(const struct ofproto
*, const char *devname
,
191 struct ofproto_port
*);
193 /* Top-level configuration. */
194 void ofproto_set_datapath_id(struct ofproto
*, uint64_t datapath_id
);
195 void ofproto_set_controllers(struct ofproto
*,
196 const struct ofproto_controller
*, size_t n
);
197 void ofproto_set_fail_mode(struct ofproto
*, enum ofproto_fail_mode fail_mode
);
198 void ofproto_reconnect_controllers(struct ofproto
*);
199 void ofproto_set_extra_in_band_remotes(struct ofproto
*,
200 const struct sockaddr_in
*, size_t n
);
201 void ofproto_set_in_band_queue(struct ofproto
*, int queue_id
);
202 void ofproto_set_flow_eviction_threshold(struct ofproto
*, unsigned threshold
);
203 void ofproto_set_forward_bpdu(struct ofproto
*, bool forward_bpdu
);
204 void ofproto_set_desc(struct ofproto
*,
205 const char *mfr_desc
, const char *hw_desc
,
206 const char *sw_desc
, const char *serial_desc
,
207 const char *dp_desc
);
208 int ofproto_set_snoops(struct ofproto
*, const struct sset
*snoops
);
209 int ofproto_set_netflow(struct ofproto
*,
210 const struct netflow_options
*nf_options
);
211 int ofproto_set_sflow(struct ofproto
*, const struct ofproto_sflow_options
*);
212 int ofproto_set_stp(struct ofproto
*, const struct ofproto_stp_settings
*);
213 int ofproto_get_stp_status(struct ofproto
*, struct ofproto_stp_status
*);
215 /* Configuration of ports. */
217 void ofproto_port_unregister(struct ofproto
*, uint16_t ofp_port
);
219 void ofproto_port_clear_cfm(struct ofproto
*, uint16_t ofp_port
);
220 void ofproto_port_set_cfm(struct ofproto
*, uint16_t ofp_port
,
221 const struct cfm_settings
*);
222 int ofproto_port_is_lacp_current(struct ofproto
*, uint16_t ofp_port
);
223 int ofproto_port_set_stp(struct ofproto
*, uint16_t ofp_port
,
224 const struct ofproto_port_stp_settings
*);
225 int ofproto_port_get_stp_status(struct ofproto
*, uint16_t ofp_port
,
226 struct ofproto_port_stp_status
*);
227 int ofproto_port_set_queues(struct ofproto
*, uint16_t ofp_port
,
228 const struct ofproto_port_queue
*,
231 /* The behaviour of the port regarding VLAN handling */
232 enum port_vlan_mode
{
233 /* This port is an access port. 'vlan' is the VLAN ID. 'trunks' is
237 /* This port is a trunk. 'trunks' is the set of trunks. 'vlan' is
241 /* Untagged incoming packets are part of 'vlan', as are incoming packets
242 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' stay tagged.
243 * Other VLANs in 'trunks' are trunked. */
244 PORT_VLAN_NATIVE_TAGGED
,
246 /* Untagged incoming packets are part of 'vlan', as are incoming packets
247 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' are untagged.
248 * Other VLANs in 'trunks' are trunked. */
249 PORT_VLAN_NATIVE_UNTAGGED
252 /* Configuration of bundles. */
253 struct ofproto_bundle_settings
{
254 char *name
; /* For use in log messages. */
256 uint16_t *slaves
; /* OpenFlow port numbers for slaves. */
259 enum port_vlan_mode vlan_mode
; /* Selects mode for vlan and trunks */
260 int vlan
; /* VLAN VID, except for PORT_VLAN_TRUNK. */
261 unsigned long *trunks
; /* vlan_bitmap, except for PORT_VLAN_ACCESS. */
262 bool use_priority_tags
; /* Use 802.1p tag for frames in VLAN 0? */
264 struct bond_settings
*bond
; /* Must be nonnull iff if n_slaves > 1. */
265 uint32_t *bond_stable_ids
; /* Array of n_slaves elements. */
267 struct lacp_settings
*lacp
; /* Nonnull to enable LACP. */
268 struct lacp_slave_settings
*lacp_slaves
; /* Array of n_slaves elements. */
270 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
272 * This is deprecated. It is only for compatibility with broken device
273 * drivers in old versions of Linux that do not properly support VLANs when
274 * VLAN devices are not used. When broken device drivers are no longer in
275 * widespread use, we will delete these interfaces. */
276 uint16_t realdev_ofp_port
; /* OpenFlow port number of real device. */
279 int ofproto_bundle_register(struct ofproto
*, void *aux
,
280 const struct ofproto_bundle_settings
*);
281 int ofproto_bundle_unregister(struct ofproto
*, void *aux
);
283 /* Configuration of mirrors. */
284 struct ofproto_mirror_settings
{
285 /* Name for log messages. */
288 /* Bundles that select packets for mirroring upon ingress. */
289 void **srcs
; /* A set of registered ofbundle handles. */
292 /* Bundles that select packets for mirroring upon egress. */
293 void **dsts
; /* A set of registered ofbundle handles. */
296 /* VLANs of packets to select for mirroring. */
297 unsigned long *src_vlans
; /* vlan_bitmap, NULL selects all VLANs. */
299 /* Output (mutually exclusive). */
300 void *out_bundle
; /* A registered ofbundle handle or NULL. */
301 uint16_t out_vlan
; /* Output VLAN, only if out_bundle is NULL. */
304 int ofproto_mirror_register(struct ofproto
*, void *aux
,
305 const struct ofproto_mirror_settings
*);
306 int ofproto_mirror_unregister(struct ofproto
*, void *aux
);
307 int ofproto_mirror_get_stats(struct ofproto
*, void *aux
,
308 uint64_t *packets
, uint64_t *bytes
);
310 int ofproto_set_flood_vlans(struct ofproto
*, unsigned long *flood_vlans
);
311 bool ofproto_is_mirror_output_bundle(const struct ofproto
*, void *aux
);
313 /* Configuration querying. */
314 bool ofproto_has_snoops(const struct ofproto
*);
315 void ofproto_get_snoops(const struct ofproto
*, struct sset
*);
316 void ofproto_get_all_flows(struct ofproto
*p
, struct ds
*);
317 void ofproto_get_netflow_ids(const struct ofproto
*,
318 uint8_t *engine_type
, uint8_t *engine_id
);
319 int ofproto_port_get_cfm_fault(const struct ofproto
*, uint16_t ofp_port
);
320 int ofproto_port_get_cfm_remote_mpids(const struct ofproto
*,
321 uint16_t ofp_port
, const uint64_t **rmps
,
324 void ofproto_get_ofproto_controller_info(const struct ofproto
*, struct shash
*);
325 void ofproto_free_ofproto_controller_info(struct shash
*);
327 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
329 * This is deprecated. It is only for compatibility with broken device drivers
330 * in old versions of Linux that do not properly support VLANs when VLAN
331 * devices are not used. When broken device drivers are no longer in
332 * widespread use, we will delete these interfaces. */
334 void ofproto_get_vlan_usage(struct ofproto
*, unsigned long int *vlan_bitmap
);
335 bool ofproto_has_vlan_usage_changed(const struct ofproto
*);
336 int ofproto_port_set_realdev(struct ofproto
*, uint16_t vlandev_ofp_port
,
337 uint16_t realdev_ofp_port
, int vid
);
343 #endif /* ofproto.h */