bsd/hfs/hfscommon/headers/FileMgrInternal.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29         File:           FilesInternal.h
  30
  31         Contains:       IPI for File Manager (HFS Plus)
  32
  33         Version:        HFS Plus 1.0
  34
  35         Copyright:      © 1996-2001 by Apple Computer, Inc., all rights reserved.
  36
  37 */
  38 #ifndef __FILEMGRINTERNAL__
  39 #define __FILEMGRINTERNAL__
  40
  41 #include <sys/appleapiopts.h>
  42
  43 #ifdef KERNEL
  44 #ifdef __APPLE_API_PRIVATE
  45
  46 #include <sys/param.h>
  47 #include <sys/vnode.h>
  48
  49 #include "../../hfs.h"
  50 #include "../../hfs_macos_defs.h"
  51 #include "../../hfs_format.h"
  52 #include "../../hfs_cnode.h"
  53
  54
  55 #if PRAGMA_ONCE
  56 #pragma once
  57 #endif
  58
  59 #ifdef __cplusplus
  60 extern "C" {
  61 #endif
  62
  63 #if PRAGMA_IMPORT
  64 #pragma import on
  65 #endif
  66
  67 #if PRAGMA_STRUCT_ALIGN
  68         #pragma options align=mac68k
  69 #elif PRAGMA_STRUCT_PACKPUSH
  70         #pragma pack(push, 2)
  71 #elif PRAGMA_STRUCT_PACK
  72         #pragma pack(2)
  73 #endif
  74
  75 /* CatalogNodeID is used to track catalog objects */
  76 typedef UInt32          HFSCatalogNodeID;
  77
  78 /* internal error codes*/
  79
  80 #if TARGET_API_MACOS_X
  81   #define ERR_BASE      -32767
  82 #else
  83   #define ERR_BASE      0
  84 #endif
  85
  86 enum {
  87                                                                                                                                 /* FXM errors*/
  88         fxRangeErr                                      = ERR_BASE + 16,                                /* file position beyond mapped range*/
  89         fxOvFlErr                                       = ERR_BASE + 17,                                /* extents file overflow*/
  90                                                                                                                                 /* Unicode errors*/
  91         uniTooLongErr                           = ERR_BASE + 24,                                /* Unicode string too long to convert to Str31*/
  92         uniBufferTooSmallErr            = ERR_BASE + 25,                                /* Unicode output buffer too small*/
  93         uniNotMappableErr                       = ERR_BASE + 26,                                /* Unicode string can't be mapped to given script*/
  94                                                                                                                                 /* BTree Manager errors*/
  95         btNotFound                                      = ERR_BASE + 32,                                /* record not found*/
  96         btExists                                        = ERR_BASE + 33,                                /* record already exists*/
  97         btNoSpaceAvail                          = ERR_BASE + 34,                                /* no available space*/
  98         btNoFit                                         = ERR_BASE + 35,                                /* record doesn't fit in node */
  99         btBadNode                                       = ERR_BASE + 36,                                /* bad node detected*/
 100         btBadHdr                                        = ERR_BASE + 37,                                /* bad BTree header record detected*/
 101         dsBadRotate                                     = ERR_BASE + 64,                                /* bad BTree rotate*/
 102                                                                                                                                 /* Catalog Manager errors*/
 103         cmNotFound                                      = ERR_BASE + 48,                                /* CNode not found*/
 104         cmExists                                        = ERR_BASE + 49,                                /* CNode already exists*/
 105         cmNotEmpty                                      = ERR_BASE + 50,                                /* directory CNode not empty (valence = 0)*/
 106         cmRootCN                                        = ERR_BASE + 51,                                /* invalid reference to root CNode*/
 107         cmBadNews                                       = ERR_BASE + 52,                                /* detected bad catalog structure*/
 108         cmFThdDirErr                            = ERR_BASE + 53,                                /* thread belongs to a directory not a file*/
 109         cmFThdGone                                      = ERR_BASE + 54,                                /* file thread doesn't exist*/
 110         cmParentNotFound                        = ERR_BASE + 55,                                /* CNode for parent ID does not exist*/
 111                                                                                                                                 /* TFS internal errors*/
 112         fsDSIntErr                                      = -127                                                  /* Internal file system error*/
 113 };
 114
 115
 116 /* internal flags*/
 117
 118 enum {
 119         kEFAllMask      = 0x01,   /* allocate all requested bytes or none */
 120         kEFContigMask   = 0x02,   /* force contiguous allocation */
 121         kEFReserveMask  = 0x04,   /* keep block reserve */
 122         kEFDeferMask    = 0x08,   /* defer file block allocations */
 123         kEFNoClumpMask  = 0x10,   /* don't round up to clump size */
 124         kEFMetadataMask  = 0x20,  /* metadata allocation */
 125
 126         kTFTrunExtBit                           = 0,                                                    /*      truncate to the extent containing new PEOF*/
 127         kTFTrunExtMask                          = 1
 128 };
 129
 130 enum {
 131         kUndefinedStrLen                        = 0,                                                    /* Unknown string length */
 132         kNoHint                                         = 0,
 133
 134                                                                                                                                 /*      FileIDs variables*/
 135         kNumExtentsToCache                      = 4                                                             /*      just guessing for ExchangeFiles*/
 136 };
 137
 138
 139 /* Universal Extent Key */
 140
 141 union ExtentKey {
 142         HFSExtentKey                                    hfs;
 143         HFSPlusExtentKey                                hfsPlus;
 144 };
 145 typedef union ExtentKey                                 ExtentKey;
 146 /* Universal extent descriptor */
 147
 148 union ExtentDescriptor {
 149         HFSExtentDescriptor                     hfs;
 150         HFSPlusExtentDescriptor                 hfsPlus;
 151 };
 152 typedef union ExtentDescriptor                  ExtentDescriptor;
 153 /* Universal extent record */
 154
 155 union ExtentRecord {
 156         HFSExtentRecord                                 hfs;
 157         HFSPlusExtentRecord                     hfsPlus;
 158 };
 159 typedef union ExtentRecord                              ExtentRecord;
 160
 161
 162 enum {
 163         CMMaxCName                                      = kHFSMaxFileNameChars
 164 };
 165
 166
 167
 168 /* Universal catalog name*/
 169
 170 union CatalogName {
 171         Str31                                                   pstr;
 172         HFSUniStr255                                    ustr;
 173 };
 174 typedef union CatalogName CatalogName;
 175
 176
 177 /*
 178  * MacOS accessor routines
 179  */
 180 #define GetFileControlBlock(fref)               VTOF((fref))
 181 #define GetFileRefNumFromFCB(fcb)               FTOV((fcb))
 182
 183
 184 /*      The following macro marks a VCB as dirty by setting the upper 8 bits of the flags*/
 185 EXTERN_API_C( void )
 186 MarkVCBDirty                                    (ExtendedVCB *vcb);
 187
 188 EXTERN_API_C( void )
 189 MarkVCBClean                                    (ExtendedVCB *vcb);
 190
 191 EXTERN_API_C( Boolean )
 192 IsVCBDirty                                              (ExtendedVCB *vcb);
 193
 194
 195 #define MarkVCBDirty(vcb)               { ((vcb)->vcbFlags |= 0xFF00); }
 196 #define MarkVCBClean(vcb)               { ((vcb)->vcbFlags &= 0x00FF); }
 197 #define IsVCBDirty(vcb)                 ((Boolean) ((vcb->vcbFlags & 0xFF00) != 0))
 198
 199
 200 /*      Test for error and return if error occurred*/
 201 EXTERN_API_C( void )
 202 ReturnIfError                                   (OSErr                                  result);
 203
 204 #define ReturnIfError(result)                                   if ( (result) != noErr ) return (result); else ;
 205
 206 /*      Exit function on error*/
 207 EXTERN_API_C( void )
 208 ExitOnError                                             (OSErr                                  result);
 209
 210 #define ExitOnError( result )                                   if ( ( result ) != noErr )      goto ErrorExit; else ;
 211
 212
 213
 214 /* Catalog Manager Routines (IPI)*/
 215
 216 EXTERN_API_C( OSErr )
 217 ExchangeFileIDs                                 (ExtendedVCB *                  volume,
 218                                                                  ConstUTF8Param                 srcName,
 219                                                                  ConstUTF8Param                 destName,
 220                                                                  HFSCatalogNodeID               srcID,
 221                                                                  HFSCatalogNodeID               destID,
 222                                                                  UInt32                                 srcHint,
 223                                                                  UInt32                                 destHint );
 224
 225
 226 /* BTree Manager Routines*/
 227
 228 typedef CALLBACK_API_C( SInt32 , KeyCompareProcPtr )(void *a, void *b);
 229
 230
 231 EXTERN_API_C( OSErr )
 232 SearchBTreeRecord                               (FileReference                          refNum,
 233                                                                  const void *                   key,
 234                                                                  UInt32                                 hint,
 235                                                                  void *                                 foundKey,
 236                                                                  void *                                 data,
 237                                                                  UInt16 *                               dataSize,
 238                                                                  UInt32 *                               newHint);
 239
 240 EXTERN_API_C( OSErr )
 241 ReplaceBTreeRecord                              (FileReference                          refNum,
 242                                                                  const void *                   key,
 243                                                                  UInt32                                 hint,
 244                                                                  void *                                 newData,
 245                                                                  UInt16                                 dataSize,
 246                                                                  UInt32 *                               newHint);
 247
 248
 249 /*      Prototypes for exported routines in VolumeAllocation.c*/
 250 EXTERN_API_C( OSErr )
 251 BlockAllocate                                   (ExtendedVCB *                  vcb,
 252                                                                  UInt32                                 startingBlock,
 253                                                                  UInt32                                 minBlocks,
 254                                                                  UInt32                                 maxBlocks,
 255                                                                  Boolean                                forceContiguous,
 256                                                                  Boolean                                useMetaZone,
 257                                                                  UInt32 *                               startBlock,
 258                                                                  UInt32 *                               actualBlocks);
 259
 260 EXTERN_API_C( OSErr )
 261 BlockDeallocate                                 (ExtendedVCB *                  vcb,
 262                                                                  UInt32                                 firstBlock,
 263                                                                  UInt32                                 numBlocks);
 264
 265 EXTERN_API_C( OSErr )
 266 BlockMarkAllocated(ExtendedVCB *vcb, UInt32 startingBlock, UInt32 numBlocks);
 267
 268 EXTERN_API_C( OSErr )
 269 BlockMarkFree( ExtendedVCB *vcb, UInt32 startingBlock, UInt32 numBlocks);
 270
 271 EXTERN_API_C( UInt32 )
 272 MetaZoneFreeBlocks(ExtendedVCB *vcb);
 273
 274 /*      File Extent Mapping routines*/
 275 EXTERN_API_C( OSErr )
 276 FlushExtentFile                                 (ExtendedVCB *                  vcb);
 277
 278 EXTERN_API_C( SInt32 )
 279 CompareExtentKeys                               (const HFSExtentKey *   searchKey,
 280                                                                  const HFSExtentKey *   trialKey);
 281
 282 EXTERN_API_C( SInt32 )
 283 CompareExtentKeysPlus                   (const HFSPlusExtentKey *searchKey,
 284                                                                  const HFSPlusExtentKey *trialKey);
 285
 286 EXTERN_API_C( OSErr )
 287 TruncateFileC                                   (ExtendedVCB *                  vcb,
 288                                                                  FCB *                                  fcb,
 289                                                                  SInt64                                 peof,
 290                                                                  Boolean                                truncateToExtent);
 291
 292 EXTERN_API_C( OSErr )
 293 ExtendFileC                                             (ExtendedVCB *                  vcb,
 294                                                                  FCB *                                  fcb,
 295                                                                  SInt64                                 bytesToAdd,
 296                                                                  UInt32                                 blockHint,
 297                                                                  UInt32                                 flags,
 298                                                                  SInt64 *                               actualBytesAdded);
 299
 300 EXTERN_API_C( OSErr )
 301 MapFileBlockC                                   (ExtendedVCB *                  vcb,
 302                                                                  FCB *                                  fcb,
 303                                                                  size_t                                 numberOfBytes,
 304                                                                  off_t                                  offset,
 305                                                                  daddr64_t *                            startBlock,
 306                                                                  size_t *                               availableBytes);
 307
 308 OSErr HeadTruncateFile(ExtendedVCB  *vcb, FCB  *fcb, UInt32  headblks);
 309
 310 EXTERN_API_C( int )
 311 AddFileExtent (ExtendedVCB *vcb, FCB *fcb, UInt32 startBlock, UInt32 blockCount);
 312
 313 #if TARGET_API_MACOS_X
 314 EXTERN_API_C( Boolean )
 315 NodesAreContiguous                              (ExtendedVCB *                  vcb,
 316                                                                  FCB *                                  fcb,
 317                                                                  UInt32                                 nodeSize);
 318 #endif
 319
 320
 321
 322 /*      Get the current time in UTC (GMT)*/
 323 EXTERN_API_C( UInt32 )
 324 GetTimeUTC                                              (void);
 325
 326 EXTERN_API_C( UInt32 )
 327 LocalToUTC                                              (UInt32                                 localTime);
 328
 329 EXTERN_API_C( UInt32 )
 330 UTCToLocal                                              (UInt32                                 utcTime);
 331
 332
 333 #if PRAGMA_STRUCT_ALIGN
 334         #pragma options align=reset
 335 #elif PRAGMA_STRUCT_PACKPUSH
 336         #pragma pack(pop)
 337 #elif PRAGMA_STRUCT_PACK
 338         #pragma pack()
 339 #endif
 340
 341 #ifdef PRAGMA_IMPORT_OFF
 342 #pragma import off
 343 #elif PRAGMA_IMPORT
 344 #pragma import reset
 345 #endif
 346
 347 #ifdef __cplusplus
 348 }
 349 #endif
 350
 351 #endif /* __APPLE_API_PRIVATE */
 352 #endif /* KERNEL */
 353 #endif /* __FILEMGRINTERNAL__ */
 354