blob: 236a81034fefec203e27bb73b5a1e5d7d512f8d5 [file] [log] [blame]
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -02001/*
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
Tom Herbertc44d13d2015-01-05 13:56:15 -080019#include <linux/bitops.h>
Vegard Nossum45e3ff82008-09-09 06:43:12 +020020#include <linux/kmemcheck.h>
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020021#include <linux/string.h>
22#include <linux/types.h>
David S. Millerb3da2cf2007-03-23 11:40:27 -070023#include <linux/jhash.h>
Tom Herbertfec5e652010-04-16 16:01:27 -070024#include <linux/netdevice.h>
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020025
26#include <net/flow.h>
27#include <net/sock.h>
28#include <net/request_sock.h>
Pavel Emelyanov0b441912008-06-16 17:14:11 -070029#include <net/netns/hash.h>
Eric Dumazetd34ac512015-03-12 16:44:05 -070030#include <net/tcp_states.h>
David Ahern6dd9a142015-12-16 13:20:44 -080031#include <net/l3mdev.h>
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020032
33/** struct ip_options - IP Options
34 *
35 * @faddr - Saved first hop address
Li Weiac8a4812011-11-22 23:33:10 +000036 * @nexthop - Saved nexthop address in LSRR and SSRR
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020037 * @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 */
44struct ip_options {
Al Viro3ca3c682006-09-27 18:28:07 -070045 __be32 faddr;
Li Weiac8a4812011-11-22 23:33:10 +000046 __be32 nexthop;
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020047 unsigned char optlen;
48 unsigned char srr;
49 unsigned char rr;
50 unsigned char ts;
Denis V. Lunevef722492008-03-22 16:35:29 -070051 unsigned char is_strictroute:1,
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020052 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;
Paul Moore11a03f72006-08-03 16:46:20 -070058 unsigned char cipso;
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020059 unsigned char __pad2;
60 unsigned char __data[0];
61};
62
Eric Dumazetf6d8bd02011-04-21 09:45:37 +000063struct ip_options_rcu {
64 struct rcu_head rcu;
65 struct ip_options opt;
66};
67
68struct ip_options_data {
69 struct ip_options_rcu opt;
70 char data[40];
71};
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020072
73struct inet_request_sock {
74 struct request_sock req;
Eric Dumazet634fb9792013-10-09 15:21:29 -070075#define ir_loc_addr req.__req_common.skc_rcv_saddr
76#define ir_rmt_addr req.__req_common.skc_daddr
Eric Dumazetb44084c2013-10-10 00:04:37 -070077#define ir_num req.__req_common.skc_num
Eric Dumazet634fb9792013-10-09 15:21:29 -070078#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
Eric Dumazet33cf7c92015-03-11 18:53:14 -070082#define ir_cookie req.__req_common.skc_cookie
83#define ireq_net req.__req_common.skc_net
Eric Dumazetd34ac512015-03-12 16:44:05 -070084#define ireq_state req.__req_common.skc_state
Eric Dumazet3f66b082015-03-12 16:44:10 -070085#define ireq_family req.__req_common.skc_family
Eric Dumazet634fb9792013-10-09 15:21:29 -070086
Vegard Nossum45e3ff82008-09-09 06:43:12 +020087 kmemcheck_bitfield_begin(flags);
88 u16 snd_wscale : 4,
89 rcv_wscale : 4,
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020090 tstamp_ok : 1,
91 sack_ok : 1,
92 wscale_ok : 1,
93 ecn_ok : 1,
KOVACS Krisztian88ef4a52008-10-01 07:41:00 -070094 acked : 1,
95 no_srccheck: 1;
Vegard Nossum45e3ff82008-09-09 06:43:12 +020096 kmemcheck_bitfield_end(flags);
Eric Dumazetadc17d62015-03-16 21:06:18 -070097 u32 ir_mark;
Octavian Purdila476eab82014-06-25 17:09:52 +030098 union {
99 struct ip_options_rcu *opt;
Huw Davies56ac42b2016-06-27 15:05:28 -0400100#if IS_ENABLED(CONFIG_IPV6)
101 struct {
102 struct ipv6_txoptions *ipv6_opt;
103 struct sk_buff *pktopts;
104 };
105#endif
Octavian Purdila476eab82014-06-25 17:09:52 +0300106 };
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200107};
108
109static inline struct inet_request_sock *inet_rsk(const struct request_sock *sk)
110{
111 return (struct inet_request_sock *)sk;
112}
113
Eric Dumazetadc17d62015-03-16 21:06:18 -0700114static inline u32 inet_request_mark(const struct sock *sk, struct sk_buff *skb)
Lorenzo Colitti84f39b02014-05-13 10:17:35 -0700115{
Eric Dumazetadc17d62015-03-16 21:06:18 -0700116 if (!sk->sk_mark && sock_net(sk)->ipv4.sysctl_tcp_fwmark_accept)
Lorenzo Colitti84f39b02014-05-13 10:17:35 -0700117 return skb->mark;
Eric Dumazetadc17d62015-03-16 21:06:18 -0700118
119 return sk->sk_mark;
Lorenzo Colitti84f39b02014-05-13 10:17:35 -0700120}
121
David Ahern6dd9a142015-12-16 13:20:44 -0800122static 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
Herbert Xu1470ddf2011-03-01 02:36:47 +0000135struct inet_cork {
136 unsigned int flags;
David S. Millerbdc712b2011-05-06 15:02:07 -0700137 __be32 addr;
Herbert Xu1470ddf2011-03-01 02:36:47 +0000138 struct ip_options *opt;
David S. Millerbdc712b2011-05-06 15:02:07 -0700139 unsigned int fragsize;
Herbert Xu1470ddf2011-03-01 02:36:47 +0000140 int length; /* Total length of all frames */
Eric Dumazet5640f762012-09-23 23:04:42 +0000141 struct dst_entry *dst;
Herbert Xu1470ddf2011-03-01 02:36:47 +0000142 u8 tx_flags;
Francesco Fuscoaa661582013-09-24 15:43:09 +0200143 __u8 ttl;
144 __s16 tos;
145 char priority;
Herbert Xu1470ddf2011-03-01 02:36:47 +0000146};
147
David S. Millerbdc712b2011-05-06 15:02:07 -0700148struct inet_cork_full {
149 struct inet_cork base;
150 struct flowi fl;
151};
152
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200153struct ip_mc_socklist;
154struct ipv6_pinfo;
155struct rtable;
156
157/** struct inet_sock - representation of INET sockets
158 *
159 * @sk - ancestor class
160 * @pinet6 - pointer to IPv6 control block
Eric Dumazetc720c7e2009-10-15 06:30:45 +0000161 * @inet_daddr - Foreign IPv4 addr
162 * @inet_rcv_saddr - Bound local IPv4 addr
163 * @inet_dport - Destination port
164 * @inet_num - Local port
165 * @inet_saddr - Sending source
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200166 * @uc_ttl - Unicast TTL
Eric Dumazetc720c7e2009-10-15 06:30:45 +0000167 * @inet_sport - Source port
168 * @inet_id - ID counter for DF pkts
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200169 * @tos - TOS
170 * @mc_ttl - Multicasting TTL
171 * @is_icsk - is this an inet_connection_sock?
Erich E. Hoover76e21052012-02-08 09:11:07 +0000172 * @uc_index - Unicast outgoing device index
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200173 * @mc_index - Multicast device index
174 * @mc_list - Group array
175 * @cork - info to build ip hdr on each ip frag while socket is corked
176 */
177struct inet_sock {
178 /* sk and pinet6 has to be the first two members of inet_sock */
179 struct sock sk;
Eric Dumazetdfd56b82011-12-10 09:48:31 +0000180#if IS_ENABLED(CONFIG_IPV6)
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200181 struct ipv6_pinfo *pinet6;
182#endif
183 /* Socket demultiplex comparisons on incoming packets. */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000184#define inet_daddr sk.__sk_common.skc_daddr
185#define inet_rcv_saddr sk.__sk_common.skc_rcv_saddr
Eric Dumazetce43b032012-11-30 09:49:27 +0000186#define inet_dport sk.__sk_common.skc_dport
187#define inet_num sk.__sk_common.skc_num
Eric Dumazet68835ab2010-11-30 19:04:07 +0000188
Eric Dumazetc720c7e2009-10-15 06:30:45 +0000189 __be32 inet_saddr;
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200190 __s16 uc_ttl;
191 __u16 cmsg_flags;
Eric Dumazetc720c7e2009-10-15 06:30:45 +0000192 __be16 inet_sport;
193 __u16 inet_id;
Stephen Hemmingerd218d112010-01-11 16:28:01 -0800194
Eric Dumazetf6d8bd02011-04-21 09:45:37 +0000195 struct ip_options_rcu __rcu *inet_opt;
Eric Dumazetce43b032012-11-30 09:49:27 +0000196 int rx_dst_ifindex;
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200197 __u8 tos;
Stephen Hemmingerd218d112010-01-11 16:28:01 -0800198 __u8 min_ttl;
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200199 __u8 mc_ttl;
200 __u8 pmtudisc;
201 __u8 recverr:1,
202 is_icsk:1,
203 freebind:1,
204 hdrincl:1,
KOVACS Krisztianf5715ae2008-10-01 07:30:02 -0700205 mc_loop:1,
Nivedita Singhvif771bef2009-05-28 07:00:46 +0000206 transparent:1,
Jiri Olsa7b2ff182010-06-15 01:07:31 +0000207 mc_all:1,
208 nodefrag:1;
Eric Dumazet90c337d2015-06-06 21:17:57 -0700209 __u8 bind_address_no_port:1;
Jiri Benc4c507d22012-02-09 09:35:49 +0000210 __u8 rcv_tos;
Tom Herbert224d0192015-01-05 13:56:14 -0800211 __u8 convert_csum;
Erich E. Hoover76e21052012-02-08 09:11:07 +0000212 int uc_index;
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200213 int mc_index;
Al Viro011a9262006-09-26 21:27:35 -0700214 __be32 mc_addr;
Eric Dumazet1d7138d2010-11-12 05:46:50 +0000215 struct ip_mc_socklist __rcu *mc_list;
David S. Millerbdc712b2011-05-06 15:02:07 -0700216 struct inet_cork_full cork;
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200217};
218
219#define IPCORK_OPT 1 /* ip-options has been held in ipcork.opt */
220#define IPCORK_ALLFRAG 2 /* always fragment (for ipv6 for now) */
221
Tom Herbertc44d13d2015-01-05 13:56:15 -0800222/* cmsg flags for inet */
223#define IP_CMSG_PKTINFO BIT(0)
224#define IP_CMSG_TTL BIT(1)
225#define IP_CMSG_TOS BIT(2)
226#define IP_CMSG_RECVOPTS BIT(3)
227#define IP_CMSG_RETOPTS BIT(4)
228#define IP_CMSG_PASSSEC BIT(5)
229#define IP_CMSG_ORIGDSTADDR BIT(6)
Tom Herbertad6f9392015-01-05 13:56:17 -0800230#define IP_CMSG_CHECKSUM BIT(7)
Tom Herbertc44d13d2015-01-05 13:56:15 -0800231
Eric Dumazetbd5eb352015-12-07 08:53:17 -0800232/**
233 * sk_to_full_sk - Access to a full socket
234 * @sk: pointer to a socket
235 *
236 * SYNACK messages might be attached to request sockets.
Eric Dumazet54abc682015-11-08 10:54:07 -0800237 * Some places want to reach the listener in this case.
238 */
Eric Dumazetbd5eb352015-12-07 08:53:17 -0800239static inline struct sock *sk_to_full_sk(struct sock *sk)
Eric Dumazet54abc682015-11-08 10:54:07 -0800240{
Eric Dumazetbd5eb352015-12-07 08:53:17 -0800241#ifdef CONFIG_INET
Eric Dumazet54abc682015-11-08 10:54:07 -0800242 if (sk && sk->sk_state == TCP_NEW_SYN_RECV)
243 sk = inet_reqsk(sk)->rsk_listener;
Eric Dumazetbd5eb352015-12-07 08:53:17 -0800244#endif
Eric Dumazet54abc682015-11-08 10:54:07 -0800245 return sk;
246}
247
Eric Dumazetbd5eb352015-12-07 08:53:17 -0800248/* sk_to_full_sk() variant with a const argument */
249static inline const struct sock *sk_const_to_full_sk(const struct sock *sk)
250{
251#ifdef CONFIG_INET
252 if (sk && sk->sk_state == TCP_NEW_SYN_RECV)
253 sk = ((const struct request_sock *)sk)->rsk_listener;
254#endif
255 return sk;
256}
257
258static inline struct sock *skb_to_full_sk(const struct sk_buff *skb)
259{
260 return sk_to_full_sk(skb->sk);
261}
262
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200263static inline struct inet_sock *inet_sk(const struct sock *sk)
264{
265 return (struct inet_sock *)sk;
266}
267
268static inline void __inet_sk_copy_descendant(struct sock *sk_to,
269 const struct sock *sk_from,
270 const int ancestor_size)
271{
272 memcpy(inet_sk(sk_to) + 1, inet_sk(sk_from) + 1,
273 sk_from->sk_prot->obj_size - ancestor_size);
274}
Eric Dumazetdfd56b82011-12-10 09:48:31 +0000275#if !(IS_ENABLED(CONFIG_IPV6))
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200276static inline void inet_sk_copy_descendant(struct sock *sk_to,
277 const struct sock *sk_from)
278{
279 __inet_sk_copy_descendant(sk_to, sk_from, sizeof(struct inet_sock));
280}
281#endif
282
Joe Perches1fd51152013-09-21 10:22:41 -0700283int inet_sk_rebuild_header(struct sock *sk);
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200284
Hannes Frederic Sowa65cd8032013-10-19 21:48:51 +0200285static inline unsigned int __inet_ehashfn(const __be32 laddr,
286 const __u16 lport,
287 const __be32 faddr,
288 const __be16 fport,
289 u32 initval)
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200290{
David S. Miller7adc3832008-03-04 14:28:41 -0800291 return jhash_3words((__force __u32) laddr,
292 (__force __u32) faddr,
David S. Millerb3da2cf2007-03-23 11:40:27 -0700293 ((__u32) lport) << 16 | (__force __u32)fport,
Hannes Frederic Sowa65cd8032013-10-19 21:48:51 +0200294 initval);
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200295}
296
Eric Dumazete49bb332015-03-17 18:32:27 -0700297struct request_sock *inet_reqsk_alloc(const struct request_sock_ops *ops,
Eric Dumazeta1a53442015-10-04 21:08:11 -0700298 struct sock *sk_listener,
299 bool attach_listener);
Arnaldo Carvalho de Meloce4a7d02008-06-10 12:39:35 -0700300
KOVACS Krisztian88ef4a52008-10-01 07:41:00 -0700301static inline __u8 inet_sk_flowi_flags(const struct sock *sk)
302{
David S. Millera4daad62011-01-27 22:01:53 -0800303 __u8 flags = 0;
304
Julian Anastasov47670b72011-08-07 09:16:09 +0000305 if (inet_sk(sk)->transparent || inet_sk(sk)->hdrincl)
David S. Millera4daad62011-01-27 22:01:53 -0800306 flags |= FLOWI_FLAG_ANYSRC;
David S. Millera4daad62011-01-27 22:01:53 -0800307 return flags;
KOVACS Krisztian88ef4a52008-10-01 07:41:00 -0700308}
309
Tom Herbert224d0192015-01-05 13:56:14 -0800310static inline void inet_inc_convert_csum(struct sock *sk)
311{
312 inet_sk(sk)->convert_csum++;
313}
314
315static inline void inet_dec_convert_csum(struct sock *sk)
316{
317 if (inet_sk(sk)->convert_csum > 0)
318 inet_sk(sk)->convert_csum--;
319}
320
321static inline bool inet_get_convert_csum(struct sock *sk)
322{
323 return !!inet_sk(sk)->convert_csum;
324}
325
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200326#endif /* _INET_SOCK_H */