Blame rt/aio.h

Packit Service 82fcde
/* Copyright (C) 1996-2018 Free Software Foundation, Inc.
Packit Service 82fcde
   This file is part of the GNU C Library.
Packit Service 82fcde
Packit Service 82fcde
   The GNU C Library is free software; you can redistribute it and/or
Packit Service 82fcde
   modify it under the terms of the GNU Lesser General Public
Packit Service 82fcde
   License as published by the Free Software Foundation; either
Packit Service 82fcde
   version 2.1 of the License, or (at your option) any later version.
Packit Service 82fcde
Packit Service 82fcde
   The GNU C Library is distributed in the hope that it will be useful,
Packit Service 82fcde
   but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service 82fcde
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit Service 82fcde
   Lesser General Public License for more details.
Packit Service 82fcde
Packit Service 82fcde
   You should have received a copy of the GNU Lesser General Public
Packit Service 82fcde
   License along with the GNU C Library; if not, see
Packit Service 82fcde
   <http://www.gnu.org/licenses/>.  */
Packit Service 82fcde
Packit Service 82fcde
/*
Packit Service 82fcde
 * ISO/IEC 9945-1:1996 6.7: Asynchronous Input and Output
Packit Service 82fcde
 */
Packit Service 82fcde
Packit Service 82fcde
#ifndef _AIO_H
Packit Service 82fcde
#define _AIO_H	1
Packit Service 82fcde
Packit Service 82fcde
#include <features.h>
Packit Service 82fcde
#include <sys/types.h>
Packit Service 82fcde
#include <bits/types/sigevent_t.h>
Packit Service 82fcde
#include <bits/sigevent-consts.h>
Packit Service 82fcde
#include <bits/types/struct_timespec.h>
Packit Service 82fcde
Packit Service 82fcde
__BEGIN_DECLS
Packit Service 82fcde
Packit Service 82fcde
/* Asynchronous I/O control block.  */
Packit Service 82fcde
struct aiocb
Packit Service 82fcde
{
Packit Service 82fcde
  int aio_fildes;		/* File desriptor.  */
Packit Service 82fcde
  int aio_lio_opcode;		/* Operation to be performed.  */
Packit Service 82fcde
  int aio_reqprio;		/* Request priority offset.  */
Packit Service 82fcde
  volatile void *aio_buf;	/* Location of buffer.  */
Packit Service 82fcde
  size_t aio_nbytes;		/* Length of transfer.  */
Packit Service 82fcde
  struct sigevent aio_sigevent;	/* Signal number and value.  */
Packit Service 82fcde
Packit Service 82fcde
  /* Internal members.  */
Packit Service 82fcde
  struct aiocb *__next_prio;
Packit Service 82fcde
  int __abs_prio;
Packit Service 82fcde
  int __policy;
Packit Service 82fcde
  int __error_code;
Packit Service 82fcde
  __ssize_t __return_value;
Packit Service 82fcde
Packit Service 82fcde
#ifndef __USE_FILE_OFFSET64
Packit Service 82fcde
  __off_t aio_offset;		/* File offset.  */
Packit Service 82fcde
  char __pad[sizeof (__off64_t) - sizeof (__off_t)];
Packit Service 82fcde
#else
Packit Service 82fcde
  __off64_t aio_offset;		/* File offset.  */
Packit Service 82fcde
#endif
Packit Service 82fcde
  char __glibc_reserved[32];
Packit Service 82fcde
};
Packit Service 82fcde
Packit Service 82fcde
/* The same for the 64bit offsets.  Please note that the members aio_fildes
Packit Service 82fcde
   to __return_value have to be the same in aiocb and aiocb64.  */
Packit Service 82fcde
#ifdef __USE_LARGEFILE64
Packit Service 82fcde
struct aiocb64
Packit Service 82fcde
{
Packit Service 82fcde
  int aio_fildes;		/* File desriptor.  */
Packit Service 82fcde
  int aio_lio_opcode;		/* Operation to be performed.  */
Packit Service 82fcde
  int aio_reqprio;		/* Request priority offset.  */
Packit Service 82fcde
  volatile void *aio_buf;	/* Location of buffer.  */
Packit Service 82fcde
  size_t aio_nbytes;		/* Length of transfer.  */
Packit Service 82fcde
  struct sigevent aio_sigevent;	/* Signal number and value.  */
Packit Service 82fcde
Packit Service 82fcde
  /* Internal members.  */
Packit Service 82fcde
  struct aiocb *__next_prio;
Packit Service 82fcde
  int __abs_prio;
Packit Service 82fcde
  int __policy;
Packit Service 82fcde
  int __error_code;
Packit Service 82fcde
  __ssize_t __return_value;
Packit Service 82fcde
Packit Service 82fcde
  __off64_t aio_offset;		/* File offset.  */
Packit Service 82fcde
  char __glibc_reserved[32];
Packit Service 82fcde
};
Packit Service 82fcde
#endif
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
#ifdef __USE_GNU
Packit Service 82fcde
/* To customize the implementation one can use the following struct.
Packit Service 82fcde
   This implementation follows the one in Irix.  */
Packit Service 82fcde
struct aioinit
Packit Service 82fcde
  {
Packit Service 82fcde
    int aio_threads;		/* Maximal number of threads.  */
Packit Service 82fcde
    int aio_num;		/* Number of expected simultanious requests. */
Packit Service 82fcde
    int aio_locks;		/* Not used.  */
Packit Service 82fcde
    int aio_usedba;		/* Not used.  */
Packit Service 82fcde
    int aio_debug;		/* Not used.  */
Packit Service 82fcde
    int aio_numusers;		/* Not used.  */
Packit Service 82fcde
    int aio_idle_time;		/* Number of seconds before idle thread
Packit Service 82fcde
				   terminates.  */
Packit Service 82fcde
    int aio_reserved;
Packit Service 82fcde
  };
Packit Service 82fcde
#endif
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
/* Return values of cancelation function.  */
Packit Service 82fcde
enum
Packit Service 82fcde
{
Packit Service 82fcde
  AIO_CANCELED,
Packit Service 82fcde
#define AIO_CANCELED AIO_CANCELED
Packit Service 82fcde
  AIO_NOTCANCELED,
Packit Service 82fcde
#define AIO_NOTCANCELED AIO_NOTCANCELED
Packit Service 82fcde
  AIO_ALLDONE
Packit Service 82fcde
#define AIO_ALLDONE AIO_ALLDONE
Packit Service 82fcde
};
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
/* Operation codes for `aio_lio_opcode'.  */
Packit Service 82fcde
enum
Packit Service 82fcde
{
Packit Service 82fcde
  LIO_READ,
Packit Service 82fcde
#define LIO_READ LIO_READ
Packit Service 82fcde
  LIO_WRITE,
Packit Service 82fcde
#define LIO_WRITE LIO_WRITE
Packit Service 82fcde
  LIO_NOP
Packit Service 82fcde
#define LIO_NOP LIO_NOP
Packit Service 82fcde
};
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
/* Synchronization options for `lio_listio' function.  */
Packit Service 82fcde
enum
Packit Service 82fcde
{
Packit Service 82fcde
  LIO_WAIT,
Packit Service 82fcde
#define LIO_WAIT LIO_WAIT
Packit Service 82fcde
  LIO_NOWAIT
Packit Service 82fcde
#define LIO_NOWAIT LIO_NOWAIT
Packit Service 82fcde
};
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
/* Allow user to specify optimization.  */
Packit Service 82fcde
#ifdef __USE_GNU
Packit Service 82fcde
extern void aio_init (const struct aioinit *__init) __THROW __nonnull ((1));
Packit Service 82fcde
#endif
Packit Service 82fcde
Packit Service 82fcde
Packit Service 82fcde
#ifndef __USE_FILE_OFFSET64
Packit Service 82fcde
/* Enqueue read request for given number of bytes and the given priority.  */
Packit Service 82fcde
extern int aio_read (struct aiocb *__aiocbp) __THROW __nonnull ((1));
Packit Service 82fcde
/* Enqueue write request for given number of bytes and the given priority.  */
Packit Service 82fcde
extern int aio_write (struct aiocb *__aiocbp) __THROW __nonnull ((1));
Packit Service 82fcde
Packit Service 82fcde
/* Initiate list of I/O requests.  */
Packit Service 82fcde
extern int lio_listio (int __mode,
Packit Service 82fcde
		       struct aiocb *const __list[__restrict_arr],
Packit Service 82fcde
		       int __nent, struct sigevent *__restrict __sig)
Packit Service 82fcde
  __THROW __nonnull ((2));
Packit Service 82fcde
Packit Service 82fcde
/* Retrieve error status associated with AIOCBP.  */
Packit Service 82fcde
extern int aio_error (const struct aiocb *__aiocbp) __THROW __nonnull ((1));
Packit Service 82fcde
/* Return status associated with AIOCBP.  */
Packit Service 82fcde
extern __ssize_t aio_return (struct aiocb *__aiocbp) __THROW __nonnull ((1));
Packit Service 82fcde
Packit Service 82fcde
/* Try to cancel asynchronous I/O requests outstanding against file
Packit Service 82fcde
   descriptor FILDES.  */
Packit Service 82fcde
extern int aio_cancel (int __fildes, struct aiocb *__aiocbp) __THROW;
Packit Service 82fcde
Packit Service 82fcde
/* Suspend calling thread until at least one of the asynchronous I/O
Packit Service 82fcde
   operations referenced by LIST has completed.
Packit Service 82fcde
Packit Service 82fcde
   This function is a cancellation point and therefore not marked with
Packit Service 82fcde
   __THROW.  */
Packit Service 82fcde
extern int aio_suspend (const struct aiocb *const __list[], int __nent,
Packit Service 82fcde
			const struct timespec *__restrict __timeout)
Packit Service 82fcde
  __nonnull ((1));
Packit Service 82fcde
Packit Service 82fcde
/* Force all operations associated with file desriptor described by
Packit Service 82fcde
   `aio_fildes' member of AIOCBP.  */
Packit Service 82fcde
extern int aio_fsync (int __operation, struct aiocb *__aiocbp)
Packit Service 82fcde
  __THROW __nonnull ((2));
Packit Service 82fcde
#else
Packit Service 82fcde
# ifdef __REDIRECT_NTH
Packit Service 82fcde
extern int __REDIRECT_NTH (aio_read, (struct aiocb *__aiocbp), aio_read64)
Packit Service 82fcde
  __nonnull ((1));
Packit Service 82fcde
extern int __REDIRECT_NTH (aio_write, (struct aiocb *__aiocbp), aio_write64)
Packit Service 82fcde
  __nonnull ((1));
Packit Service 82fcde
Packit Service 82fcde
extern int __REDIRECT_NTH (lio_listio,
Packit Service 82fcde
			   (int __mode,
Packit Service 82fcde
			    struct aiocb *const __list[__restrict_arr],
Packit Service 82fcde
			    int __nent, struct sigevent *__restrict __sig),
Packit Service 82fcde
			   lio_listio64) __nonnull ((2));
Packit Service 82fcde
Packit Service 82fcde
extern int __REDIRECT_NTH (aio_error, (const struct aiocb *__aiocbp),
Packit Service 82fcde
			   aio_error64) __nonnull ((1));
Packit Service 82fcde
extern __ssize_t __REDIRECT_NTH (aio_return, (struct aiocb *__aiocbp),
Packit Service 82fcde
				 aio_return64) __nonnull ((1));
Packit Service 82fcde
Packit Service 82fcde
extern int __REDIRECT_NTH (aio_cancel,
Packit Service 82fcde
			   (int __fildes, struct aiocb *__aiocbp),
Packit Service 82fcde
			   aio_cancel64);
Packit Service 82fcde
Packit Service 82fcde
extern int __REDIRECT_NTH (aio_suspend,
Packit Service 82fcde
			   (const struct aiocb *const __list[], int __nent,
Packit Service 82fcde
			    const struct timespec *__restrict __timeout),
Packit Service 82fcde
			   aio_suspend64) __nonnull ((1));
Packit Service 82fcde
Packit Service 82fcde
extern int __REDIRECT_NTH (aio_fsync,
Packit Service 82fcde
			   (int __operation, struct aiocb *__aiocbp),
Packit Service 82fcde
			   aio_fsync64) __nonnull ((2));
Packit Service 82fcde
Packit Service 82fcde
# else
Packit Service 82fcde
#  define aio_read aio_read64
Packit Service 82fcde
#  define aio_write aio_write64
Packit Service 82fcde
#  define lio_listio lio_listio64
Packit Service 82fcde
#  define aio_error aio_error64
Packit Service 82fcde
#  define aio_return aio_return64
Packit Service 82fcde
#  define aio_cancel aio_cancel64
Packit Service 82fcde
#  define aio_suspend aio_suspend64
Packit Service 82fcde
#  define aio_fsync aio_fsync64
Packit Service 82fcde
# endif
Packit Service 82fcde
#endif
Packit Service 82fcde
Packit Service 82fcde
#ifdef __USE_LARGEFILE64
Packit Service 82fcde
extern int aio_read64 (struct aiocb64 *__aiocbp) __THROW __nonnull ((1));
Packit Service 82fcde
extern int aio_write64 (struct aiocb64 *__aiocbp) __THROW __nonnull ((1));
Packit Service 82fcde
Packit Service 82fcde
extern int lio_listio64 (int __mode,
Packit Service 82fcde
			 struct aiocb64 *const __list[__restrict_arr],
Packit Service 82fcde
			 int __nent, struct sigevent *__restrict __sig)
Packit Service 82fcde
  __THROW __nonnull ((2));
Packit Service 82fcde
Packit Service 82fcde
extern int aio_error64 (const struct aiocb64 *__aiocbp)
Packit Service 82fcde
  __THROW __nonnull ((1));
Packit Service 82fcde
extern __ssize_t aio_return64 (struct aiocb64 *__aiocbp)
Packit Service 82fcde
  __THROW __nonnull ((1));
Packit Service 82fcde
Packit Service 82fcde
extern int aio_cancel64 (int __fildes, struct aiocb64 *__aiocbp) __THROW;
Packit Service 82fcde
Packit Service 82fcde
extern int aio_suspend64 (const struct aiocb64 *const __list[], int __nent,
Packit Service 82fcde
			  const struct timespec *__restrict __timeout)
Packit Service 82fcde
  __THROW __nonnull ((1));
Packit Service 82fcde
Packit Service 82fcde
extern int aio_fsync64 (int __operation, struct aiocb64 *__aiocbp)
Packit Service 82fcde
  __THROW __nonnull ((2));
Packit Service 82fcde
#endif
Packit Service 82fcde
Packit Service 82fcde
__END_DECLS
Packit Service 82fcde
Packit Service 82fcde
#endif /* aio.h */