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 /** Flag for splice(). */ 88 #define SPLICE_F_MOVE 1 89 /** Flag for splice(). */ 90 #define SPLICE_F_NONBLOCK 2 91 /** Flag for splice(). */ 92 #define SPLICE_F_MORE 4 93 /** Flag for splice(). */ 94 #define SPLICE_F_GIFT 8 95 96 /** Flag for sync_file_range(). */ 97 #define SYNC_FILE_RANGE_WAIT_BEFORE 1 98 /** Flag for sync_file_range(). */ 99 #define SYNC_FILE_RANGE_WRITE 2 100 /** Flag for sync_file_range(). */ 101 #define SYNC_FILE_RANGE_WAIT_AFTER 4 102 103 /** 104 * [creat(2)](https://man7.org/linux/man-pages/man2/creat.2.html) 105 * creates a file. 106 * 107 * Returns a new file descriptor on success and returns -1 and sets `errno` on 108 * failure. 109 */ 110 int creat(const char* _Nonnull __path, mode_t __mode); 111 /** See creat(). */ 112 int creat64(const char* _Nonnull __path, mode_t __mode); 113 114 /** 115 * [openat(2)](https://man7.org/linux/man-pages/man2/openat.2.html) 116 * opens (and possibly creates) a file. 117 * 118 * Returns a new file descriptor on success and returns -1 and sets `errno` on 119 * failure. 120 */ 121 int openat(int __dir_fd, const char* _Nonnull __path, int __flags, ...); 122 /** See openat(). */ 123 int openat64(int __dir_fd, const char* _Nonnull __path, int __flags, ...); 124 125 /** 126 * [open(2)](https://man7.org/linux/man-pages/man2/open.2.html) 127 * opens (and possibly creates) a file. 128 * 129 * Returns a new file descriptor on success and returns -1 and sets `errno` on 130 * failure. 131 */ 132 int open(const char* _Nonnull __path, int __flags, ...); 133 /** See open(). */ 134 int open64(const char* _Nonnull __path, int __flags, ...); 135 136 /** 137 * [splice(2)](https://man7.org/linux/man-pages/man2/splice.2.html) 138 * splices data to/from a pipe. 139 * 140 * Valid flags are `SPLICE_F_MOVE`, `SPLICE_F_NONBLOCK`, `SPLICE_F_MORE`, and 141 * `SPLICE_F_GIFT`. 142 * 143 * Returns the number of bytes spliced on success and returns -1 and sets 144 * `errno` on failure. 145 */ 146 ssize_t splice(int __in_fd, off64_t* __BIONIC_COMPLICATED_NULLNESS __in_offset, int __out_fd, off64_t* __BIONIC_COMPLICATED_NULLNESS __out_offset, size_t __length, unsigned int __flags); 147 148 /** 149 * [tee(2)](https://man7.org/linux/man-pages/man2/tee.2.html) 150 * duplicates data from one pipe to another. 151 * 152 * Valid flags are `SPLICE_F_MOVE`, `SPLICE_F_NONBLOCK`, `SPLICE_F_MORE`, and 153 * `SPLICE_F_GIFT`. 154 * 155 * Returns the number of bytes duplicated on success and returns -1 and sets 156 * `errno` on failure. 157 */ 158 ssize_t tee(int __in_fd, int __out_fd, size_t __length, unsigned int __flags); 159 160 /** 161 * [vmsplice(2)](https://man7.org/linux/man-pages/man2/vmsplice.2.html) 162 * splices data to/from a pipe. 163 * 164 * Valid flags are `SPLICE_F_MOVE`, `SPLICE_F_NONBLOCK`, `SPLICE_F_MORE`, and 165 * `SPLICE_F_GIFT`. 166 * 167 * Returns the number of bytes spliced on success and returns -1 and sets 168 * `errno` on failure. 169 */ 170 ssize_t vmsplice(int __fd, const struct iovec* _Nonnull __iov, size_t __count, unsigned int __flags); 171 172 /** 173 * [fallocate(2)](https://man7.org/linux/man-pages/man2/fallocate.2.html) 174 * is a Linux-specific extension of posix_fallocate(). 175 * 176 * Valid flags are `FALLOC_FL_KEEP_SIZE`, `FALLOC_FL_PUNCH_HOLE`, 177 * `FALLOC_FL_NO_HIDE_STALE`, `FALLOC_FL_COLLAPSE_RANGE`, 178 * `FALLOC_FL_ZERO_RANGE`, `FALLOC_FL_INSERT_RANGE`, and 179 * `FALLOC_FL_UNSHARE_RANGE`. 180 * 181 * Returns 0 on success and returns -1 and sets `errno` on failure. 182 */ 183 int fallocate(int __fd, int __mode, off_t __offset, off_t __length) __RENAME_IF_FILE_OFFSET64(fallocate64); 184 /** See fallocate(). */ 185 int fallocate64(int __fd, int __mode, off64_t __offset, off64_t __length); 186 187 /** 188 * [posix_fadvise(2)](https://man7.org/linux/man-pages/man2/posix_fadvise.2.html) 189 * declares an expected access pattern for file data. 190 * 191 * Valid flags are `POSIX_FADV_NORMAL`, `POSIX_FADV_RANDOM`, 192 * `POSIX_FADV_SEQUENTIAL`, `POSIX_FADV_WILLNEED`, `POSIX_FADV_DONTNEED`, 193 * and `POSIX_FADV_NOREUSE`. 194 * 195 * Returns 0 on success and returns an error number on failure. 196 */ 197 int posix_fadvise(int __fd, off_t __offset, off_t __length, int __advice) __RENAME_IF_FILE_OFFSET64(posix_fadvise64); 198 /** See posix_fadvise(). */ 199 int posix_fadvise64(int __fd, off64_t __offset, off64_t __length, int __advice); 200 201 /** 202 * [posix_fallocate(2)](https://man7.org/linux/man-pages/man2/posix_fallocate.2.html) 203 * allocates file space. 204 * 205 * Returns 0 on success and returns an error number on failure. 206 */ 207 int posix_fallocate(int __fd, off_t __offset, off_t __length) __RENAME_IF_FILE_OFFSET64(posix_fallocate64); 208 /** See posix_fallocate(). */ 209 int posix_fallocate64(int __fd, off64_t __offset, off64_t __length); 210 211 #if defined(__USE_GNU) 212 213 /** 214 * [readahead(2)](https://man7.org/linux/man-pages/man2/readahead.2.html) 215 * initiates readahead for the given file. 216 * 217 * Returns 0 on success and returns -1 and sets `errno` on failure. 218 */ 219 ssize_t readahead(int __fd, off64_t __offset, size_t __length); 220 221 /** 222 * [sync_file_range(2)](https://man7.org/linux/man-pages/man2/sync_file_range.2.html) 223 * syncs part of a file with disk. 224 * 225 * Valid flags are `SYNC_FILE_RANGE_WAIT_BEFORE`, `SYNC_FILE_RANGE_WRITE`, and 226 * `SYNC_FILE_RANGE_WAIT_AFTER`. 227 * 228 * Returns 0 on success and returns -1 and sets `errno` on failure. 229 */ 230 231 #if __BIONIC_AVAILABILITY_GUARD(26) 232 int sync_file_range(int __fd, off64_t __offset, off64_t __length, unsigned int __flags) __INTRODUCED_IN(26); 233 #endif /* __BIONIC_AVAILABILITY_GUARD(26) */ 234 235 236 #endif 237 238 #if defined(__BIONIC_INCLUDE_FORTIFY_HEADERS) 239 #include <bits/fortify/fcntl.h> 240 #endif 241 242 __END_DECLS 243