[thirdparty/glibc.git] / socket / sys / socket.h

/* Declarations of socket constants, types, and functions.
   Copyright (C) 1991,92,1994-2001,2003,2005,2007,2008,2012
   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 Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 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
   Lesser General Public License for more details.

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

#ifndef	_SYS_SOCKET_H
#define	_SYS_SOCKET_H	1

#include <features.h>

__BEGIN_DECLS

#include <sys/uio.h>
#define	__need_size_t
#include <stddef.h>
#ifdef __USE_GNU
/* Get the __sigset_t definition.  */
# include <bits/sigset.h>
#endif


/* This operating system-specific header file defines the SOCK_*, PF_*,
   AF_*, MSG_*, SOL_*, and SO_* constants, and the `struct sockaddr',
   `struct msghdr', and `struct linger' types.  */
#include <bits/socket.h>

#ifdef __USE_BSD
/* This is the 4.3 BSD `struct sockaddr' format, which is used as wire
   format in the grotty old 4.3 `talk' protocol.  */
struct osockaddr
  {
    unsigned short int sa_family;
    unsigned char sa_data[14];
  };
#endif

/* The following constants should be used for the second parameter of
   `shutdown'.  */
enum
{
  SHUT_RD = 0,		/* No more receptions.  */
#define SHUT_RD		SHUT_RD
  SHUT_WR,		/* No more transmissions.  */
#define SHUT_WR		SHUT_WR
  SHUT_RDWR		/* No more receptions or transmissions.  */
#define SHUT_RDWR	SHUT_RDWR
};

/* This is the type we use for generic socket address arguments.

   With GCC 2.7 and later, the funky union causes redeclarations or
   uses with any of the listed types to be allowed without complaint.
   G++ 2.7 does not support transparent unions so there we want the
   old-style declaration, too.  */
#if defined __cplusplus || !__GNUC_PREREQ (2, 7) || !defined __USE_GNU
# define __SOCKADDR_ARG		struct sockaddr *__restrict
# define __CONST_SOCKADDR_ARG	const struct sockaddr *
#else
/* Add more `struct sockaddr_AF' types here as necessary.
   These are all the ones I found on NetBSD and Linux.  */
# define __SOCKADDR_ALLTYPES \
  __SOCKADDR_ONETYPE (sockaddr) \
  __SOCKADDR_ONETYPE (sockaddr_at) \
  __SOCKADDR_ONETYPE (sockaddr_ax25) \
  __SOCKADDR_ONETYPE (sockaddr_dl) \
  __SOCKADDR_ONETYPE (sockaddr_eon) \
  __SOCKADDR_ONETYPE (sockaddr_in) \
  __SOCKADDR_ONETYPE (sockaddr_in6) \
  __SOCKADDR_ONETYPE (sockaddr_inarp) \
  __SOCKADDR_ONETYPE (sockaddr_ipx) \
  __SOCKADDR_ONETYPE (sockaddr_iso) \
  __SOCKADDR_ONETYPE (sockaddr_ns) \
  __SOCKADDR_ONETYPE (sockaddr_un) \
  __SOCKADDR_ONETYPE (sockaddr_x25)

# define __SOCKADDR_ONETYPE(type) struct type *__restrict __##type##__;
typedef union { __SOCKADDR_ALLTYPES
	      } __SOCKADDR_ARG __attribute__ ((__transparent_union__));
# undef __SOCKADDR_ONETYPE
# define __SOCKADDR_ONETYPE(type) const struct type *__restrict __##type##__;
typedef union { __SOCKADDR_ALLTYPES
	      } __CONST_SOCKADDR_ARG __attribute__ ((__transparent_union__));
# undef __SOCKADDR_ONETYPE
#endif


/* Create a new socket of type TYPE in domain DOMAIN, using
   protocol PROTOCOL.  If PROTOCOL is zero, one is chosen automatically.
   Returns a file descriptor for the new socket, or -1 for errors.  */
extern int socket (int __domain, int __type, int __protocol) __THROW;

/* Create two new sockets, of type TYPE in domain DOMAIN and using
   protocol PROTOCOL, which are connected to each other, and put file
   descriptors for them in FDS[0] and FDS[1].  If PROTOCOL is zero,
   one will be chosen automatically.  Returns 0 on success, -1 for errors.  */
extern int socketpair (int __domain, int __type, int __protocol,
		       int __fds[2]) __THROW;

/* Give the socket FD the local address ADDR (which is LEN bytes long).  */
extern int bind (int __fd, __CONST_SOCKADDR_ARG __addr, socklen_t __len)
     __THROW;

/* Put the local address of FD into *ADDR and its length in *LEN.  */
extern int getsockname (int __fd, __SOCKADDR_ARG __addr,
			socklen_t *__restrict __len) __THROW;

/* Open a connection on socket FD to peer at ADDR (which LEN bytes long).
   For connectionless socket types, just set the default address to send to
   and the only address from which to accept transmissions.
   Return 0 on success, -1 for errors.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern int connect (int __fd, __CONST_SOCKADDR_ARG __addr, socklen_t __len);

/* Put the address of the peer connected to socket FD into *ADDR
   (which is *LEN bytes long), and its actual length into *LEN.  */
extern int getpeername (int __fd, __SOCKADDR_ARG __addr,
			socklen_t *__restrict __len) __THROW;


/* Send N bytes of BUF to socket FD.  Returns the number sent or -1.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern ssize_t send (int __fd, const void *__buf, size_t __n, int __flags);

/* Read N bytes into BUF from socket FD.
   Returns the number read or -1 for errors.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern ssize_t recv (int __fd, void *__buf, size_t __n, int __flags);

/* Send N bytes of BUF on socket FD to peer at address ADDR (which is
   ADDR_LEN bytes long).  Returns the number sent, or -1 for errors.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern ssize_t sendto (int __fd, const void *__buf, size_t __n,
		       int __flags, __CONST_SOCKADDR_ARG __addr,
		       socklen_t __addr_len);

/* Read N bytes into BUF through socket FD.
   If ADDR is not NULL, fill in *ADDR_LEN bytes of it with tha address of
   the sender, and store the actual size of the address in *ADDR_LEN.
   Returns the number of bytes read or -1 for errors.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern ssize_t recvfrom (int __fd, void *__restrict __buf, size_t __n,
			 int __flags, __SOCKADDR_ARG __addr,
			 socklen_t *__restrict __addr_len);


/* Send a message described MESSAGE on socket FD.
   Returns the number of bytes sent, or -1 for errors.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern ssize_t sendmsg (int __fd, const struct msghdr *__message,
			int __flags);

/* Receive a message as described by MESSAGE from socket FD.
   Returns the number of bytes read or -1 for errors.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern ssize_t recvmsg (int __fd, struct msghdr *__message, int __flags);


/* Put the current value for socket FD's option OPTNAME at protocol level LEVEL
   into OPTVAL (which is *OPTLEN bytes long), and set *OPTLEN to the value's
   actual length.  Returns 0 on success, -1 for errors.  */
extern int getsockopt (int __fd, int __level, int __optname,
		       void *__restrict __optval,
		       socklen_t *__restrict __optlen) __THROW;

/* Set socket FD's option OPTNAME at protocol level LEVEL
   to *OPTVAL (which is OPTLEN bytes long).
   Returns 0 on success, -1 for errors.  */
extern int setsockopt (int __fd, int __level, int __optname,
		       const void *__optval, socklen_t __optlen) __THROW;


/* Prepare to accept connections on socket FD.
   N connection requests will be queued before further requests are refused.
   Returns 0 on success, -1 for errors.  */
extern int listen (int __fd, int __n) __THROW;

/* Await a connection on socket FD.
   When a connection arrives, open a new socket to communicate with it,
   set *ADDR (which is *ADDR_LEN bytes long) to the address of the connecting
   peer and *ADDR_LEN to the address's actual length, and return the
   new socket's descriptor, or -1 for errors.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern int accept (int __fd, __SOCKADDR_ARG __addr,
		   socklen_t *__restrict __addr_len);

#ifdef __USE_GNU
/* Similar to 'accept' but takes an additional parameter to specify flags.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern int accept4 (int __fd, __SOCKADDR_ARG __addr,
		    socklen_t *__restrict __addr_len, int __flags);
#endif

/* Shut down all or part of the connection open on socket FD.
   HOW determines what to shut down:
     SHUT_RD   = No more receptions;
     SHUT_WR   = No more transmissions;
     SHUT_RDWR = No more receptions or transmissions.
   Returns 0 on success, -1 for errors.  */
extern int shutdown (int __fd, int __how) __THROW;


#ifdef __USE_XOPEN2K
/* Determine wheter socket is at a out-of-band mark.  */
extern int sockatmark (int __fd) __THROW;
#endif


#ifdef __USE_MISC
/* FDTYPE is S_IFSOCK or another S_IF* macro defined in <sys/stat.h>;
   returns 1 if FD is open on an object of the indicated type, 0 if not,
   or -1 for errors (setting errno).  */
extern int isfdtype (int __fd, int __fdtype) __THROW;
#endif


/* Define some macros helping to catch buffer overflows.  */
#if __USE_FORTIFY_LEVEL > 0 && defined __extern_always_inline
# include <bits/socket2.h>
#endif

__END_DECLS

#endif /* sys/socket.h */
Commit	Line	Data
07a4742f	1	/* Declarations of socket constants, types, and functions.
a784e502	2	Copyright (C) 1991,92,1994-2001,2003,2005,2007,2008,2012
de1c3ebb	3	Free Software Foundation, Inc.
54d79e99 UD	4	This file is part of the GNU C Library.
	5
	6	The GNU C Library is free software; you can redistribute it and/or
41bdb6e2 AJ	7	modify it under the terms of the GNU Lesser General Public
	8	License as published by the Free Software Foundation; either
	9	version 2.1 of the License, or (at your option) any later version.
54d79e99 UD	10
	11	The GNU C Library is distributed in the hope that it will be useful,
	12	but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41bdb6e2	14	Lesser General Public License for more details.
54d79e99	15
41bdb6e2 AJ	16	You should have received a copy of the GNU Lesser General Public
	17	License along with the GNU C Library; if not, write to the Free
	18	Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
	19	02111-1307 USA. */
0e3426bb RM	20
0e3426bb RM	21	#ifndef _SYS_SOCKET_H
0e3426bb	22	#define _SYS_SOCKET_H 1
5107cf1d	23
0e3426bb RM	24	#include <features.h>
	25
	26	__BEGIN_DECLS
	27
6f0ea379	28	#include <sys/uio.h>
0e3426bb RM	29	#define __need_size_t
0e3426bb RM	30	#include <stddef.h>
bdcebfc4 UD	31	#ifdef __USE_GNU
	32	/* Get the __sigset_t definition. */
	33	# include <bits/sigset.h>
	34	#endif
0e3426bb RM	35
0e3426bb RM	36
07a4742f RM	37	/* This operating system-specific header file defines the SOCK_, PF_,
	38	AF_, MSG_, SOL_, and SO_ constants, and the `struct sockaddr',
	39	`struct msghdr', and `struct linger' types. */
5107cf1d	40	#include <bits/socket.h>
07a4742f	41
2064087b RM	42	#ifdef __USE_BSD
	43	/* This is the 4.3 BSD `struct sockaddr' format, which is used as wire
	44	format in the grotty old 4.3 `talk' protocol. */
	45	struct osockaddr
	46	{
	47	unsigned short int sa_family;
	48	unsigned char sa_data[14];
	49	};
	50	#endif
0e3426bb	51
3ee12f2b UD	52	/* The following constants should be used for the second parameter of
	53	`shutdown'. */
	54	enum
	55	{
	56	SHUT_RD = 0, /* No more receptions. */
	57	#define SHUT_RD SHUT_RD
	58	SHUT_WR, /* No more transmissions. */
	59	#define SHUT_WR SHUT_WR
	60	SHUT_RDWR /* No more receptions or transmissions. */
	61	#define SHUT_RDWR SHUT_RDWR
	62	};
	63
0e3426bb RM	64	/* This is the type we use for generic socket address arguments.
0e3426bb RM	65
a3e59be8 UD	66	With GCC 2.7 and later, the funky union causes redeclarations or
	67	uses with any of the listed types to be allowed without complaint.
	68	G++ 2.7 does not support transparent unions so there we want the
	69	old-style declaration, too. */
6f0ea379	70	#if defined __cplusplus \|\| !__GNUC_PREREQ (2, 7) \|\| !defined __USE_GNU
98cbe360	71	# define __SOCKADDR_ARG struct sockaddr *__restrict
a784e502	72	# define __CONST_SOCKADDR_ARG const struct sockaddr *
0e3426bb RM	73	#else
	74	/* Add more `struct sockaddr_AF' types here as necessary.
	75	These are all the ones I found on NetBSD and Linux. */
55c14926	76	# define __SOCKADDR_ALLTYPES \
0e3426bb RM	77	__SOCKADDR_ONETYPE (sockaddr) \
	78	__SOCKADDR_ONETYPE (sockaddr_at) \
	79	__SOCKADDR_ONETYPE (sockaddr_ax25) \
	80	__SOCKADDR_ONETYPE (sockaddr_dl) \
	81	__SOCKADDR_ONETYPE (sockaddr_eon) \
	82	__SOCKADDR_ONETYPE (sockaddr_in) \
	83	__SOCKADDR_ONETYPE (sockaddr_in6) \
	84	__SOCKADDR_ONETYPE (sockaddr_inarp) \
	85	__SOCKADDR_ONETYPE (sockaddr_ipx) \
	86	__SOCKADDR_ONETYPE (sockaddr_iso) \
	87	__SOCKADDR_ONETYPE (sockaddr_ns) \
	88	__SOCKADDR_ONETYPE (sockaddr_un) \
	89	__SOCKADDR_ONETYPE (sockaddr_x25)
	90
98cbe360	91	# define __SOCKADDR_ONETYPE(type) struct type *__restrict __##type##__;
0e3426bb RM	92	typedef union { __SOCKADDR_ALLTYPES
0e3426bb RM	93	} __SOCKADDR_ARG __attribute__ ((__transparent_union__));
55c14926	94	# undef __SOCKADDR_ONETYPE
a784e502	95	# define __SOCKADDR_ONETYPE(type) const struct type *__restrict __##type##__;
0e3426bb RM	96	typedef union { __SOCKADDR_ALLTYPES
0e3426bb RM	97	} __CONST_SOCKADDR_ARG __attribute__ ((__transparent_union__));
55c14926	98	# undef __SOCKADDR_ONETYPE
0e3426bb RM	99	#endif
	100
	101
	102	/* Create a new socket of type TYPE in domain DOMAIN, using
	103	protocol PROTOCOL. If PROTOCOL is zero, one is chosen automatically.
	104	Returns a file descriptor for the new socket, or -1 for errors. */
ef5d6645	105	extern int socket (int __domain, int __type, int __protocol) __THROW;
0e3426bb RM	106
	107	/* Create two new sockets, of type TYPE in domain DOMAIN and using
	108	protocol PROTOCOL, which are connected to each other, and put file
	109	descriptors for them in FDS[0] and FDS[1]. If PROTOCOL is zero,
	110	one will be chosen automatically. Returns 0 on success, -1 for errors. */
ef5d6645 UD	111	extern int socketpair (int __domain, int __type, int __protocol,
ef5d6645 UD	112	int __fds[2]) __THROW;
0e3426bb RM	113
0e3426bb RM	114	/* Give the socket FD the local address ADDR (which is LEN bytes long). */
ef5d6645 UD	115	extern int bind (int __fd, __CONST_SOCKADDR_ARG __addr, socklen_t __len)
ef5d6645 UD	116	__THROW;
0e3426bb RM	117
0e3426bb RM	118	/* Put the local address of FD into ADDR and its length in LEN. */
98cbe360 UD	119	extern int getsockname (int __fd, __SOCKADDR_ARG __addr,
98cbe360 UD	120	socklen_t *__restrict __len) __THROW;
0e3426bb RM	121
	122	/* Open a connection on socket FD to peer at ADDR (which LEN bytes long).
	123	For connectionless socket types, just set the default address to send to
	124	and the only address from which to accept transmissions.
2c008571 UD	125	Return 0 on success, -1 for errors.
	126
	127	This function is a cancellation point and therefore not marked with
	128	__THROW. */
	129	extern int connect (int __fd, __CONST_SOCKADDR_ARG __addr, socklen_t __len);
0e3426bb RM	130
	131	/* Put the address of the peer connected to socket FD into *ADDR
	132	(which is LEN bytes long), and its actual length into LEN. */
98cbe360 UD	133	extern int getpeername (int __fd, __SOCKADDR_ARG __addr,
98cbe360 UD	134	socklen_t *__restrict __len) __THROW;
0e3426bb RM	135
0e3426bb RM	136
2c008571 UD	137	/* Send N bytes of BUF to socket FD. Returns the number sent or -1.
	138
	139	This function is a cancellation point and therefore not marked with
	140	__THROW. */
a784e502	141	extern ssize_t send (int __fd, const void *__buf, size_t __n, int __flags);
0e3426bb RM	142
0e3426bb RM	143	/* Read N bytes into BUF from socket FD.
2c008571 UD	144	Returns the number read or -1 for errors.
	145
	146	This function is a cancellation point and therefore not marked with
	147	__THROW. */
	148	extern ssize_t recv (int __fd, void *__buf, size_t __n, int __flags);
0e3426bb RM	149
0e3426bb RM	150	/* Send N bytes of BUF on socket FD to peer at address ADDR (which is
2c008571 UD	151	ADDR_LEN bytes long). Returns the number sent, or -1 for errors.
	152
	153	This function is a cancellation point and therefore not marked with
	154	__THROW. */
a784e502	155	extern ssize_t sendto (int __fd, const void *__buf, size_t __n,
c2063191	156	int __flags, __CONST_SOCKADDR_ARG __addr,
2c008571	157	socklen_t __addr_len);
0e3426bb RM	158
	159	/* Read N bytes into BUF through socket FD.
	160	If ADDR is not NULL, fill in *ADDR_LEN bytes of it with tha address of
	161	the sender, and store the actual size of the address in *ADDR_LEN.
2c008571 UD	162	Returns the number of bytes read or -1 for errors.
	163
	164	This function is a cancellation point and therefore not marked with
	165	__THROW. */
	166	extern ssize_t recvfrom (int __fd, void *__restrict __buf, size_t __n,
	167	int __flags, __SOCKADDR_ARG __addr,
	168	socklen_t *__restrict __addr_len);
0e3426bb RM	169
	170
	171	/* Send a message described MESSAGE on socket FD.
2c008571 UD	172	Returns the number of bytes sent, or -1 for errors.
	173
	174	This function is a cancellation point and therefore not marked with
	175	__THROW. */
a784e502	176	extern ssize_t sendmsg (int __fd, const struct msghdr *__message,
2c008571	177	int __flags);
0e3426bb RM	178
0e3426bb RM	179	/* Receive a message as described by MESSAGE from socket FD.
2c008571 UD	180	Returns the number of bytes read or -1 for errors.
	181
	182	This function is a cancellation point and therefore not marked with
	183	__THROW. */
	184	extern ssize_t recvmsg (int __fd, struct msghdr *__message, int __flags);
0e3426bb RM	185
	186
	187	/* Put the current value for socket FD's option OPTNAME at protocol level LEVEL
	188	into OPTVAL (which is OPTLEN bytes long), and set OPTLEN to the value's
	189	actual length. Returns 0 on success, -1 for errors. */
ef5d6645	190	extern int getsockopt (int __fd, int __level, int __optname,
98cbe360 UD	191	void *__restrict __optval,
98cbe360 UD	192	socklen_t *__restrict __optlen) __THROW;
0e3426bb RM	193
	194	/* Set socket FD's option OPTNAME at protocol level LEVEL
	195	to *OPTVAL (which is OPTLEN bytes long).
	196	Returns 0 on success, -1 for errors. */
ef5d6645	197	extern int setsockopt (int __fd, int __level, int __optname,
a784e502	198	const void *__optval, socklen_t __optlen) __THROW;
0e3426bb RM	199
	200
	201	/* Prepare to accept connections on socket FD.
	202	N connection requests will be queued before further requests are refused.
	203	Returns 0 on success, -1 for errors. */
6f0ea379	204	extern int listen (int __fd, int __n) __THROW;
0e3426bb RM	205
	206	/* Await a connection on socket FD.
	207	When a connection arrives, open a new socket to communicate with it,
	208	set ADDR (which is ADDR_LEN bytes long) to the address of the connecting
	209	peer and *ADDR_LEN to the address's actual length, and return the
2c008571 UD	210	new socket's descriptor, or -1 for errors.
	211
	212	This function is a cancellation point and therefore not marked with
	213	__THROW. */
98cbe360	214	extern int accept (int __fd, __SOCKADDR_ARG __addr,
2c008571	215	socklen_t *__restrict __addr_len);
0e3426bb	216
f93fc0b7 UD	217	#ifdef __USE_GNU
	218	/* Similar to 'accept' but takes an additional parameter to specify flags.
	219
	220	This function is a cancellation point and therefore not marked with
	221	__THROW. */
	222	extern int accept4 (int __fd, __SOCKADDR_ARG __addr,
	223	socklen_t *__restrict __addr_len, int __flags);
	224	#endif
	225
0e3426bb RM	226	/* Shut down all or part of the connection open on socket FD.
0e3426bb RM	227	HOW determines what to shut down:
3ee12f2b UD	228	SHUT_RD = No more receptions;
	229	SHUT_WR = No more transmissions;
	230	SHUT_RDWR = No more receptions or transmissions.
0e3426bb	231	Returns 0 on success, -1 for errors. */
ef5d6645	232	extern int shutdown (int __fd, int __how) __THROW;
0e3426bb RM	233
0e3426bb RM	234
b5041719 UD	235	#ifdef __USE_XOPEN2K
	236	/* Determine wheter socket is at a out-of-band mark. */
	237	extern int sockatmark (int __fd) __THROW;
	238	#endif
	239
	240
6f0ea379	241	#ifdef __USE_MISC
07a4742f RM	242	/* FDTYPE is S_IFSOCK or another S_IF* macro defined in <sys/stat.h>;
	243	returns 1 if FD is open on an object of the indicated type, 0 if not,
	244	or -1 for errors (setting errno). */
ef5d6645	245	extern int isfdtype (int __fd, int __fdtype) __THROW;
6f0ea379	246	#endif
07a4742f	247
553cc5f9 UD	248
553cc5f9 UD	249	/* Define some macros helping to catch buffer overflows. */
de1c3ebb	250	#if __USE_FORTIFY_LEVEL > 0 && defined __extern_always_inline
553cc5f9 UD	251	# include <bits/socket2.h>
	252	#endif
	253
0e3426bb RM	254	__END_DECLS
	255
	256	#endif /* sys/socket.h */