xref: /linux-6.15/include/linux/socket.h (revision 20dd026d)
1 #ifndef _LINUX_SOCKET_H
2 #define _LINUX_SOCKET_H
3 
4 /*
5  * Desired design of maximum size and alignment (see RFC2553)
6  */
7 #define _K_SS_MAXSIZE	128	/* Implementation specific max size */
8 #define _K_SS_ALIGNSIZE	(__alignof__ (struct sockaddr *))
9 				/* Implementation specific desired alignment */
10 
11 struct __kernel_sockaddr_storage {
12 	unsigned short	ss_family;		/* address family */
13 	/* Following field(s) are implementation specific */
14 	char		__data[_K_SS_MAXSIZE - sizeof(unsigned short)];
15 				/* space to achieve desired size, */
16 				/* _SS_MAXSIZE value minus size of ss_family */
17 } __attribute__ ((aligned(_K_SS_ALIGNSIZE)));	/* force desired alignment */
18 
19 #if defined(__KERNEL__) || !defined(__GLIBC__) || (__GLIBC__ < 2)
20 
21 #include <linux/config.h>		/* for CONFIG_COMPAT */
22 #include <linux/linkage.h>
23 #include <asm/socket.h>			/* arch-dependent defines	*/
24 #include <linux/sockios.h>		/* the SIOCxxx I/O controls	*/
25 #include <linux/uio.h>			/* iovec support		*/
26 #include <linux/types.h>		/* pid_t			*/
27 #include <linux/compiler.h>		/* __user			*/
28 
29 extern int sysctl_somaxconn;
30 extern void sock_init(void);
31 #ifdef CONFIG_PROC_FS
32 struct seq_file;
33 extern void socket_seq_show(struct seq_file *seq);
34 #endif
35 
36 typedef unsigned short	sa_family_t;
37 
38 /*
39  *	1003.1g requires sa_family_t and that sa_data is char.
40  */
41 
42 struct sockaddr {
43 	sa_family_t	sa_family;	/* address family, AF_xxx	*/
44 	char		sa_data[14];	/* 14 bytes of protocol address	*/
45 };
46 
47 struct linger {
48 	int		l_onoff;	/* Linger active		*/
49 	int		l_linger;	/* How long to linger for	*/
50 };
51 
52 #define sockaddr_storage __kernel_sockaddr_storage
53 
54 /*
55  *	As we do 4.4BSD message passing we use a 4.4BSD message passing
56  *	system, not 4.3. Thus msg_accrights(len) are now missing. They
57  *	belong in an obscure libc emulation or the bin.
58  */
59 
60 struct msghdr {
61 	void	*	msg_name;	/* Socket name			*/
62 	int		msg_namelen;	/* Length of name		*/
63 	struct iovec *	msg_iov;	/* Data blocks			*/
64 	__kernel_size_t	msg_iovlen;	/* Number of blocks		*/
65 	void 	*	msg_control;	/* Per protocol magic (eg BSD file descriptor passing) */
66 	__kernel_size_t	msg_controllen;	/* Length of cmsg list */
67 	unsigned	msg_flags;
68 };
69 
70 /*
71  *	POSIX 1003.1g - ancillary data object information
72  *	Ancillary data consits of a sequence of pairs of
73  *	(cmsghdr, cmsg_data[])
74  */
75 
76 struct cmsghdr {
77 	__kernel_size_t	cmsg_len;	/* data byte count, including hdr */
78         int		cmsg_level;	/* originating protocol */
79         int		cmsg_type;	/* protocol-specific type */
80 };
81 
82 /*
83  *	Ancilliary data object information MACROS
84  *	Table 5-14 of POSIX 1003.1g
85  */
86 
87 #define __CMSG_NXTHDR(ctl, len, cmsg) __cmsg_nxthdr((ctl),(len),(cmsg))
88 #define CMSG_NXTHDR(mhdr, cmsg) cmsg_nxthdr((mhdr), (cmsg))
89 
90 #define CMSG_ALIGN(len) ( ((len)+sizeof(long)-1) & ~(sizeof(long)-1) )
91 
92 #define CMSG_DATA(cmsg)	((void *)((char *)(cmsg) + CMSG_ALIGN(sizeof(struct cmsghdr))))
93 #define CMSG_SPACE(len) (CMSG_ALIGN(sizeof(struct cmsghdr)) + CMSG_ALIGN(len))
94 #define CMSG_LEN(len) (CMSG_ALIGN(sizeof(struct cmsghdr)) + (len))
95 
96 #define __CMSG_FIRSTHDR(ctl,len) ((len) >= sizeof(struct cmsghdr) ? \
97 				  (struct cmsghdr *)(ctl) : \
98 				  (struct cmsghdr *)NULL)
99 #define CMSG_FIRSTHDR(msg)	__CMSG_FIRSTHDR((msg)->msg_control, (msg)->msg_controllen)
100 #define CMSG_OK(mhdr, cmsg) ((cmsg)->cmsg_len >= sizeof(struct cmsghdr) && \
101 			     (cmsg)->cmsg_len <= (unsigned long) \
102 			     ((mhdr)->msg_controllen - \
103 			      ((char *)(cmsg) - (char *)(mhdr)->msg_control)))
104 
105 /*
106  *	This mess will go away with glibc
107  */
108 
109 #ifdef __KERNEL__
110 #define __KINLINE static inline
111 #elif  defined(__GNUC__)
112 #define __KINLINE static __inline__
113 #elif defined(__cplusplus)
114 #define __KINLINE static inline
115 #else
116 #define __KINLINE static
117 #endif
118 
119 
120 /*
121  *	Get the next cmsg header
122  *
123  *	PLEASE, do not touch this function. If you think, that it is
124  *	incorrect, grep kernel sources and think about consequences
125  *	before trying to improve it.
126  *
127  *	Now it always returns valid, not truncated ancillary object
128  *	HEADER. But caller still MUST check, that cmsg->cmsg_len is
129  *	inside range, given by msg->msg_controllen before using
130  *	ancillary object DATA.				--ANK (980731)
131  */
132 
133 __KINLINE struct cmsghdr * __cmsg_nxthdr(void *__ctl, __kernel_size_t __size,
134 					       struct cmsghdr *__cmsg)
135 {
136 	struct cmsghdr * __ptr;
137 
138 	__ptr = (struct cmsghdr*)(((unsigned char *) __cmsg) +  CMSG_ALIGN(__cmsg->cmsg_len));
139 	if ((unsigned long)((char*)(__ptr+1) - (char *) __ctl) > __size)
140 		return (struct cmsghdr *)0;
141 
142 	return __ptr;
143 }
144 
145 __KINLINE struct cmsghdr * cmsg_nxthdr (struct msghdr *__msg, struct cmsghdr *__cmsg)
146 {
147 	return __cmsg_nxthdr(__msg->msg_control, __msg->msg_controllen, __cmsg);
148 }
149 
150 /* "Socket"-level control message types: */
151 
152 #define	SCM_RIGHTS	0x01		/* rw: access rights (array of int) */
153 #define SCM_CREDENTIALS 0x02		/* rw: struct ucred		*/
154 
155 struct ucred {
156 	__u32	pid;
157 	__u32	uid;
158 	__u32	gid;
159 };
160 
161 /* Supported address families. */
162 #define AF_UNSPEC	0
163 #define AF_UNIX		1	/* Unix domain sockets 		*/
164 #define AF_LOCAL	1	/* POSIX name for AF_UNIX	*/
165 #define AF_INET		2	/* Internet IP Protocol 	*/
166 #define AF_AX25		3	/* Amateur Radio AX.25 		*/
167 #define AF_IPX		4	/* Novell IPX 			*/
168 #define AF_APPLETALK	5	/* AppleTalk DDP 		*/
169 #define AF_NETROM	6	/* Amateur Radio NET/ROM 	*/
170 #define AF_BRIDGE	7	/* Multiprotocol bridge 	*/
171 #define AF_ATMPVC	8	/* ATM PVCs			*/
172 #define AF_X25		9	/* Reserved for X.25 project 	*/
173 #define AF_INET6	10	/* IP version 6			*/
174 #define AF_ROSE		11	/* Amateur Radio X.25 PLP	*/
175 #define AF_DECnet	12	/* Reserved for DECnet project	*/
176 #define AF_NETBEUI	13	/* Reserved for 802.2LLC project*/
177 #define AF_SECURITY	14	/* Security callback pseudo AF */
178 #define AF_KEY		15      /* PF_KEY key management API */
179 #define AF_NETLINK	16
180 #define AF_ROUTE	AF_NETLINK /* Alias to emulate 4.4BSD */
181 #define AF_PACKET	17	/* Packet family		*/
182 #define AF_ASH		18	/* Ash				*/
183 #define AF_ECONET	19	/* Acorn Econet			*/
184 #define AF_ATMSVC	20	/* ATM SVCs			*/
185 #define AF_SNA		22	/* Linux SNA Project (nutters!) */
186 #define AF_IRDA		23	/* IRDA sockets			*/
187 #define AF_PPPOX	24	/* PPPoX sockets		*/
188 #define AF_WANPIPE	25	/* Wanpipe API Sockets */
189 #define AF_LLC		26	/* Linux LLC			*/
190 #define AF_BLUETOOTH	31	/* Bluetooth sockets 		*/
191 #define AF_MAX		32	/* For now.. */
192 
193 /* Protocol families, same as address families. */
194 #define PF_UNSPEC	AF_UNSPEC
195 #define PF_UNIX		AF_UNIX
196 #define PF_LOCAL	AF_LOCAL
197 #define PF_INET		AF_INET
198 #define PF_AX25		AF_AX25
199 #define PF_IPX		AF_IPX
200 #define PF_APPLETALK	AF_APPLETALK
201 #define	PF_NETROM	AF_NETROM
202 #define PF_BRIDGE	AF_BRIDGE
203 #define PF_ATMPVC	AF_ATMPVC
204 #define PF_X25		AF_X25
205 #define PF_INET6	AF_INET6
206 #define PF_ROSE		AF_ROSE
207 #define PF_DECnet	AF_DECnet
208 #define PF_NETBEUI	AF_NETBEUI
209 #define PF_SECURITY	AF_SECURITY
210 #define PF_KEY		AF_KEY
211 #define PF_NETLINK	AF_NETLINK
212 #define PF_ROUTE	AF_ROUTE
213 #define PF_PACKET	AF_PACKET
214 #define PF_ASH		AF_ASH
215 #define PF_ECONET	AF_ECONET
216 #define PF_ATMSVC	AF_ATMSVC
217 #define PF_SNA		AF_SNA
218 #define PF_IRDA		AF_IRDA
219 #define PF_PPPOX	AF_PPPOX
220 #define PF_WANPIPE	AF_WANPIPE
221 #define PF_LLC		AF_LLC
222 #define PF_BLUETOOTH	AF_BLUETOOTH
223 #define PF_MAX		AF_MAX
224 
225 /* Maximum queue length specifiable by listen.  */
226 #define SOMAXCONN	128
227 
228 /* Flags we can use with send/ and recv.
229    Added those for 1003.1g not all are supported yet
230  */
231 
232 #define MSG_OOB		1
233 #define MSG_PEEK	2
234 #define MSG_DONTROUTE	4
235 #define MSG_TRYHARD     4       /* Synonym for MSG_DONTROUTE for DECnet */
236 #define MSG_CTRUNC	8
237 #define MSG_PROBE	0x10	/* Do not send. Only probe path f.e. for MTU */
238 #define MSG_TRUNC	0x20
239 #define MSG_DONTWAIT	0x40	/* Nonblocking io		 */
240 #define MSG_EOR         0x80	/* End of record */
241 #define MSG_WAITALL	0x100	/* Wait for a full request */
242 #define MSG_FIN         0x200
243 #define MSG_SYN		0x400
244 #define MSG_CONFIRM	0x800	/* Confirm path validity */
245 #define MSG_RST		0x1000
246 #define MSG_ERRQUEUE	0x2000	/* Fetch message from error queue */
247 #define MSG_NOSIGNAL	0x4000	/* Do not generate SIGPIPE */
248 #define MSG_MORE	0x8000	/* Sender will send more */
249 
250 #define MSG_EOF         MSG_FIN
251 
252 #if defined(CONFIG_COMPAT)
253 #define MSG_CMSG_COMPAT	0x80000000	/* This message needs 32 bit fixups */
254 #else
255 #define MSG_CMSG_COMPAT	0		/* We never have 32 bit fixups */
256 #endif
257 
258 
259 /* Setsockoptions(2) level. Thanks to BSD these must match IPPROTO_xxx */
260 #define SOL_IP		0
261 /* #define SOL_ICMP	1	No-no-no! Due to Linux :-) we cannot use SOL_ICMP=1 */
262 #define SOL_TCP		6
263 #define SOL_UDP		17
264 #define SOL_IPV6	41
265 #define SOL_ICMPV6	58
266 #define SOL_SCTP	132
267 #define SOL_RAW		255
268 #define SOL_IPX		256
269 #define SOL_AX25	257
270 #define SOL_ATALK	258
271 #define SOL_NETROM	259
272 #define SOL_ROSE	260
273 #define SOL_DECNET	261
274 #define	SOL_X25		262
275 #define SOL_PACKET	263
276 #define SOL_ATM		264	/* ATM layer (cell level) */
277 #define SOL_AAL		265	/* ATM Adaption Layer (packet level) */
278 #define SOL_IRDA        266
279 #define SOL_NETBEUI	267
280 #define SOL_LLC		268
281 #define SOL_DCCP	269
282 #define SOL_NETLINK	270
283 
284 /* IPX options */
285 #define IPX_TYPE	1
286 
287 #ifdef __KERNEL__
288 extern int memcpy_fromiovec(unsigned char *kdata, struct iovec *iov, int len);
289 extern int memcpy_fromiovecend(unsigned char *kdata, struct iovec *iov,
290 				int offset, int len);
291 extern int csum_partial_copy_fromiovecend(unsigned char *kdata,
292 					  struct iovec *iov,
293 					  int offset,
294 					  unsigned int len, int *csump);
295 
296 extern int verify_iovec(struct msghdr *m, struct iovec *iov, char *address, int mode);
297 extern int memcpy_toiovec(struct iovec *v, unsigned char *kdata, int len);
298 extern int move_addr_to_user(void *kaddr, int klen, void __user *uaddr, int __user *ulen);
299 extern int move_addr_to_kernel(void __user *uaddr, int ulen, void *kaddr);
300 extern int put_cmsg(struct msghdr*, int level, int type, int len, void *data);
301 
302 #endif
303 #endif /* not kernel and not glibc */
304 #endif /* _LINUX_SOCKET_H */
305