xref: /openbmc/linux/include/net/inet_sock.h (revision 96de0e252cedffad61b3cb5e05662c591898e69a)
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 
20 #include <linux/string.h>
21 #include <linux/types.h>
22 #include <linux/jhash.h>
23 
24 #include <net/flow.h>
25 #include <net/sock.h>
26 #include <net/request_sock.h>
27 
28 /** struct ip_options - IP Options
29  *
30  * @faddr - Saved first hop address
31  * @is_data - Options in __data, rather than skb
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  */
39 struct ip_options {
40 	__be32		faddr;
41 	unsigned char	optlen;
42 	unsigned char	srr;
43 	unsigned char	rr;
44 	unsigned char	ts;
45 	unsigned char	is_data:1,
46 			is_strictroute:1,
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;
53 	unsigned char	cipso;
54 	unsigned char	__pad2;
55 	unsigned char	__data[0];
56 };
57 
58 #define optlength(opt) (sizeof(struct ip_options) + opt->optlen)
59 
60 struct inet_request_sock {
61 	struct request_sock	req;
62 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
63 	u16			inet6_rsk_offset;
64 	/* 2 bytes hole, try to pack */
65 #endif
66 	__be32			loc_addr;
67 	__be32			rmt_addr;
68 	__be16			rmt_port;
69 	u16			snd_wscale : 4,
70 				rcv_wscale : 4,
71 				tstamp_ok  : 1,
72 				sack_ok	   : 1,
73 				wscale_ok  : 1,
74 				ecn_ok	   : 1,
75 				acked	   : 1;
76 	struct ip_options	*opt;
77 };
78 
79 static inline struct inet_request_sock *inet_rsk(const struct request_sock *sk)
80 {
81 	return (struct inet_request_sock *)sk;
82 }
83 
84 struct ip_mc_socklist;
85 struct ipv6_pinfo;
86 struct rtable;
87 
88 /** struct inet_sock - representation of INET sockets
89  *
90  * @sk - ancestor class
91  * @pinet6 - pointer to IPv6 control block
92  * @daddr - Foreign IPv4 addr
93  * @rcv_saddr - Bound local IPv4 addr
94  * @dport - Destination port
95  * @num - Local port
96  * @saddr - Sending source
97  * @uc_ttl - Unicast TTL
98  * @sport - Source port
99  * @id - ID counter for DF pkts
100  * @tos - TOS
101  * @mc_ttl - Multicasting TTL
102  * @is_icsk - is this an inet_connection_sock?
103  * @mc_index - Multicast device index
104  * @mc_list - Group array
105  * @cork - info to build ip hdr on each ip frag while socket is corked
106  */
107 struct inet_sock {
108 	/* sk and pinet6 has to be the first two members of inet_sock */
109 	struct sock		sk;
110 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
111 	struct ipv6_pinfo	*pinet6;
112 #endif
113 	/* Socket demultiplex comparisons on incoming packets. */
114 	__be32			daddr;
115 	__be32			rcv_saddr;
116 	__be16			dport;
117 	__u16			num;
118 	__be32			saddr;
119 	__s16			uc_ttl;
120 	__u16			cmsg_flags;
121 	struct ip_options	*opt;
122 	__be16			sport;
123 	__u16			id;
124 	__u8			tos;
125 	__u8			mc_ttl;
126 	__u8			pmtudisc;
127 	__u8			recverr:1,
128 				is_icsk:1,
129 				freebind:1,
130 				hdrincl:1,
131 				mc_loop:1;
132 	int			mc_index;
133 	__be32			mc_addr;
134 	struct ip_mc_socklist	*mc_list;
135 	struct {
136 		unsigned int		flags;
137 		unsigned int		fragsize;
138 		struct ip_options	*opt;
139 		struct rtable		*rt;
140 		int			length; /* Total length of all frames */
141 		__be32			addr;
142 		struct flowi		fl;
143 	} cork;
144 };
145 
146 #define IPCORK_OPT	1	/* ip-options has been held in ipcork.opt */
147 #define IPCORK_ALLFRAG	2	/* always fragment (for ipv6 for now) */
148 
149 static inline struct inet_sock *inet_sk(const struct sock *sk)
150 {
151 	return (struct inet_sock *)sk;
152 }
153 
154 static inline void __inet_sk_copy_descendant(struct sock *sk_to,
155 					     const struct sock *sk_from,
156 					     const int ancestor_size)
157 {
158 	memcpy(inet_sk(sk_to) + 1, inet_sk(sk_from) + 1,
159 	       sk_from->sk_prot->obj_size - ancestor_size);
160 }
161 #if !(defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE))
162 static inline void inet_sk_copy_descendant(struct sock *sk_to,
163 					   const struct sock *sk_from)
164 {
165 	__inet_sk_copy_descendant(sk_to, sk_from, sizeof(struct inet_sock));
166 }
167 #endif
168 
169 extern int inet_sk_rebuild_header(struct sock *sk);
170 
171 extern u32 inet_ehash_secret;
172 extern void build_ehash_secret(void);
173 
174 static inline unsigned int inet_ehashfn(const __be32 laddr, const __u16 lport,
175 					const __be32 faddr, const __be16 fport)
176 {
177 	return jhash_2words((__force __u32) laddr ^ (__force __u32) faddr,
178 			    ((__u32) lport) << 16 | (__force __u32)fport,
179 			    inet_ehash_secret);
180 }
181 
182 static inline int inet_sk_ehashfn(const struct sock *sk)
183 {
184 	const struct inet_sock *inet = inet_sk(sk);
185 	const __be32 laddr = inet->rcv_saddr;
186 	const __u16 lport = inet->num;
187 	const __be32 faddr = inet->daddr;
188 	const __be16 fport = inet->dport;
189 
190 	return inet_ehashfn(laddr, lport, faddr, fport);
191 }
192 
193 #endif	/* _INET_SOCK_H */
194