diff options
author | Gregory Nutt <gnutt@nuttx.org> | 2014-10-04 09:59:44 -0600 |
---|---|---|
committer | Gregory Nutt <gnutt@nuttx.org> | 2014-10-04 09:59:44 -0600 |
commit | 276f53391d9a7e603f976da6c6deec6bf89eede9 (patch) | |
tree | 55968351870843196907c146b174398aa02fc35c /nuttx/include/aio.h | |
parent | f0f5e156c35426eba70b10d63ef1cc5571a9099d (diff) |
Add aio.h header file
Diffstat (limited to 'nuttx/include/aio.h')
-rw-r--r-- | nuttx/include/aio.h | 137 |
1 files changed, 137 insertions, 0 deletions
diff --git a/nuttx/include/aio.h b/nuttx/include/aio.h new file mode 100644 index 0000000000..f945cd717c --- /dev/null +++ b/nuttx/include/aio.h @@ -0,0 +1,137 @@ +/**************************************************************************** + * include/aio.h + * + * Copyright (C) 2014 Gregory Nutt. All rights reserved. + * Author: Gregory Nutt <gnutt@nuttx.org> + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * 3. Neither the name NuttX nor the names of its contributors may be + * used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS + * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN + * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + * + ****************************************************************************/ + +#ifndef __INCLUDE_AIO_H +#define __INCLUDE_AIO_H + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> + +#include <sys/types.h> +#include <signal.h> +#include <time.h> + +/**************************************************************************** + * Pre-processor Definitions + ****************************************************************************/ +/* aio_cancel return values + * + * AIO_ALLDONE - Indicates that none of the requested operations could + * be cancelled since they are already complete. + * AIO_CANCELED - Indicates that all requested operations have been + * cancelled. + * AIO_NOTCANCELED - Indicates that some of the requested operations could + * not be cancelled since they are in progress. + */ + +#define AIO_CANCELED 0 +#define AIO_ALLDONE 1 +#define AIO_NOTCANCELED 2 + +/* lio_listio element operations + * + * LIO_NOP - Indicates that no transfer is requested. + * LIO_READ - Requests a read operation. + * LIO_WRITE - Requests a write operation. + */ + +#define LIO_NOP 0 +#define LIO_READ 1 +#define LIO_WRITE 2 + +/* lio_listio modes + * + * LIO_NOWAIT - Indicates that the calling thread is to continue + * execution while the lio_listio() operation is being + * performed, and no notification is given when the + * operation is complete. + * LIO_WAIT - Indicates that the calling thread is to suspend until + * the lio_listio() operation is complete. + */ + +#define LIO_NOWAIT 0 +#define LIO_WAIT 1 + +/**************************************************************************** + * Type Definitions + ****************************************************************************/ + +struct aiocb +{ + struct sigevent aio_sigevent; /* Signal number and value */ + FAR volatile void *aio_buf; /* Location of buffer */ + off_t aio_offset; /* File offset */ + size_t aio_nbytes; /* Length of transfer */ + int aio_fildes; /* File descriptor */ + int aio_reqprio; /* Request priority offset */ + int aio_lio_opcode; /* Operation to be performed */ +}; + +/**************************************************************************** + * Public Data + ****************************************************************************/ + +#ifdef __cplusplus +#define EXTERN extern "C" +extern "C" +{ +#else +#define EXTERN extern +#endif + +/**************************************************************************** + * Public Function Prototypes + ****************************************************************************/ + +int aio_cancel(int, FAR struct aiocb *aiocbp); +int aio_error(FAR const struct aiocb *aiocbp); +int aio_fsync(int, FAR struct aiocb *aiocbp); +int aio_read(FAR struct aiocb *aiocbp); +ssize_t aio_return(FAR struct aiocb *aiocbp); +int aio_suspend(FAR const struct aiocb *const list[], int nent, + FAR const struct timespec *timeout); +int aio_write(FAR struct aiocb *aiocbp); +int lio_listio(int mode, FAR struct aiocb *const list[], int nent, + FAR struct sigevent *sig); + +#undef EXTERN +#ifdef __cplusplus +} +#endif + +#endif /* __INCLUDE_AIO_H */ |