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: src/sys/sys/socket.h,v 1.15.2.2 2001/02/09 22:53:18 alfred Exp $
35 */
36
37 #ifndef _SYS_SOCKET_H_
38 #define _SYS_SOCKET_H_
39
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 #define SO_REUSEPORT 0x0200 /* allow local address & port reuse */
66 #define SO_TIMESTAMP 0x0400 /* timestamp received dgram traffic */
67
68 /*
69 * Additional options, not kept in so_options.
70 */
71 #define SO_SNDBUF 0x1001 /* send buffer size */
72 #define SO_RCVBUF 0x1002 /* receive buffer size */
73 #define SO_SNDLOWAT 0x1003 /* send low-water mark */
74 #define SO_RCVLOWAT 0x1004 /* receive low-water mark */
75 #define SO_SNDTIMEO 0x1005 /* send timeout */
76 #define SO_RCVTIMEO 0x1006 /* receive timeout */
77 #define SO_ERROR 0x1007 /* get error status and clear */
78 #define SO_TYPE 0x1008 /* get socket type */
79 #define SO_PRIVSTATE 0x1009 /* get/deny privileged state */
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 */
98 #define AF_LOCAL 1 /* local to host (pipes, portals) */
99 #define AF_UNIX AF_LOCAL /* backward compatibility */
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) */
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 */
123 #define AF_SIP 24 /* Simple Internet Protocol */
124 #define pseudo_AF_PIP 25 /* Help Identify PIP packets */
125 #define AF_ISDN 26 /* Integrated Services Digital Network*/
126 #define AF_E164 AF_ISDN /* CCITT E.164 recommendation */
127 #define pseudo_AF_KEY 27 /* Internal key-management function */
128 #define AF_INET6 28 /* IPv6 */
129
130 #define AF_MAX 29
131
132 /*
133 * Structure used by kernel to store most
134 * addresses.
135 */
136 struct sockaddr {
137 u_char sa_len; /* total length */
138 u_char sa_family; /* address family */
139 char sa_data[14]; /* actually longer; address value */
140 };
141
142 /*
143 * Structure used by kernel to pass protocol
144 * information in raw sockets.
145 */
146 struct sockproto {
147 u_short sp_family; /* address family */
148 u_short sp_protocol; /* protocol */
149 };
150
151 /*
152 * Protocol families, same as address families for now.
153 */
154 #define PF_UNSPEC AF_UNSPEC
155 #define PF_LOCAL AF_LOCAL
156 #define PF_UNIX PF_LOCAL /* backward compatibility */
157 #define PF_INET AF_INET
158 #define PF_IMPLINK AF_IMPLINK
159 #define PF_PUP AF_PUP
160 #define PF_CHAOS AF_CHAOS
161 #define PF_NS AF_NS
162 #define PF_ISO AF_ISO
163 #define PF_OSI AF_ISO
164 #define PF_ECMA AF_ECMA
165 #define PF_DATAKIT AF_DATAKIT
166 #define PF_CCITT AF_CCITT
167 #define PF_SNA AF_SNA
168 #define PF_DECnet AF_DECnet
169 #define PF_DLI AF_DLI
170 #define PF_LAT AF_LAT
171 #define PF_HYLINK AF_HYLINK
172 #define PF_APPLETALK AF_APPLETALK
173 #define PF_ROUTE AF_ROUTE
174 #define PF_LINK AF_LINK
175 #define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */
176 #define PF_COIP AF_COIP
177 #define PF_CNT AF_CNT
178 #define PF_SIP AF_SIP
179 #define PF_IPX AF_IPX /* same format as AF_NS */
180 #define PF_RTIP pseudo_AF_RTIP /* same format as AF_INET */
181 #define PF_PIP pseudo_AF_PIP
182 #define PF_ISDN AF_ISDN
183 #define PF_KEY pseudo_AF_KEY
184 #define PF_INET6 AF_INET6
185
186 #define PF_MAX AF_MAX
187
188 /*
189 * Definitions for network related sysctl, CTL_NET.
190 *
191 * Second level is protocol family.
192 * Third level is protocol number.
193 *
194 * Further levels are defined by the individual families below.
195 */
196 #define NET_MAXID AF_MAX
197
198 #define CTL_NET_NAMES { \
199 { 0, 0 }, \
200 { "unix", CTLTYPE_NODE }, \
201 { "inet", CTLTYPE_NODE }, \
202 { "implink", CTLTYPE_NODE }, \
203 { "pup", CTLTYPE_NODE }, \
204 { "chaos", CTLTYPE_NODE }, \
205 { "xerox_ns", CTLTYPE_NODE }, \
206 { "iso", CTLTYPE_NODE }, \
207 { "emca", CTLTYPE_NODE }, \
208 { "datakit", CTLTYPE_NODE }, \
209 { "ccitt", CTLTYPE_NODE }, \
210 { "ibm_sna", CTLTYPE_NODE }, \
211 { "decnet", CTLTYPE_NODE }, \
212 { "dec_dli", CTLTYPE_NODE }, \
213 { "lat", CTLTYPE_NODE }, \
214 { "hylink", CTLTYPE_NODE }, \
215 { "appletalk", CTLTYPE_NODE }, \
216 { "route", CTLTYPE_NODE }, \
217 { "link_layer", CTLTYPE_NODE }, \
218 { "xtp", CTLTYPE_NODE }, \
219 { "coip", CTLTYPE_NODE }, \
220 { "cnt", CTLTYPE_NODE }, \
221 { "rtip", CTLTYPE_NODE }, \
222 { "ipx", CTLTYPE_NODE }, \
223 { "sip", CTLTYPE_NODE }, \
224 { "pip", CTLTYPE_NODE }, \
225 { "isdn", CTLTYPE_NODE }, \
226 { "key", CTLTYPE_NODE }, \
227 }
228
229 /*
230 * PF_ROUTE - Routing table
231 *
232 * Three additional levels are defined:
233 * Fourth: address family, 0 is wildcard
234 * Fifth: type of info, defined below
235 * Sixth: flag(s) to mask with for NET_RT_FLAGS
236 */
237 #define NET_RT_DUMP 1 /* dump; may limit to a.f. */
238 #define NET_RT_FLAGS 2 /* by flags, e.g. RESOLVING */
239 #define NET_RT_IFLIST 3 /* survey interface list */
240 #define NET_RT_MAXID 4
241
242 #define CTL_NET_RT_NAMES { \
243 { 0, 0 }, \
244 { "dump", CTLTYPE_STRUCT }, \
245 { "flags", CTLTYPE_STRUCT }, \
246 { "iflist", CTLTYPE_STRUCT }, \
247 }
248
249 /*
250 * Maximum queue length specifiable by listen.
251 */
252 #define SOMAXCONN 128
253
254 /*
255 * Message header for recvmsg and sendmsg calls.
256 * Used value-result for recvmsg, value only for sendmsg.
257 */
258 struct msghdr {
259 caddr_t msg_name; /* optional address */
260 u_int msg_namelen; /* size of address */
261 struct iovec *msg_iov; /* scatter/gather array */
262 u_int msg_iovlen; /* # elements in msg_iov */
263 caddr_t msg_control; /* ancillary data, see below */
264 u_int msg_controllen; /* ancillary data buffer len */
265 int msg_flags; /* flags on received message */
266 };
267
268 #define MSG_OOB 0x1 /* process out-of-band data */
269 #define MSG_PEEK 0x2 /* peek at incoming message */
270 #define MSG_DONTROUTE 0x4 /* send without using routing tables */
271 #define MSG_EOR 0x8 /* data completes record */
272 #define MSG_TRUNC 0x10 /* data discarded before delivery */
273 #define MSG_CTRUNC 0x20 /* control data lost before delivery */
274 #define MSG_WAITALL 0x40 /* wait for full request or error */
275 #define MSG_DONTWAIT 0x80 /* this message should be nonblocking */
276 #define MSG_EOF 0x100 /* data completes connection */
277 #define MSG_COMPAT 0x8000 /* used in sendit() */
278
279 /*
280 * Header for ancillary data objects in msg_control buffer.
281 * Used for additional information with/about a datagram
282 * not expressible by flags. The format is a sequence
283 * of message elements headed by cmsghdr structures.
284 */
285 struct cmsghdr {
286 u_int cmsg_len; /* data byte count, including hdr */
287 int cmsg_level; /* originating protocol */
288 int cmsg_type; /* protocol-specific type */
289 /* followed by u_char cmsg_data[]; */
290 };
291
292 /* given pointer to struct cmsghdr, return pointer to data */
293 #define CMSG_DATA(cmsg) ((u_char *)((cmsg) + 1))
294
295 /* given pointer to struct cmsghdr, return pointer to next cmsghdr */
296 #define CMSG_NXTHDR(mhdr, cmsg) \
297 (((caddr_t)(cmsg) + (cmsg)->cmsg_len + sizeof(struct cmsghdr) > \
298 (mhdr)->msg_control + (mhdr)->msg_controllen) ? \
299 (struct cmsghdr *)NULL : \
300 (struct cmsghdr *)((caddr_t)(cmsg) + ALIGN((cmsg)->cmsg_len)))
301
302 #define CMSG_FIRSTHDR(mhdr) ((struct cmsghdr *)(mhdr)->msg_control)
303
304 /* "Socket"-level control message types: */
305 #define SCM_RIGHTS 0x01 /* access rights (array of int) */
306 #define SCM_TIMESTAMP 0x02 /* timestamp (struct timeval) */
307
308 /*
309 * 4.3 compat sockaddr, move to compat file later
310 */
311 struct osockaddr {
312 u_short sa_family; /* address family */
313 char sa_data[14]; /* up to 14 bytes of direct address */
314 };
315
316 /*
317 * 4.3-compat message header (move to compat file later).
318 */
319 struct omsghdr {
320 caddr_t msg_name; /* optional address */
321 int msg_namelen; /* size of address */
322 struct iovec *msg_iov; /* scatter/gather array */
323 int msg_iovlen; /* # elements in msg_iov */
324 caddr_t msg_accrights; /* access rights sent/received */
325 int msg_accrightslen;
326 };
327
328 /*
329 * howto arguments for shutdown(2), specified by Posix.1g.
330 */
331 #define SHUT_RD 0 /* shut down the reading side */
332 #define SHUT_WR 1 /* shut down the writing side */
333 #define SHUT_RDWR 2 /* shut down both sides */
334
335 #ifndef KERNEL
336
337 #include <sys/cdefs.h>
338
339 __BEGIN_DECLS
340 int accept __P((int, struct sockaddr *, int *));
341 int bind __P((int, const struct sockaddr *, int));
342 int connect __P((int, const struct sockaddr *, int));
343 int getpeername __P((int, struct sockaddr *, int *));
344 int getsockname __P((int, struct sockaddr *, int *));
345 int getsockopt __P((int, int, int, void *, int *));
346 int listen __P((int, int));
347 ssize_t recv __P((int, void *, size_t, int));
348 ssize_t recvfrom __P((int, void *, size_t, int, struct sockaddr *, int *));
349 ssize_t recvmsg __P((int, struct msghdr *, int));
350 ssize_t send __P((int, const void *, size_t, int));
351 ssize_t sendto __P((int, const void *,
352 size_t, int, const struct sockaddr *, int));
353 ssize_t sendmsg __P((int, const struct msghdr *, int));
354 int setsockopt __P((int, int, int, const void *, int));
355 int shutdown __P((int, int));
356 int socket __P((int, int, int));
357 int socketpair __P((int, int, int, int *));
358 __END_DECLS
359
360 #else /* KERNEL */
361 void pfctlinput __P((int, struct sockaddr *));
362 #endif /* !KERNEL */
363 #endif /* !_SYS_SOCKET_H_ */
Cache object: b386082d619c4583543e6ab35e0c6ae4
|