blob: 20fc4bbfca42b4327c346fd1f491661838062e34 [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
David S. Miller304c2092007-02-26 15:45:15 -080019#if defined(__KERNEL__) || !defined(__GLIBC__) || (__GLIBC__ < 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#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
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -030027#ifdef CONFIG_PROC_FS
28struct seq_file;
29extern void socket_seq_show(struct seq_file *seq);
30#endif
31
Linus Torvalds1da177e2005-04-16 15:20:36 -070032typedef unsigned short sa_family_t;
33
34/*
35 * 1003.1g requires sa_family_t and that sa_data is char.
36 */
37
38struct sockaddr {
39 sa_family_t sa_family; /* address family, AF_xxx */
40 char sa_data[14]; /* 14 bytes of protocol address */
41};
42
43struct linger {
44 int l_onoff; /* Linger active */
45 int l_linger; /* How long to linger for */
46};
47
48#define sockaddr_storage __kernel_sockaddr_storage
49
50/*
51 * As we do 4.4BSD message passing we use a 4.4BSD message passing
52 * system, not 4.3. Thus msg_accrights(len) are now missing. They
53 * belong in an obscure libc emulation or the bin.
54 */
55
56struct msghdr {
57 void * msg_name; /* Socket name */
58 int msg_namelen; /* Length of name */
59 struct iovec * msg_iov; /* Data blocks */
60 __kernel_size_t msg_iovlen; /* Number of blocks */
61 void * msg_control; /* Per protocol magic (eg BSD file descriptor passing) */
62 __kernel_size_t msg_controllen; /* Length of cmsg list */
63 unsigned msg_flags;
64};
65
66/*
67 * POSIX 1003.1g - ancillary data object information
68 * Ancillary data consits of a sequence of pairs of
69 * (cmsghdr, cmsg_data[])
70 */
71
72struct cmsghdr {
73 __kernel_size_t cmsg_len; /* data byte count, including hdr */
74 int cmsg_level; /* originating protocol */
75 int cmsg_type; /* protocol-specific type */
76};
77
78/*
79 * Ancilliary data object information MACROS
80 * Table 5-14 of POSIX 1003.1g
81 */
82
83#define __CMSG_NXTHDR(ctl, len, cmsg) __cmsg_nxthdr((ctl),(len),(cmsg))
84#define CMSG_NXTHDR(mhdr, cmsg) cmsg_nxthdr((mhdr), (cmsg))
85
86#define CMSG_ALIGN(len) ( ((len)+sizeof(long)-1) & ~(sizeof(long)-1) )
87
88#define CMSG_DATA(cmsg) ((void *)((char *)(cmsg) + CMSG_ALIGN(sizeof(struct cmsghdr))))
89#define CMSG_SPACE(len) (CMSG_ALIGN(sizeof(struct cmsghdr)) + CMSG_ALIGN(len))
90#define CMSG_LEN(len) (CMSG_ALIGN(sizeof(struct cmsghdr)) + (len))
91
92#define __CMSG_FIRSTHDR(ctl,len) ((len) >= sizeof(struct cmsghdr) ? \
93 (struct cmsghdr *)(ctl) : \
94 (struct cmsghdr *)NULL)
95#define CMSG_FIRSTHDR(msg) __CMSG_FIRSTHDR((msg)->msg_control, (msg)->msg_controllen)
96#define CMSG_OK(mhdr, cmsg) ((cmsg)->cmsg_len >= sizeof(struct cmsghdr) && \
97 (cmsg)->cmsg_len <= (unsigned long) \
98 ((mhdr)->msg_controllen - \
99 ((char *)(cmsg) - (char *)(mhdr)->msg_control)))
100
101/*
102 * This mess will go away with glibc
103 */
104
105#ifdef __KERNEL__
106#define __KINLINE static inline
107#elif defined(__GNUC__)
108#define __KINLINE static __inline__
109#elif defined(__cplusplus)
110#define __KINLINE static inline
111#else
112#define __KINLINE static
113#endif
114
115
116/*
117 * Get the next cmsg header
118 *
119 * PLEASE, do not touch this function. If you think, that it is
120 * incorrect, grep kernel sources and think about consequences
121 * before trying to improve it.
122 *
123 * Now it always returns valid, not truncated ancillary object
124 * HEADER. But caller still MUST check, that cmsg->cmsg_len is
125 * inside range, given by msg->msg_controllen before using
126 * ancillary object DATA. --ANK (980731)
127 */
128
129__KINLINE struct cmsghdr * __cmsg_nxthdr(void *__ctl, __kernel_size_t __size,
130 struct cmsghdr *__cmsg)
131{
132 struct cmsghdr * __ptr;
133
134 __ptr = (struct cmsghdr*)(((unsigned char *) __cmsg) + CMSG_ALIGN(__cmsg->cmsg_len));
135 if ((unsigned long)((char*)(__ptr+1) - (char *) __ctl) > __size)
136 return (struct cmsghdr *)0;
137
138 return __ptr;
139}
140
141__KINLINE struct cmsghdr * cmsg_nxthdr (struct msghdr *__msg, struct cmsghdr *__cmsg)
142{
143 return __cmsg_nxthdr(__msg->msg_control, __msg->msg_controllen, __cmsg);
144}
145
146/* "Socket"-level control message types: */
147
148#define SCM_RIGHTS 0x01 /* rw: access rights (array of int) */
149#define SCM_CREDENTIALS 0x02 /* rw: struct ucred */
Catherine Zhang2c7946a2006-03-20 22:41:23 -0800150#define SCM_SECURITY 0x03 /* rw: security label */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
152struct ucred {
153 __u32 pid;
154 __u32 uid;
155 __u32 gid;
156};
157
158/* Supported address families. */
159#define AF_UNSPEC 0
160#define AF_UNIX 1 /* Unix domain sockets */
161#define AF_LOCAL 1 /* POSIX name for AF_UNIX */
162#define AF_INET 2 /* Internet IP Protocol */
163#define AF_AX25 3 /* Amateur Radio AX.25 */
164#define AF_IPX 4 /* Novell IPX */
165#define AF_APPLETALK 5 /* AppleTalk DDP */
166#define AF_NETROM 6 /* Amateur Radio NET/ROM */
167#define AF_BRIDGE 7 /* Multiprotocol bridge */
168#define AF_ATMPVC 8 /* ATM PVCs */
169#define AF_X25 9 /* Reserved for X.25 project */
170#define AF_INET6 10 /* IP version 6 */
171#define AF_ROSE 11 /* Amateur Radio X.25 PLP */
172#define AF_DECnet 12 /* Reserved for DECnet project */
173#define AF_NETBEUI 13 /* Reserved for 802.2LLC project*/
174#define AF_SECURITY 14 /* Security callback pseudo AF */
175#define AF_KEY 15 /* PF_KEY key management API */
176#define AF_NETLINK 16
177#define AF_ROUTE AF_NETLINK /* Alias to emulate 4.4BSD */
178#define AF_PACKET 17 /* Packet family */
179#define AF_ASH 18 /* Ash */
180#define AF_ECONET 19 /* Acorn Econet */
181#define AF_ATMSVC 20 /* ATM SVCs */
182#define AF_SNA 22 /* Linux SNA Project (nutters!) */
183#define AF_IRDA 23 /* IRDA sockets */
184#define AF_PPPOX 24 /* PPPoX sockets */
185#define AF_WANPIPE 25 /* Wanpipe API Sockets */
186#define AF_LLC 26 /* Linux LLC */
Oliver Hartkoppcd05acf2007-12-16 15:59:24 -0800187#define AF_CAN 29 /* Controller Area Network */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100188#define AF_TIPC 30 /* TIPC sockets */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189#define AF_BLUETOOTH 31 /* Bluetooth sockets */
Jennifer Hunteac37312007-02-08 13:51:54 -0800190#define AF_IUCV 32 /* IUCV sockets */
David Howells17926a72007-04-26 15:48:28 -0700191#define AF_RXRPC 33 /* RxRPC sockets */
Karsten Keil04578dd2008-07-26 18:52:34 +0200192#define AF_ISDN 34 /* mISDN sockets */
Remi Denis-Courmontbce7b152008-09-22 19:51:15 -0700193#define AF_PHONET 35 /* Phonet sockets */
194#define AF_MAX 36 /* For now.. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
196/* Protocol families, same as address families. */
197#define PF_UNSPEC AF_UNSPEC
198#define PF_UNIX AF_UNIX
199#define PF_LOCAL AF_LOCAL
200#define PF_INET AF_INET
201#define PF_AX25 AF_AX25
202#define PF_IPX AF_IPX
203#define PF_APPLETALK AF_APPLETALK
204#define PF_NETROM AF_NETROM
205#define PF_BRIDGE AF_BRIDGE
206#define PF_ATMPVC AF_ATMPVC
207#define PF_X25 AF_X25
208#define PF_INET6 AF_INET6
209#define PF_ROSE AF_ROSE
210#define PF_DECnet AF_DECnet
211#define PF_NETBEUI AF_NETBEUI
212#define PF_SECURITY AF_SECURITY
213#define PF_KEY AF_KEY
214#define PF_NETLINK AF_NETLINK
215#define PF_ROUTE AF_ROUTE
216#define PF_PACKET AF_PACKET
217#define PF_ASH AF_ASH
218#define PF_ECONET AF_ECONET
219#define PF_ATMSVC AF_ATMSVC
220#define PF_SNA AF_SNA
221#define PF_IRDA AF_IRDA
222#define PF_PPPOX AF_PPPOX
223#define PF_WANPIPE AF_WANPIPE
224#define PF_LLC AF_LLC
Oliver Hartkoppcd05acf2007-12-16 15:59:24 -0800225#define PF_CAN AF_CAN
Per Lidenb97bf3f2006-01-02 19:04:38 +0100226#define PF_TIPC AF_TIPC
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227#define PF_BLUETOOTH AF_BLUETOOTH
Jennifer Hunteac37312007-02-08 13:51:54 -0800228#define PF_IUCV AF_IUCV
David Howells17926a72007-04-26 15:48:28 -0700229#define PF_RXRPC AF_RXRPC
Karsten Keil04578dd2008-07-26 18:52:34 +0200230#define PF_ISDN AF_ISDN
Remi Denis-Courmontbce7b152008-09-22 19:51:15 -0700231#define PF_PHONET AF_PHONET
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232#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
Ulrich Drepper4a195422007-07-15 23:40:34 -0700261#define MSG_CMSG_CLOEXEC 0x40000000 /* Set close_on_exit for file
262 descriptor received through
263 SCM_RIGHTS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264#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
Gerrit Renkerba4e58e2006-11-27 11:10:57 -0800279#define SOL_UDPLITE 136 /* UDP-Lite (RFC 3828) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280#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
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700294#define SOL_DCCP 269
Patrick McHardy9a4595b2005-08-15 12:32:15 -0700295#define SOL_NETLINK 270
Per Lidenb97bf3f2006-01-02 19:04:38 +0100296#define SOL_TIPC 271
David Howells17926a72007-04-26 15:48:28 -0700297#define SOL_RXRPC 272
James Chapmancf14a4d2007-06-27 15:43:43 -0700298#define SOL_PPPOL2TP 273
Marcel Holtmann2cb33772007-10-20 15:28:08 +0200299#define SOL_BLUETOOTH 274
RĂ©mi Denis-Courmont02a47612008-10-05 11:16:16 -0700300#define SOL_PNPIPE 275
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301
302/* IPX options */
303#define IPX_TYPE 1
304
305#ifdef __KERNEL__
306extern int memcpy_fromiovec(unsigned char *kdata, struct iovec *iov, int len);
307extern int memcpy_fromiovecend(unsigned char *kdata, struct iovec *iov,
308 int offset, int len);
309extern int csum_partial_copy_fromiovecend(unsigned char *kdata,
310 struct iovec *iov,
311 int offset,
Al Viro44bb9362006-11-14 21:36:14 -0800312 unsigned int len, __wsum *csump);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
YOSHIFUJI Hideaki230b1832008-07-19 22:35:47 -0700314extern int verify_iovec(struct msghdr *m, struct iovec *iov, struct sockaddr *address, int mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315extern int memcpy_toiovec(struct iovec *v, unsigned char *kdata, int len);
YOSHIFUJI Hideaki230b1832008-07-19 22:35:47 -0700316extern int move_addr_to_user(struct sockaddr *kaddr, int klen, void __user *uaddr, int __user *ulen);
317extern int move_addr_to_kernel(void __user *uaddr, int ulen, struct sockaddr *kaddr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318extern int put_cmsg(struct msghdr*, int level, int type, int len, void *data);
319
320#endif
321#endif /* not kernel and not glibc */
322#endif /* _LINUX_SOCKET_H */