flow.h 8.4 KB

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