openvswitch.h 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558
  1. /*
  2. * Copyright (c) 2007-2013 Nicira, Inc.
  3. *
  4. * This program is free software; you can redistribute it and/or
  5. * modify it under the terms of version 2 of the GNU General Public
  6. * License as published by the Free Software Foundation.
  7. *
  8. * This program is distributed in the hope that it will be useful, but
  9. * WITHOUT ANY WARRANTY; without even the implied warranty of
  10. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11. * General Public License for more details.
  12. *
  13. * You should have received a copy of the GNU General Public License
  14. * along with this program; if not, write to the Free Software
  15. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  16. * 02110-1301, USA
  17. */
  18. #ifndef _UAPI__LINUX_OPENVSWITCH_H
  19. #define _UAPI__LINUX_OPENVSWITCH_H 1
  20. #include <linux/types.h>
  21. #include <linux/if_ether.h>
  22. /**
  23. * struct ovs_header - header for OVS Generic Netlink messages.
  24. * @dp_ifindex: ifindex of local port for datapath (0 to make a request not
  25. * specific to a datapath).
  26. *
  27. * Attributes following the header are specific to a particular OVS Generic
  28. * Netlink family, but all of the OVS families use this header.
  29. */
  30. struct ovs_header {
  31. int dp_ifindex;
  32. };
  33. /* Datapaths. */
  34. #define OVS_DATAPATH_FAMILY "ovs_datapath"
  35. #define OVS_DATAPATH_MCGROUP "ovs_datapath"
  36. /* V2:
  37. * - API users are expected to provide OVS_DP_ATTR_USER_FEATURES
  38. * when creating the datapath.
  39. */
  40. #define OVS_DATAPATH_VERSION 2
  41. /* First OVS datapath version to support features */
  42. #define OVS_DP_VER_FEATURES 2
  43. enum ovs_datapath_cmd {
  44. OVS_DP_CMD_UNSPEC,
  45. OVS_DP_CMD_NEW,
  46. OVS_DP_CMD_DEL,
  47. OVS_DP_CMD_GET,
  48. OVS_DP_CMD_SET
  49. };
  50. /**
  51. * enum ovs_datapath_attr - attributes for %OVS_DP_* commands.
  52. * @OVS_DP_ATTR_NAME: Name of the network device that serves as the "local
  53. * port". This is the name of the network device whose dp_ifindex is given in
  54. * the &struct ovs_header. Always present in notifications. Required in
  55. * %OVS_DP_NEW requests. May be used as an alternative to specifying
  56. * dp_ifindex in other requests (with a dp_ifindex of 0).
  57. * @OVS_DP_ATTR_UPCALL_PID: The Netlink socket in userspace that is initially
  58. * set on the datapath port (for OVS_ACTION_ATTR_MISS). Only valid on
  59. * %OVS_DP_CMD_NEW requests. A value of zero indicates that upcalls should
  60. * not be sent.
  61. * @OVS_DP_ATTR_STATS: Statistics about packets that have passed through the
  62. * datapath. Always present in notifications.
  63. * @OVS_DP_ATTR_MEGAFLOW_STATS: Statistics about mega flow masks usage for the
  64. * datapath. Always present in notifications.
  65. *
  66. * These attributes follow the &struct ovs_header within the Generic Netlink
  67. * payload for %OVS_DP_* commands.
  68. */
  69. enum ovs_datapath_attr {
  70. OVS_DP_ATTR_UNSPEC,
  71. OVS_DP_ATTR_NAME, /* name of dp_ifindex netdev */
  72. OVS_DP_ATTR_UPCALL_PID, /* Netlink PID to receive upcalls */
  73. OVS_DP_ATTR_STATS, /* struct ovs_dp_stats */
  74. OVS_DP_ATTR_MEGAFLOW_STATS, /* struct ovs_dp_megaflow_stats */
  75. OVS_DP_ATTR_USER_FEATURES, /* OVS_DP_F_* */
  76. __OVS_DP_ATTR_MAX
  77. };
  78. #define OVS_DP_ATTR_MAX (__OVS_DP_ATTR_MAX - 1)
  79. struct ovs_dp_stats {
  80. __u64 n_hit; /* Number of flow table matches. */
  81. __u64 n_missed; /* Number of flow table misses. */
  82. __u64 n_lost; /* Number of misses not sent to userspace. */
  83. __u64 n_flows; /* Number of flows present */
  84. };
  85. struct ovs_dp_megaflow_stats {
  86. __u64 n_mask_hit; /* Number of masks used for flow lookups. */
  87. __u32 n_masks; /* Number of masks for the datapath. */
  88. __u32 pad0; /* Pad for future expension. */
  89. __u64 pad1; /* Pad for future expension. */
  90. __u64 pad2; /* Pad for future expension. */
  91. };
  92. struct ovs_vport_stats {
  93. __u64 rx_packets; /* total packets received */
  94. __u64 tx_packets; /* total packets transmitted */
  95. __u64 rx_bytes; /* total bytes received */
  96. __u64 tx_bytes; /* total bytes transmitted */
  97. __u64 rx_errors; /* bad packets received */
  98. __u64 tx_errors; /* packet transmit problems */
  99. __u64 rx_dropped; /* no space in linux buffers */
  100. __u64 tx_dropped; /* no space available in linux */
  101. };
  102. /* Allow last Netlink attribute to be unaligned */
  103. #define OVS_DP_F_UNALIGNED (1 << 0)
  104. /* Allow datapath to associate multiple Netlink PIDs to each vport */
  105. #define OVS_DP_F_VPORT_PIDS (1 << 1)
  106. /* Fixed logical ports. */
  107. #define OVSP_LOCAL ((__u32)0)
  108. /* Packet transfer. */
  109. #define OVS_PACKET_FAMILY "ovs_packet"
  110. #define OVS_PACKET_VERSION 0x1
  111. enum ovs_packet_cmd {
  112. OVS_PACKET_CMD_UNSPEC,
  113. /* Kernel-to-user notifications. */
  114. OVS_PACKET_CMD_MISS, /* Flow table miss. */
  115. OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */
  116. /* Userspace commands. */
  117. OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */
  118. };
  119. /**
  120. * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
  121. * @OVS_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire
  122. * packet as received, from the start of the Ethernet header onward. For
  123. * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
  124. * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
  125. * the flow key extracted from the packet as originally received.
  126. * @OVS_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key
  127. * extracted from the packet as nested %OVS_KEY_ATTR_* attributes. This allows
  128. * userspace to adapt its flow setup strategy by comparing its notion of the
  129. * flow key against the kernel's.
  130. * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet. Used
  131. * for %OVS_PACKET_CMD_EXECUTE. It has nested %OVS_ACTION_ATTR_* attributes.
  132. * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
  133. * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
  134. * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
  135. * specified there.
  136. *
  137. * These attributes follow the &struct ovs_header within the Generic Netlink
  138. * payload for %OVS_PACKET_* commands.
  139. */
  140. enum ovs_packet_attr {
  141. OVS_PACKET_ATTR_UNSPEC,
  142. OVS_PACKET_ATTR_PACKET, /* Packet data. */
  143. OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */
  144. OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
  145. OVS_PACKET_ATTR_USERDATA, /* OVS_ACTION_ATTR_USERSPACE arg. */
  146. __OVS_PACKET_ATTR_MAX
  147. };
  148. #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
  149. /* Virtual ports. */
  150. #define OVS_VPORT_FAMILY "ovs_vport"
  151. #define OVS_VPORT_MCGROUP "ovs_vport"
  152. #define OVS_VPORT_VERSION 0x1
  153. enum ovs_vport_cmd {
  154. OVS_VPORT_CMD_UNSPEC,
  155. OVS_VPORT_CMD_NEW,
  156. OVS_VPORT_CMD_DEL,
  157. OVS_VPORT_CMD_GET,
  158. OVS_VPORT_CMD_SET
  159. };
  160. enum ovs_vport_type {
  161. OVS_VPORT_TYPE_UNSPEC,
  162. OVS_VPORT_TYPE_NETDEV, /* network device */
  163. OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
  164. OVS_VPORT_TYPE_GRE, /* GRE tunnel. */
  165. OVS_VPORT_TYPE_VXLAN, /* VXLAN tunnel. */
  166. OVS_VPORT_TYPE_GENEVE, /* Geneve tunnel. */
  167. __OVS_VPORT_TYPE_MAX
  168. };
  169. #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
  170. /**
  171. * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
  172. * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
  173. * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
  174. * of vport.
  175. * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device
  176. * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes
  177. * plus a null terminator.
  178. * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
  179. * @OVS_VPORT_ATTR_UPCALL_PID: The array of Netlink socket pids in userspace
  180. * among which OVS_PACKET_CMD_MISS upcalls will be distributed for packets
  181. * received on this port. If this is a single-element array of value 0,
  182. * upcalls should not be sent.
  183. * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
  184. * packets sent or received through the vport.
  185. *
  186. * These attributes follow the &struct ovs_header within the Generic Netlink
  187. * payload for %OVS_VPORT_* commands.
  188. *
  189. * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
  190. * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is
  191. * optional; if not specified a free port number is automatically selected.
  192. * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
  193. * of vport.
  194. *
  195. * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
  196. * look up the vport to operate on; otherwise dp_idx from the &struct
  197. * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
  198. */
  199. enum ovs_vport_attr {
  200. OVS_VPORT_ATTR_UNSPEC,
  201. OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
  202. OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */
  203. OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */
  204. OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
  205. OVS_VPORT_ATTR_UPCALL_PID, /* array of u32 Netlink socket PIDs for */
  206. /* receiving upcalls */
  207. OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */
  208. __OVS_VPORT_ATTR_MAX
  209. };
  210. #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
  211. /* OVS_VPORT_ATTR_OPTIONS attributes for tunnels.
  212. */
  213. enum {
  214. OVS_TUNNEL_ATTR_UNSPEC,
  215. OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */
  216. __OVS_TUNNEL_ATTR_MAX
  217. };
  218. #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1)
  219. /* Flows. */
  220. #define OVS_FLOW_FAMILY "ovs_flow"
  221. #define OVS_FLOW_MCGROUP "ovs_flow"
  222. #define OVS_FLOW_VERSION 0x1
  223. enum ovs_flow_cmd {
  224. OVS_FLOW_CMD_UNSPEC,
  225. OVS_FLOW_CMD_NEW,
  226. OVS_FLOW_CMD_DEL,
  227. OVS_FLOW_CMD_GET,
  228. OVS_FLOW_CMD_SET
  229. };
  230. struct ovs_flow_stats {
  231. __u64 n_packets; /* Number of matched packets. */
  232. __u64 n_bytes; /* Number of matched bytes. */
  233. };
  234. enum ovs_key_attr {
  235. OVS_KEY_ATTR_UNSPEC,
  236. OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */
  237. OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */
  238. OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */
  239. OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */
  240. OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */
  241. OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */
  242. OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */
  243. OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */
  244. OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */
  245. OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */
  246. OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */
  247. OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */
  248. OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */
  249. OVS_KEY_ATTR_ND, /* struct ovs_key_nd */
  250. OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */
  251. OVS_KEY_ATTR_TUNNEL, /* Nested set of ovs_tunnel attributes */
  252. OVS_KEY_ATTR_SCTP, /* struct ovs_key_sctp */
  253. OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */
  254. OVS_KEY_ATTR_DP_HASH, /* u32 hash value. Value 0 indicates the hash
  255. is not computed by the datapath. */
  256. OVS_KEY_ATTR_RECIRC_ID, /* u32 recirc id */
  257. #ifdef __KERNEL__
  258. OVS_KEY_ATTR_TUNNEL_INFO, /* struct ovs_tunnel_info */
  259. #endif
  260. __OVS_KEY_ATTR_MAX
  261. };
  262. #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
  263. enum ovs_tunnel_key_attr {
  264. OVS_TUNNEL_KEY_ATTR_ID, /* be64 Tunnel ID */
  265. OVS_TUNNEL_KEY_ATTR_IPV4_SRC, /* be32 src IP address. */
  266. OVS_TUNNEL_KEY_ATTR_IPV4_DST, /* be32 dst IP address. */
  267. OVS_TUNNEL_KEY_ATTR_TOS, /* u8 Tunnel IP ToS. */
  268. OVS_TUNNEL_KEY_ATTR_TTL, /* u8 Tunnel IP TTL. */
  269. OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT, /* No argument, set DF. */
  270. OVS_TUNNEL_KEY_ATTR_CSUM, /* No argument. CSUM packet. */
  271. OVS_TUNNEL_KEY_ATTR_OAM, /* No argument. OAM frame. */
  272. OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, /* Array of Geneve options. */
  273. __OVS_TUNNEL_KEY_ATTR_MAX
  274. };
  275. #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
  276. /**
  277. * enum ovs_frag_type - IPv4 and IPv6 fragment type
  278. * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
  279. * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
  280. * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
  281. *
  282. * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
  283. * ovs_key_ipv6.
  284. */
  285. enum ovs_frag_type {
  286. OVS_FRAG_TYPE_NONE,
  287. OVS_FRAG_TYPE_FIRST,
  288. OVS_FRAG_TYPE_LATER,
  289. __OVS_FRAG_TYPE_MAX
  290. };
  291. #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
  292. struct ovs_key_ethernet {
  293. __u8 eth_src[ETH_ALEN];
  294. __u8 eth_dst[ETH_ALEN];
  295. };
  296. struct ovs_key_ipv4 {
  297. __be32 ipv4_src;
  298. __be32 ipv4_dst;
  299. __u8 ipv4_proto;
  300. __u8 ipv4_tos;
  301. __u8 ipv4_ttl;
  302. __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */
  303. };
  304. struct ovs_key_ipv6 {
  305. __be32 ipv6_src[4];
  306. __be32 ipv6_dst[4];
  307. __be32 ipv6_label; /* 20-bits in least-significant bits. */
  308. __u8 ipv6_proto;
  309. __u8 ipv6_tclass;
  310. __u8 ipv6_hlimit;
  311. __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */
  312. };
  313. struct ovs_key_tcp {
  314. __be16 tcp_src;
  315. __be16 tcp_dst;
  316. };
  317. struct ovs_key_udp {
  318. __be16 udp_src;
  319. __be16 udp_dst;
  320. };
  321. struct ovs_key_sctp {
  322. __be16 sctp_src;
  323. __be16 sctp_dst;
  324. };
  325. struct ovs_key_icmp {
  326. __u8 icmp_type;
  327. __u8 icmp_code;
  328. };
  329. struct ovs_key_icmpv6 {
  330. __u8 icmpv6_type;
  331. __u8 icmpv6_code;
  332. };
  333. struct ovs_key_arp {
  334. __be32 arp_sip;
  335. __be32 arp_tip;
  336. __be16 arp_op;
  337. __u8 arp_sha[ETH_ALEN];
  338. __u8 arp_tha[ETH_ALEN];
  339. };
  340. struct ovs_key_nd {
  341. __u32 nd_target[4];
  342. __u8 nd_sll[ETH_ALEN];
  343. __u8 nd_tll[ETH_ALEN];
  344. };
  345. /**
  346. * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
  347. * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
  348. * key. Always present in notifications. Required for all requests (except
  349. * dumps).
  350. * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
  351. * the actions to take for packets that match the key. Always present in
  352. * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for
  353. * %OVS_FLOW_CMD_SET requests. An %OVS_FLOW_CMD_SET without
  354. * %OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions,
  355. * an %OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given.
  356. * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
  357. * flow. Present in notifications if the stats would be nonzero. Ignored in
  358. * requests.
  359. * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
  360. * TCP flags seen on packets in this flow. Only present in notifications for
  361. * TCP flows, and only if it would be nonzero. Ignored in requests.
  362. * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
  363. * the system monotonic clock, at which a packet was last processed for this
  364. * flow. Only present in notifications if a packet has been processed for this
  365. * flow. Ignored in requests.
  366. * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
  367. * last-used time, accumulated TCP flags, and statistics for this flow.
  368. * Otherwise ignored in requests. Never present in notifications.
  369. * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the
  370. * mask bits for wildcarded flow match. Mask bit value '1' specifies exact
  371. * match with corresponding flow key bit, while mask bit value '0' specifies
  372. * a wildcarded match. Omitting attribute is treated as wildcarding all
  373. * corresponding fields. Optional for all requests. If not present,
  374. * all flow key bits are exact match bits.
  375. *
  376. * These attributes follow the &struct ovs_header within the Generic Netlink
  377. * payload for %OVS_FLOW_* commands.
  378. */
  379. enum ovs_flow_attr {
  380. OVS_FLOW_ATTR_UNSPEC,
  381. OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */
  382. OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
  383. OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */
  384. OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
  385. OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */
  386. OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */
  387. OVS_FLOW_ATTR_MASK, /* Sequence of OVS_KEY_ATTR_* attributes. */
  388. __OVS_FLOW_ATTR_MAX
  389. };
  390. #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
  391. /**
  392. * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
  393. * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
  394. * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of
  395. * %UINT32_MAX samples all packets and intermediate values sample intermediate
  396. * fractions of packets.
  397. * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
  398. * Actions are passed as nested attributes.
  399. *
  400. * Executes the specified actions with the given probability on a per-packet
  401. * basis.
  402. */
  403. enum ovs_sample_attr {
  404. OVS_SAMPLE_ATTR_UNSPEC,
  405. OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
  406. OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
  407. __OVS_SAMPLE_ATTR_MAX,
  408. };
  409. #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
  410. /**
  411. * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
  412. * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
  413. * message should be sent. Required.
  414. * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
  415. * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
  416. */
  417. enum ovs_userspace_attr {
  418. OVS_USERSPACE_ATTR_UNSPEC,
  419. OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */
  420. OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */
  421. __OVS_USERSPACE_ATTR_MAX
  422. };
  423. #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
  424. /**
  425. * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
  426. * @vlan_tpid: Tag protocol identifier (TPID) to push.
  427. * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set
  428. * (but it will not be set in the 802.1Q header that is pushed).
  429. *
  430. * The @vlan_tpid value is typically %ETH_P_8021Q. The only acceptable TPID
  431. * values are those that the kernel module also parses as 802.1Q headers, to
  432. * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN
  433. * from having surprising results.
  434. */
  435. struct ovs_action_push_vlan {
  436. __be16 vlan_tpid; /* 802.1Q TPID. */
  437. __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */
  438. };
  439. /* Data path hash algorithm for computing Datapath hash.
  440. *
  441. * The algorithm type only specifies the fields in a flow
  442. * will be used as part of the hash. Each datapath is free
  443. * to use its own hash algorithm. The hash value will be
  444. * opaque to the user space daemon.
  445. */
  446. enum ovs_hash_alg {
  447. OVS_HASH_ALG_L4,
  448. };
  449. /*
  450. * struct ovs_action_hash - %OVS_ACTION_ATTR_HASH action argument.
  451. * @hash_alg: Algorithm used to compute hash prior to recirculation.
  452. * @hash_basis: basis used for computing hash.
  453. */
  454. struct ovs_action_hash {
  455. uint32_t hash_alg; /* One of ovs_hash_alg. */
  456. uint32_t hash_basis;
  457. };
  458. /**
  459. * enum ovs_action_attr - Action types.
  460. *
  461. * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
  462. * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
  463. * %OVS_USERSPACE_ATTR_* attributes.
  464. * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The
  465. * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
  466. * value.
  467. * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the
  468. * packet.
  469. * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet.
  470. * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
  471. * the nested %OVS_SAMPLE_ATTR_* attributes.
  472. *
  473. * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all
  474. * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
  475. * type may not be changed.
  476. */
  477. enum ovs_action_attr {
  478. OVS_ACTION_ATTR_UNSPEC,
  479. OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */
  480. OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */
  481. OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */
  482. OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */
  483. OVS_ACTION_ATTR_POP_VLAN, /* No argument. */
  484. OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */
  485. OVS_ACTION_ATTR_RECIRC, /* u32 recirc_id. */
  486. OVS_ACTION_ATTR_HASH, /* struct ovs_action_hash. */
  487. __OVS_ACTION_ATTR_MAX
  488. };
  489. #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
  490. #endif /* _LINUX_OPENVSWITCH_H */