Annotation of src/sys/sys/socket.h, Revision 1.7
1.1 cgd 1: /*
2: * Copyright (c) 1982,1985,1986,1988 Regents of the University of California.
3: * 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: *
1.4 cgd 33: * from: @(#)socket.h 7.13 (Berkeley) 4/20/91
1.7 ! mycroft 34: * $Id: socket.h,v 1.6 1994/05/04 10:59:14 mycroft Exp $
1.1 cgd 35: */
36:
1.2 mycroft 37: #ifndef _SYS_SOCKET_H_
38: #define _SYS_SOCKET_H_
39:
1.1 cgd 40: /*
41: * Definitions related to sockets: types, address families, options.
42: */
43:
44: /*
45: * Types
46: */
47: #define SOCK_STREAM 1 /* stream socket */
48: #define SOCK_DGRAM 2 /* datagram socket */
49: #define SOCK_RAW 3 /* raw-protocol interface */
50: #define SOCK_RDM 4 /* reliably-delivered message */
51: #define SOCK_SEQPACKET 5 /* sequenced packet stream */
52:
53: /*
54: * Option flags per-socket.
55: */
56: #define SO_DEBUG 0x0001 /* turn on debugging info recording */
57: #define SO_ACCEPTCONN 0x0002 /* socket has had listen() */
58: #define SO_REUSEADDR 0x0004 /* allow local address reuse */
59: #define SO_KEEPALIVE 0x0008 /* keep connections alive */
60: #define SO_DONTROUTE 0x0010 /* just use interface addresses */
61: #define SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */
62: #define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */
63: #define SO_LINGER 0x0080 /* linger on close if data present */
64: #define SO_OOBINLINE 0x0100 /* leave received OOB data in line */
65:
66: /*
67: * Additional options, not kept in so_options.
68: */
69: #define SO_SNDBUF 0x1001 /* send buffer size */
70: #define SO_RCVBUF 0x1002 /* receive buffer size */
71: #define SO_SNDLOWAT 0x1003 /* send low-water mark */
72: #define SO_RCVLOWAT 0x1004 /* receive low-water mark */
73: #define SO_SNDTIMEO 0x1005 /* send timeout */
74: #define SO_RCVTIMEO 0x1006 /* receive timeout */
75: #define SO_ERROR 0x1007 /* get error status and clear */
76: #define SO_TYPE 0x1008 /* get socket type */
77:
78: /*
79: * Structure used for manipulating linger option.
80: */
81: struct linger {
82: int l_onoff; /* option on/off */
83: int l_linger; /* linger time */
84: };
85:
86: /*
87: * Level number for (get/set)sockopt() to apply to socket itself.
88: */
89: #define SOL_SOCKET 0xffff /* options for socket level */
90:
91: /*
92: * Address families.
93: */
94: #define AF_UNSPEC 0 /* unspecified */
95: #define AF_UNIX 1 /* local to host (pipes, portals) */
96: #define AF_INET 2 /* internetwork: UDP, TCP, etc. */
97: #define AF_IMPLINK 3 /* arpanet imp addresses */
98: #define AF_PUP 4 /* pup protocols: e.g. BSP */
99: #define AF_CHAOS 5 /* mit CHAOS protocols */
100: #define AF_NS 6 /* XEROX NS protocols */
101: #define AF_ISO 7 /* ISO protocols */
102: #define AF_OSI AF_ISO
103: #define AF_ECMA 8 /* european computer manufacturers */
104: #define AF_DATAKIT 9 /* datakit protocols */
105: #define AF_CCITT 10 /* CCITT protocols, X.25 etc */
106: #define AF_SNA 11 /* IBM SNA */
107: #define AF_DECnet 12 /* DECnet */
108: #define AF_DLI 13 /* DEC Direct data link interface */
109: #define AF_LAT 14 /* LAT */
110: #define AF_HYLINK 15 /* NSC Hyperchannel */
111: #define AF_APPLETALK 16 /* Apple Talk */
112: #define AF_ROUTE 17 /* Internal Routing Protocol */
113: #define AF_LINK 18 /* Link layer interface */
114: #define pseudo_AF_XTP 19 /* eXpress Transfer Protocol (no AF) */
115:
116: #define AF_MAX 20
117:
118: /*
119: * Structure used by kernel to store most
120: * addresses.
121: */
122: struct sockaddr {
123: u_char sa_len; /* total length */
124: u_char sa_family; /* address family */
125: char sa_data[14]; /* actually longer; address value */
126: };
127:
128: /*
129: * Structure used by kernel to pass protocol
130: * information in raw sockets.
131: */
132: struct sockproto {
133: u_short sp_family; /* address family */
134: u_short sp_protocol; /* protocol */
135: };
136:
137: /*
138: * Protocol families, same as address families for now.
139: */
140: #define PF_UNSPEC AF_UNSPEC
141: #define PF_UNIX AF_UNIX
142: #define PF_INET AF_INET
143: #define PF_IMPLINK AF_IMPLINK
144: #define PF_PUP AF_PUP
145: #define PF_CHAOS AF_CHAOS
146: #define PF_NS AF_NS
147: #define PF_ISO AF_ISO
148: #define PF_OSI AF_ISO
149: #define PF_ECMA AF_ECMA
150: #define PF_DATAKIT AF_DATAKIT
151: #define PF_CCITT AF_CCITT
152: #define PF_SNA AF_SNA
153: #define PF_DECnet AF_DECnet
154: #define PF_DLI AF_DLI
155: #define PF_LAT AF_LAT
156: #define PF_HYLINK AF_HYLINK
157: #define PF_APPLETALK AF_APPLETALK
158: #define PF_ROUTE AF_ROUTE
159: #define PF_LINK AF_LINK
160: #define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */
161:
162: #define PF_MAX AF_MAX
163:
164: /*
165: * Maximum queue length specifiable by listen.
166: */
167: #define SOMAXCONN 5
168:
169: /*
170: * Message header for recvmsg and sendmsg calls.
171: * Used value-result for recvmsg, value only for sendmsg.
172: */
173: struct msghdr {
174: caddr_t msg_name; /* optional address */
175: u_int msg_namelen; /* size of address */
176: struct iovec *msg_iov; /* scatter/gather array */
177: u_int msg_iovlen; /* # elements in msg_iov */
178: caddr_t msg_control; /* ancillary data, see below */
179: u_int msg_controllen; /* ancillary data buffer len */
180: int msg_flags; /* flags on received message */
181: };
182:
183: #define MSG_OOB 0x1 /* process out-of-band data */
184: #define MSG_PEEK 0x2 /* peek at incoming message */
185: #define MSG_DONTROUTE 0x4 /* send without using routing tables */
186: #define MSG_EOR 0x8 /* data completes record */
187: #define MSG_TRUNC 0x10 /* data discarded before delivery */
188: #define MSG_CTRUNC 0x20 /* control data lost before delivery */
189: #define MSG_WAITALL 0x40 /* wait for full request or error */
190:
191: /*
192: * Header for ancillary data objects in msg_control buffer.
193: * Used for additional information with/about a datagram
194: * not expressible by flags. The format is a sequence
195: * of message elements headed by cmsghdr structures.
196: */
197: struct cmsghdr {
198: u_int cmsg_len; /* data byte count, including hdr */
199: int cmsg_level; /* originating protocol */
200: int cmsg_type; /* protocol-specific type */
201: /* followed by u_char cmsg_data[]; */
202: };
203:
204: /* given pointer to struct adatahdr, return pointer to data */
205: #define CMSG_DATA(cmsg) ((u_char *)((cmsg) + 1))
206:
207: /* given pointer to struct adatahdr, return pointer to next adatahdr */
208: #define CMSG_NXTHDR(mhdr, cmsg) \
209: (((caddr_t)(cmsg) + (cmsg)->cmsg_len + sizeof(struct cmsghdr) > \
210: (mhdr)->msg_control + (mhdr)->msg_controllen) ? \
211: (struct cmsghdr *)NULL : \
212: (struct cmsghdr *)((caddr_t)(cmsg) + ALIGN((cmsg)->cmsg_len)))
213:
214: #define CMSG_FIRSTHDR(mhdr) ((struct cmsghdr *)(mhdr)->msg_control)
215:
216: /* "Socket"-level control message types: */
217: #define SCM_RIGHTS 0x01 /* access rights (array of int) */
218:
219: /*
220: * 4.3 compat sockaddr, move to compat file later
221: */
222: struct osockaddr {
223: u_short sa_family; /* address family */
224: char sa_data[14]; /* up to 14 bytes of direct address */
225: };
226:
227: /*
228: * 4.3-compat message header (move to compat file later).
229: */
230: struct omsghdr {
231: caddr_t msg_name; /* optional address */
232: int msg_namelen; /* size of address */
233: struct iovec *msg_iov; /* scatter/gather array */
234: int msg_iovlen; /* # elements in msg_iov */
235: caddr_t msg_accrights; /* access rights sent/received */
236: int msg_accrightslen;
237: };
238:
1.7 ! mycroft 239: #ifndef KERNEL
1.1 cgd 240:
241: #include <sys/cdefs.h>
242:
243: __BEGIN_DECLS
244: int accept __P((int, struct sockaddr *, int *));
245: int bind __P((int, const struct sockaddr *, int));
246: int connect __P((int, const struct sockaddr *, int));
247: int getpeername __P((int, struct sockaddr *, int *));
248: int getsockname __P((int, struct sockaddr *, int *));
249: int getsockopt __P((int, int, int, void *, int *));
250: int listen __P((int, int));
251: int recv __P((int, void *, int, int));
252: int recvfrom __P((int, void *, int, int,
253: struct sockaddr *, int *));
254: int recvmsg __P((int, struct msghdr *, int));
255: int send __P((int, const void *, int, int));
256: int sendto __P((int, const void *, int, int, const struct sockaddr *, int));
257: int sendmsg __P((int, const struct msghdr *, int));
258: int setsockopt __P((int, int, int, const void *, int));
259: int shutdown __P((int, int));
260: int socket __P((int, int, int));
261: int socketpair __P((int, int, int, int *));
262: __END_DECLS
263:
1.3 mycroft 264: #endif /* !KERNEL */
1.2 mycroft 265:
266: #endif /* !_SYS_SOCKET_H_ */
CVSweb <webmaster@jp.NetBSD.org>