[linux-block.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 file;
struct pid;
struct cred;
struct socket;
struct sock;
struct sk_buff;

#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	*/
	union {
		char sa_data_min[14];		/* Minimum 14 bytes of protocol address	*/
		DECLARE_FLEX_ARRAY(char, sa_data);
	};
};

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 */

	int		msg_inq;	/* output, data left in socket */

	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;
	bool		msg_get_inq : 1;/* return INQ after receive */
	unsigned int	msg_flags;	/* flags on received message */
	__kernel_size_t	msg_controllen;	/* ancillary data buffer length */
	struct kiocb	*msg_iocb;	/* ptr to iocb for async requests */
	struct ubuf_info *msg_ubuf;
	int (*sg_from_iter)(struct sock *sk, struct sk_buff *skb,
			    struct iov_iter *from, size_t length);
};

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 consists 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		*/
#define SCM_PIDFD	0x04		/* ro: pidfd (int)		*/

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_MCTP		45	/* Management component
				 * transport protocol
				 */

#define AF_MAX		46	/* 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_MCTP		AF_MCTP
#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_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_SPLICE_PAGES 0x8000000	/* Splice the pages from the iterator in sendmsg() */
#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

/* Flags to be cleared on entry by sendmsg and sendmmsg syscalls */
#define MSG_INTERNAL_SENDMSG_FLAGS \
	(MSG_SPLICE_PAGES | MSG_SENDPAGE_NOPOLICY | MSG_SENDPAGE_DECRYPTED)

/* 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
#define SOL_MPTCP	284
#define SOL_MCTP	285
#define SOL_SMC		286

/* 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(struct msghdr *kmsg,
			 struct user_msghdr *umsg,
			 struct sockaddr __user **save_addr);

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