Annotation of src/sys/sys/socket.h, Revision 1.78.4.1
1.78.4.1! kardel 1: /* $NetBSD: socket.h,v 1.78 2006/01/28 13:20:18 kleink Exp $ */
1.44 itojun 2:
3: /*
4: * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
5: * All rights reserved.
1.71 perry 6: *
1.44 itojun 7: * Redistribution and use in source and binary forms, with or without
8: * modification, are permitted provided that the following conditions
9: * are met:
10: * 1. Redistributions of source code must retain the above copyright
11: * notice, this list of conditions and the following disclaimer.
12: * 2. Redistributions in binary form must reproduce the above copyright
13: * notice, this list of conditions and the following disclaimer in the
14: * documentation and/or other materials provided with the distribution.
15: * 3. Neither the name of the project nor the names of its contributors
16: * may be used to endorse or promote products derived from this software
17: * without specific prior written permission.
1.71 perry 18: *
1.44 itojun 19: * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
20: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22: * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
23: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29: * SUCH DAMAGE.
30: */
1.10 cgd 31:
1.1 cgd 32: /*
1.8 mycroft 33: * Copyright (c) 1982, 1985, 1986, 1988, 1993, 1994
34: * The Regents of the University of California. All rights reserved.
1.1 cgd 35: *
36: * Redistribution and use in source and binary forms, with or without
37: * modification, are permitted provided that the following conditions
38: * are met:
39: * 1. Redistributions of source code must retain the above copyright
40: * notice, this list of conditions and the following disclaimer.
41: * 2. Redistributions in binary form must reproduce the above copyright
42: * notice, this list of conditions and the following disclaimer in the
43: * documentation and/or other materials provided with the distribution.
1.68 agc 44: * 3. Neither the name of the University nor the names of its contributors
1.1 cgd 45: * may be used to endorse or promote products derived from this software
46: * without specific prior written permission.
47: *
48: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
49: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
52: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58: * SUCH DAMAGE.
59: *
1.28 fvdl 60: * @(#)socket.h 8.6 (Berkeley) 5/3/95
1.1 cgd 61: */
62:
1.2 mycroft 63: #ifndef _SYS_SOCKET_H_
1.8 mycroft 64: #define _SYS_SOCKET_H_
1.2 mycroft 65:
1.67 bjh21 66: #include <sys/featuretest.h>
67:
1.1 cgd 68: /*
69: * Definitions related to sockets: types, address families, options.
70: */
71:
72: /*
1.42 kleink 73: * Data types.
74: */
1.55 itojun 75: #include <sys/ansi.h>
1.56 kleink 76:
77: #ifndef sa_family_t
78: typedef __sa_family_t sa_family_t;
1.58 kleink 79: #define sa_family_t __sa_family_t
1.56 kleink 80: #endif
81:
1.55 itojun 82: #ifndef socklen_t
83: typedef __socklen_t socklen_t;
1.58 kleink 84: #define socklen_t __socklen_t
1.55 itojun 85: #endif
1.42 kleink 86:
1.63 kleink 87: #include <machine/ansi.h>
88:
89: #ifdef _BSD_SIZE_T_
90: typedef _BSD_SIZE_T_ size_t;
91: #undef _BSD_SIZE_T_
92: #endif
93:
94: #ifdef _BSD_SSIZE_T_
95: typedef _BSD_SSIZE_T_ ssize_t;
96: #undef _BSD_SSIZE_T_
97: #endif
98:
99: #include <sys/uio.h>
100:
1.42 kleink 101: /*
102: * Socket types.
1.1 cgd 103: */
104: #define SOCK_STREAM 1 /* stream socket */
105: #define SOCK_DGRAM 2 /* datagram socket */
106: #define SOCK_RAW 3 /* raw-protocol interface */
107: #define SOCK_RDM 4 /* reliably-delivered message */
108: #define SOCK_SEQPACKET 5 /* sequenced packet stream */
109:
110: /*
111: * Option flags per-socket.
112: */
113: #define SO_DEBUG 0x0001 /* turn on debugging info recording */
114: #define SO_ACCEPTCONN 0x0002 /* socket has had listen() */
115: #define SO_REUSEADDR 0x0004 /* allow local address reuse */
116: #define SO_KEEPALIVE 0x0008 /* keep connections alive */
117: #define SO_DONTROUTE 0x0010 /* just use interface addresses */
118: #define SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */
119: #define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */
120: #define SO_LINGER 0x0080 /* linger on close if data present */
121: #define SO_OOBINLINE 0x0100 /* leave received OOB data in line */
1.8 mycroft 122: #define SO_REUSEPORT 0x0200 /* allow local address & port reuse */
1.18 thorpej 123: #define SO_TIMESTAMP 0x0400 /* timestamp received dgram traffic */
1.1 cgd 124:
1.78.4.1! kardel 125:
1.1 cgd 126: /*
127: * Additional options, not kept in so_options.
128: */
129: #define SO_SNDBUF 0x1001 /* send buffer size */
130: #define SO_RCVBUF 0x1002 /* receive buffer size */
131: #define SO_SNDLOWAT 0x1003 /* send low-water mark */
132: #define SO_RCVLOWAT 0x1004 /* receive low-water mark */
133: #define SO_SNDTIMEO 0x1005 /* send timeout */
134: #define SO_RCVTIMEO 0x1006 /* receive timeout */
135: #define SO_ERROR 0x1007 /* get error status and clear */
136: #define SO_TYPE 0x1008 /* get socket type */
1.69 darrenr 137: #define SO_OVERFLOWED 0x1009 /* datagrams: return packets dropped */
1.1 cgd 138:
139: /*
140: * Structure used for manipulating linger option.
141: */
142: struct linger {
143: int l_onoff; /* option on/off */
1.28 fvdl 144: int l_linger; /* linger time in seconds */
1.1 cgd 145: };
146:
147: /*
148: * Level number for (get/set)sockopt() to apply to socket itself.
149: */
150: #define SOL_SOCKET 0xffff /* options for socket level */
151:
152: /*
153: * Address families.
154: */
155: #define AF_UNSPEC 0 /* unspecified */
1.8 mycroft 156: #define AF_LOCAL 1 /* local to host (pipes, portals) */
157: #define AF_UNIX AF_LOCAL /* backward compatibility */
1.1 cgd 158: #define AF_INET 2 /* internetwork: UDP, TCP, etc. */
159: #define AF_IMPLINK 3 /* arpanet imp addresses */
160: #define AF_PUP 4 /* pup protocols: e.g. BSP */
161: #define AF_CHAOS 5 /* mit CHAOS protocols */
162: #define AF_NS 6 /* XEROX NS protocols */
163: #define AF_ISO 7 /* ISO protocols */
164: #define AF_OSI AF_ISO
165: #define AF_ECMA 8 /* european computer manufacturers */
166: #define AF_DATAKIT 9 /* datakit protocols */
167: #define AF_CCITT 10 /* CCITT protocols, X.25 etc */
168: #define AF_SNA 11 /* IBM SNA */
169: #define AF_DECnet 12 /* DECnet */
170: #define AF_DLI 13 /* DEC Direct data link interface */
171: #define AF_LAT 14 /* LAT */
172: #define AF_HYLINK 15 /* NSC Hyperchannel */
173: #define AF_APPLETALK 16 /* Apple Talk */
174: #define AF_ROUTE 17 /* Internal Routing Protocol */
175: #define AF_LINK 18 /* Link layer interface */
1.67 bjh21 176: #if defined(_NETBSD_SOURCE)
1.1 cgd 177: #define pseudo_AF_XTP 19 /* eXpress Transfer Protocol (no AF) */
1.42 kleink 178: #endif
1.8 mycroft 179: #define AF_COIP 20 /* connection-oriented IP, aka ST II */
180: #define AF_CNT 21 /* Computer Network Technology */
1.67 bjh21 181: #if defined(_NETBSD_SOURCE)
1.8 mycroft 182: #define pseudo_AF_RTIP 22 /* Help Identify RTIP packets */
1.42 kleink 183: #endif
1.8 mycroft 184: #define AF_IPX 23 /* Novell Internet Protocol */
1.21 sommerfe 185: #define AF_INET6 24 /* IP version 6 */
1.67 bjh21 186: #if defined(_NETBSD_SOURCE)
1.8 mycroft 187: #define pseudo_AF_PIP 25 /* Help Identify PIP packets */
1.42 kleink 188: #endif
1.17 chuck 189: #define AF_ISDN 26 /* Integrated Services Digital Network*/
190: #define AF_E164 AF_ISDN /* CCITT E.164 recommendation */
191: #define AF_NATM 27 /* native ATM access */
1.19 is 192: #define AF_ARP 28 /* (rev.) addr. res. prot. (RFC 826) */
1.67 bjh21 193: #if defined(_NETBSD_SOURCE)
1.21 sommerfe 194: #define pseudo_AF_KEY 29 /* Internal key management protocol */
1.31 thorpej 195: #define pseudo_AF_HDRCMPLT 30 /* Used by BPF to not rewrite hdrs
196: in interface output routine */
1.42 kleink 197: #endif
1.1 cgd 198:
1.31 thorpej 199: #define AF_MAX 31
1.1 cgd 200:
201: /*
1.26 thorpej 202: * Structure used by kernel to store most
203: * addresses.
1.1 cgd 204: */
205: struct sockaddr {
1.63 kleink 206: __uint8_t sa_len; /* total length */
1.56 kleink 207: sa_family_t sa_family; /* address family */
208: char sa_data[14]; /* actually longer; address value */
1.26 thorpej 209: };
1.1 cgd 210:
1.42 kleink 211: #if defined(_KERNEL)
1.1 cgd 212: /*
213: * Structure used by kernel to pass protocol
214: * information in raw sockets.
215: */
216: struct sockproto {
217: u_short sp_family; /* address family */
218: u_short sp_protocol; /* protocol */
219: };
1.42 kleink 220: #endif /* _KERNEL */
1.1 cgd 221:
1.44 itojun 222: #if 1
223: /*
224: * RFC 2553: protocol-independent placeholder for socket addresses
225: */
226: #define _SS_MAXSIZE 128
1.63 kleink 227: #define _SS_ALIGNSIZE (sizeof(__int64_t))
1.60 kleink 228: #define _SS_PAD1SIZE (_SS_ALIGNSIZE - 2)
229: #define _SS_PAD2SIZE (_SS_MAXSIZE - 2 - \
1.44 itojun 230: _SS_PAD1SIZE - _SS_ALIGNSIZE)
231:
1.67 bjh21 232: #if (_XOPEN_SOURCE - 0) >= 500 || defined(_NETBSD_SOURCE)
1.44 itojun 233: struct sockaddr_storage {
1.63 kleink 234: __uint8_t ss_len; /* address length */
1.56 kleink 235: sa_family_t ss_family; /* address family */
236: char __ss_pad1[_SS_PAD1SIZE];
1.63 kleink 237: __int64_t __ss_align;/* force desired structure storage alignment */
1.56 kleink 238: char __ss_pad2[_SS_PAD2SIZE];
1.44 itojun 239: };
1.67 bjh21 240: #endif /* _XOPEN_SOURCE >= 500 || _NETBSD_SOURCE */
1.46 kleink 241: #endif /* 1 */
1.44 itojun 242:
1.1 cgd 243: /*
244: * Protocol families, same as address families for now.
245: */
246: #define PF_UNSPEC AF_UNSPEC
1.8 mycroft 247: #define PF_LOCAL AF_LOCAL
248: #define PF_UNIX PF_LOCAL /* backward compatibility */
1.1 cgd 249: #define PF_INET AF_INET
250: #define PF_IMPLINK AF_IMPLINK
251: #define PF_PUP AF_PUP
252: #define PF_CHAOS AF_CHAOS
253: #define PF_NS AF_NS
254: #define PF_ISO AF_ISO
255: #define PF_OSI AF_ISO
256: #define PF_ECMA AF_ECMA
257: #define PF_DATAKIT AF_DATAKIT
258: #define PF_CCITT AF_CCITT
259: #define PF_SNA AF_SNA
260: #define PF_DECnet AF_DECnet
261: #define PF_DLI AF_DLI
262: #define PF_LAT AF_LAT
263: #define PF_HYLINK AF_HYLINK
264: #define PF_APPLETALK AF_APPLETALK
265: #define PF_ROUTE AF_ROUTE
266: #define PF_LINK AF_LINK
1.67 bjh21 267: #if defined(_NETBSD_SOURCE)
1.1 cgd 268: #define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */
1.42 kleink 269: #endif
1.8 mycroft 270: #define PF_COIP AF_COIP
271: #define PF_CNT AF_CNT
1.21 sommerfe 272: #define PF_INET6 AF_INET6
1.8 mycroft 273: #define PF_IPX AF_IPX /* same format as AF_NS */
1.67 bjh21 274: #if defined(_NETBSD_SOURCE)
1.72 kleink 275: #define PF_RTIP pseudo_AF_RTIP /* same format as AF_INET */
1.8 mycroft 276: #define PF_PIP pseudo_AF_PIP
1.42 kleink 277: #endif
1.20 is 278: #define PF_ISDN AF_ISDN /* same as E164 */
279: #define PF_E164 AF_E164
1.17 chuck 280: #define PF_NATM AF_NATM
1.19 is 281: #define PF_ARP AF_ARP
1.67 bjh21 282: #if defined(_NETBSD_SOURCE)
1.21 sommerfe 283: #define PF_KEY pseudo_AF_KEY /* like PF_ROUTE, only for key mgmt */
1.42 kleink 284: #endif
1.1 cgd 285:
286: #define PF_MAX AF_MAX
287:
1.67 bjh21 288: #if defined(_NETBSD_SOURCE)
1.63 kleink 289:
290: #ifndef gid_t
291: typedef __gid_t gid_t; /* group id */
292: #define gid_t __gid_t
293: #endif
294:
295: #ifndef uid_t
296: typedef __uid_t uid_t; /* user id */
297: #define uid_t __uid_t
298: #endif
299:
1.1 cgd 300: /*
1.27 thorpej 301: * Socket credentials.
302: */
303: struct sockcred {
304: uid_t sc_uid; /* real user id */
305: uid_t sc_euid; /* effective user id */
306: gid_t sc_gid; /* real group id */
307: gid_t sc_egid; /* effective group id */
308: int sc_ngroups; /* number of supplemental groups */
309: gid_t sc_groups[1]; /* variable length */
310: };
311:
312: /*
313: * Compute size of a sockcred structure with groups.
314: */
315: #define SOCKCREDSIZE(ngrps) \
316: (sizeof(struct sockcred) + (sizeof(gid_t) * ((ngrps) - 1)))
1.67 bjh21 317: #endif /* _NETBSD_SOURCE */
1.27 thorpej 318:
1.38 kleink 319:
1.67 bjh21 320: #if defined(_NETBSD_SOURCE)
1.27 thorpej 321: /*
1.8 mycroft 322: * Definitions for network related sysctl, CTL_NET.
323: *
324: * Second level is protocol family.
325: * Third level is protocol number.
326: *
327: * Further levels are defined by the individual families below.
328: */
329: #define NET_MAXID AF_MAX
330:
331: #define CTL_NET_NAMES { \
332: { 0, 0 }, \
1.28 fvdl 333: { "local", CTLTYPE_NODE }, \
1.8 mycroft 334: { "inet", CTLTYPE_NODE }, \
335: { "implink", CTLTYPE_NODE }, \
336: { "pup", CTLTYPE_NODE }, \
337: { "chaos", CTLTYPE_NODE }, \
338: { "xerox_ns", CTLTYPE_NODE }, \
339: { "iso", CTLTYPE_NODE }, \
340: { "emca", CTLTYPE_NODE }, \
341: { "datakit", CTLTYPE_NODE }, \
342: { "ccitt", CTLTYPE_NODE }, \
343: { "ibm_sna", CTLTYPE_NODE }, \
344: { "decnet", CTLTYPE_NODE }, \
345: { "dec_dli", CTLTYPE_NODE }, \
346: { "lat", CTLTYPE_NODE }, \
347: { "hylink", CTLTYPE_NODE }, \
348: { "appletalk", CTLTYPE_NODE }, \
349: { "route", CTLTYPE_NODE }, \
350: { "link_layer", CTLTYPE_NODE }, \
351: { "xtp", CTLTYPE_NODE }, \
352: { "coip", CTLTYPE_NODE }, \
353: { "cnt", CTLTYPE_NODE }, \
354: { "rtip", CTLTYPE_NODE }, \
355: { "ipx", CTLTYPE_NODE }, \
1.21 sommerfe 356: { "inet6", CTLTYPE_NODE }, \
1.8 mycroft 357: { "pip", CTLTYPE_NODE }, \
1.20 is 358: { "isdn", CTLTYPE_NODE }, \
1.17 chuck 359: { "natm", CTLTYPE_NODE }, \
1.20 is 360: { "arp", CTLTYPE_NODE }, \
1.21 sommerfe 361: { "key", CTLTYPE_NODE }, \
1.8 mycroft 362: }
1.73 atatat 363:
364: struct kinfo_pcb {
1.75 tron 365: __uint64_t ki_pcbaddr; /* PTR: pcb addr */
366: __uint64_t ki_ppcbaddr; /* PTR: ppcb addr */
367: __uint64_t ki_sockaddr; /* PTR: socket addr */
368:
369: __uint32_t ki_family; /* INT: protocol family */
370: __uint32_t ki_type; /* INT: socket type */
371: __uint32_t ki_protocol; /* INT: protocol */
372: __uint32_t ki_pflags; /* INT: generic protocol flags */
373:
374: __uint32_t ki_sostate; /* INT: socket state */
375: __uint32_t ki_prstate; /* INT: protocol state */
376: __int32_t ki_tstate; /* INT: tcp state */
377: __uint32_t ki_tflags; /* INT: tcp flags */
1.73 atatat 378:
1.75 tron 379: __uint64_t ki_rcvq; /* U_LONG: receive queue len */
380: __uint64_t ki_sndq; /* U_LONG: send queue len */
1.73 atatat 381:
382: union {
383: struct sockaddr _kis_src; /* STRUCT: local address */
384: char _kis_pad[256 + 8]; /* pad to max addr length */
385: } ki_s;
386: union {
387: struct sockaddr _kid_dst; /* STRUCT: remote address */
388: char _kid_pad[256 + 8]; /* pad to max addr length */
389: } ki_d;
390:
1.75 tron 391: __uint64_t ki_inode; /* INO_T: fake inode number */
392: __uint64_t ki_vnode; /* PTR: if associated with file */
393: __uint64_t ki_conn; /* PTR: control block of peer */
394: __uint64_t ki_refs; /* PTR: referencing socket */
395: __uint64_t ki_nextref; /* PTR: link in refs list */
1.73 atatat 396: };
397:
398: #define ki_src ki_s._kis_src
399: #define ki_dst ki_d._kid_dst
400:
401: #define PCB_SLOP 20
402: #define PCB_ALL 0
403:
1.67 bjh21 404: #endif /* _NETBSD_SOURCE */
1.8 mycroft 405:
1.67 bjh21 406: #if defined(_NETBSD_SOURCE)
1.8 mycroft 407: /*
408: * PF_ROUTE - Routing table
409: *
410: * Three additional levels are defined:
411: * Fourth: address family, 0 is wildcard
412: * Fifth: type of info, defined below
413: * Sixth: flag(s) to mask with for NET_RT_FLAGS
414: */
415: #define NET_RT_DUMP 1 /* dump; may limit to a.f. */
416: #define NET_RT_FLAGS 2 /* by flags, e.g. RESOLVING */
1.47 bouyer 417: #define NET_RT_OIFLIST 3 /* old NET_RT_IFLIST (pre 1.5) */
418: #define NET_RT_IFLIST 4 /* survey interface list */
419: #define NET_RT_MAXID 5
1.8 mycroft 420:
421: #define CTL_NET_RT_NAMES { \
422: { 0, 0 }, \
423: { "dump", CTLTYPE_STRUCT }, \
424: { "flags", CTLTYPE_STRUCT }, \
1.47 bouyer 425: { 0, 0 }, \
1.8 mycroft 426: { "iflist", CTLTYPE_STRUCT }, \
427: }
1.67 bjh21 428: #endif /* _NETBSD_SOURCE */
1.8 mycroft 429:
430: /*
1.13 mycroft 431: * Maximum queue length specifiable by listen(2).
1.1 cgd 432: */
1.66 christos 433: #ifndef SOMAXCONN
1.13 mycroft 434: #define SOMAXCONN 128
1.66 christos 435: #endif
1.16 neil 436:
1.1 cgd 437: /*
438: * Message header for recvmsg and sendmsg calls.
439: * Used value-result for recvmsg, value only for sendmsg.
440: */
441: struct msghdr {
1.42 kleink 442: void *msg_name; /* optional address */
443: socklen_t msg_namelen; /* size of address */
444: struct iovec *msg_iov; /* scatter/gather array */
445: int msg_iovlen; /* # elements in msg_iov */
446: void *msg_control; /* ancillary data, see below */
447: socklen_t msg_controllen; /* ancillary data buffer len */
448: int msg_flags; /* flags on received message */
1.1 cgd 449: };
450:
1.78.4.1! kardel 451: #define MSG_OOB 0x0001 /* process out-of-band data */
! 452: #define MSG_PEEK 0x0002 /* peek at incoming message */
! 453: #define MSG_DONTROUTE 0x0004 /* send without using routing tables */
! 454: #define MSG_EOR 0x0008 /* data completes record */
! 455: #define MSG_TRUNC 0x0010 /* data discarded before delivery */
! 456: #define MSG_CTRUNC 0x0020 /* control data lost before delivery */
! 457: #define MSG_WAITALL 0x0040 /* wait for full request or error */
! 458: #define MSG_DONTWAIT 0x0080 /* this message should be nonblocking */
! 459: #define MSG_BCAST 0x0100 /* this message was rcvd using link-level brdcst */
! 460: #define MSG_MCAST 0x0200 /* this message was rcvd using link-level mcast */
! 461: #define MSG_NOSIGNAL 0x0400 /* do not generate SIGPIPE on EOF */
1.1 cgd 462:
463: /*
464: * Header for ancillary data objects in msg_control buffer.
465: * Used for additional information with/about a datagram
466: * not expressible by flags. The format is a sequence
467: * of message elements headed by cmsghdr structures.
468: */
469: struct cmsghdr {
1.42 kleink 470: socklen_t cmsg_len; /* data byte count, including hdr */
471: int cmsg_level; /* originating protocol */
472: int cmsg_type; /* protocol-specific type */
1.1 cgd 473: /* followed by u_char cmsg_data[]; */
474: };
475:
1.8 mycroft 476: /* given pointer to struct cmsghdr, return pointer to data */
1.50 itojun 477: #define CMSG_DATA(cmsg) \
1.57 christos 478: ((u_char *)(void *)(cmsg) + __CMSG_ALIGN(sizeof(struct cmsghdr)))
1.77 christos 479: #define CCMSG_DATA(cmsg) \
480: ((const u_char *)(const void *)(cmsg) + \
481: __CMSG_ALIGN(sizeof(struct cmsghdr)))
1.1 cgd 482:
1.44 itojun 483: /*
484: * Alignment requirement for CMSG struct manipulation.
1.51 itojun 485: * This basically behaves the same as ALIGN() ARCH/include/param.h.
486: * We declare it separately for two reasons:
487: * (1) avoid dependency between machine/param.h, and (2) to sync with kernel's
488: * idea of ALIGNBYTES at runtime.
489: * without (2), we can't guarantee binary compatibility in case of future
490: * changes in ALIGNBYTES.
1.44 itojun 491: */
1.53 itojun 492: #define __CMSG_ALIGN(n) (((n) + __cmsg_alignbytes()) & ~__cmsg_alignbytes())
493: #ifdef _KERNEL
1.54 augustss 494: #define CMSG_ALIGN(n) __CMSG_ALIGN(n)
1.53 itojun 495: #endif
1.44 itojun 496:
1.8 mycroft 497: /* given pointer to struct cmsghdr, return pointer to next cmsghdr */
1.1 cgd 498: #define CMSG_NXTHDR(mhdr, cmsg) \
1.63 kleink 499: (((__caddr_t)(cmsg) + __CMSG_ALIGN((cmsg)->cmsg_len) + \
1.53 itojun 500: __CMSG_ALIGN(sizeof(struct cmsghdr)) > \
1.63 kleink 501: (((__caddr_t)(mhdr)->msg_control) + (mhdr)->msg_controllen)) ? \
1.78 kleink 502: (struct cmsghdr *)0 : \
1.63 kleink 503: (struct cmsghdr *)((__caddr_t)(cmsg) + \
504: __CMSG_ALIGN((cmsg)->cmsg_len)))
1.1 cgd 505:
1.62 itojun 506: /*
507: * RFC 2292 requires to check msg_controllen, in case that the kernel returns
508: * an empty list for some reasons.
509: */
510: #define CMSG_FIRSTHDR(mhdr) \
511: ((mhdr)->msg_controllen >= sizeof(struct cmsghdr) ? \
512: (struct cmsghdr *)(mhdr)->msg_control : \
1.78 kleink 513: (struct cmsghdr *)0)
1.1 cgd 514:
1.53 itojun 515: #define CMSG_SPACE(l) (__CMSG_ALIGN(sizeof(struct cmsghdr)) + __CMSG_ALIGN(l))
516: #define CMSG_LEN(l) (__CMSG_ALIGN(sizeof(struct cmsghdr)) + (l))
1.44 itojun 517:
1.1 cgd 518: /* "Socket"-level control message types: */
519: #define SCM_RIGHTS 0x01 /* access rights (array of int) */
1.67 bjh21 520: #if defined(_NETBSD_SOURCE)
1.18 thorpej 521: #define SCM_TIMESTAMP 0x02 /* timestamp (struct timeval) */
1.42 kleink 522: #define SCM_CREDS 0x04 /* credentials (struct sockcred) */
523: #endif
1.29 kleink 524:
525: /*
526: * Types of socket shutdown(2).
527: */
528: #define SHUT_RD 0 /* Disallow further receives. */
529: #define SHUT_WR 1 /* Disallow further sends. */
530: #define SHUT_RDWR 2 /* Disallow further sends/receives. */
1.1 cgd 531:
1.59 toshii 532: #include <sys/cdefs.h>
533:
534: __BEGIN_DECLS
1.70 perry 535: int __cmsg_alignbytes(void);
1.59 toshii 536: __END_DECLS
1.1 cgd 537:
1.12 briggs 538: #ifndef _KERNEL
1.1 cgd 539:
540: __BEGIN_DECLS
1.70 perry 541: int accept(int, struct sockaddr * __restrict, socklen_t * __restrict);
542: int bind(int, const struct sockaddr *, socklen_t);
543: int connect(int, const struct sockaddr *, socklen_t);
544: int getpeername(int, struct sockaddr * __restrict, socklen_t * __restrict);
545: int getsockname(int, struct sockaddr * __restrict, socklen_t * __restrict);
546: int getsockopt(int, int, int, void * __restrict, socklen_t * __restrict);
547: int listen(int, int);
548: ssize_t recv(int, void *, size_t, int);
549: ssize_t recvfrom(int, void * __restrict, size_t, int,
550: struct sockaddr * __restrict, socklen_t * __restrict);
551: ssize_t recvmsg(int, struct msghdr *, int);
552: ssize_t send(int, const void *, size_t, int);
553: ssize_t sendto(int, const void *,
554: size_t, int, const struct sockaddr *, socklen_t);
555: ssize_t sendmsg(int, const struct msghdr *, int);
556: int setsockopt(int, int, int, const void *, socklen_t);
557: int shutdown(int, int);
558: int sockatmark(int);
559: int socket(int, int, int);
560: int socketpair(int, int, int, int *);
1.1 cgd 561: __END_DECLS
1.14 christos 562: #endif /* !_KERNEL */
1.1 cgd 563:
1.2 mycroft 564: #endif /* !_SYS_SOCKET_H_ */
CVSweb <webmaster@jp.NetBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to socket.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [cvs.NetBSD.org] / src / sys / sys