epoc32/include/stdapis/sys/socket.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
     1 // © Portions copyright (c) 2006 Nokia Corporation.  All rights reserved.
     2 
     3 /*-
     4  * Copyright (c) 1982, 1985, 1986, 1988, 1993, 1994
     5  *	The Regents of the University of California.  All rights reserved.
     6  * © Portions copyright (c) 2007 Symbian Software Ltd. All rights reserved.
     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  * 4. Neither the name of the University 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.
    18  *
    19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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  *
    31  *	@(#)socket.h	8.4 (Berkeley) 2/21/94
    32  * $FreeBSD: src/sys/sys/socket.h,v 1.88.2.1 2005/09/27 21:14:10 rwatson Exp $
    33  */
    34 
    35 #ifndef _SYS_SOCKET_H_
    36 #define	_SYS_SOCKET_H_
    37 
    38 #include <sys/cdefs.h>
    39 #include <sys/types.h>
    40 #include <sys/_types.h>
    41 #include <sys/_iovec.h>
    42 #define _NO_NAMESPACE_POLLUTION
    43 #include <machine/param.h>
    44 #undef _NO_NAMESPACE_POLLUTION
    45 
    46 /*
    47  * Definitions related to sockets: types, address families, options.
    48  */
    49 
    50 /*
    51  * Data types.
    52  */
    53 #if __BSD_VISIBLE
    54 #ifndef _GID_T_DECLARED
    55 typedef	__gid_t		gid_t;
    56 #define	_GID_T_DECLARED
    57 #endif
    58 
    59 #ifndef _OFF_T_DECLARED
    60 typedef	__off_t		off_t;
    61 #define	_OFF_T_DECLARED
    62 #endif
    63 
    64 #ifndef _PID_T_DECLARED
    65 typedef	__pid_t		pid_t;
    66 #define	_PID_T_DECLARED
    67 #endif
    68 #endif
    69 
    70 #ifndef _SA_FAMILY_T_DECLARED
    71 typedef	__sa_family_t	sa_family_t;
    72 #define	_SA_FAMILY_T_DECLARED
    73 #endif
    74 
    75 #ifndef _SOCKLEN_T_DECLARED
    76 typedef	__socklen_t	socklen_t;
    77 #define	_SOCKLEN_T_DECLARED
    78 #endif
    79  
    80 #ifndef _SSIZE_T_DECLARED
    81 typedef	__ssize_t	ssize_t;
    82 #define	_SSIZE_T_DECLARED
    83 #endif
    84 
    85 #if __BSD_VISIBLE 
    86 #ifndef _UID_T_DECLARED
    87 typedef	__uid_t		uid_t;
    88 #define	_UID_T_DECLARED
    89 #endif
    90 #endif
    91 
    92 /*
    93  * Types
    94  */
    95 #define	SOCK_STREAM	1		/* stream socket */
    96 #define	SOCK_DGRAM	2		/* datagram socket */
    97 #ifdef __SYMBIAN32__
    98 #define	SOCK_RAW	4		/* raw-protocol interface */
    99 #else
   100 #define	SOCK_RAW	3		/* raw-protocol interface */
   101 #endif	// __SYMBIAN32__
   102 #if __BSD_VISIBLE
   103 #define	SOCK_RDM	4		/* reliably-delivered message */
   104 #endif
   105 #ifdef __SYMBIAN32__
   106 #define	SOCK_SEQPACKET	3		/* sequenced packet stream */
   107 #else
   108 #define	SOCK_SEQPACKET	5		/* sequenced packet stream */
   109 #endif	// __SYMBIAN32__
   110 
   111 /*
   112  * Option flags per-socket.
   113  */
   114 #define	SO_DEBUG	0x0001		/* turn on debugging info recording KSODebug */
   115 #define	SO_ACCEPTCONN	0x0002		/* socket has had listen() */
   116 #ifdef __SYMBIAN32__
   117 #define	SO_REUSEADDR	0x406		/* allow local address reuse */
   118 #else
   119 #define	SO_REUSEADDR	0x0004		/* allow local address reuse */
   120 #endif	// __SYMBIAN32__
   121 #ifdef __SYMBIAN32__
   122 #define	SO_KEEPALIVE	0x305		/* keep connections alive KSoTcpKeepAlive */
   123 #else
   124 #define	SO_KEEPALIVE	0x0008		/* keep connections alive */
   125 #endif	// __SYMBIAN32__
   126 #define	SO_DONTROUTE	0x0010		/* just use interface addresses */
   127 #ifdef __SYMBIAN32__
   128 #define	SO_BROADCAST	-1			/* permit sending of broadcast msgs */
   129 #else
   130 #define	SO_BROADCAST	0x0020		/* permit sending of broadcast msgs */
   131 #endif	// __SYMBIAN32__
   132 #if __BSD_VISIBLE
   133 #ifdef __SYMBIAN32__
   134 #define	SO_USELOOPBACK	-2 		/* bypass hardware when possible */
   135 #else
   136 #define	SO_USELOOPBACK	0x0040		/* bypass hardware when possible */
   137 #endif	// __SYMBIAN32__
   138 #endif
   139 #ifdef __SYMBIAN32__
   140 #define	SO_LINGER	-3			/* linger on close if data present */
   141 #else
   142 #define	SO_LINGER	0x0080		/* linger on close if data present */
   143 #endif	// __SYMBIAN32__
   144 #ifdef __SYMBIAN32__
   145 #define	SO_OOBINLINE	0x315		/* leave received OOB data in line KSoTcpOobInline */
   146 #else
   147 #define	SO_OOBINLINE	0x0100		/* leave received OOB data in line */
   148 #endif	// __SYMBIAN32__
   149 #if __BSD_VISIBLE
   150 #define	SO_REUSEPORT	0x0200		/* allow local address & port reuse */
   151 #define	SO_TIMESTAMP	0x0400		/* timestamp received dgram traffic */
   152 #define	SO_NOSIGPIPE	0x0800		/* no SIGPIPE from EPIPE */
   153 #define	SO_ACCEPTFILTER	0x1000		/* there is an accept filter */
   154 #define	SO_BINTIME	0x2000		/* timestamp received dgram traffic */
   155 #endif
   156 
   157 /*
   158  * Additional options, not kept in so_options.
   159  */
   160 #ifdef __SYMBIAN32__
   161 #define	SO_SNDBUF	3			/* send buffer size KSOSendBuf */
   162 #else
   163 #define	SO_SNDBUF	0x1001		/* send buffer size */
   164 #endif	// __SYMBIAN32__
   165 #ifdef __SYMBIAN32__
   166 #define	SO_RCVBUF	2			/* receive buffer size KSORecvBuf */
   167 #else
   168 #define	SO_RCVBUF	0x1002		/* receive buffer size */
   169 #endif	// __SYMBIAN32__
   170 #define	SO_SNDLOWAT	0x1003		/* send low-water mark */
   171 #define	SO_RCVLOWAT	0x1004		/* receive low-water mark */
   172 #define	SO_SNDTIMEO	0x1005		/* send timeout */
   173 #define	SO_RCVTIMEO	0x1006		/* receive timeout */
   174 #ifdef __SYMBIAN32__
   175 #define	SO_ERROR	9		/* get error status and clear */
   176 #else
   177 #define	SO_ERROR	0x1007		/* get error status and clear */
   178 #endif	// __SYMBIAN32__
   179 #define	SO_TYPE		0x1008		/* get socket type */
   180 #if __BSD_VISIBLE
   181 #define	SO_LABEL	0x1009		/* socket's MAC label */
   182 #define	SO_PEERLABEL	0x1010		/* socket's peer's MAC label */
   183 #define	SO_LISTENQLIMIT	0x1011		/* socket's backlog limit */
   184 #define	SO_LISTENQLEN	0x1012		/* socket's complete queue length */
   185 #define	SO_LISTENINCQLEN	0x1013	/* socket's incomplete queue length */
   186 #endif
   187 
   188 /*
   189  * Structure used for manipulating linger option.
   190  */
   191 struct linger {
   192 	int	l_onoff;		/* option on/off */
   193 	int	l_linger;		/* linger time */
   194 };
   195 
   196 #if __BSD_VISIBLE
   197 struct accept_filter_arg {
   198 	char	af_name[16];
   199 	char	af_arg[256-16];
   200 };
   201 #endif
   202 
   203 /*
   204  * Level number for (get/set)sockopt() to apply to socket itself.
   205  */
   206 #ifdef __SYMBIAN32__
   207 #define	SOL_SOCKET	1			/* options for socket level KSOLSocket */
   208 #else
   209 #define	SOL_SOCKET	0xffff		/* options for socket level */
   210 #endif	// __SYMBIAN32__
   211 /*
   212  * Address families.
   213  */
   214 #define	AF_UNSPEC	0		/* unspecified */
   215 #if __BSD_VISIBLE
   216 #ifdef __SYMBIAN32__
   217 #define	AF_LOCAL	0x666		/* local to host (pipes, portals) */
   218 #else
   219 #define	AF_LOCAL	AF_UNIX		/* local to host (pipes, portals) */
   220 #endif	// __SYMBIAN32__
   221 #endif
   222 #define	AF_UNIX		1		/* standardized name for AF_LOCAL */
   223 #ifdef __SYMBIAN32__
   224 #define	AF_INET		0x0800		/* internetwork: UDP, TCP, etc. */
   225 #else
   226 #define	AF_INET		2		/* internetwork: UDP, TCP, etc. */
   227 #endif	// __SYMBIAN32__
   228 #if __BSD_VISIBLE
   229 #define	AF_IMPLINK	3		/* arpanet imp addresses */
   230 #define	AF_PUP		4		/* pup protocols: e.g. BSP */
   231 #define	AF_CHAOS	5		/* mit CHAOS protocols */
   232 #define	AF_NETBIOS	6		/* SMB protocols */
   233 #define	AF_ISO		7		/* ISO protocols */
   234 #define	AF_OSI		AF_ISO
   235 #define	AF_ECMA		8		/* European computer manufacturers */
   236 #define	AF_DATAKIT	9		/* datakit protocols */
   237 #define	AF_CCITT	10		/* CCITT protocols, X.25 etc */
   238 #define	AF_SNA		11		/* IBM SNA */
   239 #define AF_DECnet	12		/* DECnet */
   240 #define AF_DLI		13		/* DEC Direct data link interface */
   241 #define AF_LAT		14		/* LAT */
   242 #define	AF_HYLINK	15		/* NSC Hyperchannel */
   243 #define	AF_APPLETALK	16		/* Apple Talk */
   244 #define	AF_ROUTE	17		/* Internal Routing Protocol */
   245 #define	AF_LINK		18		/* Link layer interface */
   246 #define	pseudo_AF_XTP	19		/* eXpress Transfer Protocol (no AF) */
   247 #define	AF_COIP		20		/* connection-oriented IP, aka ST II */
   248 #define	AF_CNT		21		/* Computer Network Technology */
   249 #define pseudo_AF_RTIP	22		/* Help Identify RTIP packets */
   250 #define	AF_IPX		23		/* Novell Internet Protocol */
   251 #define	AF_SIP		24		/* Simple Internet Protocol */
   252 #define	pseudo_AF_PIP	25		/* Help Identify PIP packets */
   253 #define	AF_ISDN		26		/* Integrated Services Digital Network*/
   254 #define	AF_E164		AF_ISDN		/* CCITT E.164 recommendation */
   255 #define	pseudo_AF_KEY	27		/* Internal key-management function */
   256 #endif
   257 #ifdef __SYMBIAN32__
   258 #define	AF_INET6	0x0806		/* IPv6 */
   259 #else
   260 #define	AF_INET6	28		/* IPv6 */
   261 #endif
   262 #if __BSD_VISIBLE
   263 #define	AF_NATM		29		/* native ATM access */
   264 #define	AF_ATM		30		/* ATM */
   265 #define pseudo_AF_HDRCMPLT 31		/* Used by BPF to not rewrite headers
   266 					 * in interface output routine
   267 					 */
   268 #define	AF_NETGRAPH	32		/* Netgraph sockets */
   269 #define	AF_SLOW		33		/* 802.3ad slow protocol */
   270 #define	AF_SCLUSTER	34		/* Sitara cluster protocol */
   271 #define	AF_ARP		35
   272 #define	AF_BLUETOOTH	36		/* Bluetooth sockets */
   273 #define	AF_MAX		37
   274 #endif
   275 #ifdef __SYMBIAN32__
   276 #define	AF_IRDA		0x0100		/* IrDA */
   277 #define AF_PLP		273		/* Symbian link protocol */
   278 #endif	// __SYMBIAN32__
   279 
   280 #ifndef __SYMBIAN32__
   281 /*
   282  * Structure used by kernel to store most
   283  * addresses.
   284  */
   285 struct sockaddr {
   286 	unsigned char	sa_len;		/* total length */
   287 	sa_family_t	sa_family;	/* address family */
   288 	char		sa_data[14];	/* actually longer; address value */
   289 };
   290 #else 
   291 /**
   292 Structure used by EPOC32 to store most addresses.
   293 NB. EPOC32 uses 32-bit family and port numbers internally, but they have been
   294 left as shorts here for compatibility with code that uses htons()/ntohs() explicitly.
   295 */
   296 struct sockaddr {
   297 	u_short	sa_family;		/* address family */
   298 	u_short sa_port;		/* port number - a common feature of most protocols */
   299 	char	sa_data[24];		/* up to 24 bytes of direct address */
   300       unsigned char	sa_len;	
   301 };
   302 #endif //__SYMBIAN32__
   303 
   304 #if __BSD_VISIBLE
   305 #define	SOCK_MAXADDRLEN	255		/* longest possible addresses */
   306 
   307 /*
   308  * Structure used by kernel to pass protocol
   309  * information in raw sockets.
   310  */
   311 struct sockproto {
   312 	unsigned short	sp_family;		/* address family */
   313 	unsigned short	sp_protocol;		/* protocol */
   314 };
   315 #endif
   316 
   317 /*
   318  * RFC 2553: protocol-independent placeholder for socket addresses
   319  */
   320 #define	_SS_MAXSIZE	128U
   321 #define	_SS_ALIGNSIZE	(sizeof(__int64_t))
   322 #define	_SS_PAD1SIZE	(_SS_ALIGNSIZE - sizeof(unsigned char) - \
   323 			    sizeof(sa_family_t))
   324 #define	_SS_PAD2SIZE	(_SS_MAXSIZE - sizeof(unsigned char) - \
   325 			    sizeof(sa_family_t) - _SS_PAD1SIZE - _SS_ALIGNSIZE)
   326 
   327 struct sockaddr_storage {
   328 	unsigned char	ss_len;		/* address length */
   329 	sa_family_t	ss_family;	/* address family */
   330 	char		__ss_pad1[_SS_PAD1SIZE];
   331 	__int64_t	__ss_align;	/* force desired struct alignment */
   332 	char		__ss_pad2[_SS_PAD2SIZE];
   333 };
   334 
   335 #if __BSD_VISIBLE
   336 /*
   337  * Protocol families, same as address families for now.
   338  */
   339 #define	PF_UNSPEC	AF_UNSPEC
   340 #define	PF_LOCAL	AF_LOCAL
   341 #define	PF_UNIX		PF_LOCAL	/* backward compatibility */
   342 #define	PF_INET		AF_INET
   343 #define	PF_IMPLINK	AF_IMPLINK
   344 #define	PF_PUP		AF_PUP
   345 #define	PF_CHAOS	AF_CHAOS
   346 #define	PF_NETBIOS	AF_NETBIOS
   347 #define	PF_ISO		AF_ISO
   348 #define	PF_OSI		AF_ISO
   349 #define	PF_ECMA		AF_ECMA
   350 #define	PF_DATAKIT	AF_DATAKIT
   351 #define	PF_CCITT	AF_CCITT
   352 #define	PF_SNA		AF_SNA
   353 #define PF_DECnet	AF_DECnet
   354 #define PF_DLI		AF_DLI
   355 #define PF_LAT		AF_LAT
   356 #define	PF_HYLINK	AF_HYLINK
   357 #define	PF_APPLETALK	AF_APPLETALK
   358 #define	PF_ROUTE	AF_ROUTE
   359 #define	PF_LINK		AF_LINK
   360 #define	PF_XTP		pseudo_AF_XTP	/* really just proto family, no AF */
   361 #define	PF_COIP		AF_COIP
   362 #define	PF_CNT		AF_CNT
   363 #define	PF_SIP		AF_SIP
   364 #define	PF_IPX		AF_IPX
   365 #define PF_RTIP		pseudo_AF_RTIP	/* same format as AF_INET */
   366 #define PF_PIP		pseudo_AF_PIP
   367 #define	PF_ISDN		AF_ISDN
   368 #define	PF_KEY		pseudo_AF_KEY
   369 #define	PF_INET6	AF_INET6
   370 #define	PF_NATM		AF_NATM
   371 #define	PF_ATM		AF_ATM
   372 #define	PF_NETGRAPH	AF_NETGRAPH
   373 #define	PF_SLOW		AF_SLOW
   374 #define PF_SCLUSTER	AF_SCLUSTER
   375 #define	PF_ARP		AF_ARP
   376 #define	PF_BLUETOOTH	AF_BLUETOOTH
   377 
   378 #define	PF_MAX		AF_MAX
   379 
   380 #ifdef __SYMBIAN32__
   381 #define	PF_IRDA		AF_IRDA
   382 #define PF_PLP		AF_PLP
   383 #endif	// __SYMBIAN32__
   384 /*
   385  * Definitions for network related sysctl, CTL_NET.
   386  *
   387  * Second level is protocol family.
   388  * Third level is protocol number.
   389  *
   390  * Further levels are defined by the individual families below.
   391  */
   392 #define NET_MAXID	AF_MAX
   393 
   394 #define CTL_NET_NAMES { \
   395 	{ 0, 0 }, \
   396 	{ "unix", CTLTYPE_NODE }, \
   397 	{ "inet", CTLTYPE_NODE }, \
   398 	{ "implink", CTLTYPE_NODE }, \
   399 	{ "pup", CTLTYPE_NODE }, \
   400 	{ "chaos", CTLTYPE_NODE }, \
   401 	{ "xerox_ns", CTLTYPE_NODE }, \
   402 	{ "iso", CTLTYPE_NODE }, \
   403 	{ "emca", CTLTYPE_NODE }, \
   404 	{ "datakit", CTLTYPE_NODE }, \
   405 	{ "ccitt", CTLTYPE_NODE }, \
   406 	{ "ibm_sna", CTLTYPE_NODE }, \
   407 	{ "decnet", CTLTYPE_NODE }, \
   408 	{ "dec_dli", CTLTYPE_NODE }, \
   409 	{ "lat", CTLTYPE_NODE }, \
   410 	{ "hylink", CTLTYPE_NODE }, \
   411 	{ "appletalk", CTLTYPE_NODE }, \
   412 	{ "route", CTLTYPE_NODE }, \
   413 	{ "link_layer", CTLTYPE_NODE }, \
   414 	{ "xtp", CTLTYPE_NODE }, \
   415 	{ "coip", CTLTYPE_NODE }, \
   416 	{ "cnt", CTLTYPE_NODE }, \
   417 	{ "rtip", CTLTYPE_NODE }, \
   418 	{ "ipx", CTLTYPE_NODE }, \
   419 	{ "sip", CTLTYPE_NODE }, \
   420 	{ "pip", CTLTYPE_NODE }, \
   421 	{ "isdn", CTLTYPE_NODE }, \
   422 	{ "key", CTLTYPE_NODE }, \
   423 	{ "inet6", CTLTYPE_NODE }, \
   424 	{ "natm", CTLTYPE_NODE }, \
   425 	{ "atm", CTLTYPE_NODE }, \
   426 	{ "hdrcomplete", CTLTYPE_NODE }, \
   427 	{ "netgraph", CTLTYPE_NODE }, \
   428 	{ "snp", CTLTYPE_NODE }, \
   429 	{ "scp", CTLTYPE_NODE }, \
   430 }
   431 
   432 /*
   433  * PF_ROUTE - Routing table
   434  *
   435  * Three additional levels are defined:
   436  *	Fourth: address family, 0 is wildcard
   437  *	Fifth: type of info, defined below
   438  *	Sixth: flag(s) to mask with for NET_RT_FLAGS
   439  */
   440 #define NET_RT_DUMP	1		/* dump; may limit to a.f. */
   441 #define NET_RT_FLAGS	2		/* by flags, e.g. RESOLVING */
   442 #define NET_RT_IFLIST	3		/* survey interface list */
   443 #define	NET_RT_IFMALIST	4		/* return multicast address list */
   444 #define	NET_RT_MAXID	5
   445 
   446 #define CTL_NET_RT_NAMES { \
   447 	{ 0, 0 }, \
   448 	{ "dump", CTLTYPE_STRUCT }, \
   449 	{ "flags", CTLTYPE_STRUCT }, \
   450 	{ "iflist", CTLTYPE_STRUCT }, \
   451 	{ "ifmalist", CTLTYPE_STRUCT }, \
   452 }
   453 #endif /* __BSD_VISIBLE */
   454 
   455 /*
   456  * Maximum queue length specifiable by listen.
   457  */
   458 #ifdef __SYMBIAN32__
   459 #define	SOMAXCONN	5
   460 #else
   461 #define	SOMAXCONN	128
   462 #endif	// __SYMBIAN32__
   463 
   464 /*
   465  * Message header for recvmsg and sendmsg calls.
   466  * Used value-result for recvmsg, value only for sendmsg.
   467  */
   468 struct msghdr {
   469 	void		*msg_name;		/* optional address */
   470 	socklen_t	 msg_namelen;		/* size of address */
   471 	struct iovec	*msg_iov;		/* scatter/gather array */
   472 	int		 msg_iovlen;		/* # elements in msg_iov */
   473 	void		*msg_control;		/* ancillary data, see below */
   474 	socklen_t	 msg_controllen;	/* ancillary data buffer len */
   475 	int		 msg_flags;		/* flags on received message */
   476 };
   477 
   478 #define	MSG_OOB		0x1		/* process out-of-band data */
   479 #define	MSG_PEEK	0x2		/* peek at incoming message */
   480 #define	MSG_DONTROUTE	0x4		/* send without using routing tables */
   481 #define	MSG_EOR		0x8		/* data completes record */
   482 #define	MSG_TRUNC	0x10		/* data discarded before delivery */
   483 #define	MSG_CTRUNC	0x20		/* control data lost before delivery */
   484 #define	MSG_WAITALL	0x40		/* wait for full request or error */
   485 #if __BSD_VISIBLE
   486 #define	MSG_DONTWAIT	0x80		/* this message should be nonblocking */
   487 #define	MSG_EOF		0x100		/* data completes connection */
   488 #define	MSG_NBIO	0x4000		/* FIONBIO mode, used by fifofs */
   489 #define	MSG_COMPAT      0x8000		/* used in sendit() */
   490 #endif
   491 #ifdef _KERNEL
   492 #define	MSG_SOCALLBCK   0x10000		/* for use by socket callbacks - soreceive (TCP) */
   493 #endif
   494 #if __BSD_VISIBLE
   495 #define	MSG_NOSIGNAL	0x20000		/* do not generate SIGPIPE on EOF */
   496 #endif
   497 
   498 /*
   499  * Header for ancillary data objects in msg_control buffer.
   500  * Used for additional information with/about a datagram
   501  * not expressible by flags.  The format is a sequence
   502  * of message elements headed by cmsghdr structures.
   503  */
   504 struct cmsghdr {
   505 	socklen_t	cmsg_len;		/* data byte count, including hdr */
   506 	int		cmsg_level;		/* originating protocol */
   507 	int		cmsg_type;		/* protocol-specific type */
   508 /* followed by	u_char  cmsg_data[]; */
   509 };
   510 
   511 #if __BSD_VISIBLE
   512 /*
   513  * While we may have more groups than this, the cmsgcred struct must
   514  * be able to fit in an mbuf, and NGROUPS_MAX is too large to allow
   515  * this.
   516 */
   517 #define CMGROUP_MAX 16
   518 
   519 /*
   520  * Credentials structure, used to verify the identity of a peer
   521  * process that has sent us a message. This is allocated by the
   522  * peer process but filled in by the kernel. This prevents the
   523  * peer from lying about its identity. (Note that cmcred_groups[0]
   524  * is the effective GID.)
   525  */
   526 struct cmsgcred {
   527 	pid_t	cmcred_pid;		/* PID of sending process */
   528 	uid_t	cmcred_uid;		/* real UID of sending process */
   529 	uid_t	cmcred_euid;		/* effective UID of sending process */
   530 	gid_t	cmcred_gid;		/* real GID of sending process */
   531 	short	cmcred_ngroups;		/* number or groups */
   532 	gid_t	cmcred_groups[CMGROUP_MAX];	/* groups */
   533 };
   534 
   535 /*
   536  * Socket credentials.
   537  */
   538 struct sockcred {
   539 	uid_t	sc_uid;			/* real user id */
   540 	uid_t	sc_euid;		/* effective user id */
   541 	gid_t	sc_gid;			/* real group id */
   542 	gid_t	sc_egid;		/* effective group id */
   543 	int	sc_ngroups;		/* number of supplemental groups */
   544 	gid_t	sc_groups[1];		/* variable length */
   545 };
   546 
   547 /*
   548  * Compute size of a sockcred structure with groups.
   549  */
   550 #define	SOCKCREDSIZE(ngrps) \
   551 	(sizeof(struct sockcred) + (sizeof(gid_t) * ((ngrps) - 1)))
   552 
   553 #endif /* __BSD_VISIBLE */
   554 
   555 /* given pointer to struct cmsghdr, return pointer to data */
   556 #define	CMSG_DATA(cmsg)		((unsigned char *)(cmsg) + \
   557 				 _ALIGN(sizeof(struct cmsghdr)))
   558 
   559 /* given pointer to struct cmsghdr, return pointer to next cmsghdr */
   560 #define	CMSG_NXTHDR(mhdr, cmsg)	\
   561 	(((char *)(cmsg) + _ALIGN((cmsg)->cmsg_len) + \
   562 	  _ALIGN(sizeof(struct cmsghdr)) > \
   563 	    (char *)(mhdr)->msg_control + (mhdr)->msg_controllen) ? \
   564 	    (struct cmsghdr *)0 : \
   565 	    (struct cmsghdr *)((char *)(cmsg) + _ALIGN((cmsg)->cmsg_len)))
   566 
   567 /*
   568  * RFC 2292 requires to check msg_controllen, in case that the kernel returns
   569  * an empty list for some reasons.
   570  */
   571 #define	CMSG_FIRSTHDR(mhdr) \
   572 	((mhdr)->msg_controllen >= sizeof(struct cmsghdr) ? \
   573 	 (struct cmsghdr *)(mhdr)->msg_control : \
   574 	 (struct cmsghdr *)NULL)
   575 
   576 #if __BSD_VISIBLE
   577 /* RFC 2292 additions */
   578 #define	CMSG_SPACE(l)		(_ALIGN(sizeof(struct cmsghdr)) + _ALIGN(l))
   579 #define	CMSG_LEN(l)		(_ALIGN(sizeof(struct cmsghdr)) + (l))
   580 #endif
   581 
   582 #ifdef _KERNEL
   583 #define	CMSG_ALIGN(n)	_ALIGN(n)
   584 #endif
   585 
   586 /* "Socket"-level control message types: */
   587 #define	SCM_RIGHTS	0x01		/* access rights (array of int) */
   588 #if __BSD_VISIBLE
   589 #define	SCM_TIMESTAMP	0x02		/* timestamp (struct timeval) */
   590 #define	SCM_CREDS	0x03		/* process creds (struct cmsgcred) */
   591 #define	SCM_BINTIME	0x04		/* timestamp (struct bintime) */
   592 #endif
   593 
   594 #if __BSD_VISIBLE
   595 /*
   596  * 4.3 compat sockaddr, move to compat file later
   597  */
   598 struct osockaddr {
   599 	unsigned short sa_family;	/* address family */
   600 	char	sa_data[14];		/* up to 14 bytes of direct address */
   601 };
   602 
   603 /*
   604  * 4.3-compat message header (move to compat file later).
   605  */
   606 struct omsghdr {
   607 	char	*msg_name;		/* optional address */
   608 	int	msg_namelen;		/* size of address */
   609 	struct	iovec *msg_iov;		/* scatter/gather array */
   610 	int	msg_iovlen;		/* # elements in msg_iov */
   611 	char	*msg_accrights;		/* access rights sent/received */
   612 	int	msg_accrightslen;
   613 };
   614 #endif
   615 
   616 /*
   617  * howto arguments for shutdown(2), specified by Posix.1g.
   618  */
   619 #define	SHUT_RD		0		/* shut down the reading side */
   620 #define	SHUT_WR		1		/* shut down the writing side */
   621 #define	SHUT_RDWR	2		/* shut down both sides */
   622 
   623 #if __BSD_VISIBLE
   624 /*
   625  * sendfile(2) header/trailer struct
   626  */
   627 struct sf_hdtr {
   628 	struct iovec *headers;	/* pointer to an array of header struct iovec's */
   629 	int hdr_cnt;		/* number of header iovec's */
   630 	struct iovec *trailers;	/* pointer to an array of trailer struct iovec's */
   631 	int trl_cnt;		/* number of trailer iovec's */
   632 };
   633 
   634 /*
   635  * Sendfile-specific flag(s)
   636  */
   637 #define        SF_NODISKIO     0x00000001
   638 #endif
   639 
   640 #ifndef	_KERNEL
   641 
   642 #include <sys/cdefs.h>
   643 
   644 __BEGIN_DECLS
   645 IMPORT_C int	accept(int, struct sockaddr * __restrict, socklen_t * __restrict);
   646 IMPORT_C int	bind(int, const struct sockaddr *, socklen_t);
   647 IMPORT_C int	connect(int, const struct sockaddr *, socklen_t);
   648 IMPORT_C int	getpeername(int, struct sockaddr * __restrict, socklen_t * __restrict);
   649 IMPORT_C int	getsockname(int, struct sockaddr * __restrict, socklen_t * __restrict);
   650 IMPORT_C int	getsockopt(int, int, int, void * __restrict, socklen_t * __restrict);
   651 IMPORT_C int	listen(int, int);
   652 IMPORT_C ssize_t	recv(int, void *, size_t, int);
   653 IMPORT_C ssize_t	recvfrom(int, void *, size_t, int, struct sockaddr * __restrict, socklen_t * __restrict);
   654 IMPORT_C ssize_t	recvmsg(int, struct msghdr *, int);
   655 IMPORT_C ssize_t	send(int, const void *, size_t, int);
   656 IMPORT_C ssize_t	sendto(int, const void *,
   657 	    size_t, int, const struct sockaddr *, socklen_t);
   658 IMPORT_C ssize_t	sendmsg(int, const struct msghdr *, int);
   659 IMPORT_C int	setsockopt(int, int, int, const void *, socklen_t);
   660 IMPORT_C int	shutdown(int, int);
   661 IMPORT_C int	sockatmark(int);
   662 IMPORT_C int	socket(int, int, int);
   663 __END_DECLS
   664 
   665 #endif /* !_KERNEL */
   666 
   667 #endif /* !_SYS_SOCKET_H_ */