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;
120 struct ofproto_port_stp_stats {
121 bool enabled; /* If false, ignore other members. */
122 int tx_count; /* Number of BPDUs transmitted. */
123 int rx_count; /* Number of valid BPDUs received. */
124 int error_count; /* Number of bad BPDUs received. */
127 struct ofproto_port_queue {
128 uint32_t queue; /* Queue ID. */
129 uint8_t dscp; /* DSCP bits (e.g. [0, 63]). */
132 /* How the switch should act if the controller cannot be contacted. */
133 enum ofproto_fail_mode {
134 OFPROTO_FAIL_SECURE, /* Preserve flow table. */
135 OFPROTO_FAIL_STANDALONE /* Act as a standalone switch. */
139 OFPROTO_IN_BAND, /* In-band connection to controller. */
140 OFPROTO_OUT_OF_BAND /* Out-of-band connection to controller. */
143 struct ofproto_controller {
144 char *target; /* e.g. "tcp:127.0.0.1" */
145 int max_backoff; /* Maximum reconnection backoff, in seconds. */
146 int probe_interval; /* Max idle time before probing, in seconds. */
147 enum ofproto_band band; /* In-band or out-of-band? */
148 bool enable_async_msgs; /* Initially enable asynchronous messages? */
150 /* OpenFlow packet-in rate-limiting. */
151 int rate_limit; /* Max packet-in rate in packets per second. */
152 int burst_limit; /* Limit on accumulating packet credits. */
154 uint8_t dscp; /* DSCP value for controller connection. */
157 void ofproto_enumerate_types(struct sset *types);
158 const char *ofproto_normalize_type(const char *);
160 int ofproto_enumerate_names(const char *type, struct sset *names);
161 void ofproto_parse_name(const char *name, char **dp_name, char **dp_type);
163 /* An interface hint element, which is used by ofproto_init() to
164 * describe the caller's understanding of the startup state. */
166 char *br_name; /* Name of owning bridge. */
167 char *br_type; /* Type of owning bridge. */
168 ofp_port_t ofp_port; /* OpenFlow port number. */
171 void ofproto_init(const struct shash *iface_hints);
173 int ofproto_type_run(const char *datapath_type);
174 int ofproto_type_run_fast(const char *datapath_type);
175 void ofproto_type_wait(const char *datapath_type);
177 int ofproto_create(const char *datapath, const char *datapath_type,
178 struct ofproto **ofprotop);
179 void ofproto_destroy(struct ofproto *);
180 int ofproto_delete(const char *name, const char *type);
182 int ofproto_run(struct ofproto *);
183 int ofproto_run_fast(struct ofproto *);
184 void ofproto_wait(struct ofproto *);
185 bool ofproto_is_alive(const struct ofproto *);
187 void ofproto_get_memory_usage(const struct ofproto *, struct simap *);
189 /* A port within an OpenFlow switch.
191 * 'name' and 'type' are suitable for passing to netdev_open(). */
192 struct ofproto_port {
193 char *name; /* Network device name, e.g. "eth0". */
194 char *type; /* Network device type, e.g. "system". */
195 ofp_port_t ofp_port; /* OpenFlow port number. */
197 void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *);
198 void ofproto_port_destroy(struct ofproto_port *);
200 struct ofproto_port_dump {
201 const struct ofproto *ofproto;
205 void ofproto_port_dump_start(struct ofproto_port_dump *,
206 const struct ofproto *);
207 bool ofproto_port_dump_next(struct ofproto_port_dump *, struct ofproto_port *);
208 int ofproto_port_dump_done(struct ofproto_port_dump *);
210 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
212 * Arguments all have pointer type.
214 * If you break out of the loop, then you need to free the dump structure by
215 * hand using ofproto_port_dump_done(). */
216 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO) \
217 for (ofproto_port_dump_start(DUMP, OFPROTO); \
218 (ofproto_port_dump_next(DUMP, OFPROTO_PORT) \
220 : (ofproto_port_dump_done(DUMP), false)); \
223 #define OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT 2500
224 #define OFPROTO_FLOW_EVICTION_THRESHOLD_MIN 100
226 /* How flow misses should be handled in ofproto-dpif */
227 enum ofproto_flow_miss_model {
228 OFPROTO_HANDLE_MISS_AUTO, /* Based on flow eviction threshold. */
229 OFPROTO_HANDLE_MISS_WITH_FACETS, /* Always create facets. */
230 OFPROTO_HANDLE_MISS_WITHOUT_FACETS /* Always handle without facets.*/
233 const char *ofproto_port_open_type(const char *datapath_type,
234 const char *port_type);
235 int ofproto_port_add(struct ofproto *, struct netdev *, ofp_port_t *ofp_portp);
236 int ofproto_port_del(struct ofproto *, ofp_port_t ofp_port);
237 int ofproto_port_get_stats(const struct ofport *, struct netdev_stats *stats);
239 int ofproto_port_query_by_name(const struct ofproto *, const char *devname,
240 struct ofproto_port *);
242 /* Top-level configuration. */
243 uint64_t ofproto_get_datapath_id(const struct ofproto *);
244 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
245 void ofproto_set_controllers(struct ofproto *,
246 const struct ofproto_controller *, size_t n,
247 uint32_t allowed_versions);
248 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
249 void ofproto_reconnect_controllers(struct ofproto *);
250 void ofproto_set_extra_in_band_remotes(struct ofproto *,
251 const struct sockaddr_in *, size_t n);
252 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
253 void ofproto_set_flow_eviction_threshold(unsigned threshold);
254 void ofproto_set_flow_miss_model(unsigned model);
255 void ofproto_set_forward_bpdu(struct ofproto *, bool forward_bpdu);
256 void ofproto_set_mac_table_config(struct ofproto *, unsigned idle_time,
258 void ofproto_set_n_handler_threads(unsigned limit);
259 void ofproto_set_dp_desc(struct ofproto *, const char *dp_desc);
260 int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
261 int ofproto_set_netflow(struct ofproto *,
262 const struct netflow_options *nf_options);
263 int ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
264 int ofproto_set_ipfix(struct ofproto *,
265 const struct ofproto_ipfix_bridge_exporter_options *,
266 const struct ofproto_ipfix_flow_exporter_options *,
268 void ofproto_set_flow_restore_wait(bool flow_restore_wait_db);
269 bool ofproto_get_flow_restore_wait(void);
270 int ofproto_set_stp(struct ofproto *, const struct ofproto_stp_settings *);
271 int ofproto_get_stp_status(struct ofproto *, struct ofproto_stp_status *);
273 /* Configuration of ports. */
274 void ofproto_port_unregister(struct ofproto *, ofp_port_t ofp_port);
276 void ofproto_port_clear_cfm(struct ofproto *, ofp_port_t ofp_port);
277 void ofproto_port_set_cfm(struct ofproto *, ofp_port_t ofp_port,
278 const struct cfm_settings *);
279 void ofproto_port_set_bfd(struct ofproto *, ofp_port_t ofp_port,
280 const struct smap *cfg);
281 int ofproto_port_get_bfd_status(struct ofproto *, ofp_port_t ofp_port,
283 int ofproto_port_is_lacp_current(struct ofproto *, ofp_port_t ofp_port);
284 int ofproto_port_set_stp(struct ofproto *, ofp_port_t ofp_port,
285 const struct ofproto_port_stp_settings *);
286 int ofproto_port_get_stp_status(struct ofproto *, ofp_port_t ofp_port,
287 struct ofproto_port_stp_status *);
288 int ofproto_port_get_stp_stats(struct ofproto *, ofp_port_t ofp_port,
289 struct ofproto_port_stp_stats *);
290 int ofproto_port_set_queues(struct ofproto *, ofp_port_t ofp_port,
291 const struct ofproto_port_queue *,
294 /* The behaviour of the port regarding VLAN handling */
295 enum port_vlan_mode {
296 /* This port is an access port. 'vlan' is the VLAN ID. 'trunks' is
300 /* This port is a trunk. 'trunks' is the set of trunks. 'vlan' is
304 /* Untagged incoming packets are part of 'vlan', as are incoming packets
305 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' stay tagged.
306 * Other VLANs in 'trunks' are trunked. */
307 PORT_VLAN_NATIVE_TAGGED,
309 /* Untagged incoming packets are part of 'vlan', as are incoming packets
310 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' are untagged.
311 * Other VLANs in 'trunks' are trunked. */
312 PORT_VLAN_NATIVE_UNTAGGED
315 /* Configuration of bundles. */
316 struct ofproto_bundle_settings {
317 char *name; /* For use in log messages. */
319 ofp_port_t *slaves; /* OpenFlow port numbers for slaves. */
322 enum port_vlan_mode vlan_mode; /* Selects mode for vlan and trunks */
323 int vlan; /* VLAN VID, except for PORT_VLAN_TRUNK. */
324 unsigned long *trunks; /* vlan_bitmap, except for PORT_VLAN_ACCESS. */
325 bool use_priority_tags; /* Use 802.1p tag for frames in VLAN 0? */
327 struct bond_settings *bond; /* Must be nonnull iff if n_slaves > 1. */
329 struct lacp_settings *lacp; /* Nonnull to enable LACP. */
330 struct lacp_slave_settings *lacp_slaves; /* Array of n_slaves elements. */
332 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
334 * This is deprecated. It is only for compatibility with broken device
335 * drivers in old versions of Linux that do not properly support VLANs when
336 * VLAN devices are not used. When broken device drivers are no longer in
337 * widespread use, we will delete these interfaces. */
338 ofp_port_t realdev_ofp_port;/* OpenFlow port number of real device. */
341 int ofproto_bundle_register(struct ofproto *, void *aux,
342 const struct ofproto_bundle_settings *);
343 int ofproto_bundle_unregister(struct ofproto *, void *aux);
345 /* Configuration of mirrors. */
346 struct ofproto_mirror_settings {
347 /* Name for log messages. */
350 /* Bundles that select packets for mirroring upon ingress. */
351 void **srcs; /* A set of registered ofbundle handles. */
354 /* Bundles that select packets for mirroring upon egress. */
355 void **dsts; /* A set of registered ofbundle handles. */
358 /* VLANs of packets to select for mirroring. */
359 unsigned long *src_vlans; /* vlan_bitmap, NULL selects all VLANs. */
361 /* Output (mutually exclusive). */
362 void *out_bundle; /* A registered ofbundle handle or NULL. */
363 uint16_t out_vlan; /* Output VLAN, only if out_bundle is NULL. */
366 int ofproto_mirror_register(struct ofproto *, void *aux,
367 const struct ofproto_mirror_settings *);
368 int ofproto_mirror_unregister(struct ofproto *, void *aux);
369 int ofproto_mirror_get_stats(struct ofproto *, void *aux,
370 uint64_t *packets, uint64_t *bytes);
372 int ofproto_set_flood_vlans(struct ofproto *, unsigned long *flood_vlans);
373 bool ofproto_is_mirror_output_bundle(const struct ofproto *, void *aux);
375 /* Configuration of OpenFlow tables. */
376 struct ofproto_table_settings {
377 char *name; /* Name exported via OpenFlow or NULL. */
378 unsigned int max_flows; /* Maximum number of flows or UINT_MAX. */
380 /* These members determine the handling of an attempt to add a flow that
381 * would cause the table to have more than 'max_flows' flows.
383 * If 'groups' is NULL, overflows will be rejected with an error.
385 * If 'groups' is nonnull, an overflow will cause a flow to be removed.
386 * The flow to be removed is chosen to give fairness among groups
387 * distinguished by different values for the subfields within 'groups'. */
388 struct mf_subfield *groups;
392 int ofproto_get_n_tables(const struct ofproto *);
393 void ofproto_configure_table(struct ofproto *, int table_id,
394 const struct ofproto_table_settings *);
396 /* Configuration querying. */
397 bool ofproto_has_snoops(const struct ofproto *);
398 void ofproto_get_snoops(const struct ofproto *, struct sset *);
399 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
400 void ofproto_get_netflow_ids(const struct ofproto *,
401 uint8_t *engine_type, uint8_t *engine_id);
403 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
404 void ofproto_free_ofproto_controller_info(struct shash *);
406 /* CFM status query. */
407 struct ofproto_cfm_status {
408 /* 0 if not faulted, otherwise a combination of one or more reasons. */
409 enum cfm_fault_reason faults;
411 /* 0 if the remote CFM endpoint is operationally down,
412 * 1 if the remote CFM endpoint is operationally up,
413 * -1 if we don't know because the remote CFM endpoint is not in extended
419 /* Ordinarily a "health status" in the range 0...100 inclusive, with 0
420 * being worst and 100 being best, or -1 if the health status is not
424 /* MPIDs of remote maintenance points whose CCMs have been received. */
429 bool ofproto_port_get_cfm_status(const struct ofproto *,
431 struct ofproto_cfm_status *);
433 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
435 * This is deprecated. It is only for compatibility with broken device drivers
436 * in old versions of Linux that do not properly support VLANs when VLAN
437 * devices are not used. When broken device drivers are no longer in
438 * widespread use, we will delete these interfaces. */
440 void ofproto_get_vlan_usage(struct ofproto *, unsigned long int *vlan_bitmap);
441 bool ofproto_has_vlan_usage_changed(const struct ofproto *);
442 int ofproto_port_set_realdev(struct ofproto *, ofp_port_t vlandev_ofp_port,
443 ofp_port_t realdev_ofp_port, int vid);
449 #endif /* ofproto.h */