]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/hfs/hfs.h
xnu-1699.22.73.tar.gz
[apple/xnu.git] / bsd / hfs / hfs.h
index 76b23b70ffae2d83ff307461e920e2a3f4543263..114fcecc71159a77083557256610ad51c2e050f9 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2010 Apple Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
 #ifndef __HFS__
 #define __HFS__
 
+/* If set to 1, enables the code to allocate blocks from the start 
+ * of the disk instead of the nextAllocation for sparse devices like 
+ * sparse disk images or sparsebundle images.  The free extent cache 
+ * for such volumes is also maintained based on the start block instead 
+ * of number of contiguous allocation blocks.  These devices prefer 
+ * allocation of blocks near the start of the disk to avoid the 
+ * increasing the image size, but it can also result in file fragmentation. 
+ */
 #define HFS_SPARSE_DEV 1
 
+#if DEBUG
+#define HFS_CHECK_LOCK_ORDER 1
+#endif
+
 #include <sys/appleapiopts.h>
 
 #ifdef KERNEL
@@ -42,6 +54,8 @@
 #include <sys/quota.h>
 #include <sys/dirent.h>
 #include <sys/event.h>
+#include <sys/disk.h>
+#include <kern/thread_call.h>
 
 #include <kern/locks.h>
 
 #include <hfs/hfs_encodings.h>
 #include <hfs/hfs_hotfiles.h>
 
+#if CONFIG_HFS_ALLOC_RBTREE
+#include <hfs/hfscommon/headers/HybridAllocator.h>
+#endif
+
 /*
  *     Just reported via MIG interface.
  */
@@ -63,9 +81,9 @@
 
 #define HFS_MAX_DEFERED_ALLOC  (1024*1024)
 
-// 400 mb is a "big" file (i.e. one that when deleted
+// 400 megs is a "big" file (i.e. one that when deleted
 // would touch enough data that we should break it into
-// multiple separate transactions
+// multiple separate transactions)
 #define HFS_BIGFILE_SIZE (400LL * 1024LL * 1024LL)
 
 
@@ -80,15 +98,6 @@ enum { kMDBOffset = kMasterDirectoryBlock * 512 };   /* MDB offset on disk in byte
 /* number of locked buffer caches to hold for b-tree meta data */
 #define kMaxLockedMetaBuffers          32              
 
-/*
- *     File type and creator for symbolic links
- */
-enum {
-       kSymLinkFileType  = 0x736C6E6B, /* 'slnk' */
-       kSymLinkCreator   = 0x72686170  /* 'rhap' */
-};
-
-
 extern struct timezone gTimeZone;
 
 
@@ -112,33 +121,32 @@ extern struct timezone gTimeZone;
  * volume size, all capped at a certain fixed level
  */
  
-#define HFS_ROOTLOWDISKTRIGGERFRACTION 5
-#define HFS_ROOTLOWDISKTRIGGERLEVEL ((u_int64_t)(250*1024*1024))
-#define HFS_ROOTLOWDISKSHUTOFFFRACTION 6
-#define HFS_ROOTLOWDISKSHUTOFFLEVEL ((u_int64_t)(375*1024*1024))
-
-#define HFS_LOWDISKTRIGGERFRACTION 1
-#define HFS_LOWDISKTRIGGERLEVEL ((u_int64_t)(50*1024*1024))
-#define HFS_LOWDISKSHUTOFFFRACTION 2
-#define HFS_LOWDISKSHUTOFFLEVEL ((u_int64_t)(75*1024*1024))
+#define HFS_ROOTVERYLOWDISKTRIGGERFRACTION 5
+#define HFS_ROOTVERYLOWDISKTRIGGERLEVEL ((u_int64_t)(512*1024*1024))
+#define HFS_ROOTLOWDISKTRIGGERFRACTION 10
+#define HFS_ROOTLOWDISKTRIGGERLEVEL ((u_int64_t)(1024*1024*1024))
+#define HFS_ROOTLOWDISKSHUTOFFFRACTION 11
+#define HFS_ROOTLOWDISKSHUTOFFLEVEL ((u_int64_t)(1024*1024*1024 + 250*1024*1024))
+
+#define HFS_VERYLOWDISKTRIGGERFRACTION 1
+#define HFS_VERYLOWDISKTRIGGERLEVEL ((u_int64_t)(100*1024*1024))
+#define HFS_LOWDISKTRIGGERFRACTION 2
+#define HFS_LOWDISKTRIGGERLEVEL ((u_int64_t)(150*1024*1024))
+#define HFS_LOWDISKSHUTOFFFRACTION 3
+#define HFS_LOWDISKSHUTOFFLEVEL ((u_int64_t)(200*1024*1024))
 
 /* Internal Data structures*/
 
-
-#define kHFS_DamagedVolume  0x1        /* This volume has errors, unmount dirty */
-
-/* XXX */
-#define MARK_VOLUMEDAMAGED(fcb) 
-
-
 /* This structure describes the HFS specific mount structure data. */
 typedef struct hfsmount {
        u_int32_t     hfs_flags;              /* see below */
 
        /* Physical Description */
-       u_long        hfs_phys_block_size;    /* Always a multiple of 512 */
-       daddr64_t     hfs_phys_block_count;   /* Num of PHYSICAL blocks of volume */
-       daddr64_t     hfs_alt_id_sector;      /* location of alternate VH/MDB */
+       u_int32_t     hfs_logical_block_size;   /* Logical block size of the disk as reported by ioctl(DKIOCGETBLOCKSIZE), always a multiple of 512 */
+       daddr64_t     hfs_logical_block_count;  /* Number of logical blocks on the disk */
+       daddr64_t     hfs_alt_id_sector;        /* location of alternate VH/MDB */
+       u_int32_t     hfs_physical_block_size;  /* Physical block size of the disk as reported by ioctl(DKIOCGETPHYSICALBLOCKSIZE) */ 
+       u_int32_t     hfs_log_per_phys;         /* Number of logical blocks per physical block size */
 
        /* Access to VFS and devices */
        struct mount            *hfs_mp;                                /* filesystem vfs structure */
@@ -147,6 +155,13 @@ typedef struct hfsmount {
        struct vnode *          hfs_catalog_vp;
        struct vnode *          hfs_allocation_vp;
        struct vnode *          hfs_attribute_vp;
+       struct vnode *          hfs_startup_vp;
+       struct vnode *          hfs_attrdata_vp;   /* pseudo file */
+       struct cnode *          hfs_extents_cp;
+       struct cnode *          hfs_catalog_cp;
+       struct cnode *          hfs_allocation_cp;
+       struct cnode *          hfs_attribute_cp;
+       struct cnode *          hfs_startup_cp;
        dev_t                   hfs_raw_dev;                    /* device mounted */
        u_int32_t               hfs_logBlockSize;               /* Size of buffer cache buffer for I/O */
        
@@ -155,7 +170,7 @@ typedef struct hfsmount {
        gid_t         hfs_gid;            /* gid to set as owner of the files */
        mode_t        hfs_dir_mask;       /* mask to and with directory protection bits */
        mode_t        hfs_file_mask;      /* mask to and with file protection bits */
-       u_long        hfs_encoding;       /* Defualt encoding for non hfs+ volumes */   
+       u_int32_t        hfs_encoding;       /* Default encoding for non hfs+ volumes */        
 
        /* Persistent fields (on disk, dynamic) */
        time_t        hfs_mtime;          /* file system last modification time */
@@ -163,7 +178,8 @@ typedef struct hfsmount {
        u_int32_t     hfs_dircount;       /* number of directories in file system */
        u_int32_t     freeBlocks;         /* free allocation blocks */
        u_int32_t     nextAllocation;     /* start of next allocation search */
-       u_int32_t     vcbNxtCNID;         /* next unused catalog node ID */
+       u_int32_t     sparseAllocation;   /* start of allocations for sparse devices */
+       u_int32_t     vcbNxtCNID;         /* next unused catalog node ID - protected by catalog lock */
        u_int32_t     vcbWrCnt;           /* file system write count */
        u_int64_t     encodingsBitmap;    /* in-use encodings */
        u_int16_t     vcbNmFls;           /* HFS Only - root dir file count */
@@ -171,13 +187,22 @@ typedef struct hfsmount {
 
        /* Persistent fields (on disk, static) */
        u_int16_t                       vcbSigWord;
-       int16_t                         vcbFlags;
+       int16_t                         vcbFlags; /* Runtime flag to indicate if volume is dirty/clean */
        u_int32_t                       vcbAtrb;
        u_int32_t                       vcbJinfoBlock;
-       time_t        hfs_itime;   /* file system creation time */
-       time_t        hfs_btime;   /* file system last backup time */
+       u_int32_t                       localCreateDate;/* volume create time from volume header (For HFS+, value is in local time) */
+       time_t                          hfs_itime;      /* file system creation time (creation date of the root folder) */
+       time_t                          hfs_btime;      /* file system last backup time */
        u_int32_t                       blockSize;      /* size of allocation blocks */
        u_int32_t                       totalBlocks;    /* total allocation blocks */
+       u_int32_t                       allocLimit;     /* Do not allocate this block or beyond */
+       /*
+        * NOTE: When resizing a volume to make it smaller, allocLimit is set to the allocation
+        * block number which will contain the new alternate volume header.  At all other times,
+        * allocLimit is set to totalBlocks.  The allocation code uses allocLimit instead of
+        * totalBlocks to limit which blocks may be allocated, so that during a resize, we don't
+        * put new content into the blocks we're trying to truncate away.
+        */
        int32_t                         vcbClpSiz;
        u_int32_t     vcbFndrInfo[8];
        int16_t                         vcbVBMSt;               /* HFS only */
@@ -192,13 +217,42 @@ typedef struct hfsmount {
        /* cache of largest known free extents */
        u_int32_t                       vcbFreeExtCnt;
        HFSPlusExtentDescriptor vcbFreeExt[kMaxFreeExtents];
+       lck_spin_t                      vcbFreeExtLock;
+       
+#if CONFIG_HFS_ALLOC_RBTREE
+       /*
+        * Access to these fields should only be done 
+        * after acquiring the bitmap lock.  Note that the
+        * "offset_block_end" field indicates the portion of 
+        * the bitmap that is currently managed by the red-black tree.
+        */
        
+       /* Normal Allocation Tree */
+       extent_tree_offset_t offset_tree;
+       u_int32_t                       offset_free_extents;  /* number of free extents managed by tree */
+       u_int32_t                       offset_block_end;
+#endif
+       
+       /* 
+        * For setting persistent in-mount fields that relate
+        * to the use of the extent trees.  See HFS Red-Black 
+        * Tree Allocator Flags below.
+        */
+       u_int32_t extent_tree_flags;
+
+
        u_int32_t               reserveBlocks;          /* free block reserve */
        u_int32_t               loanedBlocks;           /* blocks on loan for delayed allocations */
        
-       u_int32_t                       localCreateDate;        /* creation times for HFS+ volumes are in local time */
-       struct cat_desc         hfs_privdir_desc;
-       struct cat_attr         hfs_privdir_attr;
+
+       /*
+        * HFS+ Private system directories (two). Any access
+        * (besides looking at the cd_cnid) requires holding
+        * the Catalog File lock.
+        */
+       struct cat_desc     hfs_private_desc[2];
+       struct cat_attr     hfs_private_attr[2];
+
        u_int32_t               hfs_metadata_createdate;
        hfs_to_unicode_func_t   hfs_get_unicode;
        unicode_to_hfs_func_t   hfs_get_hfsname;
@@ -213,11 +267,13 @@ typedef struct hfsmount {
        u_int32_t            jnl_size;
        u_int32_t            hfs_jnlfileid;
        u_int32_t            hfs_jnlinfoblkid;
-       lck_rw_t             hfs_global_lock;
+       lck_rw_t                hfs_global_lock;
        u_int32_t            hfs_global_lock_nesting;
+       void*                           hfs_global_lockowner;
        
        /* Notification variables: */
-       unsigned long           hfs_notification_conditions;
+       u_int32_t               hfs_notification_conditions;
+       u_int32_t               hfs_freespace_notify_dangerlimit;
        u_int32_t               hfs_freespace_notify_warninglimit;
        u_int32_t               hfs_freespace_notify_desiredlevel;
 
@@ -230,6 +286,8 @@ typedef struct hfsmount {
        u_int32_t       hfs_metazone_end;
        u_int32_t       hfs_hotfile_start;
        u_int32_t       hfs_hotfile_end;
+        u_int32_t       hfs_min_alloc_start;
+       u_int32_t       hfs_freed_block_count;
        int             hfs_hotfile_freeblks;
        int             hfs_hotfile_maxblks;
        int             hfs_overflow_maxblks;
@@ -244,26 +302,63 @@ typedef struct hfsmount {
        int             hfc_maxfiles;   /* maximum files to track */
        struct vnode *  hfc_filevp;
 
-#ifdef HFS_SPARSE_DEV
+#if HFS_SPARSE_DEV
        /* Sparse device variables: */
        struct vnode * hfs_backingfs_rootvp;
+       u_int32_t      hfs_last_backingstatfs;
        int            hfs_sparsebandblks;
+       u_int64_t      hfs_backingfs_maxblocks;
 #endif
        size_t         hfs_max_inline_attrsize;
 
        lck_mtx_t      hfs_mutex;      /* protects access to hfsmount data */
        void          *hfs_freezing_proc;  /* who froze the fs */
+       void          *hfs_downgrading_proc; /* process who's downgrading to rdonly */
        lck_rw_t       hfs_insync;     /* protects sync/freeze interaction */
 
        /* Resize variables: */
-       u_int32_t               hfs_resize_filesmoved;
-       u_int32_t               hfs_resize_totalfiles;
+       u_int32_t               hfs_resize_blocksmoved;
+       u_int32_t               hfs_resize_totalblocks;
+       u_int32_t               hfs_resize_progress;
+
+       /* Per mount cnode hash variables: */
+       lck_mtx_t      hfs_chash_mutex; /* protects access to cnode hash table */
+       u_long         hfs_cnodehash;   /* size of cnode hash table - 1 */
+       LIST_HEAD(cnodehashhead, cnode) *hfs_cnodehashtbl;      /* base of cnode hash */
+                                       
+
+       /*
+        * About the sync counters:
+        * hfs_sync_scheduled  keeps track whether a timer was scheduled but we
+        *                     haven't started processing the callback (i.e. we
+        *                     haven't begun the flush).  This will be non-zero
+        *                     even if the callback has been invoked, before we
+        *                    start the flush.
+        * hfs_sync_incomplete keeps track of the number of callbacks that have
+        *                     not completed yet (including callbacks not yet
+        *                     invoked).  We cannot safely unmount until this
+        *                     drops to zero.
+        *
+        * In both cases, we use counters, not flags, so that we can avoid
+        * taking locks.
+        */
+       int32_t         hfs_sync_scheduled;
+       int32_t         hfs_sync_incomplete;
+       u_int64_t       hfs_last_sync_request_time;
+       u_int64_t       hfs_last_sync_time;
+       u_int32_t       hfs_active_threads;
+       u_int64_t       hfs_max_pending_io;
+                                       
+       thread_call_t   hfs_syncer;           // removeable devices get sync'ed by this guy
+
 } hfsmount_t;
 
+#define HFS_META_DELAY     (100)
+#define HFS_MILLISEC_SCALE (1000*1000)
+
 typedef hfsmount_t  ExtendedVCB;
 
-/* Aliases for legacy field names */
-#define vcbCrDate          hfs_itime
+/* Aliases for legacy (Mac OS 9) field names */
 #define vcbLsMod           hfs_mtime
 #define vcbVolBkUp         hfs_btime
 #define extentsRefNum      hfs_extents_vp
@@ -272,21 +367,89 @@ typedef hfsmount_t  ExtendedVCB;
 #define vcbFilCnt          hfs_filecount
 #define vcbDirCnt          hfs_dircount
 
+/* Inline functions to set/reset vcbFlags.  Upper 8 bits indicate if the volume 
+ * header/VCB is clean/dirty --- if set, volume header is dirty, and 
+ * if clear, volume header is clean.  This value is checked to determine
+ * if the in-memory copy of volume header should be flushed to the disk
+ * or not. 
+ */
+/* Set runtime flag to indicate that volume is dirty */
+static __inline__ void MarkVCBDirty(ExtendedVCB *vcb)
+{ 
+       vcb->vcbFlags |= 0xFF00;
+}
+
+/* Clear runtime flag to indicate that volume is dirty */
+static __inline__ void MarkVCBClean(ExtendedVCB *vcb)
+{
+       vcb->vcbFlags &= 0x00FF;
+}
+
+/* Check runtime flag to determine if the volume is dirty or not */
+static __inline__ Boolean IsVCBDirty(ExtendedVCB *vcb)
+{
+       return (vcb->vcbFlags & 0xFF00 ? true  : false);
+}
+
+/*
+ * There are two private directories in HFS+.
+ *
+ * One contains inodes for files that are hardlinked or open/unlinked.
+ * The other contains inodes for directories that are hardlinked.
+ */
+enum privdirtype {FILE_HARDLINKS, DIR_HARDLINKS};
+
+/* HFS Red-Black Tree Allocator Flags */
+#define HFS_ALLOC_RB_ENABLED           0x000001        /* trees in use */
+#define HFS_ALLOC_RB_ERRORED           0x000002        /* tree hit error; disabled for the mount */
+#define HFS_ALLOC_RB_MZACTIVE          0x000004        /* metazone tree has finished building */
+#define HFS_ALLOC_RB_ACTIVE                    0x000008        /* normalzone tree finished building */
+
+/* HFS Red-Black Unmount Synch. Flags */
+#define HFS_ALLOC_TREEBUILD_INFLIGHT   0x000010
+#define HFS_ALLOC_TEARDOWN_INFLIGHT            0x000020
 
 /* HFS mount point flags */
-#define HFS_READ_ONLY             0x001
-#define HFS_UNKNOWN_PERMS         0x002
-#define HFS_WRITEABLE_MEDIA       0x004
-#define HFS_CLEANED_ORPHANS       0x008
-#define HFS_X                     0x010
-#define HFS_CASE_SENSITIVE        0x020
-#define HFS_STANDARD              0x040
-#define HFS_METADATA_ZONE         0x080
-#define HFS_FRAGMENTED_FREESPACE  0x100
-#define HFS_NEED_JNL_RESET        0x200
-#define HFS_HAS_SPARSE_DEVICE     0x400
-#define HFS_RESIZE_IN_PROGRESS    0x800
+#define HFS_READ_ONLY             0x00001
+#define HFS_UNKNOWN_PERMS         0x00002
+#define HFS_WRITEABLE_MEDIA       0x00004
+#define HFS_CLEANED_ORPHANS       0x00008
+#define HFS_X                     0x00010
+#define HFS_CASE_SENSITIVE        0x00020
+#define HFS_STANDARD              0x00040
+#define HFS_METADATA_ZONE         0x00080
+#define HFS_FRAGMENTED_FREESPACE  0x00100
+#define HFS_NEED_JNL_RESET        0x00200
+#define HFS_HAS_SPARSE_DEVICE     0x00400
+#define HFS_RESIZE_IN_PROGRESS    0x00800
+#define HFS_QUOTAS                0x01000
+#define HFS_CREATING_BTREE        0x02000
+/* When set, do not update nextAllocation in the mount structure */
+#define HFS_SKIP_UPDATE_NEXT_ALLOCATION 0x04000        
+/* When set, the file system supports extent-based extended attributes */
+#define HFS_XATTR_EXTENTS         0x08000      
+#define        HFS_FOLDERCOUNT           0x10000
+/* When set, the file system exists on a virtual device, like disk image */
+#define HFS_VIRTUAL_DEVICE        0x20000
+/* When set, we're in hfs_changefs, so hfs_sync should do nothing. */
+#define HFS_IN_CHANGEFS           0x40000
+/* When set, we are in process of downgrading or have downgraded to read-only, 
+ * so hfs_start_transaction should return EROFS.
+ */
+#define HFS_RDONLY_DOWNGRADE      0x80000
+#define HFS_DID_CONTIG_SCAN      0x100000
+#define HFS_SSD                                         0x400000
+
 
+/* Macro to update next allocation block in the HFS mount structure.  If 
+ * the HFS_SKIP_UPDATE_NEXT_ALLOCATION is set, do not update 
+ * nextAllocation block.
+ */
+#define HFS_UPDATE_NEXT_ALLOCATION(hfsmp, new_nextAllocation)                  \
+       {                                                               \
+               if ((hfsmp->hfs_flags & HFS_SKIP_UPDATE_NEXT_ALLOCATION) == 0)\
+                       hfsmp->nextAllocation = new_nextAllocation;     \
+       }                                                               \
 
 #define HFS_MOUNT_LOCK(hfsmp, metadata)                      \
        {                                                    \
@@ -300,20 +463,40 @@ typedef hfsmount_t  ExtendedVCB;
                        lck_mtx_unlock(&(hfsmp)->hfs_mutex); \
        }                                                    \
 
-#define hfs_global_exclusive_lock_acquire(hfsmp) lck_rw_lock_exclusive(&(hfsmp)->hfs_global_lock)
-#define hfs_global_exclusive_lock_release(hfsmp) lck_rw_done(&(hfsmp)->hfs_global_lock)
-
-
-#define MAXHFSVNODELEN         31
-
+/* Macro for incrementing and decrementing the folder count in a cnode 
+ * attribute only if the HFS_FOLDERCOUNT bit is set in the mount flags 
+ * and kHFSHasFolderCount bit is set in the cnode flags.  Currently these 
+ * bits are only set for case sensitive HFS+ volumes.
+ */
+#define INC_FOLDERCOUNT(hfsmp, cattr)                          \
+       if ((hfsmp->hfs_flags & HFS_FOLDERCOUNT) &&             \
+           (cattr.ca_recflags & kHFSHasFolderCountMask)) {     \
+               cattr.ca_dircount++;                            \
+       }                                                       \
+
+#define DEC_FOLDERCOUNT(hfsmp, cattr)                          \
+       if ((hfsmp->hfs_flags & HFS_FOLDERCOUNT) &&             \
+           (cattr.ca_recflags & kHFSHasFolderCountMask) &&     \
+           (cattr.ca_dircount > 0)) {                          \
+               cattr.ca_dircount--;                            \
+       }                                                       \
 
 typedef struct filefork FCB;
 
+/*
+ * Macros for creating item names for our special/private directories.
+ */
+#define MAKE_INODE_NAME(name, size, linkno) \
+           (void) snprintf((name), size, "%s%d", HFS_INODE_PREFIX, (linkno))
+#define HFS_INODE_PREFIX_LEN   5
 
-#define MAKE_INODE_NAME(name,linkno) \
-           (void) sprintf((name), "%s%d", HFS_INODE_PREFIX, (linkno))
+#define MAKE_DIRINODE_NAME(name, size, linkno) \
+           (void) snprintf((name), size, "%s%d", HFS_DIRINODE_PREFIX, (linkno))
+#define HFS_DIRINODE_PREFIX_LEN   4
 
-#define HFS_INODE_PREFIX_LEN   5
+#define MAKE_DELETED_NAME(NAME, size, FID) \
+           (void) snprintf((NAME), size, "%s%d", HFS_DELETE_PREFIX, (FID))
+#define HFS_DELETE_PREFIX_LEN  4
 
 
 #define HFS_AVERAGE_NAME_SIZE  22
@@ -358,9 +541,6 @@ enum { kHFSPlusMaxFileNameBytes = kHFSPlusMaxFileNameChars * 3 };
 #define FCBTOVCB(FCB)    FCBTOHFS(FCB)
 
 
-#define HFS_KNOTE(vp, hint) KNOTE(&VTOC(vp)->c_knotes, (hint))
-
-
 #define E_NONE 0
 #define kHFSBlockSize 512
 
@@ -373,15 +553,18 @@ enum { kHFSPlusMaxFileNameBytes = kHFSPlusMaxFileNameChars * 3 };
 #define HFS_ALT_SECTOR(blksize, blkcnt)  (((blkcnt) - 1) - (512 / (blksize)))
 #define HFS_ALT_OFFSET(blksize)          ((blksize) > 1024 ? (blksize) - 1024 : 0)
 
+/* Convert the logical sector number to be aligned on physical block size boundary.  
+ * We are assuming the partition is a multiple of physical block size.
+ */
+#define HFS_PHYSBLK_ROUNDDOWN(sector_num, log_per_phys)        ((sector_num / log_per_phys) * log_per_phys)
 
 /*
  * HFS specific fcntl()'s
  */
-#define HFS_BULKACCESS      (FCNTL_FS_SPECIFIC_BASE + 0x00001)
-#define HFS_GET_MOUNT_TIME  (FCNTL_FS_SPECIFIC_BASE + 0x00002)
-#define HFS_GET_LAST_MTIME  (FCNTL_FS_SPECIFIC_BASE + 0x00003)
 #define HFS_GET_BOOT_INFO   (FCNTL_FS_SPECIFIC_BASE + 0x00004)
 #define HFS_SET_BOOT_INFO   (FCNTL_FS_SPECIFIC_BASE + 0x00005)
+/* See HFSIOC_EXT_BULKACCESS and friends for HFS specific fsctls*/
+
 
 
 /*
@@ -392,119 +575,185 @@ enum { kHFSPlusMaxFileNameBytes = kHFSPlusMaxFileNameChars * 3 };
 #define MAC_GMT_FACTOR         2082844800UL
 
 
-time_t to_bsd_time(u_int32_t hfs_time);
-u_int32_t to_hfs_time(time_t bsd_time);
-
-int hfs_flushvolumeheader(struct hfsmount *hfsmp, int waitfor, int altflush);
-#define HFS_ALTFLUSH   1
-
-extern int hfsUnmount(struct hfsmount *hfsmp, struct proc *p);
-
-extern int hfs_getnewvnode(struct hfsmount *hfsmp, struct vnode *dvp, struct componentname *cnp,
-                           struct cat_desc *descp, int wantrsrc, struct cat_attr *attrp,
-                           struct cat_fork *forkp, struct vnode **vpp);
-
-extern u_int32_t hfs_freeblks(struct hfsmount * hfsmp, int wantreserve);
-
-extern void hfs_remove_orphans(struct hfsmount *);
-
-
-short MacToVFSError(OSErr err);
+/*****************************************************************************
+       FUNCTION PROTOTYPES 
+******************************************************************************/
+
+/*****************************************************************************
+       hfs_vnop_xxx functions from different files 
+******************************************************************************/
+int hfs_vnop_readdirattr(struct vnop_readdirattr_args *);  /* in hfs_attrlist.c */
+
+int hfs_vnop_inactive(struct vnop_inactive_args *);        /* in hfs_cnode.c */
+int hfs_vnop_reclaim(struct vnop_reclaim_args *);          /* in hfs_cnode.c */
+int hfs_set_backingstore (struct vnode *vp, int val);                          /* in hfs_cnode.c */
+int hfs_is_backingstore (struct vnode *vp, int *val);          /* in hfs_cnode.c */
+
+
+int hfs_vnop_link(struct vnop_link_args *);                /* in hfs_link.c */
+
+int hfs_vnop_lookup(struct vnop_lookup_args *);            /* in hfs_lookup.c */
+
+int hfs_vnop_search(struct vnop_searchfs_args *);          /* in hfs_search.c */
+
+int hfs_vnop_read(struct vnop_read_args *);           /* in hfs_readwrite.c */
+int hfs_vnop_write(struct vnop_write_args *);         /* in hfs_readwrite.c */
+int hfs_vnop_ioctl(struct vnop_ioctl_args *);         /* in hfs_readwrite.c */
+int hfs_vnop_select(struct vnop_select_args *);       /* in hfs_readwrite.c */
+int hfs_vnop_strategy(struct vnop_strategy_args *);   /* in hfs_readwrite.c */
+int hfs_vnop_allocate(struct vnop_allocate_args *);   /* in hfs_readwrite.c */
+int hfs_vnop_pagein(struct vnop_pagein_args *);       /* in hfs_readwrite.c */
+int hfs_vnop_pageout(struct vnop_pageout_args *);     /* in hfs_readwrite.c */
+int hfs_vnop_bwrite(struct vnop_bwrite_args *);       /* in hfs_readwrite.c */
+int hfs_vnop_blktooff(struct vnop_blktooff_args *);   /* in hfs_readwrite.c */
+int hfs_vnop_offtoblk(struct vnop_offtoblk_args *);   /* in hfs_readwrite.c */
+int hfs_vnop_blockmap(struct vnop_blockmap_args *);   /* in hfs_readwrite.c */
+
+int hfs_vnop_getxattr(struct vnop_getxattr_args *);        /* in hfs_xattr.c */
+int hfs_vnop_setxattr(struct vnop_setxattr_args *);        /* in hfs_xattr.c */
+int hfs_vnop_removexattr(struct vnop_removexattr_args *);  /* in hfs_xattr.c */
+int hfs_vnop_listxattr(struct vnop_listxattr_args *);      /* in hfs_xattr.c */
+#if NAMEDSTREAMS
+extern int hfs_vnop_getnamedstream(struct vnop_getnamedstream_args*);
+extern int hfs_vnop_makenamedstream(struct vnop_makenamedstream_args*);
+extern int hfs_vnop_removenamedstream(struct vnop_removenamedstream_args*);
+#endif
 
-extern int hfs_owner_rights(struct hfsmount *hfsmp, uid_t cnode_uid, struct ucred *cred,
-               struct proc *p, int invokesuperuserstatus);
 
-u_long FindMetaDataDirectory(ExtendedVCB *vcb);
+/*****************************************************************************
+       Functions from MacOSStubs.c
+******************************************************************************/
+time_t to_bsd_time(u_int32_t hfs_time);
 
-#define  kMaxSecsForFsync      5
-#define  HFS_SYNCTRANS         1
+u_int32_t to_hfs_time(time_t bsd_time);
 
-extern int hfs_btsync(struct vnode *vp, int sync_transaction);
-// used as a callback by the journaling code
-extern void hfs_sync_metadata(void *arg);
 
-short make_dir_entry(FCB **fileptr, char *name, u_int32_t fileID);
+/*****************************************************************************
+       Functions from hfs_encodinghint.c
+******************************************************************************/
+u_int32_t hfs_pickencoding(const u_int16_t *src, int len);
 
+u_int32_t hfs_getencodingbias(void);
 
-unsigned long BestBlockSizeFit(unsigned long allocationBlockSize,
-                               unsigned long blockSizeLimit,
-                               unsigned long baseMultiple);
+void hfs_setencodingbias(u_int32_t bias);
 
-OSErr  hfs_MountHFSVolume(struct hfsmount *hfsmp, HFSMasterDirectoryBlock *mdb,
-               struct proc *p);
-OSErr  hfs_MountHFSPlusVolume(struct hfsmount *hfsmp, HFSPlusVolumeHeader *vhp,
-               off_t embeddedOffset, u_int64_t disksize, struct proc *p, void *args, kauth_cred_t cred);
 
-extern int     hfs_early_journal_init(struct hfsmount *hfsmp, HFSPlusVolumeHeader *vhp,
-                                                          void *_args, off_t embeddedOffset, daddr64_t mdb_offset,
-                                                          HFSMasterDirectoryBlock *mdbp, struct ucred *cred);
-extern u_long  GetFileInfo(ExtendedVCB *vcb, u_int32_t dirid, const char *name,
-                                                  struct cat_attr *fattr, struct cat_fork *forkinfo);
+/*****************************************************************************
+       Functions from hfs_encodings.c
+******************************************************************************/
+void hfs_converterinit(void);
 
 int hfs_getconverter(u_int32_t encoding, hfs_to_unicode_func_t *get_unicode,
                     unicode_to_hfs_func_t *get_hfsname);
 
 int hfs_relconverter(u_int32_t encoding);
 
-int hfs_to_utf8(ExtendedVCB *vcb, Str31 hfs_str, ByteCount maxDstLen,
+int hfs_to_utf8(ExtendedVCB *vcb, const Str31 hfs_str, ByteCount maxDstLen,
                ByteCount *actualDstLen, unsigned char* dstStr);
 
 int utf8_to_hfs(ExtendedVCB *vcb, ByteCount srcLen, const unsigned char* srcStr,
                Str31 dstStr);
 
-int mac_roman_to_utf8(Str31 hfs_str, ByteCount maxDstLen, ByteCount *actualDstLen,
+int mac_roman_to_utf8(const Str31 hfs_str, ByteCount maxDstLen, ByteCount *actualDstLen,
                unsigned char* dstStr);
 
 int utf8_to_mac_roman(ByteCount srcLen, const unsigned char* srcStr, Str31 dstStr);
 
-u_int32_t hfs_pickencoding(const u_int16_t *src, int len);
+int mac_roman_to_unicode(const Str31 hfs_str, UniChar *uni_str, u_int32_t maxCharLen, u_int32_t *usedCharLen);
 
-enum volop {VOL_UPDATE, VOL_MKDIR, VOL_RMDIR, VOL_MKFILE, VOL_RMFILE};
+int unicode_to_hfs(ExtendedVCB *vcb, ByteCount srcLen, u_int16_t* srcStr, Str31 dstStr, int retry);
 
-extern int hfs_volupdate(struct hfsmount *hfsmp, enum volop op, int inroot);
 
-extern void hfs_setencodingbits(struct hfsmount *hfsmp, u_int32_t encoding);
+/*****************************************************************************
+       Functions from hfs_notifications.c
+******************************************************************************/
+void hfs_generate_volume_notifications(struct hfsmount *hfsmp);
 
 
-extern void replace_desc(struct cnode *cp, struct cat_desc *cdp);
+/*****************************************************************************
+       Functions from hfs_readwrite.c
+******************************************************************************/
+extern int  hfs_relocate(struct  vnode *, u_int32_t, kauth_cred_t, struct  proc *);
 
-extern int hfs_namecmp(const char *, size_t, const char *, size_t);
+extern int hfs_truncate(struct vnode *, off_t, int, int, int, vfs_context_t);
 
-extern int  hfs_virtualmetafile(struct cnode *);
+extern int hfs_release_storage (struct hfsmount *hfsmp, struct filefork *datafork, 
+                                                               struct filefork *rsrcfork,  u_int32_t fileid);
 
-void hfs_generate_volume_notifications(struct hfsmount *hfsmp);
+extern int hfs_prepare_release_storage (struct hfsmount *hfsmp, struct vnode *vp);
 
-__private_extern__ u_int32_t hfs_getencodingbias(void);
-__private_extern__ void hfs_setencodingbias(u_int32_t bias);
+extern int hfs_bmap(struct vnode *, daddr_t, struct vnode **, daddr64_t *, unsigned int *);
 
-extern int hfs_vgetrsrc(struct hfsmount *hfsmp, struct vnode *vp,
-                       struct vnode **rvpp, struct proc *p);
+extern int hfs_fsync(struct vnode *, int, int, struct proc *);
 
-extern int hfs_update(struct vnode *, int);
+extern int hfs_access(struct vnode *, mode_t, kauth_cred_t, struct proc *);
 
-extern int hfs_truncate(struct vnode *, off_t, int, int, vfs_context_t);
+extern int hfs_removeallattr(struct hfsmount *hfsmp, u_int32_t fileid);
 
-extern int hfs_fsync(struct vnode *, int, int, struct proc *);
+extern int hfs_set_volxattr(struct hfsmount *hfsmp, unsigned int xattrtype, int state);
 
-extern int hfs_access(struct vnode *, mode_t, struct ucred *, struct proc *);
+extern int hfs_isallocated(struct hfsmount *hfsmp, u_int32_t startingBlock, u_int32_t numBlocks);
 
-extern int hfs_vget(struct hfsmount *, cnid_t, struct vnode **, int);
+extern int hfs_count_allocated(struct hfsmount *hfsmp, u_int32_t startBlock, 
+               u_int32_t numBlocks, u_int32_t *alloc_count);
 
-extern int hfs_bmap(struct vnode *, daddr_t, struct vnode **, daddr64_t *, int *);
+extern int hfs_isrbtree_active (struct hfsmount *hfsmp);
 
-extern int hfs_removeallattr(struct hfsmount *hfsmp, u_int32_t fileid);
 
-__private_extern__ int hfs_start_transaction(struct hfsmount *hfsmp);
-__private_extern__ int hfs_end_transaction(struct hfsmount *hfsmp);
+/*****************************************************************************
+       Functions from hfs_vfsops.c
+******************************************************************************/
+int hfs_mountroot(mount_t mp, vnode_t rvp, vfs_context_t context);
+
+/* used as a callback by the journaling code */
+extern void hfs_sync_metadata(void *arg);
+
+extern int hfs_vget(struct hfsmount *, cnid_t, struct vnode **, int, int);
+
+extern void hfs_setencodingbits(struct hfsmount *hfsmp, u_int32_t encoding);
+
+enum volop {VOL_UPDATE, VOL_MKDIR, VOL_RMDIR, VOL_MKFILE, VOL_RMFILE};
+extern int hfs_volupdate(struct hfsmount *hfsmp, enum volop op, int inroot);
 
-extern int  hfs_setextendedsecurity(struct hfsmount *hfsmp, int state);
-extern void hfs_checkextendedsecurity(struct hfsmount *hfsmp);
+int hfs_flushvolumeheader(struct hfsmount *hfsmp, int waitfor, int altflush);
+#define HFS_ALTFLUSH   1
 
 extern int  hfs_extendfs(struct hfsmount *, u_int64_t, vfs_context_t);
 extern int  hfs_truncatefs(struct hfsmount *, u_int64_t, vfs_context_t);
 extern int  hfs_resize_progress(struct hfsmount *, u_int32_t *);
 
-extern int  hfs_isallocated(struct hfsmount *, u_long, u_long);
+/* If a runtime corruption is detected, mark the volume inconsistent 
+ * bit in the volume attributes.
+ */
+void hfs_mark_volume_inconsistent(struct hfsmount *hfsmp);
+
+/*****************************************************************************
+       Functions from hfs_vfsutils.c
+******************************************************************************/
+u_int32_t BestBlockSizeFit(u_int32_t allocationBlockSize,
+                               u_int32_t blockSizeLimit,
+                               u_int32_t baseMultiple);
+
+OSErr  hfs_MountHFSVolume(struct hfsmount *hfsmp, HFSMasterDirectoryBlock *mdb,
+               struct proc *p);
+OSErr  hfs_MountHFSPlusVolume(struct hfsmount *hfsmp, HFSPlusVolumeHeader *vhp,
+               off_t embeddedOffset, u_int64_t disksize, struct proc *p, void *args, kauth_cred_t cred);
+
+extern int hfsUnmount(struct hfsmount *hfsmp, struct proc *p);
+
+extern int overflow_extents(struct filefork *fp);
+
+extern int hfs_owner_rights(struct hfsmount *hfsmp, uid_t cnode_uid, kauth_cred_t cred,
+               struct proc *p, int invokesuperuserstatus);
+
+extern int check_for_tracked_file(struct vnode *vp, time_t ctime, uint64_t op_type, void *arg);
+extern int check_for_dataless_file(struct vnode *vp, uint64_t op_type);
+
+/*
+ * Journal lock function prototypes
+ */
+int hfs_lock_global (struct hfsmount *hfsmp, enum hfslocktype locktype);
+void hfs_unlock_global (struct hfsmount *hfsmp);
 
 
 /* HFS System file locking */
@@ -512,11 +761,113 @@ extern int  hfs_isallocated(struct hfsmount *, u_long, u_long);
 #define SFL_EXTENTS     0x0002
 #define SFL_BITMAP      0x0004
 #define SFL_ATTRIBUTE   0x0008
-#define SFL_VALIDMASK   (SFL_CATALOG | SFL_EXTENTS | SFL_BITMAP | SFL_ATTRIBUTE)
+#define SFL_STARTUP    0x0010
+#define SFL_VALIDMASK   (SFL_CATALOG | SFL_EXTENTS | SFL_BITMAP | SFL_ATTRIBUTE | SFL_STARTUP)
 
 extern int  hfs_systemfile_lock(struct hfsmount *, int, enum hfslocktype);
 extern void hfs_systemfile_unlock(struct hfsmount *, int);
 
+extern u_int32_t  GetFileInfo(ExtendedVCB *vcb, u_int32_t dirid, const char *name,
+                                                  struct cat_attr *fattr, struct cat_fork *forkinfo);
+
+extern void hfs_remove_orphans(struct hfsmount *);
+
+u_int32_t GetLogicalBlockSize(struct vnode *vp);
+
+extern u_int32_t hfs_freeblks(struct hfsmount * hfsmp, int wantreserve);
+
+short MacToVFSError(OSErr err);
+
+void hfs_metadatazone_init(struct hfsmount *hfsmp, int disable);
+
+/* HFS directory hint functions. */
+extern directoryhint_t * hfs_getdirhint(struct cnode *, int, int);
+extern void  hfs_reldirhint(struct cnode *, directoryhint_t *);
+extern void  hfs_reldirhints(struct cnode *, int);
+extern void  hfs_insertdirhint(struct cnode *, directoryhint_t *);
+
+extern int hfs_namecmp(const u_int8_t *str1, size_t len1, const u_int8_t *str2, size_t len2);
+
+extern int     hfs_early_journal_init(struct hfsmount *hfsmp, HFSPlusVolumeHeader *vhp,
+                          void *_args, off_t embeddedOffset, daddr64_t mdb_offset,
+                          HFSMasterDirectoryBlock *mdbp, kauth_cred_t cred);
+
+extern int  hfs_virtualmetafile(struct cnode *);
+
+extern int hfs_start_transaction(struct hfsmount *hfsmp);
+extern int hfs_end_transaction(struct hfsmount *hfsmp);
+extern int hfs_journal_flush(struct hfsmount *hfsmp, boolean_t wait_for_IO);
+extern void hfs_sync_ejectable(struct hfsmount *hfsmp);
+
+extern void hfs_trim_callback(void *arg, uint32_t extent_count, const dk_extent_t *extents);
+
+/* Erase unused Catalog nodes due to <rdar://problem/6947811>. */
+extern int hfs_erase_unused_nodes(struct hfsmount *hfsmp);
+
+
+/*****************************************************************************
+       Functions from hfs_vnops.c
+******************************************************************************/
+int hfs_write_access(struct vnode *vp, kauth_cred_t cred, struct proc *p, Boolean considerFlags);
+
+int hfs_chmod(struct vnode *vp, int mode, kauth_cred_t cred, struct proc *p);
+
+int hfs_chown(struct vnode *vp, uid_t uid, gid_t gid, kauth_cred_t cred, struct proc *p);
+
+#define  kMaxSecsForFsync      5
+#define  HFS_SYNCTRANS         1
+extern int hfs_btsync(struct vnode *vp, int sync_transaction);
+
+extern void replace_desc(struct cnode *cp, struct cat_desc *cdp);
+
+extern int hfs_vgetrsrc(struct hfsmount *hfsmp, struct vnode *vp,
+                       struct vnode **rvpp, int can_drop_lock, int error_on_unlink);
+
+extern int hfs_update(struct vnode *, int);
+
+
+/*****************************************************************************
+       Functions from hfs_xattr.c
+******************************************************************************/
+
+/* Maximum extended attribute size supported for all extended attributes except  
+ * resource fork and finder info.
+ */
+#define HFS_XATTR_MAXSIZE      (128 * 1024)
+
+/* Number of bits used to represent maximum extended attribute size */
+#define HFS_XATTR_SIZE_BITS    18
+
+int  hfs_attrkeycompare(HFSPlusAttrKey *searchKey, HFSPlusAttrKey *trialKey);
+int  hfs_buildattrkey(u_int32_t fileID, const char *attrname, HFSPlusAttrKey *key);
+void hfs_xattr_init(struct hfsmount * hfsmp);
+int file_attribute_exist(struct hfsmount *hfsmp, uint32_t fileID);
+int init_attrdata_vnode(struct hfsmount *hfsmp);
+int hfs_getxattr_internal(struct cnode *, struct vnop_getxattr_args *,
+                                                       struct hfsmount *, u_int32_t);
+int hfs_setxattr_internal(struct cnode *, caddr_t, size_t, 
+                                                 struct vnop_setxattr_args *, struct hfsmount *, u_int32_t);
+
+
+
+/*****************************************************************************
+       Functions from hfs_link.c
+******************************************************************************/
+
+extern int  hfs_unlink(struct hfsmount *hfsmp, struct vnode *dvp, struct vnode *vp,
+                       struct componentname *cnp, int skip_reserve);
+extern int  hfs_lookup_siblinglinks(struct hfsmount *hfsmp, cnid_t linkfileid,
+                           cnid_t *prevlinkid,  cnid_t *nextlinkid);
+extern void  hfs_privatedir_init(struct hfsmount *, enum privdirtype);
+
+extern void  hfs_savelinkorigin(cnode_t *cp, cnid_t parentcnid);
+extern void  hfs_relorigins(struct cnode *cp);
+extern void  hfs_relorigin(struct cnode *cp, cnid_t parentcnid);
+extern int   hfs_haslinkorigin(cnode_t *cp);
+extern cnid_t  hfs_currentparent(cnode_t *cp);
+extern cnid_t  hfs_currentcnid(cnode_t *cp);
+
+
 #endif /* __APPLE_API_PRIVATE */
 #endif /* KERNEL */
 #endif /* __HFS__ */