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