bsd/sys/fcntl.h

   1 /*
   2  * Copyright (c) 2006 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License.  The rights granted to you under the
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  31 /*-
  32  * Copyright (c) 1983, 1990, 1993
  33  *      The Regents of the University of California.  All rights reserved.
  34  * (c) UNIX System Laboratories, Inc.
  35  * All or some portions of this file are derived from material licensed
  36  * to the University of California by American Telephone and Telegraph
  37  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  38  * the permission of UNIX System Laboratories, Inc.
  39  *
  40  * Redistribution and use in source and binary forms, with or without
  41  * modification, are permitted provided that the following conditions
  42  * are met:
  43  * 1. Redistributions of source code must retain the above copyright
  44  *    notice, this list of conditions and the following disclaimer.
  45  * 2. Redistributions in binary form must reproduce the above copyright
  46  *    notice, this list of conditions and the following disclaimer in the
  47  *    documentation and/or other materials provided with the distribution.
  48  * 3. All advertising materials mentioning features or use of this software
  49  *    must display the following acknowledgement:
  50  *      This product includes software developed by the University of
  51  *      California, Berkeley and its contributors.
  52  * 4. Neither the name of the University nor the names of its contributors
  53  *    may be used to endorse or promote products derived from this software
  54  *    without specific prior written permission.
  55  *
  56  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  57  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  58  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  59  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  60  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  61  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  62  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  63  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  64  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  65  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  66  * SUCH DAMAGE.
  67  *
  68  *      @(#)fcntl.h     8.3 (Berkeley) 1/21/94
  69  */
  70
  71
  72 #ifndef _SYS_FCNTL_H_
  73 #define _SYS_FCNTL_H_
  74
  75 /*
  76  * This file includes the definitions for open and fcntl
  77  * described by POSIX for <fcntl.h>; it also includes
  78  * related kernel definitions.
  79  */
  80 #include <sys/_types.h>
  81 #include <sys/cdefs.h>
  82
  83 /* We should not be exporting size_t here.  Temporary for gcc bootstrapping. */
  84 #ifndef _SIZE_T
  85 #define _SIZE_T
  86 typedef __darwin_size_t size_t;
  87 #endif
  88
  89 #ifndef _MODE_T
  90 typedef __darwin_mode_t mode_t;
  91 #define _MODE_T
  92 #endif
  93
  94 #ifndef _OFF_T
  95 typedef __darwin_off_t  off_t;
  96 #define _OFF_T
  97 #endif
  98
  99 #ifndef _PID_T
 100 typedef __darwin_pid_t  pid_t;
 101 #define _PID_T
 102 #endif
 103
 104 /*
 105  * File status flags: these are used by open(2), fcntl(2).
 106  * They are also used (indirectly) in the kernel file structure f_flags,
 107  * which is a superset of the open/fcntl flags.  Open flags and f_flags
 108  * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags).
 109  * Open/fcntl flags begin with O_; kernel-internal flags begin with F.
 110  */
 111 /* open-only flags */
 112 #define O_RDONLY        0x0000          /* open for reading only */
 113 #define O_WRONLY        0x0001          /* open for writing only */
 114 #define O_RDWR          0x0002          /* open for reading and writing */
 115 #define O_ACCMODE       0x0003          /* mask for above modes */
 116
 117 /*
 118  * Kernel encoding of open mode; separate read and write bits that are
 119  * independently testable: 1 greater than the above.
 120  *
 121  * XXX
 122  * FREAD and FWRITE are excluded from the #ifdef KERNEL so that TIOCFLUSH,
 123  * which was documented to use FREAD/FWRITE, continues to work.
 124  */
 125 #ifndef _POSIX_C_SOURCE
 126 #define FREAD           0x0001
 127 #define FWRITE          0x0002
 128 #endif
 129 #define O_NONBLOCK      0x0004          /* no delay */
 130 #define O_APPEND        0x0008          /* set append mode */
 131 #define O_SYNC          0x0080          /* synchronous writes */
 132 #ifndef _POSIX_C_SOURCE
 133 #define O_SHLOCK        0x0010          /* open with shared file lock */
 134 #define O_EXLOCK        0x0020          /* open with exclusive file lock */
 135 #define O_ASYNC         0x0040          /* signal pgrp when data ready */
 136 #define O_FSYNC         O_SYNC          /* source compatibility: do not use */
 137 #define O_NOFOLLOW  0x0100      /* don't follow symlinks */
 138 #endif /* _POSIX_C_SOURCE */
 139 #define O_CREAT         0x0200          /* create if nonexistant */
 140 #define O_TRUNC         0x0400          /* truncate to zero length */
 141 #define O_EXCL          0x0800          /* error if already exists */
 142 #ifdef KERNEL
 143 #define FMARK           0x1000          /* mark during gc() */
 144 #define FDEFER          0x2000          /* defer for next gc pass */
 145 #define FHASLOCK        0x4000          /* descriptor holds advisory lock */
 146 #endif
 147 #ifndef _POSIX_C_SOURCE
 148 #define O_EVTONLY       0x8000          /* descriptor requested for event notifications only */
 149 #endif
 150
 151 #ifdef KERNEL
 152 #define FWASWRITTEN     0x10000         /* descriptor was written */
 153 #endif
 154
 155 /* defined by POSIX 1003.1; BSD default, so no bit required */
 156 #define O_NOCTTY        0               /* don't assign controlling terminal */
 157 //#define       O_SYNC  /* ??? POSIX: Write according to synchronized I/O file integrity completion */
 158
 159 #ifdef KERNEL
 160 /* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */
 161 #define FFLAGS(oflags)  ((oflags) + 1)
 162 #define OFLAGS(fflags)  ((fflags) - 1)
 163
 164 /* bits to save after open */
 165 #define FMASK           (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK)
 166 /* bits settable by fcntl(F_SETFL, ...) */
 167 #define FCNTLFLAGS      (FAPPEND|FASYNC|FFSYNC|FNONBLOCK)
 168 #endif
 169
 170 /*
 171  * The O_* flags used to have only F* names, which were used in the kernel
 172  * and by fcntl.  We retain the F* names for the kernel f_flags field
 173  * and for backward compatibility for fcntl.
 174  */
 175 #ifndef _POSIX_C_SOURCE
 176 #define FAPPEND         O_APPEND        /* kernel/compat */
 177 #define FASYNC          O_ASYNC         /* kernel/compat */
 178 #define FFSYNC          O_FSYNC         /* kernel */
 179 #define FNONBLOCK       O_NONBLOCK      /* kernel */
 180 #define FNDELAY         O_NONBLOCK      /* compat */
 181 #define O_NDELAY        O_NONBLOCK      /* compat */
 182 #endif
 183
 184 /*
 185  * Flags used for copyfile(2)
 186  */
 187
 188 #ifndef _POSIX_C_SOURCE
 189 #define CPF_OVERWRITE 1
 190 #define CPF_IGNORE_MODE 2
 191 #define CPF_MASK (CPF_OVERWRITE|CPF_IGNORE_MODE)
 192 #endif
 193
 194 /*
 195  * Constants used for fcntl(2)
 196  */
 197
 198 /* command values */
 199 #define F_DUPFD         0               /* duplicate file descriptor */
 200 #define F_GETFD         1               /* get file descriptor flags */
 201 #define F_SETFD         2               /* set file descriptor flags */
 202 #define F_GETFL         3               /* get file status flags */
 203 #define F_SETFL         4               /* set file status flags */
 204 #define F_GETOWN        5               /* get SIGIO/SIGURG proc/pgrp */
 205 #define F_SETOWN        6               /* set SIGIO/SIGURG proc/pgrp */
 206 #define F_GETLK         7               /* get record locking information */
 207 #define F_SETLK         8               /* set record locking information */
 208 #define F_SETLKW        9               /* F_SETLK; wait if blocked */
 209 #ifndef _POSIX_C_SOURCE
 210 #define F_CHKCLEAN      41              /* Used for regression test */
 211 #define F_PREALLOCATE   42              /* Preallocate storage */
 212 #define F_SETSIZE       43              /* Truncate a file without zeroing space */
 213 #define F_RDADVISE      44              /* Issue an advisory read async with no copy to user */
 214 #define F_RDAHEAD       45              /* turn read ahead off/on */
 215 #define F_READBOOTSTRAP 46              /* Read bootstrap from disk */
 216 #define F_WRITEBOOTSTRAP 47             /* Write bootstrap on disk */
 217 #define F_NOCACHE       48              /* turning data caching off/on */
 218 #define F_LOG2PHYS      49              /* file offset to device offset */
 219 #define F_GETPATH       50              /* return the full path of the fd */
 220 #define F_FULLFSYNC     51              /* fsync + ask the drive to flush to the media */
 221 #define F_PATHPKG_CHECK 52              /* find which component (if any) is a package */
 222 #define F_FREEZE_FS     53              /* "freeze" all fs operations */
 223 #define F_THAW_FS       54              /* "thaw" all fs operations */
 224 #define F_GLOBAL_NOCACHE 55             /* turn data caching off/on (globally) for this file */
 225
 226 // FS-specific fcntl()'s numbers begin at 0x00010000 and go up
 227 #define FCNTL_FS_SPECIFIC_BASE  0x00010000
 228 #endif /* _POSIX_C_SOURCE */
 229
 230 /* file descriptor flags (F_GETFD, F_SETFD) */
 231 #define FD_CLOEXEC      1               /* close-on-exec flag */
 232
 233 /* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */
 234 #define F_RDLCK         1               /* shared or read lock */
 235 #define F_UNLCK         2               /* unlock */
 236 #define F_WRLCK         3               /* exclusive or write lock */
 237 #ifdef KERNEL
 238 #define F_WAIT          0x010           /* Wait until lock is granted */
 239 #define F_FLOCK         0x020           /* Use flock(2) semantics for lock */
 240 #define F_POSIX         0x040           /* Use POSIX semantics for lock */
 241 #endif
 242
 243 /*
 244  * [XSI] The values used for l_whence shall be defined as described
 245  * in <unistd.h>
 246  */
 247 #ifndef SEEK_SET
 248 #define SEEK_SET        0       /* set file offset to offset */
 249 #define SEEK_CUR        1       /* set file offset to current plus offset */
 250 #define SEEK_END        2       /* set file offset to EOF plus offset */
 251 #endif  /* !SEEK_SET */
 252
 253 /*
 254  * [XSI] The symbolic names for file modes for use as values of mode_t
 255  * shall be defined as described in <sys/stat.h>
 256  */
 257 #ifndef S_IFMT
 258 /* File type */
 259 #define S_IFMT          0170000         /* [XSI] type of file mask */
 260 #define S_IFIFO         0010000         /* [XSI] named pipe (fifo) */
 261 #define S_IFCHR         0020000         /* [XSI] character special */
 262 #define S_IFDIR         0040000         /* [XSI] directory */
 263 #define S_IFBLK         0060000         /* [XSI] block special */
 264 #define S_IFREG         0100000         /* [XSI] regular */
 265 #define S_IFLNK         0120000         /* [XSI] symbolic link */
 266 #define S_IFSOCK        0140000         /* [XSI] socket */
 267 #ifndef _POSIX_C_SOURCE
 268 #define S_IFWHT         0160000         /* whiteout */
 269 #define S_IFXATTR       0200000         /* extended attribute */
 270 #endif
 271
 272 /* File mode */
 273 /* Read, write, execute/search by owner */
 274 #define S_IRWXU         0000700         /* [XSI] RWX mask for owner */
 275 #define S_IRUSR         0000400         /* [XSI] R for owner */
 276 #define S_IWUSR         0000200         /* [XSI] W for owner */
 277 #define S_IXUSR         0000100         /* [XSI] X for owner */
 278 /* Read, write, execute/search by group */
 279 #define S_IRWXG         0000070         /* [XSI] RWX mask for group */
 280 #define S_IRGRP         0000040         /* [XSI] R for group */
 281 #define S_IWGRP         0000020         /* [XSI] W for group */
 282 #define S_IXGRP         0000010         /* [XSI] X for group */
 283 /* Read, write, execute/search by others */
 284 #define S_IRWXO         0000007         /* [XSI] RWX mask for other */
 285 #define S_IROTH         0000004         /* [XSI] R for other */
 286 #define S_IWOTH         0000002         /* [XSI] W for other */
 287 #define S_IXOTH         0000001         /* [XSI] X for other */
 288
 289 #define S_ISUID         0004000         /* [XSI] set user id on execution */
 290 #define S_ISGID         0002000         /* [XSI] set group id on execution */
 291 #define S_ISVTX         0001000         /* [XSI] directory restrcted delete */
 292
 293 #ifndef _POSIX_C_SOURCE
 294 #define S_ISTXT         S_ISVTX         /* sticky bit: not supported */
 295 #define S_IREAD         S_IRUSR         /* backward compatability */
 296 #define S_IWRITE        S_IWUSR         /* backward compatability */
 297 #define S_IEXEC         S_IXUSR         /* backward compatability */
 298 #endif
 299 #endif  /* !S_IFMT */
 300
 301 #ifndef _POSIX_C_SOURCE
 302 /* allocate flags (F_PREALLOCATE) */
 303
 304 #define F_ALLOCATECONTIG  0x00000002    /* allocate contigious space */
 305 #define F_ALLOCATEALL     0x00000004    /* allocate all requested space or no space at all */
 306
 307 /* Position Modes (fst_posmode) for F_PREALLOCATE */
 308
 309 #define F_PEOFPOSMODE 3                 /* Make it past all of the SEEK pos modes so that */
 310                                         /* we can keep them in sync should we desire */
 311 #define F_VOLPOSMODE    4               /* specify volume starting postion */
 312 #endif /* _POSIX_C_SOURCE */
 313
 314 /*
 315  * Advisory file segment locking data type -
 316  * information passed to system by user
 317  */
 318 struct flock {
 319         off_t   l_start;        /* starting offset */
 320         off_t   l_len;          /* len = 0 means until end of file */
 321         pid_t   l_pid;          /* lock owner */
 322         short   l_type;         /* lock type: read/write, etc. */
 323         short   l_whence;       /* type of l_start */
 324 };
 325
 326
 327 #ifndef _POSIX_C_SOURCE
 328 /*
 329  * advisory file read data type -
 330  * information passed by user to system
 331  */
 332 struct radvisory {
 333        off_t   ra_offset;
 334        int     ra_count;
 335 };
 336
 337
 338 /* lock operations for flock(2) */
 339 #define LOCK_SH         0x01            /* shared file lock */
 340 #define LOCK_EX         0x02            /* exclusive file lock */
 341 #define LOCK_NB         0x04            /* don't block when locking */
 342 #define LOCK_UN         0x08            /* unlock file */
 343
 344 /*  fstore_t type used by F_DEALLOCATE and F_PREALLOCATE commands */
 345
 346 typedef struct fstore {
 347         unsigned int fst_flags; /* IN: flags word */
 348         int     fst_posmode;    /* IN: indicates use of offset field */
 349         off_t   fst_offset;     /* IN: start of the region */
 350         off_t   fst_length;     /* IN: size of the region */
 351         off_t   fst_bytesalloc; /* OUT: number of bytes allocated */
 352 } fstore_t;
 353
 354 /* fbootstraptransfer_t used by F_READBOOTSTRAP and F_WRITEBOOTSTRAP commands */
 355
 356 typedef struct fbootstraptransfer {
 357   off_t fbt_offset;             /* IN: offset to start read/write */
 358   size_t fbt_length;          /* IN: number of bytes to transfer */
 359   void *fbt_buffer;             /* IN: buffer to be read/written */
 360 } fbootstraptransfer_t;
 361
 362
 363 // LP64todo - should this move?
 364 #ifdef KERNEL
 365 /* LP64 version of fbootstraptransfer.  all pointers
 366  * grow when we're dealing with a 64-bit process.
 367  * WARNING - keep in sync with fbootstraptransfer
 368  */
 369
 370 #if __DARWIN_ALIGN_NATURAL
 371 #pragma options align=natural
 372 #endif
 373
 374 typedef struct user_fbootstraptransfer {
 375   off_t fbt_offset;             /* IN: offset to start read/write */
 376   user_size_t fbt_length;               /* IN: number of bytes to transfer */
 377   user_addr_t fbt_buffer;               /* IN: buffer to be read/written */
 378 } user_fbootstraptransfer_t;
 379
 380 #if __DARWIN_ALIGN_NATURAL
 381 #pragma options align=reset
 382 #endif
 383
 384 #endif // KERNEL
 385
 386 /*
 387  * For F_LOG2PHYS this information is passed back to user
 388  * Currently only devoffset is returned - that is the VOP_BMAP
 389  * result - the disk device address corresponding to the
 390  * current file offset (likely set with an lseek).
 391  *
 392  * The flags could hold an indication of whether the # of
 393  * contiguous bytes reflects the true extent length on disk,
 394  * or is an advisory value that indicates there is at least that
 395  * many bytes contiguous.  For some filesystems it might be too
 396  * inefficient to provide anything beyond the advisory value.
 397  * Flags and contiguous bytes return values are not yet implemented.
 398  * For them the fcntl will nedd to switch from using BMAP to CMAP
 399  * and a per filesystem type flag will be needed to interpret the
 400  * contiguous bytes count result from CMAP.
 401  */
 402 #if __DARWIN_ALIGN_POWER
 403 #pragma options align=power
 404 #endif
 405
 406 struct log2phys {
 407         unsigned int    l2p_flags;              /* unused so far */
 408         off_t           l2p_contigbytes;        /* unused so far */
 409         off_t           l2p_devoffset;  /* bytes into device */
 410 };
 411
 412 #if __DARWIN_ALIGN_POWER
 413 #pragma options align=reset
 414 #endif
 415
 416 #define O_POPUP    0x80000000   /* force window to popup on open */
 417 #define O_ALERT    0x20000000   /* small, clean popup window */
 418 #endif /* _POSIX_C_SOURCE */
 419
 420 #ifndef KERNEL
 421
 422 #ifndef _POSIX_C_SOURCE
 423 #ifndef _FILESEC_T
 424 struct _filesec;
 425 typedef struct _filesec *filesec_t;
 426 #define _FILESEC_T
 427 #endif
 428 typedef enum {
 429         FILESEC_OWNER = 1,
 430         FILESEC_GROUP = 2,
 431         FILESEC_UUID = 3,
 432         FILESEC_MODE = 4,
 433         FILESEC_ACL = 5,
 434         FILESEC_GRPUUID = 6,
 435
 436 /* XXX these are private to the implementation */
 437         FILESEC_ACL_RAW = 100,
 438         FILESEC_ACL_ALLOCSIZE = 101
 439 } filesec_property_t;
 440
 441 /* XXX backwards compatibility */
 442 #define FILESEC_GUID FILESEC_UUID
 443 #endif /* _POSIX_C_SOURCE */
 444
 445 __BEGIN_DECLS
 446 int     open(const char *, int, ...);
 447 int     creat(const char *, mode_t);
 448 int     fcntl(int, int, ...);
 449 #ifndef _POSIX_C_SOURCE
 450 int     openx_np(const char *, int, filesec_t);
 451 int     flock(int, int);
 452 filesec_t filesec_init(void);
 453 filesec_t filesec_dup(filesec_t);
 454 void    filesec_free(filesec_t);
 455 int     filesec_get_property(filesec_t, filesec_property_t, void *);
 456 int     filesec_set_property(filesec_t, filesec_property_t, const void *);
 457 int     filesec_unset_property(filesec_t, filesec_property_t);
 458 int     filesec_query_property(filesec_t, filesec_property_t, int *);
 459 #define _FILESEC_UNSET_PROPERTY ((void *)0)
 460 #define _FILESEC_REMOVE_ACL     ((void *)1)
 461 #endif /* !_POSIX_C_SOURCE */
 462 __END_DECLS
 463 #endif
 464
 465 #endif /* !_SYS_FCNTL_H_ */