xref: /linux-6.15/include/linux/socket.h (revision 0cb6c969)
1 #ifndef _LINUX_SOCKET_H
2 #define _LINUX_SOCKET_H
3 
4 
5 #include <asm/socket.h>			/* arch-dependent defines	*/
6 #include <linux/sockios.h>		/* the SIOCxxx I/O controls	*/
7 #include <linux/uio.h>			/* iovec support		*/
8 #include <linux/types.h>		/* pid_t			*/
9 #include <linux/compiler.h>		/* __user			*/
10 #include <uapi/linux/socket.h>
11 
12 struct pid;
13 struct cred;
14 
15 #define __sockaddr_check_size(size)	\
16 	BUILD_BUG_ON(((size) > sizeof(struct __kernel_sockaddr_storage)))
17 
18 #ifdef CONFIG_PROC_FS
19 struct seq_file;
20 extern void socket_seq_show(struct seq_file *seq);
21 #endif
22 
23 typedef __kernel_sa_family_t	sa_family_t;
24 
25 /*
26  *	1003.1g requires sa_family_t and that sa_data is char.
27  */
28 
29 struct sockaddr {
30 	sa_family_t	sa_family;	/* address family, AF_xxx	*/
31 	char		sa_data[14];	/* 14 bytes of protocol address	*/
32 };
33 
34 struct linger {
35 	int		l_onoff;	/* Linger active		*/
36 	int		l_linger;	/* How long to linger for	*/
37 };
38 
39 #define sockaddr_storage __kernel_sockaddr_storage
40 
41 /*
42  *	As we do 4.4BSD message passing we use a 4.4BSD message passing
43  *	system, not 4.3. Thus msg_accrights(len) are now missing. They
44  *	belong in an obscure libc emulation or the bin.
45  */
46 
47 struct msghdr {
48 	void		*msg_name;	/* ptr to socket address structure */
49 	int		msg_namelen;	/* size of socket address structure */
50 	struct iov_iter	msg_iter;	/* data */
51 	void		*msg_control;	/* ancillary data */
52 	__kernel_size_t	msg_controllen;	/* ancillary data buffer length */
53 	unsigned int	msg_flags;	/* flags on received message */
54 };
55 
56 struct user_msghdr {
57 	void		__user *msg_name;	/* ptr to socket address structure */
58 	int		msg_namelen;		/* size of socket address structure */
59 	struct iovec	__user *msg_iov;	/* scatter/gather array */
60 	__kernel_size_t	msg_iovlen;		/* # elements in msg_iov */
61 	void		__user *msg_control;	/* ancillary data */
62 	__kernel_size_t	msg_controllen;		/* ancillary data buffer length */
63 	unsigned int	msg_flags;		/* flags on received message */
64 };
65 
66 /* For recvmmsg/sendmmsg */
67 struct mmsghdr {
68 	struct user_msghdr  msg_hdr;
69 	unsigned int        msg_len;
70 };
71 
72 /*
73  *	POSIX 1003.1g - ancillary data object information
74  *	Ancillary data consits of a sequence of pairs of
75  *	(cmsghdr, cmsg_data[])
76  */
77 
78 struct cmsghdr {
79 	__kernel_size_t	cmsg_len;	/* data byte count, including hdr */
80         int		cmsg_level;	/* originating protocol */
81         int		cmsg_type;	/* protocol-specific type */
82 };
83 
84 /*
85  *	Ancillary data object information MACROS
86  *	Table 5-14 of POSIX 1003.1g
87  */
88 
89 #define __CMSG_NXTHDR(ctl, len, cmsg) __cmsg_nxthdr((ctl),(len),(cmsg))
90 #define CMSG_NXTHDR(mhdr, cmsg) cmsg_nxthdr((mhdr), (cmsg))
91 
92 #define CMSG_ALIGN(len) ( ((len)+sizeof(long)-1) & ~(sizeof(long)-1) )
93 
94 #define CMSG_DATA(cmsg)	((void *)((char *)(cmsg) + CMSG_ALIGN(sizeof(struct cmsghdr))))
95 #define CMSG_SPACE(len) (CMSG_ALIGN(sizeof(struct cmsghdr)) + CMSG_ALIGN(len))
96 #define CMSG_LEN(len) (CMSG_ALIGN(sizeof(struct cmsghdr)) + (len))
97 
98 #define __CMSG_FIRSTHDR(ctl,len) ((len) >= sizeof(struct cmsghdr) ? \
99 				  (struct cmsghdr *)(ctl) : \
100 				  (struct cmsghdr *)NULL)
101 #define CMSG_FIRSTHDR(msg)	__CMSG_FIRSTHDR((msg)->msg_control, (msg)->msg_controllen)
102 #define CMSG_OK(mhdr, cmsg) ((cmsg)->cmsg_len >= sizeof(struct cmsghdr) && \
103 			     (cmsg)->cmsg_len <= (unsigned long) \
104 			     ((mhdr)->msg_controllen - \
105 			      ((char *)(cmsg) - (char *)(mhdr)->msg_control)))
106 
107 /*
108  *	Get the next cmsg header
109  *
110  *	PLEASE, do not touch this function. If you think, that it is
111  *	incorrect, grep kernel sources and think about consequences
112  *	before trying to improve it.
113  *
114  *	Now it always returns valid, not truncated ancillary object
115  *	HEADER. But caller still MUST check, that cmsg->cmsg_len is
116  *	inside range, given by msg->msg_controllen before using
117  *	ancillary object DATA.				--ANK (980731)
118  */
119 
120 static inline struct cmsghdr * __cmsg_nxthdr(void *__ctl, __kernel_size_t __size,
121 					       struct cmsghdr *__cmsg)
122 {
123 	struct cmsghdr * __ptr;
124 
125 	__ptr = (struct cmsghdr*)(((unsigned char *) __cmsg) +  CMSG_ALIGN(__cmsg->cmsg_len));
126 	if ((unsigned long)((char*)(__ptr+1) - (char *) __ctl) > __size)
127 		return (struct cmsghdr *)0;
128 
129 	return __ptr;
130 }
131 
132 static inline struct cmsghdr * cmsg_nxthdr (struct msghdr *__msg, struct cmsghdr *__cmsg)
133 {
134 	return __cmsg_nxthdr(__msg->msg_control, __msg->msg_controllen, __cmsg);
135 }
136 
137 /* "Socket"-level control message types: */
138 
139 #define	SCM_RIGHTS	0x01		/* rw: access rights (array of int) */
140 #define SCM_CREDENTIALS 0x02		/* rw: struct ucred		*/
141 #define SCM_SECURITY	0x03		/* rw: security label		*/
142 
143 struct ucred {
144 	__u32	pid;
145 	__u32	uid;
146 	__u32	gid;
147 };
148 
149 /* Supported address families. */
150 #define AF_UNSPEC	0
151 #define AF_UNIX		1	/* Unix domain sockets 		*/
152 #define AF_LOCAL	1	/* POSIX name for AF_UNIX	*/
153 #define AF_INET		2	/* Internet IP Protocol 	*/
154 #define AF_AX25		3	/* Amateur Radio AX.25 		*/
155 #define AF_IPX		4	/* Novell IPX 			*/
156 #define AF_APPLETALK	5	/* AppleTalk DDP 		*/
157 #define AF_NETROM	6	/* Amateur Radio NET/ROM 	*/
158 #define AF_BRIDGE	7	/* Multiprotocol bridge 	*/
159 #define AF_ATMPVC	8	/* ATM PVCs			*/
160 #define AF_X25		9	/* Reserved for X.25 project 	*/
161 #define AF_INET6	10	/* IP version 6			*/
162 #define AF_ROSE		11	/* Amateur Radio X.25 PLP	*/
163 #define AF_DECnet	12	/* Reserved for DECnet project	*/
164 #define AF_NETBEUI	13	/* Reserved for 802.2LLC project*/
165 #define AF_SECURITY	14	/* Security callback pseudo AF */
166 #define AF_KEY		15      /* PF_KEY key management API */
167 #define AF_NETLINK	16
168 #define AF_ROUTE	AF_NETLINK /* Alias to emulate 4.4BSD */
169 #define AF_PACKET	17	/* Packet family		*/
170 #define AF_ASH		18	/* Ash				*/
171 #define AF_ECONET	19	/* Acorn Econet			*/
172 #define AF_ATMSVC	20	/* ATM SVCs			*/
173 #define AF_RDS		21	/* RDS sockets 			*/
174 #define AF_SNA		22	/* Linux SNA Project (nutters!) */
175 #define AF_IRDA		23	/* IRDA sockets			*/
176 #define AF_PPPOX	24	/* PPPoX sockets		*/
177 #define AF_WANPIPE	25	/* Wanpipe API Sockets */
178 #define AF_LLC		26	/* Linux LLC			*/
179 #define AF_IB		27	/* Native InfiniBand address	*/
180 #define AF_CAN		29	/* Controller Area Network      */
181 #define AF_TIPC		30	/* TIPC sockets			*/
182 #define AF_BLUETOOTH	31	/* Bluetooth sockets 		*/
183 #define AF_IUCV		32	/* IUCV sockets			*/
184 #define AF_RXRPC	33	/* RxRPC sockets 		*/
185 #define AF_ISDN		34	/* mISDN sockets 		*/
186 #define AF_PHONET	35	/* Phonet sockets		*/
187 #define AF_IEEE802154	36	/* IEEE802154 sockets		*/
188 #define AF_CAIF		37	/* CAIF sockets			*/
189 #define AF_ALG		38	/* Algorithm sockets		*/
190 #define AF_NFC		39	/* NFC sockets			*/
191 #define AF_VSOCK	40	/* vSockets			*/
192 #define AF_MAX		41	/* For now.. */
193 
194 /* Protocol families, same as address families. */
195 #define PF_UNSPEC	AF_UNSPEC
196 #define PF_UNIX		AF_UNIX
197 #define PF_LOCAL	AF_LOCAL
198 #define PF_INET		AF_INET
199 #define PF_AX25		AF_AX25
200 #define PF_IPX		AF_IPX
201 #define PF_APPLETALK	AF_APPLETALK
202 #define	PF_NETROM	AF_NETROM
203 #define PF_BRIDGE	AF_BRIDGE
204 #define PF_ATMPVC	AF_ATMPVC
205 #define PF_X25		AF_X25
206 #define PF_INET6	AF_INET6
207 #define PF_ROSE		AF_ROSE
208 #define PF_DECnet	AF_DECnet
209 #define PF_NETBEUI	AF_NETBEUI
210 #define PF_SECURITY	AF_SECURITY
211 #define PF_KEY		AF_KEY
212 #define PF_NETLINK	AF_NETLINK
213 #define PF_ROUTE	AF_ROUTE
214 #define PF_PACKET	AF_PACKET
215 #define PF_ASH		AF_ASH
216 #define PF_ECONET	AF_ECONET
217 #define PF_ATMSVC	AF_ATMSVC
218 #define PF_RDS		AF_RDS
219 #define PF_SNA		AF_SNA
220 #define PF_IRDA		AF_IRDA
221 #define PF_PPPOX	AF_PPPOX
222 #define PF_WANPIPE	AF_WANPIPE
223 #define PF_LLC		AF_LLC
224 #define PF_IB		AF_IB
225 #define PF_CAN		AF_CAN
226 #define PF_TIPC		AF_TIPC
227 #define PF_BLUETOOTH	AF_BLUETOOTH
228 #define PF_IUCV		AF_IUCV
229 #define PF_RXRPC	AF_RXRPC
230 #define PF_ISDN		AF_ISDN
231 #define PF_PHONET	AF_PHONET
232 #define PF_IEEE802154	AF_IEEE802154
233 #define PF_CAIF		AF_CAIF
234 #define PF_ALG		AF_ALG
235 #define PF_NFC		AF_NFC
236 #define PF_VSOCK	AF_VSOCK
237 #define PF_MAX		AF_MAX
238 
239 /* Maximum queue length specifiable by listen.  */
240 #define SOMAXCONN	128
241 
242 /* Flags we can use with send/ and recv.
243    Added those for 1003.1g not all are supported yet
244  */
245 
246 #define MSG_OOB		1
247 #define MSG_PEEK	2
248 #define MSG_DONTROUTE	4
249 #define MSG_TRYHARD     4       /* Synonym for MSG_DONTROUTE for DECnet */
250 #define MSG_CTRUNC	8
251 #define MSG_PROBE	0x10	/* Do not send. Only probe path f.e. for MTU */
252 #define MSG_TRUNC	0x20
253 #define MSG_DONTWAIT	0x40	/* Nonblocking io		 */
254 #define MSG_EOR         0x80	/* End of record */
255 #define MSG_WAITALL	0x100	/* Wait for a full request */
256 #define MSG_FIN         0x200
257 #define MSG_SYN		0x400
258 #define MSG_CONFIRM	0x800	/* Confirm path validity */
259 #define MSG_RST		0x1000
260 #define MSG_ERRQUEUE	0x2000	/* Fetch message from error queue */
261 #define MSG_NOSIGNAL	0x4000	/* Do not generate SIGPIPE */
262 #define MSG_MORE	0x8000	/* Sender will send more */
263 #define MSG_WAITFORONE	0x10000	/* recvmmsg(): block until 1+ packets avail */
264 #define MSG_SENDPAGE_NOTLAST 0x20000 /* sendpage() internal : not the last page */
265 #define MSG_EOF         MSG_FIN
266 
267 #define MSG_FASTOPEN	0x20000000	/* Send data in TCP SYN */
268 #define MSG_CMSG_CLOEXEC 0x40000000	/* Set close_on_exec for file
269 					   descriptor received through
270 					   SCM_RIGHTS */
271 #if defined(CONFIG_COMPAT)
272 #define MSG_CMSG_COMPAT	0x80000000	/* This message needs 32 bit fixups */
273 #else
274 #define MSG_CMSG_COMPAT	0		/* We never have 32 bit fixups */
275 #endif
276 
277 
278 /* Setsockoptions(2) level. Thanks to BSD these must match IPPROTO_xxx */
279 #define SOL_IP		0
280 /* #define SOL_ICMP	1	No-no-no! Due to Linux :-) we cannot use SOL_ICMP=1 */
281 #define SOL_TCP		6
282 #define SOL_UDP		17
283 #define SOL_IPV6	41
284 #define SOL_ICMPV6	58
285 #define SOL_SCTP	132
286 #define SOL_UDPLITE	136     /* UDP-Lite (RFC 3828) */
287 #define SOL_RAW		255
288 #define SOL_IPX		256
289 #define SOL_AX25	257
290 #define SOL_ATALK	258
291 #define SOL_NETROM	259
292 #define SOL_ROSE	260
293 #define SOL_DECNET	261
294 #define	SOL_X25		262
295 #define SOL_PACKET	263
296 #define SOL_ATM		264	/* ATM layer (cell level) */
297 #define SOL_AAL		265	/* ATM Adaption Layer (packet level) */
298 #define SOL_IRDA        266
299 #define SOL_NETBEUI	267
300 #define SOL_LLC		268
301 #define SOL_DCCP	269
302 #define SOL_NETLINK	270
303 #define SOL_TIPC	271
304 #define SOL_RXRPC	272
305 #define SOL_PPPOL2TP	273
306 #define SOL_BLUETOOTH	274
307 #define SOL_PNPIPE	275
308 #define SOL_RDS		276
309 #define SOL_IUCV	277
310 #define SOL_CAIF	278
311 #define SOL_ALG		279
312 #define SOL_NFC		280
313 
314 /* IPX options */
315 #define IPX_TYPE	1
316 
317 extern int csum_partial_copy_fromiovecend(unsigned char *kdata,
318 					  struct iovec *iov,
319 					  int offset,
320 					  unsigned int len, __wsum *csump);
321 extern unsigned long iov_pages(const struct iovec *iov, int offset,
322 			       unsigned long nr_segs);
323 
324 extern int move_addr_to_kernel(void __user *uaddr, int ulen, struct sockaddr_storage *kaddr);
325 extern int put_cmsg(struct msghdr*, int level, int type, int len, void *data);
326 
327 struct timespec;
328 
329 /* The __sys_...msg variants allow MSG_CMSG_COMPAT */
330 extern long __sys_recvmsg(int fd, struct user_msghdr __user *msg, unsigned flags);
331 extern long __sys_sendmsg(int fd, struct user_msghdr __user *msg, unsigned flags);
332 extern int __sys_recvmmsg(int fd, struct mmsghdr __user *mmsg, unsigned int vlen,
333 			  unsigned int flags, struct timespec *timeout);
334 extern int __sys_sendmmsg(int fd, struct mmsghdr __user *mmsg,
335 			  unsigned int vlen, unsigned int flags);
336 #endif /* _LINUX_SOCKET_H */
337