]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
e0edde6f | 2 | * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc. |
064af421 | 3 | * |
a14bc59f BP |
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: | |
064af421 | 7 | * |
a14bc59f BP |
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. | |
064af421 BP |
15 | */ |
16 | ||
17 | ||
18 | #ifndef DPIF_H | |
19 | #define DPIF_H 1 | |
20 | ||
064af421 BP |
21 | #include <stdbool.h> |
22 | #include <stddef.h> | |
23 | #include <stdint.h> | |
077257b8 | 24 | #include <linux/openvswitch.h> |
9dbb9d5e | 25 | #include "openflow/openflow.h" |
032aa6a3 | 26 | #include "netdev.h" |
9dbb9d5e | 27 | #include "util.h" |
064af421 | 28 | |
03292c46 JG |
29 | #ifdef __cplusplus |
30 | extern "C" { | |
31 | #endif | |
32 | ||
c228a364 | 33 | struct dpif; |
c97fb132 | 34 | struct ds; |
572b7068 | 35 | struct flow; |
cdee00fd | 36 | struct nlattr; |
064af421 | 37 | struct ofpbuf; |
d0c23a1a | 38 | struct sset; |
999401aa | 39 | struct dpif_class; |
064af421 | 40 | |
999401aa JG |
41 | int dp_register_provider(const struct dpif_class *); |
42 | int dp_unregister_provider(const char *type); | |
579a77e0 | 43 | void dp_blacklist_provider(const char *type); |
d0c23a1a | 44 | void dp_enumerate_types(struct sset *types); |
f79e673f | 45 | const char *dpif_normalize_type(const char *); |
999401aa | 46 | |
d0c23a1a | 47 | int dp_enumerate_names(const char *type, struct sset *names); |
1a6f1e2a | 48 | void dp_parse_name(const char *datapath_name, char **name, char **type); |
5792c5c6 | 49 | |
1a6f1e2a JG |
50 | int dpif_open(const char *name, const char *type, struct dpif **); |
51 | int dpif_create(const char *name, const char *type, struct dpif **); | |
52 | int dpif_create_and_open(const char *name, const char *type, struct dpif **); | |
064af421 BP |
53 | void dpif_close(struct dpif *); |
54 | ||
640e1b20 BP |
55 | void dpif_run(struct dpif *); |
56 | void dpif_wait(struct dpif *); | |
57 | ||
b29ba128 | 58 | const char *dpif_name(const struct dpif *); |
1a6f1e2a | 59 | const char *dpif_base_name(const struct dpif *); |
064af421 BP |
60 | |
61 | int dpif_delete(struct dpif *); | |
62 | ||
a8d9304d BP |
63 | /* Statisticss for a dpif as a whole. */ |
64 | struct dpif_dp_stats { | |
a8d9304d BP |
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. */ | |
69 | }; | |
70 | int dpif_get_dp_stats(const struct dpif *, struct dpif_dp_stats *); | |
71 | ||
6bc60024 BP |
72 | \f |
73 | /* Port operations. */ | |
064af421 | 74 | |
c3827f61 | 75 | int dpif_port_add(struct dpif *, struct netdev *, uint16_t *port_nop); |
064af421 | 76 | int dpif_port_del(struct dpif *, uint16_t port_no); |
4c738a8d BP |
77 | |
78 | /* A port within a datapath. | |
79 | * | |
80 | * 'name' and 'type' are suitable for passing to netdev_open(). */ | |
81 | struct dpif_port { | |
82 | char *name; /* Network device name, e.g. "eth0". */ | |
83 | char *type; /* Network device type, e.g. "system". */ | |
84 | uint32_t port_no; /* Port number within datapath. */ | |
85 | }; | |
86 | void dpif_port_clone(struct dpif_port *, const struct dpif_port *); | |
87 | void dpif_port_destroy(struct dpif_port *); | |
064af421 | 88 | int dpif_port_query_by_number(const struct dpif *, uint16_t port_no, |
4c738a8d | 89 | struct dpif_port *); |
064af421 | 90 | int dpif_port_query_by_name(const struct dpif *, const char *devname, |
4c738a8d | 91 | struct dpif_port *); |
335562c0 BP |
92 | int dpif_port_get_name(struct dpif *, uint16_t port_no, |
93 | char *name, size_t name_size); | |
996c1b3d | 94 | int dpif_get_max_ports(const struct dpif *); |
98403001 | 95 | uint32_t dpif_port_get_pid(const struct dpif *, uint16_t port_no); |
b0ec0f27 BP |
96 | |
97 | struct dpif_port_dump { | |
98 | const struct dpif *dpif; | |
99 | int error; | |
100 | void *state; | |
101 | }; | |
102 | void dpif_port_dump_start(struct dpif_port_dump *, const struct dpif *); | |
4c738a8d | 103 | bool dpif_port_dump_next(struct dpif_port_dump *, struct dpif_port *); |
b0ec0f27 BP |
104 | int dpif_port_dump_done(struct dpif_port_dump *); |
105 | ||
4c738a8d | 106 | /* Iterates through each DPIF_PORT in DPIF, using DUMP as state. |
b0ec0f27 BP |
107 | * |
108 | * Arguments all have pointer type. | |
109 | * | |
110 | * If you break out of the loop, then you need to free the dump structure by | |
111 | * hand using dpif_port_dump_done(). */ | |
4c738a8d | 112 | #define DPIF_PORT_FOR_EACH(DPIF_PORT, DUMP, DPIF) \ |
b0ec0f27 | 113 | for (dpif_port_dump_start(DUMP, DPIF); \ |
4c738a8d | 114 | (dpif_port_dump_next(DUMP, DPIF_PORT) \ |
b0ec0f27 BP |
115 | ? true \ |
116 | : (dpif_port_dump_done(DUMP), false)); \ | |
117 | ) | |
064af421 | 118 | |
e9e28be3 BP |
119 | int dpif_port_poll(const struct dpif *, char **devnamep); |
120 | void dpif_port_poll_wait(const struct dpif *); | |
6bc60024 BP |
121 | \f |
122 | /* Flow table operations. */ | |
e9e28be3 | 123 | |
c97fb132 BP |
124 | struct dpif_flow_stats { |
125 | uint64_t n_packets; | |
126 | uint64_t n_bytes; | |
127 | long long int used; | |
128 | uint8_t tcp_flags; | |
129 | }; | |
130 | ||
a39edbd4 | 131 | void dpif_flow_stats_extract(const struct flow *, const struct ofpbuf *packet, |
572b7068 | 132 | struct dpif_flow_stats *); |
c97fb132 BP |
133 | void dpif_flow_stats_format(const struct dpif_flow_stats *, struct ds *); |
134 | ||
ba25b8f4 BP |
135 | enum dpif_flow_put_flags { |
136 | DPIF_FP_CREATE = 1 << 0, /* Allow creating a new flow. */ | |
137 | DPIF_FP_MODIFY = 1 << 1, /* Allow modifying an existing flow. */ | |
138 | DPIF_FP_ZERO_STATS = 1 << 2 /* Zero the stats of an existing flow. */ | |
139 | }; | |
140 | ||
064af421 | 141 | int dpif_flow_flush(struct dpif *); |
ba25b8f4 | 142 | int dpif_flow_put(struct dpif *, enum dpif_flow_put_flags, |
feebdea2 BP |
143 | const struct nlattr *key, size_t key_len, |
144 | const struct nlattr *actions, size_t actions_len, | |
c97fb132 | 145 | struct dpif_flow_stats *); |
feebdea2 BP |
146 | int dpif_flow_del(struct dpif *, |
147 | const struct nlattr *key, size_t key_len, | |
c97fb132 | 148 | struct dpif_flow_stats *); |
693c4a01 | 149 | int dpif_flow_get(const struct dpif *, |
feebdea2 | 150 | const struct nlattr *key, size_t key_len, |
c97fb132 | 151 | struct ofpbuf **actionsp, struct dpif_flow_stats *); |
704a1e09 BP |
152 | |
153 | struct dpif_flow_dump { | |
154 | const struct dpif *dpif; | |
155 | int error; | |
156 | void *state; | |
157 | }; | |
158 | void dpif_flow_dump_start(struct dpif_flow_dump *, const struct dpif *); | |
feebdea2 BP |
159 | bool dpif_flow_dump_next(struct dpif_flow_dump *, |
160 | const struct nlattr **key, size_t *key_len, | |
161 | const struct nlattr **actions, size_t *actions_len, | |
c97fb132 | 162 | const struct dpif_flow_stats **); |
704a1e09 | 163 | int dpif_flow_dump_done(struct dpif_flow_dump *); |
6bc60024 BP |
164 | \f |
165 | /* Packet operations. */ | |
064af421 | 166 | |
80e5eed9 BP |
167 | int dpif_execute(struct dpif *, |
168 | const struct nlattr *key, size_t key_len, | |
169 | const struct nlattr *actions, size_t actions_len, | |
170 | const struct ofpbuf *); | |
6bc60024 BP |
171 | \f |
172 | /* Operation batching interface. | |
173 | * | |
174 | * Some datapaths are faster at performing N operations together than the same | |
175 | * N operations individually, hence an interface for batching. | |
176 | */ | |
177 | ||
178 | enum dpif_op_type { | |
179 | DPIF_OP_FLOW_PUT = 1, | |
b99d3cee BP |
180 | DPIF_OP_FLOW_DEL, |
181 | DPIF_OP_EXECUTE, | |
6bc60024 BP |
182 | }; |
183 | ||
184 | struct dpif_flow_put { | |
6bc60024 BP |
185 | /* Input. */ |
186 | enum dpif_flow_put_flags flags; /* DPIF_FP_*. */ | |
187 | const struct nlattr *key; /* Flow to put. */ | |
188 | size_t key_len; /* Length of 'key' in bytes. */ | |
189 | const struct nlattr *actions; /* Actions to perform on flow. */ | |
190 | size_t actions_len; /* Length of 'actions' in bytes. */ | |
191 | ||
192 | /* Output. */ | |
193 | struct dpif_flow_stats *stats; /* Optional flow statistics. */ | |
6bc60024 BP |
194 | }; |
195 | ||
b99d3cee BP |
196 | struct dpif_flow_del { |
197 | /* Input. */ | |
198 | const struct nlattr *key; /* Flow to delete. */ | |
199 | size_t key_len; /* Length of 'key' in bytes. */ | |
200 | ||
201 | /* Output. */ | |
202 | struct dpif_flow_stats *stats; /* Optional flow statistics. */ | |
203 | }; | |
204 | ||
6bc60024 | 205 | struct dpif_execute { |
6bc60024 BP |
206 | const struct nlattr *key; /* Partial flow key (only for metadata). */ |
207 | size_t key_len; /* Length of 'key' in bytes. */ | |
208 | const struct nlattr *actions; /* Actions to execute on packet. */ | |
209 | size_t actions_len; /* Length of 'actions' in bytes. */ | |
210 | const struct ofpbuf *packet; /* Packet to execute. */ | |
6bc60024 BP |
211 | }; |
212 | ||
c2b565b5 | 213 | struct dpif_op { |
6bc60024 | 214 | enum dpif_op_type type; |
c2b565b5 BP |
215 | int error; |
216 | union { | |
217 | struct dpif_flow_put flow_put; | |
b99d3cee | 218 | struct dpif_flow_del flow_del; |
c2b565b5 BP |
219 | struct dpif_execute execute; |
220 | } u; | |
6bc60024 BP |
221 | }; |
222 | ||
c2b565b5 | 223 | void dpif_operate(struct dpif *, struct dpif_op **ops, size_t n_ops); |
6bc60024 BP |
224 | \f |
225 | /* Upcalls. */ | |
064af421 | 226 | |
82272ede BP |
227 | enum dpif_upcall_type { |
228 | DPIF_UC_MISS, /* Miss in flow table. */ | |
df2c07f4 | 229 | DPIF_UC_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */ |
982b8810 | 230 | DPIF_N_UC_TYPES |
82272ede BP |
231 | }; |
232 | ||
01545c1a BP |
233 | const char *dpif_upcall_type_to_string(enum dpif_upcall_type); |
234 | ||
856081f6 BP |
235 | /* A packet passed up from the datapath to userspace. |
236 | * | |
237 | * If 'key' or 'actions' is nonnull, then it points into data owned by | |
238 | * 'packet', so their memory cannot be freed separately. (This is hardly a | |
239 | * great way to do things but it works out OK for the dpif providers and | |
240 | * clients that exist so far.) | |
241 | */ | |
242 | struct dpif_upcall { | |
856081f6 | 243 | /* All types. */ |
82272ede | 244 | enum dpif_upcall_type type; |
856081f6 BP |
245 | struct ofpbuf *packet; /* Packet data. */ |
246 | struct nlattr *key; /* Flow key. */ | |
247 | size_t key_len; /* Length of 'key' in bytes. */ | |
248 | ||
82272ede | 249 | /* DPIF_UC_ACTION only. */ |
df2c07f4 | 250 | uint64_t userdata; /* Argument to OVS_ACTION_ATTR_USERSPACE. */ |
856081f6 | 251 | }; |
9dbb9d5e | 252 | |
a12b3ead | 253 | int dpif_recv_set(struct dpif *, bool enable); |
90a7c55e | 254 | int dpif_recv(struct dpif *, struct dpif_upcall *, struct ofpbuf *); |
1ba530f4 | 255 | void dpif_recv_purge(struct dpif *); |
064af421 | 256 | void dpif_recv_wait(struct dpif *); |
6bc60024 BP |
257 | \f |
258 | /* Miscellaneous. */ | |
064af421 | 259 | |
53a4218d BP |
260 | void dpif_get_netflow_ids(const struct dpif *, |
261 | uint8_t *engine_type, uint8_t *engine_id); | |
064af421 | 262 | |
aae51f53 BP |
263 | int dpif_queue_to_priority(const struct dpif *, uint32_t queue_id, |
264 | uint32_t *priority); | |
265 | ||
03292c46 JG |
266 | #ifdef __cplusplus |
267 | } | |
268 | #endif | |
269 | ||
064af421 | 270 | #endif /* dpif.h */ |