blob: a5c7d96e4d2e12172e892b3eb3a3b806e2fa2ca9 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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#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
29typedef unsigned short sa_family_t;
30
31/*
32 * 1003.1g requires sa_family_t and that sa_data is char.
33 */
34
35struct sockaddr {
36 sa_family_t sa_family; /* address family, AF_xxx */
37 char sa_data[14]; /* 14 bytes of protocol address */
38};
39
40struct linger {
41 int l_onoff; /* Linger active */
42 int l_linger; /* How long to linger for */
43};
44
45#define sockaddr_storage __kernel_sockaddr_storage
46
47/*
48 * As we do 4.4BSD message passing we use a 4.4BSD message passing
49 * system, not 4.3. Thus msg_accrights(len) are now missing. They
50 * belong in an obscure libc emulation or the bin.
51 */
52
53struct msghdr {
54 void * msg_name; /* Socket name */
55 int msg_namelen; /* Length of name */
56 struct iovec * msg_iov; /* Data blocks */
57 __kernel_size_t msg_iovlen; /* Number of blocks */
58 void * msg_control; /* Per protocol magic (eg BSD file descriptor passing) */
59 __kernel_size_t msg_controllen; /* Length of cmsg list */
60 unsigned msg_flags;
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 * Ancilliary 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 * This mess will go away with glibc
100 */
101
102#ifdef __KERNEL__
103#define __KINLINE static inline
104#elif defined(__GNUC__)
105#define __KINLINE static __inline__
106#elif defined(__cplusplus)
107#define __KINLINE static inline
108#else
109#define __KINLINE static
110#endif
111
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
126__KINLINE 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
138__KINLINE 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
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_SNA 22 /* Linux SNA Project (nutters!) */
179#define AF_IRDA 23 /* IRDA sockets */
180#define AF_PPPOX 24 /* PPPoX sockets */
181#define AF_WANPIPE 25 /* Wanpipe API Sockets */
182#define AF_LLC 26 /* Linux LLC */
183#define AF_BLUETOOTH 31 /* Bluetooth sockets */
184#define AF_MAX 32 /* For now.. */
185
186/* Protocol families, same as address families. */
187#define PF_UNSPEC AF_UNSPEC
188#define PF_UNIX AF_UNIX
189#define PF_LOCAL AF_LOCAL
190#define PF_INET AF_INET
191#define PF_AX25 AF_AX25
192#define PF_IPX AF_IPX
193#define PF_APPLETALK AF_APPLETALK
194#define PF_NETROM AF_NETROM
195#define PF_BRIDGE AF_BRIDGE
196#define PF_ATMPVC AF_ATMPVC
197#define PF_X25 AF_X25
198#define PF_INET6 AF_INET6
199#define PF_ROSE AF_ROSE
200#define PF_DECnet AF_DECnet
201#define PF_NETBEUI AF_NETBEUI
202#define PF_SECURITY AF_SECURITY
203#define PF_KEY AF_KEY
204#define PF_NETLINK AF_NETLINK
205#define PF_ROUTE AF_ROUTE
206#define PF_PACKET AF_PACKET
207#define PF_ASH AF_ASH
208#define PF_ECONET AF_ECONET
209#define PF_ATMSVC AF_ATMSVC
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_BLUETOOTH AF_BLUETOOTH
216#define PF_MAX AF_MAX
217
218/* Maximum queue length specifiable by listen. */
219#define SOMAXCONN 128
220
221/* Flags we can use with send/ and recv.
222 Added those for 1003.1g not all are supported yet
223 */
224
225#define MSG_OOB 1
226#define MSG_PEEK 2
227#define MSG_DONTROUTE 4
228#define MSG_TRYHARD 4 /* Synonym for MSG_DONTROUTE for DECnet */
229#define MSG_CTRUNC 8
230#define MSG_PROBE 0x10 /* Do not send. Only probe path f.e. for MTU */
231#define MSG_TRUNC 0x20
232#define MSG_DONTWAIT 0x40 /* Nonblocking io */
233#define MSG_EOR 0x80 /* End of record */
234#define MSG_WAITALL 0x100 /* Wait for a full request */
235#define MSG_FIN 0x200
236#define MSG_SYN 0x400
237#define MSG_CONFIRM 0x800 /* Confirm path validity */
238#define MSG_RST 0x1000
239#define MSG_ERRQUEUE 0x2000 /* Fetch message from error queue */
240#define MSG_NOSIGNAL 0x4000 /* Do not generate SIGPIPE */
241#define MSG_MORE 0x8000 /* Sender will send more */
242
243#define MSG_EOF MSG_FIN
244
245#if defined(CONFIG_COMPAT)
246#define MSG_CMSG_COMPAT 0x80000000 /* This message needs 32 bit fixups */
247#else
248#define MSG_CMSG_COMPAT 0 /* We never have 32 bit fixups */
249#endif
250
251
252/* Setsockoptions(2) level. Thanks to BSD these must match IPPROTO_xxx */
253#define SOL_IP 0
254/* #define SOL_ICMP 1 No-no-no! Due to Linux :-) we cannot use SOL_ICMP=1 */
255#define SOL_TCP 6
256#define SOL_UDP 17
257#define SOL_IPV6 41
258#define SOL_ICMPV6 58
259#define SOL_SCTP 132
260#define SOL_RAW 255
261#define SOL_IPX 256
262#define SOL_AX25 257
263#define SOL_ATALK 258
264#define SOL_NETROM 259
265#define SOL_ROSE 260
266#define SOL_DECNET 261
267#define SOL_X25 262
268#define SOL_PACKET 263
269#define SOL_ATM 264 /* ATM layer (cell level) */
270#define SOL_AAL 265 /* ATM Adaption Layer (packet level) */
271#define SOL_IRDA 266
272#define SOL_NETBEUI 267
273#define SOL_LLC 268
274
275/* IPX options */
276#define IPX_TYPE 1
277
278#ifdef __KERNEL__
279extern int memcpy_fromiovec(unsigned char *kdata, struct iovec *iov, int len);
280extern int memcpy_fromiovecend(unsigned char *kdata, struct iovec *iov,
281 int offset, int len);
282extern int csum_partial_copy_fromiovecend(unsigned char *kdata,
283 struct iovec *iov,
284 int offset,
285 unsigned int len, int *csump);
286
287extern int verify_iovec(struct msghdr *m, struct iovec *iov, char *address, int mode);
288extern int memcpy_toiovec(struct iovec *v, unsigned char *kdata, int len);
289extern int move_addr_to_user(void *kaddr, int klen, void __user *uaddr, int __user *ulen);
290extern int move_addr_to_kernel(void __user *uaddr, int ulen, void *kaddr);
291extern int put_cmsg(struct msghdr*, int level, int type, int len, void *data);
292
293#endif
294#endif /* not kernel and not glibc */
295#endif /* _LINUX_SOCKET_H */