xref: /openbmc/linux/include/net/inet_sock.h (revision b627b4ed)
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 
19 
20 #include <linux/string.h>
21 #include <linux/types.h>
22 #include <linux/jhash.h>
23 
24 #include <net/flow.h>
25 #include <net/sock.h>
26 #include <net/request_sock.h>
27 #include <net/netns/hash.h>
28 
29 /** struct ip_options - IP Options
30  *
31  * @faddr - Saved first hop address
32  * @is_data - Options in __data, rather than skb
33  * @is_strictroute - Strict source route
34  * @srr_is_hit - Packet destination addr was our one
35  * @is_changed - IP checksum more not valid
36  * @rr_needaddr - Need to record addr of outgoing dev
37  * @ts_needtime - Need to record timestamp
38  * @ts_needaddr - Need to record addr of outgoing dev
39  */
40 struct ip_options {
41 	__be32		faddr;
42 	unsigned char	optlen;
43 	unsigned char	srr;
44 	unsigned char	rr;
45 	unsigned char	ts;
46 	unsigned char	is_strictroute:1,
47 			srr_is_hit:1,
48 			is_changed:1,
49 			rr_needaddr:1,
50 			ts_needtime:1,
51 			ts_needaddr:1;
52 	unsigned char	router_alert;
53 	unsigned char	cipso;
54 	unsigned char	__pad2;
55 	unsigned char	__data[0];
56 };
57 
58 #define optlength(opt) (sizeof(struct ip_options) + opt->optlen)
59 
60 struct inet_request_sock {
61 	struct request_sock	req;
62 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
63 	u16			inet6_rsk_offset;
64 #endif
65 	__be16			loc_port;
66 	__be32			loc_addr;
67 	__be32			rmt_addr;
68 	__be16			rmt_port;
69 	u16			snd_wscale : 4,
70 				rcv_wscale : 4,
71 				tstamp_ok  : 1,
72 				sack_ok	   : 1,
73 				wscale_ok  : 1,
74 				ecn_ok	   : 1,
75 				acked	   : 1,
76 				no_srccheck: 1;
77 	struct ip_options	*opt;
78 };
79 
80 static inline struct inet_request_sock *inet_rsk(const struct request_sock *sk)
81 {
82 	return (struct inet_request_sock *)sk;
83 }
84 
85 struct ip_mc_socklist;
86 struct ipv6_pinfo;
87 struct rtable;
88 
89 /** struct inet_sock - representation of INET sockets
90  *
91  * @sk - ancestor class
92  * @pinet6 - pointer to IPv6 control block
93  * @daddr - Foreign IPv4 addr
94  * @rcv_saddr - Bound local IPv4 addr
95  * @dport - Destination port
96  * @num - Local port
97  * @saddr - Sending source
98  * @uc_ttl - Unicast TTL
99  * @sport - Source port
100  * @id - ID counter for DF pkts
101  * @tos - TOS
102  * @mc_ttl - Multicasting TTL
103  * @is_icsk - is this an inet_connection_sock?
104  * @mc_index - Multicast device index
105  * @mc_list - Group array
106  * @cork - info to build ip hdr on each ip frag while socket is corked
107  */
108 struct inet_sock {
109 	/* sk and pinet6 has to be the first two members of inet_sock */
110 	struct sock		sk;
111 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
112 	struct ipv6_pinfo	*pinet6;
113 #endif
114 	/* Socket demultiplex comparisons on incoming packets. */
115 	__be32			daddr;
116 	__be32			rcv_saddr;
117 	__be16			dport;
118 	__u16			num;
119 	__be32			saddr;
120 	__s16			uc_ttl;
121 	__u16			cmsg_flags;
122 	struct ip_options	*opt;
123 	__be16			sport;
124 	__u16			id;
125 	__u8			tos;
126 	__u8			mc_ttl;
127 	__u8			pmtudisc;
128 	__u8			recverr:1,
129 				is_icsk:1,
130 				freebind:1,
131 				hdrincl:1,
132 				mc_loop:1,
133 				transparent:1;
134 	int			mc_index;
135 	__be32			mc_addr;
136 	struct ip_mc_socklist	*mc_list;
137 	struct {
138 		unsigned int		flags;
139 		unsigned int		fragsize;
140 		struct ip_options	*opt;
141 		struct dst_entry	*dst;
142 		int			length; /* Total length of all frames */
143 		__be32			addr;
144 		struct flowi		fl;
145 	} cork;
146 };
147 
148 #define IPCORK_OPT	1	/* ip-options has been held in ipcork.opt */
149 #define IPCORK_ALLFRAG	2	/* always fragment (for ipv6 for now) */
150 
151 static inline struct inet_sock *inet_sk(const struct sock *sk)
152 {
153 	return (struct inet_sock *)sk;
154 }
155 
156 static inline void __inet_sk_copy_descendant(struct sock *sk_to,
157 					     const struct sock *sk_from,
158 					     const int ancestor_size)
159 {
160 	memcpy(inet_sk(sk_to) + 1, inet_sk(sk_from) + 1,
161 	       sk_from->sk_prot->obj_size - ancestor_size);
162 }
163 #if !(defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE))
164 static inline void inet_sk_copy_descendant(struct sock *sk_to,
165 					   const struct sock *sk_from)
166 {
167 	__inet_sk_copy_descendant(sk_to, sk_from, sizeof(struct inet_sock));
168 }
169 #endif
170 
171 extern int inet_sk_rebuild_header(struct sock *sk);
172 
173 extern u32 inet_ehash_secret;
174 extern void build_ehash_secret(void);
175 
176 static inline unsigned int inet_ehashfn(struct net *net,
177 					const __be32 laddr, const __u16 lport,
178 					const __be32 faddr, const __be16 fport)
179 {
180 	return jhash_3words((__force __u32) laddr,
181 			    (__force __u32) faddr,
182 			    ((__u32) lport) << 16 | (__force __u32)fport,
183 			    inet_ehash_secret + net_hash_mix(net));
184 }
185 
186 static inline int inet_sk_ehashfn(const struct sock *sk)
187 {
188 	const struct inet_sock *inet = inet_sk(sk);
189 	const __be32 laddr = inet->rcv_saddr;
190 	const __u16 lport = inet->num;
191 	const __be32 faddr = inet->daddr;
192 	const __be16 fport = inet->dport;
193 	struct net *net = sock_net(sk);
194 
195 	return inet_ehashfn(net, laddr, lport, faddr, fport);
196 }
197 
198 static inline struct request_sock *inet_reqsk_alloc(struct request_sock_ops *ops)
199 {
200 	struct request_sock *req = reqsk_alloc(ops);
201 
202 	if (req != NULL)
203 		inet_rsk(req)->opt = NULL;
204 
205 	return req;
206 }
207 
208 static inline __u8 inet_sk_flowi_flags(const struct sock *sk)
209 {
210 	return inet_sk(sk)->transparent ? FLOWI_FLAG_ANYSRC : 0;
211 }
212 
213 #endif	/* _INET_SOCK_H */
214