openvswitch.h 18 KB

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