X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/d52fe63fc81f7e44faaae711812a211a78434976..d41d1dae2cd00cc08c7982087d1c445180cad9f5:/bsd/hfs/hfs.h diff --git a/bsd/hfs/hfs.h b/bsd/hfs/hfs.h index c88467a1c..89f97ebc1 100644 --- a/bsd/hfs/hfs.h +++ b/bsd/hfs/hfs.h @@ -1,52 +1,63 @@ /* - * Copyright (c) 2000-2001 Apple Computer, Inc. All rights reserved. + * Copyright (c) 2000-2009 Apple Inc. All rights reserved. * - * @APPLE_LICENSE_HEADER_START@ + * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ * - * The contents of this file constitute Original Code as defined in and - * are subject to the Apple Public Source License Version 1.1 (the - * "License"). You may not use this file except in compliance with the - * License. Please obtain a copy of the License at - * http://www.apple.com/publicsource and read it before using this file. + * 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. * - * This Original Code and all software distributed under the License are - * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER + * 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 OR NON-INFRINGEMENT. Please see the - * License for the specific language governing rights and limitations - * under the License. + * 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_LICENSE_HEADER_END@ + * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ */ -/* @(#)hfs.h 3.0 -* -* (c) 1990, 1992 NeXT Computer, Inc. All Rights Reserved -* (c) 1997-1999 Apple Computer, Inc. All Rights Reserved -* -* hfs.h -- constants, structures, function declarations. etc. -* for Macintosh file system vfs. -* -*/ #ifndef __HFS__ #define __HFS__ +#define HFS_SPARSE_DEV 1 + +#if DEBUG +#define HFS_CHECK_LOCK_ORDER 1 +#endif + +#include + +#ifdef KERNEL +#ifdef __APPLE_API_PRIVATE #include -#include #include -#include - +#include +#include +#include #include +#include +#include + +#include + +#include #include +#include +#include #include #include -#include - - -struct uio; // This is more effective than #include in case KERNEL is undefined... -struct hfslockf; // For advisory locking +#include /* * Just reported via MIG interface. @@ -55,634 +66,464 @@ struct hfslockf; // For advisory locking #define HFS_LINK_MAX 32767 -/* - * Set to force READ_ONLY. - */ -#define FORCE_READONLY 0 +#define HFS_MAX_DEFERED_ALLOC (1024*1024) + +// 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) +#define HFS_BIGFILE_SIZE (400LL * 1024LL * 1024LL) + enum { kMDBSize = 512 }; /* Size of I/O transfer to read entire MDB */ enum { kMasterDirectoryBlock = 2 }; /* MDB offset on disk in 512-byte blocks */ enum { kMDBOffset = kMasterDirectoryBlock * 512 }; /* MDB offset on disk in bytes */ -enum { - kUnknownID = 0, - kRootParID = 1, - kRootDirID = 2 -}; - -enum { - kUndefinedFork = 0, - kDataFork, - kRsrcFork, - kDirectory, - kSysFile, - kDefault, - kAnyFork -}; +#define kRootDirID kHFSRootFolderID + /* 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' */ -}; - -#define BUFFERPTRLISTSIZE 25 - -extern char * gBufferAddress[BUFFERPTRLISTSIZE]; -extern struct buf *gBufferHeaderPtr[BUFFERPTRLISTSIZE]; -extern int gBufferListIndex; -extern simple_lock_data_t gBufferPtrListLock; - extern struct timezone gTimeZone; -/* Flag values for bexpand: */ -#define RELEASE_BUFFER 0x00000001 - /* How many free extents to cache per volume */ #define kMaxFreeExtents 10 -/* Internal Data structures*/ - -struct vcb_t { - u_int16_t vcbSigWord; - int16_t vcbAtrb; - int16_t vcbFlags; - int16_t vcbVRefNum; - - u_int32_t vcbCrDate; - u_int32_t vcbLsMod; - u_int32_t vcbVolBkUp; - u_int32_t checkedDate; /* time of last disk check */ - - int32_t vcbFilCnt; - int32_t vcbDirCnt; - u_int32_t blockSize; /* size of allocation blocks */ - u_int32_t totalBlocks; /* total allocation blocks */ - u_int32_t freeBlocks; /* free allocation blocks */ - u_int32_t nextAllocation; /* start of next allocation search */ - int32_t vcbClpSiz; - u_int32_t vcbNxtCNID; - u_int32_t vcbCNIDGen; - int32_t vcbWrCnt; - - int32_t vcbFndrInfo[8]; - - u_int64_t encodingsBitmap; /* HFS Plus only */ - - u_int16_t vcbNmFls; /* HFS only */ - u_int16_t vcbNmRtDirs; /* HFS only */ - int16_t vcbVBMSt; /* HFS only */ - int16_t vcbAlBlSt; /* HFS only */ - - struct vnode * extentsRefNum; - struct vnode * catalogRefNum; - struct vnode * allocationsRefNum; - - u_int8_t vcbVN[256]; /* volume name in UTF-8 */ - u_int32_t volumeNameEncodingHint; - u_int32_t altIDSector; /* location of alternate MDB/VH */ - u_int32_t hfsPlusIOPosOffset; /* Disk block where HFS+ starts */ - u_int32_t vcbVBMIOSize; /* volume bitmap I/O size */ - char * hintCachePtr; /* volume heuristicHint cache */ - - /* cache of largest known free extents */ - u_int32_t vcbFreeExtCnt; - HFSPlusExtentDescriptor vcbFreeExt[kMaxFreeExtents]; - - u_int32_t localCreateDate; /* creation times for HFS+ volumes are in local time */ - simple_lock_data_t vcbSimpleLock; /* simple lock to allow concurrent access to vcb data */ -}; -typedef struct vcb_t ExtendedVCB; - - -/* vcbFlags */ -#define kHFS_DamagedVolume 0x1 /* This volume has errors, unmount dirty */ -#define MARK_VOLUMEDAMAGED(fcb) FCBTOVCB((fcb))->vcbFlags |= kHFS_DamagedVolume; - - /* - * NOTE: The code relies on being able to cast an ExtendedVCB* to a vfsVCB* in order - * to gain access to the mount point pointer from a pointer - * to an ExtendedVCB. DO NOT INSERT OTHER FIELDS BEFORE THE vcb FIELD!! - * - * vcbFlags, vcbLsMod, vcbFilCnt, vcbDirCnt, vcbNxtCNID, etc - * are locked by the hfs_lock simple lock. + * HFS_MINFREE gives the minimum acceptable percentage + * of file system blocks which may be free (but this + * minimum will never exceed HFS_MAXRESERVE bytes). If + * the free block count drops below this level only the + * superuser may continue to allocate blocks. */ -typedef struct vfsVCB { - ExtendedVCB vcb_vcb; - struct hfsmount *vcb_hfsmp; /* Pointer to hfsmount structure */ -} vfsVCB_t; +#define HFS_MINFREE 1 +#define HFS_MAXRESERVE ((u_int64_t)(250*1024*1024)) +/* + * The system distinguishes between the desirable low-disk + * notifiaction levels for root volumes and non-root volumes. + * The various thresholds are computed as a fraction of the + * volume size, all capped at a certain fixed level + */ + +#define HFS_ROOTVERYLOWDISKTRIGGERFRACTION 5 +#define HFS_ROOTVERYLOWDISKTRIGGERLEVEL ((u_int64_t)(125*1024*1024)) +#define HFS_ROOTLOWDISKTRIGGERFRACTION 10 +#define HFS_ROOTLOWDISKTRIGGERLEVEL ((u_int64_t)(250*1024*1024)) +#define HFS_ROOTLOWDISKSHUTOFFFRACTION 11 +#define HFS_ROOTLOWDISKSHUTOFFLEVEL ((u_int64_t)(375*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*/ /* This structure describes the HFS specific mount structure data. */ typedef struct hfsmount { - u_long hfs_mount_flags; - u_int8_t hfs_fs_clean; /* Whether contents have been flushed in clean state */ - u_int8_t hfs_fs_ronly; /* Whether this was mounted as read-initially */ - u_int8_t hfs_unknownpermissions; /* Whether this was mounted with MNT_UNKNOWNPERMISSIONS */ - + u_int32_t hfs_flags; /* see below */ + /* Physical Description */ - u_long hfs_phys_block_count; /* Num of PHYSICAL blocks of volume */ - u_long hfs_phys_block_size; /* Always a multiple of 512 */ + 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 */ struct vnode *hfs_devvp; /* block device mounted vnode */ - dev_t hfs_raw_dev; /* device mounted */ - struct netexport hfs_export; /* Export information */ - u_int32_t hfs_logBlockSize; /* Size of buffer cache buffer for I/O */ + struct vnode * hfs_extents_vp; + 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 */ /* Default values for HFS standard and non-init access */ - uid_t hfs_uid; /* uid to set as owner of the files */ - 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 */ - - /* simple lock for shared meta renaming */ - simple_lock_data_t hfs_renamelock; - - /* HFS Specific */ - struct vfsVCB hfs_vcb; - u_long hfs_private_metadata_dir; /* private/hidden directory for unlinked files */ + uid_t hfs_uid; /* uid to set as owner of the files */ + 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_int32_t hfs_encoding; /* Default encoding for non hfs+ volumes */ + + /* Persistent fields (on disk, dynamic) */ + time_t hfs_mtime; /* file system last modification time */ + u_int32_t hfs_filecount; /* number of files in file system */ + 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 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 */ + u_int16_t vcbNmRtDirs; /* HFS Only - root dir directory count */ + + /* Persistent fields (on disk, static) */ + u_int16_t vcbSigWord; + 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 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 */ + int16_t vcbAlBlSt; /* HFS only */ + + /* vcb stuff */ + u_int8_t vcbVN[256]; /* volume name in UTF-8 */ + u_int32_t volumeNameEncodingHint; + u_int32_t hfsPlusIOPosOffset; /* Disk block where HFS+ starts */ + u_int32_t vcbVBMIOSize; /* volume bitmap I/O size */ + + /* cache of largest known free extents */ + u_int32_t vcbFreeExtCnt; + HFSPlusExtentDescriptor vcbFreeExt[kMaxFreeExtents]; + + 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 */ + + /* + * 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; -} hfsmount_t; - -#define HFSPLUS_PRIVATE_DIR \ - "\xE2\x90\x80\xE2\x90\x80\xE2\x90\x80\xE2\x90\x80HFS+ Private Data" - - -/***************************************************************************** -* -* hfsnode structure -* -* -* -*****************************************************************************/ - -#define MAXHFSVNODELEN 31 -typedef u_char FileNameStr[MAXHFSVNODELEN+1]; - -CIRCLEQ_HEAD(siblinghead, hfsnode) ; /* Head of the sibling list */ - - -struct hfsnode { - LIST_ENTRY(hfsnode) h_hash; /* links on valid files */ - CIRCLEQ_ENTRY(hfsnode) h_sibling; /* links on siblings */ - struct lock__bsd__ h_lock; /* node lock. */ - union { - struct hfslockf *hu_lockf; /* Head of byte-level lock list. */ - void *hu_sysdata; /* private data for system files */ - char hu_symlinkdata[4]; /* symbolic link (4 chars or less) */ - char *hu_symlinkptr; /* symbolic link pathname */ - } h_un; - struct vnode * h_vp; /* vnode associated with this inode. */ - struct hfsfilemeta * h_meta; /* Ptr to file meta data */ - u_int16_t h_nodeflags; /* flags, see below */ - u_int8_t h_type; /* Type of info: dir, data, rsrc */ - int8_t fcbFlags; /* FCB flags */ - struct rl_head h_invalidranges;/* Areas of disk that should read back as zeroes */ - u_int64_t fcbEOF; /* Logical length or EOF in bytes */ - u_int64_t fcbPLen; /* Physical file length in bytes */ - u_int32_t fcbClmpSize; /* Number of bytes per clump */ - HFSPlusExtentRecord fcbExtents; /* Extents of file */ - -#if HFS_DIAGNOSTIC - u_int32_t h_valid; /* is the vnode reference valid */ + + /* Quota variables: */ + struct quotafile hfs_qfiles[MAXQUOTAS]; /* quota files */ + + /* Journaling variables: */ + void *jnl; // the journal for this volume (if one exists) + struct vnode *jvp; // device where the journal lives (may be equal to devvp) + u_int32_t jnl_start; // start block of the journal file (so we don't delete it) + u_int32_t jnl_size; + u_int32_t hfs_jnlfileid; + u_int32_t hfs_jnlinfoblkid; + lck_rw_t hfs_global_lock; + u_int32_t hfs_global_lock_nesting; + + /* Notification variables: */ + 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; + + /* time mounted and last mounted mod time "snapshot" */ + time_t hfs_mount_time; + time_t hfs_last_mounted_mtime; + + /* Metadata allocation zone variables: */ + u_int32_t hfs_metazone_start; + 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; + int hfs_catalog_maxblks; + + /* Hot File Clustering variables: */ + lck_mtx_t hfc_mutex; /* serialize hot file stages */ + enum hfc_stage hfc_stage; /* what are we up to... */ + time_t hfc_timebase; /* recording period start time */ + time_t hfc_timeout; /* recording period stop time */ + void * hfc_recdata; /* recording data (opaque) */ + int hfc_maxfiles; /* maximum files to track */ + struct vnode * hfc_filevp; + +#ifdef 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 -}; -#define h_lockf h_un.hu_lockf -#define fcbBTCBPtr h_un.hu_sysdata -#define h_symlinkptr h_un.hu_symlinkptr -#define h_symlinkdata h_un.hu_symlinkdata - -typedef struct hfsnode FCB; - - -typedef struct hfsfilemeta { - struct siblinghead h_siblinghead; /* Head of the sibling list */ - simple_lock_data_t h_siblinglock; /* sibling list lock. */ - u_int32_t h_metaflags; /* IN_LONGNAME, etc */ - struct vnode *h_devvp; /* vnode for block I/O. */ - - dev_t h_dev; /* Device associated with the inode. */ - u_int32_t h_nodeID; /* specific id of this node */ - u_int32_t h_dirID; /* Parent Directory ID */ - u_int32_t h_hint; /* Catalog hint */ - - off_t h_size; /* Total physical size of object */ - u_int16_t h_usecount; /* How many siblings */ - u_int16_t h_mode; /* IFMT, permissions; see below. */ - u_int32_t h_pflags; /* Permission flags (NODUMP, IMMUTABLE, APPEND etc.) */ - u_int32_t h_uid; /* File owner. */ - u_int32_t h_gid; /* File group. */ - union { - dev_t hu_rdev; /* Special device info for this node */ - u_int32_t hu_indnodeno; /* internal indirect node number (never exported) */ - } h_spun; - u_int32_t h_crtime; /* BSD-format creation date in secs. */ - u_int32_t h_atime; /* BSD-format access date in secs. */ - u_int32_t h_mtime; /* BSD-format mod date in seconds */ - u_int32_t h_ctime; /* BSD-format status change date */ - u_int32_t h_butime; /* BSD-format last backup date in secs. */ - u_int16_t h_nlink; /* link count (aprox. for dirs) */ - u_short h_namelen; /* Length of name string */ - char * h_namePtr; /* Points the name of the file */ - FileNameStr h_fileName; /* CName of file */ -} hfsfilemeta; -#define h_rdev h_spun.hu_rdev -#define h_indnodeno h_spun.hu_indnodeno - -#define H_EXTENDSIZE(VP,BYTES) ((VP)->h_meta->h_size += (BYTES)) -#define H_TRUNCSIZE(VP,BYTES) ((VP)->h_meta->h_size -= (BYTES)) - -#define MAKE_INODE_NAME(name,linkno) \ - (void) sprintf((name), "%s%d", HFS_INODE_PREFIX, (linkno)) + 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; + + /* 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; -/* - * Macros for quick access to fields buried in the fcb inside an hfs node: +#define HFS_META_DELAY (100) +#define HFS_MILLISEC_SCALE (1000*1000) + +typedef hfsmount_t ExtendedVCB; + +/* Aliases for legacy (Mac OS 9) field names */ +#define vcbCrDate hfs_itime +#define vcbLsMod hfs_mtime +#define vcbVolBkUp hfs_btime +#define extentsRefNum hfs_extents_vp +#define catalogRefNum hfs_catalog_vp +#define allocationsRefNum hfs_allocation_vp +#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. */ -#define H_FORKTYPE(HP) ((HP)->h_type) -#define H_FILEID(HP) ((HP)->h_meta->h_nodeID) -#define H_DIRID(HP) ((HP)->h_meta->h_dirID) -#define H_NAME(HP) ((HP)->h_meta->h_namePtr) -#define H_HINT(HP) ((HP)->h_meta->h_hint) -#define H_DEV(HP) ((HP)->h_meta->h_dev) - -#define H_ISBIGLINK(HP) ((HP)->fcbEOF > 4) -#define H_SYMLINK(HP) (H_ISBIGLINK((HP)) ? (HP)->h_symlinkptr : (HP)->h_symlinkdata) - -/* These flags are kept in flags. */ -#define IN_ACCESS 0x0001 /* Access time update request. */ -#define IN_CHANGE 0x0002 /* Change time update request. */ -#define IN_UPDATE 0x0004 /* Modification time update request. */ -#define IN_MODIFIED 0x0008 /* Node has been modified. */ -#define IN_RENAME 0x0010 /* Node is being renamed. */ -#define IN_SHLOCK 0x0020 /* File has shared lock. */ -#define IN_EXLOCK 0x0040 /* File has exclusive lock. */ -#define IN_BYCNID 0x0100 /* Dir was found by CNID */ -#define IN_ALLOCATING 0x1000 /* vnode is in transit, wait or ignore */ -#define IN_WANT 0x2000 /* Its being waited for */ - -/* These flags are kept in meta flags. */ -#define IN_LONGNAME 0x0400 /* File has long name buffer. */ -#define IN_UNSETACCESS 0x0200 /* File has unset access. */ -#define IN_DELETED 0x0800 /* File has been marked to be deleted */ -#define IN_NOEXISTS 0x1000 /* File has been deleted, catalog entry is gone */ -#if HFS_HARDLINKS -#define IN_DATANODE 0x2000 /* File is a data node (hard-linked) */ -#endif - - -/* File permissions stored in mode */ -#define IEXEC 0000100 /* Executable. */ -#define IWRITE 0000200 /* Writeable. */ -#define IREAD 0000400 /* Readable. */ -#define ISVTX 0001000 /* Sticky bit. */ -#define ISGID 0002000 /* Set-gid. */ -#define ISUID 0004000 /* Set-uid. */ - -/* File types */ -#define IFMT 0170000 /* Mask of file type. */ -#define IFIFO 0010000 /* Named pipe (fifo). */ -#define IFCHR 0020000 /* Character device. */ -#define IFDIR 0040000 /* Directory file. */ -#define IFBLK 0060000 /* Block device. */ -#define IFREG 0100000 /* Regular file. */ -#define IFLNK 0120000 /* Symbolic link. */ -#define IFSOCK 0140000 /* UNIX domain socket. */ -#define IFWHT 0160000 /* Whiteout. */ - -/* Value to make sure vnode is real and defined */ -#define HFS_VNODE_MAGIC 0x4846532b /* 'HFS+' */ - -/* To test wether the forkType is a sibling type */ -#define SIBLING_FORKTYPE(FORK) ((FORK==kDataFork) || (FORK==kRsrcFork)) +/* Set runtime flag to indicate that volume is dirty */ +static __inline__ void MarkVCBDirty(ExtendedVCB *vcb) +{ + vcb->vcbFlags |= 0xFF00; +} -/* - * Write check macro - */ -#define WRITE_CK(VNODE, FUNC_NAME) { \ - if ((VNODE)->v_mount->mnt_flag & MNT_RDONLY) { \ - DBG_ERR(("%s: ATTEMPT TO WRITE A READONLY VOLUME\n", \ - FUNC_NAME)); \ - return(EROFS); \ - } \ +/* 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); +} /* - * hfsmount locking and unlocking. + * There are two private directories in HFS+. * - * mvl_lock_flags + * One contains inodes for files that are hardlinked or open/unlinked. + * The other contains inodes for directories that are hardlinked. */ -#define MVL_LOCKED 0x00000001 /* debug only */ - -#if HFS_DIAGNOSTIC -#define MVL_LOCK(mvip) { \ - (simple_lock(&(mvip)->mvl_lock)); \ - (mvip)->mvl_flags |= MVL_LOCKED; \ -} +enum privdirtype {FILE_HARDLINKS, DIR_HARDLINKS}; + + +/* HFS mount point flags */ +#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 +#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 MVL_UNLOCK(mvip) { \ - if(((mvip)->mvl_flags & MVL_LOCKED) == 0) { \ - panic("MVL_UNLOCK - hfsnode not locked"); \ - } \ - (simple_unlock(&(mvip)->mvl_lock)); \ - (mvip)->mvl_flags &= ~MVL_LOCKED; \ -} -#else /* HFS_DIAGNOSTIC */ -#define MVL_LOCK(mvip) (simple_lock(&(mvip)->mvl_lock)) -#define MVL_UNLOCK(mvip) (simple_unlock(&(mvip)->mvl_lock)) -#endif /* HFS_DIAGNOSTIC */ - - -/* structure to hold a "." or ".." directory entry (12 bytes) */ -typedef struct hfsdotentry { - u_int32_t d_fileno; /* unique file number */ - u_int16_t d_reclen; /* length of this structure */ - u_int8_t d_type; /* dirent file type */ - u_int8_t d_namelen; /* len of filename */ - char d_name[4]; /* "." or ".." */ -} hfsdotentry; - -#define AVERAGE_HFSDIRENTRY_SIZE (8+22+4) -#define MAX_HFSDIRENTRY_SIZE sizeof(struct dirent) - -#define DIRENTRY_SIZE(namlen) \ - ((sizeof(struct dirent) - (NAME_MAX+1)) + (((namlen)+1 + 3) &~ 3)) - -enum { - kCatNameIsAllocated = 0x1, /* The name is malloc'd and is in cnm_nameptr */ - kCatNameIsMangled = 0x2, /* The name is mangled */ - kCatNameUsesReserved = 0x4, /* It overides the space reserved by cnm_namespace into cndu_extra, careful */ - kCatNameIsConsumed = 0x8, /* The name has been already processed, no freeing or work is needed */ - kCatNameNoCopyName = 0x10, /* Dont copy the name */ - kCatNameMangleName = 0x20 /* Mangle name if greater than passed in length */ -}; -/* - * CatalogNameSpecifier is a structure that contains a name and possibly its form - * - * Special care needs to be taken with the flags, they can cause side effects. +/* 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. */ -struct CatalogNameSpecifier { - u_int16_t cnm_flags; /* See above */ - u_int16_t cnm_length; /* Length of the name */ - u_int32_t cnm_parID; /* ID of the parent directory */ - unsigned char *cnm_nameptr; /* If allocated, a ptr to the space, else NULL */ - unsigned char cnm_namespace[MAXHFSVNODELEN+1]; /* Space where the name can be kept */ -}; -/* - * NOTE IT IS REQUIRED that KMaxMangleNameLen >= MAXHFSVNODELEN - * Also the total size of CatalogNameSpecifier should be less then cndu_extra, which - * currently it easily is, this is not a requirement, just a nicety. - * - * The rules to how to store a name: - * If its less than MAXHFSVNODELEN always store it in cnm_namespace. - * If we can get by doing mangling then cnm_namespace - * else allocate the space needed to cnm_nameptr. - * This reflects what is done at vnode creation. +#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) \ + { \ + if ((metadata) && 1) \ + lck_mtx_lock(&(hfsmp)->hfs_mutex); \ + } \ + +#define HFS_MOUNT_UNLOCK(hfsmp, metadata) \ + { \ + if ((metadata) && 1) \ + 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_unlock_exclusive(&(hfsmp)->hfs_global_lock) + +/* 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--; \ + } \ -enum { - kCatalogFolderNode = 1, - kCatalogFileNode = 2 -}; +typedef struct filefork FCB; -/* - * CatalogNodeData has same layout as the on-disk HFS Plus file/dir records. - * Classic hfs file/dir records are converted to match this layout. - * - * The cnd_extra padding allows big hfs plus thread records (520 bytes max) - * to be read onto this stucture during a cnid lookup. - * - * IMPORTANT!!!!!! - * After declaring this structure, you must use the macro INIT_CATALOGDATA to prepare it - * and CLEAN_CATALOGDATA after using it, to clean any allocated structures. - * - * If you do not need to have the name, then pass in kCatNameNoCopyName for flags +/* + * Macros for creating item names for our special/private directories. */ -struct CatalogNodeData { - int16_t cnd_type; - u_int16_t cnd_flags; - u_int32_t cnd_valence; /* dirs only */ - u_int32_t cnd_nodeID; - u_int32_t cnd_createDate; - u_int32_t cnd_contentModDate; - u_int32_t cnd_attributeModDate; - u_int32_t cnd_accessDate; - u_int32_t cnd_backupDate; - u_int32_t cnd_ownerID; - u_int32_t cnd_groupID; - u_int8_t cnd_adminFlags; /* super-user changeable flags */ - u_int8_t cnd_ownerFlags; /* owner changeable flags */ - u_int16_t cnd_mode; /* file type + permission bits */ - union { - u_int32_t cndu_iNodeNum; /* indirect links only */ - u_int32_t cndu_linkCount; /* indirect nodes only */ - u_int32_t cndu_rawDevice; /* special files (FBLK and FCHR) only */ - } cnd_un; - u_int8_t cnd_finderInfo[32]; - u_int32_t cnd_textEncoding; - u_int32_t cnd_reserved; - HFSPlusForkData cnd_datafork; - HFSPlusForkData cnd_rsrcfork; - u_int32_t cnd_iNodeNumCopy; - u_int32_t cnd_linkCNID; /* for hard links only */ - u_int8_t cnd_extra[264]; /* make struct at least 520 bytes long */ - struct CatalogNameSpecifier cnd_namespecifier; -}; -typedef struct CatalogNodeData CatalogNodeData; - -#define cnd_iNodeNum cnd_un.cndu_iNodeNum -#define cnd_linkCount cnd_un.cndu_linkCount -#define cnd_rawDevice cnd_un.cndu_rawDevice - -#define cnm_flags cnd_namespecifier.cnm_flags -#define cnm_length cnd_namespecifier.cnm_length -#define cnm_parID cnd_namespecifier.cnm_parID -#define cnm_nameptr cnd_namespecifier.cnm_nameptr -#define cnm_namespace cnd_namespecifier.cnm_namespace - -#define INIT_CATALOGDATA(C,F) do { bzero(&((C)->cnd_namespecifier), sizeof(struct CatalogNameSpecifier)); (C)->cnm_flags=(F);}while(0); -#if HFS_DIAGNOSTIC -extern void debug_check_catalogdata(struct CatalogNodeData *cat); -#define CLEAN_CATALOGDATA(C) do { debug_check_catalogdata(C); \ - if ((C)->cnm_flags & kCatNameIsAllocated) {\ - FREE((C)->cnm_nameptr, M_TEMP);\ - (C)->cnm_flags &= ~kCatNameIsAllocated;\ - (C)->cnm_nameptr = NULL;\ - }}while(0); -#else -#define CLEAN_CATALOGDATA(C) do { if ((C)->cnm_flags & kCatNameIsAllocated) {\ - FREE((C)->cnm_nameptr, M_TEMP);\ - (C)->cnm_flags &= ~kCatNameIsAllocated;\ - (C)->cnm_nameptr = NULL;\ - }}while(0); -#endif +#define MAKE_INODE_NAME(name, size, linkno) \ + (void) snprintf((name), size, "%s%d", HFS_INODE_PREFIX, (linkno)) +#define HFS_INODE_PREFIX_LEN 5 -/* structure to hold a catalog record information */ -/* Of everything you wanted to know about a catalog entry, file and directory */ -typedef struct hfsCatalogInfo { - CatalogNodeData nodeData; - u_int32_t hint; -} hfsCatalogInfo; +#define MAKE_DIRINODE_NAME(name, size, linkno) \ + (void) snprintf((name), size, "%s%d", HFS_DIRINODE_PREFIX, (linkno)) +#define HFS_DIRINODE_PREFIX_LEN 4 -enum { kHFSPlusMaxFileNameBytes = kHFSPlusMaxFileNameChars * 3 }; +#define MAKE_DELETED_NAME(NAME, size, FID) \ + (void) snprintf((NAME), size, "%s%d", HFS_DELETE_PREFIX, (FID)) +#define HFS_DELETE_PREFIX_LEN 4 -enum { kdirentMaxNameBytes = NAME_MAX }; -// structure definition of the searchfs system trap for the search criterea. -struct directoryInfoSpec -{ - u_long numFiles; -}; +#define HFS_AVERAGE_NAME_SIZE 22 +#define AVERAGE_HFSDIRENTRY_SIZE (8+HFS_AVERAGE_NAME_SIZE+4) -struct fileInfoSpec -{ - off_t dataLogicalLength; - off_t dataPhysicalLength; - off_t resourceLogicalLength; - off_t resourcePhysicalLength; -}; +#define STD_DIRENT_LEN(namlen) \ + ((sizeof(struct dirent) - (NAME_MAX+1)) + (((namlen)+1 + 3) &~ 3)) -struct searchinfospec -{ - u_char name[kHFSPlusMaxFileNameBytes]; - u_long nameLength; - char attributes; // see IM:Files 2-100 - u_long nodeID; - u_long parentDirID; - struct timespec creationDate; - struct timespec modificationDate; - struct timespec changeDate; - struct timespec lastBackupDate; - u_long finderInfo[8]; - uid_t uid; - gid_t gid; - mode_t mask; - struct fileInfoSpec f; - struct directoryInfoSpec d; -}; -typedef struct searchinfospec searchinfospec_t; - -#define HFSTIMES(hp, t1, t2) { \ - if ((hp)->h_nodeflags & (IN_ACCESS | IN_CHANGE | IN_UPDATE)) { \ - (hp)->h_nodeflags |= IN_MODIFIED; \ - if ((hp)->h_nodeflags & IN_ACCESS) { \ - (hp)->h_meta->h_atime = (t1)->tv_sec; \ - }; \ - if ((hp)->h_nodeflags & IN_UPDATE) { \ - (hp)->h_meta->h_mtime = (t2)->tv_sec; \ - } \ - if ((hp)->h_nodeflags & IN_CHANGE) { \ - (hp)->h_meta->h_ctime = time.tv_sec; \ - }; \ - (hp)->h_nodeflags &= ~(IN_ACCESS | IN_CHANGE | IN_UPDATE); \ - } \ -} +#define EXT_DIRENT_LEN(namlen) \ + ((sizeof(struct direntry) + (namlen) - (MAXPATHLEN-1) + 3) & ~3) + + +enum { kHFSPlusMaxFileNameBytes = kHFSPlusMaxFileNameChars * 3 }; -/* This overlays the fid structure (see mount.h). */ -struct hfsfid { - u_int16_t hfsfid_len; /* Length of structure. */ - u_int16_t hfsfid_pad; /* Force 32-bit alignment. */ - /* The following data is filesystem-dependent, up to MAXFIDSZ (16) bytes: */ - u_int32_t hfsfid_cnid; /* Catalog node ID. */ - u_int32_t hfsfid_gen; /* Generation number (create date). */ -}; /* macro to determine if hfs or hfsplus */ #define ISHFSPLUS(VCB) ((VCB)->vcbSigWord == kHFSPlusSigWord) #define ISHFS(VCB) ((VCB)->vcbSigWord == kHFSSigWord) -/* - * Various ways to acquire a VNode pointer: - */ -#define HTOV(HP) ((HP)->h_vp) - -/* - * Various ways to acquire an HFS Node pointer: - */ -#define VTOH(VP) ((struct hfsnode *)((VP)->v_data)) -#define FCBTOH(FCB) ((struct hfsnode *)FCB) - -/* - * Various ways to acquire an FCB pointer: - */ -#define HTOFCB(HP) (HP) -#define VTOFCB(VP) ((FCB *)((VP)->v_data)) /* Should be the same as VTOH */ - /* * Various ways to acquire a VFS mount point pointer: */ -#define VTOVFS(VP) ((VP)->v_mount) -#define HTOVFS(HP) ((HP)->h_vp->v_mount) -#define FCBTOVFS(FCB) ((FCB)->h_vp->v_mount) +#define VTOVFS(VP) vnode_mount((VP)) #define HFSTOVFS(HFSMP) ((HFSMP)->hfs_mp) -#define VCBTOVFS(VCB) (((struct vfsVCB *)(VCB))->vcb_hfsmp->hfs_mp) +#define VCBTOVFS(VCB) HFSTOVFS(VCB) /* * Various ways to acquire an HFS mount point pointer: */ -#define VTOHFS(VP) ((struct hfsmount *)((VP)->v_mount->mnt_data)) -#define HTOHFS(HP) ((struct hfsmount *)(HP)->h_vp->v_mount->mnt_data) -#define FCBTOHFS(FCB) ((struct hfsmount *)(FCB)->h_vp->v_mount->mnt_data) -#define VFSTOHFS(MP) ((struct hfsmount *)(MP)->mnt_data) -#define VCBTOHFS(VCB) (((struct vfsVCB *)(VCB))->vcb_hfsmp) +#define VTOHFS(VP) ((struct hfsmount *)vfs_fsprivate(vnode_mount((VP)))) +#define VFSTOHFS(MP) ((struct hfsmount *)vfs_fsprivate((MP))) +#define VCBTOHFS(VCB) (VCB) +#define FCBTOHFS(FCB) ((struct hfsmount *)vfs_fsprivate(vnode_mount((FCB)->ff_cp->c_vp))) /* - * Various ways to acquire a VCB pointer: + * Various ways to acquire a VCB (legacy) pointer: */ -#define VTOVCB(VP) (&(((struct hfsmount *)((VP)->v_mount->mnt_data))->hfs_vcb.vcb_vcb)) -#define HTOVCB(HP) (&(((struct hfsmount *)((HP)->h_vp->v_mount->mnt_data))->hfs_vcb.vcb_vcb)) -#define FCBTOVCB(FCB) (&(((struct hfsmount *)((FCB)->h_vp->v_mount->mnt_data))->hfs_vcb.vcb_vcb)) -#define VFSTOVCB(MP) (&(((struct hfsmount *)(MP)->mnt_data)->hfs_vcb.vcb_vcb)) -#define HFSTOVCB(HFSMP) (&(HFSMP)->hfs_vcb.vcb_vcb) +#define VTOVCB(VP) VTOHFS(VP) +#define VFSTOVCB(MP) VFSTOHFS(MP) +#define HFSTOVCB(HFSMP) (HFSMP) +#define FCBTOVCB(FCB) FCBTOHFS(FCB) #define E_NONE 0 #define kHFSBlockSize 512 -#define IOBLKNOFORBLK(STARTINGBLOCK, BLOCKSIZEINBYTES) ((daddr_t)((STARTINGBLOCK) / ((BLOCKSIZEINBYTES) >> 9))) -#define IOBLKCNTFORBLK(STARTINGBLOCK, BYTESTOTRANSFER, BLOCKSIZEINBYTES) \ - ((int)(IOBLKNOFORBYTE(((STARTINGBLOCK) * 512) + (BYTESTOTRANSFER) - 1, (BLOCKSIZEINBYTES)) - \ - IOBLKNOFORBLK((STARTINGBLOCK), (BLOCKSIZEINBYTES)) + 1)) -#define IOBYTECCNTFORBLK(STARTINGBLOCK, BYTESTOTRANSFER, BLOCKSIZEINBYTES) \ - (IOBLKCNTFORBLK((STARTINGBLOCK),(BYTESTOTRANSFER),(BLOCKSIZEINBYTES)) * (BLOCKSIZEINBYTES)) -#define IOBYTEOFFSETFORBLK(STARTINGBLOCK, BLOCKSIZEINBYTES) \ - (((STARTINGBLOCK) * 512) - \ - (IOBLKNOFORBLK((STARTINGBLOCK), (BLOCKSIZEINBYTES)) * (BLOCKSIZEINBYTES))) +/* + * Macros for getting the MDB/VH sector and offset + */ +#define HFS_PRI_SECTOR(blksize) (1024 / (blksize)) +#define HFS_PRI_OFFSET(blksize) ((blksize) > 1024 ? 1024 : 0) -#define IOBLKNOFORBYTE(STARTINGBYTE, BLOCKSIZEINBYTES) ((daddr_t)((STARTINGBYTE) / (BLOCKSIZEINBYTES))) -#define IOBLKCNTFORBYTE(STARTINGBYTE, BYTESTOTRANSFER, BLOCKSIZEINBYTES) \ -((int)(IOBLKNOFORBYTE((STARTINGBYTE) + (BYTESTOTRANSFER) - 1, (BLOCKSIZEINBYTES)) - \ - IOBLKNOFORBYTE((STARTINGBYTE), (BLOCKSIZEINBYTES)) + 1)) -#define IOBYTECNTFORBYTE(STARTINGBYTE, BYTESTOTRANSFER, BLOCKSIZEINBYTES) \ - (IOBLKCNTFORBYTE((STARTINGBYTE),(BYTESTOTRANSFER),(BLOCKSIZEINBYTES)) * (BLOCKSIZEINBYTES)) -#define IOBYTEOFFSETFORBYTE(STARTINGBYTE, BLOCKSIZEINBYTES) ((STARTINGBYTE) - (IOBLKNOFORBYTE((STARTINGBYTE), (BLOCKSIZEINBYTES)) * (BLOCKSIZEINBYTES))) +#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) -#define HFS_PRI_SECTOR(blksize) (1024 / (blksize)) -#define HFS_PRI_OFFSET(blksize) ((blksize) > 1024 ? 1024 : 0) +/* + * 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) +#define HFS_EXT_BULKACCESS (FCNTL_FS_SPECIFIC_BASE + 0x00006) -#define HFS_ALT_SECTOR(blksize, blkcnt) (((blkcnt) - 1) - (512 / (blksize))) -#define HFS_ALT_OFFSET(blksize) ((blksize) > 1024 ? (blksize) - 1024 : 0) -#define MAKE_VREFNUM(x) ((int32_t)((x) & 0xffff)) /* * This is the straight GMT conversion constant: * 00:00:00 January 1, 1970 - 00:00:00 January 1, 1904 @@ -690,109 +531,265 @@ struct hfsfid { */ #define MAC_GMT_FACTOR 2082844800UL -#define HFS_ATTR_CMN_LOOKUPMASK (ATTR_CMN_SCRIPT | ATTR_CMN_FNDRINFO | ATTR_CMN_NAMEDATTRCOUNT | ATTR_CMN_NAMEDATTRLIST) -#define HFS_ATTR_DIR_LOOKUPMASK (ATTR_DIR_LINKCOUNT | ATTR_DIR_ENTRYCOUNT) -#define HFS_ATTR_FILE_LOOKUPMASK (ATTR_FILE_LINKCOUNT | ATTR_FILE_TOTALSIZE | ATTR_FILE_ALLOCSIZE | \ - ATTR_FILE_DATALENGTH | ATTR_FILE_DATAALLOCSIZE | ATTR_FILE_DATAEXTENTS | \ - ATTR_FILE_RSRCLENGTH | ATTR_FILE_RSRCALLOCSIZE | ATTR_FILE_RSRCEXTENTS) -u_int32_t to_bsd_time(u_int32_t hfs_time); -u_int32_t to_hfs_time(u_int32_t bsd_time); +/***************************************************************************** + 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_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 -int hfs_flushfiles(struct mount *mp, int flags); -short hfs_flushMDB(struct hfsmount *hfsmp, int waitfor); -short hfs_flushvolumeheader(struct hfsmount *hfsmp, int waitfor); -short hfs_getcatalog (ExtendedVCB *vcb, u_int32_t dirID, char *name, short len, hfsCatalogInfo *catInfo); -short hfsMoveRename (ExtendedVCB *vcb, u_int32_t oldDirID, char *oldName, u_int32_t newDirID, char *newName, u_int32_t *hint); -short hfsCreate (ExtendedVCB *vcb, u_int32_t dirID, char *name, int mode, u_int32_t tehint); -short hfsCreateFileID (ExtendedVCB *vcb, u_int32_t parentDirID, StringPtr name, u_int32_t catalogHint, u_int32_t *fileIDPtr); -short hfs_vcreate (ExtendedVCB *vcb, hfsCatalogInfo *catInfo, u_int8_t forkType, struct vnode **vpp); -short hfsDelete (ExtendedVCB *vcb, u_int32_t parentDirID, StringPtr name, short isfile, u_int32_t catalogHint); -short hfsUnmount(struct hfsmount *hfsmp, struct proc *p); +/***************************************************************************** + Functions from MacOSStubs.c +******************************************************************************/ +time_t to_bsd_time(u_int32_t hfs_time); -extern int hfs_metafilelocking(struct hfsmount *hfsmp, u_long fileID, u_int flags, struct proc *p); -extern int hasOverflowExtents(struct hfsnode *hp); +u_int32_t to_hfs_time(time_t bsd_time); -void hfs_set_metaname(char *, struct hfsfilemeta *, struct hfsmount *); -short MacToVFSError(OSErr err); -int hfs_owner_rights(struct vnode *vp, struct ucred *cred, struct proc *p, Boolean invokesuperuserstatus); - -void CopyVNodeToCatalogNode (struct vnode *vp, struct CatalogNodeData *nodeData); -void CopyCatalogToHFSNode(struct hfsCatalogInfo *catalogInfo, struct hfsnode *hp); -u_long FindMetaDataDirectory(ExtendedVCB *vcb); - - -short make_dir_entry(FCB **fileptr, char *name, u_int32_t fileID); - -int AttributeBlockSize(struct attrlist *attrlist); -void PackCommonAttributeBlock(struct attrlist *alist, - struct vnode *vp, - struct hfsCatalogInfo *catInfo, - void **attrbufptrptr, - void **varbufptrptr); -void PackVolAttributeBlock(struct attrlist *alist, - struct vnode *vp, - struct hfsCatalogInfo *catInfo, - void **attrbufptrptr, - void **varbufptrptr); -void PackFileDirAttributeBlock(struct attrlist *alist, - struct vnode *vp, - struct hfsCatalogInfo *catInfo, - void **attrbufptrptr, - void **varbufptrptr); -void PackForkAttributeBlock(struct attrlist *alist, - struct vnode *vp, - struct hfsCatalogInfo *catInfo, - void **attrbufptrptr, - void **varbufptrptr); -void PackAttributeBlock(struct attrlist *alist, - struct vnode *vp, - struct hfsCatalogInfo *catInfo, - void **attrbufptrptr, - void **varbufptrptr); -void PackCatalogInfoAttributeBlock (struct attrlist *alist, - struct vnode * root_vp, - struct hfsCatalogInfo *catInfo, - void **attrbufptrptr, - void **varbufptrptr); -void UnpackCommonAttributeBlock(struct attrlist *alist, - struct vnode *vp, - struct hfsCatalogInfo *catInfo, - void **attrbufptrptr, - void **varbufptrptr); -void UnpackAttributeBlock(struct attrlist *alist, - struct vnode *vp, - struct hfsCatalogInfo *catInfo, - void **attrbufptrptr, - void **varbufptrptr); -unsigned long BestBlockSizeFit(unsigned long allocationBlockSize, - unsigned long blockSizeLimit, - unsigned long baseMultiple); +/***************************************************************************** + Functions from hfs_encodinghint.c +******************************************************************************/ +u_int32_t hfs_pickencoding(const u_int16_t *src, int len); -OSErr hfs_MountHFSVolume(struct hfsmount *hfsmp, HFSMasterDirectoryBlock *mdb, - struct proc *p); -OSErr hfs_MountHFSPlusVolume(struct hfsmount *hfsmp, HFSPlusVolumeHeader *vhp, - off_t embeddedOffset, off_t disksize, struct proc *p); -OSStatus GetInitializedVNode(struct hfsmount *hfsmp, struct vnode **tmpvnode); +u_int32_t hfs_getencodingbias(void); + +void hfs_setencodingbias(u_int32_t bias); + + +/***************************************************************************** + 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); + +int unicode_to_hfs(ExtendedVCB *vcb, ByteCount srcLen, u_int16_t* srcStr, Str31 dstStr, int retry); + + +/***************************************************************************** + Functions from hfs_notifications.c +******************************************************************************/ +void hfs_generate_volume_notifications(struct hfsmount *hfsmp); + + +/***************************************************************************** + Functions from hfs_readwrite.c +******************************************************************************/ +extern int hfs_relocate(struct vnode *, u_int32_t, kauth_cred_t, struct proc *); + +extern int hfs_truncate(struct vnode *, off_t, int, int, int, vfs_context_t); + +extern int hfs_bmap(struct vnode *, daddr_t, struct vnode **, daddr64_t *, unsigned int *); + +extern int hfs_fsync(struct vnode *, int, int, struct proc *); + +extern int hfs_access(struct vnode *, mode_t, kauth_cred_t, struct proc *); + +extern int hfs_removeallattr(struct hfsmount *hfsmp, u_int32_t fileid); + +extern int hfs_set_volxattr(struct hfsmount *hfsmp, unsigned int xattrtype, int state); + +extern void hfs_check_volxattr(struct hfsmount *hfsmp, unsigned int xattrtype); + +extern int hfs_isallocated(struct hfsmount *, u_int32_t, u_int32_t); + + +/***************************************************************************** + 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); + +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); + +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 *); + +/* 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); + + +/* HFS System file locking */ +#define SFL_CATALOG 0x0001 +#define SFL_EXTENTS 0x0002 +#define SFL_BITMAP 0x0004 +#define SFL_ATTRIBUTE 0x0008 +#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); + +/* 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); +extern void hfs_sync_ejectable(struct hfsmount *hfsmp); + +/* Erase unused Catalog nodes due to . */ +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_unlinked); + +extern int hfs_update(struct vnode *, int); + + +/***************************************************************************** + Functions from hfs_xattr.c +******************************************************************************/ +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); + + + +/***************************************************************************** + 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_lookuplink(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__ */