[mirror_ubuntu-eoan-kernel.git] / include / net / flow.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *
 *	Generic internet FLOW.
 *
 */

#ifndef _NET_FLOW_H
#define _NET_FLOW_H

#include <linux/socket.h>
#include <linux/in6.h>
#include <linux/atomic.h>
#include <net/flow_dissector.h>
#include <linux/uidgid.h>

/*
 * ifindex generation is per-net namespace, and loopback is
 * always the 1st device in ns (see net_dev_init), thus any
 * loopback device should get ifindex 1
 */

#define LOOPBACK_IFINDEX	1

struct flowi_tunnel {
	__be64			tun_id;
};

struct flowi_common {
	int	flowic_oif;
	int	flowic_iif;
	__u32	flowic_mark;
	__u8	flowic_tos;
	__u8	flowic_scope;
	__u8	flowic_proto;
	__u8	flowic_flags;
#define FLOWI_FLAG_ANYSRC		0x01
#define FLOWI_FLAG_KNOWN_NH		0x02
#define FLOWI_FLAG_SKIP_NH_OIF		0x04
	__u32	flowic_secid;
	kuid_t  flowic_uid;
	struct flowi_tunnel flowic_tun_key;
	__u32		flowic_multipath_hash;
};

union flowi_uli {
	struct {
		__be16	dport;
		__be16	sport;
	} ports;

	struct {
		__u8	type;
		__u8	code;
	} icmpt;

	struct {
		__le16	dport;
		__le16	sport;
	} dnports;

	__be32		spi;
	__be32		gre_key;

	struct {
		__u8	type;
	} mht;
};

struct flowi4 {
	struct flowi_common	__fl_common;
#define flowi4_oif		__fl_common.flowic_oif
#define flowi4_iif		__fl_common.flowic_iif
#define flowi4_mark		__fl_common.flowic_mark
#define flowi4_tos		__fl_common.flowic_tos
#define flowi4_scope		__fl_common.flowic_scope
#define flowi4_proto		__fl_common.flowic_proto
#define flowi4_flags		__fl_common.flowic_flags
#define flowi4_secid		__fl_common.flowic_secid
#define flowi4_tun_key		__fl_common.flowic_tun_key
#define flowi4_uid		__fl_common.flowic_uid
#define flowi4_multipath_hash	__fl_common.flowic_multipath_hash

	/* (saddr,daddr) must be grouped, same order as in IP header */
	__be32			saddr;
	__be32			daddr;

	union flowi_uli		uli;
#define fl4_sport		uli.ports.sport
#define fl4_dport		uli.ports.dport
#define fl4_icmp_type		uli.icmpt.type
#define fl4_icmp_code		uli.icmpt.code
#define fl4_ipsec_spi		uli.spi
#define fl4_mh_type		uli.mht.type
#define fl4_gre_key		uli.gre_key
} __attribute__((__aligned__(BITS_PER_LONG/8)));

static inline void 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)
{
	fl4->flowi4_oif = oif;
	fl4->flowi4_iif = LOOPBACK_IFINDEX;
	fl4->flowi4_mark = mark;
	fl4->flowi4_tos = tos;
	fl4->flowi4_scope = scope;
	fl4->flowi4_proto = proto;
	fl4->flowi4_flags = flags;
	fl4->flowi4_secid = 0;
	fl4->flowi4_tun_key.tun_id = 0;
	fl4->flowi4_uid = uid;
	fl4->daddr = daddr;
	fl4->saddr = saddr;
	fl4->fl4_dport = dport;
	fl4->fl4_sport = sport;
}

/* Reset some input parameters after previous lookup */
static inline void flowi4_update_output(struct flowi4 *fl4, int oif, __u8 tos,
					__be32 daddr, __be32 saddr)
{
	fl4->flowi4_oif = oif;
	fl4->flowi4_tos = tos;
	fl4->daddr = daddr;
	fl4->saddr = saddr;
}


struct flowi6 {
	struct flowi_common	__fl_common;
#define flowi6_oif		__fl_common.flowic_oif
#define flowi6_iif		__fl_common.flowic_iif
#define flowi6_mark		__fl_common.flowic_mark
#define flowi6_scope		__fl_common.flowic_scope
#define flowi6_proto		__fl_common.flowic_proto
#define flowi6_flags		__fl_common.flowic_flags
#define flowi6_secid		__fl_common.flowic_secid
#define flowi6_tun_key		__fl_common.flowic_tun_key
#define flowi6_uid		__fl_common.flowic_uid
	struct in6_addr		daddr;
	struct in6_addr		saddr;
	/* Note: flowi6_tos is encoded in flowlabel, too. */
	__be32			flowlabel;
	union flowi_uli		uli;
#define fl6_sport		uli.ports.sport
#define fl6_dport		uli.ports.dport
#define fl6_icmp_type		uli.icmpt.type
#define fl6_icmp_code		uli.icmpt.code
#define fl6_ipsec_spi		uli.spi
#define fl6_mh_type		uli.mht.type
#define fl6_gre_key		uli.gre_key
	__u32			mp_hash;
} __attribute__((__aligned__(BITS_PER_LONG/8)));

struct flowidn {
	struct flowi_common	__fl_common;
#define flowidn_oif		__fl_common.flowic_oif
#define flowidn_iif		__fl_common.flowic_iif
#define flowidn_mark		__fl_common.flowic_mark
#define flowidn_scope		__fl_common.flowic_scope
#define flowidn_proto		__fl_common.flowic_proto
#define flowidn_flags		__fl_common.flowic_flags
	__le16			daddr;
	__le16			saddr;
	union flowi_uli		uli;
#define fld_sport		uli.ports.sport
#define fld_dport		uli.ports.dport
} __attribute__((__aligned__(BITS_PER_LONG/8)));

struct flowi {
	union {
		struct flowi_common	__fl_common;
		struct flowi4		ip4;
		struct flowi6		ip6;
		struct flowidn		dn;
	} u;
#define flowi_oif	u.__fl_common.flowic_oif
#define flowi_iif	u.__fl_common.flowic_iif
#define flowi_mark	u.__fl_common.flowic_mark
#define flowi_tos	u.__fl_common.flowic_tos
#define flowi_scope	u.__fl_common.flowic_scope
#define flowi_proto	u.__fl_common.flowic_proto
#define flowi_flags	u.__fl_common.flowic_flags
#define flowi_secid	u.__fl_common.flowic_secid
#define flowi_tun_key	u.__fl_common.flowic_tun_key
#define flowi_uid	u.__fl_common.flowic_uid
} __attribute__((__aligned__(BITS_PER_LONG/8)));

static inline struct flowi *flowi4_to_flowi(struct flowi4 *fl4)
{
	return container_of(fl4, struct flowi, u.ip4);
}

static inline struct flowi *flowi6_to_flowi(struct flowi6 *fl6)
{
	return container_of(fl6, struct flowi, u.ip6);
}

static inline struct flowi *flowidn_to_flowi(struct flowidn *fldn)
{
	return container_of(fldn, struct flowi, u.dn);
}

typedef unsigned long flow_compare_t;

static inline unsigned int flow_key_size(u16 family)
{
	switch (family) {
	case AF_INET:
		BUILD_BUG_ON(sizeof(struct flowi4) % sizeof(flow_compare_t));
		return sizeof(struct flowi4) / sizeof(flow_compare_t);
	case AF_INET6:
		BUILD_BUG_ON(sizeof(struct flowi6) % sizeof(flow_compare_t));
		return sizeof(struct flowi6) / sizeof(flow_compare_t);
	case AF_DECnet:
		BUILD_BUG_ON(sizeof(struct flowidn) % sizeof(flow_compare_t));
		return sizeof(struct flowidn) / sizeof(flow_compare_t);
	}
	return 0;
}

__u32 __get_hash_from_flowi6(const struct flowi6 *fl6, struct flow_keys *keys);

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	/*
	3	*
	4	* Generic internet FLOW.
	5	*
	6	*/
	7
	8	#ifndef _NET_FLOW_H
	9	#define _NET_FLOW_H
	10
aa1c366e	11	#include <linux/socket.h>
1da177e4	12	#include <linux/in6.h>
60063497	13	#include <linux/atomic.h>
c6cc1ca7	14	#include <net/flow_dissector.h>
622ec2c9	15	#include <linux/uidgid.h>
1da177e4	16
6a662719 CW	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
1b7179d3 TG	25	struct flowi_tunnel {
	26	__be64 tun_id;
	27	};
	28
806566cc DM	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;
fbef0a40	37	#define FLOWI_FLAG_ANYSRC 0x01
0e0d44ab	38	#define FLOWI_FLAG_KNOWN_NH 0x02
c71ad3d4	39	#define FLOWI_FLAG_SKIP_NH_OIF 0x04
806566cc	40	__u32 flowic_secid;
622ec2c9	41	kuid_t flowic_uid;
bf1c3ab8	42	struct flowi_tunnel flowic_tun_key;
24ba1440	43	__u32 flowic_multipath_hash;
806566cc DM	44	};
806566cc DM	45
08704bcb DM	46	union flowi_uli {
08704bcb DM	47	struct {
08704bcb	48	__be16 dport;
9b12c75b	49	__be16 sport;
08704bcb DM	50	} ports;
	51
	52	struct {
	53	__u8 type;
	54	__u8 code;
	55	} icmpt;
	56
	57	struct {
08704bcb	58	__le16 dport;
9b12c75b	59	__le16 sport;
08704bcb DM	60	} dnports;
	61
	62	__be32 spi;
	63	__be32 gre_key;
	64
	65	struct {
	66	__u8 type;
	67	} mht;
	68	};
	69
56bb8059 DM	70	struct flowi4 {
56bb8059 DM	71	struct flowi_common __fl_common;
22bd5b9b DM	72	#define flowi4_oif __fl_common.flowic_oif
	73	#define flowi4_iif __fl_common.flowic_iif
	74	#define flowi4_mark __fl_common.flowic_mark
	75	#define flowi4_tos __fl_common.flowic_tos
	76	#define flowi4_scope __fl_common.flowic_scope
	77	#define flowi4_proto __fl_common.flowic_proto
	78	#define flowi4_flags __fl_common.flowic_flags
	79	#define flowi4_secid __fl_common.flowic_secid
1b7179d3	80	#define flowi4_tun_key __fl_common.flowic_tun_key
622ec2c9	81	#define flowi4_uid __fl_common.flowic_uid
24ba1440	82	#define flowi4_multipath_hash __fl_common.flowic_multipath_hash
84f9307c ED	83
84f9307c ED	84	/* (saddr,daddr) must be grouped, same order as in IP header */
56bb8059	85	__be32 saddr;
84f9307c ED	86	__be32 daddr;
84f9307c ED	87
56bb8059	88	union flowi_uli uli;
9cce96df DM	89	#define fl4_sport uli.ports.sport
	90	#define fl4_dport uli.ports.dport
	91	#define fl4_icmp_type uli.icmpt.type
	92	#define fl4_icmp_code uli.icmpt.code
	93	#define fl4_ipsec_spi uli.spi
	94	#define fl4_mh_type uli.mht.type
	95	#define fl4_gre_key uli.gre_key
728871bc	96	} __attribute__((__aligned__(BITS_PER_LONG/8)));
56bb8059	97
83229aa5 DM	98	static inline void flowi4_init_output(struct flowi4 *fl4, int oif,
	99	__u32 mark, __u8 tos, __u8 scope,
	100	__u8 proto, __u8 flags,
	101	__be32 daddr, __be32 saddr,
e2d118a1 LC	102	__be16 dport, __be16 sport,
e2d118a1 LC	103	kuid_t uid)
83229aa5 DM	104	{
83229aa5 DM	105	fl4->flowi4_oif = oif;
6a662719	106	fl4->flowi4_iif = LOOPBACK_IFINDEX;
83229aa5 DM	107	fl4->flowi4_mark = mark;
	108	fl4->flowi4_tos = tos;
	109	fl4->flowi4_scope = scope;
	110	fl4->flowi4_proto = proto;
	111	fl4->flowi4_flags = flags;
	112	fl4->flowi4_secid = 0;
1b7179d3	113	fl4->flowi4_tun_key.tun_id = 0;
e2d118a1	114	fl4->flowi4_uid = uid;
83229aa5 DM	115	fl4->daddr = daddr;
83229aa5 DM	116	fl4->saddr = saddr;
83229aa5	117	fl4->fl4_dport = dport;
9b12c75b	118	fl4->fl4_sport = sport;
83229aa5	119	}
e6b45241 JA	120
	121	/* Reset some input parameters after previous lookup */
	122	static inline void flowi4_update_output(struct flowi4 *fl4, int oif, __u8 tos,
	123	__be32 daddr, __be32 saddr)
	124	{
	125	fl4->flowi4_oif = oif;
	126	fl4->flowi4_tos = tos;
	127	fl4->daddr = daddr;
	128	fl4->saddr = saddr;
	129	}
82695b30	130
83229aa5	131
56bb8059	132	struct flowi6 {
806566cc	133	struct flowi_common __fl_common;
2032656e DM	134	#define flowi6_oif __fl_common.flowic_oif
	135	#define flowi6_iif __fl_common.flowic_iif
	136	#define flowi6_mark __fl_common.flowic_mark
2032656e DM	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
904af04d	141	#define flowi6_tun_key __fl_common.flowic_tun_key
622ec2c9	142	#define flowi6_uid __fl_common.flowic_uid
56bb8059 DM	143	struct in6_addr daddr;
56bb8059 DM	144	struct in6_addr saddr;
69716a2b	145	/* Note: flowi6_tos is encoded in flowlabel, too. */
56bb8059 DM	146	__be32 flowlabel;
56bb8059 DM	147	union flowi_uli uli;
1958b856 DM	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_ipsec_spi uli.spi
	153	#define fl6_mh_type uli.mht.type
	154	#define fl6_gre_key uli.gre_key
29825717	155	__u32 mp_hash;
728871bc	156	} __attribute__((__aligned__(BITS_PER_LONG/8)));
1da177e4	157
56bb8059 DM	158	struct flowidn {
56bb8059 DM	159	struct flowi_common __fl_common;
bef55aeb DM	160	#define flowidn_oif __fl_common.flowic_oif
	161	#define flowidn_iif __fl_common.flowic_iif
	162	#define flowidn_mark __fl_common.flowic_mark
	163	#define flowidn_scope __fl_common.flowic_scope
	164	#define flowidn_proto __fl_common.flowic_proto
	165	#define flowidn_flags __fl_common.flowic_flags
56bb8059 DM	166	__le16 daddr;
	167	__le16 saddr;
	168	union flowi_uli uli;
bef55aeb DM	169	#define fld_sport uli.ports.sport
bef55aeb DM	170	#define fld_dport uli.ports.dport
728871bc	171	} __attribute__((__aligned__(BITS_PER_LONG/8)));
56bb8059 DM	172
56bb8059 DM	173	struct flowi {
1da177e4	174	union {
56bb8059 DM	175	struct flowi_common __fl_common;
	176	struct flowi4 ip4;
	177	struct flowi6 ip6;
	178	struct flowidn dn;
	179	} u;
	180	#define flowi_oif u.__fl_common.flowic_oif
	181	#define flowi_iif u.__fl_common.flowic_iif
	182	#define flowi_mark u.__fl_common.flowic_mark
	183	#define flowi_tos u.__fl_common.flowic_tos
	184	#define flowi_scope u.__fl_common.flowic_scope
	185	#define flowi_proto u.__fl_common.flowic_proto
	186	#define flowi_flags u.__fl_common.flowic_flags
	187	#define flowi_secid u.__fl_common.flowic_secid
1b7179d3	188	#define flowi_tun_key u.__fl_common.flowic_tun_key
622ec2c9	189	#define flowi_uid u.__fl_common.flowic_uid
1da177e4 LT	190	} __attribute__((__aligned__(BITS_PER_LONG/8)));
1da177e4 LT	191
59b1a94c DM	192	static inline struct flowi flowi4_to_flowi(struct flowi4 fl4)
	193	{
	194	return container_of(fl4, struct flowi, u.ip4);
	195	}
	196
	197	static inline struct flowi flowi6_to_flowi(struct flowi6 fl6)
	198	{
	199	return container_of(fl6, struct flowi, u.ip6);
	200	}
	201
	202	static inline struct flowi flowidn_to_flowi(struct flowidn fldn)
	203	{
	204	return container_of(fldn, struct flowi, u.dn);
	205	}
	206
aa1c366e	207	typedef unsigned long flow_compare_t;
aa1c366e	208
5a17d9ed	209	static inline unsigned int flow_key_size(u16 family)
aa1c366e	210	{
	211	switch (family) {
	212	case AF_INET:
	213	BUILD_BUG_ON(sizeof(struct flowi4) % sizeof(flow_compare_t));
	214	return sizeof(struct flowi4) / sizeof(flow_compare_t);
	215	case AF_INET6:
	216	BUILD_BUG_ON(sizeof(struct flowi6) % sizeof(flow_compare_t));
	217	return sizeof(struct flowi6) / sizeof(flow_compare_t);
	218	case AF_DECnet:
	219	BUILD_BUG_ON(sizeof(struct flowidn) % sizeof(flow_compare_t));
	220	return sizeof(struct flowidn) / sizeof(flow_compare_t);
	221	}
	222	return 0;
	223	}
	224
20a17bf6	225	__u32 __get_hash_from_flowi6(const struct flowi6 fl6, struct flow_keys keys);
c6cc1ca7	226
1da177e4	227	#endif