[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>

/*
 * 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_VRFSRC		0x04
	__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;

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