OSDN Git Service

Replace FSF snail mail address with URLs
[uclinux-h8/uClibc.git] / libc / sysdeps / linux / sparc / bits / socket.h
1 /* System-specific socket constants and types.  Linux version.
2    Copyright (C) 1991,1992,1994-2001,2004,2006 Free Software Foundation, Inc.
3    This file is part of the GNU C Library.
4
5    The GNU C Library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Lesser General Public
7    License as published by the Free Software Foundation; either
8    version 2.1 of the License, or (at your option) any later version.
9
10    The GNU C Library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Lesser General Public License for more details.
14
15    You should have received a copy of the GNU Lesser General Public
16    License along with the GNU C Library; if not, see
17    <http://www.gnu.org/licenses/>.  */
18
19 #ifndef __BITS_SOCKET_H
20 #define __BITS_SOCKET_H
21
22 #if !defined _SYS_SOCKET_H && !defined _NETINET_IN_H
23 # error "Never include <bits/socket.h> directly; use <sys/socket.h> instead."
24 #endif
25
26 #define __need_size_t
27 #define __need_NULL
28 #include <stddef.h>
29
30 #include <limits.h>
31 #include <sys/types.h>
32
33 /* Type for length arguments in socket calls.  */
34 #ifndef __socklen_t_defined
35 typedef __socklen_t socklen_t;
36 # define __socklen_t_defined
37 #endif
38
39 /* Types of sockets.  */
40 enum __socket_type
41 {
42   SOCK_STREAM = 1,              /* Sequenced, reliable, connection-based
43                                    byte streams.  */
44 #define SOCK_STREAM SOCK_STREAM
45   SOCK_DGRAM = 2,               /* Connectionless, unreliable datagrams
46                                    of fixed maximum length.  */
47 #define SOCK_DGRAM SOCK_DGRAM
48   SOCK_RAW = 3,                 /* Raw protocol interface.  */
49 #define SOCK_RAW SOCK_RAW
50   SOCK_RDM = 4,                 /* Reliably-delivered messages.  */
51 #define SOCK_RDM SOCK_RDM
52   SOCK_SEQPACKET = 5,           /* Sequenced, reliable, connection-based,
53                                    datagrams of fixed maximum length.  */
54 #define SOCK_SEQPACKET SOCK_SEQPACKET
55   SOCK_PACKET = 10              /* Linux specific way of getting packets
56                                    at the dev level.  For writing rarp and
57                                    other similar things on the user level. */
58 #define SOCK_PACKET SOCK_PACKET
59 };
60
61 /* Protocol families.  */
62 #define PF_UNSPEC       0       /* Unspecified.  */
63 #define PF_LOCAL        1       /* Local to host (pipes and file-domain).  */
64 #define PF_UNIX         PF_LOCAL /* Old BSD name for PF_LOCAL.  */
65 #define PF_FILE         PF_LOCAL /* Another non-standard name for PF_LOCAL.  */
66 #define PF_INET         2       /* IP protocol family.  */
67 #define PF_AX25         3       /* Amateur Radio AX.25.  */
68 #define PF_IPX          4       /* Novell Internet Protocol.  */
69 #define PF_APPLETALK    5       /* Appletalk DDP.  */
70 #define PF_NETROM       6       /* Amateur radio NetROM.  */
71 #define PF_BRIDGE       7       /* Multiprotocol bridge.  */
72 #define PF_ATMPVC       8       /* ATM PVCs.  */
73 #define PF_X25          9       /* Reserved for X.25 project.  */
74 #define PF_INET6        10      /* IP version 6.  */
75 #define PF_ROSE         11      /* Amateur Radio X.25 PLP.  */
76 #define PF_DECnet       12      /* Reserved for DECnet project.  */
77 #define PF_NETBEUI      13      /* Reserved for 802.2LLC project.  */
78 #define PF_SECURITY     14      /* Security callback pseudo AF.  */
79 #define PF_KEY          15      /* PF_KEY key management API.  */
80 #define PF_NETLINK      16
81 #define PF_ROUTE        PF_NETLINK /* Alias to emulate 4.4BSD.  */
82 #define PF_PACKET       17      /* Packet family.  */
83 #define PF_ASH          18      /* Ash.  */
84 #define PF_ECONET       19      /* Acorn Econet.  */
85 #define PF_ATMSVC       20      /* ATM SVCs.  */
86 #define PF_SNA          22      /* Linux SNA Project */
87 #define PF_IRDA         23      /* IRDA sockets.  */
88 #define PF_PPPOX        24      /* PPPoX sockets.  */
89 #define PF_WANPIPE      25      /* Wanpipe API sockets.  */
90 #define PF_LLC          26      /* Linux LLC.  */
91 #define PF_CAN          29      /* Controller Area Network.  */
92 #define PF_TIPC         30      /* TIPC sockets.  */
93 #define PF_BLUETOOTH    31      /* Bluetooth sockets.  */
94 #define PF_IUCV         32      /* IUCV sockets.  */
95 #define PF_RXRPC        33      /* RxRPC sockets.  */
96 #define PF_ISDN         34      /* mISDN sockets.  */
97 #define PF_PHONET       35      /* Phonet sockets.  */
98 #define PF_IEEE802154   36      /* IEEE 802.15.4 sockets.  */
99 #define PF_CAIF         37      /* CAIF sockets.  */
100 #define PF_ALG          38      /* Algorithm sockets.  */
101 #define PF_MAX          39      /* For now..  */
102
103 /* Address families.  */
104 #define AF_UNSPEC       PF_UNSPEC
105 #define AF_LOCAL        PF_LOCAL
106 #define AF_UNIX         PF_UNIX
107 #define AF_FILE         PF_FILE
108 #define AF_INET         PF_INET
109 #define AF_AX25         PF_AX25
110 #define AF_IPX          PF_IPX
111 #define AF_APPLETALK    PF_APPLETALK
112 #define AF_NETROM       PF_NETROM
113 #define AF_BRIDGE       PF_BRIDGE
114 #define AF_ATMPVC       PF_ATMPVC
115 #define AF_X25          PF_X25
116 #define AF_INET6        PF_INET6
117 #define AF_ROSE         PF_ROSE
118 #define AF_DECnet       PF_DECnet
119 #define AF_NETBEUI      PF_NETBEUI
120 #define AF_SECURITY     PF_SECURITY
121 #define AF_KEY          PF_KEY
122 #define AF_NETLINK      PF_NETLINK
123 #define AF_ROUTE        PF_ROUTE
124 #define AF_PACKET       PF_PACKET
125 #define AF_ASH          PF_ASH
126 #define AF_ECONET       PF_ECONET
127 #define AF_ATMSVC       PF_ATMSVC
128 #define AF_SNA          PF_SNA
129 #define AF_IRDA         PF_IRDA
130 #define AF_PPPOX        PF_PPPOX
131 #define AF_WANPIPE      PF_WANPIPE
132 #define AF_LLC          PF_LLC
133 #define AF_CAN          PF_CAN
134 #define AF_TIPC         PF_TIPC
135 #define AF_BLUETOOTH    PF_BLUETOOTH
136 #define AF_IUCV         PF_IUCV
137 #define AF_RXRPC        PF_RXRPC
138 #define AF_ISDN         PF_ISDN
139 #define AF_PHONET       PF_PHONET
140 #define AF_IEEE802154   PF_IEEE802154
141 #define AF_CAIF         PF_CAIF
142 #define AF_ALG          PF_ALG
143 #define AF_MAX          PF_MAX
144
145 /* Socket level values.  Others are defined in the appropriate headers.
146
147    XXX These definitions also should go into the appropriate headers as
148    far as they are available.  */
149 #define SOL_RAW         255
150 #define SOL_DECNET      261
151 #define SOL_X25         262
152 #define SOL_PACKET      263
153 #define SOL_ATM         264     /* ATM layer (cell level).  */
154 #define SOL_AAL         265     /* ATM Adaption Layer (packet level).  */
155 #define SOL_IRDA        266
156
157 /* Maximum queue length specifiable by listen.  */
158 #define SOMAXCONN       128
159
160 /* Get the definition of the macro to define the common sockaddr members.  */
161 #include <bits/sockaddr.h>
162
163 /* Structure describing a generic socket address.  */
164 struct sockaddr
165   {
166     __SOCKADDR_COMMON (sa_);    /* Common data: address family and length.  */
167     char sa_data[14];           /* Address data.  */
168   };
169
170
171 /* Structure large enough to hold any socket address (with the historical
172    exception of AF_UNIX).  We reserve 128 bytes.  */
173 #if ULONG_MAX > 0xffffffff
174 # define __ss_aligntype __uint64_t
175 #else
176 # define __ss_aligntype __uint32_t
177 #endif
178 #define _SS_SIZE        128
179 #define _SS_PADSIZE     (_SS_SIZE - (2 * sizeof (__ss_aligntype)))
180
181 struct sockaddr_storage
182   {
183     __SOCKADDR_COMMON (ss_);    /* Address family, etc.  */
184     __ss_aligntype __ss_align;  /* Force desired alignment.  */
185     char __ss_padding[_SS_PADSIZE];
186   };
187
188
189 /* Bits in the FLAGS argument to `send', `recv', et al.  */
190 enum
191   {
192     MSG_OOB             = 0x01, /* Process out-of-band data.  */
193 #define MSG_OOB         MSG_OOB
194     MSG_PEEK            = 0x02, /* Peek at incoming messages.  */
195 #define MSG_PEEK        MSG_PEEK
196     MSG_DONTROUTE       = 0x04, /* Don't use local routing.  */
197 #define MSG_DONTROUTE   MSG_DONTROUTE
198 #ifdef __USE_GNU
199     /* DECnet uses a different name.  */
200     MSG_TRYHARD         = MSG_DONTROUTE,
201 # define MSG_TRYHARD    MSG_DONTROUTE
202 #endif
203     MSG_CTRUNC          = 0x08, /* Control data lost before delivery.  */
204 #define MSG_CTRUNC      MSG_CTRUNC
205     MSG_PROXY           = 0x10, /* Supply or ask second address.  */
206 #define MSG_PROXY       MSG_PROXY
207     MSG_TRUNC           = 0x20,
208 #define MSG_TRUNC       MSG_TRUNC
209     MSG_DONTWAIT        = 0x40, /* Nonblocking IO.  */
210 #define MSG_DONTWAIT    MSG_DONTWAIT
211     MSG_EOR             = 0x80, /* End of record.  */
212 #define MSG_EOR         MSG_EOR
213     MSG_WAITALL         = 0x100, /* Wait for a full request.  */
214 #define MSG_WAITALL     MSG_WAITALL
215     MSG_FIN             = 0x200,
216 #define MSG_FIN         MSG_FIN
217     MSG_SYN             = 0x400,
218 #define MSG_SYN         MSG_SYN
219     MSG_CONFIRM         = 0x800, /* Confirm path validity.  */
220 #define MSG_CONFIRM     MSG_CONFIRM
221     MSG_RST             = 0x1000,
222 #define MSG_RST         MSG_RST
223     MSG_ERRQUEUE        = 0x2000, /* Fetch message from error queue.  */
224 #define MSG_ERRQUEUE    MSG_ERRQUEUE
225     MSG_NOSIGNAL        = 0x4000, /* Do not generate SIGPIPE.  */
226 #define MSG_NOSIGNAL    MSG_NOSIGNAL
227     MSG_MORE            = 0x8000  /* Sender will send more.  */
228 #define MSG_MORE        MSG_MORE
229   };
230
231
232 /* Structure describing messages sent by
233    `sendmsg' and received by `recvmsg'.  */
234 /* Note: do not change these members to match glibc; these match the
235    SuSv3 spec already (e.g. msg_iovlen/msg_controllen).
236    http://www.opengroup.org/onlinepubs/009695399/basedefs/sys/socket.h.html */
237 /* Note: linux kernel uses __kernel_size_t (which is 8bytes on 64bit
238    platforms, and 4bytes on 32bit platforms) for msg_iovlen/msg_controllen */
239 struct msghdr
240   {
241     void *msg_name;             /* Address to send to/receive from.  */
242     socklen_t msg_namelen;      /* Length of address data.  */
243
244     struct iovec *msg_iov;      /* Vector of data to send/receive into.  */
245 #if __WORDSIZE == 32
246     int msg_iovlen;             /* Number of elements in the vector.  */
247 #else
248     size_t msg_iovlen;          /* Number of elements in the vector.  */
249 #endif
250
251     void *msg_control;          /* Ancillary data (eg BSD filedesc passing). */
252 #if __WORDSIZE == 32
253     socklen_t msg_controllen;   /* Ancillary data buffer length.  */
254 #else
255     size_t msg_controllen;      /* Ancillary data buffer length.  */
256 #endif
257
258     int msg_flags;              /* Flags on received message.  */
259   };
260
261 /* Structure used for storage of ancillary data object information.  */
262 struct cmsghdr
263   {
264     size_t cmsg_len;            /* Length of data in cmsg_data plus length
265                                    of cmsghdr structure.  */
266     int cmsg_level;             /* Originating protocol.  */
267     int cmsg_type;              /* Protocol specific type.  */
268 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
269     __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data.  */
270 #endif
271   };
272
273 /* Ancillary data object manipulation macros.  */
274 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
275 # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
276 #else
277 # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
278 #endif
279 #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
280 #define CMSG_FIRSTHDR(mhdr) \
281   ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr)                 \
282    ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) NULL)
283 #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
284                          & (size_t) ~(sizeof (size_t) - 1))
285 #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
286                          + CMSG_ALIGN (sizeof (struct cmsghdr)))
287 #define CMSG_LEN(len)   (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
288
289 extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr,
290                                       struct cmsghdr *__cmsg) __THROW;
291 libc_hidden_proto(__cmsg_nxthdr)
292 #ifdef __USE_EXTERN_INLINES
293 # ifndef _EXTERN_INLINE
294 #  define _EXTERN_INLINE extern __inline
295 # endif
296 _EXTERN_INLINE struct cmsghdr *
297 __NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg))
298 {
299   if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
300     /* The kernel header does this so there may be a reason.  */
301     return 0;
302
303   __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg
304                                + CMSG_ALIGN (__cmsg->cmsg_len));
305   if ((unsigned char *) (__cmsg + 1) > ((unsigned char *) __mhdr->msg_control
306                                         + __mhdr->msg_controllen)
307       || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len)
308           > ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)))
309     /* No more entries.  */
310     return 0;
311   return __cmsg;
312 }
313 #endif  /* Use `extern inline'.  */
314
315 /* Socket level message types.  This must match the definitions in
316    <linux/socket.h>.  */
317 enum
318   {
319     SCM_RIGHTS = 0x01           /* Transfer file descriptors.  */
320 #define SCM_RIGHTS SCM_RIGHTS
321 #ifdef __USE_BSD
322     , SCM_CREDENTIALS = 0x02    /* Credentials passing.  */
323 # define SCM_CREDENTIALS SCM_CREDENTIALS
324 #endif
325   };
326
327 /* User visible structure for SCM_CREDENTIALS message */
328
329 struct ucred
330 {
331   pid_t pid;                    /* PID of sending process.  */
332   uid_t uid;                    /* UID of sending process.  */
333   gid_t gid;                    /* GID of sending process.  */
334 };
335
336 /* Get socket manipulation related informations from kernel headers.  */
337 #ifndef __GLIBC__
338 #define __GLIBC__ 2
339 #include <asm/socket.h>
340 #undef __GLIBC__
341 #else
342 #include <asm/socket.h>
343 #endif
344
345
346 /* Structure used to manipulate the SO_LINGER option.  */
347 struct linger
348   {
349     int l_onoff;                /* Nonzero to linger on close.  */
350     int l_linger;               /* Time to linger.  */
351   };
352
353 /* Prefer socketcall over all these for sparc32, 
354    since it only has socketcall */
355 #ifndef __arch64__
356  #undef __NR_accept
357  #undef __NR_bind
358  #undef __NR_connect
359  #undef __NR_getpeername
360  #undef __NR_getsockname
361  #undef __NR_getsockopt
362  #undef __NR_listen
363  #undef __NR_recv
364  #undef __NR_recvfrom
365  #undef __NR_recvmsg
366  #undef __NR_send
367  #undef __NR_sendmsg
368  #undef __NR_sendto
369  #undef __NR_setsockopt
370  #undef __NR_shutdown
371  #undef __NR_socket
372  #undef __NR_socketpair
373 #endif
374
375 #endif  /* bits/socket.h */