]> git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blame - include/net/inet_sock.h
Merge tag 'nfs-for-5.2-2' of git://git.linux-nfs.org/projects/anna/linux-nfs
[mirror_ubuntu-eoan-kernel.git] / include / net / inet_sock.h
CommitLineData
2874c5fd 1/* SPDX-License-Identifier: GPL-2.0-or-later */
14c85021
ACM
2/*
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.
6 *
7 * Definitions for inet_sock
8 *
9 * Authors: Many, reorganised here by
10 * Arnaldo Carvalho de Melo <acme@mandriva.com>
14c85021
ACM
11 */
12#ifndef _INET_SOCK_H
13#define _INET_SOCK_H
14
c44d13d6 15#include <linux/bitops.h>
14c85021
ACM
16#include <linux/string.h>
17#include <linux/types.h>
b3da2cf3 18#include <linux/jhash.h>
fec5e652 19#include <linux/netdevice.h>
14c85021
ACM
20
21#include <net/flow.h>
22#include <net/sock.h>
23#include <net/request_sock.h>
0b441916 24#include <net/netns/hash.h>
d34ac51b 25#include <net/tcp_states.h>
6dd9a14e 26#include <net/l3mdev.h>
14c85021
ACM
27
28/** struct ip_options - IP Options
29 *
30 * @faddr - Saved first hop address
ac8a4810 31 * @nexthop - Saved nexthop address in LSRR and SSRR
14c85021
ACM
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
38 */
39struct ip_options {
3ca3c68e 40 __be32 faddr;
ac8a4810 41 __be32 nexthop;
14c85021
ACM
42 unsigned char optlen;
43 unsigned char srr;
44 unsigned char rr;
45 unsigned char ts;
ef722495 46 unsigned char is_strictroute:1,
14c85021
ACM
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;
11a03f78 53 unsigned char cipso;
14c85021
ACM
54 unsigned char __pad2;
55 unsigned char __data[0];
56};
57
f6d8bd05
ED
58struct ip_options_rcu {
59 struct rcu_head rcu;
60 struct ip_options opt;
61};
62
63struct ip_options_data {
64 struct ip_options_rcu opt;
65 char data[40];
66};
14c85021
ACM
67
68struct inet_request_sock {
69 struct request_sock req;
634fb979
ED
70#define ir_loc_addr req.__req_common.skc_rcv_saddr
71#define ir_rmt_addr req.__req_common.skc_daddr
b44084c2 72#define ir_num req.__req_common.skc_num
634fb979
ED
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
33cf7c90
ED
77#define ir_cookie req.__req_common.skc_cookie
78#define ireq_net req.__req_common.skc_net
d34ac51b 79#define ireq_state req.__req_common.skc_state
3f66b083 80#define ireq_family req.__req_common.skc_family
634fb979 81
45e3ff82
VN
82 u16 snd_wscale : 4,
83 rcv_wscale : 4,
14c85021
ACM
84 tstamp_ok : 1,
85 sack_ok : 1,
86 wscale_ok : 1,
87 ecn_ok : 1,
88ef4a5a 88 acked : 1,
60e2a778
UB
89 no_srccheck: 1,
90 smc_ok : 1;
adc17d6a 91 u32 ir_mark;
476eab82 92 union {
c92e8c02 93 struct ip_options_rcu __rcu *ireq_opt;
56ac42bc
HD
94#if IS_ENABLED(CONFIG_IPV6)
95 struct {
96 struct ipv6_txoptions *ipv6_opt;
97 struct sk_buff *pktopts;
98 };
99#endif
476eab82 100 };
14c85021
ACM
101};
102
103static inline struct inet_request_sock *inet_rsk(const struct request_sock *sk)
104{
105 return (struct inet_request_sock *)sk;
106}
107
adc17d6a 108static inline u32 inet_request_mark(const struct sock *sk, struct sk_buff *skb)
84f39b08 109{
adc17d6a 110 if (!sk->sk_mark && sock_net(sk)->ipv4.sysctl_tcp_fwmark_accept)
84f39b08 111 return skb->mark;
adc17d6a
ED
112
113 return sk->sk_mark;
84f39b08
LC
114}
115
6dd9a14e
DA
116static inline int inet_request_bound_dev_if(const struct sock *sk,
117 struct sk_buff *skb)
118{
119#ifdef CONFIG_NET_L3_MASTER_DEV
120 struct net *net = sock_net(sk);
121
122 if (!sk->sk_bound_dev_if && net->ipv4.sysctl_tcp_l3mdev_accept)
123 return l3mdev_master_ifindex_by_index(net, skb->skb_iif);
124#endif
125
126 return sk->sk_bound_dev_if;
127}
128
3c82a21f
RS
129static inline int inet_sk_bound_l3mdev(const struct sock *sk)
130{
131#ifdef CONFIG_NET_L3_MASTER_DEV
132 struct net *net = sock_net(sk);
133
134 if (!net->ipv4.sysctl_tcp_l3mdev_accept)
135 return l3mdev_master_ifindex_by_index(net,
136 sk->sk_bound_dev_if);
137#endif
138
139 return 0;
140}
141
e7819058
MM
142static inline bool inet_bound_dev_eq(bool l3mdev_accept, int bound_dev_if,
143 int dif, int sdif)
144{
145 if (!bound_dev_if)
146 return !sdif || l3mdev_accept;
147 return bound_dev_if == dif || bound_dev_if == sdif;
148}
149
1470ddf7
HX
150struct inet_cork {
151 unsigned int flags;
bdc712b4 152 __be32 addr;
1470ddf7 153 struct ip_options *opt;
bdc712b4 154 unsigned int fragsize;
1470ddf7 155 int length; /* Total length of all frames */
5640f768 156 struct dst_entry *dst;
1470ddf7 157 u8 tx_flags;
aa661581
FF
158 __u8 ttl;
159 __s16 tos;
160 char priority;
bec1f6f6 161 __u16 gso_size;
bc969a97 162 u64 transmit_time;
1470ddf7
HX
163};
164
bdc712b4
DM
165struct inet_cork_full {
166 struct inet_cork base;
167 struct flowi fl;
168};
169
14c85021
ACM
170struct ip_mc_socklist;
171struct ipv6_pinfo;
172struct rtable;
173
174/** struct inet_sock - representation of INET sockets
175 *
176 * @sk - ancestor class
177 * @pinet6 - pointer to IPv6 control block
c720c7e8
ED
178 * @inet_daddr - Foreign IPv4 addr
179 * @inet_rcv_saddr - Bound local IPv4 addr
180 * @inet_dport - Destination port
181 * @inet_num - Local port
182 * @inet_saddr - Sending source
14c85021 183 * @uc_ttl - Unicast TTL
c720c7e8
ED
184 * @inet_sport - Source port
185 * @inet_id - ID counter for DF pkts
14c85021
ACM
186 * @tos - TOS
187 * @mc_ttl - Multicasting TTL
188 * @is_icsk - is this an inet_connection_sock?
76e21053 189 * @uc_index - Unicast outgoing device index
14c85021
ACM
190 * @mc_index - Multicast device index
191 * @mc_list - Group array
192 * @cork - info to build ip hdr on each ip frag while socket is corked
193 */
194struct inet_sock {
195 /* sk and pinet6 has to be the first two members of inet_sock */
196 struct sock sk;
dfd56b8b 197#if IS_ENABLED(CONFIG_IPV6)
14c85021
ACM
198 struct ipv6_pinfo *pinet6;
199#endif
200 /* Socket demultiplex comparisons on incoming packets. */
68835aba
ED
201#define inet_daddr sk.__sk_common.skc_daddr
202#define inet_rcv_saddr sk.__sk_common.skc_rcv_saddr
ce43b03e
ED
203#define inet_dport sk.__sk_common.skc_dport
204#define inet_num sk.__sk_common.skc_num
68835aba 205
c720c7e8 206 __be32 inet_saddr;
14c85021
ACM
207 __s16 uc_ttl;
208 __u16 cmsg_flags;
c720c7e8
ED
209 __be16 inet_sport;
210 __u16 inet_id;
d218d111 211
f6d8bd05 212 struct ip_options_rcu __rcu *inet_opt;
ce43b03e 213 int rx_dst_ifindex;
14c85021 214 __u8 tos;
d218d111 215 __u8 min_ttl;
14c85021
ACM
216 __u8 mc_ttl;
217 __u8 pmtudisc;
218 __u8 recverr:1,
219 is_icsk:1,
220 freebind:1,
221 hdrincl:1,
f5715aea 222 mc_loop:1,
f771bef9 223 transparent:1,
7b2ff18e
JO
224 mc_all:1,
225 nodefrag:1;
19f6d3f3
WW
226 __u8 bind_address_no_port:1,
227 defer_connect:1; /* Indicates that fastopen_connect is set
228 * and cookie exists so we defer connect
229 * until first data frame is written
230 */
4c507d28 231 __u8 rcv_tos;
224d019c 232 __u8 convert_csum;
76e21053 233 int uc_index;
14c85021 234 int mc_index;
011a9261 235 __be32 mc_addr;
1d7138de 236 struct ip_mc_socklist __rcu *mc_list;
bdc712b4 237 struct inet_cork_full cork;
14c85021
ACM
238};
239
240#define IPCORK_OPT 1 /* ip-options has been held in ipcork.opt */
241#define IPCORK_ALLFRAG 2 /* always fragment (for ipv6 for now) */
242
c44d13d6
TH
243/* cmsg flags for inet */
244#define IP_CMSG_PKTINFO BIT(0)
245#define IP_CMSG_TTL BIT(1)
246#define IP_CMSG_TOS BIT(2)
247#define IP_CMSG_RECVOPTS BIT(3)
248#define IP_CMSG_RETOPTS BIT(4)
249#define IP_CMSG_PASSSEC BIT(5)
250#define IP_CMSG_ORIGDSTADDR BIT(6)
ad6f939a 251#define IP_CMSG_CHECKSUM BIT(7)
70ecc248 252#define IP_CMSG_RECVFRAGSIZE BIT(8)
c44d13d6 253
bd5eb35f
ED
254/**
255 * sk_to_full_sk - Access to a full socket
256 * @sk: pointer to a socket
257 *
258 * SYNACK messages might be attached to request sockets.
54abc686
ED
259 * Some places want to reach the listener in this case.
260 */
bd5eb35f 261static inline struct sock *sk_to_full_sk(struct sock *sk)
54abc686 262{
bd5eb35f 263#ifdef CONFIG_INET
54abc686
ED
264 if (sk && sk->sk_state == TCP_NEW_SYN_RECV)
265 sk = inet_reqsk(sk)->rsk_listener;
bd5eb35f
ED
266#endif
267 return sk;
268}
269
270/* sk_to_full_sk() variant with a const argument */
271static inline const struct sock *sk_const_to_full_sk(const struct sock *sk)
272{
273#ifdef CONFIG_INET
274 if (sk && sk->sk_state == TCP_NEW_SYN_RECV)
275 sk = ((const struct request_sock *)sk)->rsk_listener;
276#endif
54abc686
ED
277 return sk;
278}
279
bd5eb35f
ED
280static inline struct sock *skb_to_full_sk(const struct sk_buff *skb)
281{
282 return sk_to_full_sk(skb->sk);
283}
284
14c85021
ACM
285static inline struct inet_sock *inet_sk(const struct sock *sk)
286{
287 return (struct inet_sock *)sk;
288}
289
290static inline void __inet_sk_copy_descendant(struct sock *sk_to,
291 const struct sock *sk_from,
292 const int ancestor_size)
293{
294 memcpy(inet_sk(sk_to) + 1, inet_sk(sk_from) + 1,
295 sk_from->sk_prot->obj_size - ancestor_size);
296}
dfd56b8b 297#if !(IS_ENABLED(CONFIG_IPV6))
14c85021
ACM
298static inline void inet_sk_copy_descendant(struct sock *sk_to,
299 const struct sock *sk_from)
300{
301 __inet_sk_copy_descendant(sk_to, sk_from, sizeof(struct inet_sock));
302}
303#endif
304
1fd51155 305int inet_sk_rebuild_header(struct sock *sk);
986ffdfd
YS
306
307/**
308 * inet_sk_state_load - read sk->sk_state for lockless contexts
309 * @sk: socket pointer
310 *
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() ...
313 */
314static inline int inet_sk_state_load(const struct sock *sk)
315{
316 /* state change might impact lockless readers. */
317 return smp_load_acquire(&sk->sk_state);
318}
319
320/**
321 * inet_sk_state_store - update sk->sk_state
322 * @sk: socket pointer
323 * @newstate: new state
324 *
325 * Paired with inet_sk_state_load(). Should be used in contexts where
326 * state change might impact lockless readers.
327 */
563e0bb0 328void inet_sk_state_store(struct sock *sk, int newstate);
14c85021 329
986ffdfd
YS
330void inet_sk_set_state(struct sock *sk, int state);
331
65cd8033
HFS
332static inline unsigned int __inet_ehashfn(const __be32 laddr,
333 const __u16 lport,
334 const __be32 faddr,
335 const __be16 fport,
336 u32 initval)
14c85021 337{
7adc3830
DM
338 return jhash_3words((__force __u32) laddr,
339 (__force __u32) faddr,
b3da2cf3 340 ((__u32) lport) << 16 | (__force __u32)fport,
65cd8033 341 initval);
14c85021
ACM
342}
343
e49bb337 344struct request_sock *inet_reqsk_alloc(const struct request_sock_ops *ops,
a1a5344d
ED
345 struct sock *sk_listener,
346 bool attach_listener);
ce4a7d0d 347
88ef4a5a
KK
348static inline __u8 inet_sk_flowi_flags(const struct sock *sk)
349{
a4daad6b
DM
350 __u8 flags = 0;
351
47670b76 352 if (inet_sk(sk)->transparent || inet_sk(sk)->hdrincl)
a4daad6b 353 flags |= FLOWI_FLAG_ANYSRC;
a4daad6b 354 return flags;
88ef4a5a
KK
355}
356
224d019c
TH
357static inline void inet_inc_convert_csum(struct sock *sk)
358{
359 inet_sk(sk)->convert_csum++;
360}
361
362static inline void inet_dec_convert_csum(struct sock *sk)
363{
364 if (inet_sk(sk)->convert_csum > 0)
365 inet_sk(sk)->convert_csum--;
366}
367
368static inline bool inet_get_convert_csum(struct sock *sk)
369{
370 return !!inet_sk(sk)->convert_csum;
371}
372
83ba4645
VB
373
374static inline bool inet_can_nonlocal_bind(struct net *net,
375 struct inet_sock *inet)
376{
377 return net->ipv4.sysctl_ip_nonlocal_bind ||
378 inet->freebind || inet->transparent;
379}
380
14c85021 381#endif /* _INET_SOCK_H */