blob: b21a7f06d6a4955910b577a23b04eb904207265a [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
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020019
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>
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020030
31/** struct ip_options - IP Options
32 *
33 * @faddr - Saved first hop address
Li Weiac8a4812011-11-22 23:33:10 +000034 * @nexthop - Saved nexthop address in LSRR and SSRR
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020035 * @is_strictroute - Strict source route
36 * @srr_is_hit - Packet destination addr was our one
37 * @is_changed - IP checksum more not valid
38 * @rr_needaddr - Need to record addr of outgoing dev
39 * @ts_needtime - Need to record timestamp
40 * @ts_needaddr - Need to record addr of outgoing dev
41 */
42struct ip_options {
Al Viro3ca3c682006-09-27 18:28:07 -070043 __be32 faddr;
Li Weiac8a4812011-11-22 23:33:10 +000044 __be32 nexthop;
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020045 unsigned char optlen;
46 unsigned char srr;
47 unsigned char rr;
48 unsigned char ts;
Denis V. Lunevef722492008-03-22 16:35:29 -070049 unsigned char is_strictroute:1,
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020050 srr_is_hit:1,
51 is_changed:1,
52 rr_needaddr:1,
53 ts_needtime:1,
54 ts_needaddr:1;
55 unsigned char router_alert;
Paul Moore11a03f72006-08-03 16:46:20 -070056 unsigned char cipso;
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020057 unsigned char __pad2;
58 unsigned char __data[0];
59};
60
Eric Dumazetf6d8bd02011-04-21 09:45:37 +000061struct ip_options_rcu {
62 struct rcu_head rcu;
63 struct ip_options opt;
64};
65
66struct ip_options_data {
67 struct ip_options_rcu opt;
68 char data[40];
69};
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020070
71struct inet_request_sock {
72 struct request_sock req;
Eric Dumazetdfd56b82011-12-10 09:48:31 +000073#if IS_ENABLED(CONFIG_IPV6)
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020074 u16 inet6_rsk_offset;
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020075#endif
KOVACS Krisztiana3116ac52008-10-01 07:46:49 -070076 __be16 loc_port;
Al Viroadaf3452006-09-27 18:27:13 -070077 __be32 loc_addr;
78 __be32 rmt_addr;
Al Viroe11be942006-09-27 18:35:29 -070079 __be16 rmt_port;
Vegard Nossum45e3ff82008-09-09 06:43:12 +020080 kmemcheck_bitfield_begin(flags);
81 u16 snd_wscale : 4,
82 rcv_wscale : 4,
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020083 tstamp_ok : 1,
84 sack_ok : 1,
85 wscale_ok : 1,
86 ecn_ok : 1,
KOVACS Krisztian88ef4a52008-10-01 07:41:00 -070087 acked : 1,
88 no_srccheck: 1;
Vegard Nossum45e3ff82008-09-09 06:43:12 +020089 kmemcheck_bitfield_end(flags);
Eric Dumazetf6d8bd02011-04-21 09:45:37 +000090 struct ip_options_rcu *opt;
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020091};
92
93static inline struct inet_request_sock *inet_rsk(const struct request_sock *sk)
94{
95 return (struct inet_request_sock *)sk;
96}
97
Herbert Xu1470ddf2011-03-01 02:36:47 +000098struct inet_cork {
99 unsigned int flags;
David S. Millerbdc712b2011-05-06 15:02:07 -0700100 __be32 addr;
Herbert Xu1470ddf2011-03-01 02:36:47 +0000101 struct ip_options *opt;
David S. Millerbdc712b2011-05-06 15:02:07 -0700102 unsigned int fragsize;
Herbert Xu1470ddf2011-03-01 02:36:47 +0000103 int length; /* Total length of all frames */
Eric Dumazet5640f762012-09-23 23:04:42 +0000104 struct dst_entry *dst;
Herbert Xu1470ddf2011-03-01 02:36:47 +0000105 u8 tx_flags;
106};
107
David S. Millerbdc712b2011-05-06 15:02:07 -0700108struct inet_cork_full {
109 struct inet_cork base;
110 struct flowi fl;
111};
112
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200113struct ip_mc_socklist;
114struct ipv6_pinfo;
115struct rtable;
116
117/** struct inet_sock - representation of INET sockets
118 *
119 * @sk - ancestor class
120 * @pinet6 - pointer to IPv6 control block
Eric Dumazetc720c7e2009-10-15 06:30:45 +0000121 * @inet_daddr - Foreign IPv4 addr
122 * @inet_rcv_saddr - Bound local IPv4 addr
123 * @inet_dport - Destination port
124 * @inet_num - Local port
125 * @inet_saddr - Sending source
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200126 * @uc_ttl - Unicast TTL
Eric Dumazetc720c7e2009-10-15 06:30:45 +0000127 * @inet_sport - Source port
128 * @inet_id - ID counter for DF pkts
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200129 * @tos - TOS
130 * @mc_ttl - Multicasting TTL
131 * @is_icsk - is this an inet_connection_sock?
Erich E. Hoover76e21052012-02-08 09:11:07 +0000132 * @uc_index - Unicast outgoing device index
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200133 * @mc_index - Multicast device index
134 * @mc_list - Group array
135 * @cork - info to build ip hdr on each ip frag while socket is corked
136 */
137struct inet_sock {
138 /* sk and pinet6 has to be the first two members of inet_sock */
139 struct sock sk;
Eric Dumazetdfd56b82011-12-10 09:48:31 +0000140#if IS_ENABLED(CONFIG_IPV6)
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200141 struct ipv6_pinfo *pinet6;
142#endif
143 /* Socket demultiplex comparisons on incoming packets. */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000144#define inet_daddr sk.__sk_common.skc_daddr
145#define inet_rcv_saddr sk.__sk_common.skc_rcv_saddr
Eric Dumazetce43b032012-11-30 09:49:27 +0000146#define inet_addrpair sk.__sk_common.skc_addrpair
147#define inet_dport sk.__sk_common.skc_dport
148#define inet_num sk.__sk_common.skc_num
149#define inet_portpair sk.__sk_common.skc_portpair
Eric Dumazet68835ab2010-11-30 19:04:07 +0000150
Eric Dumazetc720c7e2009-10-15 06:30:45 +0000151 __be32 inet_saddr;
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200152 __s16 uc_ttl;
153 __u16 cmsg_flags;
Eric Dumazetc720c7e2009-10-15 06:30:45 +0000154 __be16 inet_sport;
155 __u16 inet_id;
Stephen Hemmingerd218d112010-01-11 16:28:01 -0800156
Eric Dumazetf6d8bd02011-04-21 09:45:37 +0000157 struct ip_options_rcu __rcu *inet_opt;
Eric Dumazetce43b032012-11-30 09:49:27 +0000158 int rx_dst_ifindex;
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200159 __u8 tos;
Stephen Hemmingerd218d112010-01-11 16:28:01 -0800160 __u8 min_ttl;
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200161 __u8 mc_ttl;
162 __u8 pmtudisc;
163 __u8 recverr:1,
164 is_icsk:1,
165 freebind:1,
166 hdrincl:1,
KOVACS Krisztianf5715ae2008-10-01 07:30:02 -0700167 mc_loop:1,
Nivedita Singhvif771bef2009-05-28 07:00:46 +0000168 transparent:1,
Jiri Olsa7b2ff182010-06-15 01:07:31 +0000169 mc_all:1,
170 nodefrag:1;
Jiri Benc4c507d22012-02-09 09:35:49 +0000171 __u8 rcv_tos;
Erich E. Hoover76e21052012-02-08 09:11:07 +0000172 int uc_index;
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200173 int mc_index;
Al Viro011a9262006-09-26 21:27:35 -0700174 __be32 mc_addr;
Eric Dumazet1d7138d2010-11-12 05:46:50 +0000175 struct ip_mc_socklist __rcu *mc_list;
David S. Millerbdc712b2011-05-06 15:02:07 -0700176 struct inet_cork_full cork;
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200177};
178
179#define IPCORK_OPT 1 /* ip-options has been held in ipcork.opt */
180#define IPCORK_ALLFRAG 2 /* always fragment (for ipv6 for now) */
181
182static inline struct inet_sock *inet_sk(const struct sock *sk)
183{
184 return (struct inet_sock *)sk;
185}
186
187static inline void __inet_sk_copy_descendant(struct sock *sk_to,
188 const struct sock *sk_from,
189 const int ancestor_size)
190{
191 memcpy(inet_sk(sk_to) + 1, inet_sk(sk_from) + 1,
192 sk_from->sk_prot->obj_size - ancestor_size);
193}
Eric Dumazetdfd56b82011-12-10 09:48:31 +0000194#if !(IS_ENABLED(CONFIG_IPV6))
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200195static inline void inet_sk_copy_descendant(struct sock *sk_to,
196 const struct sock *sk_from)
197{
198 __inet_sk_copy_descendant(sk_to, sk_from, sizeof(struct inet_sock));
199}
200#endif
201
202extern int inet_sk_rebuild_header(struct sock *sk);
203
David S. Millerb3da2cf2007-03-23 11:40:27 -0700204extern u32 inet_ehash_secret;
Eric Dumazet08dcdbf2013-02-21 12:18:52 +0000205extern u32 ipv6_hash_secret;
David S. Millerb3da2cf2007-03-23 11:40:27 -0700206extern void build_ehash_secret(void);
207
Pavel Emelyanov9f26b3a2008-06-16 17:13:27 -0700208static inline unsigned int inet_ehashfn(struct net *net,
209 const __be32 laddr, const __u16 lport,
Al Virofb99c842006-09-27 18:43:33 -0700210 const __be32 faddr, const __be16 fport)
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200211{
David S. Miller7adc3832008-03-04 14:28:41 -0800212 return jhash_3words((__force __u32) laddr,
213 (__force __u32) faddr,
David S. Millerb3da2cf2007-03-23 11:40:27 -0700214 ((__u32) lport) << 16 | (__force __u32)fport,
Pavel Emelyanov0b441912008-06-16 17:14:11 -0700215 inet_ehash_secret + net_hash_mix(net));
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200216}
217
218static inline int inet_sk_ehashfn(const struct sock *sk)
219{
220 const struct inet_sock *inet = inet_sk(sk);
Eric Dumazetc720c7e2009-10-15 06:30:45 +0000221 const __be32 laddr = inet->inet_rcv_saddr;
222 const __u16 lport = inet->inet_num;
223 const __be32 faddr = inet->inet_daddr;
224 const __be16 fport = inet->inet_dport;
Pavel Emelyanov9f26b3a2008-06-16 17:13:27 -0700225 struct net *net = sock_net(sk);
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200226
Pavel Emelyanov9f26b3a2008-06-16 17:13:27 -0700227 return inet_ehashfn(net, laddr, lport, faddr, fport);
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200228}
229
Arnaldo Carvalho de Meloce4a7d02008-06-10 12:39:35 -0700230static inline struct request_sock *inet_reqsk_alloc(struct request_sock_ops *ops)
231{
232 struct request_sock *req = reqsk_alloc(ops);
Vegard Nossum45e3ff82008-09-09 06:43:12 +0200233 struct inet_request_sock *ireq = inet_rsk(req);
Arnaldo Carvalho de Meloce4a7d02008-06-10 12:39:35 -0700234
Vegard Nossum45e3ff82008-09-09 06:43:12 +0200235 if (req != NULL) {
236 kmemcheck_annotate_bitfield(ireq, flags);
237 ireq->opt = NULL;
238 }
Arnaldo Carvalho de Meloce4a7d02008-06-10 12:39:35 -0700239
240 return req;
241}
242
KOVACS Krisztian88ef4a52008-10-01 07:41:00 -0700243static inline __u8 inet_sk_flowi_flags(const struct sock *sk)
244{
David S. Millera4daad62011-01-27 22:01:53 -0800245 __u8 flags = 0;
246
Julian Anastasov47670b72011-08-07 09:16:09 +0000247 if (inet_sk(sk)->transparent || inet_sk(sk)->hdrincl)
David S. Millera4daad62011-01-27 22:01:53 -0800248 flags |= FLOWI_FLAG_ANYSRC;
David S. Millera4daad62011-01-27 22:01:53 -0800249 return flags;
KOVACS Krisztian88ef4a52008-10-01 07:41:00 -0700250}
251
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -0200252#endif /* _INET_SOCK_H */