xref: /linux-6.15/include/linux/net.h (revision 4a8e43fe)
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/socket.h>
22 #include <asm/socket.h>
23 
24 #define NPROTO		AF_MAX
25 
26 #define SYS_SOCKET	1		/* sys_socket(2)		*/
27 #define SYS_BIND	2		/* sys_bind(2)			*/
28 #define SYS_CONNECT	3		/* sys_connect(2)		*/
29 #define SYS_LISTEN	4		/* sys_listen(2)		*/
30 #define SYS_ACCEPT	5		/* sys_accept(2)		*/
31 #define SYS_GETSOCKNAME	6		/* sys_getsockname(2)		*/
32 #define SYS_GETPEERNAME	7		/* sys_getpeername(2)		*/
33 #define SYS_SOCKETPAIR	8		/* sys_socketpair(2)		*/
34 #define SYS_SEND	9		/* sys_send(2)			*/
35 #define SYS_RECV	10		/* sys_recv(2)			*/
36 #define SYS_SENDTO	11		/* sys_sendto(2)		*/
37 #define SYS_RECVFROM	12		/* sys_recvfrom(2)		*/
38 #define SYS_SHUTDOWN	13		/* sys_shutdown(2)		*/
39 #define SYS_SETSOCKOPT	14		/* sys_setsockopt(2)		*/
40 #define SYS_GETSOCKOPT	15		/* sys_getsockopt(2)		*/
41 #define SYS_SENDMSG	16		/* sys_sendmsg(2)		*/
42 #define SYS_RECVMSG	17		/* sys_recvmsg(2)		*/
43 #define SYS_ACCEPT4	18		/* sys_accept4(2)		*/
44 #define SYS_RECVMMSG	19		/* sys_recvmmsg(2)		*/
45 #define SYS_SENDMMSG	20		/* sys_sendmmsg(2)		*/
46 
47 typedef enum {
48 	SS_FREE = 0,			/* not allocated		*/
49 	SS_UNCONNECTED,			/* unconnected to any socket	*/
50 	SS_CONNECTING,			/* in process of connecting	*/
51 	SS_CONNECTED,			/* connected to socket		*/
52 	SS_DISCONNECTING		/* in process of disconnecting	*/
53 } socket_state;
54 
55 #define __SO_ACCEPTCON	(1 << 16)	/* performed a listen		*/
56 
57 #ifdef __KERNEL__
58 #include <linux/stringify.h>
59 #include <linux/random.h>
60 #include <linux/wait.h>
61 #include <linux/fcntl.h>	/* For O_CLOEXEC and O_NONBLOCK */
62 #include <linux/kmemcheck.h>
63 #include <linux/rcupdate.h>
64 
65 struct poll_table_struct;
66 struct pipe_inode_info;
67 struct inode;
68 struct file;
69 struct net;
70 
71 #define SOCK_ASYNC_NOSPACE	0
72 #define SOCK_ASYNC_WAITDATA	1
73 #define SOCK_NOSPACE		2
74 #define SOCK_PASSCRED		3
75 #define SOCK_PASSSEC		4
76 #define SOCK_EXTERNALLY_ALLOCATED 5
77 
78 #ifndef ARCH_HAS_SOCKET_TYPES
79 /**
80  * enum sock_type - Socket types
81  * @SOCK_STREAM: stream (connection) socket
82  * @SOCK_DGRAM: datagram (conn.less) socket
83  * @SOCK_RAW: raw socket
84  * @SOCK_RDM: reliably-delivered message
85  * @SOCK_SEQPACKET: sequential packet socket
86  * @SOCK_DCCP: Datagram Congestion Control Protocol socket
87  * @SOCK_PACKET: linux specific way of getting packets at the dev level.
88  *		  For writing rarp and other similar things on the user level.
89  *
90  * When adding some new socket type please
91  * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
92  * overrides this enum for binary compat reasons.
93  */
94 enum sock_type {
95 	SOCK_STREAM	= 1,
96 	SOCK_DGRAM	= 2,
97 	SOCK_RAW	= 3,
98 	SOCK_RDM	= 4,
99 	SOCK_SEQPACKET	= 5,
100 	SOCK_DCCP	= 6,
101 	SOCK_PACKET	= 10,
102 };
103 
104 #define SOCK_MAX (SOCK_PACKET + 1)
105 /* Mask which covers at least up to SOCK_MASK-1.  The
106  * remaining bits are used as flags. */
107 #define SOCK_TYPE_MASK 0xf
108 
109 /* Flags for socket, socketpair, accept4 */
110 #define SOCK_CLOEXEC	O_CLOEXEC
111 #ifndef SOCK_NONBLOCK
112 #define SOCK_NONBLOCK	O_NONBLOCK
113 #endif
114 
115 #endif /* ARCH_HAS_SOCKET_TYPES */
116 
117 enum sock_shutdown_cmd {
118 	SHUT_RD		= 0,
119 	SHUT_WR		= 1,
120 	SHUT_RDWR	= 2,
121 };
122 
123 struct socket_wq {
124 	/* Note: wait MUST be first field of socket_wq */
125 	wait_queue_head_t	wait;
126 	struct fasync_struct	*fasync_list;
127 	struct rcu_head		rcu;
128 } ____cacheline_aligned_in_smp;
129 
130 /**
131  *  struct socket - general BSD socket
132  *  @state: socket state (%SS_CONNECTED, etc)
133  *  @type: socket type (%SOCK_STREAM, etc)
134  *  @flags: socket flags (%SOCK_ASYNC_NOSPACE, etc)
135  *  @ops: protocol specific socket operations
136  *  @file: File back pointer for gc
137  *  @sk: internal networking protocol agnostic socket representation
138  *  @wq: wait queue for several uses
139  */
140 struct socket {
141 	socket_state		state;
142 
143 	kmemcheck_bitfield_begin(type);
144 	short			type;
145 	kmemcheck_bitfield_end(type);
146 
147 	unsigned long		flags;
148 
149 	struct socket_wq __rcu	*wq;
150 
151 	struct file		*file;
152 	struct sock		*sk;
153 	const struct proto_ops	*ops;
154 };
155 
156 struct vm_area_struct;
157 struct page;
158 struct kiocb;
159 struct sockaddr;
160 struct msghdr;
161 struct module;
162 
163 struct proto_ops {
164 	int		family;
165 	struct module	*owner;
166 	int		(*release)   (struct socket *sock);
167 	int		(*bind)	     (struct socket *sock,
168 				      struct sockaddr *myaddr,
169 				      int sockaddr_len);
170 	int		(*connect)   (struct socket *sock,
171 				      struct sockaddr *vaddr,
172 				      int sockaddr_len, int flags);
173 	int		(*socketpair)(struct socket *sock1,
174 				      struct socket *sock2);
175 	int		(*accept)    (struct socket *sock,
176 				      struct socket *newsock, int flags);
177 	int		(*getname)   (struct socket *sock,
178 				      struct sockaddr *addr,
179 				      int *sockaddr_len, int peer);
180 	unsigned int	(*poll)	     (struct file *file, struct socket *sock,
181 				      struct poll_table_struct *wait);
182 	int		(*ioctl)     (struct socket *sock, unsigned int cmd,
183 				      unsigned long arg);
184 #ifdef CONFIG_COMPAT
185 	int	 	(*compat_ioctl) (struct socket *sock, unsigned int cmd,
186 				      unsigned long arg);
187 #endif
188 	int		(*listen)    (struct socket *sock, int len);
189 	int		(*shutdown)  (struct socket *sock, int flags);
190 	int		(*setsockopt)(struct socket *sock, int level,
191 				      int optname, char __user *optval, unsigned int optlen);
192 	int		(*getsockopt)(struct socket *sock, int level,
193 				      int optname, char __user *optval, int __user *optlen);
194 #ifdef CONFIG_COMPAT
195 	int		(*compat_setsockopt)(struct socket *sock, int level,
196 				      int optname, char __user *optval, unsigned int optlen);
197 	int		(*compat_getsockopt)(struct socket *sock, int level,
198 				      int optname, char __user *optval, int __user *optlen);
199 #endif
200 	int		(*sendmsg)   (struct kiocb *iocb, struct socket *sock,
201 				      struct msghdr *m, size_t total_len);
202 	int		(*recvmsg)   (struct kiocb *iocb, struct socket *sock,
203 				      struct msghdr *m, size_t total_len,
204 				      int flags);
205 	int		(*mmap)	     (struct file *file, struct socket *sock,
206 				      struct vm_area_struct * vma);
207 	ssize_t		(*sendpage)  (struct socket *sock, struct page *page,
208 				      int offset, size_t size, int flags);
209 	ssize_t 	(*splice_read)(struct socket *sock,  loff_t *ppos,
210 				       struct pipe_inode_info *pipe, size_t len, unsigned int flags);
211 	void		(*set_peek_off)(struct sock *sk, int val);
212 };
213 
214 #define DECLARE_SOCKADDR(type, dst, src)	\
215 	type dst = ({ __sockaddr_check_size(sizeof(*dst)); (type) src; })
216 
217 struct net_proto_family {
218 	int		family;
219 	int		(*create)(struct net *net, struct socket *sock,
220 				  int protocol, int kern);
221 	struct module	*owner;
222 };
223 
224 struct iovec;
225 struct kvec;
226 
227 enum {
228 	SOCK_WAKE_IO,
229 	SOCK_WAKE_WAITD,
230 	SOCK_WAKE_SPACE,
231 	SOCK_WAKE_URG,
232 };
233 
234 extern int	     sock_wake_async(struct socket *sk, int how, int band);
235 extern int	     sock_register(const struct net_proto_family *fam);
236 extern void	     sock_unregister(int family);
237 extern int	     __sock_create(struct net *net, int family, int type, int proto,
238 				 struct socket **res, int kern);
239 extern int	     sock_create(int family, int type, int proto,
240 				 struct socket **res);
241 extern int	     sock_create_kern(int family, int type, int proto,
242 				      struct socket **res);
243 extern int	     sock_create_lite(int family, int type, int proto,
244 				      struct socket **res);
245 extern void	     sock_release(struct socket *sock);
246 extern int   	     sock_sendmsg(struct socket *sock, struct msghdr *msg,
247 				  size_t len);
248 extern int	     sock_recvmsg(struct socket *sock, struct msghdr *msg,
249 				  size_t size, int flags);
250 extern struct file  *sock_alloc_file(struct socket *sock, int flags, const char *dname);
251 extern struct socket *sockfd_lookup(int fd, int *err);
252 extern struct socket *sock_from_file(struct file *file, int *err);
253 #define		     sockfd_put(sock) fput(sock->file)
254 extern int	     net_ratelimit(void);
255 
256 #define net_ratelimited_function(function, ...)			\
257 do {								\
258 	if (net_ratelimit())					\
259 		function(__VA_ARGS__);				\
260 } while (0)
261 
262 #define net_emerg_ratelimited(fmt, ...)				\
263 	net_ratelimited_function(pr_emerg, fmt, ##__VA_ARGS__)
264 #define net_alert_ratelimited(fmt, ...)				\
265 	net_ratelimited_function(pr_alert, fmt, ##__VA_ARGS__)
266 #define net_crit_ratelimited(fmt, ...)				\
267 	net_ratelimited_function(pr_crit, fmt, ##__VA_ARGS__)
268 #define net_err_ratelimited(fmt, ...)				\
269 	net_ratelimited_function(pr_err, fmt, ##__VA_ARGS__)
270 #define net_notice_ratelimited(fmt, ...)			\
271 	net_ratelimited_function(pr_notice, fmt, ##__VA_ARGS__)
272 #define net_warn_ratelimited(fmt, ...)				\
273 	net_ratelimited_function(pr_warn, fmt, ##__VA_ARGS__)
274 #define net_info_ratelimited(fmt, ...)				\
275 	net_ratelimited_function(pr_info, fmt, ##__VA_ARGS__)
276 #define net_dbg_ratelimited(fmt, ...)				\
277 	net_ratelimited_function(pr_debug, fmt, ##__VA_ARGS__)
278 
279 #define net_random()		random32()
280 #define net_srandom(seed)	srandom32((__force u32)seed)
281 
282 extern int   	     kernel_sendmsg(struct socket *sock, struct msghdr *msg,
283 				    struct kvec *vec, size_t num, size_t len);
284 extern int   	     kernel_recvmsg(struct socket *sock, struct msghdr *msg,
285 				    struct kvec *vec, size_t num,
286 				    size_t len, int flags);
287 
288 extern int kernel_bind(struct socket *sock, struct sockaddr *addr,
289 		       int addrlen);
290 extern int kernel_listen(struct socket *sock, int backlog);
291 extern int kernel_accept(struct socket *sock, struct socket **newsock,
292 			 int flags);
293 extern int kernel_connect(struct socket *sock, struct sockaddr *addr,
294 			  int addrlen, int flags);
295 extern int kernel_getsockname(struct socket *sock, struct sockaddr *addr,
296 			      int *addrlen);
297 extern int kernel_getpeername(struct socket *sock, struct sockaddr *addr,
298 			      int *addrlen);
299 extern int kernel_getsockopt(struct socket *sock, int level, int optname,
300 			     char *optval, int *optlen);
301 extern int kernel_setsockopt(struct socket *sock, int level, int optname,
302 			     char *optval, unsigned int optlen);
303 extern int kernel_sendpage(struct socket *sock, struct page *page, int offset,
304 			   size_t size, int flags);
305 extern int kernel_sock_ioctl(struct socket *sock, int cmd, unsigned long arg);
306 extern int kernel_sock_shutdown(struct socket *sock,
307 				enum sock_shutdown_cmd how);
308 
309 #define MODULE_ALIAS_NETPROTO(proto) \
310 	MODULE_ALIAS("net-pf-" __stringify(proto))
311 
312 #define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
313 	MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
314 
315 #define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
316 	MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
317 		     "-type-" __stringify(type))
318 
319 #define MODULE_ALIAS_NET_PF_PROTO_NAME(pf, proto, name) \
320 	MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
321 		     name)
322 #endif /* __KERNEL__ */
323 #endif	/* _LINUX_NET_H */
324