[thirdparty/glibc.git] / sysdeps / generic / socketbits.h

/* System-specific socket constants and types.  Generic/4.3 BSD version.
   Copyright (C) 1991, 92, 94, 95, 96, 97 Free Software Foundation, Inc.
   This file is part of the GNU C Library.

   The GNU C Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public License as
   published by the Free Software Foundation; either version 2 of the
   License, or (at your option) any later version.

   The GNU C Library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with the GNU C Library; see the file COPYING.LIB.  If not,
   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.  */

#ifndef	_SOCKETBITS_H

#define	_SOCKETBITS_H	1
#include <features.h>

__BEGIN_DECLS

#define	__need_size_t
#include <stddef.h>


/* Types of sockets.  */
enum __socket_type
{
  SOCK_STREAM = 1,		/* Sequenced, reliable, connection-based
				   byte streams.  */
#define SOCK_STREAM SOCK_STREAM
  SOCK_DGRAM = 2,		/* Connectionless, unreliable datagrams
				   of fixed maximum length.  */
#define SOCK_DGRAM SOCK_DGRAM
  SOCK_RAW = 3,			/* Raw protocol interface.  */
#define SOCK_RAW SOCK_RAW
  SOCK_RDM = 4,			/* Reliably-delivered messages.  */
#define SOCK_RDM SOCK_RDM
  SOCK_SEQPACKET = 5,		/* Sequenced, reliable, connection-based,
				   datagrams of fixed maximum length.  */
#define SOCK_SEQPACKET SOCK_SEQPACKET
};

/* Protocol families.  */
#define	PF_UNSPEC	0	/* Unspecified.  */
#define	PF_LOCAL	1	/* Local to host (pipes and file-domain).  */
#define	PF_UNIX		PF_LOCAL /* Old BSD name for PF_LOCAL.  */
#define	PF_INET		2	/* IP protocol family.  */
#define	PF_IMPLINK	3	/* ARPAnet IMP protocol.  */
#define	PF_PUP		4	/* PUP protocols.  */
#define	PF_CHAOS	5	/* MIT Chaos protocols.  */
#define	PF_NS		6	/* Xerox NS protocols.  */
#define	PF_ISO		7	/* ISO protocols.  */
#define	PF_OSI		PF_ISO
#define	PF_ECMA		8	/* ECMA protocols.  */
#define	PF_DATAKIT	9	/* AT&T Datakit protocols.  */
#define	PF_CCITT	10	/* CCITT protocols (X.25 et al).  */
#define	PF_SNA		11	/* IBM SNA protocol.  */
#define	PF_DECnet	12	/* DECnet protocols.  */
#define	PF_DLI		13	/* Direct data link interface.  */
#define	PF_LAT		14	/* DEC Local Area Transport protocol.  */
#define	PF_HYLINK	15	/* NSC Hyperchannel protocol.  */
#define	PF_APPLETALK	16	/* Don't use this.  */
#define	PF_ROUTE	17	/* Internal Routing Protocol.  */
#define	PF_LINK		18	/* Link layer interface.  */
#define	PF_XTP		19	/* eXpress Transfer Protocol (no AF).  */
#define	PF_COIP		20	/* Connection-oriented IP, aka ST II.  */
#define	PF_CNT		21	/* Computer Network Technology.  */
#define PF_RTIP		22	/* Help Identify RTIP packets.  **/
#define	PF_IPX		23	/* Novell Internet Protocol.  */
#define	PF_SIP		24	/* Simple Internet Protocol.  */
#define PF_PIP		25	/* Help Identify PIP packets.  */
#define PF_INET6	26	/* IP version 6.  */
#define	PF_MAX		27

/* Address families.  */
#define	AF_UNSPEC	PF_UNSPEC
#define	AF_LOCAL	PF_LOCAL
#define	AF_UNIX		PF_UNIX
#define	AF_INET		PF_INET
#define	AF_IMPLINK	PF_IMPLINK
#define	AF_PUP		PF_PUP
#define	AF_CHAOS	PF_CHAOS
#define	AF_NS		PF_NS
#define	AF_ISO		PF_ISO
#define	AF_OSI		PF_OSI
#define	AF_ECMA		PF_ECMA
#define	AF_DATAKIT	PF_DATAKIT
#define	AF_CCITT	PF_CCITT
#define	AF_SNA		PF_SNA
#define	AF_DECnet	PF_DECnet
#define	AF_DLI		PF_DLI
#define	AF_LAT		PF_LAT
#define	AF_HYLINK	PF_HYLINK
#define	AF_APPLETALK	PF_APPLETALK
#define	AF_ROUTE	PF_ROUTE
#define	AF_LINK		PF_LINK
#define	pseudo_AF_XTP	PF_XTP
#define	AF_COIP		PF_COIP
#define	AF_CNT		PF_CNT
#define pseudo_AF_RTIP	PF_RTIP
#define	AF_IPX		PF_IPX
#define	AF_SIP		PF_SIP
#define pseudo_AF_PIP	PF_PIP
#define AF_INET6	PF_INET6
#define	AF_MAX		PF_MAX


/* Get the definition of the macro to define the common sockaddr members.  */
#include <sockaddrcom.h>

/* Structure describing a generic socket address.  */
struct sockaddr
  {
    __SOCKADDR_COMMON (sa_);	/* Common data: address family and length.  */
    char sa_data[14];		/* Address data.  */
  };


/* Bits in the FLAGS argument to `send', `recv', et al.  */
enum
  {
    MSG_OOB		= 0x01,	/* Process out-of-band data.  */
    MSG_PEEK		= 0x02,	/* Peek at incoming messages.  */
    MSG_DONTROUTE	= 0x04,	/* Don't use local routing.  */
    MSG_EOR		= 0x08,	/* Data completes record.  */
    MSG_TRUNC		= 0x10,	/* Data discarded before delivery.  */
    MSG_CTRUNC		= 0x20,	/* Control data lost before delivery.  */
    MSG_WAITALL		= 0x40,	/* Wait for full request or error.  */
    MSG_DONTWAIT	= 0x80,	/* This message should be nonblocking.  */
  };


/* Structure describing messages sent by
   `sendmsg' and received by `recvmsg'.  */
struct msghdr
  {
    __ptr_t msg_name;		/* Address to send to/receive from.  */
    size_t msg_namelen;		/* Length of address data.  */

    struct iovec *msg_iov;	/* Vector of data to send/receive into.  */
    size_t msg_iovlen;		/* Number of elements in the vector.  */

    __ptr_t msg_accrights;	/* Access rights information.  */
    size_t msg_accrightslen;	/* Length of access rights information.  */
  };


/* Protocol number used to manipulate socket-level options
   with `getsockopt' and `setsockopt'.  */
#define	SOL_SOCKET	0xffff

/* Socket-level options for `getsockopt' and `setsockopt'.  */
enum
  {
    SO_DEBUG = 0x0001,		/* Record debugging information.  */
    SO_ACCEPTCONN = 0x0002,	/* Accept connections on socket.  */
    SO_REUSEADDR = 0x0004,	/* Allow reuse of local addresses.  */
    SO_KEEPALIVE = 0x0008,	/* Keep connections alive and send
				   SIGPIPE when they die.  */
    SO_DONTROUTE = 0x0010,	/* Don't do local routing.  */
    SO_BROADCAST = 0x0020,	/* Allow transmission of
				   broadcast messages.  */
    SO_USELOOPBACK = 0x0040,	/* Use the software loopback to avoid
				   hardware use when possible.  */
    SO_LINGER = 0x0080,		/* Block on close of a reliable
				   socket to transmit pending data.  */
    SO_OOBINLINE = 0x0100,	/* Receive out-of-band data in-band.  */

    SO_REUSEPORT = 0x0200,	/* Allow local address and port reuse.  */

    SO_SNDBUF = 0x1001,		/* Send buffer size.  */
    SO_RCVBUF = 0x1002,		/* Receive buffer.  */
    SO_SNDLOWAT = 0x1003,	/* Send low-water mark.  */
    SO_RCVLOWAT = 0x1004,	/* Receive low-water mark.  */
    SO_SNDTIMEO = 0x1005,	/* Send timeout.  */
    SO_RCVTIMEO = 0x1006,	/* Receive timeout.  */

    SO_ERROR = 0x1007,		/* Get and clear error status.  */
    SO_STYLE = 0x1008,		/* Get socket connection style.  */
    SO_TYPE = SO_STYLE,		/* Compatible name for SO_STYLE.  */
  };

/* Structure used to manipulate the SO_LINGER option.  */
struct linger
  {
    int l_onoff;		/* Nonzero to linger on close.  */
    int l_linger;		/* Time to linger.  */
  };

__END_DECLS

#endif /* socketbits.h */
Commit	Line	Data
07a4742f	1	/* System-specific socket constants and types. Generic/4.3 BSD version.
5b826692 UD	2	Copyright (C) 1991, 92, 94, 95, 96, 97 Free Software Foundation, Inc.
5b826692 UD	3	This file is part of the GNU C Library.
28f540f4	4
5b826692 UD	5	The GNU C Library is free software; you can redistribute it and/or
	6	modify it under the terms of the GNU Library General Public License as
	7	published by the Free Software Foundation; either version 2 of the
	8	License, or (at your option) any later version.
28f540f4	9
5b826692 UD	10	The GNU C Library is distributed in the hope that it will be useful,
	11	but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	13	Library General Public License for more details.
28f540f4	14
5b826692 UD	15	You should have received a copy of the GNU Library General Public
	16	License along with the GNU C Library; see the file COPYING.LIB. If not,
	17	write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
	18	Boston, MA 02111-1307, USA. */
28f540f4	19
07a4742f	20	#ifndef _SOCKETBITS_H
28f540f4	21
07a4742f	22	#define _SOCKETBITS_H 1
28f540f4 RM	23	#include <features.h>
	24
	25	__BEGIN_DECLS
	26
	27	#define __need_size_t
	28	#include <stddef.h>
	29
	30
	31	/* Types of sockets. */
	32	enum __socket_type
	33	{
	34	SOCK_STREAM = 1, /* Sequenced, reliable, connection-based
	35	byte streams. */
5b826692	36	#define SOCK_STREAM SOCK_STREAM
28f540f4 RM	37	SOCK_DGRAM = 2, /* Connectionless, unreliable datagrams
28f540f4 RM	38	of fixed maximum length. */
5b826692	39	#define SOCK_DGRAM SOCK_DGRAM
28f540f4	40	SOCK_RAW = 3, /* Raw protocol interface. */
5b826692	41	#define SOCK_RAW SOCK_RAW
28f540f4	42	SOCK_RDM = 4, /* Reliably-delivered messages. */
5b826692	43	#define SOCK_RDM SOCK_RDM
28f540f4 RM	44	SOCK_SEQPACKET = 5, /* Sequenced, reliable, connection-based,
28f540f4 RM	45	datagrams of fixed maximum length. */
5b826692	46	#define SOCK_SEQPACKET SOCK_SEQPACKET
28f540f4 RM	47	};
	48
	49	/* Protocol families. */
	50	#define PF_UNSPEC 0 /* Unspecified. */
	51	#define PF_LOCAL 1 /* Local to host (pipes and file-domain). */
	52	#define PF_UNIX PF_LOCAL /* Old BSD name for PF_LOCAL. */
	53	#define PF_INET 2 /* IP protocol family. */
	54	#define PF_IMPLINK 3 /* ARPAnet IMP protocol. */
	55	#define PF_PUP 4 /* PUP protocols. */
	56	#define PF_CHAOS 5 /* MIT Chaos protocols. */
	57	#define PF_NS 6 /* Xerox NS protocols. */
	58	#define PF_ISO 7 /* ISO protocols. */
	59	#define PF_OSI PF_ISO
	60	#define PF_ECMA 8 /* ECMA protocols. */
	61	#define PF_DATAKIT 9 /* AT&T Datakit protocols. */
	62	#define PF_CCITT 10 /* CCITT protocols (X.25 et al). */
	63	#define PF_SNA 11 /* IBM SNA protocol. */
	64	#define PF_DECnet 12 /* DECnet protocols. */
	65	#define PF_DLI 13 /* Direct data link interface. */
	66	#define PF_LAT 14 /* DEC Local Area Transport protocol. */
	67	#define PF_HYLINK 15 /* NSC Hyperchannel protocol. */
	68	#define PF_APPLETALK 16 /* Don't use this. */
	69	#define PF_ROUTE 17 /* Internal Routing Protocol. */
	70	#define PF_LINK 18 /* Link layer interface. */
	71	#define PF_XTP 19 /* eXpress Transfer Protocol (no AF). */
	72	#define PF_COIP 20 /* Connection-oriented IP, aka ST II. */
	73	#define PF_CNT 21 /* Computer Network Technology. */
	74	#define PF_RTIP 22 /* Help Identify RTIP packets. **/
	75	#define PF_IPX 23 /* Novell Internet Protocol. */
	76	#define PF_SIP 24 /* Simple Internet Protocol. */
	77	#define PF_PIP 25 /* Help Identify PIP packets. */
e5508520 MB	78	#define PF_INET6 26 /* IP version 6. */
e5508520 MB	79	#define PF_MAX 27
28f540f4 RM	80
	81	/* Address families. */
	82	#define AF_UNSPEC PF_UNSPEC
	83	#define AF_LOCAL PF_LOCAL
	84	#define AF_UNIX PF_UNIX
	85	#define AF_INET PF_INET
	86	#define AF_IMPLINK PF_IMPLINK
	87	#define AF_PUP PF_PUP
	88	#define AF_CHAOS PF_CHAOS
	89	#define AF_NS PF_NS
	90	#define AF_ISO PF_ISO
	91	#define AF_OSI PF_OSI
	92	#define AF_ECMA PF_ECMA
	93	#define AF_DATAKIT PF_DATAKIT
	94	#define AF_CCITT PF_CCITT
	95	#define AF_SNA PF_SNA
	96	#define AF_DECnet PF_DECnet
	97	#define AF_DLI PF_DLI
	98	#define AF_LAT PF_LAT
	99	#define AF_HYLINK PF_HYLINK
	100	#define AF_APPLETALK PF_APPLETALK
	101	#define AF_ROUTE PF_ROUTE
	102	#define AF_LINK PF_LINK
	103	#define pseudo_AF_XTP PF_XTP
	104	#define AF_COIP PF_COIP
	105	#define AF_CNT PF_CNT
	106	#define pseudo_AF_RTIP PF_RTIP
	107	#define AF_IPX PF_IPX
	108	#define AF_SIP PF_SIP
	109	#define pseudo_AF_PIP PF_PIP
e5508520	110	#define AF_INET6 PF_INET6
28f540f4 RM	111	#define AF_MAX PF_MAX
	112
	113
	114	/* Get the definition of the macro to define the common sockaddr members. */
	115	#include <sockaddrcom.h>
	116
	117	/* Structure describing a generic socket address. */
	118	struct sockaddr
	119	{
	120	__SOCKADDR_COMMON (sa_); /* Common data: address family and length. */
	121	char sa_data[14]; /* Address data. */
	122	};
	123
28f540f4 RM	124
	125	/* Bits in the FLAGS argument to `send', `recv', et al. */
	126	enum
	127	{
	128	MSG_OOB = 0x01, /* Process out-of-band data. */
	129	MSG_PEEK = 0x02, /* Peek at incoming messages. */
	130	MSG_DONTROUTE = 0x04, /* Don't use local routing. */
	131	MSG_EOR = 0x08, /* Data completes record. */
	132	MSG_TRUNC = 0x10, /* Data discarded before delivery. */
	133	MSG_CTRUNC = 0x20, /* Control data lost before delivery. */
	134	MSG_WAITALL = 0x40, /* Wait for full request or error. */
	135	MSG_DONTWAIT = 0x80, /* This message should be nonblocking. */
	136	};
	137
28f540f4 RM	138
	139	/* Structure describing messages sent by
	140	`sendmsg' and received by `recvmsg'. */
	141	struct msghdr
	142	{
	143	__ptr_t msg_name; /* Address to send to/receive from. */
	144	size_t msg_namelen; /* Length of address data. */
	145
	146	struct iovec msg_iov; / Vector of data to send/receive into. */
	147	size_t msg_iovlen; /* Number of elements in the vector. */
	148
	149	__ptr_t msg_accrights; /* Access rights information. */
	150	size_t msg_accrightslen; /* Length of access rights information. */
	151	};
	152
28f540f4 RM	153
	154	/* Protocol number used to manipulate socket-level options
	155	with `getsockopt' and `setsockopt'. */
	156	#define SOL_SOCKET 0xffff
	157
	158	/* Socket-level options for `getsockopt' and `setsockopt'. */
	159	enum
	160	{
	161	SO_DEBUG = 0x0001, /* Record debugging information. */
	162	SO_ACCEPTCONN = 0x0002, /* Accept connections on socket. */
	163	SO_REUSEADDR = 0x0004, /* Allow reuse of local addresses. */
	164	SO_KEEPALIVE = 0x0008, /* Keep connections alive and send
	165	SIGPIPE when they die. */
	166	SO_DONTROUTE = 0x0010, /* Don't do local routing. */
	167	SO_BROADCAST = 0x0020, /* Allow transmission of
	168	broadcast messages. */
	169	SO_USELOOPBACK = 0x0040, /* Use the software loopback to avoid
	170	hardware use when possible. */
	171	SO_LINGER = 0x0080, /* Block on close of a reliable
	172	socket to transmit pending data. */
	173	SO_OOBINLINE = 0x0100, /* Receive out-of-band data in-band. */
	174
	175	SO_REUSEPORT = 0x0200, /* Allow local address and port reuse. */
	176
	177	SO_SNDBUF = 0x1001, /* Send buffer size. */
	178	SO_RCVBUF = 0x1002, /* Receive buffer. */
	179	SO_SNDLOWAT = 0x1003, /* Send low-water mark. */
	180	SO_RCVLOWAT = 0x1004, /* Receive low-water mark. */
	181	SO_SNDTIMEO = 0x1005, /* Send timeout. */
	182	SO_RCVTIMEO = 0x1006, /* Receive timeout. */
	183
	184	SO_ERROR = 0x1007, /* Get and clear error status. */
	185	SO_STYLE = 0x1008, /* Get socket connection style. */
	186	SO_TYPE = SO_STYLE, /* Compatible name for SO_STYLE. */
	187	};
	188
	189	/* Structure used to manipulate the SO_LINGER option. */
	190	struct linger
	191	{
	192	int l_onoff; /* Nonzero to linger on close. */
	193	int l_linger; /* Time to linger. */
	194	};
	195
28f540f4 RM	196	__END_DECLS
28f540f4 RM	197
07a4742f	198	#endif /* socketbits.h */