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, <obz@Kodak.COM>
10 *		Ross Biro
11 *		Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
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/stringify.h>
22#include <linux/random.h>
23#include <linux/wait.h>
24#include <linux/fcntl.h>	/* For O_CLOEXEC and O_NONBLOCK */
25#include <linux/kmemcheck.h>
26#include <linux/rcupdate.h>
27#include <linux/jump_label.h>
28#include <uapi/linux/net.h>
29
30struct poll_table_struct;
31struct pipe_inode_info;
32struct inode;
33struct file;
34struct net;
35
36#define SOCK_ASYNC_NOSPACE	0
37#define SOCK_ASYNC_WAITDATA	1
38#define SOCK_NOSPACE		2
39#define SOCK_PASSCRED		3
40#define SOCK_PASSSEC		4
41#define SOCK_EXTERNALLY_ALLOCATED 5
42
43#ifndef ARCH_HAS_SOCKET_TYPES
44/**
45 * enum sock_type - Socket types
46 * @SOCK_STREAM: stream (connection) socket
47 * @SOCK_DGRAM: datagram (conn.less) socket
48 * @SOCK_RAW: raw socket
49 * @SOCK_RDM: reliably-delivered message
50 * @SOCK_SEQPACKET: sequential packet socket
51 * @SOCK_DCCP: Datagram Congestion Control Protocol socket
52 * @SOCK_PACKET: linux specific way of getting packets at the dev level.
53 *		  For writing rarp and other similar things on the user level.
54 *
55 * When adding some new socket type please
56 * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
57 * overrides this enum for binary compat reasons.
58 */
59enum sock_type {
60	SOCK_STREAM	= 1,
61	SOCK_DGRAM	= 2,
62	SOCK_RAW	= 3,
63	SOCK_RDM	= 4,
64	SOCK_SEQPACKET	= 5,
65	SOCK_DCCP	= 6,
66	SOCK_PACKET	= 10,
67};
68
69#define SOCK_MAX (SOCK_PACKET + 1)
70/* Mask which covers at least up to SOCK_MASK-1.  The
71 * remaining bits are used as flags. */
72#define SOCK_TYPE_MASK 0xf
73
74/* Flags for socket, socketpair, accept4 */
75#define SOCK_CLOEXEC	O_CLOEXEC
76#ifndef SOCK_NONBLOCK
77#define SOCK_NONBLOCK	O_NONBLOCK
78#endif
79
80#endif /* ARCH_HAS_SOCKET_TYPES */
81
82enum sock_shutdown_cmd {
83	SHUT_RD,
84	SHUT_WR,
85	SHUT_RDWR,
86};
87
88struct socket_wq {
89	/* Note: wait MUST be first field of socket_wq */
90	wait_queue_head_t	wait;
91	struct fasync_struct	*fasync_list;
92	struct rcu_head		rcu;
93} ____cacheline_aligned_in_smp;
94
95/**
96 *  struct socket - general BSD socket
97 *  @state: socket state (%SS_CONNECTED, etc)
98 *  @type: socket type (%SOCK_STREAM, etc)
99 *  @flags: socket flags (%SOCK_ASYNC_NOSPACE, etc)
100 *  @ops: protocol specific socket operations
101 *  @file: File back pointer for gc
102 *  @sk: internal networking protocol agnostic socket representation
103 *  @wq: wait queue for several uses
104 */
105struct socket {
106	socket_state		state;
107
108	kmemcheck_bitfield_begin(type);
109	short			type;
110	kmemcheck_bitfield_end(type);
111
112	unsigned long		flags;
113
114	struct socket_wq __rcu	*wq;
115
116	struct file		*file;
117	struct sock		*sk;
118	const struct proto_ops	*ops;
119};
120
121struct vm_area_struct;
122struct page;
123struct sockaddr;
124struct msghdr;
125struct module;
126
127struct proto_ops {
128	int		family;
129	struct module	*owner;
130	int		(*release)   (struct socket *sock);
131	int		(*bind)	     (struct socket *sock,
132				      struct sockaddr *myaddr,
133				      int sockaddr_len);
134	int		(*connect)   (struct socket *sock,
135				      struct sockaddr *vaddr,
136				      int sockaddr_len, int flags);
137	int		(*socketpair)(struct socket *sock1,
138				      struct socket *sock2);
139	int		(*accept)    (struct socket *sock,
140				      struct socket *newsock, int flags);
141	int		(*getname)   (struct socket *sock,
142				      struct sockaddr *addr,
143				      int *sockaddr_len, int peer);
144	unsigned int	(*poll)	     (struct file *file, struct socket *sock,
145				      struct poll_table_struct *wait);
146	int		(*ioctl)     (struct socket *sock, unsigned int cmd,
147				      unsigned long arg);
148#ifdef CONFIG_COMPAT
149	int	 	(*compat_ioctl) (struct socket *sock, unsigned int cmd,
150				      unsigned long arg);
151#endif
152	int		(*listen)    (struct socket *sock, int len);
153	int		(*shutdown)  (struct socket *sock, int flags);
154	int		(*setsockopt)(struct socket *sock, int level,
155				      int optname, char __user *optval, unsigned int optlen);
156	int		(*getsockopt)(struct socket *sock, int level,
157				      int optname, char __user *optval, int __user *optlen);
158#ifdef CONFIG_COMPAT
159	int		(*compat_setsockopt)(struct socket *sock, int level,
160				      int optname, char __user *optval, unsigned int optlen);
161	int		(*compat_getsockopt)(struct socket *sock, int level,
162				      int optname, char __user *optval, int __user *optlen);
163#endif
164	int		(*sendmsg)   (struct socket *sock, struct msghdr *m,
165				      size_t total_len);
166	/* Notes for implementing recvmsg:
167	 * ===============================
168	 * msg->msg_namelen should get updated by the recvmsg handlers
169	 * iff msg_name != NULL. It is by default 0 to prevent
170	 * returning uninitialized memory to user space.  The recvfrom
171	 * handlers can assume that msg.msg_name is either NULL or has
172	 * a minimum size of sizeof(struct sockaddr_storage).
173	 */
174	int		(*recvmsg)   (struct socket *sock, struct msghdr *m,
175				      size_t total_len, int flags);
176	int		(*mmap)	     (struct file *file, struct socket *sock,
177				      struct vm_area_struct * vma);
178	ssize_t		(*sendpage)  (struct socket *sock, struct page *page,
179				      int offset, size_t size, int flags);
180	ssize_t 	(*splice_read)(struct socket *sock,  loff_t *ppos,
181				       struct pipe_inode_info *pipe, size_t len, unsigned int flags);
182	int		(*set_peek_off)(struct sock *sk, int val);
183};
184
185#define DECLARE_SOCKADDR(type, dst, src)	\
186	type dst = ({ __sockaddr_check_size(sizeof(*dst)); (type) src; })
187
188struct net_proto_family {
189	int		family;
190	int		(*create)(struct net *net, struct socket *sock,
191				  int protocol, int kern);
192	struct module	*owner;
193};
194
195struct iovec;
196struct kvec;
197
198enum {
199	SOCK_WAKE_IO,
200	SOCK_WAKE_WAITD,
201	SOCK_WAKE_SPACE,
202	SOCK_WAKE_URG,
203};
204
205int sock_wake_async(struct socket *sk, int how, int band);
206int sock_register(const struct net_proto_family *fam);
207void sock_unregister(int family);
208int __sock_create(struct net *net, int family, int type, int proto,
209		  struct socket **res, int kern);
210int sock_create(int family, int type, int proto, struct socket **res);
211int sock_create_kern(int family, int type, int proto, struct socket **res);
212int sock_create_lite(int family, int type, int proto, struct socket **res);
213void sock_release(struct socket *sock);
214int sock_sendmsg(struct socket *sock, struct msghdr *msg);
215int sock_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
216		 int flags);
217struct file *sock_alloc_file(struct socket *sock, int flags, const char *dname);
218struct socket *sockfd_lookup(int fd, int *err);
219struct socket *sock_from_file(struct file *file, int *err);
220#define		     sockfd_put(sock) fput(sock->file)
221int net_ratelimit(void);
222
223#define net_ratelimited_function(function, ...)			\
224do {								\
225	if (net_ratelimit())					\
226		function(__VA_ARGS__);				\
227} while (0)
228
229#define net_emerg_ratelimited(fmt, ...)				\
230	net_ratelimited_function(pr_emerg, fmt, ##__VA_ARGS__)
231#define net_alert_ratelimited(fmt, ...)				\
232	net_ratelimited_function(pr_alert, fmt, ##__VA_ARGS__)
233#define net_crit_ratelimited(fmt, ...)				\
234	net_ratelimited_function(pr_crit, fmt, ##__VA_ARGS__)
235#define net_err_ratelimited(fmt, ...)				\
236	net_ratelimited_function(pr_err, fmt, ##__VA_ARGS__)
237#define net_notice_ratelimited(fmt, ...)			\
238	net_ratelimited_function(pr_notice, fmt, ##__VA_ARGS__)
239#define net_warn_ratelimited(fmt, ...)				\
240	net_ratelimited_function(pr_warn, fmt, ##__VA_ARGS__)
241#define net_info_ratelimited(fmt, ...)				\
242	net_ratelimited_function(pr_info, fmt, ##__VA_ARGS__)
243#define net_dbg_ratelimited(fmt, ...)				\
244	net_ratelimited_function(pr_debug, fmt, ##__VA_ARGS__)
245
246bool __net_get_random_once(void *buf, int nbytes, bool *done,
247			   struct static_key *done_key);
248
249#define net_get_random_once(buf, nbytes)				\
250	({								\
251		bool ___ret = false;					\
252		static bool ___done = false;				\
253		static struct static_key ___once_key =			\
254			STATIC_KEY_INIT_TRUE;				\
255		if (static_key_true(&___once_key))			\
256			___ret = __net_get_random_once(buf,		\
257						       nbytes,		\
258						       &___done,	\
259						       &___once_key);	\
260		___ret;							\
261	})
262
263int kernel_sendmsg(struct socket *sock, struct msghdr *msg, struct kvec *vec,
264		   size_t num, size_t len);
265int kernel_recvmsg(struct socket *sock, struct msghdr *msg, struct kvec *vec,
266		   size_t num, size_t len, int flags);
267
268int kernel_bind(struct socket *sock, struct sockaddr *addr, int addrlen);
269int kernel_listen(struct socket *sock, int backlog);
270int kernel_accept(struct socket *sock, struct socket **newsock, int flags);
271int kernel_connect(struct socket *sock, struct sockaddr *addr, int addrlen,
272		   int flags);
273int kernel_getsockname(struct socket *sock, struct sockaddr *addr,
274		       int *addrlen);
275int kernel_getpeername(struct socket *sock, struct sockaddr *addr,
276		       int *addrlen);
277int kernel_getsockopt(struct socket *sock, int level, int optname, char *optval,
278		      int *optlen);
279int kernel_setsockopt(struct socket *sock, int level, int optname, char *optval,
280		      unsigned int optlen);
281int kernel_sendpage(struct socket *sock, struct page *page, int offset,
282		    size_t size, int flags);
283int kernel_sock_ioctl(struct socket *sock, int cmd, unsigned long arg);
284int kernel_sock_shutdown(struct socket *sock, enum sock_shutdown_cmd how);
285
286#define MODULE_ALIAS_NETPROTO(proto) \
287	MODULE_ALIAS("net-pf-" __stringify(proto))
288
289#define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
290	MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
291
292#define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
293	MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
294		     "-type-" __stringify(type))
295
296#define MODULE_ALIAS_NET_PF_PROTO_NAME(pf, proto, name) \
297	MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
298		     name)
299#endif	/* _LINUX_NET_H */
300