fcntl.h 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
  1. /* Copyright (C) 1991,1992,1994-2001,2003,2004,2005,2006,2007, 2009
  2. Free Software Foundation, Inc.
  3. This file is part of the GNU C Library.
  4. The GNU C Library is free software; you can redistribute it and/or
  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.
  8. The GNU C Library is distributed in the hope that it will be useful,
  9. but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11. Lesser General Public License for more details.
  12. You should have received a copy of the GNU Lesser General Public
  13. License along with the GNU C Library; if not, see
  14. <http://www.gnu.org/licenses/>. */
  15. /*
  16. * POSIX Standard: 6.5 File Control Operations <fcntl.h>
  17. */
  18. #ifndef _FCNTL_H
  19. #define _FCNTL_H 1
  20. #include <features.h>
  21. /* This must be early so <bits/fcntl.h> can define types winningly. */
  22. __BEGIN_DECLS
  23. /* Get the definitions of O_*, F_*, FD_*: all the
  24. numbers and flag bits for `open', `fcntl', et al. */
  25. #include <bits/fcntl.h>
  26. /* For XPG all symbols from <sys/stat.h> should also be available. */
  27. #ifdef __USE_XOPEN
  28. # include <sys/stat.h>
  29. #endif
  30. #ifdef __USE_MISC
  31. # ifndef R_OK /* Verbatim from <unistd.h>. Ugh. */
  32. /* Values for the second argument to access.
  33. These may be OR'd together. */
  34. # define R_OK 4 /* Test for read permission. */
  35. # define W_OK 2 /* Test for write permission. */
  36. # define X_OK 1 /* Test for execute permission. */
  37. # define F_OK 0 /* Test for existence. */
  38. # endif
  39. #endif /* Use misc. */
  40. /* XPG wants the following symbols. */
  41. #ifdef __USE_XOPEN /* <stdio.h> has the same definitions. */
  42. # define SEEK_SET 0 /* Seek from beginning of file. */
  43. # define SEEK_CUR 1 /* Seek from current position. */
  44. # define SEEK_END 2 /* Seek from end of file. */
  45. #endif /* XPG */
  46. #ifdef __USE_ATFILE
  47. # define AT_FDCWD -100 /* Special value used to indicate
  48. the *at functions should use the
  49. current working directory. */
  50. # define AT_SYMLINK_NOFOLLOW 0x100 /* Do not follow symbolic links. */
  51. # define AT_REMOVEDIR 0x200 /* Remove directory instead of
  52. unlinking file. */
  53. # define AT_SYMLINK_FOLLOW 0x400 /* Follow symbolic links. */
  54. # ifdef __USE_GNU
  55. # define AT_NO_AUTOMOUNT 0x800 /* Suppress terminal automount
  56. traversal. */
  57. # define AT_EMPTY_PATH 0x1000 /* Allow empty relative pathname. */
  58. # endif
  59. # define AT_EACCESS 0x200 /* Test access permitted for
  60. effective IDs, not real IDs. */
  61. #endif
  62. /* Do the file control operation described by CMD on FD.
  63. The remaining arguments are interpreted depending on CMD.
  64. This function is a cancellation point and therefore not marked with
  65. __THROW. */
  66. #if !defined(__USE_FILE_OFFSET64) || defined(__LP64__)
  67. extern int fcntl (int __fd, int __cmd, ...);
  68. # ifdef _LIBC
  69. extern int __fcntl_nocancel(int, int, long) attribute_hidden;
  70. libc_hidden_proto(fcntl)
  71. # endif
  72. #else
  73. # ifdef __REDIRECT
  74. extern int __REDIRECT (fcntl, (int __fd, int __cmd, ...), fcntl64);
  75. # else
  76. # define fcntl fcntl64
  77. # endif
  78. #endif
  79. #if defined(__USE_LARGEFILE64) && !defined(__LP64__)
  80. extern int fcntl64 (int __fd, int __cmd, ...);
  81. # ifdef _LIBC
  82. extern int __fcntl64_nocancel(int, int, long) attribute_hidden;
  83. libc_hidden_proto(fcntl64)
  84. # endif
  85. #endif
  86. /* Open FILE and return a new file descriptor for it, or -1 on error.
  87. OFLAG determines the type of access used. If O_CREAT is on OFLAG,
  88. the third argument is taken as a `mode_t', the mode of the created file.
  89. This function is a cancellation point and therefore not marked with
  90. __THROW. */
  91. #ifndef __USE_FILE_OFFSET64
  92. extern int open (const char *__file, int __oflag, ...) __nonnull ((1));
  93. libc_hidden_proto(open)
  94. # ifdef _LIBC
  95. extern int __open2_nocancel(const char *, int) __nonnull ((1)) attribute_hidden;
  96. extern int __open_nocancel(const char *, int, mode_t) __nonnull ((1)) attribute_hidden;
  97. # endif
  98. #else
  99. # ifdef __REDIRECT
  100. extern int __REDIRECT (open, (const char *__file, int __oflag, ...), open64)
  101. __nonnull ((1));
  102. # else
  103. # define open open64
  104. # endif
  105. #endif
  106. #ifdef __USE_LARGEFILE64
  107. extern int open64 (const char *__file, int __oflag, ...) __nonnull ((1));
  108. libc_hidden_proto(open64)
  109. #endif
  110. #ifdef __USE_ATFILE
  111. /* Similar to `open' but a relative path name is interpreted relative to
  112. the directory for which FD is a descriptor.
  113. NOTE: some other `openat' implementation support additional functionality
  114. through this interface, especially using the O_XATTR flag. This is not
  115. yet supported here.
  116. This function is a cancellation point and therefore not marked with
  117. __THROW. */
  118. # ifndef __USE_FILE_OFFSET64
  119. extern int openat (int __fd, const char *__file, int __oflag, ...)
  120. __nonnull ((2));
  121. libc_hidden_proto(openat)
  122. # else
  123. # ifdef __REDIRECT
  124. extern int __REDIRECT (openat, (int __fd, const char *__file, int __oflag,
  125. ...), openat64) __nonnull ((2));
  126. # else
  127. # define openat openat64
  128. # endif
  129. # endif
  130. extern int openat64 (int __fd, const char *__file, int __oflag, ...)
  131. __nonnull ((2));
  132. #endif
  133. /* Create and open FILE, with mode MODE. This takes an `int' MODE
  134. argument because that is what `mode_t' will be widened to.
  135. This function is a cancellation point and therefore not marked with
  136. __THROW. */
  137. #ifndef __USE_FILE_OFFSET64
  138. extern int creat (const char *__file, __mode_t __mode) __nonnull ((1));
  139. #else
  140. # ifdef __REDIRECT
  141. extern int __REDIRECT (creat, (const char *__file, __mode_t __mode),
  142. creat64) __nonnull ((1));
  143. # else
  144. # define creat creat64
  145. # endif
  146. #endif
  147. #ifdef __USE_LARGEFILE64
  148. extern int creat64 (const char *__file, __mode_t __mode) __nonnull ((1));
  149. #endif
  150. #if !defined F_LOCK && (defined __USE_MISC || (defined __USE_XOPEN_EXTENDED \
  151. && !defined __USE_POSIX))
  152. /* NOTE: These declarations also appear in <unistd.h>; be sure to keep both
  153. files consistent. Some systems have them there and some here, and some
  154. software depends on the macros being defined without including both. */
  155. /* `lockf' is a simpler interface to the locking facilities of `fcntl'.
  156. LEN is always relative to the current file position.
  157. The CMD argument is one of the following. */
  158. # define F_ULOCK 0 /* Unlock a previously locked region. */
  159. # define F_LOCK 1 /* Lock a region for exclusive use. */
  160. # define F_TLOCK 2 /* Test and lock a region for exclusive use. */
  161. # define F_TEST 3 /* Test a region for other processes locks. */
  162. # ifndef __USE_FILE_OFFSET64
  163. extern int lockf (int __fd, int __cmd, __off_t __len);
  164. libc_hidden_proto(lockf)
  165. # else
  166. # ifdef __REDIRECT
  167. extern int __REDIRECT (lockf, (int __fd, int __cmd, __off64_t __len), lockf64);
  168. # else
  169. # define lockf lockf64
  170. # endif
  171. # endif
  172. # ifdef __USE_LARGEFILE64
  173. extern int lockf64 (int __fd, int __cmd, __off64_t __len);
  174. # endif
  175. #endif
  176. #if defined __USE_XOPEN2K && defined __UCLIBC_HAS_ADVANCED_REALTIME__
  177. /* Advice the system about the expected behaviour of the application with
  178. respect to the file associated with FD. */
  179. # ifndef __USE_FILE_OFFSET64
  180. extern int posix_fadvise (int __fd, __off_t __offset, __off_t __len,
  181. int __advise) __THROW;
  182. # else
  183. # ifdef __REDIRECT_NTH
  184. extern int __REDIRECT_NTH (posix_fadvise, (int __fd, __off64_t __offset,
  185. __off64_t __len, int __advise),
  186. posix_fadvise64);
  187. # else
  188. # define posix_fadvise posix_fadvise64
  189. # endif
  190. # endif
  191. # ifdef __USE_LARGEFILE64
  192. extern int posix_fadvise64 (int __fd, __off64_t __offset, __off64_t __len,
  193. int __advise) __THROW;
  194. # endif
  195. #endif
  196. #if defined __UCLIBC_HAS_ADVANCED_REALTIME__
  197. /* Reserve storage for the data of the file associated with FD.
  198. This function is a possible cancellation point and therefore not
  199. marked with __THROW. */
  200. # ifndef __USE_FILE_OFFSET64
  201. extern int posix_fallocate (int __fd, __off_t __offset, __off_t __len);
  202. # else
  203. # ifdef __REDIRECT
  204. extern int __REDIRECT (posix_fallocate, (int __fd, __off64_t __offset,
  205. __off64_t __len),
  206. posix_fallocate64);
  207. # else
  208. # define posix_fallocate posix_fallocate64
  209. # endif
  210. # endif
  211. # ifdef __USE_LARGEFILE64
  212. extern int posix_fallocate64 (int __fd, __off64_t __offset, __off64_t __len);
  213. # endif
  214. #endif
  215. #if (defined __UCLIBC_LINUX_SPECIFIC__ && defined __USE_GNU) || defined _LIBC
  216. /* Reserve storage for the data of a file associated with FD. This function
  217. is Linux-specific. For the portable version, use posix_fallocate().
  218. Unlike the latter, fallocate can operate in different modes. The default
  219. mode = 0 is equivalent to posix_fallocate().
  220. Note: These declarations are used in posix_fallocate.c and
  221. posix_fallocate64.c, so we expose them internally.
  222. */
  223. /* Flags for fallocate's mode. */
  224. # define FALLOC_FL_KEEP_SIZE 1 /* Don't extend size of file
  225. even if offset + len is
  226. greater than file size. */
  227. # define FALLOC_FL_PUNCH_HOLE 2 /* Create a hole in the file. */
  228. # ifndef __USE_FILE_OFFSET64
  229. extern int fallocate (int __fd, int __mode, __off_t __offset, __off_t __len);
  230. # else
  231. # ifdef __REDIRECT
  232. extern int __REDIRECT (fallocate, (int __fd, int __mode, __off64_t __offset,
  233. __off64_t __len),
  234. fallocate64);
  235. # else
  236. # define fallocate fallocate64
  237. # endif
  238. # endif
  239. # ifdef __USE_LARGEFILE64
  240. extern int fallocate64 (int __fd, int __mode, __off64_t __offset, __off64_t __len);
  241. # endif
  242. #endif
  243. __END_DECLS
  244. #endif /* fcntl.h */