1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * INET An implementation of the TCP/IP protocol suite for the LINUX
4 * operating system. INET is implemented using the BSD Socket
5 * interface as the means of communication with the user level.
7 * Definitions for inet_sock
9 * Authors: Many, reorganised here by
10 * Arnaldo Carvalho de Melo <acme@mandriva.com>
15 #include <linux/bitops.h>
16 #include <linux/string.h>
17 #include <linux/types.h>
18 #include <linux/jhash.h>
19 #include <linux/netdevice.h>
23 #include <net/request_sock.h>
24 #include <net/netns/hash.h>
25 #include <net/tcp_states.h>
26 #include <net/l3mdev.h>
28 /** struct ip_options - IP Options
30 * @faddr - Saved first hop address
31 * @nexthop - Saved nexthop address in LSRR and SSRR
32 * @is_strictroute - Strict source route
33 * @srr_is_hit - Packet destination addr was our one
34 * @is_changed - IP checksum more not valid
35 * @rr_needaddr - Need to record addr of outgoing dev
36 * @ts_needtime - Need to record timestamp
37 * @ts_needaddr - Need to record addr of outgoing dev
46 unsigned char is_strictroute:1,
52 unsigned char router_alert;
55 unsigned char __data[];
58 struct ip_options_rcu {
60 struct ip_options opt;
63 struct ip_options_data {
64 struct ip_options_rcu opt;
68 struct inet_request_sock {
69 struct request_sock req;
70 #define ir_loc_addr req.__req_common.skc_rcv_saddr
71 #define ir_rmt_addr req.__req_common.skc_daddr
72 #define ir_num req.__req_common.skc_num
73 #define ir_rmt_port req.__req_common.skc_dport
74 #define ir_v6_rmt_addr req.__req_common.skc_v6_daddr
75 #define ir_v6_loc_addr req.__req_common.skc_v6_rcv_saddr
76 #define ir_iif req.__req_common.skc_bound_dev_if
77 #define ir_cookie req.__req_common.skc_cookie
78 #define ireq_net req.__req_common.skc_net
79 #define ireq_state req.__req_common.skc_state
80 #define ireq_family req.__req_common.skc_family
93 struct ip_options_rcu __rcu *ireq_opt;
94 #if IS_ENABLED(CONFIG_IPV6)
96 struct ipv6_txoptions *ipv6_opt;
97 struct sk_buff *pktopts;
103 static inline struct inet_request_sock *inet_rsk(const struct request_sock *sk)
105 return (struct inet_request_sock *)sk;
108 static inline u32 inet_request_mark(const struct sock *sk, struct sk_buff *skb)
110 if (!sk->sk_mark && sock_net(sk)->ipv4.sysctl_tcp_fwmark_accept)
116 static inline int inet_request_bound_dev_if(const struct sock *sk,
119 int bound_dev_if = READ_ONCE(sk->sk_bound_dev_if);
120 #ifdef CONFIG_NET_L3_MASTER_DEV
121 struct net *net = sock_net(sk);
123 if (!bound_dev_if && net->ipv4.sysctl_tcp_l3mdev_accept)
124 return l3mdev_master_ifindex_by_index(net, skb->skb_iif);
130 static inline int inet_sk_bound_l3mdev(const struct sock *sk)
132 #ifdef CONFIG_NET_L3_MASTER_DEV
133 struct net *net = sock_net(sk);
135 if (!net->ipv4.sysctl_tcp_l3mdev_accept)
136 return l3mdev_master_ifindex_by_index(net,
137 sk->sk_bound_dev_if);
143 static inline bool inet_bound_dev_eq(bool l3mdev_accept, int bound_dev_if,
147 return !sdif || l3mdev_accept;
148 return bound_dev_if == dif || bound_dev_if == sdif;
154 struct ip_options *opt;
155 unsigned int fragsize;
156 int length; /* Total length of all frames */
157 struct dst_entry *dst;
167 struct inet_cork_full {
168 struct inet_cork base;
172 struct ip_mc_socklist;
176 /** struct inet_sock - representation of INET sockets
178 * @sk - ancestor class
179 * @pinet6 - pointer to IPv6 control block
180 * @inet_daddr - Foreign IPv4 addr
181 * @inet_rcv_saddr - Bound local IPv4 addr
182 * @inet_dport - Destination port
183 * @inet_num - Local port
184 * @inet_saddr - Sending source
185 * @uc_ttl - Unicast TTL
186 * @inet_sport - Source port
187 * @inet_id - ID counter for DF pkts
189 * @mc_ttl - Multicasting TTL
190 * @is_icsk - is this an inet_connection_sock?
191 * @uc_index - Unicast outgoing device index
192 * @mc_index - Multicast device index
193 * @mc_list - Group array
194 * @cork - info to build ip hdr on each ip frag while socket is corked
197 /* sk and pinet6 has to be the first two members of inet_sock */
199 #if IS_ENABLED(CONFIG_IPV6)
200 struct ipv6_pinfo *pinet6;
202 /* Socket demultiplex comparisons on incoming packets. */
203 #define inet_daddr sk.__sk_common.skc_daddr
204 #define inet_rcv_saddr sk.__sk_common.skc_rcv_saddr
205 #define inet_dport sk.__sk_common.skc_dport
206 #define inet_num sk.__sk_common.skc_num
211 struct ip_options_rcu __rcu *inet_opt;
227 __u8 bind_address_no_port:1,
229 defer_connect:1; /* Indicates that fastopen_connect is set
230 * and cookie exists so we defer connect
231 * until first data frame is written
238 struct ip_mc_socklist __rcu *mc_list;
239 struct inet_cork_full cork;
242 #define IPCORK_OPT 1 /* ip-options has been held in ipcork.opt */
243 #define IPCORK_ALLFRAG 2 /* always fragment (for ipv6 for now) */
245 /* cmsg flags for inet */
246 #define IP_CMSG_PKTINFO BIT(0)
247 #define IP_CMSG_TTL BIT(1)
248 #define IP_CMSG_TOS BIT(2)
249 #define IP_CMSG_RECVOPTS BIT(3)
250 #define IP_CMSG_RETOPTS BIT(4)
251 #define IP_CMSG_PASSSEC BIT(5)
252 #define IP_CMSG_ORIGDSTADDR BIT(6)
253 #define IP_CMSG_CHECKSUM BIT(7)
254 #define IP_CMSG_RECVFRAGSIZE BIT(8)
256 static inline bool sk_is_inet(struct sock *sk)
258 return sk->sk_family == AF_INET || sk->sk_family == AF_INET6;
262 * sk_to_full_sk - Access to a full socket
263 * @sk: pointer to a socket
265 * SYNACK messages might be attached to request sockets.
266 * Some places want to reach the listener in this case.
268 static inline struct sock *sk_to_full_sk(struct sock *sk)
271 if (sk && sk->sk_state == TCP_NEW_SYN_RECV)
272 sk = inet_reqsk(sk)->rsk_listener;
277 /* sk_to_full_sk() variant with a const argument */
278 static inline const struct sock *sk_const_to_full_sk(const struct sock *sk)
281 if (sk && sk->sk_state == TCP_NEW_SYN_RECV)
282 sk = ((const struct request_sock *)sk)->rsk_listener;
287 static inline struct sock *skb_to_full_sk(const struct sk_buff *skb)
289 return sk_to_full_sk(skb->sk);
292 static inline struct inet_sock *inet_sk(const struct sock *sk)
294 return (struct inet_sock *)sk;
297 static inline void __inet_sk_copy_descendant(struct sock *sk_to,
298 const struct sock *sk_from,
299 const int ancestor_size)
301 memcpy(inet_sk(sk_to) + 1, inet_sk(sk_from) + 1,
302 sk_from->sk_prot->obj_size - ancestor_size);
305 int inet_sk_rebuild_header(struct sock *sk);
308 * inet_sk_state_load - read sk->sk_state for lockless contexts
309 * @sk: socket pointer
311 * Paired with inet_sk_state_store(). Used in places we don't hold socket lock:
312 * tcp_diag_get_info(), tcp_get_info(), tcp_poll(), get_tcp4_sock() ...
314 static inline int inet_sk_state_load(const struct sock *sk)
316 /* state change might impact lockless readers. */
317 return smp_load_acquire(&sk->sk_state);
321 * inet_sk_state_store - update sk->sk_state
322 * @sk: socket pointer
323 * @newstate: new state
325 * Paired with inet_sk_state_load(). Should be used in contexts where
326 * state change might impact lockless readers.
328 void inet_sk_state_store(struct sock *sk, int newstate);
330 void inet_sk_set_state(struct sock *sk, int state);
332 static inline unsigned int __inet_ehashfn(const __be32 laddr,
338 return jhash_3words((__force __u32) laddr,
339 (__force __u32) faddr,
340 ((__u32) lport) << 16 | (__force __u32)fport,
344 struct request_sock *inet_reqsk_alloc(const struct request_sock_ops *ops,
345 struct sock *sk_listener,
346 bool attach_listener);
348 static inline __u8 inet_sk_flowi_flags(const struct sock *sk)
352 if (inet_sk(sk)->transparent || inet_sk(sk)->hdrincl)
353 flags |= FLOWI_FLAG_ANYSRC;
357 static inline void inet_inc_convert_csum(struct sock *sk)
359 inet_sk(sk)->convert_csum++;
362 static inline void inet_dec_convert_csum(struct sock *sk)
364 if (inet_sk(sk)->convert_csum > 0)
365 inet_sk(sk)->convert_csum--;
368 static inline bool inet_get_convert_csum(struct sock *sk)
370 return !!inet_sk(sk)->convert_csum;
374 static inline bool inet_can_nonlocal_bind(struct net *net,
375 struct inet_sock *inet)
377 return net->ipv4.sysctl_ip_nonlocal_bind ||
378 inet->freebind || inet->transparent;
381 static inline bool inet_addr_valid_or_nonlocal(struct net *net,
382 struct inet_sock *inet,
386 return inet_can_nonlocal_bind(net, inet) ||
387 addr == htonl(INADDR_ANY) ||
388 addr_type == RTN_LOCAL ||
389 addr_type == RTN_MULTICAST ||
390 addr_type == RTN_BROADCAST;
393 #endif /* _INET_SOCK_H */