Annotation of src/sys/sys/socket.h, Revision 1.27
1.27 ! thorpej 1: /* $NetBSD: socket.h,v 1.26 1997/05/05 06:29:09 thorpej Exp $ */
1.10 cgd 2:
1.1 cgd 3: /*
1.8 mycroft 4: * Copyright (c) 1982, 1985, 1986, 1988, 1993, 1994
5: * The Regents of the University of California. All rights reserved.
1.1 cgd 6: *
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. All advertising materials mentioning features or use of this software
16: * must display the following acknowledgement:
17: * This product includes software developed by the University of
18: * California, Berkeley and its contributors.
19: * 4. Neither the name of the University nor the names of its contributors
20: * may be used to endorse or promote products derived from this software
21: * without specific prior written permission.
22: *
23: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33: * SUCH DAMAGE.
34: *
1.9 cgd 35: * @(#)socket.h 8.4 (Berkeley) 2/21/94
1.1 cgd 36: */
37:
1.2 mycroft 38: #ifndef _SYS_SOCKET_H_
1.8 mycroft 39: #define _SYS_SOCKET_H_
1.2 mycroft 40:
1.1 cgd 41: /*
42: * Definitions related to sockets: types, address families, options.
43: */
44:
45: /*
46: * Types
47: */
48: #define SOCK_STREAM 1 /* stream socket */
49: #define SOCK_DGRAM 2 /* datagram socket */
50: #define SOCK_RAW 3 /* raw-protocol interface */
51: #define SOCK_RDM 4 /* reliably-delivered message */
52: #define SOCK_SEQPACKET 5 /* sequenced packet stream */
53:
54: /*
55: * Option flags per-socket.
56: */
57: #define SO_DEBUG 0x0001 /* turn on debugging info recording */
58: #define SO_ACCEPTCONN 0x0002 /* socket has had listen() */
59: #define SO_REUSEADDR 0x0004 /* allow local address reuse */
60: #define SO_KEEPALIVE 0x0008 /* keep connections alive */
61: #define SO_DONTROUTE 0x0010 /* just use interface addresses */
62: #define SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */
63: #define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */
64: #define SO_LINGER 0x0080 /* linger on close if data present */
65: #define SO_OOBINLINE 0x0100 /* leave received OOB data in line */
1.8 mycroft 66: #define SO_REUSEPORT 0x0200 /* allow local address & port reuse */
1.18 thorpej 67: #define SO_TIMESTAMP 0x0400 /* timestamp received dgram traffic */
1.1 cgd 68:
69: /*
70: * Additional options, not kept in so_options.
71: */
72: #define SO_SNDBUF 0x1001 /* send buffer size */
73: #define SO_RCVBUF 0x1002 /* receive buffer size */
74: #define SO_SNDLOWAT 0x1003 /* send low-water mark */
75: #define SO_RCVLOWAT 0x1004 /* receive low-water mark */
76: #define SO_SNDTIMEO 0x1005 /* send timeout */
77: #define SO_RCVTIMEO 0x1006 /* receive timeout */
78: #define SO_ERROR 0x1007 /* get error status and clear */
79: #define SO_TYPE 0x1008 /* get socket type */
80:
81: /*
82: * Structure used for manipulating linger option.
83: */
84: struct linger {
85: int l_onoff; /* option on/off */
86: int l_linger; /* linger time */
87: };
88:
89: /*
90: * Level number for (get/set)sockopt() to apply to socket itself.
91: */
92: #define SOL_SOCKET 0xffff /* options for socket level */
93:
94: /*
95: * Address families.
96: */
97: #define AF_UNSPEC 0 /* unspecified */
1.8 mycroft 98: #define AF_LOCAL 1 /* local to host (pipes, portals) */
99: #define AF_UNIX AF_LOCAL /* backward compatibility */
1.1 cgd 100: #define AF_INET 2 /* internetwork: UDP, TCP, etc. */
101: #define AF_IMPLINK 3 /* arpanet imp addresses */
102: #define AF_PUP 4 /* pup protocols: e.g. BSP */
103: #define AF_CHAOS 5 /* mit CHAOS protocols */
104: #define AF_NS 6 /* XEROX NS protocols */
105: #define AF_ISO 7 /* ISO protocols */
106: #define AF_OSI AF_ISO
107: #define AF_ECMA 8 /* european computer manufacturers */
108: #define AF_DATAKIT 9 /* datakit protocols */
109: #define AF_CCITT 10 /* CCITT protocols, X.25 etc */
110: #define AF_SNA 11 /* IBM SNA */
111: #define AF_DECnet 12 /* DECnet */
112: #define AF_DLI 13 /* DEC Direct data link interface */
113: #define AF_LAT 14 /* LAT */
114: #define AF_HYLINK 15 /* NSC Hyperchannel */
115: #define AF_APPLETALK 16 /* Apple Talk */
116: #define AF_ROUTE 17 /* Internal Routing Protocol */
117: #define AF_LINK 18 /* Link layer interface */
118: #define pseudo_AF_XTP 19 /* eXpress Transfer Protocol (no AF) */
1.8 mycroft 119: #define AF_COIP 20 /* connection-oriented IP, aka ST II */
120: #define AF_CNT 21 /* Computer Network Technology */
121: #define pseudo_AF_RTIP 22 /* Help Identify RTIP packets */
122: #define AF_IPX 23 /* Novell Internet Protocol */
1.21 sommerfe 123: #define AF_INET6 24 /* IP version 6 */
1.8 mycroft 124: #define pseudo_AF_PIP 25 /* Help Identify PIP packets */
1.17 chuck 125: #define AF_ISDN 26 /* Integrated Services Digital Network*/
126: #define AF_E164 AF_ISDN /* CCITT E.164 recommendation */
127: #define AF_NATM 27 /* native ATM access */
1.19 is 128: #define AF_ARP 28 /* (rev.) addr. res. prot. (RFC 826) */
1.21 sommerfe 129: #define pseudo_AF_KEY 29 /* Internal key management protocol */
1.1 cgd 130:
1.21 sommerfe 131: #define AF_MAX 30
1.1 cgd 132:
133: /*
1.26 thorpej 134: * Structure used by kernel to store most
135: * addresses.
1.1 cgd 136: */
137: struct sockaddr {
138: u_char sa_len; /* total length */
139: u_char sa_family; /* address family */
140: char sa_data[14]; /* actually longer; address value */
1.26 thorpej 141: };
1.1 cgd 142:
143: /*
144: * Structure used by kernel to pass protocol
145: * information in raw sockets.
146: */
147: struct sockproto {
148: u_short sp_family; /* address family */
149: u_short sp_protocol; /* protocol */
150: };
151:
152: /*
153: * Protocol families, same as address families for now.
154: */
155: #define PF_UNSPEC AF_UNSPEC
1.8 mycroft 156: #define PF_LOCAL AF_LOCAL
157: #define PF_UNIX PF_LOCAL /* backward compatibility */
1.1 cgd 158: #define PF_INET AF_INET
159: #define PF_IMPLINK AF_IMPLINK
160: #define PF_PUP AF_PUP
161: #define PF_CHAOS AF_CHAOS
162: #define PF_NS AF_NS
163: #define PF_ISO AF_ISO
164: #define PF_OSI AF_ISO
165: #define PF_ECMA AF_ECMA
166: #define PF_DATAKIT AF_DATAKIT
167: #define PF_CCITT AF_CCITT
168: #define PF_SNA AF_SNA
169: #define PF_DECnet AF_DECnet
170: #define PF_DLI AF_DLI
171: #define PF_LAT AF_LAT
172: #define PF_HYLINK AF_HYLINK
173: #define PF_APPLETALK AF_APPLETALK
174: #define PF_ROUTE AF_ROUTE
175: #define PF_LINK AF_LINK
176: #define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */
1.8 mycroft 177: #define PF_COIP AF_COIP
178: #define PF_CNT AF_CNT
1.21 sommerfe 179: #define PF_INET6 AF_INET6
1.8 mycroft 180: #define PF_IPX AF_IPX /* same format as AF_NS */
181: #define PF_RTIP pseudo_AF_FTIP /* same format as AF_INET */
182: #define PF_PIP pseudo_AF_PIP
1.20 is 183: #define PF_ISDN AF_ISDN /* same as E164 */
184: #define PF_E164 AF_E164
1.17 chuck 185: #define PF_NATM AF_NATM
1.19 is 186: #define PF_ARP AF_ARP
1.21 sommerfe 187: #define PF_KEY pseudo_AF_KEY /* like PF_ROUTE, only for key mgmt */
1.1 cgd 188:
189: #define PF_MAX AF_MAX
190:
191: /*
1.27 ! thorpej 192: * Socket credentials.
! 193: */
! 194: struct sockcred {
! 195: uid_t sc_uid; /* real user id */
! 196: uid_t sc_euid; /* effective user id */
! 197: gid_t sc_gid; /* real group id */
! 198: gid_t sc_egid; /* effective group id */
! 199: int sc_ngroups; /* number of supplemental groups */
! 200: gid_t sc_groups[1]; /* variable length */
! 201: };
! 202:
! 203: /*
! 204: * Compute size of a sockcred structure with groups.
! 205: */
! 206: #define SOCKCREDSIZE(ngrps) \
! 207: (sizeof(struct sockcred) + (sizeof(gid_t) * ((ngrps) - 1)))
! 208:
! 209: /*
1.8 mycroft 210: * Definitions for network related sysctl, CTL_NET.
211: *
212: * Second level is protocol family.
213: * Third level is protocol number.
214: *
215: * Further levels are defined by the individual families below.
216: */
217: #define NET_MAXID AF_MAX
218:
219: #define CTL_NET_NAMES { \
220: { 0, 0 }, \
221: { "unix", CTLTYPE_NODE }, \
222: { "inet", CTLTYPE_NODE }, \
223: { "implink", CTLTYPE_NODE }, \
224: { "pup", CTLTYPE_NODE }, \
225: { "chaos", CTLTYPE_NODE }, \
226: { "xerox_ns", CTLTYPE_NODE }, \
227: { "iso", CTLTYPE_NODE }, \
228: { "emca", CTLTYPE_NODE }, \
229: { "datakit", CTLTYPE_NODE }, \
230: { "ccitt", CTLTYPE_NODE }, \
231: { "ibm_sna", CTLTYPE_NODE }, \
232: { "decnet", CTLTYPE_NODE }, \
233: { "dec_dli", CTLTYPE_NODE }, \
234: { "lat", CTLTYPE_NODE }, \
235: { "hylink", CTLTYPE_NODE }, \
236: { "appletalk", CTLTYPE_NODE }, \
237: { "route", CTLTYPE_NODE }, \
238: { "link_layer", CTLTYPE_NODE }, \
239: { "xtp", CTLTYPE_NODE }, \
240: { "coip", CTLTYPE_NODE }, \
241: { "cnt", CTLTYPE_NODE }, \
242: { "rtip", CTLTYPE_NODE }, \
243: { "ipx", CTLTYPE_NODE }, \
1.21 sommerfe 244: { "inet6", CTLTYPE_NODE }, \
1.8 mycroft 245: { "pip", CTLTYPE_NODE }, \
1.20 is 246: { "isdn", CTLTYPE_NODE }, \
1.17 chuck 247: { "natm", CTLTYPE_NODE }, \
1.20 is 248: { "arp", CTLTYPE_NODE }, \
1.21 sommerfe 249: { "key", CTLTYPE_NODE }, \
1.8 mycroft 250: }
251:
252: /*
253: * PF_ROUTE - Routing table
254: *
255: * Three additional levels are defined:
256: * Fourth: address family, 0 is wildcard
257: * Fifth: type of info, defined below
258: * Sixth: flag(s) to mask with for NET_RT_FLAGS
259: */
260: #define NET_RT_DUMP 1 /* dump; may limit to a.f. */
261: #define NET_RT_FLAGS 2 /* by flags, e.g. RESOLVING */
262: #define NET_RT_IFLIST 3 /* survey interface list */
263: #define NET_RT_MAXID 4
264:
265: #define CTL_NET_RT_NAMES { \
266: { 0, 0 }, \
267: { "dump", CTLTYPE_STRUCT }, \
268: { "flags", CTLTYPE_STRUCT }, \
269: { "iflist", CTLTYPE_STRUCT }, \
270: }
271:
272: /*
1.13 mycroft 273: * Maximum queue length specifiable by listen(2).
1.1 cgd 274: */
1.16 neil 275:
1.13 mycroft 276: #define SOMAXCONN 128
1.16 neil 277:
1.1 cgd 278: /*
279: * Message header for recvmsg and sendmsg calls.
280: * Used value-result for recvmsg, value only for sendmsg.
281: */
282: struct msghdr {
283: caddr_t msg_name; /* optional address */
284: u_int msg_namelen; /* size of address */
285: struct iovec *msg_iov; /* scatter/gather array */
286: u_int msg_iovlen; /* # elements in msg_iov */
287: caddr_t msg_control; /* ancillary data, see below */
288: u_int msg_controllen; /* ancillary data buffer len */
289: int msg_flags; /* flags on received message */
290: };
291:
292: #define MSG_OOB 0x1 /* process out-of-band data */
293: #define MSG_PEEK 0x2 /* peek at incoming message */
294: #define MSG_DONTROUTE 0x4 /* send without using routing tables */
295: #define MSG_EOR 0x8 /* data completes record */
296: #define MSG_TRUNC 0x10 /* data discarded before delivery */
297: #define MSG_CTRUNC 0x20 /* control data lost before delivery */
298: #define MSG_WAITALL 0x40 /* wait for full request or error */
1.8 mycroft 299: #define MSG_DONTWAIT 0x80 /* this message should be nonblocking */
1.1 cgd 300:
301: /*
302: * Header for ancillary data objects in msg_control buffer.
303: * Used for additional information with/about a datagram
304: * not expressible by flags. The format is a sequence
305: * of message elements headed by cmsghdr structures.
306: */
307: struct cmsghdr {
308: u_int cmsg_len; /* data byte count, including hdr */
309: int cmsg_level; /* originating protocol */
310: int cmsg_type; /* protocol-specific type */
311: /* followed by u_char cmsg_data[]; */
312: };
313:
1.8 mycroft 314: /* given pointer to struct cmsghdr, return pointer to data */
1.1 cgd 315: #define CMSG_DATA(cmsg) ((u_char *)((cmsg) + 1))
316:
1.8 mycroft 317: /* given pointer to struct cmsghdr, return pointer to next cmsghdr */
1.1 cgd 318: #define CMSG_NXTHDR(mhdr, cmsg) \
319: (((caddr_t)(cmsg) + (cmsg)->cmsg_len + sizeof(struct cmsghdr) > \
320: (mhdr)->msg_control + (mhdr)->msg_controllen) ? \
321: (struct cmsghdr *)NULL : \
322: (struct cmsghdr *)((caddr_t)(cmsg) + ALIGN((cmsg)->cmsg_len)))
323:
324: #define CMSG_FIRSTHDR(mhdr) ((struct cmsghdr *)(mhdr)->msg_control)
325:
326: /* "Socket"-level control message types: */
327: #define SCM_RIGHTS 0x01 /* access rights (array of int) */
1.18 thorpej 328: #define SCM_TIMESTAMP 0x02 /* timestamp (struct timeval) */
1.27 ! thorpej 329: #define SCM_CREDS 0x04 /* credientials (struct sockcred) */
1.1 cgd 330:
331: /*
332: * 4.3 compat sockaddr, move to compat file later
333: */
334: struct osockaddr {
335: u_short sa_family; /* address family */
336: char sa_data[14]; /* up to 14 bytes of direct address */
337: };
338:
339: /*
340: * 4.3-compat message header (move to compat file later).
341: */
342: struct omsghdr {
343: caddr_t msg_name; /* optional address */
344: int msg_namelen; /* size of address */
345: struct iovec *msg_iov; /* scatter/gather array */
346: int msg_iovlen; /* # elements in msg_iov */
347: caddr_t msg_accrights; /* access rights sent/received */
348: int msg_accrightslen;
349: };
350:
1.12 briggs 351: #ifndef _KERNEL
1.1 cgd 352:
353: #include <sys/cdefs.h>
354:
355: __BEGIN_DECLS
356: int accept __P((int, struct sockaddr *, int *));
357: int bind __P((int, const struct sockaddr *, int));
358: int connect __P((int, const struct sockaddr *, int));
359: int getpeername __P((int, struct sockaddr *, int *));
360: int getsockname __P((int, struct sockaddr *, int *));
361: int getsockopt __P((int, int, int, void *, int *));
362: int listen __P((int, int));
1.8 mycroft 363: ssize_t recv __P((int, void *, size_t, int));
364: ssize_t recvfrom __P((int, void *, size_t, int, struct sockaddr *, int *));
365: ssize_t recvmsg __P((int, struct msghdr *, int));
366: ssize_t send __P((int, const void *, size_t, int));
367: ssize_t sendto __P((int, const void *,
368: size_t, int, const struct sockaddr *, int));
369: ssize_t sendmsg __P((int, const struct msghdr *, int));
1.1 cgd 370: int setsockopt __P((int, int, int, const void *, int));
371: int shutdown __P((int, int));
372: int socket __P((int, int, int));
373: int socketpair __P((int, int, int, int *));
374: __END_DECLS
1.14 christos 375: #else
376: # if defined(COMPAT_43) || defined(COMPAT_SUNOS) || defined(COMPAT_LINUX) || \
377: defined(COMPAT_HPUX) || defined(COMPAT_FREEBSD)
378: # define COMPAT_OLDSOCK
379: # define MSG_COMPAT 0x8000
380: # endif
381: #endif /* !_KERNEL */
1.1 cgd 382:
1.2 mycroft 383: #endif /* !_SYS_SOCKET_H_ */
CVSweb <webmaster@jp.NetBSD.org>