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_NEW _IOR('O', 7, struct odp_vport)
86 #define ODP_VPORT_DEL _IOR('O', 8, struct odp_vport)
87 #define ODP_VPORT_GET _IOWR('O', 9, struct odp_vport)
88 #define ODP_VPORT_SET _IOR('O', 22, struct odp_vport)
89 #define ODP_VPORT_DUMP _IOWR('O', 10, struct odp_vport)
91 #define ODP_FLOW_GET _IOWR('O', 13, struct odp_flow)
92 #define ODP_FLOW_PUT _IOWR('O', 14, struct odp_flow)
93 #define ODP_FLOW_DUMP _IOWR('O', 15, struct odp_flow_dump)
94 #define ODP_FLOW_FLUSH _IO('O', 16)
95 #define ODP_FLOW_DEL _IOWR('O', 17, struct odp_flow)
97 #define ODP_EXECUTE _IOR('O', 18, struct odp_execute)
99 #define ODP_SET_SFLOW_PROBABILITY _IOR('O', 19, int)
100 #define ODP_GET_SFLOW_PROBABILITY _IOW('O', 20, int)
103 uint64_t n_frags; /* Number of dropped IP fragments. */
104 uint64_t n_hit; /* Number of flow table matches. */
105 uint64_t n_missed; /* Number of flow table misses. */
106 uint64_t n_lost; /* Number of misses not sent to userspace. */
110 #define ODPP_LOCAL ((uint16_t)0)
111 #define ODPP_NONE ((uint16_t)-1)
113 /* Listening channels. */
114 #define _ODPL_MISS_NR 0 /* Packet missed in flow table. */
115 #define ODPL_MISS (1 << _ODPL_MISS_NR)
116 #define _ODPL_ACTION_NR 1 /* Packet output to ODPP_CONTROLLER. */
117 #define ODPL_ACTION (1 << _ODPL_ACTION_NR)
118 #define _ODPL_SFLOW_NR 2 /* sFlow samples. */
119 #define ODPL_SFLOW (1 << _ODPL_SFLOW_NR)
120 #define ODPL_ALL (ODPL_MISS | ODPL_ACTION | ODPL_SFLOW)
122 enum odp_packet_type {
123 ODP_PACKET_ATTR_UNSPEC,
124 ODP_PACKET_ATTR_TYPE, /* 32-bit enum, one of _ODP_*_NR. */
125 ODP_PACKET_ATTR_PACKET, /* Packet data. */
126 ODP_PACKET_ATTR_KEY, /* Nested ODP_KEY_ATTR_* attributes. */
127 ODP_PACKET_ATTR_USERDATA, /* 64-bit data from ODPAT_CONTROLLER. */
128 ODP_PACKET_ATTR_SAMPLE_POOL, /* # sampling candidate packets so far. */
129 ODP_PACKET_ATTR_ACTIONS, /* Nested ODPAT_* attributes. */
130 __ODP_PACKET_ATTR_MAX
133 #define ODP_PACKET_ATTR_MAX (__ODP_PACKET_ATTR_MAX - 1)
136 * struct odp_packet - header for packets passed up between kernel and
138 * @dp_idx: Number of datapath to which the packet belongs.
139 * @len: Length of complete message, including this header.
141 * The header is followed by a sequence of Netlink attributes. The
142 * %ODP_PACKET_ATTR_TYPE, %ODP_PACKET_ATTR_PACKET, and %ODP_PACKET_ATTR_KEY
143 * attributes are always present. When @type == %_ODPL_ACTION_NR, the
144 * %ODP_PACKET_ATTR_USERDATA attribute is included if it would be nonzero.
145 * When @type == %_ODPL_SFLOW_NR, the %ODP_PACKET_ATTR_SAMPLE_POOL and
146 * %ODP_PACKET_ATTR_ACTIONS attributes are included.
148 * For @type of %_ODPL_ACTION_NR, %ODP_PACKET_ATTR_PACKET reflects changes made
149 * by actions preceding %ODPAT_CONTROLLER, but %ODP_PACKET_ATTR_KEY is the flow
150 * key extracted from the packet as originally received.
157 enum odp_vport_type {
158 ODP_VPORT_TYPE_UNSPEC,
159 ODP_VPORT_TYPE_NETDEV, /* network device */
160 ODP_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
161 ODP_VPORT_TYPE_PATCH, /* virtual tunnel connecting two vports */
162 ODP_VPORT_TYPE_GRE, /* GRE tunnel */
163 ODP_VPORT_TYPE_CAPWAP, /* CAPWAP tunnel */
167 #define ODP_VPORT_TYPE_MAX (__ODP_VPORT_TYPE_MAX - 1)
170 * struct odp_vport - header with basic information about a virtual port.
171 * @dp_idx: Number of datapath to which the vport belongs.
172 * @len: Length of this structure plus the Netlink attributes following it.
173 * @total_len: Total space available for kernel reply to request.
175 * Followed by &struct nlattr attributes, whose types are drawn from
176 * %ODP_VPORT_ATTR_*, up to a length of @len bytes including the &struct
186 ODP_VPORT_ATTR_UNSPEC,
187 ODP_VPORT_ATTR_PORT_NO, /* port number within datapath */
188 ODP_VPORT_ATTR_TYPE, /* 32-bit ODP_VPORT_TYPE_* constant. */
189 ODP_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */
190 ODP_VPORT_ATTR_STATS, /* struct rtnl_link_stats64 */
191 ODP_VPORT_ATTR_ADDRESS, /* hardware address */
192 ODP_VPORT_ATTR_MTU, /* 32-bit maximum transmission unit */
193 ODP_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
194 ODP_VPORT_ATTR_IFINDEX, /* 32-bit ifindex of backing netdev */
195 ODP_VPORT_ATTR_IFLINK, /* 32-bit ifindex on which packets are sent */
199 #define ODP_VPORT_ATTR_MAX (__ODP_VPORT_ATTR_MAX - 1)
201 /* ODP_VPORT_ATTR_OPTIONS attributes for patch vports. */
203 ODP_PATCH_ATTR_UNSPEC,
204 ODP_PATCH_ATTR_PEER, /* name of peer vport, as a string */
208 #define ODP_PATCH_ATTR_MAX (__ODP_PATCH_ATTR_MAX - 1)
210 struct odp_flow_stats {
211 uint64_t n_packets; /* Number of matched packets. */
212 uint64_t n_bytes; /* Number of matched bytes. */
213 uint64_t used_sec; /* Time last used, in system monotonic time. */
221 ODP_KEY_ATTR_TUN_ID, /* 64-bit tunnel ID */
222 ODP_KEY_ATTR_IN_PORT, /* 32-bit ODP port number */
223 ODP_KEY_ATTR_ETHERNET, /* struct odp_key_ethernet */
224 ODP_KEY_ATTR_8021Q, /* struct odp_key_8021q */
225 ODP_KEY_ATTR_ETHERTYPE, /* 16-bit Ethernet type */
226 ODP_KEY_ATTR_IPV4, /* struct odp_key_ipv4 */
227 ODP_KEY_ATTR_TCP, /* struct odp_key_tcp */
228 ODP_KEY_ATTR_UDP, /* struct odp_key_udp */
229 ODP_KEY_ATTR_ICMP, /* struct odp_key_icmp */
230 ODP_KEY_ATTR_ARP, /* struct odp_key_arp */
234 #define ODP_KEY_ATTR_MAX (__ODP_KEY_ATTR_MAX - 1)
236 struct odp_key_ethernet {
241 struct odp_key_8021q {
246 struct odp_key_ipv4 {
263 struct odp_key_icmp {
276 struct odp_flow_stats stats;
279 struct nlattr *actions;
280 uint32_t actions_len;
283 /* Flags for ODP_FLOW_PUT. */
284 #define ODPPF_CREATE (1 << 0) /* Allow creating a new flow. */
285 #define ODPPF_MODIFY (1 << 1) /* Allow modifying an existing flow. */
286 #define ODPPF_ZERO_STATS (1 << 2) /* Zero the stats of an existing flow. */
288 /* ODP_FLOW_PUT argument. */
289 struct odp_flow_put {
290 struct odp_flow flow;
294 /* ODP_FLOW_DUMP argument.
296 * This is used to iterate through the flow table flow-by-flow. Each
297 * ODP_FLOW_DUMP call either stores a new odp_flow into 'flow' or stores 0 into
298 * flow->key_len to indicate that the end of the table has been reached, and
299 * updates 'state' in-place.
301 * Before the first call, zero 'state'. The format of 'state' is otherwise
304 struct odp_flow_dump {
306 struct odp_flow *flow;
311 enum odp_action_type {
313 ODPAT_OUTPUT, /* Output to switch port. */
314 ODPAT_CONTROLLER, /* Send copy to controller. */
315 ODPAT_SET_DL_TCI, /* Set the 802.1q TCI value. */
316 ODPAT_STRIP_VLAN, /* Strip the 802.1q header. */
317 ODPAT_SET_DL_SRC, /* Ethernet source address. */
318 ODPAT_SET_DL_DST, /* Ethernet destination address. */
319 ODPAT_SET_NW_SRC, /* IPv4 source address. */
320 ODPAT_SET_NW_DST, /* IPv4 destination address. */
321 ODPAT_SET_NW_TOS, /* IP ToS/DSCP field (6 bits). */
322 ODPAT_SET_TP_SRC, /* TCP/UDP source port. */
323 ODPAT_SET_TP_DST, /* TCP/UDP destination port. */
324 ODPAT_SET_TUNNEL, /* Set the encapsulating tunnel ID. */
325 ODPAT_SET_PRIORITY, /* Set skb->priority. */
326 ODPAT_POP_PRIORITY, /* Restore original skb->priority. */
327 ODPAT_DROP_SPOOFED_ARP, /* Drop ARPs with spoofed source MAC. */
331 #define ODPAT_MAX (__ODPAT_MAX - 1)
336 struct nlattr *actions;
337 uint32_t actions_len;
343 #endif /* openvswitch/datapath-protocol.h */