[deliverable/linux.git] / include / net / inet_sock.h

/*
 * INET		An implementation of the TCP/IP protocol suite for the LINUX
 *		operating system.  INET is implemented using the  BSD Socket
 *		interface as the means of communication with the user level.
 *
 *		Definitions for inet_sock
 *
 * Authors:	Many, reorganised here by
 * 		Arnaldo Carvalho de Melo <acme@mandriva.com>
 *
 *		This program is free software; you can redistribute it and/or
 *		modify it under the terms of the GNU General Public License
 *		as published by the Free Software Foundation; either version
 *		2 of the License, or (at your option) any later version.
 */
#ifndef _INET_SOCK_H
#define _INET_SOCK_H

#include <linux/bitops.h>
#include <linux/kmemcheck.h>
#include <linux/string.h>
#include <linux/types.h>
#include <linux/jhash.h>
#include <linux/netdevice.h>

#include <net/flow.h>
#include <net/sock.h>
#include <net/request_sock.h>
#include <net/netns/hash.h>
#include <net/tcp_states.h>
#include <net/l3mdev.h>

/** struct ip_options - IP Options
 *
 * @faddr - Saved first hop address
 * @nexthop - Saved nexthop address in LSRR and SSRR
 * @is_strictroute - Strict source route
 * @srr_is_hit - Packet destination addr was our one
 * @is_changed - IP checksum more not valid
 * @rr_needaddr - Need to record addr of outgoing dev
 * @ts_needtime - Need to record timestamp
 * @ts_needaddr - Need to record addr of outgoing dev
 */
struct ip_options {
	__be32		faddr;
	__be32		nexthop;
	unsigned char	optlen;
	unsigned char	srr;
	unsigned char	rr;
	unsigned char	ts;
	unsigned char	is_strictroute:1,
			srr_is_hit:1,
			is_changed:1,
			rr_needaddr:1,
			ts_needtime:1,
			ts_needaddr:1;
	unsigned char	router_alert;
	unsigned char	cipso;
	unsigned char	__pad2;
	unsigned char	__data[0];
};

struct ip_options_rcu {
	struct rcu_head rcu;
	struct ip_options opt;
};

struct ip_options_data {
	struct ip_options_rcu	opt;
	char			data[40];
};

struct inet_request_sock {
	struct request_sock	req;
#define ir_loc_addr		req.__req_common.skc_rcv_saddr
#define ir_rmt_addr		req.__req_common.skc_daddr
#define ir_num			req.__req_common.skc_num
#define ir_rmt_port		req.__req_common.skc_dport
#define ir_v6_rmt_addr		req.__req_common.skc_v6_daddr
#define ir_v6_loc_addr		req.__req_common.skc_v6_rcv_saddr
#define ir_iif			req.__req_common.skc_bound_dev_if
#define ir_cookie		req.__req_common.skc_cookie
#define ireq_net		req.__req_common.skc_net
#define ireq_state		req.__req_common.skc_state
#define ireq_family		req.__req_common.skc_family

	kmemcheck_bitfield_begin(flags);
	u16			snd_wscale : 4,
				rcv_wscale : 4,
				tstamp_ok  : 1,
				sack_ok	   : 1,
				wscale_ok  : 1,
				ecn_ok	   : 1,
				acked	   : 1,
				no_srccheck: 1;
	kmemcheck_bitfield_end(flags);
	u32                     ir_mark;
	union {
		struct ip_options_rcu	*opt;
		struct sk_buff		*pktopts;
	};
};

static inline struct inet_request_sock *inet_rsk(const struct request_sock *sk)
{
	return (struct inet_request_sock *)sk;
}

static inline u32 inet_request_mark(const struct sock *sk, struct sk_buff *skb)
{
	if (!sk->sk_mark && sock_net(sk)->ipv4.sysctl_tcp_fwmark_accept)
		return skb->mark;

	return sk->sk_mark;
}

static inline int inet_request_bound_dev_if(const struct sock *sk,
					    struct sk_buff *skb)
{
#ifdef CONFIG_NET_L3_MASTER_DEV
	struct net *net = sock_net(sk);

	if (!sk->sk_bound_dev_if && net->ipv4.sysctl_tcp_l3mdev_accept)
		return l3mdev_master_ifindex_by_index(net, skb->skb_iif);
#endif

	return sk->sk_bound_dev_if;
}

struct inet_cork {
	unsigned int		flags;
	__be32			addr;
	struct ip_options	*opt;
	unsigned int		fragsize;
	int			length; /* Total length of all frames */
	struct dst_entry	*dst;
	u8			tx_flags;
	__u8			ttl;
	__s16			tos;
	char			priority;
};

struct inet_cork_full {
	struct inet_cork	base;
	struct flowi		fl;
};

struct ip_mc_socklist;
struct ipv6_pinfo;
struct rtable;

/** struct inet_sock - representation of INET sockets
 *
 * @sk - ancestor class
 * @pinet6 - pointer to IPv6 control block
 * @inet_daddr - Foreign IPv4 addr
 * @inet_rcv_saddr - Bound local IPv4 addr
 * @inet_dport - Destination port
 * @inet_num - Local port
 * @inet_saddr - Sending source
 * @uc_ttl - Unicast TTL
 * @inet_sport - Source port
 * @inet_id - ID counter for DF pkts
 * @tos - TOS
 * @mc_ttl - Multicasting TTL
 * @is_icsk - is this an inet_connection_sock?
 * @uc_index - Unicast outgoing device index
 * @mc_index - Multicast device index
 * @mc_list - Group array
 * @cork - info to build ip hdr on each ip frag while socket is corked
 */
struct inet_sock {
	/* sk and pinet6 has to be the first two members of inet_sock */
	struct sock		sk;
#if IS_ENABLED(CONFIG_IPV6)
	struct ipv6_pinfo	*pinet6;
#endif
	/* Socket demultiplex comparisons on incoming packets. */
#define inet_daddr		sk.__sk_common.skc_daddr
#define inet_rcv_saddr		sk.__sk_common.skc_rcv_saddr
#define inet_dport		sk.__sk_common.skc_dport
#define inet_num		sk.__sk_common.skc_num

	__be32			inet_saddr;
	__s16			uc_ttl;
	__u16			cmsg_flags;
	__be16			inet_sport;
	__u16			inet_id;

	struct ip_options_rcu __rcu	*inet_opt;
	int			rx_dst_ifindex;
	__u8			tos;
	__u8			min_ttl;
	__u8			mc_ttl;
	__u8			pmtudisc;
	__u8			recverr:1,
				is_icsk:1,
				freebind:1,
				hdrincl:1,
				mc_loop:1,
				transparent:1,
				mc_all:1,
				nodefrag:1;
	__u8			bind_address_no_port:1;
	__u8			rcv_tos;
	__u8			convert_csum;
	int			uc_index;
	int			mc_index;
	__be32			mc_addr;
	struct ip_mc_socklist __rcu	*mc_list;
	struct inet_cork_full	cork;
};

#define IPCORK_OPT	1	/* ip-options has been held in ipcork.opt */
#define IPCORK_ALLFRAG	2	/* always fragment (for ipv6 for now) */

/* cmsg flags for inet */
#define IP_CMSG_PKTINFO		BIT(0)
#define IP_CMSG_TTL		BIT(1)
#define IP_CMSG_TOS		BIT(2)
#define IP_CMSG_RECVOPTS	BIT(3)
#define IP_CMSG_RETOPTS		BIT(4)
#define IP_CMSG_PASSSEC		BIT(5)
#define IP_CMSG_ORIGDSTADDR	BIT(6)
#define IP_CMSG_CHECKSUM	BIT(7)

/**
 * sk_to_full_sk - Access to a full socket
 * @sk: pointer to a socket
 *
 * SYNACK messages might be attached to request sockets.
 * Some places want to reach the listener in this case.
 */
static inline struct sock *sk_to_full_sk(struct sock *sk)
{
#ifdef CONFIG_INET
	if (sk && sk->sk_state == TCP_NEW_SYN_RECV)
		sk = inet_reqsk(sk)->rsk_listener;
#endif
	return sk;
}

/* sk_to_full_sk() variant with a const argument */
static inline const struct sock *sk_const_to_full_sk(const struct sock *sk)
{
#ifdef CONFIG_INET
	if (sk && sk->sk_state == TCP_NEW_SYN_RECV)
		sk = ((const struct request_sock *)sk)->rsk_listener;
#endif
	return sk;
}

static inline struct sock *skb_to_full_sk(const struct sk_buff *skb)
{
	return sk_to_full_sk(skb->sk);
}

static inline struct inet_sock *inet_sk(const struct sock *sk)
{
	return (struct inet_sock *)sk;
}

static inline void __inet_sk_copy_descendant(struct sock *sk_to,
					     const struct sock *sk_from,
					     const int ancestor_size)
{
	memcpy(inet_sk(sk_to) + 1, inet_sk(sk_from) + 1,
	       sk_from->sk_prot->obj_size - ancestor_size);
}
#if !(IS_ENABLED(CONFIG_IPV6))
static inline void inet_sk_copy_descendant(struct sock *sk_to,
					   const struct sock *sk_from)
{
	__inet_sk_copy_descendant(sk_to, sk_from, sizeof(struct inet_sock));
}
#endif

int inet_sk_rebuild_header(struct sock *sk);

static inline unsigned int __inet_ehashfn(const __be32 laddr,
					  const __u16 lport,
					  const __be32 faddr,
					  const __be16 fport,
					  u32 initval)
{
	return jhash_3words((__force __u32) laddr,
			    (__force __u32) faddr,
			    ((__u32) lport) << 16 | (__force __u32)fport,
			    initval);
}

struct request_sock *inet_reqsk_alloc(const struct request_sock_ops *ops,
				      struct sock *sk_listener,
				      bool attach_listener);

static inline __u8 inet_sk_flowi_flags(const struct sock *sk)
{
	__u8 flags = 0;

	if (inet_sk(sk)->transparent || inet_sk(sk)->hdrincl)
		flags |= FLOWI_FLAG_ANYSRC;
	return flags;
}

static inline void inet_inc_convert_csum(struct sock *sk)
{
	inet_sk(sk)->convert_csum++;
}

static inline void inet_dec_convert_csum(struct sock *sk)
{
	if (inet_sk(sk)->convert_csum > 0)
		inet_sk(sk)->convert_csum--;
}

static inline bool inet_get_convert_csum(struct sock *sk)
{
	return !!inet_sk(sk)->convert_csum;
}

#endif	/* _INET_SOCK_H */
Commit	Line	Data
14c85021 ACM	1	/*
	2	* INET An implementation of the TCP/IP protocol suite for the LINUX
	3	* operating system. INET is implemented using the BSD Socket
	4	* interface as the means of communication with the user level.
	5	*
	6	* Definitions for inet_sock
	7	*
	8	* Authors: Many, reorganised here by
	9	* Arnaldo Carvalho de Melo <acme@mandriva.com>
	10	*
	11	* This program is free software; you can redistribute it and/or
	12	* modify it under the terms of the GNU General Public License
	13	* as published by the Free Software Foundation; either version
	14	* 2 of the License, or (at your option) any later version.
	15	*/
	16	#ifndef _INET_SOCK_H
	17	#define _INET_SOCK_H
	18
c44d13d6	19	#include <linux/bitops.h>
45e3ff82	20	#include <linux/kmemcheck.h>
14c85021 ACM	21	#include <linux/string.h>
14c85021 ACM	22	#include <linux/types.h>
b3da2cf3	23	#include <linux/jhash.h>
fec5e652	24	#include <linux/netdevice.h>
14c85021 ACM	25
	26	#include <net/flow.h>
	27	#include <net/sock.h>
	28	#include <net/request_sock.h>
0b441916	29	#include <net/netns/hash.h>
d34ac51b	30	#include <net/tcp_states.h>
6dd9a14e	31	#include <net/l3mdev.h>
14c85021 ACM	32
	33	/** struct ip_options - IP Options
	34	*
	35	* @faddr - Saved first hop address
ac8a4810	36	* @nexthop - Saved nexthop address in LSRR and SSRR
14c85021 ACM	37	* @is_strictroute - Strict source route
	38	* @srr_is_hit - Packet destination addr was our one
	39	* @is_changed - IP checksum more not valid
	40	* @rr_needaddr - Need to record addr of outgoing dev
	41	* @ts_needtime - Need to record timestamp
	42	* @ts_needaddr - Need to record addr of outgoing dev
	43	*/
	44	struct ip_options {
3ca3c68e	45	__be32 faddr;
ac8a4810	46	__be32 nexthop;
14c85021 ACM	47	unsigned char optlen;
	48	unsigned char srr;
	49	unsigned char rr;
	50	unsigned char ts;
ef722495	51	unsigned char is_strictroute:1,
14c85021 ACM	52	srr_is_hit:1,
	53	is_changed:1,
	54	rr_needaddr:1,
	55	ts_needtime:1,
	56	ts_needaddr:1;
	57	unsigned char router_alert;
11a03f78	58	unsigned char cipso;
14c85021 ACM	59	unsigned char __pad2;
	60	unsigned char __data[0];
	61	};
	62
f6d8bd05 ED	63	struct ip_options_rcu {
	64	struct rcu_head rcu;
	65	struct ip_options opt;
	66	};
	67
	68	struct ip_options_data {
	69	struct ip_options_rcu opt;
	70	char data[40];
	71	};
14c85021 ACM	72
	73	struct inet_request_sock {
	74	struct request_sock req;
634fb979 ED	75	#define ir_loc_addr req.__req_common.skc_rcv_saddr
634fb979 ED	76	#define ir_rmt_addr req.__req_common.skc_daddr
b44084c2	77	#define ir_num req.__req_common.skc_num
634fb979 ED	78	#define ir_rmt_port req.__req_common.skc_dport
	79	#define ir_v6_rmt_addr req.__req_common.skc_v6_daddr
	80	#define ir_v6_loc_addr req.__req_common.skc_v6_rcv_saddr
	81	#define ir_iif req.__req_common.skc_bound_dev_if
33cf7c90 ED	82	#define ir_cookie req.__req_common.skc_cookie
33cf7c90 ED	83	#define ireq_net req.__req_common.skc_net
d34ac51b	84	#define ireq_state req.__req_common.skc_state
3f66b083	85	#define ireq_family req.__req_common.skc_family
634fb979	86
45e3ff82 VN	87	kmemcheck_bitfield_begin(flags);
	88	u16 snd_wscale : 4,
	89	rcv_wscale : 4,
14c85021 ACM	90	tstamp_ok : 1,
	91	sack_ok : 1,
	92	wscale_ok : 1,
	93	ecn_ok : 1,
88ef4a5a KK	94	acked : 1,
88ef4a5a KK	95	no_srccheck: 1;
45e3ff82	96	kmemcheck_bitfield_end(flags);
adc17d6a	97	u32 ir_mark;
476eab82 OP	98	union {
	99	struct ip_options_rcu *opt;
	100	struct sk_buff *pktopts;
	101	};
14c85021 ACM	102	};
	103
	104	static inline struct inet_request_sock inet_rsk(const struct request_sock sk)
	105	{
	106	return (struct inet_request_sock *)sk;
	107	}
	108
adc17d6a	109	static inline u32 inet_request_mark(const struct sock sk, struct sk_buff skb)
84f39b08	110	{
adc17d6a	111	if (!sk->sk_mark && sock_net(sk)->ipv4.sysctl_tcp_fwmark_accept)
84f39b08	112	return skb->mark;
adc17d6a ED	113
adc17d6a ED	114	return sk->sk_mark;
84f39b08 LC	115	}
84f39b08 LC	116
6dd9a14e DA	117	static inline int inet_request_bound_dev_if(const struct sock *sk,
	118	struct sk_buff *skb)
	119	{
	120	#ifdef CONFIG_NET_L3_MASTER_DEV
	121	struct net *net = sock_net(sk);
	122
	123	if (!sk->sk_bound_dev_if && net->ipv4.sysctl_tcp_l3mdev_accept)
	124	return l3mdev_master_ifindex_by_index(net, skb->skb_iif);
	125	#endif
	126
	127	return sk->sk_bound_dev_if;
	128	}
	129
1470ddf7 HX	130	struct inet_cork {
1470ddf7 HX	131	unsigned int flags;
bdc712b4	132	__be32 addr;
1470ddf7	133	struct ip_options *opt;
bdc712b4	134	unsigned int fragsize;
1470ddf7	135	int length; /* Total length of all frames */
5640f768	136	struct dst_entry *dst;
1470ddf7	137	u8 tx_flags;
aa661581 FF	138	__u8 ttl;
	139	__s16 tos;
	140	char priority;
1470ddf7 HX	141	};
1470ddf7 HX	142
bdc712b4 DM	143	struct inet_cork_full {
	144	struct inet_cork base;
	145	struct flowi fl;
	146	};
	147
14c85021 ACM	148	struct ip_mc_socklist;
	149	struct ipv6_pinfo;
	150	struct rtable;
	151
	152	/** struct inet_sock - representation of INET sockets
	153	*
	154	* @sk - ancestor class
	155	* @pinet6 - pointer to IPv6 control block
c720c7e8 ED	156	* @inet_daddr - Foreign IPv4 addr
	157	* @inet_rcv_saddr - Bound local IPv4 addr
	158	* @inet_dport - Destination port
	159	* @inet_num - Local port
	160	* @inet_saddr - Sending source
14c85021	161	* @uc_ttl - Unicast TTL
c720c7e8 ED	162	* @inet_sport - Source port
c720c7e8 ED	163	* @inet_id - ID counter for DF pkts
14c85021 ACM	164	* @tos - TOS
	165	* @mc_ttl - Multicasting TTL
	166	* @is_icsk - is this an inet_connection_sock?
76e21053	167	* @uc_index - Unicast outgoing device index
14c85021 ACM	168	* @mc_index - Multicast device index
	169	* @mc_list - Group array
	170	* @cork - info to build ip hdr on each ip frag while socket is corked
	171	*/
	172	struct inet_sock {
	173	/* sk and pinet6 has to be the first two members of inet_sock */
	174	struct sock sk;
dfd56b8b	175	#if IS_ENABLED(CONFIG_IPV6)
14c85021 ACM	176	struct ipv6_pinfo *pinet6;
	177	#endif
	178	/* Socket demultiplex comparisons on incoming packets. */
68835aba ED	179	#define inet_daddr sk.__sk_common.skc_daddr
68835aba ED	180	#define inet_rcv_saddr sk.__sk_common.skc_rcv_saddr
ce43b03e ED	181	#define inet_dport sk.__sk_common.skc_dport
ce43b03e ED	182	#define inet_num sk.__sk_common.skc_num
68835aba	183
c720c7e8	184	__be32 inet_saddr;
14c85021 ACM	185	__s16 uc_ttl;
14c85021 ACM	186	__u16 cmsg_flags;
c720c7e8 ED	187	__be16 inet_sport;
c720c7e8 ED	188	__u16 inet_id;
d218d111	189
f6d8bd05	190	struct ip_options_rcu __rcu *inet_opt;
ce43b03e	191	int rx_dst_ifindex;
14c85021	192	__u8 tos;
d218d111	193	__u8 min_ttl;
14c85021 ACM	194	__u8 mc_ttl;
	195	__u8 pmtudisc;
	196	__u8 recverr:1,
	197	is_icsk:1,
	198	freebind:1,
	199	hdrincl:1,
f5715aea	200	mc_loop:1,
f771bef9	201	transparent:1,
7b2ff18e JO	202	mc_all:1,
7b2ff18e JO	203	nodefrag:1;
90c337da	204	__u8 bind_address_no_port:1;
4c507d28	205	__u8 rcv_tos;
224d019c	206	__u8 convert_csum;
76e21053	207	int uc_index;
14c85021	208	int mc_index;
011a9261	209	__be32 mc_addr;
1d7138de	210	struct ip_mc_socklist __rcu *mc_list;
bdc712b4	211	struct inet_cork_full cork;
14c85021 ACM	212	};
	213
	214	#define IPCORK_OPT 1 /* ip-options has been held in ipcork.opt */
	215	#define IPCORK_ALLFRAG 2 /* always fragment (for ipv6 for now) */
	216
c44d13d6 TH	217	/* cmsg flags for inet */
	218	#define IP_CMSG_PKTINFO BIT(0)
	219	#define IP_CMSG_TTL BIT(1)
	220	#define IP_CMSG_TOS BIT(2)
	221	#define IP_CMSG_RECVOPTS BIT(3)
	222	#define IP_CMSG_RETOPTS BIT(4)
	223	#define IP_CMSG_PASSSEC BIT(5)
	224	#define IP_CMSG_ORIGDSTADDR BIT(6)
ad6f939a	225	#define IP_CMSG_CHECKSUM BIT(7)
c44d13d6	226
bd5eb35f ED	227	/**
	228	* sk_to_full_sk - Access to a full socket
	229	* @sk: pointer to a socket
	230	*
	231	* SYNACK messages might be attached to request sockets.
54abc686 ED	232	* Some places want to reach the listener in this case.
54abc686 ED	233	*/
bd5eb35f	234	static inline struct sock sk_to_full_sk(struct sock sk)
54abc686	235	{
bd5eb35f	236	#ifdef CONFIG_INET
54abc686 ED	237	if (sk && sk->sk_state == TCP_NEW_SYN_RECV)
54abc686 ED	238	sk = inet_reqsk(sk)->rsk_listener;
bd5eb35f ED	239	#endif
	240	return sk;
	241	}
	242
	243	/* sk_to_full_sk() variant with a const argument */
	244	static inline const struct sock sk_const_to_full_sk(const struct sock sk)
	245	{
	246	#ifdef CONFIG_INET
	247	if (sk && sk->sk_state == TCP_NEW_SYN_RECV)
	248	sk = ((const struct request_sock *)sk)->rsk_listener;
	249	#endif
54abc686 ED	250	return sk;
	251	}
	252
bd5eb35f ED	253	static inline struct sock skb_to_full_sk(const struct sk_buff skb)
	254	{
	255	return sk_to_full_sk(skb->sk);
	256	}
	257
14c85021 ACM	258	static inline struct inet_sock inet_sk(const struct sock sk)
	259	{
	260	return (struct inet_sock *)sk;
	261	}
	262
	263	static inline void __inet_sk_copy_descendant(struct sock *sk_to,
	264	const struct sock *sk_from,
	265	const int ancestor_size)
	266	{
	267	memcpy(inet_sk(sk_to) + 1, inet_sk(sk_from) + 1,
	268	sk_from->sk_prot->obj_size - ancestor_size);
	269	}
dfd56b8b	270	#if !(IS_ENABLED(CONFIG_IPV6))
14c85021 ACM	271	static inline void inet_sk_copy_descendant(struct sock *sk_to,
	272	const struct sock *sk_from)
	273	{
	274	__inet_sk_copy_descendant(sk_to, sk_from, sizeof(struct inet_sock));
	275	}
	276	#endif
	277
1fd51155	278	int inet_sk_rebuild_header(struct sock *sk);
14c85021	279
65cd8033 HFS	280	static inline unsigned int __inet_ehashfn(const __be32 laddr,
	281	const __u16 lport,
	282	const __be32 faddr,
	283	const __be16 fport,
	284	u32 initval)
14c85021	285	{
7adc3830 DM	286	return jhash_3words((__force __u32) laddr,
7adc3830 DM	287	(__force __u32) faddr,
b3da2cf3	288	((__u32) lport) << 16 \| (__force __u32)fport,
65cd8033	289	initval);
14c85021 ACM	290	}
14c85021 ACM	291
e49bb337	292	struct request_sock inet_reqsk_alloc(const struct request_sock_ops ops,
a1a5344d ED	293	struct sock *sk_listener,
a1a5344d ED	294	bool attach_listener);
ce4a7d0d	295
88ef4a5a KK	296	static inline __u8 inet_sk_flowi_flags(const struct sock *sk)
88ef4a5a KK	297	{
a4daad6b DM	298	__u8 flags = 0;
a4daad6b DM	299
47670b76	300	if (inet_sk(sk)->transparent \|\| inet_sk(sk)->hdrincl)
a4daad6b	301	flags \|= FLOWI_FLAG_ANYSRC;
a4daad6b	302	return flags;
88ef4a5a KK	303	}
88ef4a5a KK	304
224d019c TH	305	static inline void inet_inc_convert_csum(struct sock *sk)
	306	{
	307	inet_sk(sk)->convert_csum++;
	308	}
	309
	310	static inline void inet_dec_convert_csum(struct sock *sk)
	311	{
	312	if (inet_sk(sk)->convert_csum > 0)
	313	inet_sk(sk)->convert_csum--;
	314	}
	315
	316	static inline bool inet_get_convert_csum(struct sock *sk)
	317	{
	318	return !!inet_sk(sk)->convert_csum;
	319	}
	320
14c85021	321	#endif /* _INET_SOCK_H */