ofproto: Rename "private.h" to "ofproto->provider.h".
[openvswitch] / ofproto / 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 "flow.h"
26 #include "netflow.h"
27 #include "sset.h"
28 #include "tag.h"
29
30 #ifdef  __cplusplus
31 extern "C" {
32 #endif
33
34 struct cfm_settings;
35 struct cls_rule;
36 struct netdev;
37 struct ofproto;
38 struct shash;
39
40 struct ofproto_controller_info {
41     bool is_connected;
42     enum nx_role role;
43     struct {
44         const char *keys[4];
45         const char *values[4];
46         size_t n;
47     } pairs;
48 };
49
50 struct ofexpired {
51     struct flow flow;
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). */
55 };
56
57 struct ofproto_sflow_options {
58     struct sset targets;
59     uint32_t sampling_rate;
60     uint32_t polling_interval;
61     uint32_t header_len;
62     uint32_t sub_id;
63     char *agent_device;
64     char *control_ip;
65 };
66
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. */
71 };
72
73 enum ofproto_band {
74     OFPROTO_IN_BAND,            /* In-band connection to controller. */
75     OFPROTO_OUT_OF_BAND         /* Out-of-band connection to controller. */
76 };
77
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? */
83
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. */
87 };
88
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"
94
95 void ofproto_enumerate_types(struct sset *types);
96 const char *ofproto_normalize_type(const char *);
97
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);
100
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);
105
106 int ofproto_run(struct ofproto *);
107 void ofproto_wait(struct ofproto *);
108 bool ofproto_is_alive(const struct ofproto *);
109
110 /* A port within an OpenFlow switch.
111  *
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. */
117 };
118 void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *);
119 void ofproto_port_destroy(struct ofproto_port *);
120
121 struct ofproto_port_dump {
122     const struct ofproto *ofproto;
123     int error;
124     void *state;
125 };
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 *);
130
131 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
132  *
133  * Arguments all have pointer type.
134  *
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)        \
140           ? true                                            \
141           : (ofproto_port_dump_done(DUMP), false));         \
142         )
143
144 int ofproto_port_add(struct ofproto *, struct netdev *, uint16_t *ofp_portp);
145 int ofproto_port_del(struct ofproto *, uint16_t ofp_port);
146
147 int ofproto_port_query_by_name(const struct ofproto *, const char *devname,
148                                struct ofproto_port *);
149
150 /* Top-level configuration. */
151 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
152 void ofproto_set_controllers(struct ofproto *,
153                              const struct ofproto_controller *, size_t n);
154 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
155 void ofproto_reconnect_controllers(struct ofproto *);
156 void ofproto_set_extra_in_band_remotes(struct ofproto *,
157                                        const struct sockaddr_in *, size_t n);
158 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
159 void ofproto_set_desc(struct ofproto *,
160                       const char *mfr_desc, const char *hw_desc,
161                       const char *sw_desc, const char *serial_desc,
162                       const char *dp_desc);
163 int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
164 int ofproto_set_netflow(struct ofproto *,
165                         const struct netflow_options *nf_options);
166 int ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
167
168 /* Configuration of ports. */
169
170 void ofproto_port_unregister(struct ofproto *, uint16_t ofp_port);
171
172 void ofproto_port_clear_cfm(struct ofproto *, uint16_t ofp_port);
173 void ofproto_port_set_cfm(struct ofproto *, uint16_t ofp_port,
174                           const struct cfm_settings *);
175 int ofproto_port_is_lacp_current(struct ofproto *, uint16_t ofp_port);
176
177 /* Configuration of bundles. */
178 struct ofproto_bundle_settings {
179     char *name;                 /* For use in log messages. */
180
181     uint16_t *slaves;           /* OpenFlow port numbers for slaves. */
182     size_t n_slaves;
183
184     int vlan;                   /* VLAN if access port, -1 if trunk port. */
185     unsigned long *trunks;      /* vlan_bitmap, NULL to trunk all VLANs. */
186
187     struct bond_settings *bond; /* Must be nonnull iff if n_slaves > 1. */
188     uint32_t *bond_stable_ids;  /* Array of n_slaves elements. */
189
190     struct lacp_settings *lacp;              /* Nonnull to enable LACP. */
191     struct lacp_slave_settings *lacp_slaves; /* Array of n_slaves elements. */
192 };
193
194 int ofproto_bundle_register(struct ofproto *, void *aux,
195                             const struct ofproto_bundle_settings *);
196 int ofproto_bundle_unregister(struct ofproto *, void *aux);
197
198 /* Configuration of mirrors. */
199 struct ofproto_mirror_settings {
200     /* Name for log messages. */
201     char *name;
202
203     /* Bundles that select packets for mirroring upon ingress.  */
204     void **srcs;                /* A set of registered ofbundle handles. */
205     size_t n_srcs;
206
207     /* Bundles that select packets for mirroring upon egress.  */
208     void **dsts;                /* A set of registered ofbundle handles. */
209     size_t n_dsts;
210
211     /* VLANs of packets to select for mirroring. */
212     unsigned long *src_vlans;   /* vlan_bitmap, NULL selects all VLANs. */
213
214     /* Output (mutually exclusive). */
215     void *out_bundle;           /* A registered ofbundle handle or NULL. */
216     uint16_t out_vlan;          /* Output VLAN, only if out_bundle is NULL. */
217 };
218
219 int ofproto_mirror_register(struct ofproto *, void *aux,
220                             const struct ofproto_mirror_settings *);
221 int ofproto_mirror_unregister(struct ofproto *, void *aux);
222
223 int ofproto_set_flood_vlans(struct ofproto *, unsigned long *flood_vlans);
224 bool ofproto_is_mirror_output_bundle(struct ofproto *, void *aux);
225
226 /* Configuration querying. */
227 bool ofproto_has_snoops(const struct ofproto *);
228 void ofproto_get_snoops(const struct ofproto *, struct sset *);
229 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
230 void ofproto_get_netflow_ids(const struct ofproto *,
231                              uint8_t *engine_type, uint8_t *engine_id);
232 int ofproto_port_get_cfm_fault(const struct ofproto *, uint16_t ofp_port);
233
234 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
235 void ofproto_free_ofproto_controller_info(struct shash *);
236
237 #ifdef  __cplusplus
238 }
239 #endif
240
241 #endif /* ofproto.h */