xref: /linux/include/net/flow.h (revision 90e0d94d369d342e735a75174439482119b6c393)
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 	int     flowic_l3mdev;
33 	__u32	flowic_mark;
34 	__u8	flowic_tos;
35 	__u8	flowic_scope;
36 	__u8	flowic_proto;
37 	__u8	flowic_flags;
38 #define FLOWI_FLAG_ANYSRC		0x01
39 #define FLOWI_FLAG_KNOWN_NH		0x02
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 	__be32		gre_key;
58 
59 	struct {
60 		__u8	type;
61 	} mht;
62 };
63 
64 struct flowi4 {
65 	struct flowi_common	__fl_common;
66 #define flowi4_oif		__fl_common.flowic_oif
67 #define flowi4_iif		__fl_common.flowic_iif
68 #define flowi4_l3mdev		__fl_common.flowic_l3mdev
69 #define flowi4_mark		__fl_common.flowic_mark
70 #define flowi4_tos		__fl_common.flowic_tos
71 #define flowi4_scope		__fl_common.flowic_scope
72 #define flowi4_proto		__fl_common.flowic_proto
73 #define flowi4_flags		__fl_common.flowic_flags
74 #define flowi4_secid		__fl_common.flowic_secid
75 #define flowi4_tun_key		__fl_common.flowic_tun_key
76 #define flowi4_uid		__fl_common.flowic_uid
77 #define flowi4_multipath_hash	__fl_common.flowic_multipath_hash
78 
79 	/* (saddr,daddr) must be grouped, same order as in IP header */
80 	__be32			saddr;
81 	__be32			daddr;
82 
83 	union flowi_uli		uli;
84 #define fl4_sport		uli.ports.sport
85 #define fl4_dport		uli.ports.dport
86 #define fl4_icmp_type		uli.icmpt.type
87 #define fl4_icmp_code		uli.icmpt.code
88 #define fl4_mh_type		uli.mht.type
89 #define fl4_gre_key		uli.gre_key
90 } __attribute__((__aligned__(BITS_PER_LONG/8)));
91 
92 static inline void flowi4_init_output(struct flowi4 *fl4, int oif,
93 				      __u32 mark, __u8 tos, __u8 scope,
94 				      __u8 proto, __u8 flags,
95 				      __be32 daddr, __be32 saddr,
96 				      __be16 dport, __be16 sport,
97 				      kuid_t uid)
98 {
99 	fl4->flowi4_oif = oif;
100 	fl4->flowi4_iif = LOOPBACK_IFINDEX;
101 	fl4->flowi4_l3mdev = 0;
102 	fl4->flowi4_mark = mark;
103 	fl4->flowi4_tos = tos;
104 	fl4->flowi4_scope = scope;
105 	fl4->flowi4_proto = proto;
106 	fl4->flowi4_flags = flags;
107 	fl4->flowi4_secid = 0;
108 	fl4->flowi4_tun_key.tun_id = 0;
109 	fl4->flowi4_uid = uid;
110 	fl4->daddr = daddr;
111 	fl4->saddr = saddr;
112 	fl4->fl4_dport = dport;
113 	fl4->fl4_sport = sport;
114 	fl4->flowi4_multipath_hash = 0;
115 }
116 
117 /* Reset some input parameters after previous lookup */
118 static inline void flowi4_update_output(struct flowi4 *fl4, int oif, __u8 tos,
119 					__be32 daddr, __be32 saddr)
120 {
121 	fl4->flowi4_oif = oif;
122 	fl4->flowi4_tos = tos;
123 	fl4->daddr = daddr;
124 	fl4->saddr = saddr;
125 }
126 
127 
128 struct flowi6 {
129 	struct flowi_common	__fl_common;
130 #define flowi6_oif		__fl_common.flowic_oif
131 #define flowi6_iif		__fl_common.flowic_iif
132 #define flowi6_l3mdev		__fl_common.flowic_l3mdev
133 #define flowi6_mark		__fl_common.flowic_mark
134 #define flowi6_scope		__fl_common.flowic_scope
135 #define flowi6_proto		__fl_common.flowic_proto
136 #define flowi6_flags		__fl_common.flowic_flags
137 #define flowi6_secid		__fl_common.flowic_secid
138 #define flowi6_tun_key		__fl_common.flowic_tun_key
139 #define flowi6_uid		__fl_common.flowic_uid
140 	struct in6_addr		daddr;
141 	struct in6_addr		saddr;
142 	/* Note: flowi6_tos is encoded in flowlabel, too. */
143 	__be32			flowlabel;
144 	union flowi_uli		uli;
145 #define fl6_sport		uli.ports.sport
146 #define fl6_dport		uli.ports.dport
147 #define fl6_icmp_type		uli.icmpt.type
148 #define fl6_icmp_code		uli.icmpt.code
149 #define fl6_mh_type		uli.mht.type
150 #define fl6_gre_key		uli.gre_key
151 	__u32			mp_hash;
152 } __attribute__((__aligned__(BITS_PER_LONG/8)));
153 
154 struct flowi {
155 	union {
156 		struct flowi_common	__fl_common;
157 		struct flowi4		ip4;
158 		struct flowi6		ip6;
159 	} u;
160 #define flowi_oif	u.__fl_common.flowic_oif
161 #define flowi_iif	u.__fl_common.flowic_iif
162 #define flowi_l3mdev	u.__fl_common.flowic_l3mdev
163 #define flowi_mark	u.__fl_common.flowic_mark
164 #define flowi_tos	u.__fl_common.flowic_tos
165 #define flowi_scope	u.__fl_common.flowic_scope
166 #define flowi_proto	u.__fl_common.flowic_proto
167 #define flowi_flags	u.__fl_common.flowic_flags
168 #define flowi_secid	u.__fl_common.flowic_secid
169 #define flowi_tun_key	u.__fl_common.flowic_tun_key
170 #define flowi_uid	u.__fl_common.flowic_uid
171 } __attribute__((__aligned__(BITS_PER_LONG/8)));
172 
173 static inline struct flowi *flowi4_to_flowi(struct flowi4 *fl4)
174 {
175 	return container_of(fl4, struct flowi, u.ip4);
176 }
177 
178 static inline struct flowi_common *flowi4_to_flowi_common(struct flowi4 *fl4)
179 {
180 	return &(fl4->__fl_common);
181 }
182 
183 static inline struct flowi *flowi6_to_flowi(struct flowi6 *fl6)
184 {
185 	return container_of(fl6, struct flowi, u.ip6);
186 }
187 
188 static inline struct flowi_common *flowi6_to_flowi_common(struct flowi6 *fl6)
189 {
190 	return &(fl6->__fl_common);
191 }
192 
193 __u32 __get_hash_from_flowi6(const struct flowi6 *fl6, struct flow_keys *keys);
194 
195 #endif
196