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

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _LINUX_SOCKET_H
#define _LINUX_SOCKET_H


#include <asm/socket.h>			/* arch-dependent defines	*/
#include <linux/sockios.h>		/* the SIOCxxx I/O controls	*/
#include <linux/uio.h>			/* iovec support		*/
#include <linux/types.h>		/* pid_t			*/
#include <linux/compiler.h>		/* __user			*/
#include <uapi/linux/socket.h>

struct pid;
struct cred;
struct socket;

#define __sockaddr_check_size(size)	\
	BUILD_BUG_ON(((size) > sizeof(struct __kernel_sockaddr_storage)))

#ifdef CONFIG_PROC_FS
struct seq_file;
extern void socket_seq_show(struct seq_file *seq);
#endif

typedef __kernel_sa_family_t	sa_family_t;

/*
 *	1003.1g requires sa_family_t and that sa_data is char.
 */

struct sockaddr {
	sa_family_t	sa_family;	/* address family, AF_xxx	*/
	char		sa_data[14];	/* 14 bytes of protocol address	*/
};

struct linger {
	int		l_onoff;	/* Linger active		*/
	int		l_linger;	/* How long to linger for	*/
};

#define sockaddr_storage __kernel_sockaddr_storage

/*
 *	As we do 4.4BSD message passing we use a 4.4BSD message passing
 *	system, not 4.3. Thus msg_accrights(len) are now missing. They
 *	belong in an obscure libc emulation or the bin.
 */

struct msghdr {
	void		*msg_name;	/* ptr to socket address structure */
	int		msg_namelen;	/* size of socket address structure */
	struct iov_iter	msg_iter;	/* data */

	/*
	 * Ancillary data. msg_control_user is the user buffer used for the
	 * recv* side when msg_control_is_user is set, msg_control is the kernel
	 * buffer used for all other cases.
	 */
	union {
		void		*msg_control;
		void __user	*msg_control_user;
	};
	bool		msg_control_is_user : 1;
	__kernel_size_t	msg_controllen;	/* ancillary data buffer length */
	unsigned int	msg_flags;	/* flags on received message */
	struct kiocb	*msg_iocb;	/* ptr to iocb for async requests */
};

struct user_msghdr {
	void		__user *msg_name;	/* ptr to socket address structure */
	int		msg_namelen;		/* size of socket address structure */
	struct iovec	__user *msg_iov;	/* scatter/gather array */
	__kernel_size_t	msg_iovlen;		/* # elements in msg_iov */
	void		__user *msg_control;	/* ancillary data */
	__kernel_size_t	msg_controllen;		/* ancillary data buffer length */
	unsigned int	msg_flags;		/* flags on received message */
};

/* For recvmmsg/sendmmsg */
struct mmsghdr {
	struct user_msghdr  msg_hdr;
	unsigned int        msg_len;
};

/*
 *	POSIX 1003.1g - ancillary data object information
 *	Ancillary data consits of a sequence of pairs of
 *	(cmsghdr, cmsg_data[])
 */

struct cmsghdr {
	__kernel_size_t	cmsg_len;	/* data byte count, including hdr */
        int		cmsg_level;	/* originating protocol */
        int		cmsg_type;	/* protocol-specific type */
};

/*
 *	Ancillary data object information MACROS
 *	Table 5-14 of POSIX 1003.1g
 */

#define __CMSG_NXTHDR(ctl, len, cmsg) __cmsg_nxthdr((ctl),(len),(cmsg))
#define CMSG_NXTHDR(mhdr, cmsg) cmsg_nxthdr((mhdr), (cmsg))

#define CMSG_ALIGN(len) ( ((len)+sizeof(long)-1) & ~(sizeof(long)-1) )

#define CMSG_DATA(cmsg) \
	((void *)(cmsg) + sizeof(struct cmsghdr))
#define CMSG_USER_DATA(cmsg) \
	((void __user *)(cmsg) + sizeof(struct cmsghdr))
#define CMSG_SPACE(len) (sizeof(struct cmsghdr) + CMSG_ALIGN(len))
#define CMSG_LEN(len) (sizeof(struct cmsghdr) + (len))

#define __CMSG_FIRSTHDR(ctl,len) ((len) >= sizeof(struct cmsghdr) ? \
				  (struct cmsghdr *)(ctl) : \
				  (struct cmsghdr *)NULL)
#define CMSG_FIRSTHDR(msg)	__CMSG_FIRSTHDR((msg)->msg_control, (msg)->msg_controllen)
#define CMSG_OK(mhdr, cmsg) ((cmsg)->cmsg_len >= sizeof(struct cmsghdr) && \
			     (cmsg)->cmsg_len <= (unsigned long) \
			     ((mhdr)->msg_controllen - \
			      ((char *)(cmsg) - (char *)(mhdr)->msg_control)))
#define for_each_cmsghdr(cmsg, msg) \
	for (cmsg = CMSG_FIRSTHDR(msg); \
	     cmsg; \
	     cmsg = CMSG_NXTHDR(msg, cmsg))

/*
 *	Get the next cmsg header
 *
 *	PLEASE, do not touch this function. If you think, that it is
 *	incorrect, grep kernel sources and think about consequences
 *	before trying to improve it.
 *
 *	Now it always returns valid, not truncated ancillary object
 *	HEADER. But caller still MUST check, that cmsg->cmsg_len is
 *	inside range, given by msg->msg_controllen before using
 *	ancillary object DATA.				--ANK (980731)
 */

static inline struct cmsghdr * __cmsg_nxthdr(void *__ctl, __kernel_size_t __size,
					       struct cmsghdr *__cmsg)
{
	struct cmsghdr * __ptr;

	__ptr = (struct cmsghdr*)(((unsigned char *) __cmsg) +  CMSG_ALIGN(__cmsg->cmsg_len));
	if ((unsigned long)((char*)(__ptr+1) - (char *) __ctl) > __size)
		return (struct cmsghdr *)0;

	return __ptr;
}

static inline struct cmsghdr * cmsg_nxthdr (struct msghdr *__msg, struct cmsghdr *__cmsg)
{
	return __cmsg_nxthdr(__msg->msg_control, __msg->msg_controllen, __cmsg);
}

static inline size_t msg_data_left(struct msghdr *msg)
{
	return iov_iter_count(&msg->msg_iter);
}

/* "Socket"-level control message types: */

#define	SCM_RIGHTS	0x01		/* rw: access rights (array of int) */
#define SCM_CREDENTIALS 0x02		/* rw: struct ucred		*/
#define SCM_SECURITY	0x03		/* rw: security label		*/

struct ucred {
	__u32	pid;
	__u32	uid;
	__u32	gid;
};

/* Supported address families. */
#define AF_UNSPEC	0
#define AF_UNIX		1	/* Unix domain sockets 		*/
#define AF_LOCAL	1	/* POSIX name for AF_UNIX	*/
#define AF_INET		2	/* Internet IP Protocol 	*/
#define AF_AX25		3	/* Amateur Radio AX.25 		*/
#define AF_IPX		4	/* Novell IPX 			*/
#define AF_APPLETALK	5	/* AppleTalk DDP 		*/
#define AF_NETROM	6	/* Amateur Radio NET/ROM 	*/
#define AF_BRIDGE	7	/* Multiprotocol bridge 	*/
#define AF_ATMPVC	8	/* ATM PVCs			*/
#define AF_X25		9	/* Reserved for X.25 project 	*/
#define AF_INET6	10	/* IP version 6			*/
#define AF_ROSE		11	/* Amateur Radio X.25 PLP	*/
#define AF_DECnet	12	/* Reserved for DECnet project	*/
#define AF_NETBEUI	13	/* Reserved for 802.2LLC project*/
#define AF_SECURITY	14	/* Security callback pseudo AF */
#define AF_KEY		15      /* PF_KEY key management API */
#define AF_NETLINK	16
#define AF_ROUTE	AF_NETLINK /* Alias to emulate 4.4BSD */
#define AF_PACKET	17	/* Packet family		*/
#define AF_ASH		18	/* Ash				*/
#define AF_ECONET	19	/* Acorn Econet			*/
#define AF_ATMSVC	20	/* ATM SVCs			*/
#define AF_RDS		21	/* RDS sockets 			*/
#define AF_SNA		22	/* Linux SNA Project (nutters!) */
#define AF_IRDA		23	/* IRDA sockets			*/
#define AF_PPPOX	24	/* PPPoX sockets		*/
#define AF_WANPIPE	25	/* Wanpipe API Sockets */
#define AF_LLC		26	/* Linux LLC			*/
#define AF_IB		27	/* Native InfiniBand address	*/
#define AF_MPLS		28	/* MPLS */
#define AF_CAN		29	/* Controller Area Network      */
#define AF_TIPC		30	/* TIPC sockets			*/
#define AF_BLUETOOTH	31	/* Bluetooth sockets 		*/
#define AF_IUCV		32	/* IUCV sockets			*/
#define AF_RXRPC	33	/* RxRPC sockets 		*/
#define AF_ISDN		34	/* mISDN sockets 		*/
#define AF_PHONET	35	/* Phonet sockets		*/
#define AF_IEEE802154	36	/* IEEE802154 sockets		*/
#define AF_CAIF		37	/* CAIF sockets			*/
#define AF_ALG		38	/* Algorithm sockets		*/
#define AF_NFC		39	/* NFC sockets			*/
#define AF_VSOCK	40	/* vSockets			*/
#define AF_KCM		41	/* Kernel Connection Multiplexor*/
#define AF_QIPCRTR	42	/* Qualcomm IPC Router          */
#define AF_SMC		43	/* smc sockets: reserve number for
				 * PF_SMC protocol family that
				 * reuses AF_INET address family
				 */
#define AF_XDP		44	/* XDP sockets			*/

#define AF_MAX		45	/* For now.. */

/* Protocol families, same as address families. */
#define PF_UNSPEC	AF_UNSPEC
#define PF_UNIX		AF_UNIX
#define PF_LOCAL	AF_LOCAL
#define PF_INET		AF_INET
#define PF_AX25		AF_AX25
#define PF_IPX		AF_IPX
#define PF_APPLETALK	AF_APPLETALK
#define	PF_NETROM	AF_NETROM
#define PF_BRIDGE	AF_BRIDGE
#define PF_ATMPVC	AF_ATMPVC
#define PF_X25		AF_X25
#define PF_INET6	AF_INET6
#define PF_ROSE		AF_ROSE
#define PF_DECnet	AF_DECnet
#define PF_NETBEUI	AF_NETBEUI
#define PF_SECURITY	AF_SECURITY
#define PF_KEY		AF_KEY
#define PF_NETLINK	AF_NETLINK
#define PF_ROUTE	AF_ROUTE
#define PF_PACKET	AF_PACKET
#define PF_ASH		AF_ASH
#define PF_ECONET	AF_ECONET
#define PF_ATMSVC	AF_ATMSVC
#define PF_RDS		AF_RDS
#define PF_SNA		AF_SNA
#define PF_IRDA		AF_IRDA
#define PF_PPPOX	AF_PPPOX
#define PF_WANPIPE	AF_WANPIPE
#define PF_LLC		AF_LLC
#define PF_IB		AF_IB
#define PF_MPLS		AF_MPLS
#define PF_CAN		AF_CAN
#define PF_TIPC		AF_TIPC
#define PF_BLUETOOTH	AF_BLUETOOTH
#define PF_IUCV		AF_IUCV
#define PF_RXRPC	AF_RXRPC
#define PF_ISDN		AF_ISDN
#define PF_PHONET	AF_PHONET
#define PF_IEEE802154	AF_IEEE802154
#define PF_CAIF		AF_CAIF
#define PF_ALG		AF_ALG
#define PF_NFC		AF_NFC
#define PF_VSOCK	AF_VSOCK
#define PF_KCM		AF_KCM
#define PF_QIPCRTR	AF_QIPCRTR
#define PF_SMC		AF_SMC
#define PF_XDP		AF_XDP
#define PF_MAX		AF_MAX

/* Maximum queue length specifiable by listen.  */
#define SOMAXCONN	4096

/* Flags we can use with send/ and recv.
   Added those for 1003.1g not all are supported yet
 */

#define MSG_OOB		1
#define MSG_PEEK	2
#define MSG_DONTROUTE	4
#define MSG_TRYHARD     4       /* Synonym for MSG_DONTROUTE for DECnet */
#define MSG_CTRUNC	8
#define MSG_PROBE	0x10	/* Do not send. Only probe path f.e. for MTU */
#define MSG_TRUNC	0x20
#define MSG_DONTWAIT	0x40	/* Nonblocking io		 */
#define MSG_EOR         0x80	/* End of record */
#define MSG_WAITALL	0x100	/* Wait for a full request */
#define MSG_FIN         0x200
#define MSG_SYN		0x400
#define MSG_CONFIRM	0x800	/* Confirm path validity */
#define MSG_RST		0x1000
#define MSG_ERRQUEUE	0x2000	/* Fetch message from error queue */
#define MSG_NOSIGNAL	0x4000	/* Do not generate SIGPIPE */
#define MSG_MORE	0x8000	/* Sender will send more */
#define MSG_WAITFORONE	0x10000	/* recvmmsg(): block until 1+ packets avail */
#define MSG_SENDPAGE_NOPOLICY 0x10000 /* sendpage() internal : do no apply policy */
#define MSG_SENDPAGE_NOTLAST 0x20000 /* sendpage() internal : not the last page */
#define MSG_BATCH	0x40000 /* sendmmsg(): more messages coming */
#define MSG_EOF         MSG_FIN
#define MSG_NO_SHARED_FRAGS 0x80000 /* sendpage() internal : page frags are not shared */
#define MSG_SENDPAGE_DECRYPTED	0x100000 /* sendpage() internal : page may carry
					  * plain text and require encryption
					  */

#define MSG_ZEROCOPY	0x4000000	/* Use user data in kernel path */
#define MSG_FASTOPEN	0x20000000	/* Send data in TCP SYN */
#define MSG_CMSG_CLOEXEC 0x40000000	/* Set close_on_exec for file
					   descriptor received through
					   SCM_RIGHTS */
#if defined(CONFIG_COMPAT)
#define MSG_CMSG_COMPAT	0x80000000	/* This message needs 32 bit fixups */
#else
#define MSG_CMSG_COMPAT	0		/* We never have 32 bit fixups */
#endif


/* Setsockoptions(2) level. Thanks to BSD these must match IPPROTO_xxx */
#define SOL_IP		0
/* #define SOL_ICMP	1	No-no-no! Due to Linux :-) we cannot use SOL_ICMP=1 */
#define SOL_TCP		6
#define SOL_UDP		17
#define SOL_IPV6	41
#define SOL_ICMPV6	58
#define SOL_SCTP	132
#define SOL_UDPLITE	136     /* UDP-Lite (RFC 3828) */
#define SOL_RAW		255
#define SOL_IPX		256
#define SOL_AX25	257
#define SOL_ATALK	258
#define SOL_NETROM	259
#define SOL_ROSE	260
#define SOL_DECNET	261
#define	SOL_X25		262
#define SOL_PACKET	263
#define SOL_ATM		264	/* ATM layer (cell level) */
#define SOL_AAL		265	/* ATM Adaption Layer (packet level) */
#define SOL_IRDA        266
#define SOL_NETBEUI	267
#define SOL_LLC		268
#define SOL_DCCP	269
#define SOL_NETLINK	270
#define SOL_TIPC	271
#define SOL_RXRPC	272
#define SOL_PPPOL2TP	273
#define SOL_BLUETOOTH	274
#define SOL_PNPIPE	275
#define SOL_RDS		276
#define SOL_IUCV	277
#define SOL_CAIF	278
#define SOL_ALG		279
#define SOL_NFC		280
#define SOL_KCM		281
#define SOL_TLS		282
#define SOL_XDP		283

/* IPX options */
#define IPX_TYPE	1

extern int move_addr_to_kernel(void __user *uaddr, int ulen, struct sockaddr_storage *kaddr);
extern int put_cmsg(struct msghdr*, int level, int type, int len, void *data);

struct timespec64;
struct __kernel_timespec;
struct old_timespec32;

struct scm_timestamping_internal {
	struct timespec64 ts[3];
};

extern void put_cmsg_scm_timestamping64(struct msghdr *msg, struct scm_timestamping_internal *tss);
extern void put_cmsg_scm_timestamping(struct msghdr *msg, struct scm_timestamping_internal *tss);

/* The __sys_...msg variants allow MSG_CMSG_COMPAT iff
 * forbid_cmsg_compat==false
 */
extern long __sys_recvmsg(int fd, struct user_msghdr __user *msg,
			  unsigned int flags, bool forbid_cmsg_compat);
extern long __sys_sendmsg(int fd, struct user_msghdr __user *msg,
			  unsigned int flags, bool forbid_cmsg_compat);
extern int __sys_recvmmsg(int fd, struct mmsghdr __user *mmsg,
			  unsigned int vlen, unsigned int flags,
			  struct __kernel_timespec __user *timeout,
			  struct old_timespec32 __user *timeout32);
extern int __sys_sendmmsg(int fd, struct mmsghdr __user *mmsg,
			  unsigned int vlen, unsigned int flags,
			  bool forbid_cmsg_compat);
extern long __sys_sendmsg_sock(struct socket *sock, struct msghdr *msg,
			       unsigned int flags);
extern long __sys_recvmsg_sock(struct socket *sock, struct msghdr *msg,
			       struct user_msghdr __user *umsg,
			       struct sockaddr __user *uaddr,
			       unsigned int flags);
extern int sendmsg_copy_msghdr(struct msghdr *msg,
			       struct user_msghdr __user *umsg, unsigned flags,
			       struct iovec **iov);
extern int recvmsg_copy_msghdr(struct msghdr *msg,
			       struct user_msghdr __user *umsg, unsigned flags,
			       struct sockaddr __user **uaddr,
			       struct iovec **iov);
extern int __copy_msghdr_from_user(struct msghdr *kmsg,
				   struct user_msghdr __user *umsg,
				   struct sockaddr __user **save_addr,
				   struct iovec __user **uiov, size_t *nsegs);

/* helpers which do the actual work for syscalls */
extern int __sys_recvfrom(int fd, void __user *ubuf, size_t size,
			  unsigned int flags, struct sockaddr __user *addr,
			  int __user *addr_len);
extern int __sys_sendto(int fd, void __user *buff, size_t len,
			unsigned int flags, struct sockaddr __user *addr,
			int addr_len);
extern int __sys_accept4_file(struct file *file, unsigned file_flags,
			struct sockaddr __user *upeer_sockaddr,
			 int __user *upeer_addrlen, int flags,
			 unsigned long nofile);
extern int __sys_accept4(int fd, struct sockaddr __user *upeer_sockaddr,
			 int __user *upeer_addrlen, int flags);
extern int __sys_socket(int family, int type, int protocol);
extern int __sys_bind(int fd, struct sockaddr __user *umyaddr, int addrlen);
extern int __sys_connect_file(struct file *file, struct sockaddr_storage *addr,
			      int addrlen, int file_flags);
extern int __sys_connect(int fd, struct sockaddr __user *uservaddr,
			 int addrlen);
extern int __sys_listen(int fd, int backlog);
extern int __sys_getsockname(int fd, struct sockaddr __user *usockaddr,
			     int __user *usockaddr_len);
extern int __sys_getpeername(int fd, struct sockaddr __user *usockaddr,
			     int __user *usockaddr_len);
extern int __sys_socketpair(int family, int type, int protocol,
			    int __user *usockvec);
extern int __sys_shutdown(int fd, int how);

extern struct ns_common *get_net_ns(struct ns_common *ns);
#endif /* _LINUX_SOCKET_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	#ifndef _LINUX_SOCKET_H
	3	#define _LINUX_SOCKET_H
	4
1da177e4	5
1da177e4 LT	6	#include <asm/socket.h> /* arch-dependent defines */
	7	#include <linux/sockios.h> /* the SIOCxxx I/O controls */
	8	#include <linux/uio.h> /* iovec support */
	9	#include <linux/types.h> /* pid_t */
	10	#include <linux/compiler.h> /* __user */
607ca46e	11	#include <uapi/linux/socket.h>
1da177e4	12
3f551f94 EB	13	struct pid;
3f551f94 EB	14	struct cred;
0fa03c62	15	struct socket;
3f551f94	16
38bfd8f5 CG	17	#define __sockaddr_check_size(size) \
	18	BUILD_BUG_ON(((size) > sizeof(struct __kernel_sockaddr_storage)))
	19
2ad0d9d4	20	#ifdef CONFIG_PROC_FS
20380731 ACM	21	struct seq_file;
20380731 ACM	22	extern void socket_seq_show(struct seq_file *seq);
2ad0d9d4	23	#endif
20380731	24
6602a4ba	25	typedef __kernel_sa_family_t sa_family_t;
1da177e4 LT	26
	27	/*
	28	* 1003.1g requires sa_family_t and that sa_data is char.
	29	*/
8a3c245c	30
1da177e4 LT	31	struct sockaddr {
	32	sa_family_t sa_family; /* address family, AF_xxx */
	33	char sa_data[14]; /* 14 bytes of protocol address */
	34	};
	35
	36	struct linger {
	37	int l_onoff; /* Linger active */
	38	int l_linger; /* How long to linger for */
	39	};
	40
	41	#define sockaddr_storage __kernel_sockaddr_storage
	42
	43	/*
	44	* As we do 4.4BSD message passing we use a 4.4BSD message passing
	45	* system, not 4.3. Thus msg_accrights(len) are now missing. They
	46	* belong in an obscure libc emulation or the bin.
	47	*/
8a3c245c	48
1da177e4	49	struct msghdr {
eb97768a FLB	50	void msg_name; / ptr to socket address structure */
eb97768a FLB	51	int msg_namelen; /* size of socket address structure */
c0371da6	52	struct iov_iter msg_iter; /* data */
1f466e1f CH	53
	54	/*
	55	* Ancillary data. msg_control_user is the user buffer used for the
	56	* recv* side when msg_control_is_user is set, msg_control is the kernel
	57	* buffer used for all other cases.
	58	*/
	59	union {
	60	void *msg_control;
	61	void __user *msg_control_user;
	62	};
	63	bool msg_control_is_user : 1;
eb97768a FLB	64	__kernel_size_t msg_controllen; /* ancillary data buffer length */
eb97768a FLB	65	unsigned int msg_flags; /* flags on received message */
0345f931	66	struct kiocb msg_iocb; / ptr to iocb for async requests */
1da177e4	67	};
8a3c245c	68
666547ff AV	69	struct user_msghdr {
	70	void __user msg_name; / ptr to socket address structure */
	71	int msg_namelen; /* size of socket address structure */
	72	struct iovec __user msg_iov; / scatter/gather array */
	73	__kernel_size_t msg_iovlen; /* # elements in msg_iov */
	74	void __user msg_control; / ancillary data */
	75	__kernel_size_t msg_controllen; /* ancillary data buffer length */
	76	unsigned int msg_flags; /* flags on received message */
	77	};
1da177e4	78
a2e27255 ACM	79	/* For recvmmsg/sendmmsg */
a2e27255 ACM	80	struct mmsghdr {
666547ff	81	struct user_msghdr msg_hdr;
95c96174	82	unsigned int msg_len;
a2e27255 ACM	83	};
a2e27255 ACM	84
1da177e4 LT	85	/*
	86	* POSIX 1003.1g - ancillary data object information
	87	* Ancillary data consits of a sequence of pairs of
	88	* (cmsghdr, cmsg_data[])
	89	*/
	90
	91	struct cmsghdr {
	92	__kernel_size_t cmsg_len; /* data byte count, including hdr */
	93	int cmsg_level; /* originating protocol */
	94	int cmsg_type; /* protocol-specific type */
	95	};
	96
	97	/*
25985edc	98	* Ancillary data object information MACROS
1da177e4 LT	99	* Table 5-14 of POSIX 1003.1g
	100	*/
	101
	102	#define __CMSG_NXTHDR(ctl, len, cmsg) __cmsg_nxthdr((ctl),(len),(cmsg))
	103	#define CMSG_NXTHDR(mhdr, cmsg) cmsg_nxthdr((mhdr), (cmsg))
	104
	105	#define CMSG_ALIGN(len) ( ((len)+sizeof(long)-1) & ~(sizeof(long)-1) )
	106
0462b6bd CH	107	#define CMSG_DATA(cmsg) \
	108	((void *)(cmsg) + sizeof(struct cmsghdr))
	109	#define CMSG_USER_DATA(cmsg) \
	110	((void __user *)(cmsg) + sizeof(struct cmsghdr))
1ff8cebf	111	#define CMSG_SPACE(len) (sizeof(struct cmsghdr) + CMSG_ALIGN(len))
1ff8cebf	112	#define CMSG_LEN(len) (sizeof(struct cmsghdr) + (len))
1da177e4 LT	113
	114	#define __CMSG_FIRSTHDR(ctl,len) ((len) >= sizeof(struct cmsghdr) ? \
	115	(struct cmsghdr *)(ctl) : \
	116	(struct cmsghdr *)NULL)
	117	#define CMSG_FIRSTHDR(msg) __CMSG_FIRSTHDR((msg)->msg_control, (msg)->msg_controllen)
	118	#define CMSG_OK(mhdr, cmsg) ((cmsg)->cmsg_len >= sizeof(struct cmsghdr) && \
	119	(cmsg)->cmsg_len <= (unsigned long) \
	120	((mhdr)->msg_controllen - \
	121	((char )(cmsg) - (char )(mhdr)->msg_control)))
f95b414e GZ	122	#define for_each_cmsghdr(cmsg, msg) \
	123	for (cmsg = CMSG_FIRSTHDR(msg); \
	124	cmsg; \
	125	cmsg = CMSG_NXTHDR(msg, cmsg))
1da177e4	126
1da177e4 LT	127	/*
	128	* Get the next cmsg header
	129	*
	130	* PLEASE, do not touch this function. If you think, that it is
	131	* incorrect, grep kernel sources and think about consequences
	132	* before trying to improve it.
	133	*
	134	* Now it always returns valid, not truncated ancillary object
	135	* HEADER. But caller still MUST check, that cmsg->cmsg_len is
	136	* inside range, given by msg->msg_controllen before using
	137	* ancillary object DATA. --ANK (980731)
	138	*/
8a3c245c	139
9c501935	140	static inline struct cmsghdr * __cmsg_nxthdr(void *__ctl, __kernel_size_t __size,
1da177e4 LT	141	struct cmsghdr *__cmsg)
	142	{
	143	struct cmsghdr * __ptr;
	144
	145	__ptr = (struct cmsghdr)(((unsigned char ) __cmsg) + CMSG_ALIGN(__cmsg->cmsg_len));
	146	if ((unsigned long)((char)(__ptr+1) - (char ) __ctl) > __size)
	147	return (struct cmsghdr *)0;
	148
	149	return __ptr;
	150	}
	151
9c501935	152	static inline struct cmsghdr * cmsg_nxthdr (struct msghdr __msg, struct cmsghdr __cmsg)
1da177e4 LT	153	{
	154	return __cmsg_nxthdr(__msg->msg_control, __msg->msg_controllen, __cmsg);
	155	}
	156
01e97e65 AV	157	static inline size_t msg_data_left(struct msghdr *msg)
	158	{
	159	return iov_iter_count(&msg->msg_iter);
	160	}
	161
1da177e4 LT	162	/* "Socket"-level control message types: */
	163
	164	#define SCM_RIGHTS 0x01 /* rw: access rights (array of int) */
	165	#define SCM_CREDENTIALS 0x02 /* rw: struct ucred */
2c7946a7	166	#define SCM_SECURITY 0x03 /* rw: security label */
1da177e4 LT	167
	168	struct ucred {
	169	__u32 pid;
	170	__u32 uid;
	171	__u32 gid;
	172	};
	173
	174	/* Supported address families. */
	175	#define AF_UNSPEC 0
	176	#define AF_UNIX 1 /* Unix domain sockets */
	177	#define AF_LOCAL 1 /* POSIX name for AF_UNIX */
	178	#define AF_INET 2 /* Internet IP Protocol */
	179	#define AF_AX25 3 /* Amateur Radio AX.25 */
	180	#define AF_IPX 4 /* Novell IPX */
	181	#define AF_APPLETALK 5 /* AppleTalk DDP */
	182	#define AF_NETROM 6 /* Amateur Radio NET/ROM */
	183	#define AF_BRIDGE 7 /* Multiprotocol bridge */
	184	#define AF_ATMPVC 8 /* ATM PVCs */
	185	#define AF_X25 9 /* Reserved for X.25 project */
	186	#define AF_INET6 10 /* IP version 6 */
	187	#define AF_ROSE 11 /* Amateur Radio X.25 PLP */
	188	#define AF_DECnet 12 /* Reserved for DECnet project */
	189	#define AF_NETBEUI 13 /* Reserved for 802.2LLC project*/
	190	#define AF_SECURITY 14 /* Security callback pseudo AF */
	191	#define AF_KEY 15 /* PF_KEY key management API */
	192	#define AF_NETLINK 16
	193	#define AF_ROUTE AF_NETLINK /* Alias to emulate 4.4BSD */
	194	#define AF_PACKET 17 /* Packet family */
	195	#define AF_ASH 18 /* Ash */
	196	#define AF_ECONET 19 /* Acorn Econet */
	197	#define AF_ATMSVC 20 /* ATM SVCs */
8a7c4c77	198	#define AF_RDS 21 /* RDS sockets */
1da177e4 LT	199	#define AF_SNA 22 /* Linux SNA Project (nutters!) */
	200	#define AF_IRDA 23 /* IRDA sockets */
	201	#define AF_PPPOX 24 /* PPPoX sockets */
	202	#define AF_WANPIPE 25 /* Wanpipe API Sockets */
	203	#define AF_LLC 26 /* Linux LLC */
8d36eb01	204	#define AF_IB 27 /* Native InfiniBand address */
0189197f	205	#define AF_MPLS 28 /* MPLS */
cd05acfe	206	#define AF_CAN 29 /* Controller Area Network */
b97bf3fd	207	#define AF_TIPC 30 /* TIPC sockets */
1da177e4	208	#define AF_BLUETOOTH 31 /* Bluetooth sockets */
eac3731b	209	#define AF_IUCV 32 /* IUCV sockets */
17926a79	210	#define AF_RXRPC 33 /* RxRPC sockets */
04578dd3	211	#define AF_ISDN 34 /* mISDN sockets */
bce7b154	212	#define AF_PHONET 35 /* Phonet sockets */
fcb94e42	213	#define AF_IEEE802154 36 /* IEEE802154 sockets */
70596b61	214	#define AF_CAIF 37 /* CAIF sockets */
c2f9bff5	215	#define AF_ALG 38 /* Algorithm sockets */
c7fe3b52	216	#define AF_NFC 39 /* NFC sockets */
d021c344	217	#define AF_VSOCK 40 /* vSockets */
ab7ac4eb	218	#define AF_KCM 41 /* Kernel Connection Multiplexor*/
bdabad3e	219	#define AF_QIPCRTR 42 /* Qualcomm IPC Router */
ac713874 UB	220	#define AF_SMC 43 /* smc sockets: reserve number for
	221	* PF_SMC protocol family that
	222	* reuses AF_INET address family
	223	*/
68e8b849	224	#define AF_XDP 44 /* XDP sockets */
ab7ac4eb	225
68e8b849	226	#define AF_MAX 45 /* For now.. */
1da177e4 LT	227
	228	/* Protocol families, same as address families. */
	229	#define PF_UNSPEC AF_UNSPEC
	230	#define PF_UNIX AF_UNIX
	231	#define PF_LOCAL AF_LOCAL
	232	#define PF_INET AF_INET
	233	#define PF_AX25 AF_AX25
	234	#define PF_IPX AF_IPX
	235	#define PF_APPLETALK AF_APPLETALK
	236	#define PF_NETROM AF_NETROM
	237	#define PF_BRIDGE AF_BRIDGE
	238	#define PF_ATMPVC AF_ATMPVC
	239	#define PF_X25 AF_X25
	240	#define PF_INET6 AF_INET6
	241	#define PF_ROSE AF_ROSE
	242	#define PF_DECnet AF_DECnet
	243	#define PF_NETBEUI AF_NETBEUI
	244	#define PF_SECURITY AF_SECURITY
	245	#define PF_KEY AF_KEY
	246	#define PF_NETLINK AF_NETLINK
	247	#define PF_ROUTE AF_ROUTE
	248	#define PF_PACKET AF_PACKET
	249	#define PF_ASH AF_ASH
	250	#define PF_ECONET AF_ECONET
	251	#define PF_ATMSVC AF_ATMSVC
8a7c4c77	252	#define PF_RDS AF_RDS
1da177e4 LT	253	#define PF_SNA AF_SNA
	254	#define PF_IRDA AF_IRDA
	255	#define PF_PPPOX AF_PPPOX
	256	#define PF_WANPIPE AF_WANPIPE
	257	#define PF_LLC AF_LLC
8d36eb01	258	#define PF_IB AF_IB
0189197f	259	#define PF_MPLS AF_MPLS
cd05acfe	260	#define PF_CAN AF_CAN
b97bf3fd	261	#define PF_TIPC AF_TIPC
1da177e4	262	#define PF_BLUETOOTH AF_BLUETOOTH
eac3731b	263	#define PF_IUCV AF_IUCV
17926a79	264	#define PF_RXRPC AF_RXRPC
04578dd3	265	#define PF_ISDN AF_ISDN
bce7b154	266	#define PF_PHONET AF_PHONET
fcb94e42	267	#define PF_IEEE802154 AF_IEEE802154
70596b61	268	#define PF_CAIF AF_CAIF
c2f9bff5	269	#define PF_ALG AF_ALG
c7fe3b52	270	#define PF_NFC AF_NFC
d021c344	271	#define PF_VSOCK AF_VSOCK
ab7ac4eb	272	#define PF_KCM AF_KCM
bdabad3e	273	#define PF_QIPCRTR AF_QIPCRTR
ac713874	274	#define PF_SMC AF_SMC
68e8b849	275	#define PF_XDP AF_XDP
1da177e4 LT	276	#define PF_MAX AF_MAX
	277
	278	/* Maximum queue length specifiable by listen. */
19f92a03	279	#define SOMAXCONN 4096
1da177e4	280
8a3c245c	281	/* Flags we can use with send/ and recv.
1da177e4 LT	282	Added those for 1003.1g not all are supported yet
1da177e4 LT	283	*/
8a3c245c	284
1da177e4 LT	285	#define MSG_OOB 1
	286	#define MSG_PEEK 2
	287	#define MSG_DONTROUTE 4
	288	#define MSG_TRYHARD 4 /* Synonym for MSG_DONTROUTE for DECnet */
	289	#define MSG_CTRUNC 8
	290	#define MSG_PROBE 0x10 /* Do not send. Only probe path f.e. for MTU */
	291	#define MSG_TRUNC 0x20
	292	#define MSG_DONTWAIT 0x40 /* Nonblocking io */
	293	#define MSG_EOR 0x80 /* End of record */
	294	#define MSG_WAITALL 0x100 /* Wait for a full request */
	295	#define MSG_FIN 0x200
	296	#define MSG_SYN 0x400
	297	#define MSG_CONFIRM 0x800 /* Confirm path validity */
	298	#define MSG_RST 0x1000
	299	#define MSG_ERRQUEUE 0x2000 /* Fetch message from error queue */
	300	#define MSG_NOSIGNAL 0x4000 /* Do not generate SIGPIPE */
	301	#define MSG_MORE 0x8000 /* Sender will send more */
71c5c159	302	#define MSG_WAITFORONE 0x10000 /* recvmmsg(): block until 1+ packets avail */
0608c69c	303	#define MSG_SENDPAGE_NOPOLICY 0x10000 /* sendpage() internal : do no apply policy */
35f9c09f	304	#define MSG_SENDPAGE_NOTLAST 0x20000 /* sendpage() internal : not the last page */
f092276d	305	#define MSG_BATCH 0x40000 /* sendmmsg(): more messages coming */
1da177e4	306	#define MSG_EOF MSG_FIN
312fc2b4	307	#define MSG_NO_SHARED_FRAGS 0x80000 /* sendpage() internal : page frags are not shared */
41477662 JK	308	#define MSG_SENDPAGE_DECRYPTED 0x100000 /* sendpage() internal : page may carry
	309	* plain text and require encryption
	310	*/
1da177e4	311
52267790	312	#define MSG_ZEROCOPY 0x4000000 /* Use user data in kernel path */
cf60af03	313	#define MSG_FASTOPEN 0x20000000 /* Send data in TCP SYN */
9cdb5dbf	314	#define MSG_CMSG_CLOEXEC 0x40000000 /* Set close_on_exec for file
4a19542e UD	315	descriptor received through
4a19542e UD	316	SCM_RIGHTS */
1da177e4 LT	317	#if defined(CONFIG_COMPAT)
	318	#define MSG_CMSG_COMPAT 0x80000000 /* This message needs 32 bit fixups */
	319	#else
	320	#define MSG_CMSG_COMPAT 0 /* We never have 32 bit fixups */
	321	#endif
	322
	323
	324	/* Setsockoptions(2) level. Thanks to BSD these must match IPPROTO_xxx */
	325	#define SOL_IP 0
	326	/* #define SOL_ICMP 1 No-no-no! Due to Linux :-) we cannot use SOL_ICMP=1 */
	327	#define SOL_TCP 6
	328	#define SOL_UDP 17
	329	#define SOL_IPV6 41
	330	#define SOL_ICMPV6 58
	331	#define SOL_SCTP 132
ba4e58ec	332	#define SOL_UDPLITE 136 /* UDP-Lite (RFC 3828) */
1da177e4 LT	333	#define SOL_RAW 255
	334	#define SOL_IPX 256
	335	#define SOL_AX25 257
	336	#define SOL_ATALK 258
	337	#define SOL_NETROM 259
	338	#define SOL_ROSE 260
	339	#define SOL_DECNET 261
	340	#define SOL_X25 262
	341	#define SOL_PACKET 263
	342	#define SOL_ATM 264 /* ATM layer (cell level) */
	343	#define SOL_AAL 265 /* ATM Adaption Layer (packet level) */
	344	#define SOL_IRDA 266
	345	#define SOL_NETBEUI 267
	346	#define SOL_LLC 268
7c657876	347	#define SOL_DCCP 269
9a4595bc	348	#define SOL_NETLINK 270
b97bf3fd	349	#define SOL_TIPC 271
17926a79	350	#define SOL_RXRPC 272
cf14a4d0	351	#define SOL_PPPOL2TP 273
2cb3377a	352	#define SOL_BLUETOOTH 274
02a47617	353	#define SOL_PNPIPE 275
8a7c4c77	354	#define SOL_RDS 276
9d5c5d8f	355	#define SOL_IUCV 277
70596b61	356	#define SOL_CAIF 278
c2f9bff5	357	#define SOL_ALG 279
26fd76ca	358	#define SOL_NFC 280
ab7ac4eb	359	#define SOL_KCM 281
3c4d7559	360	#define SOL_TLS 282
68e8b849	361	#define SOL_XDP 283
1da177e4 LT	362
	363	/* IPX options */
	364	#define IPX_TYPE 1
	365
43db362d	366	extern int move_addr_to_kernel(void __user uaddr, int ulen, struct sockaddr_storage kaddr);
1da177e4 LT	367	extern int put_cmsg(struct msghdr, int level, int type, int len, void data);
1da177e4 LT	368
9718475e	369	struct timespec64;
e11d4284 AB	370	struct __kernel_timespec;
e11d4284 AB	371	struct old_timespec32;
a2e27255	372
9718475e DD	373	struct scm_timestamping_internal {
	374	struct timespec64 ts[3];
	375	};
	376
	377	extern void put_cmsg_scm_timestamping64(struct msghdr msg, struct scm_timestamping_internal tss);
	378	extern void put_cmsg_scm_timestamping(struct msghdr msg, struct scm_timestamping_internal tss);
	379
e1834a32 DB	380	/* The __sys_...msg variants allow MSG_CMSG_COMPAT iff
	381	* forbid_cmsg_compat==false
	382	*/
	383	extern long __sys_recvmsg(int fd, struct user_msghdr __user *msg,
	384	unsigned int flags, bool forbid_cmsg_compat);
	385	extern long __sys_sendmsg(int fd, struct user_msghdr __user *msg,
	386	unsigned int flags, bool forbid_cmsg_compat);
e11d4284 AB	387	extern int __sys_recvmmsg(int fd, struct mmsghdr __user *mmsg,
	388	unsigned int vlen, unsigned int flags,
	389	struct __kernel_timespec __user *timeout,
	390	struct old_timespec32 __user *timeout32);
228e548e	391	extern int __sys_sendmmsg(int fd, struct mmsghdr __user *mmsg,
e1834a32 DB	392	unsigned int vlen, unsigned int flags,
e1834a32 DB	393	bool forbid_cmsg_compat);
03b1230c	394	extern long __sys_sendmsg_sock(struct socket sock, struct msghdr msg,
0fa03c62	395	unsigned int flags);
03b1230c JA	396	extern long __sys_recvmsg_sock(struct socket sock, struct msghdr msg,
	397	struct user_msghdr __user *umsg,
	398	struct sockaddr __user *uaddr,
aa1fa28f	399	unsigned int flags);
03b1230c JA	400	extern int sendmsg_copy_msghdr(struct msghdr *msg,
	401	struct user_msghdr __user *umsg, unsigned flags,
	402	struct iovec **iov);
	403	extern int recvmsg_copy_msghdr(struct msghdr *msg,
	404	struct user_msghdr __user *umsg, unsigned flags,
	405	struct sockaddr __user **uaddr,
	406	struct iovec **iov);
0a384abf JA	407	extern int __copy_msghdr_from_user(struct msghdr *kmsg,
	408	struct user_msghdr __user *umsg,
	409	struct sockaddr __user **save_addr,
	410	struct iovec __user *uiov, size_t nsegs);
7a09e1eb DB	411
	412	/* helpers which do the actual work for syscalls */
	413	extern int __sys_recvfrom(int fd, void __user *ubuf, size_t size,
	414	unsigned int flags, struct sockaddr __user *addr,
	415	int __user *addr_len);
211b634b DB	416	extern int __sys_sendto(int fd, void __user *buff, size_t len,
	417	unsigned int flags, struct sockaddr __user *addr,
	418	int addr_len);
de2ea4b6 JA	419	extern int __sys_accept4_file(struct file *file, unsigned file_flags,
de2ea4b6 JA	420	struct sockaddr __user *upeer_sockaddr,
09952e3e JA	421	int __user *upeer_addrlen, int flags,
09952e3e JA	422	unsigned long nofile);
4541e805 DB	423	extern int __sys_accept4(int fd, struct sockaddr __user *upeer_sockaddr,
4541e805 DB	424	int __user *upeer_addrlen, int flags);
9d6a15c3	425	extern int __sys_socket(int family, int type, int protocol);
a87d35d8	426	extern int __sys_bind(int fd, struct sockaddr __user *umyaddr, int addrlen);
f499a021 JA	427	extern int __sys_connect_file(struct file file, struct sockaddr_storage addr,
f499a021 JA	428	int addrlen, int file_flags);
1387c2c2 DB	429	extern int __sys_connect(int fd, struct sockaddr __user *uservaddr,
1387c2c2 DB	430	int addrlen);
25e290ee	431	extern int __sys_listen(int fd, int backlog);
8882a107 DB	432	extern int __sys_getsockname(int fd, struct sockaddr __user *usockaddr,
8882a107 DB	433	int __user *usockaddr_len);
b21c8f83 DB	434	extern int __sys_getpeername(int fd, struct sockaddr __user *usockaddr,
b21c8f83 DB	435	int __user *usockaddr_len);
6debc8d8 DB	436	extern int __sys_socketpair(int family, int type, int protocol,
6debc8d8 DB	437	int __user *usockvec);
005a1aea	438	extern int __sys_shutdown(int fd, int how);
7a09e1eb	439
d8d211a2	440	extern struct ns_common get_net_ns(struct ns_common ns);
1da177e4	441	#endif /* _LINUX_SOCKET_H */