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