2 * Copyright (c) 2008, 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.
24 #include <linux/openvswitch.h>
25 #include "openflow/openflow.h"
41 int dp_register_provider(const struct dpif_class *);
42 int dp_unregister_provider(const char *type);
43 void dp_enumerate_types(struct sset *types);
44 const char *dpif_normalize_type(const char *);
46 int dp_enumerate_names(const char *type, struct sset *names);
47 void dp_parse_name(const char *datapath_name, char **name, char **type);
49 int dpif_open(const char *name, const char *type, struct dpif **);
50 int dpif_create(const char *name, const char *type, struct dpif **);
51 int dpif_create_and_open(const char *name, const char *type, struct dpif **);
52 void dpif_close(struct dpif *);
54 void dpif_run(struct dpif *);
55 void dpif_wait(struct dpif *);
57 const char *dpif_name(const struct dpif *);
58 const char *dpif_base_name(const struct dpif *);
60 int dpif_delete(struct dpif *);
62 /* Statisticss for a dpif as a whole. */
63 struct dpif_dp_stats {
64 uint64_t n_frags; /* Number of dropped IP fragments. */
65 uint64_t n_hit; /* Number of flow table matches. */
66 uint64_t n_missed; /* Number of flow table misses. */
67 uint64_t n_lost; /* Number of misses not sent to userspace. */
68 uint64_t n_flows; /* Number of flows present. */
70 int dpif_get_dp_stats(const struct dpif *, struct dpif_dp_stats *);
72 int dpif_get_drop_frags(const struct dpif *, bool *drop_frags);
73 int dpif_set_drop_frags(struct dpif *, bool drop_frags);
75 /* Port operations. */
77 int dpif_port_add(struct dpif *, struct netdev *, uint16_t *port_nop);
78 int dpif_port_del(struct dpif *, uint16_t port_no);
80 /* A port within a datapath.
82 * 'name' and 'type' are suitable for passing to netdev_open(). */
84 char *name; /* Network device name, e.g. "eth0". */
85 char *type; /* Network device type, e.g. "system". */
86 uint32_t port_no; /* Port number within datapath. */
88 void dpif_port_clone(struct dpif_port *, const struct dpif_port *);
89 void dpif_port_destroy(struct dpif_port *);
90 int dpif_port_query_by_number(const struct dpif *, uint16_t port_no,
92 int dpif_port_query_by_name(const struct dpif *, const char *devname,
94 int dpif_port_get_name(struct dpif *, uint16_t port_no,
95 char *name, size_t name_size);
96 int dpif_get_max_ports(const struct dpif *);
97 uint32_t dpif_port_get_pid(const struct dpif *, uint16_t port_no);
99 struct dpif_port_dump {
100 const struct dpif *dpif;
104 void dpif_port_dump_start(struct dpif_port_dump *, const struct dpif *);
105 bool dpif_port_dump_next(struct dpif_port_dump *, struct dpif_port *);
106 int dpif_port_dump_done(struct dpif_port_dump *);
108 /* Iterates through each DPIF_PORT in DPIF, using DUMP as state.
110 * Arguments all have pointer type.
112 * If you break out of the loop, then you need to free the dump structure by
113 * hand using dpif_port_dump_done(). */
114 #define DPIF_PORT_FOR_EACH(DPIF_PORT, DUMP, DPIF) \
115 for (dpif_port_dump_start(DUMP, DPIF); \
116 (dpif_port_dump_next(DUMP, DPIF_PORT) \
118 : (dpif_port_dump_done(DUMP), false)); \
121 int dpif_port_poll(const struct dpif *, char **devnamep);
122 void dpif_port_poll_wait(const struct dpif *);
124 /* Flow table operations. */
126 struct dpif_flow_stats {
133 void dpif_flow_stats_extract(const struct flow *, struct ofpbuf *packet,
134 struct dpif_flow_stats *);
135 void dpif_flow_stats_format(const struct dpif_flow_stats *, struct ds *);
137 enum dpif_flow_put_flags {
138 DPIF_FP_CREATE = 1 << 0, /* Allow creating a new flow. */
139 DPIF_FP_MODIFY = 1 << 1, /* Allow modifying an existing flow. */
140 DPIF_FP_ZERO_STATS = 1 << 2 /* Zero the stats of an existing flow. */
143 int dpif_flow_flush(struct dpif *);
144 int dpif_flow_put(struct dpif *, enum dpif_flow_put_flags,
145 const struct nlattr *key, size_t key_len,
146 const struct nlattr *actions, size_t actions_len,
147 struct dpif_flow_stats *);
148 int dpif_flow_del(struct dpif *,
149 const struct nlattr *key, size_t key_len,
150 struct dpif_flow_stats *);
151 int dpif_flow_get(const struct dpif *,
152 const struct nlattr *key, size_t key_len,
153 struct ofpbuf **actionsp, struct dpif_flow_stats *);
155 struct dpif_flow_dump {
156 const struct dpif *dpif;
160 void dpif_flow_dump_start(struct dpif_flow_dump *, const struct dpif *);
161 bool dpif_flow_dump_next(struct dpif_flow_dump *,
162 const struct nlattr **key, size_t *key_len,
163 const struct nlattr **actions, size_t *actions_len,
164 const struct dpif_flow_stats **);
165 int dpif_flow_dump_done(struct dpif_flow_dump *);
167 /* Packet operations. */
169 int dpif_execute(struct dpif *,
170 const struct nlattr *key, size_t key_len,
171 const struct nlattr *actions, size_t actions_len,
172 const struct ofpbuf *);
174 /* Operation batching interface.
176 * Some datapaths are faster at performing N operations together than the same
177 * N operations individually, hence an interface for batching.
181 DPIF_OP_FLOW_PUT = 1,
185 struct dpif_flow_put {
186 enum dpif_op_type type; /* Always DPIF_OP_FLOW_PUT. */
189 enum dpif_flow_put_flags flags; /* DPIF_FP_*. */
190 const struct nlattr *key; /* Flow to put. */
191 size_t key_len; /* Length of 'key' in bytes. */
192 const struct nlattr *actions; /* Actions to perform on flow. */
193 size_t actions_len; /* Length of 'actions' in bytes. */
196 struct dpif_flow_stats *stats; /* Optional flow statistics. */
197 int error; /* 0 or positive errno value. */
200 struct dpif_execute {
201 enum dpif_op_type type; /* Always DPIF_OP_EXECUTE. */
204 const struct nlattr *key; /* Partial flow key (only for metadata). */
205 size_t key_len; /* Length of 'key' in bytes. */
206 const struct nlattr *actions; /* Actions to execute on packet. */
207 size_t actions_len; /* Length of 'actions' in bytes. */
208 const struct ofpbuf *packet; /* Packet to execute. */
211 int error; /* 0 or positive errno value. */
215 enum dpif_op_type type;
216 struct dpif_flow_put flow_put;
217 struct dpif_execute execute;
220 void dpif_operate(struct dpif *, union dpif_op **ops, size_t n_ops);
224 enum dpif_upcall_type {
225 DPIF_UC_MISS, /* Miss in flow table. */
226 DPIF_UC_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */
230 const char *dpif_upcall_type_to_string(enum dpif_upcall_type);
232 /* A packet passed up from the datapath to userspace.
234 * If 'key' or 'actions' is nonnull, then it points into data owned by
235 * 'packet', so their memory cannot be freed separately. (This is hardly a
236 * great way to do things but it works out OK for the dpif providers and
237 * clients that exist so far.)
241 enum dpif_upcall_type type;
242 struct ofpbuf *packet; /* Packet data. */
243 struct nlattr *key; /* Flow key. */
244 size_t key_len; /* Length of 'key' in bytes. */
246 /* DPIF_UC_ACTION only. */
247 uint64_t userdata; /* Argument to OVS_ACTION_ATTR_USERSPACE. */
250 int dpif_recv_get_mask(const struct dpif *, int *listen_mask);
251 int dpif_recv_set_mask(struct dpif *, int listen_mask);
252 int dpif_recv(struct dpif *, struct dpif_upcall *);
253 void dpif_recv_purge(struct dpif *);
254 void dpif_recv_wait(struct dpif *);
258 void dpif_get_netflow_ids(const struct dpif *,
259 uint8_t *engine_type, uint8_t *engine_id);
261 int dpif_queue_to_priority(const struct dpif *, uint32_t queue_id,