newfs_hfs.h   [plain text]

/*
 * Copyright (c) 1999-2015 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
 
#include <CoreFoundation/CFBase.h>

enum {
	kMinHFSPlusVolumeSize	= (512 * 1024),
	
	kBytesPerSector		= 512,
	kBitsPerSector		= 4096,
	kBTreeHeaderUserBytes	= 128,
	kLog2SectorSize		= 9,
	kHFSNodeSize		= 512,
	kHFSMaxAllocationBlks	= 65536,
	
	kHFSPlusDataClumpFactor	= 16,
	kHFSPlusRsrcClumpFactor = 16,

	kWriteSeqNum		= 2,
	kHeaderBlocks		= 3,
	kTailBlocks		= 2,
	kMDBStart		= 2,
	kVolBitMapStart		= kHeaderBlocks,

	/* Desktop DB, Desktop DF, Finder, System, ReadMe */
	kWapperFileCount	= 5,
	/* Maximum wrapper size is 32MB */
	kMaxWrapperSize		= 1024 * 1024 * 32,
	/* Maximum volume that can be wrapped is 256GB */
	kMaxWrapableSectors	= (kMaxWrapperSize/8) * (65536/512)
};

/* B-tree key descriptor */
#define KD_SKIP		0
#define KD_BYTE		1
#define KD_SIGNBYTE	2
#define KD_STRING	3
#define KD_WORD		4
#define KD_SIGNWORD	5
#define KD_LONG		6
#define KD_SIGNLONG	7
#define KD_FIXLENSTR	8
#define KD_DTDBSTR	9
#define KD_USEPROC	10

/*
 * The following constant sets the default block size.
 * This constant must be a power of 2 and meet the following constraints:
 *	MINBSIZE <= DFL_BLKSIZE <= MAXBSIZE
 *	sectorsize <= DFL_BLKSIZE
 */
#define HFSOPTIMALBLKSIZE	4096
#define HFSMINBSIZE		512
#define HFSMAXBSIZE		2147483648U
#define	DFL_BLKSIZE		HFSOPTIMALBLKSIZE


#define kDTDF_FileID	16
#define kDTDF_Name	"Desktop DF"
#define kDTDF_Chars	10
#define kDTDF_Type	'DTFL'
#define kDTDF_Creator	'DMGR'

#define kDTDB_FileID	17
#define kDTDB_Name	"Desktop DB"
#define kDTDB_Chars	10
#define kDTDB_Type	'BTFL'
#define kDTDB_Creator	'DMGR'
#define kDTDB_Size	1024

#define kReadMe_FileID	18
#define kReadMe_Name	"ReadMe"
#define kReadMe_Chars	6
#define kReadMe_Type	'ttro'
#define kReadMe_Creator	'ttxt'

#define kFinder_FileID	19
#define kFinder_Name	"Finder"
#define kFinder_Chars	6
#define kFinder_Type	'FNDR'
#define kFinder_Creator	'MACS'

#define kSystem_FileID	20
#define kSystem_Name	"System"
#define kSystem_Chars	6
#define kSystem_Type	'zsys'
#define kSystem_Creator	'MACS'



#if !defined(FALSE) && !defined(TRUE)
enum {
	FALSE = 0,
	TRUE  = 1
};
#endif


#define kDefaultVolumeNameStr	"untitled"

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

/*
 * Maximum number of bytes in an HFS+ filename.
 * It's 255 characters; a UTF16 character may translate
 * to 3 bytes.  Plus one for NUL.
 */

#define kHFSPlusMaxFileNameBytes	(3 * 255 + 1)

/* sectorSize = kBytesPerSector = 512
   sectorOffset and totalSectors are in terms of 512-byte sector size.
*/
struct DriveInfo {
	int	fd;
	uint32_t sectorSize;
	uint32_t sectorOffset;
	uint64_t totalSectors;

	/* actual device info. physSectorSize is necessary to de-block
	 * while using the raw device.
	 */
	uint32_t physSectorSize;
	uint64_t physSectorsPerIO;
	uint64_t physTotalSectors;
};
typedef struct DriveInfo DriveInfo;

enum {
	kMakeHFSWrapper    = 0x01,
	kMakeMaxHFSBitmap  = 0x02,
	kMakeStandardHFS   = 0x04,
	kMakeCaseSensitive = 0x08,
	kUseAccessPerms    = 0x10,
	kMakeContentProtect= 0x20,
};


struct hfsparams {
	uint32_t 	flags;			/* kMakeHFSWrapper, ... */
	uint32_t 	blockSize;
	uint32_t 	rsrcClumpSize;
	uint32_t 	dataClumpSize;
	uint32_t 	nextFreeFileID;

	uint32_t 	catalogClumpSize;
	uint32_t 	catalogInitialSize;
	uint32_t 	catalogNodeSize;
	uint32_t	catalogExtsCount;
	uint32_t	catalogStartBlock;

	uint32_t 	extentsClumpSize;
	uint32_t 	extentsInitialSize;
	uint32_t 	extentsNodeSize;
	uint32_t	extentsExtsCount;
	uint32_t	extentsStartBlock;

	uint32_t 	attributesClumpSize;
	uint32_t 	attributesInitialSize;
	uint32_t 	attributesNodeSize;
	uint32_t	attributesExtsCount;
	uint32_t	attributesStartBlock;

	uint32_t 	allocationClumpSize;
	uint32_t	allocationExtsCount;
	uint32_t	allocationStartBlock;

	uint32_t        createDate;             /* in UTC */
	uint32_t	hfsAlignment;
	unsigned char	*volumeName;		/* In UTF8, but we need to allocate space for it. */
	uint32_t 	journaledHFS;
	uint32_t 	journalSize;
	uint32_t	journalInfoBlock;
	uint32_t	journalBlock;
	char 		*journalDevice;
	uid_t		owner;
	gid_t		group;
	mode_t		mask;
#ifdef DEBUG_BUILD
	uint16_t	protectlevel;
#endif
	uint32_t	fsStartBlock;		/* allocation block offset where the btree allocaiton should start */
	uint32_t	nextAllocBlock;		/* Set VH nextAllocationBlock */
};
typedef struct hfsparams hfsparams_t;

extern int make_hfsplus(const DriveInfo *driveInfo, hfsparams_t *defaults);


#if __STDC__
void	fatal(const char *fmt, ...);
#else
void	fatal();
#endif