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