1
/* System-specific socket constants and types. 4.4 BSD version.
2
Copyright (C) 1991-2013 Free Software Foundation, Inc.
3
This file is part of the GNU C Library.
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 License as
7
published by the Free Software Foundation; either version 2.1 of the
8
License, or (at your option) any later version.
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.
15
You should have received a copy of the GNU Lesser General Public
16
License along with the GNU C Library; see the file COPYING.LIB. If
17
not, see <http://www.gnu.org/licenses/>. */
19
#ifndef __BITS_SOCKET_H
20
#define __BITS_SOCKET_H 1
23
# error "Never include <bits/socket.h> directly; use <sys/socket.h> instead."
30
#include <limits.h> /* XXX Is this allowed? */
31
#include <bits/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
40
/* Types of sockets. */
43
SOCK_STREAM = 1, /* Sequenced, reliable, connection-based
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
58
/* Protocol families. */
59
#define PF_UNSPEC 0 /* Unspecified. */
60
#define PF_LOCAL 1 /* Local to host (pipes and file-domain). */
61
#define PF_UNIX PF_LOCAL /* Old BSD name for PF_LOCAL. */
62
#define PF_FILE PF_LOCAL /* POSIX name for PF_LOCAL. */
63
#define PF_INET 2 /* IP protocol family. */
64
#define PF_IMPLINK 3 /* ARPAnet IMP protocol. */
65
#define PF_PUP 4 /* PUP protocols. */
66
#define PF_CHAOS 5 /* MIT Chaos protocols. */
67
#define PF_NS 6 /* Xerox NS protocols. */
68
#define PF_ISO 7 /* ISO protocols. */
70
#define PF_ECMA 8 /* ECMA protocols. */
71
#define PF_DATAKIT 9 /* AT&T Datakit protocols. */
72
#define PF_CCITT 10 /* CCITT protocols (X.25 et al). */
73
#define PF_SNA 11 /* IBM SNA protocol. */
74
#define PF_DECnet 12 /* DECnet protocols. */
75
#define PF_DLI 13 /* Direct data link interface. */
76
#define PF_LAT 14 /* DEC Local Area Transport protocol. */
77
#define PF_HYLINK 15 /* NSC Hyperchannel protocol. */
78
#define PF_APPLETALK 16 /* Don't use this. */
79
#define PF_ROUTE 17 /* Internal Routing Protocol. */
80
#define PF_LINK 18 /* Link layer interface. */
81
#define PF_XTP 19 /* eXpress Transfer Protocol (no AF). */
82
#define PF_COIP 20 /* Connection-oriented IP, aka ST II. */
83
#define PF_CNT 21 /* Computer Network Technology. */
84
#define PF_RTIP 22 /* Help Identify RTIP packets. **/
85
#define PF_IPX 23 /* Novell Internet Protocol. */
86
#define PF_SIP 24 /* Simple Internet Protocol. */
87
#define PF_PIP 25 /* Help Identify PIP packets. */
88
#define PF_INET6 26 /* IP version 6. */
91
/* Address families. */
92
#define AF_UNSPEC PF_UNSPEC
93
#define AF_LOCAL PF_LOCAL
94
#define AF_UNIX PF_UNIX
95
#define AF_FILE PF_FILE
96
#define AF_INET PF_INET
97
#define AF_IMPLINK PF_IMPLINK
99
#define AF_CHAOS PF_CHAOS
101
#define AF_ISO PF_ISO
102
#define AF_OSI PF_OSI
103
#define AF_ECMA PF_ECMA
104
#define AF_DATAKIT PF_DATAKIT
105
#define AF_CCITT PF_CCITT
106
#define AF_SNA PF_SNA
107
#define AF_DECnet PF_DECnet
108
#define AF_DLI PF_DLI
109
#define AF_LAT PF_LAT
110
#define AF_HYLINK PF_HYLINK
111
#define AF_APPLETALK PF_APPLETALK
112
#define AF_ROUTE PF_ROUTE
113
#define AF_LINK PF_LINK
114
#define pseudo_AF_XTP PF_XTP
115
#define AF_COIP PF_COIP
116
#define AF_CNT PF_CNT
117
#define pseudo_AF_RTIP PF_RTIP
118
#define AF_IPX PF_IPX
119
#define AF_SIP PF_SIP
120
#define pseudo_AF_PIP PF_PIP
121
#define AF_INET6 PF_INET6
122
#define AF_MAX PF_MAX
124
/* Maximum queue length specifiable by listen. */
125
#define SOMAXCONN 128 /* 5 on the origional 4.4 BSD. */
127
/* Get the definition of the macro to define the common sockaddr members. */
128
#include <bits/sockaddr.h>
130
/* Structure describing a generic socket address. */
133
__SOCKADDR_COMMON (sa_); /* Common data: address family and length. */
134
char sa_data[14]; /* Address data. */
138
/* Structure large enough to hold any socket address (with the historical
139
exception of AF_UNIX). We reserve 128 bytes. */
140
#if ULONG_MAX > 0xffffffff
141
# define __ss_aligntype __uint64_t
143
# define __ss_aligntype __uint32_t
146
#define _SS_PADSIZE (_SS_SIZE - (2 * sizeof (__ss_aligntype)))
148
struct sockaddr_storage
150
__SOCKADDR_COMMON (ss_); /* Address family, etc. */
151
__ss_aligntype __ss_align; /* Force desired alignment. */
152
char __ss_padding[_SS_PADSIZE];
156
/* Bits in the FLAGS argument to `send', `recv', et al. */
159
MSG_OOB = 0x01, /* Process out-of-band data. */
160
#define MSG_OOB MSG_OOB
161
MSG_PEEK = 0x02, /* Peek at incoming messages. */
162
#define MSG_PEEK MSG_PEEK
163
MSG_DONTROUTE = 0x04, /* Don't use local routing. */
164
#define MSG_DONTROUTE MSG_DONTROUTE
165
MSG_EOR = 0x08, /* Data completes record. */
166
#define MSG_EOR MSG_EOR
167
MSG_TRUNC = 0x10, /* Data discarded before delivery. */
168
#define MSG_TRUNC MSG_TRUNC
169
MSG_CTRUNC = 0x20, /* Control data lost before delivery. */
170
#define MSG_CTRUNC MSG_CTRUNC
171
MSG_WAITALL = 0x40, /* Wait for full request or error. */
172
#define MSG_WAITALL MSG_WAITALL
173
MSG_DONTWAIT = 0x80, /* This message should be nonblocking. */
174
#define MSG_DONTWAIT MSG_DONTWAIT
175
MSG_NOSIGNAL = 0x0400 /* Do not generate SIGPIPE on EPIPE. */
176
#define MSG_NOSIGNAL MSG_NOSIGNAL
180
/* Structure describing messages sent by
181
`sendmsg' and received by `recvmsg'. */
184
void *msg_name; /* Address to send to/receive from. */
185
socklen_t msg_namelen; /* Length of address data. */
187
struct iovec *msg_iov; /* Vector of data to send/receive into. */
188
int msg_iovlen; /* Number of elements in the vector. */
190
void *msg_control; /* Ancillary data (eg BSD filedesc passing). */
191
socklen_t msg_controllen; /* Ancillary data buffer length. */
193
int msg_flags; /* Flags in received message. */
196
/* Structure used for storage of ancillary data object information. */
199
socklen_t cmsg_len; /* Length of data in cmsg_data plus length
200
of cmsghdr structure. */
201
int cmsg_level; /* Originating protocol. */
202
int cmsg_type; /* Protocol specific type. */
203
#if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
204
__extension__ unsigned char __cmsg_data __flexarr; /* Ancillary data. */
208
/* Ancillary data object manipulation macros. */
209
#if (!defined __STRICT_ANSI__ && __GNUC__ >= 2) || __STDC_VERSION__ >= 199901L
210
# define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
212
# define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
215
#define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
217
#define CMSG_FIRSTHDR(mhdr) \
218
((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr) \
219
? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) NULL)
221
#define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
222
& (size_t) ~(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))
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
233
_EXTERN_INLINE struct cmsghdr *
234
__NTH (__cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg))
236
if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
237
/* The kernel header does this so there may be a reason. */
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. */
250
#endif /* Use `extern inline'. */
252
/* Socket level message types. */
255
SCM_RIGHTS = 0x01, /* Access rights (array of int). */
256
#define SCM_RIGHTS SCM_RIGHTS
257
SCM_TIMESTAMP = 0x02, /* Timestamp (struct timeval). */
258
#define SCM_TIMESTAMP SCM_TIMESTAMP
259
SCM_CREDS = 0x03 /* Process creds (struct cmsgcred). */
260
#define SCM_CREDS SCM_CREDS
263
/* Unfortunately, BSD practice dictates this structure be of fixed size.
264
If there are more than CMGROUP_MAX groups, the list is truncated.
265
(On GNU systems, the `cmcred_euid' field is just the first in the
266
list of effective UIDs.) */
267
#define CMGROUP_MAX 16
269
/* Structure delivered by SCM_CREDS. This describes the identity of the
270
sender of the data simultaneously received on the socket. By BSD
271
convention, this is included only when a sender on a AF_LOCAL socket
272
sends cmsg data of this type and size; the sender's structure is
273
ignored, and the system fills in the various IDs of the sender process. */
281
__gid_t cmcred_groups[CMGROUP_MAX];
284
/* Protocol number used to manipulate socket-level options
285
with `getsockopt' and `setsockopt'. */
286
#define SOL_SOCKET 0xffff
288
/* Socket-level options for `getsockopt' and `setsockopt'. */
291
SO_DEBUG = 0x0001, /* Record debugging information. */
292
#define SO_DEBUG SO_DEBUG
293
SO_ACCEPTCONN = 0x0002, /* Accept connections on socket. */
294
#define SO_ACCEPTCONN SO_ACCEPTCONN
295
SO_REUSEADDR = 0x0004, /* Allow reuse of local addresses. */
296
#define SO_REUSEADDR SO_REUSEADDR
297
SO_KEEPALIVE = 0x0008, /* Keep connections alive and send
298
SIGPIPE when they die. */
299
#define SO_KEEPALIVE SO_KEEPALIVE
300
SO_DONTROUTE = 0x0010, /* Don't do local routing. */
301
#define SO_DONTROUTE SO_DONTROUTE
302
SO_BROADCAST = 0x0020, /* Allow transmission of
303
broadcast messages. */
304
#define SO_BROADCAST SO_BROADCAST
305
SO_USELOOPBACK = 0x0040, /* Use the software loopback to avoid
306
hardware use when possible. */
307
#define SO_USELOOPBACK SO_USELOOPBACK
308
SO_LINGER = 0x0080, /* Block on close of a reliable
309
socket to transmit pending data. */
310
#define SO_LINGER SO_LINGER
311
SO_OOBINLINE = 0x0100, /* Receive out-of-band data in-band. */
312
#define SO_OOBINLINE SO_OOBINLINE
313
SO_REUSEPORT = 0x0200, /* Allow local address and port reuse. */
314
#define SO_REUSEPORT SO_REUSEPORT
315
SO_SNDBUF = 0x1001, /* Send buffer size. */
316
#define SO_SNDBUF SO_SNDBUF
317
SO_RCVBUF = 0x1002, /* Receive buffer. */
318
#define SO_RCVBUF SO_RCVBUF
319
SO_SNDLOWAT = 0x1003, /* Send low-water mark. */
320
#define SO_SNDLOWAT SO_SNDLOWAT
321
SO_RCVLOWAT = 0x1004, /* Receive low-water mark. */
322
#define SO_RCVLOWAT SO_RCVLOWAT
323
SO_SNDTIMEO = 0x1005, /* Send timeout. */
324
#define SO_SNDTIMEO SO_SNDTIMEO
325
SO_RCVTIMEO = 0x1006, /* Receive timeout. */
326
#define SO_RCVTIMEO SO_RCVTIMEO
327
SO_ERROR = 0x1007, /* Get and clear error status. */
328
#define SO_ERROR SO_ERROR
329
SO_STYLE = 0x1008, /* Get socket connection style. */
330
#define SO_STYLE SO_STYLE
331
SO_TYPE = SO_STYLE /* Compatible name for SO_STYLE. */
332
#define SO_TYPE SO_TYPE
335
/* Structure used to manipulate the SO_LINGER option. */
338
int l_onoff; /* Nonzero to linger on close. */
339
int l_linger; /* Time to linger. */
342
#endif /* bits/socket.h */
added
removed
libc/sysdeps/unix/bsd/bsd4.4/bits/socket.h
