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