2 * Copyright (c) 2009, 2010, 2011 Nicira Networks.
4 * This file is offered under your choice of two licenses: Apache 2.0 or GNU
5 * GPL 2.0 or later. The permission statements for each of these licenses is
6 * given below. You may license your modifications to this file under either
7 * of these licenses or both. If you wish to license your modifications under
8 * only one of these licenses, delete the permission text for the other
11 * ----------------------------------------------------------------------
12 * Licensed under the Apache License, Version 2.0 (the "License");
13 * you may not use this file except in compliance with the License.
14 * You may obtain a copy of the License at:
16 * http://www.apache.org/licenses/LICENSE-2.0
18 * Unless required by applicable law or agreed to in writing, software
19 * distributed under the License is distributed on an "AS IS" BASIS,
20 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21 * See the License for the specific language governing permissions and
22 * limitations under the License.
23 * ----------------------------------------------------------------------
24 * This program is free software; you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License as published by
26 * the Free Software Foundation; either version 2 of the License, or
27 * (at your option) any later version.
29 * This program is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU General Public License for more details.
34 * You should have received a copy of the GNU General Public License along
35 * with this program; if not, write to the Free Software Foundation, Inc.,
36 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
37 * ----------------------------------------------------------------------
40 /* Protocol between userspace and kernel datapath.
42 * Be sure to update datapath/odp-compat.h if you change any of the structures
45 #ifndef OPENVSWITCH_DATAPATH_PROTOCOL_H
46 #define OPENVSWITCH_DATAPATH_PROTOCOL_H 1
48 /* The ovs_be<N> types indicate that an object is in big-endian, not
49 * native-endian, byte order. They are otherwise equivalent to uint<N>_t.
50 * The Linux kernel already has __be<N> types for this, which take on
51 * additional semantics when the "sparse" static checker is used, so we use
52 * those types when compiling the kernel. */
54 #include <linux/types.h>
55 #include <linux/socket.h>
56 #define ovs_be16 __be16
57 #define ovs_be32 __be32
58 #define ovs_be64 __be64
60 #include "openvswitch/types.h"
61 #include <sys/socket.h>
65 #define __aligned_u64 __u64 __attribute__((aligned(8)))
66 #define __aligned_be64 __be64 __attribute__((aligned(8)))
67 #define __aligned_le64 __le64 __attribute__((aligned(8)))
70 #include <linux/if_link.h>
71 #include <linux/netlink.h>
73 #define ODP_MAX 256 /* Maximum number of datapaths. */
75 #define ODP_DP_CREATE _IO('O', 0)
76 #define ODP_DP_DESTROY _IO('O', 1)
77 #define ODP_DP_STATS _IOW('O', 2, struct odp_stats)
79 #define ODP_GET_DROP_FRAGS _IOW('O', 3, int)
80 #define ODP_SET_DROP_FRAGS _IOR('O', 4, int)
82 #define ODP_GET_LISTEN_MASK _IOW('O', 5, int)
83 #define ODP_SET_LISTEN_MASK _IOR('O', 6, int)
85 #define ODP_VPORT_ATTACH _IOR('O', 7, struct odp_port)
86 #define ODP_VPORT_DETACH _IOR('O', 8, int)
87 #define ODP_VPORT_QUERY _IOWR('O', 9, struct odp_port)
88 #define ODP_VPORT_DUMP _IOWR('O', 10, struct odp_vport_dump)
90 #define ODP_FLOW_GET _IOWR('O', 13, struct odp_flowvec)
91 #define ODP_FLOW_PUT _IOWR('O', 14, struct odp_flow)
92 #define ODP_FLOW_DUMP _IOWR('O', 15, struct odp_flow_dump)
93 #define ODP_FLOW_FLUSH _IO('O', 16)
94 #define ODP_FLOW_DEL _IOWR('O', 17, struct odp_flow)
96 #define ODP_EXECUTE _IOR('O', 18, struct odp_execute)
98 #define ODP_SET_SFLOW_PROBABILITY _IOR('O', 19, int)
99 #define ODP_GET_SFLOW_PROBABILITY _IOW('O', 20, int)
101 #define ODP_VPORT_MOD _IOR('O', 22, struct odp_port)
102 #define ODP_VPORT_STATS_GET _IOWR('O', 24, struct odp_vport_stats_req)
103 #define ODP_VPORT_ETHER_GET _IOWR('O', 25, struct odp_vport_ether)
104 #define ODP_VPORT_ETHER_SET _IOW('O', 26, struct odp_vport_ether)
105 #define ODP_VPORT_MTU_GET _IOWR('O', 27, struct odp_vport_mtu)
106 #define ODP_VPORT_MTU_SET _IOW('O', 28, struct odp_vport_mtu)
107 #define ODP_VPORT_STATS_SET _IOWR('O', 29, struct odp_vport_stats_req)
111 uint32_t n_flows; /* Number of flows in flow table. */
112 uint32_t cur_capacity; /* Current flow table capacity. */
113 uint32_t max_capacity; /* Maximum expansion of flow table capacity. */
116 uint32_t n_ports; /* Current number of ports. */
117 uint32_t max_ports; /* Maximum supported number of ports. */
120 uint64_t n_frags; /* Number of dropped IP fragments. */
121 uint64_t n_hit; /* Number of flow table matches. */
122 uint64_t n_missed; /* Number of flow table misses. */
123 uint64_t n_lost; /* Number of misses not sent to userspace. */
126 uint16_t max_miss_queue; /* Max length of ODPL_MISS queue. */
127 uint16_t max_action_queue; /* Max length of ODPL_ACTION queue. */
128 uint16_t max_sflow_queue; /* Max length of ODPL_SFLOW queue. */
132 #define ODPP_LOCAL ((uint16_t)0)
133 #define ODPP_NONE ((uint16_t)-1)
135 /* Listening channels. */
136 #define _ODPL_MISS_NR 0 /* Packet missed in flow table. */
137 #define ODPL_MISS (1 << _ODPL_MISS_NR)
138 #define _ODPL_ACTION_NR 1 /* Packet output to ODPP_CONTROLLER. */
139 #define ODPL_ACTION (1 << _ODPL_ACTION_NR)
140 #define _ODPL_SFLOW_NR 2 /* sFlow samples. */
141 #define ODPL_SFLOW (1 << _ODPL_SFLOW_NR)
142 #define ODPL_ALL (ODPL_MISS | ODPL_ACTION | ODPL_SFLOW)
144 enum odp_packet_type {
145 ODP_PACKET_ATTR_UNSPEC,
146 ODP_PACKET_ATTR_TYPE, /* 32-bit enum, one of _ODP_*_NR. */
147 ODP_PACKET_ATTR_PACKET, /* Packet data. */
148 ODP_PACKET_ATTR_KEY, /* Nested ODP_KEY_ATTR_* attributes. */
149 ODP_PACKET_ATTR_USERDATA, /* 64-bit data from ODPAT_CONTROLLER. */
150 ODP_PACKET_ATTR_SAMPLE_POOL, /* # sampling candidate packets so far. */
151 ODP_PACKET_ATTR_ACTIONS, /* Nested ODPAT_* attributes. */
152 __ODP_PACKET_ATTR_MAX
155 #define ODP_PACKET_ATTR_MAX (__ODP_PACKET_ATTR_MAX - 1)
158 * struct odp_packet - header for packets passed up between kernel and
160 * @dp_idx: Number of datapath to which the packet belongs.
161 * @len: Length of complete message, including this header.
163 * The header is followed by a sequence of Netlink attributes. The
164 * %ODP_PACKET_ATTR_TYPE, %ODP_PACKET_ATTR_PACKET, and %ODP_PACKET_ATTR_KEY
165 * attributes are always present. When @type == %_ODPL_ACTION_NR, the
166 * %ODP_PACKET_ATTR_USERDATA attribute is included if it would be nonzero.
167 * When @type == %_ODPL_SFLOW_NR, the %ODP_PACKET_ATTR_SAMPLE_POOL and
168 * %ODP_PACKET_ATTR_ACTIONS attributes are included.
170 * For @type of %_ODPL_ACTION_NR, %ODP_PACKET_ATTR_PACKET reflects changes made
171 * by actions preceding %ODPAT_CONTROLLER, but %ODP_PACKET_ATTR_KEY is the flow
172 * key extracted from the packet as originally received.
179 #define VPORT_CONFIG_SIZE 32
181 char devname[16]; /* IFNAMSIZ */
182 uint32_t type; /* One of ODP_VPORT_TYPE_*. */
186 __aligned_u64 config[VPORT_CONFIG_SIZE / 8]; /* type-specific */
189 enum odp_vport_type {
190 ODP_VPORT_TYPE_UNSPEC,
191 ODP_VPORT_TYPE_NETDEV, /* network device */
192 ODP_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
193 ODP_VPORT_TYPE_PATCH, /* virtual tunnel connecting two vports */
194 ODP_VPORT_TYPE_GRE, /* GRE tunnel */
195 ODP_VPORT_TYPE_CAPWAP, /* CAPWAP tunnel */
199 #define ODP_VPORT_TYPE_MAX (__ODP_VPORT_TYPE_MAX - 1)
202 * struct odp_vport_dump - ODP_VPORT_DUMP argument.
203 * @port: Points to port structure to fill in.
204 * @port_no: Minimum port number of interest.
206 * Used to iterate through vports one at a time. The kernel fills in @port
207 * with the information for the configured port with the smallest port number
208 * greater than or equal to @port_no. If there is no such port, it sets
209 * @port->devname to the empty string.
211 struct odp_vport_dump {
212 struct odp_port *port;
216 struct odp_flow_stats {
217 uint64_t n_packets; /* Number of matched packets. */
218 uint64_t n_bytes; /* Number of matched bytes. */
219 uint64_t used_sec; /* Time last used, in system monotonic time. */
223 uint16_t error; /* Used by ODP_FLOW_GET. */
228 ODP_KEY_ATTR_TUN_ID, /* 64-bit tunnel ID */
229 ODP_KEY_ATTR_IN_PORT, /* 32-bit ODP port number */
230 ODP_KEY_ATTR_ETHERNET, /* struct odp_key_ethernet */
231 ODP_KEY_ATTR_8021Q, /* struct odp_key_8021q */
232 ODP_KEY_ATTR_ETHERTYPE, /* 16-bit Ethernet type */
233 ODP_KEY_ATTR_IPV4, /* struct odp_key_ipv4 */
234 ODP_KEY_ATTR_TCP, /* struct odp_key_tcp */
235 ODP_KEY_ATTR_UDP, /* struct odp_key_udp */
236 ODP_KEY_ATTR_ICMP, /* struct odp_key_icmp */
237 ODP_KEY_ATTR_ARP, /* struct odp_key_arp */
241 #define ODP_KEY_ATTR_MAX (__ODP_KEY_ATTR_MAX - 1)
243 struct odp_key_ethernet {
248 struct odp_key_8021q {
253 struct odp_key_ipv4 {
270 struct odp_key_icmp {
281 /* Flags for ODP_FLOW. */
282 #define ODPFF_ZERO_TCP_FLAGS (1 << 0) /* Zero the TCP flags. */
283 #define ODPFF_EOF (1 << 1) /* ODP_FLOW_DUMP: end of flow table. */
286 struct odp_flow_stats stats;
289 struct nlattr *actions;
290 uint32_t actions_len;
294 /* Flags for ODP_FLOW_PUT. */
295 #define ODPPF_CREATE (1 << 0) /* Allow creating a new flow. */
296 #define ODPPF_MODIFY (1 << 1) /* Allow modifying an existing flow. */
297 #define ODPPF_ZERO_STATS (1 << 2) /* Zero the stats of an existing flow. */
299 /* ODP_FLOW_PUT argument. */
300 struct odp_flow_put {
301 struct odp_flow flow;
306 struct odp_flow *flows;
310 /* ODP_FLOW_DUMP argument.
312 * This is used to iterate through the flow table flow-by-flow. Each
313 * ODP_FLOW_DUMP call either stores a new odp_flow into 'flow' or stores
314 * ODPFF_EOF into flow->flags to indicate that the end of the table has been
315 * reaches, and updates 'state' in-place.
317 * Before the first call, zero 'state'. The format of 'state' is otherwise
320 struct odp_flow_dump {
321 struct odp_flow *flow;
326 enum odp_action_type {
328 ODPAT_OUTPUT, /* Output to switch port. */
329 ODPAT_CONTROLLER, /* Send copy to controller. */
330 ODPAT_SET_DL_TCI, /* Set the 802.1q TCI value. */
331 ODPAT_STRIP_VLAN, /* Strip the 802.1q header. */
332 ODPAT_SET_DL_SRC, /* Ethernet source address. */
333 ODPAT_SET_DL_DST, /* Ethernet destination address. */
334 ODPAT_SET_NW_SRC, /* IPv4 source address. */
335 ODPAT_SET_NW_DST, /* IPv4 destination address. */
336 ODPAT_SET_NW_TOS, /* IP ToS/DSCP field (6 bits). */
337 ODPAT_SET_TP_SRC, /* TCP/UDP source port. */
338 ODPAT_SET_TP_DST, /* TCP/UDP destination port. */
339 ODPAT_SET_TUNNEL, /* Set the encapsulating tunnel ID. */
340 ODPAT_SET_PRIORITY, /* Set skb->priority. */
341 ODPAT_POP_PRIORITY, /* Restore original skb->priority. */
342 ODPAT_DROP_SPOOFED_ARP, /* Drop ARPs with spoofed source MAC. */
346 #define ODPAT_MAX (__ODPAT_MAX - 1)
349 struct nlattr *actions;
350 uint32_t actions_len;
356 #define VPORT_TYPE_SIZE 16
357 struct odp_vport_add {
358 char port_type[VPORT_TYPE_SIZE];
359 char devname[16]; /* IFNAMSIZ */
363 struct odp_vport_mod {
364 char devname[16]; /* IFNAMSIZ */
368 struct odp_vport_stats_req {
369 char devname[16]; /* IFNAMSIZ */
370 struct rtnl_link_stats64 stats;
373 struct odp_vport_ether {
374 char devname[16]; /* IFNAMSIZ */
375 unsigned char ether_addr[6];
378 struct odp_vport_mtu {
379 char devname[16]; /* IFNAMSIZ */
383 #endif /* openvswitch/datapath-protocol.h */