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