ofproto-dpif: Avoid extra flow copy in xlate_actions() for unneeded warnings.
[openvswitch] / ofproto / ofproto.h
1 /*
2  * Copyright (c) 2009, 2010, 2011, 2012 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 ofport;
41 struct shash;
42 struct netdev_stats;
43
44 struct ofproto_controller_info {
45     bool is_connected;
46     enum nx_role role;
47     struct {
48         const char *keys[4];
49         const char *values[4];
50         size_t n;
51     } pairs;
52 };
53
54 struct ofexpired {
55     struct flow flow;
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). */
59 };
60
61 struct ofproto_sflow_options {
62     struct sset targets;
63     uint32_t sampling_rate;
64     uint32_t polling_interval;
65     uint32_t header_len;
66     uint32_t sub_id;
67     char *agent_device;
68     char *control_ip;
69 };
70
71 struct ofproto_stp_settings {
72     stp_identifier system_id;
73     uint16_t priority;
74     uint16_t hello_time;
75     uint16_t max_age;
76     uint16_t fwd_delay;
77 };
78
79 struct ofproto_stp_status {
80     bool enabled;               /* If false, ignore other members. */
81     stp_identifier bridge_id;
82     stp_identifier designated_root;
83     int root_path_cost;
84 };
85
86 struct ofproto_port_stp_settings {
87     bool enable;
88     uint8_t port_num;           /* In the range 1-255, inclusive. */
89     uint8_t priority;
90     uint16_t path_cost;
91 };
92
93 struct ofproto_port_stp_status {
94     bool enabled;               /* If false, ignore other members. */
95     int port_id;
96     enum stp_state state;
97     unsigned int sec_in_state;
98     enum stp_role role;
99     int tx_count;               /* Number of BPDUs transmitted. */
100     int rx_count;               /* Number of valid BPDUs received. */
101     int error_count;            /* Number of bad BPDUs received. */
102 };
103
104 struct ofproto_port_queue {
105     uint32_t queue;             /* Queue ID. */
106     uint8_t dscp;               /* DSCP bits (e.g. [0, 63]). */
107 };
108
109 /* How the switch should act if the controller cannot be contacted. */
110 enum ofproto_fail_mode {
111     OFPROTO_FAIL_SECURE,        /* Preserve flow table. */
112     OFPROTO_FAIL_STANDALONE     /* Act as a standalone switch. */
113 };
114
115 enum ofproto_band {
116     OFPROTO_IN_BAND,            /* In-band connection to controller. */
117     OFPROTO_OUT_OF_BAND         /* Out-of-band connection to controller. */
118 };
119
120 struct ofproto_controller {
121     char *target;               /* e.g. "tcp:127.0.0.1" */
122     int max_backoff;            /* Maximum reconnection backoff, in seconds. */
123     int probe_interval;         /* Max idle time before probing, in seconds. */
124     enum ofproto_band band;     /* In-band or out-of-band? */
125     bool enable_async_msgs;     /* Initially enable asynchronous messages? */
126
127     /* OpenFlow packet-in rate-limiting. */
128     int rate_limit;             /* Max packet-in rate in packets per second. */
129     int burst_limit;            /* Limit on accumulating packet credits. */
130
131     uint8_t dscp;               /* DSCP value for controller connection. */
132 };
133
134 #define DEFAULT_MFR_DESC "Nicira Networks, Inc."
135 #define DEFAULT_HW_DESC "Open vSwitch"
136 #define DEFAULT_SW_DESC VERSION
137 #define DEFAULT_SERIAL_DESC "None"
138 #define DEFAULT_DP_DESC "None"
139
140 void ofproto_enumerate_types(struct sset *types);
141 const char *ofproto_normalize_type(const char *);
142
143 int ofproto_enumerate_names(const char *type, struct sset *names);
144 void ofproto_parse_name(const char *name, char **dp_name, char **dp_type);
145
146 int ofproto_create(const char *datapath, const char *datapath_type,
147                    struct ofproto **ofprotop);
148 void ofproto_destroy(struct ofproto *);
149 int ofproto_delete(const char *name, const char *type);
150
151 int ofproto_run(struct ofproto *);
152 int ofproto_run_fast(struct ofproto *);
153 void ofproto_wait(struct ofproto *);
154 bool ofproto_is_alive(const struct ofproto *);
155
156 /* A port within an OpenFlow switch.
157  *
158  * 'name' and 'type' are suitable for passing to netdev_open(). */
159 struct ofproto_port {
160     char *name;                 /* Network device name, e.g. "eth0". */
161     char *type;                 /* Network device type, e.g. "system". */
162     uint16_t ofp_port;          /* OpenFlow port number. */
163 };
164 void ofproto_port_clone(struct ofproto_port *, const struct ofproto_port *);
165 void ofproto_port_destroy(struct ofproto_port *);
166
167 struct ofproto_port_dump {
168     const struct ofproto *ofproto;
169     int error;
170     void *state;
171 };
172 void ofproto_port_dump_start(struct ofproto_port_dump *,
173                              const struct ofproto *);
174 bool ofproto_port_dump_next(struct ofproto_port_dump *, struct ofproto_port *);
175 int ofproto_port_dump_done(struct ofproto_port_dump *);
176
177 /* Iterates through each OFPROTO_PORT in OFPROTO, using DUMP as state.
178  *
179  * Arguments all have pointer type.
180  *
181  * If you break out of the loop, then you need to free the dump structure by
182  * hand using ofproto_port_dump_done(). */
183 #define OFPROTO_PORT_FOR_EACH(OFPROTO_PORT, DUMP, OFPROTO)  \
184     for (ofproto_port_dump_start(DUMP, OFPROTO);            \
185          (ofproto_port_dump_next(DUMP, OFPROTO_PORT)        \
186           ? true                                            \
187           : (ofproto_port_dump_done(DUMP), false));         \
188         )
189
190 #define OFPROTO_FLOW_EVICTON_THRESHOLD_DEFAULT  1000
191 #define OFPROTO_FLOW_EVICTION_THRESHOLD_MIN 100
192
193 int ofproto_port_add(struct ofproto *, struct netdev *, uint16_t *ofp_portp);
194 int ofproto_port_del(struct ofproto *, uint16_t ofp_port);
195 int ofproto_port_get_stats(const struct ofport *, struct netdev_stats *stats);
196
197 int ofproto_port_query_by_name(const struct ofproto *, const char *devname,
198                                struct ofproto_port *);
199
200 /* Top-level configuration. */
201 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
202 void ofproto_set_controllers(struct ofproto *,
203                              const struct ofproto_controller *, size_t n);
204 void ofproto_set_fail_mode(struct ofproto *, enum ofproto_fail_mode fail_mode);
205 void ofproto_reconnect_controllers(struct ofproto *);
206 void ofproto_set_extra_in_band_remotes(struct ofproto *,
207                                        const struct sockaddr_in *, size_t n);
208 void ofproto_set_in_band_queue(struct ofproto *, int queue_id);
209 void ofproto_set_flow_eviction_threshold(struct ofproto *, unsigned threshold);
210 void ofproto_set_forward_bpdu(struct ofproto *, bool forward_bpdu);
211 void ofproto_set_mac_idle_time(struct ofproto *, unsigned idle_time);
212 void ofproto_set_desc(struct ofproto *,
213                       const char *mfr_desc, const char *hw_desc,
214                       const char *sw_desc, const char *serial_desc,
215                       const char *dp_desc);
216 int ofproto_set_snoops(struct ofproto *, const struct sset *snoops);
217 int ofproto_set_netflow(struct ofproto *,
218                         const struct netflow_options *nf_options);
219 int ofproto_set_sflow(struct ofproto *, const struct ofproto_sflow_options *);
220 int ofproto_set_stp(struct ofproto *, const struct ofproto_stp_settings *);
221 int ofproto_get_stp_status(struct ofproto *, struct ofproto_stp_status *);
222
223 /* Configuration of ports. */
224 void ofproto_port_unregister(struct ofproto *, uint16_t ofp_port);
225
226 void ofproto_port_clear_cfm(struct ofproto *, uint16_t ofp_port);
227 void ofproto_port_set_cfm(struct ofproto *, uint16_t ofp_port,
228                           const struct cfm_settings *);
229 int ofproto_port_is_lacp_current(struct ofproto *, uint16_t ofp_port);
230 int ofproto_port_set_stp(struct ofproto *, uint16_t ofp_port,
231                          const struct ofproto_port_stp_settings *);
232 int ofproto_port_get_stp_status(struct ofproto *, uint16_t ofp_port,
233                                 struct ofproto_port_stp_status *);
234 int ofproto_port_set_queues(struct ofproto *, uint16_t ofp_port,
235                             const struct ofproto_port_queue *,
236                             size_t n_queues);
237
238 /* The behaviour of the port regarding VLAN handling */
239 enum port_vlan_mode {
240     /* This port is an access port.  'vlan' is the VLAN ID.  'trunks' is
241      * ignored. */
242     PORT_VLAN_ACCESS,
243
244     /* This port is a trunk.  'trunks' is the set of trunks. 'vlan' is
245      * ignored. */
246     PORT_VLAN_TRUNK,
247
248     /* Untagged incoming packets are part of 'vlan', as are incoming packets
249      * tagged with 'vlan'.  Outgoing packets tagged with 'vlan' stay tagged.
250      * Other VLANs in 'trunks' are trunked. */
251     PORT_VLAN_NATIVE_TAGGED,
252
253     /* Untagged incoming packets are part of 'vlan', as are incoming packets
254      * tagged with 'vlan'.  Outgoing packets tagged with 'vlan' are untagged.
255      * Other VLANs in 'trunks' are trunked. */
256     PORT_VLAN_NATIVE_UNTAGGED
257 };
258
259 /* Configuration of bundles. */
260 struct ofproto_bundle_settings {
261     char *name;                 /* For use in log messages. */
262
263     uint16_t *slaves;           /* OpenFlow port numbers for slaves. */
264     size_t n_slaves;
265
266     enum port_vlan_mode vlan_mode; /* Selects mode for vlan and trunks */
267     int vlan;                   /* VLAN VID, except for PORT_VLAN_TRUNK. */
268     unsigned long *trunks;      /* vlan_bitmap, except for PORT_VLAN_ACCESS. */
269     bool use_priority_tags;     /* Use 802.1p tag for frames in VLAN 0? */
270
271     struct bond_settings *bond; /* Must be nonnull iff if n_slaves > 1. */
272     uint32_t *bond_stable_ids;  /* Array of n_slaves elements. */
273
274     struct lacp_settings *lacp;              /* Nonnull to enable LACP. */
275     struct lacp_slave_settings *lacp_slaves; /* Array of n_slaves elements. */
276
277     /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
278      *
279      * This is deprecated.  It is only for compatibility with broken device
280      * drivers in old versions of Linux that do not properly support VLANs when
281      * VLAN devices are not used.  When broken device drivers are no longer in
282      * widespread use, we will delete these interfaces. */
283     uint16_t realdev_ofp_port;  /* OpenFlow port number of real device. */
284 };
285
286 int ofproto_bundle_register(struct ofproto *, void *aux,
287                             const struct ofproto_bundle_settings *);
288 int ofproto_bundle_unregister(struct ofproto *, void *aux);
289
290 /* Configuration of mirrors. */
291 struct ofproto_mirror_settings {
292     /* Name for log messages. */
293     char *name;
294
295     /* Bundles that select packets for mirroring upon ingress.  */
296     void **srcs;                /* A set of registered ofbundle handles. */
297     size_t n_srcs;
298
299     /* Bundles that select packets for mirroring upon egress.  */
300     void **dsts;                /* A set of registered ofbundle handles. */
301     size_t n_dsts;
302
303     /* VLANs of packets to select for mirroring. */
304     unsigned long *src_vlans;   /* vlan_bitmap, NULL selects all VLANs. */
305
306     /* Output (mutually exclusive). */
307     void *out_bundle;           /* A registered ofbundle handle or NULL. */
308     uint16_t out_vlan;          /* Output VLAN, only if out_bundle is NULL. */
309 };
310
311 int ofproto_mirror_register(struct ofproto *, void *aux,
312                             const struct ofproto_mirror_settings *);
313 int ofproto_mirror_unregister(struct ofproto *, void *aux);
314 int ofproto_mirror_get_stats(struct ofproto *, void *aux,
315                              uint64_t *packets, uint64_t *bytes);
316
317 int ofproto_set_flood_vlans(struct ofproto *, unsigned long *flood_vlans);
318 bool ofproto_is_mirror_output_bundle(const struct ofproto *, void *aux);
319
320 /* Configuration of OpenFlow tables. */
321 struct ofproto_table_settings {
322     char *name;                 /* Name exported via OpenFlow or NULL. */
323     unsigned int max_flows;     /* Maximum number of flows or UINT_MAX. */
324
325     /* These members determine the handling of an attempt to add a flow that
326      * would cause the table to have more than 'max_flows' flows.
327      *
328      * If 'groups' is NULL, overflows will be rejected with an error.
329      *
330      * If 'groups' is nonnull, an overflow will cause a flow to be removed.
331      * The flow to be removed is chosen to give fairness among groups
332      * distinguished by different values for the subfields within 'groups'. */
333     struct mf_subfield *groups;
334     size_t n_groups;
335 };
336
337 int ofproto_get_n_tables(const struct ofproto *);
338 void ofproto_configure_table(struct ofproto *, int table_id,
339                              const struct ofproto_table_settings *);
340
341 /* Configuration querying. */
342 bool ofproto_has_snoops(const struct ofproto *);
343 void ofproto_get_snoops(const struct ofproto *, struct sset *);
344 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
345 void ofproto_get_netflow_ids(const struct ofproto *,
346                              uint8_t *engine_type, uint8_t *engine_id);
347 int ofproto_port_get_cfm_fault(const struct ofproto *, uint16_t ofp_port);
348 int ofproto_port_get_cfm_remote_mpids(const struct ofproto *,
349                                       uint16_t ofp_port, const uint64_t **rmps,
350                                       size_t *n_rmps);
351 int ofproto_port_get_cfm_health(const struct ofproto *ofproto,
352                                 uint16_t ofp_port);
353 void ofproto_get_ofproto_controller_info(const struct ofproto *, struct shash *);
354 void ofproto_free_ofproto_controller_info(struct shash *);
355 \f
356 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
357  *
358  * This is deprecated.  It is only for compatibility with broken device drivers
359  * in old versions of Linux that do not properly support VLANs when VLAN
360  * devices are not used.  When broken device drivers are no longer in
361  * widespread use, we will delete these interfaces. */
362
363 void ofproto_get_vlan_usage(struct ofproto *, unsigned long int *vlan_bitmap);
364 bool ofproto_has_vlan_usage_changed(const struct ofproto *);
365 int ofproto_port_set_realdev(struct ofproto *, uint16_t vlandev_ofp_port,
366                              uint16_t realdev_ofp_port, int vid);
367
368 #ifdef  __cplusplus
369 }
370 #endif
371
372 #endif /* ofproto.h */