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];
60 uint64_t packet_count; /* Packets from subrules. */
61 uint64_t byte_count; /* Bytes from subrules. */
62 long long int used; /* Last-used time (0 if never used). */
65 struct ofproto_sflow_options {
67 uint32_t sampling_rate;
68 uint32_t polling_interval;
76 struct ofproto_ipfix_bridge_exporter_options {
78 uint32_t sampling_rate;
79 uint32_t obs_domain_id; /* Bridge-wide Observation Domain ID. */
80 uint32_t obs_point_id; /* Bridge-wide Observation Point ID. */
81 uint32_t cache_active_timeout;
82 uint32_t cache_max_flows;
85 struct ofproto_ipfix_flow_exporter_options {
86 uint32_t collector_set_id;
88 uint32_t cache_active_timeout;
89 uint32_t cache_max_flows;
92 struct ofproto_stp_settings {
93 stp_identifier system_id;
100 struct ofproto_stp_status {
101 bool enabled; /* If false, ignore other members. */
102 stp_identifier bridge_id;
103 stp_identifier designated_root;
107 struct ofproto_port_stp_settings {
109 uint8_t port_num; /* In the range 1-255, inclusive. */
114 struct ofproto_port_stp_status {
115 bool enabled; /* If false, ignore other members. */
117 enum stp_state state;
118 unsigned int sec_in_state;
122 struct ofproto_port_stp_stats {
123 bool enabled; /* If false, ignore other members. */
124 int tx_count; /* Number of BPDUs transmitted. */
125 int rx_count; /* Number of valid BPDUs received. */
126 int error_count; /* Number of bad BPDUs received. */
129 struct ofproto_port_queue {
130 uint32_t queue; /* Queue ID. */
131 uint8_t dscp; /* DSCP bits (e.g. [0, 63]). */
134 /* How the switch should act if the controller cannot be contacted. */
135 enum ofproto_fail_mode {
136 OFPROTO_FAIL_SECURE, /* Preserve flow table. */
137 OFPROTO_FAIL_STANDALONE /* Act as a standalone switch. */
141 OFPROTO_IN_BAND, /* In-band connection to controller. */
142 OFPROTO_OUT_OF_BAND /* Out-of-band connection to controller. */
145 struct ofproto_controller {
146 char *target; /* e.g. "tcp:127.0.0.1" */
147 int max_backoff; /* Maximum reconnection backoff, in seconds. */
148 int probe_interval; /* Max idle time before probing, in seconds. */
149 enum ofproto_band band; /* In-band or out-of-band? */
150 bool enable_async_msgs; /* Initially enable asynchronous messages? */
152 /* OpenFlow packet-in rate-limiting. */
153 int rate_limit; /* Max packet-in rate in packets per second. */
154 int burst_limit; /* Limit on accumulating packet credits. */
156 uint8_t dscp; /* DSCP value for controller connection. */
159 void ofproto_enumerate_types(struct sset *types);
160 const char *ofproto_normalize_type(const char *);
162 int ofproto_enumerate_names(const char *type, struct sset *names);
163 void ofproto_parse_name(const char *name, char **dp_name, char **dp_type);
165 /* An interface hint element, which is used by ofproto_init() to
166 * describe the caller's understanding of the startup state. */
168 char *br_name; /* Name of owning bridge. */
169 char *br_type; /* Type of owning bridge. */
170 ofp_port_t ofp_port; /* OpenFlow port number. */
173 void ofproto_init(const struct shash *iface_hints);
175 int ofproto_type_run(const char *datapath_type);
176 int ofproto_type_run_fast(const char *datapath_type);
177 void ofproto_type_wait(const char *datapath_type);
179 int ofproto_create(const char *datapath, const char *datapath_type,
180 struct ofproto **ofprotop);
181 void ofproto_destroy(struct ofproto *);
182 int ofproto_delete(const char *name, const char *type);
184 int ofproto_run(struct ofproto *);
185 int ofproto_run_fast(struct ofproto *);
186 void ofproto_wait(struct ofproto *);
187 bool ofproto_is_alive(const struct ofproto *);
189 void ofproto_get_memory_usage(const struct ofproto *, struct simap *);
191 /* A port within an OpenFlow switch.
193 * 'name' and 'type' are suitable for passing to netdev_open(). */
194 struct ofproto_port {
195 char *name; /* Network device name, e.g. "eth0". */
196 char *type; /* Network device type, e.g. "system". */
197 ofp_port_t ofp_port; /* OpenFlow port number. */
199 void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *);
200 void ofproto_port_destroy(struct ofproto_port *);
202 struct ofproto_port_dump {
203 const struct ofproto *ofproto;
207 void ofproto_port_dump_start(struct ofproto_port_dump *,
208 const struct ofproto *);
209 bool ofproto_port_dump_next(struct ofproto_port_dump *, struct ofproto_port *);
210 int ofproto_port_dump_done(struct ofproto_port_dump *);
212 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
214 * Arguments all have pointer type.
216 * If you break out of the loop, then you need to free the dump structure by
217 * hand using ofproto_port_dump_done(). */
218 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO) \
219 for (ofproto_port_dump_start(DUMP, OFPROTO); \
220 (ofproto_port_dump_next(DUMP, OFPROTO_PORT) \
222 : (ofproto_port_dump_done(DUMP), false)); \
225 #define OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT 2500
226 #define OFPROTO_FLOW_EVICTION_THRESHOLD_MIN 100
228 /* How flow misses should be handled in ofproto-dpif */
229 enum ofproto_flow_miss_model {
230 OFPROTO_HANDLE_MISS_AUTO, /* Based on flow eviction threshold. */
231 OFPROTO_HANDLE_MISS_WITH_FACETS, /* Always create facets. */
232 OFPROTO_HANDLE_MISS_WITHOUT_FACETS /* Always handle without facets.*/
235 const char *ofproto_port_open_type(const char *datapath_type,
236 const char *port_type);
237 int ofproto_port_add(struct ofproto *, struct netdev *, ofp_port_t *ofp_portp);
238 int ofproto_port_del(struct ofproto *, ofp_port_t ofp_port);
239 int ofproto_port_get_stats(const struct ofport *, struct netdev_stats *stats);
241 int ofproto_port_query_by_name(const struct ofproto *, const char *devname,
242 struct ofproto_port *);
244 /* Top-level configuration. */
245 uint64_t ofproto_get_datapath_id(const struct ofproto *);
246 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
247 void ofproto_set_controllers(struct ofproto *,
248 const struct ofproto_controller *, size_t n,
249 uint32_t allowed_versions);
250 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
251 void ofproto_reconnect_controllers(struct ofproto *);
252 void ofproto_set_extra_in_band_remotes(struct ofproto *,
253 const struct sockaddr_in *, size_t n);
254 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
255 void ofproto_set_flow_eviction_threshold(unsigned threshold);
256 void ofproto_set_flow_miss_model(unsigned model);
257 void ofproto_set_forward_bpdu(struct ofproto *, bool forward_bpdu);
258 void ofproto_set_mac_table_config(struct ofproto *, unsigned idle_time,
260 void ofproto_set_n_handler_threads(unsigned limit);
261 void ofproto_set_dp_desc(struct ofproto *, const char *dp_desc);
262 int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
263 int ofproto_set_netflow(struct ofproto *,
264 const struct netflow_options *nf_options);
265 int ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
266 int ofproto_set_ipfix(struct ofproto *,
267 const struct ofproto_ipfix_bridge_exporter_options *,
268 const struct ofproto_ipfix_flow_exporter_options *,
270 void ofproto_set_flow_restore_wait(bool flow_restore_wait_db);
271 bool ofproto_get_flow_restore_wait(void);
272 int ofproto_set_stp(struct ofproto *, const struct ofproto_stp_settings *);
273 int ofproto_get_stp_status(struct ofproto *, struct ofproto_stp_status *);
275 /* Configuration of ports. */
276 void ofproto_port_unregister(struct ofproto *, ofp_port_t ofp_port);
278 void ofproto_port_clear_cfm(struct ofproto *, ofp_port_t ofp_port);
279 void ofproto_port_set_cfm(struct ofproto *, ofp_port_t ofp_port,
280 const struct cfm_settings *);
281 void ofproto_port_set_bfd(struct ofproto *, ofp_port_t ofp_port,
282 const struct smap *cfg);
283 int ofproto_port_get_bfd_status(struct ofproto *, ofp_port_t ofp_port,
285 int ofproto_port_is_lacp_current(struct ofproto *, ofp_port_t ofp_port);
286 int ofproto_port_set_stp(struct ofproto *, ofp_port_t ofp_port,
287 const struct ofproto_port_stp_settings *);
288 int ofproto_port_get_stp_status(struct ofproto *, ofp_port_t ofp_port,
289 struct ofproto_port_stp_status *);
290 int ofproto_port_get_stp_stats(struct ofproto *, ofp_port_t ofp_port,
291 struct ofproto_port_stp_stats *);
292 int ofproto_port_set_queues(struct ofproto *, ofp_port_t ofp_port,
293 const struct ofproto_port_queue *,
296 /* The behaviour of the port regarding VLAN handling */
297 enum port_vlan_mode {
298 /* This port is an access port. 'vlan' is the VLAN ID. 'trunks' is
302 /* This port is a trunk. 'trunks' is the set of trunks. 'vlan' is
306 /* Untagged incoming packets are part of 'vlan', as are incoming packets
307 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' stay tagged.
308 * Other VLANs in 'trunks' are trunked. */
309 PORT_VLAN_NATIVE_TAGGED,
311 /* Untagged incoming packets are part of 'vlan', as are incoming packets
312 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' are untagged.
313 * Other VLANs in 'trunks' are trunked. */
314 PORT_VLAN_NATIVE_UNTAGGED
317 /* Configuration of bundles. */
318 struct ofproto_bundle_settings {
319 char *name; /* For use in log messages. */
321 ofp_port_t *slaves; /* OpenFlow port numbers for slaves. */
324 enum port_vlan_mode vlan_mode; /* Selects mode for vlan and trunks */
325 int vlan; /* VLAN VID, except for PORT_VLAN_TRUNK. */
326 unsigned long *trunks; /* vlan_bitmap, except for PORT_VLAN_ACCESS. */
327 bool use_priority_tags; /* Use 802.1p tag for frames in VLAN 0? */
329 struct bond_settings *bond; /* Must be nonnull iff if n_slaves > 1. */
331 struct lacp_settings *lacp; /* Nonnull to enable LACP. */
332 struct lacp_slave_settings *lacp_slaves; /* Array of n_slaves elements. */
334 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
336 * This is deprecated. It is only for compatibility with broken device
337 * drivers in old versions of Linux that do not properly support VLANs when
338 * VLAN devices are not used. When broken device drivers are no longer in
339 * widespread use, we will delete these interfaces. */
340 ofp_port_t realdev_ofp_port;/* OpenFlow port number of real device. */
343 int ofproto_bundle_register(struct ofproto *, void *aux,
344 const struct ofproto_bundle_settings *);
345 int ofproto_bundle_unregister(struct ofproto *, void *aux);
347 /* Configuration of mirrors. */
348 struct ofproto_mirror_settings {
349 /* Name for log messages. */
352 /* Bundles that select packets for mirroring upon ingress. */
353 void **srcs; /* A set of registered ofbundle handles. */
356 /* Bundles that select packets for mirroring upon egress. */
357 void **dsts; /* A set of registered ofbundle handles. */
360 /* VLANs of packets to select for mirroring. */
361 unsigned long *src_vlans; /* vlan_bitmap, NULL selects all VLANs. */
363 /* Output (mutually exclusive). */
364 void *out_bundle; /* A registered ofbundle handle or NULL. */
365 uint16_t out_vlan; /* Output VLAN, only if out_bundle is NULL. */
368 int ofproto_mirror_register(struct ofproto *, void *aux,
369 const struct ofproto_mirror_settings *);
370 int ofproto_mirror_unregister(struct ofproto *, void *aux);
371 int ofproto_mirror_get_stats(struct ofproto *, void *aux,
372 uint64_t *packets, uint64_t *bytes);
374 int ofproto_set_flood_vlans(struct ofproto *, unsigned long *flood_vlans);
375 bool ofproto_is_mirror_output_bundle(const struct ofproto *, void *aux);
377 /* Configuration of OpenFlow tables. */
378 struct ofproto_table_settings {
379 char *name; /* Name exported via OpenFlow or NULL. */
380 unsigned int max_flows; /* Maximum number of flows or UINT_MAX. */
382 /* These members determine the handling of an attempt to add a flow that
383 * would cause the table to have more than 'max_flows' flows.
385 * If 'groups' is NULL, overflows will be rejected with an error.
387 * If 'groups' is nonnull, an overflow will cause a flow to be removed.
388 * The flow to be removed is chosen to give fairness among groups
389 * distinguished by different values for the subfields within 'groups'. */
390 struct mf_subfield *groups;
394 * Fields for which prefix trie lookup is maintained.
396 unsigned int n_prefix_fields;
397 enum mf_field_id prefix_fields[CLS_MAX_TRIES];
400 int ofproto_get_n_tables(const struct ofproto *);
401 void ofproto_configure_table(struct ofproto *, int table_id,
402 const struct ofproto_table_settings *);
404 /* Configuration querying. */
405 bool ofproto_has_snoops(const struct ofproto *);
406 void ofproto_get_snoops(const struct ofproto *, struct sset *);
407 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
408 void ofproto_get_netflow_ids(const struct ofproto *,
409 uint8_t *engine_type, uint8_t *engine_id);
411 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
412 void ofproto_free_ofproto_controller_info(struct shash *);
414 /* CFM status query. */
415 struct ofproto_cfm_status {
416 /* 0 if not faulted, otherwise a combination of one or more reasons. */
417 enum cfm_fault_reason faults;
419 /* 0 if the remote CFM endpoint is operationally down,
420 * 1 if the remote CFM endpoint is operationally up,
421 * -1 if we don't know because the remote CFM endpoint is not in extended
427 /* Ordinarily a "health status" in the range 0...100 inclusive, with 0
428 * being worst and 100 being best, or -1 if the health status is not
432 /* MPIDs of remote maintenance points whose CCMs have been received. */
437 bool ofproto_port_get_cfm_status(const struct ofproto *,
439 struct ofproto_cfm_status *);
441 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
443 * This is deprecated. It is only for compatibility with broken device drivers
444 * in old versions of Linux that do not properly support VLANs when VLAN
445 * devices are not used. When broken device drivers are no longer in
446 * widespread use, we will delete these interfaces. */
448 void ofproto_get_vlan_usage(struct ofproto *, unsigned long int *vlan_bitmap);
449 bool ofproto_has_vlan_usage_changed(const struct ofproto *);
450 int ofproto_port_set_realdev(struct ofproto *, ofp_port_t vlandev_ofp_port,
451 ofp_port_t realdev_ofp_port, int vid);
457 #endif /* ofproto.h */