(struct cmsghdr): Don't declare __cmsg_data field if its size would be bigger
[kopensolaris-gnu/glibc.git] / sysdeps / unix / sysv / aix / bits / socket.h
1 /* System-specific socket constants and types.  AIX version.
2    Copyright (C) 1991,92,1994-1999,2000,2001 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, write to the Free
17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18    02111-1307 USA.  */
19
20 #ifndef __BITS_SOCKET_H
21 #define __BITS_SOCKET_H
22
23 #if !defined _SYS_SOCKET_H && !defined _NETINET_IN_H
24 # error "Never include <bits/socket.h> directly; use <sys/socket.h> instead."
25 #endif
26
27 #define __need_size_t
28 #define __need_NULL
29 #include <stddef.h>
30
31 #include <limits.h>
32 #include <sys/types.h>
33
34 /* Type for length arguments in socket calls.  */
35 #ifndef __socklen_t_defined
36 typedef __socklen_t socklen_t;
37 # define __socklen_t_defined
38 #endif
39
40 /* Types of sockets.  */
41 enum __socket_type
42 {
43   SOCK_STREAM = 1,              /* Sequenced, reliable, connection-based
44                                    byte streams.  */
45 #define SOCK_STREAM SOCK_STREAM
46   SOCK_DGRAM = 2,               /* Connectionless, unreliable datagrams
47                                    of fixed maximum length.  */
48 #define SOCK_DGRAM SOCK_DGRAM
49   SOCK_RAW = 3,                 /* Raw protocol interface.  */
50 #define SOCK_RAW SOCK_RAW
51   SOCK_RDM = 4,                 /* Reliably-delivered messages.  */
52 #define SOCK_RDM SOCK_RDM
53   SOCK_SEQPACKET = 5,           /* Sequenced, reliable, connection-based,
54                                    datagrams of fixed maximum length.  */
55 #define SOCK_SEQPACKET SOCK_SEQPACKET
56   SOCK_CONN_DGRAM = 6           /* Conneciton datagram.  */
57 #define SOCK_CONN_DGRAM SOCK_CONN_DGRAM
58 };
59
60 /* Protocol families.  */
61 #define PF_UNSPEC       0       /* Unspecified.  */
62 #define PF_LOCAL        1       /* Local to host (pipes and file-domain).  */
63 #define PF_UNIX         PF_LOCAL /* Old BSD name for PF_LOCAL.  */
64 #define PF_FILE         PF_LOCAL /* Another non-standard name for PF_LOCAL.  */
65 #define PF_INET         2       /* IP protocol family.  */
66 #define PF_IMPLINK      3       /* ARPAnet IMP addresses.  */
67 #define PF_PUP          4       /* PUP protocols (e.g., BSP).  */
68 #define PF_CHAOS        5       /* MIT CHAOS protocols.  */
69 #define PF_NS           6       /* XEROX NS protocols.  */
70 #define PF_ISO          7       /* ISO protocols.  */
71 #define PF_OSI          PF_ISO
72 #define PF_ECMA         8       /* European Computer Manufacturers.  */
73 #define PF_DATAKIT      9       /* Datakit protocols.  */
74 #define PF_CCITT        10      /* CCITT protocols, X.25 etc. */
75 #define PF_SNA          11      /* IBM SNA.  */
76 #define PF_DECnet       12      /* DECnet.  */
77 #define PF_DLI          13      /* DEC Direct data link interface.  */
78 #define PF_LAT          14      /* LAT. */
79 #define PF_HYLINK       15      /* NSC Hyperchannel.  */
80 #define PF_APPLETALK    16      /* Apple Talk.  */
81 #define PF_NETLINK      17      /* Internet Routing Protocol.  */
82 #define PF_ROUTE        PF_NETLINK /* Alias to emulate 4.4BSD.  */
83 #define PF_LINK         18      /* Link layer interface.  */
84 #define PF_XTP          19      /* eXpress Transfer Protocol (no AF).  */
85 #define PF_INTF         20      /* Debugging use only.  */
86 #define PF_RIF          21      /* Raw interface.  */
87 #define PF_NETWARE      22
88 #define PF_NDD          23
89 #define PF_INET6        24      /* IPv6.  */
90 #define PF_MAX          30      /* For now..  */
91
92 /* Address families.  */
93 #define AF_UNSPEC       PF_UNSPEC
94 #define AF_LOCAL        PF_LOCAL
95 #define AF_UNIX         PF_UNIX
96 #define AF_FILE         PF_FILE
97 #define AF_INET         PF_INET
98 #define AF_IMPLINK      PF_IMPLINK
99 #define AF_PUP          PF_PUP
100 #define AF_CHAOS        PF_CHAOS
101 #define AF_NS           PF_NS
102 #define AF_ISO          PF_ISO
103 #define AF_OSI          PF_OSI
104 #define AF_ECMA         PF_ECMA
105 #define AF_DATAKIT      PF_DATAKIT
106 #define AF_CCITT        PF_CCITT
107 #define AF_SNA          PF_SNA
108 #define AF_DECnet       PF_DECnet
109 #define AF_DLI          PF_DLI
110 #define AF_LAT          PF_LAT
111 #define AF_HYLINK       PF_HYLINK
112 #define AF_APPLETALK    PF_APPLETALK
113 #define AF_NETLINK      PF_NETLINK
114 #define AF_ROUTE        PF_ROUTE
115 #define AF_LINK         PF_LINK
116 #define AF_INTF         PF_INTF
117 #define AF_RIF          PF_RIF
118 #define AF_NETWARE      PF_NETWARE
119 #define AF_NDD          PF_NDD
120 #define AF_INET6        PF_INET6
121 #define AF_MAX          PF_MAX
122
123 /* Socket level values.  Others are defined in the appropriate headers.
124
125    XXX These definitions also should go into the appropriate headers as
126    far as they are available.  */
127 #define SOL_SOCKET      0xffff
128
129 /* Maximum queue length specifiable by listen.  */
130 #define SOMAXCONN       1024
131
132 /* Get the definition of the macro to define the common sockaddr members.  */
133 #include <bits/sockaddr.h>
134
135 /* Structure describing a generic socket address.  */
136 struct sockaddr
137   {
138     __SOCKADDR_COMMON (sa_);    /* Common data: address family and length.  */
139     char sa_data[14];           /* Address data.  */
140   };
141
142
143 /* Structure large enough to hold any socket address (with the historical
144    exception of AF_UNIX).  We reserve 128 bytes.  */
145 #if ULONG_MAX > 0xffffffff
146 # define __ss_aligntype __uint64_t
147 #else
148 # define __ss_aligntype __uint32_t
149 #endif
150 #define _SS_SIZE        128
151 #define _SS_PADSIZE     (_SS_SIZE - (2 * sizeof (__ss_aligntype)))
152
153 struct sockaddr_storage
154   {
155     __SOCKADDR_COMMON (ss_);    /* Address family, etc.  */
156     __ss_aligntype __ss_align;  /* Force desired alignment.  */
157     char __ss_padding[_SS_PADSIZE];
158   };
159
160
161 /* Bits in the FLAGS argument to `send', `recv', et al.  */
162 enum
163   {
164     MSG_OOB             = 0x01, /* Process out-of-band data.  */
165 #define MSG_OOB         MSG_OOB
166     MSG_PEEK            = 0x02, /* Peek at incoming messages.  */
167 #define MSG_PEEK        MSG_PEEK
168     MSG_DONTROUTE       = 0x04, /* Don't use local routing.  */
169 #define MSG_DONTROUTE   MSG_DONTROUTE
170     MSG_EOR             = 0x08, /* End of record.  */
171 #define MSG_EOR         MSG_EOR
172     MSG_TRUNC           = 0x10,
173 #define MSG_TRUNC       MSG_TRUNC
174     MSG_CTRUNC          = 0x20, /* Control data lost before delivery.  */
175 #define MSG_CTRUNC      MSG_CTRUNC
176     MSG_WAITALL         = 0x40, /* Wait for a full request.  */
177 #define MSG_WAITALL     MSG_WAITALL
178     MSG_MPEG2           = 0x80, /* Message contain MPEG2 data.  */
179 #define MSG_MPEG2       MSG_MPEG2
180   };
181
182
183 /* Structure describing messages sent by
184    `sendmsg' and received by `recvmsg'.  */
185 struct msghdr
186   {
187     void *msg_name;             /* Address to send to/receive from.  */
188     socklen_t msg_namelen;      /* Length of address data.  */
189
190     struct iovec *msg_iov;      /* Vector of data to send/receive into.  */
191     int msg_iovlen;             /* Number of elements in the vector.  */
192
193     void *msg_control;          /* Ancillary data (eg BSD filedesc passing). */
194     socklen_t msg_controllen;   /* Ancillary data buffer length.  */
195
196     int msg_flags;              /* Flags on received message.  */
197   };
198
199 /* Structure used for storage of ancillary data object information.  */
200 struct cmsghdr
201   {
202     socklen_t cmsg_len;         /* Length of data in cmsg_data plus length
203                                    of cmsghdr structure.  */
204     int cmsg_level;             /* Originating protocol.  */
205     int cmsg_type;              /* Protocol specific type.  */
206 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
207     __extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data.  */
208 #endif
209   };
210
211 /* Ancillary data object manipulation macros.  */
212 #if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
213 # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
214 #else
215 # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
216 #endif
217 #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
218 #define CMSG_FIRSTHDR(mhdr) \
219   ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr)                 \
220    ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) NULL)
221 #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
222                          & ~(sizeof (size_t) - 1))
223 #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
224                          + CMSG_ALIGN (sizeof (struct cmsghdr)))
225 #define CMSG_LEN(len)   (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
226
227 extern struct cmsghdr *__cmsg_nxthdr (struct msghdr *__mhdr,
228                                       struct cmsghdr *__cmsg) __THROW;
229 #ifdef __USE_EXTERN_INLINES
230 # ifndef _EXTERN_INLINE
231 #  define _EXTERN_INLINE extern __inline
232 # endif
233 _EXTERN_INLINE struct cmsghdr *
234 __cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg) __THROW
235 {
236   if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
237     /* The kernel header does this so there may be a reason.  */
238     return 0;
239
240   __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg
241                                + CMSG_ALIGN (__cmsg->cmsg_len));
242   if ((unsigned char *) (__cmsg + 1) >= ((unsigned char *) __mhdr->msg_control
243                                          + __mhdr->msg_controllen)
244       || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len)
245           > ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)))
246     /* No more entries.  */
247     return 0;
248   return __cmsg;
249 }
250 #endif  /* Use `extern inline'.  */
251
252 /* Socket level message types.  This must match the definitions in
253    <linux/socket.h>.  */
254 enum
255   {
256     SCM_RIGHTS = 0x01           /* Transfer file descriptors.  */
257 #define SCM_RIGHTS SCM_RIGHTS
258   };
259
260 /* Options flags per socket.  */
261 #define SO_DEBUG        0x0001  /* Turn on debugging info recording.  */
262 #define SO_ACCEPTCONN   0x0002  /* Socket has had listen().  */
263 #define SO_REUSEADDR    0x0004  /* Allow local address reuse.  */
264 #define SO_KEEPALIVE    0x0008  /* Keep connections alive.  */
265 #define SO_DONTROUTE    0x0010  /* Just use interface addresses.  */
266 #define SO_BROADCAST    0x0020  /* Permit sending of broadcast msgs.  */
267 #define SO_USELOOPBACK  0x0040  /* Bypass hardware when possible.  */
268 #define SO_LINGER       0x0080  /* Linger on close if data present.  */
269 #define SO_OOBINLINE    0x0100  /* Leave received OOB data in line.  */
270 #define SO_REUSEPORT    0x0200  /* Allow local address & port reuse.  */
271 #define SO_USE_IFBUFS   0x0400  /* Interface will supply buffers.  */
272 #define SO_CKSUMRECV    0x0800  /* Defer checksum until receive.  */
273 #define SO_NOREUSEADDR  0x1000  /* Prevent local address reuse.  */
274 #define SO_SNDBUF       0x1001  /* Send buffer size.  */
275 #define SO_RCVBUF       0x1002  /* Receive buffer size.  */
276 #define SO_SNDLOWAT     0x1003  /* Send low-water mark.  */
277 #define SO_RCVLOWAT     0x1004  /* Receive low-water mark.  */
278 #define SO_SNDTIMEO     0x1005  /* Send timeout.  */
279 #define SO_RCVTIMEO     0x1006  /* Receive timeout.  */
280 #define SO_ERROR        0x1007  /* Get error status and clear.  */
281 #define SO_TYPE         0x1008  /* Get socket type.  */
282 #define SO_KERNACCEPT   0x2000  /* Derive a in-kernel only socket.  */
283 #define SO_AUDIT        0x8000  /* Turn on socket auditing.  */
284
285
286 /* Structure used to manipulate the SO_LINGER option.  */
287 struct linger
288   {
289     int l_onoff;                /* Nonzero to linger on close.  */
290     int l_linger;               /* Time to linger.  */
291   };
292
293 #endif  /* bits/socket.h */