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