openvswitch.h 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522
  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. /* Fixed logical ports. */
  105. #define OVSP_LOCAL ((__u32)0)
  106. /* Packet transfer. */
  107. #define OVS_PACKET_FAMILY "ovs_packet"
  108. #define OVS_PACKET_VERSION 0x1
  109. enum ovs_packet_cmd {
  110. OVS_PACKET_CMD_UNSPEC,
  111. /* Kernel-to-user notifications. */
  112. OVS_PACKET_CMD_MISS, /* Flow table miss. */
  113. OVS_PACKET_CMD_ACTION, /* OVS_ACTION_ATTR_USERSPACE action. */
  114. /* Userspace commands. */
  115. OVS_PACKET_CMD_EXECUTE /* Apply actions to a packet. */
  116. };
  117. /**
  118. * enum ovs_packet_attr - attributes for %OVS_PACKET_* commands.
  119. * @OVS_PACKET_ATTR_PACKET: Present for all notifications. Contains the entire
  120. * packet as received, from the start of the Ethernet header onward. For
  121. * %OVS_PACKET_CMD_ACTION, %OVS_PACKET_ATTR_PACKET reflects changes made by
  122. * actions preceding %OVS_ACTION_ATTR_USERSPACE, but %OVS_PACKET_ATTR_KEY is
  123. * the flow key extracted from the packet as originally received.
  124. * @OVS_PACKET_ATTR_KEY: Present for all notifications. Contains the flow key
  125. * extracted from the packet as nested %OVS_KEY_ATTR_* attributes. This allows
  126. * userspace to adapt its flow setup strategy by comparing its notion of the
  127. * flow key against the kernel's.
  128. * @OVS_PACKET_ATTR_ACTIONS: Contains actions for the packet. Used
  129. * for %OVS_PACKET_CMD_EXECUTE. It has nested %OVS_ACTION_ATTR_* attributes.
  130. * @OVS_PACKET_ATTR_USERDATA: Present for an %OVS_PACKET_CMD_ACTION
  131. * notification if the %OVS_ACTION_ATTR_USERSPACE action specified an
  132. * %OVS_USERSPACE_ATTR_USERDATA attribute, with the same length and content
  133. * specified there.
  134. *
  135. * These attributes follow the &struct ovs_header within the Generic Netlink
  136. * payload for %OVS_PACKET_* commands.
  137. */
  138. enum ovs_packet_attr {
  139. OVS_PACKET_ATTR_UNSPEC,
  140. OVS_PACKET_ATTR_PACKET, /* Packet data. */
  141. OVS_PACKET_ATTR_KEY, /* Nested OVS_KEY_ATTR_* attributes. */
  142. OVS_PACKET_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
  143. OVS_PACKET_ATTR_USERDATA, /* OVS_ACTION_ATTR_USERSPACE arg. */
  144. __OVS_PACKET_ATTR_MAX
  145. };
  146. #define OVS_PACKET_ATTR_MAX (__OVS_PACKET_ATTR_MAX - 1)
  147. /* Virtual ports. */
  148. #define OVS_VPORT_FAMILY "ovs_vport"
  149. #define OVS_VPORT_MCGROUP "ovs_vport"
  150. #define OVS_VPORT_VERSION 0x1
  151. enum ovs_vport_cmd {
  152. OVS_VPORT_CMD_UNSPEC,
  153. OVS_VPORT_CMD_NEW,
  154. OVS_VPORT_CMD_DEL,
  155. OVS_VPORT_CMD_GET,
  156. OVS_VPORT_CMD_SET
  157. };
  158. enum ovs_vport_type {
  159. OVS_VPORT_TYPE_UNSPEC,
  160. OVS_VPORT_TYPE_NETDEV, /* network device */
  161. OVS_VPORT_TYPE_INTERNAL, /* network device implemented by datapath */
  162. OVS_VPORT_TYPE_GRE, /* GRE tunnel. */
  163. OVS_VPORT_TYPE_VXLAN, /* VXLAN tunnel. */
  164. __OVS_VPORT_TYPE_MAX
  165. };
  166. #define OVS_VPORT_TYPE_MAX (__OVS_VPORT_TYPE_MAX - 1)
  167. /**
  168. * enum ovs_vport_attr - attributes for %OVS_VPORT_* commands.
  169. * @OVS_VPORT_ATTR_PORT_NO: 32-bit port number within datapath.
  170. * @OVS_VPORT_ATTR_TYPE: 32-bit %OVS_VPORT_TYPE_* constant describing the type
  171. * of vport.
  172. * @OVS_VPORT_ATTR_NAME: Name of vport. For a vport based on a network device
  173. * this is the name of the network device. Maximum length %IFNAMSIZ-1 bytes
  174. * plus a null terminator.
  175. * @OVS_VPORT_ATTR_OPTIONS: Vport-specific configuration information.
  176. * @OVS_VPORT_ATTR_UPCALL_PID: The Netlink socket in userspace that
  177. * OVS_PACKET_CMD_MISS upcalls will be directed to for packets received on
  178. * this port. A value of zero indicates that upcalls should not be sent.
  179. * @OVS_VPORT_ATTR_STATS: A &struct ovs_vport_stats giving statistics for
  180. * packets sent or received through the vport.
  181. *
  182. * These attributes follow the &struct ovs_header within the Generic Netlink
  183. * payload for %OVS_VPORT_* commands.
  184. *
  185. * For %OVS_VPORT_CMD_NEW requests, the %OVS_VPORT_ATTR_TYPE and
  186. * %OVS_VPORT_ATTR_NAME attributes are required. %OVS_VPORT_ATTR_PORT_NO is
  187. * optional; if not specified a free port number is automatically selected.
  188. * Whether %OVS_VPORT_ATTR_OPTIONS is required or optional depends on the type
  189. * of vport.
  190. *
  191. * For other requests, if %OVS_VPORT_ATTR_NAME is specified then it is used to
  192. * look up the vport to operate on; otherwise dp_idx from the &struct
  193. * ovs_header plus %OVS_VPORT_ATTR_PORT_NO determine the vport.
  194. */
  195. enum ovs_vport_attr {
  196. OVS_VPORT_ATTR_UNSPEC,
  197. OVS_VPORT_ATTR_PORT_NO, /* u32 port number within datapath */
  198. OVS_VPORT_ATTR_TYPE, /* u32 OVS_VPORT_TYPE_* constant. */
  199. OVS_VPORT_ATTR_NAME, /* string name, up to IFNAMSIZ bytes long */
  200. OVS_VPORT_ATTR_OPTIONS, /* nested attributes, varies by vport type */
  201. OVS_VPORT_ATTR_UPCALL_PID, /* u32 Netlink PID to receive upcalls */
  202. OVS_VPORT_ATTR_STATS, /* struct ovs_vport_stats */
  203. __OVS_VPORT_ATTR_MAX
  204. };
  205. #define OVS_VPORT_ATTR_MAX (__OVS_VPORT_ATTR_MAX - 1)
  206. /* OVS_VPORT_ATTR_OPTIONS attributes for tunnels.
  207. */
  208. enum {
  209. OVS_TUNNEL_ATTR_UNSPEC,
  210. OVS_TUNNEL_ATTR_DST_PORT, /* 16-bit UDP port, used by L4 tunnels. */
  211. __OVS_TUNNEL_ATTR_MAX
  212. };
  213. #define OVS_TUNNEL_ATTR_MAX (__OVS_TUNNEL_ATTR_MAX - 1)
  214. /* Flows. */
  215. #define OVS_FLOW_FAMILY "ovs_flow"
  216. #define OVS_FLOW_MCGROUP "ovs_flow"
  217. #define OVS_FLOW_VERSION 0x1
  218. enum ovs_flow_cmd {
  219. OVS_FLOW_CMD_UNSPEC,
  220. OVS_FLOW_CMD_NEW,
  221. OVS_FLOW_CMD_DEL,
  222. OVS_FLOW_CMD_GET,
  223. OVS_FLOW_CMD_SET
  224. };
  225. struct ovs_flow_stats {
  226. __u64 n_packets; /* Number of matched packets. */
  227. __u64 n_bytes; /* Number of matched bytes. */
  228. };
  229. enum ovs_key_attr {
  230. OVS_KEY_ATTR_UNSPEC,
  231. OVS_KEY_ATTR_ENCAP, /* Nested set of encapsulated attributes. */
  232. OVS_KEY_ATTR_PRIORITY, /* u32 skb->priority */
  233. OVS_KEY_ATTR_IN_PORT, /* u32 OVS dp port number */
  234. OVS_KEY_ATTR_ETHERNET, /* struct ovs_key_ethernet */
  235. OVS_KEY_ATTR_VLAN, /* be16 VLAN TCI */
  236. OVS_KEY_ATTR_ETHERTYPE, /* be16 Ethernet type */
  237. OVS_KEY_ATTR_IPV4, /* struct ovs_key_ipv4 */
  238. OVS_KEY_ATTR_IPV6, /* struct ovs_key_ipv6 */
  239. OVS_KEY_ATTR_TCP, /* struct ovs_key_tcp */
  240. OVS_KEY_ATTR_UDP, /* struct ovs_key_udp */
  241. OVS_KEY_ATTR_ICMP, /* struct ovs_key_icmp */
  242. OVS_KEY_ATTR_ICMPV6, /* struct ovs_key_icmpv6 */
  243. OVS_KEY_ATTR_ARP, /* struct ovs_key_arp */
  244. OVS_KEY_ATTR_ND, /* struct ovs_key_nd */
  245. OVS_KEY_ATTR_SKB_MARK, /* u32 skb mark */
  246. OVS_KEY_ATTR_TUNNEL, /* Nested set of ovs_tunnel attributes */
  247. OVS_KEY_ATTR_SCTP, /* struct ovs_key_sctp */
  248. OVS_KEY_ATTR_TCP_FLAGS, /* be16 TCP flags. */
  249. #ifdef __KERNEL__
  250. OVS_KEY_ATTR_IPV4_TUNNEL, /* struct ovs_key_ipv4_tunnel */
  251. #endif
  252. __OVS_KEY_ATTR_MAX
  253. };
  254. #define OVS_KEY_ATTR_MAX (__OVS_KEY_ATTR_MAX - 1)
  255. enum ovs_tunnel_key_attr {
  256. OVS_TUNNEL_KEY_ATTR_ID, /* be64 Tunnel ID */
  257. OVS_TUNNEL_KEY_ATTR_IPV4_SRC, /* be32 src IP address. */
  258. OVS_TUNNEL_KEY_ATTR_IPV4_DST, /* be32 dst IP address. */
  259. OVS_TUNNEL_KEY_ATTR_TOS, /* u8 Tunnel IP ToS. */
  260. OVS_TUNNEL_KEY_ATTR_TTL, /* u8 Tunnel IP TTL. */
  261. OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT, /* No argument, set DF. */
  262. OVS_TUNNEL_KEY_ATTR_CSUM, /* No argument. CSUM packet. */
  263. __OVS_TUNNEL_KEY_ATTR_MAX
  264. };
  265. #define OVS_TUNNEL_KEY_ATTR_MAX (__OVS_TUNNEL_KEY_ATTR_MAX - 1)
  266. /**
  267. * enum ovs_frag_type - IPv4 and IPv6 fragment type
  268. * @OVS_FRAG_TYPE_NONE: Packet is not a fragment.
  269. * @OVS_FRAG_TYPE_FIRST: Packet is a fragment with offset 0.
  270. * @OVS_FRAG_TYPE_LATER: Packet is a fragment with nonzero offset.
  271. *
  272. * Used as the @ipv4_frag in &struct ovs_key_ipv4 and as @ipv6_frag &struct
  273. * ovs_key_ipv6.
  274. */
  275. enum ovs_frag_type {
  276. OVS_FRAG_TYPE_NONE,
  277. OVS_FRAG_TYPE_FIRST,
  278. OVS_FRAG_TYPE_LATER,
  279. __OVS_FRAG_TYPE_MAX
  280. };
  281. #define OVS_FRAG_TYPE_MAX (__OVS_FRAG_TYPE_MAX - 1)
  282. struct ovs_key_ethernet {
  283. __u8 eth_src[ETH_ALEN];
  284. __u8 eth_dst[ETH_ALEN];
  285. };
  286. struct ovs_key_ipv4 {
  287. __be32 ipv4_src;
  288. __be32 ipv4_dst;
  289. __u8 ipv4_proto;
  290. __u8 ipv4_tos;
  291. __u8 ipv4_ttl;
  292. __u8 ipv4_frag; /* One of OVS_FRAG_TYPE_*. */
  293. };
  294. struct ovs_key_ipv6 {
  295. __be32 ipv6_src[4];
  296. __be32 ipv6_dst[4];
  297. __be32 ipv6_label; /* 20-bits in least-significant bits. */
  298. __u8 ipv6_proto;
  299. __u8 ipv6_tclass;
  300. __u8 ipv6_hlimit;
  301. __u8 ipv6_frag; /* One of OVS_FRAG_TYPE_*. */
  302. };
  303. struct ovs_key_tcp {
  304. __be16 tcp_src;
  305. __be16 tcp_dst;
  306. };
  307. struct ovs_key_udp {
  308. __be16 udp_src;
  309. __be16 udp_dst;
  310. };
  311. struct ovs_key_sctp {
  312. __be16 sctp_src;
  313. __be16 sctp_dst;
  314. };
  315. struct ovs_key_icmp {
  316. __u8 icmp_type;
  317. __u8 icmp_code;
  318. };
  319. struct ovs_key_icmpv6 {
  320. __u8 icmpv6_type;
  321. __u8 icmpv6_code;
  322. };
  323. struct ovs_key_arp {
  324. __be32 arp_sip;
  325. __be32 arp_tip;
  326. __be16 arp_op;
  327. __u8 arp_sha[ETH_ALEN];
  328. __u8 arp_tha[ETH_ALEN];
  329. };
  330. struct ovs_key_nd {
  331. __u32 nd_target[4];
  332. __u8 nd_sll[ETH_ALEN];
  333. __u8 nd_tll[ETH_ALEN];
  334. };
  335. /**
  336. * enum ovs_flow_attr - attributes for %OVS_FLOW_* commands.
  337. * @OVS_FLOW_ATTR_KEY: Nested %OVS_KEY_ATTR_* attributes specifying the flow
  338. * key. Always present in notifications. Required for all requests (except
  339. * dumps).
  340. * @OVS_FLOW_ATTR_ACTIONS: Nested %OVS_ACTION_ATTR_* attributes specifying
  341. * the actions to take for packets that match the key. Always present in
  342. * notifications. Required for %OVS_FLOW_CMD_NEW requests, optional for
  343. * %OVS_FLOW_CMD_SET requests.
  344. * @OVS_FLOW_ATTR_STATS: &struct ovs_flow_stats giving statistics for this
  345. * flow. Present in notifications if the stats would be nonzero. Ignored in
  346. * requests.
  347. * @OVS_FLOW_ATTR_TCP_FLAGS: An 8-bit value giving the OR'd value of all of the
  348. * TCP flags seen on packets in this flow. Only present in notifications for
  349. * TCP flows, and only if it would be nonzero. Ignored in requests.
  350. * @OVS_FLOW_ATTR_USED: A 64-bit integer giving the time, in milliseconds on
  351. * the system monotonic clock, at which a packet was last processed for this
  352. * flow. Only present in notifications if a packet has been processed for this
  353. * flow. Ignored in requests.
  354. * @OVS_FLOW_ATTR_CLEAR: If present in a %OVS_FLOW_CMD_SET request, clears the
  355. * last-used time, accumulated TCP flags, and statistics for this flow.
  356. * Otherwise ignored in requests. Never present in notifications.
  357. * @OVS_FLOW_ATTR_MASK: Nested %OVS_KEY_ATTR_* attributes specifying the
  358. * mask bits for wildcarded flow match. Mask bit value '1' specifies exact
  359. * match with corresponding flow key bit, while mask bit value '0' specifies
  360. * a wildcarded match. Omitting attribute is treated as wildcarding all
  361. * corresponding fields. Optional for all requests. If not present,
  362. * all flow key bits are exact match bits.
  363. *
  364. * These attributes follow the &struct ovs_header within the Generic Netlink
  365. * payload for %OVS_FLOW_* commands.
  366. */
  367. enum ovs_flow_attr {
  368. OVS_FLOW_ATTR_UNSPEC,
  369. OVS_FLOW_ATTR_KEY, /* Sequence of OVS_KEY_ATTR_* attributes. */
  370. OVS_FLOW_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
  371. OVS_FLOW_ATTR_STATS, /* struct ovs_flow_stats. */
  372. OVS_FLOW_ATTR_TCP_FLAGS, /* 8-bit OR'd TCP flags. */
  373. OVS_FLOW_ATTR_USED, /* u64 msecs last used in monotonic time. */
  374. OVS_FLOW_ATTR_CLEAR, /* Flag to clear stats, tcp_flags, used. */
  375. OVS_FLOW_ATTR_MASK, /* Sequence of OVS_KEY_ATTR_* attributes. */
  376. __OVS_FLOW_ATTR_MAX
  377. };
  378. #define OVS_FLOW_ATTR_MAX (__OVS_FLOW_ATTR_MAX - 1)
  379. /**
  380. * enum ovs_sample_attr - Attributes for %OVS_ACTION_ATTR_SAMPLE action.
  381. * @OVS_SAMPLE_ATTR_PROBABILITY: 32-bit fraction of packets to sample with
  382. * @OVS_ACTION_ATTR_SAMPLE. A value of 0 samples no packets, a value of
  383. * %UINT32_MAX samples all packets and intermediate values sample intermediate
  384. * fractions of packets.
  385. * @OVS_SAMPLE_ATTR_ACTIONS: Set of actions to execute in sampling event.
  386. * Actions are passed as nested attributes.
  387. *
  388. * Executes the specified actions with the given probability on a per-packet
  389. * basis.
  390. */
  391. enum ovs_sample_attr {
  392. OVS_SAMPLE_ATTR_UNSPEC,
  393. OVS_SAMPLE_ATTR_PROBABILITY, /* u32 number */
  394. OVS_SAMPLE_ATTR_ACTIONS, /* Nested OVS_ACTION_ATTR_* attributes. */
  395. __OVS_SAMPLE_ATTR_MAX,
  396. };
  397. #define OVS_SAMPLE_ATTR_MAX (__OVS_SAMPLE_ATTR_MAX - 1)
  398. /**
  399. * enum ovs_userspace_attr - Attributes for %OVS_ACTION_ATTR_USERSPACE action.
  400. * @OVS_USERSPACE_ATTR_PID: u32 Netlink PID to which the %OVS_PACKET_CMD_ACTION
  401. * message should be sent. Required.
  402. * @OVS_USERSPACE_ATTR_USERDATA: If present, its variable-length argument is
  403. * copied to the %OVS_PACKET_CMD_ACTION message as %OVS_PACKET_ATTR_USERDATA.
  404. */
  405. enum ovs_userspace_attr {
  406. OVS_USERSPACE_ATTR_UNSPEC,
  407. OVS_USERSPACE_ATTR_PID, /* u32 Netlink PID to receive upcalls. */
  408. OVS_USERSPACE_ATTR_USERDATA, /* Optional user-specified cookie. */
  409. __OVS_USERSPACE_ATTR_MAX
  410. };
  411. #define OVS_USERSPACE_ATTR_MAX (__OVS_USERSPACE_ATTR_MAX - 1)
  412. /**
  413. * struct ovs_action_push_vlan - %OVS_ACTION_ATTR_PUSH_VLAN action argument.
  414. * @vlan_tpid: Tag protocol identifier (TPID) to push.
  415. * @vlan_tci: Tag control identifier (TCI) to push. The CFI bit must be set
  416. * (but it will not be set in the 802.1Q header that is pushed).
  417. *
  418. * The @vlan_tpid value is typically %ETH_P_8021Q. The only acceptable TPID
  419. * values are those that the kernel module also parses as 802.1Q headers, to
  420. * prevent %OVS_ACTION_ATTR_PUSH_VLAN followed by %OVS_ACTION_ATTR_POP_VLAN
  421. * from having surprising results.
  422. */
  423. struct ovs_action_push_vlan {
  424. __be16 vlan_tpid; /* 802.1Q TPID. */
  425. __be16 vlan_tci; /* 802.1Q TCI (VLAN ID and priority). */
  426. };
  427. /**
  428. * enum ovs_action_attr - Action types.
  429. *
  430. * @OVS_ACTION_ATTR_OUTPUT: Output packet to port.
  431. * @OVS_ACTION_ATTR_USERSPACE: Send packet to userspace according to nested
  432. * %OVS_USERSPACE_ATTR_* attributes.
  433. * @OVS_ACTION_ATTR_SET: Replaces the contents of an existing header. The
  434. * single nested %OVS_KEY_ATTR_* attribute specifies a header to modify and its
  435. * value.
  436. * @OVS_ACTION_ATTR_PUSH_VLAN: Push a new outermost 802.1Q header onto the
  437. * packet.
  438. * @OVS_ACTION_ATTR_POP_VLAN: Pop the outermost 802.1Q header off the packet.
  439. * @OVS_ACTION_ATTR_SAMPLE: Probabilitically executes actions, as specified in
  440. * the nested %OVS_SAMPLE_ATTR_* attributes.
  441. *
  442. * Only a single header can be set with a single %OVS_ACTION_ATTR_SET. Not all
  443. * fields within a header are modifiable, e.g. the IPv4 protocol and fragment
  444. * type may not be changed.
  445. */
  446. enum ovs_action_attr {
  447. OVS_ACTION_ATTR_UNSPEC,
  448. OVS_ACTION_ATTR_OUTPUT, /* u32 port number. */
  449. OVS_ACTION_ATTR_USERSPACE, /* Nested OVS_USERSPACE_ATTR_*. */
  450. OVS_ACTION_ATTR_SET, /* One nested OVS_KEY_ATTR_*. */
  451. OVS_ACTION_ATTR_PUSH_VLAN, /* struct ovs_action_push_vlan. */
  452. OVS_ACTION_ATTR_POP_VLAN, /* No argument. */
  453. OVS_ACTION_ATTR_SAMPLE, /* Nested OVS_SAMPLE_ATTR_*. */
  454. __OVS_ACTION_ATTR_MAX
  455. };
  456. #define OVS_ACTION_ATTR_MAX (__OVS_ACTION_ATTR_MAX - 1)
  457. #endif /* _LINUX_OPENVSWITCH_H */