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>
26 #include "classifier.h"
28 #include "meta-flow.h"
48 struct ofproto_controller_info {
50 enum ofp12_controller_role role;
53 const char *values[4];
58 struct ofproto_sflow_options {
60 uint32_t sampling_rate;
61 uint32_t polling_interval;
68 struct ofproto_ipfix_bridge_exporter_options {
70 uint32_t sampling_rate;
71 uint32_t obs_domain_id; /* Bridge-wide Observation Domain ID. */
72 uint32_t obs_point_id; /* Bridge-wide Observation Point ID. */
73 uint32_t cache_active_timeout;
74 uint32_t cache_max_flows;
77 struct ofproto_ipfix_flow_exporter_options {
78 uint32_t collector_set_id;
80 uint32_t cache_active_timeout;
81 uint32_t cache_max_flows;
84 struct ofproto_stp_settings {
85 stp_identifier system_id;
92 struct ofproto_stp_status {
93 bool enabled; /* If false, ignore other members. */
94 stp_identifier bridge_id;
95 stp_identifier designated_root;
99 struct ofproto_port_stp_settings {
101 uint8_t port_num; /* In the range 1-255, inclusive. */
106 struct ofproto_port_stp_status {
107 bool enabled; /* If false, ignore other members. */
109 enum stp_state state;
110 unsigned int sec_in_state;
114 struct ofproto_port_stp_stats {
115 bool enabled; /* If false, ignore other members. */
116 int tx_count; /* Number of BPDUs transmitted. */
117 int rx_count; /* Number of valid BPDUs received. */
118 int error_count; /* Number of bad BPDUs received. */
121 struct ofproto_port_queue {
122 uint32_t queue; /* Queue ID. */
123 uint8_t dscp; /* DSCP bits (e.g. [0, 63]). */
126 /* How the switch should act if the controller cannot be contacted. */
127 enum ofproto_fail_mode {
128 OFPROTO_FAIL_SECURE, /* Preserve flow table. */
129 OFPROTO_FAIL_STANDALONE /* Act as a standalone switch. */
133 OFPROTO_IN_BAND, /* In-band connection to controller. */
134 OFPROTO_OUT_OF_BAND /* Out-of-band connection to controller. */
137 struct ofproto_controller {
138 char *target; /* e.g. "tcp:127.0.0.1" */
139 int max_backoff; /* Maximum reconnection backoff, in seconds. */
140 int probe_interval; /* Max idle time before probing, in seconds. */
141 enum ofproto_band band; /* In-band or out-of-band? */
142 bool enable_async_msgs; /* Initially enable asynchronous messages? */
144 /* OpenFlow packet-in rate-limiting. */
145 int rate_limit; /* Max packet-in rate in packets per second. */
146 int burst_limit; /* Limit on accumulating packet credits. */
148 uint8_t dscp; /* DSCP value for controller connection. */
151 void ofproto_enumerate_types(struct sset *types);
152 const char *ofproto_normalize_type(const char *);
154 int ofproto_enumerate_names(const char *type, struct sset *names);
155 void ofproto_parse_name(const char *name, char **dp_name, char **dp_type);
157 /* An interface hint element, which is used by ofproto_init() to
158 * describe the caller's understanding of the startup state. */
160 char *br_name; /* Name of owning bridge. */
161 char *br_type; /* Type of owning bridge. */
162 ofp_port_t ofp_port; /* OpenFlow port number. */
165 void ofproto_init(const struct shash *iface_hints);
167 int ofproto_type_run(const char *datapath_type);
168 int ofproto_type_run_fast(const char *datapath_type);
169 void ofproto_type_wait(const char *datapath_type);
171 int ofproto_create(const char *datapath, const char *datapath_type,
172 struct ofproto **ofprotop);
173 void ofproto_destroy(struct ofproto *);
174 int ofproto_delete(const char *name, const char *type);
176 int ofproto_run(struct ofproto *);
177 int ofproto_run_fast(struct ofproto *);
178 void ofproto_wait(struct ofproto *);
179 bool ofproto_is_alive(const struct ofproto *);
181 void ofproto_get_memory_usage(const struct ofproto *, struct simap *);
183 /* A port within an OpenFlow switch.
185 * 'name' and 'type' are suitable for passing to netdev_open(). */
186 struct ofproto_port {
187 char *name; /* Network device name, e.g. "eth0". */
188 char *type; /* Network device type, e.g. "system". */
189 ofp_port_t ofp_port; /* OpenFlow port number. */
191 void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *);
192 void ofproto_port_destroy(struct ofproto_port *);
194 struct ofproto_port_dump {
195 const struct ofproto *ofproto;
199 void ofproto_port_dump_start(struct ofproto_port_dump *,
200 const struct ofproto *);
201 bool ofproto_port_dump_next(struct ofproto_port_dump *, struct ofproto_port *);
202 int ofproto_port_dump_done(struct ofproto_port_dump *);
204 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
206 * Arguments all have pointer type.
208 * If you break out of the loop, then you need to free the dump structure by
209 * hand using ofproto_port_dump_done(). */
210 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO) \
211 for (ofproto_port_dump_start(DUMP, OFPROTO); \
212 (ofproto_port_dump_next(DUMP, OFPROTO_PORT) \
214 : (ofproto_port_dump_done(DUMP), false)); \
217 #define OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT 2500
218 #define OFPROTO_FLOW_EVICTION_THRESHOLD_MIN 100
220 /* How flow misses should be handled in ofproto-dpif */
221 enum ofproto_flow_miss_model {
222 OFPROTO_HANDLE_MISS_AUTO, /* Based on flow eviction threshold. */
223 OFPROTO_HANDLE_MISS_WITH_FACETS, /* Always create facets. */
224 OFPROTO_HANDLE_MISS_WITHOUT_FACETS /* Always handle without facets.*/
227 const char *ofproto_port_open_type(const char *datapath_type,
228 const char *port_type);
229 int ofproto_port_add(struct ofproto *, struct netdev *, ofp_port_t *ofp_portp);
230 int ofproto_port_del(struct ofproto *, ofp_port_t ofp_port);
231 int ofproto_port_get_stats(const struct ofport *, struct netdev_stats *stats);
233 int ofproto_port_query_by_name(const struct ofproto *, const char *devname,
234 struct ofproto_port *);
236 /* Top-level configuration. */
237 uint64_t ofproto_get_datapath_id(const struct ofproto *);
238 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
239 void ofproto_set_controllers(struct ofproto *,
240 const struct ofproto_controller *, size_t n,
241 uint32_t allowed_versions);
242 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
243 void ofproto_reconnect_controllers(struct ofproto *);
244 void ofproto_set_extra_in_band_remotes(struct ofproto *,
245 const struct sockaddr_in *, size_t n);
246 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
247 void ofproto_set_flow_eviction_threshold(unsigned threshold);
248 void ofproto_set_flow_miss_model(unsigned model);
249 void ofproto_set_forward_bpdu(struct ofproto *, bool forward_bpdu);
250 void ofproto_set_mac_table_config(struct ofproto *, unsigned idle_time,
252 void ofproto_set_n_handler_threads(unsigned limit);
253 void ofproto_set_dp_desc(struct ofproto *, const char *dp_desc);
254 int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
255 int ofproto_set_netflow(struct ofproto *,
256 const struct netflow_options *nf_options);
257 int ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
258 int ofproto_set_ipfix(struct ofproto *,
259 const struct ofproto_ipfix_bridge_exporter_options *,
260 const struct ofproto_ipfix_flow_exporter_options *,
262 void ofproto_set_flow_restore_wait(bool flow_restore_wait_db);
263 bool ofproto_get_flow_restore_wait(void);
264 int ofproto_set_stp(struct ofproto *, const struct ofproto_stp_settings *);
265 int ofproto_get_stp_status(struct ofproto *, struct ofproto_stp_status *);
267 /* Configuration of ports. */
268 void ofproto_port_unregister(struct ofproto *, ofp_port_t ofp_port);
270 void ofproto_port_clear_cfm(struct ofproto *, ofp_port_t ofp_port);
271 void ofproto_port_set_cfm(struct ofproto *, ofp_port_t ofp_port,
272 const struct cfm_settings *);
273 void ofproto_port_set_bfd(struct ofproto *, ofp_port_t ofp_port,
274 const struct smap *cfg);
275 int ofproto_port_get_bfd_status(struct ofproto *, ofp_port_t ofp_port,
277 int ofproto_port_is_lacp_current(struct ofproto *, ofp_port_t ofp_port);
278 int ofproto_port_set_stp(struct ofproto *, ofp_port_t ofp_port,
279 const struct ofproto_port_stp_settings *);
280 int ofproto_port_get_stp_status(struct ofproto *, ofp_port_t ofp_port,
281 struct ofproto_port_stp_status *);
282 int ofproto_port_get_stp_stats(struct ofproto *, ofp_port_t ofp_port,
283 struct ofproto_port_stp_stats *);
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 * Fields for which prefix trie lookup is maintained.
388 unsigned int n_prefix_fields;
389 enum mf_field_id prefix_fields[CLS_MAX_TRIES];
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 */