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 "openflow/openflow.h"
25 #include "openvswitch/datapath-protocol.h"
43 int dp_register_provider(const struct dpif_class *);
44 int dp_unregister_provider(const char *type);
45 void dp_enumerate_types(struct sset *types);
47 int dp_enumerate_names(const char *type, struct sset *names);
48 void dp_parse_name(const char *datapath_name, char **name, char **type);
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 **);
53 void dpif_close(struct dpif *);
55 const char *dpif_name(const struct dpif *);
56 const char *dpif_base_name(const struct dpif *);
58 int dpif_delete(struct dpif *);
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);
64 int dpif_port_add(struct dpif *, struct netdev *, uint16_t *port_nop);
65 int dpif_port_del(struct dpif *, uint16_t port_no);
67 /* A port within a datapath.
69 * 'name' and 'type' are suitable for passing to netdev_open(). */
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 struct netdev_stats stats; /* Port statistics. */
76 void dpif_port_clone(struct dpif_port *, const struct dpif_port *);
77 void dpif_port_destroy(struct dpif_port *);
78 int dpif_port_query_by_number(const struct dpif *, uint16_t port_no,
80 int dpif_port_query_by_name(const struct dpif *, const char *devname,
82 int dpif_port_get_name(struct dpif *, uint16_t port_no,
83 char *name, size_t name_size);
84 int dpif_get_max_ports(const struct dpif *);
86 struct dpif_port_dump {
87 const struct dpif *dpif;
91 void dpif_port_dump_start(struct dpif_port_dump *, const struct dpif *);
92 bool dpif_port_dump_next(struct dpif_port_dump *, struct dpif_port *);
93 int dpif_port_dump_done(struct dpif_port_dump *);
95 /* Iterates through each DPIF_PORT in DPIF, using DUMP as state.
97 * Arguments all have pointer type.
99 * If you break out of the loop, then you need to free the dump structure by
100 * hand using dpif_port_dump_done(). */
101 #define DPIF_PORT_FOR_EACH(DPIF_PORT, DUMP, DPIF) \
102 for (dpif_port_dump_start(DUMP, DPIF); \
103 (dpif_port_dump_next(DUMP, DPIF_PORT) \
105 : (dpif_port_dump_done(DUMP), false)); \
108 int dpif_port_poll(const struct dpif *, char **devnamep);
109 void dpif_port_poll_wait(const struct dpif *);
111 struct dpif_flow_stats {
118 void dpif_flow_stats_format(const struct dpif_flow_stats *, struct ds *);
120 enum dpif_flow_put_flags {
121 DPIF_FP_CREATE = 1 << 0, /* Allow creating a new flow. */
122 DPIF_FP_MODIFY = 1 << 1, /* Allow modifying an existing flow. */
123 DPIF_FP_ZERO_STATS = 1 << 2 /* Zero the stats of an existing flow. */
126 int dpif_flow_flush(struct dpif *);
127 int dpif_flow_put(struct dpif *, enum dpif_flow_put_flags,
128 const struct nlattr *key, size_t key_len,
129 const struct nlattr *actions, size_t actions_len,
130 struct dpif_flow_stats *);
131 int dpif_flow_del(struct dpif *,
132 const struct nlattr *key, size_t key_len,
133 struct dpif_flow_stats *);
134 int dpif_flow_get(const struct dpif *,
135 const struct nlattr *key, size_t key_len,
136 struct ofpbuf **actionsp, struct dpif_flow_stats *);
138 struct dpif_flow_dump {
139 const struct dpif *dpif;
143 void dpif_flow_dump_start(struct dpif_flow_dump *, const struct dpif *);
144 bool dpif_flow_dump_next(struct dpif_flow_dump *,
145 const struct nlattr **key, size_t *key_len,
146 const struct nlattr **actions, size_t *actions_len,
147 const struct dpif_flow_stats **);
148 int dpif_flow_dump_done(struct dpif_flow_dump *);
150 int dpif_execute(struct dpif *, const struct nlattr *actions,
151 size_t actions_len, const struct ofpbuf *);
153 enum dpif_upcall_type {
154 DPIF_UC_MISS, /* Miss in flow table. */
155 DPIF_UC_ACTION, /* ODP_ACTION_ATTR_CONTROLLER action. */
156 DPIF_UC_SAMPLE, /* Packet sampling. */
160 /* A packet passed up from the datapath to userspace.
162 * If 'key' or 'actions' is nonnull, then it points into data owned by
163 * 'packet', so their memory cannot be freed separately. (This is hardly a
164 * great way to do things but it works out OK for the dpif providers and
165 * clients that exist so far.)
169 enum dpif_upcall_type type;
170 struct ofpbuf *packet; /* Packet data. */
171 struct nlattr *key; /* Flow key. */
172 size_t key_len; /* Length of 'key' in bytes. */
174 /* DPIF_UC_ACTION only. */
175 uint64_t userdata; /* Argument to ODP_ACTION_ATTR_CONTROLLER. */
177 /* DPIF_UC_SAMPLE only. */
178 uint32_t sample_pool; /* # of sampling candidate packets so far. */
179 struct nlattr *actions; /* Associated flow actions. */
183 int dpif_recv_get_mask(const struct dpif *, int *listen_mask);
184 int dpif_recv_set_mask(struct dpif *, int listen_mask);
185 int dpif_get_sflow_probability(const struct dpif *, uint32_t *probability);
186 int dpif_set_sflow_probability(struct dpif *, uint32_t probability);
187 int dpif_recv(struct dpif *, struct dpif_upcall *);
188 void dpif_recv_purge(struct dpif *);
189 void dpif_recv_wait(struct dpif *);
191 void dpif_get_netflow_ids(const struct dpif *,
192 uint8_t *engine_type, uint8_t *engine_id);
194 int dpif_queue_to_priority(const struct dpif *, uint32_t queue_id,