1 #ifndef _NET_FLOW_DISSECTOR_H
2 #define _NET_FLOW_DISSECTOR_H
4 #include <linux/types.h>
6 #include <uapi/linux/if_ether.h>
9 * struct flow_dissector_key_control:
10 * @thoff: Transport header offset
12 struct flow_dissector_key_control {
18 #define FLOW_DIS_IS_FRAGMENT BIT(0)
19 #define FLOW_DIS_FIRST_FRAG BIT(1)
20 #define FLOW_DIS_ENCAPSULATION BIT(2)
23 * struct flow_dissector_key_basic:
24 * @thoff: Transport header offset
25 * @n_proto: Network header protocol (eg. IPv4/IPv6)
26 * @ip_proto: Transport header protocol (eg. TCP/UDP)
28 struct flow_dissector_key_basic {
34 struct flow_dissector_key_tags {
38 struct flow_dissector_key_vlan {
44 struct flow_dissector_key_mpls {
51 struct flow_dissector_key_keyid {
56 * struct flow_dissector_key_ipv4_addrs:
57 * @src: source ip address
58 * @dst: destination ip address
60 struct flow_dissector_key_ipv4_addrs {
61 /* (src,dst) must be grouped, in the same way than in IP header */
67 * struct flow_dissector_key_ipv6_addrs:
68 * @src: source ip address
69 * @dst: destination ip address
71 struct flow_dissector_key_ipv6_addrs {
72 /* (src,dst) must be grouped, in the same way than in IP header */
78 * struct flow_dissector_key_tipc_addrs:
79 * @srcnode: source node address
81 struct flow_dissector_key_tipc_addrs {
86 * struct flow_dissector_key_addrs:
87 * @v4addrs: IPv4 addresses
88 * @v6addrs: IPv6 addresses
90 struct flow_dissector_key_addrs {
92 struct flow_dissector_key_ipv4_addrs v4addrs;
93 struct flow_dissector_key_ipv6_addrs v6addrs;
94 struct flow_dissector_key_tipc_addrs tipcaddrs;
99 * flow_dissector_key_arp:
100 * @ports: Operation, source and target addresses for an ARP header
101 * for Ethernet hardware addresses and IPv4 protocol addresses
102 * sip: Sender IP address
103 * tip: Target IP address
105 * sha: Sender hardware address
106 * tpa: Target hardware address
108 struct flow_dissector_key_arp {
112 unsigned char sha[ETH_ALEN];
113 unsigned char tha[ETH_ALEN];
117 * flow_dissector_key_tp_ports:
118 * @ports: port numbers of Transport header
119 * src: source port number
120 * dst: destination port number
122 struct flow_dissector_key_ports {
133 * flow_dissector_key_icmp:
134 * @ports: type and code of ICMP header
135 * icmp: ICMP type (high) and code (low)
139 struct flow_dissector_key_icmp {
150 * struct flow_dissector_key_eth_addrs:
151 * @src: source Ethernet address
152 * @dst: destination Ethernet address
154 struct flow_dissector_key_eth_addrs {
155 /* (dst,src) must be grouped, in the same way than in ETH header */
156 unsigned char dst[ETH_ALEN];
157 unsigned char src[ETH_ALEN];
161 * struct flow_dissector_key_tcp:
164 struct flow_dissector_key_tcp {
168 enum flow_dissector_key_id {
169 FLOW_DISSECTOR_KEY_CONTROL, /* struct flow_dissector_key_control */
170 FLOW_DISSECTOR_KEY_BASIC, /* struct flow_dissector_key_basic */
171 FLOW_DISSECTOR_KEY_IPV4_ADDRS, /* struct flow_dissector_key_ipv4_addrs */
172 FLOW_DISSECTOR_KEY_IPV6_ADDRS, /* struct flow_dissector_key_ipv6_addrs */
173 FLOW_DISSECTOR_KEY_PORTS, /* struct flow_dissector_key_ports */
174 FLOW_DISSECTOR_KEY_ICMP, /* struct flow_dissector_key_icmp */
175 FLOW_DISSECTOR_KEY_ETH_ADDRS, /* struct flow_dissector_key_eth_addrs */
176 FLOW_DISSECTOR_KEY_TIPC_ADDRS, /* struct flow_dissector_key_tipc_addrs */
177 FLOW_DISSECTOR_KEY_ARP, /* struct flow_dissector_key_arp */
178 FLOW_DISSECTOR_KEY_VLAN, /* struct flow_dissector_key_flow_vlan */
179 FLOW_DISSECTOR_KEY_FLOW_LABEL, /* struct flow_dissector_key_flow_tags */
180 FLOW_DISSECTOR_KEY_GRE_KEYID, /* struct flow_dissector_key_keyid */
181 FLOW_DISSECTOR_KEY_MPLS_ENTROPY, /* struct flow_dissector_key_keyid */
182 FLOW_DISSECTOR_KEY_ENC_KEYID, /* struct flow_dissector_key_keyid */
183 FLOW_DISSECTOR_KEY_ENC_IPV4_ADDRS, /* struct flow_dissector_key_ipv4_addrs */
184 FLOW_DISSECTOR_KEY_ENC_IPV6_ADDRS, /* struct flow_dissector_key_ipv6_addrs */
185 FLOW_DISSECTOR_KEY_ENC_CONTROL, /* struct flow_dissector_key_control */
186 FLOW_DISSECTOR_KEY_ENC_PORTS, /* struct flow_dissector_key_ports */
187 FLOW_DISSECTOR_KEY_MPLS, /* struct flow_dissector_key_mpls */
188 FLOW_DISSECTOR_KEY_TCP, /* struct flow_dissector_key_tcp */
190 FLOW_DISSECTOR_KEY_MAX,
193 #define FLOW_DISSECTOR_F_PARSE_1ST_FRAG BIT(0)
194 #define FLOW_DISSECTOR_F_STOP_AT_L3 BIT(1)
195 #define FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL BIT(2)
196 #define FLOW_DISSECTOR_F_STOP_AT_ENCAP BIT(3)
198 struct flow_dissector_key {
199 enum flow_dissector_key_id key_id;
200 size_t offset; /* offset of struct flow_dissector_key_*
201 in target the struct */
204 struct flow_dissector {
205 unsigned int used_keys; /* each bit repesents presence of one key id */
206 unsigned short int offset[FLOW_DISSECTOR_KEY_MAX];
210 struct flow_dissector_key_control control;
211 #define FLOW_KEYS_HASH_START_FIELD basic
212 struct flow_dissector_key_basic basic;
213 struct flow_dissector_key_tags tags;
214 struct flow_dissector_key_vlan vlan;
215 struct flow_dissector_key_keyid keyid;
216 struct flow_dissector_key_ports ports;
217 struct flow_dissector_key_addrs addrs;
220 #define FLOW_KEYS_HASH_OFFSET \
221 offsetof(struct flow_keys, FLOW_KEYS_HASH_START_FIELD)
223 __be32 flow_get_u32_src(const struct flow_keys *flow);
224 __be32 flow_get_u32_dst(const struct flow_keys *flow);
226 extern struct flow_dissector flow_keys_dissector;
227 extern struct flow_dissector flow_keys_buf_dissector;
229 /* struct flow_keys_digest:
231 * This structure is used to hold a digest of the full flow keys. This is a
232 * larger "hash" of a flow to allow definitively matching specific flows where
233 * the 32 bit skb->hash is not large enough. The size is limited to 16 bytes so
234 * that it can by used in CB of skb (see sch_choke for an example).
236 #define FLOW_KEYS_DIGEST_LEN 16
237 struct flow_keys_digest {
238 u8 data[FLOW_KEYS_DIGEST_LEN];
241 void make_flow_keys_digest(struct flow_keys_digest *digest,
242 const struct flow_keys *flow);
244 static inline bool flow_keys_have_l4(const struct flow_keys *keys)
246 return (keys->ports.ports || keys->tags.flow_label);
249 u32 flow_hash_from_keys(struct flow_keys *keys);
251 static inline bool dissector_uses_key(const struct flow_dissector *flow_dissector,
252 enum flow_dissector_key_id key_id)
254 return flow_dissector->used_keys & (1 << key_id);
257 static inline void *skb_flow_dissector_target(struct flow_dissector *flow_dissector,
258 enum flow_dissector_key_id key_id,
259 void *target_container)
261 return ((char *)target_container) + flow_dissector->offset[key_id];