flow.h 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * Copyright (c) 2007-2017 Nicira, Inc.
  4. */
  5. #ifndef FLOW_H
  6. #define FLOW_H 1
  7. #include <linux/cache.h>
  8. #include <linux/kernel.h>
  9. #include <linux/netlink.h>
  10. #include <linux/openvswitch.h>
  11. #include <linux/spinlock.h>
  12. #include <linux/types.h>
  13. #include <linux/rcupdate.h>
  14. #include <linux/if_ether.h>
  15. #include <linux/in6.h>
  16. #include <linux/jiffies.h>
  17. #include <linux/time.h>
  18. #include <linux/cpumask.h>
  19. #include <net/inet_ecn.h>
  20. #include <net/ip_tunnels.h>
  21. #include <net/dst_metadata.h>
  22. #include <net/nsh.h>
  23. struct sk_buff;
  24. enum sw_flow_mac_proto {
  25. MAC_PROTO_NONE = 0,
  26. MAC_PROTO_ETHERNET,
  27. };
  28. #define SW_FLOW_KEY_INVALID 0x80
  29. #define MPLS_LABEL_DEPTH 3
  30. /* Store options at the end of the array if they are less than the
  31. * maximum size. This allows us to get the benefits of variable length
  32. * matching for small options.
  33. */
  34. #define TUN_METADATA_OFFSET(opt_len) \
  35. (sizeof_field(struct sw_flow_key, tun_opts) - opt_len)
  36. #define TUN_METADATA_OPTS(flow_key, opt_len) \
  37. ((void *)((flow_key)->tun_opts + TUN_METADATA_OFFSET(opt_len)))
  38. struct ovs_tunnel_info {
  39. struct metadata_dst *tun_dst;
  40. };
  41. struct vlan_head {
  42. __be16 tpid; /* Vlan type. Generally 802.1q or 802.1ad.*/
  43. __be16 tci; /* 0 if no VLAN, VLAN_CFI_MASK set otherwise. */
  44. };
  45. #define OVS_SW_FLOW_KEY_METADATA_SIZE \
  46. (offsetof(struct sw_flow_key, recirc_id) + \
  47. sizeof_field(struct sw_flow_key, recirc_id))
  48. struct ovs_key_nsh {
  49. struct ovs_nsh_key_base base;
  50. __be32 context[NSH_MD1_CONTEXT_SIZE];
  51. };
  52. struct sw_flow_key {
  53. u8 tun_opts[IP_TUNNEL_OPTS_MAX];
  54. u8 tun_opts_len;
  55. struct ip_tunnel_key tun_key; /* Encapsulating tunnel key. */
  56. struct {
  57. u32 priority; /* Packet QoS priority. */
  58. u32 skb_mark; /* SKB mark. */
  59. u16 in_port; /* Input switch port (or DP_MAX_PORTS). */
  60. } __packed phy; /* Safe when right after 'tun_key'. */
  61. u8 mac_proto; /* MAC layer protocol (e.g. Ethernet). */
  62. u8 tun_proto; /* Protocol of encapsulating tunnel. */
  63. u32 ovs_flow_hash; /* Datapath computed hash value. */
  64. u32 recirc_id; /* Recirculation ID. */
  65. struct {
  66. u8 src[ETH_ALEN]; /* Ethernet source address. */
  67. u8 dst[ETH_ALEN]; /* Ethernet destination address. */
  68. struct vlan_head vlan;
  69. struct vlan_head cvlan;
  70. __be16 type; /* Ethernet frame type. */
  71. } eth;
  72. /* Filling a hole of two bytes. */
  73. u8 ct_state;
  74. u8 ct_orig_proto; /* CT original direction tuple IP
  75. * protocol.
  76. */
  77. union {
  78. struct {
  79. u8 proto; /* IP protocol or lower 8 bits of ARP opcode. */
  80. u8 tos; /* IP ToS. */
  81. u8 ttl; /* IP TTL/hop limit. */
  82. u8 frag; /* One of OVS_FRAG_TYPE_*. */
  83. } ip;
  84. };
  85. u16 ct_zone; /* Conntrack zone. */
  86. struct {
  87. __be16 src; /* TCP/UDP/SCTP source port. */
  88. __be16 dst; /* TCP/UDP/SCTP destination port. */
  89. __be16 flags; /* TCP flags. */
  90. } tp;
  91. union {
  92. struct {
  93. struct {
  94. __be32 src; /* IP source address. */
  95. __be32 dst; /* IP destination address. */
  96. } addr;
  97. union {
  98. struct {
  99. __be32 src;
  100. __be32 dst;
  101. } ct_orig; /* Conntrack original direction fields. */
  102. struct {
  103. u8 sha[ETH_ALEN]; /* ARP source hardware address. */
  104. u8 tha[ETH_ALEN]; /* ARP target hardware address. */
  105. } arp;
  106. };
  107. } ipv4;
  108. struct {
  109. struct {
  110. struct in6_addr src; /* IPv6 source address. */
  111. struct in6_addr dst; /* IPv6 destination address. */
  112. } addr;
  113. __be32 label; /* IPv6 flow label. */
  114. union {
  115. struct {
  116. struct in6_addr src;
  117. struct in6_addr dst;
  118. } ct_orig; /* Conntrack original direction fields. */
  119. struct {
  120. struct in6_addr target; /* ND target address. */
  121. u8 sll[ETH_ALEN]; /* ND source link layer address. */
  122. u8 tll[ETH_ALEN]; /* ND target link layer address. */
  123. } nd;
  124. };
  125. } ipv6;
  126. struct {
  127. u32 num_labels_mask; /* labels present bitmap of effective length MPLS_LABEL_DEPTH */
  128. __be32 lse[MPLS_LABEL_DEPTH]; /* label stack entry */
  129. } mpls;
  130. struct ovs_key_nsh nsh; /* network service header */
  131. };
  132. struct {
  133. /* Connection tracking fields not packed above. */
  134. struct {
  135. __be16 src; /* CT orig tuple tp src port. */
  136. __be16 dst; /* CT orig tuple tp dst port. */
  137. } orig_tp;
  138. u32 mark;
  139. struct ovs_key_ct_labels labels;
  140. } ct;
  141. } __aligned(BITS_PER_LONG/8); /* Ensure that we can do comparisons as longs. */
  142. static inline bool sw_flow_key_is_nd(const struct sw_flow_key *key)
  143. {
  144. return key->eth.type == htons(ETH_P_IPV6) &&
  145. key->ip.proto == NEXTHDR_ICMP &&
  146. key->tp.dst == 0 &&
  147. (key->tp.src == htons(NDISC_NEIGHBOUR_SOLICITATION) ||
  148. key->tp.src == htons(NDISC_NEIGHBOUR_ADVERTISEMENT));
  149. }
  150. struct sw_flow_key_range {
  151. unsigned short int start;
  152. unsigned short int end;
  153. };
  154. struct sw_flow_mask {
  155. int ref_count;
  156. struct rcu_head rcu;
  157. struct sw_flow_key_range range;
  158. struct sw_flow_key key;
  159. };
  160. struct sw_flow_match {
  161. struct sw_flow_key *key;
  162. struct sw_flow_key_range range;
  163. struct sw_flow_mask *mask;
  164. };
  165. #define MAX_UFID_LENGTH 16 /* 128 bits */
  166. struct sw_flow_id {
  167. u32 ufid_len;
  168. union {
  169. u32 ufid[MAX_UFID_LENGTH / 4];
  170. struct sw_flow_key *unmasked_key;
  171. };
  172. };
  173. struct sw_flow_actions {
  174. struct rcu_head rcu;
  175. size_t orig_len; /* From flow_cmd_new netlink actions size */
  176. u32 actions_len;
  177. struct nlattr actions[];
  178. };
  179. struct sw_flow_stats {
  180. u64 packet_count; /* Number of packets matched. */
  181. u64 byte_count; /* Number of bytes matched. */
  182. unsigned long used; /* Last used time (in jiffies). */
  183. spinlock_t lock; /* Lock for atomic stats update. */
  184. __be16 tcp_flags; /* Union of seen TCP flags. */
  185. };
  186. struct sw_flow {
  187. struct rcu_head rcu;
  188. struct {
  189. struct hlist_node node[2];
  190. u32 hash;
  191. } flow_table, ufid_table;
  192. int stats_last_writer; /* CPU id of the last writer on
  193. * 'stats[0]'.
  194. */
  195. struct sw_flow_key key;
  196. struct sw_flow_id id;
  197. struct cpumask cpu_used_mask;
  198. struct sw_flow_mask *mask;
  199. struct sw_flow_actions __rcu *sf_acts;
  200. struct sw_flow_stats __rcu *stats[]; /* One for each CPU. First one
  201. * is allocated at flow creation time,
  202. * the rest are allocated on demand
  203. * while holding the 'stats[0].lock'.
  204. */
  205. };
  206. struct arp_eth_header {
  207. __be16 ar_hrd; /* format of hardware address */
  208. __be16 ar_pro; /* format of protocol address */
  209. unsigned char ar_hln; /* length of hardware address */
  210. unsigned char ar_pln; /* length of protocol address */
  211. __be16 ar_op; /* ARP opcode (command) */
  212. /* Ethernet+IPv4 specific members. */
  213. unsigned char ar_sha[ETH_ALEN]; /* sender hardware address */
  214. unsigned char ar_sip[4]; /* sender IP address */
  215. unsigned char ar_tha[ETH_ALEN]; /* target hardware address */
  216. unsigned char ar_tip[4]; /* target IP address */
  217. } __packed;
  218. static inline u8 ovs_key_mac_proto(const struct sw_flow_key *key)
  219. {
  220. return key->mac_proto & ~SW_FLOW_KEY_INVALID;
  221. }
  222. static inline u16 __ovs_mac_header_len(u8 mac_proto)
  223. {
  224. return mac_proto == MAC_PROTO_ETHERNET ? ETH_HLEN : 0;
  225. }
  226. static inline u16 ovs_mac_header_len(const struct sw_flow_key *key)
  227. {
  228. return __ovs_mac_header_len(ovs_key_mac_proto(key));
  229. }
  230. static inline bool ovs_identifier_is_ufid(const struct sw_flow_id *sfid)
  231. {
  232. return sfid->ufid_len;
  233. }
  234. static inline bool ovs_identifier_is_key(const struct sw_flow_id *sfid)
  235. {
  236. return !ovs_identifier_is_ufid(sfid);
  237. }
  238. void ovs_flow_stats_update(struct sw_flow *, __be16 tcp_flags,
  239. const struct sk_buff *);
  240. void ovs_flow_stats_get(const struct sw_flow *, struct ovs_flow_stats *,
  241. unsigned long *used, __be16 *tcp_flags);
  242. void ovs_flow_stats_clear(struct sw_flow *);
  243. u64 ovs_flow_used_time(unsigned long flow_jiffies);
  244. int ovs_flow_key_update(struct sk_buff *skb, struct sw_flow_key *key);
  245. int ovs_flow_key_update_l3l4(struct sk_buff *skb, struct sw_flow_key *key);
  246. int ovs_flow_key_extract(const struct ip_tunnel_info *tun_info,
  247. struct sk_buff *skb,
  248. struct sw_flow_key *key);
  249. /* Extract key from packet coming from userspace. */
  250. int ovs_flow_key_extract_userspace(struct net *net, const struct nlattr *attr,
  251. struct sk_buff *skb,
  252. struct sw_flow_key *key, bool log);
  253. #endif /* flow.h */