1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 22 /* 23 * Copyright (c) 1989, 2010, Oracle and/or its affiliates. All rights reserved. 24 */ 25 26 /* Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */ 27 /* All Rights Reserved */ 28 29 /* 30 * University Copyright- Copyright (c) 1982, 1986, 1988 31 * The Regents of the University of California 32 * All Rights Reserved 33 * 34 * University Acknowledgment- Portions of this document are derived from 35 * software developed by the University of California, Berkeley, and its 36 * contributors. 37 */ 38 39 /* Copyright (c) 2013, OmniTI Computer Consulting, Inc. All rights reserved. */ 40 /* Copyright 2015, Joyent, Inc. */ 41 42 #ifndef _SYS_FCNTL_H 43 #define _SYS_FCNTL_H 44 45 #include <sys/feature_tests.h> 46 47 #include <sys/types.h> 48 49 #ifdef __cplusplus 50 extern "C" { 51 #endif 52 53 /* 54 * Flag values accessible to open(2) and fcntl(2) 55 * The first five can only be set (exclusively) by open(2). 56 */ 57 #define O_RDONLY 0 58 #define O_WRONLY 1 59 #define O_RDWR 2 60 #define O_SEARCH 0x200000 61 #define O_EXEC 0x400000 62 #if defined(__EXTENSIONS__) || !defined(_POSIX_C_SOURCE) 63 #define O_NDELAY 0x04 /* non-blocking I/O */ 64 #endif /* defined(__EXTENSIONS__) || !defined(_POSIX_C_SOURCE) */ 65 #define O_APPEND 0x08 /* append (writes guaranteed at the end) */ 66 #if defined(__EXTENSIONS__) || !defined(_POSIX_C_SOURCE) || \ 67 (_POSIX_C_SOURCE > 2) || defined(_XOPEN_SOURCE) 68 #define O_SYNC 0x10 /* synchronized file update option */ 69 #define O_DSYNC 0x40 /* synchronized data update option */ 70 #define O_RSYNC 0x8000 /* synchronized file update option */ 71 /* defines read/write file integrity */ 72 #endif /* defined(__EXTENSIONS__) || !defined(_POSIX_C_SOURCE) ... */ 73 #define O_NONBLOCK 0x80 /* non-blocking I/O (POSIX) */ 74 #ifdef _LARGEFILE_SOURCE 75 #define O_LARGEFILE 0x2000 76 #endif 77 78 /* 79 * Flag values accessible only to open(2). 80 */ 81 #define O_CREAT 0x100 /* open with file create (uses third arg) */ 82 #define O_TRUNC 0x200 /* open with truncation */ 83 #define O_EXCL 0x400 /* exclusive open */ 84 #define O_NOCTTY 0x800 /* don't allocate controlling tty (POSIX) */ 85 #define O_XATTR 0x4000 /* extended attribute */ 86 #define O_NOFOLLOW 0x20000 /* don't follow symlinks */ 87 #define O_NOLINKS 0x40000 /* don't allow multiple hard links */ 88 #define O_CLOEXEC 0x800000 /* set the close-on-exec flag */ 89 90 /* 91 * fcntl(2) requests 92 * 93 * N.B.: values are not necessarily assigned sequentially below. 94 */ 95 #define F_DUPFD 0 /* Duplicate fildes */ 96 #define F_GETFD 1 /* Get fildes flags */ 97 #define F_SETFD 2 /* Set fildes flags */ 98 #define F_GETFL 3 /* Get file flags */ 99 #define F_GETXFL 45 /* Get file flags including open-only flags */ 100 #define F_SETFL 4 /* Set file flags */ 101 102 /* 103 * Applications that read /dev/mem must be built like the kernel. A 104 * new symbol "_KMEMUSER" is defined for this purpose. 105 */ 106 #if defined(_KERNEL) || defined(_KMEMUSER) 107 #define F_O_GETLK 5 /* SVR3 Get file lock (need for rfs, across */ 108 /* the wire compatibility */ 109 /* clustering: lock id contains both per-node sysid and node id */ 110 #define SYSIDMASK 0x0000ffff 111 #define GETSYSID(id) (id & SYSIDMASK) 112 #define NODEIDMASK 0xffff0000 113 #define BITS_IN_SYSID 16 114 #define GETNLMID(sysid) ((int)(((uint_t)(sysid) & NODEIDMASK) >> \ 115 BITS_IN_SYSID)) 116 117 /* Clustering: Macro used for PXFS locks */ 118 #define GETPXFSID(sysid) ((int)(((uint_t)(sysid) & NODEIDMASK) >> \ 119 BITS_IN_SYSID)) 120 #endif /* defined(_KERNEL) */ 121 122 #define F_CHKFL 8 /* Unused */ 123 #define F_DUP2FD 9 /* Duplicate fildes at third arg */ 124 #define F_DUP2FD_CLOEXEC 36 /* Like F_DUP2FD with O_CLOEXEC set */ 125 /* EINVAL is fildes matches arg1 */ 126 #define F_DUPFD_CLOEXEC 37 /* Like F_DUPFD with O_CLOEXEC set */ 127 128 #define F_ISSTREAM 13 /* Is the file desc. a stream ? */ 129 #define F_PRIV 15 /* Turn on private access to file */ 130 #define F_NPRIV 16 /* Turn off private access to file */ 131 #define F_QUOTACTL 17 /* UFS quota call */ 132 #define F_BLOCKS 18 /* Get number of BLKSIZE blocks allocated */ 133 #define F_BLKSIZE 19 /* Get optimal I/O block size */ 134 /* 135 * Numbers 20-22 have been removed and should not be reused. 136 */ 137 #define F_GETOWN 23 /* Get owner (socket emulation) */ 138 #define F_SETOWN 24 /* Set owner (socket emulation) */ 139 #define F_REVOKE 25 /* Object reuse revoke access to file desc. */ 140 141 #define F_HASREMOTELOCKS 26 /* Does vp have NFS locks; private to lock */ 142 /* manager */ 143 144 /* 145 * Commands that refer to flock structures. The argument types differ between 146 * the large and small file environments; therefore, the #defined values must 147 * as well. 148 * The NBMAND forms are private and should not be used. 149 * The FLOCK forms are also private and should not be used. 150 */ 151 152 #if defined(_LP64) || _FILE_OFFSET_BITS == 32 153 /* "Native" application compilation environment */ 154 #define F_SETLK 6 /* Set file lock */ 155 #define F_SETLKW 7 /* Set file lock and wait */ 156 #define F_ALLOCSP 10 /* Allocate file space */ 157 #define F_FREESP 11 /* Free file space */ 158 #define F_GETLK 14 /* Get file lock */ 159 #define F_SETLK_NBMAND 42 /* private */ 160 #if !defined(_STRICT_SYMBOLS) 161 #define F_OFD_GETLK 47 /* Get file lock owned by file */ 162 #define F_OFD_SETLK 48 /* Set file lock owned by file */ 163 #define F_OFD_SETLKW 49 /* Set file lock owned by file and wait */ 164 #define F_FLOCK 53 /* private - set flock owned by file */ 165 #define F_FLOCKW 54 /* private - set flock owned by file and wait */ 166 #endif /* _STRICT_SYMBOLS */ 167 #else 168 /* ILP32 large file application compilation environment version */ 169 #define F_SETLK 34 /* Set file lock */ 170 #define F_SETLKW 35 /* Set file lock and wait */ 171 #define F_ALLOCSP 28 /* Alllocate file space */ 172 #define F_FREESP 27 /* Free file space */ 173 #define F_GETLK 33 /* Get file lock */ 174 #define F_SETLK_NBMAND 44 /* private */ 175 #if !defined(_STRICT_SYMBOLS) 176 #define F_OFD_GETLK 50 /* Get file lock owned by file */ 177 #define F_OFD_SETLK 51 /* Set file lock owned by file */ 178 #define F_OFD_SETLKW 52 /* Set file lock owned by file and wait */ 179 #define F_FLOCK 55 /* private - set flock owned by file */ 180 #define F_FLOCKW 56 /* private - set flock owned by file and wait */ 181 #endif /* _STRICT_SYMBOLS */ 182 #endif /* _LP64 || _FILE_OFFSET_BITS == 32 */ 183 184 #if defined(_LARGEFILE64_SOURCE) 185 186 #if !defined(_LP64) || defined(_KERNEL) 187 /* 188 * transitional large file interface version 189 * These are only valid in a 32 bit application compiled with large files 190 * option, for source compatibility, the 64-bit versions are mapped back 191 * to the native versions. 192 */ 193 #define F_SETLK64 34 /* Set file lock */ 194 #define F_SETLKW64 35 /* Set file lock and wait */ 195 #define F_ALLOCSP64 28 /* Allocate file space */ 196 #define F_FREESP64 27 /* Free file space */ 197 #define F_GETLK64 33 /* Get file lock */ 198 #define F_SETLK64_NBMAND 44 /* private */ 199 #if !defined(_STRICT_SYMBOLS) 200 #define F_OFD_GETLK64 50 /* Get file lock owned by file */ 201 #define F_OFD_SETLK64 51 /* Set file lock owned by file */ 202 #define F_OFD_SETLKW64 52 /* Set file lock owned by file and wait */ 203 #define F_FLOCK64 55 /* private - set flock owned by file */ 204 #define F_FLOCKW64 56 /* private - set flock owned by file and wait */ 205 #endif /* _STRICT_SYMBOLS */ 206 #else 207 #define F_SETLK64 6 /* Set file lock */ 208 #define F_SETLKW64 7 /* Set file lock and wait */ 209 #define F_ALLOCSP64 10 /* Allocate file space */ 210 #define F_FREESP64 11 /* Free file space */ 211 #define F_GETLK64 14 /* Get file lock */ 212 #define F_SETLK64_NBMAND 42 /* private */ 213 #if !defined(_STRICT_SYMBOLS) 214 #define F_OFD_GETLK64 47 /* Get file lock owned by file */ 215 #define F_OFD_SETLK64 48 /* Set file lock owned by file */ 216 #define F_OFD_SETLKW64 49 /* Set file lock owned by file and wait */ 217 #define F_FLOCK64 53 /* private - set flock owned by file */ 218 #define F_FLOCKW64 54 /* private - set flock owned by file and wait */ 219 #endif /* _STRICT_SYMBOLS */ 220 #endif /* !_LP64 || _KERNEL */ 221 222 #endif /* _LARGEFILE64_SOURCE */ 223 224 #define F_SHARE 40 /* Set a file share reservation */ 225 #define F_UNSHARE 41 /* Remove a file share reservation */ 226 #define F_SHARE_NBMAND 43 /* private */ 227 228 #define F_BADFD 46 /* Create Poison FD */ 229 230 /* 231 * File segment locking set data type - information passed to system by user. 232 */ 233 234 /* regular version, for both small and large file compilation environment */ 235 typedef struct flock { 236 short l_type; 237 short l_whence; 238 off_t l_start; 239 off_t l_len; /* len == 0 means until end of file */ 240 int l_sysid; 241 pid_t l_pid; 242 long l_pad[4]; /* reserve area */ 243 } flock_t; 244 245 #if defined(_SYSCALL32) 246 247 /* Kernel's view of ILP32 flock structure */ 248 249 typedef struct flock32 { 250 int16_t l_type; 251 int16_t l_whence; 252 off32_t l_start; 253 off32_t l_len; /* len == 0 means until end of file */ 254 int32_t l_sysid; 255 pid32_t l_pid; 256 int32_t l_pad[4]; /* reserve area */ 257 } flock32_t; 258 259 #endif /* _SYSCALL32 */ 260 261 /* transitional large file interface version */ 262 263 #if defined(_LARGEFILE64_SOURCE) 264 265 typedef struct flock64 { 266 short l_type; 267 short l_whence; 268 off64_t l_start; 269 off64_t l_len; /* len == 0 means until end of file */ 270 int l_sysid; 271 pid_t l_pid; 272 long l_pad[4]; /* reserve area */ 273 } flock64_t; 274 275 #if defined(_SYSCALL32) 276 277 /* Kernel's view of ILP32 flock64 */ 278 279 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4 280 #pragma pack(4) 281 #endif 282 283 typedef struct flock64_32 { 284 int16_t l_type; 285 int16_t l_whence; 286 off64_t l_start; 287 off64_t l_len; /* len == 0 means until end of file */ 288 int32_t l_sysid; 289 pid32_t l_pid; 290 int32_t l_pad[4]; /* reserve area */ 291 } flock64_32_t; 292 293 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4 294 #pragma pack() 295 #endif 296 297 /* Kernel's view of LP64 flock64 */ 298 299 typedef struct flock64_64 { 300 int16_t l_type; 301 int16_t l_whence; 302 off64_t l_start; 303 off64_t l_len; /* len == 0 means until end of file */ 304 int32_t l_sysid; 305 pid32_t l_pid; 306 int64_t l_pad[4]; /* reserve area */ 307 } flock64_64_t; 308 309 #endif /* _SYSCALL32 */ 310 311 #endif /* _LARGEFILE64_SOURCE */ 312 313 #if defined(_KERNEL) || defined(_KMEMUSER) 314 /* SVr3 flock type; needed for rfs across the wire compatibility */ 315 typedef struct o_flock { 316 int16_t l_type; 317 int16_t l_whence; 318 int32_t l_start; 319 int32_t l_len; /* len == 0 means until end of file */ 320 int16_t l_sysid; 321 int16_t l_pid; 322 } o_flock_t; 323 #endif /* defined(_KERNEL) */ 324 325 /* 326 * File segment locking types. 327 */ 328 #define F_RDLCK 01 /* Read lock */ 329 #define F_WRLCK 02 /* Write lock */ 330 #define F_UNLCK 03 /* Remove lock(s) */ 331 #define F_UNLKSYS 04 /* remove remote locks for a given system */ 332 333 /* 334 * POSIX constants 335 */ 336 337 /* Mask for file access modes */ 338 #define O_ACCMODE (O_SEARCH | O_EXEC | 0x3) 339 #define FD_CLOEXEC 1 /* close on exec flag */ 340 341 /* 342 * DIRECTIO 343 */ 344 #if defined(__EXTENSIONS__) || !defined(__XOPEN_OR_POSIX) 345 #define DIRECTIO_OFF (0) 346 #define DIRECTIO_ON (1) 347 348 /* 349 * File share reservation type 350 */ 351 typedef struct fshare { 352 short f_access; 353 short f_deny; 354 int f_id; 355 } fshare_t; 356 357 /* 358 * f_access values 359 */ 360 #define F_RDACC 0x1 /* Read-only share access */ 361 #define F_WRACC 0x2 /* Write-only share access */ 362 #define F_RWACC 0x3 /* Read-Write share access */ 363 #define F_RMACC 0x4 /* private flag: Delete share access */ 364 #define F_MDACC 0x20 /* private flag: Metadata share access */ 365 366 /* 367 * f_deny values 368 */ 369 #define F_NODNY 0x0 /* Don't deny others access */ 370 #define F_RDDNY 0x1 /* Deny others read share access */ 371 #define F_WRDNY 0x2 /* Deny others write share access */ 372 #define F_RWDNY 0x3 /* Deny others read or write share access */ 373 #define F_RMDNY 0x4 /* private flag: Deny delete share access */ 374 #define F_COMPAT 0x8 /* Set share to old DOS compatibility mode */ 375 #define F_MANDDNY 0x10 /* private flag: mandatory enforcement */ 376 #endif /* defined(__EXTENSIONS__) || !defined(__XOPEN_OR_POSIX) */ 377 378 /* 379 * Special flags for functions such as openat(), fstatat().... 380 */ 381 #if !defined(__XOPEN_OR_POSIX) || defined(_ATFILE_SOURCE) || \ 382 defined(__EXTENSIONS__) 383 /* || defined(_XPG7) */ 384 #define AT_FDCWD 0xffd19553 385 #define AT_SYMLINK_NOFOLLOW 0x1000 386 #define AT_SYMLINK_FOLLOW 0x2000 /* only for linkat() */ 387 #define AT_REMOVEDIR 0x1 388 #define _AT_TRIGGER 0x2 389 #define AT_EACCESS 0x4 /* use EUID/EGID for access */ 390 #endif 391 392 #if !defined(__XOPEN_OR_POSIX) || defined(_XPG6) || defined(__EXTENSIONS__) 393 /* advice for posix_fadvise */ 394 #define POSIX_FADV_NORMAL 0 395 #define POSIX_FADV_RANDOM 1 396 #define POSIX_FADV_SEQUENTIAL 2 397 #define POSIX_FADV_WILLNEED 3 398 #define POSIX_FADV_DONTNEED 4 399 #define POSIX_FADV_NOREUSE 5 400 #endif 401 402 #ifdef __cplusplus 403 } 404 #endif 405 406 #endif /* _SYS_FCNTL_H */