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

/*
 *
 *	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>

/*
 * 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_L3MDEV_SRC		0x04
#define FLOWI_FLAG_SKIP_NH_OIF		0x08
	__u32	flowic_secid;
	struct flowi_tunnel flowic_tun_key;
};

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

	/* (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)
{
	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->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_tos		__fl_common.flowic_tos
#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
	struct in6_addr		daddr;
	struct in6_addr		saddr;
	__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
} __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
} __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 size_t 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;
}

#define FLOW_DIR_IN	0
#define FLOW_DIR_OUT	1
#define FLOW_DIR_FWD	2

struct net;
struct sock;
struct flow_cache_ops;

struct flow_cache_object {
	const struct flow_cache_ops *ops;
};

struct flow_cache_ops {
	struct flow_cache_object *(*get)(struct flow_cache_object *);
	int (*check)(struct flow_cache_object *);
	void (*delete)(struct flow_cache_object *);
};

typedef struct flow_cache_object *(*flow_resolve_t)(
		struct net *net, const struct flowi *key, u16 family,
		u8 dir, struct flow_cache_object *oldobj, void *ctx);

struct flow_cache_object *flow_cache_lookup(struct net *net,
					    const struct flowi *key, u16 family,
					    u8 dir, flow_resolve_t resolver,
					    void *ctx);
int flow_cache_init(struct net *net);
void flow_cache_fini(struct net *net);

void flow_cache_flush(struct net *net);
void flow_cache_flush_deferred(struct net *net);
extern atomic_t flow_cache_genid;

__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
1da177e4 LT	1	/*
	2	*
	3	* Generic internet FLOW.
	4	*
	5	*/
	6
	7	#ifndef _NET_FLOW_H
	8	#define _NET_FLOW_H
	9
aa1c366e	10	#include <linux/socket.h>
1da177e4	11	#include <linux/in6.h>
60063497	12	#include <linux/atomic.h>
c6cc1ca7	13	#include <net/flow_dissector.h>
1da177e4	14
6a662719 CW	15	/*
	16	* ifindex generation is per-net namespace, and loopback is
	17	* always the 1st device in ns (see net_dev_init), thus any
	18	* loopback device should get ifindex 1
	19	*/
	20
	21	#define LOOPBACK_IFINDEX 1
	22
1b7179d3 TG	23	struct flowi_tunnel {
	24	__be64 tun_id;
	25	};
	26
806566cc DM	27	struct flowi_common {
	28	int flowic_oif;
	29	int flowic_iif;
	30	__u32 flowic_mark;
	31	__u8 flowic_tos;
	32	__u8 flowic_scope;
	33	__u8 flowic_proto;
	34	__u8 flowic_flags;
fbef0a40	35	#define FLOWI_FLAG_ANYSRC 0x01
0e0d44ab	36	#define FLOWI_FLAG_KNOWN_NH 0x02
6e2895a8	37	#define FLOWI_FLAG_L3MDEV_SRC 0x04
58189ca7	38	#define FLOWI_FLAG_SKIP_NH_OIF 0x08
806566cc	39	__u32 flowic_secid;
1b7179d3	40	struct flowi_tunnel flowic_tun_key;
806566cc DM	41	};
806566cc DM	42
08704bcb DM	43	union flowi_uli {
08704bcb DM	44	struct {
08704bcb	45	__be16 dport;
9b12c75b	46	__be16 sport;
08704bcb DM	47	} ports;
	48
	49	struct {
	50	__u8 type;
	51	__u8 code;
	52	} icmpt;
	53
	54	struct {
08704bcb	55	__le16 dport;
9b12c75b	56	__le16 sport;
08704bcb DM	57	} dnports;
	58
	59	__be32 spi;
	60	__be32 gre_key;
	61
	62	struct {
	63	__u8 type;
	64	} mht;
	65	};
	66
56bb8059 DM	67	struct flowi4 {
56bb8059 DM	68	struct flowi_common __fl_common;
22bd5b9b DM	69	#define flowi4_oif __fl_common.flowic_oif
	70	#define flowi4_iif __fl_common.flowic_iif
	71	#define flowi4_mark __fl_common.flowic_mark
	72	#define flowi4_tos __fl_common.flowic_tos
	73	#define flowi4_scope __fl_common.flowic_scope
	74	#define flowi4_proto __fl_common.flowic_proto
	75	#define flowi4_flags __fl_common.flowic_flags
	76	#define flowi4_secid __fl_common.flowic_secid
1b7179d3	77	#define flowi4_tun_key __fl_common.flowic_tun_key
84f9307c ED	78
84f9307c ED	79	/* (saddr,daddr) must be grouped, same order as in IP header */
56bb8059	80	__be32 saddr;
84f9307c ED	81	__be32 daddr;
84f9307c ED	82
56bb8059	83	union flowi_uli uli;
9cce96df DM	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
728871bc	91	} __attribute__((__aligned__(BITS_PER_LONG/8)));
56bb8059	92
83229aa5 DM	93	static 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,
747465ef	97	__be16 dport, __be16 sport)
83229aa5 DM	98	{
83229aa5 DM	99	fl4->flowi4_oif = oif;
6a662719	100	fl4->flowi4_iif = LOOPBACK_IFINDEX;
83229aa5 DM	101	fl4->flowi4_mark = mark;
	102	fl4->flowi4_tos = tos;
	103	fl4->flowi4_scope = scope;
	104	fl4->flowi4_proto = proto;
	105	fl4->flowi4_flags = flags;
	106	fl4->flowi4_secid = 0;
1b7179d3	107	fl4->flowi4_tun_key.tun_id = 0;
83229aa5 DM	108	fl4->daddr = daddr;
83229aa5 DM	109	fl4->saddr = saddr;
83229aa5	110	fl4->fl4_dport = dport;
9b12c75b	111	fl4->fl4_sport = sport;
83229aa5	112	}
e6b45241 JA	113
	114	/* Reset some input parameters after previous lookup */
	115	static inline void flowi4_update_output(struct flowi4 *fl4, int oif, __u8 tos,
	116	__be32 daddr, __be32 saddr)
	117	{
	118	fl4->flowi4_oif = oif;
	119	fl4->flowi4_tos = tos;
	120	fl4->daddr = daddr;
	121	fl4->saddr = saddr;
	122	}
83229aa5 DM	123
83229aa5 DM	124
56bb8059	125	struct flowi6 {
806566cc	126	struct flowi_common __fl_common;
2032656e DM	127	#define flowi6_oif __fl_common.flowic_oif
	128	#define flowi6_iif __fl_common.flowic_iif
	129	#define flowi6_mark __fl_common.flowic_mark
	130	#define flowi6_tos __fl_common.flowic_tos
	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
904af04d	135	#define flowi6_tun_key __fl_common.flowic_tun_key
56bb8059 DM	136	struct in6_addr daddr;
	137	struct in6_addr saddr;
	138	__be32 flowlabel;
	139	union flowi_uli uli;
1958b856 DM	140	#define fl6_sport uli.ports.sport
	141	#define fl6_dport uli.ports.dport
	142	#define fl6_icmp_type uli.icmpt.type
	143	#define fl6_icmp_code uli.icmpt.code
	144	#define fl6_ipsec_spi uli.spi
	145	#define fl6_mh_type uli.mht.type
	146	#define fl6_gre_key uli.gre_key
728871bc	147	} __attribute__((__aligned__(BITS_PER_LONG/8)));
1da177e4	148
56bb8059 DM	149	struct flowidn {
56bb8059 DM	150	struct flowi_common __fl_common;
bef55aeb DM	151	#define flowidn_oif __fl_common.flowic_oif
	152	#define flowidn_iif __fl_common.flowic_iif
	153	#define flowidn_mark __fl_common.flowic_mark
	154	#define flowidn_scope __fl_common.flowic_scope
	155	#define flowidn_proto __fl_common.flowic_proto
	156	#define flowidn_flags __fl_common.flowic_flags
56bb8059 DM	157	__le16 daddr;
	158	__le16 saddr;
	159	union flowi_uli uli;
bef55aeb DM	160	#define fld_sport uli.ports.sport
bef55aeb DM	161	#define fld_dport uli.ports.dport
728871bc	162	} __attribute__((__aligned__(BITS_PER_LONG/8)));
56bb8059 DM	163
56bb8059 DM	164	struct flowi {
1da177e4	165	union {
56bb8059 DM	166	struct flowi_common __fl_common;
	167	struct flowi4 ip4;
	168	struct flowi6 ip6;
	169	struct flowidn dn;
	170	} u;
	171	#define flowi_oif u.__fl_common.flowic_oif
	172	#define flowi_iif u.__fl_common.flowic_iif
	173	#define flowi_mark u.__fl_common.flowic_mark
	174	#define flowi_tos u.__fl_common.flowic_tos
	175	#define flowi_scope u.__fl_common.flowic_scope
	176	#define flowi_proto u.__fl_common.flowic_proto
	177	#define flowi_flags u.__fl_common.flowic_flags
	178	#define flowi_secid u.__fl_common.flowic_secid
1b7179d3	179	#define flowi_tun_key u.__fl_common.flowic_tun_key
1da177e4 LT	180	} __attribute__((__aligned__(BITS_PER_LONG/8)));
1da177e4 LT	181
59b1a94c DM	182	static inline struct flowi flowi4_to_flowi(struct flowi4 fl4)
	183	{
	184	return container_of(fl4, struct flowi, u.ip4);
	185	}
	186
	187	static inline struct flowi flowi6_to_flowi(struct flowi6 fl6)
	188	{
	189	return container_of(fl6, struct flowi, u.ip6);
	190	}
	191
	192	static inline struct flowi flowidn_to_flowi(struct flowidn fldn)
	193	{
	194	return container_of(fldn, struct flowi, u.dn);
	195	}
	196
aa1c366e	197	typedef unsigned long flow_compare_t;
	198
	199	static inline size_t flow_key_size(u16 family)
	200	{
	201	switch (family) {
	202	case AF_INET:
	203	BUILD_BUG_ON(sizeof(struct flowi4) % sizeof(flow_compare_t));
	204	return sizeof(struct flowi4) / sizeof(flow_compare_t);
	205	case AF_INET6:
	206	BUILD_BUG_ON(sizeof(struct flowi6) % sizeof(flow_compare_t));
	207	return sizeof(struct flowi6) / sizeof(flow_compare_t);
	208	case AF_DECnet:
	209	BUILD_BUG_ON(sizeof(struct flowidn) % sizeof(flow_compare_t));
	210	return sizeof(struct flowidn) / sizeof(flow_compare_t);
	211	}
	212	return 0;
	213	}
	214
1da177e4 LT	215	#define FLOW_DIR_IN 0
	216	#define FLOW_DIR_OUT 1
	217	#define FLOW_DIR_FWD 2
	218
52479b62	219	struct net;
df71837d	220	struct sock;
fe1a5f03 TT	221	struct flow_cache_ops;
	222
	223	struct flow_cache_object {
	224	const struct flow_cache_ops *ops;
	225	};
	226
	227	struct flow_cache_ops {
	228	struct flow_cache_object (get)(struct flow_cache_object *);
	229	int (check)(struct flow_cache_object );
	230	void (delete)(struct flow_cache_object );
	231	};
	232
	233	typedef struct flow_cache_object (flow_resolve_t)(
dee9f4bc	234	struct net net, const struct flowi key, u16 family,
fe1a5f03 TT	235	u8 dir, struct flow_cache_object oldobj, void ctx);
fe1a5f03 TT	236
4787342c JP	237	struct flow_cache_object flow_cache_lookup(struct net net,
	238	const struct flowi *key, u16 family,
	239	u8 dir, flow_resolve_t resolver,
	240	void *ctx);
ca925cf1	241	int flow_cache_init(struct net *net);
4a93f509	242	void flow_cache_fini(struct net *net);
1da177e4	243
ca925cf1 FD	244	void flow_cache_flush(struct net *net);
ca925cf1 FD	245	void flow_cache_flush_deferred(struct net *net);
1da177e4 LT	246	extern atomic_t flow_cache_genid;
1da177e4 LT	247
20a17bf6	248	__u32 __get_hash_from_flowi6(const struct flowi6 fl6, struct flow_keys keys);
c6cc1ca7	249
20a17bf6	250	static inline __u32 get_hash_from_flowi6(const struct flowi6 *fl6)
c6cc1ca7 TH	251	{
	252	struct flow_keys keys;
	253
	254	return __get_hash_from_flowi6(fl6, &keys);
	255	}
	256
20a17bf6	257	__u32 __get_hash_from_flowi4(const struct flowi4 fl4, struct flow_keys keys);
c6cc1ca7	258
20a17bf6	259	static inline __u32 get_hash_from_flowi4(const struct flowi4 *fl4)
c6cc1ca7 TH	260	{
	261	struct flow_keys keys;
	262
	263	return __get_hash_from_flowi4(fl4, &keys);
	264	}
	265
1da177e4	266	#endif