xnu-517.3.7.tar.gz

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

diff --git a/bsd/hfs/hfs_catalog.h b/bsd/hfs/hfs_catalog.h
index da27320b137f6f74437d06064564189c9d6ba41a..6f6becd2d8012ecd2adb1ee68a9f1687760d45cb 100644 (file)
--- a/bsd/hfs/hfs_catalog.h
+++ b/bsd/hfs/hfs_catalog.h
@@ -1,21 +1,24 @@
 /*
- * Copyright (c) 2002 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2002-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.
+ * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
  * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * 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 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@
  */
@@ -62,6 +65,7 @@ struct cat_desc {
 /* cd_flags */
 #define        CD_HASBUF       0x01    /* allocated filename buffer */
 #define CD_DECOMPOSED  0x02    /* name is fully decomposed */
+#define        CD_ISMETA       0x40    /* describes a metadata file */
 #define        CD_ISDIR        0x80    /* describes a directory */
 
 /*
@@ -92,15 +96,24 @@ struct cat_attr {
 #define        ca_entries      ca_union.cau_entries
 
 /*
- * Catalog Node Fork (runtime + on disk)
+ * Catalog Node Fork (runtime)
+ *
+ * NOTE: this is not the same as a struct HFSPlusForkData
  */
 struct cat_fork {
-       u_int64_t       cf_size;        /* fork's logical size in bytes */
-       u_int32_t       cf_clump;       /* fork's clump size in bytes */
-       u_int32_t       cf_blocks;      /* total blocks used by this fork */
-       struct HFSPlusExtentDescriptor  cf_extents[8];  /* initial set of extents */
+       u_int64_t      cf_size;        /* fork's logical size in bytes */
+       union {
+           u_int32_t  cfu_clump;      /* fork's clump size in bytes (sys files only) */
+           u_int64_t  cfu_bytesread;  /* bytes read from this fork */
+       } cf_union;
+       u_int32_t      cf_vblocks;     /* virtual (unalloated) blocks */
+       u_int32_t      cf_blocks;      /* total blocks used by this fork */
+       struct HFSPlusExtentDescriptor  cf_extents[8];  /* initial set of extents */
 };
 
+#define cf_clump       cf_union.cfu_clump
+#define cf_bytesread   cf_union.cfu_bytesread
+
 
 /*
  * Catalog Node Entry
@@ -128,6 +141,28 @@ struct cat_entrylist {
        struct cat_entry  entry[MAXCATENTRIES];   /* array of entries */
 };
 
+/*
+ * Catalog Operations Hint
+ *
+ * lower 16 bits: count of B-tree insert operations
+ * upper 16 bits: count of B-tree delete operations
+ *
+ */
+#define CAT_DELETE     0x00020000
+#define CAT_CREATE     0x00000002
+#define CAT_RENAME     0x00020002
+#define CAT_EXCHANGE   0x00020002
+
+typedef u_int32_t      catops_t;
+
+/*
+ * The size of cat_cookie_t much match the size of
+ * the nreserve struct (in BTreeNodeReserve.c).
+ */
+typedef        struct cat_cookie_t {
+       char    opaque[24];
+} cat_cookie_t;
+
 /*
  * Catalog Interface
  *
@@ -183,13 +218,31 @@ extern int cat_update (   struct hfsmount *hfsmp,
 extern int cat_getdirentries(
                        struct hfsmount *hfsmp,
                        struct cat_desc *descp,
+                       int entrycnt,
                        struct uio *uio,
-                       int *eofflag);
+                       int *eofflag,
+                       u_long *cookies,
+                       int ncookies);
 
 extern int cat_insertfilethread (
                        struct hfsmount *hfsmp,
                        struct cat_desc *descp);
 
+extern int cat_preflight(
+                       struct hfsmount *hfsmp,
+                       catops_t ops,
+                       cat_cookie_t *cookie,
+                       struct proc *p);
+
+extern void cat_postflight(
+                       struct hfsmount *hfsmp,
+                       cat_cookie_t *cookie,
+                       struct proc *p);
+
+extern int cat_binarykeycompare(
+                       HFSPlusCatalogKey *searchKey,
+                       HFSPlusCatalogKey *trialKey);
+
 #endif /* __APPLE_API_PRIVATE */
 #endif /* KERNEL */
 #endif /* __HFS_CATALOG__ */