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