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