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