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