bsd/sys/fcntl.h

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