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 2008 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 /* Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */ 28 /* All Rights Reserved */ 29 30 /* 31 * University Copyright- Copyright (c) 1982, 1986, 1988 32 * The Regents of the University of California 33 * All Rights Reserved 34 * 35 * University Acknowledgment- Portions of this document are derived from 36 * software developed by the University of California, Berkeley, and its 37 * contributors. 38 */ 39 40 #ifndef _SYS_FCNTL_H 41 #define _SYS_FCNTL_H 42 43 #pragma ident "%Z%%M% %I% %E% SMI" 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 three can only be set by open(2)). 56 */ 57 #define O_RDONLY 0 58 #define O_WRONLY 1 59 #define O_RDWR 2 60 #if defined(__EXTENSIONS__) || !defined(_POSIX_C_SOURCE) 61 #define O_NDELAY 0x04 /* non-blocking I/O */ 62 #endif /* defined(__EXTENSIONS__) || !defined(_POSIX_C_SOURCE) */ 63 #define O_APPEND 0x08 /* append (writes guaranteed at the end) */ 64 #if defined(__EXTENSIONS__) || !defined(_POSIX_C_SOURCE) || \ 65 (_POSIX_C_SOURCE > 2) || defined(_XOPEN_SOURCE) 66 #define O_SYNC 0x10 /* synchronized file update option */ 67 #define O_DSYNC 0x40 /* synchronized data update option */ 68 #define O_RSYNC 0x8000 /* synchronized file update option */ 69 /* defines read/write file integrity */ 70 #endif /* defined(__EXTENSIONS__) || !defined(_POSIX_C_SOURCE) ... */ 71 #define O_NONBLOCK 0x80 /* non-blocking I/O (POSIX) */ 72 #ifdef SUN_SRC_COMPAT 73 #define O_PRIV 0x1000 /* Private access to file */ 74 #endif /* SUN_SRC_COMPAT */ 75 #ifdef _LARGEFILE_SOURCE 76 #define O_LARGEFILE 0x2000 77 #endif 78 79 /* 80 * Flag values accessible only to open(2). 81 */ 82 #define O_CREAT 0x100 /* open with file create (uses third arg) */ 83 #define O_TRUNC 0x200 /* open with truncation */ 84 #define O_EXCL 0x400 /* exclusive open */ 85 #define O_NOCTTY 0x800 /* don't allocate controlling tty (POSIX) */ 86 #define O_XATTR 0x4000 /* extended attribute */ 87 #define O_NOFOLLOW 0x20000 /* don't follow symlinks */ 88 #define O_NOLINKS 0x40000 /* don't allow multiple hard links */ 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 125 #define F_ISSTREAM 13 /* Is the file desc. a stream ? */ 126 #define F_PRIV 15 /* Turn on private access to file */ 127 #define F_NPRIV 16 /* Turn off private access to file */ 128 #define F_QUOTACTL 17 /* UFS quota call */ 129 #define F_BLOCKS 18 /* Get number of BLKSIZE blocks allocated */ 130 #define F_BLKSIZE 19 /* Get optimal I/O block size */ 131 /* 132 * Numbers 20-22 have been removed and should not be reused. 133 */ 134 #define F_GETOWN 23 /* Get owner (socket emulation) */ 135 #define F_SETOWN 24 /* Set owner (socket emulation) */ 136 #define F_REVOKE 25 /* Object reuse revoke access to file desc. */ 137 138 #define F_HASREMOTELOCKS 26 /* Does vp have NFS locks; private to lock */ 139 /* manager */ 140 141 /* 142 * Commands that refer to flock structures. The argument types differ between 143 * the large and small file environments; therefore, the #defined values must 144 * as well. 145 * The NBMAND forms are private and should not be used. 146 */ 147 148 #if defined(_LP64) || _FILE_OFFSET_BITS == 32 149 /* "Native" application compilation environment */ 150 #define F_SETLK 6 /* Set file lock */ 151 #define F_SETLKW 7 /* Set file lock and wait */ 152 #define F_ALLOCSP 10 /* Allocate file space */ 153 #define F_FREESP 11 /* Free file space */ 154 #define F_GETLK 14 /* Get file lock */ 155 #define F_SETLK_NBMAND 42 /* private */ 156 #else 157 /* ILP32 large file application compilation environment version */ 158 #define F_SETLK 34 /* Set file lock */ 159 #define F_SETLKW 35 /* Set file lock and wait */ 160 #define F_ALLOCSP 28 /* Alllocate file space */ 161 #define F_FREESP 27 /* Free file space */ 162 #define F_GETLK 33 /* Get file lock */ 163 #define F_SETLK_NBMAND 44 /* private */ 164 #endif /* _LP64 || _FILE_OFFSET_BITS == 32 */ 165 166 #if defined(_LARGEFILE64_SOURCE) 167 168 #if !defined(_LP64) || defined(_KERNEL) 169 /* 170 * transitional large file interface version 171 * These are only valid in a 32 bit application compiled with large files 172 * option, for source compatibility, the 64-bit versions are mapped back 173 * to the native versions. 174 */ 175 #define F_SETLK64 34 /* Set file lock */ 176 #define F_SETLKW64 35 /* Set file lock and wait */ 177 #define F_ALLOCSP64 28 /* Allocate file space */ 178 #define F_FREESP64 27 /* Free file space */ 179 #define F_GETLK64 33 /* Get file lock */ 180 #define F_SETLK64_NBMAND 44 /* private */ 181 #else 182 #define F_SETLK64 6 /* Set file lock */ 183 #define F_SETLKW64 7 /* Set file lock and wait */ 184 #define F_ALLOCSP64 10 /* Allocate file space */ 185 #define F_FREESP64 11 /* Free file space */ 186 #define F_GETLK64 14 /* Get file lock */ 187 #define F_SETLK64_NBMAND 42 /* private */ 188 #endif /* !_LP64 || _KERNEL */ 189 190 #endif /* _LARGEFILE64_SOURCE */ 191 192 #define F_SHARE 40 /* Set a file share reservation */ 193 #define F_UNSHARE 41 /* Remove a file share reservation */ 194 #define F_SHARE_NBMAND 43 /* private */ 195 196 #define F_BADFD 46 /* Create Poison FD */ 197 198 /* 199 * File segment locking set data type - information passed to system by user. 200 */ 201 202 /* regular version, for both small and large file compilation environment */ 203 typedef struct flock { 204 short l_type; 205 short l_whence; 206 off_t l_start; 207 off_t l_len; /* len == 0 means until end of file */ 208 int l_sysid; 209 pid_t l_pid; 210 long l_pad[4]; /* reserve area */ 211 } flock_t; 212 213 #if defined(_SYSCALL32) 214 215 /* Kernel's view of ILP32 flock structure */ 216 217 typedef struct flock32 { 218 int16_t l_type; 219 int16_t l_whence; 220 off32_t l_start; 221 off32_t l_len; /* len == 0 means until end of file */ 222 int32_t l_sysid; 223 pid32_t l_pid; 224 int32_t l_pad[4]; /* reserve area */ 225 } flock32_t; 226 227 #endif /* _SYSCALL32 */ 228 229 /* transitional large file interface version */ 230 231 #if defined(_LARGEFILE64_SOURCE) 232 233 typedef struct flock64 { 234 short l_type; 235 short l_whence; 236 off64_t l_start; 237 off64_t l_len; /* len == 0 means until end of file */ 238 int l_sysid; 239 pid_t l_pid; 240 long l_pad[4]; /* reserve area */ 241 } flock64_t; 242 243 #if defined(_SYSCALL32) 244 245 /* Kernel's view of ILP32 flock64 */ 246 247 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4 248 #pragma pack(4) 249 #endif 250 251 typedef struct flock64_32 { 252 int16_t l_type; 253 int16_t l_whence; 254 off64_t l_start; 255 off64_t l_len; /* len == 0 means until end of file */ 256 int32_t l_sysid; 257 pid32_t l_pid; 258 int32_t l_pad[4]; /* reserve area */ 259 } flock64_32_t; 260 261 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4 262 #pragma pack() 263 #endif 264 265 /* Kernel's view of LP64 flock64 */ 266 267 typedef struct flock64_64 { 268 int16_t l_type; 269 int16_t l_whence; 270 off64_t l_start; 271 off64_t l_len; /* len == 0 means until end of file */ 272 int32_t l_sysid; 273 pid32_t l_pid; 274 int64_t l_pad[4]; /* reserve area */ 275 } flock64_64_t; 276 277 #endif /* _SYSCALL32 */ 278 279 #endif /* _LARGEFILE64_SOURCE */ 280 281 #if defined(_KERNEL) || defined(_KMEMUSER) 282 /* SVr3 flock type; needed for rfs across the wire compatibility */ 283 typedef struct o_flock { 284 int16_t l_type; 285 int16_t l_whence; 286 int32_t l_start; 287 int32_t l_len; /* len == 0 means until end of file */ 288 int16_t l_sysid; 289 int16_t l_pid; 290 } o_flock_t; 291 #endif /* defined(_KERNEL) */ 292 293 /* 294 * File segment locking types. 295 */ 296 #define F_RDLCK 01 /* Read lock */ 297 #define F_WRLCK 02 /* Write lock */ 298 #define F_UNLCK 03 /* Remove lock(s) */ 299 #define F_UNLKSYS 04 /* remove remote locks for a given system */ 300 301 /* 302 * POSIX constants 303 */ 304 305 #define O_ACCMODE 3 /* Mask for file access modes */ 306 #define FD_CLOEXEC 1 /* close on exec flag */ 307 308 /* 309 * DIRECTIO 310 */ 311 #if defined(__EXTENSIONS__) || !defined(__XOPEN_OR_POSIX) 312 #define DIRECTIO_OFF (0) 313 #define DIRECTIO_ON (1) 314 315 /* 316 * File share reservation type 317 */ 318 typedef struct fshare { 319 short f_access; 320 short f_deny; 321 int f_id; 322 } fshare_t; 323 324 /* 325 * f_access values 326 */ 327 #define F_RDACC 0x1 /* Read-only share access */ 328 #define F_WRACC 0x2 /* Write-only share access */ 329 #define F_RWACC 0x3 /* Read-Write share access */ 330 #define F_RMACC 0x4 /* private flag: Delete share access */ 331 #define F_MDACC 0x20 /* private flag: Metadata share access */ 332 333 /* 334 * f_deny values 335 */ 336 #define F_NODNY 0x0 /* Don't deny others access */ 337 #define F_RDDNY 0x1 /* Deny others read share access */ 338 #define F_WRDNY 0x2 /* Deny others write share access */ 339 #define F_RWDNY 0x3 /* Deny others read or write share access */ 340 #define F_RMDNY 0x4 /* private flag: Deny delete share access */ 341 #define F_COMPAT 0x8 /* Set share to old DOS compatibility mode */ 342 #define F_MANDDNY 0x10 /* private flag: mandatory enforcement */ 343 #endif /* defined(__EXTENSIONS__) || !defined(__XOPEN_OR_POSIX) */ 344 345 /* 346 * Special flags for functions such as openat(), fstatat().... 347 */ 348 #if !defined(__XOPEN_OR_POSIX) || defined(_ATFILE_SOURCE) || \ 349 defined(__EXTENSIONS__) 350 #define AT_FDCWD 0xffd19553 351 #define AT_SYMLINK_NOFOLLOW 0x1000 352 #define AT_REMOVEDIR 0x1 353 #define _AT_TRIGGER 0x2 354 #endif 355 356 #if !defined(__XOPEN_OR_POSIX) || defined(_XPG6) || defined(__EXTENSIONS__) 357 /* advice for posix_fadvise */ 358 #define POSIX_FADV_NORMAL 0 359 #define POSIX_FADV_RANDOM 1 360 #define POSIX_FADV_SEQUENTIAL 2 361 #define POSIX_FADV_WILLNEED 3 362 #define POSIX_FADV_DONTNEED 4 363 #define POSIX_FADV_NOREUSE 5 364 #endif 365 366 #ifdef __cplusplus 367 } 368 #endif 369 370 #endif /* _SYS_FCNTL_H */ 371