bsd/sys/fcntl.h

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