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