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