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