xref: /linux/include/net/flow.h (revision 85502b2214d50ba0ddf2a5fb454e4d28a160d175)
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/in6.h>
12 #include <linux/atomic.h>
13 #include <linux/container_of.h>
14 #include <linux/uidgid.h>
15 
16 struct flow_keys;
17 
18 /*
19  * ifindex generation is per-net namespace, and loopback is
20  * always the 1st device in ns (see net_dev_init), thus any
21  * loopback device should get ifindex 1
22  */
23 
24 #define LOOPBACK_IFINDEX	1
25 
26 struct flowi_tunnel {
27 	__be64			tun_id;
28 };
29 
30 struct flowi_common {
31 	int	flowic_oif;
32 	int	flowic_iif;
33 	int     flowic_l3mdev;
34 	__u32	flowic_mark;
35 	__u8	flowic_tos;
36 	__u8	flowic_scope;
37 	__u8	flowic_proto;
38 	__u8	flowic_flags;
39 #define FLOWI_FLAG_ANYSRC		0x01
40 #define FLOWI_FLAG_KNOWN_NH		0x02
41 #define FLOWI_FLAG_L3MDEV_OIF		0x04
42 #define FLOWI_FLAG_ANY_SPORT		0x08
43 	__u32	flowic_secid;
44 	kuid_t  flowic_uid;
45 	__u32		flowic_multipath_hash;
46 	struct flowi_tunnel flowic_tun_key;
47 };
48 
49 union flowi_uli {
50 	struct {
51 		__be16	dport;
52 		__be16	sport;
53 	} ports;
54 
55 	struct {
56 		__u8	type;
57 		__u8	code;
58 	} icmpt;
59 
60 	__be32		gre_key;
61 
62 	struct {
63 		__u8	type;
64 	} mht;
65 };
66 
67 struct flowi4 {
68 	struct flowi_common	__fl_common;
69 #define flowi4_oif		__fl_common.flowic_oif
70 #define flowi4_iif		__fl_common.flowic_iif
71 #define flowi4_l3mdev		__fl_common.flowic_l3mdev
72 #define flowi4_mark		__fl_common.flowic_mark
73 #define flowi4_tos		__fl_common.flowic_tos
74 #define flowi4_scope		__fl_common.flowic_scope
75 #define flowi4_proto		__fl_common.flowic_proto
76 #define flowi4_flags		__fl_common.flowic_flags
77 #define flowi4_secid		__fl_common.flowic_secid
78 #define flowi4_tun_key		__fl_common.flowic_tun_key
79 #define flowi4_uid		__fl_common.flowic_uid
80 #define flowi4_multipath_hash	__fl_common.flowic_multipath_hash
81 
82 	/* (saddr,daddr) must be grouped, same order as in IP header */
83 	__be32			saddr;
84 	__be32			daddr;
85 
86 	union flowi_uli		uli;
87 #define fl4_sport		uli.ports.sport
88 #define fl4_dport		uli.ports.dport
89 #define fl4_icmp_type		uli.icmpt.type
90 #define fl4_icmp_code		uli.icmpt.code
91 #define fl4_mh_type		uli.mht.type
92 #define fl4_gre_key		uli.gre_key
93 } __attribute__((__aligned__(BITS_PER_LONG/8)));
94 
flowi4_init_output(struct flowi4 * fl4,int oif,__u32 mark,__u8 tos,__u8 scope,__u8 proto,__u8 flags,__be32 daddr,__be32 saddr,__be16 dport,__be16 sport,kuid_t uid)95 static inline void flowi4_init_output(struct flowi4 *fl4, int oif,
96 				      __u32 mark, __u8 tos, __u8 scope,
97 				      __u8 proto, __u8 flags,
98 				      __be32 daddr, __be32 saddr,
99 				      __be16 dport, __be16 sport,
100 				      kuid_t uid)
101 {
102 	fl4->flowi4_oif = oif;
103 	fl4->flowi4_iif = LOOPBACK_IFINDEX;
104 	fl4->flowi4_l3mdev = 0;
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 */
flowi4_update_output(struct flowi4 * fl4,int oif,__be32 daddr,__be32 saddr)121 static inline void flowi4_update_output(struct flowi4 *fl4, int oif,
122 					__be32 daddr, __be32 saddr)
123 {
124 	fl4->flowi4_oif = oif;
125 	fl4->daddr = daddr;
126 	fl4->saddr = saddr;
127 }
128 
129 
130 struct flowi6 {
131 	struct flowi_common	__fl_common;
132 #define flowi6_oif		__fl_common.flowic_oif
133 #define flowi6_iif		__fl_common.flowic_iif
134 #define flowi6_l3mdev		__fl_common.flowic_l3mdev
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 flowi {
157 	union {
158 		struct flowi_common	__fl_common;
159 		struct flowi4		ip4;
160 		struct flowi6		ip6;
161 	} u;
162 #define flowi_oif	u.__fl_common.flowic_oif
163 #define flowi_iif	u.__fl_common.flowic_iif
164 #define flowi_l3mdev	u.__fl_common.flowic_l3mdev
165 #define flowi_mark	u.__fl_common.flowic_mark
166 #define flowi_tos	u.__fl_common.flowic_tos
167 #define flowi_scope	u.__fl_common.flowic_scope
168 #define flowi_proto	u.__fl_common.flowic_proto
169 #define flowi_flags	u.__fl_common.flowic_flags
170 #define flowi_secid	u.__fl_common.flowic_secid
171 #define flowi_tun_key	u.__fl_common.flowic_tun_key
172 #define flowi_uid	u.__fl_common.flowic_uid
173 } __attribute__((__aligned__(BITS_PER_LONG/8)));
174 
flowi4_to_flowi(struct flowi4 * fl4)175 static inline struct flowi *flowi4_to_flowi(struct flowi4 *fl4)
176 {
177 	return container_of(fl4, struct flowi, u.ip4);
178 }
179 
flowi4_to_flowi_common(struct flowi4 * fl4)180 static inline struct flowi_common *flowi4_to_flowi_common(struct flowi4 *fl4)
181 {
182 	return &(fl4->__fl_common);
183 }
184 
flowi6_to_flowi(struct flowi6 * fl6)185 static inline struct flowi *flowi6_to_flowi(struct flowi6 *fl6)
186 {
187 	return container_of(fl6, struct flowi, u.ip6);
188 }
189 
flowi6_to_flowi_common(struct flowi6 * fl6)190 static inline struct flowi_common *flowi6_to_flowi_common(struct flowi6 *fl6)
191 {
192 	return &(fl6->__fl_common);
193 }
194 
195 __u32 __get_hash_from_flowi6(const struct flowi6 *fl6, struct flow_keys *keys);
196 
197 #endif
198