[linux.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>
#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
} __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;
}

#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_hp_init(void);

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