[mirror_ubuntu-bionic-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;
	struct flowi_tunnel flowic_tun_key;
	kuid_t  flowic_uid;
};

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

	/* (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);

static inline __u32 get_hash_from_flowi6(const struct flowi6 *fl6)
{
	struct flow_keys keys;

	return __get_hash_from_flowi6(fl6, &keys);
}

__u32 __get_hash_from_flowi4(const struct flowi4 *fl4, struct flow_keys *keys);

static inline __u32 get_hash_from_flowi4(const struct flowi4 *fl4)
{
	struct flow_keys keys;

	return __get_hash_from_flowi4(fl4, &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;
1b7179d3	41	struct flowi_tunnel flowic_tun_key;
622ec2c9	42	kuid_t flowic_uid;
806566cc DM	43	};
806566cc DM	44
08704bcb DM	45	union flowi_uli {
08704bcb DM	46	struct {
08704bcb	47	__be16 dport;
9b12c75b	48	__be16 sport;
08704bcb DM	49	} ports;
	50
	51	struct {
	52	__u8 type;
	53	__u8 code;
	54	} icmpt;
	55
	56	struct {
08704bcb	57	__le16 dport;
9b12c75b	58	__le16 sport;
08704bcb DM	59	} dnports;
	60
	61	__be32 spi;
	62	__be32 gre_key;
	63
	64	struct {
	65	__u8 type;
	66	} mht;
	67	};
	68
56bb8059 DM	69	struct flowi4 {
56bb8059 DM	70	struct flowi_common __fl_common;
22bd5b9b DM	71	#define flowi4_oif __fl_common.flowic_oif
	72	#define flowi4_iif __fl_common.flowic_iif
	73	#define flowi4_mark __fl_common.flowic_mark
	74	#define flowi4_tos __fl_common.flowic_tos
	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
1b7179d3	79	#define flowi4_tun_key __fl_common.flowic_tun_key
622ec2c9	80	#define flowi4_uid __fl_common.flowic_uid
84f9307c ED	81
84f9307c ED	82	/* (saddr,daddr) must be grouped, same order as in IP header */
56bb8059	83	__be32 saddr;
84f9307c ED	84	__be32 daddr;
84f9307c ED	85
56bb8059	86	union flowi_uli uli;
9cce96df DM	87	#define fl4_sport uli.ports.sport
	88	#define fl4_dport uli.ports.dport
	89	#define fl4_icmp_type uli.icmpt.type
	90	#define fl4_icmp_code uli.icmpt.code
	91	#define fl4_ipsec_spi uli.spi
	92	#define fl4_mh_type uli.mht.type
	93	#define fl4_gre_key uli.gre_key
728871bc	94	} __attribute__((__aligned__(BITS_PER_LONG/8)));
56bb8059	95
83229aa5 DM	96	static 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,
e2d118a1 LC	100	__be16 dport, __be16 sport,
e2d118a1 LC	101	kuid_t uid)
83229aa5 DM	102	{
83229aa5 DM	103	fl4->flowi4_oif = oif;
6a662719	104	fl4->flowi4_iif = LOOPBACK_IFINDEX;
83229aa5 DM	105	fl4->flowi4_mark = mark;
	106	fl4->flowi4_tos = tos;
	107	fl4->flowi4_scope = scope;
	108	fl4->flowi4_proto = proto;
	109	fl4->flowi4_flags = flags;
	110	fl4->flowi4_secid = 0;
1b7179d3	111	fl4->flowi4_tun_key.tun_id = 0;
e2d118a1	112	fl4->flowi4_uid = uid;
83229aa5 DM	113	fl4->daddr = daddr;
83229aa5 DM	114	fl4->saddr = saddr;
83229aa5	115	fl4->fl4_dport = dport;
9b12c75b	116	fl4->fl4_sport = sport;
83229aa5	117	}
e6b45241 JA	118
	119	/* Reset some input parameters after previous lookup */
	120	static inline void flowi4_update_output(struct flowi4 *fl4, int oif, __u8 tos,
	121	__be32 daddr, __be32 saddr)
	122	{
	123	fl4->flowi4_oif = oif;
	124	fl4->flowi4_tos = tos;
	125	fl4->daddr = daddr;
	126	fl4->saddr = saddr;
	127	}
83229aa5 DM	128
83229aa5 DM	129
56bb8059	130	struct flowi6 {
806566cc	131	struct flowi_common __fl_common;
2032656e DM	132	#define flowi6_oif __fl_common.flowic_oif
	133	#define flowi6_iif __fl_common.flowic_iif
	134	#define flowi6_mark __fl_common.flowic_mark
2032656e DM	135	#define flowi6_scope __fl_common.flowic_scope
	136	#define flowi6_proto __fl_common.flowic_proto
	137	#define flowi6_flags __fl_common.flowic_flags
	138	#define flowi6_secid __fl_common.flowic_secid
904af04d	139	#define flowi6_tun_key __fl_common.flowic_tun_key
622ec2c9	140	#define flowi6_uid __fl_common.flowic_uid
56bb8059 DM	141	struct in6_addr daddr;
56bb8059 DM	142	struct in6_addr saddr;
69716a2b	143	/* Note: flowi6_tos is encoded in flowlabel, too. */
56bb8059 DM	144	__be32 flowlabel;
56bb8059 DM	145	union flowi_uli uli;
1958b856 DM	146	#define fl6_sport uli.ports.sport
	147	#define fl6_dport uli.ports.dport
	148	#define fl6_icmp_type uli.icmpt.type
	149	#define fl6_icmp_code uli.icmpt.code
	150	#define fl6_ipsec_spi uli.spi
	151	#define fl6_mh_type uli.mht.type
	152	#define fl6_gre_key uli.gre_key
29825717	153	__u32 mp_hash;
728871bc	154	} __attribute__((__aligned__(BITS_PER_LONG/8)));
1da177e4	155
56bb8059 DM	156	struct flowidn {
56bb8059 DM	157	struct flowi_common __fl_common;
bef55aeb DM	158	#define flowidn_oif __fl_common.flowic_oif
	159	#define flowidn_iif __fl_common.flowic_iif
	160	#define flowidn_mark __fl_common.flowic_mark
	161	#define flowidn_scope __fl_common.flowic_scope
	162	#define flowidn_proto __fl_common.flowic_proto
	163	#define flowidn_flags __fl_common.flowic_flags
56bb8059 DM	164	__le16 daddr;
	165	__le16 saddr;
	166	union flowi_uli uli;
bef55aeb DM	167	#define fld_sport uli.ports.sport
bef55aeb DM	168	#define fld_dport uli.ports.dport
728871bc	169	} __attribute__((__aligned__(BITS_PER_LONG/8)));
56bb8059 DM	170
56bb8059 DM	171	struct flowi {
1da177e4	172	union {
56bb8059 DM	173	struct flowi_common __fl_common;
	174	struct flowi4 ip4;
	175	struct flowi6 ip6;
	176	struct flowidn dn;
	177	} u;
	178	#define flowi_oif u.__fl_common.flowic_oif
	179	#define flowi_iif u.__fl_common.flowic_iif
	180	#define flowi_mark u.__fl_common.flowic_mark
	181	#define flowi_tos u.__fl_common.flowic_tos
	182	#define flowi_scope u.__fl_common.flowic_scope
	183	#define flowi_proto u.__fl_common.flowic_proto
	184	#define flowi_flags u.__fl_common.flowic_flags
	185	#define flowi_secid u.__fl_common.flowic_secid
1b7179d3	186	#define flowi_tun_key u.__fl_common.flowic_tun_key
622ec2c9	187	#define flowi_uid u.__fl_common.flowic_uid
1da177e4 LT	188	} __attribute__((__aligned__(BITS_PER_LONG/8)));
1da177e4 LT	189
59b1a94c DM	190	static inline struct flowi flowi4_to_flowi(struct flowi4 fl4)
	191	{
	192	return container_of(fl4, struct flowi, u.ip4);
	193	}
	194
	195	static inline struct flowi flowi6_to_flowi(struct flowi6 fl6)
	196	{
	197	return container_of(fl6, struct flowi, u.ip6);
	198	}
	199
	200	static inline struct flowi flowidn_to_flowi(struct flowidn fldn)
	201	{
	202	return container_of(fldn, struct flowi, u.dn);
	203	}
	204
aa1c366e	205	typedef unsigned long flow_compare_t;
aa1c366e	206
5a17d9ed	207	static inline unsigned int flow_key_size(u16 family)
aa1c366e	208	{
	209	switch (family) {
	210	case AF_INET:
	211	BUILD_BUG_ON(sizeof(struct flowi4) % sizeof(flow_compare_t));
	212	return sizeof(struct flowi4) / sizeof(flow_compare_t);
	213	case AF_INET6:
	214	BUILD_BUG_ON(sizeof(struct flowi6) % sizeof(flow_compare_t));
	215	return sizeof(struct flowi6) / sizeof(flow_compare_t);
	216	case AF_DECnet:
	217	BUILD_BUG_ON(sizeof(struct flowidn) % sizeof(flow_compare_t));
	218	return sizeof(struct flowidn) / sizeof(flow_compare_t);
	219	}
	220	return 0;
	221	}
	222
20a17bf6	223	__u32 __get_hash_from_flowi6(const struct flowi6 fl6, struct flow_keys keys);
c6cc1ca7	224
20a17bf6	225	static inline __u32 get_hash_from_flowi6(const struct flowi6 *fl6)
c6cc1ca7 TH	226	{
	227	struct flow_keys keys;
	228
	229	return __get_hash_from_flowi6(fl6, &keys);
	230	}
	231
20a17bf6	232	__u32 __get_hash_from_flowi4(const struct flowi4 fl4, struct flow_keys keys);
c6cc1ca7	233
20a17bf6	234	static inline __u32 get_hash_from_flowi4(const struct flowi4 *fl4)
c6cc1ca7 TH	235	{
	236	struct flow_keys keys;
	237
	238	return __get_hash_from_flowi4(fl4, &keys);
	239	}
	240
1da177e4	241	#endif