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>
44 struct ofproto_controller_info {
46 enum ofp12_controller_role role;
49 const char *values[4];
56 uint64_t packet_count; /* Packets from subrules. */
57 uint64_t byte_count; /* Bytes from subrules. */
58 long long int used; /* Last-used time (0 if never used). */
61 struct ofproto_sflow_options {
63 uint32_t sampling_rate;
64 uint32_t polling_interval;
72 struct ofproto_ipfix_bridge_exporter_options {
74 uint32_t sampling_rate;
75 uint32_t obs_domain_id; /* Bridge-wide Observation Domain ID. */
76 uint32_t obs_point_id; /* Bridge-wide Observation Point ID. */
79 struct ofproto_ipfix_flow_exporter_options {
80 uint32_t collector_set_id;
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;
112 int tx_count; /* Number of BPDUs transmitted. */
113 int rx_count; /* Number of valid BPDUs received. */
114 int error_count; /* Number of bad BPDUs received. */
117 struct ofproto_port_queue {
118 uint32_t queue; /* Queue ID. */
119 uint8_t dscp; /* DSCP bits (e.g. [0, 63]). */
122 /* How the switch should act if the controller cannot be contacted. */
123 enum ofproto_fail_mode {
124 OFPROTO_FAIL_SECURE, /* Preserve flow table. */
125 OFPROTO_FAIL_STANDALONE /* Act as a standalone switch. */
129 OFPROTO_IN_BAND, /* In-band connection to controller. */
130 OFPROTO_OUT_OF_BAND /* Out-of-band connection to controller. */
133 struct ofproto_controller {
134 char *target; /* e.g. "tcp:127.0.0.1" */
135 int max_backoff; /* Maximum reconnection backoff, in seconds. */
136 int probe_interval; /* Max idle time before probing, in seconds. */
137 enum ofproto_band band; /* In-band or out-of-band? */
138 bool enable_async_msgs; /* Initially enable asynchronous messages? */
140 /* OpenFlow packet-in rate-limiting. */
141 int rate_limit; /* Max packet-in rate in packets per second. */
142 int burst_limit; /* Limit on accumulating packet credits. */
144 uint8_t dscp; /* DSCP value for controller connection. */
147 void ofproto_enumerate_types(struct sset *types);
148 const char *ofproto_normalize_type(const char *);
150 int ofproto_enumerate_names(const char *type, struct sset *names);
151 void ofproto_parse_name(const char *name, char **dp_name, char **dp_type);
153 /* An interface hint element, which is used by ofproto_init() to
154 * describe the caller's understanding of the startup state. */
156 char *br_name; /* Name of owning bridge. */
157 char *br_type; /* Type of owning bridge. */
158 uint16_t ofp_port; /* OpenFlow port number. */
161 void ofproto_init(const struct shash *iface_hints);
163 int ofproto_type_run(const char *datapath_type);
164 int ofproto_type_run_fast(const char *datapath_type);
165 void ofproto_type_wait(const char *datapath_type);
167 int ofproto_create(const char *datapath, const char *datapath_type,
168 struct ofproto **ofprotop);
169 void ofproto_destroy(struct ofproto *);
170 int ofproto_delete(const char *name, const char *type);
172 int ofproto_run(struct ofproto *);
173 int ofproto_run_fast(struct ofproto *);
174 void ofproto_wait(struct ofproto *);
175 bool ofproto_is_alive(const struct ofproto *);
177 void ofproto_get_memory_usage(const struct ofproto *, struct simap *);
179 /* A port within an OpenFlow switch.
181 * 'name' and 'type' are suitable for passing to netdev_open(). */
182 struct ofproto_port {
183 char *name; /* Network device name, e.g. "eth0". */
184 char *type; /* Network device type, e.g. "system". */
185 uint16_t ofp_port; /* OpenFlow port number. */
187 void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *);
188 void ofproto_port_destroy(struct ofproto_port *);
190 struct ofproto_port_dump {
191 const struct ofproto *ofproto;
195 void ofproto_port_dump_start(struct ofproto_port_dump *,
196 const struct ofproto *);
197 bool ofproto_port_dump_next(struct ofproto_port_dump *, struct ofproto_port *);
198 int ofproto_port_dump_done(struct ofproto_port_dump *);
200 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
202 * Arguments all have pointer type.
204 * If you break out of the loop, then you need to free the dump structure by
205 * hand using ofproto_port_dump_done(). */
206 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO) \
207 for (ofproto_port_dump_start(DUMP, OFPROTO); \
208 (ofproto_port_dump_next(DUMP, OFPROTO_PORT) \
210 : (ofproto_port_dump_done(DUMP), false)); \
213 #define OFPROTO_FLOW_EVICTION_THRESHOLD_DEFAULT 2500
214 #define OFPROTO_FLOW_EVICTION_THRESHOLD_MIN 100
216 const char *ofproto_port_open_type(const char *datapath_type,
217 const char *port_type);
218 int ofproto_port_add(struct ofproto *, struct netdev *, uint16_t *ofp_portp);
219 int ofproto_port_del(struct ofproto *, uint16_t ofp_port);
220 int ofproto_port_get_stats(const struct ofport *, struct netdev_stats *stats);
222 int ofproto_port_query_by_name(const struct ofproto *, const char *devname,
223 struct ofproto_port *);
225 /* Top-level configuration. */
226 uint64_t ofproto_get_datapath_id(const struct ofproto *);
227 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
228 void ofproto_set_controllers(struct ofproto *,
229 const struct ofproto_controller *, size_t n,
230 uint32_t allowed_versions);
231 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
232 void ofproto_reconnect_controllers(struct ofproto *);
233 void ofproto_set_extra_in_band_remotes(struct ofproto *,
234 const struct sockaddr_in *, size_t n);
235 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
236 void ofproto_set_flow_eviction_threshold(struct ofproto *, unsigned threshold);
237 void ofproto_set_forward_bpdu(struct ofproto *, bool forward_bpdu);
238 void ofproto_set_mac_table_config(struct ofproto *, unsigned idle_time,
240 void ofproto_set_dp_desc(struct ofproto *, const char *dp_desc);
241 int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
242 int ofproto_set_netflow(struct ofproto *,
243 const struct netflow_options *nf_options);
244 int ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
245 int ofproto_set_ipfix(struct ofproto *,
246 const struct ofproto_ipfix_bridge_exporter_options *,
247 const struct ofproto_ipfix_flow_exporter_options *,
249 int ofproto_set_stp(struct ofproto *, const struct ofproto_stp_settings *);
250 int ofproto_get_stp_status(struct ofproto *, struct ofproto_stp_status *);
252 /* Configuration of ports. */
253 void ofproto_port_unregister(struct ofproto *, uint16_t ofp_port);
255 void ofproto_port_clear_cfm(struct ofproto *, uint16_t ofp_port);
256 void ofproto_port_set_cfm(struct ofproto *, uint16_t ofp_port,
257 const struct cfm_settings *);
258 int ofproto_port_is_lacp_current(struct ofproto *, uint16_t ofp_port);
259 int ofproto_port_set_stp(struct ofproto *, uint16_t ofp_port,
260 const struct ofproto_port_stp_settings *);
261 int ofproto_port_get_stp_status(struct ofproto *, uint16_t ofp_port,
262 struct ofproto_port_stp_status *);
263 int ofproto_port_set_queues(struct ofproto *, uint16_t ofp_port,
264 const struct ofproto_port_queue *,
267 /* The behaviour of the port regarding VLAN handling */
268 enum port_vlan_mode {
269 /* This port is an access port. 'vlan' is the VLAN ID. 'trunks' is
273 /* This port is a trunk. 'trunks' is the set of trunks. 'vlan' is
277 /* Untagged incoming packets are part of 'vlan', as are incoming packets
278 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' stay tagged.
279 * Other VLANs in 'trunks' are trunked. */
280 PORT_VLAN_NATIVE_TAGGED,
282 /* Untagged incoming packets are part of 'vlan', as are incoming packets
283 * tagged with 'vlan'. Outgoing packets tagged with 'vlan' are untagged.
284 * Other VLANs in 'trunks' are trunked. */
285 PORT_VLAN_NATIVE_UNTAGGED
288 /* Configuration of bundles. */
289 struct ofproto_bundle_settings {
290 char *name; /* For use in log messages. */
292 uint16_t *slaves; /* OpenFlow port numbers for slaves. */
295 enum port_vlan_mode vlan_mode; /* Selects mode for vlan and trunks */
296 int vlan; /* VLAN VID, except for PORT_VLAN_TRUNK. */
297 unsigned long *trunks; /* vlan_bitmap, except for PORT_VLAN_ACCESS. */
298 bool use_priority_tags; /* Use 802.1p tag for frames in VLAN 0? */
300 struct bond_settings *bond; /* Must be nonnull iff if n_slaves > 1. */
302 struct lacp_settings *lacp; /* Nonnull to enable LACP. */
303 struct lacp_slave_settings *lacp_slaves; /* Array of n_slaves elements. */
305 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
307 * This is deprecated. It is only for compatibility with broken device
308 * drivers in old versions of Linux that do not properly support VLANs when
309 * VLAN devices are not used. When broken device drivers are no longer in
310 * widespread use, we will delete these interfaces. */
311 uint16_t realdev_ofp_port; /* OpenFlow port number of real device. */
314 int ofproto_bundle_register(struct ofproto *, void *aux,
315 const struct ofproto_bundle_settings *);
316 int ofproto_bundle_unregister(struct ofproto *, void *aux);
318 /* Configuration of mirrors. */
319 struct ofproto_mirror_settings {
320 /* Name for log messages. */
323 /* Bundles that select packets for mirroring upon ingress. */
324 void **srcs; /* A set of registered ofbundle handles. */
327 /* Bundles that select packets for mirroring upon egress. */
328 void **dsts; /* A set of registered ofbundle handles. */
331 /* VLANs of packets to select for mirroring. */
332 unsigned long *src_vlans; /* vlan_bitmap, NULL selects all VLANs. */
334 /* Output (mutually exclusive). */
335 void *out_bundle; /* A registered ofbundle handle or NULL. */
336 uint16_t out_vlan; /* Output VLAN, only if out_bundle is NULL. */
339 int ofproto_mirror_register(struct ofproto *, void *aux,
340 const struct ofproto_mirror_settings *);
341 int ofproto_mirror_unregister(struct ofproto *, void *aux);
342 int ofproto_mirror_get_stats(struct ofproto *, void *aux,
343 uint64_t *packets, uint64_t *bytes);
345 int ofproto_set_flood_vlans(struct ofproto *, unsigned long *flood_vlans);
346 bool ofproto_is_mirror_output_bundle(const struct ofproto *, void *aux);
348 /* Configuration of OpenFlow tables. */
349 struct ofproto_table_settings {
350 char *name; /* Name exported via OpenFlow or NULL. */
351 unsigned int max_flows; /* Maximum number of flows or UINT_MAX. */
353 /* These members determine the handling of an attempt to add a flow that
354 * would cause the table to have more than 'max_flows' flows.
356 * If 'groups' is NULL, overflows will be rejected with an error.
358 * If 'groups' is nonnull, an overflow will cause a flow to be removed.
359 * The flow to be removed is chosen to give fairness among groups
360 * distinguished by different values for the subfields within 'groups'. */
361 struct mf_subfield *groups;
365 int ofproto_get_n_tables(const struct ofproto *);
366 void ofproto_configure_table(struct ofproto *, int table_id,
367 const struct ofproto_table_settings *);
369 /* Configuration querying. */
370 bool ofproto_has_snoops(const struct ofproto *);
371 void ofproto_get_snoops(const struct ofproto *, struct sset *);
372 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
373 void ofproto_get_netflow_ids(const struct ofproto *,
374 uint8_t *engine_type, uint8_t *engine_id);
376 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
377 void ofproto_free_ofproto_controller_info(struct shash *);
379 /* CFM status query. */
380 struct ofproto_cfm_status {
381 /* 0 if not faulted, otherwise a combination of one or more reasons. */
382 enum cfm_fault_reason faults;
384 /* 0 if the remote CFM endpoint is operationally down,
385 * 1 if the remote CFM endpoint is operationally up,
386 * -1 if we don't know because the remote CFM endpoint is not in extended
390 /* Ordinarily a "health status" in the range 0...100 inclusive, with 0
391 * being worst and 100 being best, or -1 if the health status is not
395 /* MPIDs of remote maintenance points whose CCMs have been received. */
396 const uint64_t *rmps;
400 bool ofproto_port_get_cfm_status(const struct ofproto *, uint16_t ofp_port,
401 struct ofproto_cfm_status *);
403 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
405 * This is deprecated. It is only for compatibility with broken device drivers
406 * in old versions of Linux that do not properly support VLANs when VLAN
407 * devices are not used. When broken device drivers are no longer in
408 * widespread use, we will delete these interfaces. */
410 void ofproto_get_vlan_usage(struct ofproto *, unsigned long int *vlan_bitmap);
411 bool ofproto_has_vlan_usage_changed(const struct ofproto *);
412 int ofproto_port_set_realdev(struct ofproto *, uint16_t vlandev_ofp_port,
413 uint16_t realdev_ofp_port, int vid);
419 #endif /* ofproto.h */