Update MIPS bits/socket.h for mmsghdr and recvmmsg.
[glibc-ports.git] / sysdeps / unix / sysv / linux / mips / bits / socket.h
blob4899077a961c6503046ffadc15b32ba855cba3ff
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 2009 Free Software Foundation, Inc.
4 This file is part of the GNU C Library.
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.
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.
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. */
21 #ifndef __BITS_SOCKET_H
22 #define __BITS_SOCKET_H
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
28 #define __need_size_t
29 #include <stddef.h>
31 #include <sys/types.h>
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
39 /* Types of sockets. */
40 enum __socket_type
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_DCCP = 6,
56 #define SOCK_DCCP SOCK_DCCP /* Datagram Congestion Control Protocol. */
57 SOCK_PACKET = 10, /* Linux specific way of getting packets
58 at the dev level. For writing rarp and
59 other similar things on the user level. */
60 #define SOCK_PACKET SOCK_PACKET
62 /* Flags to be ORed into the type parameter of socket and socketpair and
63 used for the flags parameter of paccept. */
65 SOCK_CLOEXEC = 02000000, /* Atomically set close-on-exec flag for the
66 new descriptor(s). */
67 #define SOCK_CLOEXEC SOCK_CLOEXEC
68 SOCK_NONBLOCK = 0200 /* Atomically mark descriptor(s) as
69 non-blocking. */
70 #define SOCK_NONBLOCK SOCK_NONBLOCK
73 /* Protocol families. */
74 #define PF_UNSPEC 0 /* Unspecified. */
75 #define PF_LOCAL 1 /* Local to host (pipes and file-domain). */
76 #define PF_UNIX PF_LOCAL /* POSIX name for PF_LOCAL. */
77 #define PF_FILE PF_LOCAL /* Another non-standard name for PF_LOCAL. */
78 #define PF_INET 2 /* IP protocol family. */
79 #define PF_AX25 3 /* Amateur Radio AX.25. */
80 #define PF_IPX 4 /* Novell Internet Protocol. */
81 #define PF_APPLETALK 5 /* Appletalk DDP. */
82 #define PF_NETROM 6 /* Amateur radio NetROM. */
83 #define PF_BRIDGE 7 /* Multiprotocol bridge. */
84 #define PF_ATMPVC 8 /* ATM PVCs. */
85 #define PF_X25 9 /* Reserved for X.25 project. */
86 #define PF_INET6 10 /* IP version 6. */
87 #define PF_ROSE 11 /* Amateur Radio X.25 PLP. */
88 #define PF_DECnet 12 /* Reserved for DECnet project. */
89 #define PF_NETBEUI 13 /* Reserved for 802.2LLC project. */
90 #define PF_SECURITY 14 /* Security callback pseudo AF. */
91 #define PF_KEY 15 /* PF_KEY key management API. */
92 #define PF_NETLINK 16
93 #define PF_ROUTE PF_NETLINK /* Alias to emulate 4.4BSD. */
94 #define PF_PACKET 17 /* Packet family. */
95 #define PF_ASH 18 /* Ash. */
96 #define PF_ECONET 19 /* Acorn Econet. */
97 #define PF_ATMSVC 20 /* ATM SVCs. */
98 #define PF_RDS 21 /* RDS sockets. */
99 #define PF_SNA 22 /* Linux SNA Project */
100 #define PF_IRDA 23 /* IRDA sockets. */
101 #define PF_PPPOX 24 /* PPPoX sockets. */
102 #define PF_WANPIPE 25 /* Wanpipe API sockets. */
103 #define PF_LLC 26 /* Linux LLC. */
104 #define PF_CAN 29 /* Controller Area Network. */
105 #define PF_TIPC 30 /* TIPC sockets. */
106 #define PF_BLUETOOTH 31 /* Bluetooth sockets. */
107 #define PF_IUCV 32 /* IUCV sockets. */
108 #define PF_RXRPC 33 /* RxRPC sockets. */
109 #define PF_ISDN 34 /* mISDN sockets. */
110 #define PF_PHONET 35 /* Phonet sockets. */
111 #define PF_IEEE802154 36 /* IEEE 802.15.4 sockets. */
112 #define PF_MAX 37 /* For now.. */
114 /* Address families. */
115 #define AF_UNSPEC PF_UNSPEC
116 #define AF_LOCAL PF_LOCAL
117 #define AF_UNIX PF_UNIX
118 #define AF_FILE PF_FILE
119 #define AF_INET PF_INET
120 #define AF_AX25 PF_AX25
121 #define AF_IPX PF_IPX
122 #define AF_APPLETALK PF_APPLETALK
123 #define AF_NETROM PF_NETROM
124 #define AF_BRIDGE PF_BRIDGE
125 #define AF_ATMPVC PF_ATMPVC
126 #define AF_X25 PF_X25
127 #define AF_INET6 PF_INET6
128 #define AF_ROSE PF_ROSE
129 #define AF_DECnet PF_DECnet
130 #define AF_NETBEUI PF_NETBEUI
131 #define AF_SECURITY PF_SECURITY
132 #define AF_KEY PF_KEY
133 #define AF_NETLINK PF_NETLINK
134 #define AF_ROUTE PF_ROUTE
135 #define AF_PACKET PF_PACKET
136 #define AF_ASH PF_ASH
137 #define AF_ECONET PF_ECONET
138 #define AF_ATMSVC PF_ATMSVC
139 #define AF_RDS PF_RDS
140 #define AF_SNA PF_SNA
141 #define AF_IRDA PF_IRDA
142 #define AF_PPPOX PF_PPPOX
143 #define AF_WANPIPE PF_WANPIPE
144 #define AF_LLC PF_LLC
145 #define AF_CAN PF_CAN
146 #define AF_TIPC PF_TIPC
147 #define AF_BLUETOOTH PF_BLUETOOTH
148 #define AF_IUCV PF_IUCV
149 #define AF_RXRPC PF_RXRPC
150 #define AF_ISDN PF_ISDN
151 #define AF_PHONET PF_PHONET
152 #define AF_IEEE802154 PF_IEEE802154
153 #define AF_MAX PF_MAX
155 /* Socket level values. Others are defined in the appropriate headers.
157 XXX These definitions also should go into the appropriate headers as
158 far as they are available. */
159 #define SOL_RAW 255
160 #define SOL_DECNET 261
161 #define SOL_X25 262
162 #define SOL_PACKET 263
163 #define SOL_ATM 264 /* ATM layer (cell level). */
164 #define SOL_AAL 265 /* ATM Adaption Layer (packet level). */
165 #define SOL_IRDA 266
167 /* Maximum queue length specifiable by listen. */
168 #define SOMAXCONN 128
170 /* Get the definition of the macro to define the common sockaddr members. */
171 #include <bits/sockaddr.h>
173 /* Structure describing a generic socket address. */
174 struct sockaddr
176 __SOCKADDR_COMMON (sa_); /* Common data: address family and length. */
177 char sa_data[14]; /* Address data. */
181 /* Structure large enough to hold any socket address (with the historical
182 exception of AF_UNIX). We reserve 128 bytes. */
183 #define __ss_aligntype unsigned long int
184 #define _SS_SIZE 128
185 #define _SS_PADSIZE (_SS_SIZE - (2 * sizeof (__ss_aligntype)))
187 struct sockaddr_storage
189 __SOCKADDR_COMMON (ss_); /* Address family, etc. */
190 __ss_aligntype __ss_align; /* Force desired alignment. */
191 char __ss_padding[_SS_PADSIZE];
195 /* Bits in the FLAGS argument to `send', `recv', et al. */
196 enum
198 MSG_OOB = 0x01, /* Process out-of-band data. */
199 #define MSG_OOB MSG_OOB
200 MSG_PEEK = 0x02, /* Peek at incoming messages. */
201 #define MSG_PEEK MSG_PEEK
202 MSG_DONTROUTE = 0x04, /* Don't use local routing. */
203 #define MSG_DONTROUTE MSG_DONTROUTE
204 #ifdef __USE_GNU
205 /* DECnet uses a different name. */
206 MSG_TRYHARD = MSG_DONTROUTE,
207 # define MSG_TRYHARD MSG_DONTROUTE
208 #endif
209 MSG_CTRUNC = 0x08, /* Control data lost before delivery. */
210 #define MSG_CTRUNC MSG_CTRUNC
211 MSG_PROXY = 0x10, /* Supply or ask second address. */
212 #define MSG_PROXY MSG_PROXY
213 MSG_TRUNC = 0x20,
214 #define MSG_TRUNC MSG_TRUNC
215 MSG_DONTWAIT = 0x40, /* Nonblocking IO. */
216 #define MSG_DONTWAIT MSG_DONTWAIT
217 MSG_EOR = 0x80, /* End of record. */
218 #define MSG_EOR MSG_EOR
219 MSG_WAITALL = 0x100, /* Wait for a full request. */
220 #define MSG_WAITALL MSG_WAITALL
221 MSG_FIN = 0x200,
222 #define MSG_FIN MSG_FIN
223 MSG_SYN = 0x400,
224 #define MSG_SYN MSG_SYN
225 MSG_CONFIRM = 0x800, /* Confirm path validity. */
226 #define MSG_CONFIRM MSG_CONFIRM
227 MSG_RST = 0x1000,
228 #define MSG_RST MSG_RST
229 MSG_ERRQUEUE = 0x2000, /* Fetch message from error queue. */
230 #define MSG_ERRQUEUE MSG_ERRQUEUE
231 MSG_NOSIGNAL = 0x4000, /* Do not generate SIGPIPE. */
232 #define MSG_NOSIGNAL MSG_NOSIGNAL
233 MSG_MORE = 0x8000, /* Sender will send more. */
234 #define MSG_MORE MSG_MORE
236 MSG_CMSG_CLOEXEC = 0x40000000 /* Set close_on_exit for file
237 descriptor received through
238 SCM_RIGHTS. */
239 #define MSG_CMSG_CLOEXEC MSG_CMSG_CLOEXEC
243 /* Structure describing messages sent by
244 `sendmsg' and received by `recvmsg'. */
245 struct msghdr
247 void *msg_name; /* Address to send to/receive from. */
248 socklen_t msg_namelen; /* Length of address data. */
250 struct iovec *msg_iov; /* Vector of data to send/receive into. */
251 size_t msg_iovlen; /* Number of elements in the vector. */
253 void *msg_control; /* Ancillary data (eg BSD filedesc passing). */
254 size_t msg_controllen; /* Ancillary data buffer length. */
256 int msg_flags; /* Flags on received message. */
259 #ifdef __USE_GNU
260 /* For `recvmmsg'. */
261 struct mmsghdr
263 struct msghdr msg_hdr; /* Actual message header. */
264 unsigned int msg_len; /* Number of received bytes for the entry. */
266 #endif
268 /* Structure used for storage of ancillary data object information. */
269 struct cmsghdr
271 size_t cmsg_len; /* Length of data in cmsg_data plus length
272 of cmsghdr structure. */
273 int cmsg_level; /* Originating protocol. */
274 int cmsg_type; /* Protocol specific type. */
275 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
276 __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data. */
277 #endif
280 /* Ancillary data object manipulation macros. */
281 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
282 # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
283 #else
284 # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
285 #endif
286 #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
287 #define CMSG_FIRSTHDR(mhdr) \
288 ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr) \
289 ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) 0)
290 #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
291 & (size_t) ~(sizeof (size_t) - 1))
292 #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
293 + CMSG_ALIGN (sizeof (struct cmsghdr)))
294 #define CMSG_LEN(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
296 extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr,
297 struct cmsghdr *__cmsg) __THROW;
298 #ifdef __USE_EXTERN_INLINES
299 # ifndef _EXTERN_INLINE
300 # define _EXTERN_INLINE __extern_inline
301 # endif
302 _EXTERN_INLINE struct cmsghdr *
303 __NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg))
305 if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
306 /* The kernel header does this so there may be a reason. */
307 return 0;
309 __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg
310 + CMSG_ALIGN (__cmsg->cmsg_len));
311 if ((unsigned char *) (__cmsg + 1) > ((unsigned char *) __mhdr->msg_control
312 + __mhdr->msg_controllen)
313 || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len)
314 > ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)))
315 /* No more entries. */
316 return 0;
317 return __cmsg;
319 #endif /* Use `extern inline'. */
321 /* Socket level message types. This must match the definitions in
322 <linux/socket.h>. */
323 enum
325 SCM_RIGHTS = 0x01 /* Transfer file descriptors. */
326 #define SCM_RIGHTS SCM_RIGHTS
327 #ifdef __USE_GNU
328 , SCM_CREDENTIALS = 0x02 /* Credentials passing. */
329 # define SCM_CREDENTIALS SCM_CREDENTIALS
330 #endif
333 #ifdef __USE_GNU
334 /* User visible structure for SCM_CREDENTIALS message */
335 struct ucred
337 pid_t pid; /* PID of sending process. */
338 uid_t uid; /* UID of sending process. */
339 gid_t gid; /* GID of sending process. */
341 #endif
343 /* Ugly workaround for unclean kernel headers. */
344 #if !defined __USE_MISC && !defined __USE_GNU
345 # ifndef FIOGETOWN
346 # define __SYS_SOCKET_H_undef_FIOGETOWN
347 # endif
348 # ifndef FIOSETOWN
349 # define __SYS_SOCKET_H_undef_FIOSETOWN
350 # endif
351 # ifndef SIOCATMARK
352 # define __SYS_SOCKET_H_undef_SIOCATMARK
353 # endif
354 # ifndef SIOCGPGRP
355 # define __SYS_SOCKET_H_undef_SIOCGPGRP
356 # endif
357 # ifndef SIOCGSTAMP
358 # define __SYS_SOCKET_H_undef_SIOCGSTAMP
359 # endif
360 # ifndef SIOCGSTAMPNS
361 # define __SYS_SOCKET_H_undef_SIOCGSTAMPNS
362 # endif
363 # ifndef SIOCSPGRP
364 # define __SYS_SOCKET_H_undef_SIOCSPGRP
365 # endif
366 #endif
368 /* Get socket manipulation related informations from kernel headers. */
369 #include <asm/socket.h>
371 #if !defined __USE_MISC && !defined __USE_GNU
372 # ifdef __SYS_SOCKET_H_undef_FIOGETOWN
373 # undef __SYS_SOCKET_H_undef_FIOGETOWN
374 # undef FIOGETOWN
375 # endif
376 # ifdef __SYS_SOCKET_H_undef_FIOSETOWN
377 # undef __SYS_SOCKET_H_undef_FIOSETOWN
378 # undef FIOSETOWN
379 # endif
380 # ifdef __SYS_SOCKET_H_undef_SIOCATMARK
381 # undef __SYS_SOCKET_H_undef_SIOCATMARK
382 # undef SIOCATMARK
383 # endif
384 # ifdef __SYS_SOCKET_H_undef_SIOCGPGRP
385 # undef __SYS_SOCKET_H_undef_SIOCGPGRP
386 # undef SIOCGPGRP
387 # endif
388 # ifdef __SYS_SOCKET_H_undef_SIOCGSTAMP
389 # undef __SYS_SOCKET_H_undef_SIOCGSTAMP
390 # undef SIOCGSTAMP
391 # endif
392 # ifdef __SYS_SOCKET_H_undef_SIOCGSTAMPNS
393 # undef __SYS_SOCKET_H_undef_SIOCGSTAMPNS
394 # undef SIOCGSTAMPNS
395 # endif
396 # ifdef __SYS_SOCKET_H_undef_SIOCSPGRP
397 # undef __SYS_SOCKET_H_undef_SIOCSPGRP
398 # undef SIOCSPGRP
399 # endif
400 #endif
402 /* Structure used to manipulate the SO_LINGER option. */
403 struct linger
405 int l_onoff; /* Nonzero to linger on close. */
406 int l_linger; /* Time to linger. */
410 __BEGIN_DECLS
412 /* Receive a message as described by MESSAGE from socket FD.
413 Returns the number of bytes read or -1 for errors.
415 This function is a cancellation point and therefore not marked with
416 __THROW. */
417 extern int recvmmsg (int __fd, struct mmsghdr *__vmessages,
418 unsigned int __vlen, int __flags,
419 __const struct timespec *__tmo);
421 __END_DECLS
423 #endif /* bits/socket.h */