[apple/xnu.git] / bsd / sys / unistd.h

/*
 * Copyright (c) 2000-2010 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
/*
 * Copyright (c) 1989, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)unistd.h	8.2 (Berkeley) 1/7/94
 */

#ifndef _SYS_UNISTD_H_
#define	_SYS_UNISTD_H_

#include <sys/cdefs.h>

/*
 * Although we have saved user/group IDs, we do not use them in setuid
 * as described in POSIX 1003.1, because the feature does not work for
 * root.  We use the saved IDs in seteuid/setegid, which are not currently
 * part of the POSIX 1003.1 specification.
 */
#ifdef	_NOT_AVAILABLE
#define	_POSIX_SAVED_IDS	/* saved set-user-ID and set-group-ID */
#endif

#define	_POSIX_VERSION		200112L
#define	_POSIX2_VERSION		200112L

/* execution-time symbolic constants */
				/* may disable terminal special characters */
#ifndef _POSIX_VDISABLE
#define	_POSIX_VDISABLE		((unsigned char)'\377')
#endif

#define _POSIX_THREAD_KEYS_MAX 128

/* access function */
#define	F_OK		0	/* test for existence of file */
#define	X_OK		(1<<0)	/* test for execute or search permission */
#define	W_OK		(1<<1)	/* test for write permission */
#define	R_OK		(1<<2)	/* test for read permission */

#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
/*
 * Extended access functions.
 * Note that we depend on these matching the definitions in sys/kauth.h,
 * but with the bits shifted left by 8.
 */
#define _READ_OK	(1<<9)	/* read file data / read directory */
#define _WRITE_OK	(1<<10)	/* write file data / add file to directory */
#define _EXECUTE_OK	(1<<11) /* execute file / search in directory*/
#define _DELETE_OK	(1<<12)	/* delete file / delete directory */
#define _APPEND_OK	(1<<13)	/* append to file / add subdirectory to directory */
#define _RMFILE_OK	(1<<14)	/* - / remove file from directory */
#define _RATTR_OK	(1<<15)	/* read basic attributes */
#define _WATTR_OK	(1<<16)	/* write basic attributes */
#define _REXT_OK	(1<<17)	/* read extended attributes */
#define _WEXT_OK	(1<<18)	/* write extended attributes */
#define _RPERM_OK	(1<<19)	/* read permissions */
#define _WPERM_OK	(1<<20)	/* write permissions */
#define _CHOWN_OK	(1<<21)	/* change ownership */

#define _ACCESS_EXTENDED_MASK (_READ_OK | _WRITE_OK | _EXECUTE_OK | \
				_DELETE_OK | _APPEND_OK | \
				_RMFILE_OK | _REXT_OK | \
				_WEXT_OK | _RATTR_OK | _WATTR_OK | _RPERM_OK | \
				_WPERM_OK | _CHOWN_OK)
#endif

/* whence values for lseek(2) */
#ifndef SEEK_SET
#define	SEEK_SET	0	/* set file offset to offset */
#define	SEEK_CUR	1	/* set file offset to current plus offset */
#define	SEEK_END	2	/* set file offset to EOF plus offset */
#endif	/* !SEEK_SET */

#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
/* whence values for lseek(2); renamed by POSIX 1003.1 */
#define	L_SET		SEEK_SET
#define	L_INCR		SEEK_CUR
#define	L_XTND		SEEK_END
#endif

#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
struct accessx_descriptor {
	unsigned int ad_name_offset;
	int ad_flags;
	int ad_pad[2];
};
#define ACCESSX_MAX_DESCRIPTORS	100
#define ACCESSX_MAX_TABLESIZE	(16 * 1024)
#endif

/* configurable pathname variables */
#define	_PC_LINK_MAX		 1
#define	_PC_MAX_CANON		 2
#define	_PC_MAX_INPUT		 3
#define	_PC_NAME_MAX		 4
#define	_PC_PATH_MAX		 5
#define	_PC_PIPE_BUF		 6
#define	_PC_CHOWN_RESTRICTED	 7
#define	_PC_NO_TRUNC		 8
#define	_PC_VDISABLE		 9

#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
#define	_PC_NAME_CHARS_MAX	 10
#define	_PC_CASE_SENSITIVE		 11
#define	_PC_CASE_PRESERVING		 12
#define _PC_EXTENDED_SECURITY_NP        13
#define _PC_AUTH_OPAQUE_NP      14
#endif

#define	_PC_2_SYMLINKS		15	/* Symlink supported in directory */
#define	_PC_ALLOC_SIZE_MIN	16	/* Minimum storage actually allocated */
#define	_PC_ASYNC_IO		17	/* Async I/O [AIO] supported? */
#define	_PC_FILESIZEBITS	18	/* # of bits to represent file size */
#define	_PC_PRIO_IO		19	/* Priority I/O [PIO] supported? */
#define	_PC_REC_INCR_XFER_SIZE	20	/* Recommended increment for next two */
#define	_PC_REC_MAX_XFER_SIZE	21	/* Recommended max file transfer size */
#define	_PC_REC_MIN_XFER_SIZE	22	/* Recommended min file transfer size */
#define	_PC_REC_XFER_ALIGN	23	/* Recommended buffer alignment */
#define	_PC_SYMLINK_MAX		24	/* Max # of bytes in symlink name */
#define	_PC_SYNC_IO		25	/* Sync I/O [SIO] supported? */
#define _PC_XATTR_SIZE_BITS 	26	/* # of bits to represent maximum xattr size */

/* configurable system strings */
#define	_CS_PATH		 1

#endif /* !_SYS_UNISTD_H_ */
Commit	Line	Data
1c79356b	1	/*
6d2010ae	2	* Copyright (c) 2000-2010 Apple Inc. All rights reserved.
5d5c5d0d	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 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 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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
	29	/*
	30	* Copyright (c) 1989, 1993
	31	* The Regents of the University of California. All rights reserved.
	32	*
	33	* Redistribution and use in source and binary forms, with or without
	34	* modification, are permitted provided that the following conditions
	35	* are met:
	36	* 1. Redistributions of source code must retain the above copyright
	37	* notice, this list of conditions and the following disclaimer.
	38	* 2. Redistributions in binary form must reproduce the above copyright
	39	* notice, this list of conditions and the following disclaimer in the
	40	* documentation and/or other materials provided with the distribution.
	41	* 3. All advertising materials mentioning features or use of this software
	42	* must display the following acknowledgement:
	43	* This product includes software developed by the University of
	44	* California, Berkeley and its contributors.
	45	* 4. Neither the name of the University nor the names of its contributors
	46	* may be used to endorse or promote products derived from this software
	47	* without specific prior written permission.
	48	*
	49	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	50	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	51	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	52	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	53	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	54	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	55	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	56	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	57	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	58	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	59	* SUCH DAMAGE.
	60	*
	61	* @(#)unistd.h 8.2 (Berkeley) 1/7/94
	62	*/
	63
	64	#ifndef _SYS_UNISTD_H_
	65	#define _SYS_UNISTD_H_
	66
2d21ac55 A	67	#include <sys/cdefs.h>
2d21ac55 A	68
1c79356b A	69	/*
	70	* Although we have saved user/group IDs, we do not use them in setuid
	71	* as described in POSIX 1003.1, because the feature does not work for
	72	* root. We use the saved IDs in seteuid/setegid, which are not currently
	73	* part of the POSIX 1003.1 specification.
	74	*/
	75	#ifdef _NOT_AVAILABLE
	76	#define _POSIX_SAVED_IDS /* saved set-user-ID and set-group-ID */
	77	#endif
	78
91447636 A	79	#define _POSIX_VERSION 200112L
91447636 A	80	#define _POSIX2_VERSION 200112L
1c79356b A	81
1c79356b A	82	/* execution-time symbolic constants */
1c79356b A	83	/* may disable terminal special characters */
	84	#ifndef _POSIX_VDISABLE
	85	#define _POSIX_VDISABLE ((unsigned char)'\377')
	86	#endif
	87
1c79356b A	88	#define _POSIX_THREAD_KEYS_MAX 128
	89
	90	/* access function */
	91	#define F_OK 0 /* test for existence of file */
91447636 A	92	#define X_OK (1<<0) /* test for execute or search permission */
	93	#define W_OK (1<<1) /* test for write permission */
	94	#define R_OK (1<<2) /* test for read permission */
	95
2d21ac55	96	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
91447636 A	97	/*
	98	* Extended access functions.
	99	* Note that we depend on these matching the definitions in sys/kauth.h,
	100	* but with the bits shifted left by 8.
	101	*/
	102	#define _READ_OK (1<<9) /* read file data / read directory */
	103	#define _WRITE_OK (1<<10) /* write file data / add file to directory */
	104	#define _EXECUTE_OK (1<<11) /* execute file / search in directory*/
	105	#define _DELETE_OK (1<<12) /* delete file / delete directory */
	106	#define _APPEND_OK (1<<13) /* append to file / add subdirectory to directory */
	107	#define _RMFILE_OK (1<<14) /* - / remove file from directory */
	108	#define _RATTR_OK (1<<15) /* read basic attributes */
	109	#define _WATTR_OK (1<<16) /* write basic attributes */
	110	#define _REXT_OK (1<<17) /* read extended attributes */
	111	#define _WEXT_OK (1<<18) /* write extended attributes */
	112	#define _RPERM_OK (1<<19) /* read permissions */
	113	#define _WPERM_OK (1<<20) /* write permissions */
	114	#define _CHOWN_OK (1<<21) /* change ownership */
	115
	116	#define _ACCESS_EXTENDED_MASK (_READ_OK \| _WRITE_OK \| _EXECUTE_OK \| \
	117	_DELETE_OK \| _APPEND_OK \| \
	118	_RMFILE_OK \| _REXT_OK \| \
	119	_WEXT_OK \| _RATTR_OK \| _WATTR_OK \| _RPERM_OK \| \
	120	_WPERM_OK \| _CHOWN_OK)
	121	#endif
1c79356b A	122
1c79356b A	123	/* whence values for lseek(2) */
91447636	124	#ifndef SEEK_SET
1c79356b A	125	#define SEEK_SET 0 /* set file offset to offset */
	126	#define SEEK_CUR 1 /* set file offset to current plus offset */
	127	#define SEEK_END 2 /* set file offset to EOF plus offset */
91447636	128	#endif /* !SEEK_SET */
1c79356b	129
2d21ac55	130	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
1c79356b A	131	/* whence values for lseek(2); renamed by POSIX 1003.1 */
	132	#define L_SET SEEK_SET
	133	#define L_INCR SEEK_CUR
	134	#define L_XTND SEEK_END
	135	#endif
	136
2d21ac55	137	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
91447636	138	struct accessx_descriptor {
2d21ac55	139	unsigned int ad_name_offset;
91447636 A	140	int ad_flags;
	141	int ad_pad[2];
	142	};
	143	#define ACCESSX_MAX_DESCRIPTORS 100
	144	#define ACCESSX_MAX_TABLESIZE (16 * 1024)
	145	#endif
	146
1c79356b A	147	/* configurable pathname variables */
	148	#define _PC_LINK_MAX 1
	149	#define _PC_MAX_CANON 2
	150	#define _PC_MAX_INPUT 3
	151	#define _PC_NAME_MAX 4
	152	#define _PC_PATH_MAX 5
	153	#define _PC_PIPE_BUF 6
	154	#define _PC_CHOWN_RESTRICTED 7
	155	#define _PC_NO_TRUNC 8
	156	#define _PC_VDISABLE 9
	157
2d21ac55	158	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
1c79356b A	159	#define _PC_NAME_CHARS_MAX 10
	160	#define _PC_CASE_SENSITIVE 11
	161	#define _PC_CASE_PRESERVING 12
91447636 A	162	#define _PC_EXTENDED_SECURITY_NP 13
91447636 A	163	#define _PC_AUTH_OPAQUE_NP 14
1c79356b A	164	#endif
1c79356b A	165
2d21ac55 A	166	#define _PC_2_SYMLINKS 15 /* Symlink supported in directory */
	167	#define _PC_ALLOC_SIZE_MIN 16 /* Minimum storage actually allocated */
	168	#define _PC_ASYNC_IO 17 /* Async I/O [AIO] supported? */
	169	#define _PC_FILESIZEBITS 18 /* # of bits to represent file size */
	170	#define _PC_PRIO_IO 19 /* Priority I/O [PIO] supported? */
	171	#define _PC_REC_INCR_XFER_SIZE 20 /* Recommended increment for next two */
	172	#define _PC_REC_MAX_XFER_SIZE 21 /* Recommended max file transfer size */
	173	#define _PC_REC_MIN_XFER_SIZE 22 /* Recommended min file transfer size */
	174	#define _PC_REC_XFER_ALIGN 23 /* Recommended buffer alignment */
	175	#define _PC_SYMLINK_MAX 24 /* Max # of bytes in symlink name */
	176	#define _PC_SYNC_IO 25 /* Sync I/O [SIO] supported? */
6d2010ae	177	#define _PC_XATTR_SIZE_BITS 26 /* # of bits to represent maximum xattr size */
2d21ac55	178
1c79356b A	179	/* configurable system strings */
	180	#define _CS_PATH 1
	181
	182	#endif /* !_SYS_UNISTD_H_ */