aio_abi.h 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. /* include/linux/aio_abi.h
  2. *
  3. * Copyright 2000,2001,2002 Red Hat.
  4. *
  5. * Written by Benjamin LaHaise <bcrl@kvack.org>
  6. *
  7. * Distribute under the terms of the GPLv2 (see ../../COPYING) or under
  8. * the following terms.
  9. *
  10. * Permission to use, copy, modify, and distribute this software and its
  11. * documentation is hereby granted, provided that the above copyright
  12. * notice appears in all copies. This software is provided without any
  13. * warranty, express or implied. Red Hat makes no representations about
  14. * the suitability of this software for any purpose.
  15. *
  16. * IN NO EVENT SHALL RED HAT BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
  17. * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF
  18. * THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF RED HAT HAS BEEN ADVISED
  19. * OF THE POSSIBILITY OF SUCH DAMAGE.
  20. *
  21. * RED HAT DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  23. * PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND
  24. * RED HAT HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
  25. * ENHANCEMENTS, OR MODIFICATIONS.
  26. */
  27. #ifndef __LINUX__AIO_ABI_H
  28. #define __LINUX__AIO_ABI_H
  29. #include <linux/types.h>
  30. #include <asm/byteorder.h>
  31. typedef __kernel_ulong_t aio_context_t;
  32. enum {
  33. IOCB_CMD_PREAD = 0,
  34. IOCB_CMD_PWRITE = 1,
  35. IOCB_CMD_FSYNC = 2,
  36. IOCB_CMD_FDSYNC = 3,
  37. /* These two are experimental.
  38. * IOCB_CMD_PREADX = 4,
  39. * IOCB_CMD_POLL = 5,
  40. */
  41. IOCB_CMD_NOOP = 6,
  42. IOCB_CMD_PREADV = 7,
  43. IOCB_CMD_PWRITEV = 8,
  44. };
  45. /*
  46. * Valid flags for the "aio_flags" member of the "struct iocb".
  47. *
  48. * IOCB_FLAG_RESFD - Set if the "aio_resfd" member of the "struct iocb"
  49. * is valid.
  50. */
  51. #define IOCB_FLAG_RESFD (1 << 0)
  52. /* read() from /dev/aio returns these structures. */
  53. struct io_event {
  54. __u64 data; /* the data field from the iocb */
  55. __u64 obj; /* what iocb this event came from */
  56. __s64 res; /* result code for this event */
  57. __s64 res2; /* secondary result */
  58. };
  59. #if defined(__BYTE_ORDER) ? __BYTE_ORDER == __LITTLE_ENDIAN : defined(__LITTLE_ENDIAN)
  60. #define PADDED(x,y) x, y
  61. #elif defined(__BYTE_ORDER) ? __BYTE_ORDER == __BIG_ENDIAN : defined(__BIG_ENDIAN)
  62. #define PADDED(x,y) y, x
  63. #else
  64. #error edit for your odd byteorder.
  65. #endif
  66. /*
  67. * we always use a 64bit off_t when communicating
  68. * with userland. its up to libraries to do the
  69. * proper padding and aio_error abstraction
  70. */
  71. struct iocb {
  72. /* these are internal to the kernel/libc. */
  73. __u64 aio_data; /* data to be returned in event's data */
  74. __u32 PADDED(aio_key, aio_reserved1);
  75. /* the kernel sets aio_key to the req # */
  76. /* common fields */
  77. __u16 aio_lio_opcode; /* see IOCB_CMD_ above */
  78. __s16 aio_reqprio;
  79. __u32 aio_fildes;
  80. __u64 aio_buf;
  81. __u64 aio_nbytes;
  82. __s64 aio_offset;
  83. /* extra parameters */
  84. __u64 aio_reserved2; /* TODO: use this for a (struct sigevent *) */
  85. /* flags for the "struct iocb" */
  86. __u32 aio_flags;
  87. /*
  88. * if the IOCB_FLAG_RESFD flag of "aio_flags" is set, this is an
  89. * eventfd to signal AIO readiness to
  90. */
  91. __u32 aio_resfd;
  92. }; /* 64 bytes */
  93. #undef IFBIG
  94. #undef IFLITTLE
  95. #endif /* __LINUX__AIO_ABI_H */