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 #ifndef OPENVSWITCH_DATAPATH_PROTOCOL_H
43 #define OPENVSWITCH_DATAPATH_PROTOCOL_H 1
46 #include <linux/types.h>
48 #include <sys/types.h>
50 #include <linux/if_ether.h>
52 #define ODP_MAX 256 /* Maximum number of datapaths. */
54 #define ODP_DP_CREATE _IO('O', 0)
55 #define ODP_DP_DESTROY _IO('O', 1)
56 #define ODP_DP_STATS _IOW('O', 2, struct odp_stats)
58 #define ODP_GET_DROP_FRAGS _IOW('O', 3, int)
59 #define ODP_SET_DROP_FRAGS _IOR('O', 4, int)
61 #define ODP_GET_LISTEN_MASK _IOW('O', 5, int)
62 #define ODP_SET_LISTEN_MASK _IOR('O', 6, int)
64 #define ODP_PORT_ATTACH _IOR('O', 7, struct odp_port)
65 #define ODP_PORT_DETACH _IOR('O', 8, int)
66 #define ODP_PORT_QUERY _IOWR('O', 9, struct odp_port)
67 #define ODP_PORT_LIST _IOWR('O', 10, struct odp_portvec)
69 #define ODP_PORT_GROUP_SET _IOR('O', 11, struct odp_port_group)
70 #define ODP_PORT_GROUP_GET _IOWR('O', 12, struct odp_port_group)
72 #define ODP_FLOW_GET _IOWR('O', 13, struct odp_flow)
73 #define ODP_FLOW_PUT _IOWR('O', 14, struct odp_flow)
74 #define ODP_FLOW_LIST _IOWR('O', 15, struct odp_flowvec)
75 #define ODP_FLOW_FLUSH _IO('O', 16)
76 #define ODP_FLOW_DEL _IOWR('O', 17, struct odp_flow)
78 #define ODP_EXECUTE _IOR('O', 18, struct odp_execute)
80 #define ODP_SET_SFLOW_PROBABILITY _IOR('O', 19, int)
81 #define ODP_GET_SFLOW_PROBABILITY _IOW('O', 20, int)
83 #define ODP_VPORT_ADD _IOR('O', 21, struct odp_vport_add)
84 #define ODP_VPORT_MOD _IOR('O', 22, struct odp_vport_mod)
85 #define ODP_VPORT_DEL _IO('O', 23)
86 #define ODP_VPORT_STATS_GET _IOWR('O', 24, struct odp_vport_stats_req)
87 #define ODP_VPORT_ETHER_GET _IOWR('O', 25, struct odp_vport_ether)
88 #define ODP_VPORT_ETHER_SET _IOW('O', 26, struct odp_vport_ether)
89 #define ODP_VPORT_MTU_GET _IOWR('O', 27, struct odp_vport_mtu)
90 #define ODP_VPORT_MTU_SET _IOW('O', 28, struct odp_vport_mtu)
94 __u32 n_flows; /* Number of flows in flow table. */
95 __u32 cur_capacity; /* Current flow table capacity. */
96 __u32 max_capacity; /* Maximum expansion of flow table capacity. */
99 __u32 n_ports; /* Current number of ports. */
100 __u32 max_ports; /* Maximum supported number of ports. */
101 __u16 max_groups; /* Maximum number of port groups. */
105 __u64 n_frags; /* Number of dropped IP fragments. */
106 __u64 n_hit; /* Number of flow table matches. */
107 __u64 n_missed; /* Number of flow table misses. */
108 __u64 n_lost; /* Number of misses not sent to userspace. */
111 __u16 max_miss_queue; /* Max length of ODPL_MISS queue. */
112 __u16 max_action_queue; /* Max length of ODPL_ACTION queue. */
113 __u16 max_sflow_queue; /* Max length of ODPL_SFLOW queue. */
117 #define ODPP_LOCAL ((__u16)0)
118 #define ODPP_NONE ((__u16)-1)
119 #define ODPP_NORMAL ((__u16)-2)
121 /* Listening channels. */
122 #define _ODPL_MISS_NR 0 /* Packet missed in flow table. */
123 #define ODPL_MISS (1 << _ODPL_MISS_NR)
124 #define _ODPL_ACTION_NR 1 /* Packet output to ODPP_CONTROLLER. */
125 #define ODPL_ACTION (1 << _ODPL_ACTION_NR)
126 #define _ODPL_SFLOW_NR 2 /* sFlow samples. */
127 #define ODPL_SFLOW (1 << _ODPL_SFLOW_NR)
128 #define ODPL_ALL (ODPL_MISS | ODPL_ACTION | ODPL_SFLOW)
131 * struct odp_msg - format of messages read from datapath fd.
132 * @type: One of the %_ODPL_* constants.
133 * @length: Total length of message, including this header.
134 * @port: Port that received the packet embedded in this message.
135 * @reserved: Not currently used. Should be set to 0.
136 * @arg: Argument value whose meaning depends on @type.
138 * For @type == %_ODPL_MISS_NR, the header is followed by packet data. The
139 * @arg member is the ID (in network byte order) of the tunnel that
140 * encapsulated this packet. It is 0 if the packet was not received on a tunnel.
142 * For @type == %_ODPL_ACTION_NR, the header is followed by packet data. The
143 * @arg member is copied from the &struct odp_action_controller that caused
144 * the &struct odp_msg to be composed.
146 * For @type == %_ODPL_SFLOW_NR, the header is followed by &struct
147 * odp_sflow_sample_header, then by an array of &union odp_action (the number
148 * of which is specified in &struct odp_sflow_sample_header), then by packet
160 * struct odp_sflow_sample_header - header added to sFlow sampled packet.
161 * @sample_pool: Number of packets that were candidates for sFlow sampling,
162 * regardless of whether they were actually chosen and sent down to userspace.
163 * @n_actions: Number of "union odp_action"s immediately following this header.
165 * This header follows &struct odp_msg when that structure's @type is
166 * %_ODPL_SFLOW_NR, and it is itself followed by an array of &union odp_action
167 * (the number of which is specified in @n_actions) and then by packet data.
169 struct odp_sflow_sample_header {
174 #define ODP_PORT_INTERNAL (1 << 0) /* This port is simulated. */
176 char devname[16]; /* IFNAMSIZ */
183 struct odp_port *ports;
187 struct odp_port_group {
189 __u16 n_ports; /* Number of ports. */
190 __u16 group; /* Group number. */
193 struct odp_flow_stats {
194 __u64 n_packets; /* Number of matched packets. */
195 __u64 n_bytes; /* Number of matched bytes. */
196 __u64 used_sec; /* Time last used. */
200 __u16 error; /* Used by ODP_FLOW_GET. */
203 struct odp_flow_key {
204 __be32 tun_id; /* Encapsulating tunnel ID. */
205 __be32 nw_src; /* IP source address. */
206 __be32 nw_dst; /* IP destination address. */
207 __u16 in_port; /* Input switch port. */
208 __be16 dl_vlan; /* Input VLAN. */
209 __be16 dl_type; /* Ethernet frame type. */
210 __be16 tp_src; /* TCP/UDP source port. */
211 __be16 tp_dst; /* TCP/UDP destination port. */
212 __u8 dl_src[ETH_ALEN]; /* Ethernet source address. */
213 __u8 dl_dst[ETH_ALEN]; /* Ethernet destination address. */
214 __u8 nw_proto; /* IP protocol or lower 8 bits of
216 __u8 dl_vlan_pcp; /* Input VLAN priority. */
217 __u8 nw_tos; /* IP ToS (DSCP field, 6 bits). */
218 __u8 reserved[3]; /* Align to 32-bits...must be zeroed. */
221 /* Flags for ODP_FLOW. */
222 #define ODPFF_ZERO_TCP_FLAGS (1 << 0) /* Zero the TCP flags. */
225 struct odp_flow_stats stats;
226 struct odp_flow_key key;
227 union odp_action *actions;
232 /* Flags for ODP_FLOW_PUT. */
233 #define ODPPF_CREATE (1 << 0) /* Allow creating a new flow. */
234 #define ODPPF_MODIFY (1 << 1) /* Allow modifying an existing flow. */
235 #define ODPPF_ZERO_STATS (1 << 2) /* Zero the stats of an existing flow. */
237 /* ODP_FLOW_PUT argument. */
238 struct odp_flow_put {
239 struct odp_flow flow;
244 struct odp_flow *flows;
248 /* The VLAN id is 12 bits, so we can use the entire 16 bits to indicate
249 * special conditions. All ones is used to match that no VLAN id was
251 #define ODP_VLAN_NONE 0xffff
254 #define ODPAT_OUTPUT 0 /* Output to switch port. */
255 #define ODPAT_OUTPUT_GROUP 1 /* Output to all ports in group. */
256 #define ODPAT_CONTROLLER 2 /* Send copy to controller. */
257 #define ODPAT_SET_VLAN_VID 3 /* Set the 802.1q VLAN id. */
258 #define ODPAT_SET_VLAN_PCP 4 /* Set the 802.1q priority. */
259 #define ODPAT_STRIP_VLAN 5 /* Strip the 802.1q header. */
260 #define ODPAT_SET_DL_SRC 6 /* Ethernet source address. */
261 #define ODPAT_SET_DL_DST 7 /* Ethernet destination address. */
262 #define ODPAT_SET_NW_SRC 8 /* IP source address. */
263 #define ODPAT_SET_NW_DST 9 /* IP destination address. */
264 #define ODPAT_SET_NW_TOS 10 /* IP ToS/DSCP field (6 bits). */
265 #define ODPAT_SET_TP_SRC 11 /* TCP/UDP source port. */
266 #define ODPAT_SET_TP_DST 12 /* TCP/UDP destination port. */
267 #define ODPAT_SET_TUNNEL 13 /* Set the encapsulating tunnel ID. */
268 #define ODPAT_N_ACTIONS 14
270 struct odp_action_output {
271 __u16 type; /* ODPAT_OUTPUT. */
272 __u16 port; /* Output port. */
277 struct odp_action_output_group {
278 __u16 type; /* ODPAT_OUTPUT_GROUP. */
279 __u16 group; /* Group number. */
284 struct odp_action_controller {
285 __u16 type; /* ODPAT_OUTPUT_CONTROLLER. */
287 __u32 arg; /* Copied to struct odp_msg 'arg' member. */
290 struct odp_action_tunnel {
291 __u16 type; /* ODPAT_SET_TUNNEL. */
293 __be32 tun_id; /* Tunnel ID. */
296 /* Action structure for ODPAT_SET_VLAN_VID. */
297 struct odp_action_vlan_vid {
298 __u16 type; /* ODPAT_SET_VLAN_VID. */
299 __be16 vlan_vid; /* VLAN id. */
304 /* Action structure for ODPAT_SET_VLAN_PCP. */
305 struct odp_action_vlan_pcp {
306 __u16 type; /* ODPAT_SET_VLAN_PCP. */
307 __u8 vlan_pcp; /* VLAN priority. */
313 /* Action structure for ODPAT_SET_DL_SRC/DST. */
314 struct odp_action_dl_addr {
315 __u16 type; /* ODPAT_SET_DL_SRC/DST. */
316 __u8 dl_addr[ETH_ALEN]; /* Ethernet address. */
319 /* Action structure for ODPAT_SET_NW_SRC/DST. */
320 struct odp_action_nw_addr {
321 __u16 type; /* ODPAT_SET_TW_SRC/DST. */
323 __be32 nw_addr; /* IP address. */
326 struct odp_action_nw_tos {
327 __u16 type; /* ODPAT_SET_NW_TOS. */
328 __u8 nw_tos; /* IP ToS/DSCP field (6 bits). */
334 /* Action structure for ODPAT_SET_TP_SRC/DST. */
335 struct odp_action_tp_port {
336 __u16 type; /* ODPAT_SET_TP_SRC/DST. */
337 __be16 tp_port; /* TCP/UDP port. */
344 struct odp_action_output output;
345 struct odp_action_output_group output_group;
346 struct odp_action_controller controller;
347 struct odp_action_tunnel tunnel;
348 struct odp_action_vlan_vid vlan_vid;
349 struct odp_action_vlan_pcp vlan_pcp;
350 struct odp_action_dl_addr dl_addr;
351 struct odp_action_nw_addr nw_addr;
352 struct odp_action_nw_tos nw_tos;
353 struct odp_action_tp_port tp_port;
361 union odp_action *actions;
368 #define VPORT_TYPE_SIZE 16
369 struct odp_vport_add {
370 char port_type[VPORT_TYPE_SIZE];
371 char devname[16]; /* IFNAMSIZ */
375 struct odp_vport_mod {
376 char devname[16]; /* IFNAMSIZ */
380 struct odp_vport_stats {
395 struct odp_vport_stats_req {
396 char devname[16]; /* IFNAMSIZ */
397 struct odp_vport_stats stats;
400 struct odp_vport_ether {
401 char devname[16]; /* IFNAMSIZ */
402 unsigned char ether_addr[ETH_ALEN];
405 struct odp_vport_mtu {
406 char devname[16]; /* IFNAMSIZ */
410 /* Values below this cutoff are 802.3 packets and the two bytes
411 * following MAC addresses are used as a frame length. Otherwise, the
412 * two bytes are used as the Ethernet type.
414 #define ODP_DL_TYPE_ETH2_CUTOFF 0x0600
416 /* Value of dl_type to indicate that the frame does not include an
419 #define ODP_DL_TYPE_NOT_ETH_TYPE 0x05ff
421 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
422 * special conditions. All ones indicates that no VLAN id was set.
424 #define ODP_VLAN_NONE 0xffff
426 #endif /* openvswitch/datapath-protocol.h */