FreeBSD/Linux Kernel Cross Reference
sys/sys/socket.h
1 /*
2 * Copyright (c) 1982, 1985, 1986, 1988, 1993, 1994
3 * The Regents of the University of California. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 * @(#)socket.h 8.4 (Berkeley) 2/21/94
34 * $FreeBSD: releng/5.2/sys/sys/socket.h 122685 2003-11-14 18:48:15Z bms $
35 */
36
37 #ifndef _SYS_SOCKET_H_
38 #define _SYS_SOCKET_H_
39
40 #include <sys/cdefs.h>
41 #include <sys/_types.h>
42 #include <sys/_iovec.h>
43 #define _NO_NAMESPACE_POLLUTION
44 #include <machine/param.h>
45 #undef _NO_NAMESPACE_POLLUTION
46
47 /*
48 * Definitions related to sockets: types, address families, options.
49 */
50
51 /*
52 * Data types.
53 */
54 #if __BSD_VISIBLE
55 #ifndef _GID_T_DECLARED
56 typedef __gid_t gid_t;
57 #define _GID_T_DECLARED
58 #endif
59
60 #ifndef _OFF_T_DECLARED
61 typedef __off_t off_t;
62 #define _OFF_T_DECLARED
63 #endif
64
65 #ifndef _PID_T_DECLARED
66 typedef __pid_t pid_t;
67 #define _PID_T_DECLARED
68 #endif
69 #endif
70
71 #ifndef _SA_FAMILY_T_DECLARED
72 typedef __sa_family_t sa_family_t;
73 #define _SA_FAMILY_T_DECLARED
74 #endif
75
76 #ifndef _SOCKLEN_T_DECLARED
77 typedef __socklen_t socklen_t;
78 #define _SOCKLEN_T_DECLARED
79 #endif
80
81 #ifndef _SSIZE_T_DECLARED
82 typedef __ssize_t ssize_t;
83 #define _SSIZE_T_DECLARED
84 #endif
85
86 #if __BSD_VISIBLE
87 #ifndef _UID_T_DECLARED
88 typedef __uid_t uid_t;
89 #define _UID_T_DECLARED
90 #endif
91 #endif
92
93 /*
94 * Types
95 */
96 #define SOCK_STREAM 1 /* stream socket */
97 #define SOCK_DGRAM 2 /* datagram socket */
98 #define SOCK_RAW 3 /* raw-protocol interface */
99 #if __BSD_VISIBLE
100 #define SOCK_RDM 4 /* reliably-delivered message */
101 #endif
102 #define SOCK_SEQPACKET 5 /* sequenced packet stream */
103
104 /*
105 * Option flags per-socket.
106 */
107 #define SO_DEBUG 0x0001 /* turn on debugging info recording */
108 #define SO_ACCEPTCONN 0x0002 /* socket has had listen() */
109 #define SO_REUSEADDR 0x0004 /* allow local address reuse */
110 #define SO_KEEPALIVE 0x0008 /* keep connections alive */
111 #define SO_DONTROUTE 0x0010 /* just use interface addresses */
112 #define SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */
113 #if __BSD_VISIBLE
114 #define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */
115 #endif
116 #define SO_LINGER 0x0080 /* linger on close if data present */
117 #define SO_OOBINLINE 0x0100 /* leave received OOB data in line */
118 #if __BSD_VISIBLE
119 #define SO_REUSEPORT 0x0200 /* allow local address & port reuse */
120 #define SO_TIMESTAMP 0x0400 /* timestamp received dgram traffic */
121 #define SO_NOSIGPIPE 0x0800 /* no SIGPIPE from EPIPE */
122 #define SO_ACCEPTFILTER 0x1000 /* there is an accept filter */
123 #endif
124
125 /*
126 * Additional options, not kept in so_options.
127 */
128 #define SO_SNDBUF 0x1001 /* send buffer size */
129 #define SO_RCVBUF 0x1002 /* receive buffer size */
130 #define SO_SNDLOWAT 0x1003 /* send low-water mark */
131 #define SO_RCVLOWAT 0x1004 /* receive low-water mark */
132 #define SO_SNDTIMEO 0x1005 /* send timeout */
133 #define SO_RCVTIMEO 0x1006 /* receive timeout */
134 #define SO_ERROR 0x1007 /* get error status and clear */
135 #define SO_TYPE 0x1008 /* get socket type */
136 #if __BSD_VISIBLE
137 #define SO_LABEL 0x1009 /* socket's MAC label */
138 #define SO_PEERLABEL 0x1010 /* socket's peer's MAC label */
139 #endif
140
141 /*
142 * Structure used for manipulating linger option.
143 */
144 struct linger {
145 int l_onoff; /* option on/off */
146 int l_linger; /* linger time */
147 };
148
149 #if __BSD_VISIBLE
150 struct accept_filter_arg {
151 char af_name[16];
152 char af_arg[256-16];
153 };
154 #endif
155
156 /*
157 * Level number for (get/set)sockopt() to apply to socket itself.
158 */
159 #define SOL_SOCKET 0xffff /* options for socket level */
160
161 /*
162 * Address families.
163 */
164 #define AF_UNSPEC 0 /* unspecified */
165 #if __BSD_VISIBLE
166 #define AF_LOCAL AF_UNIX /* local to host (pipes, portals) */
167 #endif
168 #define AF_UNIX 1 /* standardized name for AF_LOCAL */
169 #define AF_INET 2 /* internetwork: UDP, TCP, etc. */
170 #if __BSD_VISIBLE
171 #define AF_IMPLINK 3 /* arpanet imp addresses */
172 #define AF_PUP 4 /* pup protocols: e.g. BSP */
173 #define AF_CHAOS 5 /* mit CHAOS protocols */
174 #define AF_NETBIOS 6 /* SMB protocols */
175 #define AF_ISO 7 /* ISO protocols */
176 #define AF_OSI AF_ISO
177 #define AF_ECMA 8 /* European computer manufacturers */
178 #define AF_DATAKIT 9 /* datakit protocols */
179 #define AF_CCITT 10 /* CCITT protocols, X.25 etc */
180 #define AF_SNA 11 /* IBM SNA */
181 #define AF_DECnet 12 /* DECnet */
182 #define AF_DLI 13 /* DEC Direct data link interface */
183 #define AF_LAT 14 /* LAT */
184 #define AF_HYLINK 15 /* NSC Hyperchannel */
185 #define AF_APPLETALK 16 /* Apple Talk */
186 #define AF_ROUTE 17 /* Internal Routing Protocol */
187 #define AF_LINK 18 /* Link layer interface */
188 #define pseudo_AF_XTP 19 /* eXpress Transfer Protocol (no AF) */
189 #define AF_COIP 20 /* connection-oriented IP, aka ST II */
190 #define AF_CNT 21 /* Computer Network Technology */
191 #define pseudo_AF_RTIP 22 /* Help Identify RTIP packets */
192 #define AF_IPX 23 /* Novell Internet Protocol */
193 #define AF_SIP 24 /* Simple Internet Protocol */
194 #define pseudo_AF_PIP 25 /* Help Identify PIP packets */
195 #define AF_ISDN 26 /* Integrated Services Digital Network*/
196 #define AF_E164 AF_ISDN /* CCITT E.164 recommendation */
197 #define pseudo_AF_KEY 27 /* Internal key-management function */
198 #endif
199 #define AF_INET6 28 /* IPv6 */
200 #if __BSD_VISIBLE
201 #define AF_NATM 29 /* native ATM access */
202 #define AF_ATM 30 /* ATM */
203 #define pseudo_AF_HDRCMPLT 31 /* Used by BPF to not rewrite headers
204 * in interface output routine
205 */
206 #define AF_NETGRAPH 32 /* Netgraph sockets */
207 #define AF_SLOW 33 /* 802.3ad slow protocol */
208 #define AF_SCLUSTER 34 /* Sitara cluster protocol */
209 #define AF_MAX 35
210 #endif
211
212 /*
213 * Structure used by kernel to store most
214 * addresses.
215 */
216 struct sockaddr {
217 unsigned char sa_len; /* total length */
218 sa_family_t sa_family; /* address family */
219 char sa_data[14]; /* actually longer; address value */
220 };
221 #if __BSD_VISIBLE
222 #define SOCK_MAXADDRLEN 255 /* longest possible addresses */
223
224 /*
225 * Structure used by kernel to pass protocol
226 * information in raw sockets.
227 */
228 struct sockproto {
229 unsigned short sp_family; /* address family */
230 unsigned short sp_protocol; /* protocol */
231 };
232 #endif
233
234 /*
235 * RFC 2553: protocol-independent placeholder for socket addresses
236 */
237 #define _SS_MAXSIZE 128U
238 #define _SS_ALIGNSIZE (sizeof(__int64_t))
239 #define _SS_PAD1SIZE (_SS_ALIGNSIZE - sizeof(unsigned char) - \
240 sizeof(sa_family_t))
241 #define _SS_PAD2SIZE (_SS_MAXSIZE - sizeof(unsigned char) - \
242 sizeof(sa_family_t) - _SS_PAD1SIZE - _SS_ALIGNSIZE)
243
244 struct sockaddr_storage {
245 unsigned char ss_len; /* address length */
246 sa_family_t ss_family; /* address family */
247 char __ss_pad1[_SS_PAD1SIZE];
248 __int64_t __ss_align; /* force desired struct alignment */
249 char __ss_pad2[_SS_PAD2SIZE];
250 };
251
252 #if __BSD_VISIBLE
253 /*
254 * Protocol families, same as address families for now.
255 */
256 #define PF_UNSPEC AF_UNSPEC
257 #define PF_LOCAL AF_LOCAL
258 #define PF_UNIX PF_LOCAL /* backward compatibility */
259 #define PF_INET AF_INET
260 #define PF_IMPLINK AF_IMPLINK
261 #define PF_PUP AF_PUP
262 #define PF_CHAOS AF_CHAOS
263 #define PF_NETBIOS AF_NETBIOS
264 #define PF_ISO AF_ISO
265 #define PF_OSI AF_ISO
266 #define PF_ECMA AF_ECMA
267 #define PF_DATAKIT AF_DATAKIT
268 #define PF_CCITT AF_CCITT
269 #define PF_SNA AF_SNA
270 #define PF_DECnet AF_DECnet
271 #define PF_DLI AF_DLI
272 #define PF_LAT AF_LAT
273 #define PF_HYLINK AF_HYLINK
274 #define PF_APPLETALK AF_APPLETALK
275 #define PF_ROUTE AF_ROUTE
276 #define PF_LINK AF_LINK
277 #define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */
278 #define PF_COIP AF_COIP
279 #define PF_CNT AF_CNT
280 #define PF_SIP AF_SIP
281 #define PF_IPX AF_IPX
282 #define PF_RTIP pseudo_AF_RTIP /* same format as AF_INET */
283 #define PF_PIP pseudo_AF_PIP
284 #define PF_ISDN AF_ISDN
285 #define PF_KEY pseudo_AF_KEY
286 #define PF_INET6 AF_INET6
287 #define PF_NATM AF_NATM
288 #define PF_ATM AF_ATM
289 #define PF_NETGRAPH AF_NETGRAPH
290 #define PF_SLOW AF_SLOW
291 #define PF_SCLUSTER AF_SCLUSTER
292
293 #define PF_MAX AF_MAX
294
295 /*
296 * Definitions for network related sysctl, CTL_NET.
297 *
298 * Second level is protocol family.
299 * Third level is protocol number.
300 *
301 * Further levels are defined by the individual families below.
302 */
303 #define NET_MAXID AF_MAX
304
305 #define CTL_NET_NAMES { \
306 { 0, 0 }, \
307 { "unix", CTLTYPE_NODE }, \
308 { "inet", CTLTYPE_NODE }, \
309 { "implink", CTLTYPE_NODE }, \
310 { "pup", CTLTYPE_NODE }, \
311 { "chaos", CTLTYPE_NODE }, \
312 { "xerox_ns", CTLTYPE_NODE }, \
313 { "iso", CTLTYPE_NODE }, \
314 { "emca", CTLTYPE_NODE }, \
315 { "datakit", CTLTYPE_NODE }, \
316 { "ccitt", CTLTYPE_NODE }, \
317 { "ibm_sna", CTLTYPE_NODE }, \
318 { "decnet", CTLTYPE_NODE }, \
319 { "dec_dli", CTLTYPE_NODE }, \
320 { "lat", CTLTYPE_NODE }, \
321 { "hylink", CTLTYPE_NODE }, \
322 { "appletalk", CTLTYPE_NODE }, \
323 { "route", CTLTYPE_NODE }, \
324 { "link_layer", CTLTYPE_NODE }, \
325 { "xtp", CTLTYPE_NODE }, \
326 { "coip", CTLTYPE_NODE }, \
327 { "cnt", CTLTYPE_NODE }, \
328 { "rtip", CTLTYPE_NODE }, \
329 { "ipx", CTLTYPE_NODE }, \
330 { "sip", CTLTYPE_NODE }, \
331 { "pip", CTLTYPE_NODE }, \
332 { "isdn", CTLTYPE_NODE }, \
333 { "key", CTLTYPE_NODE }, \
334 { "inet6", CTLTYPE_NODE }, \
335 { "natm", CTLTYPE_NODE }, \
336 { "atm", CTLTYPE_NODE }, \
337 { "hdrcomplete", CTLTYPE_NODE }, \
338 { "netgraph", CTLTYPE_NODE }, \
339 { "snp", CTLTYPE_NODE }, \
340 { "scp", CTLTYPE_NODE }, \
341 }
342
343 /*
344 * PF_ROUTE - Routing table
345 *
346 * Three additional levels are defined:
347 * Fourth: address family, 0 is wildcard
348 * Fifth: type of info, defined below
349 * Sixth: flag(s) to mask with for NET_RT_FLAGS
350 */
351 #define NET_RT_DUMP 1 /* dump; may limit to a.f. */
352 #define NET_RT_FLAGS 2 /* by flags, e.g. RESOLVING */
353 #define NET_RT_IFLIST 3 /* survey interface list */
354 #define NET_RT_IFMALIST 4 /* return multicast address list */
355 #define NET_RT_MAXID 5
356
357 #define CTL_NET_RT_NAMES { \
358 { 0, 0 }, \
359 { "dump", CTLTYPE_STRUCT }, \
360 { "flags", CTLTYPE_STRUCT }, \
361 { "iflist", CTLTYPE_STRUCT }, \
362 { "ifmalist", CTLTYPE_STRUCT }, \
363 }
364 #endif /* __BSD_VISIBLE */
365
366 /*
367 * Maximum queue length specifiable by listen.
368 */
369 #define SOMAXCONN 128
370
371 /*
372 * Message header for recvmsg and sendmsg calls.
373 * Used value-result for recvmsg, value only for sendmsg.
374 */
375 struct msghdr {
376 void *msg_name; /* optional address */
377 socklen_t msg_namelen; /* size of address */
378 struct iovec *msg_iov; /* scatter/gather array */
379 int msg_iovlen; /* # elements in msg_iov */
380 void *msg_control; /* ancillary data, see below */
381 socklen_t msg_controllen; /* ancillary data buffer len */
382 int msg_flags; /* flags on received message */
383 };
384
385 #define MSG_OOB 0x1 /* process out-of-band data */
386 #define MSG_PEEK 0x2 /* peek at incoming message */
387 #define MSG_DONTROUTE 0x4 /* send without using routing tables */
388 #define MSG_EOR 0x8 /* data completes record */
389 #define MSG_TRUNC 0x10 /* data discarded before delivery */
390 #define MSG_CTRUNC 0x20 /* control data lost before delivery */
391 #define MSG_WAITALL 0x40 /* wait for full request or error */
392 #if __BSD_VISIBLE
393 #define MSG_DONTWAIT 0x80 /* this message should be nonblocking */
394 #define MSG_EOF 0x100 /* data completes connection */
395 #define MSG_COMPAT 0x8000 /* used in sendit() */
396 #endif
397
398 /*
399 * Header for ancillary data objects in msg_control buffer.
400 * Used for additional information with/about a datagram
401 * not expressible by flags. The format is a sequence
402 * of message elements headed by cmsghdr structures.
403 */
404 struct cmsghdr {
405 socklen_t cmsg_len; /* data byte count, including hdr */
406 int cmsg_level; /* originating protocol */
407 int cmsg_type; /* protocol-specific type */
408 /* followed by u_char cmsg_data[]; */
409 };
410
411 #if __BSD_VISIBLE
412 /*
413 * While we may have more groups than this, the cmsgcred struct must
414 * be able to fit in an mbuf, and NGROUPS_MAX is too large to allow
415 * this.
416 */
417 #define CMGROUP_MAX 16
418
419 /*
420 * Credentials structure, used to verify the identity of a peer
421 * process that has sent us a message. This is allocated by the
422 * peer process but filled in by the kernel. This prevents the
423 * peer from lying about its identity. (Note that cmcred_groups[0]
424 * is the effective GID.)
425 */
426 struct cmsgcred {
427 pid_t cmcred_pid; /* PID of sending process */
428 uid_t cmcred_uid; /* real UID of sending process */
429 uid_t cmcred_euid; /* effective UID of sending process */
430 gid_t cmcred_gid; /* real GID of sending process */
431 short cmcred_ngroups; /* number or groups */
432 gid_t cmcred_groups[CMGROUP_MAX]; /* groups */
433 };
434 #endif /* __BSD_VISIBLE */
435
436 /* given pointer to struct cmsghdr, return pointer to data */
437 #define CMSG_DATA(cmsg) ((unsigned char *)(cmsg) + \
438 _ALIGN(sizeof(struct cmsghdr)))
439
440 /* given pointer to struct cmsghdr, return pointer to next cmsghdr */
441 #define CMSG_NXTHDR(mhdr, cmsg) \
442 (((char *)(cmsg) + _ALIGN((cmsg)->cmsg_len) + \
443 _ALIGN(sizeof(struct cmsghdr)) > \
444 (char *)(mhdr)->msg_control + (mhdr)->msg_controllen) ? \
445 (struct cmsghdr *)NULL : \
446 (struct cmsghdr *)((char *)(cmsg) + _ALIGN((cmsg)->cmsg_len)))
447
448 #define CMSG_FIRSTHDR(mhdr) ((struct cmsghdr *)(mhdr)->msg_control)
449
450 #if __BSD_VISIBLE
451 /* RFC 2292 additions */
452 #define CMSG_SPACE(l) (_ALIGN(sizeof(struct cmsghdr)) + _ALIGN(l))
453 #define CMSG_LEN(l) (_ALIGN(sizeof(struct cmsghdr)) + (l))
454 #endif
455
456 #ifdef _KERNEL
457 #define CMSG_ALIGN(n) _ALIGN(n)
458 #endif
459
460 /* "Socket"-level control message types: */
461 #define SCM_RIGHTS 0x01 /* access rights (array of int) */
462 #if __BSD_VISIBLE
463 #define SCM_TIMESTAMP 0x02 /* timestamp (struct timeval) */
464 #define SCM_CREDS 0x03 /* process creds (struct cmsgcred) */
465 #endif
466
467 #if __BSD_VISIBLE
468 /*
469 * 4.3 compat sockaddr, move to compat file later
470 */
471 struct osockaddr {
472 unsigned short sa_family; /* address family */
473 char sa_data[14]; /* up to 14 bytes of direct address */
474 };
475
476 /*
477 * 4.3-compat message header (move to compat file later).
478 */
479 struct omsghdr {
480 char *msg_name; /* optional address */
481 int msg_namelen; /* size of address */
482 struct iovec *msg_iov; /* scatter/gather array */
483 int msg_iovlen; /* # elements in msg_iov */
484 char *msg_accrights; /* access rights sent/received */
485 int msg_accrightslen;
486 };
487 #endif
488
489 /*
490 * howto arguments for shutdown(2), specified by Posix.1g.
491 */
492 #define SHUT_RD 0 /* shut down the reading side */
493 #define SHUT_WR 1 /* shut down the writing side */
494 #define SHUT_RDWR 2 /* shut down both sides */
495
496 #if __BSD_VISIBLE
497 /*
498 * sendfile(2) header/trailer struct
499 */
500 struct sf_hdtr {
501 struct iovec *headers; /* pointer to an array of header struct iovec's */
502 int hdr_cnt; /* number of header iovec's */
503 struct iovec *trailers; /* pointer to an array of trailer struct iovec's */
504 int trl_cnt; /* number of trailer iovec's */
505 };
506 #endif
507
508 #ifndef _KERNEL
509
510 #include <sys/cdefs.h>
511
512 __BEGIN_DECLS
513 /*
514 * XXX functions missing restrict type-qualifiers.
515 */
516 int accept(int, struct sockaddr *, socklen_t *);
517 int bind(int, const struct sockaddr *, socklen_t);
518 int connect(int, const struct sockaddr *, socklen_t);
519 int getpeername(int, struct sockaddr *, socklen_t *);
520 int getsockname(int, struct sockaddr *, socklen_t *);
521 int getsockopt(int, int, int, void *, socklen_t *);
522 int listen(int, int);
523 ssize_t recv(int, void *, size_t, int);
524 ssize_t recvfrom(int, void *, size_t, int, struct sockaddr *, socklen_t *);
525 ssize_t recvmsg(int, struct msghdr *, int);
526 ssize_t send(int, const void *, size_t, int);
527 ssize_t sendto(int, const void *,
528 size_t, int, const struct sockaddr *, socklen_t);
529 ssize_t sendmsg(int, const struct msghdr *, int);
530 #if __BSD_VISIBLE
531 int sendfile(int, int, off_t, size_t, struct sf_hdtr *, off_t *, int);
532 #endif
533 int setsockopt(int, int, int, const void *, socklen_t);
534 int shutdown(int, int);
535 int sockatmark(int);
536 int socket(int, int, int);
537 int socketpair(int, int, int, int *);
538 __END_DECLS
539
540 #endif /* !_KERNEL */
541
542 #endif /* !_SYS_SOCKET_H_ */
Cache object: ecfef65eadd5712d11b7e9a4f1f1072c
|