ofproto: Reinterpret meaning of OpenFlow hard timeouts with OFPFC_MODIFY.
[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 "cfm.h"
26 #include "flow.h"
27 #include "netflow.h"
28 #include "sset.h"
29 #include "tag.h"
30
31 #ifdef  __cplusplus
32 extern "C" {
33 #endif
34
35 struct cfm_settings;
36 struct cls_rule;
37 struct netdev;
38 struct ofproto;
39 struct shash;
40
41 struct ofproto_controller_info {
42     bool is_connected;
43     enum nx_role role;
44     struct {
45         const char *keys[4];
46         const char *values[4];
47         size_t n;
48     } pairs;
49 };
50
51 struct ofexpired {
52     struct flow flow;
53     uint64_t packet_count;      /* Packets from subrules. */
54     uint64_t byte_count;        /* Bytes from subrules. */
55     long long int used;         /* Last-used time (0 if never used). */
56 };
57
58 struct ofproto_sflow_options {
59     struct sset targets;
60     uint32_t sampling_rate;
61     uint32_t polling_interval;
62     uint32_t header_len;
63     uint32_t sub_id;
64     char *agent_device;
65     char *control_ip;
66 };
67
68 /* How the switch should act if the controller cannot be contacted. */
69 enum ofproto_fail_mode {
70     OFPROTO_FAIL_SECURE,        /* Preserve flow table. */
71     OFPROTO_FAIL_STANDALONE     /* Act as a standalone switch. */
72 };
73
74 enum ofproto_band {
75     OFPROTO_IN_BAND,            /* In-band connection to controller. */
76     OFPROTO_OUT_OF_BAND         /* Out-of-band connection to controller. */
77 };
78
79 struct ofproto_controller {
80     char *target;               /* e.g. "tcp:127.0.0.1" */
81     int max_backoff;            /* Maximum reconnection backoff, in seconds. */
82     int probe_interval;         /* Max idle time before probing, in seconds. */
83     enum ofproto_band band;      /* In-band or out-of-band? */
84
85     /* OpenFlow packet-in rate-limiting. */
86     int rate_limit;             /* Max packet-in rate in packets per second. */
87     int burst_limit;            /* Limit on accumulating packet credits. */
88 };
89
90 #define DEFAULT_MFR_DESC "Nicira Networks, Inc."
91 #define DEFAULT_HW_DESC "Open vSwitch"
92 #define DEFAULT_SW_DESC VERSION BUILDNR
93 #define DEFAULT_SERIAL_DESC "None"
94 #define DEFAULT_DP_DESC "None"
95
96 void ofproto_enumerate_types(struct sset *types);
97 const char *ofproto_normalize_type(const char *);
98
99 int ofproto_enumerate_names(const char *type, struct sset *names);
100 void ofproto_parse_name(const char *name, char **dp_name, char **dp_type);
101
102 int ofproto_create(const char *datapath, const char *datapath_type,
103                    struct ofproto **ofprotop);
104 void ofproto_destroy(struct ofproto *);
105 int ofproto_delete(const char *name, const char *type);
106
107 int ofproto_run(struct ofproto *);
108 void ofproto_wait(struct ofproto *);
109 bool ofproto_is_alive(const struct ofproto *);
110
111 /* A port within an OpenFlow switch.
112  *
113  * 'name' and 'type' are suitable for passing to netdev_open(). */
114 struct ofproto_port {
115     char *name;                 /* Network device name, e.g. "eth0". */
116     char *type;                 /* Network device type, e.g. "system". */
117     uint16_t ofp_port;          /* OpenFlow port number. */
118 };
119 void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *);
120 void ofproto_port_destroy(struct ofproto_port *);
121
122 struct ofproto_port_dump {
123     const struct ofproto *ofproto;
124     int error;
125     void *state;
126 };
127 void ofproto_port_dump_start(struct ofproto_port_dump *,
128                              const struct ofproto *);
129 bool ofproto_port_dump_next(struct ofproto_port_dump *, struct ofproto_port *);
130 int ofproto_port_dump_done(struct ofproto_port_dump *);
131
132 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
133  *
134  * Arguments all have pointer type.
135  *
136  * If you break out of the loop, then you need to free the dump structure by
137  * hand using ofproto_port_dump_done(). */
138 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO)  \
139     for (ofproto_port_dump_start(DUMP, OFPROTO);            \
140          (ofproto_port_dump_next(DUMP, OFPROTO_PORT)        \
141           ? true                                            \
142           : (ofproto_port_dump_done(DUMP), false));         \
143         )
144
145 #define OFPROTO_FLOW_EVICTON_THRESHOLD_DEFAULT  1000
146 #define OFPROTO_FLOW_EVICTION_THRESHOLD_MIN     100
147
148 int ofproto_port_add(struct ofproto *, struct netdev *, uint16_t *ofp_portp);
149 int ofproto_port_del(struct ofproto *, uint16_t ofp_port);
150
151 int ofproto_port_query_by_name(const struct ofproto *, const char *devname,
152                                struct ofproto_port *);
153
154 /* Top-level configuration. */
155 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
156 void ofproto_set_controllers(struct ofproto *,
157                              const struct ofproto_controller *, size_t n);
158 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
159 void ofproto_reconnect_controllers(struct ofproto *);
160 void ofproto_set_extra_in_band_remotes(struct ofproto *,
161                                        const struct sockaddr_in *, size_t n);
162 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
163 void ofproto_set_flow_eviction_threshold(struct ofproto *, unsigned threshold);
164 void ofproto_set_forward_bpdu(struct ofproto *, bool forward_bpdu);
165 void ofproto_set_desc(struct ofproto *,
166                       const char *mfr_desc, const char *hw_desc,
167                       const char *sw_desc, const char *serial_desc,
168                       const char *dp_desc);
169 int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
170 int ofproto_set_netflow(struct ofproto *,
171                         const struct netflow_options *nf_options);
172 int ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
173
174 /* Configuration of ports. */
175
176 void ofproto_port_unregister(struct ofproto *, uint16_t ofp_port);
177
178 void ofproto_port_clear_cfm(struct ofproto *, uint16_t ofp_port);
179 void ofproto_port_set_cfm(struct ofproto *, uint16_t ofp_port,
180                           const struct cfm_settings *);
181 int ofproto_port_is_lacp_current(struct ofproto *, uint16_t ofp_port);
182
183 /* Configuration of bundles. */
184 struct ofproto_bundle_settings {
185     char *name;                 /* For use in log messages. */
186
187     uint16_t *slaves;           /* OpenFlow port numbers for slaves. */
188     size_t n_slaves;
189
190     int vlan;                   /* VLAN if access port, -1 if trunk port. */
191     unsigned long *trunks;      /* vlan_bitmap, NULL to trunk all VLANs. */
192
193     struct bond_settings *bond; /* Must be nonnull iff if n_slaves > 1. */
194     uint32_t *bond_stable_ids;  /* Array of n_slaves elements. */
195
196     struct lacp_settings *lacp;              /* Nonnull to enable LACP. */
197     struct lacp_slave_settings *lacp_slaves; /* Array of n_slaves elements. */
198 };
199
200 int ofproto_bundle_register(struct ofproto *, void *aux,
201                             const struct ofproto_bundle_settings *);
202 int ofproto_bundle_unregister(struct ofproto *, void *aux);
203
204 /* Configuration of mirrors. */
205 struct ofproto_mirror_settings {
206     /* Name for log messages. */
207     char *name;
208
209     /* Bundles that select packets for mirroring upon ingress.  */
210     void **srcs;                /* A set of registered ofbundle handles. */
211     size_t n_srcs;
212
213     /* Bundles that select packets for mirroring upon egress.  */
214     void **dsts;                /* A set of registered ofbundle handles. */
215     size_t n_dsts;
216
217     /* VLANs of packets to select for mirroring. */
218     unsigned long *src_vlans;   /* vlan_bitmap, NULL selects all VLANs. */
219
220     /* Output (mutually exclusive). */
221     void *out_bundle;           /* A registered ofbundle handle or NULL. */
222     uint16_t out_vlan;          /* Output VLAN, only if out_bundle is NULL. */
223 };
224
225 int ofproto_mirror_register(struct ofproto *, void *aux,
226                             const struct ofproto_mirror_settings *);
227 int ofproto_mirror_unregister(struct ofproto *, void *aux);
228
229 int ofproto_set_flood_vlans(struct ofproto *, unsigned long *flood_vlans);
230 bool ofproto_is_mirror_output_bundle(struct ofproto *, void *aux);
231
232 /* Configuration querying. */
233 bool ofproto_has_snoops(const struct ofproto *);
234 void ofproto_get_snoops(const struct ofproto *, struct sset *);
235 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
236 void ofproto_get_netflow_ids(const struct ofproto *,
237                              uint8_t *engine_type, uint8_t *engine_id);
238 int ofproto_port_get_cfm_fault(const struct ofproto *, uint16_t ofp_port);
239 int ofproto_port_get_cfm_remote_mpids(const struct ofproto *,
240                                       uint16_t ofp_port, const uint64_t **rmps,
241                                       size_t *n_rmps);
242
243 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
244 void ofproto_free_ofproto_controller_info(struct shash *);
245
246 #ifdef  __cplusplus
247 }
248 #endif
249
250 #endif /* ofproto.h */