]> git.saurik.com Git - apple/xnu.git/blame - bsd/sys/fcntl.h
xnu-792.13.8.tar.gz
[apple/xnu.git] / bsd / sys / fcntl.h
CommitLineData
1c79356b 1/*
5d5c5d0d
A
2 * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
3 *
8ad349bb 4 * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
1c79356b 5 *
8ad349bb
A
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@
1c79356b
A
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 */
91447636
A
80#include <sys/_types.h>
81#include <sys/cdefs.h>
1c79356b 82
91447636
A
83/* We should not be exporting size_t here. Temporary for gcc bootstrapping. */
84#ifndef _SIZE_T
85#define _SIZE_T
86typedef __darwin_size_t size_t;
87#endif
88
89#ifndef _MODE_T
90typedef __darwin_mode_t mode_t;
91#define _MODE_T
92#endif
93
94#ifndef _OFF_T
95typedef __darwin_off_t off_t;
96#define _OFF_T
97#endif
98
99#ifndef _PID_T
100typedef __darwin_pid_t pid_t;
101#define _PID_T
1c79356b
A
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 */
91447636 125#ifndef _POSIX_C_SOURCE
1c79356b
A
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 */
91447636
A
131#define O_SYNC 0x0080 /* synchronous writes */
132#ifndef _POSIX_C_SOURCE
1c79356b
A
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 */
91447636 136#define O_FSYNC O_SYNC /* source compatibility: do not use */
9bccf70c 137#define O_NOFOLLOW 0x0100 /* don't follow symlinks */
91447636 138#endif /* _POSIX_C_SOURCE */
1c79356b
A
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
91447636 147#ifndef _POSIX_C_SOURCE
55e303ae
A
148#define O_EVTONLY 0x8000 /* descriptor requested for event notifications only */
149#endif
1c79356b 150
91447636
A
151#ifdef KERNEL
152#define FWASWRITTEN 0x10000 /* descriptor was written */
153#endif
154
5d5c5d0d
A
155#ifndef _POSIX_C_SOURCE
156#define O_DIRECTORY 0x100000
157#endif
158
1c79356b
A
159/* defined by POSIX 1003.1; BSD default, so no bit required */
160#define O_NOCTTY 0 /* don't assign controlling terminal */
91447636 161//#define O_SYNC /* ??? POSIX: Write according to synchronized I/O file integrity completion */
1c79356b
A
162
163#ifdef KERNEL
164/* convert from open() flags to/from fflags; convert O_RD/WR to FREAD/FWRITE */
165#define FFLAGS(oflags) ((oflags) + 1)
166#define OFLAGS(fflags) ((fflags) - 1)
167
168/* bits to save after open */
169#define FMASK (FREAD|FWRITE|FAPPEND|FASYNC|FFSYNC|FNONBLOCK)
170/* bits settable by fcntl(F_SETFL, ...) */
171#define FCNTLFLAGS (FAPPEND|FASYNC|FFSYNC|FNONBLOCK)
172#endif
173
174/*
175 * The O_* flags used to have only F* names, which were used in the kernel
176 * and by fcntl. We retain the F* names for the kernel f_flags field
177 * and for backward compatibility for fcntl.
178 */
91447636 179#ifndef _POSIX_C_SOURCE
1c79356b
A
180#define FAPPEND O_APPEND /* kernel/compat */
181#define FASYNC O_ASYNC /* kernel/compat */
182#define FFSYNC O_FSYNC /* kernel */
183#define FNONBLOCK O_NONBLOCK /* kernel */
184#define FNDELAY O_NONBLOCK /* compat */
185#define O_NDELAY O_NONBLOCK /* compat */
186#endif
187
188/*
189 * Flags used for copyfile(2)
190 */
191
91447636 192#ifndef _POSIX_C_SOURCE
1c79356b
A
193#define CPF_OVERWRITE 1
194#define CPF_IGNORE_MODE 2
195#define CPF_MASK (CPF_OVERWRITE|CPF_IGNORE_MODE)
196#endif
197
198/*
199 * Constants used for fcntl(2)
200 */
201
202/* command values */
203#define F_DUPFD 0 /* duplicate file descriptor */
204#define F_GETFD 1 /* get file descriptor flags */
205#define F_SETFD 2 /* set file descriptor flags */
206#define F_GETFL 3 /* get file status flags */
207#define F_SETFL 4 /* set file status flags */
1c79356b
A
208#define F_GETOWN 5 /* get SIGIO/SIGURG proc/pgrp */
209#define F_SETOWN 6 /* set SIGIO/SIGURG proc/pgrp */
1c79356b
A
210#define F_GETLK 7 /* get record locking information */
211#define F_SETLK 8 /* set record locking information */
212#define F_SETLKW 9 /* F_SETLK; wait if blocked */
91447636 213#ifndef _POSIX_C_SOURCE
55e303ae 214#define F_CHKCLEAN 41 /* Used for regression test */
1c79356b
A
215#define F_PREALLOCATE 42 /* Preallocate storage */
216#define F_SETSIZE 43 /* Truncate a file without zeroing space */
217#define F_RDADVISE 44 /* Issue an advisory read async with no copy to user */
218#define F_RDAHEAD 45 /* turn read ahead off/on */
219#define F_READBOOTSTRAP 46 /* Read bootstrap from disk */
220#define F_WRITEBOOTSTRAP 47 /* Write bootstrap on disk */
221#define F_NOCACHE 48 /* turning data caching off/on */
222#define F_LOG2PHYS 49 /* file offset to device offset */
55e303ae
A
223#define F_GETPATH 50 /* return the full path of the fd */
224#define F_FULLFSYNC 51 /* fsync + ask the drive to flush to the media */
91447636
A
225#define F_PATHPKG_CHECK 52 /* find which component (if any) is a package */
226#define F_FREEZE_FS 53 /* "freeze" all fs operations */
227#define F_THAW_FS 54 /* "thaw" all fs operations */
3a60a9f5 228#define F_GLOBAL_NOCACHE 55 /* turn data caching off/on (globally) for this file */
91447636
A
229
230// FS-specific fcntl()'s numbers begin at 0x00010000 and go up
231#define FCNTL_FS_SPECIFIC_BASE 0x00010000
232#endif /* _POSIX_C_SOURCE */
1c79356b
A
233
234/* file descriptor flags (F_GETFD, F_SETFD) */
235#define FD_CLOEXEC 1 /* close-on-exec flag */
236
237/* record locking flags (F_GETLK, F_SETLK, F_SETLKW) */
238#define F_RDLCK 1 /* shared or read lock */
239#define F_UNLCK 2 /* unlock */
240#define F_WRLCK 3 /* exclusive or write lock */
241#ifdef KERNEL
242#define F_WAIT 0x010 /* Wait until lock is granted */
243#define F_FLOCK 0x020 /* Use flock(2) semantics for lock */
244#define F_POSIX 0x040 /* Use POSIX semantics for lock */
245#endif
246
91447636
A
247/*
248 * [XSI] The values used for l_whence shall be defined as described
249 * in <unistd.h>
250 */
251#ifndef SEEK_SET
252#define SEEK_SET 0 /* set file offset to offset */
253#define SEEK_CUR 1 /* set file offset to current plus offset */
254#define SEEK_END 2 /* set file offset to EOF plus offset */
255#endif /* !SEEK_SET */
256
257/*
258 * [XSI] The symbolic names for file modes for use as values of mode_t
259 * shall be defined as described in <sys/stat.h>
260 */
261#ifndef S_IFMT
262/* File type */
263#define S_IFMT 0170000 /* [XSI] type of file mask */
264#define S_IFIFO 0010000 /* [XSI] named pipe (fifo) */
265#define S_IFCHR 0020000 /* [XSI] character special */
266#define S_IFDIR 0040000 /* [XSI] directory */
267#define S_IFBLK 0060000 /* [XSI] block special */
268#define S_IFREG 0100000 /* [XSI] regular */
269#define S_IFLNK 0120000 /* [XSI] symbolic link */
270#define S_IFSOCK 0140000 /* [XSI] socket */
271#ifndef _POSIX_C_SOURCE
272#define S_IFWHT 0160000 /* whiteout */
273#define S_IFXATTR 0200000 /* extended attribute */
274#endif
275
276/* File mode */
277/* Read, write, execute/search by owner */
278#define S_IRWXU 0000700 /* [XSI] RWX mask for owner */
279#define S_IRUSR 0000400 /* [XSI] R for owner */
280#define S_IWUSR 0000200 /* [XSI] W for owner */
281#define S_IXUSR 0000100 /* [XSI] X for owner */
282/* Read, write, execute/search by group */
283#define S_IRWXG 0000070 /* [XSI] RWX mask for group */
284#define S_IRGRP 0000040 /* [XSI] R for group */
285#define S_IWGRP 0000020 /* [XSI] W for group */
286#define S_IXGRP 0000010 /* [XSI] X for group */
287/* Read, write, execute/search by others */
288#define S_IRWXO 0000007 /* [XSI] RWX mask for other */
289#define S_IROTH 0000004 /* [XSI] R for other */
290#define S_IWOTH 0000002 /* [XSI] W for other */
291#define S_IXOTH 0000001 /* [XSI] X for other */
292
293#define S_ISUID 0004000 /* [XSI] set user id on execution */
294#define S_ISGID 0002000 /* [XSI] set group id on execution */
295#define S_ISVTX 0001000 /* [XSI] directory restrcted delete */
296
297#ifndef _POSIX_C_SOURCE
298#define S_ISTXT S_ISVTX /* sticky bit: not supported */
299#define S_IREAD S_IRUSR /* backward compatability */
300#define S_IWRITE S_IWUSR /* backward compatability */
301#define S_IEXEC S_IXUSR /* backward compatability */
302#endif
303#endif /* !S_IFMT */
304
305#ifndef _POSIX_C_SOURCE
1c79356b
A
306/* allocate flags (F_PREALLOCATE) */
307
308#define F_ALLOCATECONTIG 0x00000002 /* allocate contigious space */
309#define F_ALLOCATEALL 0x00000004 /* allocate all requested space or no space at all */
310
311/* Position Modes (fst_posmode) for F_PREALLOCATE */
312
313#define F_PEOFPOSMODE 3 /* Make it past all of the SEEK pos modes so that */
314 /* we can keep them in sync should we desire */
0b4e3aa0 315#define F_VOLPOSMODE 4 /* specify volume starting postion */
91447636 316#endif /* _POSIX_C_SOURCE */
1c79356b
A
317
318/*
319 * Advisory file segment locking data type -
320 * information passed to system by user
321 */
322struct flock {
323 off_t l_start; /* starting offset */
324 off_t l_len; /* len = 0 means until end of file */
325 pid_t l_pid; /* lock owner */
326 short l_type; /* lock type: read/write, etc. */
327 short l_whence; /* type of l_start */
328};
329
330
91447636 331#ifndef _POSIX_C_SOURCE
1c79356b
A
332/*
333 * advisory file read data type -
334 * information passed by user to system
335 */
336struct radvisory {
337 off_t ra_offset;
338 int ra_count;
339};
340
341
1c79356b
A
342/* lock operations for flock(2) */
343#define LOCK_SH 0x01 /* shared file lock */
344#define LOCK_EX 0x02 /* exclusive file lock */
345#define LOCK_NB 0x04 /* don't block when locking */
346#define LOCK_UN 0x08 /* unlock file */
1c79356b 347
0b4e3aa0 348/* fstore_t type used by F_DEALLOCATE and F_PREALLOCATE commands */
1c79356b
A
349
350typedef struct fstore {
91447636 351 unsigned int fst_flags; /* IN: flags word */
1c79356b
A
352 int fst_posmode; /* IN: indicates use of offset field */
353 off_t fst_offset; /* IN: start of the region */
354 off_t fst_length; /* IN: size of the region */
355 off_t fst_bytesalloc; /* OUT: number of bytes allocated */
356} fstore_t;
357
358/* fbootstraptransfer_t used by F_READBOOTSTRAP and F_WRITEBOOTSTRAP commands */
359
360typedef struct fbootstraptransfer {
361 off_t fbt_offset; /* IN: offset to start read/write */
91447636 362 size_t fbt_length; /* IN: number of bytes to transfer */
1c79356b
A
363 void *fbt_buffer; /* IN: buffer to be read/written */
364} fbootstraptransfer_t;
365
91447636
A
366
367// LP64todo - should this move?
368#ifdef KERNEL
369/* LP64 version of fbootstraptransfer. all pointers
370 * grow when we're dealing with a 64-bit process.
371 * WARNING - keep in sync with fbootstraptransfer
372 */
373
91447636
A
374typedef 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
91447636
A
380#endif // KERNEL
381
1c79356b
A
382/*
383 * For F_LOG2PHYS this information is passed back to user
384 * Currently only devoffset is returned - that is the VOP_BMAP
385 * result - the disk device address corresponding to the
386 * current file offset (likely set with an lseek).
387 *
388 * The flags could hold an indication of whether the # of
389 * contiguous bytes reflects the true extent length on disk,
390 * or is an advisory value that indicates there is at least that
391 * many bytes contiguous. For some filesystems it might be too
392 * inefficient to provide anything beyond the advisory value.
393 * Flags and contiguous bytes return values are not yet implemented.
394 * For them the fcntl will nedd to switch from using BMAP to CMAP
395 * and a per filesystem type flag will be needed to interpret the
396 * contiguous bytes count result from CMAP.
397 */
5d5c5d0d 398#pragma pack(4)
91447636 399
1c79356b 400struct log2phys {
91447636 401 unsigned int l2p_flags; /* unused so far */
1c79356b
A
402 off_t l2p_contigbytes; /* unused so far */
403 off_t l2p_devoffset; /* bytes into device */
404};
405
5d5c5d0d 406#pragma pack()
91447636 407
1c79356b
A
408#define O_POPUP 0x80000000 /* force window to popup on open */
409#define O_ALERT 0x20000000 /* small, clean popup window */
91447636 410#endif /* _POSIX_C_SOURCE */
1c79356b
A
411
412#ifndef KERNEL
91447636
A
413
414#ifndef _POSIX_C_SOURCE
415#ifndef _FILESEC_T
416struct _filesec;
417typedef struct _filesec *filesec_t;
418#define _FILESEC_T
419#endif
420typedef 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 */
1c79356b
A
436
437__BEGIN_DECLS
91447636
A
438int open(const char *, int, ...);
439int creat(const char *, mode_t);
440int fcntl(int, int, ...);
441#ifndef _POSIX_C_SOURCE
442int openx_np(const char *, int, filesec_t);
443int flock(int, int);
444filesec_t filesec_init(void);
445filesec_t filesec_dup(filesec_t);
446void filesec_free(filesec_t);
447int filesec_get_property(filesec_t, filesec_property_t, void *);
448int filesec_set_property(filesec_t, filesec_property_t, const void *);
449int filesec_unset_property(filesec_t, filesec_property_t);
450int 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 */
1c79356b
A
454__END_DECLS
455#endif
456
457#endif /* !_SYS_FCNTL_H_ */