blob: a27222d5b413a85d4c773b5b43563bf9b57831d2 [file] [log] [blame]
Ben Cheng224b54f2013-10-15 18:26:18 -07001
2/*
Christopher Ferrise0845012014-07-09 14:58:51 -07003 * Copyright (c) 2007-2013 Nicira, Inc.
Ben Cheng224b54f2013-10-15 18:26:18 -07004 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of version 2 of the GNU General Public
7 * License as published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17 * 02110-1301, USA
18 */
19
20#ifndef _UAPI__LINUX_OPENVSWITCH_H
21#define _UAPI__LINUX_OPENVSWITCH_H 1
22
23#include <linux/types.h>
24#include <linux/if_ether.h>
25
26/**
27 * struct ovs_header - header for OVS Generic Netlink messages.
28 * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
29 * specific to a datapath).
30 *
31 * Attributes following the header are specific to a particular OVS Generic
32 * Netlink family, but all of the OVS families use this header.
33 */
34
35struct ovs_header {
36 int dp_ifindex;
37};
38
39/* Datapaths. */
40
41#define OVS_DATAPATH_FAMILY "ovs_datapath"
42#define OVS_DATAPATH_MCGROUP "ovs_datapath"
Christopher Ferrise0845012014-07-09 14:58:51 -070043
44/* V2:
45 * - API users are expected to provide OVS_DP_ATTR_USER_FEATURES
46 * when creating the datapath.
47 */
48#define OVS_DATAPATH_VERSION 2
49
50/* First OVS datapath version to support features */
51#define OVS_DP_VER_FEATURES 2
Ben Cheng224b54f2013-10-15 18:26:18 -070052
53enum ovs_datapath_cmd {
54 OVS_DP_CMD_UNSPEC,
55 OVS_DP_CMD_NEW,
56 OVS_DP_CMD_DEL,
57 OVS_DP_CMD_GET,
58 OVS_DP_CMD_SET
59};
60
61/**
62 * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
63 * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
64 * port". This is the name of the network device whose dp_ifindex is given in
65 * the &struct ovs_header. Always present in notifications. Required in
66 * %OVS_DP_NEW requests. May be used as an alternative to specifying
67 * dp_ifindex in other requests (with a dp_ifindex of 0).
68 * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
69 * set on the datapath port (for OVS_ACTION_ATTR_MISS). Only valid on
70 * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
71 * not be sent.
72 * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
73 * datapath. Always present in notifications.
Christopher Ferrise0845012014-07-09 14:58:51 -070074 * @OVS_DP_ATTR_MEGAFLOW_STATS: Statistics about mega flow masks usage for the
75 * datapath. Always present in notifications.
Ben Cheng224b54f2013-10-15 18:26:18 -070076 *
77 * These attributes follow the &struct ovs_header within the Generic Netlink
78 * payload for %OVS_DP_* commands.
79 */
80enum ovs_datapath_attr {
81 OVS_DP_ATTR_UNSPEC,
Christopher Ferrise0845012014-07-09 14:58:51 -070082 OVS_DP_ATTR_NAME, /* name of dp_ifindex netdev */
83 OVS_DP_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */
84 OVS_DP_ATTR_STATS, /* struct ovs_dp_stats */
85 OVS_DP_ATTR_MEGAFLOW_STATS, /* struct ovs_dp_megaflow_stats */
86 OVS_DP_ATTR_USER_FEATURES, /* OVS_DP_F_* */
Ben Cheng224b54f2013-10-15 18:26:18 -070087 __OVS_DP_ATTR_MAX
88};
89
90#define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
91
92struct ovs_dp_stats {
93 __u64 n_hit; /* Number of flow table matches. */
94 __u64 n_missed; /* Number of flow table misses. */
95 __u64 n_lost; /* Number of misses not sent to userspace. */
96 __u64 n_flows; /* Number of flows present */
97};
98
Christopher Ferrise0845012014-07-09 14:58:51 -070099struct ovs_dp_megaflow_stats {
100 __u64 n_mask_hit; /* Number of masks used for flow lookups. */
101 __u32 n_masks; /* Number of masks for the datapath. */
102 __u32 pad0; /* Pad for future expension. */
103 __u64 pad1; /* Pad for future expension. */
104 __u64 pad2; /* Pad for future expension. */
105};
106
Ben Cheng224b54f2013-10-15 18:26:18 -0700107struct ovs_vport_stats {
108 __u64 rx_packets; /* total packets received */
109 __u64 tx_packets; /* total packets transmitted */
110 __u64 rx_bytes; /* total bytes received */
111 __u64 tx_bytes; /* total bytes transmitted */
112 __u64 rx_errors; /* bad packets received */
113 __u64 tx_errors; /* packet transmit problems */
114 __u64 rx_dropped; /* no space in linux buffers */
115 __u64 tx_dropped; /* no space available in linux */
116};
117
Christopher Ferrise0845012014-07-09 14:58:51 -0700118/* Allow last Netlink attribute to be unaligned */
119#define OVS_DP_F_UNALIGNED (1 << 0)
120
Christopher Ferris7c0b6392015-01-23 15:34:26 -0800121/* Allow datapath to associate multiple Netlink PIDs to each vport */
122#define OVS_DP_F_VPORT_PIDS (1 << 1)
123
Ben Cheng224b54f2013-10-15 18:26:18 -0700124/* Fixed logical ports. */
125#define OVSP_LOCAL ((__u32)0)
126
127/* Packet transfer. */
128
129#define OVS_PACKET_FAMILY "ovs_packet"
130#define OVS_PACKET_VERSION 0x1
131
132enum ovs_packet_cmd {
133 OVS_PACKET_CMD_UNSPEC,
134
135 /* Kernel-to-user notifications. */
136 OVS_PACKET_CMD_MISS, /* Flow table miss. */
137 OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */
138
139 /* Userspace commands. */
140 OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */
141};
142
143/**
144 * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
145 * @OVS_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire
146 * packet as received, from the start of the Ethernet header onward. For
147 * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
148 * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
149 * the flow key extracted from the packet as originally received.
150 * @OVS_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key
151 * extracted from the packet as nested %OVS_KEY_ATTR_* attributes. This allows
152 * userspace to adapt its flow setup strategy by comparing its notion of the
153 * flow key against the kernel's.
154 * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet. Used
155 * for %OVS_PACKET_CMD_EXECUTE. It has nested %OVS_ACTION_ATTR_* attributes.
Christopher Ferris12e1f282016-02-04 12:35:07 -0800156 * Also used in upcall when %OVS_ACTION_ATTR_USERSPACE has optional
157 * %OVS_USERSPACE_ATTR_ACTIONS attribute.
Ben Cheng224b54f2013-10-15 18:26:18 -0700158 * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
159 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
160 * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
161 * specified there.
Christopher Ferris12e1f282016-02-04 12:35:07 -0800162 * @OVS_PACKET_ATTR_EGRESS_TUN_KEY: Present for an %OVS_PACKET_CMD_ACTION
163 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
164 * %OVS_USERSPACE_ATTR_EGRESS_TUN_PORT attribute, which is sent only if the
165 * output port is actually a tunnel port. Contains the output tunnel key
166 * extracted from the packet as nested %OVS_TUNNEL_KEY_ATTR_* attributes.
167 * @OVS_PACKET_ATTR_MRU: Present for an %OVS_PACKET_CMD_ACTION and
168 * %OVS_PACKET_ATTR_USERSPACE action specify the Maximum received fragment
169 * size.
Ben Cheng224b54f2013-10-15 18:26:18 -0700170 *
171 * These attributes follow the &struct ovs_header within the Generic Netlink
172 * payload for %OVS_PACKET_* commands.
173 */
174enum ovs_packet_attr {
175 OVS_PACKET_ATTR_UNSPEC,
176 OVS_PACKET_ATTR_PACKET, /* Packet data. */
177 OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */
178 OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
179 OVS_PACKET_ATTR_USERDATA, /* OVS_ACTION_ATTR_USERSPACE arg. */
Christopher Ferris12e1f282016-02-04 12:35:07 -0800180 OVS_PACKET_ATTR_EGRESS_TUN_KEY, /* Nested OVS_TUNNEL_KEY_ATTR_*
181 attributes. */
182 OVS_PACKET_ATTR_UNUSED1,
183 OVS_PACKET_ATTR_UNUSED2,
184 OVS_PACKET_ATTR_PROBE, /* Packet operation is a feature probe,
185 error logging should be suppressed. */
186 OVS_PACKET_ATTR_MRU, /* Maximum received IP fragment size. */
Ben Cheng224b54f2013-10-15 18:26:18 -0700187 __OVS_PACKET_ATTR_MAX
188};
189
190#define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
191
192/* Virtual ports. */
193
194#define OVS_VPORT_FAMILY "ovs_vport"
195#define OVS_VPORT_MCGROUP "ovs_vport"
196#define OVS_VPORT_VERSION 0x1
197
198enum ovs_vport_cmd {
199 OVS_VPORT_CMD_UNSPEC,
200 OVS_VPORT_CMD_NEW,
201 OVS_VPORT_CMD_DEL,
202 OVS_VPORT_CMD_GET,
203 OVS_VPORT_CMD_SET
204};
205
206enum 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 */
Christopher Ferrise0845012014-07-09 14:58:51 -0700210 OVS_VPORT_TYPE_GRE, /* GRE tunnel. */
211 OVS_VPORT_TYPE_VXLAN, /* VXLAN tunnel. */
Christopher Ferris7c0b6392015-01-23 15:34:26 -0800212 OVS_VPORT_TYPE_GENEVE, /* Geneve tunnel. */
Ben Cheng224b54f2013-10-15 18:26:18 -0700213 __OVS_VPORT_TYPE_MAX
214};
215
216#define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
217
218/**
219 * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
220 * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
221 * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
222 * of vport.
223 * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device
224 * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes
225 * plus a null terminator.
226 * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
Christopher Ferris7c0b6392015-01-23 15:34:26 -0800227 * @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace
228 * among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets
229 * received on this port. If this is a single-element array of value 0,
230 * upcalls should not be sent.
Ben Cheng224b54f2013-10-15 18:26:18 -0700231 * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
232 * packets sent or received through the vport.
233 *
234 * These attributes follow the &struct ovs_header within the Generic Netlink
235 * payload for %OVS_VPORT_* commands.
236 *
237 * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
238 * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is
239 * optional; if not specified a free port number is automatically selected.
240 * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
241 * of vport.
242 *
243 * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
244 * look up the vport to operate on; otherwise dp_idx from the &struct
245 * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
246 */
247enum ovs_vport_attr {
248 OVS_VPORT_ATTR_UNSPEC,
249 OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
250 OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */
251 OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */
252 OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
Christopher Ferris7c0b6392015-01-23 15:34:26 -0800253 OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */
254 /* receiving upcalls */
Ben Cheng224b54f2013-10-15 18:26:18 -0700255 OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */
256 __OVS_VPORT_ATTR_MAX
257};
258
259#define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
260
Christopher Ferris12e1f282016-02-04 12:35:07 -0800261enum {
262 OVS_VXLAN_EXT_UNSPEC,
263 OVS_VXLAN_EXT_GBP, /* Flag or __u32 */
264 __OVS_VXLAN_EXT_MAX,
265};
266
267#define OVS_VXLAN_EXT_MAX (__OVS_VXLAN_EXT_MAX - 1)
268
269
Christopher Ferrise0845012014-07-09 14:58:51 -0700270/* OVS_VPORT_ATTR_OPTIONS attributes for tunnels.
271 */
272enum {
273 OVS_TUNNEL_ATTR_UNSPEC,
274 OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */
Christopher Ferris12e1f282016-02-04 12:35:07 -0800275 OVS_TUNNEL_ATTR_EXTENSION,
Christopher Ferrise0845012014-07-09 14:58:51 -0700276 __OVS_TUNNEL_ATTR_MAX
277};
278
279#define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1)
280
Ben Cheng224b54f2013-10-15 18:26:18 -0700281/* Flows. */
282
283#define OVS_FLOW_FAMILY "ovs_flow"
284#define OVS_FLOW_MCGROUP "ovs_flow"
285#define OVS_FLOW_VERSION 0x1
286
287enum ovs_flow_cmd {
288 OVS_FLOW_CMD_UNSPEC,
289 OVS_FLOW_CMD_NEW,
290 OVS_FLOW_CMD_DEL,
291 OVS_FLOW_CMD_GET,
292 OVS_FLOW_CMD_SET
293};
294
295struct ovs_flow_stats {
296 __u64 n_packets; /* Number of matched packets. */
297 __u64 n_bytes; /* Number of matched bytes. */
298};
299
300enum ovs_key_attr {
301 OVS_KEY_ATTR_UNSPEC,
302 OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */
303 OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */
304 OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */
305 OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */
306 OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */
307 OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */
308 OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */
309 OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */
310 OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */
311 OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */
312 OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */
313 OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */
314 OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */
315 OVS_KEY_ATTR_ND, /* struct ovs_key_nd */
316 OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */
Christopher Ferrise0845012014-07-09 14:58:51 -0700317 OVS_KEY_ATTR_TUNNEL, /* Nested set of ovs_tunnel attributes */
318 OVS_KEY_ATTR_SCTP, /* struct ovs_key_sctp */
319 OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */
Christopher Ferris7c0b6392015-01-23 15:34:26 -0800320 OVS_KEY_ATTR_DP_HASH, /* u32 hash value. Value 0 indicates the hash
321 is not computed by the datapath. */
322 OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */
Christopher Ferris12e1f282016-02-04 12:35:07 -0800323 OVS_KEY_ATTR_MPLS, /* array of struct ovs_key_mpls.
324 * The implementation may restrict
325 * the accepted length of the array. */
326 OVS_KEY_ATTR_CT_STATE, /* u32 bitmask of OVS_CS_F_* */
327 OVS_KEY_ATTR_CT_ZONE, /* u16 connection tracking zone. */
328 OVS_KEY_ATTR_CT_MARK, /* u32 connection tracking mark */
329 OVS_KEY_ATTR_CT_LABELS, /* 16-octet connection tracking label */
Christopher Ferrise0845012014-07-09 14:58:51 -0700330
331#ifdef __KERNEL__
Christopher Ferris12e1f282016-02-04 12:35:07 -0800332 OVS_KEY_ATTR_TUNNEL_INFO, /* struct ip_tunnel_info */
Christopher Ferrise0845012014-07-09 14:58:51 -0700333#endif
Ben Cheng224b54f2013-10-15 18:26:18 -0700334 __OVS_KEY_ATTR_MAX
335};
336
337#define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
338
Christopher Ferrise0845012014-07-09 14:58:51 -0700339enum ovs_tunnel_key_attr {
340 OVS_TUNNEL_KEY_ATTR_ID, /* be64 Tunnel ID */
341 OVS_TUNNEL_KEY_ATTR_IPV4_SRC, /* be32 src IP address. */
342 OVS_TUNNEL_KEY_ATTR_IPV4_DST, /* be32 dst IP address. */
343 OVS_TUNNEL_KEY_ATTR_TOS, /* u8 Tunnel IP ToS. */
344 OVS_TUNNEL_KEY_ATTR_TTL, /* u8 Tunnel IP TTL. */
345 OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT, /* No argument, set DF. */
346 OVS_TUNNEL_KEY_ATTR_CSUM, /* No argument. CSUM packet. */
Christopher Ferris7c0b6392015-01-23 15:34:26 -0800347 OVS_TUNNEL_KEY_ATTR_OAM, /* No argument. OAM frame. */
348 OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, /* Array of Geneve options. */
Christopher Ferris12e1f282016-02-04 12:35:07 -0800349 OVS_TUNNEL_KEY_ATTR_TP_SRC, /* be16 src Transport Port. */
350 OVS_TUNNEL_KEY_ATTR_TP_DST, /* be16 dst Transport Port. */
351 OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS, /* Nested OVS_VXLAN_EXT_* */
352 OVS_TUNNEL_KEY_ATTR_IPV6_SRC, /* struct in6_addr src IPv6 address. */
353 OVS_TUNNEL_KEY_ATTR_IPV6_DST, /* struct in6_addr dst IPv6 address. */
Christopher Ferrise0845012014-07-09 14:58:51 -0700354 __OVS_TUNNEL_KEY_ATTR_MAX
355};
356
357#define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
358
Ben Cheng224b54f2013-10-15 18:26:18 -0700359/**
360 * enum ovs_frag_type - IPv4 and IPv6 fragment type
361 * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
362 * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
363 * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
364 *
365 * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
366 * ovs_key_ipv6.
367 */
368enum ovs_frag_type {
369 OVS_FRAG_TYPE_NONE,
370 OVS_FRAG_TYPE_FIRST,
371 OVS_FRAG_TYPE_LATER,
372 __OVS_FRAG_TYPE_MAX
373};
374
375#define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
376
377struct ovs_key_ethernet {
378 __u8 eth_src[ETH_ALEN];
379 __u8 eth_dst[ETH_ALEN];
380};
381
Christopher Ferris12e1f282016-02-04 12:35:07 -0800382struct ovs_key_mpls {
383 __be32 mpls_lse;
384};
385
Ben Cheng224b54f2013-10-15 18:26:18 -0700386struct ovs_key_ipv4 {
387 __be32 ipv4_src;
388 __be32 ipv4_dst;
389 __u8 ipv4_proto;
390 __u8 ipv4_tos;
391 __u8 ipv4_ttl;
392 __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */
393};
394
395struct ovs_key_ipv6 {
396 __be32 ipv6_src[4];
397 __be32 ipv6_dst[4];
398 __be32 ipv6_label; /* 20-bits in least-significant bits. */
399 __u8 ipv6_proto;
400 __u8 ipv6_tclass;
401 __u8 ipv6_hlimit;
402 __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */
403};
404
405struct ovs_key_tcp {
406 __be16 tcp_src;
407 __be16 tcp_dst;
408};
409
410struct ovs_key_udp {
411 __be16 udp_src;
412 __be16 udp_dst;
413};
414
Christopher Ferrise0845012014-07-09 14:58:51 -0700415struct ovs_key_sctp {
416 __be16 sctp_src;
417 __be16 sctp_dst;
418};
419
Ben Cheng224b54f2013-10-15 18:26:18 -0700420struct ovs_key_icmp {
421 __u8 icmp_type;
422 __u8 icmp_code;
423};
424
425struct ovs_key_icmpv6 {
426 __u8 icmpv6_type;
427 __u8 icmpv6_code;
428};
429
430struct ovs_key_arp {
431 __be32 arp_sip;
432 __be32 arp_tip;
433 __be16 arp_op;
434 __u8 arp_sha[ETH_ALEN];
435 __u8 arp_tha[ETH_ALEN];
436};
437
438struct ovs_key_nd {
Christopher Ferris12e1f282016-02-04 12:35:07 -0800439 __be32 nd_target[4];
440 __u8 nd_sll[ETH_ALEN];
441 __u8 nd_tll[ETH_ALEN];
Ben Cheng224b54f2013-10-15 18:26:18 -0700442};
443
Christopher Ferris12e1f282016-02-04 12:35:07 -0800444#define OVS_CT_LABELS_LEN 16
445struct ovs_key_ct_labels {
446 __u8 ct_labels[OVS_CT_LABELS_LEN];
447};
448
449/* OVS_KEY_ATTR_CT_STATE flags */
450#define OVS_CS_F_NEW 0x01 /* Beginning of a new connection. */
451#define OVS_CS_F_ESTABLISHED 0x02 /* Part of an existing connection. */
452#define OVS_CS_F_RELATED 0x04 /* Related to an established
453 * connection. */
454#define OVS_CS_F_REPLY_DIR 0x08 /* Flow is in the reply direction. */
455#define OVS_CS_F_INVALID 0x10 /* Could not track connection. */
456#define OVS_CS_F_TRACKED 0x20 /* Conntrack has occurred. */
457
Ben Cheng224b54f2013-10-15 18:26:18 -0700458/**
459 * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
460 * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
461 * key. Always present in notifications. Required for all requests (except
462 * dumps).
463 * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
464 * the actions to take for packets that match the key. Always present in
465 * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for
Christopher Ferris31475242014-09-02 17:43:51 -0700466 * %OVS_FLOW_CMD_SET requests. An %OVS_FLOW_CMD_SET without
467 * %OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions,
468 * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given.
Ben Cheng224b54f2013-10-15 18:26:18 -0700469 * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
470 * flow. Present in notifications if the stats would be nonzero. Ignored in
471 * requests.
472 * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
473 * TCP flags seen on packets in this flow. Only present in notifications for
474 * TCP flows, and only if it would be nonzero. Ignored in requests.
475 * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
476 * the system monotonic clock, at which a packet was last processed for this
477 * flow. Only present in notifications if a packet has been processed for this
478 * flow. Ignored in requests.
479 * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
480 * last-used time, accumulated TCP flags, and statistics for this flow.
481 * Otherwise ignored in requests. Never present in notifications.
Christopher Ferrise0845012014-07-09 14:58:51 -0700482 * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the
483 * mask bits for wildcarded flow match. Mask bit value '1' specifies exact
484 * match with corresponding flow key bit, while mask bit value '0' specifies
485 * a wildcarded match. Omitting attribute is treated as wildcarding all
486 * corresponding fields. Optional for all requests. If not present,
487 * all flow key bits are exact match bits.
Christopher Ferris12e1f282016-02-04 12:35:07 -0800488 * @OVS_FLOW_ATTR_UFID: A value between 1-16 octets specifying a unique
489 * identifier for the flow. Causes the flow to be indexed by this value rather
490 * than the value of the %OVS_FLOW_ATTR_KEY attribute. Optional for all
491 * requests. Present in notifications if the flow was created with this
492 * attribute.
493 * @OVS_FLOW_ATTR_UFID_FLAGS: A 32-bit value of OR'd %OVS_UFID_F_*
494 * flags that provide alternative semantics for flow installation and
495 * retrieval. Optional for all requests.
Ben Cheng224b54f2013-10-15 18:26:18 -0700496 *
497 * These attributes follow the &struct ovs_header within the Generic Netlink
498 * payload for %OVS_FLOW_* commands.
499 */
500enum ovs_flow_attr {
501 OVS_FLOW_ATTR_UNSPEC,
502 OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */
503 OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
504 OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */
505 OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
506 OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */
507 OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */
Christopher Ferrise0845012014-07-09 14:58:51 -0700508 OVS_FLOW_ATTR_MASK, /* Sequence of OVS_KEY_ATTR_* attributes. */
Christopher Ferris12e1f282016-02-04 12:35:07 -0800509 OVS_FLOW_ATTR_PROBE, /* Flow operation is a feature probe, error
510 * logging should be suppressed. */
511 OVS_FLOW_ATTR_UFID, /* Variable length unique flow identifier. */
512 OVS_FLOW_ATTR_UFID_FLAGS,/* u32 of OVS_UFID_F_*. */
Ben Cheng224b54f2013-10-15 18:26:18 -0700513 __OVS_FLOW_ATTR_MAX
514};
515
516#define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
517
518/**
Christopher Ferris12e1f282016-02-04 12:35:07 -0800519 * Omit attributes for notifications.
520 *
521 * If a datapath request contains an %OVS_UFID_F_OMIT_* flag, then the datapath
522 * may omit the corresponding %OVS_FLOW_ATTR_* from the response.
523 */
524#define OVS_UFID_F_OMIT_KEY (1 << 0)
525#define OVS_UFID_F_OMIT_MASK (1 << 1)
526#define OVS_UFID_F_OMIT_ACTIONS (1 << 2)
527
528/**
Ben Cheng224b54f2013-10-15 18:26:18 -0700529 * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
530 * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
531 * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of
532 * %UINT32_MAX samples all packets and intermediate values sample intermediate
533 * fractions of packets.
534 * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
535 * Actions are passed as nested attributes.
536 *
537 * Executes the specified actions with the given probability on a per-packet
538 * basis.
539 */
540enum ovs_sample_attr {
541 OVS_SAMPLE_ATTR_UNSPEC,
542 OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
543 OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
544 __OVS_SAMPLE_ATTR_MAX,
545};
546
547#define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
548
549/**
550 * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
551 * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
552 * message should be sent. Required.
553 * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
554 * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
Christopher Ferris12e1f282016-02-04 12:35:07 -0800555 * @OVS_USERSPACE_ATTR_EGRESS_TUN_PORT: If present, u32 output port to get
556 * tunnel info.
557 * @OVS_USERSPACE_ATTR_ACTIONS: If present, send actions with upcall.
Ben Cheng224b54f2013-10-15 18:26:18 -0700558 */
559enum ovs_userspace_attr {
560 OVS_USERSPACE_ATTR_UNSPEC,
561 OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */
562 OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */
Christopher Ferris12e1f282016-02-04 12:35:07 -0800563 OVS_USERSPACE_ATTR_EGRESS_TUN_PORT, /* Optional, u32 output port
564 * to get tunnel info. */
565 OVS_USERSPACE_ATTR_ACTIONS, /* Optional flag to get actions. */
Ben Cheng224b54f2013-10-15 18:26:18 -0700566 __OVS_USERSPACE_ATTR_MAX
567};
568
569#define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
570
571/**
Christopher Ferris12e1f282016-02-04 12:35:07 -0800572 * struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument.
573 * @mpls_lse: MPLS label stack entry to push.
574 * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame.
575 *
576 * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and
577 * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected.
578 */
579struct ovs_action_push_mpls {
580 __be32 mpls_lse;
581 __be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */
582};
583
584/**
Ben Cheng224b54f2013-10-15 18:26:18 -0700585 * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
586 * @vlan_tpid: Tag protocol identifier (TPID) to push.
587 * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set
588 * (but it will not be set in the 802.1Q header that is pushed).
589 *
590 * The @vlan_tpid value is typically %ETH_P_8021Q. The only acceptable TPID
591 * values are those that the kernel module also parses as 802.1Q headers, to
592 * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN
593 * from having surprising results.
594 */
595struct ovs_action_push_vlan {
596 __be16 vlan_tpid; /* 802.1Q TPID. */
597 __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */
598};
599
Christopher Ferris7c0b6392015-01-23 15:34:26 -0800600/* Data path hash algorithm for computing Datapath hash.
601 *
602 * The algorithm type only specifies the fields in a flow
603 * will be used as part of the hash. Each datapath is free
604 * to use its own hash algorithm. The hash value will be
605 * opaque to the user space daemon.
606 */
607enum ovs_hash_alg {
608 OVS_HASH_ALG_L4,
609};
610
611/*
612 * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument.
613 * @hash_alg: Algorithm used to compute hash prior to recirculation.
614 * @hash_basis: basis used for computing hash.
615 */
616struct ovs_action_hash {
617 uint32_t hash_alg; /* One of ovs_hash_alg. */
618 uint32_t hash_basis;
619};
620
Ben Cheng224b54f2013-10-15 18:26:18 -0700621/**
Christopher Ferris12e1f282016-02-04 12:35:07 -0800622 * enum ovs_ct_attr - Attributes for %OVS_ACTION_ATTR_CT action.
623 * @OVS_CT_ATTR_COMMIT: If present, commits the connection to the conntrack
624 * table. This allows future packets for the same connection to be identified
625 * as 'established' or 'related'. The flow key for the current packet will
626 * retain the pre-commit connection state.
627 * @OVS_CT_ATTR_ZONE: u16 connection tracking zone.
628 * @OVS_CT_ATTR_MARK: u32 value followed by u32 mask. For each bit set in the
629 * mask, the corresponding bit in the value is copied to the connection
630 * tracking mark field in the connection.
631 * @OVS_CT_ATTR_LABELS: %OVS_CT_LABELS_LEN value followed by %OVS_CT_LABELS_LEN
632 * mask. For each bit set in the mask, the corresponding bit in the value is
633 * copied to the connection tracking label field in the connection.
634 * @OVS_CT_ATTR_HELPER: variable length string defining conntrack ALG.
635 */
636enum ovs_ct_attr {
637 OVS_CT_ATTR_UNSPEC,
638 OVS_CT_ATTR_COMMIT, /* No argument, commits connection. */
639 OVS_CT_ATTR_ZONE, /* u16 zone id. */
640 OVS_CT_ATTR_MARK, /* mark to associate with this connection. */
641 OVS_CT_ATTR_LABELS, /* labels to associate with this connection. */
642 OVS_CT_ATTR_HELPER, /* netlink helper to assist detection of
643 related connections. */
644 __OVS_CT_ATTR_MAX
645};
646
647#define OVS_CT_ATTR_MAX (__OVS_CT_ATTR_MAX - 1)
648
649/**
Ben Cheng224b54f2013-10-15 18:26:18 -0700650 * enum ovs_action_attr - Action types.
651 *
652 * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
653 * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
654 * %OVS_USERSPACE_ATTR_* attributes.
655 * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The
656 * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
657 * value.
Christopher Ferris12e1f282016-02-04 12:35:07 -0800658 * @OVS_ACTION_ATTR_SET_MASKED: Replaces the contents of an existing header. A
659 * nested %OVS_KEY_ATTR_* attribute specifies a header to modify, its value,
660 * and a mask. For every bit set in the mask, the corresponding bit value
661 * is copied from the value to the packet header field, rest of the bits are
662 * left unchanged. The non-masked value bits must be passed in as zeroes.
663 * Masking is not supported for the %OVS_KEY_ATTR_TUNNEL attribute.
Ben Cheng224b54f2013-10-15 18:26:18 -0700664 * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the
665 * packet.
666 * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet.
667 * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
668 * the nested %OVS_SAMPLE_ATTR_* attributes.
Christopher Ferris12e1f282016-02-04 12:35:07 -0800669 * @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the
670 * top of the packets MPLS label stack. Set the ethertype of the
671 * encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to
672 * indicate the new packet contents.
673 * @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the
674 * packet's MPLS label stack. Set the encapsulating frame's ethertype to
675 * indicate the new packet contents. This could potentially still be
676 * %ETH_P_MPLS if the resulting MPLS label stack is not empty. If there
677 * is no MPLS label stack, as determined by ethertype, no action is taken.
678 * @OVS_ACTION_ATTR_CT: Track the connection. Populate the conntrack-related
679 * entries in the flow key.
Ben Cheng224b54f2013-10-15 18:26:18 -0700680 *
681 * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all
682 * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
683 * type may not be changed.
Christopher Ferris12e1f282016-02-04 12:35:07 -0800684 *
685 * @OVS_ACTION_ATTR_SET_TO_MASKED: Kernel internal masked set action translated
686 * from the @OVS_ACTION_ATTR_SET.
Ben Cheng224b54f2013-10-15 18:26:18 -0700687 */
688
689enum ovs_action_attr {
690 OVS_ACTION_ATTR_UNSPEC,
691 OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */
692 OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */
693 OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */
694 OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */
695 OVS_ACTION_ATTR_POP_VLAN, /* No argument. */
696 OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */
Christopher Ferris7c0b6392015-01-23 15:34:26 -0800697 OVS_ACTION_ATTR_RECIRC, /* u32 recirc_id. */
698 OVS_ACTION_ATTR_HASH, /* struct ovs_action_hash. */
Christopher Ferris12e1f282016-02-04 12:35:07 -0800699 OVS_ACTION_ATTR_PUSH_MPLS, /* struct ovs_action_push_mpls. */
700 OVS_ACTION_ATTR_POP_MPLS, /* __be16 ethertype. */
701 OVS_ACTION_ATTR_SET_MASKED, /* One nested OVS_KEY_ATTR_* including
702 * data immediately followed by a mask.
703 * The data must be zero for the unmasked
704 * bits. */
705 OVS_ACTION_ATTR_CT, /* Nested OVS_CT_ATTR_* . */
706
707 __OVS_ACTION_ATTR_MAX, /* Nothing past this will be accepted
708 * from userspace. */
709
710#ifdef __KERNEL__
711 OVS_ACTION_ATTR_SET_TO_MASKED, /* Kernel module internal masked
712 * set action converted from
713 * OVS_ACTION_ATTR_SET. */
714#endif
Ben Cheng224b54f2013-10-15 18:26:18 -0700715};
716
717#define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
718
719#endif /* _LINUX_OPENVSWITCH_H */