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_STATS: Statistics about packets that have passed through the
89 * datapath. Always present in notifications.
90 * @OVS_DP_ATTR_IPV4_FRAGS: One of %OVS_DP_FRAG_*. Always present in
91 * notifications. May be included in %OVS_DP_NEW or %OVS_DP_SET requests to
92 * change the fragment handling policy.
93 * @OVS_DP_ATTR_SAMPLING: 32-bit fraction of packets to sample with
94 * @OVS_PACKET_CMD_SAMPLE. A value of 0 samples no packets, a value of
95 * %UINT32_MAX samples all packets, and intermediate values sample intermediate
96 * fractions of packets.
97 * @OVS_DP_ATTR_MCGROUPS: Nested attributes with multicast groups. Each nested
98 * attribute has a %OVS_PACKET_CMD_* type with a 32-bit value giving the
99 * Generic Netlink multicast group number used for sending this datapath's
100 * messages with that command type up to userspace.
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_STATS, /* struct ovs_dp_stats */
109 OVS_DP_ATTR_IPV4_FRAGS, /* 32-bit enum ovs_frag_handling */
110 OVS_DP_ATTR_SAMPLING, /* 32-bit fraction of packets to sample. */
111 OVS_DP_ATTR_MCGROUPS, /* Nested attributes with multicast groups. */
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_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
178 * notification if the %OVS_ACTION_ATTR_USERSPACE, action's argument was
180 * @OVS_PACKET_ATTR_SAMPLE_POOL: Present for %OVS_PACKET_CMD_SAMPLE. Contains
181 * the number of packets processed so far that were candidates for sampling.
182 * @OVS_PACKET_ATTR_ACTIONS: Present for %OVS_PACKET_CMD_SAMPLE. Contains a
183 * copy of the actions applied to the packet, as nested %OVS_ACTION_ATTR_*
186 * These attributes follow the &struct ovs_header within the Generic Netlink
187 * payload for %OVS_PACKET_* commands.
189 enum ovs_packet_attr {
190 OVS_PACKET_ATTR_UNSPEC,
191 OVS_PACKET_ATTR_PACKET, /* Packet data. */
192 OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */
193 OVS_PACKET_ATTR_USERDATA, /* u64 OVS_ACTION_ATTR_USERSPACE arg. */
194 OVS_PACKET_ATTR_SAMPLE_POOL, /* # sampling candidate packets so far. */
195 OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
196 __OVS_PACKET_ATTR_MAX
199 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
201 enum ovs_vport_type {
202 OVS_VPORT_TYPE_UNSPEC,
203 OVS_VPORT_TYPE_NETDEV, /* network device */
204 OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
205 OVS_VPORT_TYPE_PATCH, /* virtual tunnel connecting two vports */
206 OVS_VPORT_TYPE_GRE, /* GRE tunnel */
207 OVS_VPORT_TYPE_CAPWAP, /* CAPWAP tunnel */
211 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
213 #define OVS_VPORT_FAMILY "ovs_vport"
214 #define OVS_VPORT_MCGROUP "ovs_vport"
217 OVS_VPORT_CMD_UNSPEC,
225 * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
226 * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
227 * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
229 * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device
230 * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes
231 * plus a null terminator.
232 * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
233 * packets sent or received through the vport.
234 * @OVS_VPORT_ATTR_ADDRESS: A 6-byte Ethernet address for the vport.
235 * @OVS_VPORT_ATTR_IFINDEX: ifindex of the underlying network device, if any.
237 * These attributes follow the &struct ovs_header within the Generic Netlink
238 * payload for %OVS_VPORT_* commands.
240 * All attributes applicable to a given port are present in notifications.
241 * This means that, for example, a vport that has no corresponding network
242 * device would omit %OVS_VPORT_ATTR_IFINDEX.
244 * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
245 * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is
246 * optional; if not specified a free port number is automatically selected.
247 * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
248 * of vport. %OVS_VPORT_ATTR_STATS and %OVS_VPORT_ATTR_ADDRESS are optional,
249 * and other attributes are ignored.
251 * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
252 * look up the vport to operate on; otherwise dp_idx from the &struct
253 * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
255 enum ovs_vport_attr {
256 OVS_VPORT_ATTR_UNSPEC,
257 OVS_VPORT_ATTR_PORT_NO, /* port number within datapath */
258 OVS_VPORT_ATTR_TYPE, /* 32-bit OVS_VPORT_TYPE_* constant. */
259 OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */
260 OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */
261 OVS_VPORT_ATTR_ADDRESS, /* hardware address */
262 OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
263 OVS_VPORT_ATTR_IFINDEX, /* 32-bit ifindex of backing netdev */
267 #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
269 /* OVS_VPORT_ATTR_OPTIONS attributes for patch vports. */
271 OVS_PATCH_ATTR_UNSPEC,
272 OVS_PATCH_ATTR_PEER, /* name of peer vport, as a string */
276 #define OVS_PATCH_ATTR_MAX (__OVS_PATCH_ATTR_MAX - 1)
280 #define OVS_FLOW_FAMILY "ovs_flow"
281 #define OVS_FLOW_MCGROUP "ovs_flow"
291 struct ovs_flow_stats {
292 uint64_t n_packets; /* Number of matched packets. */
293 uint64_t n_bytes; /* Number of matched bytes. */
298 OVS_KEY_ATTR_TUN_ID, /* 64-bit tunnel ID */
299 OVS_KEY_ATTR_IN_PORT, /* 32-bit OVS dp port number */
300 OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */
301 OVS_KEY_ATTR_8021Q, /* struct ovs_key_8021q */
302 OVS_KEY_ATTR_ETHERTYPE, /* 16-bit Ethernet type */
303 OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */
304 OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */
305 OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */
306 OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */
307 OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */
308 OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */
309 OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */
310 OVS_KEY_ATTR_ND, /* struct ovs_key_nd */
314 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
316 struct ovs_key_ethernet {
321 struct ovs_key_8021q {
326 struct ovs_key_ipv4 {
333 struct ovs_key_ipv6 {
334 ovs_be32 ipv6_src[4];
335 ovs_be32 ipv6_dst[4];
350 struct ovs_key_icmp {
355 struct ovs_key_icmpv6 {
369 uint32_t nd_target[4];
375 * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
376 * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
377 * key. Always present in notifications. Required for all requests (except
379 * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
380 * the actions to take for packets that match the key. Always present in
381 * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional
382 * on %OVS_FLOW_CMD_SET request to change the existing actions, ignored for
384 * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
385 * flow. Present in notifications if the stats would be nonzero. Ignored in
387 * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
388 * TCP flags seen on packets in this flow. Only present in notifications for
389 * TCP flows, and only if it would be nonzero. Ignored in requests.
390 * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
391 * the system monotonic clock, at which a packet was last processed for this
392 * flow. Only present in notifications if a packet has been processed for this
393 * flow. Ignored in requests.
394 * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
395 * last-used time, accumulated TCP flags, and statistics for this flow.
396 * Otherwise ignored in requests. Never present in notifications.
398 * These attributes follow the &struct ovs_header within the Generic Netlink
399 * payload for %OVS_FLOW_* commands.
402 OVS_FLOW_ATTR_UNSPEC,
403 OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */
404 OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
405 OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */
406 OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
407 OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */
408 OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */
412 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
415 enum ovs_action_type {
416 OVS_ACTION_ATTR_UNSPEC,
417 OVS_ACTION_ATTR_OUTPUT, /* Output to switch port. */
418 OVS_ACTION_ATTR_USERSPACE, /* Send copy to userspace. */
419 OVS_ACTION_ATTR_PUSH_VLAN, /* Set the 802.1q TCI value. */
420 OVS_ACTION_ATTR_POP_VLAN, /* Strip the 802.1q header. */
421 OVS_ACTION_ATTR_SET_DL_SRC, /* Ethernet source address. */
422 OVS_ACTION_ATTR_SET_DL_DST, /* Ethernet destination address. */
423 OVS_ACTION_ATTR_SET_NW_SRC, /* IPv4 source address. */
424 OVS_ACTION_ATTR_SET_NW_DST, /* IPv4 destination address. */
425 OVS_ACTION_ATTR_SET_NW_TOS, /* IP ToS/DSCP field (6 bits). */
426 OVS_ACTION_ATTR_SET_TP_SRC, /* TCP/UDP source port. */
427 OVS_ACTION_ATTR_SET_TP_DST, /* TCP/UDP destination port. */
428 OVS_ACTION_ATTR_SET_TUNNEL, /* Set the encapsulating tunnel ID. */
429 OVS_ACTION_ATTR_SET_PRIORITY, /* Set skb->priority. */
430 OVS_ACTION_ATTR_POP_PRIORITY, /* Restore original skb->priority. */
431 __OVS_ACTION_ATTR_MAX
434 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
436 #endif /* openvswitch/datapath-protocol.h */