Update primary code license to Apache 2.0.
[cascardo/ovs.git] / include / openvswitch / datapath-protocol.h
1 /*
2  * Copyright (c) 2009 Nicira Networks.
3  *
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
9  * license.
10  *
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:
15  *
16  *     http://www.apache.org/licenses/LICENSE-2.0
17  *
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.
28  *
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.
33  *
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  * ----------------------------------------------------------------------
38  */
39
40 /* Protocol between secchan and datapath. */
41
42 #ifndef OPENVSWITCH_DATAPATH_PROTOCOL_H
43 #define OPENVSWITCH_DATAPATH_PROTOCOL_H 1
44
45 #ifdef __KERNEL__
46 #include <linux/types.h>
47 #else
48 #include <sys/types.h>
49 #endif
50 #include <linux/if_ether.h>
51
52 #define ODP_MAX 256             /* Maximum number of datapaths. */
53
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)
57
58 #define ODP_GET_DROP_FRAGS      _IOW('O', 3, int)
59 #define ODP_SET_DROP_FRAGS      _IOR('O', 4, int)
60
61 #define ODP_GET_LISTEN_MASK     _IOW('O', 5, int)
62 #define ODP_SET_LISTEN_MASK     _IOR('O', 6, int)
63
64 #define ODP_PORT_ADD            _IOR('O', 7, struct odp_port)
65 #define ODP_PORT_DEL            _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)
68
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)
71
72 #define ODP_FLOW_GET            _IOWR('O', 13, struct odp_flow)
73 #define ODP_FLOW_GET_MULTIPLE   _IOWR('O', 14, struct odp_flowvec)
74 #define ODP_FLOW_LIST           _IOWR('O', 15, struct odp_flowvec)
75
76 #define ODP_FLOW_FLUSH          _IO('O', 16)
77 #define ODP_FLOW_PUT            _IOWR('O', 17, struct odp_flow)
78 #define ODP_FLOW_DEL            _IOWR('O', 18, struct odp_flow)
79
80 #define ODP_EXECUTE             _IOR('O', 19, struct odp_execute)
81
82 struct odp_stats {
83     /* Flows. */
84     __u32 n_flows;              /* Number of flows in flow table. */
85     __u32 cur_capacity;         /* Current flow table capacity. */
86     __u32 max_capacity;         /* Maximum expansion of flow table capacity. */
87
88     /* Ports. */
89     __u32 n_ports;              /* Current number of ports. */
90     __u32 max_ports;            /* Maximum supported number of ports. */
91     __u16 max_groups;           /* Maximum number of port groups. */
92     __u16 reserved;
93
94     /* Lookups. */
95     __u64 n_frags;               /* Number of dropped IP fragments. */
96     __u64 n_hit;                 /* Number of flow table matches. */
97     __u64 n_missed;              /* Number of flow table misses. */
98     __u64 n_lost;                /* Number of misses not sent to userspace. */
99
100     /* Queues. */
101     __u16 max_miss_queue;       /* Max length of ODPL_MISS queue. */
102     __u16 max_action_queue;     /* Max length of ODPL_ACTION queue. */
103 };
104
105 /* Logical ports. */
106 #define ODPP_LOCAL      ((__u16)0)
107 #define ODPP_NONE       ((__u16)-1)
108
109 /* Listening channels. */
110 #define _ODPL_MISS_NR   0       /* Packet missed in flow table. */
111 #define ODPL_MISS       (1 << _ODPL_MISS_NR)
112 #define _ODPL_ACTION_NR 1       /* Packet output to ODPP_CONTROLLER. */
113 #define ODPL_ACTION     (1 << _ODPL_ACTION_NR)
114 #define ODPL_ALL        (ODPL_MISS | ODPL_ACTION)
115
116 /* Format of messages read from datapath fd. */
117 struct odp_msg {
118     __u32 type;                 /* _ODPL_MISS_NR or _ODPL_ACTION_NR. */
119     __u32 length;               /* Message length, including header. */
120     __u16 port;                 /* Port on which frame was received. */
121     __u16 reserved;
122     __u32 arg;                  /* Argument value specified in action. */
123     /* Followed by packet data. */
124 };
125
126 #define ODP_PORT_INTERNAL (1 << 0) /* This port is simulated. */
127 struct odp_port {
128     char devname[16];           /* IFNAMSIZ */
129     __u16 port;
130     __u16 flags;
131     __u32 reserved2;
132 };
133
134 struct odp_portvec {
135     struct odp_port *ports;
136     int n_ports;
137 };
138
139 struct odp_port_group {
140     __u16 *ports;
141     __u16 n_ports;                /* Number of ports. */
142     __u16 group;                  /* Group number. */
143 };
144
145 struct odp_flow_stats {
146     __u64 n_packets;            /* Number of matched packets. */
147     __u64 n_bytes;              /* Number of matched bytes. */
148     __u64 used_sec;             /* Time last used. */
149     __u32 used_nsec;
150     __u8 tcp_flags;
151     __u8 ip_tos;
152     __u16 reserved;
153 };
154
155 struct odp_flow_key {
156         __be32 nw_src;               /* IP source address. */
157         __be32 nw_dst;               /* IP destination address. */
158         __u16  in_port;              /* Input switch port. */
159         __be16 dl_vlan;              /* Input VLAN. */
160         __be16 dl_type;              /* Ethernet frame type. */
161         __be16 tp_src;               /* TCP/UDP source port. */
162         __be16 tp_dst;               /* TCP/UDP destination port. */
163         __u8   dl_src[ETH_ALEN];     /* Ethernet source address. */
164         __u8   dl_dst[ETH_ALEN];     /* Ethernet destination address. */
165         __u8   nw_proto;             /* IP protocol. */
166         __u8   reserved;             /* Pad to 64 bits. */
167 };
168
169 struct odp_flow {
170     struct odp_flow_stats stats;
171     struct odp_flow_key key;
172     union odp_action *actions;
173     __u32 n_actions;
174 };
175
176 /* Flags for ODP_FLOW_PUT. */
177 #define ODPPF_CREATE        (1 << 0) /* Allow creating a new flow. */
178 #define ODPPF_MODIFY        (1 << 1) /* Allow modifying an existing flow. */
179 #define ODPPF_ZERO_STATS    (1 << 2) /* Zero the stats of an existing flow. */
180
181 /* ODP_FLOW_PUT argument. */
182 struct odp_flow_put {
183     struct odp_flow flow;
184     __u32 flags;
185 };
186
187 struct odp_flowvec {
188     struct odp_flow *flows;
189     int n_flows;
190 };
191
192 /* The VLAN id is 12 bits, so we can use the entire 16 bits to indicate
193  * special conditions.  All ones is used to match that no VLAN id was
194  * set. */
195 #define ODP_VLAN_NONE      0xffff
196
197 /* Action types. */
198 #define ODPAT_OUTPUT            0    /* Output to switch port. */
199 #define ODPAT_OUTPUT_GROUP      1    /* Output to all ports in group. */
200 #define ODPAT_CONTROLLER        2    /* Send copy to controller. */
201 #define ODPAT_SET_VLAN_VID      3    /* Set the 802.1q VLAN id. */
202 #define ODPAT_SET_VLAN_PCP      4    /* Set the 802.1q priority. */
203 #define ODPAT_STRIP_VLAN        5    /* Strip the 802.1q header. */
204 #define ODPAT_SET_DL_SRC        6    /* Ethernet source address. */
205 #define ODPAT_SET_DL_DST        7    /* Ethernet destination address. */
206 #define ODPAT_SET_NW_SRC        8    /* IP source address. */
207 #define ODPAT_SET_NW_DST        9    /* IP destination address. */
208 #define ODPAT_SET_TP_SRC        10   /* TCP/UDP source port. */
209 #define ODPAT_SET_TP_DST        11   /* TCP/UDP destination port. */
210 #define ODPAT_N_ACTIONS         12
211
212 struct odp_action_output {
213     __u16 type;                  /* ODPAT_OUTPUT. */
214     __u16 port;                  /* Output port. */
215     __u16 reserved1;
216     __u16 reserved2;
217 };
218
219 struct odp_action_output_group {
220     __u16 type;                 /* ODPAT_OUTPUT_GROUP. */
221     __u16 group;                /* Group number. */
222     __u16 reserved1;
223     __u16 reserved2;
224 };
225
226 struct odp_action_controller {
227     __u16 type;                 /* ODPAT_OUTPUT_CONTROLLER. */
228     __u16 reserved;
229     __u32 arg;                  /* Copied to struct odp_msg 'arg' member. */
230 };
231
232 /* Action structure for ODPAT_SET_VLAN_VID. */
233 struct odp_action_vlan_vid {
234     __u16 type;                  /* ODPAT_SET_VLAN_VID. */
235     __be16 vlan_vid;             /* VLAN id. */
236     __u16 reserved1;
237     __u16 reserved2;
238 };
239
240 /* Action structure for ODPAT_SET_VLAN_PCP. */
241 struct odp_action_vlan_pcp {
242     __u16 type;                  /* ODPAT_SET_VLAN_PCP. */
243     __u8 vlan_pcp;               /* VLAN priority. */
244     __u8 reserved1;
245     __u16 reserved2;
246     __u16 reserved3;
247 };
248
249 /* Action structure for ODPAT_SET_DL_SRC/DST. */
250 struct odp_action_dl_addr {
251     __u16 type;                  /* ODPAT_SET_DL_SRC/DST. */
252     __u8 dl_addr[ETH_ALEN];      /* Ethernet address. */
253 };
254
255 /* Action structure for ODPAT_SET_NW_SRC/DST. */
256 struct odp_action_nw_addr {
257     __u16 type;                 /* ODPAT_SET_TW_SRC/DST. */
258     __u16 reserved;
259     __be32 nw_addr;             /* IP address. */
260 };
261
262 /* Action structure for ODPAT_SET_TP_SRC/DST. */
263 struct odp_action_tp_port {
264     __u16 type;                  /* ODPAT_SET_TP_SRC/DST. */
265     __be16 tp_port;              /* TCP/UDP port. */
266     __u16 reserved1;
267     __u16 reserved2;
268 };
269
270 union odp_action {
271     __u16 type;
272     struct odp_action_output output;
273     struct odp_action_output_group output_group;
274     struct odp_action_controller controller;
275     struct odp_action_vlan_vid vlan_vid;
276     struct odp_action_vlan_pcp vlan_pcp;
277     struct odp_action_dl_addr dl_addr;
278     struct odp_action_nw_addr nw_addr;
279     struct odp_action_tp_port tp_port;
280 };
281
282 struct odp_execute {
283     __u16 in_port;
284     __u16 reserved1;
285     __u32 reserved2;
286
287     union odp_action *actions;
288     __u32 n_actions;
289
290     const void *data;
291     __u32 length;
292 };
293
294 /* Values below this cutoff are 802.3 packets and the two bytes
295  * following MAC addresses are used as a frame length.  Otherwise, the
296  * two bytes are used as the Ethernet type.
297  */
298 #define ODP_DL_TYPE_ETH2_CUTOFF   0x0600
299
300 /* Value of dl_type to indicate that the frame does not include an
301  * Ethernet type.
302  */
303 #define ODP_DL_TYPE_NOT_ETH_TYPE  0x05ff
304
305 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
306  * special conditions.  All ones indicates that no VLAN id was set.
307  */
308 #define ODP_VLAN_NONE      0xffff
309
310 #endif /* openvswitch/datapath-protocol.h */