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

/*
 * Copyright (c) 2000-2008 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
/* The following option only valid when requesting ATTR_CMN_RETURNED_ATTRS */
#define FSOPT_PACK_INVAL_ATTRS	0x00000008

/* 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: If this bit is set the volume format supports
 * file sizes larger than 4GB, and potentially up to 2TB; it does not
 * indicate whether the filesystem supports files larger than that.
 *
 * 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.
 * 
 * VOL_CAP_FMT_NO_VOLUME_SIZES: When set, the volume does not support 
 * returning values for total data blocks, available blocks, or free blocks
 * (as in f_blocks, f_bavail, or f_bfree in "struct statfs").  Historically,
 * those values were set to 0xFFFFFFFF for volumes that did not support them.
 * 
 * VOL_CAP_FMT_DECMPFS_COMPRESSION: When set, the volume supports transparent
 * decompression of compressed files using decmpfs.
 */
#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
#define VOL_CAP_FMT_NO_VOLUME_SIZES		0x00008000
#define VOL_CAP_FMT_DECMPFS_COMPRESSION	0x00010000


/*
 * 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
#ifdef PRIVATE
/* Volume supports kqueue notifications for remote events */
#define VOL_CAP_INT_REMOTE_EVENT		0x00008000
#endif /* PRIVATE */

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_NAMEDATTRCOUNT		0x00080000	 not implemented */
/*  #define ATTR_CMN_NAMEDATTRLIST		0x00100000	 not implemented */
#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_FULLPATH			0x08000000
/*
 * ATTR_CMN_RETURNED_ATTRS is only valid with getattrlist(2).
 * It is always the first attribute in the return buffer.
 */
#define ATTR_CMN_RETURNED_ATTRS			0x80000000

#define ATTR_CMN_VALIDMASK			0x8FE7FFFF
#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_UUID				0x00040000
#define ATTR_VOL_ATTRIBUTES			0x40000000
#define ATTR_VOL_INFO				0x80000000

#define ATTR_VOL_VALIDMASK			0xC007FFFF
#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			0x000037FF
#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 user64_fssearchblock {
	user64_addr_t         returnattrs;
	user64_addr_t         returnbuffer;
	user64_size_t         returnbuffersize;
	user64_ulong_t        maxmatches;
	struct user64_timeval	timelimit;
	user64_addr_t         searchparams1;
	user64_size_t         sizeofsearchparams1;
	user64_addr_t         searchparams2;
	user64_size_t         sizeofsearchparams2;
	struct attrlist		searchattrs;
};

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