xref: /openbmc/linux/include/net/flow.h (revision bbde9fc1824aab58bc78c084163007dd6c03fe5b)
1 /*
2  *
3  *	Generic internet FLOW.
4  *
5  */
6 
7 #ifndef _NET_FLOW_H
8 #define _NET_FLOW_H
9 
10 #include <linux/socket.h>
11 #include <linux/in6.h>
12 #include <linux/atomic.h>
13 
14 /*
15  * ifindex generation is per-net namespace, and loopback is
16  * always the 1st device in ns (see net_dev_init), thus any
17  * loopback device should get ifindex 1
18  */
19 
20 #define LOOPBACK_IFINDEX	1
21 
22 struct flowi_tunnel {
23 	__be64			tun_id;
24 };
25 
26 struct flowi_common {
27 	int	flowic_oif;
28 	int	flowic_iif;
29 	__u32	flowic_mark;
30 	__u8	flowic_tos;
31 	__u8	flowic_scope;
32 	__u8	flowic_proto;
33 	__u8	flowic_flags;
34 #define FLOWI_FLAG_ANYSRC		0x01
35 #define FLOWI_FLAG_KNOWN_NH		0x02
36 	__u32	flowic_secid;
37 	struct flowi_tunnel flowic_tun_key;
38 };
39 
40 union flowi_uli {
41 	struct {
42 		__be16	dport;
43 		__be16	sport;
44 	} ports;
45 
46 	struct {
47 		__u8	type;
48 		__u8	code;
49 	} icmpt;
50 
51 	struct {
52 		__le16	dport;
53 		__le16	sport;
54 	} dnports;
55 
56 	__be32		spi;
57 	__be32		gre_key;
58 
59 	struct {
60 		__u8	type;
61 	} mht;
62 };
63 
64 struct flowi4 {
65 	struct flowi_common	__fl_common;
66 #define flowi4_oif		__fl_common.flowic_oif
67 #define flowi4_iif		__fl_common.flowic_iif
68 #define flowi4_mark		__fl_common.flowic_mark
69 #define flowi4_tos		__fl_common.flowic_tos
70 #define flowi4_scope		__fl_common.flowic_scope
71 #define flowi4_proto		__fl_common.flowic_proto
72 #define flowi4_flags		__fl_common.flowic_flags
73 #define flowi4_secid		__fl_common.flowic_secid
74 #define flowi4_tun_key		__fl_common.flowic_tun_key
75 
76 	/* (saddr,daddr) must be grouped, same order as in IP header */
77 	__be32			saddr;
78 	__be32			daddr;
79 
80 	union flowi_uli		uli;
81 #define fl4_sport		uli.ports.sport
82 #define fl4_dport		uli.ports.dport
83 #define fl4_icmp_type		uli.icmpt.type
84 #define fl4_icmp_code		uli.icmpt.code
85 #define fl4_ipsec_spi		uli.spi
86 #define fl4_mh_type		uli.mht.type
87 #define fl4_gre_key		uli.gre_key
88 } __attribute__((__aligned__(BITS_PER_LONG/8)));
89 
90 static inline void flowi4_init_output(struct flowi4 *fl4, int oif,
91 				      __u32 mark, __u8 tos, __u8 scope,
92 				      __u8 proto, __u8 flags,
93 				      __be32 daddr, __be32 saddr,
94 				      __be16 dport, __be16 sport)
95 {
96 	fl4->flowi4_oif = oif;
97 	fl4->flowi4_iif = LOOPBACK_IFINDEX;
98 	fl4->flowi4_mark = mark;
99 	fl4->flowi4_tos = tos;
100 	fl4->flowi4_scope = scope;
101 	fl4->flowi4_proto = proto;
102 	fl4->flowi4_flags = flags;
103 	fl4->flowi4_secid = 0;
104 	fl4->flowi4_tun_key.tun_id = 0;
105 	fl4->daddr = daddr;
106 	fl4->saddr = saddr;
107 	fl4->fl4_dport = dport;
108 	fl4->fl4_sport = sport;
109 }
110 
111 /* Reset some input parameters after previous lookup */
112 static inline void flowi4_update_output(struct flowi4 *fl4, int oif, __u8 tos,
113 					__be32 daddr, __be32 saddr)
114 {
115 	fl4->flowi4_oif = oif;
116 	fl4->flowi4_tos = tos;
117 	fl4->daddr = daddr;
118 	fl4->saddr = saddr;
119 }
120 
121 
122 struct flowi6 {
123 	struct flowi_common	__fl_common;
124 #define flowi6_oif		__fl_common.flowic_oif
125 #define flowi6_iif		__fl_common.flowic_iif
126 #define flowi6_mark		__fl_common.flowic_mark
127 #define flowi6_tos		__fl_common.flowic_tos
128 #define flowi6_scope		__fl_common.flowic_scope
129 #define flowi6_proto		__fl_common.flowic_proto
130 #define flowi6_flags		__fl_common.flowic_flags
131 #define flowi6_secid		__fl_common.flowic_secid
132 	struct in6_addr		daddr;
133 	struct in6_addr		saddr;
134 	__be32			flowlabel;
135 	union flowi_uli		uli;
136 #define fl6_sport		uli.ports.sport
137 #define fl6_dport		uli.ports.dport
138 #define fl6_icmp_type		uli.icmpt.type
139 #define fl6_icmp_code		uli.icmpt.code
140 #define fl6_ipsec_spi		uli.spi
141 #define fl6_mh_type		uli.mht.type
142 #define fl6_gre_key		uli.gre_key
143 } __attribute__((__aligned__(BITS_PER_LONG/8)));
144 
145 struct flowidn {
146 	struct flowi_common	__fl_common;
147 #define flowidn_oif		__fl_common.flowic_oif
148 #define flowidn_iif		__fl_common.flowic_iif
149 #define flowidn_mark		__fl_common.flowic_mark
150 #define flowidn_scope		__fl_common.flowic_scope
151 #define flowidn_proto		__fl_common.flowic_proto
152 #define flowidn_flags		__fl_common.flowic_flags
153 	__le16			daddr;
154 	__le16			saddr;
155 	union flowi_uli		uli;
156 #define fld_sport		uli.ports.sport
157 #define fld_dport		uli.ports.dport
158 } __attribute__((__aligned__(BITS_PER_LONG/8)));
159 
160 struct flowi {
161 	union {
162 		struct flowi_common	__fl_common;
163 		struct flowi4		ip4;
164 		struct flowi6		ip6;
165 		struct flowidn		dn;
166 	} u;
167 #define flowi_oif	u.__fl_common.flowic_oif
168 #define flowi_iif	u.__fl_common.flowic_iif
169 #define flowi_mark	u.__fl_common.flowic_mark
170 #define flowi_tos	u.__fl_common.flowic_tos
171 #define flowi_scope	u.__fl_common.flowic_scope
172 #define flowi_proto	u.__fl_common.flowic_proto
173 #define flowi_flags	u.__fl_common.flowic_flags
174 #define flowi_secid	u.__fl_common.flowic_secid
175 #define flowi_tun_key	u.__fl_common.flowic_tun_key
176 } __attribute__((__aligned__(BITS_PER_LONG/8)));
177 
178 static inline struct flowi *flowi4_to_flowi(struct flowi4 *fl4)
179 {
180 	return container_of(fl4, struct flowi, u.ip4);
181 }
182 
183 static inline struct flowi *flowi6_to_flowi(struct flowi6 *fl6)
184 {
185 	return container_of(fl6, struct flowi, u.ip6);
186 }
187 
188 static inline struct flowi *flowidn_to_flowi(struct flowidn *fldn)
189 {
190 	return container_of(fldn, struct flowi, u.dn);
191 }
192 
193 typedef unsigned long flow_compare_t;
194 
195 static inline size_t flow_key_size(u16 family)
196 {
197 	switch (family) {
198 	case AF_INET:
199 		BUILD_BUG_ON(sizeof(struct flowi4) % sizeof(flow_compare_t));
200 		return sizeof(struct flowi4) / sizeof(flow_compare_t);
201 	case AF_INET6:
202 		BUILD_BUG_ON(sizeof(struct flowi6) % sizeof(flow_compare_t));
203 		return sizeof(struct flowi6) / sizeof(flow_compare_t);
204 	case AF_DECnet:
205 		BUILD_BUG_ON(sizeof(struct flowidn) % sizeof(flow_compare_t));
206 		return sizeof(struct flowidn) / sizeof(flow_compare_t);
207 	}
208 	return 0;
209 }
210 
211 #define FLOW_DIR_IN	0
212 #define FLOW_DIR_OUT	1
213 #define FLOW_DIR_FWD	2
214 
215 struct net;
216 struct sock;
217 struct flow_cache_ops;
218 
219 struct flow_cache_object {
220 	const struct flow_cache_ops *ops;
221 };
222 
223 struct flow_cache_ops {
224 	struct flow_cache_object *(*get)(struct flow_cache_object *);
225 	int (*check)(struct flow_cache_object *);
226 	void (*delete)(struct flow_cache_object *);
227 };
228 
229 typedef struct flow_cache_object *(*flow_resolve_t)(
230 		struct net *net, const struct flowi *key, u16 family,
231 		u8 dir, struct flow_cache_object *oldobj, void *ctx);
232 
233 struct flow_cache_object *flow_cache_lookup(struct net *net,
234 					    const struct flowi *key, u16 family,
235 					    u8 dir, flow_resolve_t resolver,
236 					    void *ctx);
237 int flow_cache_init(struct net *net);
238 void flow_cache_fini(struct net *net);
239 
240 void flow_cache_flush(struct net *net);
241 void flow_cache_flush_deferred(struct net *net);
242 extern atomic_t flow_cache_genid;
243 
244 #endif
245