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