]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/hfs/hfscommon/headers/BTreesInternal.h
xnu-792.17.14.tar.gz
[apple/xnu.git] / bsd / hfs / hfscommon / headers / BTreesInternal.h
index d692e1a5295d234d7ffcfe7339117a8b058b0aeb..ef0906cd40b879649aa8c1b896df70b2a6650a7b 100644 (file)
@@ -1,23 +1,29 @@
 /*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2004 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:           BTreesInternal.h
 #ifndef        __BTREESINTERNAL__
 #define __BTREESINTERNAL__
 
+#include <sys/appleapiopts.h>
+
+#ifdef KERNEL
+#ifdef __APPLE_API_PRIVATE
+
 #ifndef __FILEMGRINTERNAL__
 #include "FileMgrInternal.h"
 #endif
@@ -108,18 +119,20 @@ enum {
 struct BlockDescriptor{
        void            *buffer;
        void            *blockHeader;
+       daddr64_t        blockNum;      /* logical block number (used by hfs_swap_BTNode) */
        ByteCount        blockSize;
        Boolean          blockReadFromDisk;
-       Byte             reserved[3];
+       Byte         isModified;             // XXXdbg - for journaling
+       Byte             reserved[2];
 };
 typedef struct BlockDescriptor BlockDescriptor;
 typedef BlockDescriptor *BlockDescPtr;
 
 
 struct FSBufferDescriptor {
-       LogicalAddress                                  bufferAddress;
-       ByteCount                                               itemSize;
-       ItemCount                                               itemCount;
+       void *          bufferAddress;
+       ByteCount       itemSize;
+       ItemCount       itemCount;
 };
 typedef struct FSBufferDescriptor FSBufferDescriptor;
 
@@ -148,7 +161,7 @@ enum {
 };
 typedef OptionBits     ReleaseBlockOptions;
 
-typedef        UInt32  FSSize;
+typedef        UInt64  FSSize;
 typedef        UInt32  ForkBlockNumber;
 
 /*============================================================================
@@ -211,6 +224,8 @@ enum BTreeTypes{
        kReservedBTreeType              = 255           //
 };
 
+#define        kBTreeHeaderUserBytes   128
+
 
 typedef BTreeKey *BTreeKeyPtr;
 
@@ -227,7 +242,8 @@ struct BTreeInfoRec{
        ItemCount                       numRecords;
        ItemCount                       numNodes;
        ItemCount                       numFreeNodes;
-       UInt32                          reserved;
+       UInt8                           keyCompareType;
+       UInt8                           reserved[3];
 };
 typedef struct BTreeInfoRec BTreeInfoRec;
 typedef BTreeInfoRec *BTreeInfoPtr;
@@ -271,21 +287,16 @@ typedef BTreeIterator *BTreeIteratorPtr;
 //typedef SInt32                               (* KeyCompareProcPtr)(BTreeKeyPtr a, BTreeKeyPtr b);
 
 
-typedef SInt32 (* IterateCallBackProcPtr)(BTreeKeyPtr key, void * record, UInt16 recordLen, void * state);
+typedef SInt32 (* IterateCallBackProcPtr)(BTreeKeyPtr key, void * record, void * state);
 
-extern OSStatus        BTOpenPath                      (FCB                                            *filePtr,
-                                                                        KeyCompareProcPtr                       keyCompareProc,
-                                                                        GetBlockProcPtr                         getBlockProc,
-                                                                        ReleaseBlockProcPtr             releaseBlockProc,
-                                                                        SetEndOfForkProcPtr             setEndOfForkProc,
-                                                                        SetBlockSizeProcPtr             setBlockSizeProc );
+
+extern OSStatus        BTOpenPath(FCB *filePtr, KeyCompareProcPtr keyCompareProc);
 
 extern OSStatus        BTClosePath                     (FCB                                            *filePtr );
 
 
 extern OSStatus        BTSearchRecord          (FCB                                            *filePtr,
                                                                         BTreeIterator                          *searchIterator,
-                                                                        UInt32                                         heuristicHint,
                                                                         FSBufferDescriptor                     *btRecord,
                                                                         UInt16                                         *recordLen,
                                                                         BTreeIterator                          *resultIterator );
@@ -310,12 +321,16 @@ extern OSStatus   BTReplaceRecord         (FCB                                            *filePtr,
                                                                         FSBufferDescriptor                     *btRecord,
                                                                         UInt16                                          recordLen );
 
+extern OSStatus        BTUpdateRecord          (FCB                                            *filePtr,
+                                                                        BTreeIterator                          *iterator,
+                                                                        IterateCallBackProcPtr          callBackProc,
+                                                                        void                                           *callBackState );
 
 extern OSStatus        BTDeleteRecord          (FCB                                            *filePtr,
                                                                         BTreeIterator                          *iterator );
 
 extern OSStatus        BTGetInformation        (FCB                                            *filePtr,
-                                                                        UInt16                                          version,
+                                                                        UInt16                                          vers,
                                                                         BTreeInfoRec                           *info );
 
 extern OSStatus        BTFlushPath                     (FCB                                            *filePtr );
@@ -330,4 +345,20 @@ extern OSStatus    BTGetLastSync           (FCB                                            *filePtr,
 extern OSStatus        BTSetLastSync           (FCB                                            *filePtr,
                                                                         UInt32                                         lastfsync );
 
+extern OSStatus        BTHasContiguousNodes(FCB                                                *filePtr);
+
+extern OSStatus BTGetUserData(FCB *filePtr, void * dataPtr, int dataSize);
+
+extern OSStatus BTSetUserData(FCB *filePtr, void * dataPtr, int dataSize);
+
+/* B-tree node reserve routines. */
+extern void BTReserveSetup(void);
+
+extern int  BTReserveSpace(FCB *file, int operations, void * data);
+
+extern int  BTReleaseReserve(FCB *file, void * data);
+
+
+#endif /* __APPLE_API_PRIVATE */
+#endif /* KERNEL */
 #endif // __BTREESINTERNAL__