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 #include <linux/bitops.h>
20 #include <linux/kmemcheck.h>
21 #include <linux/string.h>
22 #include <linux/types.h>
23 #include <linux/jhash.h>
24 #include <linux/netdevice.h>
25
26 #include <net/flow.h>
27 #include <net/sock.h>
28 #include <net/request_sock.h>
29 #include <net/netns/hash.h>
30 #include <net/tcp_states.h>
31 #include <net/l3mdev.h>
32
33 /** struct ip_options - IP Options
34 *
35 * @faddr - Saved first hop address
36 * @nexthop - Saved nexthop address in LSRR and SSRR
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 {
45 __be32 faddr;
46 __be32 nexthop;
47 unsigned char optlen;
48 unsigned char srr;
49 unsigned char rr;
50 unsigned char ts;
51 unsigned char is_strictroute:1,
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;
58 unsigned char cipso;
59 unsigned char __pad2;
60 unsigned char __data[0];
61 };
62
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 };
72
73 struct inet_request_sock {
74 struct request_sock req;
75 #define ir_loc_addr req.__req_common.skc_rcv_saddr
76 #define ir_rmt_addr req.__req_common.skc_daddr
77 #define ir_num req.__req_common.skc_num
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
82 #define ir_cookie req.__req_common.skc_cookie
83 #define ireq_net req.__req_common.skc_net
84 #define ireq_state req.__req_common.skc_state
85 #define ireq_family req.__req_common.skc_family
86
87 kmemcheck_bitfield_begin(flags);
88 u16 snd_wscale : 4,
89 rcv_wscale : 4,
90 tstamp_ok : 1,
91 sack_ok : 1,
92 wscale_ok : 1,
93 ecn_ok : 1,
94 acked : 1,
95 no_srccheck: 1;
96 kmemcheck_bitfield_end(flags);
97 u32 ir_mark;
98 union {
99 struct ip_options_rcu __rcu *ireq_opt;
100 #if IS_ENABLED(CONFIG_IPV6)
101 struct {
102 struct ipv6_txoptions *ipv6_opt;
103 struct sk_buff *pktopts;
104 };
105 #endif
106 };
107 };
108
inet_rsk(const struct request_sock * sk)109 static inline struct inet_request_sock *inet_rsk(const struct request_sock *sk)
110 {
111 return (struct inet_request_sock *)sk;
112 }
113
inet_request_mark(const struct sock * sk,struct sk_buff * skb)114 static inline u32 inet_request_mark(const struct sock *sk, struct sk_buff *skb)
115 {
116 if (!sk->sk_mark && sock_net(sk)->ipv4.sysctl_tcp_fwmark_accept)
117 return skb->mark;
118
119 return sk->sk_mark;
120 }
121
inet_request_bound_dev_if(const struct sock * sk,struct sk_buff * skb)122 static inline int inet_request_bound_dev_if(const struct sock *sk,
123 struct sk_buff *skb)
124 {
125 #ifdef CONFIG_NET_L3_MASTER_DEV
126 struct net *net = sock_net(sk);
127
128 if (!sk->sk_bound_dev_if && net->ipv4.sysctl_tcp_l3mdev_accept)
129 return l3mdev_master_ifindex_by_index(net, skb->skb_iif);
130 #endif
131
132 return sk->sk_bound_dev_if;
133 }
134
ireq_opt_deref(const struct inet_request_sock * ireq)135 static inline struct ip_options_rcu *ireq_opt_deref(const struct inet_request_sock *ireq)
136 {
137 return rcu_dereference_check(ireq->ireq_opt,
138 atomic_read(&ireq->req.rsk_refcnt) > 0);
139 }
140
141 struct inet_cork {
142 unsigned int flags;
143 __be32 addr;
144 struct ip_options *opt;
145 unsigned int fragsize;
146 int length; /* Total length of all frames */
147 struct dst_entry *dst;
148 u8 tx_flags;
149 __u8 ttl;
150 __s16 tos;
151 char priority;
152 };
153
154 struct inet_cork_full {
155 struct inet_cork base;
156 struct flowi fl;
157 };
158
159 struct ip_mc_socklist;
160 struct ipv6_pinfo;
161 struct rtable;
162
163 /** struct inet_sock - representation of INET sockets
164 *
165 * @sk - ancestor class
166 * @pinet6 - pointer to IPv6 control block
167 * @inet_daddr - Foreign IPv4 addr
168 * @inet_rcv_saddr - Bound local IPv4 addr
169 * @inet_dport - Destination port
170 * @inet_num - Local port
171 * @inet_saddr - Sending source
172 * @uc_ttl - Unicast TTL
173 * @inet_sport - Source port
174 * @inet_id - ID counter for DF pkts
175 * @tos - TOS
176 * @mc_ttl - Multicasting TTL
177 * @is_icsk - is this an inet_connection_sock?
178 * @uc_index - Unicast outgoing device index
179 * @mc_index - Multicast device index
180 * @mc_list - Group array
181 * @cork - info to build ip hdr on each ip frag while socket is corked
182 */
183 struct inet_sock {
184 /* sk and pinet6 has to be the first two members of inet_sock */
185 struct sock sk;
186 #if IS_ENABLED(CONFIG_IPV6)
187 struct ipv6_pinfo *pinet6;
188 #endif
189 /* Socket demultiplex comparisons on incoming packets. */
190 #define inet_daddr sk.__sk_common.skc_daddr
191 #define inet_rcv_saddr sk.__sk_common.skc_rcv_saddr
192 #define inet_dport sk.__sk_common.skc_dport
193 #define inet_num sk.__sk_common.skc_num
194
195 __be32 inet_saddr;
196 __s16 uc_ttl;
197 __u16 cmsg_flags;
198 __be16 inet_sport;
199 __u16 inet_id;
200
201 struct ip_options_rcu __rcu *inet_opt;
202 int rx_dst_ifindex;
203 __u8 tos;
204 __u8 min_ttl;
205 __u8 mc_ttl;
206 __u8 pmtudisc;
207 __u8 recverr:1,
208 is_icsk:1,
209 freebind:1,
210 hdrincl:1,
211 mc_loop:1,
212 transparent:1,
213 mc_all:1,
214 nodefrag:1;
215 __u8 bind_address_no_port:1,
216 defer_connect:1; /* Indicates that fastopen_connect is set
217 * and cookie exists so we defer connect
218 * until first data frame is written
219 */
220 __u8 rcv_tos;
221 __u8 convert_csum;
222 int uc_index;
223 int mc_index;
224 __be32 mc_addr;
225 struct ip_mc_socklist __rcu *mc_list;
226 struct inet_cork_full cork;
227 };
228
229 #define IPCORK_OPT 1 /* ip-options has been held in ipcork.opt */
230 #define IPCORK_ALLFRAG 2 /* always fragment (for ipv6 for now) */
231
232 /* cmsg flags for inet */
233 #define IP_CMSG_PKTINFO BIT(0)
234 #define IP_CMSG_TTL BIT(1)
235 #define IP_CMSG_TOS BIT(2)
236 #define IP_CMSG_RECVOPTS BIT(3)
237 #define IP_CMSG_RETOPTS BIT(4)
238 #define IP_CMSG_PASSSEC BIT(5)
239 #define IP_CMSG_ORIGDSTADDR BIT(6)
240 #define IP_CMSG_CHECKSUM BIT(7)
241
242 /**
243 * sk_to_full_sk - Access to a full socket
244 * @sk: pointer to a socket
245 *
246 * SYNACK messages might be attached to request sockets.
247 * Some places want to reach the listener in this case.
248 */
sk_to_full_sk(struct sock * sk)249 static inline struct sock *sk_to_full_sk(struct sock *sk)
250 {
251 #ifdef CONFIG_INET
252 if (sk && sk->sk_state == TCP_NEW_SYN_RECV)
253 sk = inet_reqsk(sk)->rsk_listener;
254 #endif
255 return sk;
256 }
257
258 /* sk_to_full_sk() variant with a const argument */
sk_const_to_full_sk(const struct sock * sk)259 static inline const struct sock *sk_const_to_full_sk(const struct sock *sk)
260 {
261 #ifdef CONFIG_INET
262 if (sk && sk->sk_state == TCP_NEW_SYN_RECV)
263 sk = ((const struct request_sock *)sk)->rsk_listener;
264 #endif
265 return sk;
266 }
267
skb_to_full_sk(const struct sk_buff * skb)268 static inline struct sock *skb_to_full_sk(const struct sk_buff *skb)
269 {
270 return sk_to_full_sk(skb->sk);
271 }
272
inet_sk(const struct sock * sk)273 static inline struct inet_sock *inet_sk(const struct sock *sk)
274 {
275 return (struct inet_sock *)sk;
276 }
277
__inet_sk_copy_descendant(struct sock * sk_to,const struct sock * sk_from,const int ancestor_size)278 static inline void __inet_sk_copy_descendant(struct sock *sk_to,
279 const struct sock *sk_from,
280 const int ancestor_size)
281 {
282 memcpy(inet_sk(sk_to) + 1, inet_sk(sk_from) + 1,
283 sk_from->sk_prot->obj_size - ancestor_size);
284 }
285 #if !(IS_ENABLED(CONFIG_IPV6))
inet_sk_copy_descendant(struct sock * sk_to,const struct sock * sk_from)286 static inline void inet_sk_copy_descendant(struct sock *sk_to,
287 const struct sock *sk_from)
288 {
289 __inet_sk_copy_descendant(sk_to, sk_from, sizeof(struct inet_sock));
290 }
291 #endif
292
293 int inet_sk_rebuild_header(struct sock *sk);
294
__inet_ehashfn(const __be32 laddr,const __u16 lport,const __be32 faddr,const __be16 fport,u32 initval)295 static inline unsigned int __inet_ehashfn(const __be32 laddr,
296 const __u16 lport,
297 const __be32 faddr,
298 const __be16 fport,
299 u32 initval)
300 {
301 return jhash_3words((__force __u32) laddr,
302 (__force __u32) faddr,
303 ((__u32) lport) << 16 | (__force __u32)fport,
304 initval);
305 }
306
307 struct request_sock *inet_reqsk_alloc(const struct request_sock_ops *ops,
308 struct sock *sk_listener,
309 bool attach_listener);
310
inet_sk_flowi_flags(const struct sock * sk)311 static inline __u8 inet_sk_flowi_flags(const struct sock *sk)
312 {
313 __u8 flags = 0;
314
315 if (inet_sk(sk)->transparent || inet_sk(sk)->hdrincl)
316 flags |= FLOWI_FLAG_ANYSRC;
317 return flags;
318 }
319
inet_inc_convert_csum(struct sock * sk)320 static inline void inet_inc_convert_csum(struct sock *sk)
321 {
322 inet_sk(sk)->convert_csum++;
323 }
324
inet_dec_convert_csum(struct sock * sk)325 static inline void inet_dec_convert_csum(struct sock *sk)
326 {
327 if (inet_sk(sk)->convert_csum > 0)
328 inet_sk(sk)->convert_csum--;
329 }
330
inet_get_convert_csum(struct sock * sk)331 static inline bool inet_get_convert_csum(struct sock *sk)
332 {
333 return !!inet_sk(sk)->convert_csum;
334 }
335
336 #endif /* _INET_SOCK_H */
337