1 /* 2 * Copyright (C) 2008 The Android Open Source Project 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in 12 * the documentation and/or other materials provided with the 13 * distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 18 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 19 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 22 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 25 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #pragma once 30 #define _FCNTL_H 31 32 /** 33 * @file fcntl.h 34 * @brief File control operations. 35 */ 36 37 #include <sys/cdefs.h> 38 #include <sys/types.h> 39 #include <linux/fadvise.h> 40 #include <linux/falloc.h> 41 #include <linux/fcntl.h> 42 #include <linux/stat.h> 43 #include <linux/uio.h> 44 45 #include <bits/fcntl.h> 46 #include <bits/seek_constants.h> 47 48 #if defined(__USE_GNU) || defined(__USE_BSD) 49 #include <bits/lockf.h> 50 #endif 51 52 __BEGIN_DECLS 53 54 #if defined(__LP64__) 55 56 /* LP64 kernels don't have F_*64 defines because their flock is 64-bit. */ 57 58 /** Flag for flock(). */ 59 #define F_GETLK64 F_GETLK 60 /** Flag for flock(). */ 61 #define F_SETLK64 F_SETLK 62 /** Flag for flock(). */ 63 #define F_SETLKW64 F_SETLKW 64 65 #elif defined(__USE_FILE_OFFSET64) 66 67 /* For _FILE_OFFSET_BITS=64, redirect the constants to the off64_t variants. */ 68 69 #undef F_GETLK 70 #undef F_SETLK 71 #undef F_SETLKW 72 73 /** Flag for flock(). */ 74 #define F_GETLK F_GETLK64 75 /** Flag for flock(). */ 76 #define F_SETLK F_SETLK64 77 /** Flag for flock(). */ 78 #define F_SETLKW F_SETLKW64 79 80 #endif 81 82 /** Flag for open(). */ 83 #define O_ASYNC FASYNC 84 /** Flag for open(). */ 85 #define O_RSYNC O_SYNC 86 87 #if __ANDROID_API__ >= 21 88 /** Flag for splice(). */ 89 #define SPLICE_F_MOVE 1 90 /** Flag for splice(). */ 91 #define SPLICE_F_NONBLOCK 2 92 /** Flag for splice(). */ 93 #define SPLICE_F_MORE 4 94 /** Flag for splice(). */ 95 #define SPLICE_F_GIFT 8 96 #endif 97 98 #if __ANDROID_API__ >= 26 99 /** Flag for sync_file_range(). */ 100 #define SYNC_FILE_RANGE_WAIT_BEFORE 1 101 /** Flag for sync_file_range(). */ 102 #define SYNC_FILE_RANGE_WRITE 2 103 /** Flag for sync_file_range(). */ 104 #define SYNC_FILE_RANGE_WAIT_AFTER 4 105 #endif 106 107 /** 108 * [creat(2)](http://man7.org/linux/man-pages/man2/creat.2.html) 109 * creates a file. 110 * 111 * Returns a new file descriptor on success and returns -1 and sets `errno` on 112 * failure. 113 */ 114 int creat(const char* __path, mode_t __mode); 115 /** See creat(). */ 116 int creat64(const char* __path, mode_t __mode) __INTRODUCED_IN(21); 117 118 /** 119 * [openat(2)](http://man7.org/linux/man-pages/man2/openat.2.html) 120 * opens (and possibly creates) a file. 121 * 122 * Returns a new file descriptor on success and returns -1 and sets `errno` on 123 * failure. 124 */ 125 int openat(int __dir_fd, const char* __path, int __flags, ...); 126 /** See openat(). */ 127 int openat64(int __dir_fd, const char* __path, int __flags, ...) __INTRODUCED_IN(21); 128 129 /** 130 * [open(2)](http://man7.org/linux/man-pages/man2/open.2.html) 131 * opens (and possibly creates) a file. 132 * 133 * Returns a new file descriptor on success and returns -1 and sets `errno` on 134 * failure. 135 */ 136 int open(const char* __path, int __flags, ...); 137 /** See open(). */ 138 int open64(const char* __path, int __flags, ...) __INTRODUCED_IN(21); 139 140 /** 141 * [splice(2)](http://man7.org/linux/man-pages/man2/splice.2.html) 142 * splices data to/from a pipe. 143 * 144 * Valid flags are `SPLICE_F_MOVE`, `SPLICE_F_NONBLOCK`, `SPLICE_F_MORE`, and 145 * `SPLICE_F_GIFT`. 146 * 147 * Returns the number of bytes spliced on success and returns -1 and sets 148 * `errno` on failure. 149 * 150 * Available since API level 21. 151 */ 152 ssize_t splice(int __in_fd, off64_t* __in_offset, int __out_fd, off64_t* __out_offset, size_t __length, unsigned int __flags) __INTRODUCED_IN(21); 153 154 /** 155 * [tee(2)](http://man7.org/linux/man-pages/man2/tee.2.html) 156 * duplicates data from one pipe to another. 157 * 158 * Valid flags are `SPLICE_F_MOVE`, `SPLICE_F_NONBLOCK`, `SPLICE_F_MORE`, and 159 * `SPLICE_F_GIFT`. 160 * 161 * Returns the number of bytes duplicated on success and returns -1 and sets 162 * `errno` on failure. 163 * 164 * Available since API level 21. 165 */ 166 ssize_t tee(int __in_fd, int __out_fd, size_t __length, unsigned int __flags) __INTRODUCED_IN(21); 167 168 /** 169 * [vmsplice(2)](http://man7.org/linux/man-pages/man2/vmsplice.2.html) 170 * splices data to/from a pipe. 171 * 172 * Valid flags are `SPLICE_F_MOVE`, `SPLICE_F_NONBLOCK`, `SPLICE_F_MORE`, and 173 * `SPLICE_F_GIFT`. 174 * 175 * Returns the number of bytes spliced on success and returns -1 and sets 176 * `errno` on failure. 177 * 178 * Available since API level 21. 179 */ 180 ssize_t vmsplice(int __fd, const struct iovec* __iov, size_t __count, unsigned int __flags) __INTRODUCED_IN(21); 181 182 /** 183 * [fallocate(2)](http://man7.org/linux/man-pages/man2/fallocate.2.html) 184 * is a Linux-specific extension of posix_fallocate(). 185 * 186 * Valid flags are `FALLOC_FL_KEEP_SIZE`, `FALLOC_FL_PUNCH_HOLE`, 187 * `FALLOC_FL_NO_HIDE_STALE`, `FALLOC_FL_COLLAPSE_RANGE`, 188 * `FALLOC_FL_ZERO_RANGE`, `FALLOC_FL_INSERT_RANGE`, and 189 * `FALLOC_FL_UNSHARE_RANGE`. 190 * 191 * Returns 0 on success and returns -1 and sets `errno` on failure. 192 * 193 * Available since API level 21. 194 */ 195 int fallocate(int __fd, int __mode, off_t __offset, off_t __length) __RENAME_IF_FILE_OFFSET64(fallocate64) __INTRODUCED_IN(21); 196 /** See fallocate(). */ 197 int fallocate64(int __fd, int __mode, off64_t __offset, off64_t __length) __INTRODUCED_IN(21); 198 199 /** 200 * [posix_fadvise(2)](http://man7.org/linux/man-pages/man2/posix_fadvise.2.html) 201 * declares an expected access pattern for file data. 202 * 203 * Valid flags are `POSIX_FADV_NORMAL`, `POSIX_FADV_RANDOM`, 204 * `POSIX_FADV_SEQUENTIAL`, `POSIX_FADV_WILLNEED`, `POSIX_FADV_DONTNEED`, 205 * and `POSIX_FADV_NOREUSE`. 206 * 207 * Returns 0 on success and returns an error number on failure. 208 * 209 * Available since API level 21. 210 */ 211 int posix_fadvise(int __fd, off_t __offset, off_t __length, int __advice) __RENAME_IF_FILE_OFFSET64(posix_fadvise64) __INTRODUCED_IN(21); 212 /** See posix_fadvise(). */ 213 int posix_fadvise64(int __fd, off64_t __offset, off64_t __length, int __advice) __INTRODUCED_IN(21); 214 215 /** 216 * [posix_fallocate(2)](http://man7.org/linux/man-pages/man2/posix_fallocate.2.html) 217 * allocates file space. 218 * 219 * Returns 0 on success and returns an error number on failure. 220 * 221 * Available since API level 21. 222 */ 223 int posix_fallocate(int __fd, off_t __offset, off_t __length) __RENAME_IF_FILE_OFFSET64(posix_fallocate64) __INTRODUCED_IN(21); 224 /** See posix_fallocate(). */ 225 int posix_fallocate64(int __fd, off64_t __offset, off64_t __length) __INTRODUCED_IN(21); 226 227 #if defined(__USE_GNU) 228 229 /** 230 * [readahead(2)](http://man7.org/linux/man-pages/man2/readahead.2.html) 231 * initiates readahead for the given file. 232 * 233 * Returns 0 on success and returns -1 and sets `errno` on failure. 234 */ 235 ssize_t readahead(int __fd, off64_t __offset, size_t __length); 236 237 /** 238 * [sync_file_range(2)](http://man7.org/linux/man-pages/man2/sync_file_range.2.html) 239 * syncs part of a file with disk. 240 * 241 * Valid flags are `SYNC_FILE_RANGE_WAIT_BEFORE`, `SYNC_FILE_RANGE_WRITE`, and 242 * `SYNC_FILE_RANGE_WAIT_AFTER`. 243 * 244 * Returns 0 on success and returns -1 and sets `errno` on failure. 245 */ 246 int sync_file_range(int __fd, off64_t __offset, off64_t __length, unsigned int __flags) __INTRODUCED_IN(26); 247 248 #endif 249 250 #if defined(__BIONIC_INCLUDE_FORTIFY_HEADERS) 251 #include <bits/fortify/fcntl.h> 252 #endif 253 254 __END_DECLS 255