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/in6.h>
 12#include <linux/atomic.h>
 13#include <linux/container_of.h>
 14#include <linux/uidgid.h>
 15#include <net/inet_dscp.h>
 16
 17struct flow_keys;
 18
 19/*
 20 * ifindex generation is per-net namespace, and loopback is
 21 * always the 1st device in ns (see net_dev_init), thus any
 22 * loopback device should get ifindex 1
 23 */
 24
 25#define LOOPBACK_IFINDEX	1
 26
 27struct flowi_tunnel {
 28	__be64			tun_id;
 29};
 30
 31struct flowi_common {
 32	int	flowic_oif;
 33	int	flowic_iif;
 34	int     flowic_l3mdev;
 35	__u32	flowic_mark;
 36	dscp_t	flowic_dscp;
 37	__u8	flowic_scope;
 38	__u8	flowic_proto;
 39	__u8	flowic_flags;
 40#define FLOWI_FLAG_ANYSRC		0x01
 41#define FLOWI_FLAG_KNOWN_NH		0x02
 42#define FLOWI_FLAG_L3MDEV_OIF		0x04
 43#define FLOWI_FLAG_ANY_SPORT		0x08
 44	__u32	flowic_secid;
 45	kuid_t  flowic_uid;
 46	__u32		flowic_multipath_hash;
 47	struct flowi_tunnel flowic_tun_key;
 48};
 49
 50union flowi_uli {
 51	struct {
 52		__be16	dport;
 53		__be16	sport;
 54	} ports;
 55
 56	struct {
 57		__u8	type;
 58		__u8	code;
 59	} icmpt;
 60
 61	__be32		gre_key;
 62
 63	struct {
 64		__u8	type;
 65	} mht;
 66};
 67
 68struct flowi4 {
 69	struct flowi_common	__fl_common;
 70#define flowi4_oif		__fl_common.flowic_oif
 71#define flowi4_iif		__fl_common.flowic_iif
 72#define flowi4_l3mdev		__fl_common.flowic_l3mdev
 73#define flowi4_mark		__fl_common.flowic_mark
 74#define flowi4_dscp		__fl_common.flowic_dscp
 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
 96static 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_l3mdev = 0;
106	fl4->flowi4_mark = mark;
107	fl4->flowi4_dscp = inet_dsfield_to_dscp(tos);
108	fl4->flowi4_scope = scope;
109	fl4->flowi4_proto = proto;
110	fl4->flowi4_flags = flags;
111	fl4->flowi4_secid = 0;
112	fl4->flowi4_tun_key.tun_id = 0;
113	fl4->flowi4_uid = uid;
114	fl4->daddr = daddr;
115	fl4->saddr = saddr;
116	fl4->fl4_dport = dport;
117	fl4->fl4_sport = sport;
118	fl4->flowi4_multipath_hash = 0;
119}
120
121/* Reset some input parameters after previous lookup */
122static inline void flowi4_update_output(struct flowi4 *fl4, int oif,
123					__be32 daddr, __be32 saddr)
124{
125	fl4->flowi4_oif = oif;
126	fl4->daddr = daddr;
127	fl4->saddr = saddr;
128}
129
130
131struct 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_l3mdev		__fl_common.flowic_l3mdev
136#define flowi6_mark		__fl_common.flowic_mark
137#define flowi6_scope		__fl_common.flowic_scope
138#define flowi6_proto		__fl_common.flowic_proto
139#define flowi6_flags		__fl_common.flowic_flags
140#define flowi6_secid		__fl_common.flowic_secid
141#define flowi6_tun_key		__fl_common.flowic_tun_key
142#define flowi6_uid		__fl_common.flowic_uid
143	struct in6_addr		daddr;
144	struct in6_addr		saddr;
145	/* Note: flowi6_dscp is encoded in flowlabel, too. */
146	__be32			flowlabel;
147	union flowi_uli		uli;
148#define fl6_sport		uli.ports.sport
149#define fl6_dport		uli.ports.dport
150#define fl6_icmp_type		uli.icmpt.type
151#define fl6_icmp_code		uli.icmpt.code
152#define fl6_mh_type		uli.mht.type
153#define fl6_gre_key		uli.gre_key
154	__u32			mp_hash;
155} __attribute__((__aligned__(BITS_PER_LONG/8)));
156
157struct flowi {
158	union {
159		struct flowi_common	__fl_common;
160		struct flowi4		ip4;
161		struct flowi6		ip6;
162	} u;
163#define flowi_oif	u.__fl_common.flowic_oif
164#define flowi_iif	u.__fl_common.flowic_iif
165#define flowi_l3mdev	u.__fl_common.flowic_l3mdev
166#define flowi_mark	u.__fl_common.flowic_mark
167#define flowi_dscp	u.__fl_common.flowic_dscp
168#define flowi_scope	u.__fl_common.flowic_scope
169#define flowi_proto	u.__fl_common.flowic_proto
170#define flowi_flags	u.__fl_common.flowic_flags
171#define flowi_secid	u.__fl_common.flowic_secid
172#define flowi_tun_key	u.__fl_common.flowic_tun_key
173#define flowi_uid	u.__fl_common.flowic_uid
174} __attribute__((__aligned__(BITS_PER_LONG/8)));
175
176static inline struct flowi *flowi4_to_flowi(struct flowi4 *fl4)
177{
178	return container_of(fl4, struct flowi, u.ip4);
179}
180
181static inline struct flowi_common *flowi4_to_flowi_common(struct flowi4 *fl4)
182{
183	return &(fl4->__fl_common);
184}
185
186static inline struct flowi *flowi6_to_flowi(struct flowi6 *fl6)
187{
188	return container_of(fl6, struct flowi, u.ip6);
189}
190
191static inline struct flowi_common *flowi6_to_flowi_common(struct flowi6 *fl6)
192{
193	return &(fl6->__fl_common);
194}
195
196__u32 __get_hash_from_flowi6(const struct flowi6 *fl6, struct flow_keys *keys);
197
198#endif