[mirror_ubuntu-jammy-kernel.git] / include / linux / net.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * NET		An implementation of the SOCKET network access protocol.
 *		This is the master header file for the Linux NET layer,
 *		or, in plain English: the networking handling part of the
 *		kernel.
 *
 * Version:	@(#)net.h	1.0.3	05/25/93
 *
 * Authors:	Orest Zborowski, <obz@Kodak.COM>
 *		Ross Biro
 *		Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
 */
#ifndef _LINUX_NET_H
#define _LINUX_NET_H

#include <linux/stringify.h>
#include <linux/random.h>
#include <linux/wait.h>
#include <linux/fcntl.h>	/* For O_CLOEXEC and O_NONBLOCK */
#include <linux/rcupdate.h>
#include <linux/once.h>
#include <linux/fs.h>
#include <linux/mm.h>
#include <linux/sockptr.h>

#include <uapi/linux/net.h>

struct poll_table_struct;
struct pipe_inode_info;
struct inode;
struct file;
struct net;

/* Historically, SOCKWQ_ASYNC_NOSPACE & SOCKWQ_ASYNC_WAITDATA were located
 * in sock->flags, but moved into sk->sk_wq->flags to be RCU protected.
 * Eventually all flags will be in sk->sk_wq->flags.
 */
#define SOCKWQ_ASYNC_NOSPACE	0
#define SOCKWQ_ASYNC_WAITDATA	1
#define SOCK_NOSPACE		2
#define SOCK_PASSCRED		3
#define SOCK_PASSSEC		4

#define PROTO_CMSG_DATA_ONLY	0x0001

#ifndef ARCH_HAS_SOCKET_TYPES
/**
 * enum sock_type - Socket types
 * @SOCK_STREAM: stream (connection) socket
 * @SOCK_DGRAM: datagram (conn.less) socket
 * @SOCK_RAW: raw socket
 * @SOCK_RDM: reliably-delivered message
 * @SOCK_SEQPACKET: sequential packet socket
 * @SOCK_DCCP: Datagram Congestion Control Protocol socket
 * @SOCK_PACKET: linux specific way of getting packets at the dev level.
 *		  For writing rarp and other similar things on the user level.
 *
 * When adding some new socket type please
 * grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
 * overrides this enum for binary compat reasons.
 */
enum sock_type {
	SOCK_STREAM	= 1,
	SOCK_DGRAM	= 2,
	SOCK_RAW	= 3,
	SOCK_RDM	= 4,
	SOCK_SEQPACKET	= 5,
	SOCK_DCCP	= 6,
	SOCK_PACKET	= 10,
};

#define SOCK_MAX (SOCK_PACKET + 1)
/* Mask which covers at least up to SOCK_MASK-1.  The
 * remaining bits are used as flags. */
#define SOCK_TYPE_MASK 0xf

/* Flags for socket, socketpair, accept4 */
#define SOCK_CLOEXEC	O_CLOEXEC
#ifndef SOCK_NONBLOCK
#define SOCK_NONBLOCK	O_NONBLOCK
#endif

#endif /* ARCH_HAS_SOCKET_TYPES */

/**
 * enum sock_shutdown_cmd - Shutdown types
 * @SHUT_RD: shutdown receptions
 * @SHUT_WR: shutdown transmissions
 * @SHUT_RDWR: shutdown receptions/transmissions
 */
enum sock_shutdown_cmd {
	SHUT_RD,
	SHUT_WR,
	SHUT_RDWR,
};

struct socket_wq {
	/* Note: wait MUST be first field of socket_wq */
	wait_queue_head_t	wait;
	struct fasync_struct	*fasync_list;
	unsigned long		flags; /* %SOCKWQ_ASYNC_NOSPACE, etc */
	struct rcu_head		rcu;
} ____cacheline_aligned_in_smp;

/**
 *  struct socket - general BSD socket
 *  @state: socket state (%SS_CONNECTED, etc)
 *  @type: socket type (%SOCK_STREAM, etc)
 *  @flags: socket flags (%SOCK_NOSPACE, etc)
 *  @ops: protocol specific socket operations
 *  @file: File back pointer for gc
 *  @sk: internal networking protocol agnostic socket representation
 *  @wq: wait queue for several uses
 */
struct socket {
	socket_state		state;

	short			type;

	unsigned long		flags;

	struct file		*file;
	struct sock		*sk;
	const struct proto_ops	*ops;

	struct socket_wq	wq;
};

struct vm_area_struct;
struct page;
struct sockaddr;
struct msghdr;
struct module;
struct sk_buff;
typedef int (*sk_read_actor_t)(read_descriptor_t *, struct sk_buff *,
			       unsigned int, size_t);

struct proto_ops {
	int		family;
	unsigned int	flags;
	struct module	*owner;
	int		(*release)   (struct socket *sock);
	int		(*bind)	     (struct socket *sock,
				      struct sockaddr *myaddr,
				      int sockaddr_len);
	int		(*connect)   (struct socket *sock,
				      struct sockaddr *vaddr,
				      int sockaddr_len, int flags);
	int		(*socketpair)(struct socket *sock1,
				      struct socket *sock2);
	int		(*accept)    (struct socket *sock,
				      struct socket *newsock, int flags, bool kern);
	int		(*getname)   (struct socket *sock,
				      struct sockaddr *addr,
				      int peer);
	__poll_t	(*poll)	     (struct file *file, struct socket *sock,
				      struct poll_table_struct *wait);
	int		(*ioctl)     (struct socket *sock, unsigned int cmd,
				      unsigned long arg);
#ifdef CONFIG_COMPAT
	int	 	(*compat_ioctl) (struct socket *sock, unsigned int cmd,
				      unsigned long arg);
#endif
	int		(*gettstamp) (struct socket *sock, void __user *userstamp,
				      bool timeval, bool time32);
	int		(*listen)    (struct socket *sock, int len);
	int		(*shutdown)  (struct socket *sock, int flags);
	int		(*setsockopt)(struct socket *sock, int level,
				      int optname, sockptr_t optval,
				      unsigned int optlen);
	int		(*getsockopt)(struct socket *sock, int level,
				      int optname, char __user *optval, int __user *optlen);
	void		(*show_fdinfo)(struct seq_file *m, struct socket *sock);
	int		(*sendmsg)   (struct socket *sock, struct msghdr *m,
				      size_t total_len);
	/* Notes for implementing recvmsg:
	 * ===============================
	 * msg->msg_namelen should get updated by the recvmsg handlers
	 * iff msg_name != NULL. It is by default 0 to prevent
	 * returning uninitialized memory to user space.  The recvfrom
	 * handlers can assume that msg.msg_name is either NULL or has
	 * a minimum size of sizeof(struct sockaddr_storage).
	 */
	int		(*recvmsg)   (struct socket *sock, struct msghdr *m,
				      size_t total_len, int flags);
	int		(*mmap)	     (struct file *file, struct socket *sock,
				      struct vm_area_struct * vma);
	ssize_t		(*sendpage)  (struct socket *sock, struct page *page,
				      int offset, size_t size, int flags);
	ssize_t 	(*splice_read)(struct socket *sock,  loff_t *ppos,
				       struct pipe_inode_info *pipe, size_t len, unsigned int flags);
	int		(*set_peek_off)(struct sock *sk, int val);
	int		(*peek_len)(struct socket *sock);

	/* The following functions are called internally by kernel with
	 * sock lock already held.
	 */
	int		(*read_sock)(struct sock *sk, read_descriptor_t *desc,
				     sk_read_actor_t recv_actor);
	int		(*sendpage_locked)(struct sock *sk, struct page *page,
					   int offset, size_t size, int flags);
	int		(*sendmsg_locked)(struct sock *sk, struct msghdr *msg,
					  size_t size);
	int		(*set_rcvlowat)(struct sock *sk, int val);
};

#define DECLARE_SOCKADDR(type, dst, src)	\
	type dst = ({ __sockaddr_check_size(sizeof(*dst)); (type) src; })

struct net_proto_family {
	int		family;
	int		(*create)(struct net *net, struct socket *sock,
				  int protocol, int kern);
	struct module	*owner;
};

struct iovec;
struct kvec;

enum {
	SOCK_WAKE_IO,
	SOCK_WAKE_WAITD,
	SOCK_WAKE_SPACE,
	SOCK_WAKE_URG,
};

int sock_wake_async(struct socket_wq *sk_wq, int how, int band);
int sock_register(const struct net_proto_family *fam);
void sock_unregister(int family);
bool sock_is_registered(int family);
int __sock_create(struct net *net, int family, int type, int proto,
		  struct socket **res, int kern);
int sock_create(int family, int type, int proto, struct socket **res);
int sock_create_kern(struct net *net, int family, int type, int proto, struct socket **res);
int sock_create_lite(int family, int type, int proto, struct socket **res);
struct socket *sock_alloc(void);
void sock_release(struct socket *sock);
int sock_sendmsg(struct socket *sock, struct msghdr *msg);
int sock_recvmsg(struct socket *sock, struct msghdr *msg, int flags);
struct file *sock_alloc_file(struct socket *sock, int flags, const char *dname);
struct socket *sockfd_lookup(int fd, int *err);
struct socket *sock_from_file(struct file *file);
#define		     sockfd_put(sock) fput(sock->file)
int net_ratelimit(void);

#define net_ratelimited_function(function, ...)			\
do {								\
	if (net_ratelimit())					\
		function(__VA_ARGS__);				\
} while (0)

#define net_emerg_ratelimited(fmt, ...)				\
	net_ratelimited_function(pr_emerg, fmt, ##__VA_ARGS__)
#define net_alert_ratelimited(fmt, ...)				\
	net_ratelimited_function(pr_alert, fmt, ##__VA_ARGS__)
#define net_crit_ratelimited(fmt, ...)				\
	net_ratelimited_function(pr_crit, fmt, ##__VA_ARGS__)
#define net_err_ratelimited(fmt, ...)				\
	net_ratelimited_function(pr_err, fmt, ##__VA_ARGS__)
#define net_notice_ratelimited(fmt, ...)			\
	net_ratelimited_function(pr_notice, fmt, ##__VA_ARGS__)
#define net_warn_ratelimited(fmt, ...)				\
	net_ratelimited_function(pr_warn, fmt, ##__VA_ARGS__)
#define net_info_ratelimited(fmt, ...)				\
	net_ratelimited_function(pr_info, fmt, ##__VA_ARGS__)
#if defined(CONFIG_DYNAMIC_DEBUG) || \
	(defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE))
#define net_dbg_ratelimited(fmt, ...)					\
do {									\
	DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt);			\
	if (DYNAMIC_DEBUG_BRANCH(descriptor) &&				\
	    net_ratelimit())						\
		__dynamic_pr_debug(&descriptor, pr_fmt(fmt),		\
		                   ##__VA_ARGS__);			\
} while (0)
#elif defined(DEBUG)
#define net_dbg_ratelimited(fmt, ...)				\
	net_ratelimited_function(pr_debug, fmt, ##__VA_ARGS__)
#else
#define net_dbg_ratelimited(fmt, ...)				\
	do {							\
		if (0)						\
			no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \
	} while (0)
#endif

#define net_get_random_once(buf, nbytes)			\
	get_random_once((buf), (nbytes))
#define net_get_random_once_wait(buf, nbytes)			\
	get_random_once_wait((buf), (nbytes))

/*
 * E.g. XFS meta- & log-data is in slab pages, or bcache meta
 * data pages, or other high order pages allocated by
 * __get_free_pages() without __GFP_COMP, which have a page_count
 * of 0 and/or have PageSlab() set. We cannot use send_page for
 * those, as that does get_page(); put_page(); and would cause
 * either a VM_BUG directly, or __page_cache_release a page that
 * would actually still be referenced by someone, leading to some
 * obscure delayed Oops somewhere else.
 */
static inline bool sendpage_ok(struct page *page)
{
	return !PageSlab(page) && page_count(page) >= 1;
}

int kernel_sendmsg(struct socket *sock, struct msghdr *msg, struct kvec *vec,
		   size_t num, size_t len);
int kernel_sendmsg_locked(struct sock *sk, struct msghdr *msg,
			  struct kvec *vec, size_t num, size_t len);
int kernel_recvmsg(struct socket *sock, struct msghdr *msg, struct kvec *vec,
		   size_t num, size_t len, int flags);

int kernel_bind(struct socket *sock, struct sockaddr *addr, int addrlen);
int kernel_listen(struct socket *sock, int backlog);
int kernel_accept(struct socket *sock, struct socket **newsock, int flags);
int kernel_connect(struct socket *sock, struct sockaddr *addr, int addrlen,
		   int flags);
int kernel_getsockname(struct socket *sock, struct sockaddr *addr);
int kernel_getpeername(struct socket *sock, struct sockaddr *addr);
int kernel_sendpage(struct socket *sock, struct page *page, int offset,
		    size_t size, int flags);
int kernel_sendpage_locked(struct sock *sk, struct page *page, int offset,
			   size_t size, int flags);
int kernel_sock_shutdown(struct socket *sock, enum sock_shutdown_cmd how);

/* Routine returns the IP overhead imposed by a (caller-protected) socket. */
u32 kernel_sock_ip_overhead(struct sock *sk);

#define MODULE_ALIAS_NETPROTO(proto) \
	MODULE_ALIAS("net-pf-" __stringify(proto))

#define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
	MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))

#define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
	MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
		     "-type-" __stringify(type))

#define MODULE_ALIAS_NET_PF_PROTO_NAME(pf, proto, name) \
	MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
		     name)
#endif	/* _LINUX_NET_H */
Commit	Line	Data
2874c5fd	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4 LT	2	/*
	3	* NET An implementation of the SOCKET network access protocol.
	4	* This is the master header file for the Linux NET layer,
	5	* or, in plain English: the networking handling part of the
	6	* kernel.
	7	*
	8	* Version: @(#)net.h 1.0.3 05/25/93
	9	*
	10	* Authors: Orest Zborowski, <obz@Kodak.COM>
02c30a84	11	* Ross Biro
1da177e4	12	* Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
1da177e4 LT	13	*/
	14	#ifndef _LINUX_NET_H
	15	#define _LINUX_NET_H
	16
eacf17bd	17	#include <linux/stringify.h>
cb4db4c2	18	#include <linux/random.h>
5770a3fb DW	19	#include <linux/wait.h>
5770a3fb DW	20	#include <linux/fcntl.h> /* For O_CLOEXEC and O_NONBLOCK */
43815482	21	#include <linux/rcupdate.h>
46234253	22	#include <linux/once.h>
0294b625	23	#include <linux/fs.h>
c381b079	24	#include <linux/mm.h>
a7b75c5a	25	#include <linux/sockptr.h>
46234253	26
607ca46e	27	#include <uapi/linux/net.h>
5770a3fb DW	28
	29	struct poll_table_struct;
	30	struct pipe_inode_info;
	31	struct inode;
56b31d1c	32	struct file;
5770a3fb	33	struct net;
1da177e4	34
ceb5d58b ED	35	/* Historically, SOCKWQ_ASYNC_NOSPACE & SOCKWQ_ASYNC_WAITDATA were located
ceb5d58b ED	36	* in sock->flags, but moved into sk->sk_wq->flags to be RCU protected.
b3dc8f77	37	* Eventually all flags will be in sk->sk_wq->flags.
ceb5d58b	38	*/
9cd3e072 ED	39	#define SOCKWQ_ASYNC_NOSPACE 0
9cd3e072 ED	40	#define SOCKWQ_ASYNC_WAITDATA 1
1da177e4 LT	41	#define SOCK_NOSPACE 2
1da177e4 LT	42	#define SOCK_PASSCRED 3
877ce7c1	43	#define SOCK_PASSSEC 4
1da177e4	44
583bbf06 LH	45	#define PROTO_CMSG_DATA_ONLY 0x0001
583bbf06 LH	46
1da177e4	47	#ifndef ARCH_HAS_SOCKET_TYPES
4dc3b16b PP	48	/**
	49	* enum sock_type - Socket types
	50	* @SOCK_STREAM: stream (connection) socket
	51	* @SOCK_DGRAM: datagram (conn.less) socket
	52	* @SOCK_RAW: raw socket
	53	* @SOCK_RDM: reliably-delivered message
	54	* @SOCK_SEQPACKET: sequential packet socket
8f2709b5	55	* @SOCK_DCCP: Datagram Congestion Control Protocol socket
4dc3b16b PP	56	* @SOCK_PACKET: linux specific way of getting packets at the dev level.
	57	* For writing rarp and other similar things on the user level.
	58	*
1da177e4 LT	59	* When adding some new socket type please
	60	* grep ARCH_HAS_SOCKET_TYPE include/asm-* /socket.h, at least MIPS
	61	* overrides this enum for binary compat reasons.
1da177e4 LT	62	*/
	63	enum sock_type {
	64	SOCK_STREAM = 1,
	65	SOCK_DGRAM = 2,
	66	SOCK_RAW = 3,
	67	SOCK_RDM = 4,
	68	SOCK_SEQPACKET = 5,
7c657876	69	SOCK_DCCP = 6,
1da177e4 LT	70	SOCK_PACKET = 10,
	71	};
	72
	73	#define SOCK_MAX (SOCK_PACKET + 1)
a677a039 UD	74	/* Mask which covers at least up to SOCK_MASK-1. The
	75	* remaining bits are used as flags. */
	76	#define SOCK_TYPE_MASK 0xf
	77
de11defe	78	/* Flags for socket, socketpair, accept4 */
a677a039	79	#define SOCK_CLOEXEC O_CLOEXEC
c019bbc6 UD	80	#ifndef SOCK_NONBLOCK
	81	#define SOCK_NONBLOCK O_NONBLOCK
	82	#endif
1da177e4 LT	83
	84	#endif /* ARCH_HAS_SOCKET_TYPES */
	85
8a3c245c PT	86	/**
	87	* enum sock_shutdown_cmd - Shutdown types
	88	* @SHUT_RD: shutdown receptions
	89	* @SHUT_WR: shutdown transmissions
	90	* @SHUT_RDWR: shutdown receptions/transmissions
	91	*/
91cf45f0	92	enum sock_shutdown_cmd {
0e9649c1 JS	93	SHUT_RD,
	94	SHUT_WR,
	95	SHUT_RDWR,
91cf45f0 TM	96	};
91cf45f0 TM	97
43815482	98	struct socket_wq {
eaefd110	99	/* Note: wait MUST be first field of socket_wq */
43815482 ED	100	wait_queue_head_t wait;
43815482 ED	101	struct fasync_struct *fasync_list;
ceb5d58b	102	unsigned long flags; /* %SOCKWQ_ASYNC_NOSPACE, etc */
43815482 ED	103	struct rcu_head rcu;
	104	} ____cacheline_aligned_in_smp;
	105
1da177e4 LT	106	/**
1da177e4 LT	107	* struct socket - general BSD socket
4dc3b16b	108	* @state: socket state (%SS_CONNECTED, etc)
2c693610	109	* @type: socket type (%SOCK_STREAM, etc)
9cd3e072	110	* @flags: socket flags (%SOCK_NOSPACE, etc)
4dc3b16b	111	* @ops: protocol specific socket operations
4dc3b16b PP	112	* @file: File back pointer for gc
4dc3b16b PP	113	* @sk: internal networking protocol agnostic socket representation
e2aec372	114	* @wq: wait queue for several uses
1da177e4 LT	115	*/
	116	struct socket {
	117	socket_state state;
29a020d3	118
2c693610	119	short type;
29a020d3	120
1da177e4	121	unsigned long flags;
43815482	122
1da177e4 LT	123	struct file *file;
1da177e4 LT	124	struct sock *sk;
8bdd663a	125	const struct proto_ops *ops;
333f7909 AV	126
333f7909 AV	127	struct socket_wq wq;
1da177e4 LT	128	};
	129
	130	struct vm_area_struct;
	131	struct page;
1da177e4 LT	132	struct sockaddr;
	133	struct msghdr;
	134	struct module;
0294b625 TH	135	struct sk_buff;
	136	typedef int (sk_read_actor_t)(read_descriptor_t , struct sk_buff *,
	137	unsigned int, size_t);
1da177e4 LT	138
	139	struct proto_ops {
	140	int family;
583bbf06	141	unsigned int flags;
1da177e4 LT	142	struct module *owner;
	143	int (release) (struct socket sock);
	144	int (bind) (struct socket sock,
	145	struct sockaddr *myaddr,
	146	int sockaddr_len);
	147	int (connect) (struct socket sock,
	148	struct sockaddr *vaddr,
	149	int sockaddr_len, int flags);
	150	int (socketpair)(struct socket sock1,
	151	struct socket *sock2);
	152	int (accept) (struct socket sock,
cdfbabfb	153	struct socket *newsock, int flags, bool kern);
1da177e4 LT	154	int (getname) (struct socket sock,
1da177e4 LT	155	struct sockaddr *addr,
9b2c45d4	156	int peer);
a3f8683b	157	__poll_t (poll) (struct file file, struct socket *sock,
1da177e4 LT	158	struct poll_table_struct *wait);
	159	int (ioctl) (struct socket sock, unsigned int cmd,
	160	unsigned long arg);
1621e094	161	#ifdef CONFIG_COMPAT
89bbfc95 SP	162	int (compat_ioctl) (struct socket sock, unsigned int cmd,
89bbfc95 SP	163	unsigned long arg);
1621e094	164	#endif
c7cbdbf2 AB	165	int (gettstamp) (struct socket sock, void __user *userstamp,
c7cbdbf2 AB	166	bool timeval, bool time32);
1da177e4 LT	167	int (listen) (struct socket sock, int len);
	168	int (shutdown) (struct socket sock, int flags);
	169	int (setsockopt)(struct socket sock, int level,
a7b75c5a CH	170	int optname, sockptr_t optval,
a7b75c5a CH	171	unsigned int optlen);
1da177e4 LT	172	int (getsockopt)(struct socket sock, int level,
1da177e4 LT	173	int optname, char __user optval, int __user optlen);
b4653342	174	void (show_fdinfo)(struct seq_file m, struct socket *sock);
1b784140 YX	175	int (sendmsg) (struct socket sock, struct msghdr *m,
1b784140 YX	176	size_t total_len);
f3d33426 HFS	177	/* Notes for implementing recvmsg:
	178	* ===============================
	179	* msg->msg_namelen should get updated by the recvmsg handlers
	180	* iff msg_name != NULL. It is by default 0 to prevent
	181	* returning uninitialized memory to user space. The recvfrom
	182	* handlers can assume that msg.msg_name is either NULL or has
	183	* a minimum size of sizeof(struct sockaddr_storage).
	184	*/
1b784140 YX	185	int (recvmsg) (struct socket sock, struct msghdr *m,
1b784140 YX	186	size_t total_len, int flags);
1da177e4 LT	187	int (mmap) (struct file file, struct socket *sock,
	188	struct vm_area_struct * vma);
	189	ssize_t (sendpage) (struct socket sock, struct page *page,
	190	int offset, size_t size, int flags);
9c55e01c JA	191	ssize_t (splice_read)(struct socket sock, loff_t *ppos,
9c55e01c JA	192	struct pipe_inode_info *pipe, size_t len, unsigned int flags);
12663bfc	193	int (set_peek_off)(struct sock sk, int val);
1576d986	194	int (peek_len)(struct socket sock);
306b13eb TH	195
	196	/* The following functions are called internally by kernel with
	197	* sock lock already held.
	198	*/
0294b625 TH	199	int (read_sock)(struct sock sk, read_descriptor_t *desc,
0294b625 TH	200	sk_read_actor_t recv_actor);
306b13eb TH	201	int (sendpage_locked)(struct sock sk, struct page *page,
	202	int offset, size_t size, int flags);
	203	int (sendmsg_locked)(struct sock sk, struct msghdr *msg,
	204	size_t size);
d1361840	205	int (set_rcvlowat)(struct sock sk, int val);
1da177e4 LT	206	};
1da177e4 LT	207
38bfd8f5 CG	208	#define DECLARE_SOCKADDR(type, dst, src) \
	209	type dst = ({ __sockaddr_check_size(sizeof(*dst)); (type) src; })
	210
1da177e4 LT	211	struct net_proto_family {
1da177e4 LT	212	int family;
3f378b68 EP	213	int (create)(struct net net, struct socket *sock,
3f378b68 EP	214	int protocol, int kern);
1da177e4 LT	215	struct module *owner;
	216	};
	217
	218	struct iovec;
	219	struct kvec;
	220
8d8ad9d7 PE	221	enum {
	222	SOCK_WAKE_IO,
	223	SOCK_WAKE_WAITD,
	224	SOCK_WAKE_SPACE,
	225	SOCK_WAKE_URG,
	226	};
	227
ceb5d58b	228	int sock_wake_async(struct socket_wq *sk_wq, int how, int band);
7965bd4d JP	229	int sock_register(const struct net_proto_family *fam);
7965bd4d JP	230	void sock_unregister(int family);
bf2ae2e4	231	bool sock_is_registered(int family);
7965bd4d JP	232	int __sock_create(struct net *net, int family, int type, int proto,
	233	struct socket **res, int kern);
	234	int sock_create(int family, int type, int proto, struct socket **res);
eeb1bd5c	235	int sock_create_kern(struct net net, int family, int type, int proto, struct socket *res);
7965bd4d	236	int sock_create_lite(int family, int type, int proto, struct socket **res);
f4a00aac	237	struct socket *sock_alloc(void);
7965bd4d	238	void sock_release(struct socket *sock);
d8725c86	239	int sock_sendmsg(struct socket sock, struct msghdr msg);
2da62906	240	int sock_recvmsg(struct socket sock, struct msghdr msg, int flags);
7965bd4d JP	241	struct file sock_alloc_file(struct socket sock, int flags, const char *dname);
7965bd4d JP	242	struct socket sockfd_lookup(int fd, int err);
dba4a925	243	struct socket sock_from_file(struct file file);
1da177e4	244	#define sockfd_put(sock) fput(sock->file)
7965bd4d	245	int net_ratelimit(void);
aaa248f6	246
3a3bfb61 JP	247	#define net_ratelimited_function(function, ...) \
	248	do { \
	249	if (net_ratelimit()) \
	250	function(__VA_ARGS__); \
	251	} while (0)
	252
	253	#define net_emerg_ratelimited(fmt, ...) \
	254	net_ratelimited_function(pr_emerg, fmt, ##__VA_ARGS__)
	255	#define net_alert_ratelimited(fmt, ...) \
	256	net_ratelimited_function(pr_alert, fmt, ##__VA_ARGS__)
	257	#define net_crit_ratelimited(fmt, ...) \
	258	net_ratelimited_function(pr_crit, fmt, ##__VA_ARGS__)
	259	#define net_err_ratelimited(fmt, ...) \
	260	net_ratelimited_function(pr_err, fmt, ##__VA_ARGS__)
	261	#define net_notice_ratelimited(fmt, ...) \
	262	net_ratelimited_function(pr_notice, fmt, ##__VA_ARGS__)
	263	#define net_warn_ratelimited(fmt, ...) \
	264	net_ratelimited_function(pr_warn, fmt, ##__VA_ARGS__)
	265	#define net_info_ratelimited(fmt, ...) \
	266	net_ratelimited_function(pr_info, fmt, ##__VA_ARGS__)
ceabef7d OZ	267	#if defined(CONFIG_DYNAMIC_DEBUG) \|\| \
ceabef7d OZ	268	(defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE))
2c94b537 TB	269	#define net_dbg_ratelimited(fmt, ...) \
	270	do { \
	271	DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
3f16d181	272	if (DYNAMIC_DEBUG_BRANCH(descriptor) && \
2c94b537	273	net_ratelimit()) \
daddef76 JD	274	__dynamic_pr_debug(&descriptor, pr_fmt(fmt), \
daddef76 JD	275	##__VA_ARGS__); \
2c94b537 TB	276	} while (0)
2c94b537 TB	277	#elif defined(DEBUG)
3a3bfb61 JP	278	#define net_dbg_ratelimited(fmt, ...) \
3a3bfb61 JP	279	net_ratelimited_function(pr_debug, fmt, ##__VA_ARGS__)
d92cff89 JD	280	#else
	281	#define net_dbg_ratelimited(fmt, ...) \
	282	do { \
	283	if (0) \
	284	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); \
	285	} while (0)
	286	#endif
3a3bfb61	287
46234253 HFS	288	#define net_get_random_once(buf, nbytes) \
46234253 HFS	289	get_random_once((buf), (nbytes))
da9ba564 JD	290	#define net_get_random_once_wait(buf, nbytes) \
da9ba564 JD	291	get_random_once_wait((buf), (nbytes))
a48e4292	292
c381b079 CL	293	/*
	294	* E.g. XFS meta- & log-data is in slab pages, or bcache meta
	295	* data pages, or other high order pages allocated by
	296	* __get_free_pages() without __GFP_COMP, which have a page_count
	297	* of 0 and/or have PageSlab() set. We cannot use send_page for
	298	* those, as that does get_page(); put_page(); and would cause
	299	* either a VM_BUG directly, or __page_cache_release a page that
	300	* would actually still be referenced by someone, leading to some
	301	* obscure delayed Oops somewhere else.
	302	*/
	303	static inline bool sendpage_ok(struct page *page)
	304	{
	305	return !PageSlab(page) && page_count(page) >= 1;
	306	}
	307
7965bd4d JP	308	int kernel_sendmsg(struct socket sock, struct msghdr msg, struct kvec *vec,
7965bd4d JP	309	size_t num, size_t len);
306b13eb TH	310	int kernel_sendmsg_locked(struct sock sk, struct msghdr msg,
306b13eb TH	311	struct kvec *vec, size_t num, size_t len);
7965bd4d JP	312	int kernel_recvmsg(struct socket sock, struct msghdr msg, struct kvec *vec,
7965bd4d JP	313	size_t num, size_t len, int flags);
1da177e4	314
7965bd4d JP	315	int kernel_bind(struct socket sock, struct sockaddr addr, int addrlen);
	316	int kernel_listen(struct socket *sock, int backlog);
	317	int kernel_accept(struct socket sock, struct socket *newsock, int flags);
	318	int kernel_connect(struct socket sock, struct sockaddr addr, int addrlen,
	319	int flags);
9b2c45d4 DV	320	int kernel_getsockname(struct socket sock, struct sockaddr addr);
9b2c45d4 DV	321	int kernel_getpeername(struct socket sock, struct sockaddr addr);
7965bd4d JP	322	int kernel_sendpage(struct socket sock, struct page page, int offset,
7965bd4d JP	323	size_t size, int flags);
306b13eb TH	324	int kernel_sendpage_locked(struct sock sk, struct page page, int offset,
306b13eb TH	325	size_t size, int flags);
7965bd4d	326	int kernel_sock_shutdown(struct socket *sock, enum sock_shutdown_cmd how);
ac5a488e	327
57240d00	328	/* Routine returns the IP overhead imposed by a (caller-protected) socket. */
113c3075 P	329	u32 kernel_sock_ip_overhead(struct sock *sk);
113c3075 P	330
1da177e4 LT	331	#define MODULE_ALIAS_NETPROTO(proto) \
	332	MODULE_ALIAS("net-pf-" __stringify(proto))
	333
4fdb3bb7 HW	334	#define MODULE_ALIAS_NET_PF_PROTO(pf, proto) \
	335	MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto))
	336
305e1e96 JD	337	#define MODULE_ALIAS_NET_PF_PROTO_TYPE(pf, proto, type) \
	338	MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
	339	"-type-" __stringify(type))
	340
2033e9bf NH	341	#define MODULE_ALIAS_NET_PF_PROTO_NAME(pf, proto, name) \
	342	MODULE_ALIAS("net-pf-" __stringify(pf) "-proto-" __stringify(proto) \
	343	name)
1da177e4	344	#endif /* _LINUX_NET_H */