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

/*
 * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_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 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.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */

#ifndef __HFS__
#define __HFS__

#define HFS_SPARSE_DEV 1

#include <sys/appleapiopts.h>

#ifdef KERNEL
#ifdef __APPLE_API_PRIVATE
#include <sys/param.h>
#include <sys/queue.h>
#include <sys/mount.h>
#include <sys/vnode.h>
#include <sys/quota.h>
#include <sys/dirent.h>
#include <sys/event.h>

#include <kern/locks.h>

#include <vfs/vfs_journal.h>

#include <hfs/hfs_format.h>
#include <hfs/hfs_catalog.h>
#include <hfs/hfs_cnode.h>
#include <hfs/hfs_macos_defs.h>
#include <hfs/hfs_encodings.h>
#include <hfs/hfs_hotfiles.h>

/*
 *	Just reported via MIG interface.
 */
#define VERSION_STRING	"hfs-2 (4-12-99)"

#define HFS_LINK_MAX	32767

#define HFS_MAX_DEFERED_ALLOC	(1024*1024)

// 32 gigs 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 (32LL * 1024LL * 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 */

#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' */
};


extern struct timezone gTimeZone;


/* How many free extents to cache per volume */
#define kMaxFreeExtents		10

/*
 * 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.
 */
#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_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))

/* 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 */

	/* Access to VFS and devices */
	struct mount		*hfs_mp;				/* filesystem vfs structure */
	struct vnode		*hfs_devvp;				/* block device mounted vnode */
	struct vnode *		hfs_extents_vp;
	struct vnode *		hfs_catalog_vp;
	struct vnode *		hfs_allocation_vp;
	struct vnode *		hfs_attribute_vp;
	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 */	

	/* 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     vcbNxtCNID;         /* next unused catalog node ID */
	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;
	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 */
	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 */
	struct cat_desc		hfs_privdir_desc;
	struct cat_attr		hfs_privdir_attr;
	u_int32_t		hfs_metadata_createdate;
	hfs_to_unicode_func_t	hfs_get_unicode;
	unicode_to_hfs_func_t	hfs_get_hfsname;
 
	/* 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: */
	unsigned long		hfs_notification_conditions;
	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;
	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;
	int            hfs_sparsebandblks;
#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 */
	lck_rw_t       hfs_insync;     /* protects sync/freeze interaction */
} hfsmount_t;

typedef hfsmount_t  ExtendedVCB;

/* Aliases for legacy 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


/* 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_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_done(&(hfsmp)->hfs_global_lock)


#define MAXHFSVNODELEN		31


typedef struct filefork FCB;


#define MAKE_INODE_NAME(name,linkno) \
	    (void) sprintf((name), "%s%d", HFS_INODE_PREFIX, (linkno))

#define HFS_INODE_PREFIX_LEN	5


#define HFS_AVERAGE_NAME_SIZE	22
#define AVERAGE_HFSDIRENTRY_SIZE  (8+HFS_AVERAGE_NAME_SIZE+4)

#define STD_DIRENT_LEN(namlen) \
	((sizeof(struct dirent) - (NAME_MAX+1)) + (((namlen)+1 + 3) &~ 3))

#define EXT_DIRENT_LEN(namlen) \
	((sizeof(struct direntry) + (namlen) - (MAXPATHLEN-1) + 3) & ~3)


enum { kHFSPlusMaxFileNameBytes = kHFSPlusMaxFileNameChars * 3 };


/* macro to determine if hfs or hfsplus */
#define ISHFSPLUS(VCB) ((VCB)->vcbSigWord == kHFSPlusSigWord)
#define ISHFS(VCB) ((VCB)->vcbSigWord == kHFSSigWord)


/*
 * Various ways to acquire a VFS mount point pointer:
 */
#define VTOVFS(VP)  vnode_mount((VP))
#define HFSTOVFS(HFSMP) ((HFSMP)->hfs_mp)
#define VCBTOVFS(VCB)   HFSTOVFS(VCB)

/*
 * Various ways to acquire an HFS mount point pointer:
 */
#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 (legacy) pointer:
 */
#define VTOVCB(VP)       VTOHFS(VP)
#define VFSTOVCB(MP)     VFSTOHFS(MP)
#define HFSTOVCB(HFSMP)  (HFSMP)
#define FCBTOVCB(FCB)    FCBTOHFS(FCB)


#define HFS_KNOTE(vp, hint) KNOTE(&VTOC(vp)->c_knotes, (hint))


#define E_NONE	0
#define kHFSBlockSize 512

/*
 * 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 HFS_ALT_SECTOR(blksize, blkcnt)  (((blkcnt) - 1) - (512 / (blksize)))
#define HFS_ALT_OFFSET(blksize)          ((blksize) > 1024 ? (blksize) - 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)


/*
 *	This is the straight GMT conversion constant:
 *	00:00:00 January 1, 1970 - 00:00:00 January 1, 1904
 *	(3600 * 24 * ((365 * (1970 - 1904)) + (((1970 - 1904) / 4) + 1)))
 */
#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);

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);

#define  kMaxSecsForFsync	5
#define  HFS_SYNCTRANS		1

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);


unsigned long BestBlockSizeFit(unsigned long allocationBlockSize,
                               unsigned long blockSizeLimit,
                               unsigned long 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     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);

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,
		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,
		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);

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 void hfs_setencodingbits(struct hfsmount *hfsmp, u_int32_t encoding);


extern void replace_desc(struct cnode *cp, struct cat_desc *cdp);

extern int hfs_namecmp(const char *, size_t, const char *, size_t);

extern int  hfs_virtualmetafile(struct cnode *);

void hfs_generate_volume_notifications(struct hfsmount *hfsmp);

__private_extern__ u_int32_t hfs_getencodingbias(void);
__private_extern__ void hfs_setencodingbias(u_int32_t bias);

extern int hfs_vgetrsrc(struct hfsmount *hfsmp, struct vnode *vp,
			struct vnode **rvpp, struct proc *p);

extern int hfs_update(struct vnode *, int);

extern int hfs_truncate(struct vnode *, off_t, int, int, vfs_context_t);

extern int hfs_fsync(struct vnode *, int, int, struct proc *);

extern int hfs_access(struct vnode *, mode_t, struct ucred *, struct proc *);

extern int hfs_vget(struct hfsmount *, cnid_t, struct vnode **, int);

extern int hfs_bmap(struct vnode *, daddr_t, struct vnode **, daddr64_t *, int *);

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);

extern int  hfs_setextendedsecurity(struct hfsmount *hfsmp, int state);
extern void hfs_checkextendedsecurity(struct hfsmount *hfsmp);

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_isallocated(struct hfsmount *, u_long, u_long);


/* HFS System file locking */
#define SFL_CATALOG     0x0001
#define SFL_EXTENTS     0x0002
#define SFL_BITMAP      0x0004
#define SFL_ATTRIBUTE   0x0008
#define SFL_VALIDMASK   (SFL_CATALOG | SFL_EXTENTS | SFL_BITMAP | SFL_ATTRIBUTE)

extern int  hfs_systemfile_lock(struct hfsmount *, int, enum hfslocktype);
extern void hfs_systemfile_unlock(struct hfsmount *, int);

#endif /* __APPLE_API_PRIVATE */
#endif /* KERNEL */
#endif /* __HFS__ */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
6601e61a	4	* @APPLE_LICENSE_HEADER_START@
1c79356b	5	*
6601e61a A	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
8f6c56a5	11	*
6601e61a A	12	* This Original Code and all software distributed under the License are
6601e61a A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
6601e61a A	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
8f6c56a5	19	*
6601e61a	20	* @APPLE_LICENSE_HEADER_END@
1c79356b	21	*/
1c79356b A	22
	23	#ifndef __HFS__
	24	#define __HFS__
	25
55e303ae A	26	#define HFS_SPARSE_DEV 1
55e303ae A	27
9bccf70c A	28	#include <sys/appleapiopts.h>
	29
	30	#ifdef KERNEL
	31	#ifdef __APPLE_API_PRIVATE
1c79356b	32	#include <sys/param.h>
1c79356b	33	#include <sys/queue.h>
9bccf70c	34	#include <sys/mount.h>
9bccf70c A	35	#include <sys/vnode.h>
9bccf70c A	36	#include <sys/quota.h>
1c79356b	37	#include <sys/dirent.h>
55e303ae	38	#include <sys/event.h>
1c79356b	39
91447636 A	40	#include <kern/locks.h>
91447636 A	41
b4c24cb9 A	42	#include <vfs/vfs_journal.h>
b4c24cb9 A	43
1c79356b	44	#include <hfs/hfs_format.h>
9bccf70c A	45	#include <hfs/hfs_catalog.h>
9bccf70c A	46	#include <hfs/hfs_cnode.h>
1c79356b A	47	#include <hfs/hfs_macos_defs.h>
1c79356b A	48	#include <hfs/hfs_encodings.h>
55e303ae	49	#include <hfs/hfs_hotfiles.h>
1c79356b	50
1c79356b A	51	/*
	52	* Just reported via MIG interface.
	53	*/
	54	#define VERSION_STRING "hfs-2 (4-12-99)"
	55
	56	#define HFS_LINK_MAX 32767
	57
9bccf70c A	58	#define HFS_MAX_DEFERED_ALLOC (1024*1024)
9bccf70c A	59
6601e61a	60	// 32 gigs is a "big" file (i.e. one that when deleted
55e303ae A	61	// would touch enough data that we should break it into
55e303ae A	62	// multiple separate transactions
6601e61a	63	#define HFS_BIGFILE_SIZE (32LL * 1024LL * 1024LL * 1024LL)
55e303ae	64
1c79356b A	65
	66	enum { kMDBSize = 512 }; /* Size of I/O transfer to read entire MDB */
	67
	68	enum { kMasterDirectoryBlock = 2 }; /* MDB offset on disk in 512-byte blocks */
	69	enum { kMDBOffset = kMasterDirectoryBlock * 512 }; /* MDB offset on disk in bytes */
	70
91447636	71	#define kRootDirID kHFSRootFolderID
1c79356b	72
1c79356b	73
0b4e3aa0 A	74	/* number of locked buffer caches to hold for b-tree meta data */
0b4e3aa0 A	75	#define kMaxLockedMetaBuffers 32
1c79356b A	76
	77	/*
	78	* File type and creator for symbolic links
	79	*/
	80	enum {
9bccf70c A	81	kSymLinkFileType = 0x736C6E6B, /* 'slnk' */
9bccf70c A	82	kSymLinkCreator = 0x72686170 /* 'rhap' */
1c79356b A	83	};
1c79356b A	84
1c79356b A	85
	86	extern struct timezone gTimeZone;
	87
1c79356b	88
0b4e3aa0 A	89	/* How many free extents to cache per volume */
	90	#define kMaxFreeExtents 10
	91
9bccf70c A	92	/*
	93	* HFS_MINFREE gives the minimum acceptable percentage
	94	* of file system blocks which may be free (but this
	95	* minimum will never exceed HFS_MAXRESERVE bytes). If
	96	* the free block count drops below this level only the
	97	* superuser may continue to allocate blocks.
	98	*/
	99	#define HFS_MINFREE 1
55e303ae A	100	#define HFS_MAXRESERVE ((u_int64_t)(25010241024))
	101
	102	/*
	103	* The system distinguishes between the desirable low-disk
	104	* notifiaction levels for root volumes and non-root volumes.
	105	* The various thresholds are computed as a fraction of the
	106	* volume size, all capped at a certain fixed level
	107	*/
	108
	109	#define HFS_ROOTLOWDISKTRIGGERFRACTION 5
	110	#define HFS_ROOTLOWDISKTRIGGERLEVEL ((u_int64_t)(25010241024))
	111	#define HFS_ROOTLOWDISKSHUTOFFFRACTION 6
	112	#define HFS_ROOTLOWDISKSHUTOFFLEVEL ((u_int64_t)(37510241024))
	113
	114	#define HFS_LOWDISKTRIGGERFRACTION 1
	115	#define HFS_LOWDISKTRIGGERLEVEL ((u_int64_t)(5010241024))
	116	#define HFS_LOWDISKSHUTOFFFRACTION 2
	117	#define HFS_LOWDISKSHUTOFFLEVEL ((u_int64_t)(7510241024))
9bccf70c	118
1c79356b A	119	/* Internal Data structures*/
1c79356b A	120
0b4e3aa0	121
9bccf70c	122	#define kHFS_DamagedVolume 0x1 /* This volume has errors, unmount dirty */
1c79356b	123
9bccf70c A	124	/* XXX */
9bccf70c A	125	#define MARK_VOLUMEDAMAGED(fcb)
1c79356b	126
1c79356b A	127
	128	/* This structure describes the HFS specific mount structure data. */
	129	typedef struct hfsmount {
91447636 A	130	u_int32_t hfs_flags; /* see below */
91447636 A	131
1c79356b	132	/* Physical Description */
91447636 A	133	u_long hfs_phys_block_size; /* Always a multiple of 512 */
	134	daddr64_t hfs_phys_block_count; /* Num of PHYSICAL blocks of volume */
	135	daddr64_t hfs_alt_id_sector; /* location of alternate VH/MDB */
1c79356b A	136
	137	/* Access to VFS and devices */
	138	struct mount hfs_mp; / filesystem vfs structure */
	139	struct vnode hfs_devvp; / block device mounted vnode */
91447636 A	140	struct vnode * hfs_extents_vp;
	141	struct vnode * hfs_catalog_vp;
	142	struct vnode * hfs_allocation_vp;
	143	struct vnode * hfs_attribute_vp;
	144	dev_t hfs_raw_dev; /* device mounted */
	145	u_int32_t hfs_logBlockSize; /* Size of buffer cache buffer for I/O */
1c79356b A	146
1c79356b A	147	/* Default values for HFS standard and non-init access */
91447636 A	148	uid_t hfs_uid; /* uid to set as owner of the files */
	149	gid_t hfs_gid; /* gid to set as owner of the files */
	150	mode_t hfs_dir_mask; /* mask to and with directory protection bits */
	151	mode_t hfs_file_mask; /* mask to and with file protection bits */
	152	u_long hfs_encoding; /* Defualt encoding for non hfs+ volumes */
	153
	154	/* Persistent fields (on disk, dynamic) */
	155	time_t hfs_mtime; /* file system last modification time */
	156	u_int32_t hfs_filecount; /* number of files in file system */
	157	u_int32_t hfs_dircount; /* number of directories in file system */
	158	u_int32_t freeBlocks; /* free allocation blocks */
	159	u_int32_t nextAllocation; /* start of next allocation search */
	160	u_int32_t vcbNxtCNID; /* next unused catalog node ID */
	161	u_int32_t vcbWrCnt; /* file system write count */
	162	u_int64_t encodingsBitmap; /* in-use encodings */
	163	u_int16_t vcbNmFls; /* HFS Only - root dir file count */
	164	u_int16_t vcbNmRtDirs; /* HFS Only - root dir directory count */
	165
	166	/* Persistent fields (on disk, static) */
	167	u_int16_t vcbSigWord;
	168	int16_t vcbFlags;
	169	u_int32_t vcbAtrb;
	170	u_int32_t vcbJinfoBlock;
	171	time_t hfs_itime; /* file system creation time */
	172	time_t hfs_btime; /* file system last backup time */
	173	u_int32_t blockSize; /* size of allocation blocks */
	174	u_int32_t totalBlocks; /* total allocation blocks */
	175	int32_t vcbClpSiz;
	176	u_int32_t vcbFndrInfo[8];
	177	int16_t vcbVBMSt; /* HFS only */
	178	int16_t vcbAlBlSt; /* HFS only */
	179
	180	/* vcb stuff */
	181	u_int8_t vcbVN[256]; /* volume name in UTF-8 */
	182	u_int32_t volumeNameEncodingHint;
	183	u_int32_t hfsPlusIOPosOffset; /* Disk block where HFS+ starts */
	184	u_int32_t vcbVBMIOSize; /* volume bitmap I/O size */
	185
	186	/* cache of largest known free extents */
	187	u_int32_t vcbFreeExtCnt;
	188	HFSPlusExtentDescriptor vcbFreeExt[kMaxFreeExtents];
	189
	190	u_int32_t reserveBlocks; /* free block reserve */
	191	u_int32_t loanedBlocks; /* blocks on loan for delayed allocations */
	192
	193	u_int32_t localCreateDate; /* creation times for HFS+ volumes are in local time */
9bccf70c A	194	struct cat_desc hfs_privdir_desc;
9bccf70c A	195	struct cat_attr hfs_privdir_attr;
1c79356b A	196	u_int32_t hfs_metadata_createdate;
	197	hfs_to_unicode_func_t hfs_get_unicode;
	198	unicode_to_hfs_func_t hfs_get_hfsname;
9bccf70c	199
55e303ae	200	/* Quota variables: */
9bccf70c	201	struct quotafile hfs_qfiles[MAXQUOTAS]; /* quota files */
b4c24cb9	202
55e303ae	203	/* Journaling variables: */
b4c24cb9 A	204	void *jnl; // the journal for this volume (if one exists)
	205	struct vnode *jvp; // device where the journal lives (may be equal to devvp)
	206	u_int32_t jnl_start; // start block of the journal file (so we don't delete it)
55e303ae	207	u_int32_t jnl_size;
b4c24cb9 A	208	u_int32_t hfs_jnlfileid;
b4c24cb9 A	209	u_int32_t hfs_jnlinfoblkid;
91447636 A	210	lck_rw_t hfs_global_lock;
91447636 A	211	u_int32_t hfs_global_lock_nesting;
55e303ae A	212
	213	/* Notification variables: */
	214	unsigned long hfs_notification_conditions;
	215	u_int32_t hfs_freespace_notify_warninglimit;
	216	u_int32_t hfs_freespace_notify_desiredlevel;
	217
91447636 A	218	/* time mounted and last mounted mod time "snapshot" */
	219	time_t hfs_mount_time;
	220	time_t hfs_last_mounted_mtime;
	221
55e303ae A	222	/* Metadata allocation zone variables: */
	223	u_int32_t hfs_metazone_start;
	224	u_int32_t hfs_metazone_end;
	225	u_int32_t hfs_hotfile_start;
	226	u_int32_t hfs_hotfile_end;
	227	int hfs_hotfile_freeblks;
	228	int hfs_hotfile_maxblks;
	229	int hfs_overflow_maxblks;
	230	int hfs_catalog_maxblks;
	231
	232	/* Hot File Clustering variables: */
91447636	233	lck_mtx_t hfc_mutex; /* serialize hot file stages */
55e303ae A	234	enum hfc_stage hfc_stage; /* what are we up to... */
	235	time_t hfc_timebase; /* recording period start time */
	236	time_t hfc_timeout; /* recording period stop time */
	237	void * hfc_recdata; /* recording data (opaque) */
	238	int hfc_maxfiles; /* maximum files to track */
	239	struct vnode * hfc_filevp;
	240
	241	#ifdef HFS_SPARSE_DEV
	242	/* Sparse device variables: */
	243	struct vnode * hfs_backingfs_rootvp;
	244	int hfs_sparsebandblks;
	245	#endif
91447636 A	246	size_t hfs_max_inline_attrsize;
	247
	248	lck_mtx_t hfs_mutex; /* protects access to hfsmount data */
	249	void hfs_freezing_proc; / who froze the fs */
3a60a9f5	250	lck_rw_t hfs_insync; /* protects sync/freeze interaction */
1c79356b A	251	} hfsmount_t;
1c79356b A	252
91447636 A	253	typedef hfsmount_t ExtendedVCB;
	254
	255	/* Aliases for legacy field names */
	256	#define vcbCrDate hfs_itime
	257	#define vcbLsMod hfs_mtime
	258	#define vcbVolBkUp hfs_btime
	259	#define extentsRefNum hfs_extents_vp
	260	#define catalogRefNum hfs_catalog_vp
	261	#define allocationsRefNum hfs_allocation_vp
	262	#define vcbFilCnt hfs_filecount
	263	#define vcbDirCnt hfs_dircount
	264
55e303ae A	265
	266	/* HFS mount point flags */
	267	#define HFS_READ_ONLY 0x001
	268	#define HFS_UNKNOWN_PERMS 0x002
	269	#define HFS_WRITEABLE_MEDIA 0x004
	270	#define HFS_CLEANED_ORPHANS 0x008
	271	#define HFS_X 0x010
	272	#define HFS_CASE_SENSITIVE 0x020
	273	#define HFS_STANDARD 0x040
	274	#define HFS_METADATA_ZONE 0x080
	275	#define HFS_FRAGMENTED_FREESPACE 0x100
	276	#define HFS_NEED_JNL_RESET 0x200
55e303ae	277	#define HFS_HAS_SPARSE_DEVICE 0x400
55e303ae	278
1c79356b	279
91447636 A	280	#define HFS_MOUNT_LOCK(hfsmp, metadata) \
	281	{ \
	282	if ((metadata) && 1) \
	283	lck_mtx_lock(&(hfsmp)->hfs_mutex); \
	284	} \
	285
	286	#define HFS_MOUNT_UNLOCK(hfsmp, metadata) \
	287	{ \
	288	if ((metadata) && 1) \
	289	lck_mtx_unlock(&(hfsmp)->hfs_mutex); \
	290	} \
	291
	292	#define hfs_global_exclusive_lock_acquire(hfsmp) lck_rw_lock_exclusive(&(hfsmp)->hfs_global_lock)
	293	#define hfs_global_exclusive_lock_release(hfsmp) lck_rw_done(&(hfsmp)->hfs_global_lock)
	294
b4c24cb9	295
1c79356b	296	#define MAXHFSVNODELEN 31
1c79356b	297
1c79356b	298
9bccf70c	299	typedef struct filefork FCB;
1c79356b	300
1c79356b A	301
	302	#define MAKE_INODE_NAME(name,linkno) \
	303	(void) sprintf((name), "%s%d", HFS_INODE_PREFIX, (linkno))
	304
743b1565	305	#define HFS_INODE_PREFIX_LEN 5
1c79356b	306
1c79356b	307
9bccf70c A	308	#define HFS_AVERAGE_NAME_SIZE 22
9bccf70c A	309	#define AVERAGE_HFSDIRENTRY_SIZE (8+HFS_AVERAGE_NAME_SIZE+4)
1c79356b	310
91447636 A	311	#define STD_DIRENT_LEN(namlen) \
91447636 A	312	((sizeof(struct dirent) - (NAME_MAX+1)) + (((namlen)+1 + 3) &~ 3))
1c79356b	313
91447636 A	314	#define EXT_DIRENT_LEN(namlen) \
91447636 A	315	((sizeof(struct direntry) + (namlen) - (MAXPATHLEN-1) + 3) & ~3)
1c79356b	316
1c79356b A	317
	318	enum { kHFSPlusMaxFileNameBytes = kHFSPlusMaxFileNameChars * 3 };
	319
1c79356b A	320
	321	/* macro to determine if hfs or hfsplus */
	322	#define ISHFSPLUS(VCB) ((VCB)->vcbSigWord == kHFSPlusSigWord)
	323	#define ISHFS(VCB) ((VCB)->vcbSigWord == kHFSSigWord)
	324
	325
1c79356b A	326	/*
	327	* Various ways to acquire a VFS mount point pointer:
	328	*/
91447636	329	#define VTOVFS(VP) vnode_mount((VP))
1c79356b	330	#define HFSTOVFS(HFSMP) ((HFSMP)->hfs_mp)
91447636	331	#define VCBTOVFS(VCB) HFSTOVFS(VCB)
1c79356b A	332
	333	/*
	334	* Various ways to acquire an HFS mount point pointer:
	335	*/
91447636 A	336	#define VTOHFS(VP) ((struct hfsmount *)vfs_fsprivate(vnode_mount((VP))))
	337	#define VFSTOHFS(MP) ((struct hfsmount *)vfs_fsprivate((MP)))
	338	#define VCBTOHFS(VCB) (VCB)
	339	#define FCBTOHFS(FCB) ((struct hfsmount *)vfs_fsprivate(vnode_mount((FCB)->ff_cp->c_vp)))
1c79356b A	340
1c79356b A	341	/*
91447636	342	* Various ways to acquire a VCB (legacy) pointer:
1c79356b	343	*/
91447636 A	344	#define VTOVCB(VP) VTOHFS(VP)
	345	#define VFSTOVCB(MP) VFSTOHFS(MP)
	346	#define HFSTOVCB(HFSMP) (HFSMP)
	347	#define FCBTOVCB(FCB) FCBTOHFS(FCB)
1c79356b A	348
1c79356b A	349
55e303ae A	350	#define HFS_KNOTE(vp, hint) KNOTE(&VTOC(vp)->c_knotes, (hint))
	351
	352
1c79356b A	353	#define E_NONE 0
1c79356b A	354	#define kHFSBlockSize 512
1c79356b	355
9bccf70c A	356	/*
	357	* Macros for getting the MDB/VH sector and offset
	358	*/
	359	#define HFS_PRI_SECTOR(blksize) (1024 / (blksize))
	360	#define HFS_PRI_OFFSET(blksize) ((blksize) > 1024 ? 1024 : 0)
d52fe63f A	361
	362	#define HFS_ALT_SECTOR(blksize, blkcnt) (((blkcnt) - 1) - (512 / (blksize)))
	363	#define HFS_ALT_OFFSET(blksize) ((blksize) > 1024 ? (blksize) - 1024 : 0)
	364
91447636 A	365
	366	/*
	367	* HFS specific fcntl()'s
	368	*/
	369	#define HFS_BULKACCESS (FCNTL_FS_SPECIFIC_BASE + 0x00001)
	370	#define HFS_GET_MOUNT_TIME (FCNTL_FS_SPECIFIC_BASE + 0x00002)
	371	#define HFS_GET_LAST_MTIME (FCNTL_FS_SPECIFIC_BASE + 0x00003)
	372	#define HFS_GET_BOOT_INFO (FCNTL_FS_SPECIFIC_BASE + 0x00004)
	373	#define HFS_SET_BOOT_INFO (FCNTL_FS_SPECIFIC_BASE + 0x00005)
	374
	375
1c79356b A	376	/*
	377	* This is the straight GMT conversion constant:
	378	* 00:00:00 January 1, 1970 - 00:00:00 January 1, 1904
	379	* (3600 * 24 * ((365 * (1970 - 1904)) + (((1970 - 1904) / 4) + 1)))
	380	*/
	381	#define MAC_GMT_FACTOR 2082844800UL
	382
1c79356b	383
91447636 A	384	time_t to_bsd_time(u_int32_t hfs_time);
91447636 A	385	u_int32_t to_hfs_time(time_t bsd_time);
1c79356b	386
9bccf70c A	387	int hfs_flushvolumeheader(struct hfsmount *hfsmp, int waitfor, int altflush);
9bccf70c A	388	#define HFS_ALTFLUSH 1
1c79356b	389
55e303ae	390	extern int hfsUnmount(struct hfsmount hfsmp, struct proc p);
1c79356b	391
91447636	392	extern int hfs_getnewvnode(struct hfsmount hfsmp, struct vnode dvp, struct componentname *cnp,
9bccf70c A	393	struct cat_desc descp, int wantrsrc, struct cat_attr attrp,
	394	struct cat_fork forkp, struct vnode *vpp);
	395
9bccf70c A	396	extern u_int32_t hfs_freeblks(struct hfsmount * hfsmp, int wantreserve);
9bccf70c A	397
b4c24cb9 A	398	extern void hfs_remove_orphans(struct hfsmount *);
b4c24cb9 A	399
1c79356b A	400
1c79356b A	401	short MacToVFSError(OSErr err);
1c79356b	402
9bccf70c A	403	extern int hfs_owner_rights(struct hfsmount hfsmp, uid_t cnode_uid, struct ucred cred,
	404	struct proc *p, int invokesuperuserstatus);
	405
1c79356b A	406	u_long FindMetaDataDirectory(ExtendedVCB *vcb);
1c79356b A	407
9bccf70c A	408	#define kMaxSecsForFsync 5
	409	#define HFS_SYNCTRANS 1
	410
	411	extern int hfs_btsync(struct vnode *vp, int sync_transaction);
b4c24cb9 A	412	// used as a callback by the journaling code
b4c24cb9 A	413	extern void hfs_sync_metadata(void *arg);
1c79356b A	414
	415	short make_dir_entry(FCB *fileptr, char name, u_int32_t fileID);
	416
9bccf70c	417
1c79356b A	418	unsigned long BestBlockSizeFit(unsigned long allocationBlockSize,
	419	unsigned long blockSizeLimit,
	420	unsigned long baseMultiple);
	421
	422	OSErr hfs_MountHFSVolume(struct hfsmount hfsmp, HFSMasterDirectoryBlock mdb,
d52fe63f	423	struct proc *p);
1c79356b	424	OSErr hfs_MountHFSPlusVolume(struct hfsmount hfsmp, HFSPlusVolumeHeader vhp,
91447636	425	off_t embeddedOffset, u_int64_t disksize, struct proc p, void args, kauth_cred_t cred);
b4c24cb9 A	426
b4c24cb9 A	427	extern int hfs_early_journal_init(struct hfsmount hfsmp, HFSPlusVolumeHeader vhp,
91447636	428	void *_args, off_t embeddedOffset, daddr64_t mdb_offset,
b4c24cb9	429	HFSMasterDirectoryBlock mdbp, struct ucred cred);
91447636 A	430	extern u_long GetFileInfo(ExtendedVCB vcb, u_int32_t dirid, const char name,
91447636 A	431	struct cat_attr fattr, struct cat_fork forkinfo);
1c79356b A	432
	433	int hfs_getconverter(u_int32_t encoding, hfs_to_unicode_func_t *get_unicode,
	434	unicode_to_hfs_func_t *get_hfsname);
	435
	436	int hfs_relconverter(u_int32_t encoding);
	437
	438	int hfs_to_utf8(ExtendedVCB *vcb, Str31 hfs_str, ByteCount maxDstLen,
	439	ByteCount actualDstLen, unsigned char dstStr);
	440
	441	int utf8_to_hfs(ExtendedVCB vcb, ByteCount srcLen, const unsigned char srcStr,
	442	Str31 dstStr);
	443
	444	int mac_roman_to_utf8(Str31 hfs_str, ByteCount maxDstLen, ByteCount *actualDstLen,
	445	unsigned char* dstStr);
	446
	447	int utf8_to_mac_roman(ByteCount srcLen, const unsigned char* srcStr, Str31 dstStr);
	448
0b4e3aa0 A	449	u_int32_t hfs_pickencoding(const u_int16_t *src, int len);
0b4e3aa0 A	450
9bccf70c A	451	enum volop {VOL_UPDATE, VOL_MKDIR, VOL_RMDIR, VOL_MKFILE, VOL_RMFILE};
	452
	453	extern int hfs_volupdate(struct hfsmount *hfsmp, enum volop op, int inroot);
	454
	455	extern void hfs_setencodingbits(struct hfsmount *hfsmp, u_int32_t encoding);
	456
	457
	458	extern void replace_desc(struct cnode cp, struct cat_desc cdp);
	459
d7e50217 A	460	extern int hfs_namecmp(const char , size_t, const char , size_t);
d7e50217 A	461
55e303ae A	462	extern int hfs_virtualmetafile(struct cnode *);
	463
	464	void hfs_generate_volume_notifications(struct hfsmount *hfsmp);
	465
91447636 A	466	__private_extern__ u_int32_t hfs_getencodingbias(void);
	467	__private_extern__ void hfs_setencodingbias(u_int32_t bias);
	468
	469	extern int hfs_vgetrsrc(struct hfsmount hfsmp, struct vnode vp,
	470	struct vnode *rvpp, struct proc p);
	471
	472	extern int hfs_update(struct vnode *, int);
	473
	474	extern int hfs_truncate(struct vnode *, off_t, int, int, vfs_context_t);
	475
	476	extern int hfs_fsync(struct vnode , int, int, struct proc );
	477
	478	extern int hfs_access(struct vnode , mode_t, struct ucred , struct proc *);
	479
	480	extern int hfs_vget(struct hfsmount , cnid_t, struct vnode *, int);
	481
	482	extern int hfs_bmap(struct vnode , daddr_t, struct vnode , daddr64_t , int *);
	483
	484	extern int hfs_removeallattr(struct hfsmount *hfsmp, u_int32_t fileid);
	485
	486	__private_extern__ int hfs_start_transaction(struct hfsmount *hfsmp);
	487	__private_extern__ int hfs_end_transaction(struct hfsmount *hfsmp);
	488
	489	extern int hfs_setextendedsecurity(struct hfsmount *hfsmp, int state);
	490	extern void hfs_checkextendedsecurity(struct hfsmount *hfsmp);
	491
	492	extern int hfs_extendfs(struct hfsmount *, u_int64_t, vfs_context_t);
	493	extern int hfs_truncatefs(struct hfsmount *, u_int64_t, vfs_context_t);
	494
	495	extern int hfs_isallocated(struct hfsmount *, u_long, u_long);
	496
	497
	498	/* HFS System file locking */
	499	#define SFL_CATALOG 0x0001
	500	#define SFL_EXTENTS 0x0002
	501	#define SFL_BITMAP 0x0004
	502	#define SFL_ATTRIBUTE 0x0008
	503	#define SFL_VALIDMASK (SFL_CATALOG \| SFL_EXTENTS \| SFL_BITMAP \| SFL_ATTRIBUTE)
	504
	505	extern int hfs_systemfile_lock(struct hfsmount *, int, enum hfslocktype);
	506	extern void hfs_systemfile_unlock(struct hfsmount *, int);
d7e50217	507
9bccf70c A	508	#endif /* __APPLE_API_PRIVATE */
9bccf70c A	509	#endif /* KERNEL */
1c79356b	510	#endif /* __HFS__ */