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