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 2020 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 #if !defined(_STRICT_SYMBOLS) || defined(_XPG7) 90 #define O_DIRECTORY 0x1000000 /* fail if not a directory */ 91 #endif 92 #if !defined(_STRICT_SYMBOLS) 93 #define O_DIRECT 0x2000000 /* direct disk access hint */ 94 #endif 95 #if !defined(_STRICT_SYMBOLS) || defined(_XPG8) 96 #define O_CLOFORK 0x4000000 /* set the close-on-fork flag */ 97 #endif 98 99 /* 100 * fcntl(2) requests 101 * 102 * N.B.: values are not necessarily assigned sequentially below. 103 */ 104 #define F_DUPFD 0 /* Duplicate fildes */ 105 #define F_GETFD 1 /* Get fildes flags */ 106 #define F_SETFD 2 /* Set fildes flags */ 107 #define F_GETFL 3 /* Get file flags */ 108 #define F_GETXFL 45 /* Get file flags including open-only flags */ 109 #define F_SETFL 4 /* Set file flags */ 110 111 /* 112 * Applications that read /dev/mem must be built like the kernel. A 113 * new symbol "_KMEMUSER" is defined for this purpose. 114 */ 115 #if defined(_KERNEL) || defined(_KMEMUSER) 116 #define F_O_GETLK 5 /* SVR3 Get file lock (need for rfs, across */ 117 /* the wire compatibility */ 118 /* clustering: lock id contains both per-node sysid and node id */ 119 #define SYSIDMASK 0x0000ffff 120 #define GETSYSID(id) (id & SYSIDMASK) 121 #define NODEIDMASK 0xffff0000 122 #define BITS_IN_SYSID 16 123 #define GETNLMID(sysid) ((int)(((uint_t)(sysid) & NODEIDMASK) >> \ 124 BITS_IN_SYSID)) 125 126 /* Clustering: Macro used for PXFS locks */ 127 #define GETPXFSID(sysid) ((int)(((uint_t)(sysid) & NODEIDMASK) >> \ 128 BITS_IN_SYSID)) 129 #endif /* defined(_KERNEL) */ 130 131 #define F_CHKFL 8 /* Unused */ 132 #define F_DUP2FD 9 /* Duplicate fildes at third arg */ 133 #define F_DUP2FD_CLOEXEC 36 /* Like F_DUP2FD with O_CLOEXEC set */ 134 /* EINVAL is fildes matches arg1 */ 135 #define F_DUPFD_CLOEXEC 37 /* Like F_DUPFD with O_CLOEXEC set */ 136 #define F_DUP2FD_CLOFORK 57 /* This time with FD_CLOFORK */ 137 #define F_DUPFD_CLOFORK 58 /* Again, but with FD_CLOFORK */ 138 #define F_DUP3FD 59 /* Duplicate fildes, with flags */ 139 140 #define F_ISSTREAM 13 /* Is the file desc. a stream ? */ 141 #define F_PRIV 15 /* Turn on private access to file */ 142 #define F_NPRIV 16 /* Turn off private access to file */ 143 #define F_QUOTACTL 17 /* UFS quota call */ 144 #define F_BLOCKS 18 /* Get number of BLKSIZE blocks allocated */ 145 #define F_BLKSIZE 19 /* Get optimal I/O block size */ 146 /* 147 * Numbers 20-22 have been removed and should not be reused. 148 */ 149 #define F_GETOWN 23 /* Get owner (socket emulation) */ 150 #define F_SETOWN 24 /* Set owner (socket emulation) */ 151 #define F_REVOKE 25 /* Object reuse revoke access to file desc. */ 152 153 #define F_HASREMOTELOCKS 26 /* Does vp have NFS locks; private to lock */ 154 /* manager */ 155 156 /* 157 * Commands that refer to flock structures. The argument types differ between 158 * the large and small file environments; therefore, the #defined values must 159 * as well. 160 * The NBMAND forms are private and should not be used. 161 * The FLOCK forms are also private and should not be used. 162 */ 163 164 #if defined(_LP64) || _FILE_OFFSET_BITS == 32 165 /* "Native" application compilation environment */ 166 #define F_SETLK 6 /* Set file lock */ 167 #define F_SETLKW 7 /* Set file lock and wait */ 168 #define F_ALLOCSP 10 /* Allocate file space */ 169 #define F_FREESP 11 /* Free file space */ 170 #define F_GETLK 14 /* Get file lock */ 171 #define F_SETLK_NBMAND 42 /* private */ 172 #if !defined(_STRICT_SYMBOLS) 173 #define F_OFD_GETLK 47 /* Get file lock owned by file */ 174 #define F_OFD_SETLK 48 /* Set file lock owned by file */ 175 #define F_OFD_SETLKW 49 /* Set file lock owned by file and wait */ 176 #define F_FLOCK 53 /* private - set flock owned by file */ 177 #define F_FLOCKW 54 /* private - set flock owned by file and wait */ 178 #endif /* _STRICT_SYMBOLS */ 179 #else 180 /* ILP32 large file application compilation environment version */ 181 #define F_SETLK 34 /* Set file lock */ 182 #define F_SETLKW 35 /* Set file lock and wait */ 183 #define F_ALLOCSP 28 /* Alllocate file space */ 184 #define F_FREESP 27 /* Free file space */ 185 #define F_GETLK 33 /* Get file lock */ 186 #define F_SETLK_NBMAND 44 /* private */ 187 #if !defined(_STRICT_SYMBOLS) 188 #define F_OFD_GETLK 50 /* Get file lock owned by file */ 189 #define F_OFD_SETLK 51 /* Set file lock owned by file */ 190 #define F_OFD_SETLKW 52 /* Set file lock owned by file and wait */ 191 #define F_FLOCK 55 /* private - set flock owned by file */ 192 #define F_FLOCKW 56 /* private - set flock owned by file and wait */ 193 #endif /* _STRICT_SYMBOLS */ 194 #endif /* _LP64 || _FILE_OFFSET_BITS == 32 */ 195 196 #if defined(_LARGEFILE64_SOURCE) 197 198 #if !defined(_LP64) || defined(_KERNEL) 199 /* 200 * transitional large file interface version 201 * These are only valid in a 32 bit application compiled with large files 202 * option, for source compatibility, the 64-bit versions are mapped back 203 * to the native versions. 204 */ 205 #define F_SETLK64 34 /* Set file lock */ 206 #define F_SETLKW64 35 /* Set file lock and wait */ 207 #define F_ALLOCSP64 28 /* Allocate file space */ 208 #define F_FREESP64 27 /* Free file space */ 209 #define F_GETLK64 33 /* Get file lock */ 210 #define F_SETLK64_NBMAND 44 /* private */ 211 #if !defined(_STRICT_SYMBOLS) 212 #define F_OFD_GETLK64 50 /* Get file lock owned by file */ 213 #define F_OFD_SETLK64 51 /* Set file lock owned by file */ 214 #define F_OFD_SETLKW64 52 /* Set file lock owned by file and wait */ 215 #define F_FLOCK64 55 /* private - set flock owned by file */ 216 #define F_FLOCKW64 56 /* private - set flock owned by file and wait */ 217 #endif /* _STRICT_SYMBOLS */ 218 #else 219 #define F_SETLK64 6 /* Set file lock */ 220 #define F_SETLKW64 7 /* Set file lock and wait */ 221 #define F_ALLOCSP64 10 /* Allocate file space */ 222 #define F_FREESP64 11 /* Free file space */ 223 #define F_GETLK64 14 /* Get file lock */ 224 #define F_SETLK64_NBMAND 42 /* private */ 225 #if !defined(_STRICT_SYMBOLS) 226 #define F_OFD_GETLK64 47 /* Get file lock owned by file */ 227 #define F_OFD_SETLK64 48 /* Set file lock owned by file */ 228 #define F_OFD_SETLKW64 49 /* Set file lock owned by file and wait */ 229 #define F_FLOCK64 53 /* private - set flock owned by file */ 230 #define F_FLOCKW64 54 /* private - set flock owned by file and wait */ 231 #endif /* _STRICT_SYMBOLS */ 232 #endif /* !_LP64 || _KERNEL */ 233 234 #endif /* _LARGEFILE64_SOURCE */ 235 236 #define F_SHARE 40 /* Set a file share reservation */ 237 #define F_UNSHARE 41 /* Remove a file share reservation */ 238 #define F_SHARE_NBMAND 43 /* private */ 239 240 #define F_BADFD 46 /* Create Poison FD */ 241 242 /* 243 * File segment locking set data type - information passed to system by user. 244 */ 245 246 /* regular version, for both small and large file compilation environment */ 247 typedef struct flock { 248 short l_type; 249 short l_whence; 250 off_t l_start; 251 off_t l_len; /* len == 0 means until end of file */ 252 int l_sysid; 253 pid_t l_pid; 254 long l_pad[4]; /* reserve area */ 255 } flock_t; 256 257 #if defined(_SYSCALL32) 258 259 /* Kernel's view of ILP32 flock structure */ 260 261 typedef struct flock32 { 262 int16_t l_type; 263 int16_t l_whence; 264 off32_t l_start; 265 off32_t l_len; /* len == 0 means until end of file */ 266 int32_t l_sysid; 267 pid32_t l_pid; 268 int32_t l_pad[4]; /* reserve area */ 269 } flock32_t; 270 271 #endif /* _SYSCALL32 */ 272 273 /* transitional large file interface version */ 274 275 #if defined(_LARGEFILE64_SOURCE) 276 277 typedef struct flock64 { 278 short l_type; 279 short l_whence; 280 off64_t l_start; 281 off64_t l_len; /* len == 0 means until end of file */ 282 int l_sysid; 283 pid_t l_pid; 284 long l_pad[4]; /* reserve area */ 285 } flock64_t; 286 287 #if defined(_SYSCALL32) 288 289 /* Kernel's view of ILP32 flock64 */ 290 291 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4 292 #pragma pack(4) 293 #endif 294 295 typedef struct flock64_32 { 296 int16_t l_type; 297 int16_t l_whence; 298 off64_t l_start; 299 off64_t l_len; /* len == 0 means until end of file */ 300 int32_t l_sysid; 301 pid32_t l_pid; 302 int32_t l_pad[4]; /* reserve area */ 303 } flock64_32_t; 304 305 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4 306 #pragma pack() 307 #endif 308 309 /* Kernel's view of LP64 flock64 */ 310 311 typedef struct flock64_64 { 312 int16_t l_type; 313 int16_t l_whence; 314 off64_t l_start; 315 off64_t l_len; /* len == 0 means until end of file */ 316 int32_t l_sysid; 317 pid32_t l_pid; 318 int64_t l_pad[4]; /* reserve area */ 319 } flock64_64_t; 320 321 #endif /* _SYSCALL32 */ 322 323 #endif /* _LARGEFILE64_SOURCE */ 324 325 #if defined(_KERNEL) || defined(_KMEMUSER) 326 /* SVr3 flock type; needed for rfs across the wire compatibility */ 327 typedef struct o_flock { 328 int16_t l_type; 329 int16_t l_whence; 330 int32_t l_start; 331 int32_t l_len; /* len == 0 means until end of file */ 332 int16_t l_sysid; 333 int16_t l_pid; 334 } o_flock_t; 335 #endif /* defined(_KERNEL) */ 336 337 /* 338 * File segment locking types. 339 */ 340 #define F_RDLCK 01 /* Read lock */ 341 #define F_WRLCK 02 /* Write lock */ 342 #define F_UNLCK 03 /* Remove lock(s) */ 343 #define F_UNLKSYS 04 /* remove remote locks for a given system */ 344 345 /* 346 * POSIX constants 347 */ 348 349 /* Mask for file access modes */ 350 #define O_ACCMODE (O_SEARCH | O_EXEC | 0x3) 351 #define FD_CLOEXEC 1 /* close-on-exec flag */ 352 #define FD_CLOFORK 2 /* close-on-fork flag */ 353 354 /* 355 * DIRECTIO 356 */ 357 #if defined(__EXTENSIONS__) || !defined(__XOPEN_OR_POSIX) 358 #define DIRECTIO_OFF (0) 359 #define DIRECTIO_ON (1) 360 361 /* 362 * File share reservation type 363 */ 364 typedef struct fshare { 365 short f_access; 366 short f_deny; 367 int f_id; 368 } fshare_t; 369 370 /* 371 * f_access values 372 */ 373 #define F_RDACC 0x1 /* Read-only share access */ 374 #define F_WRACC 0x2 /* Write-only share access */ 375 #define F_RWACC 0x3 /* Read-Write share access */ 376 #define F_RMACC 0x4 /* private flag: Delete share access */ 377 #define F_MDACC 0x20 /* private flag: Metadata share access */ 378 379 /* 380 * f_deny values 381 */ 382 #define F_NODNY 0x0 /* Don't deny others access */ 383 #define F_RDDNY 0x1 /* Deny others read share access */ 384 #define F_WRDNY 0x2 /* Deny others write share access */ 385 #define F_RWDNY 0x3 /* Deny others read or write share access */ 386 #define F_RMDNY 0x4 /* private flag: Deny delete share access */ 387 #define F_COMPAT 0x8 /* Set share to old DOS compatibility mode */ 388 #define F_MANDDNY 0x10 /* private flag: mandatory enforcement */ 389 #endif /* defined(__EXTENSIONS__) || !defined(__XOPEN_OR_POSIX) */ 390 391 /* 392 * Special flags for functions such as openat(), fstatat().... 393 */ 394 #if !defined(__XOPEN_OR_POSIX) || defined(_ATFILE_SOURCE) || \ 395 defined(__EXTENSIONS__) 396 /* || defined(_XPG7) */ 397 #define AT_FDCWD 0xffd19553 398 #define AT_SYMLINK_NOFOLLOW 0x1000 399 #define AT_SYMLINK_FOLLOW 0x2000 /* only for linkat() */ 400 #define AT_REMOVEDIR 0x1 401 #define _AT_TRIGGER 0x2 402 #define AT_EACCESS 0x4 /* use EUID/EGID for access */ 403 #endif 404 405 #if !defined(__XOPEN_OR_POSIX) || defined(_XPG6) || defined(__EXTENSIONS__) 406 /* advice for posix_fadvise */ 407 #define POSIX_FADV_NORMAL 0 408 #define POSIX_FADV_RANDOM 1 409 #define POSIX_FADV_SEQUENTIAL 2 410 #define POSIX_FADV_WILLNEED 3 411 #define POSIX_FADV_DONTNEED 4 412 #define POSIX_FADV_NOREUSE 5 413 #endif 414 415 #ifdef __cplusplus 416 } 417 #endif 418 419 #endif /* _SYS_FCNTL_H */ 420