]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
4c738a8d | 2 | * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks. |
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> | |
9dbb9d5e BP |
24 | #include "openflow/openflow.h" |
25 | #include "openvswitch/datapath-protocol.h" | |
26 | #include "util.h" | |
064af421 | 27 | |
03292c46 JG |
28 | #ifdef __cplusplus |
29 | extern "C" { | |
30 | #endif | |
31 | ||
c228a364 | 32 | struct dpif; |
c97fb132 | 33 | struct ds; |
c3827f61 | 34 | struct netdev; |
cdee00fd | 35 | struct nlattr; |
064af421 | 36 | struct ofpbuf; |
d3d22744 | 37 | struct svec; |
999401aa | 38 | struct dpif_class; |
064af421 | 39 | |
5792c5c6 BP |
40 | void dp_run(void); |
41 | void dp_wait(void); | |
999401aa JG |
42 | |
43 | int dp_register_provider(const struct dpif_class *); | |
44 | int dp_unregister_provider(const char *type); | |
1a6f1e2a | 45 | void dp_enumerate_types(struct svec *types); |
999401aa | 46 | |
1a6f1e2a JG |
47 | int dp_enumerate_names(const char *type, struct svec *names); |
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 | ||
b29ba128 | 55 | const char *dpif_name(const struct dpif *); |
1a6f1e2a | 56 | const char *dpif_base_name(const struct dpif *); |
064af421 BP |
57 | |
58 | int dpif_delete(struct dpif *); | |
59 | ||
60 | int dpif_get_dp_stats(const struct dpif *, struct odp_stats *); | |
61 | int dpif_get_drop_frags(const struct dpif *, bool *drop_frags); | |
62 | int dpif_set_drop_frags(struct dpif *, bool drop_frags); | |
63 | ||
c3827f61 | 64 | int dpif_port_add(struct dpif *, struct netdev *, uint16_t *port_nop); |
064af421 | 65 | int dpif_port_del(struct dpif *, uint16_t port_no); |
4c738a8d BP |
66 | |
67 | /* A port within a datapath. | |
68 | * | |
69 | * 'name' and 'type' are suitable for passing to netdev_open(). */ | |
70 | struct dpif_port { | |
71 | char *name; /* Network device name, e.g. "eth0". */ | |
72 | char *type; /* Network device type, e.g. "system". */ | |
73 | uint32_t port_no; /* Port number within datapath. */ | |
74 | }; | |
75 | void dpif_port_clone(struct dpif_port *, const struct dpif_port *); | |
76 | void dpif_port_destroy(struct dpif_port *); | |
064af421 | 77 | int dpif_port_query_by_number(const struct dpif *, uint16_t port_no, |
4c738a8d | 78 | struct dpif_port *); |
064af421 | 79 | int dpif_port_query_by_name(const struct dpif *, const char *devname, |
4c738a8d | 80 | struct dpif_port *); |
335562c0 BP |
81 | int dpif_port_get_name(struct dpif *, uint16_t port_no, |
82 | char *name, size_t name_size); | |
996c1b3d | 83 | int dpif_get_max_ports(const struct dpif *); |
b0ec0f27 BP |
84 | |
85 | struct dpif_port_dump { | |
86 | const struct dpif *dpif; | |
87 | int error; | |
88 | void *state; | |
89 | }; | |
90 | void dpif_port_dump_start(struct dpif_port_dump *, const struct dpif *); | |
4c738a8d | 91 | bool dpif_port_dump_next(struct dpif_port_dump *, struct dpif_port *); |
b0ec0f27 BP |
92 | int dpif_port_dump_done(struct dpif_port_dump *); |
93 | ||
4c738a8d | 94 | /* Iterates through each DPIF_PORT in DPIF, using DUMP as state. |
b0ec0f27 BP |
95 | * |
96 | * Arguments all have pointer type. | |
97 | * | |
98 | * If you break out of the loop, then you need to free the dump structure by | |
99 | * hand using dpif_port_dump_done(). */ | |
4c738a8d | 100 | #define DPIF_PORT_FOR_EACH(DPIF_PORT, DUMP, DPIF) \ |
b0ec0f27 | 101 | for (dpif_port_dump_start(DUMP, DPIF); \ |
4c738a8d | 102 | (dpif_port_dump_next(DUMP, DPIF_PORT) \ |
b0ec0f27 BP |
103 | ? true \ |
104 | : (dpif_port_dump_done(DUMP), false)); \ | |
105 | ) | |
064af421 | 106 | |
e9e28be3 BP |
107 | int dpif_port_poll(const struct dpif *, char **devnamep); |
108 | void dpif_port_poll_wait(const struct dpif *); | |
109 | ||
c97fb132 BP |
110 | struct dpif_flow_stats { |
111 | uint64_t n_packets; | |
112 | uint64_t n_bytes; | |
113 | long long int used; | |
114 | uint8_t tcp_flags; | |
115 | }; | |
116 | ||
117 | void dpif_flow_stats_format(const struct dpif_flow_stats *, struct ds *); | |
118 | ||
ba25b8f4 BP |
119 | enum dpif_flow_put_flags { |
120 | DPIF_FP_CREATE = 1 << 0, /* Allow creating a new flow. */ | |
121 | DPIF_FP_MODIFY = 1 << 1, /* Allow modifying an existing flow. */ | |
122 | DPIF_FP_ZERO_STATS = 1 << 2 /* Zero the stats of an existing flow. */ | |
123 | }; | |
124 | ||
064af421 | 125 | int dpif_flow_flush(struct dpif *); |
ba25b8f4 | 126 | int dpif_flow_put(struct dpif *, enum dpif_flow_put_flags, |
feebdea2 BP |
127 | const struct nlattr *key, size_t key_len, |
128 | const struct nlattr *actions, size_t actions_len, | |
c97fb132 | 129 | struct dpif_flow_stats *); |
feebdea2 BP |
130 | int dpif_flow_del(struct dpif *, |
131 | const struct nlattr *key, size_t key_len, | |
c97fb132 | 132 | struct dpif_flow_stats *); |
693c4a01 | 133 | int dpif_flow_get(const struct dpif *, |
feebdea2 | 134 | const struct nlattr *key, size_t key_len, |
c97fb132 | 135 | struct ofpbuf **actionsp, struct dpif_flow_stats *); |
704a1e09 BP |
136 | |
137 | struct dpif_flow_dump { | |
138 | const struct dpif *dpif; | |
139 | int error; | |
140 | void *state; | |
141 | }; | |
142 | void dpif_flow_dump_start(struct dpif_flow_dump *, const struct dpif *); | |
feebdea2 BP |
143 | bool dpif_flow_dump_next(struct dpif_flow_dump *, |
144 | const struct nlattr **key, size_t *key_len, | |
145 | const struct nlattr **actions, size_t *actions_len, | |
c97fb132 | 146 | const struct dpif_flow_stats **); |
704a1e09 | 147 | int dpif_flow_dump_done(struct dpif_flow_dump *); |
064af421 | 148 | |
cdee00fd BP |
149 | int dpif_execute(struct dpif *, const struct nlattr *actions, |
150 | size_t actions_len, const struct ofpbuf *); | |
064af421 | 151 | |
82272ede BP |
152 | enum dpif_upcall_type { |
153 | DPIF_UC_MISS, /* Miss in flow table. */ | |
154 | DPIF_UC_ACTION, /* ODPAT_CONTROLLER action. */ | |
982b8810 BP |
155 | DPIF_UC_SAMPLE, /* Packet sampling. */ |
156 | DPIF_N_UC_TYPES | |
82272ede BP |
157 | }; |
158 | ||
856081f6 BP |
159 | /* A packet passed up from the datapath to userspace. |
160 | * | |
161 | * If 'key' or 'actions' is nonnull, then it points into data owned by | |
162 | * 'packet', so their memory cannot be freed separately. (This is hardly a | |
163 | * great way to do things but it works out OK for the dpif providers and | |
164 | * clients that exist so far.) | |
165 | */ | |
166 | struct dpif_upcall { | |
856081f6 | 167 | /* All types. */ |
82272ede | 168 | enum dpif_upcall_type type; |
856081f6 BP |
169 | struct ofpbuf *packet; /* Packet data. */ |
170 | struct nlattr *key; /* Flow key. */ | |
171 | size_t key_len; /* Length of 'key' in bytes. */ | |
172 | ||
82272ede | 173 | /* DPIF_UC_ACTION only. */ |
856081f6 BP |
174 | uint64_t userdata; /* Argument to ODPAT_CONTROLLER. */ |
175 | ||
82272ede | 176 | /* DPIF_UC_SAMPLE only. */ |
856081f6 BP |
177 | uint32_t sample_pool; /* # of sampling candidate packets so far. */ |
178 | struct nlattr *actions; /* Associated flow actions. */ | |
179 | size_t actions_len; | |
180 | }; | |
9dbb9d5e | 181 | |
8f24562a BP |
182 | int dpif_recv_get_mask(const struct dpif *, int *listen_mask); |
183 | int dpif_recv_set_mask(struct dpif *, int listen_mask); | |
72b06300 BP |
184 | int dpif_get_sflow_probability(const struct dpif *, uint32_t *probability); |
185 | int dpif_set_sflow_probability(struct dpif *, uint32_t probability); | |
856081f6 | 186 | int dpif_recv(struct dpif *, struct dpif_upcall *); |
1ba530f4 | 187 | void dpif_recv_purge(struct dpif *); |
064af421 BP |
188 | void dpif_recv_wait(struct dpif *); |
189 | ||
53a4218d BP |
190 | void dpif_get_netflow_ids(const struct dpif *, |
191 | uint8_t *engine_type, uint8_t *engine_id); | |
064af421 | 192 | |
aae51f53 BP |
193 | int dpif_queue_to_priority(const struct dpif *, uint32_t queue_id, |
194 | uint32_t *priority); | |
195 | ||
03292c46 JG |
196 | #ifdef __cplusplus |
197 | } | |
198 | #endif | |
199 | ||
064af421 | 200 | #endif /* dpif.h */ |