1 /* $OpenBSD: socket.h,v 1.53 2006/03/31 17:30:39 claudio Exp $ */
2 /* $NetBSD: socket.h,v 1.14 1996/02/09 18:25:36 christos Exp $ */
3
4 /*
5 * Copyright (c) 1982, 1985, 1986, 1988, 1993, 1994
6 * The Regents of the University of California. All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 * @(#)socket.h 8.4 (Berkeley) 2/21/94
33 */
34
35 #ifndef _SYS_SOCKET_H_
36 #define _SYS_SOCKET_H_
37
38 /*
39 * needed for ALIGNBYTES
40 */
41 #include <machine/param.h>
42
43 /*
44 * Definitions related to sockets: types, address families, options.
45 */
46
47 /*
48 * Types
49 */
50 #define SOCK_STREAM 1 /* stream socket */
51 #define SOCK_DGRAM 2 /* datagram socket */
52 #define SOCK_RAW 3 /* raw-protocol interface */
53 #define SOCK_RDM 4 /* reliably-delivered message */
54 #define SOCK_SEQPACKET 5 /* sequenced packet stream */
55
56 /*
57 * Option flags per-socket.
58 */
59 #define SO_DEBUG 0x0001 /* turn on debugging info recording */
60 #define SO_ACCEPTCONN 0x0002 /* socket has had listen() */
61 #define SO_REUSEADDR 0x0004 /* allow local address reuse */
62 #define SO_KEEPALIVE 0x0008 /* keep connections alive */
63 #define SO_DONTROUTE 0x0010 /* just use interface addresses */
64 #define SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */
65 #define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */
66 #define SO_LINGER 0x0080 /* linger on close if data present */
67 #define SO_OOBINLINE 0x0100 /* leave received OOB data in line */
68 #define SO_REUSEPORT 0x0200 /* allow local address & port reuse */
69 #define SO_JUMBO 0x0400 /* try to use jumbograms */
70
71 /*
72 * Additional options, not kept in so_options.
73 */
74 #define SO_SNDBUF 0x1001 /* send buffer size */
75 #define SO_RCVBUF 0x1002 /* receive buffer size */
76 #define SO_SNDLOWAT 0x1003 /* send low-water mark */
77 #define SO_RCVLOWAT 0x1004 /* receive low-water mark */
78 #define SO_SNDTIMEO 0x1005 /* send timeout */
79 #define SO_RCVTIMEO 0x1006 /* receive timeout */
80 #define SO_ERROR 0x1007 /* get error status and clear */
81 #define SO_TYPE 0x1008 /* get socket type */
82 #define SO_NETPROC 0x1020 /* multiplex; network processing */
83
84 /*
85 * Structure used for manipulating linger option.
86 */
87 struct linger {
88 int l_onoff; /* option on/off */
89 int l_linger; /* linger time */
90 };
91
92 /*
93 * Level number for (get/set)sockopt() to apply to socket itself.
94 */
95 #define SOL_SOCKET 0xffff /* options for socket level */
96
97 /*
98 * Address families.
99 */
100 #define AF_UNSPEC 0 /* unspecified */
101 #define AF_LOCAL 1 /* local to host (pipes, portals) */
102 #define AF_UNIX AF_LOCAL /* backward compatibility */
103 #define AF_INET 2 /* internetwork: UDP, TCP, etc. */
104 #define AF_IMPLINK 3 /* arpanet imp addresses */
105 #define AF_PUP 4 /* pup protocols: e.g. BSP */
106 #define AF_CHAOS 5 /* mit CHAOS protocols */
107 #define AF_NS 6 /* XEROX NS protocols */
108 #define AF_ISO 7 /* ISO protocols */
109 #define AF_OSI AF_ISO
110 #define AF_ECMA 8 /* european computer manufacturers */
111 #define AF_DATAKIT 9 /* datakit protocols */
112 #define AF_CCITT 10 /* CCITT protocols, X.25 etc */
113 #define AF_SNA 11 /* IBM SNA */
114 #define AF_DECnet 12 /* DECnet */
115 #define AF_DLI 13 /* DEC Direct data link interface */
116 #define AF_LAT 14 /* LAT */
117 #define AF_HYLINK 15 /* NSC Hyperchannel */
118 #define AF_APPLETALK 16 /* Apple Talk */
119 #define AF_ROUTE 17 /* Internal Routing Protocol */
120 #define AF_LINK 18 /* Link layer interface */
121 #define pseudo_AF_XTP 19 /* eXpress Transfer Protocol (no AF) */
122 #define AF_COIP 20 /* connection-oriented IP, aka ST II */
123 #define AF_CNT 21 /* Computer Network Technology */
124 #define pseudo_AF_RTIP 22 /* Help Identify RTIP packets */
125 #define AF_IPX 23 /* Novell Internet Protocol */
126 #define AF_INET6 24 /* IPv6 */
127 #define pseudo_AF_PIP 25 /* Help Identify PIP packets */
128 #define AF_ISDN 26 /* Integrated Services Digital Network*/
129 #define AF_E164 AF_ISDN /* CCITT E.164 recommendation */
130 #define AF_NATM 27 /* native ATM access */
131 #define AF_ENCAP 28
132 #define AF_SIP 29 /* Simple Internet Protocol */
133 #define AF_KEY 30
134 #define pseudo_AF_HDRCMPLT 31 /* Used by BPF to not rewrite headers
135 in interface output routine */
136 #define AF_BLUETOOTH 32 /* Bluetooth */
137
138 #define AF_MAX 33
139
140 /*
141 * Structure used by kernel to store most
142 * addresses.
143 */
144 struct sockaddr {
145 u_int8_t sa_len; /* total length */
146 sa_family_t sa_family; /* address family */
147 char sa_data[14]; /* actually longer; address value */
148 };
149
150 /*
151 * Sockaddr type which can hold any sockaddr type available
152 * in the system.
153 *
154 * Note: __ss_{len,family} is defined in RFC2553. During RFC2553 discussion
155 * the field name went back and forth between ss_len and __ss_len,
156 * and RFC2553 specifies it to be __ss_len. openbsd picked ss_len.
157 * For maximum portability, userland programmer would need to
158 * (1) make the code never touch ss_len portion (cast it into sockaddr and
159 * touch sa_len), or (2) add "-Dss_len=__ss_len" into CFLAGS to unify all
160 * occurences (including header file) to __ss_len.
161 */
162 struct sockaddr_storage {
163 u_int8_t ss_len; /* total length */
164 sa_family_t ss_family; /* address family */
165 unsigned char __ss_pad1[6]; /* align to quad */
166 u_int64_t __ss_pad2; /* force alignment for stupid compilers */
167 unsigned char __ss_pad3[240]; /* pad to a total of 256 bytes */
168 };
169
170 /*
171 * Structure used by kernel to pass protocol
172 * information in raw sockets.
173 */
174 struct sockproto {
175 unsigned short sp_family; /* address family */
176 unsigned short sp_protocol; /* protocol */
177 };
178
179 /*
180 * Protocol families, same as address families for now.
181 */
182 #define PF_UNSPEC AF_UNSPEC
183 #define PF_LOCAL AF_LOCAL
184 #define PF_UNIX PF_LOCAL /* backward compatibility */
185 #define PF_INET AF_INET
186 #define PF_IMPLINK AF_IMPLINK
187 #define PF_PUP AF_PUP
188 #define PF_CHAOS AF_CHAOS
189 #define PF_NS AF_NS
190 #define PF_ISO AF_ISO
191 #define PF_OSI AF_ISO
192 #define PF_ECMA AF_ECMA
193 #define PF_DATAKIT AF_DATAKIT
194 #define PF_CCITT AF_CCITT
195 #define PF_SNA AF_SNA
196 #define PF_DECnet AF_DECnet
197 #define PF_DLI AF_DLI
198 #define PF_LAT AF_LAT
199 #define PF_HYLINK AF_HYLINK
200 #define PF_APPLETALK AF_APPLETALK
201 #define PF_ROUTE AF_ROUTE
202 #define PF_LINK AF_LINK
203 #define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */
204 #define PF_COIP AF_COIP
205 #define PF_CNT AF_CNT
206 #define PF_IPX AF_IPX /* same format as AF_NS */
207 #define PF_INET6 AF_INET6
208 #define PF_RTIP pseudo_AF_RTIP /* same format as AF_INET */
209 #define PF_PIP pseudo_AF_PIP
210 #define PF_ISDN AF_ISDN
211 #define PF_NATM AF_NATM
212 #define PF_ENCAP AF_ENCAP
213 #define PF_SIP AF_SIP
214 #define PF_KEY AF_KEY
215 #define PF_BPF pseudo_AF_HDRCMPLT
216 #define PF_BLUETOOTH AF_BLUETOOTH
217 #define PF_MAX AF_MAX
218
219 /*
220 * These are the valid values for the "how" field used by shutdown(2).
221 */
222 #define SHUT_RD 0
223 #define SHUT_WR 1
224 #define SHUT_RDWR 2
225
226 /*
227 * Socket credentials.
228 */
229 struct sockcred {
230 uid_t sc_uid; /* real user id */
231 uid_t sc_euid; /* effective user id */
232 gid_t sc_gid; /* real group id */
233 gid_t sc_egid; /* effective group id */
234 int sc_ngroups; /* number of supplemental groups */
235 gid_t sc_groups[1]; /* variable length */
236 };
237
238 /*
239 * Compute size of a sockcred structure with groups.
240 */
241 #define SOCKCREDSIZE(ngrps) \
242 (sizeof(struct sockcred) + (sizeof(gid_t) * ((ngrps) - 1)))
243
244 /*
245 * Definitions for network related sysctl, CTL_NET.
246 *
247 * Second level is protocol family.
248 * Third level is protocol number.
249 *
250 * Further levels are defined by the individual families below.
251 */
252 #define NET_MAXID AF_MAX
253
254 #define CTL_NET_NAMES { \
255 { 0, 0 }, \
256 { "unix", CTLTYPE_NODE }, \
257 { "inet", CTLTYPE_NODE }, \
258 { "implink", CTLTYPE_NODE }, \
259 { "pup", CTLTYPE_NODE }, \
260 { "chaos", CTLTYPE_NODE }, \
261 { "xerox_ns", CTLTYPE_NODE }, \
262 { "iso", CTLTYPE_NODE }, \
263 { "emca", CTLTYPE_NODE }, \
264 { "datakit", CTLTYPE_NODE }, \
265 { "ccitt", CTLTYPE_NODE }, \
266 { "ibm_sna", CTLTYPE_NODE }, \
267 { "decnet", CTLTYPE_NODE }, \
268 { "dec_dli", CTLTYPE_NODE }, \
269 { "lat", CTLTYPE_NODE }, \
270 { "hylink", CTLTYPE_NODE }, \
271 { "appletalk", CTLTYPE_NODE }, \
272 { "route", CTLTYPE_NODE }, \
273 { "link_layer", CTLTYPE_NODE }, \
274 { "xtp", CTLTYPE_NODE }, \
275 { "coip", CTLTYPE_NODE }, \
276 { "cnt", CTLTYPE_NODE }, \
277 { "rtip", CTLTYPE_NODE }, \
278 { "ipx", CTLTYPE_NODE }, \
279 { "inet6", CTLTYPE_NODE }, \
280 { "pip", CTLTYPE_NODE }, \
281 { "isdn", CTLTYPE_NODE }, \
282 { "natm", CTLTYPE_NODE }, \
283 { "encap", CTLTYPE_NODE }, \
284 { "sip", CTLTYPE_NODE }, \
285 { "key", CTLTYPE_NODE }, \
286 { "bpf", CTLTYPE_NODE }, \
287 }
288
289 /*
290 * PF_ROUTE - Routing table
291 *
292 * Three additional levels are defined:
293 * Fourth: address family, 0 is wildcard
294 * Fifth: type of info, defined below
295 * Sixth: flag(s) to mask with for NET_RT_FLAGS
296 */
297 #define NET_RT_DUMP 1 /* dump; may limit to a.f. */
298 #define NET_RT_FLAGS 2 /* by flags, e.g. RESOLVING */
299 #define NET_RT_IFLIST 3 /* survey interface list */
300 #define NET_RT_STATS 4 /* routing table statistics */
301 #define NET_RT_MAXID 5
302
303 #define CTL_NET_RT_NAMES { \
304 { 0, 0 }, \
305 { "dump", CTLTYPE_STRUCT }, \
306 { "flags", CTLTYPE_STRUCT }, \
307 { "iflist", CTLTYPE_STRUCT }, \
308 { "stats", CTLTYPE_STRUCT }, \
309 }
310
311 /*
312 * PF_KEY - Key Management
313 */
314 #define NET_KEY_SADB_DUMP 1 /* return SADB */
315 #define NET_KEY_SPD_DUMP 2 /* return SPD */
316 #define NET_KEY_MAXID 3
317
318 #define CTL_NET_KEY_NAMES { \
319 { 0, 0 }, \
320 { "sadb_dump", CTLTYPE_STRUCT }, \
321 { "spd_dump", CTLTYPE_STRUCT }, \
322 }
323
324 /*
325 * PF_BPF not really a family, but connected under CTL_NET
326 */
327 #define NET_BPF_BUFSIZE 1 /* default buffer size */
328 #define NET_BPF_MAXBUFSIZE 2 /* maximum buffer size */
329 #define NET_BPF_MAXID 3
330
331 #define CTL_NET_BPF_NAMES { \
332 { 0, 0 }, \
333 { "bufsize", CTLTYPE_INT }, \
334 { "maxbufsize", CTLTYPE_INT }, \
335 }
336
337 /*
338 * Maximum queue length specifiable by listen(2).
339 */
340 #define SOMAXCONN 128
341
342 /*
343 * Message header for recvmsg and sendmsg calls.
344 * Used value-result for recvmsg, value only for sendmsg.
345 */
346 struct msghdr {
347 void *msg_name; /* optional address */
348 socklen_t msg_namelen; /* size of address */
349 struct iovec *msg_iov; /* scatter/gather array */
350 unsigned int msg_iovlen; /* # elements in msg_iov */
351 void *msg_control; /* ancillary data, see below */
352 socklen_t msg_controllen; /* ancillary data buffer len */
353 int msg_flags; /* flags on received message */
354 };
355
356 #define MSG_OOB 0x1 /* process out-of-band data */
357 #define MSG_PEEK 0x2 /* peek at incoming message */
358 #define MSG_DONTROUTE 0x4 /* send without using routing tables */
359 #define MSG_EOR 0x8 /* data completes record */
360 #define MSG_TRUNC 0x10 /* data discarded before delivery */
361 #define MSG_CTRUNC 0x20 /* control data lost before delivery */
362 #define MSG_WAITALL 0x40 /* wait for full request or error */
363 #define MSG_DONTWAIT 0x80 /* this message should be nonblocking */
364 #define MSG_BCAST 0x100 /* this message rec'd as broadcast */
365 #define MSG_MCAST 0x200 /* this message rec'd as multicast */
366
367 /*
368 * Header for ancillary data objects in msg_control buffer.
369 * Used for additional information with/about a datagram
370 * not expressible by flags. The format is a sequence
371 * of message elements headed by cmsghdr structures.
372 */
373 struct cmsghdr {
374 socklen_t cmsg_len; /* data byte count, including hdr */
375 int cmsg_level; /* originating protocol */
376 int cmsg_type; /* protocol-specific type */
377 /* followed by u_char cmsg_data[]; */
378 };
379
380 /* given pointer to struct cmsghdr, return pointer to data */
381 #define CMSG_DATA(cmsg) \
382 ((u_char *)(cmsg) + __CMSG_ALIGN(sizeof(struct cmsghdr)))
383
384 /* given pointer to struct cmsghdr, return pointer to next cmsghdr */
385 #define CMSG_NXTHDR(mhdr, cmsg) \
386 (((caddr_t)(cmsg) + __CMSG_ALIGN((cmsg)->cmsg_len) + \
387 __CMSG_ALIGN(sizeof(struct cmsghdr)) > \
388 ((caddr_t)(mhdr)->msg_control) + (mhdr)->msg_controllen) ? \
389 (struct cmsghdr *)NULL : \
390 (struct cmsghdr *)((caddr_t)(cmsg) + __CMSG_ALIGN((cmsg)->cmsg_len)))
391
392 /*
393 * RFC 2292 requires to check msg_controllen, in case that the kernel returns
394 * an empty list for some reasons.
395 */
396 #define CMSG_FIRSTHDR(mhdr) \
397 ((mhdr)->msg_controllen >= sizeof(struct cmsghdr) ? \
398 (struct cmsghdr *)(mhdr)->msg_control : \
399 (struct cmsghdr *)NULL)
400
401 /* Round len up to next alignment boundary */
402 #define __CMSG_ALIGN(len) ALIGN(len)
403 #ifdef _KERNEL
404 #define CMSG_ALIGN(n) __CMSG_ALIGN(n)
405 #endif
406
407 /* Length of the contents of a control message of length len */
408 #define CMSG_LEN(len) (__CMSG_ALIGN(sizeof(struct cmsghdr)) + (len))
409
410 /* Length of the space taken up by a padded control message of length len */
411 #define CMSG_SPACE(len) (__CMSG_ALIGN(sizeof(struct cmsghdr)) + __CMSG_ALIGN(len))
412
413 /* "Socket"-level control message types: */
414 #define SCM_RIGHTS 0x01 /* access rights (array of int) */
415 #define SCM_CREDS 0x02 /* credentials (struct sockcred) */
416
417 /*
418 * 4.3 compat sockaddr, move to compat file later
419 */
420 struct osockaddr {
421 unsigned short sa_family; /* address family */
422 char sa_data[14]; /* up to 14 bytes of direct address */
423 };
424
425 /*
426 * 4.3-compat message header (move to compat file later).
427 */
428 struct omsghdr {
429 caddr_t msg_name; /* optional address */
430 int msg_namelen; /* size of address */
431 struct iovec *msg_iov; /* scatter/gather array */
432 int msg_iovlen; /* # elements in msg_iov */
433 caddr_t msg_accrights; /* access rights sent/received */
434 int msg_accrightslen;
435 };
436
437 #define SA_LEN(x) ((x)->sa_len)
438
439 #ifndef _KERNEL
440
441 #include <sys/cdefs.h>
442
443 __BEGIN_DECLS
444 int accept(int, struct sockaddr *, socklen_t *);
445 int bind(int, const struct sockaddr *, socklen_t);
446 int connect(int, const struct sockaddr *, socklen_t);
447 int getpeereid(int, uid_t *, gid_t *);
448 int getpeername(int, struct sockaddr *, socklen_t *);
449 int getsockname(int, struct sockaddr *, socklen_t *);
450 int getsockopt(int, int, int, void *, socklen_t *);
451 int listen(int, int);
452 ssize_t recv(int, void *, size_t, int);
453 ssize_t recvfrom(int, void *, size_t, int, struct sockaddr *, socklen_t *);
454 ssize_t recvmsg(int, struct msghdr *, int);
455 ssize_t send(int, const void *, size_t, int);
456 ssize_t sendto(int, const void *,
457 size_t, int, const struct sockaddr *, socklen_t);
458 ssize_t sendmsg(int, const struct msghdr *, int);
459 int setsockopt(int, int, int, const void *, socklen_t);
460 int shutdown(int, int);
461 int socket(int, int, int);
462 int socketpair(int, int, int, int *);
463 __END_DECLS
464 #else
465 # if defined(COMPAT_43) || defined(COMPAT_SUNOS) || defined(COMPAT_LINUX) || \
466 defined(COMPAT_HPUX) || defined(COMPAT_FREEBSD) || defined(COMPAT_BSDOS) \
467 || defined(COMPAT_OSF1)
468 # define COMPAT_OLDSOCK
469 # define MSG_COMPAT 0x8000
470 # endif
471
472 void pfctlinput(int, struct sockaddr *);
473 #endif /* !_KERNEL */
474
475 #endif /* !_SYS_SOCKET_H_ */