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