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>
40 struct ofproto_controller_info
{
45 const char *values
[4];
52 uint64_t packet_count
; /* Packets from subrules. */
53 uint64_t byte_count
; /* Bytes from subrules. */
54 long long int used
; /* Last-used time (0 if never used). */
57 struct ofproto_sflow_options
{
59 uint32_t sampling_rate
;
60 uint32_t polling_interval
;
67 /* How the switch should act if the controller cannot be contacted. */
68 enum ofproto_fail_mode
{
69 OFPROTO_FAIL_SECURE
, /* Preserve flow table. */
70 OFPROTO_FAIL_STANDALONE
/* Act as a standalone switch. */
74 OFPROTO_IN_BAND
, /* In-band connection to controller. */
75 OFPROTO_OUT_OF_BAND
/* Out-of-band connection to controller. */
78 struct ofproto_controller
{
79 char *target
; /* e.g. "tcp:127.0.0.1" */
80 int max_backoff
; /* Maximum reconnection backoff, in seconds. */
81 int probe_interval
; /* Max idle time before probing, in seconds. */
82 enum ofproto_band band
; /* In-band or out-of-band? */
84 /* OpenFlow packet-in rate-limiting. */
85 int rate_limit
; /* Max packet-in rate in packets per second. */
86 int burst_limit
; /* Limit on accumulating packet credits. */
89 #define DEFAULT_MFR_DESC "Nicira Networks, Inc."
90 #define DEFAULT_HW_DESC "Open vSwitch"
91 #define DEFAULT_SW_DESC VERSION BUILDNR
92 #define DEFAULT_SERIAL_DESC "None"
93 #define DEFAULT_DP_DESC "None"
95 void ofproto_enumerate_types(struct sset
*types
);
96 const char *ofproto_normalize_type(const char *);
98 int ofproto_enumerate_names(const char *type
, struct sset
*names
);
99 void ofproto_parse_name(const char *name
, char **dp_name
, char **dp_type
);
101 int ofproto_create(const char *datapath
, const char *datapath_type
,
102 struct ofproto
**ofprotop
);
103 void ofproto_destroy(struct ofproto
*);
104 int ofproto_delete(const char *name
, const char *type
);
106 int ofproto_run(struct ofproto
*);
107 void ofproto_wait(struct ofproto
*);
108 bool ofproto_is_alive(const struct ofproto
*);
110 /* A port within an OpenFlow switch.
112 * 'name' and 'type' are suitable for passing to netdev_open(). */
113 struct ofproto_port
{
114 char *name
; /* Network device name, e.g. "eth0". */
115 char *type
; /* Network device type, e.g. "system". */
116 uint16_t ofp_port
; /* OpenFlow port number. */
118 void ofproto_port_clone(struct ofproto_port
*, const struct ofproto_port
*);
119 void ofproto_port_destroy(struct ofproto_port
*);
121 struct ofproto_port_dump
{
122 const struct ofproto
*ofproto
;
126 void ofproto_port_dump_start(struct ofproto_port_dump
*,
127 const struct ofproto
*);
128 bool ofproto_port_dump_next(struct ofproto_port_dump
*, struct ofproto_port
*);
129 int ofproto_port_dump_done(struct ofproto_port_dump
*);
131 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
133 * Arguments all have pointer type.
135 * If you break out of the loop, then you need to free the dump structure by
136 * hand using ofproto_port_dump_done(). */
137 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO) \
138 for (ofproto_port_dump_start(DUMP, OFPROTO); \
139 (ofproto_port_dump_next(DUMP, OFPROTO_PORT) \
141 : (ofproto_port_dump_done(DUMP), false)); \
144 #define OFPROTO_FLOW_EVICTON_THRESHOLD_DEFAULT 1000
145 #define OFPROTO_FLOW_EVICTION_THRESHOLD_MIN 100
147 int ofproto_port_add(struct ofproto
*, struct netdev
*, uint16_t *ofp_portp
);
148 int ofproto_port_del(struct ofproto
*, uint16_t ofp_port
);
150 int ofproto_port_query_by_name(const struct ofproto
*, const char *devname
,
151 struct ofproto_port
*);
153 /* Top-level configuration. */
154 void ofproto_set_datapath_id(struct ofproto
*, uint64_t datapath_id
);
155 void ofproto_set_controllers(struct ofproto
*,
156 const struct ofproto_controller
*, size_t n
);
157 void ofproto_set_fail_mode(struct ofproto
*, enum ofproto_fail_mode fail_mode
);
158 void ofproto_reconnect_controllers(struct ofproto
*);
159 void ofproto_set_extra_in_band_remotes(struct ofproto
*,
160 const struct sockaddr_in
*, size_t n
);
161 void ofproto_set_in_band_queue(struct ofproto
*, int queue_id
);
162 void ofproto_set_flow_eviction_threshold(struct ofproto
*, unsigned threshold
);
163 void ofproto_set_forward_bpdu(struct ofproto
*, bool forward_bpdu
);
164 void ofproto_set_desc(struct ofproto
*,
165 const char *mfr_desc
, const char *hw_desc
,
166 const char *sw_desc
, const char *serial_desc
,
167 const char *dp_desc
);
168 int ofproto_set_snoops(struct ofproto
*, const struct sset
*snoops
);
169 int ofproto_set_netflow(struct ofproto
*,
170 const struct netflow_options
*nf_options
);
171 int ofproto_set_sflow(struct ofproto
*, const struct ofproto_sflow_options
*);
173 /* Configuration of ports. */
175 void ofproto_port_unregister(struct ofproto
*, uint16_t ofp_port
);
177 void ofproto_port_clear_cfm(struct ofproto
*, uint16_t ofp_port
);
178 void ofproto_port_set_cfm(struct ofproto
*, uint16_t ofp_port
,
179 const struct cfm_settings
*);
180 int ofproto_port_is_lacp_current(struct ofproto
*, uint16_t ofp_port
);
182 /* Configuration of bundles. */
183 struct ofproto_bundle_settings
{
184 char *name
; /* For use in log messages. */
186 uint16_t *slaves
; /* OpenFlow port numbers for slaves. */
189 int vlan
; /* VLAN if access port, -1 if trunk port. */
190 unsigned long *trunks
; /* vlan_bitmap, NULL to trunk all VLANs. */
192 struct bond_settings
*bond
; /* Must be nonnull iff if n_slaves > 1. */
193 uint32_t *bond_stable_ids
; /* Array of n_slaves elements. */
195 struct lacp_settings
*lacp
; /* Nonnull to enable LACP. */
196 struct lacp_slave_settings
*lacp_slaves
; /* Array of n_slaves elements. */
199 int ofproto_bundle_register(struct ofproto
*, void *aux
,
200 const struct ofproto_bundle_settings
*);
201 int ofproto_bundle_unregister(struct ofproto
*, void *aux
);
203 /* Configuration of mirrors. */
204 struct ofproto_mirror_settings
{
205 /* Name for log messages. */
208 /* Bundles that select packets for mirroring upon ingress. */
209 void **srcs
; /* A set of registered ofbundle handles. */
212 /* Bundles that select packets for mirroring upon egress. */
213 void **dsts
; /* A set of registered ofbundle handles. */
216 /* VLANs of packets to select for mirroring. */
217 unsigned long *src_vlans
; /* vlan_bitmap, NULL selects all VLANs. */
219 /* Output (mutually exclusive). */
220 void *out_bundle
; /* A registered ofbundle handle or NULL. */
221 uint16_t out_vlan
; /* Output VLAN, only if out_bundle is NULL. */
224 int ofproto_mirror_register(struct ofproto
*, void *aux
,
225 const struct ofproto_mirror_settings
*);
226 int ofproto_mirror_unregister(struct ofproto
*, void *aux
);
228 int ofproto_set_flood_vlans(struct ofproto
*, unsigned long *flood_vlans
);
229 bool ofproto_is_mirror_output_bundle(struct ofproto
*, void *aux
);
231 /* Configuration querying. */
232 bool ofproto_has_snoops(const struct ofproto
*);
233 void ofproto_get_snoops(const struct ofproto
*, struct sset
*);
234 void ofproto_get_all_flows(struct ofproto
*p
, struct ds
*);
235 void ofproto_get_netflow_ids(const struct ofproto
*,
236 uint8_t *engine_type
, uint8_t *engine_id
);
237 int ofproto_port_get_cfm_fault(const struct ofproto
*, uint16_t ofp_port
);
239 void ofproto_get_ofproto_controller_info(const struct ofproto
*, struct shash
*);
240 void ofproto_free_ofproto_controller_info(struct shash
*);
246 #endif /* ofproto.h */