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