X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/0b4e3aa066abc0728aacb4bbeb86f53f9737156e..d1ecb069dfe24481e4a83f44cb5217a2b06746d7:/bsd/hfs/hfscommon/headers/FileMgrInternal.h diff --git a/bsd/hfs/hfscommon/headers/FileMgrInternal.h b/bsd/hfs/hfscommon/headers/FileMgrInternal.h index 370dca4e9..a2d1552ee 100644 --- a/bsd/hfs/hfscommon/headers/FileMgrInternal.h +++ b/bsd/hfs/hfscommon/headers/FileMgrInternal.h @@ -1,23 +1,29 @@ /* - * Copyright (c) 2000-2001 Apple Computer, Inc. All rights reserved. + * Copyright (c) 2000-2005 Apple Computer, 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@ */ /* File: FilesInternal.h @@ -32,36 +38,26 @@ #ifndef __FILEMGRINTERNAL__ #define __FILEMGRINTERNAL__ +#include + +#ifdef KERNEL +#ifdef __APPLE_API_PRIVATE + #include #include #include "../../hfs.h" #include "../../hfs_macos_defs.h" #include "../../hfs_format.h" +#include "../../hfs_cnode.h" -#if PRAGMA_ONCE -#pragma once -#endif - #ifdef __cplusplus extern "C" { #endif -#if PRAGMA_IMPORT -#pragma import on -#endif - -#if PRAGMA_STRUCT_ALIGN - #pragma options align=mac68k -#elif PRAGMA_STRUCT_PACKPUSH - #pragma pack(push, 2) -#elif PRAGMA_STRUCT_PACK - #pragma pack(2) -#endif - /* CatalogNodeID is used to track catalog objects */ -typedef UInt32 HFSCatalogNodeID; +typedef u_int32_t HFSCatalogNodeID; /* internal error codes*/ @@ -104,10 +100,13 @@ enum { /* internal flags*/ enum { - kEFContigBit = 1, /* force contiguous allocation*/ - kEFContigMask = 0x02, - kEFAllBit = 0, /* allocate all requested bytes or none*/ - kEFAllMask = 0x01, /* TruncateFile option flags*/ + kEFAllMask = 0x01, /* allocate all requested bytes or none */ + kEFContigMask = 0x02, /* force contiguous allocation */ + kEFReserveMask = 0x04, /* keep block reserve */ + kEFDeferMask = 0x08, /* defer file block allocations */ + kEFNoClumpMask = 0x10, /* don't round up to clump size */ + kEFMetadataMask = 0x20, /* metadata allocation */ + kTFTrunExtBit = 0, /* truncate to the extent containing new PEOF*/ kTFTrunExtMask = 1 }; @@ -121,12 +120,6 @@ enum { }; -enum { - kInvalidMRUCacheKey = -1L, /* flag to denote current MRU cache key is invalid*/ - kDefaultNumMRUCacheBlocks = 16 /* default number of blocks in each cache*/ -}; - - /* Universal Extent Key */ union ExtentKey { @@ -148,25 +141,6 @@ union ExtentRecord { HFSPlusExtentRecord hfsPlus; }; typedef union ExtentRecord ExtentRecord; -/* Universal catalog key */ - -union CatalogKey { - HFSCatalogKey hfs; - HFSPlusCatalogKey hfsPlus; -}; -typedef union CatalogKey CatalogKey; -/* Universal catalog data record */ - -union CatalogRecord { - SInt16 recordType; - HFSCatalogFolder hfsFolder; - HFSCatalogFile hfsFile; - HFSCatalogThread hfsThread; - HFSPlusCatalogFolder hfsPlusFolder; - HFSPlusCatalogFile hfsPlusFile; - HFSPlusCatalogThread hfsPlusThread; -}; -typedef union CatalogRecord CatalogRecord; enum { @@ -174,16 +148,6 @@ enum { }; -enum { - vcbMaxNam = 27, /* volumes currently have a 27 byte max name length*/ - /* VCB flags*/ - vcbManualEjectMask = 0x0001, /* bit 0 manual-eject bit: set if volume is in a manual-eject drive*/ - vcbFlushCriticalInfoMask = 0x0002, /* bit 1 critical info bit: set if critical MDB information needs to flush*/ - /* IoParam->ioVAtrb*/ - kDefaultVolumeMask = 0x0020, - kFilesOpenMask = 0x0040 -}; - /* Universal catalog name*/ @@ -197,325 +161,141 @@ typedef union CatalogName CatalogName; /* * MacOS accessor routines */ -#define GetFileControlBlock(fref) ((FCB *)((fref)->v_data)) -#define GetFileRefNumFromFCB(filePtr) ((filePtr)->h_vp) - - -/* The following macro marks a VCB as dirty by setting the upper 8 bits of the flags*/ -EXTERN_API_C( void ) -MarkVCBDirty (ExtendedVCB *vcb); - -EXTERN_API_C( void ) -MarkVCBClean (ExtendedVCB *vcb); - -EXTERN_API_C( Boolean ) -IsVCBDirty (ExtendedVCB *vcb); - - -#define VCB_LOCK_INIT(vcb) simple_lock_init(&vcb->vcbSimpleLock) -#define VCB_LOCK(vcb) simple_lock(&vcb->vcbSimpleLock) -#define VCB_UNLOCK(vcb) simple_unlock(&vcb->vcbSimpleLock) - -#define MarkVCBDirty(vcb) { VCB_LOCK((vcb)); ((vcb)->vcbFlags |= 0xFF00); VCB_UNLOCK((vcb)); } -#define MarkVCBClean(vcb) { VCB_LOCK((vcb)); ((vcb)->vcbFlags &= 0x00FF); VCB_UNLOCK((vcb)); } -#define IsVCBDirty(vcb) ((Boolean) ((vcb->vcbFlags & 0xFF00) != 0)) - +#define GetFileControlBlock(fref) VTOF((fref)) +#define GetFileRefNumFromFCB(fcb) FTOV((fcb)) /* Test for error and return if error occurred*/ EXTERN_API_C( void ) ReturnIfError (OSErr result); -#define ReturnIfError(result) if ( (result) != noErr ) return (result); else ; -/* Test for passed condition and return if true*/ -EXTERN_API_C( void ) -ReturnErrorIf (Boolean condition, - OSErr result); +#define ReturnIfError(result) do { if ( (result) != noErr ) return (result); } while(0) -#define ReturnErrorIf(condition, error) if ( (condition) ) return( (error) ); /* Exit function on error*/ EXTERN_API_C( void ) ExitOnError (OSErr result); -#define ExitOnError( result ) if ( ( result ) != noErr ) goto ErrorExit; else ; +#define ExitOnError( result ) do { if ( ( result ) != noErr ) goto ErrorExit; } while(0) /* Catalog Manager Routines (IPI)*/ -EXTERN_API_C( OSErr ) -CreateCatalogNode (ExtendedVCB * volume, - HFSCatalogNodeID parentID, - ConstUTF8Param name, - UInt32 nodeType, - HFSCatalogNodeID * catalogNodeID, - UInt32 * catalogHint, - UInt32 teHint); - -EXTERN_API_C( OSErr ) -DeleteCatalogNode (ExtendedVCB * volume, - HFSCatalogNodeID parentID, - ConstUTF8Param name, - UInt32 hint); - -EXTERN_API_C( OSErr ) -GetCatalogNode (ExtendedVCB * volume, - HFSCatalogNodeID parentID, - ConstUTF8Param name, - UInt32 length, - UInt32 hint, - CatalogNodeData * nodeData, - UInt32 * newHint); - -EXTERN_API_C( OSErr ) -GetCatalogOffspring (ExtendedVCB * volume, - HFSCatalogNodeID folderID, - UInt16 index, - CatalogNodeData * nodeData, - HFSCatalogNodeID * nodeID, - SInt16 * nodeType); - -EXTERN_API_C( OSErr ) -MoveRenameCatalogNode (ExtendedVCB * volume, - HFSCatalogNodeID srcParentID, - ConstUTF8Param srcName, - UInt32 srcHint, - HFSCatalogNodeID dstParentID, - ConstUTF8Param dstName, - UInt32 * newHint, - UInt32 teHint); - -EXTERN_API_C( OSErr ) -UpdateCatalogNode (ExtendedVCB * volume, - HFSCatalogNodeID parentID, - ConstUTF8Param name, - UInt32 catalogHint, - const CatalogNodeData * nodeData); - -EXTERN_API_C( OSErr ) -CreateFileIDRef (ExtendedVCB * volume, - HFSCatalogNodeID parentID, - ConstUTF8Param name, - UInt32 hint, - HFSCatalogNodeID * threadID); - EXTERN_API_C( OSErr ) ExchangeFileIDs (ExtendedVCB * volume, ConstUTF8Param srcName, ConstUTF8Param destName, HFSCatalogNodeID srcID, HFSCatalogNodeID destID, - UInt32 srcHint, - UInt32 destHint ); - -EXTERN_API_C( OSErr ) -LinkCatalogNode (ExtendedVCB * volume, - HFSCatalogNodeID parentID, - ConstUTF8Param name, - HFSCatalogNodeID linkParentID, - ConstUTF8Param linkName); - -EXTERN_API_C( SInt32 ) -CompareCatalogKeys (HFSCatalogKey * searchKey, - HFSCatalogKey * trialKey); + u_int32_t srcHint, + u_int32_t destHint ); -EXTERN_API_C( SInt32 ) -CompareExtendedCatalogKeys (HFSPlusCatalogKey * searchKey, - HFSPlusCatalogKey * trialKey); - -EXTERN_API_C( OSErr ) -InitCatalogCache (void); - -EXTERN_API_C( void ) -InvalidateCatalogCache (ExtendedVCB * volume); - - -/* GenericMRUCache Routines*/ -EXTERN_API_C( OSErr ) -InitMRUCache (UInt32 bufferSize, - UInt32 numCacheBlocks, - Ptr * cachePtr); - -EXTERN_API_C( OSErr ) -DisposeMRUCache (Ptr cachePtr); - -EXTERN_API_C( void ) -TrashMRUCache (Ptr cachePtr); - -EXTERN_API_C( OSErr ) -GetMRUCacheBlock (UInt32 key, - Ptr cachePtr, - Ptr * buffer); - -EXTERN_API_C( void ) -InvalidateMRUCacheBlock (Ptr cachePtr, - Ptr buffer); - -EXTERN_API_C( void ) -InsertMRUCacheBlock (Ptr cachePtr, - UInt32 key, - Ptr buffer); /* BTree Manager Routines*/ -typedef CALLBACK_API_C( SInt32 , KeyCompareProcPtr )(void *a, void *b); - - -EXTERN_API_C( OSErr ) -SearchBTreeRecord (FileReference refNum, - const void * key, - UInt32 hint, - void * foundKey, - void * data, - UInt16 * dataSize, - UInt32 * newHint); - -EXTERN_API_C( OSErr ) -InsertBTreeRecord (FileReference refNum, - void * key, - void * data, - UInt16 dataSize, - UInt32 * newHint); +typedef CALLBACK_API_C( int32_t , KeyCompareProcPtr )(void *a, void *b); -EXTERN_API_C( OSErr ) -DeleteBTreeRecord (FileReference refNum, - void * key); EXTERN_API_C( OSErr ) ReplaceBTreeRecord (FileReference refNum, const void * key, - UInt32 hint, + u_int32_t hint, void * newData, - UInt16 dataSize, - UInt32 * newHint); - -/* Prototypes for C->Asm glue*/ -EXTERN_API_C( OSErr ) -GetBlock_glue (UInt16 flags, - UInt32 nodeNumber, - Ptr * nodeBuffer, - FileReference refNum, - ExtendedVCB * vcb); + u_int16_t dataSize, + u_int32_t * newHint); -EXTERN_API_C( OSErr ) -RelBlock_glue (Ptr nodeBuffer, - UInt16 flags); /* Prototypes for exported routines in VolumeAllocation.c*/ EXTERN_API_C( OSErr ) BlockAllocate (ExtendedVCB * vcb, - UInt32 startingBlock, - SInt64 bytesRequested, - SInt64 bytesMaximum, + u_int32_t startingBlock, + u_int32_t minBlocks, + u_int32_t maxBlocks, Boolean forceContiguous, - UInt32 * startBlock, - UInt32 * actualBlocks); + Boolean useMetaZone, + u_int32_t * startBlock, + u_int32_t * actualBlocks); EXTERN_API_C( OSErr ) BlockDeallocate (ExtendedVCB * vcb, - UInt32 firstBlock, - UInt32 numBlocks); + u_int32_t firstBlock, + u_int32_t numBlocks); + +EXTERN_API_C ( void ) +invalidate_free_extent_cache (ExtendedVCB * vcb); + +EXTERN_API_C( OSErr ) +BlockMarkAllocated(ExtendedVCB *vcb, u_int32_t startingBlock, u_int32_t numBlocks); + +EXTERN_API_C( OSErr ) +BlockMarkFree( ExtendedVCB *vcb, u_int32_t startingBlock, u_int32_t numBlocks); -EXTERN_API_C( UInt32 ) -FileBytesToBlocks (SInt64 numerator, - UInt32 denominator); +EXTERN_API_C( u_int32_t ) +MetaZoneFreeBlocks(ExtendedVCB *vcb); /* File Extent Mapping routines*/ EXTERN_API_C( OSErr ) FlushExtentFile (ExtendedVCB * vcb); -EXTERN_API_C( SInt32 ) +EXTERN_API_C( int32_t ) CompareExtentKeys (const HFSExtentKey * searchKey, const HFSExtentKey * trialKey); -EXTERN_API_C( SInt32 ) +EXTERN_API_C( int32_t ) CompareExtentKeysPlus (const HFSPlusExtentKey *searchKey, const HFSPlusExtentKey *trialKey); -EXTERN_API_C( OSErr ) -DeleteFile (ExtendedVCB * vcb, - HFSCatalogNodeID parDirID, - ConstUTF8Param catalogName, - UInt32 catalogHint); - EXTERN_API_C( OSErr ) TruncateFileC (ExtendedVCB * vcb, FCB * fcb, - SInt64 peof, + int64_t peof, Boolean truncateToExtent); EXTERN_API_C( OSErr ) ExtendFileC (ExtendedVCB * vcb, FCB * fcb, - SInt64 bytesToAdd, - UInt32 blockHint, - UInt32 flags, - SInt64 * actualBytesAdded); + int64_t bytesToAdd, + u_int32_t blockHint, + u_int32_t flags, + int64_t * actualBytesAdded); EXTERN_API_C( OSErr ) MapFileBlockC (ExtendedVCB * vcb, FCB * fcb, size_t numberOfBytes, off_t offset, - daddr_t * startBlock, + daddr64_t * startBlock, size_t * availableBytes); +OSErr HeadTruncateFile(ExtendedVCB *vcb, FCB *fcb, u_int32_t headblks); + +EXTERN_API_C( int ) +AddFileExtent (ExtendedVCB *vcb, FCB *fcb, u_int32_t startBlock, u_int32_t blockCount); + #if TARGET_API_MACOS_X EXTERN_API_C( Boolean ) NodesAreContiguous (ExtendedVCB * vcb, FCB * fcb, - UInt32 nodeSize); + u_int32_t nodeSize); #endif -/* Utility routines*/ - -EXTERN_API_C( void ) -ClearMemory (void * start, - UInt32 length); - -EXTERN_API_C( OSErr ) -VolumeWritable (ExtendedVCB * vcb); /* Get the current time in UTC (GMT)*/ -EXTERN_API_C( UInt32 ) +EXTERN_API_C( u_int32_t ) GetTimeUTC (void); -/* Get the current local time*/ -EXTERN_API_C( UInt32 ) -GetTimeLocal (Boolean forHFS); - -EXTERN_API_C( UInt32 ) -LocalToUTC (UInt32 localTime); - -EXTERN_API_C( UInt32 ) -UTCToLocal (UInt32 utcTime); - - -/* Volumes routines*/ -EXTERN_API_C( OSErr ) -FlushVolumeControlBlock (ExtendedVCB * vcb); - -EXTERN_API_C( OSErr ) -ValidVolumeHeader (HFSPlusVolumeHeader * volumeHeader); +EXTERN_API_C( u_int32_t ) +LocalToUTC (u_int32_t localTime); +EXTERN_API_C( u_int32_t ) +UTCToLocal (u_int32_t utcTime); -#if PRAGMA_STRUCT_ALIGN - #pragma options align=reset -#elif PRAGMA_STRUCT_PACKPUSH - #pragma pack(pop) -#elif PRAGMA_STRUCT_PACK - #pragma pack() -#endif - -#ifdef PRAGMA_IMPORT_OFF -#pragma import off -#elif PRAGMA_IMPORT -#pragma import reset -#endif #ifdef __cplusplus } #endif +#endif /* __APPLE_API_PRIVATE */ +#endif /* KERNEL */ #endif /* __FILEMGRINTERNAL__ */