xref: /linux-6.15/include/linux/net.h (revision c0a9290e)
1 /*
2  * NET		An implementation of the SOCKET network access protocol.
3  *		This is the master header file for the Linux NET layer,
4  *		or, in plain English: the networking handling part of the
5  *		kernel.
6  *
7  * Version:	@(#)net.h	1.0.3	05/25/93
8  *
9  * Authors:	Orest Zborowski, <[email protected]>
10  *		Ross Biro
11  *		Fred N. van Kempen, <[email protected]>
12  *
13  *		This program is free software; you can redistribute it and/or
14  *		modify it under the terms of the GNU General Public License
15  *		as published by the Free Software Foundation; either version
16  *		2 of the License, or (at your option) any later version.
17  */
18 #ifndef _LINUX_NET_H
19 #define _LINUX_NET_H
20 
21 #include <linux/wait.h>
22 #include <asm/socket.h>
23 
24 struct poll_table_struct;
25 struct pipe_inode_info;
26 struct inode;
27 struct net;
28 
29 #define NPROTO		34		/* should be enough for now..	*/
30 
31 #define SYS_SOCKET	1		/* sys_socket(2)		*/
32 #define SYS_BIND	2		/* sys_bind(2)			*/
33 #define SYS_CONNECT	3		/* sys_connect(2)		*/
34 #define SYS_LISTEN	4		/* sys_listen(2)		*/
35 #define SYS_ACCEPT	5		/* sys_accept(2)		*/
36 #define SYS_GETSOCKNAME	6		/* sys_getsockname(2)		*/
37 #define SYS_GETPEERNAME	7		/* sys_getpeername(2)		*/
38 #define SYS_SOCKETPAIR	8		/* sys_socketpair(2)		*/
39 #define SYS_SEND	9		/* sys_send(2)			*/
40 #define SYS_RECV	10		/* sys_recv(2)			*/
41 #define SYS_SENDTO	11		/* sys_sendto(2)		*/
42 #define SYS_RECVFROM	12		/* sys_recvfrom(2)		*/
43 #define SYS_SHUTDOWN	13		/* sys_shutdown(2)		*/
44 #define SYS_SETSOCKOPT	14		/* sys_setsockopt(2)		*/
45 #define SYS_GETSOCKOPT	15		/* sys_getsockopt(2)		*/
46 #define SYS_SENDMSG	16		/* sys_sendmsg(2)		*/
47 #define SYS_RECVMSG	17		/* sys_recvmsg(2)		*/
48 
49 typedef enum {
50 	SS_FREE = 0,			/* not allocated		*/
51 	SS_UNCONNECTED,			/* unconnected to any socket	*/
52 	SS_CONNECTING,			/* in process of connecting	*/
53 	SS_CONNECTED,			/* connected to socket		*/
54 	SS_DISCONNECTING		/* in process of disconnecting	*/
55 } socket_state;
56 
57 #define __SO_ACCEPTCON	(1 << 16)	/* performed a listen		*/
58 
59 #ifdef __KERNEL__
60 #include <linux/stringify.h>
61 #include <linux/random.h>
62 
63 #define SOCK_ASYNC_NOSPACE	0
64 #define SOCK_ASYNC_WAITDATA	1
65 #define SOCK_NOSPACE		2
66 #define SOCK_PASSCRED		3
67 #define SOCK_PASSSEC		4
68 
69 #ifndef ARCH_HAS_SOCKET_TYPES
70 /**
71  * enum sock_type - Socket types
72  * @SOCK_STREAM: stream (connection) socket
73  * @SOCK_DGRAM: datagram (conn.less) socket
74  * @SOCK_RAW: raw socket
75  * @SOCK_RDM: reliably-delivered message
76  * @SOCK_SEQPACKET: sequential packet socket
77  * @SOCK_DCCP: Datagram Congestion Control Protocol socket
78  * @SOCK_PACKET: linux specific way of getting packets at the dev level.
79  *		  For writing rarp and other similar things on the user level.
80  *
81  * When adding some new socket type please
82  * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
83  * overrides this enum for binary compat reasons.
84  */
85 enum sock_type {
86 	SOCK_STREAM	= 1,
87 	SOCK_DGRAM	= 2,
88 	SOCK_RAW	= 3,
89 	SOCK_RDM	= 4,
90 	SOCK_SEQPACKET	= 5,
91 	SOCK_DCCP	= 6,
92 	SOCK_PACKET	= 10,
93 };
94 
95 #define SOCK_MAX (SOCK_PACKET + 1)
96 
97 #endif /* ARCH_HAS_SOCKET_TYPES */
98 
99 enum sock_shutdown_cmd {
100 	SHUT_RD		= 0,
101 	SHUT_WR		= 1,
102 	SHUT_RDWR	= 2,
103 };
104 
105 /**
106  *  struct socket - general BSD socket
107  *  @state: socket state (%SS_CONNECTED, etc)
108  *  @flags: socket flags (%SOCK_ASYNC_NOSPACE, etc)
109  *  @ops: protocol specific socket operations
110  *  @fasync_list: Asynchronous wake up list
111  *  @file: File back pointer for gc
112  *  @sk: internal networking protocol agnostic socket representation
113  *  @wait: wait queue for several uses
114  *  @type: socket type (%SOCK_STREAM, etc)
115  */
116 struct socket {
117 	socket_state		state;
118 	unsigned long		flags;
119 	const struct proto_ops	*ops;
120 	struct fasync_struct	*fasync_list;
121 	struct file		*file;
122 	struct sock		*sk;
123 	wait_queue_head_t	wait;
124 	short			type;
125 };
126 
127 struct vm_area_struct;
128 struct page;
129 struct kiocb;
130 struct sockaddr;
131 struct msghdr;
132 struct module;
133 
134 struct proto_ops {
135 	int		family;
136 	struct module	*owner;
137 	int		(*release)   (struct socket *sock);
138 	int		(*bind)	     (struct socket *sock,
139 				      struct sockaddr *myaddr,
140 				      int sockaddr_len);
141 	int		(*connect)   (struct socket *sock,
142 				      struct sockaddr *vaddr,
143 				      int sockaddr_len, int flags);
144 	int		(*socketpair)(struct socket *sock1,
145 				      struct socket *sock2);
146 	int		(*accept)    (struct socket *sock,
147 				      struct socket *newsock, int flags);
148 	int		(*getname)   (struct socket *sock,
149 				      struct sockaddr *addr,
150 				      int *sockaddr_len, int peer);
151 	unsigned int	(*poll)	     (struct file *file, struct socket *sock,
152 				      struct poll_table_struct *wait);
153 	int		(*ioctl)     (struct socket *sock, unsigned int cmd,
154 				      unsigned long arg);
155 	int	 	(*compat_ioctl) (struct socket *sock, unsigned int cmd,
156 				      unsigned long arg);
157 	int		(*listen)    (struct socket *sock, int len);
158 	int		(*shutdown)  (struct socket *sock, int flags);
159 	int		(*setsockopt)(struct socket *sock, int level,
160 				      int optname, char __user *optval, int optlen);
161 	int		(*getsockopt)(struct socket *sock, int level,
162 				      int optname, char __user *optval, int __user *optlen);
163 	int		(*compat_setsockopt)(struct socket *sock, int level,
164 				      int optname, char __user *optval, int optlen);
165 	int		(*compat_getsockopt)(struct socket *sock, int level,
166 				      int optname, char __user *optval, int __user *optlen);
167 	int		(*sendmsg)   (struct kiocb *iocb, struct socket *sock,
168 				      struct msghdr *m, size_t total_len);
169 	int		(*recvmsg)   (struct kiocb *iocb, struct socket *sock,
170 				      struct msghdr *m, size_t total_len,
171 				      int flags);
172 	int		(*mmap)	     (struct file *file, struct socket *sock,
173 				      struct vm_area_struct * vma);
174 	ssize_t		(*sendpage)  (struct socket *sock, struct page *page,
175 				      int offset, size_t size, int flags);
176 	ssize_t 	(*splice_read)(struct socket *sock,  loff_t *ppos,
177 				       struct pipe_inode_info *pipe, size_t len, unsigned int flags);
178 };
179 
180 struct net_proto_family {
181 	int		family;
182 	int		(*create)(struct net *net, struct socket *sock, int protocol);
183 	struct module	*owner;
184 };
185 
186 struct iovec;
187 struct kvec;
188 
189 enum {
190 	SOCK_WAKE_IO,
191 	SOCK_WAKE_WAITD,
192 	SOCK_WAKE_SPACE,
193 	SOCK_WAKE_URG,
194 };
195 
196 extern int	     sock_wake_async(struct socket *sk, int how, int band);
197 extern int	     sock_register(const struct net_proto_family *fam);
198 extern void	     sock_unregister(int family);
199 extern int	     sock_create(int family, int type, int proto,
200 				 struct socket **res);
201 extern int	     sock_create_kern(int family, int type, int proto,
202 				      struct socket **res);
203 extern int	     sock_create_lite(int family, int type, int proto,
204 				      struct socket **res);
205 extern void	     sock_release(struct socket *sock);
206 extern int   	     sock_sendmsg(struct socket *sock, struct msghdr *msg,
207 				  size_t len);
208 extern int	     sock_recvmsg(struct socket *sock, struct msghdr *msg,
209 				  size_t size, int flags);
210 extern int 	     sock_map_fd(struct socket *sock);
211 extern struct socket *sockfd_lookup(int fd, int *err);
212 #define		     sockfd_put(sock) fput(sock->file)
213 extern int	     net_ratelimit(void);
214 
215 #define net_random()		random32()
216 #define net_srandom(seed)	srandom32((__force u32)seed)
217 
218 extern int   	     kernel_sendmsg(struct socket *sock, struct msghdr *msg,
219 				    struct kvec *vec, size_t num, size_t len);
220 extern int   	     kernel_recvmsg(struct socket *sock, struct msghdr *msg,
221 				    struct kvec *vec, size_t num,
222 				    size_t len, int flags);
223 
224 extern int kernel_bind(struct socket *sock, struct sockaddr *addr,
225 		       int addrlen);
226 extern int kernel_listen(struct socket *sock, int backlog);
227 extern int kernel_accept(struct socket *sock, struct socket **newsock,
228 			 int flags);
229 extern int kernel_connect(struct socket *sock, struct sockaddr *addr,
230 			  int addrlen, int flags);
231 extern int kernel_getsockname(struct socket *sock, struct sockaddr *addr,
232 			      int *addrlen);
233 extern int kernel_getpeername(struct socket *sock, struct sockaddr *addr,
234 			      int *addrlen);
235 extern int kernel_getsockopt(struct socket *sock, int level, int optname,
236 			     char *optval, int *optlen);
237 extern int kernel_setsockopt(struct socket *sock, int level, int optname,
238 			     char *optval, int optlen);
239 extern int kernel_sendpage(struct socket *sock, struct page *page, int offset,
240 			   size_t size, int flags);
241 extern int kernel_sock_ioctl(struct socket *sock, int cmd, unsigned long arg);
242 extern int kernel_sock_shutdown(struct socket *sock,
243 				enum sock_shutdown_cmd how);
244 
245 #ifndef CONFIG_SMP
246 #define SOCKOPS_WRAPPED(name) name
247 #define SOCKOPS_WRAP(name, fam)
248 #else
249 
250 #define SOCKOPS_WRAPPED(name) __unlocked_##name
251 
252 #define SOCKCALL_WRAP(name, call, parms, args)		\
253 static int __lock_##name##_##call  parms		\
254 {							\
255 	int ret;					\
256 	lock_kernel();					\
257 	ret = __unlocked_##name##_ops.call  args ;\
258 	unlock_kernel();				\
259 	return ret;					\
260 }
261 
262 #define SOCKCALL_UWRAP(name, call, parms, args)		\
263 static unsigned int __lock_##name##_##call  parms	\
264 {							\
265 	int ret;					\
266 	lock_kernel();					\
267 	ret = __unlocked_##name##_ops.call  args ;\
268 	unlock_kernel();				\
269 	return ret;					\
270 }
271 
272 
273 #define SOCKOPS_WRAP(name, fam)					\
274 SOCKCALL_WRAP(name, release, (struct socket *sock), (sock))	\
275 SOCKCALL_WRAP(name, bind, (struct socket *sock, struct sockaddr *uaddr, int addr_len), \
276 	      (sock, uaddr, addr_len))				\
277 SOCKCALL_WRAP(name, connect, (struct socket *sock, struct sockaddr * uaddr, \
278 			      int addr_len, int flags), 	\
279 	      (sock, uaddr, addr_len, flags))			\
280 SOCKCALL_WRAP(name, socketpair, (struct socket *sock1, struct socket *sock2), \
281 	      (sock1, sock2))					\
282 SOCKCALL_WRAP(name, accept, (struct socket *sock, struct socket *newsock, \
283 			 int flags), (sock, newsock, flags)) \
284 SOCKCALL_WRAP(name, getname, (struct socket *sock, struct sockaddr *uaddr, \
285 			 int *addr_len, int peer), (sock, uaddr, addr_len, peer)) \
286 SOCKCALL_UWRAP(name, poll, (struct file *file, struct socket *sock, struct poll_table_struct *wait), \
287 	      (file, sock, wait)) \
288 SOCKCALL_WRAP(name, ioctl, (struct socket *sock, unsigned int cmd, \
289 			 unsigned long arg), (sock, cmd, arg)) \
290 SOCKCALL_WRAP(name, compat_ioctl, (struct socket *sock, unsigned int cmd, \
291 			 unsigned long arg), (sock, cmd, arg)) \
292 SOCKCALL_WRAP(name, listen, (struct socket *sock, int len), (sock, len)) \
293 SOCKCALL_WRAP(name, shutdown, (struct socket *sock, int flags), (sock, flags)) \
294 SOCKCALL_WRAP(name, setsockopt, (struct socket *sock, int level, int optname, \
295 			 char __user *optval, int optlen), (sock, level, optname, optval, optlen)) \
296 SOCKCALL_WRAP(name, getsockopt, (struct socket *sock, int level, int optname, \
297 			 char __user *optval, int __user *optlen), (sock, level, optname, optval, optlen)) \
298 SOCKCALL_WRAP(name, sendmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len), \
299 	      (iocb, sock, m, len)) \
300 SOCKCALL_WRAP(name, recvmsg, (struct kiocb *iocb, struct socket *sock, struct msghdr *m, size_t len, int flags), \
301 	      (iocb, sock, m, len, flags)) \
302 SOCKCALL_WRAP(name, mmap, (struct file *file, struct socket *sock, struct vm_area_struct *vma), \
303 	      (file, sock, vma)) \
304 	      \
305 static const struct proto_ops name##_ops = {			\
306 	.family		= fam,				\
307 	.owner		= THIS_MODULE,			\
308 	.release	= __lock_##name##_release,	\
309 	.bind		= __lock_##name##_bind,		\
310 	.connect	= __lock_##name##_connect,	\
311 	.socketpair	= __lock_##name##_socketpair,	\
312 	.accept		= __lock_##name##_accept,	\
313 	.getname	= __lock_##name##_getname,	\
314 	.poll		= __lock_##name##_poll,		\
315 	.ioctl		= __lock_##name##_ioctl,	\
316 	.compat_ioctl	= __lock_##name##_compat_ioctl,	\
317 	.listen		= __lock_##name##_listen,	\
318 	.shutdown	= __lock_##name##_shutdown,	\
319 	.setsockopt	= __lock_##name##_setsockopt,	\
320 	.getsockopt	= __lock_##name##_getsockopt,	\
321 	.sendmsg	= __lock_##name##_sendmsg,	\
322 	.recvmsg	= __lock_##name##_recvmsg,	\
323 	.mmap		= __lock_##name##_mmap,		\
324 };
325 
326 #endif
327 
328 #define MODULE_ALIAS_NETPROTO(proto) \
329 	MODULE_ALIAS("net-pf-" __stringify(proto))
330 
331 #define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
332 	MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
333 
334 #define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
335 	MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
336 		     "-type-" __stringify(type))
337 
338 #ifdef CONFIG_SYSCTL
339 #include <linux/sysctl.h>
340 extern int net_msg_cost;
341 extern int net_msg_burst;
342 #endif
343 
344 #endif /* __KERNEL__ */
345 #endif	/* _LINUX_NET_H */
346