/* * Copyright (c) 2002-2013 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 #ifdef KERNEL #ifdef __APPLE_API_PRIVATE #include #include /* 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 */ }; #define cf_clump cf_union.cfu_clump #define cf_bytesread cf_union.cfu_bytesread /* * 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__ */