[apple/xnu.git] / bsd / hfs / hfs_catalog.h

/*
 * Copyright (c) 2002-2014 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@
 */
#ifndef __HFS_CATALOG__
#define __HFS_CATALOG__

#include <sys/appleapiopts.h>

#ifdef KERNEL
#ifdef __APPLE_API_PRIVATE
#include <sys/vnode.h>

#include <hfs/hfs_format.h>

/* HFS Catalog */


/*
 * Catalog ADTs
 *
 * The cat_desc, cat_attr, and cat_fork structures are
 * use to import/export data to/from the Catalog file.
 * The fields in these structures are always in BSD
 * runtime format (e.g. dates and names).
 */
 
typedef u_int32_t	cnid_t;

/*
 * Catalog Node Descriptor (runtime)
 */
struct cat_desc {
	u_int8_t  cd_flags;       /* see below (8 bits) */
	u_int8_t  cd_encoding;    /* name encoding */
	int16_t   cd_namelen;     /* length of cnode name */
	cnid_t    cd_parentcnid;  /* parent directory CNID */
	u_int32_t    cd_hint;        /* catalog file hint */
	cnid_t    cd_cnid;        /* cnode id (for getattrlist) */
	const u_int8_t * cd_nameptr; /* pointer to cnode name */
};

/* cd_flags
 *
 * CD_EOF is used by hfs_vnop_readdir / cat_getdirentries to indicate EOF was
 * encountered during a directory enumeration.  When this flag is observed
 * on the next call to hfs_vnop_readdir it tells the caller that there's no
 * need to descend into the catalog as EOF was encountered during the last call.
 * This flag should only be set on the descriptor embedded in the directoryhint. 
 */

#define	CD_HASBUF	0x01	/* allocated filename buffer */
#define CD_DECOMPOSED	0x02	/* name is fully decomposed */
#define CD_EOF		0x04	/* see above */
#define	CD_ISMETA	0x40	/* describes a metadata file */
#define	CD_ISDIR	0x80	/* describes a directory */

/*
 * Catalog Node Attributes (runtime)
 */
struct cat_attr {
	cnid_t		ca_fileid;	/* inode number (for stat) normally == cnid */
	mode_t		ca_mode;	/* file access mode and type (16 bits) */
	u_int16_t	ca_recflags;	/* catalog record flags (16 bit integer) */
	u_int32_t	ca_linkcount;	/* real hard link count */
	uid_t		ca_uid;		/* file owner */
	gid_t		ca_gid;		/* file group */
	union {
	    dev_t	cau_rdev;	/* special file device (VBLK or VCHAR only) */
	    u_int32_t	cau_linkref;	/* hardlink reference number */
	} ca_union1;
	time_t		ca_atime;	/* last access time */
	time_t		ca_atimeondisk;	/* access time value on disk */
	time_t		ca_mtime;	/* last data modification time */
	time_t		ca_ctime;	/* last file status change */
	time_t		ca_itime;	/* file initialization time */
	time_t		ca_btime;	/* last backup time */
	u_int32_t	ca_flags;	/* status flags (chflags) */
	union {
	    u_int32_t	cau_blocks;	/* total file blocks used (rsrc + data) */
	    u_int32_t	cau_entries;	/* total directory entries (valence) */
	} ca_union2;
	union {
	    u_int32_t	cau_dircount;	/* count of sub dirs (for posix nlink) */
	    u_int32_t	cau_firstlink;	/* first hardlink link (files only) */
	} ca_union3;
	union {
		u_int8_t 	ca_finderinfo[32]; /* Opaque Finder information */
		struct {
			FndrFileInfo 					ca_finderfileinfo;
			struct FndrExtendedFileInfo 	ca_finderextendedfileinfo;
		};
		struct {
			FndrDirInfo 					ca_finderdirinfo;
			struct FndrExtendedDirInfo 		ca_finderextendeddirinfo;
		};
	};
};

/* Aliases for common fields */
#define	ca_rdev		ca_union1.cau_rdev	
#define	ca_linkref	ca_union1.cau_linkref
#define	ca_blocks	ca_union2.cau_blocks
#define	ca_entries	ca_union2.cau_entries
#define	ca_dircount	ca_union3.cau_dircount
#define	ca_firstlink	ca_union3.cau_firstlink

/*
 * Catalog Node Fork (runtime)
 *
 * NOTE: this is not the same as a struct HFSPlusForkData
 *
 * NOTE: if cf_new_size > cf_size, then a write is in progress and is extending
 * the EOF; the new EOF will be cf_new_size.  Writes and pageouts may validly
 * write up to cf_new_size, but reads should only read up to cf_size.  When
 * an extending write is not in progress, cf_new_size is zero.
 */
struct cat_fork {
	off_t          cf_size;        /* fork's logical size in bytes */
	off_t          cf_new_size;    /* fork's logical size after write completes */
	union {
	    u_int32_t  cfu_clump;      /* fork's clump size in bytes (sys files only) */
	    u_int64_t  cfu_bytesread;  /* bytes read from this fork */
	} cf_union;
	u_int32_t      cf_vblocks;     /* virtual (unalloated) blocks */
	u_int32_t      cf_blocks;      /* total blocks used by this fork */
	struct HFSPlusExtentDescriptor  cf_extents[8];  /* initial set of extents */

	/*
	 * NOTE: If you change this structure, make sure you change you change
	 * hfs_fork_copy.
	 */
};

#define cf_clump	cf_union.cfu_clump
#define cf_bytesread	cf_union.cfu_bytesread

void hfs_fork_copy(struct cat_fork *dst, const struct cat_fork *src,
				   HFSPlusExtentDescriptor *extents);

/*
 * Directory Hint
 * Used to hold state across directory enumerations.
 *
 */
struct directoryhint {
	TAILQ_ENTRY(directoryhint) dh_link; /* chain */
	int     dh_index;                   /* index into directory (zero relative) */
	u_int32_t  dh_threadhint;           /* node hint of a directory's thread record */
	u_int32_t  dh_time;
	struct  cat_desc  dh_desc;          /* entry's descriptor */
};
typedef struct directoryhint directoryhint_t;

/* 
 * HFS_MAXDIRHINTS cannot be larger than 63 without reducing
 * HFS_INDEX_BITS, because given the 6-bit tag, at most 63 different
 * tags can exist.  When HFS_MAXDIRHINTS is larger than 63, the same
 * list may contain dirhints of the same tag, and a staled dirhint may
 * be returned.
 */
#define HFS_MAXDIRHINTS 32
#define HFS_DIRHINT_TTL 45

#define HFS_INDEX_MASK  0x03ffffff
#define HFS_INDEX_BITS  26


/*
 * Catalog Node Entry
 *
 * A cat_entry is used for bulk enumerations (hfs_readdirattr).
 */
struct cat_entry {
	struct cat_desc	ce_desc;
	struct cat_attr	ce_attr;
	off_t		ce_datasize;
	off_t		ce_rsrcsize;
	u_int32_t		ce_datablks;
	u_int32_t		ce_rsrcblks;
};

/*
 * Starting in 10.5, hfs_vnop_readdirattr() only makes one
 * call to cat_getentriesattr(). So we increased MAXCATENTRIES
 * while keeping the total size of the CE LIST buffer <= 8K
 * (which works out to be 60 entries per call).  The 8K limit
 * keeps the memory coming from a kalloc zone instead of
 * valuable/fragment-able kernel map space.
 */
#define MAXCATENTRIES	\
	(1 + (8192 - sizeof (struct cat_entrylist)) / sizeof (struct cat_entry))

/*
 * Catalog Node Entry List
 *
 * A cat_entrylist is a list of Catalog Node Entries.
 */
struct cat_entrylist {
	u_int32_t  maxentries;    /* number of entries requested */
	u_int32_t  realentries;   /* number of valid entries returned */
	u_int32_t  skipentries;   /* number of entries skipped (reserved HFS+ files) */
	struct cat_entry  entry[1];   /* array of entries */
};

#define CE_LIST_SIZE(entries)	\
	sizeof (*ce_list) + (((entries) - 1) * sizeof (struct cat_entry))

struct hfsmount;

/*
 * Catalog FileID/CNID Acquisition / Lookup 
 *
 * Some use-cases require that we find a valid CNID
 * before we may be ready to enter the item into the namespace.
 * In order to resolve this, we support a hashtable attached to
 * the mount that is secured by the catalog lock.  
 * 
 * Finding the next valid CNID is easy if the wraparound bit is
 * not set -- you just pull from the hfsmp next pointer.  
 * If it is set then you must find a free entry in the catalog
 * and also query the hashtable to see if the item is free or not.
 * 
 * If you want to request a CNID before there is a backing item
 * in the catalog, you must find one that is valid, then insert
 * it into the hash table until such time that the item is
 * inserted into the catalog.  After successful catalog insertion,
 * you must remove the item from the hashtable.
 */

typedef struct cat_preflightid {
	cnid_t fileid;
	LIST_ENTRY(cat_preflightid) id_hash;
} cat_preflightid_t;

extern int cat_remove_idhash (cat_preflightid_t *preflight);
extern int cat_insert_idhash (struct hfsmount *hfsmp, cat_preflightid_t *preflight);
extern int cat_check_idhash (struct hfsmount *hfsmp, cnid_t test_fileid);

/* initialize the id look up hashtable during mount */
extern void hfs_idhash_init (struct hfsmount *hfsmp);

/* release the id lookup hashtable during unmount */
extern void hfs_idhash_destroy (struct hfsmount *hfsmp);

/* Get a new CNID for use */
extern int cat_acquire_cnid (struct hfsmount *hfsmp, cnid_t *new_cnid);


/* default size of ID hash is 64 entries */
#define HFS_IDHASH_DEFAULT 64


/*
 * Catalog Operations Hint
 *
 * lower 16 bits: count of B-tree insert operations
 * upper 16 bits: count of B-tree delete operations
 *
 */
#define CAT_DELETE	0x00010000
#define CAT_CREATE	0x00000002
#define CAT_RENAME	0x00010002
#define CAT_EXCHANGE	0x00010002

typedef u_int32_t	catops_t;

/*
 * The size of cat_cookie_t much match the size of
 * the nreserve struct (in BTreeNodeReserve.c).
 */
typedef	struct cat_cookie_t {
#if defined(__LP64__)
	char	opaque[40];
#else
	char	opaque[24];
#endif
} cat_cookie_t;

/* Universal catalog key */
union CatalogKey {
	HFSCatalogKey      hfs;
	HFSPlusCatalogKey  hfsPlus;
};
typedef union CatalogKey  CatalogKey;

/* Universal catalog data record */
union CatalogRecord {
	int16_t               recordType;
	HFSCatalogFolder      hfsFolder;
	HFSCatalogFile        hfsFile;
	HFSCatalogThread      hfsThread;
	HFSPlusCatalogFolder  hfsPlusFolder;
	HFSPlusCatalogFile    hfsPlusFile;
	HFSPlusCatalogThread  hfsPlusThread;
};
typedef union CatalogRecord  CatalogRecord;

/* Constants for HFS fork types */
enum {
	kHFSDataForkType = 0x0, 	/* data fork */
	kHFSResourceForkType = 0xff	/* resource fork */
};

/*
 * Catalog Interface
 *
 * These functions perform a catalog transactions. The
 * catalog b-tree is abstracted through this interface.
 * (please don't go around it)
 */


extern void cat_releasedesc(struct cat_desc *descp);

extern int cat_create (	struct hfsmount *hfsmp,
			cnid_t new_fileid,
			struct cat_desc *descp,
			struct cat_attr *attrp,
			struct cat_desc *out_descp);

extern int cat_delete (	struct hfsmount *hfsmp,
			struct cat_desc *descp,
			struct cat_attr *attrp);

extern int cat_lookup (	struct hfsmount *hfsmp,
			struct cat_desc *descp,
			int wantrsrc,
			int force_casesensitive_lookup,
			struct cat_desc *outdescp,
			struct cat_attr *attrp,
			struct cat_fork *forkp,
    			cnid_t          *desc_cnid);

extern int cat_idlookup (struct hfsmount *hfsmp,
			cnid_t cnid,
			int allow_system_files,
			int wantrsrc,
			struct cat_desc *outdescp,
			struct cat_attr *attrp,
			struct cat_fork *forkp);

extern int cat_findname (struct hfsmount *hfsmp,
                         cnid_t cnid,
                         struct cat_desc *outdescp);

extern int cat_getentriesattr(
			struct hfsmount *hfsmp,
			directoryhint_t *dirhint,
			struct cat_entrylist *ce_list, 
			int *reachedeof);

extern int cat_rename (	struct hfsmount * hfsmp,
			struct cat_desc * from_cdp,
			struct cat_desc * todir_cdp,
			struct cat_desc * to_cdp,
			struct cat_desc * cdp);

extern int cat_update (	struct hfsmount *hfsmp,
			struct cat_desc *descp,
			struct cat_attr *attrp,
			const struct cat_fork *dataforkp,
			const struct cat_fork *rsrcforkp);

extern int cat_getdirentries(
			struct hfsmount *hfsmp,
			u_int32_t entrycnt,
			directoryhint_t *dirhint,
			uio_t uio,
			int extended,
			int * items,
			int * eofflag);

extern int cat_insertfilethread (
			struct hfsmount *hfsmp,
			struct cat_desc *descp);

extern int cat_preflight(
			struct hfsmount *hfsmp,
			catops_t ops,
			cat_cookie_t *cookie,
			struct proc *p);

extern void cat_postflight(
			struct hfsmount *hfsmp,
			cat_cookie_t *cookie,
			struct proc *p);

extern int cat_binarykeycompare(
			HFSPlusCatalogKey *searchKey,
			HFSPlusCatalogKey *trialKey);

extern int CompareCatalogKeys(
			HFSCatalogKey *searchKey,
			HFSCatalogKey *trialKey);

extern int CompareExtendedCatalogKeys(
			HFSPlusCatalogKey *searchKey,
			HFSPlusCatalogKey *trialKey);

extern void cat_convertattr(
			struct hfsmount *hfsmp,
			CatalogRecord * recp,
			struct cat_attr *attrp,
			struct cat_fork *datafp,
			struct cat_fork *rsrcfp);

extern int cat_convertkey(
			struct hfsmount *hfsmp,
			CatalogKey *key,
			CatalogRecord * recp,
			struct cat_desc *descp);

extern int cat_getkeyplusattr(
			struct hfsmount *hfsmp, 
			cnid_t cnid, 
			CatalogKey *key, 
			struct cat_attr *attrp);

/* Hard link functions. */

extern int cat_check_link_ancestry(
			struct hfsmount *hfsmp,
			cnid_t parentid, 
			cnid_t pointed_at_cnid);

extern int cat_set_childlinkbit(
			struct hfsmount *hfsmp, 
			cnid_t cnid);

#define HFS_IGNORABLE_LINK  0x00000001

extern int cat_resolvelink( struct hfsmount *hfsmp,
                            u_int32_t linkref,
                            int isdirlink,
                            struct HFSPlusCatalogFile *recp);

extern int cat_createlink( struct hfsmount *hfsmp,
                           struct cat_desc *descp,
                           struct cat_attr *attr,
                           cnid_t nextlinkid,
                           cnid_t *linkfileid);

/* Finder Info's file type and creator for directory hard link alias */
enum {
	kHFSAliasType    = 0x66647270,  /* 'fdrp' */
	kHFSAliasCreator = 0x4D414353   /* 'MACS' */
};

extern int cat_deletelink( struct hfsmount *hfsmp,
                           struct cat_desc *descp);

extern int cat_update_siblinglinks( struct hfsmount *hfsmp,
                           cnid_t linkfileid,
                           cnid_t prevlinkid,
                           cnid_t nextlinkid);

extern int cat_lookuplink( struct hfsmount *hfsmp,
                           struct cat_desc *descp,
                           cnid_t *linkfileid,
                           cnid_t *prevlinkid,
                           cnid_t *nextlinkid);

extern int cat_lookup_siblinglinks( struct hfsmount *hfsmp,
                               cnid_t linkfileid,
                               cnid_t *prevlinkid,
                               cnid_t *nextlinkid);

extern int cat_lookup_lastlink( struct hfsmount *hfsmp,
                               cnid_t startid,
                               cnid_t *nextlinkid,
							   struct cat_desc *cdesc);

extern int cat_lookup_dirlink(struct hfsmount *hfsmp, 
			     cnid_t dirlink_id, 
			     u_int8_t forktype, 
			     struct cat_desc *outdescp, 
			     struct cat_attr *attrp, 
			     struct cat_fork *forkp);

extern int cat_update_dirlink(struct hfsmount *hfsmp, 
			      u_int8_t forktype, 
			      struct cat_desc *descp, 
			      struct cat_attr *attrp, 
			      struct cat_fork *rsrcforkp);

#endif /* __APPLE_API_PRIVATE */
#endif /* KERNEL */
#endif /* __HFS_CATALOG__ */
Commit	Line	Data
9bccf70c	1	/*
3e170ce0	2	* Copyright (c) 2002-2014 Apple Inc. All rights reserved.
9bccf70c	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
9bccf70c	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@
9bccf70c A	27	*/
	28	#ifndef __HFS_CATALOG__
	29	#define __HFS_CATALOG__
	30
	31	#include <sys/appleapiopts.h>
	32
	33	#ifdef KERNEL
	34	#ifdef __APPLE_API_PRIVATE
9bccf70c	35	#include <sys/vnode.h>
9bccf70c A	36
	37	#include <hfs/hfs_format.h>
	38
	39	/* HFS Catalog */
	40
	41
	42	/*
	43	* Catalog ADTs
	44	*
	45	* The cat_desc, cat_attr, and cat_fork structures are
	46	* use to import/export data to/from the Catalog file.
	47	* The fields in these structures are always in BSD
	48	* runtime format (e.g. dates and names).
	49	*/
	50
	51	typedef u_int32_t cnid_t;
	52
	53	/*
	54	* Catalog Node Descriptor (runtime)
	55	*/
	56	struct cat_desc {
	57	u_int8_t cd_flags; /* see below (8 bits) */
	58	u_int8_t cd_encoding; /* name encoding */
	59	int16_t cd_namelen; /* length of cnode name */
9bccf70c	60	cnid_t cd_parentcnid; /* parent directory CNID */
b0d623f7	61	u_int32_t cd_hint; /* catalog file hint */
9bccf70c	62	cnid_t cd_cnid; /* cnode id (for getattrlist) */
b0d623f7	63	const u_int8_t * cd_nameptr; /* pointer to cnode name */
9bccf70c A	64	};
9bccf70c A	65
6d2010ae	66	/* cd_flags
7e4a7d39 A	67	*
	68	* CD_EOF is used by hfs_vnop_readdir / cat_getdirentries to indicate EOF was
	69	* encountered during a directory enumeration. When this flag is observed
	70	* on the next call to hfs_vnop_readdir it tells the caller that there's no
	71	* need to descend into the catalog as EOF was encountered during the last call.
	72	* This flag should only be set on the descriptor embedded in the directoryhint.
	73	*/
	74
9bccf70c A	75	#define CD_HASBUF 0x01 /* allocated filename buffer */
9bccf70c A	76	#define CD_DECOMPOSED 0x02 /* name is fully decomposed */
7e4a7d39	77	#define CD_EOF 0x04 /* see above */
55e303ae	78	#define CD_ISMETA 0x40 /* describes a metadata file */
9bccf70c A	79	#define CD_ISDIR 0x80 /* describes a directory */
	80
	81	/*
	82	* Catalog Node Attributes (runtime)
	83	*/
	84	struct cat_attr {
	85	cnid_t ca_fileid; /* inode number (for stat) normally == cnid */
	86	mode_t ca_mode; /* file access mode and type (16 bits) */
91447636	87	u_int16_t ca_recflags; /* catalog record flags (16 bit integer) */
2d21ac55	88	u_int32_t ca_linkcount; /* real hard link count */
9bccf70c A	89	uid_t ca_uid; /* file owner */
9bccf70c A	90	gid_t ca_gid; /* file group */
2d21ac55 A	91	union {
	92	dev_t cau_rdev; /* special file device (VBLK or VCHAR only) */
	93	u_int32_t cau_linkref; /* hardlink reference number */
	94	} ca_union1;
9bccf70c	95	time_t ca_atime; /* last access time */
91447636	96	time_t ca_atimeondisk; /* access time value on disk */
9bccf70c	97	time_t ca_mtime; /* last data modification time */
9bccf70c A	98	time_t ca_ctime; /* last file status change */
	99	time_t ca_itime; /* file initialization time */
	100	time_t ca_btime; /* last backup time */
91447636	101	u_int32_t ca_flags; /* status flags (chflags) */
9bccf70c	102	union {
2d21ac55 A	103	u_int32_t cau_blocks; /* total file blocks used (rsrc + data) */
	104	u_int32_t cau_entries; /* total directory entries (valence) */
	105	} ca_union2;
	106	union {
	107	u_int32_t cau_dircount; /* count of sub dirs (for posix nlink) */
	108	u_int32_t cau_firstlink; /* first hardlink link (files only) */
	109	} ca_union3;
fe8ab488 A	110	union {
	111	u_int8_t ca_finderinfo[32]; /* Opaque Finder information */
	112	struct {
	113	FndrFileInfo ca_finderfileinfo;
	114	struct FndrExtendedFileInfo ca_finderextendedfileinfo;
	115	};
	116	struct {
	117	FndrDirInfo ca_finderdirinfo;
	118	struct FndrExtendedDirInfo ca_finderextendeddirinfo;
	119	};
	120	};
9bccf70c	121	};
2d21ac55	122
9bccf70c	123	/* Aliases for common fields */
2d21ac55 A	124	#define ca_rdev ca_union1.cau_rdev
	125	#define ca_linkref ca_union1.cau_linkref
	126	#define ca_blocks ca_union2.cau_blocks
	127	#define ca_entries ca_union2.cau_entries
	128	#define ca_dircount ca_union3.cau_dircount
	129	#define ca_firstlink ca_union3.cau_firstlink
9bccf70c A	130
9bccf70c A	131	/*
55e303ae A	132	* Catalog Node Fork (runtime)
	133	*
	134	* NOTE: this is not the same as a struct HFSPlusForkData
593a1d5f A	135	*
	136	* NOTE: if cf_new_size > cf_size, then a write is in progress and is extending
	137	* the EOF; the new EOF will be cf_new_size. Writes and pageouts may validly
	138	* write up to cf_new_size, but reads should only read up to cf_size. When
	139	* an extending write is not in progress, cf_new_size is zero.
9bccf70c A	140	*/
9bccf70c A	141	struct cat_fork {
2d21ac55	142	off_t cf_size; /* fork's logical size in bytes */
593a1d5f	143	off_t cf_new_size; /* fork's logical size after write completes */
55e303ae A	144	union {
	145	u_int32_t cfu_clump; /* fork's clump size in bytes (sys files only) */
	146	u_int64_t cfu_bytesread; /* bytes read from this fork */
	147	} cf_union;
	148	u_int32_t cf_vblocks; /* virtual (unalloated) blocks */
	149	u_int32_t cf_blocks; /* total blocks used by this fork */
	150	struct HFSPlusExtentDescriptor cf_extents[8]; /* initial set of extents */
3e170ce0 A	151
	152	/*
	153	* NOTE: If you change this structure, make sure you change you change
	154	* hfs_fork_copy.
	155	*/
9bccf70c A	156	};
9bccf70c A	157
55e303ae A	158	#define cf_clump cf_union.cfu_clump
	159	#define cf_bytesread cf_union.cfu_bytesread
	160
3e170ce0 A	161	void hfs_fork_copy(struct cat_fork dst, const struct cat_fork src,
3e170ce0 A	162	HFSPlusExtentDescriptor *extents);
9bccf70c	163
91447636 A	164	/*
	165	* Directory Hint
	166	* Used to hold state across directory enumerations.
	167	*
	168	*/
	169	struct directoryhint {
b36670ce	170	TAILQ_ENTRY(directoryhint) dh_link; /* chain */
91447636	171	int dh_index; /* index into directory (zero relative) */
2d21ac55	172	u_int32_t dh_threadhint; /* node hint of a directory's thread record */
91447636 A	173	u_int32_t dh_time;
	174	struct cat_desc dh_desc; /* entry's descriptor */
	175	};
	176	typedef struct directoryhint directoryhint_t;
	177
b36670ce A	178	/*
	179	* HFS_MAXDIRHINTS cannot be larger than 63 without reducing
	180	* HFS_INDEX_BITS, because given the 6-bit tag, at most 63 different
	181	* tags can exist. When HFS_MAXDIRHINTS is larger than 63, the same
	182	* list may contain dirhints of the same tag, and a staled dirhint may
	183	* be returned.
	184	*/
91447636 A	185	#define HFS_MAXDIRHINTS 32
	186	#define HFS_DIRHINT_TTL 45
	187
	188	#define HFS_INDEX_MASK 0x03ffffff
	189	#define HFS_INDEX_BITS 26
	190
	191
9bccf70c A	192	/*
	193	* Catalog Node Entry
	194	*
	195	* A cat_entry is used for bulk enumerations (hfs_readdirattr).
	196	*/
	197	struct cat_entry {
	198	struct cat_desc ce_desc;
	199	struct cat_attr ce_attr;
	200	off_t ce_datasize;
	201	off_t ce_rsrcsize;
b0d623f7 A	202	u_int32_t ce_datablks;
b0d623f7 A	203	u_int32_t ce_rsrcblks;
9bccf70c A	204	};
9bccf70c A	205
2d21ac55 A	206	/*
	207	* Starting in 10.5, hfs_vnop_readdirattr() only makes one
	208	* call to cat_getentriesattr(). So we increased MAXCATENTRIES
	209	* while keeping the total size of the CE LIST buffer <= 8K
	210	* (which works out to be 60 entries per call). The 8K limit
	211	* keeps the memory coming from a kalloc zone instead of
	212	* valuable/fragment-able kernel map space.
	213	*/
	214	#define MAXCATENTRIES \
	215	(1 + (8192 - sizeof (struct cat_entrylist)) / sizeof (struct cat_entry))
	216
9bccf70c A	217	/*
	218	* Catalog Node Entry List
	219	*
	220	* A cat_entrylist is a list of Catalog Node Entries.
	221	*/
	222	struct cat_entrylist {
b0d623f7 A	223	u_int32_t maxentries; /* number of entries requested */
	224	u_int32_t realentries; /* number of valid entries returned */
	225	u_int32_t skipentries; /* number of entries skipped (reserved HFS+ files) */
2d21ac55	226	struct cat_entry entry[1]; /* array of entries */
9bccf70c A	227	};
9bccf70c A	228
2d21ac55 A	229	#define CE_LIST_SIZE(entries) \
	230	sizeof (ce_list) + (((entries) - 1) sizeof (struct cat_entry))
	231
39236c6e A	232	struct hfsmount;
	233
	234	/*
	235	* Catalog FileID/CNID Acquisition / Lookup
	236	*
	237	* Some use-cases require that we find a valid CNID
	238	* before we may be ready to enter the item into the namespace.
	239	* In order to resolve this, we support a hashtable attached to
	240	* the mount that is secured by the catalog lock.
	241	*
	242	* Finding the next valid CNID is easy if the wraparound bit is
	243	* not set -- you just pull from the hfsmp next pointer.
	244	* If it is set then you must find a free entry in the catalog
	245	* and also query the hashtable to see if the item is free or not.
	246	*
	247	* If you want to request a CNID before there is a backing item
	248	* in the catalog, you must find one that is valid, then insert
	249	* it into the hash table until such time that the item is
	250	* inserted into the catalog. After successful catalog insertion,
	251	* you must remove the item from the hashtable.
	252	*/
	253
	254	typedef struct cat_preflightid {
	255	cnid_t fileid;
	256	LIST_ENTRY(cat_preflightid) id_hash;
	257	} cat_preflightid_t;
	258
	259	extern int cat_remove_idhash (cat_preflightid_t *preflight);
	260	extern int cat_insert_idhash (struct hfsmount hfsmp, cat_preflightid_t preflight);
	261	extern int cat_check_idhash (struct hfsmount *hfsmp, cnid_t test_fileid);
	262
	263	/* initialize the id look up hashtable during mount */
	264	extern void hfs_idhash_init (struct hfsmount *hfsmp);
	265
	266	/* release the id lookup hashtable during unmount */
	267	extern void hfs_idhash_destroy (struct hfsmount *hfsmp);
	268
	269	/* Get a new CNID for use */
	270	extern int cat_acquire_cnid (struct hfsmount hfsmp, cnid_t new_cnid);
	271
	272
	273	/* default size of ID hash is 64 entries */
	274	#define HFS_IDHASH_DEFAULT 64
	275
2d21ac55	276
55e303ae A	277	/*
	278	* Catalog Operations Hint
	279	*
	280	* lower 16 bits: count of B-tree insert operations
	281	* upper 16 bits: count of B-tree delete operations
	282	*
	283	*/
2d21ac55	284	#define CAT_DELETE 0x00010000
55e303ae	285	#define CAT_CREATE 0x00000002
2d21ac55 A	286	#define CAT_RENAME 0x00010002
2d21ac55 A	287	#define CAT_EXCHANGE 0x00010002
55e303ae A	288
	289	typedef u_int32_t catops_t;
	290
	291	/*
	292	* The size of cat_cookie_t much match the size of
	293	* the nreserve struct (in BTreeNodeReserve.c).
	294	*/
	295	typedef struct cat_cookie_t {
b0d623f7 A	296	#if defined(__LP64__)
	297	char opaque[40];
	298	#else
55e303ae	299	char opaque[24];
b0d623f7	300	#endif
55e303ae A	301	} cat_cookie_t;
55e303ae A	302
91447636 A	303	/* Universal catalog key */
	304	union CatalogKey {
	305	HFSCatalogKey hfs;
	306	HFSPlusCatalogKey hfsPlus;
	307	};
	308	typedef union CatalogKey CatalogKey;
	309
	310	/* Universal catalog data record */
	311	union CatalogRecord {
	312	int16_t recordType;
	313	HFSCatalogFolder hfsFolder;
	314	HFSCatalogFile hfsFile;
	315	HFSCatalogThread hfsThread;
	316	HFSPlusCatalogFolder hfsPlusFolder;
	317	HFSPlusCatalogFile hfsPlusFile;
	318	HFSPlusCatalogThread hfsPlusThread;
	319	};
	320	typedef union CatalogRecord CatalogRecord;
	321
6d2010ae A	322	/* Constants for HFS fork types */
	323	enum {
	324	kHFSDataForkType = 0x0, /* data fork */
	325	kHFSResourceForkType = 0xff /* resource fork */
	326	};
91447636	327
9bccf70c A	328	/*
	329	* Catalog Interface
	330	*
	331	* These functions perform a catalog transactions. The
	332	* catalog b-tree is abstracted through this interface.
	333	* (please don't go around it)
	334	*/
	335
9bccf70c A	336
	337	extern void cat_releasedesc(struct cat_desc *descp);
	338
	339	extern int cat_create ( struct hfsmount *hfsmp,
39236c6e	340	cnid_t new_fileid,
9bccf70c A	341	struct cat_desc *descp,
	342	struct cat_attr *attrp,
	343	struct cat_desc *out_descp);
	344
	345	extern int cat_delete ( struct hfsmount *hfsmp,
	346	struct cat_desc *descp,
	347	struct cat_attr *attrp);
	348
	349	extern int cat_lookup ( struct hfsmount *hfsmp,
	350	struct cat_desc *descp,
	351	int wantrsrc,
39236c6e	352	int force_casesensitive_lookup,
9bccf70c A	353	struct cat_desc *outdescp,
9bccf70c A	354	struct cat_attr *attrp,
91447636 A	355	struct cat_fork *forkp,
91447636 A	356	cnid_t *desc_cnid);
9bccf70c A	357
	358	extern int cat_idlookup (struct hfsmount *hfsmp,
	359	cnid_t cnid,
2d21ac55	360	int allow_system_files,
db609669	361	int wantrsrc,
9bccf70c A	362	struct cat_desc *outdescp,
	363	struct cat_attr *attrp,
	364	struct cat_fork *forkp);
	365
91447636 A	366	extern int cat_findname (struct hfsmount *hfsmp,
	367	cnid_t cnid,
	368	struct cat_desc *outdescp);
	369
9bccf70c A	370	extern int cat_getentriesattr(
9bccf70c A	371	struct hfsmount *hfsmp,
91447636	372	directoryhint_t *dirhint,
fe8ab488 A	373	struct cat_entrylist *ce_list,
fe8ab488 A	374	int *reachedeof);
9bccf70c A	375
	376	extern int cat_rename ( struct hfsmount * hfsmp,
	377	struct cat_desc * from_cdp,
	378	struct cat_desc * todir_cdp,
	379	struct cat_desc * to_cdp,
	380	struct cat_desc * cdp);
	381
	382	extern int cat_update ( struct hfsmount *hfsmp,
	383	struct cat_desc *descp,
	384	struct cat_attr *attrp,
fe8ab488 A	385	const struct cat_fork *dataforkp,
fe8ab488 A	386	const struct cat_fork *rsrcforkp);
9bccf70c A	387
	388	extern int cat_getdirentries(
	389	struct hfsmount *hfsmp,
316670eb	390	u_int32_t entrycnt,
91447636 A	391	directoryhint_t *dirhint,
	392	uio_t uio,
	393	int extended,
3a60a9f5 A	394	int * items,
3a60a9f5 A	395	int * eofflag);
9bccf70c A	396
	397	extern int cat_insertfilethread (
	398	struct hfsmount *hfsmp,
	399	struct cat_desc *descp);
	400
55e303ae A	401	extern int cat_preflight(
	402	struct hfsmount *hfsmp,
	403	catops_t ops,
	404	cat_cookie_t *cookie,
	405	struct proc *p);
	406
	407	extern void cat_postflight(
	408	struct hfsmount *hfsmp,
	409	cat_cookie_t *cookie,
	410	struct proc *p);
	411
	412	extern int cat_binarykeycompare(
	413	HFSPlusCatalogKey *searchKey,
	414	HFSPlusCatalogKey *trialKey);
	415
91447636 A	416	extern int CompareCatalogKeys(
	417	HFSCatalogKey *searchKey,
	418	HFSCatalogKey *trialKey);
	419
	420	extern int CompareExtendedCatalogKeys(
	421	HFSPlusCatalogKey *searchKey,
	422	HFSPlusCatalogKey *trialKey);
	423
	424	extern void cat_convertattr(
	425	struct hfsmount *hfsmp,
	426	CatalogRecord * recp,
	427	struct cat_attr *attrp,
	428	struct cat_fork *datafp,
	429	struct cat_fork *rsrcfp);
	430
	431	extern int cat_convertkey(
	432	struct hfsmount *hfsmp,
	433	CatalogKey *key,
	434	CatalogRecord * recp,
	435	struct cat_desc *descp);
	436
91447636 A	437	extern int cat_getkeyplusattr(
	438	struct hfsmount *hfsmp,
	439	cnid_t cnid,
	440	CatalogKey *key,
	441	struct cat_attr *attrp);
	442
2d21ac55 A	443	/* Hard link functions. */
	444
	445	extern int cat_check_link_ancestry(
	446	struct hfsmount *hfsmp,
	447	cnid_t parentid,
	448	cnid_t pointed_at_cnid);
	449
	450	extern int cat_set_childlinkbit(
	451	struct hfsmount *hfsmp,
	452	cnid_t cnid);
	453
	454	#define HFS_IGNORABLE_LINK 0x00000001
	455
	456	extern int cat_resolvelink( struct hfsmount *hfsmp,
b0d623f7	457	u_int32_t linkref,
2d21ac55 A	458	int isdirlink,
	459	struct HFSPlusCatalogFile *recp);
	460
	461	extern int cat_createlink( struct hfsmount *hfsmp,
	462	struct cat_desc *descp,
	463	struct cat_attr *attr,
	464	cnid_t nextlinkid,
	465	cnid_t *linkfileid);
	466
	467	/* Finder Info's file type and creator for directory hard link alias */
	468	enum {
	469	kHFSAliasType = 0x66647270, /* 'fdrp' */
	470	kHFSAliasCreator = 0x4D414353 /* 'MACS' */
	471	};
	472
	473	extern int cat_deletelink( struct hfsmount *hfsmp,
	474	struct cat_desc *descp);
	475
6d2010ae	476	extern int cat_update_siblinglinks( struct hfsmount *hfsmp,
2d21ac55 A	477	cnid_t linkfileid,
	478	cnid_t prevlinkid,
	479	cnid_t nextlinkid);
	480
	481	extern int cat_lookuplink( struct hfsmount *hfsmp,
	482	struct cat_desc *descp,
	483	cnid_t *linkfileid,
	484	cnid_t *prevlinkid,
	485	cnid_t *nextlinkid);
	486
6d2010ae	487	extern int cat_lookup_siblinglinks( struct hfsmount *hfsmp,
2d21ac55 A	488	cnid_t linkfileid,
	489	cnid_t *prevlinkid,
	490	cnid_t *nextlinkid);
	491
39236c6e A	492	extern int cat_lookup_lastlink( struct hfsmount *hfsmp,
	493	cnid_t startid,
	494	cnid_t *nextlinkid,
	495	struct cat_desc *cdesc);
	496
6d2010ae A	497	extern int cat_lookup_dirlink(struct hfsmount *hfsmp,
	498	cnid_t dirlink_id,
	499	u_int8_t forktype,
	500	struct cat_desc *outdescp,
	501	struct cat_attr *attrp,
	502	struct cat_fork *forkp);
	503
	504	extern int cat_update_dirlink(struct hfsmount *hfsmp,
	505	u_int8_t forktype,
	506	struct cat_desc *descp,
	507	struct cat_attr *attrp,
	508	struct cat_fork *rsrcforkp);
2d21ac55	509
9bccf70c A	510	#endif /* __APPLE_API_PRIVATE */
	511	#endif /* KERNEL */
	512	#endif /* __HFS_CATALOG__ */