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

/*
 * Copyright (c) 2000-2006 Apple Computer, 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@
 */

/*
 * attr.h - attribute data structures and interfaces
 *
 * Copyright (c) 1998, Apple Computer, Inc.  All Rights Reserved.
 */

#ifndef _SYS_ATTR_H_
#define _SYS_ATTR_H_

#include <sys/appleapiopts.h>

#ifdef __APPLE_API_UNSTABLE
#include <sys/types.h>
#include <sys/ucred.h>
#include <sys/time.h>
#include <sys/cdefs.h>

#define FSOPT_NOFOLLOW 		0x00000001
#define FSOPT_NOINMEMUPDATE 	0x00000002
#define FSOPT_REPORT_FULLSIZE	0x00000004

/* we currently aren't anywhere near this amount for a valid
 * fssearchblock.sizeofsearchparams1 or fssearchblock.sizeofsearchparams2
 * but we put a sanity check in to avoid abuse of the value passed in from
 * user land.
 */
#define SEARCHFS_MAX_SEARCHPARMS  4096

typedef u_int32_t text_encoding_t;

typedef u_int32_t fsobj_type_t;

typedef u_int32_t fsobj_tag_t;

typedef u_int32_t fsfile_type_t;

typedef u_int32_t fsvolid_t;

typedef struct fsobj_id {
	u_int32_t		fid_objno;
	u_int32_t		fid_generation;
} fsobj_id_t;

typedef u_int32_t attrgroup_t;

struct attrlist {
	u_short bitmapcount;			/* number of attr. bit sets in list (should be 5) */
	u_int16_t reserved;				/* (to maintain 4-byte alignment) */
	attrgroup_t commonattr;			/* common attribute group */
	attrgroup_t volattr;			/* Volume attribute group */
	attrgroup_t dirattr;			/* directory attribute group */
	attrgroup_t fileattr;			/* file attribute group */
	attrgroup_t forkattr;			/* fork attribute group */
};
#define ATTR_BIT_MAP_COUNT 5

typedef struct attribute_set {
	attrgroup_t commonattr;			/* common attribute group */
	attrgroup_t volattr;			/* Volume attribute group */
	attrgroup_t dirattr;			/* directory attribute group */
	attrgroup_t fileattr;			/* file attribute group */
	attrgroup_t forkattr;			/* fork attribute group */
} attribute_set_t;

typedef struct attrreference {
	int32_t     attr_dataoffset;
	u_int32_t   attr_length;
} attrreference_t;

/* XXX PPD This is derived from HFSVolumePriv.h and should perhaps be referenced from there? */

struct diskextent {
	u_int32_t					startblock;				/* first block allocated */
	u_int32_t					blockcount;				/* number of blocks allocated */
};

typedef struct diskextent extentrecord[8];

typedef u_int32_t vol_capabilities_set_t[4];

#define VOL_CAPABILITIES_FORMAT 0
#define VOL_CAPABILITIES_INTERFACES 1
#define VOL_CAPABILITIES_RESERVED1 2
#define VOL_CAPABILITIES_RESERVED2 3

typedef struct vol_capabilities_attr {
	vol_capabilities_set_t capabilities;
	vol_capabilities_set_t valid;
} vol_capabilities_attr_t;

/*
 * XXX this value needs to be raised - 3893388
 */
#define ATTR_MAX_BUFFER		8192

/*
 * VOL_CAP_FMT_PERSISTENTOBJECTIDS: When set, the volume has object IDs
 * that are persistent (retain their values even when the volume is
 * unmounted and remounted), and a file or directory can be looked up
 * by ID.  Volumes that support VolFS and can support Carbon File ID
 * references should set this bit.
 *
 * VOL_CAP_FMT_SYMBOLICLINKS: When set, the volume supports symbolic
 * links.  The symlink(), readlink(), and lstat() calls all use this
 * symbolic link.
 *
 * VOL_CAP_FMT_HARDLINKS: When set, the volume supports hard links.
 * The link() call creates hard links.
 *
 * VOL_CAP_FMT_JOURNAL: When set, the volume is capable of supporting
 * a journal used to speed recovery in case of unplanned shutdown
 * (such as a power outage or crash).  This bit does not necessarily
 * mean the volume is actively using a journal for recovery.
 *
 * VOL_CAP_FMT_JOURNAL_ACTIVE: When set, the volume is currently using
 * a journal for use in speeding recovery after an unplanned shutdown.
 * This bit can be set only if VOL_CAP_FMT_JOURNAL is also set.
 *
 * VOL_CAP_FMT_NO_ROOT_TIMES: When set, the volume format does not
 * store reliable times for the root directory, so you should not
 * depend on them to detect changes, etc.
 *
 * VOL_CAP_FMT_SPARSE_FILES: When set, the volume supports sparse files.
 * That is, files which can have "holes" that have never been written
 * to, and are not allocated on disk.  Sparse files may have an
 * allocated size that is less than the file's logical length.
 *
 * VOL_CAP_FMT_ZERO_RUNS: For security reasons, parts of a file (runs)
 * that have never been written to must appear to contain zeroes.  When
 * this bit is set, the volume keeps track of allocated but unwritten
 * runs of a file so that it can substitute zeroes without actually
 * writing zeroes to the media.  This provides performance similar to
 * sparse files, but not the space savings.
 *
 * VOL_CAP_FMT_CASE_SENSITIVE: When set, file and directory names are
 * case sensitive (upper and lower case are different).  When clear,
 * an upper case character is equivalent to a lower case character,
 * and you can't have two names that differ solely in the case of
 * the characters.
 *
 * VOL_CAP_FMT_CASE_PRESERVING: When set, file and directory names
 * preserve the difference between upper and lower case.  If clear,
 * the volume may change the case of some characters (typically
 * making them all upper or all lower case).  A volume that sets
 * VOL_CAP_FMT_CASE_SENSITIVE should also set VOL_CAP_FMT_CASE_PRESERVING.
 *
 * VOL_CAP_FMT_FAST_STATFS: This bit is used as a hint to upper layers
 * (especially Carbon) that statfs() is fast enough that its results
 * need not be cached by those upper layers.  A volume that caches
 * the statfs information in its in-memory structures should set this bit.
 * A volume that must always read from disk or always perform a network
 * transaction should not set this bit.  
 * 
 * VOL_CAP_FMT_2TB_FILESIZE: When set, the volume format supports file 
 * size upto 2TB.  This bit does not necessarily mean that the file 
 * system does not support file size more than 2TB.   This bit does 
 * not mean that the currently available space on the volume is 2TB. 
 *
 * VOL_CAP_FMT_OPENDENYMODES: When set, the volume supports open deny
 * modes (e.g. "open for read write, deny write"; effectively, mandatory
 * file locking based on open modes).
 *
 * VOL_CAP_FMT_HIDDEN_FILES: When set, the volume supports the UF_HIDDEN
 * file flag, and the UF_HIDDEN flag is mapped to that volume's native
 * "hidden" or "invisible" bit (which may be the invisible bit from the
 * Finder Info extended attribute).
 *
 * VOL_CAP_FMT_PATH_FROM_ID:  When set, the volume supports the ability
 * to derive a pathname to the root of the file system given only the
 * id of an object.  This also implies that object ids on this file
 * system are persistent and not recycled.  This is a very specialized
 * capability and it is assumed that most file systems will not support
 * it.  Its use is for legacy non-posix APIs like ResolveFileIDRef.
 * 
 */
#define VOL_CAP_FMT_PERSISTENTOBJECTIDS		0x00000001
#define VOL_CAP_FMT_SYMBOLICLINKS 		0x00000002
#define VOL_CAP_FMT_HARDLINKS      		0x00000004
#define VOL_CAP_FMT_JOURNAL       		0x00000008
#define VOL_CAP_FMT_JOURNAL_ACTIVE 		0x00000010
#define VOL_CAP_FMT_NO_ROOT_TIMES 		0x00000020
#define VOL_CAP_FMT_SPARSE_FILES 		0x00000040
#define VOL_CAP_FMT_ZERO_RUNS     		0x00000080
#define VOL_CAP_FMT_CASE_SENSITIVE 		0x00000100
#define VOL_CAP_FMT_CASE_PRESERVING		0x00000200
#define VOL_CAP_FMT_FAST_STATFS 		0x00000400
#define VOL_CAP_FMT_2TB_FILESIZE		0x00000800
#define VOL_CAP_FMT_OPENDENYMODES		0x00001000
#define VOL_CAP_FMT_HIDDEN_FILES		0x00002000
#define VOL_CAP_FMT_PATH_FROM_ID		0x00004000


/*
 * VOL_CAP_INT_SEARCHFS: When set, the volume implements the
 * searchfs() system call (the vnop_searchfs vnode operation).
 *
 * VOL_CAP_INT_ATTRLIST: When set, the volume implements the
 * getattrlist() and setattrlist() system calls (vnop_getattrlist
 * and vnop_setattrlist vnode operations) for the volume, files,
 * and directories.  The volume may or may not implement the
 * readdirattr() system call.  XXX Is there any minimum set
 * of attributes that should be supported?  To determine the
 * set of supported attributes, get the ATTR_VOL_ATTRIBUTES
 * attribute of the volume.
 *
 * VOL_CAP_INT_NFSEXPORT: When set, the volume implements exporting
 * of NFS volumes.
 *
 * VOL_CAP_INT_READDIRATTR: When set, the volume implements the
 * readdirattr() system call (vnop_readdirattr vnode operation).
 *
 * VOL_CAP_INT_EXCHANGEDATA: When set, the volume implements the
 * exchangedata() system call (VNOP_EXCHANGE vnode operation).
 *
 * VOL_CAP_INT_COPYFILE: When set, the volume implements the
 * VOP_COPYFILE vnode operation.  (XXX There should be a copyfile()
 * system call in <unistd.h>.)
 *
 * VOL_CAP_INT_ALLOCATE: When set, the volume implements the
 * VNOP_ALLOCATE vnode operation, which means it implements the
 * F_PREALLOCATE selector of fcntl(2).
 *
 * VOL_CAP_INT_VOL_RENAME: When set, the volume implements the
 * ATTR_VOL_NAME attribute for both getattrlist() and setattrlist().
 * The volume can be renamed by setting ATTR_VOL_NAME with setattrlist().
 *
 * VOL_CAP_INT_ADVLOCK: When set, the volume implements POSIX style
 * byte range locks via vnop_advlock (accessible from fcntl(2)).
 *
 * VOL_CAP_INT_FLOCK: When set, the volume implements whole-file flock(2)
 * style locks via vnop_advlock.  This includes the O_EXLOCK and O_SHLOCK
 * flags of the open(2) call.
 *
 * VOL_CAP_INT_EXTENDED_SECURITY: When set, the volume implements
 * extended security (ACLs).
 *
 * VOL_CAP_INT_USERACCESS:  When set, the volume supports the
 * ATTR_CMN_USERACCESS attribute (used to get the user's access
 * mode to the file).
 *
 * VOL_CAP_INT_MANLOCK: When set, the volume supports AFP-style
 * mandatory byte range locks via an ioctl().
 *
 * VOL_CAP_INT_EXTENDED_ATTR: When set, the volume implements
 * native extended attribues.
 *
 * VOL_CAP_INT_NAMEDSTREAMS: When set, the volume supports
 * native named streams.
 */
#define VOL_CAP_INT_SEARCHFS			0x00000001
#define VOL_CAP_INT_ATTRLIST			0x00000002
#define VOL_CAP_INT_NFSEXPORT			0x00000004
#define VOL_CAP_INT_READDIRATTR			0x00000008
#define VOL_CAP_INT_EXCHANGEDATA		0x00000010
#define VOL_CAP_INT_COPYFILE			0x00000020
#define VOL_CAP_INT_ALLOCATE			0x00000040
#define VOL_CAP_INT_VOL_RENAME			0x00000080
#define VOL_CAP_INT_ADVLOCK			0x00000100
#define VOL_CAP_INT_FLOCK			0x00000200
#define VOL_CAP_INT_EXTENDED_SECURITY		0x00000400
#define VOL_CAP_INT_USERACCESS			0x00000800
#define VOL_CAP_INT_MANLOCK			0x00001000
#define VOL_CAP_INT_NAMEDSTREAMS		0x00002000
#define VOL_CAP_INT_EXTENDED_ATTR		0x00004000

typedef struct vol_attributes_attr {
	attribute_set_t validattr;
	attribute_set_t nativeattr;
} vol_attributes_attr_t;

#define ATTR_CMN_NAME				0x00000001
#define ATTR_CMN_DEVID				0x00000002
#define ATTR_CMN_FSID				0x00000004
#define ATTR_CMN_OBJTYPE			0x00000008
#define ATTR_CMN_OBJTAG				0x00000010
#define ATTR_CMN_OBJID				0x00000020
#define ATTR_CMN_OBJPERMANENTID			0x00000040
#define ATTR_CMN_PAROBJID			0x00000080
#define ATTR_CMN_SCRIPT				0x00000100
#define ATTR_CMN_CRTIME				0x00000200
#define ATTR_CMN_MODTIME			0x00000400
#define ATTR_CMN_CHGTIME			0x00000800
#define ATTR_CMN_ACCTIME			0x00001000
#define ATTR_CMN_BKUPTIME			0x00002000
#define ATTR_CMN_FNDRINFO			0x00004000
#define ATTR_CMN_OWNERID			0x00008000
#define ATTR_CMN_GRPID				0x00010000
#define ATTR_CMN_ACCESSMASK			0x00020000
#define ATTR_CMN_FLAGS				0x00040000
#define ATTR_CMN_USERACCESS			0x00200000
#define ATTR_CMN_EXTENDED_SECURITY		0x00400000
#define ATTR_CMN_UUID				0x00800000
#define ATTR_CMN_GRPUUID			0x01000000
#define ATTR_CMN_FILEID				0x02000000
#define ATTR_CMN_PARENTID			0x04000000

#define ATTR_CMN_VALIDMASK			0x07FFFFFF
#define ATTR_CMN_SETMASK			0x01C7FF00
#define ATTR_CMN_VOLSETMASK			0x00006700

#define ATTR_VOL_FSTYPE				0x00000001
#define ATTR_VOL_SIGNATURE			0x00000002
#define ATTR_VOL_SIZE				0x00000004
#define ATTR_VOL_SPACEFREE			0x00000008
#define ATTR_VOL_SPACEAVAIL			0x00000010
#define ATTR_VOL_MINALLOCATION			0x00000020
#define ATTR_VOL_ALLOCATIONCLUMP		0x00000040
#define ATTR_VOL_IOBLOCKSIZE			0x00000080
#define ATTR_VOL_OBJCOUNT			0x00000100
#define ATTR_VOL_FILECOUNT			0x00000200
#define ATTR_VOL_DIRCOUNT			0x00000400
#define ATTR_VOL_MAXOBJCOUNT			0x00000800
#define ATTR_VOL_MOUNTPOINT			0x00001000
#define ATTR_VOL_NAME				0x00002000
#define ATTR_VOL_MOUNTFLAGS			0x00004000
#define ATTR_VOL_MOUNTEDDEVICE			0x00008000
#define ATTR_VOL_ENCODINGSUSED			0x00010000
#define ATTR_VOL_CAPABILITIES			0x00020000
#define ATTR_VOL_ATTRIBUTES			0x40000000
#define ATTR_VOL_INFO				0x80000000

#define ATTR_VOL_VALIDMASK			0xC003FFFF
#define ATTR_VOL_SETMASK			0x80002000


/* File/directory attributes: */
#define ATTR_DIR_LINKCOUNT			0x00000001
#define ATTR_DIR_ENTRYCOUNT			0x00000002
#define ATTR_DIR_MOUNTSTATUS			0x00000004
#define DIR_MNTSTATUS_MNTPOINT		0x00000001

#define ATTR_DIR_VALIDMASK			0x00000007
#define ATTR_DIR_SETMASK			0x00000000

#define ATTR_FILE_LINKCOUNT			0x00000001
#define ATTR_FILE_TOTALSIZE			0x00000002
#define ATTR_FILE_ALLOCSIZE			0x00000004
#define ATTR_FILE_IOBLOCKSIZE			0x00000008
#define ATTR_FILE_DEVTYPE			0x00000020
#define ATTR_FILE_FORKCOUNT			0x00000080
#define ATTR_FILE_FORKLIST			0x00000100
#define ATTR_FILE_DATALENGTH			0x00000200
#define ATTR_FILE_DATAALLOCSIZE			0x00000400
#define ATTR_FILE_RSRCLENGTH			0x00001000
#define ATTR_FILE_RSRCALLOCSIZE			0x00002000

#define ATTR_FILE_VALIDMASK			0x00007FFF
#define ATTR_FILE_SETMASK			0x00000020

#define ATTR_FORK_TOTALSIZE			0x00000001
#define ATTR_FORK_ALLOCSIZE			0x00000002

#define ATTR_FORK_VALIDMASK			0x00000003
#define ATTR_FORK_SETMASK			0x00000000

/* Obsolete, implemented, not supported */
#define ATTR_CMN_NAMEDATTRCOUNT			0x00080000	/* not implemented */
#define ATTR_CMN_NAMEDATTRLIST			0x00100000	/* not implemented */
#define ATTR_FILE_CLUMPSIZE			0x00000010	/* obsolete */
#define ATTR_FILE_FILETYPE			0x00000040	/* always zero */
#define ATTR_FILE_DATAEXTENTS			0x00000800	/* obsolete, HFS-specific */
#define ATTR_FILE_RSRCEXTENTS			0x00004000	/* obsolete, HFS-specific */

/*
 * Searchfs
 */
#define SRCHFS_START 				0x00000001
#define SRCHFS_MATCHPARTIALNAMES 		0x00000002
#define SRCHFS_MATCHDIRS 			0x00000004
#define SRCHFS_MATCHFILES 			0x00000008
#define SRCHFS_SKIPLINKS 			0x00000010
#define SRCHFS_SKIPINVISIBLE			0x00000020
#define SRCHFS_SKIPPACKAGES			0x00000040
#define SRCHFS_SKIPINAPPROPRIATE		0x00000080

#define SRCHFS_NEGATEPARAMS 			0x80000000
#define SRCHFS_VALIDOPTIONSMASK			0x800000FF

struct fssearchblock {
	struct attrlist		*returnattrs;
	void				*returnbuffer;
	size_t				returnbuffersize;
	u_long				maxmatches;
	struct timeval		timelimit;
	void				*searchparams1;
	size_t				sizeofsearchparams1;
	void				*searchparams2;
	size_t				sizeofsearchparams2;
	struct attrlist		searchattrs;
};

#ifdef KERNEL
/* LP64 version of fssearchblock.  all pointers and longs
 * grow when we're dealing with a 64-bit process.
 * WARNING - keep in sync with fssearchblock
 */

struct user_fssearchblock {
	user_addr_t         returnattrs;
	user_addr_t         returnbuffer;
	user_size_t         returnbuffersize;
	user_ulong_t        maxmatches;
	struct user_timeval	timelimit;
	user_addr_t         searchparams1 __attribute((aligned(8)));
	user_size_t         sizeofsearchparams1;
	user_addr_t         searchparams2;
	user_size_t         sizeofsearchparams2;
	struct attrlist		searchattrs;
};


#endif // KERNEL


struct searchstate {
	u_char				reserved[556];		//	sizeof( SearchState )
};


#define FST_EOF (-1)				/* end-of-file offset */

#endif /* __APPLE_API_UNSTABLE */
#endif /* !_SYS_ATTR_H_ */
Commit	Line	Data
1c79356b	1	/*
2d21ac55	2	* Copyright (c) 2000-2006 Apple Computer, 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
	29	/*
	30	* attr.h - attribute data structures and interfaces
	31	*
	32	* Copyright (c) 1998, Apple Computer, Inc. All Rights Reserved.
	33	*/
	34
	35	#ifndef _SYS_ATTR_H_
	36	#define _SYS_ATTR_H_
	37
9bccf70c A	38	#include <sys/appleapiopts.h>
	39
	40	#ifdef __APPLE_API_UNSTABLE
1c79356b	41	#include <sys/types.h>
1c79356b	42	#include <sys/ucred.h>
1c79356b	43	#include <sys/time.h>
91447636	44	#include <sys/cdefs.h>
1c79356b A	45
1c79356b A	46	#define FSOPT_NOFOLLOW 0x00000001
91447636 A	47	#define FSOPT_NOINMEMUPDATE 0x00000002
91447636 A	48	#define FSOPT_REPORT_FULLSIZE 0x00000004
1c79356b	49
a3d08fcd A	50	/* we currently aren't anywhere near this amount for a valid
	51	* fssearchblock.sizeofsearchparams1 or fssearchblock.sizeofsearchparams2
	52	* but we put a sanity check in to avoid abuse of the value passed in from
	53	* user land.
	54	*/
	55	#define SEARCHFS_MAX_SEARCHPARMS 4096
	56
1c79356b A	57	typedef u_int32_t text_encoding_t;
	58
	59	typedef u_int32_t fsobj_type_t;
	60
	61	typedef u_int32_t fsobj_tag_t;
	62
	63	typedef u_int32_t fsfile_type_t;
	64
	65	typedef u_int32_t fsvolid_t;
	66
	67	typedef struct fsobj_id {
	68	u_int32_t fid_objno;
	69	u_int32_t fid_generation;
	70	} fsobj_id_t;
	71
	72	typedef u_int32_t attrgroup_t;
	73
	74	struct attrlist {
	75	u_short bitmapcount; /* number of attr. bit sets in list (should be 5) */
	76	u_int16_t reserved; /* (to maintain 4-byte alignment) */
	77	attrgroup_t commonattr; /* common attribute group */
	78	attrgroup_t volattr; /* Volume attribute group */
	79	attrgroup_t dirattr; /* directory attribute group */
	80	attrgroup_t fileattr; /* file attribute group */
	81	attrgroup_t forkattr; /* fork attribute group */
	82	};
	83	#define ATTR_BIT_MAP_COUNT 5
	84
	85	typedef struct attribute_set {
	86	attrgroup_t commonattr; /* common attribute group */
	87	attrgroup_t volattr; /* Volume attribute group */
	88	attrgroup_t dirattr; /* directory attribute group */
	89	attrgroup_t fileattr; /* file attribute group */
	90	attrgroup_t forkattr; /* fork attribute group */
	91	} attribute_set_t;
	92
	93	typedef struct attrreference {
91447636 A	94	int32_t attr_dataoffset;
91447636 A	95	u_int32_t attr_length;
1c79356b A	96	} attrreference_t;
	97
	98	/* XXX PPD This is derived from HFSVolumePriv.h and should perhaps be referenced from there? */
	99
	100	struct diskextent {
	101	u_int32_t startblock; /* first block allocated */
	102	u_int32_t blockcount; /* number of blocks allocated */
	103	};
	104
	105	typedef struct diskextent extentrecord[8];
	106
	107	typedef u_int32_t vol_capabilities_set_t[4];
	108
	109	#define VOL_CAPABILITIES_FORMAT 0
	110	#define VOL_CAPABILITIES_INTERFACES 1
	111	#define VOL_CAPABILITIES_RESERVED1 2
	112	#define VOL_CAPABILITIES_RESERVED2 3
	113
	114	typedef struct vol_capabilities_attr {
	115	vol_capabilities_set_t capabilities;
	116	vol_capabilities_set_t valid;
	117	} vol_capabilities_attr_t;
	118
91447636 A	119	/*
	120	* XXX this value needs to be raised - 3893388
	121	*/
	122	#define ATTR_MAX_BUFFER 8192
	123
55e303ae A	124	/*
	125	* VOL_CAP_FMT_PERSISTENTOBJECTIDS: When set, the volume has object IDs
	126	* that are persistent (retain their values even when the volume is
	127	* unmounted and remounted), and a file or directory can be looked up
	128	* by ID. Volumes that support VolFS and can support Carbon File ID
	129	* references should set this bit.
	130	*
	131	* VOL_CAP_FMT_SYMBOLICLINKS: When set, the volume supports symbolic
	132	* links. The symlink(), readlink(), and lstat() calls all use this
	133	* symbolic link.
	134	*
	135	* VOL_CAP_FMT_HARDLINKS: When set, the volume supports hard links.
	136	* The link() call creates hard links.
	137	*
	138	* VOL_CAP_FMT_JOURNAL: When set, the volume is capable of supporting
	139	* a journal used to speed recovery in case of unplanned shutdown
	140	* (such as a power outage or crash). This bit does not necessarily
	141	* mean the volume is actively using a journal for recovery.
	142	*
	143	* VOL_CAP_FMT_JOURNAL_ACTIVE: When set, the volume is currently using
	144	* a journal for use in speeding recovery after an unplanned shutdown.
	145	* This bit can be set only if VOL_CAP_FMT_JOURNAL is also set.
	146	*
	147	* VOL_CAP_FMT_NO_ROOT_TIMES: When set, the volume format does not
	148	* store reliable times for the root directory, so you should not
	149	* depend on them to detect changes, etc.
	150	*
	151	* VOL_CAP_FMT_SPARSE_FILES: When set, the volume supports sparse files.
	152	* That is, files which can have "holes" that have never been written
	153	* to, and are not allocated on disk. Sparse files may have an
	154	* allocated size that is less than the file's logical length.
	155	*
	156	* VOL_CAP_FMT_ZERO_RUNS: For security reasons, parts of a file (runs)
	157	* that have never been written to must appear to contain zeroes. When
	158	* this bit is set, the volume keeps track of allocated but unwritten
	159	* runs of a file so that it can substitute zeroes without actually
	160	* writing zeroes to the media. This provides performance similar to
	161	* sparse files, but not the space savings.
	162	*
	163	* VOL_CAP_FMT_CASE_SENSITIVE: When set, file and directory names are
	164	* case sensitive (upper and lower case are different). When clear,
	165	* an upper case character is equivalent to a lower case character,
	166	* and you can't have two names that differ solely in the case of
	167	* the characters.
	168	*
	169	* VOL_CAP_FMT_CASE_PRESERVING: When set, file and directory names
	170	* preserve the difference between upper and lower case. If clear,
	171	* the volume may change the case of some characters (typically
	172	* making them all upper or all lower case). A volume that sets
	173	* VOL_CAP_FMT_CASE_SENSITIVE should also set VOL_CAP_FMT_CASE_PRESERVING.
	174	*
	175	* VOL_CAP_FMT_FAST_STATFS: This bit is used as a hint to upper layers
	176	* (especially Carbon) that statfs() is fast enough that its results
	177	* need not be cached by those upper layers. A volume that caches
	178	* the statfs information in its in-memory structures should set this bit.
	179	* A volume that must always read from disk or always perform a network
	180	* transaction should not set this bit.
91447636 A	181	*
	182	* VOL_CAP_FMT_2TB_FILESIZE: When set, the volume format supports file
	183	* size upto 2TB. This bit does not necessarily mean that the file
	184	* system does not support file size more than 2TB. This bit does
	185	* not mean that the currently available space on the volume is 2TB.
2d21ac55 A	186	*
	187	* VOL_CAP_FMT_OPENDENYMODES: When set, the volume supports open deny
	188	* modes (e.g. "open for read write, deny write"; effectively, mandatory
	189	* file locking based on open modes).
	190	*
	191	* VOL_CAP_FMT_HIDDEN_FILES: When set, the volume supports the UF_HIDDEN
	192	* file flag, and the UF_HIDDEN flag is mapped to that volume's native
	193	* "hidden" or "invisible" bit (which may be the invisible bit from the
	194	* Finder Info extended attribute).
	195	*
	196	* VOL_CAP_FMT_PATH_FROM_ID: When set, the volume supports the ability
	197	* to derive a pathname to the root of the file system given only the
	198	* id of an object. This also implies that object ids on this file
	199	* system are persistent and not recycled. This is a very specialized
	200	* capability and it is assumed that most file systems will not support
	201	* it. Its use is for legacy non-posix APIs like ResolveFileIDRef.
	202	*
55e303ae	203	*/
91447636 A	204	#define VOL_CAP_FMT_PERSISTENTOBJECTIDS 0x00000001
	205	#define VOL_CAP_FMT_SYMBOLICLINKS 0x00000002
	206	#define VOL_CAP_FMT_HARDLINKS 0x00000004
	207	#define VOL_CAP_FMT_JOURNAL 0x00000008
	208	#define VOL_CAP_FMT_JOURNAL_ACTIVE 0x00000010
	209	#define VOL_CAP_FMT_NO_ROOT_TIMES 0x00000020
	210	#define VOL_CAP_FMT_SPARSE_FILES 0x00000040
	211	#define VOL_CAP_FMT_ZERO_RUNS 0x00000080
	212	#define VOL_CAP_FMT_CASE_SENSITIVE 0x00000100
	213	#define VOL_CAP_FMT_CASE_PRESERVING 0x00000200
	214	#define VOL_CAP_FMT_FAST_STATFS 0x00000400
	215	#define VOL_CAP_FMT_2TB_FILESIZE 0x00000800
2d21ac55 A	216	#define VOL_CAP_FMT_OPENDENYMODES 0x00001000
	217	#define VOL_CAP_FMT_HIDDEN_FILES 0x00002000
	218	#define VOL_CAP_FMT_PATH_FROM_ID 0x00004000
55e303ae	219
1c79356b	220
55e303ae A	221	/*
55e303ae A	222	* VOL_CAP_INT_SEARCHFS: When set, the volume implements the
91447636	223	* searchfs() system call (the vnop_searchfs vnode operation).
55e303ae A	224	*
55e303ae A	225	* VOL_CAP_INT_ATTRLIST: When set, the volume implements the
91447636 A	226	* getattrlist() and setattrlist() system calls (vnop_getattrlist
91447636 A	227	* and vnop_setattrlist vnode operations) for the volume, files,
55e303ae A	228	* and directories. The volume may or may not implement the
	229	* readdirattr() system call. XXX Is there any minimum set
	230	* of attributes that should be supported? To determine the
	231	* set of supported attributes, get the ATTR_VOL_ATTRIBUTES
	232	* attribute of the volume.
	233	*
	234	* VOL_CAP_INT_NFSEXPORT: When set, the volume implements exporting
	235	* of NFS volumes.
	236	*
	237	* VOL_CAP_INT_READDIRATTR: When set, the volume implements the
91447636	238	* readdirattr() system call (vnop_readdirattr vnode operation).
55e303ae A	239	*
55e303ae A	240	* VOL_CAP_INT_EXCHANGEDATA: When set, the volume implements the
91447636	241	* exchangedata() system call (VNOP_EXCHANGE vnode operation).
55e303ae A	242	*
	243	* VOL_CAP_INT_COPYFILE: When set, the volume implements the
	244	* VOP_COPYFILE vnode operation. (XXX There should be a copyfile()
	245	* system call in <unistd.h>.)
	246	*
	247	* VOL_CAP_INT_ALLOCATE: When set, the volume implements the
91447636	248	* VNOP_ALLOCATE vnode operation, which means it implements the
55e303ae A	249	* F_PREALLOCATE selector of fcntl(2).
	250	*
	251	* VOL_CAP_INT_VOL_RENAME: When set, the volume implements the
	252	* ATTR_VOL_NAME attribute for both getattrlist() and setattrlist().
	253	* The volume can be renamed by setting ATTR_VOL_NAME with setattrlist().
	254	*
	255	* VOL_CAP_INT_ADVLOCK: When set, the volume implements POSIX style
91447636	256	* byte range locks via vnop_advlock (accessible from fcntl(2)).
55e303ae A	257	*
55e303ae A	258	* VOL_CAP_INT_FLOCK: When set, the volume implements whole-file flock(2)
91447636	259	* style locks via vnop_advlock. This includes the O_EXLOCK and O_SHLOCK
55e303ae A	260	* flags of the open(2) call.
55e303ae A	261	*
2d21ac55 A	262	* VOL_CAP_INT_EXTENDED_SECURITY: When set, the volume implements
	263	* extended security (ACLs).
	264	*
	265	* VOL_CAP_INT_USERACCESS: When set, the volume supports the
	266	* ATTR_CMN_USERACCESS attribute (used to get the user's access
	267	* mode to the file).
	268	*
	269	* VOL_CAP_INT_MANLOCK: When set, the volume supports AFP-style
	270	* mandatory byte range locks via an ioctl().
	271	*
	272	* VOL_CAP_INT_EXTENDED_ATTR: When set, the volume implements
	273	* native extended attribues.
	274	*
	275	* VOL_CAP_INT_NAMEDSTREAMS: When set, the volume supports
	276	* native named streams.
55e303ae	277	*/
91447636 A	278	#define VOL_CAP_INT_SEARCHFS 0x00000001
	279	#define VOL_CAP_INT_ATTRLIST 0x00000002
	280	#define VOL_CAP_INT_NFSEXPORT 0x00000004
	281	#define VOL_CAP_INT_READDIRATTR 0x00000008
	282	#define VOL_CAP_INT_EXCHANGEDATA 0x00000010
	283	#define VOL_CAP_INT_COPYFILE 0x00000020
	284	#define VOL_CAP_INT_ALLOCATE 0x00000040
	285	#define VOL_CAP_INT_VOL_RENAME 0x00000080
	286	#define VOL_CAP_INT_ADVLOCK 0x00000100
	287	#define VOL_CAP_INT_FLOCK 0x00000200
	288	#define VOL_CAP_INT_EXTENDED_SECURITY 0x00000400
	289	#define VOL_CAP_INT_USERACCESS 0x00000800
2d21ac55 A	290	#define VOL_CAP_INT_MANLOCK 0x00001000
	291	#define VOL_CAP_INT_NAMEDSTREAMS 0x00002000
	292	#define VOL_CAP_INT_EXTENDED_ATTR 0x00004000
1c79356b A	293
	294	typedef struct vol_attributes_attr {
	295	attribute_set_t validattr;
	296	attribute_set_t nativeattr;
	297	} vol_attributes_attr_t;
	298
1c79356b A	299	#define ATTR_CMN_NAME 0x00000001
	300	#define ATTR_CMN_DEVID 0x00000002
	301	#define ATTR_CMN_FSID 0x00000004
	302	#define ATTR_CMN_OBJTYPE 0x00000008
	303	#define ATTR_CMN_OBJTAG 0x00000010
	304	#define ATTR_CMN_OBJID 0x00000020
91447636	305	#define ATTR_CMN_OBJPERMANENTID 0x00000040
1c79356b A	306	#define ATTR_CMN_PAROBJID 0x00000080
	307	#define ATTR_CMN_SCRIPT 0x00000100
	308	#define ATTR_CMN_CRTIME 0x00000200
	309	#define ATTR_CMN_MODTIME 0x00000400
	310	#define ATTR_CMN_CHGTIME 0x00000800
	311	#define ATTR_CMN_ACCTIME 0x00001000
	312	#define ATTR_CMN_BKUPTIME 0x00002000
	313	#define ATTR_CMN_FNDRINFO 0x00004000
	314	#define ATTR_CMN_OWNERID 0x00008000
	315	#define ATTR_CMN_GRPID 0x00010000
	316	#define ATTR_CMN_ACCESSMASK 0x00020000
	317	#define ATTR_CMN_FLAGS 0x00040000
1c79356b	318	#define ATTR_CMN_USERACCESS 0x00200000
91447636 A	319	#define ATTR_CMN_EXTENDED_SECURITY 0x00400000
	320	#define ATTR_CMN_UUID 0x00800000
	321	#define ATTR_CMN_GRPUUID 0x01000000
2d21ac55 A	322	#define ATTR_CMN_FILEID 0x02000000
2d21ac55 A	323	#define ATTR_CMN_PARENTID 0x04000000
1c79356b	324
2d21ac55	325	#define ATTR_CMN_VALIDMASK 0x07FFFFFF
91447636	326	#define ATTR_CMN_SETMASK 0x01C7FF00
1c79356b A	327	#define ATTR_CMN_VOLSETMASK 0x00006700
	328
	329	#define ATTR_VOL_FSTYPE 0x00000001
	330	#define ATTR_VOL_SIGNATURE 0x00000002
	331	#define ATTR_VOL_SIZE 0x00000004
	332	#define ATTR_VOL_SPACEFREE 0x00000008
	333	#define ATTR_VOL_SPACEAVAIL 0x00000010
91447636 A	334	#define ATTR_VOL_MINALLOCATION 0x00000020
	335	#define ATTR_VOL_ALLOCATIONCLUMP 0x00000040
	336	#define ATTR_VOL_IOBLOCKSIZE 0x00000080
1c79356b A	337	#define ATTR_VOL_OBJCOUNT 0x00000100
	338	#define ATTR_VOL_FILECOUNT 0x00000200
	339	#define ATTR_VOL_DIRCOUNT 0x00000400
91447636	340	#define ATTR_VOL_MAXOBJCOUNT 0x00000800
1c79356b A	341	#define ATTR_VOL_MOUNTPOINT 0x00001000
	342	#define ATTR_VOL_NAME 0x00002000
	343	#define ATTR_VOL_MOUNTFLAGS 0x00004000
91447636 A	344	#define ATTR_VOL_MOUNTEDDEVICE 0x00008000
	345	#define ATTR_VOL_ENCODINGSUSED 0x00010000
	346	#define ATTR_VOL_CAPABILITIES 0x00020000
1c79356b A	347	#define ATTR_VOL_ATTRIBUTES 0x40000000
	348	#define ATTR_VOL_INFO 0x80000000
	349
	350	#define ATTR_VOL_VALIDMASK 0xC003FFFF
	351	#define ATTR_VOL_SETMASK 0x80002000
	352
	353
	354	/* File/directory attributes: */
	355	#define ATTR_DIR_LINKCOUNT 0x00000001
	356	#define ATTR_DIR_ENTRYCOUNT 0x00000002
91447636 A	357	#define ATTR_DIR_MOUNTSTATUS 0x00000004
91447636 A	358	#define DIR_MNTSTATUS_MNTPOINT 0x00000001
1c79356b A	359
	360	#define ATTR_DIR_VALIDMASK 0x00000007
	361	#define ATTR_DIR_SETMASK 0x00000000
	362
	363	#define ATTR_FILE_LINKCOUNT 0x00000001
	364	#define ATTR_FILE_TOTALSIZE 0x00000002
	365	#define ATTR_FILE_ALLOCSIZE 0x00000004
91447636	366	#define ATTR_FILE_IOBLOCKSIZE 0x00000008
1c79356b	367	#define ATTR_FILE_DEVTYPE 0x00000020
1c79356b A	368	#define ATTR_FILE_FORKCOUNT 0x00000080
1c79356b A	369	#define ATTR_FILE_FORKLIST 0x00000100
91447636 A	370	#define ATTR_FILE_DATALENGTH 0x00000200
	371	#define ATTR_FILE_DATAALLOCSIZE 0x00000400
	372	#define ATTR_FILE_RSRCLENGTH 0x00001000
	373	#define ATTR_FILE_RSRCALLOCSIZE 0x00002000
1c79356b A	374
	375	#define ATTR_FILE_VALIDMASK 0x00007FFF
	376	#define ATTR_FILE_SETMASK 0x00000020
	377
	378	#define ATTR_FORK_TOTALSIZE 0x00000001
	379	#define ATTR_FORK_ALLOCSIZE 0x00000002
	380
	381	#define ATTR_FORK_VALIDMASK 0x00000003
	382	#define ATTR_FORK_SETMASK 0x00000000
	383
91447636 A	384	/* Obsolete, implemented, not supported */
	385	#define ATTR_CMN_NAMEDATTRCOUNT 0x00080000 /* not implemented */
	386	#define ATTR_CMN_NAMEDATTRLIST 0x00100000 /* not implemented */
	387	#define ATTR_FILE_CLUMPSIZE 0x00000010 /* obsolete */
	388	#define ATTR_FILE_FILETYPE 0x00000040 /* always zero */
	389	#define ATTR_FILE_DATAEXTENTS 0x00000800 /* obsolete, HFS-specific */
	390	#define ATTR_FILE_RSRCEXTENTS 0x00004000 /* obsolete, HFS-specific */
	391
	392	/*
	393	* Searchfs
	394	*/
	395	#define SRCHFS_START 0x00000001
1c79356b	396	#define SRCHFS_MATCHPARTIALNAMES 0x00000002
91447636 A	397	#define SRCHFS_MATCHDIRS 0x00000004
	398	#define SRCHFS_MATCHFILES 0x00000008
	399	#define SRCHFS_SKIPLINKS 0x00000010
	400	#define SRCHFS_SKIPINVISIBLE 0x00000020
	401	#define SRCHFS_SKIPPACKAGES 0x00000040
	402	#define SRCHFS_SKIPINAPPROPRIATE 0x00000080
55e303ae	403
1c79356b	404	#define SRCHFS_NEGATEPARAMS 0x80000000
55e303ae	405	#define SRCHFS_VALIDOPTIONSMASK 0x800000FF
1c79356b A	406
	407	struct fssearchblock {
	408	struct attrlist *returnattrs;
	409	void *returnbuffer;
	410	size_t returnbuffersize;
	411	u_long maxmatches;
	412	struct timeval timelimit;
	413	void *searchparams1;
	414	size_t sizeofsearchparams1;
	415	void *searchparams2;
	416	size_t sizeofsearchparams2;
	417	struct attrlist searchattrs;
	418	};
	419
91447636 A	420	#ifdef KERNEL
	421	/* LP64 version of fssearchblock. all pointers and longs
	422	* grow when we're dealing with a 64-bit process.
	423	* WARNING - keep in sync with fssearchblock
	424	*/
91447636	425
91447636 A	426	struct user_fssearchblock {
	427	user_addr_t returnattrs;
	428	user_addr_t returnbuffer;
	429	user_size_t returnbuffersize;
	430	user_ulong_t maxmatches;
0c530ab8 A	431	struct user_timeval timelimit;
0c530ab8 A	432	user_addr_t searchparams1 __attribute((aligned(8)));
91447636 A	433	user_size_t sizeofsearchparams1;
	434	user_addr_t searchparams2;
	435	user_size_t sizeofsearchparams2;
	436	struct attrlist searchattrs;
	437	};
	438
91447636 A	439
	440	#endif // KERNEL
	441
1c79356b A	442
	443	struct searchstate {
	444	u_char reserved[556]; // sizeof( SearchState )
	445	};
	446
	447
1c79356b A	448	#define FST_EOF (-1) /* end-of-file offset */
1c79356b A	449
9bccf70c	450	#endif /* __APPLE_API_UNSTABLE */
1c79356b	451	#endif /* !_SYS_ATTR_H_ */