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
* @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
180
* notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
181
* %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
183
* @OVS_PACKET_ATTR_EGRESS_TUN_KEY: Present for an %OVS_PACKET_CMD_ACTION
184
* notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
185
* %OVS_USERSPACE_ATTR_EGRESS_TUN_PORT attribute, which is sent only if the
186
* output port is actually a tunnel port. Contains the output tunnel key
187
* extracted from the packet as nested %OVS_TUNNEL_KEY_ATTR_* attributes.
189
* These attributes follow the &struct ovs_header within the Generic Netlink
190
* payload for %OVS_PACKET_* commands.
192
enum ovs_packet_attr {
193
OVS_PACKET_ATTR_UNSPEC,
194
OVS_PACKET_ATTR_PACKET, /* Packet data. */
195
OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */
196
OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
197
OVS_PACKET_ATTR_USERDATA, /* OVS_ACTION_ATTR_USERSPACE arg. */
198
OVS_PACKET_ATTR_EGRESS_TUN_KEY, /* Nested OVS_TUNNEL_KEY_ATTR_*
200
OVS_PACKET_ATTR_UNUSED1,
201
OVS_PACKET_ATTR_UNUSED2,
202
OVS_PACKET_ATTR_PROBE, /* Packet operation is a feature probe,
203
error logging should be suppressed. */
204
__OVS_PACKET_ATTR_MAX
207
#define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
211
#define OVS_VPORT_FAMILY "ovs_vport"
212
#define OVS_VPORT_MCGROUP "ovs_vport"
213
#define OVS_VPORT_VERSION 0x1
216
OVS_VPORT_CMD_UNSPEC,
223
enum ovs_vport_type {
224
OVS_VPORT_TYPE_UNSPEC,
225
OVS_VPORT_TYPE_NETDEV, /* network device */
226
OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
227
OVS_VPORT_TYPE_GRE, /* GRE tunnel. */
228
OVS_VPORT_TYPE_VXLAN, /* VXLAN tunnel. */
229
OVS_VPORT_TYPE_GENEVE, /* Geneve tunnel. */
230
OVS_VPORT_TYPE_GRE64 = 104, /* GRE tunnel with 64-bit keys */
231
OVS_VPORT_TYPE_LISP = 105, /* LISP tunnel */
232
OVS_VPORT_TYPE_STT = 106, /* STT tunnel */
236
#define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
239
* enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
240
* @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
241
* @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
243
* @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device
244
* this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes
245
* plus a null terminator.
246
* @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
247
* @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace
248
* among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets
249
* received on this port. If this is a single-element array of value 0,
250
* upcalls should not be sent.
251
* @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
252
* packets sent or received through the vport.
254
* These attributes follow the &struct ovs_header within the Generic Netlink
255
* payload for %OVS_VPORT_* commands.
257
* For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
258
* %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is
259
* optional; if not specified a free port number is automatically selected.
260
* Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
261
* of vport. %OVS_VPORT_ATTR_STATS is optional and other attributes are
264
* For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
265
* look up the vport to operate on; otherwise dp_idx from the &struct
266
* ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
268
enum ovs_vport_attr {
269
OVS_VPORT_ATTR_UNSPEC,
270
OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
271
OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */
272
OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */
273
OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
274
OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */
275
/* receiving upcalls */
276
OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */
280
#define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
283
OVS_VXLAN_EXT_UNSPEC,
284
OVS_VXLAN_EXT_GBP, /* Flag or __u32 */
288
#define OVS_VXLAN_EXT_MAX (__OVS_VXLAN_EXT_MAX - 1)
290
/* OVS_VPORT_ATTR_OPTIONS attributes for tunnels.
293
OVS_TUNNEL_ATTR_UNSPEC,
294
OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */
295
OVS_TUNNEL_ATTR_EXTENSION,
296
__OVS_TUNNEL_ATTR_MAX
299
#define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1)
303
#define OVS_FLOW_FAMILY "ovs_flow"
304
#define OVS_FLOW_MCGROUP "ovs_flow"
305
#define OVS_FLOW_VERSION 0x1
315
struct ovs_flow_stats {
316
__u64 n_packets; /* Number of matched packets. */
317
__u64 n_bytes; /* Number of matched bytes. */
322
OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */
323
OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */
324
OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */
325
OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */
326
OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */
327
OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */
328
OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */
329
OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */
330
OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */
331
OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */
332
OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */
333
OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */
334
OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */
335
OVS_KEY_ATTR_ND, /* struct ovs_key_nd */
336
OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */
337
OVS_KEY_ATTR_TUNNEL, /* Nested set of ovs_tunnel attributes */
338
OVS_KEY_ATTR_SCTP, /* struct ovs_key_sctp */
339
OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */
340
OVS_KEY_ATTR_DP_HASH, /* u32 hash value. Value 0 indicates the hash
341
is not computed by the datapath. */
342
OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */
343
OVS_KEY_ATTR_MPLS, /* array of struct ovs_key_mpls.
344
* The implementation may restrict
345
* the accepted length of the array. */
348
/* Only used within kernel data path. */
349
OVS_KEY_ATTR_TUNNEL_INFO, /* struct ovs_tunnel_info */
354
#define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
356
enum ovs_tunnel_key_attr {
357
OVS_TUNNEL_KEY_ATTR_ID, /* be64 Tunnel ID */
358
OVS_TUNNEL_KEY_ATTR_IPV4_SRC, /* be32 src IP address. */
359
OVS_TUNNEL_KEY_ATTR_IPV4_DST, /* be32 dst IP address. */
360
OVS_TUNNEL_KEY_ATTR_TOS, /* u8 Tunnel IP ToS. */
361
OVS_TUNNEL_KEY_ATTR_TTL, /* u8 Tunnel IP TTL. */
362
OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT, /* No argument, set DF. */
363
OVS_TUNNEL_KEY_ATTR_CSUM, /* No argument. CSUM packet. */
364
OVS_TUNNEL_KEY_ATTR_OAM, /* No argument. OAM frame. */
365
OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, /* Array of Geneve options. */
366
OVS_TUNNEL_KEY_ATTR_TP_SRC, /* be16 src Transport Port. */
367
OVS_TUNNEL_KEY_ATTR_TP_DST, /* be16 dst Transport Port. */
368
OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS, /* Nested OVS_VXLAN_EXT_* */
369
__OVS_TUNNEL_KEY_ATTR_MAX
372
#define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
375
* enum ovs_frag_type - IPv4 and IPv6 fragment type
376
* @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
377
* @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
378
* @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
380
* Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
390
#define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
392
struct ovs_key_ethernet {
393
__u8 eth_src[ETH_ALEN];
394
__u8 eth_dst[ETH_ALEN];
397
struct ovs_key_mpls {
401
struct ovs_key_ipv4 {
407
__u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */
410
struct ovs_key_ipv6 {
413
__be32 ipv6_label; /* 20-bits in least-significant bits. */
417
__u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */
430
struct ovs_key_sctp {
435
struct ovs_key_icmp {
440
struct ovs_key_icmpv6 {
449
__u8 arp_sha[ETH_ALEN];
450
__u8 arp_tha[ETH_ALEN];
455
__u8 nd_sll[ETH_ALEN];
456
__u8 nd_tll[ETH_ALEN];
460
* enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
461
* @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
462
* key. Always present in notifications. Required for all requests (except
464
* @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
465
* the actions to take for packets that match the key. Always present in
466
* notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for
467
* %OVS_FLOW_CMD_SET requests. An %OVS_FLOW_CMD_SET without
468
* %OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions,
469
* an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given.
470
* @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
471
* flow. Present in notifications if the stats would be nonzero. Ignored in
473
* @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
474
* TCP flags seen on packets in this flow. Only present in notifications for
475
* TCP flows, and only if it would be nonzero. Ignored in requests.
476
* @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
477
* the system monotonic clock, at which a packet was last processed for this
478
* flow. Only present in notifications if a packet has been processed for this
479
* flow. Ignored in requests.
480
* @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
481
* last-used time, accumulated TCP flags, and statistics for this flow.
482
* Otherwise ignored in requests. Never present in notifications.
483
* @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the
484
* mask bits for wildcarded flow match. Mask bit value '1' specifies exact
485
* match with corresponding flow key bit, while mask bit value '0' specifies
486
* a wildcarded match. Omitting attribute is treated as wildcarding all
487
* corresponding fields. Optional for all requests. If not present,
488
* all flow key bits are exact match bits.
489
* @OVS_FLOW_ATTR_UFID: A value between 1-16 octets specifying a unique
490
* identifier for the flow. Causes the flow to be indexed by this value rather
491
* than the value of the %OVS_FLOW_ATTR_KEY attribute. Optional for all
492
* requests. Present in notifications if the flow was created with this
494
* @OVS_FLOW_ATTR_UFID_FLAGS: A 32-bit value of OR'd %OVS_UFID_F_*
495
* flags that provide alternative semantics for flow installation and
496
* retrieval. Optional for all requests.
498
* These attributes follow the &struct ovs_header within the Generic Netlink
499
* payload for %OVS_FLOW_* commands.
502
OVS_FLOW_ATTR_UNSPEC,
503
OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */
504
OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
505
OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */
506
OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
507
OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */
508
OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */
509
OVS_FLOW_ATTR_MASK, /* Sequence of OVS_KEY_ATTR_* attributes. */
510
OVS_FLOW_ATTR_PROBE, /* Flow operation is a feature probe, error
511
* logging should be suppressed. */
512
OVS_FLOW_ATTR_UFID, /* Variable length unique flow identifier. */
513
OVS_FLOW_ATTR_UFID_FLAGS,/* u32 of OVS_UFID_F_*. */
517
#define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
520
* Omit attributes for notifications.
522
* If a datapath request contains an OVS_UFID_F_OMIT_* flag, then the datapath
523
* may omit the corresponding 'ovs_flow_attr' from the response.
525
#define OVS_UFID_F_OMIT_KEY (1 << 0)
526
#define OVS_UFID_F_OMIT_MASK (1 << 1)
527
#define OVS_UFID_F_OMIT_ACTIONS (1 << 2)
530
* enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
531
* @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
532
* @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of
533
* %UINT32_MAX samples all packets and intermediate values sample intermediate
534
* fractions of packets.
535
* @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
536
* Actions are passed as nested attributes.
538
* Executes the specified actions with the given probability on a per-packet
541
enum ovs_sample_attr {
542
OVS_SAMPLE_ATTR_UNSPEC,
543
OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
544
OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
545
__OVS_SAMPLE_ATTR_MAX,
548
#define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
551
* enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
552
* @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
553
* message should be sent. Required.
554
* @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
555
* copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
556
* @OVS_USERSPACE_ATTR_EGRESS_TUN_PORT: If present, u32 output port to get
559
enum 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. */
563
OVS_USERSPACE_ATTR_EGRESS_TUN_PORT, /* Optional, u32 output port
564
* to get tunnel info. */
565
__OVS_USERSPACE_ATTR_MAX
568
#define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
571
* struct ovs_action_push_mpls - %OVS_ACTION_ATTR_PUSH_MPLS action argument.
572
* @mpls_lse: MPLS label stack entry to push.
573
* @mpls_ethertype: Ethertype to set in the encapsulating ethernet frame.
575
* The only values @mpls_ethertype should ever be given are %ETH_P_MPLS_UC and
576
* %ETH_P_MPLS_MC, indicating MPLS unicast or multicast. Other are rejected.
578
struct ovs_action_push_mpls {
580
__be16 mpls_ethertype; /* Either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC */
584
* struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
585
* @vlan_tpid: Tag protocol identifier (TPID) to push.
586
* @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set
587
* (but it will not be set in the 802.1Q header that is pushed).
589
* The @vlan_tpid value is typically %ETH_P_8021Q. The only acceptable TPID
590
* values are those that the kernel module also parses as 802.1Q headers, to
591
* prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN
592
* from having surprising results.
594
struct ovs_action_push_vlan {
595
__be16 vlan_tpid; /* 802.1Q TPID. */
596
__be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */
599
/* Data path hash algorithm for computing Datapath hash.
601
* The algorithm type only specifies the fields in a flow
602
* will be used as part of the hash. Each datapath is free
603
* to use its own hash algorithm. The hash value will be
604
* opaque to the user space daemon.
611
* struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument.
612
* @hash_alg: Algorithm used to compute hash prior to recirculation.
613
* @hash_basis: basis used for computing hash.
615
struct ovs_action_hash {
616
uint32_t hash_alg; /* One of ovs_hash_alg. */
621
#define TNL_PUSH_HEADER_SIZE 128
624
* struct ovs_action_push_tnl - %OVS_ACTION_ATTR_TUNNEL_PUSH
625
* @tnl_port: To identify tunnel port to pass header info.
626
* @out_port: Physical port to send encapsulated packet.
627
* @header_len: Length of the header to be pushed.
628
* @tnl_type: This is only required to format this header. Otherwise
629
* ODP layer can not parse %header.
630
* @header: Partial header for the tunnel. Tunnel push action can use
631
* this header to build final header according to actual packet parameters.
633
struct ovs_action_push_tnl {
637
uint32_t tnl_type; /* For logging. */
638
uint8_t header[TNL_PUSH_HEADER_SIZE];
643
* enum ovs_action_attr - Action types.
645
* @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
646
* @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
647
* %OVS_USERSPACE_ATTR_* attributes.
648
* @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the
650
* @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet.
651
* @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
652
* the nested %OVS_SAMPLE_ATTR_* attributes.
653
* @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The
654
* single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
656
* @OVS_ACTION_ATTR_SET_MASKED: Replaces the contents of an existing header. A
657
* nested %OVS_KEY_ATTR_* attribute specifies a header to modify, its value,
658
* and a mask. For every bit set in the mask, the corresponding bit value
659
* is copied from the value to the packet header field, rest of the bits are
660
* left unchanged. The non-masked value bits must be passed in as zeroes.
661
* Masking is not supported for the %OVS_KEY_ATTR_TUNNEL attribute.
662
* @OVS_ACTION_RECIRC: Recirculate within the data path.
663
* @OVS_ACTION_HASH: Compute and set flow hash value.
664
* @OVS_ACTION_ATTR_PUSH_MPLS: Push a new MPLS label stack entry onto the
665
* top of the packets MPLS label stack. Set the ethertype of the
666
* encapsulating frame to either %ETH_P_MPLS_UC or %ETH_P_MPLS_MC to
667
* indicate the new packet contents.
668
* @OVS_ACTION_ATTR_POP_MPLS: Pop an MPLS label stack entry off of the
669
* packet's MPLS label stack. Set the encapsulating frame's ethertype to
670
* indicate the new packet contents. This could potentially still be
671
* %ETH_P_MPLS if the resulting MPLS label stack is not empty. If there
672
* is no MPLS label stack, as determined by ethertype, no action is taken.
674
* Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all
675
* fields within a header are modifiable, e.g. the IPv4 protocol and fragment
676
* type may not be changed.
679
* @OVS_ACTION_ATTR_SET_TO_MASKED: Kernel internal masked set action translated
680
* from the @OVS_ACTION_ATTR_SET.
681
* @OVS_ACTION_ATTR_TUNNEL_PUSH: Push tunnel header described by struct
682
* ovs_action_push_tnl.
683
* @OVS_ACTION_ATTR_TUNNEL_POP: Lookup tunnel port by port-no passed and pop
687
enum ovs_action_attr {
688
OVS_ACTION_ATTR_UNSPEC,
689
OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */
690
OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */
691
OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */
692
OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */
693
OVS_ACTION_ATTR_POP_VLAN, /* No argument. */
694
OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */
695
OVS_ACTION_ATTR_RECIRC, /* u32 recirc_id. */
696
OVS_ACTION_ATTR_HASH, /* struct ovs_action_hash. */
697
OVS_ACTION_ATTR_PUSH_MPLS, /* struct ovs_action_push_mpls. */
698
OVS_ACTION_ATTR_POP_MPLS, /* __be16 ethertype. */
699
OVS_ACTION_ATTR_SET_MASKED, /* One nested OVS_KEY_ATTR_* including
700
* data immediately followed by a mask.
701
* The data must be zero for the unmasked
705
OVS_ACTION_ATTR_TUNNEL_PUSH, /* struct ovs_action_push_tnl*/
706
OVS_ACTION_ATTR_TUNNEL_POP, /* u32 port number. */
708
__OVS_ACTION_ATTR_MAX, /* Nothing past this will be accepted
712
OVS_ACTION_ATTR_SET_TO_MASKED, /* Kernel module internal masked
713
* set action converted from
714
* OVS_ACTION_ATTR_SET. */
718
#define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
720
#endif /* _LINUX_OPENVSWITCH_H */
added
removed
datapath/linux/compat/include/linux/openvswitch.h
