2 * Copyright (c) 2007-2014 Nicira, Inc.
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
25 * modify it under the terms of version 2 of the GNU General Public
26 * License as published by the Free Software Foundation.
28 * This program is distributed in the hope that it will be useful, but
29 * WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
31 * General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program; if not, write to the Free Software
35 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
37 * ----------------------------------------------------------------------
40 #ifndef _LINUX_OPENVSWITCH_H
41 #define _LINUX_OPENVSWITCH_H 1
43 #include <linux/types.h>
44 #include <linux/if_ether.h>
47 * struct ovs_header - header for OVS Generic Netlink messages.
48 * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
49 * specific to a datapath).
51 * Attributes following the header are specific to a particular OVS Generic
52 * Netlink family, but all of the OVS families use this header.
61 #define OVS_DATAPATH_FAMILY "ovs_datapath"
62 #define OVS_DATAPATH_MCGROUP "ovs_datapath"
65 * - API users are expected to provide OVS_DP_ATTR_USER_FEATURES
66 * when creating the datapath.
68 #define OVS_DATAPATH_VERSION 2
70 /* First OVS datapath version to support features */
71 #define OVS_DP_VER_FEATURES 2
73 enum ovs_datapath_cmd {
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_MEGAFLOW_STATS: Statistics about mega flow masks usage for the
95 * datapath. Always present in notifications.
97 * These attributes follow the &struct ovs_header within the Generic Netlink
98 * payload for %OVS_DP_* commands.
100 enum ovs_datapath_attr {
102 OVS_DP_ATTR_NAME, /* name of dp_ifindex netdev */
103 OVS_DP_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */
104 OVS_DP_ATTR_STATS, /* struct ovs_dp_stats */
105 OVS_DP_ATTR_MEGAFLOW_STATS, /* struct ovs_dp_megaflow_stats */
106 OVS_DP_ATTR_USER_FEATURES, /* OVS_DP_F_* */
110 #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
112 /* All 64-bit integers within Netlink messages are 4-byte aligned only. */
113 struct ovs_dp_stats {
114 __u64 n_hit; /* Number of flow table matches. */
115 __u64 n_missed; /* Number of flow table misses. */
116 __u64 n_lost; /* Number of misses not sent to userspace. */
117 __u64 n_flows; /* Number of flows present */
120 struct ovs_dp_megaflow_stats {
121 __u64 n_mask_hit; /* Number of masks used for flow lookups. */
122 __u32 n_masks; /* Number of masks for the datapath. */
123 __u32 pad0; /* Pad for future expension. */
124 __u64 pad1; /* Pad for future expension. */
125 __u64 pad2; /* Pad for future expension. */
128 struct ovs_vport_stats {
129 __u64 rx_packets; /* total packets received */
130 __u64 tx_packets; /* total packets transmitted */
131 __u64 rx_bytes; /* total bytes received */
132 __u64 tx_bytes; /* total bytes transmitted */
133 __u64 rx_errors; /* bad packets received */
134 __u64 tx_errors; /* packet transmit problems */
135 __u64 rx_dropped; /* no space in linux buffers */
136 __u64 tx_dropped; /* no space available in linux */
139 /* Allow last Netlink attribute to be unaligned */
140 #define OVS_DP_F_UNALIGNED (1 << 0)
142 /* Allow datapath to associate multiple Netlink PIDs to each vport */
143 #define OVS_DP_F_VPORT_PIDS (1 << 1)
145 /* Fixed logical ports. */
146 #define OVSP_LOCAL ((__u32)0)
148 /* Packet transfer. */
150 #define OVS_PACKET_FAMILY "ovs_packet"
151 #define OVS_PACKET_VERSION 0x1
153 enum ovs_packet_cmd {
154 OVS_PACKET_CMD_UNSPEC,
156 /* Kernel-to-user notifications. */
157 OVS_PACKET_CMD_MISS, /* Flow table miss. */
158 OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */
160 /* Userspace commands. */
161 OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */
165 * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
166 * @OVS_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire
167 * packet as received, from the start of the Ethernet header onward. For
168 * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
169 * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
170 * the flow key extracted from the packet as originally received.
171 * @OVS_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key
172 * extracted from the packet as nested %OVS_KEY_ATTR_* attributes. This allows
173 * userspace to adapt its flow setup strategy by comparing its notion of the
174 * flow key against the kernel's. When used with %OVS_PACKET_CMD_EXECUTE, only
175 * metadata key fields (e.g. priority, skb mark) are honored. All the packet
176 * header fields are parsed from the packet instead.
177 * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet. Used
178 * for %OVS_PACKET_CMD_EXECUTE. It has nested %OVS_ACTION_ATTR_* attributes.
179 * Also used in upcall when %OVS_ACTION_ATTR_USERSPACE has optional
180 * %OVS_USERSPACE_ATTR_ACTIONS attribute.
181 * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
182 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
183 * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
185 * @OVS_PACKET_ATTR_EGRESS_TUN_KEY: Present for an %OVS_PACKET_CMD_ACTION
186 * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
187 * %OVS_USERSPACE_ATTR_EGRESS_TUN_PORT attribute, which is sent only if the
188 * output port is actually a tunnel port. Contains the output tunnel key
189 * extracted from the packet as nested %OVS_TUNNEL_KEY_ATTR_* attributes.
190 * @OVS_PACKET_ATTR_MRU: Present for an %OVS_PACKET_CMD_ACTION and
191 * %OVS_PACKET_ATTR_USERSPACE action specify the Maximum received fragment
194 * These attributes follow the &struct ovs_header within the Generic Netlink
195 * payload for %OVS_PACKET_* commands.
197 enum ovs_packet_attr {
198 OVS_PACKET_ATTR_UNSPEC,
199 OVS_PACKET_ATTR_PACKET, /* Packet data. */
200 OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */
201 OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
202 OVS_PACKET_ATTR_USERDATA, /* OVS_ACTION_ATTR_USERSPACE arg. */
203 OVS_PACKET_ATTR_EGRESS_TUN_KEY, /* Nested OVS_TUNNEL_KEY_ATTR_*
205 OVS_PACKET_ATTR_UNUSED1,
206 OVS_PACKET_ATTR_UNUSED2,
207 OVS_PACKET_ATTR_PROBE, /* Packet operation is a feature probe,
208 error logging should be suppressed. */
209 OVS_PACKET_ATTR_MRU, /* Maximum received IP fragment size. */
210 __OVS_PACKET_ATTR_MAX
213 #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
217 #define OVS_VPORT_FAMILY "ovs_vport"
218 #define OVS_VPORT_MCGROUP "ovs_vport"
219 #define OVS_VPORT_VERSION 0x1
222 OVS_VPORT_CMD_UNSPEC,
229 enum ovs_vport_type {
230 OVS_VPORT_TYPE_UNSPEC,
231 OVS_VPORT_TYPE_NETDEV, /* network device */
232 OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
233 OVS_VPORT_TYPE_GRE, /* GRE tunnel. */
234 OVS_VPORT_TYPE_VXLAN, /* VXLAN tunnel. */
235 OVS_VPORT_TYPE_GENEVE, /* Geneve tunnel. */
236 OVS_VPORT_TYPE_LISP = 105, /* LISP tunnel */
237 OVS_VPORT_TYPE_STT = 106, /* STT tunnel */
241 #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
244 * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
245 * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
246 * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
248 * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device
249 * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes
250 * plus a null terminator.
251 * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
252 * @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace
253 * among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets
254 * received on this port. If this is a single-element array of value 0,
255 * upcalls should not be sent.
256 * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
257 * packets sent or received through the vport.
259 * These attributes follow the &struct ovs_header within the Generic Netlink
260 * payload for %OVS_VPORT_* commands.
262 * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
263 * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is
264 * optional; if not specified a free port number is automatically selected.
265 * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
266 * of vport. %OVS_VPORT_ATTR_STATS is optional and other attributes are
269 * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
270 * look up the vport to operate on; otherwise dp_idx from the &struct
271 * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
273 enum ovs_vport_attr {
274 OVS_VPORT_ATTR_UNSPEC,
275 OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
276 OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */
277 OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */
278 OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
279 OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */
280 /* receiving upcalls */
281 OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */
285 #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
288 OVS_VXLAN_EXT_UNSPEC,
289 OVS_VXLAN_EXT_GBP, /* Flag or __u32 */
293 #define OVS_VXLAN_EXT_MAX (__OVS_VXLAN_EXT_MAX - 1)
295 /* OVS_VPORT_ATTR_OPTIONS attributes for tunnels.
298 OVS_TUNNEL_ATTR_UNSPEC,
299 OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */
300 OVS_TUNNEL_ATTR_EXTENSION,
301 __OVS_TUNNEL_ATTR_MAX
304 #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1)
308 #define OVS_FLOW_FAMILY "ovs_flow"
309 #define OVS_FLOW_MCGROUP "ovs_flow"
310 #define OVS_FLOW_VERSION 0x1
320 struct ovs_flow_stats {
321 __u64 n_packets; /* Number of matched packets. */
322 __u64 n_bytes; /* Number of matched bytes. */
327 OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */
328 OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */
329 OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */
330 OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */
331 OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */
332 OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */
333 OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */
334 OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */
335 OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */
336 OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */
337 OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */
338 OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */
339 OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */
340 OVS_KEY_ATTR_ND, /* struct ovs_key_nd */
341 OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */
342 OVS_KEY_ATTR_TUNNEL, /* Nested set of ovs_tunnel attributes */
343 OVS_KEY_ATTR_SCTP, /* struct ovs_key_sctp */
344 OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */
345 OVS_KEY_ATTR_DP_HASH, /* u32 hash value. Value 0 indicates the hash
346 is not computed by the datapath. */
347 OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */
348 OVS_KEY_ATTR_MPLS, /* array of struct ovs_key_mpls.
349 * The implementation may restrict
350 * the accepted length of the array. */
351 OVS_KEY_ATTR_CT_STATE, /* u32 bitmask of OVS_CS_F_* */
352 OVS_KEY_ATTR_CT_ZONE, /* u16 connection tracking zone. */
353 OVS_KEY_ATTR_CT_MARK, /* u32 connection tracking mark */
354 OVS_KEY_ATTR_CT_LABELS, /* 16-octet connection tracking labels */
357 /* Only used within kernel data path. */
358 OVS_KEY_ATTR_TUNNEL_INFO, /* struct ovs_tunnel_info */
363 #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
365 enum ovs_tunnel_key_attr {
366 OVS_TUNNEL_KEY_ATTR_ID, /* be64 Tunnel ID */
367 OVS_TUNNEL_KEY_ATTR_IPV4_SRC, /* be32 src IP address. */
368 OVS_TUNNEL_KEY_ATTR_IPV4_DST, /* be32 dst IP address. */
369 OVS_TUNNEL_KEY_ATTR_TOS, /* u8 Tunnel IP ToS. */
370 OVS_TUNNEL_KEY_ATTR_TTL, /* u8 Tunnel IP TTL. */
371 OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT, /* No argument, set DF. */
372 OVS_TUNNEL_KEY_ATTR_CSUM, /* No argument. CSUM packet. */
373 OVS_TUNNEL_KEY_ATTR_OAM, /* No argument. OAM frame. */
374 OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, /* Array of Geneve options. */
375 OVS_TUNNEL_KEY_ATTR_TP_SRC, /* be16 src Transport Port. */
376 OVS_TUNNEL_KEY_ATTR_TP_DST, /* be16 dst Transport Port. */
377 OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS, /* Nested OVS_VXLAN_EXT_* */
378 __OVS_TUNNEL_KEY_ATTR_MAX
381 #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
384 * enum ovs_frag_type - IPv4 and IPv6 fragment type
385 * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
386 * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
387 * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
389 * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
399 #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
401 struct ovs_key_ethernet {
402 __u8 eth_src[ETH_ALEN];
403 __u8 eth_dst[ETH_ALEN];
406 struct ovs_key_mpls {
410 struct ovs_key_ipv4 {
416 __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */
419 struct ovs_key_ipv6 {
422 __be32 ipv6_label; /* 20-bits in least-significant bits. */
426 __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */
439 struct ovs_key_sctp {
444 struct ovs_key_icmp {
449 struct ovs_key_icmpv6 {
458 __u8 arp_sha[ETH_ALEN];
459 __u8 arp_tha[ETH_ALEN];
464 __u8 nd_sll[ETH_ALEN];
465 __u8 nd_tll[ETH_ALEN];
468 #define OVS_CT_LABELS_LEN 16
469 struct ovs_key_ct_labels {
470 __u8 ct_labels[OVS_CT_LABELS_LEN];
473 /* OVS_KEY_ATTR_CT_STATE flags */
474 #define OVS_CS_F_NEW 0x01 /* Beginning of a new connection. */
475 #define OVS_CS_F_ESTABLISHED 0x02 /* Part of an existing connection. */
476 #define OVS_CS_F_RELATED 0x04 /* Related to an established
478 #define OVS_CS_F_REPLY_DIR 0x08 /* Flow is in the reply direction. */
479 #define OVS_CS_F_INVALID 0x10 /* Could not track connection. */
480 #define OVS_CS_F_TRACKED 0x20 /* Conntrack has occurred. */
483 * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
484 * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
485 * key. Always present in notifications. Required for all requests (except
487 * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
488 * the actions to take for packets that match the key. Always present in
489 * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for
490 * %OVS_FLOW_CMD_SET requests. An %OVS_FLOW_CMD_SET without
491 * %OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions,
492 * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given.
493 * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
494 * flow. Present in notifications if the stats would be nonzero. Ignored in
496 * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
497 * TCP flags seen on packets in this flow. Only present in notifications for
498 * TCP flows, and only if it would be nonzero. Ignored in requests.
499 * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
500 * the system monotonic clock, at which a packet was last processed for this
501 * flow. Only present in notifications if a packet has been processed for this
502 * flow. Ignored in requests.
503 * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
504 * last-used time, accumulated TCP flags, and statistics for this flow.
505 * Otherwise ignored in requests. Never present in notifications.
506 * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the
507 * mask bits for wildcarded flow match. Mask bit value '1' specifies exact
508 * match with corresponding flow key bit, while mask bit value '0' specifies
509 * a wildcarded match. Omitting attribute is treated as wildcarding all
510 * corresponding fields. Optional for all requests. If not present,
511 * all flow key bits are exact match bits.
512 * @OVS_FLOW_ATTR_UFID: A value between 1-16 octets specifying a unique
513 * identifier for the flow. Causes the flow to be indexed by this value rather
514 * than the value of the %OVS_FLOW_ATTR_KEY attribute. Optional for all
515 * requests. Present in notifications if the flow was created with this
517 * @OVS_FLOW_ATTR_UFID_FLAGS: A 32-bit value of OR'd %OVS_UFID_F_*
518 * flags that provide alternative semantics for flow installation and
519 * retrieval. Optional for all requests.
521 * These attributes follow the &struct ovs_header within the Generic Netlink
522 * payload for %OVS_FLOW_* commands.
525 OVS_FLOW_ATTR_UNSPEC,
526 OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */
527 OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
528 OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */
529 OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
530 OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */
531 OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */
532 OVS_FLOW_ATTR_MASK, /* Sequence of OVS_KEY_ATTR_* attributes. */
533 OVS_FLOW_ATTR_PROBE, /* Flow operation is a feature probe, error
534 * logging should be suppressed. */
535 OVS_FLOW_ATTR_UFID, /* Variable length unique flow identifier. */
536 OVS_FLOW_ATTR_UFID_FLAGS,/* u32 of OVS_UFID_F_*. */
540 #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
543 * Omit attributes for notifications.
545 * If a datapath request contains an OVS_UFID_F_OMIT_* flag, then the datapath
546 * may omit the corresponding 'ovs_flow_attr' from the response.
548 #define OVS_UFID_F_OMIT_KEY (1 << 0)
549 #define OVS_UFID_F_OMIT_MASK (1 << 1)
550 #define OVS_UFID_F_OMIT_ACTIONS (1 << 2)
553 * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
554 * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
555 * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of
556 * %UINT32_MAX samples all packets and intermediate values sample intermediate
557 * fractions of packets.
558 * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
559 * Actions are passed as nested attributes.
561 * Executes the specified actions with the given probability on a per-packet
564 enum ovs_sample_attr {
565 OVS_SAMPLE_ATTR_UNSPEC,
566 OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
567 OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
568 __OVS_SAMPLE_ATTR_MAX,
571 #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
574 * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
575 * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
576 * message should be sent. Required.
577 * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
578 * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
579 * @OVS_USERSPACE_ATTR_EGRESS_TUN_PORT: If present, u32 output port to get
581 * @OVS_USERSPACE_ATTR_ACTIONS: If present, send actions with upcall.
583 enum ovs_userspace_attr {
584 OVS_USERSPACE_ATTR_UNSPEC,
585 OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */
586 OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */
587 OVS_USERSPACE_ATTR_EGRESS_TUN_PORT, /* Optional, u32 output port
588 * to get tunnel info. */
589 OVS_USERSPACE_ATTR_ACTIONS, /* Optional flag to get actions. */
590 __OVS_USERSPACE_ATTR_MAX
593 #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
596 * struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument.
597 * @mpls_lse: MPLS label stack entry to push.
598 * @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame.
600 * The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and
601 * %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected.
603 struct ovs_action_push_mpls {
605 __be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */
609 * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
610 * @vlan_tpid: Tag protocol identifier (TPID) to push.
611 * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set
612 * (but it will not be set in the 802.1Q header that is pushed).
614 * The @vlan_tpid value is typically %ETH_P_8021Q. The only acceptable TPID
615 * values are those that the kernel module also parses as 802.1Q headers, to
616 * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN
617 * from having surprising results.
619 struct ovs_action_push_vlan {
620 __be16 vlan_tpid; /* 802.1Q TPID. */
621 __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */
624 /* Data path hash algorithm for computing Datapath hash.
626 * The algorithm type only specifies the fields in a flow
627 * will be used as part of the hash. Each datapath is free
628 * to use its own hash algorithm. The hash value will be
629 * opaque to the user space daemon.
636 * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument.
637 * @hash_alg: Algorithm used to compute hash prior to recirculation.
638 * @hash_basis: basis used for computing hash.
640 struct ovs_action_hash {
641 uint32_t hash_alg; /* One of ovs_hash_alg. */
646 #define TNL_PUSH_HEADER_SIZE 512
649 * struct ovs_action_push_tnl - %OVS_ACTION_ATTR_TUNNEL_PUSH
650 * @tnl_port: To identify tunnel port to pass header info.
651 * @out_port: Physical port to send encapsulated packet.
652 * @header_len: Length of the header to be pushed.
653 * @tnl_type: This is only required to format this header. Otherwise
654 * ODP layer can not parse %header.
655 * @header: Partial header for the tunnel. Tunnel push action can use
656 * this header to build final header according to actual packet parameters.
658 struct ovs_action_push_tnl {
662 uint32_t tnl_type; /* For logging. */
663 uint8_t header[TNL_PUSH_HEADER_SIZE];
668 * enum ovs_ct_attr - Attributes for %OVS_ACTION_ATTR_CT action.
669 * @OVS_CT_ATTR_COMMIT: If present, commits the connection to the conntrack
670 * table. This allows future packets for the same connection to be identified
671 * as 'established' or 'related'.
672 * @OVS_CT_ATTR_ZONE: u16 connection tracking zone.
673 * @OVS_CT_ATTR_MARK: u32 value followed by u32 mask. For each bit set in the
674 * mask, the corresponding bit in the value is copied to the connection
675 * tracking mark field in the connection.
676 * @OVS_CT_ATTR_LABELS: %OVS_CT_LABELS_LEN value followed by %OVS_CT_LABELS_LEN
677 * mask. For each bit set in the mask, the corresponding bit in the value is
678 * copied to the connection tracking label field in the connection.
679 * @OVS_CT_ATTR_HELPER: variable length string defining conntrack ALG.
683 OVS_CT_ATTR_COMMIT, /* No argument, commits connection. */
684 OVS_CT_ATTR_ZONE, /* u16 zone id. */
685 OVS_CT_ATTR_MARK, /* mark to associate with this connection. */
686 OVS_CT_ATTR_LABELS, /* label to associate with this connection. */
687 OVS_CT_ATTR_HELPER, /* netlink helper to assist detection of
688 related connections. */
692 #define OVS_CT_ATTR_MAX (__OVS_CT_ATTR_MAX - 1)
695 * enum ovs_action_attr - Action types.
697 * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
698 * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
699 * %OVS_USERSPACE_ATTR_* attributes.
700 * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the
702 * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet.
703 * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
704 * the nested %OVS_SAMPLE_ATTR_* attributes.
705 * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The
706 * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
708 * @OVS_ACTION_ATTR_SET_MASKED: Replaces the contents of an existing header. A
709 * nested %OVS_KEY_ATTR_* attribute specifies a header to modify, its value,
710 * and a mask. For every bit set in the mask, the corresponding bit value
711 * is copied from the value to the packet header field, rest of the bits are
712 * left unchanged. The non-masked value bits must be passed in as zeroes.
713 * Masking is not supported for the %OVS_KEY_ATTR_TUNNEL attribute.
714 * @OVS_ACTION_RECIRC: Recirculate within the data path.
715 * @OVS_ACTION_HASH: Compute and set flow hash value.
716 * @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the
717 * top of the packets MPLS label stack. Set the ethertype of the
718 * encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to
719 * indicate the new packet contents.
720 * @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the
721 * packet's MPLS label stack. Set the encapsulating frame's ethertype to
722 * indicate the new packet contents. This could potentially still be
723 * %ETH_P_MPLS if the resulting MPLS label stack is not empty. If there
724 * is no MPLS label stack, as determined by ethertype, no action is taken.
725 * @OVS_ACTION_ATTR_CT: Track the connection. Populate the conntrack-related
726 * entries in the flow key.
728 * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all
729 * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
730 * type may not be changed.
733 * @OVS_ACTION_ATTR_SET_TO_MASKED: Kernel internal masked set action translated
734 * from the @OVS_ACTION_ATTR_SET.
735 * @OVS_ACTION_ATTR_TUNNEL_PUSH: Push tunnel header described by struct
736 * ovs_action_push_tnl.
737 * @OVS_ACTION_ATTR_TUNNEL_POP: Lookup tunnel port by port-no passed and pop
741 enum ovs_action_attr {
742 OVS_ACTION_ATTR_UNSPEC,
743 OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */
744 OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */
745 OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */
746 OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */
747 OVS_ACTION_ATTR_POP_VLAN, /* No argument. */
748 OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */
749 OVS_ACTION_ATTR_RECIRC, /* u32 recirc_id. */
750 OVS_ACTION_ATTR_HASH, /* struct ovs_action_hash. */
751 OVS_ACTION_ATTR_PUSH_MPLS, /* struct ovs_action_push_mpls. */
752 OVS_ACTION_ATTR_POP_MPLS, /* __be16 ethertype. */
753 OVS_ACTION_ATTR_SET_MASKED, /* One nested OVS_KEY_ATTR_* including
754 * data immediately followed by a mask.
755 * The data must be zero for the unmasked
757 OVS_ACTION_ATTR_CT, /* Nested OVS_CT_ATTR_* . */
760 OVS_ACTION_ATTR_TUNNEL_PUSH, /* struct ovs_action_push_tnl*/
761 OVS_ACTION_ATTR_TUNNEL_POP, /* u32 port number. */
763 __OVS_ACTION_ATTR_MAX, /* Nothing past this will be accepted
767 OVS_ACTION_ATTR_SET_TO_MASKED, /* Kernel module internal masked
768 * set action converted from
769 * OVS_ACTION_ATTR_SET. */
773 #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
775 #endif /* _LINUX_OPENVSWITCH_H */