1 #ifndef _NET_FLOW_DISSECTOR_H
2 #define _NET_FLOW_DISSECTOR_H
4 #include <linux/types.h>
6 #include <linux/siphash.h>
7 #include <linux/string.h>
8 #include <uapi/linux/if_ether.h>
11 * struct flow_dissector_key_control:
12 * @thoff: Transport header offset
14 struct flow_dissector_key_control {
20 #define FLOW_DIS_IS_FRAGMENT BIT(0)
21 #define FLOW_DIS_FIRST_FRAG BIT(1)
22 #define FLOW_DIS_ENCAPSULATION BIT(2)
25 * struct flow_dissector_key_basic:
26 * @thoff: Transport header offset
27 * @n_proto: Network header protocol (eg. IPv4/IPv6)
28 * @ip_proto: Transport header protocol (eg. TCP/UDP)
30 struct flow_dissector_key_basic {
36 struct flow_dissector_key_tags {
40 struct flow_dissector_key_vlan {
46 struct flow_dissector_key_keyid {
51 * struct flow_dissector_key_ipv4_addrs:
52 * @src: source ip address
53 * @dst: destination ip address
55 struct flow_dissector_key_ipv4_addrs {
56 /* (src,dst) must be grouped, in the same way than in IP header */
62 * struct flow_dissector_key_ipv6_addrs:
63 * @src: source ip address
64 * @dst: destination ip address
66 struct flow_dissector_key_ipv6_addrs {
67 /* (src,dst) must be grouped, in the same way than in IP header */
73 * struct flow_dissector_key_tipc_addrs:
74 * @srcnode: source node address
76 struct flow_dissector_key_tipc_addrs {
81 * struct flow_dissector_key_addrs:
82 * @v4addrs: IPv4 addresses
83 * @v6addrs: IPv6 addresses
85 struct flow_dissector_key_addrs {
87 struct flow_dissector_key_ipv4_addrs v4addrs;
88 struct flow_dissector_key_ipv6_addrs v6addrs;
89 struct flow_dissector_key_tipc_addrs tipcaddrs;
94 * flow_dissector_key_tp_ports:
95 * @ports: port numbers of Transport header
96 * src: source port number
97 * dst: destination port number
99 struct flow_dissector_key_ports {
111 * struct flow_dissector_key_eth_addrs:
112 * @src: source Ethernet address
113 * @dst: destination Ethernet address
115 struct flow_dissector_key_eth_addrs {
116 /* (dst,src) must be grouped, in the same way than in ETH header */
117 unsigned char dst[ETH_ALEN];
118 unsigned char src[ETH_ALEN];
121 enum flow_dissector_key_id {
122 FLOW_DISSECTOR_KEY_CONTROL, /* struct flow_dissector_key_control */
123 FLOW_DISSECTOR_KEY_BASIC, /* struct flow_dissector_key_basic */
124 FLOW_DISSECTOR_KEY_IPV4_ADDRS, /* struct flow_dissector_key_ipv4_addrs */
125 FLOW_DISSECTOR_KEY_IPV6_ADDRS, /* struct flow_dissector_key_ipv6_addrs */
126 FLOW_DISSECTOR_KEY_PORTS, /* struct flow_dissector_key_ports */
127 FLOW_DISSECTOR_KEY_ETH_ADDRS, /* struct flow_dissector_key_eth_addrs */
128 FLOW_DISSECTOR_KEY_TIPC_ADDRS, /* struct flow_dissector_key_tipc_addrs */
129 FLOW_DISSECTOR_KEY_VLAN, /* struct flow_dissector_key_flow_vlan */
130 FLOW_DISSECTOR_KEY_FLOW_LABEL, /* struct flow_dissector_key_flow_tags */
131 FLOW_DISSECTOR_KEY_GRE_KEYID, /* struct flow_dissector_key_keyid */
132 FLOW_DISSECTOR_KEY_MPLS_ENTROPY, /* struct flow_dissector_key_keyid */
134 FLOW_DISSECTOR_KEY_MAX,
137 #define FLOW_DISSECTOR_F_PARSE_1ST_FRAG BIT(0)
138 #define FLOW_DISSECTOR_F_STOP_AT_L3 BIT(1)
139 #define FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL BIT(2)
140 #define FLOW_DISSECTOR_F_STOP_AT_ENCAP BIT(3)
142 struct flow_dissector_key {
143 enum flow_dissector_key_id key_id;
144 size_t offset; /* offset of struct flow_dissector_key_*
145 in target the struct */
148 struct flow_dissector {
149 unsigned int used_keys; /* each bit repesents presence of one key id */
150 unsigned short int offset[FLOW_DISSECTOR_KEY_MAX];
154 struct flow_dissector_key_control control;
155 #define FLOW_KEYS_HASH_START_FIELD basic
156 struct flow_dissector_key_basic basic __aligned(SIPHASH_ALIGNMENT);
157 struct flow_dissector_key_tags tags;
158 struct flow_dissector_key_vlan vlan;
159 struct flow_dissector_key_keyid keyid;
160 struct flow_dissector_key_ports ports;
161 struct flow_dissector_key_addrs addrs;
164 #define FLOW_KEYS_HASH_OFFSET \
165 offsetof(struct flow_keys, FLOW_KEYS_HASH_START_FIELD)
167 __be32 flow_get_u32_src(const struct flow_keys *flow);
168 __be32 flow_get_u32_dst(const struct flow_keys *flow);
170 extern struct flow_dissector flow_keys_dissector;
171 extern struct flow_dissector flow_keys_buf_dissector;
173 /* struct flow_keys_digest:
175 * This structure is used to hold a digest of the full flow keys. This is a
176 * larger "hash" of a flow to allow definitively matching specific flows where
177 * the 32 bit skb->hash is not large enough. The size is limited to 16 bytes so
178 * that it can by used in CB of skb (see sch_choke for an example).
180 #define FLOW_KEYS_DIGEST_LEN 16
181 struct flow_keys_digest {
182 u8 data[FLOW_KEYS_DIGEST_LEN];
185 void make_flow_keys_digest(struct flow_keys_digest *digest,
186 const struct flow_keys *flow);
188 static inline bool flow_keys_have_l4(const struct flow_keys *keys)
190 return (keys->ports.ports || keys->tags.flow_label);
193 u32 flow_hash_from_keys(struct flow_keys *keys);
195 static inline bool dissector_uses_key(const struct flow_dissector *flow_dissector,
196 enum flow_dissector_key_id key_id)
198 return flow_dissector->used_keys & (1 << key_id);
201 static inline void *skb_flow_dissector_target(struct flow_dissector *flow_dissector,
202 enum flow_dissector_key_id key_id,
203 void *target_container)
205 return ((char *)target_container) + flow_dissector->offset[key_id];
209 flow_dissector_init_keys(struct flow_dissector_key_control *key_control,
210 struct flow_dissector_key_basic *key_basic)
212 memset(key_control, 0, sizeof(*key_control));
213 memset(key_basic, 0, sizeof(*key_basic));