Thomas Graf | 22e3880 | 2013-03-29 14:46:52 +0100 | [diff] [blame] | 1 | |
| 2 | /* |
Andy Zhou | 03f0d91 | 2013-08-07 20:01:00 -0700 | [diff] [blame] | 3 | * Copyright (c) 2007-2013 Nicira, Inc. |
Thomas Graf | 22e3880 | 2013-03-29 14:46:52 +0100 | [diff] [blame] | 4 | * |
| 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 | |
| 35 | struct 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" |
Thomas Graf | 44da5ae | 2013-12-13 15:22:19 +0100 | [diff] [blame] | 43 | |
| 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 |
Thomas Graf | 22e3880 | 2013-03-29 14:46:52 +0100 | [diff] [blame] | 52 | |
| 53 | enum 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. |
Andy Zhou | 1bd7116 | 2013-10-22 10:42:46 -0700 | [diff] [blame] | 74 | * @OVS_DP_ATTR_MEGAFLOW_STATS: Statistics about mega flow masks usage for the |
| 75 | * datapath. Always present in notifications. |
Thomas Graf | 22e3880 | 2013-03-29 14:46:52 +0100 | [diff] [blame] | 76 | * |
| 77 | * These attributes follow the &struct ovs_header within the Generic Netlink |
| 78 | * payload for %OVS_DP_* commands. |
| 79 | */ |
| 80 | enum ovs_datapath_attr { |
| 81 | OVS_DP_ATTR_UNSPEC, |
Andy Zhou | 1bd7116 | 2013-10-22 10:42:46 -0700 | [diff] [blame] | 82 | 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 */ |
Thomas Graf | 43d4be9 | 2013-12-13 15:22:18 +0100 | [diff] [blame] | 86 | OVS_DP_ATTR_USER_FEATURES, /* OVS_DP_F_* */ |
Thomas Graf | 22e3880 | 2013-03-29 14:46:52 +0100 | [diff] [blame] | 87 | __OVS_DP_ATTR_MAX |
| 88 | }; |
| 89 | |
| 90 | #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1) |
| 91 | |
| 92 | struct 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 | |
Andy Zhou | 1bd7116 | 2013-10-22 10:42:46 -0700 | [diff] [blame] | 99 | struct 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 | |
Thomas Graf | 22e3880 | 2013-03-29 14:46:52 +0100 | [diff] [blame] | 107 | struct 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 | |
Thomas Graf | 43d4be9 | 2013-12-13 15:22:18 +0100 | [diff] [blame] | 118 | /* Allow last Netlink attribute to be unaligned */ |
| 119 | #define OVS_DP_F_UNALIGNED (1 << 0) |
| 120 | |
Alex Wang | 5cd667b | 2014-07-17 15:14:13 -0700 | [diff] [blame^] | 121 | /* Allow datapath to associate multiple Netlink PIDs to each vport */ |
| 122 | #define OVS_DP_F_VPORT_PIDS (1 << 1) |
| 123 | |
Thomas Graf | 22e3880 | 2013-03-29 14:46:52 +0100 | [diff] [blame] | 124 | /* 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 | |
| 132 | enum 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. |
| 156 | * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION |
| 157 | * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an |
| 158 | * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content |
| 159 | * specified there. |
| 160 | * |
| 161 | * These attributes follow the &struct ovs_header within the Generic Netlink |
| 162 | * payload for %OVS_PACKET_* commands. |
| 163 | */ |
| 164 | enum ovs_packet_attr { |
| 165 | OVS_PACKET_ATTR_UNSPEC, |
| 166 | OVS_PACKET_ATTR_PACKET, /* Packet data. */ |
| 167 | OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */ |
| 168 | OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ |
| 169 | OVS_PACKET_ATTR_USERDATA, /* OVS_ACTION_ATTR_USERSPACE arg. */ |
| 170 | __OVS_PACKET_ATTR_MAX |
| 171 | }; |
| 172 | |
| 173 | #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1) |
| 174 | |
| 175 | /* Virtual ports. */ |
| 176 | |
| 177 | #define OVS_VPORT_FAMILY "ovs_vport" |
| 178 | #define OVS_VPORT_MCGROUP "ovs_vport" |
| 179 | #define OVS_VPORT_VERSION 0x1 |
| 180 | |
| 181 | enum ovs_vport_cmd { |
| 182 | OVS_VPORT_CMD_UNSPEC, |
| 183 | OVS_VPORT_CMD_NEW, |
| 184 | OVS_VPORT_CMD_DEL, |
| 185 | OVS_VPORT_CMD_GET, |
| 186 | OVS_VPORT_CMD_SET |
| 187 | }; |
| 188 | |
| 189 | enum ovs_vport_type { |
| 190 | OVS_VPORT_TYPE_UNSPEC, |
| 191 | OVS_VPORT_TYPE_NETDEV, /* network device */ |
| 192 | OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */ |
Pravin B Shelar | aa31070 | 2013-06-17 17:50:33 -0700 | [diff] [blame] | 193 | OVS_VPORT_TYPE_GRE, /* GRE tunnel. */ |
Pravin B Shelar | 5826484 | 2013-08-19 11:23:34 -0700 | [diff] [blame] | 194 | OVS_VPORT_TYPE_VXLAN, /* VXLAN tunnel. */ |
Thomas Graf | 22e3880 | 2013-03-29 14:46:52 +0100 | [diff] [blame] | 195 | __OVS_VPORT_TYPE_MAX |
| 196 | }; |
| 197 | |
| 198 | #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1) |
| 199 | |
| 200 | /** |
| 201 | * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands. |
| 202 | * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath. |
| 203 | * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type |
| 204 | * of vport. |
| 205 | * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device |
| 206 | * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes |
| 207 | * plus a null terminator. |
| 208 | * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information. |
Alex Wang | 5cd667b | 2014-07-17 15:14:13 -0700 | [diff] [blame^] | 209 | * @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace |
| 210 | * among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets |
| 211 | * received on this port. If this is a single-element array of value 0, |
| 212 | * upcalls should not be sent. |
Thomas Graf | 22e3880 | 2013-03-29 14:46:52 +0100 | [diff] [blame] | 213 | * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for |
| 214 | * packets sent or received through the vport. |
| 215 | * |
| 216 | * These attributes follow the &struct ovs_header within the Generic Netlink |
| 217 | * payload for %OVS_VPORT_* commands. |
| 218 | * |
| 219 | * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and |
| 220 | * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is |
| 221 | * optional; if not specified a free port number is automatically selected. |
| 222 | * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type |
| 223 | * of vport. |
Thomas Graf | 22e3880 | 2013-03-29 14:46:52 +0100 | [diff] [blame] | 224 | * |
| 225 | * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to |
| 226 | * look up the vport to operate on; otherwise dp_idx from the &struct |
| 227 | * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport. |
| 228 | */ |
| 229 | enum ovs_vport_attr { |
| 230 | OVS_VPORT_ATTR_UNSPEC, |
| 231 | OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */ |
| 232 | OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */ |
| 233 | OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */ |
| 234 | OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */ |
Alex Wang | 5cd667b | 2014-07-17 15:14:13 -0700 | [diff] [blame^] | 235 | OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */ |
| 236 | /* receiving upcalls */ |
Thomas Graf | 22e3880 | 2013-03-29 14:46:52 +0100 | [diff] [blame] | 237 | OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */ |
| 238 | __OVS_VPORT_ATTR_MAX |
| 239 | }; |
| 240 | |
| 241 | #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1) |
| 242 | |
Pravin B Shelar | 5826484 | 2013-08-19 11:23:34 -0700 | [diff] [blame] | 243 | /* OVS_VPORT_ATTR_OPTIONS attributes for tunnels. |
| 244 | */ |
| 245 | enum { |
| 246 | OVS_TUNNEL_ATTR_UNSPEC, |
| 247 | OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */ |
| 248 | __OVS_TUNNEL_ATTR_MAX |
| 249 | }; |
| 250 | |
| 251 | #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1) |
| 252 | |
Thomas Graf | 22e3880 | 2013-03-29 14:46:52 +0100 | [diff] [blame] | 253 | /* Flows. */ |
| 254 | |
| 255 | #define OVS_FLOW_FAMILY "ovs_flow" |
| 256 | #define OVS_FLOW_MCGROUP "ovs_flow" |
| 257 | #define OVS_FLOW_VERSION 0x1 |
| 258 | |
| 259 | enum ovs_flow_cmd { |
| 260 | OVS_FLOW_CMD_UNSPEC, |
| 261 | OVS_FLOW_CMD_NEW, |
| 262 | OVS_FLOW_CMD_DEL, |
| 263 | OVS_FLOW_CMD_GET, |
| 264 | OVS_FLOW_CMD_SET |
| 265 | }; |
| 266 | |
| 267 | struct ovs_flow_stats { |
| 268 | __u64 n_packets; /* Number of matched packets. */ |
| 269 | __u64 n_bytes; /* Number of matched bytes. */ |
| 270 | }; |
| 271 | |
| 272 | enum ovs_key_attr { |
| 273 | OVS_KEY_ATTR_UNSPEC, |
| 274 | OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */ |
| 275 | OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */ |
| 276 | OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */ |
| 277 | OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */ |
| 278 | OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */ |
| 279 | OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */ |
| 280 | OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */ |
| 281 | OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */ |
| 282 | OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */ |
| 283 | OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */ |
| 284 | OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */ |
| 285 | OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */ |
| 286 | OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */ |
| 287 | OVS_KEY_ATTR_ND, /* struct ovs_key_nd */ |
| 288 | OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */ |
Pravin B Shelar | 7d5437c | 2013-06-17 17:50:18 -0700 | [diff] [blame] | 289 | OVS_KEY_ATTR_TUNNEL, /* Nested set of ovs_tunnel attributes */ |
Joe Stringer | a175a72 | 2013-08-22 12:30:48 -0700 | [diff] [blame] | 290 | OVS_KEY_ATTR_SCTP, /* struct ovs_key_sctp */ |
Jarno Rajahalme | 5eb26b1 | 2013-10-23 01:44:59 -0700 | [diff] [blame] | 291 | OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */ |
Pravin B Shelar | 7d5437c | 2013-06-17 17:50:18 -0700 | [diff] [blame] | 292 | |
| 293 | #ifdef __KERNEL__ |
| 294 | OVS_KEY_ATTR_IPV4_TUNNEL, /* struct ovs_key_ipv4_tunnel */ |
| 295 | #endif |
Thomas Graf | 22e3880 | 2013-03-29 14:46:52 +0100 | [diff] [blame] | 296 | __OVS_KEY_ATTR_MAX |
| 297 | }; |
| 298 | |
| 299 | #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1) |
| 300 | |
Pravin B Shelar | 7d5437c | 2013-06-17 17:50:18 -0700 | [diff] [blame] | 301 | enum ovs_tunnel_key_attr { |
| 302 | OVS_TUNNEL_KEY_ATTR_ID, /* be64 Tunnel ID */ |
| 303 | OVS_TUNNEL_KEY_ATTR_IPV4_SRC, /* be32 src IP address. */ |
| 304 | OVS_TUNNEL_KEY_ATTR_IPV4_DST, /* be32 dst IP address. */ |
| 305 | OVS_TUNNEL_KEY_ATTR_TOS, /* u8 Tunnel IP ToS. */ |
| 306 | OVS_TUNNEL_KEY_ATTR_TTL, /* u8 Tunnel IP TTL. */ |
| 307 | OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT, /* No argument, set DF. */ |
| 308 | OVS_TUNNEL_KEY_ATTR_CSUM, /* No argument. CSUM packet. */ |
| 309 | __OVS_TUNNEL_KEY_ATTR_MAX |
| 310 | }; |
| 311 | |
| 312 | #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1) |
| 313 | |
Thomas Graf | 22e3880 | 2013-03-29 14:46:52 +0100 | [diff] [blame] | 314 | /** |
| 315 | * enum ovs_frag_type - IPv4 and IPv6 fragment type |
| 316 | * @OVS_FRAG_TYPE_NONE: Packet is not a fragment. |
| 317 | * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0. |
| 318 | * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset. |
| 319 | * |
| 320 | * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct |
| 321 | * ovs_key_ipv6. |
| 322 | */ |
| 323 | enum ovs_frag_type { |
| 324 | OVS_FRAG_TYPE_NONE, |
| 325 | OVS_FRAG_TYPE_FIRST, |
| 326 | OVS_FRAG_TYPE_LATER, |
| 327 | __OVS_FRAG_TYPE_MAX |
| 328 | }; |
| 329 | |
| 330 | #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1) |
| 331 | |
| 332 | struct ovs_key_ethernet { |
| 333 | __u8 eth_src[ETH_ALEN]; |
| 334 | __u8 eth_dst[ETH_ALEN]; |
| 335 | }; |
| 336 | |
| 337 | struct ovs_key_ipv4 { |
| 338 | __be32 ipv4_src; |
| 339 | __be32 ipv4_dst; |
| 340 | __u8 ipv4_proto; |
| 341 | __u8 ipv4_tos; |
| 342 | __u8 ipv4_ttl; |
| 343 | __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */ |
| 344 | }; |
| 345 | |
| 346 | struct ovs_key_ipv6 { |
| 347 | __be32 ipv6_src[4]; |
| 348 | __be32 ipv6_dst[4]; |
| 349 | __be32 ipv6_label; /* 20-bits in least-significant bits. */ |
| 350 | __u8 ipv6_proto; |
| 351 | __u8 ipv6_tclass; |
| 352 | __u8 ipv6_hlimit; |
| 353 | __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */ |
| 354 | }; |
| 355 | |
| 356 | struct ovs_key_tcp { |
| 357 | __be16 tcp_src; |
| 358 | __be16 tcp_dst; |
| 359 | }; |
| 360 | |
| 361 | struct ovs_key_udp { |
| 362 | __be16 udp_src; |
| 363 | __be16 udp_dst; |
| 364 | }; |
| 365 | |
Joe Stringer | a175a72 | 2013-08-22 12:30:48 -0700 | [diff] [blame] | 366 | struct ovs_key_sctp { |
| 367 | __be16 sctp_src; |
| 368 | __be16 sctp_dst; |
| 369 | }; |
| 370 | |
Thomas Graf | 22e3880 | 2013-03-29 14:46:52 +0100 | [diff] [blame] | 371 | struct ovs_key_icmp { |
| 372 | __u8 icmp_type; |
| 373 | __u8 icmp_code; |
| 374 | }; |
| 375 | |
| 376 | struct ovs_key_icmpv6 { |
| 377 | __u8 icmpv6_type; |
| 378 | __u8 icmpv6_code; |
| 379 | }; |
| 380 | |
| 381 | struct ovs_key_arp { |
| 382 | __be32 arp_sip; |
| 383 | __be32 arp_tip; |
| 384 | __be16 arp_op; |
| 385 | __u8 arp_sha[ETH_ALEN]; |
| 386 | __u8 arp_tha[ETH_ALEN]; |
| 387 | }; |
| 388 | |
| 389 | struct ovs_key_nd { |
| 390 | __u32 nd_target[4]; |
| 391 | __u8 nd_sll[ETH_ALEN]; |
| 392 | __u8 nd_tll[ETH_ALEN]; |
| 393 | }; |
| 394 | |
| 395 | /** |
| 396 | * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands. |
| 397 | * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow |
| 398 | * key. Always present in notifications. Required for all requests (except |
| 399 | * dumps). |
| 400 | * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying |
| 401 | * the actions to take for packets that match the key. Always present in |
| 402 | * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for |
Jarno Rajahalme | be52c9e | 2014-05-05 09:59:40 -0700 | [diff] [blame] | 403 | * %OVS_FLOW_CMD_SET requests. An %OVS_FLOW_CMD_SET without |
| 404 | * %OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions, |
| 405 | * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given. |
Thomas Graf | 22e3880 | 2013-03-29 14:46:52 +0100 | [diff] [blame] | 406 | * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this |
| 407 | * flow. Present in notifications if the stats would be nonzero. Ignored in |
| 408 | * requests. |
| 409 | * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the |
| 410 | * TCP flags seen on packets in this flow. Only present in notifications for |
| 411 | * TCP flows, and only if it would be nonzero. Ignored in requests. |
| 412 | * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on |
| 413 | * the system monotonic clock, at which a packet was last processed for this |
| 414 | * flow. Only present in notifications if a packet has been processed for this |
| 415 | * flow. Ignored in requests. |
| 416 | * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the |
| 417 | * last-used time, accumulated TCP flags, and statistics for this flow. |
| 418 | * Otherwise ignored in requests. Never present in notifications. |
Andy Zhou | 03f0d91 | 2013-08-07 20:01:00 -0700 | [diff] [blame] | 419 | * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the |
| 420 | * mask bits for wildcarded flow match. Mask bit value '1' specifies exact |
| 421 | * match with corresponding flow key bit, while mask bit value '0' specifies |
| 422 | * a wildcarded match. Omitting attribute is treated as wildcarding all |
| 423 | * corresponding fields. Optional for all requests. If not present, |
| 424 | * all flow key bits are exact match bits. |
Thomas Graf | 22e3880 | 2013-03-29 14:46:52 +0100 | [diff] [blame] | 425 | * |
| 426 | * These attributes follow the &struct ovs_header within the Generic Netlink |
| 427 | * payload for %OVS_FLOW_* commands. |
| 428 | */ |
| 429 | enum ovs_flow_attr { |
| 430 | OVS_FLOW_ATTR_UNSPEC, |
| 431 | OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */ |
| 432 | OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ |
| 433 | OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */ |
| 434 | OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */ |
| 435 | OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */ |
| 436 | OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */ |
Andy Zhou | 03f0d91 | 2013-08-07 20:01:00 -0700 | [diff] [blame] | 437 | OVS_FLOW_ATTR_MASK, /* Sequence of OVS_KEY_ATTR_* attributes. */ |
Thomas Graf | 22e3880 | 2013-03-29 14:46:52 +0100 | [diff] [blame] | 438 | __OVS_FLOW_ATTR_MAX |
| 439 | }; |
| 440 | |
| 441 | #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1) |
| 442 | |
| 443 | /** |
| 444 | * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action. |
| 445 | * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with |
| 446 | * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of |
| 447 | * %UINT32_MAX samples all packets and intermediate values sample intermediate |
| 448 | * fractions of packets. |
| 449 | * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event. |
| 450 | * Actions are passed as nested attributes. |
| 451 | * |
| 452 | * Executes the specified actions with the given probability on a per-packet |
| 453 | * basis. |
| 454 | */ |
| 455 | enum ovs_sample_attr { |
| 456 | OVS_SAMPLE_ATTR_UNSPEC, |
| 457 | OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */ |
| 458 | OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */ |
| 459 | __OVS_SAMPLE_ATTR_MAX, |
| 460 | }; |
| 461 | |
| 462 | #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1) |
| 463 | |
| 464 | /** |
| 465 | * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action. |
| 466 | * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION |
| 467 | * message should be sent. Required. |
| 468 | * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is |
| 469 | * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA. |
| 470 | */ |
| 471 | enum ovs_userspace_attr { |
| 472 | OVS_USERSPACE_ATTR_UNSPEC, |
| 473 | OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */ |
| 474 | OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */ |
| 475 | __OVS_USERSPACE_ATTR_MAX |
| 476 | }; |
| 477 | |
| 478 | #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1) |
| 479 | |
| 480 | /** |
| 481 | * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument. |
| 482 | * @vlan_tpid: Tag protocol identifier (TPID) to push. |
| 483 | * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set |
| 484 | * (but it will not be set in the 802.1Q header that is pushed). |
| 485 | * |
| 486 | * The @vlan_tpid value is typically %ETH_P_8021Q. The only acceptable TPID |
| 487 | * values are those that the kernel module also parses as 802.1Q headers, to |
| 488 | * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN |
| 489 | * from having surprising results. |
| 490 | */ |
| 491 | struct ovs_action_push_vlan { |
| 492 | __be16 vlan_tpid; /* 802.1Q TPID. */ |
| 493 | __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */ |
| 494 | }; |
| 495 | |
| 496 | /** |
| 497 | * enum ovs_action_attr - Action types. |
| 498 | * |
| 499 | * @OVS_ACTION_ATTR_OUTPUT: Output packet to port. |
| 500 | * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested |
| 501 | * %OVS_USERSPACE_ATTR_* attributes. |
| 502 | * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The |
| 503 | * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its |
| 504 | * value. |
| 505 | * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the |
| 506 | * packet. |
| 507 | * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet. |
| 508 | * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in |
| 509 | * the nested %OVS_SAMPLE_ATTR_* attributes. |
| 510 | * |
| 511 | * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all |
| 512 | * fields within a header are modifiable, e.g. the IPv4 protocol and fragment |
| 513 | * type may not be changed. |
| 514 | */ |
| 515 | |
| 516 | enum ovs_action_attr { |
| 517 | OVS_ACTION_ATTR_UNSPEC, |
| 518 | OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */ |
| 519 | OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */ |
| 520 | OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */ |
| 521 | OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */ |
| 522 | OVS_ACTION_ATTR_POP_VLAN, /* No argument. */ |
| 523 | OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */ |
| 524 | __OVS_ACTION_ATTR_MAX |
| 525 | }; |
| 526 | |
| 527 | #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1) |
| 528 | |
| 529 | #endif /* _LINUX_OPENVSWITCH_H */ |