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

/*
 * Copyright (c) 2000-2003 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/lock.h>
#include <sys/queue.h>
#include <sys/mount.h>
#include <sys/namei.h>
#include <sys/vnode.h>
#include <sys/quota.h>
#include <sys/dirent.h>
#include <sys/event.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>


struct uio;		// This is more effective than #include <sys/uio.h> in case KERNEL is undefined...
struct hfslockf;	/* For advisory locking */

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

enum {
	kUnknownID = 0,
	kRootParID = 1,
	kRootDirID = 2
};

enum {
	kDataFork,
	kRsrcFork,
	kDirectory
};

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

struct vcb_t {
    u_int16_t 			vcbSigWord;
    int16_t 			vcbAtrb;
    int16_t			vcbFlags;
    int16_t 			vcbspare;
    u_int32_t 			vcbJinfoBlock;

    u_int32_t 			vcbCrDate;
    u_int32_t 			vcbLsMod;
    u_int32_t 			vcbVolBkUp;

    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 			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 */
    simple_lock_data_t	vcbSimpleLock;		/* simple lock to allow concurrent access to vcb data */
};
typedef struct vcb_t ExtendedVCB;


#define kHFS_DamagedVolume  0x1	/* This volume has errors, unmount dirty */

/* XXX */
#define MARK_VOLUMEDAMAGED(fcb) 

/*
 * 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.
 */
typedef struct vfsVCB {
    ExtendedVCB			vcb_vcb;
    struct hfsmount		*vcb_hfsmp;				/* Pointer to hfsmount structure */
} vfsVCB_t;


/* 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_count;	/* Num of PHYSICAL blocks of volume */
	u_long				hfs_phys_block_size;	/* Always a multiple of 512 */

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

	/* HFS Specific */
	struct vfsVCB		hfs_vcb;
	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;
	volatile int         readers;
	volatile int         blocker;
	
	/* Notification variables: */
	unsigned long		hfs_notification_conditions;
	u_int32_t		hfs_freespace_notify_warninglimit;
	u_int32_t		hfs_freespace_notify_desiredlevel;

	/* 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: */
	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
} hfsmount_t;


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

#ifdef HFS_SPARSE_DEV
#define HFS_HAS_SPARSE_DEVICE     0x400
#endif


#define hfs_global_shared_lock_acquire(hfsmp)    \
    do { \
       if (hfsmp->blocker) { \
	       tsleep((caddr_t)&hfsmp->blocker, PRIBIO, "journal_blocker", 0); \
           continue; \
	   } \
	   hfsmp->readers++; \
       break; \
	} while (1)

#define hfs_global_shared_lock_release(hfsmp)    \
    do { \
	    hfsmp->readers--; \
	    if (hfsmp->readers == 0) { \
	        wakeup((caddr_t)&hfsmp->readers); \
        } \
    } while (0)

#define hfs_global_exclusive_lock_acquire(hfsmp) \
    do { \
       if (hfsmp->blocker) { \
	       tsleep((caddr_t)&hfsmp->blocker, PRIBIO, "journal_blocker", 0); \
           continue; \
	   } \
       if (hfsmp->readers != 0) { \
	       tsleep((caddr_t)&hfsmp->readers, PRIBIO, "journal_enable/disble", 0); \
           continue; \
       } \
       hfsmp->blocker = 1; \
       break; \
	} while (1)
     
#define hfs_global_exclusive_lock_release(hfsmp) \
    hfsmp->blocker = 0; \
	wakeup((caddr_t)&hfsmp->blocker)

#define MAXHFSVNODELEN		31


typedef struct filefork FCB;


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


/* 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 HFS_AVERAGE_NAME_SIZE	22
#define AVERAGE_HFSDIRENTRY_SIZE  (8+HFS_AVERAGE_NAME_SIZE+4)
#define MAX_HFSDIRENTRY_SIZE	sizeof(struct dirent)

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


enum { kHFSPlusMaxFileNameBytes = kHFSPlusMaxFileNameChars * 3 };

enum { kdirentMaxNameBytes = NAME_MAX };


/* 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) ((VP)->v_mount)
#define HFSTOVFS(HFSMP) ((HFSMP)->hfs_mp)
#define VCBTOVFS(VCB) (((struct vfsVCB *)(VCB))->vcb_hfsmp->hfs_mp)

/*
 * Various ways to acquire an HFS mount point pointer:
 */
#define VTOHFS(VP) ((struct hfsmount *)((VP)->v_mount->mnt_data))
#define	VFSTOHFS(MP) ((struct hfsmount *)(MP)->mnt_data)	
#define VCBTOHFS(VCB) (((struct vfsVCB *)(VCB))->vcb_hfsmp)
#define FCBTOHFS(FCB) ((struct hfsmount *)(FCB)->ff_cp->c_vp->v_mount->mnt_data)

/*
 * Various ways to acquire a VCB pointer:
 */
#define VTOVCB(VP) (&(((struct hfsmount *)((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 FCBTOVCB(FCB) (&(((struct hfsmount *)((FCB)->ff_cp->c_vp->v_mount->mnt_data))->hfs_vcb.vcb_vcb))


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

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


u_int32_t to_bsd_time(u_int32_t hfs_time);
u_int32_t to_hfs_time(u_int32_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_getcnode(struct hfsmount *hfsmp, cnid_t cnid, struct cat_desc *descp,
			int wantrsrc, struct cat_attr *attrp, struct cat_fork *forkp,
			struct vnode **vpp);

extern int hfs_getnewvnode(struct hfsmount *hfsmp, struct cnode *cp,
                           struct cat_desc *descp, int wantrsrc, struct cat_attr *attrp,
                           struct cat_fork *forkp, struct vnode **vpp);

extern int hfs_metafilelocking(struct hfsmount *hfsmp, u_long fileID, u_int flags, struct proc *p);

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

extern int     hfs_early_journal_init(struct hfsmount *hfsmp, HFSPlusVolumeHeader *vhp,
							   void *_args, int embeddedOffset, int mdb_offset,
							   HFSMasterDirectoryBlock *mdbp, struct ucred *cred);
extern u_long  GetFileInfo(ExtendedVCB *vcb, u_int32_t dirid, 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);


#endif /* __APPLE_API_PRIVATE */
#endif /* KERNEL */
#endif /* __HFS__ */
Commit	Line	Data
1c79356b	1	/*
55e303ae	2	* Copyright (c) 2000-2003 Apple Computer, Inc. All rights reserved.
1c79356b A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
e5568f75 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.
1c79356b	11	*
e5568f75 A	12	* This Original Code and all software distributed under the License are
e5568f75 A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
e5568f75 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.
1c79356b A	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	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 A	32	#include <sys/param.h>
	33	#include <sys/lock.h>
	34	#include <sys/queue.h>
9bccf70c A	35	#include <sys/mount.h>
	36	#include <sys/namei.h>
	37	#include <sys/vnode.h>
	38	#include <sys/quota.h>
1c79356b	39	#include <sys/dirent.h>
55e303ae	40	#include <sys/event.h>
1c79356b	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 A	50
1c79356b A	51
9bccf70c A	52	struct uio; // This is more effective than #include <sys/uio.h> in case KERNEL is undefined...
9bccf70c A	53	struct hfslockf; /* For advisory locking */
1c79356b A	54
	55	/*
	56	* Just reported via MIG interface.
	57	*/
	58	#define VERSION_STRING "hfs-2 (4-12-99)"
	59
	60	#define HFS_LINK_MAX 32767
	61
9bccf70c A	62	#define HFS_MAX_DEFERED_ALLOC (1024*1024)
9bccf70c A	63
55e303ae A	64	// 32 gigs is a "big" file (i.e. one that when deleted
	65	// would touch enough data that we should break it into
	66	// multiple separate transactions
	67	#define HFS_BIGFILE_SIZE (32LL * 1024LL * 1024LL * 1024LL)
	68
1c79356b A	69
	70	enum { kMDBSize = 512 }; /* Size of I/O transfer to read entire MDB */
	71
	72	enum { kMasterDirectoryBlock = 2 }; /* MDB offset on disk in 512-byte blocks */
	73	enum { kMDBOffset = kMasterDirectoryBlock * 512 }; /* MDB offset on disk in bytes */
	74
	75	enum {
	76	kUnknownID = 0,
	77	kRootParID = 1,
	78	kRootDirID = 2
	79	};
	80
	81	enum {
1c79356b A	82	kDataFork,
1c79356b A	83	kRsrcFork,
9bccf70c	84	kDirectory
1c79356b A	85	};
1c79356b A	86
0b4e3aa0 A	87	/* number of locked buffer caches to hold for b-tree meta data */
0b4e3aa0 A	88	#define kMaxLockedMetaBuffers 32
1c79356b A	89
	90	/*
	91	* File type and creator for symbolic links
	92	*/
	93	enum {
9bccf70c A	94	kSymLinkFileType = 0x736C6E6B, /* 'slnk' */
9bccf70c A	95	kSymLinkCreator = 0x72686170 /* 'rhap' */
1c79356b A	96	};
1c79356b A	97
1c79356b A	98
	99	extern struct timezone gTimeZone;
	100
1c79356b	101
0b4e3aa0 A	102	/* How many free extents to cache per volume */
	103	#define kMaxFreeExtents 10
	104
9bccf70c A	105	/*
	106	* HFS_MINFREE gives the minimum acceptable percentage
	107	* of file system blocks which may be free (but this
	108	* minimum will never exceed HFS_MAXRESERVE bytes). If
	109	* the free block count drops below this level only the
	110	* superuser may continue to allocate blocks.
	111	*/
	112	#define HFS_MINFREE 1
55e303ae A	113	#define HFS_MAXRESERVE ((u_int64_t)(25010241024))
	114
	115	/*
	116	* The system distinguishes between the desirable low-disk
	117	* notifiaction levels for root volumes and non-root volumes.
	118	* The various thresholds are computed as a fraction of the
	119	* volume size, all capped at a certain fixed level
	120	*/
	121
	122	#define HFS_ROOTLOWDISKTRIGGERFRACTION 5
	123	#define HFS_ROOTLOWDISKTRIGGERLEVEL ((u_int64_t)(25010241024))
	124	#define HFS_ROOTLOWDISKSHUTOFFFRACTION 6
	125	#define HFS_ROOTLOWDISKSHUTOFFLEVEL ((u_int64_t)(37510241024))
	126
	127	#define HFS_LOWDISKTRIGGERFRACTION 1
	128	#define HFS_LOWDISKTRIGGERLEVEL ((u_int64_t)(5010241024))
	129	#define HFS_LOWDISKSHUTOFFFRACTION 2
	130	#define HFS_LOWDISKSHUTOFFLEVEL ((u_int64_t)(7510241024))
9bccf70c	131
1c79356b A	132	/* Internal Data structures*/
	133
	134	struct vcb_t {
1c79356b	135	u_int16_t vcbSigWord;
1c79356b	136	int16_t vcbAtrb;
9bccf70c A	137	int16_t vcbFlags;
9bccf70c A	138	int16_t vcbspare;
b4c24cb9	139	u_int32_t vcbJinfoBlock;
0b4e3aa0 A	140
	141	u_int32_t vcbCrDate;
	142	u_int32_t vcbLsMod;
1c79356b	143	u_int32_t vcbVolBkUp;
0b4e3aa0	144
1c79356b A	145	int32_t vcbFilCnt;
1c79356b A	146	int32_t vcbDirCnt;
9bccf70c A	147	u_int32_t blockSize; /* size of allocation blocks */
	148	u_int32_t totalBlocks; /* total allocation blocks */
	149	u_int32_t freeBlocks; /* free allocation blocks */
	150	u_int32_t nextAllocation; /* start of next allocation search */
0b4e3aa0 A	151	int32_t vcbClpSiz;
0b4e3aa0 A	152	u_int32_t vcbNxtCNID;
9bccf70c A	153	u_int32_t vcbCNIDGen;
9bccf70c A	154	int32_t vcbWrCnt;
0b4e3aa0	155
1c79356b	156	int32_t vcbFndrInfo[8];
0b4e3aa0 A	157
	158	u_int64_t encodingsBitmap; /* HFS Plus only */
	159
9bccf70c	160	u_int16_t vcbNmFls; /* HFS only */
0b4e3aa0	161	u_int16_t vcbNmRtDirs; /* HFS only */
9bccf70c A	162	int16_t vcbVBMSt; /* HFS only */
9bccf70c A	163	int16_t vcbAlBlSt; /* HFS only */
0b4e3aa0	164
1c79356b A	165	struct vnode * extentsRefNum;
	166	struct vnode * catalogRefNum;
	167	struct vnode * allocationsRefNum;
0b4e3aa0	168
9bccf70c	169	u_int8_t vcbVN[256]; /* volume name in UTF-8 */
0b4e3aa0	170	u_int32_t volumeNameEncodingHint;
9bccf70c	171	u_int32_t hfsPlusIOPosOffset; /* Disk block where HFS+ starts */
0b4e3aa0	172	u_int32_t vcbVBMIOSize; /* volume bitmap I/O size */
0b4e3aa0	173
9bccf70c A	174	/* cache of largest known free extents */
	175	u_int32_t vcbFreeExtCnt;
	176	HFSPlusExtentDescriptor vcbFreeExt[kMaxFreeExtents];
	177
	178	u_int32_t reserveBlocks; /* free block reserve */
	179	u_int32_t loanedBlocks; /* blocks on loan for delayed allocations */
0b4e3aa0	180
1c79356b A	181	u_int32_t localCreateDate; /* creation times for HFS+ volumes are in local time */
	182	simple_lock_data_t vcbSimpleLock; /* simple lock to allow concurrent access to vcb data */
	183	};
	184	typedef struct vcb_t ExtendedVCB;
	185
0b4e3aa0	186
9bccf70c	187	#define kHFS_DamagedVolume 0x1 /* This volume has errors, unmount dirty */
1c79356b	188
9bccf70c A	189	/* XXX */
9bccf70c A	190	#define MARK_VOLUMEDAMAGED(fcb)
1c79356b A	191
	192	/*
	193	* NOTE: The code relies on being able to cast an ExtendedVCB* to a vfsVCB* in order
	194	* to gain access to the mount point pointer from a pointer
	195	* to an ExtendedVCB. DO NOT INSERT OTHER FIELDS BEFORE THE vcb FIELD!!
	196	*
	197	* vcbFlags, vcbLsMod, vcbFilCnt, vcbDirCnt, vcbNxtCNID, etc
	198	* are locked by the hfs_lock simple lock.
	199	*/
	200	typedef struct vfsVCB {
	201	ExtendedVCB vcb_vcb;
	202	struct hfsmount vcb_hfsmp; / Pointer to hfsmount structure */
	203	} vfsVCB_t;
	204
	205
	206
	207	/* This structure describes the HFS specific mount structure data. */
	208	typedef struct hfsmount {
55e303ae	209	u_int32_t hfs_flags; /* see below */
1c79356b A	210
	211	/* Physical Description */
	212	u_long hfs_phys_block_count; /* Num of PHYSICAL blocks of volume */
	213	u_long hfs_phys_block_size; /* Always a multiple of 512 */
	214
	215	/* Access to VFS and devices */
	216	struct mount hfs_mp; / filesystem vfs structure */
	217	struct vnode hfs_devvp; / block device mounted vnode */
	218	dev_t hfs_raw_dev; /* device mounted */
	219	struct netexport hfs_export; /* Export information */
	220	u_int32_t hfs_logBlockSize; /* Size of buffer cache buffer for I/O */
	221
	222	/* Default values for HFS standard and non-init access */
	223	uid_t hfs_uid; /* uid to set as owner of the files */
	224	gid_t hfs_gid; /* gid to set as owner of the files */
	225	mode_t hfs_dir_mask; /* mask to and with directory protection bits */
	226	mode_t hfs_file_mask; /* mask to and with file protection bits */
	227	u_long hfs_encoding; /* Defualt encoding for non hfs+ volumes */
	228
1c79356b A	229	/* HFS Specific */
1c79356b A	230	struct vfsVCB hfs_vcb;
9bccf70c A	231	struct cat_desc hfs_privdir_desc;
9bccf70c A	232	struct cat_attr hfs_privdir_attr;
1c79356b A	233	u_int32_t hfs_metadata_createdate;
	234	hfs_to_unicode_func_t hfs_get_unicode;
	235	unicode_to_hfs_func_t hfs_get_hfsname;
9bccf70c	236
55e303ae	237	/* Quota variables: */
9bccf70c	238	struct quotafile hfs_qfiles[MAXQUOTAS]; /* quota files */
b4c24cb9	239
55e303ae	240	/* Journaling variables: */
b4c24cb9 A	241	void *jnl; // the journal for this volume (if one exists)
	242	struct vnode *jvp; // device where the journal lives (may be equal to devvp)
	243	u_int32_t jnl_start; // start block of the journal file (so we don't delete it)
55e303ae	244	u_int32_t jnl_size;
b4c24cb9 A	245	u_int32_t hfs_jnlfileid;
b4c24cb9 A	246	u_int32_t hfs_jnlinfoblkid;
55e303ae	247	volatile int readers;
b4c24cb9	248	volatile int blocker;
55e303ae A	249
	250	/* Notification variables: */
	251	unsigned long hfs_notification_conditions;
	252	u_int32_t hfs_freespace_notify_warninglimit;
	253	u_int32_t hfs_freespace_notify_desiredlevel;
	254
	255	/* Metadata allocation zone variables: */
	256	u_int32_t hfs_metazone_start;
	257	u_int32_t hfs_metazone_end;
	258	u_int32_t hfs_hotfile_start;
	259	u_int32_t hfs_hotfile_end;
	260	int hfs_hotfile_freeblks;
	261	int hfs_hotfile_maxblks;
	262	int hfs_overflow_maxblks;
	263	int hfs_catalog_maxblks;
	264
	265	/* Hot File Clustering variables: */
	266	enum hfc_stage hfc_stage; /* what are we up to... */
	267	time_t hfc_timebase; /* recording period start time */
	268	time_t hfc_timeout; /* recording period stop time */
	269	void * hfc_recdata; /* recording data (opaque) */
	270	int hfc_maxfiles; /* maximum files to track */
	271	struct vnode * hfc_filevp;
	272
	273	#ifdef HFS_SPARSE_DEV
	274	/* Sparse device variables: */
	275	struct vnode * hfs_backingfs_rootvp;
	276	int hfs_sparsebandblks;
	277	#endif
1c79356b A	278	} hfsmount_t;
1c79356b A	279
55e303ae A	280
	281	/* HFS mount point flags */
	282	#define HFS_READ_ONLY 0x001
	283	#define HFS_UNKNOWN_PERMS 0x002
	284	#define HFS_WRITEABLE_MEDIA 0x004
	285	#define HFS_CLEANED_ORPHANS 0x008
	286	#define HFS_X 0x010
	287	#define HFS_CASE_SENSITIVE 0x020
	288	#define HFS_STANDARD 0x040
	289	#define HFS_METADATA_ZONE 0x080
	290	#define HFS_FRAGMENTED_FREESPACE 0x100
	291	#define HFS_NEED_JNL_RESET 0x200
	292
	293	#ifdef HFS_SPARSE_DEV
	294	#define HFS_HAS_SPARSE_DEVICE 0x400
	295	#endif
	296
1c79356b	297
b4c24cb9 A	298	#define hfs_global_shared_lock_acquire(hfsmp) \
	299	do { \
	300	if (hfsmp->blocker) { \
	301	tsleep((caddr_t)&hfsmp->blocker, PRIBIO, "journal_blocker", 0); \
	302	continue; \
	303	} \
	304	hfsmp->readers++; \
	305	break; \
	306	} while (1)
	307
	308	#define hfs_global_shared_lock_release(hfsmp) \
	309	do { \
	310	hfsmp->readers--; \
	311	if (hfsmp->readers == 0) { \
	312	wakeup((caddr_t)&hfsmp->readers); \
	313	} \
	314	} while (0)
	315
	316	#define hfs_global_exclusive_lock_acquire(hfsmp) \
	317	do { \
	318	if (hfsmp->blocker) { \
	319	tsleep((caddr_t)&hfsmp->blocker, PRIBIO, "journal_blocker", 0); \
	320	continue; \
	321	} \
	322	if (hfsmp->readers != 0) { \
	323	tsleep((caddr_t)&hfsmp->readers, PRIBIO, "journal_enable/disble", 0); \
	324	continue; \
	325	} \
	326	hfsmp->blocker = 1; \
	327	break; \
	328	} while (1)
	329
	330	#define hfs_global_exclusive_lock_release(hfsmp) \
	331	hfsmp->blocker = 0; \
	332	wakeup((caddr_t)&hfsmp->blocker)
	333
1c79356b	334	#define MAXHFSVNODELEN 31
1c79356b	335
1c79356b	336
9bccf70c	337	typedef struct filefork FCB;
1c79356b	338
1c79356b A	339
	340	#define MAKE_INODE_NAME(name,linkno) \
	341	(void) sprintf((name), "%s%d", HFS_INODE_PREFIX, (linkno))
	342
1c79356b	343
1c79356b A	344	/* structure to hold a "." or ".." directory entry (12 bytes) */
	345	typedef struct hfsdotentry {
	346	u_int32_t d_fileno; /* unique file number */
	347	u_int16_t d_reclen; /* length of this structure */
	348	u_int8_t d_type; /* dirent file type */
	349	u_int8_t d_namelen; /* len of filename */
	350	char d_name[4]; /* "." or ".." */
	351	} hfsdotentry;
	352
9bccf70c A	353	#define HFS_AVERAGE_NAME_SIZE 22
9bccf70c A	354	#define AVERAGE_HFSDIRENTRY_SIZE (8+HFS_AVERAGE_NAME_SIZE+4)
1c79356b A	355	#define MAX_HFSDIRENTRY_SIZE sizeof(struct dirent)
	356
	357	#define DIRENTRY_SIZE(namlen) \
	358	((sizeof(struct dirent) - (NAME_MAX+1)) + (((namlen)+1 + 3) &~ 3))
	359
1c79356b	360
1c79356b A	361
	362	enum { kHFSPlusMaxFileNameBytes = kHFSPlusMaxFileNameChars * 3 };
	363
	364	enum { kdirentMaxNameBytes = NAME_MAX };
	365
1c79356b A	366
	367	/* macro to determine if hfs or hfsplus */
	368	#define ISHFSPLUS(VCB) ((VCB)->vcbSigWord == kHFSPlusSigWord)
	369	#define ISHFS(VCB) ((VCB)->vcbSigWord == kHFSSigWord)
	370
	371
1c79356b A	372	/*
	373	* Various ways to acquire a VFS mount point pointer:
	374	*/
	375	#define VTOVFS(VP) ((VP)->v_mount)
1c79356b A	376	#define HFSTOVFS(HFSMP) ((HFSMP)->hfs_mp)
	377	#define VCBTOVFS(VCB) (((struct vfsVCB *)(VCB))->vcb_hfsmp->hfs_mp)
	378
	379	/*
	380	* Various ways to acquire an HFS mount point pointer:
	381	*/
	382	#define VTOHFS(VP) ((struct hfsmount *)((VP)->v_mount->mnt_data))
1c79356b A	383	#define VFSTOHFS(MP) ((struct hfsmount *)(MP)->mnt_data)
1c79356b A	384	#define VCBTOHFS(VCB) (((struct vfsVCB *)(VCB))->vcb_hfsmp)
b4c24cb9	385	#define FCBTOHFS(FCB) ((struct hfsmount *)(FCB)->ff_cp->c_vp->v_mount->mnt_data)
1c79356b A	386
	387	/*
	388	* Various ways to acquire a VCB pointer:
	389	*/
	390	#define VTOVCB(VP) (&(((struct hfsmount *)((VP)->v_mount->mnt_data))->hfs_vcb.vcb_vcb))
1c79356b A	391	#define VFSTOVCB(MP) (&(((struct hfsmount *)(MP)->mnt_data)->hfs_vcb.vcb_vcb))
1c79356b A	392	#define HFSTOVCB(HFSMP) (&(HFSMP)->hfs_vcb.vcb_vcb)
b4c24cb9	393	#define FCBTOVCB(FCB) (&(((struct hfsmount *)((FCB)->ff_cp->c_vp->v_mount->mnt_data))->hfs_vcb.vcb_vcb))
1c79356b A	394
1c79356b A	395
55e303ae A	396	#define HFS_KNOTE(vp, hint) KNOTE(&VTOC(vp)->c_knotes, (hint))
	397
	398
1c79356b A	399	#define E_NONE 0
1c79356b A	400	#define kHFSBlockSize 512
1c79356b	401
9bccf70c A	402	/*
	403	* Macros for getting the MDB/VH sector and offset
	404	*/
	405	#define HFS_PRI_SECTOR(blksize) (1024 / (blksize))
	406	#define HFS_PRI_OFFSET(blksize) ((blksize) > 1024 ? 1024 : 0)
d52fe63f A	407
	408	#define HFS_ALT_SECTOR(blksize, blkcnt) (((blkcnt) - 1) - (512 / (blksize)))
	409	#define HFS_ALT_OFFSET(blksize) ((blksize) > 1024 ? (blksize) - 1024 : 0)
	410
1c79356b A	411	/*
	412	* This is the straight GMT conversion constant:
	413	* 00:00:00 January 1, 1970 - 00:00:00 January 1, 1904
	414	* (3600 * 24 * ((365 * (1970 - 1904)) + (((1970 - 1904) / 4) + 1)))
	415	*/
	416	#define MAC_GMT_FACTOR 2082844800UL
	417
1c79356b A	418
	419	u_int32_t to_bsd_time(u_int32_t hfs_time);
	420	u_int32_t to_hfs_time(u_int32_t bsd_time);
	421
9bccf70c A	422	int hfs_flushvolumeheader(struct hfsmount *hfsmp, int waitfor, int altflush);
9bccf70c A	423	#define HFS_ALTFLUSH 1
1c79356b	424
55e303ae	425	extern int hfsUnmount(struct hfsmount hfsmp, struct proc p);
1c79356b	426
9bccf70c A	427
	428	extern int hfs_getcnode(struct hfsmount hfsmp, cnid_t cnid, struct cat_desc descp,
	429	int wantrsrc, struct cat_attr attrp, struct cat_fork forkp,
	430	struct vnode **vpp);
	431
	432	extern int hfs_getnewvnode(struct hfsmount hfsmp, struct cnode cp,
	433	struct cat_desc descp, int wantrsrc, struct cat_attr attrp,
	434	struct cat_fork forkp, struct vnode *vpp);
	435
1c79356b	436	extern int hfs_metafilelocking(struct hfsmount hfsmp, u_long fileID, u_int flags, struct proc p);
1c79356b	437
9bccf70c A	438	extern u_int32_t hfs_freeblks(struct hfsmount * hfsmp, int wantreserve);
9bccf70c A	439
b4c24cb9 A	440	extern void hfs_remove_orphans(struct hfsmount *);
b4c24cb9 A	441
1c79356b A	442
1c79356b A	443	short MacToVFSError(OSErr err);
1c79356b	444
9bccf70c A	445	extern int hfs_owner_rights(struct hfsmount hfsmp, uid_t cnode_uid, struct ucred cred,
	446	struct proc *p, int invokesuperuserstatus);
	447
1c79356b A	448	u_long FindMetaDataDirectory(ExtendedVCB *vcb);
1c79356b A	449
9bccf70c A	450	#define kMaxSecsForFsync 5
	451	#define HFS_SYNCTRANS 1
	452
	453	extern int hfs_btsync(struct vnode *vp, int sync_transaction);
b4c24cb9 A	454	// used as a callback by the journaling code
b4c24cb9 A	455	extern void hfs_sync_metadata(void *arg);
1c79356b A	456
	457	short make_dir_entry(FCB *fileptr, char name, u_int32_t fileID);
	458
9bccf70c	459
1c79356b A	460	unsigned long BestBlockSizeFit(unsigned long allocationBlockSize,
	461	unsigned long blockSizeLimit,
	462	unsigned long baseMultiple);
	463
	464	OSErr hfs_MountHFSVolume(struct hfsmount hfsmp, HFSMasterDirectoryBlock mdb,
d52fe63f	465	struct proc *p);
1c79356b	466	OSErr hfs_MountHFSPlusVolume(struct hfsmount hfsmp, HFSPlusVolumeHeader vhp,
b4c24cb9 A	467	off_t embeddedOffset, u_int64_t disksize, struct proc p, void args);
	468
	469	extern int hfs_early_journal_init(struct hfsmount hfsmp, HFSPlusVolumeHeader vhp,
	470	void *_args, int embeddedOffset, int mdb_offset,
	471	HFSMasterDirectoryBlock mdbp, struct ucred cred);
	472	extern u_long GetFileInfo(ExtendedVCB vcb, u_int32_t dirid, char name,
	473	struct cat_attr fattr, struct cat_fork forkinfo);
1c79356b A	474
	475	int hfs_getconverter(u_int32_t encoding, hfs_to_unicode_func_t *get_unicode,
	476	unicode_to_hfs_func_t *get_hfsname);
	477
	478	int hfs_relconverter(u_int32_t encoding);
	479
	480	int hfs_to_utf8(ExtendedVCB *vcb, Str31 hfs_str, ByteCount maxDstLen,
	481	ByteCount actualDstLen, unsigned char dstStr);
	482
	483	int utf8_to_hfs(ExtendedVCB vcb, ByteCount srcLen, const unsigned char srcStr,
	484	Str31 dstStr);
	485
	486	int mac_roman_to_utf8(Str31 hfs_str, ByteCount maxDstLen, ByteCount *actualDstLen,
	487	unsigned char* dstStr);
	488
	489	int utf8_to_mac_roman(ByteCount srcLen, const unsigned char* srcStr, Str31 dstStr);
	490
0b4e3aa0 A	491	u_int32_t hfs_pickencoding(const u_int16_t *src, int len);
0b4e3aa0 A	492
9bccf70c A	493	enum volop {VOL_UPDATE, VOL_MKDIR, VOL_RMDIR, VOL_MKFILE, VOL_RMFILE};
	494
	495	extern int hfs_volupdate(struct hfsmount *hfsmp, enum volop op, int inroot);
	496
	497	extern void hfs_setencodingbits(struct hfsmount *hfsmp, u_int32_t encoding);
	498
	499
	500	extern void replace_desc(struct cnode cp, struct cat_desc cdp);
	501
d7e50217 A	502	extern int hfs_namecmp(const char , size_t, const char , size_t);
d7e50217 A	503
55e303ae A	504	extern int hfs_virtualmetafile(struct cnode *);
	505
	506	void hfs_generate_volume_notifications(struct hfsmount *hfsmp);
	507
d7e50217	508
9bccf70c A	509	#endif /* __APPLE_API_PRIVATE */
9bccf70c A	510	#endif /* KERNEL */
1c79356b	511	#endif /* __HFS__ */