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