2 * Copyright (c) 2009, 2010 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 #define ovs_be16 __be16
56 #define ovs_be32 __be32
57 #define ovs_be64 __be64
60 #define ovs_be16 uint16_t
61 #define ovs_be32 uint32_t
62 #define ovs_be64 uint64_t
65 #define ODP_MAX 256 /* Maximum number of datapaths. */
67 #define ODP_DP_CREATE _IO('O', 0)
68 #define ODP_DP_DESTROY _IO('O', 1)
69 #define ODP_DP_STATS _IOW('O', 2, struct odp_stats)
71 #define ODP_GET_DROP_FRAGS _IOW('O', 3, int)
72 #define ODP_SET_DROP_FRAGS _IOR('O', 4, int)
74 #define ODP_GET_LISTEN_MASK _IOW('O', 5, int)
75 #define ODP_SET_LISTEN_MASK _IOR('O', 6, int)
77 #define ODP_PORT_ATTACH _IOR('O', 7, struct odp_port)
78 #define ODP_PORT_DETACH _IOR('O', 8, int)
79 #define ODP_PORT_QUERY _IOWR('O', 9, struct odp_port)
80 #define ODP_PORT_LIST _IOWR('O', 10, struct odp_portvec)
82 #define ODP_PORT_GROUP_SET _IOR('O', 11, struct odp_port_group)
83 #define ODP_PORT_GROUP_GET _IOWR('O', 12, struct odp_port_group)
85 #define ODP_FLOW_GET _IOWR('O', 13, struct odp_flow)
86 #define ODP_FLOW_PUT _IOWR('O', 14, struct odp_flow)
87 #define ODP_FLOW_LIST _IOWR('O', 15, struct odp_flowvec)
88 #define ODP_FLOW_FLUSH _IO('O', 16)
89 #define ODP_FLOW_DEL _IOWR('O', 17, struct odp_flow)
91 #define ODP_EXECUTE _IOR('O', 18, struct odp_execute)
93 #define ODP_SET_SFLOW_PROBABILITY _IOR('O', 19, int)
94 #define ODP_GET_SFLOW_PROBABILITY _IOW('O', 20, int)
96 #define ODP_VPORT_ADD _IOR('O', 21, struct odp_vport_add)
97 #define ODP_VPORT_MOD _IOR('O', 22, struct odp_vport_mod)
98 #define ODP_VPORT_DEL _IO('O', 23)
99 #define ODP_VPORT_STATS_GET _IOWR('O', 24, struct odp_vport_stats_req)
100 #define ODP_VPORT_ETHER_GET _IOWR('O', 25, struct odp_vport_ether)
101 #define ODP_VPORT_ETHER_SET _IOW('O', 26, struct odp_vport_ether)
102 #define ODP_VPORT_MTU_GET _IOWR('O', 27, struct odp_vport_mtu)
103 #define ODP_VPORT_MTU_SET _IOW('O', 28, struct odp_vport_mtu)
107 uint32_t n_flows; /* Number of flows in flow table. */
108 uint32_t cur_capacity; /* Current flow table capacity. */
109 uint32_t max_capacity; /* Maximum expansion of flow table capacity. */
112 uint32_t n_ports; /* Current number of ports. */
113 uint32_t max_ports; /* Maximum supported number of ports. */
114 uint16_t max_groups; /* Maximum number of port groups. */
118 uint64_t n_frags; /* Number of dropped IP fragments. */
119 uint64_t n_hit; /* Number of flow table matches. */
120 uint64_t n_missed; /* Number of flow table misses. */
121 uint64_t n_lost; /* Number of misses not sent to userspace. */
124 uint16_t max_miss_queue; /* Max length of ODPL_MISS queue. */
125 uint16_t max_action_queue; /* Max length of ODPL_ACTION queue. */
126 uint16_t max_sflow_queue; /* Max length of ODPL_SFLOW queue. */
130 #define ODPP_LOCAL ((uint16_t)0)
131 #define ODPP_NONE ((uint16_t)-1)
132 #define ODPP_NORMAL ((uint16_t)-2)
134 /* Listening channels. */
135 #define _ODPL_MISS_NR 0 /* Packet missed in flow table. */
136 #define ODPL_MISS (1 << _ODPL_MISS_NR)
137 #define _ODPL_ACTION_NR 1 /* Packet output to ODPP_CONTROLLER. */
138 #define ODPL_ACTION (1 << _ODPL_ACTION_NR)
139 #define _ODPL_SFLOW_NR 2 /* sFlow samples. */
140 #define ODPL_SFLOW (1 << _ODPL_SFLOW_NR)
141 #define ODPL_ALL (ODPL_MISS | ODPL_ACTION | ODPL_SFLOW)
144 * struct odp_msg - format of messages read from datapath fd.
145 * @type: One of the %_ODPL_* constants.
146 * @length: Total length of message, including this header.
147 * @port: Port that received the packet embedded in this message.
148 * @reserved: Not currently used. Should be set to 0.
149 * @arg: Argument value whose meaning depends on @type.
151 * For @type == %_ODPL_MISS_NR, the header is followed by packet data. The
152 * @arg member is the ID (in network byte order) of the tunnel that
153 * encapsulated this packet. It is 0 if the packet was not received on a tunnel.
155 * For @type == %_ODPL_ACTION_NR, the header is followed by packet data. The
156 * @arg member is copied from the &struct odp_action_controller that caused
157 * the &struct odp_msg to be composed.
159 * For @type == %_ODPL_SFLOW_NR, the header is followed by &struct
160 * odp_sflow_sample_header, then by an array of &union odp_action (the number
161 * of which is specified in &struct odp_sflow_sample_header), then by packet
173 * struct odp_sflow_sample_header - header added to sFlow sampled packet.
174 * @sample_pool: Number of packets that were candidates for sFlow sampling,
175 * regardless of whether they were actually chosen and sent down to userspace.
176 * @n_actions: Number of "union odp_action"s immediately following this header.
178 * This header follows &struct odp_msg when that structure's @type is
179 * %_ODPL_SFLOW_NR, and it is itself followed by an array of &union odp_action
180 * (the number of which is specified in @n_actions) and then by packet data.
182 struct odp_sflow_sample_header {
183 uint32_t sample_pool;
187 #define ODP_PORT_INTERNAL (1 << 0) /* This port is simulated. */
189 char devname[16]; /* IFNAMSIZ */
196 struct odp_port *ports;
200 struct odp_port_group {
202 uint16_t n_ports; /* Number of ports. */
203 uint16_t group; /* Group number. */
206 struct odp_flow_stats {
207 uint64_t n_packets; /* Number of matched packets. */
208 uint64_t n_bytes; /* Number of matched bytes. */
209 uint64_t used_sec; /* Time last used. */
213 uint16_t error; /* Used by ODP_FLOW_GET. */
216 struct odp_flow_key {
217 ovs_be32 tun_id; /* Encapsulating tunnel ID. */
218 ovs_be32 nw_src; /* IP source address. */
219 ovs_be32 nw_dst; /* IP destination address. */
220 uint16_t in_port; /* Input switch port. */
221 ovs_be16 dl_vlan; /* Input VLAN. */
222 ovs_be16 dl_type; /* Ethernet frame type. */
223 ovs_be16 tp_src; /* TCP/UDP source port. */
224 ovs_be16 tp_dst; /* TCP/UDP destination port. */
225 uint8_t dl_src[6]; /* Ethernet source address. */
226 uint8_t dl_dst[6]; /* Ethernet destination address. */
227 uint8_t nw_proto; /* IP protocol or lower 8 bits of
229 uint8_t dl_vlan_pcp; /* Input VLAN priority. */
230 uint8_t nw_tos; /* IP ToS (DSCP field, 6 bits). */
231 uint8_t reserved[3]; /* Align to 32-bits...must be zeroed. */
234 /* Flags for ODP_FLOW. */
235 #define ODPFF_ZERO_TCP_FLAGS (1 << 0) /* Zero the TCP flags. */
238 struct odp_flow_stats stats;
239 struct odp_flow_key key;
240 union odp_action *actions;
245 /* Flags for ODP_FLOW_PUT. */
246 #define ODPPF_CREATE (1 << 0) /* Allow creating a new flow. */
247 #define ODPPF_MODIFY (1 << 1) /* Allow modifying an existing flow. */
248 #define ODPPF_ZERO_STATS (1 << 2) /* Zero the stats of an existing flow. */
250 /* ODP_FLOW_PUT argument. */
251 struct odp_flow_put {
252 struct odp_flow flow;
257 struct odp_flow *flows;
261 /* The VLAN id is 12 bits, so we can use the entire 16 bits to indicate
262 * special conditions. All ones is used to match that no VLAN id was
264 #define ODP_VLAN_NONE 0xffff
267 #define ODPAT_OUTPUT 0 /* Output to switch port. */
268 #define ODPAT_OUTPUT_GROUP 1 /* Output to all ports in group. */
269 #define ODPAT_CONTROLLER 2 /* Send copy to controller. */
270 #define ODPAT_SET_VLAN_VID 3 /* Set the 802.1q VLAN id. */
271 #define ODPAT_SET_VLAN_PCP 4 /* Set the 802.1q priority. */
272 #define ODPAT_STRIP_VLAN 5 /* Strip the 802.1q header. */
273 #define ODPAT_SET_DL_SRC 6 /* Ethernet source address. */
274 #define ODPAT_SET_DL_DST 7 /* Ethernet destination address. */
275 #define ODPAT_SET_NW_SRC 8 /* IP source address. */
276 #define ODPAT_SET_NW_DST 9 /* IP destination address. */
277 #define ODPAT_SET_NW_TOS 10 /* IP ToS/DSCP field (6 bits). */
278 #define ODPAT_SET_TP_SRC 11 /* TCP/UDP source port. */
279 #define ODPAT_SET_TP_DST 12 /* TCP/UDP destination port. */
280 #define ODPAT_SET_TUNNEL 13 /* Set the encapsulating tunnel ID. */
281 #define ODPAT_N_ACTIONS 14
283 struct odp_action_output {
284 uint16_t type; /* ODPAT_OUTPUT. */
285 uint16_t port; /* Output port. */
290 struct odp_action_output_group {
291 uint16_t type; /* ODPAT_OUTPUT_GROUP. */
292 uint16_t group; /* Group number. */
297 struct odp_action_controller {
298 uint16_t type; /* ODPAT_OUTPUT_CONTROLLER. */
300 uint32_t arg; /* Copied to struct odp_msg 'arg' member. */
303 struct odp_action_tunnel {
304 uint16_t type; /* ODPAT_SET_TUNNEL. */
306 ovs_be32 tun_id; /* Tunnel ID. */
309 /* Action structure for ODPAT_SET_VLAN_VID. */
310 struct odp_action_vlan_vid {
311 uint16_t type; /* ODPAT_SET_VLAN_VID. */
312 ovs_be16 vlan_vid; /* VLAN id. */
317 /* Action structure for ODPAT_SET_VLAN_PCP. */
318 struct odp_action_vlan_pcp {
319 uint16_t type; /* ODPAT_SET_VLAN_PCP. */
320 uint8_t vlan_pcp; /* VLAN priority. */
326 /* Action structure for ODPAT_SET_DL_SRC/DST. */
327 struct odp_action_dl_addr {
328 uint16_t type; /* ODPAT_SET_DL_SRC/DST. */
329 uint8_t dl_addr[6]; /* Ethernet address. */
332 /* Action structure for ODPAT_SET_NW_SRC/DST. */
333 struct odp_action_nw_addr {
334 uint16_t type; /* ODPAT_SET_TW_SRC/DST. */
336 ovs_be32 nw_addr; /* IP address. */
339 struct odp_action_nw_tos {
340 uint16_t type; /* ODPAT_SET_NW_TOS. */
341 uint8_t nw_tos; /* IP ToS/DSCP field (6 bits). */
347 /* Action structure for ODPAT_SET_TP_SRC/DST. */
348 struct odp_action_tp_port {
349 uint16_t type; /* ODPAT_SET_TP_SRC/DST. */
350 ovs_be16 tp_port; /* TCP/UDP port. */
357 struct odp_action_output output;
358 struct odp_action_output_group output_group;
359 struct odp_action_controller controller;
360 struct odp_action_tunnel tunnel;
361 struct odp_action_vlan_vid vlan_vid;
362 struct odp_action_vlan_pcp vlan_pcp;
363 struct odp_action_dl_addr dl_addr;
364 struct odp_action_nw_addr nw_addr;
365 struct odp_action_nw_tos nw_tos;
366 struct odp_action_tp_port tp_port;
374 union odp_action *actions;
381 #define VPORT_TYPE_SIZE 16
382 struct odp_vport_add {
383 char port_type[VPORT_TYPE_SIZE];
384 char devname[16]; /* IFNAMSIZ */
388 struct odp_vport_mod {
389 char devname[16]; /* IFNAMSIZ */
393 struct odp_vport_stats {
402 uint64_t rx_frame_err;
403 uint64_t rx_over_err;
408 struct odp_vport_stats_req {
409 char devname[16]; /* IFNAMSIZ */
410 struct odp_vport_stats stats;
413 struct odp_vport_ether {
414 char devname[16]; /* IFNAMSIZ */
415 unsigned char ether_addr[6];
418 struct odp_vport_mtu {
419 char devname[16]; /* IFNAMSIZ */
423 /* Values below this cutoff are 802.3 packets and the two bytes
424 * following MAC addresses are used as a frame length. Otherwise, the
425 * two bytes are used as the Ethernet type.
427 #define ODP_DL_TYPE_ETH2_CUTOFF 0x0600
429 /* Value of dl_type to indicate that the frame does not include an
432 #define ODP_DL_TYPE_NOT_ETH_TYPE 0x05ff
434 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
435 * special conditions. All ones indicates that no VLAN id was set.
437 #define ODP_VLAN_NONE 0xffff
439 #endif /* openvswitch/datapath-protocol.h */