glibc/rt/aio.h
1998-10-24 11:06:07 +00:00

228 lines
6.6 KiB
C

/* Copyright (C) 1996, 1997, 1998 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. */
/*
* ISO/IEC 9945-1:1996 6.7: Asynchronous Input and Output
*/
#ifndef _AIO_H
#define _AIO_H 1
#include <features.h>
#include <fcntl.h>
#include <signal.h>
#include <time.h>
#include <sys/types.h>
__BEGIN_DECLS
/* Asynchronous I/O control block. */
struct aiocb
{
int aio_fildes; /* File desriptor. */
int aio_lio_opcode; /* Operation to be performed. */
int aio_reqprio; /* Request priority offset. */
volatile void *aio_buf; /* Location of buffer. */
size_t aio_nbytes; /* Length of transfer. */
struct sigevent aio_sigevent; /* Signal number and value. */
/* Internal members. */
struct aiocb *__next_prio;
int __abs_prio;
int __policy;
int __error_code;
__ssize_t __return_value;
#ifndef __USE_FILE_OFFSET64
__off_t aio_offset; /* File offset. */
char __pad[sizeof (__off64_t) - sizeof (__off_t)];
#else
__off64_t aio_offset; /* File offset. */
#endif
char __unused[32];
};
/* The same for the 64bit offsets. */
#ifdef __USE_LARGEFILE64
struct aiocb64
{
int aio_fildes; /* File desriptor. */
int aio_lio_opcode; /* Operation to be performed. */
int aio_reqprio; /* Request priority offset. */
volatile void *aio_buf; /* Location of buffer. */
size_t aio_nbytes; /* Length of transfer. */
struct sigevent aio_sigevent; /* Signal number and value. */
/* Internal members. */
int __abs_prio;
int __policy;
int __error_code;
__ssize_t __return_value;
__off64_t aio_offset; /* File offset. */
char __unused[32];
};
#endif
#ifdef __USE_GNU
/* To customize the implementation one can use the following struct.
This implementation follows the one in Irix. */
struct aioinit
{
int aio_threads; /* Maximal number of threads. */
int aio_num; /* Number of expected simultanious requests. */
int aio_locks; /* Not used. */
int aio_usedba; /* Not used. */
int aio_debug; /* Not used. */
int aio_numusers; /* Not used. */
int aio_reserved[2];
};
#endif
/* Return values of cancelation function. */
enum
{
AIO_CANCELED,
#define AIO_CANCELED AIO_CANCELED
AIO_NOTCANCELED,
#define AIO_NOTCANCELED AIO_NOTCANCELED
AIO_ALLDONE
#define AIO_ALLDONE AIO_ALLDONE
};
/* Operation codes for `aio_lio_opcode'. */
enum
{
LIO_READ,
#define LIO_READ LIO_READ
LIO_WRITE,
#define LIO_WRITE LIO_WRITE
LIO_NOP
#define LIO_NOP LIO_NOP
};
/* Synchronization options for `lio_listio' function. */
enum
{
LIO_WAIT,
#define LIO_WAIT LIO_WAIT
LIO_NOWAIT
#define LIO_NOWAIT LIO_NOWAIT
};
/* Allow user to specify optimization. */
#ifdef __USE_GNU
extern void aio_init __P ((__const struct aioinit *__init));
#endif
#ifndef __USE_FILE_OFFSET64
/* Enqueue read request for given number of bytes and the given priority. */
extern int aio_read __P ((struct aiocb *__aiocbp));
/* Enqueue write request for given number of bytes and the given priority. */
extern int aio_write __P ((struct aiocb *__aiocbp));
/* Initiate list of I/O requests. */
extern int lio_listio __P ((int __mode, struct aiocb *__const __list[],
int __nent, struct sigevent *__sig));
/* Retrieve error status associated with AIOCBP. */
extern int aio_error __P ((__const struct aiocb *__aiocbp));
/* Return status associated with AIOCBP. */
extern __ssize_t aio_return __P ((struct aiocb *__aiocbp));
/* Try to cancel asynchronous I/O requests outstanding against file
descriptor FILDES. */
extern int aio_cancel __P ((int __fildes, struct aiocb *__aiocbp));
/* Suspend calling thread until at least one of the asynchronous I/O
operations referenced by LIST has completed. */
extern int aio_suspend __P ((__const struct aiocb *__const __list[],
int __nent, __const struct timespec *__timeout));
/* Force all operations associated with file desriptor described by
`aio_fildes' member of AIOCBP. */
extern int aio_fsync __P ((int __operation, struct aiocb *__aiocbp));
#else
# ifdef __REDIRECT
extern int __REDIRECT (aio_read, __P ((struct aiocb *__aiocbp)), aio_read64);
extern int __REDIRECT (aio_write, __P ((struct aiocb *__aiocbp)), aio_write64);
extern int __REDIRECT (lio_listio, __P ((int __mode,
struct aiocb *__const __list[],
int __nent, struct sigevent *__sig)),
lio_listio64);
extern int __REDIRECT (aio_error, __P ((__const struct aiocb *__aiocbp)),
aio_error64);
extern __ssize_t __REDIRECT (aio_return, __P ((struct aiocb *__aiocbp)),
aio_return64);
extern int __REDIRECT (aio_cancel, __P ((int __fildes,
struct aiocb *__aiocbp)),
aio_cancel64);
extern int __REDIRECT (aio_suspend,
__P ((__const struct aiocb *__const __list[],
int __nent, __const struct timespec *__timeout)),
aio_suspend64);
extern int __REDIRECT (aio_fsync __P ((int __operation,
struct aiocb *__aiocbp)),
aio_fsync64);
# else
# define aio_read aio_read64
# define aio_write aio_write64
# define lio_listio lio_listio64
# define aio_error aio_error64
# define aio_return aio_return64
# define aio_cancel aio_cancel64
# define aio_suspend aio_suspend64
# define aio_fsync aio_fsync64
# endif
#endif
#ifdef __USE_LARGEFILE64
extern int aio_read64 __P ((struct aiocb64 *__aiocbp));
extern int aio_write64 __P ((struct aiocb64 *__aiocbp));
extern int lio_listio64 __P ((int __mode, struct aiocb64 *__const __list[],
int __nent, struct sigevent *__sig));
extern int aio_error64 __P ((__const struct aiocb64 *__aiocbp));
extern __ssize_t aio_return64 __P ((struct aiocb64 *__aiocbp));
extern int aio_cancel64 __P ((int __fildes, struct aiocb64 *__aiocbp));
extern int aio_suspend64 __P ((__const struct aiocb64 *__const __list[],
int __nent,
__const struct timespec *__timeout));
extern int aio_fsync64 __P ((int __operation, struct aiocb64 *__aiocbp));
#endif
__END_DECLS
#endif /* aio.h */