4b37bd78ffc7a732e0eec6e74d991e57fac4714f
[openvswitch] / ofproto.h
1 /*
2  * Copyright (c) 2009, 2010, 2011 Nicira Networks.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #ifndef OFPROTO_H
18 #define OFPROTO_H 1
19
20 #include <sys/types.h>
21 #include <netinet/in.h>
22 #include <stdbool.h>
23 #include <stddef.h>
24 #include <stdint.h>
25 #include "cfm.h"
26 #include "flow.h"
27 #include "netflow.h"
28 #include "sset.h"
29 #include "stp.h"
30 #include "tag.h"
31
32 #ifdef  __cplusplus
33 extern "C" {
34 #endif
35
36 struct cfm_settings;
37 struct cls_rule;
38 struct netdev;
39 struct ofproto;
40 struct shash;
41
42 struct ofproto_controller_info {
43     bool is_connected;
44     enum nx_role role;
45     struct {
46         const char *keys[4];
47         const char *values[4];
48         size_t n;
49     } pairs;
50 };
51
52 struct ofexpired {
53     struct flow flow;
54     uint64_t packet_count;      /* Packets from subrules. */
55     uint64_t byte_count;        /* Bytes from subrules. */
56     long long int used;         /* Last-used time (0 if never used). */
57 };
58
59 struct ofproto_sflow_options {
60     struct sset targets;
61     uint32_t sampling_rate;
62     uint32_t polling_interval;
63     uint32_t header_len;
64     uint32_t sub_id;
65     char *agent_device;
66     char *control_ip;
67 };
68
69 struct ofproto_stp_settings {
70     stp_identifier system_id;
71     uint16_t priority;
72     uint16_t hello_time;
73     uint16_t max_age;
74     uint16_t fwd_delay;
75 };
76
77 struct ofproto_stp_status {
78     bool enabled;               /* If false, ignore other members. */
79     stp_identifier bridge_id;
80     stp_identifier designated_root;
81     int root_path_cost;
82 };
83
84 struct ofproto_port_stp_settings {
85     bool enable;
86     uint8_t port_num;           /* In the range 1-255, inclusive. */
87     uint8_t priority;
88     uint16_t path_cost;
89 };
90
91 struct ofproto_port_stp_status {
92     bool enabled;               /* If false, ignore other members. */
93     int port_id;
94     enum stp_state state;
95     unsigned int sec_in_state;
96     enum stp_role role;
97 };
98
99 /* How the switch should act if the controller cannot be contacted. */
100 enum ofproto_fail_mode {
101     OFPROTO_FAIL_SECURE,        /* Preserve flow table. */
102     OFPROTO_FAIL_STANDALONE     /* Act as a standalone switch. */
103 };
104
105 enum ofproto_band {
106     OFPROTO_IN_BAND,            /* In-band connection to controller. */
107     OFPROTO_OUT_OF_BAND         /* Out-of-band connection to controller. */
108 };
109
110 struct ofproto_controller {
111     char *target;               /* e.g. "tcp:127.0.0.1" */
112     int max_backoff;            /* Maximum reconnection backoff, in seconds. */
113     int probe_interval;         /* Max idle time before probing, in seconds. */
114     enum ofproto_band band;      /* In-band or out-of-band? */
115
116     /* OpenFlow packet-in rate-limiting. */
117     int rate_limit;             /* Max packet-in rate in packets per second. */
118     int burst_limit;            /* Limit on accumulating packet credits. */
119 };
120
121 #define DEFAULT_MFR_DESC "Nicira Networks, Inc."
122 #define DEFAULT_HW_DESC "Open vSwitch"
123 #define DEFAULT_SW_DESC VERSION BUILDNR
124 #define DEFAULT_SERIAL_DESC "None"
125 #define DEFAULT_DP_DESC "None"
126
127 void ofproto_enumerate_types(struct sset *types);
128 const char *ofproto_normalize_type(const char *);
129
130 int ofproto_enumerate_names(const char *type, struct sset *names);
131 void ofproto_parse_name(const char *name, char **dp_name, char **dp_type);
132
133 int ofproto_create(const char *datapath, const char *datapath_type,
134                    struct ofproto **ofprotop);
135 void ofproto_destroy(struct ofproto *);
136 int ofproto_delete(const char *name, const char *type);
137
138 int ofproto_run(struct ofproto *);
139 void ofproto_wait(struct ofproto *);
140 bool ofproto_is_alive(const struct ofproto *);
141
142 /* A port within an OpenFlow switch.
143  *
144  * 'name' and 'type' are suitable for passing to netdev_open(). */
145 struct ofproto_port {
146     char *name;                 /* Network device name, e.g. "eth0". */
147     char *type;                 /* Network device type, e.g. "system". */
148     uint16_t ofp_port;          /* OpenFlow port number. */
149 };
150 void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *);
151 void ofproto_port_destroy(struct ofproto_port *);
152
153 struct ofproto_port_dump {
154     const struct ofproto *ofproto;
155     int error;
156     void *state;
157 };
158 void ofproto_port_dump_start(struct ofproto_port_dump *,
159                              const struct ofproto *);
160 bool ofproto_port_dump_next(struct ofproto_port_dump *, struct ofproto_port *);
161 int ofproto_port_dump_done(struct ofproto_port_dump *);
162
163 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
164  *
165  * Arguments all have pointer type.
166  *
167  * If you break out of the loop, then you need to free the dump structure by
168  * hand using ofproto_port_dump_done(). */
169 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO)  \
170     for (ofproto_port_dump_start(DUMP, OFPROTO);            \
171          (ofproto_port_dump_next(DUMP, OFPROTO_PORT)        \
172           ? true                                            \
173           : (ofproto_port_dump_done(DUMP), false));         \
174         )
175
176 #define OFPROTO_FLOW_EVICTON_THRESHOLD_DEFAULT  1000
177 #define OFPROTO_FLOW_EVICTION_THRESHOLD_MIN     100
178
179 int ofproto_port_add(struct ofproto *, struct netdev *, uint16_t *ofp_portp);
180 int ofproto_port_del(struct ofproto *, uint16_t ofp_port);
181
182 int ofproto_port_query_by_name(const struct ofproto *, const char *devname,
183                                struct ofproto_port *);
184
185 /* Top-level configuration. */
186 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
187 void ofproto_set_controllers(struct ofproto *,
188                              const struct ofproto_controller *, size_t n);
189 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
190 void ofproto_reconnect_controllers(struct ofproto *);
191 void ofproto_set_extra_in_band_remotes(struct ofproto *,
192                                        const struct sockaddr_in *, size_t n);
193 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
194 void ofproto_set_flow_eviction_threshold(struct ofproto *, unsigned threshold);
195 void ofproto_set_forward_bpdu(struct ofproto *, bool forward_bpdu);
196 void ofproto_set_desc(struct ofproto *,
197                       const char *mfr_desc, const char *hw_desc,
198                       const char *sw_desc, const char *serial_desc,
199                       const char *dp_desc);
200 int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
201 int ofproto_set_netflow(struct ofproto *,
202                         const struct netflow_options *nf_options);
203 int ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
204 int ofproto_set_stp(struct ofproto *, const struct ofproto_stp_settings *);
205 int ofproto_get_stp_status(struct ofproto *, struct ofproto_stp_status *);
206
207 /* Configuration of ports. */
208
209 void ofproto_port_unregister(struct ofproto *, uint16_t ofp_port);
210
211 void ofproto_port_clear_cfm(struct ofproto *, uint16_t ofp_port);
212 void ofproto_port_set_cfm(struct ofproto *, uint16_t ofp_port,
213                           const struct cfm_settings *);
214 int ofproto_port_is_lacp_current(struct ofproto *, uint16_t ofp_port);
215 int ofproto_port_set_stp(struct ofproto *, uint16_t ofp_port,
216                          const struct ofproto_port_stp_settings *);
217 int ofproto_port_get_stp_status(struct ofproto *, uint16_t ofp_port,
218                                 struct ofproto_port_stp_status *);
219
220 /* The behaviour of the port regarding VLAN handling */
221 enum port_vlan_mode {
222     /* This port is an access port.  'vlan' is the VLAN ID.  'trunks' is
223      * ignored. */
224     PORT_VLAN_ACCESS,
225
226     /* This port is a trunk.  'trunks' is the set of trunks. 'vlan' is
227      * ignored. */
228     PORT_VLAN_TRUNK,
229
230     /* Untagged incoming packets are part of 'vlan', as are incoming packets
231      * tagged with 'vlan'.  Outgoing packets tagged with 'vlan' stay tagged.
232      * Other VLANs in 'trunks' are trunked. */
233     PORT_VLAN_NATIVE_TAGGED,
234
235     /* Untagged incoming packets are part of 'vlan', as are incoming packets
236      * tagged with 'vlan'.  Outgoing packets tagged with 'vlan' are untagged.
237      * Other VLANs in 'trunks' are trunked. */
238     PORT_VLAN_NATIVE_UNTAGGED
239 };
240
241 /* Configuration of bundles. */
242 struct ofproto_bundle_settings {
243     char *name;                 /* For use in log messages. */
244
245     uint16_t *slaves;           /* OpenFlow port numbers for slaves. */
246     size_t n_slaves;
247
248     enum port_vlan_mode vlan_mode; /* Selects mode for vlan and trunks */
249     int vlan;                   /* VLAN VID, except for PORT_VLAN_TRUNK. */
250     unsigned long *trunks;      /* vlan_bitmap, except for PORT_VLAN_ACCESS. */
251
252     struct bond_settings *bond; /* Must be nonnull iff if n_slaves > 1. */
253     uint32_t *bond_stable_ids;  /* Array of n_slaves elements. */
254
255     struct lacp_settings *lacp;              /* Nonnull to enable LACP. */
256     struct lacp_slave_settings *lacp_slaves; /* Array of n_slaves elements. */
257 };
258
259 int ofproto_bundle_register(struct ofproto *, void *aux,
260                             const struct ofproto_bundle_settings *);
261 int ofproto_bundle_unregister(struct ofproto *, void *aux);
262
263 /* Configuration of mirrors. */
264 struct ofproto_mirror_settings {
265     /* Name for log messages. */
266     char *name;
267
268     /* Bundles that select packets for mirroring upon ingress.  */
269     void **srcs;                /* A set of registered ofbundle handles. */
270     size_t n_srcs;
271
272     /* Bundles that select packets for mirroring upon egress.  */
273     void **dsts;                /* A set of registered ofbundle handles. */
274     size_t n_dsts;
275
276     /* VLANs of packets to select for mirroring. */
277     unsigned long *src_vlans;   /* vlan_bitmap, NULL selects all VLANs. */
278
279     /* Output (mutually exclusive). */
280     void *out_bundle;           /* A registered ofbundle handle or NULL. */
281     uint16_t out_vlan;          /* Output VLAN, only if out_bundle is NULL. */
282 };
283
284 int ofproto_mirror_register(struct ofproto *, void *aux,
285                             const struct ofproto_mirror_settings *);
286 int ofproto_mirror_unregister(struct ofproto *, void *aux);
287
288 int ofproto_set_flood_vlans(struct ofproto *, unsigned long *flood_vlans);
289 bool ofproto_is_mirror_output_bundle(const struct ofproto *, void *aux);
290
291 /* Configuration querying. */
292 bool ofproto_has_snoops(const struct ofproto *);
293 void ofproto_get_snoops(const struct ofproto *, struct sset *);
294 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
295 void ofproto_get_netflow_ids(const struct ofproto *,
296                              uint8_t *engine_type, uint8_t *engine_id);
297 int ofproto_port_get_cfm_fault(const struct ofproto *, uint16_t ofp_port);
298 int ofproto_port_get_cfm_remote_mpids(const struct ofproto *,
299                                       uint16_t ofp_port, const uint64_t **rmps,
300                                       size_t *n_rmps);
301
302 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
303 void ofproto_free_ofproto_controller_info(struct shash *);
304
305 #ifdef  __cplusplus
306 }
307 #endif
308
309 #endif /* ofproto.h */