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/xflow-compat.h if you change any of the
43 * structures in here. */
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 XFLOW_MAX 256 /* Maximum number of datapaths. */
67 #define XFLOW_DP_CREATE _IO('O', 0)
68 #define XFLOW_DP_DESTROY _IO('O', 1)
69 #define XFLOW_DP_STATS _IOW('O', 2, struct xflow_stats)
71 #define XFLOW_GET_DROP_FRAGS _IOW('O', 3, int)
72 #define XFLOW_SET_DROP_FRAGS _IOR('O', 4, int)
74 #define XFLOW_GET_LISTEN_MASK _IOW('O', 5, int)
75 #define XFLOW_SET_LISTEN_MASK _IOR('O', 6, int)
77 #define XFLOW_PORT_ATTACH _IOR('O', 7, struct xflow_port)
78 #define XFLOW_PORT_DETACH _IOR('O', 8, int)
79 #define XFLOW_PORT_QUERY _IOWR('O', 9, struct xflow_port)
80 #define XFLOW_PORT_LIST _IOWR('O', 10, struct xflow_portvec)
82 #define XFLOW_PORT_GROUP_SET _IOR('O', 11, struct xflow_port_group)
83 #define XFLOW_PORT_GROUP_GET _IOWR('O', 12, struct xflow_port_group)
85 #define XFLOW_FLOW_GET _IOWR('O', 13, struct xflow_flow)
86 #define XFLOW_FLOW_PUT _IOWR('O', 14, struct xflow_flow)
87 #define XFLOW_FLOW_LIST _IOWR('O', 15, struct xflow_flowvec)
88 #define XFLOW_FLOW_FLUSH _IO('O', 16)
89 #define XFLOW_FLOW_DEL _IOWR('O', 17, struct xflow_flow)
91 #define XFLOW_EXECUTE _IOR('O', 18, struct xflow_execute)
93 #define XFLOW_SET_SFLOW_PROBABILITY _IOR('O', 19, int)
94 #define XFLOW_GET_SFLOW_PROBABILITY _IOW('O', 20, int)
96 #define XFLOW_VPORT_ADD _IOR('O', 21, struct xflow_vport_add)
97 #define XFLOW_VPORT_MOD _IOR('O', 22, struct xflow_vport_mod)
98 #define XFLOW_VPORT_DEL _IO('O', 23)
99 #define XFLOW_VPORT_STATS_GET _IOWR('O', 24, struct xflow_vport_stats_req)
100 #define XFLOW_VPORT_ETHER_GET _IOWR('O', 25, struct xflow_vport_ether)
101 #define XFLOW_VPORT_ETHER_SET _IOW('O', 26, struct xflow_vport_ether)
102 #define XFLOW_VPORT_MTU_GET _IOWR('O', 27, struct xflow_vport_mtu)
103 #define XFLOW_VPORT_MTU_SET _IOW('O', 28, struct xflow_vport_mtu)
104 #define XFLOW_VPORT_STATS_SET _IOWR('O', 29, struct xflow_vport_stats_req)
108 uint32_t n_flows; /* Number of flows in flow table. */
109 uint32_t cur_capacity; /* Current flow table capacity. */
110 uint32_t max_capacity; /* Maximum expansion of flow table capacity. */
113 uint32_t n_ports; /* Current number of ports. */
114 uint32_t max_ports; /* Maximum supported number of ports. */
115 uint16_t max_groups; /* Maximum number of port groups. */
119 uint64_t n_frags; /* Number of dropped IP fragments. */
120 uint64_t n_hit; /* Number of flow table matches. */
121 uint64_t n_missed; /* Number of flow table misses. */
122 uint64_t n_lost; /* Number of misses not sent to userspace. */
125 uint16_t max_miss_queue; /* Max length of XFLOWL_MISS queue. */
126 uint16_t max_action_queue; /* Max length of XFLOWL_ACTION queue. */
127 uint16_t max_sflow_queue; /* Max length of XFLOWL_SFLOW queue. */
131 #define XFLOWP_LOCAL ((uint16_t)0)
132 #define XFLOWP_NONE ((uint16_t)-1)
133 #define XFLOWP_NORMAL ((uint16_t)-2)
135 /* Listening channels. */
136 #define _XFLOWL_MISS_NR 0 /* Packet missed in flow table. */
137 #define XFLOWL_MISS (1 << _XFLOWL_MISS_NR)
138 #define _XFLOWL_ACTION_NR 1 /* Packet output to XFLOWP_CONTROLLER. */
139 #define XFLOWL_ACTION (1 << _XFLOWL_ACTION_NR)
140 #define _XFLOWL_SFLOW_NR 2 /* sFlow samples. */
141 #define XFLOWL_SFLOW (1 << _XFLOWL_SFLOW_NR)
142 #define XFLOWL_ALL (XFLOWL_MISS | XFLOWL_ACTION | XFLOWL_SFLOW)
145 * struct xflow_msg - format of messages read from datapath fd.
146 * @type: One of the %_XFLOWL_* constants.
147 * @length: Total length of message, including this header.
148 * @port: Port that received the packet embedded in this message.
149 * @reserved: Not currently used. Should be set to 0.
150 * @arg: Argument value whose meaning depends on @type.
152 * For @type == %_XFLOWL_MISS_NR, the header is followed by packet data. The
153 * @arg member is the ID (in network byte order) of the tunnel that
154 * encapsulated this packet. It is 0 if the packet was not received on a tunnel. *
155 * For @type == %_XFLOWL_ACTION_NR, the header is followed by packet data. The
156 * @arg member is copied from the &struct xflow_action_controller that caused
157 * the &struct xflow_msg to be composed.
159 * For @type == %_XFLOWL_SFLOW_NR, the header is followed by &struct
160 * xflow_sflow_sample_header, then by an array of &union xflow_action (the
161 * number of which is specified in &struct xflow_sflow_sample_header), then by
173 * struct xflow_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 xflow_action"s immediately following this
179 * This header follows &struct xflow_msg when that structure's @type is
180 * %_XFLOWL_SFLOW_NR, and it is itself followed by an array of &union
181 * xflow_action (the number of which is specified in @n_actions) and then by
184 struct xflow_sflow_sample_header {
185 uint32_t sample_pool;
189 #define XFLOW_PORT_INTERNAL (1 << 0) /* This port is simulated. */
191 char devname[16]; /* IFNAMSIZ */
197 struct xflow_portvec {
198 struct xflow_port *ports;
202 struct xflow_port_group {
204 uint16_t n_ports; /* Number of ports. */
205 uint16_t group; /* Group number. */
208 struct xflow_flow_stats {
209 uint64_t n_packets; /* Number of matched packets. */
210 uint64_t n_bytes; /* Number of matched bytes. */
211 uint64_t used_sec; /* Time last used, in system monotonic time. */
215 uint16_t error; /* Used by XFLOW_FLOW_GET. */
219 * The datapath protocol adopts the Linux convention for TCI fields: if an
220 * 802.1Q header is present then its TCI value is used verbatim except that the
221 * CFI bit (0x1000) is always set to 1, and all-bits-zero indicates no 802.1Q
224 #define XFLOW_TCI_PRESENT 0x1000 /* CFI bit */
227 ovs_be32 tun_id; /* Encapsulating tunnel ID. */
228 ovs_be32 nw_src; /* IP source address. */
229 ovs_be32 nw_dst; /* IP destination address. */
230 uint16_t in_port; /* Input switch port. */
231 ovs_be16 dl_tci; /* All zeros if 802.1Q header absent,
232 * XFLOW_TCI_PRESENT set if present. */
233 ovs_be16 dl_type; /* Ethernet frame type. */
234 ovs_be16 tp_src; /* TCP/UDP source port. */
235 ovs_be16 tp_dst; /* TCP/UDP destination port. */
236 uint8_t dl_src[6]; /* Ethernet source address. */
237 uint8_t dl_dst[6]; /* Ethernet destination address. */
238 uint8_t nw_proto; /* IP protocol or low 8 bits of ARP opcode. */
239 uint8_t nw_tos; /* IP ToS (DSCP field, 6 bits). */
242 /* Flags for XFLOW_FLOW. */
243 #define XFLOWFF_ZERO_TCP_FLAGS (1 << 0) /* Zero the TCP flags. */
246 struct xflow_flow_stats stats;
247 struct xflow_key key;
248 union xflow_action *actions;
253 /* Flags for XFLOW_FLOW_PUT. */
254 #define XFLOWPF_CREATE (1 << 0) /* Allow creating a new flow. */
255 #define XFLOWPF_MODIFY (1 << 1) /* Allow modifying an existing flow. */
256 #define XFLOWPF_ZERO_STATS (1 << 2) /* Zero the stats of existing flow. */
258 /* XFLOW_FLOW_PUT argument. */
259 struct xflow_flow_put {
260 struct xflow_flow flow;
264 struct xflow_flowvec {
265 struct xflow_flow *flows;
270 #define XFLOWAT_OUTPUT 0 /* Output to switch port. */
271 #define XFLOWAT_OUTPUT_GROUP 1 /* Output to all ports in group. */
272 #define XFLOWAT_CONTROLLER 2 /* Send copy to controller. */
273 #define XFLOWAT_SET_DL_TCI 3 /* Set the 802.1q VLAN VID and/or PCP. */
274 #define XFLOWAT_STRIP_VLAN 4 /* Strip the 802.1q header. */
275 #define XFLOWAT_SET_DL_SRC 5 /* Ethernet source address. */
276 #define XFLOWAT_SET_DL_DST 6 /* Ethernet destination address. */
277 #define XFLOWAT_SET_NW_SRC 7 /* IP source address. */
278 #define XFLOWAT_SET_NW_DST 8 /* IP destination address. */
279 #define XFLOWAT_SET_NW_TOS 9 /* IP ToS/DSCP field (6 bits). */
280 #define XFLOWAT_SET_TP_SRC 10 /* TCP/UDP source port. */
281 #define XFLOWAT_SET_TP_DST 11 /* TCP/UDP destination port. */
282 #define XFLOWAT_SET_TUNNEL 12 /* Set the encapsulating tunnel ID. */
283 #define XFLOWAT_SET_PRIORITY 14 /* Set skb->priority. */
284 #define XFLOWAT_POP_PRIORITY 15 /* Restore original skb->priority. */
285 #define XFLOWAT_N_ACTIONS 16
287 struct xflow_action_output {
288 uint16_t type; /* XFLOWAT_OUTPUT. */
289 uint16_t port; /* Output port. */
294 struct xflow_action_output_group {
295 uint16_t type; /* XFLOWAT_OUTPUT_GROUP. */
296 uint16_t group; /* Group number. */
301 struct xflow_action_controller {
302 uint16_t type; /* XFLOWAT_OUTPUT_CONTROLLER. */
304 uint32_t arg; /* Copied to struct xflow_msg 'arg' member. */
307 struct xflow_action_tunnel {
308 uint16_t type; /* XFLOWAT_SET_TUNNEL. */
310 ovs_be32 tun_id; /* Tunnel ID. */
313 /* Action structure for XFLOWAT_SET_DL_TCI. */
314 struct xflow_action_dl_tci {
315 uint16_t type; /* XFLOWAT_SET_DL_TCI. */
316 ovs_be16 tci; /* New TCI. Bits not in mask must be zero. */
317 ovs_be16 mask; /* 0x0fff to set VID, 0xe000 to set PCP,
318 * or 0xefff to set both. */
322 /* Action structure for XFLOWAT_SET_DL_SRC/DST. */
323 struct xflow_action_dl_addr {
324 uint16_t type; /* XFLOWAT_SET_DL_SRC/DST. */
325 uint8_t dl_addr[6]; /* Ethernet address. */
328 /* Action structure for XFLOWAT_SET_NW_SRC/DST. */
329 struct xflow_action_nw_addr {
330 uint16_t type; /* XFLOWAT_SET_TW_SRC/DST. */
332 ovs_be32 nw_addr; /* IP address. */
335 struct xflow_action_nw_tos {
336 uint16_t type; /* XFLOWAT_SET_NW_TOS. */
337 uint8_t nw_tos; /* IP ToS/DSCP field (6 bits). */
343 /* Action structure for XFLOWAT_SET_PRIORITY. */
344 struct xflow_action_priority {
345 uint16_t type; /* XFLOWAT_SET_PRIORITY. */
347 uint32_t priority; /* skb->priority value. */
350 /* Action structure for XFLOWAT_SET_TP_SRC/DST. */
351 struct xflow_action_tp_port {
352 uint16_t type; /* XFLOWAT_SET_TP_SRC/DST. */
353 ovs_be16 tp_port; /* TCP/UDP port. */
360 struct xflow_action_output output;
361 struct xflow_action_output_group output_group;
362 struct xflow_action_controller controller;
363 struct xflow_action_tunnel tunnel;
364 struct xflow_action_dl_tci dl_tci;
365 struct xflow_action_dl_addr dl_addr;
366 struct xflow_action_nw_addr nw_addr;
367 struct xflow_action_nw_tos nw_tos;
368 struct xflow_action_tp_port tp_port;
369 struct xflow_action_priority priority;
372 struct xflow_execute {
377 union xflow_action *actions;
384 #define VPORT_TYPE_SIZE 16
385 struct xflow_vport_add {
386 char port_type[VPORT_TYPE_SIZE];
387 char devname[16]; /* IFNAMSIZ */
391 struct xflow_vport_mod {
392 char devname[16]; /* IFNAMSIZ */
396 struct xflow_vport_stats {
405 uint64_t rx_frame_err;
406 uint64_t rx_over_err;
411 struct xflow_vport_stats_req {
412 char devname[16]; /* IFNAMSIZ */
413 struct xflow_vport_stats stats;
416 struct xflow_vport_ether {
417 char devname[16]; /* IFNAMSIZ */
418 unsigned char ether_addr[6];
421 struct xflow_vport_mtu {
422 char devname[16]; /* IFNAMSIZ */
426 /* Values below this cutoff are 802.3 packets and the two bytes
427 * following MAC addresses are used as a frame length. Otherwise, the
428 * two bytes are used as the Ethernet type.
430 #define XFLOW_DL_TYPE_ETH2_CUTOFF 0x0600
432 /* Value of dl_type to indicate that the frame does not include an
435 #define XFLOW_DL_TYPE_NOT_ETH_TYPE 0x05ff
437 #endif /* openvswitch/xflow.h */