| 1 | /* $NetBSD: fcntl.h,v 1.47 2016/06/30 15:29:20 dholland Exp $ */ |
| 2 | |
| 3 | /*- |
| 4 | * Copyright (c) 1983, 1990, 1993 |
| 5 | * The Regents of the University of California. All rights reserved. |
| 6 | * (c) UNIX System Laboratories, Inc. |
| 7 | * All or some portions of this file are derived from material licensed |
| 8 | * to the University of California by American Telephone and Telegraph |
| 9 | * Co. or Unix System Laboratories, Inc. and are reproduced herein with |
| 10 | * the permission of UNIX System Laboratories, Inc. |
| 11 | * |
| 12 | * Redistribution and use in source and binary forms, with or without |
| 13 | * modification, are permitted provided that the following conditions |
| 14 | * are met: |
| 15 | * 1. Redistributions of source code must retain the above copyright |
| 16 | * notice, this list of conditions and the following disclaimer. |
| 17 | * 2. Redistributions in binary form must reproduce the above copyright |
| 18 | * notice, this list of conditions and the following disclaimer in the |
| 19 | * documentation and/or other materials provided with the distribution. |
| 20 | * 3. Neither the name of the University nor the names of its contributors |
| 21 | * may be used to endorse or promote products derived from this software |
| 22 | * without specific prior written permission. |
| 23 | * |
| 24 | * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND |
| 25 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 26 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 27 | * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE |
| 28 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 29 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| 30 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| 31 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| 32 | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| 33 | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| 34 | * SUCH DAMAGE. |
| 35 | * |
| 36 | * @(#)fcntl.h 8.3 (Berkeley) 1/21/94 |
| 37 | */ |
| 38 | |
| 39 | #ifndef _SYS_FCNTL_H_ |
| 40 | #define _SYS_FCNTL_H_ |
| 41 | |
| 42 | /* |
| 43 | * This file includes the definitions for open and fcntl |
| 44 | * described by POSIX for <fcntl.h>; it also includes |
| 45 | * related kernel definitions. |
| 46 | */ |
| 47 | |
| 48 | #ifndef _KERNEL |
| 49 | #include <sys/featuretest.h> |
| 50 | #include <sys/types.h> |
| 51 | #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE) |
| 52 | #include <sys/stat.h> |
| 53 | #endif /* _XOPEN_SOURCE || _NETBSD_SOURCE */ |
| 54 | #endif /* !_KERNEL */ |
| 55 | |
| 56 | /* |
| 57 | * File status flags: these are used by open(2), fcntl(2). |
| 58 | * They are also used (indirectly) in the kernel file structure f_flags, |
| 59 | * which is a superset of the open/fcntl flags. Open flags and f_flags |
| 60 | * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags). |
| 61 | * Open/fcntl flags begin with O_; kernel-internal flags begin with F. |
| 62 | */ |
| 63 | /* open-only flags */ |
| 64 | #define O_RDONLY 0x00000000 /* open for reading only */ |
| 65 | #define O_WRONLY 0x00000001 /* open for writing only */ |
| 66 | #define O_RDWR 0x00000002 /* open for reading and writing */ |
| 67 | #define O_ACCMODE 0x00000003 /* mask for above modes */ |
| 68 | |
| 69 | /* |
| 70 | * Kernel encoding of open mode; separate read and write bits that are |
| 71 | * independently testable: 1 greater than the above. |
| 72 | * |
| 73 | * XXX |
| 74 | * FREAD and FWRITE are excluded from the #ifdef _KERNEL so that TIOCFLUSH, |
| 75 | * which was documented to use FREAD/FWRITE, continues to work. |
| 76 | */ |
| 77 | #if defined(_NETBSD_SOURCE) |
| 78 | #define FREAD 0x00000001 |
| 79 | #define FWRITE 0x00000002 |
| 80 | #endif |
| 81 | #define O_NONBLOCK 0x00000004 /* no delay */ |
| 82 | #define O_APPEND 0x00000008 /* set append mode */ |
| 83 | #if defined(_NETBSD_SOURCE) |
| 84 | #define O_SHLOCK 0x00000010 /* open with shared file lock */ |
| 85 | #define O_EXLOCK 0x00000020 /* open with exclusive file lock */ |
| 86 | #define O_ASYNC 0x00000040 /* signal pgrp when data ready */ |
| 87 | #endif |
| 88 | #if (_POSIX_C_SOURCE - 0) >= 199309L || \ |
| 89 | (defined(_XOPEN_SOURCE) && defined(_XOPEN_SOURCE_EXTENDED)) || \ |
| 90 | (_XOPEN_SOURCE - 0) >= 500 || defined(_NETBSD_SOURCE) |
| 91 | #define O_SYNC 0x00000080 /* synchronous writes */ |
| 92 | #endif |
| 93 | #if defined(_NETBSD_SOURCE) |
| 94 | #define O_NOFOLLOW 0x00000100 /* don't follow symlinks on the last */ |
| 95 | /* path component */ |
| 96 | #endif |
| 97 | #define O_CREAT 0x00000200 /* create if nonexistent */ |
| 98 | #define O_TRUNC 0x00000400 /* truncate to zero length */ |
| 99 | #define O_EXCL 0x00000800 /* error if already exists */ |
| 100 | |
| 101 | /* defined by POSIX 1003.1; BSD default, but required to be bitwise distinct */ |
| 102 | #define O_NOCTTY 0x00008000 /* don't assign controlling terminal */ |
| 103 | |
| 104 | #if (_POSIX_C_SOURCE - 0) >= 199309L || (_XOPEN_SOURCE - 0) >= 500 || \ |
| 105 | defined(_NETBSD_SOURCE) |
| 106 | #define O_DSYNC 0x00010000 /* write: I/O data completion */ |
| 107 | #define O_RSYNC 0x00020000 /* read: I/O completion as for write */ |
| 108 | #endif |
| 109 | |
| 110 | #if defined(_NETBSD_SOURCE) |
| 111 | #define O_ALT_IO 0x00040000 /* use alternate i/o semantics */ |
| 112 | #define O_DIRECT 0x00080000 /* direct I/O hint */ |
| 113 | #endif |
| 114 | |
| 115 | #define O_DIRECTORY 0x00200000 /* fail if not a directory */ |
| 116 | #define O_CLOEXEC 0x00400000 /* set close on exec */ |
| 117 | #if (_POSIX_C_SOURCE - 0) >= 200809L || (_XOPEN_SOURCE - 0 >= 700) || \ |
| 118 | defined(_INCOMPLETE_XOPEN_C063) || defined(_NETBSD_SOURCE) |
| 119 | #define O_SEARCH 0x00800000 /* skip search permission checks */ |
| 120 | #endif |
| 121 | #if defined(_NETBSD_SOURCE) |
| 122 | #define O_NOSIGPIPE 0x01000000 /* don't deliver sigpipe */ |
| 123 | #endif |
| 124 | |
| 125 | #ifdef _KERNEL |
| 126 | /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */ |
| 127 | #define FFLAGS(oflags) ((oflags) + 1) |
| 128 | #define OFLAGS(fflags) ((fflags) - 1) |
| 129 | |
| 130 | /* all bits settable during open(2) */ |
| 131 | #define O_MASK (O_ACCMODE|O_NONBLOCK|O_APPEND|O_SHLOCK|O_EXLOCK|\ |
| 132 | O_ASYNC|O_SYNC|O_CREAT|O_TRUNC|O_EXCL|O_DSYNC|\ |
| 133 | O_RSYNC|O_NOCTTY|O_ALT_IO|O_NOFOLLOW|O_DIRECT|\ |
| 134 | O_DIRECTORY|O_CLOEXEC|O_NOSIGPIPE) |
| 135 | |
| 136 | #define FMARK 0x00001000 /* mark during gc() */ |
| 137 | #define FDEFER 0x00002000 /* defer for next gc pass */ |
| 138 | #define FHASLOCK 0x00004000 /* descriptor holds advisory lock */ |
| 139 | #define FSCAN 0x00100000 /* scan during gc passes */ |
| 140 | #define FSILENT 0x40000000 /* suppress kernel error messages */ |
| 141 | #define FKIOCTL 0x80000000 /* kernel originated ioctl */ |
| 142 | /* bits settable by fcntl(F_SETFL, ...) */ |
| 143 | #define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FNONBLOCK|FDSYNC|FRSYNC|FALTIO|\ |
| 144 | FDIRECT|FNOSIGPIPE) |
| 145 | /* bits to save after open(2) */ |
| 146 | #define FMASK (FREAD|FWRITE|FCNTLFLAGS) |
| 147 | #endif /* _KERNEL */ |
| 148 | |
| 149 | /* |
| 150 | * The O_* flags used to have only F* names, which were used in the kernel |
| 151 | * and by fcntl. We retain the F* names for the kernel f_flags field |
| 152 | * and for backward compatibility for fcntl. |
| 153 | */ |
| 154 | #if defined(_NETBSD_SOURCE) |
| 155 | #define FAPPEND O_APPEND /* kernel/compat */ |
| 156 | #define FASYNC O_ASYNC /* kernel/compat */ |
| 157 | #define O_FSYNC O_SYNC /* compat */ |
| 158 | #define FNDELAY O_NONBLOCK /* compat */ |
| 159 | #define O_NDELAY O_NONBLOCK /* compat */ |
| 160 | #endif |
| 161 | #if defined(_KERNEL) |
| 162 | #define FNOSIGPIPE O_NOSIGPIPE /* kernel */ |
| 163 | #define FNONBLOCK O_NONBLOCK /* kernel */ |
| 164 | #define FFSYNC O_SYNC /* kernel */ |
| 165 | #define FDSYNC O_DSYNC /* kernel */ |
| 166 | #define FRSYNC O_RSYNC /* kernel */ |
| 167 | #define FALTIO O_ALT_IO /* kernel */ |
| 168 | #define FDIRECT O_DIRECT /* kernel */ |
| 169 | #endif |
| 170 | |
| 171 | /* |
| 172 | * Constants used for fcntl(2) |
| 173 | */ |
| 174 | |
| 175 | /* command values */ |
| 176 | #define F_DUPFD 0 /* duplicate file descriptor */ |
| 177 | #define F_GETFD 1 /* get file descriptor flags */ |
| 178 | #define F_SETFD 2 /* set file descriptor flags */ |
| 179 | #define F_GETFL 3 /* get file status flags */ |
| 180 | #define F_SETFL 4 /* set file status flags */ |
| 181 | #if (_POSIX_C_SOURCE - 0) >= 200112L || (_XOPEN_SOURCE - 0) >= 500 || \ |
| 182 | defined(_NETBSD_SOURCE) |
| 183 | #define F_GETOWN 5 /* get SIGIO/SIGURG proc/pgrp */ |
| 184 | #define F_SETOWN 6 /* set SIGIO/SIGURG proc/pgrp */ |
| 185 | #endif |
| 186 | #define F_GETLK 7 /* get record locking information */ |
| 187 | #define F_SETLK 8 /* set record locking information */ |
| 188 | #define F_SETLKW 9 /* F_SETLK; wait if blocked */ |
| 189 | #if defined(_NETBSD_SOURCE) |
| 190 | #define F_CLOSEM 10 /* close all fds >= to the one given */ |
| 191 | #define F_MAXFD 11 /* return the max open fd */ |
| 192 | #define F_DUPFD_CLOEXEC 12 /* close on exec duplicated fd */ |
| 193 | #define F_GETNOSIGPIPE 13 /* get SIGPIPE disposition */ |
| 194 | #define F_SETNOSIGPIPE 14 /* set SIGPIPE disposition */ |
| 195 | #endif |
| 196 | |
| 197 | /* file descriptor flags (F_GETFD, F_SETFD) */ |
| 198 | #define FD_CLOEXEC 1 /* close-on-exec flag */ |
| 199 | |
| 200 | /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */ |
| 201 | #define F_RDLCK 1 /* shared or read lock */ |
| 202 | #define F_UNLCK 2 /* unlock */ |
| 203 | #define F_WRLCK 3 /* exclusive or write lock */ |
| 204 | #ifdef _KERNEL |
| 205 | #define F_WAIT 0x010 /* Wait until lock is granted */ |
| 206 | #define F_FLOCK 0x020 /* Use flock(2) semantics for lock */ |
| 207 | #define F_POSIX 0x040 /* Use POSIX semantics for lock */ |
| 208 | #endif |
| 209 | |
| 210 | /* Constants for fcntl's passed to the underlying fs - like ioctl's. */ |
| 211 | #if defined(_NETBSD_SOURCE) |
| 212 | #define F_PARAM_MASK 0xfff |
| 213 | #define F_PARAM_LEN(x) (((x) >> 16) & F_PARAM_MASK) |
| 214 | #define F_PARAM_MAX 4095 |
| 215 | #define F_FSCTL (int)0x80000000 /* This fcntl goes to the fs */ |
| 216 | #define F_FSVOID (int)0x40000000 /* no parameters */ |
| 217 | #define F_FSOUT (int)0x20000000 /* copy out parameter */ |
| 218 | #define F_FSIN (int)0x10000000 /* copy in parameter */ |
| 219 | #define F_FSINOUT (F_FSIN | F_FSOUT) |
| 220 | #define F_FSDIRMASK (int)0x70000000 /* mask for IN/OUT/VOID */ |
| 221 | #define F_FSPRIV (int)0x00008000 /* command is fs-specific */ |
| 222 | |
| 223 | /* |
| 224 | * Define command macros for operations which, if implemented, must be |
| 225 | * the same for all fs's. |
| 226 | */ |
| 227 | #define _FCN(inout, num, len) \ |
| 228 | (F_FSCTL | inout | ((len & F_PARAM_MASK) << 16) | (num)) |
| 229 | #define _FCNO(c) _FCN(F_FSVOID, (c), 0) |
| 230 | #define _FCNR(c, t) _FCN(F_FSIN, (c), (int)sizeof(t)) |
| 231 | #define _FCNW(c, t) _FCN(F_FSOUT, (c), (int)sizeof(t)) |
| 232 | #define _FCNRW(c, t) _FCN(F_FSINOUT, (c), (int)sizeof(t)) |
| 233 | |
| 234 | /* |
| 235 | * Define command macros for fs-specific commands. |
| 236 | */ |
| 237 | #define _FCN_FSPRIV(inout, fs, num, len) \ |
| 238 | (F_FSCTL | F_FSPRIV | inout | ((len & F_PARAM_MASK) << 16) | \ |
| 239 | (fs) << 8 | (num)) |
| 240 | #define _FCNO_FSPRIV(f, c) _FCN_FSPRIV(F_FSVOID, (f), (c), 0) |
| 241 | #define _FCNR_FSPRIV(f, c, t) _FCN_FSPRIV(F_FSIN, (f), (c), (int)sizeof(t)) |
| 242 | #define _FCNW_FSPRIV(f, c, t) _FCN_FSPRIV(F_FSOUT, (f), (c), (int)sizeof(t)) |
| 243 | #define _FCNRW_FSPRIV(f, c, t) _FCN_FSPRIV(F_FSINOUT, (f), (c), (int)sizeof(t)) |
| 244 | |
| 245 | #endif /* _NETBSD_SOURCE */ |
| 246 | |
| 247 | /* |
| 248 | * Advisory file segment locking data type - |
| 249 | * information passed to system by user |
| 250 | */ |
| 251 | struct flock { |
| 252 | off_t l_start; /* starting offset */ |
| 253 | off_t l_len; /* len = 0 means until end of file */ |
| 254 | pid_t l_pid; /* lock owner */ |
| 255 | short l_type; /* lock type: read/write, etc. */ |
| 256 | short l_whence; /* type of l_start */ |
| 257 | }; |
| 258 | |
| 259 | |
| 260 | #if defined(_NETBSD_SOURCE) |
| 261 | /* lock operations for flock(2) */ |
| 262 | #define LOCK_SH 0x01 /* shared file lock */ |
| 263 | #define LOCK_EX 0x02 /* exclusive file lock */ |
| 264 | #define LOCK_NB 0x04 /* don't block when locking */ |
| 265 | #define LOCK_UN 0x08 /* unlock file */ |
| 266 | #endif |
| 267 | |
| 268 | /* Always ensure that these are consistent with <stdio.h> and <unistd.h>! */ |
| 269 | #ifndef SEEK_SET |
| 270 | #define SEEK_SET 0 /* set file offset to offset */ |
| 271 | #endif |
| 272 | #ifndef SEEK_CUR |
| 273 | #define SEEK_CUR 1 /* set file offset to current plus offset */ |
| 274 | #endif |
| 275 | #ifndef SEEK_END |
| 276 | #define SEEK_END 2 /* set file offset to EOF plus offset */ |
| 277 | #endif |
| 278 | |
| 279 | /* |
| 280 | * posix_advise advisories. |
| 281 | */ |
| 282 | |
| 283 | #define POSIX_FADV_NORMAL 0 /* default advice / no advice */ |
| 284 | #define POSIX_FADV_RANDOM 1 /* random access */ |
| 285 | #define POSIX_FADV_SEQUENTIAL 2 /* sequential access(lower to higher) */ |
| 286 | #define POSIX_FADV_WILLNEED 3 /* be needed in near future */ |
| 287 | #define POSIX_FADV_DONTNEED 4 /* not be needed in near future */ |
| 288 | #define POSIX_FADV_NOREUSE 5 /* be accessed once */ |
| 289 | |
| 290 | /* |
| 291 | * Constants for X/Open Extended API set 2 (a.k.a. C063) |
| 292 | */ |
| 293 | #if (_POSIX_C_SOURCE - 0) >= 200809L || (_XOPEN_SOURCE - 0 >= 700) || \ |
| 294 | defined(_INCOMPLETE_XOPEN_C063) || defined(_NETBSD_SOURCE) |
| 295 | #define AT_FDCWD -100 /* Use cwd for relative link target */ |
| 296 | #define AT_EACCESS 0x100 /* Use euig/egid for access checks */ |
| 297 | #define AT_SYMLINK_NOFOLLOW 0x200 /* Do not follow symlinks */ |
| 298 | #define AT_SYMLINK_FOLLOW 0x400 /* Follow symlinks */ |
| 299 | #define AT_REMOVEDIR 0x800 /* Remove directory only */ |
| 300 | #endif |
| 301 | |
| 302 | |
| 303 | #ifndef _KERNEL |
| 304 | #include <sys/cdefs.h> |
| 305 | |
| 306 | __BEGIN_DECLS |
| 307 | int open(const char *, int, ...); |
| 308 | int creat(const char *, mode_t); |
| 309 | int fcntl(int, int, ...); |
| 310 | #if defined(_NETBSD_SOURCE) |
| 311 | int flock(int, int); |
| 312 | #endif /* _NETBSD_SOURCE */ |
| 313 | int posix_fadvise(int, off_t, off_t, int); |
| 314 | |
| 315 | /* |
| 316 | * The Open Group Base Specifications, Issue 6; IEEE Std 1003.1-2001 (POSIX) |
| 317 | */ |
| 318 | #if (_POSIX_C_SOURCE - 0) >= 200112L || (_XOPEN_SOURCE - 0) >= 600 || \ |
| 319 | defined(_NETBSD_SOURCE) |
| 320 | int posix_fallocate(int, off_t, off_t); |
| 321 | #endif |
| 322 | |
| 323 | /* |
| 324 | * X/Open Extended API set 2 (a.k.a. C063) |
| 325 | */ |
| 326 | #if (_POSIX_C_SOURCE - 0) >= 200809L || (_XOPEN_SOURCE - 0 >= 700) || \ |
| 327 | defined(_INCOMPLETE_XOPEN_C063) || defined(_NETBSD_SOURCE) |
| 328 | int openat(int, const char *, int, ...); |
| 329 | #endif |
| 330 | |
| 331 | __END_DECLS |
| 332 | #endif /* !_KERNEL */ |
| 333 | |
| 334 | #endif /* !_SYS_FCNTL_H_ */ |
| 335 | |