1/*
2 * Copyright (c) 2000-2013 Apple 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#include <Availability.h>
81
82/* We should not be exporting size_t here. Temporary for gcc bootstrapping. */
83#include <sys/_types/_size_t.h>
84#include <sys/_types/_mode_t.h>
85#include <sys/_types/_off_t.h>
86#include <sys/_types/_pid_t.h>
87
88/*
89 * File status flags: these are used by open(2), fcntl(2).
90 * They are also used (indirectly) in the kernel file structure f_flags,
91 * which is a superset of the open/fcntl flags. Open flags and f_flags
92 * are inter-convertible using OFLAGS(fflags) and FFLAGS(oflags).
93 * Open/fcntl flags begin with O_; kernel-internal flags begin with F.
94 */
95/* open-only flags */
96#define O_RDONLY 0x0000 /* open for reading only */
97#define O_WRONLY 0x0001 /* open for writing only */
98#define O_RDWR 0x0002 /* open for reading and writing */
99#define O_ACCMODE 0x0003 /* mask for above modes */
100
101/*
102 * Kernel encoding of open mode; separate read and write bits that are
103 * independently testable: 1 greater than the above.
104 *
105 * XXX
106 * FREAD and FWRITE are excluded from the #ifdef KERNEL so that TIOCFLUSH,
107 * which was documented to use FREAD/FWRITE, continues to work.
108 */
109#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
110#define FREAD 0x0001
111#define FWRITE 0x0002
112#endif
113#define O_NONBLOCK 0x0004 /* no delay */
114#define O_APPEND 0x0008 /* set append mode */
115
116#include <sys/_types/_o_sync.h>
117
118#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
119#define O_SHLOCK 0x0010 /* open with shared file lock */
120#define O_EXLOCK 0x0020 /* open with exclusive file lock */
121#define O_ASYNC 0x0040 /* signal pgrp when data ready */
122#define O_FSYNC O_SYNC /* source compatibility: do not use */
123#define O_NOFOLLOW 0x0100 /* don't follow symlinks */
124#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
125#define O_CREAT 0x0200 /* create if nonexistant */
126#define O_TRUNC 0x0400 /* truncate to zero length */
127#define O_EXCL 0x0800 /* error if already exists */
128
129#if __DARWIN_C_LEVEL >= 200809L
130/*
131 * Descriptor value for the current working directory
132 */
133#define AT_FDCWD -2
134
135/*
136 * Flags for the at functions
137 */
138#define AT_EACCESS 0x0010 /* Use effective ids in access check */
139#define AT_SYMLINK_NOFOLLOW 0x0020 /* Act on the symlink itself not the target */
140#define AT_SYMLINK_FOLLOW 0x0040 /* Act on target of symlink */
141#define AT_REMOVEDIR 0x0080 /* Path refers to directory */
142#endif
143
144#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
145#define O_EVTONLY 0x8000 /* descriptor requested for event notifications only */
146#endif
147
148
149#define O_NOCTTY 0x20000 /* don't assign controlling terminal */
150
151
152#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
153#define O_DIRECTORY 0x100000
154#define O_SYMLINK 0x200000 /* allow open of a symlink */
155#endif
156
157#include <sys/_types/_o_dsync.h>
158
159
160#if __DARWIN_C_LEVEL >= 200809L
161#define O_CLOEXEC 0x1000000 /* implicitly set FD_CLOEXEC */
162#endif
163
164
165
166
167
168/* Data Protection Flags */
169#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
170#define O_DP_GETRAWENCRYPTED 0x0001
171#define O_DP_GETRAWUNENCRYPTED 0x0002
172#endif
173
174
175
176/*
177 * The O_* flags used to have only F* names, which were used in the kernel
178 * and by fcntl. We retain the F* names for the kernel f_flags field
179 * and for backward compatibility for fcntl.
180 */
181#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
182#define FAPPEND O_APPEND /* kernel/compat */
183#define FASYNC O_ASYNC /* kernel/compat */
184#define FFSYNC O_FSYNC /* kernel */
185#define FFDSYNC O_DSYNC /* kernel */
186#define FNONBLOCK O_NONBLOCK /* kernel */
187#define FNDELAY O_NONBLOCK /* compat */
188#define O_NDELAY O_NONBLOCK /* compat */
189#endif
190
191/*
192 * Flags used for copyfile(2)
193 */
194
195#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
196#define CPF_OVERWRITE 0x0001
197#define CPF_IGNORE_MODE 0x0002
198#define CPF_MASK (CPF_OVERWRITE|CPF_IGNORE_MODE)
199#endif
200
201/*
202 * Constants used for fcntl(2)
203 */
204
205/* command values */
206#define F_DUPFD 0 /* duplicate file descriptor */
207#define F_GETFD 1 /* get file descriptor flags */
208#define F_SETFD 2 /* set file descriptor flags */
209#define F_GETFL 3 /* get file status flags */
210#define F_SETFL 4 /* set file status flags */
211#define F_GETOWN 5 /* get SIGIO/SIGURG proc/pgrp */
212#define F_SETOWN 6 /* set SIGIO/SIGURG proc/pgrp */
213#define F_GETLK 7 /* get record locking information */
214#define F_SETLK 8 /* set record locking information */
215#define F_SETLKW 9 /* F_SETLK; wait if blocked */
216#if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
217#define F_SETLKWTIMEOUT 10 /* F_SETLK; wait if blocked, return on timeout */
218#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
219#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
220#define F_FLUSH_DATA 40
221#define F_CHKCLEAN 41 /* Used for regression test */
222#define F_PREALLOCATE 42 /* Preallocate storage */
223#define F_SETSIZE 43 /* Truncate a file without zeroing space */
224#define F_RDADVISE 44 /* Issue an advisory read async with no copy to user */
225#define F_RDAHEAD 45 /* turn read ahead off/on for this fd */
226/*
227 * 46,47 used to be F_READBOOTSTRAP and F_WRITEBOOTSTRAP
228 */
229#define F_NOCACHE 48 /* turn data caching off/on for this fd */
230#define F_LOG2PHYS 49 /* file offset to device offset */
231#define F_GETPATH 50 /* return the full path of the fd */
232#define F_FULLFSYNC 51 /* fsync + ask the drive to flush to the media */
233#define F_PATHPKG_CHECK 52 /* find which component (if any) is a package */
234#define F_FREEZE_FS 53 /* "freeze" all fs operations */
235#define F_THAW_FS 54 /* "thaw" all fs operations */
236#define F_GLOBAL_NOCACHE 55 /* turn data caching off/on (globally) for this file */
237
238
239#define F_ADDSIGS 59 /* add detached signatures */
240
241
242#define F_ADDFILESIGS 61 /* add signature from same file (used by dyld for shared libs) */
243
244#define F_NODIRECT 62 /* used in conjunction with F_NOCACHE to indicate that DIRECT, synchonous writes */
245 /* should not be used (i.e. its ok to temporaily create cached pages) */
246
247#define F_GETPROTECTIONCLASS 63 /* Get the protection class of a file from the EA, returns int */
248#define F_SETPROTECTIONCLASS 64 /* Set the protection class of a file for the EA, requires int */
249
250#define F_LOG2PHYS_EXT 65 /* file offset to device offset, extended */
251
252#define F_GETLKPID 66 /* get record locking information, per-process */
253
254/* See F_DUPFD_CLOEXEC below for 67 */
255
256
257#define F_SETBACKINGSTORE 70 /* Mark the file as being the backing store for another filesystem */
258#define F_GETPATH_MTMINFO 71 /* return the full path of the FD, but error in specific mtmd circumstances */
259
260#define F_GETCODEDIR 72 /* Returns the code directory, with associated hashes, to the caller */
261
262#define F_SETNOSIGPIPE 73 /* No SIGPIPE generated on EPIPE */
263#define F_GETNOSIGPIPE 74 /* Status of SIGPIPE for this fd */
264
265#define F_TRANSCODEKEY 75 /* For some cases, we need to rewrap the key for AKS/MKB */
266
267#define F_SINGLE_WRITER 76 /* file being written to a by single writer... if throttling enabled, writes */
268 /* may be broken into smaller chunks with throttling in between */
269
270#define F_GETPROTECTIONLEVEL 77 /* Get the protection version number for this filesystem */
271
272#define F_FINDSIGS 78 /* Add detached code signatures (used by dyld for shared libs) */
273
274
275#define F_ADDFILESIGS_FOR_DYLD_SIM 83 /* Add signature from same file, only if it is signed by Apple (used by dyld for simulator) */
276
277
278#define F_BARRIERFSYNC 85 /* fsync + issue barrier to drive */
279
280
281#define F_ADDFILESIGS_RETURN 97 /* Add signature from same file, return end offset in structure on success */
282#define F_CHECK_LV 98 /* Check if Library Validation allows this Mach-O file to be mapped into the calling process */
283
284#define F_PUNCHHOLE 99 /* Deallocate a range of the file */
285
286#define F_TRIM_ACTIVE_FILE 100 /* Trim an active file */
287
288// FS-specific fcntl()'s numbers begin at 0x00010000 and go up
289#define FCNTL_FS_SPECIFIC_BASE 0x00010000
290
291#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
292
293#if __DARWIN_C_LEVEL >= 200809L
294#define F_DUPFD_CLOEXEC 67 /* mark the dup with FD_CLOEXEC */
295#endif
296
297/* file descriptor flags (F_GETFD, F_SETFD) */
298#define FD_CLOEXEC 1 /* close-on-exec flag */
299
300/* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */
301#define F_RDLCK 1 /* shared or read lock */
302#define F_UNLCK 2 /* unlock */
303#define F_WRLCK 3 /* exclusive or write lock */
304
305
306/*
307 * [XSI] The values used for l_whence shall be defined as described
308 * in <unistd.h>
309 */
310#include <sys/_types/_seek_set.h>
311
312/*
313 * [XSI] The symbolic names for file modes for use as values of mode_t
314 * shall be defined as described in <sys/stat.h>
315 */
316#include <sys/_types/_s_ifmt.h>
317
318#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
319/* allocate flags (F_PREALLOCATE) */
320
321#define F_ALLOCATECONTIG 0x00000002 /* allocate contigious space */
322#define F_ALLOCATEALL 0x00000004 /* allocate all requested space or no space at all */
323
324/* Position Modes (fst_posmode) for F_PREALLOCATE */
325
326#define F_PEOFPOSMODE 3 /* Make it past all of the SEEK pos modes so that */
327 /* we can keep them in sync should we desire */
328#define F_VOLPOSMODE 4 /* specify volume starting postion */
329#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
330
331/*
332 * Advisory file segment locking data type -
333 * information passed to system by user
334 */
335struct flock {
336 off_t l_start; /* starting offset */
337 off_t l_len; /* len = 0 means until end of file */
338 pid_t l_pid; /* lock owner */
339 short l_type; /* lock type: read/write, etc. */
340 short l_whence; /* type of l_start */
341};
342
343#include <sys/_types/_timespec.h>
344
345#if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
346/*
347 * Advisory file segment locking with time out -
348 * Information passed to system by user for F_SETLKWTIMEOUT
349 */
350struct flocktimeout {
351 struct flock fl; /* flock passed for file locking */
352 struct timespec timeout; /* timespec struct for timeout */
353};
354#endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
355
356#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
357/*
358 * advisory file read data type -
359 * information passed by user to system
360 */
361
362
363struct radvisory {
364 off_t ra_offset;
365 int ra_count;
366};
367
368
369/** Information the user passes in to get the codeblobs out of the kernel */
370typedef struct fcodeblobs {
371 void *f_cd_hash;
372 size_t f_hash_size;
373 void *f_cd_buffer;
374 size_t f_cd_size;
375 unsigned int *f_out_size;
376 int f_arch;
377 int __padding;
378} fcodeblobs_t;
379
380
381/*
382 * detached code signatures data type -
383 * information passed by user to system used by F_ADDSIGS and F_ADDFILESIGS.
384 * F_ADDFILESIGS is a shortcut for files that contain their own signature and
385 * doesn't require mapping of the file in order to load the signature.
386 */
387typedef struct fsignatures {
388 off_t fs_file_start;
389 void *fs_blob_start;
390 size_t fs_blob_size;
391} fsignatures_t;
392
393/*
394 * DYLD needs to check if the object is allowed to be combined
395 * into the main binary. This is done between the code signature
396 * is loaded and dyld is doing all the work to process the LOAD commands.
397 *
398 * While this could be done in F_ADDFILESIGS.* family the hook into
399 * the MAC module doesn't say no when LV isn't enabled and then that
400 * is cached on the vnode, and the MAC module never gets change once
401 * a process that library validation enabled.
402 */
403typedef struct fchecklv {
404 off_t lv_file_start;
405 size_t lv_error_message_size;
406 void *lv_error_message;
407} fchecklv_t;
408
409
410
411/* lock operations for flock(2) */
412#define LOCK_SH 0x01 /* shared file lock */
413#define LOCK_EX 0x02 /* exclusive file lock */
414#define LOCK_NB 0x04 /* don't block when locking */
415#define LOCK_UN 0x08 /* unlock file */
416
417/* fstore_t type used by F_PREALLOCATE command */
418
419typedef struct fstore {
420 unsigned int fst_flags; /* IN: flags word */
421 int fst_posmode; /* IN: indicates use of offset field */
422 off_t fst_offset; /* IN: start of the region */
423 off_t fst_length; /* IN: size of the region */
424 off_t fst_bytesalloc; /* OUT: number of bytes allocated */
425} fstore_t;
426
427/* fpunchhole_t used by F_PUNCHHOLE */
428typedef struct fpunchhole {
429 unsigned int fp_flags; /* unused */
430 unsigned int reserved; /* (to maintain 8-byte alignment) */
431 off_t fp_offset; /* IN: start of the region */
432 off_t fp_length; /* IN: size of the region */
433} fpunchhole_t;
434
435/* factive_file_trim_t used by F_TRIM_ACTIVE_FILE */
436typedef struct ftrimactivefile {
437 off_t fta_offset; /* IN: start of the region */
438 off_t fta_length; /* IN: size of the region */
439} ftrimactivefile_t;
440
441/* fbootstraptransfer_t used by F_READBOOTSTRAP and F_WRITEBOOTSTRAP commands */
442
443typedef struct fbootstraptransfer {
444 off_t fbt_offset; /* IN: offset to start read/write */
445 size_t fbt_length; /* IN: number of bytes to transfer */
446 void *fbt_buffer; /* IN: buffer to be read/written */
447} fbootstraptransfer_t;
448
449
450/*
451 * For F_LOG2PHYS this information is passed back to user
452 * Currently only devoffset is returned - that is the VOP_BMAP
453 * result - the disk device address corresponding to the
454 * current file offset (likely set with an lseek).
455 *
456 * The flags could hold an indication of whether the # of
457 * contiguous bytes reflects the true extent length on disk,
458 * or is an advisory value that indicates there is at least that
459 * many bytes contiguous. For some filesystems it might be too
460 * inefficient to provide anything beyond the advisory value.
461 * Flags and contiguous bytes return values are not yet implemented.
462 * For them the fcntl will nedd to switch from using BMAP to CMAP
463 * and a per filesystem type flag will be needed to interpret the
464 * contiguous bytes count result from CMAP.
465 *
466 * F_LOG2PHYS_EXT is a variant of F_LOG2PHYS that uses a passed in
467 * file offset and length instead of the current file offset.
468 * F_LOG2PHYS_EXT operates on the same structure as F_LOG2PHYS, but
469 * treats it as an in/out.
470 */
471#pragma pack(4)
472
473struct log2phys {
474 unsigned int l2p_flags; /* unused so far */
475 off_t l2p_contigbytes; /* F_LOG2PHYS: unused so far */
476 /* F_LOG2PHYS_EXT: IN: number of bytes to be queried */
477 /* OUT: number of contiguous bytes at this position */
478 off_t l2p_devoffset; /* F_LOG2PHYS: OUT: bytes into device */
479 /* F_LOG2PHYS_EXT: IN: bytes into file */
480 /* OUT: bytes into device */
481};
482
483#pragma pack()
484
485#define O_POPUP 0x80000000 /* force window to popup on open */
486#define O_ALERT 0x20000000 /* small, clean popup window */
487
488
489#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
490
491
492#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
493
494#include <sys/_types/_filesec_t.h>
495
496typedef enum {
497 FILESEC_OWNER = 1,
498 FILESEC_GROUP = 2,
499 FILESEC_UUID = 3,
500 FILESEC_MODE = 4,
501 FILESEC_ACL = 5,
502 FILESEC_GRPUUID = 6,
503
504/* XXX these are private to the implementation */
505 FILESEC_ACL_RAW = 100,
506 FILESEC_ACL_ALLOCSIZE = 101
507} filesec_property_t;
508
509/* XXX backwards compatibility */
510#define FILESEC_GUID FILESEC_UUID
511#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
512
513__BEGIN_DECLS
514int open(const char *, int, ...) __DARWIN_ALIAS_C(open);
515#if __DARWIN_C_LEVEL >= 200809L
516int openat(int, const char *, int, ...) __DARWIN_NOCANCEL(openat) __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0);
517#endif
518int creat(const char *, mode_t) __DARWIN_ALIAS_C(creat);
519int fcntl(int, int, ...) __DARWIN_ALIAS_C(fcntl);
520#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
521
522int openx_np(const char *, int, filesec_t);
523/*
524 * data-protected non-portable open(2) :
525 * int open_dprotected_np(user_addr_t path, int flags, int class, int dpflags, int mode)
526 */
527int open_dprotected_np( const char *, int, int, int, ...);
528int flock(int, int);
529filesec_t filesec_init(void);
530filesec_t filesec_dup(filesec_t);
531void filesec_free(filesec_t);
532int filesec_get_property(filesec_t, filesec_property_t, void *);
533int filesec_query_property(filesec_t, filesec_property_t, int *);
534int filesec_set_property(filesec_t, filesec_property_t, const void *);
535int filesec_unset_property(filesec_t, filesec_property_t) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
536#define _FILESEC_UNSET_PROPERTY ((void *)0)
537#define _FILESEC_REMOVE_ACL ((void *)1)
538#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
539__END_DECLS
540
541#endif /* !_SYS_FCNTL_H_ */
542