[thirdparty/glibc.git] / misc / sys / uio.h

/* Copyright (C) 1991-2021 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, see
   <https://www.gnu.org/licenses/>.  */

#ifndef _SYS_UIO_H
#define _SYS_UIO_H	1

#include <features.h>
#include <sys/types.h>
#include <bits/types/struct_iovec.h>
#include <bits/uio_lim.h>
#ifdef __IOV_MAX
# define UIO_MAXIOV __IOV_MAX
#else
# undef UIO_MAXIOV
#endif

__BEGIN_DECLS

/* Read data from file descriptor FD, and put the result in the
   buffers described by IOVEC, which is a vector of COUNT 'struct iovec's.
   The buffers are filled in the order specified.
   Operates just like 'read' (see <unistd.h>) except that data are
   put in IOVEC instead of a contiguous buffer.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern ssize_t readv (int __fd, const struct iovec *__iovec, int __count)
  __wur;

/* Write data pointed by the buffers described by IOVEC, which
   is a vector of COUNT 'struct iovec's, to file descriptor FD.
   The data is written in the order specified.
   Operates just like 'write' (see <unistd.h>) except that the data
   are taken from IOVEC instead of a contiguous buffer.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern ssize_t writev (int __fd, const struct iovec *__iovec, int __count)
  __wur;


#ifdef __USE_MISC
# ifndef __USE_FILE_OFFSET64
/* Read data from file descriptor FD at the given position OFFSET
   without change the file pointer, and put the result in the buffers
   described by IOVEC, which is a vector of COUNT 'struct iovec's.
   The buffers are filled in the order specified.  Operates just like
   'pread' (see <unistd.h>) except that data are put in IOVEC instead
   of a contiguous buffer.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern ssize_t preadv (int __fd, const struct iovec *__iovec, int __count,
		       __off_t __offset) __wur;

/* Write data pointed by the buffers described by IOVEC, which is a
   vector of COUNT 'struct iovec's, to file descriptor FD at the given
   position OFFSET without change the file pointer.  The data is
   written in the order specified.  Operates just like 'pwrite' (see
   <unistd.h>) except that the data are taken from IOVEC instead of a
   contiguous buffer.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern ssize_t pwritev (int __fd, const struct iovec *__iovec, int __count,
			__off_t __offset) __wur;

# else
#  ifdef __REDIRECT
extern ssize_t __REDIRECT (preadv, (int __fd, const struct iovec *__iovec,
				    int __count, __off64_t __offset),
			   preadv64) __wur;
extern ssize_t __REDIRECT (pwritev, (int __fd, const struct iovec *__iovec,
				     int __count, __off64_t __offset),
			   pwritev64) __wur;
#  else
#   define preadv preadv64
#   define pwritev pwritev64
#  endif
# endif

# ifdef __USE_LARGEFILE64
/* Read data from file descriptor FD at the given position OFFSET
   without change the file pointer, and put the result in the buffers
   described by IOVEC, which is a vector of COUNT 'struct iovec's.
   The buffers are filled in the order specified.  Operates just like
   'pread' (see <unistd.h>) except that data are put in IOVEC instead
   of a contiguous buffer.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern ssize_t preadv64 (int __fd, const struct iovec *__iovec, int __count,
			 __off64_t __offset) __wur;

/* Write data pointed by the buffers described by IOVEC, which is a
   vector of COUNT 'struct iovec's, to file descriptor FD at the given
   position OFFSET without change the file pointer.  The data is
   written in the order specified.  Operates just like 'pwrite' (see
   <unistd.h>) except that the data are taken from IOVEC instead of a
   contiguous buffer.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern ssize_t pwritev64 (int __fd, const struct iovec *__iovec, int __count,
			  __off64_t __offset) __wur;
# endif
#endif	/* Use misc.  */


#ifdef __USE_GNU
# ifndef __USE_FILE_OFFSET64
/* Same as preadv but with an additional flag argumenti defined at uio.h.  */
extern ssize_t preadv2 (int __fp, const struct iovec *__iovec, int __count,
			__off_t __offset, int ___flags) __wur;

/* Same as preadv but with an additional flag argument defined at uio.h.  */
extern ssize_t pwritev2 (int __fd, const struct iovec *__iodev, int __count,
			 __off_t __offset, int __flags) __wur;

# else
#  ifdef __REDIRECT
extern ssize_t __REDIRECT (pwritev2, (int __fd, const struct iovec *__iovec,
				      int __count, __off64_t __offset,
				      int __flags),
			   pwritev64v2) __wur;
extern ssize_t __REDIRECT (preadv2, (int __fd, const struct iovec *__iovec,
				     int __count, __off64_t __offset,
				     int __flags),
			   preadv64v2) __wur;
#  else
#   define preadv2 preadv64v2
#   define pwritev2 pwritev64v2
#  endif
# endif

# ifdef __USE_LARGEFILE64
/* Same as preadv but with an additional flag argumenti defined at uio.h.  */
extern ssize_t preadv64v2 (int __fp, const struct iovec *__iovec,
			   int __count, __off64_t __offset,
			   int ___flags) __wur;

/* Same as preadv but with an additional flag argument defined at uio.h.  */
extern ssize_t pwritev64v2 (int __fd, const struct iovec *__iodev,
			    int __count, __off64_t __offset,
			    int __flags) __wur;
# endif
#endif /* Use GNU.  */

__END_DECLS

/* Some operating systems provide system-specific extensions to this
   header.  */
#ifdef __USE_GNU
# include <bits/uio-ext.h>
#endif

#endif /* sys/uio.h */
Commit	Line	Data
2b778ceb	1	/* Copyright (C) 1991-2021 Free Software Foundation, Inc.
2c6fe0bd	2	This file is part of the GNU C Library.
28f540f4	3
2c6fe0bd	4	The GNU C Library is free software; you can redistribute it and/or
41bdb6e2 AJ	5	modify it under the terms of the GNU Lesser General Public
	6	License as published by the Free Software Foundation; either
	7	version 2.1 of the License, or (at your option) any later version.
28f540f4	8
2c6fe0bd UD	9	The GNU C Library is distributed in the hope that it will be useful,
	10	but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41bdb6e2	12	Lesser General Public License for more details.
28f540f4	13
41bdb6e2	14	You should have received a copy of the GNU Lesser General Public
59ba27a6	15	License along with the GNU C Library; if not, see
5a82c748	16	<https://www.gnu.org/licenses/>. */
28f540f4 RM	17
28f540f4 RM	18	#ifndef _SYS_UIO_H
28f540f4	19	#define _SYS_UIO_H 1
5107cf1d	20
28f540f4	21	#include <features.h>
2c6fe0bd	22	#include <sys/types.h>
37f802f8 ZW	23	#include <bits/types/struct_iovec.h>
	24	#include <bits/uio_lim.h>
	25	#ifdef __IOV_MAX
	26	# define UIO_MAXIOV __IOV_MAX
	27	#else
	28	# undef UIO_MAXIOV
	29	#endif
28f540f4	30
84384f5b UD	31	__BEGIN_DECLS
84384f5b UD	32
28f540f4	33	/* Read data from file descriptor FD, and put the result in the
e109c612	34	buffers described by IOVEC, which is a vector of COUNT 'struct iovec's.
28f540f4	35	The buffers are filled in the order specified.
e109c612	36	Operates just like 'read' (see <unistd.h>) except that data are
ce22661a	37	put in IOVEC instead of a contiguous buffer.
2c008571 UD	38
	39	This function is a cancellation point and therefore not marked with
	40	__THROW. */
a784e502	41	extern ssize_t readv (int __fd, const struct iovec *__iovec, int __count)
e109c612	42	__wur;
28f540f4	43
ce22661a	44	/* Write data pointed by the buffers described by IOVEC, which
e109c612	45	is a vector of COUNT 'struct iovec's, to file descriptor FD.
28f540f4	46	The data is written in the order specified.
e109c612	47	Operates just like 'write' (see <unistd.h>) except that the data
ce22661a	48	are taken from IOVEC instead of a contiguous buffer.
2c008571 UD	49
	50	This function is a cancellation point and therefore not marked with
	51	__THROW. */
a784e502	52	extern ssize_t writev (int __fd, const struct iovec *__iovec, int __count)
e109c612 UD	53	__wur;
	54
	55
498afc54	56	#ifdef __USE_MISC
e109c612 UD	57	# ifndef __USE_FILE_OFFSET64
	58	/* Read data from file descriptor FD at the given position OFFSET
	59	without change the file pointer, and put the result in the buffers
	60	described by IOVEC, which is a vector of COUNT 'struct iovec's.
	61	The buffers are filled in the order specified. Operates just like
7f8a28ef	62	'pread' (see <unistd.h>) except that data are put in IOVEC instead
e109c612 UD	63	of a contiguous buffer.
	64
	65	This function is a cancellation point and therefore not marked with
	66	__THROW. */
a784e502	67	extern ssize_t preadv (int __fd, const struct iovec *__iovec, int __count,
e109c612 UD	68	__off_t __offset) __wur;
	69
	70	/* Write data pointed by the buffers described by IOVEC, which is a
	71	vector of COUNT 'struct iovec's, to file descriptor FD at the given
	72	position OFFSET without change the file pointer. The data is
7f8a28ef	73	written in the order specified. Operates just like 'pwrite' (see
e109c612 UD	74	<unistd.h>) except that the data are taken from IOVEC instead of a
	75	contiguous buffer.
	76
	77	This function is a cancellation point and therefore not marked with
	78	__THROW. */
a784e502	79	extern ssize_t pwritev (int __fd, const struct iovec *__iovec, int __count,
e109c612	80	__off_t __offset) __wur;
52bd9381	81
e109c612 UD	82	# else
e109c612 UD	83	# ifdef __REDIRECT
a784e502	84	extern ssize_t __REDIRECT (preadv, (int __fd, const struct iovec *__iovec,
34df851b	85	int __count, __off64_t __offset),
e109c612	86	preadv64) __wur;
a784e502	87	extern ssize_t __REDIRECT (pwritev, (int __fd, const struct iovec *__iovec,
34df851b	88	int __count, __off64_t __offset),
e109c612 UD	89	pwritev64) __wur;
	90	# else
	91	# define preadv preadv64
	92	# define pwritev pwritev64
	93	# endif
	94	# endif
	95
	96	# ifdef __USE_LARGEFILE64
	97	/* Read data from file descriptor FD at the given position OFFSET
	98	without change the file pointer, and put the result in the buffers
	99	described by IOVEC, which is a vector of COUNT 'struct iovec's.
	100	The buffers are filled in the order specified. Operates just like
7f8a28ef	101	'pread' (see <unistd.h>) except that data are put in IOVEC instead
e109c612 UD	102	of a contiguous buffer.
	103
	104	This function is a cancellation point and therefore not marked with
	105	__THROW. */
a784e502	106	extern ssize_t preadv64 (int __fd, const struct iovec *__iovec, int __count,
e109c612 UD	107	__off64_t __offset) __wur;
	108
	109	/* Write data pointed by the buffers described by IOVEC, which is a
	110	vector of COUNT 'struct iovec's, to file descriptor FD at the given
	111	position OFFSET without change the file pointer. The data is
7f8a28ef	112	written in the order specified. Operates just like 'pwrite' (see
e109c612 UD	113	<unistd.h>) except that the data are taken from IOVEC instead of a
	114	contiguous buffer.
	115
	116	This function is a cancellation point and therefore not marked with
	117	__THROW. */
a784e502	118	extern ssize_t pwritev64 (int __fd, const struct iovec *__iovec, int __count,
e109c612 UD	119	__off64_t __offset) __wur;
e109c612 UD	120	# endif
acd7f096	121	#endif /* Use misc. */
28f540f4	122
52bd9381 AZ	123
	124	#ifdef __USE_GNU
	125	# ifndef __USE_FILE_OFFSET64
	126	/* Same as preadv but with an additional flag argumenti defined at uio.h. */
	127	extern ssize_t preadv2 (int __fp, const struct iovec *__iovec, int __count,
	128	__off_t __offset, int ___flags) __wur;
	129
	130	/* Same as preadv but with an additional flag argument defined at uio.h. */
	131	extern ssize_t pwritev2 (int __fd, const struct iovec *__iodev, int __count,
	132	__off_t __offset, int __flags) __wur;
	133
	134	# else
	135	# ifdef __REDIRECT
	136	extern ssize_t __REDIRECT (pwritev2, (int __fd, const struct iovec *__iovec,
	137	int __count, __off64_t __offset,
	138	int __flags),
	139	pwritev64v2) __wur;
	140	extern ssize_t __REDIRECT (preadv2, (int __fd, const struct iovec *__iovec,
	141	int __count, __off64_t __offset,
	142	int __flags),
	143	preadv64v2) __wur;
	144	# else
	145	# define preadv2 preadv64v2
	146	# define pwritev2 pwritev64v2
	147	# endif
	148	# endif
	149
	150	# ifdef __USE_LARGEFILE64
	151	/* Same as preadv but with an additional flag argumenti defined at uio.h. */
	152	extern ssize_t preadv64v2 (int __fp, const struct iovec *__iovec,
	153	int __count, __off64_t __offset,
	154	int ___flags) __wur;
	155
	156	/* Same as preadv but with an additional flag argument defined at uio.h. */
	157	extern ssize_t pwritev64v2 (int __fd, const struct iovec *__iodev,
	158	int __count, __off64_t __offset,
	159	int __flags) __wur;
	160	# endif
	161	#endif /* Use GNU. */
	162
28f540f4 RM	163	__END_DECLS
28f540f4 RM	164
37f802f8 ZW	165	/* Some operating systems provide system-specific extensions to this
	166	header. */
	167	#ifdef __USE_GNU
	168	# include <bits/uio-ext.h>
	169	#endif
	170
28f540f4	171	#endif /* sys/uio.h */