xref: /utopia/UTPA2-700.0.x/projects/tools/lint/mips-linux-gnu_include/bits/socket.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1 /* System-specific socket constants and types.  Linux/MIPS version.
2    Copyright (C) 1991, 92, 1994-1999, 2000, 2001, 2004, 2005, 2006, 2007, 2008
3    Free Software Foundation, Inc.
4    This file is part of the GNU C Library.
5 
6    The GNU C Library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2.1 of the License, or (at your option) any later version.
10 
11    The GNU C Library is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Lesser General Public License for more details.
15 
16    You should have received a copy of the GNU Lesser General Public
17    License along with the GNU C Library; if not, write to the Free
18    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19    02111-1307 USA.  */
20 
21 #ifndef __BITS_SOCKET_H
22 #define __BITS_SOCKET_H
23 
24 #if !defined _SYS_SOCKET_H && !defined _NETINET_IN_H
25 # error "Never include <bits/socket.h> directly; use <sys/socket.h> instead."
26 #endif
27 
28 #define	__need_size_t
29 #include <stddef.h>
30 
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_DGRAM = 1,		/* Connectionless, unreliable datagrams
43 				   of fixed maximum length.  */
44 #define SOCK_DGRAM SOCK_DGRAM
45   SOCK_STREAM = 2,		/* Sequenced, reliable, connection-based
46 				   byte streams.  */
47 #define SOCK_STREAM SOCK_STREAM
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 /* POSIX 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_BLUETOOTH	31	/* Bluetooth sockets.  */
91 #define	PF_IUCV		32	/* IUCV sockets.  */
92 #define PF_RXRPC	33	/* RxRPC sockets.  */
93 #define	PF_MAX		34	/* For now..  */
94 
95 /* Address families.  */
96 #define	AF_UNSPEC	PF_UNSPEC
97 #define	AF_LOCAL	PF_LOCAL
98 #define	AF_UNIX		PF_UNIX
99 #define	AF_FILE		PF_FILE
100 #define	AF_INET		PF_INET
101 #define	AF_AX25		PF_AX25
102 #define	AF_IPX		PF_IPX
103 #define	AF_APPLETALK	PF_APPLETALK
104 #define	AF_NETROM	PF_NETROM
105 #define	AF_BRIDGE	PF_BRIDGE
106 #define	AF_ATMPVC	PF_ATMPVC
107 #define	AF_X25		PF_X25
108 #define	AF_INET6	PF_INET6
109 #define	AF_ROSE		PF_ROSE
110 #define	AF_DECnet	PF_DECnet
111 #define	AF_NETBEUI	PF_NETBEUI
112 #define	AF_SECURITY	PF_SECURITY
113 #define	AF_KEY		PF_KEY
114 #define	AF_NETLINK	PF_NETLINK
115 #define	AF_ROUTE	PF_ROUTE
116 #define	AF_PACKET	PF_PACKET
117 #define	AF_ASH		PF_ASH
118 #define	AF_ECONET	PF_ECONET
119 #define	AF_ATMSVC	PF_ATMSVC
120 #define	AF_SNA		PF_SNA
121 #define	AF_IRDA		PF_IRDA
122 #define	AF_PPPOX	PF_PPPOX
123 #define	AF_WANPIPE	PF_WANPIPE
124 #define	AF_BLUETOOTH	PF_BLUETOOTH
125 #define	AF_IUCV		PF_IUCV
126 #define AF_RXRPC	PF_RXRPC
127 #define	AF_MAX		PF_MAX
128 
129 /* Socket level values.  Others are defined in the appropriate headers.
130 
131    XXX These definitions also should go into the appropriate headers as
132    far as they are available.  */
133 #define SOL_RAW		255
134 #define SOL_DECNET      261
135 #define SOL_X25         262
136 #define SOL_PACKET	263
137 #define SOL_ATM		264	/* ATM layer (cell level).  */
138 #define SOL_AAL		265	/* ATM Adaption Layer (packet level).  */
139 #define SOL_IRDA	266
140 
141 /* Maximum queue length specifiable by listen.  */
142 #define SOMAXCONN	128
143 
144 /* Get the definition of the macro to define the common sockaddr members.  */
145 #include <bits/sockaddr.h>
146 
147 /* Structure describing a generic socket address.  */
148 struct sockaddr
149   {
150     __SOCKADDR_COMMON (sa_);	/* Common data: address family and length.  */
151     char sa_data[14];		/* Address data.  */
152   };
153 
154 
155 /* Structure large enough to hold any socket address (with the historical
156    exception of AF_UNIX).  We reserve 128 bytes.  */
157 #define __ss_aligntype	unsigned long int
158 #define _SS_SIZE	128
159 #define _SS_PADSIZE	(_SS_SIZE - (2 * sizeof (__ss_aligntype)))
160 
161 struct sockaddr_storage
162   {
163     __SOCKADDR_COMMON (ss_);	/* Address family, etc.  */
164     __ss_aligntype __ss_align;	/* Force desired alignment.  */
165     char __ss_padding[_SS_PADSIZE];
166   };
167 
168 
169 /* Bits in the FLAGS argument to `send', `recv', et al.  */
170 enum
171   {
172     MSG_OOB		= 0x01,	/* Process out-of-band data.  */
173 #define MSG_OOB		MSG_OOB
174     MSG_PEEK		= 0x02,	/* Peek at incoming messages.  */
175 #define MSG_PEEK	MSG_PEEK
176     MSG_DONTROUTE	= 0x04,	/* Don't use local routing.  */
177 #define MSG_DONTROUTE	MSG_DONTROUTE
178 #ifdef __USE_GNU
179     /* DECnet uses a different name.  */
180     MSG_TRYHARD		= MSG_DONTROUTE,
181 # define MSG_TRYHARD	MSG_DONTROUTE
182 #endif
183     MSG_CTRUNC		= 0x08,	/* Control data lost before delivery.  */
184 #define MSG_CTRUNC	MSG_CTRUNC
185     MSG_PROXY		= 0x10,	/* Supply or ask second address.  */
186 #define MSG_PROXY	MSG_PROXY
187     MSG_TRUNC		= 0x20,
188 #define	MSG_TRUNC	MSG_TRUNC
189     MSG_DONTWAIT	= 0x40, /* Nonblocking IO.  */
190 #define	MSG_DONTWAIT	MSG_DONTWAIT
191     MSG_EOR		= 0x80, /* End of record.  */
192 #define	MSG_EOR		MSG_EOR
193     MSG_WAITALL		= 0x100, /* Wait for a full request.  */
194 #define	MSG_WAITALL	MSG_WAITALL
195     MSG_FIN		= 0x200,
196 #define	MSG_FIN		MSG_FIN
197     MSG_SYN		= 0x400,
198 #define	MSG_SYN		MSG_SYN
199     MSG_CONFIRM		= 0x800, /* Confirm path validity.  */
200 #define	MSG_CONFIRM	MSG_CONFIRM
201     MSG_RST		= 0x1000,
202 #define	MSG_RST		MSG_RST
203     MSG_ERRQUEUE	= 0x2000, /* Fetch message from error queue.  */
204 #define	MSG_ERRQUEUE	MSG_ERRQUEUE
205     MSG_NOSIGNAL	= 0x4000, /* Do not generate SIGPIPE.  */
206 #define	MSG_NOSIGNAL	MSG_NOSIGNAL
207     MSG_MORE		= 0x8000,  /* Sender will send more.  */
208 #define	MSG_MORE	MSG_MORE
209 
210     MSG_CMSG_CLOEXEC	= 0x40000000	/* Set close_on_exit for file
211                                            descriptor received through
212                                            SCM_RIGHTS.  */
213 #define MSG_CMSG_CLOEXEC MSG_CMSG_CLOEXEC
214   };
215 
216 
217 /* Structure describing messages sent by
218    `sendmsg' and received by `recvmsg'.  */
219 struct msghdr
220   {
221     void *msg_name;		/* Address to send to/receive from.  */
222     socklen_t msg_namelen;	/* Length of address data.  */
223 
224     struct iovec *msg_iov;	/* Vector of data to send/receive into.  */
225     size_t msg_iovlen;		/* Number of elements in the vector.  */
226 
227     void *msg_control;		/* Ancillary data (eg BSD filedesc passing). */
228     size_t msg_controllen;	/* Ancillary data buffer length.  */
229 
230     int msg_flags;		/* Flags on received message.  */
231   };
232 
233 /* Structure used for storage of ancillary data object information.  */
234 struct cmsghdr
235   {
236     size_t cmsg_len;		/* Length of data in cmsg_data plus length
237 				   of cmsghdr structure.  */
238     int cmsg_level;		/* Originating protocol.  */
239     int cmsg_type;		/* Protocol specific type.  */
240 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
241     __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data.  */
242 #endif
243   };
244 
245 /* Ancillary data object manipulation macros.  */
246 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
247 # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
248 #else
249 # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
250 #endif
251 #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
252 #define CMSG_FIRSTHDR(mhdr) \
253   ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr)		      \
254    ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) 0)
255 #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
256 			 & (size_t) ~(sizeof (size_t) - 1))
257 #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
258 			 + CMSG_ALIGN (sizeof (struct cmsghdr)))
259 #define CMSG_LEN(len)   (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
260 
261 extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr,
262 				      struct cmsghdr *__cmsg) __THROW;
263 #ifdef __USE_EXTERN_INLINES
264 # ifndef _EXTERN_INLINE
265 #  define _EXTERN_INLINE __extern_inline
266 # endif
267 _EXTERN_INLINE struct cmsghdr *
__NTH(__cmsg_nxthdr (struct msghdr * __mhdr,struct cmsghdr * __cmsg))268 __NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg))
269 {
270   if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
271     /* The kernel header does this so there may be a reason.  */
272     return 0;
273 
274   __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg
275 			       + CMSG_ALIGN (__cmsg->cmsg_len));
276   if ((unsigned char *) (__cmsg + 1) > ((unsigned char *) __mhdr->msg_control
277 					+ __mhdr->msg_controllen)
278       || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len)
279 	  > ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)))
280     /* No more entries.  */
281     return 0;
282   return __cmsg;
283 }
284 #endif	/* Use `extern inline'.  */
285 
286 /* Socket level message types.  This must match the definitions in
287    <linux/socket.h>.  */
288 enum
289   {
290     SCM_RIGHTS = 0x01		/* Transfer file descriptors.  */
291 #define SCM_RIGHTS SCM_RIGHTS
292 #ifdef __USE_BSD
293     , SCM_CREDENTIALS = 0x02	/* Credentials passing.  */
294 # define SCM_CREDENTIALS SCM_CREDENTIALS
295 #endif
296   };
297 
298 #ifdef __USE_GNU
299 /* User visible structure for SCM_CREDENTIALS message */
300 struct ucred
301 {
302   pid_t pid;			/* PID of sending process.  */
303   uid_t uid;			/* UID of sending process.  */
304   gid_t gid;			/* GID of sending process.  */
305 };
306 #endif
307 
308 /* Ugly workaround for unclean kernel headers.  */
309 #if !defined __USE_MISC && !defined __USE_GNU
310 # ifndef FIOGETOWN
311 #  define __SYS_SOCKET_H_undef_FIOGETOWN
312 # endif
313 # ifndef FIOSETOWN
314 #  define __SYS_SOCKET_H_undef_FIOSETOWN
315 # endif
316 # ifndef SIOCATMARK
317 #  define __SYS_SOCKET_H_undef_SIOCATMARK
318 # endif
319 # ifndef SIOCGPGRP
320 #  define __SYS_SOCKET_H_undef_SIOCGPGRP
321 # endif
322 # ifndef SIOCGSTAMP
323 #  define __SYS_SOCKET_H_undef_SIOCGSTAMP
324 # endif
325 # ifndef SIOCGSTAMPNS
326 #  define __SYS_SOCKET_H_undef_SIOCGSTAMPNS
327 # endif
328 # ifndef SIOCSPGRP
329 #  define __SYS_SOCKET_H_undef_SIOCSPGRP
330 # endif
331 #endif
332 
333 /* Get socket manipulation related informations from kernel headers.  */
334 #include <asm/socket.h>
335 
336 #if !defined __USE_MISC && !defined __USE_GNU
337 # ifdef __SYS_SOCKET_H_undef_FIOGETOWN
338 #  undef __SYS_SOCKET_H_undef_FIOGETOWN
339 #  undef FIOGETOWN
340 # endif
341 # ifdef __SYS_SOCKET_H_undef_FIOSETOWN
342 #  undef __SYS_SOCKET_H_undef_FIOSETOWN
343 #  undef FIOSETOWN
344 # endif
345 # ifdef __SYS_SOCKET_H_undef_SIOCATMARK
346 #  undef __SYS_SOCKET_H_undef_SIOCATMARK
347 #  undef SIOCATMARK
348 # endif
349 # ifdef __SYS_SOCKET_H_undef_SIOCGPGRP
350 #  undef __SYS_SOCKET_H_undef_SIOCGPGRP
351 #  undef SIOCGPGRP
352 # endif
353 # ifdef __SYS_SOCKET_H_undef_SIOCGSTAMP
354 #  undef __SYS_SOCKET_H_undef_SIOCGSTAMP
355 #  undef SIOCGSTAMP
356 # endif
357 # ifdef __SYS_SOCKET_H_undef_SIOCGSTAMPNS
358 #  undef __SYS_SOCKET_H_undef_SIOCGSTAMPNS
359 #  undef SIOCGSTAMPNS
360 # endif
361 # ifdef __SYS_SOCKET_H_undef_SIOCSPGRP
362 #  undef __SYS_SOCKET_H_undef_SIOCSPGRP
363 #  undef SIOCSPGRP
364 # endif
365 #endif
366 
367 /* Structure used to manipulate the SO_LINGER option.  */
368 struct linger
369   {
370     int l_onoff;		/* Nonzero to linger on close.  */
371     int l_linger;		/* Time to linger.  */
372   };
373 
374 #endif	/* bits/socket.h */
375