]>
git.proxmox.com Git - ovs.git/blob - lib/dpif.h
2 * Copyright (c) 2008, 2009, 2010 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"
42 int dp_register_provider(const struct dpif_class
*);
43 int dp_unregister_provider(const char *type
);
44 void dp_enumerate_types(struct svec
*types
);
46 int dp_enumerate_names(const char *type
, struct svec
*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 const char *dpif_name(const struct dpif
*);
55 const char *dpif_base_name(const struct dpif
*);
56 int dpif_get_all_names(const struct dpif
*, struct svec
*);
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
);
66 int dpif_port_query_by_number(const struct dpif
*, uint16_t port_no
,
68 int dpif_port_query_by_name(const struct dpif
*, const char *devname
,
70 int dpif_port_get_name(struct dpif
*, uint16_t port_no
,
71 char *name
, size_t name_size
);
73 struct dpif_port_dump
{
74 const struct dpif
*dpif
;
78 void dpif_port_dump_start(struct dpif_port_dump
*, const struct dpif
*);
79 bool dpif_port_dump_next(struct dpif_port_dump
*, struct odp_port
*);
80 int dpif_port_dump_done(struct dpif_port_dump
*);
82 /* Iterates through each ODP_PORT in DPIF, using DUMP as state.
84 * Arguments all have pointer type.
86 * If you break out of the loop, then you need to free the dump structure by
87 * hand using dpif_port_dump_done(). */
88 #define DPIF_PORT_FOR_EACH(ODP_PORT, DUMP, DPIF) \
89 for (dpif_port_dump_start(DUMP, DPIF); \
90 (dpif_port_dump_next(DUMP, ODP_PORT) \
92 : (dpif_port_dump_done(DUMP), false)); \
95 int dpif_port_poll(const struct dpif
*, char **devnamep
);
96 void dpif_port_poll_wait(const struct dpif
*);
98 int dpif_flow_flush(struct dpif
*);
99 int dpif_flow_put(struct dpif
*, struct odp_flow_put
*);
100 int dpif_flow_del(struct dpif
*, struct odp_flow
*);
101 int dpif_flow_get(const struct dpif
*, struct odp_flow
*);
102 int dpif_flow_get_multiple(const struct dpif
*, struct odp_flow
[], size_t n
);
104 struct dpif_flow_dump
{
105 const struct dpif
*dpif
;
109 void dpif_flow_dump_start(struct dpif_flow_dump
*, const struct dpif
*);
110 bool dpif_flow_dump_next(struct dpif_flow_dump
*, struct odp_flow
*);
111 int dpif_flow_dump_done(struct dpif_flow_dump
*);
113 int dpif_execute(struct dpif
*, const struct nlattr
*actions
,
114 size_t actions_len
, const struct ofpbuf
*);
116 /* A packet passed up from the datapath to userspace.
118 * If 'key' or 'actions' is nonnull, then it points into data owned by
119 * 'packet', so their memory cannot be freed separately. (This is hardly a
120 * great way to do things but it works out OK for the dpif providers and
121 * clients that exist so far.)
124 uint32_t type
; /* One of _ODPL_*_NR. */
127 struct ofpbuf
*packet
; /* Packet data. */
128 struct nlattr
*key
; /* Flow key. */
129 size_t key_len
; /* Length of 'key' in bytes. */
131 /* _ODPL_ACTION_NR only. */
132 uint64_t userdata
; /* Argument to ODPAT_CONTROLLER. */
134 /* _ODPL_SFLOW_NR only. */
135 uint32_t sample_pool
; /* # of sampling candidate packets so far. */
136 struct nlattr
*actions
; /* Associated flow actions. */
140 int dpif_recv_get_mask(const struct dpif
*, int *listen_mask
);
141 int dpif_recv_set_mask(struct dpif
*, int listen_mask
);
142 int dpif_get_sflow_probability(const struct dpif
*, uint32_t *probability
);
143 int dpif_set_sflow_probability(struct dpif
*, uint32_t probability
);
144 int dpif_recv(struct dpif
*, struct dpif_upcall
*);
145 int dpif_recv_purge(struct dpif
*);
146 void dpif_recv_wait(struct dpif
*);
148 void dpif_get_netflow_ids(const struct dpif
*,
149 uint8_t *engine_type
, uint8_t *engine_id
);
151 int dpif_queue_to_priority(const struct dpif
*, uint32_t queue_id
,