1 /* System-specific socket constants and types. Linux version.
2 Copyright (C) 1991,92,94,95,96,97,98,99 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 Library General Public License as
7 published by the Free Software Foundation; either version 2 of the
8 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 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public
16 License along with the GNU C Library; see the file COPYING.LIB. If not,
17 write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 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 typedef unsigned int socklen_t;
36
37 /* Types of sockets. */
38 enum __socket_type
39 {
40 SOCK_STREAM = 1, /* Sequenced, reliable, connection-based
41 byte streams. */
42 #define SOCK_STREAM SOCK_STREAM
43 SOCK_DGRAM = 2, /* Connectionless, unreliable datagrams
44 of fixed maximum length. */
45 #define SOCK_DGRAM SOCK_DGRAM
46 SOCK_RAW = 3, /* Raw protocol interface. */
47 #define SOCK_RAW SOCK_RAW
48 SOCK_RDM = 4, /* Reliably-delivered messages. */
49 #define SOCK_RDM SOCK_RDM
50 SOCK_SEQPACKET = 5, /* Sequenced, reliable, connection-based,
51 datagrams of fixed maximum length. */
52 #define SOCK_SEQPACKET SOCK_SEQPACKET
53 SOCK_PACKET = 10 /* Linux specific way of getting packets
54 at the dev level. For writing rarp and
55 other similar things on the user level. */
56 #define SOCK_PACKET SOCK_PACKET
57 };
58
59 /* Protocol families. */
60 #define PF_UNSPEC 0 /* Unspecified. */
61 #define PF_LOCAL 1 /* Local to host (pipes and file-domain). */
62 #define PF_UNIX PF_LOCAL /* Old BSD name for PF_LOCAL. */
63 #define PF_FILE PF_LOCAL /* Another non-standard name for PF_LOCAL. */
64 #define PF_INET 2 /* IP protocol family. */
65 #define PF_AX25 3 /* Amateur Radio AX.25. */
66 #define PF_IPX 4 /* Novell Internet Protocol. */
67 #define PF_APPLETALK 5 /* Appletalk DDP. */
68 #define PF_NETROM 6 /* Amateur radio NetROM. */
69 #define PF_BRIDGE 7 /* Multiprotocol bridge. */
70 #define PF_ATMPVC 8 /* ATM PVCs. */
71 #define PF_X25 9 /* Reserved for X.25 project. */
72 #define PF_INET6 10 /* IP version 6. */
73 #define PF_ROSE 11 /* Amateur Radio X.25 PLP. */
74 #define PF_DECnet 12 /* Reserved for DECnet project. */
75 #define PF_NETBEUI 13 /* Reserved for 802.2LLC project. */
76 #define PF_SECURITY 14 /* Security callback pseudo AF. */
77 #define PF_KEY 15 /* PF_KEY key management API. */
78 #define PF_NETLINK 16
79 #define PF_ROUTE PF_NETLINK /* Alias to emulate 4.4BSD. */
80 #define PF_PACKET 17 /* Packet family. */
81 #define PF_ASH 18 /* Ash. */
82 #define PF_ECONET 19 /* Acorn Econet. */
83 #define PF_ATMSVC 20 /* ATM SVCs. */
84 #define PF_SNA 22 /* Linux SNA Project */
85 #define PF_IRDA 23 /* IRDA sockets. */
86 #define PF_MAX 32 /* For now.. */
87
88 /* Address families. */
89 #define AF_UNSPEC PF_UNSPEC
90 #define AF_LOCAL PF_LOCAL
91 #define AF_UNIX PF_UNIX
92 #define AF_FILE PF_FILE
93 #define AF_INET PF_INET
94 #define AF_AX25 PF_AX25
95 #define AF_IPX PF_IPX
96 #define AF_APPLETALK PF_APPLETALK
97 #define AF_NETROM PF_NETROM
98 #define AF_BRIDGE PF_BRIDGE
99 #define AF_ATMPVC PF_ATMPVC
100 #define AF_X25 PF_X25
101 #define AF_INET6 PF_INET6
102 #define AF_ROSE PF_ROSE
103 #define AF_DECnet PF_DECnet
104 #define AF_NETBEUI PF_NETBEUI
105 #define AF_SECURITY PF_SECURITY
106 #define AF_KEY PF_KEY
107 #define AF_NETLINK PF_NETLINK
108 #define AF_ROUTE PF_ROUTE
109 #define AF_PACKET PF_PACKET
110 #define AF_ASH PF_ASH
111 #define AF_ECONET PF_ECONET
112 #define AF_ATMSVC PF_ATMSVC
113 #define AF_SNA PF_SNA
114 #define AF_IRDA PF_IRDA
115 #define AF_MAX PF_MAX
116
117 /* Socket level values. Others are defined in the appropriate headers.
118
119 XXX These definitions also should go into the appropriate headers as
120 far as they are available. */
121 #define SOL_RAW 255
122 #define SOL_DECNET 261
123 #define SOL_X25 262
124 #define SOL_PACKET 263
125 #define SOL_ATM 264 /* ATM layer (cell level). */
126 #define SOL_AAL 265 /* ATM Adaption Layer (packet level). */
127 #define SOL_IRDA 266
128
129 /* Maximum queue length specifiable by listen. */
130 #define SOMAXCONN 128
131
132 /* Get the definition of the macro to define the common sockaddr members. */
133
134 #include <bits/sockaddr.h>
135
136 /* Structure describing a generic socket address. */
137 struct sockaddr
138 {
139 __SOCKADDR_COMMON (sa_); /* Common data: address family and length. */
140 char sa_data[14]; /* Address data. */
141 };
142
143
144 /* Structure large enough to hold any socket address (with the historical
145 exception of AF_UNIX). We reserve 128 bytes. */
146 #if ULONG_MAX > 0xffffffff
147 # define __ss_aligntype __uint64_t
148 #else
149 # define __ss_aligntype __uint32_t
150 #endif
151 #define _SS_SIZE 128
152 #define _SS_PADSIZE (_SS_SIZE - (2 * sizeof (__ss_aligntype)))
153
154 struct sockaddr_storage
155 {
156 __SOCKADDR_COMMON (__ss_); /* Address family, etc. */
157 __ss_aligntype __ss_align; /* Force desired alignment. */
158 char __ss_padding[_SS_PADSIZE];
159 };
160
161
162 /* Bits in the FLAGS argument to `send', `recv', et al. */
163 enum
164 {
165 MSG_OOB = 0x01, /* Process out-of-band data. */
166 #define MSG_OOB MSG_OOB
167 MSG_PEEK = 0x02, /* Peek at incoming messages. */
168 #define MSG_PEEK MSG_PEEK
169 MSG_DONTROUTE = 0x04, /* Don't use local routing. */
170 #define MSG_DONTROUTE MSG_DONTROUTE
171 #ifdef __USE_GNU
172 /* DECnet uses a different name. */
173 MSG_TRYHARD = MSG_DONTROUTE,
174 # define MSG_TRYHARD MSG_DONTROUTE
175 #endif
176 MSG_CTRUNC = 0x08, /* Control data lost before delivery. */
177 #define MSG_CTRUNC MSG_CTRUNC
178 MSG_PROXY = 0x10, /* Supply or ask second address. */
179 #define MSG_PROXY MSG_PROXY
180 MSG_TRUNC = 0x20,
181 #define MSG_TRUNC MSG_TRUNC
182 MSG_DONTWAIT = 0x40, /* Nonblocking IO. */
183 #define MSG_DONTWAIT MSG_DONTWAIT
184 MSG_EOR = 0x80, /* End of record. */
185 #define MSG_EOR MSG_EOR
186 MSG_WAITALL = 0x100, /* Wait for a full request. */
187 #define MSG_WAITALL MSG_WAITALL
188 MSG_FIN = 0x200,
189 #define MSG_FIN MSG_FIN
190 MSG_SYN = 0x400,
191 #define MSG_SYN MSG_SYN
192 MSG_URG = 0x800,
193 #define MSG_URG MSG_URG
194 MSG_RST = 0x1000,
195 #define MSG_RST MSG_RST
196 MSG_ERRQUEUE = 0x2000, /* Fetch message from error queue. */
197 #define MSG_ERRQUEUE MSG_ERRQUEUE
198 MSG_NOSIGNAL = 0x4000 /* Do not generate SIGPIPE. */
199 #define MSG_NOSIGNAL MSG_NOSIGNAL
200 };
201
202
203 /* Structure describing messages sent by
204 `sendmsg' and received by `recvmsg'. */
205 struct msghdr
206 {
207 __ptr_t msg_name; /* Address to send to/receive from. */
208 socklen_t msg_namelen; /* Length of address data. */
209
210 struct iovec *msg_iov; /* Vector of data to send/receive into. */
211 size_t msg_iovlen; /* Number of elements in the vector. */
212
213 __ptr_t msg_control; /* Ancillary data (eg BSD filedesc passing). */
214 size_t msg_controllen; /* Ancillary data buffer length. */
215
216 int msg_flags; /* Flags on received message. */
217 };
218
219 /* Structure used for storage of ancillary data object information. */
220 struct cmsghdr
221 {
222 size_t cmsg_len; /* Length of data in cmsg_data plus length
223 of cmsghdr structure. */
224 int cmsg_level; /* Originating protocol. */
225 int cmsg_type; /* Protocol specific type. */
226 #if !defined __STRICT_ANSI__ && defined __GNUC__ && __GNUC__ >= 2
227 unsigned char __cmsg_data[0]; /* Ancillary data. */
228 /* XXX Perhaps this should be removed. */
229 #endif
230 };
231
232 /* Ancillary data object manipulation macros. */
233 #if !defined __STRICT_ANSI__ && defined __GNUC__ && __GNUC__ >= 2
234 # define CMSG_DATA(cmsg) ((cmsg)->__cmsg_data)
235 #else
236 # define CMSG_DATA(cmsg) ((unsigned char *) ((struct cmsghdr *) (cmsg) + 1))
237 #endif
238 #define CMSG_NXTHDR(mhdr, cmsg) __cmsg_nxthdr (mhdr, cmsg)
239 #define CMSG_FIRSTHDR(mhdr) \
240 ((size_t) (mhdr)->msg_controllen >= sizeof (struct cmsghdr) \
241 ? (struct cmsghdr *) (mhdr)->msg_control : (struct cmsghdr *) NULL)
242 #define CMSG_ALIGN(len) (((len) + sizeof (size_t) - 1) \
243 & ~(sizeof (size_t) - 1))
244 #define CMSG_SPACE(len) (CMSG_ALIGN (len) \
245 + CMSG_ALIGN (sizeof (struct cmsghdr)))
246 #define CMSG_LEN(len) (CMSG_ALIGN (sizeof (struct cmsghdr)) + (len))
247
248 extern struct cmsghdr *__cmsg_nxthdr __P ((struct msghdr *__mhdr,
249 struct cmsghdr *__cmsg));
250 #ifdef __USE_EXTERN_INLINES
251 # ifndef _EXTERN_INLINE
252 # define _EXTERN_INLINE extern __inline
253 # endif
254 _EXTERN_INLINE struct cmsghdr *
__cmsg_nxthdr(struct msghdr * __mhdr,struct cmsghdr * __cmsg)255 __cmsg_nxthdr (struct msghdr *__mhdr, struct cmsghdr *__cmsg) __THROW
256 {
257 if ((size_t) __cmsg->cmsg_len < sizeof (struct cmsghdr))
258 /* The kernel header does this so there may be a reason. */
259 return 0;
260
261 __cmsg = (struct cmsghdr *) ((unsigned char *) __cmsg
262 + CMSG_ALIGN (__cmsg->cmsg_len));
263 if ((unsigned char *) (__cmsg + 1) >= ((unsigned char *) __mhdr->msg_control
264 + __mhdr->msg_controllen)
265 || ((unsigned char *) __cmsg + CMSG_ALIGN (__cmsg->cmsg_len)
266 >= ((unsigned char *) __mhdr->msg_control + __mhdr->msg_controllen)))
267 /* No more entries. */
268 return 0;
269 return __cmsg;
270 }
271 #endif /* Use `extern inline'. */
272
273 /* Socket level message types. This must match the definitions in
274 <linux/socket.h>. */
275 enum
276 {
277 SCM_RIGHTS = 0x01, /* Transfer file descriptors. */
278 #define SCM_RIGHTS SCM_RIGHTS
279 #ifdef __USE_BSD
280 SCM_CREDENTIALS = 0x02, /* Credentials passing. */
281 # define SCM_CREDENTIALS SCM_CREDENTIALS
282 #endif
283 __SCM_CONNECT = 0x03 /* Data array is `struct scm_connect'. */
284 };
285
286 /* User visible structure for SCM_CREDENTIALS message */
287
288 struct ucred
289 {
290 pid_t pid; /* PID of sending process. */
291 uid_t uid; /* UID of sending process. */
292 gid_t gid; /* GID of sending process. */
293 };
294
295 /* Get socket manipulation related informations from kernel headers. */
296 #include <asm/socket.h>
297
298
299 /* Structure used to manipulate the SO_LINGER option. */
300 struct linger
301 {
302 int l_onoff; /* Nonzero to linger on close. */
303 int l_linger; /* Time to linger. */
304 };
305
306 #endif /* bits/socket.h */
307
308
309
310