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 #ifndef OPENVSWITCH_DATAPATH_PROTOCOL_H
41 #define OPENVSWITCH_DATAPATH_PROTOCOL_H 1
44 #include <linux/types.h>
45 #include <linux/socket.h>
46 #define ovs_be16 __be16
47 #define ovs_be32 __be32
48 #define ovs_be64 __be64
50 #include "openvswitch/types.h"
51 #include <sys/socket.h>
54 #include <linux/netlink.h>
58 #define OVS_DATAPATH_FAMILY "ovs_datapath"
59 #define OVS_DATAPATH_MCGROUP "ovs_datapath"
61 enum ovs_datapath_cmd {
70 * struct ovs_header - header for OVS Generic Netlink messages.
71 * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
72 * specific to a datapath).
74 * Attributes following the header are specific to a particular OVS Generic
75 * Netlink family, but all of the OVS families use this header.
82 * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
83 * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
84 * port". This is the name of the network device whose dp_ifindex is given in
85 * the &struct ovs_header. Always present in notifications. Required in
86 * %OVS_DP_NEW requests. May be used as an alternative to specifying
87 * dp_ifindex in other requests (with a dp_ifindex of 0).
88 * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
89 * set on the datapath port (for OVS_ACTION_ATTR_MISS). Only valid on
90 * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
92 * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
93 * datapath. Always present in notifications.
94 * @OVS_DP_ATTR_IPV4_FRAGS: One of %OVS_DP_FRAG_*. Always present in
95 * notifications. May be included in %OVS_DP_NEW or %OVS_DP_SET requests to
96 * change the fragment handling policy.
97 * @OVS_DP_ATTR_SAMPLING: 32-bit fraction of packets to sample with
98 * @OVS_PACKET_CMD_SAMPLE. A value of 0 samples no packets, a value of
99 * %UINT32_MAX samples all packets, and intermediate values sample intermediate
100 * fractions of packets.
102 * These attributes follow the &struct ovs_header within the Generic Netlink
103 * payload for %OVS_DP_* commands.
105 enum ovs_datapath_attr {
107 OVS_DP_ATTR_NAME, /* name of dp_ifindex netdev */
108 OVS_DP_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */
109 OVS_DP_ATTR_STATS, /* struct ovs_dp_stats */
110 OVS_DP_ATTR_IPV4_FRAGS, /* 32-bit enum ovs_frag_handling */
111 OVS_DP_ATTR_SAMPLING, /* 32-bit fraction of packets to sample. */
115 #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
118 * enum ovs_frag_handling - policy for handling received IPv4 fragments.
119 * @OVS_DP_FRAG_ZERO: Treat IP fragments as IP protocol 0 and transport ports
121 * @OVS_DP_FRAG_DROP: Drop IP fragments. Do not pass them through the flow
122 * table or up to userspace.
124 enum ovs_frag_handling {
126 OVS_DP_FRAG_ZERO, /* Treat IP fragments as transport port 0. */
127 OVS_DP_FRAG_DROP /* Drop IP fragments. */
130 struct ovs_dp_stats {
131 uint64_t n_frags; /* Number of dropped IP fragments. */
132 uint64_t n_hit; /* Number of flow table matches. */
133 uint64_t n_missed; /* Number of flow table misses. */
134 uint64_t n_lost; /* Number of misses not sent to userspace. */
135 uint64_t n_flows; /* Number of flows present */
138 struct ovs_vport_stats {
139 uint64_t rx_packets; /* total packets received */
140 uint64_t tx_packets; /* total packets transmitted */
141 uint64_t rx_bytes; /* total bytes received */
142 uint64_t tx_bytes; /* total bytes transmitted */
143 uint64_t rx_errors; /* bad packets received */
144 uint64_t tx_errors; /* packet transmit problems */
145 uint64_t rx_dropped; /* no space in linux buffers */
146 uint64_t tx_dropped; /* no space available in linux */
150 #define OVSP_LOCAL ((uint16_t)0)
152 #define OVS_PACKET_FAMILY "ovs_packet"
154 enum ovs_packet_cmd {
155 OVS_PACKET_CMD_UNSPEC,
157 /* Kernel-to-user notifications. */
158 OVS_PACKET_CMD_MISS, /* Flow table miss. */
159 OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */
160 OVS_PACKET_CMD_SAMPLE, /* Sampled packet. */
163 OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */
167 * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
168 * @OVS_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire
169 * packet as received, from the start of the Ethernet header onward. For
170 * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
171 * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
172 * the flow key extracted from the packet as originally received.
173 * @OVS_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key
174 * extracted from the packet as nested %OVS_KEY_ATTR_* attributes. This allows
175 * userspace to adapt its flow setup strategy by comparing its notion of the
176 * flow key against the kernel's.
177 * @OVS_PACKET_ATTR_UPCALL_PID: Optionally present for OVS_PACKET_CMD_EXECUTE.
178 * The Netlink socket in userspace that OVS_PACKET_CMD_USERSPACE and
179 * OVS_PACKET_CMD_SAMPLE upcalls will be directed to for actions triggered by
180 * this packet. A value of zero indicates that upcalls should not be sent.
181 * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
182 * notification if the %OVS_ACTION_ATTR_USERSPACE, action's argument was
184 * @OVS_PACKET_ATTR_SAMPLE_POOL: Present for %OVS_PACKET_CMD_SAMPLE. Contains
185 * the number of packets processed so far that were candidates for sampling.
186 * @OVS_PACKET_ATTR_ACTIONS: Present for %OVS_PACKET_CMD_SAMPLE. Contains a
187 * copy of the actions applied to the packet, as nested %OVS_ACTION_ATTR_*
190 * These attributes follow the &struct ovs_header within the Generic Netlink
191 * payload for %OVS_PACKET_* commands.
193 enum ovs_packet_attr {
194 OVS_PACKET_ATTR_UNSPEC,
195 OVS_PACKET_ATTR_PACKET, /* Packet data. */
196 OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */
197 OVS_PACKET_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls. */
198 OVS_PACKET_ATTR_USERDATA, /* u64 OVS_ACTION_ATTR_USERSPACE arg. */
199 OVS_PACKET_ATTR_SAMPLE_POOL, /* # sampling candidate packets so far. */
200 OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
201 __OVS_PACKET_ATTR_MAX
204 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
206 enum ovs_vport_type {
207 OVS_VPORT_TYPE_UNSPEC,
208 OVS_VPORT_TYPE_NETDEV, /* network device */
209 OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
210 OVS_VPORT_TYPE_PATCH, /* virtual tunnel connecting two vports */
211 OVS_VPORT_TYPE_GRE, /* GRE tunnel */
212 OVS_VPORT_TYPE_CAPWAP, /* CAPWAP tunnel */
216 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
218 #define OVS_VPORT_FAMILY "ovs_vport"
219 #define OVS_VPORT_MCGROUP "ovs_vport"
222 OVS_VPORT_CMD_UNSPEC,
230 * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
231 * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
232 * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
234 * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device
235 * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes
236 * plus a null terminator.
237 * @OVS_VPORT_ATTR_UPCALL_PID: The Netlink socket in userspace that
238 * OVS_PACKET_CMD_MISS upcalls will be directed to for packets received on
239 * this port. A value of zero indicates that upcalls should not be sent.
240 * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
241 * packets sent or received through the vport.
242 * @OVS_VPORT_ATTR_ADDRESS: A 6-byte Ethernet address for the vport.
243 * @OVS_VPORT_ATTR_IFINDEX: ifindex of the underlying network device, if any.
245 * These attributes follow the &struct ovs_header within the Generic Netlink
246 * payload for %OVS_VPORT_* commands.
248 * All attributes applicable to a given port are present in notifications.
249 * This means that, for example, a vport that has no corresponding network
250 * device would omit %OVS_VPORT_ATTR_IFINDEX.
252 * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
253 * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is
254 * optional; if not specified a free port number is automatically selected.
255 * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
256 * of vport. %OVS_VPORT_ATTR_STATS and %OVS_VPORT_ATTR_ADDRESS are optional,
257 * and other attributes are ignored.
259 * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
260 * look up the vport to operate on; otherwise dp_idx from the &struct
261 * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
263 enum ovs_vport_attr {
264 OVS_VPORT_ATTR_UNSPEC,
265 OVS_VPORT_ATTR_PORT_NO, /* port number within datapath */
266 OVS_VPORT_ATTR_TYPE, /* 32-bit OVS_VPORT_TYPE_* constant. */
267 OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */
268 OVS_VPORT_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */
269 OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */
270 OVS_VPORT_ATTR_ADDRESS, /* hardware address */
271 OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
272 OVS_VPORT_ATTR_IFINDEX, /* 32-bit ifindex of backing netdev */
276 #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
278 /* OVS_VPORT_ATTR_OPTIONS attributes for patch vports. */
280 OVS_PATCH_ATTR_UNSPEC,
281 OVS_PATCH_ATTR_PEER, /* name of peer vport, as a string */
285 #define OVS_PATCH_ATTR_MAX (__OVS_PATCH_ATTR_MAX - 1)
289 #define OVS_FLOW_FAMILY "ovs_flow"
290 #define OVS_FLOW_MCGROUP "ovs_flow"
300 struct ovs_flow_stats {
301 uint64_t n_packets; /* Number of matched packets. */
302 uint64_t n_bytes; /* Number of matched bytes. */
307 OVS_KEY_ATTR_TUN_ID, /* 64-bit tunnel ID */
308 OVS_KEY_ATTR_IN_PORT, /* 32-bit OVS dp port number */
309 OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */
310 OVS_KEY_ATTR_8021Q, /* struct ovs_key_8021q */
311 OVS_KEY_ATTR_ETHERTYPE, /* 16-bit Ethernet type */
312 OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */
313 OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */
314 OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */
315 OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */
316 OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */
317 OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */
318 OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */
319 OVS_KEY_ATTR_ND, /* struct ovs_key_nd */
323 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
325 struct ovs_key_ethernet {
330 struct ovs_key_8021q {
335 struct ovs_key_ipv4 {
342 struct ovs_key_ipv6 {
343 ovs_be32 ipv6_src[4];
344 ovs_be32 ipv6_dst[4];
359 struct ovs_key_icmp {
364 struct ovs_key_icmpv6 {
378 uint32_t nd_target[4];
384 * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
385 * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
386 * key. Always present in notifications. Required for all requests (except
388 * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
389 * the actions to take for packets that match the key. Always present in
390 * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional
391 * @OVS_FLOW_ATTR_UPCALL_PID: The Netlink socket in userspace that
392 * OVS_PACKET_CMD_USERSPACE and OVS_PACKET_CMD_SAMPLE upcalls will be
393 * directed to for packets received on this port. A value of zero indicates
394 * that upcalls should not be sent.
395 * on %OVS_FLOW_CMD_SET request to change the existing actions, ignored for
397 * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
398 * flow. Present in notifications if the stats would be nonzero. Ignored in
400 * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
401 * TCP flags seen on packets in this flow. Only present in notifications for
402 * TCP flows, and only if it would be nonzero. Ignored in requests.
403 * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
404 * the system monotonic clock, at which a packet was last processed for this
405 * flow. Only present in notifications if a packet has been processed for this
406 * flow. Ignored in requests.
407 * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
408 * last-used time, accumulated TCP flags, and statistics for this flow.
409 * Otherwise ignored in requests. Never present in notifications.
411 * These attributes follow the &struct ovs_header within the Generic Netlink
412 * payload for %OVS_FLOW_* commands.
415 OVS_FLOW_ATTR_UNSPEC,
416 OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */
417 OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
418 OVS_FLOW_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls. */
419 OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */
420 OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
421 OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */
422 OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */
426 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
429 enum ovs_action_type {
430 OVS_ACTION_ATTR_UNSPEC,
431 OVS_ACTION_ATTR_OUTPUT, /* Output to switch port. */
432 OVS_ACTION_ATTR_USERSPACE, /* Send copy to userspace. */
433 OVS_ACTION_ATTR_PUSH_VLAN, /* Set the 802.1q TCI value. */
434 OVS_ACTION_ATTR_POP_VLAN, /* Strip the 802.1q header. */
435 OVS_ACTION_ATTR_SET_DL_SRC, /* Ethernet source address. */
436 OVS_ACTION_ATTR_SET_DL_DST, /* Ethernet destination address. */
437 OVS_ACTION_ATTR_SET_NW_SRC, /* IPv4 source address. */
438 OVS_ACTION_ATTR_SET_NW_DST, /* IPv4 destination address. */
439 OVS_ACTION_ATTR_SET_NW_TOS, /* IP ToS/DSCP field (6 bits). */
440 OVS_ACTION_ATTR_SET_TP_SRC, /* TCP/UDP source port. */
441 OVS_ACTION_ATTR_SET_TP_DST, /* TCP/UDP destination port. */
442 OVS_ACTION_ATTR_SET_TUNNEL, /* Set the encapsulating tunnel ID. */
443 OVS_ACTION_ATTR_SET_PRIORITY, /* Set skb->priority. */
444 OVS_ACTION_ATTR_POP_PRIORITY, /* Restore original skb->priority. */
445 __OVS_ACTION_ATTR_MAX
448 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
450 #endif /* openvswitch/datapath-protocol.h */