xref: /kernel/linux/linux-5.10/include/net/flow.h (revision 8c2ecf20)
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
25struct flowi_tunnel {
26	__be64			tun_id;
27};
28
29struct 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	__u32		flowic_multipath_hash;
43	struct flowi_tunnel flowic_tun_key;
44};
45
46union 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		spi;
58	__be32		gre_key;
59
60	struct {
61		__u8	type;
62	} mht;
63};
64
65struct flowi4 {
66	struct flowi_common	__fl_common;
67#define flowi4_oif		__fl_common.flowic_oif
68#define flowi4_iif		__fl_common.flowic_iif
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_ipsec_spi		uli.spi
89#define fl4_mh_type		uli.mht.type
90#define fl4_gre_key		uli.gre_key
91} __attribute__((__aligned__(BITS_PER_LONG/8)));
92
93static inline void flowi4_init_output(struct flowi4 *fl4, int oif,
94				      __u32 mark, __u8 tos, __u8 scope,
95				      __u8 proto, __u8 flags,
96				      __be32 daddr, __be32 saddr,
97				      __be16 dport, __be16 sport,
98				      kuid_t uid)
99{
100	fl4->flowi4_oif = oif;
101	fl4->flowi4_iif = LOOPBACK_IFINDEX;
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 */
118static 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
128struct 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_mark		__fl_common.flowic_mark
133#define flowi6_scope		__fl_common.flowic_scope
134#define flowi6_proto		__fl_common.flowic_proto
135#define flowi6_flags		__fl_common.flowic_flags
136#define flowi6_secid		__fl_common.flowic_secid
137#define flowi6_tun_key		__fl_common.flowic_tun_key
138#define flowi6_uid		__fl_common.flowic_uid
139	struct in6_addr		daddr;
140	struct in6_addr		saddr;
141	/* Note: flowi6_tos is encoded in flowlabel, too. */
142	__be32			flowlabel;
143	union flowi_uli		uli;
144#define fl6_sport		uli.ports.sport
145#define fl6_dport		uli.ports.dport
146#define fl6_icmp_type		uli.icmpt.type
147#define fl6_icmp_code		uli.icmpt.code
148#define fl6_ipsec_spi		uli.spi
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
154struct 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_mark	u.__fl_common.flowic_mark
163#define flowi_tos	u.__fl_common.flowic_tos
164#define flowi_scope	u.__fl_common.flowic_scope
165#define flowi_proto	u.__fl_common.flowic_proto
166#define flowi_flags	u.__fl_common.flowic_flags
167#define flowi_secid	u.__fl_common.flowic_secid
168#define flowi_tun_key	u.__fl_common.flowic_tun_key
169#define flowi_uid	u.__fl_common.flowic_uid
170} __attribute__((__aligned__(BITS_PER_LONG/8)));
171
172static inline struct flowi *flowi4_to_flowi(struct flowi4 *fl4)
173{
174	return container_of(fl4, struct flowi, u.ip4);
175}
176
177static inline struct flowi_common *flowi4_to_flowi_common(struct flowi4 *fl4)
178{
179	return &(flowi4_to_flowi(fl4)->u.__fl_common);
180}
181
182static inline struct flowi *flowi6_to_flowi(struct flowi6 *fl6)
183{
184	return container_of(fl6, struct flowi, u.ip6);
185}
186
187static inline struct flowi_common *flowi6_to_flowi_common(struct flowi6 *fl6)
188{
189	return &(flowi6_to_flowi(fl6)->u.__fl_common);
190}
191
192__u32 __get_hash_from_flowi6(const struct flowi6 *fl6, struct flow_keys *keys);
193
194#endif
195