bsd/hfs/hfs_catalog.h

   1 /*
   2  * Copyright (c) 2002-2007 Apple 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 #ifndef __HFS_CATALOG__
  29 #define __HFS_CATALOG__
  30
  31 #include <sys/appleapiopts.h>
  32
  33 #ifdef KERNEL
  34 #ifdef __APPLE_API_PRIVATE
  35 #include <sys/vnode.h>
  36
  37 #include <hfs/hfs_format.h>
  38
  39 /* HFS Catalog */
  40
  41
  42 /*
  43  * Catalog ADTs
  44  *
  45  * The cat_desc, cat_attr, and cat_fork structures are
  46  * use to import/export data to/from the Catalog file.
  47  * The fields in these structures are always in BSD
  48  * runtime format (e.g. dates and names).
  49  */
  50
  51 typedef u_int32_t       cnid_t;
  52
  53 /*
  54  * Catalog Node Descriptor (runtime)
  55  */
  56 struct cat_desc {
  57         u_int8_t  cd_flags;       /* see below (8 bits) */
  58         u_int8_t  cd_encoding;    /* name encoding */
  59         int16_t   cd_namelen;     /* length of cnode name */
  60         cnid_t    cd_parentcnid;  /* parent directory CNID */
  61         u_int32_t    cd_hint;        /* catalog file hint */
  62         cnid_t    cd_cnid;        /* cnode id (for getattrlist) */
  63         const u_int8_t * cd_nameptr; /* pointer to cnode name */
  64 };
  65
  66 /* cd_flags */
  67 #define CD_HASBUF       0x01    /* allocated filename buffer */
  68 #define CD_DECOMPOSED   0x02    /* name is fully decomposed */
  69 #define CD_ISMETA       0x40    /* describes a metadata file */
  70 #define CD_ISDIR        0x80    /* describes a directory */
  71
  72 /*
  73  * Catalog Node Attributes (runtime)
  74  */
  75 struct cat_attr {
  76         cnid_t          ca_fileid;      /* inode number (for stat) normally == cnid */
  77         mode_t          ca_mode;        /* file access mode and type (16 bits) */
  78         u_int16_t       ca_recflags;    /* catalog record flags (16 bit integer) */
  79         u_int32_t       ca_linkcount;   /* real hard link count */
  80         uid_t           ca_uid;         /* file owner */
  81         gid_t           ca_gid;         /* file group */
  82         union {
  83             dev_t       cau_rdev;       /* special file device (VBLK or VCHAR only) */
  84             u_int32_t   cau_linkref;    /* hardlink reference number */
  85         } ca_union1;
  86         time_t          ca_atime;       /* last access time */
  87         time_t          ca_atimeondisk; /* access time value on disk */
  88         time_t          ca_mtime;       /* last data modification time */
  89         time_t          ca_ctime;       /* last file status change */
  90         time_t          ca_itime;       /* file initialization time */
  91         time_t          ca_btime;       /* last backup time */
  92         u_int32_t       ca_flags;       /* status flags (chflags) */
  93         union {
  94             u_int32_t   cau_blocks;     /* total file blocks used (rsrc + data) */
  95             u_int32_t   cau_entries;    /* total directory entries (valence) */
  96         } ca_union2;
  97         union {
  98             u_int32_t   cau_dircount;   /* count of sub dirs (for posix nlink) */
  99             u_int32_t   cau_firstlink;  /* first hardlink link (files only) */
 100         } ca_union3;
 101         u_int8_t        ca_finderinfo[32]; /* Opaque Finder information */
 102 };
 103
 104 /* Aliases for common fields */
 105 #define ca_rdev         ca_union1.cau_rdev
 106 #define ca_linkref      ca_union1.cau_linkref
 107 #define ca_blocks       ca_union2.cau_blocks
 108 #define ca_entries      ca_union2.cau_entries
 109 #define ca_dircount     ca_union3.cau_dircount
 110 #define ca_firstlink    ca_union3.cau_firstlink
 111
 112 /*
 113  * Catalog Node Fork (runtime)
 114  *
 115  * NOTE: this is not the same as a struct HFSPlusForkData
 116  *
 117  * NOTE: if cf_new_size > cf_size, then a write is in progress and is extending
 118  * the EOF; the new EOF will be cf_new_size.  Writes and pageouts may validly
 119  * write up to cf_new_size, but reads should only read up to cf_size.  When
 120  * an extending write is not in progress, cf_new_size is zero.
 121  */
 122 struct cat_fork {
 123         off_t          cf_size;        /* fork's logical size in bytes */
 124         off_t          cf_new_size;    /* fork's logical size after write completes */
 125         union {
 126             u_int32_t  cfu_clump;      /* fork's clump size in bytes (sys files only) */
 127             u_int64_t  cfu_bytesread;  /* bytes read from this fork */
 128         } cf_union;
 129         u_int32_t      cf_vblocks;     /* virtual (unalloated) blocks */
 130         u_int32_t      cf_blocks;      /* total blocks used by this fork */
 131         struct HFSPlusExtentDescriptor  cf_extents[8];  /* initial set of extents */
 132 };
 133
 134 #define cf_clump        cf_union.cfu_clump
 135 #define cf_bytesread    cf_union.cfu_bytesread
 136
 137
 138 /*
 139  * Directory Hint
 140  * Used to hold state across directory enumerations.
 141  *
 142  */
 143 struct directoryhint {
 144         TAILQ_ENTRY(directoryhint) dh_link; /* chain */
 145         int     dh_index;                   /* index into directory (zero relative) */
 146         u_int32_t  dh_threadhint;           /* node hint of a directory's thread record */
 147         u_int32_t  dh_time;
 148         struct  cat_desc  dh_desc;          /* entry's descriptor */
 149 };
 150 typedef struct directoryhint directoryhint_t;
 151
 152 /*
 153  * HFS_MAXDIRHINTS cannot be larger than 63 without reducing
 154  * HFS_INDEX_BITS, because given the 6-bit tag, at most 63 different
 155  * tags can exist.  When HFS_MAXDIRHINTS is larger than 63, the same
 156  * list may contain dirhints of the same tag, and a staled dirhint may
 157  * be returned.
 158  */
 159 #define HFS_MAXDIRHINTS 32
 160 #define HFS_DIRHINT_TTL 45
 161
 162 #define HFS_INDEX_MASK  0x03ffffff
 163 #define HFS_INDEX_BITS  26
 164
 165
 166 /*
 167  * Catalog Node Entry
 168  *
 169  * A cat_entry is used for bulk enumerations (hfs_readdirattr).
 170  */
 171 struct cat_entry {
 172         struct cat_desc ce_desc;
 173         struct cat_attr ce_attr;
 174         off_t           ce_datasize;
 175         off_t           ce_rsrcsize;
 176         u_int32_t               ce_datablks;
 177         u_int32_t               ce_rsrcblks;
 178 };
 179
 180 /*
 181  * Starting in 10.5, hfs_vnop_readdirattr() only makes one
 182  * call to cat_getentriesattr(). So we increased MAXCATENTRIES
 183  * while keeping the total size of the CE LIST buffer <= 8K
 184  * (which works out to be 60 entries per call).  The 8K limit
 185  * keeps the memory coming from a kalloc zone instead of
 186  * valuable/fragment-able kernel map space.
 187  */
 188 #define MAXCATENTRIES   \
 189         (1 + (8192 - sizeof (struct cat_entrylist)) / sizeof (struct cat_entry))
 190
 191 /*
 192  * Catalog Node Entry List
 193  *
 194  * A cat_entrylist is a list of Catalog Node Entries.
 195  */
 196 struct cat_entrylist {
 197         u_int32_t  maxentries;    /* number of entries requested */
 198         u_int32_t  realentries;   /* number of valid entries returned */
 199         u_int32_t  skipentries;   /* number of entries skipped (reserved HFS+ files) */
 200         struct cat_entry  entry[1];   /* array of entries */
 201 };
 202
 203 #define CE_LIST_SIZE(entries)   \
 204         sizeof (*ce_list) + (((entries) - 1) * sizeof (struct cat_entry))
 205
 206
 207 /*
 208  * Catalog Operations Hint
 209  *
 210  * lower 16 bits: count of B-tree insert operations
 211  * upper 16 bits: count of B-tree delete operations
 212  *
 213  */
 214 #define CAT_DELETE      0x00010000
 215 #define CAT_CREATE      0x00000002
 216 #define CAT_RENAME      0x00010002
 217 #define CAT_EXCHANGE    0x00010002
 218
 219 typedef u_int32_t       catops_t;
 220
 221 /*
 222  * The size of cat_cookie_t much match the size of
 223  * the nreserve struct (in BTreeNodeReserve.c).
 224  */
 225 typedef struct cat_cookie_t {
 226 #if defined(__LP64__)
 227         char    opaque[40];
 228 #else
 229         char    opaque[24];
 230 #endif
 231 } cat_cookie_t;
 232
 233 /* Universal catalog key */
 234 union CatalogKey {
 235         HFSCatalogKey      hfs;
 236         HFSPlusCatalogKey  hfsPlus;
 237 };
 238 typedef union CatalogKey  CatalogKey;
 239
 240 /* Universal catalog data record */
 241 union CatalogRecord {
 242         int16_t               recordType;
 243         HFSCatalogFolder      hfsFolder;
 244         HFSCatalogFile        hfsFile;
 245         HFSCatalogThread      hfsThread;
 246         HFSPlusCatalogFolder  hfsPlusFolder;
 247         HFSPlusCatalogFile    hfsPlusFile;
 248         HFSPlusCatalogThread  hfsPlusThread;
 249 };
 250 typedef union CatalogRecord  CatalogRecord;
 251
 252
 253 /*
 254  * Catalog Interface
 255  *
 256  * These functions perform a catalog transactions. The
 257  * catalog b-tree is abstracted through this interface.
 258  * (please don't go around it)
 259  */
 260
 261 struct hfsmount;
 262
 263 extern void cat_releasedesc(struct cat_desc *descp);
 264
 265 extern int cat_create ( struct hfsmount *hfsmp,
 266                         struct cat_desc *descp,
 267                         struct cat_attr *attrp,
 268                         struct cat_desc *out_descp);
 269
 270 extern int cat_delete ( struct hfsmount *hfsmp,
 271                         struct cat_desc *descp,
 272                         struct cat_attr *attrp);
 273
 274 extern int cat_lookup ( struct hfsmount *hfsmp,
 275                         struct cat_desc *descp,
 276                         int wantrsrc,
 277                         struct cat_desc *outdescp,
 278                         struct cat_attr *attrp,
 279                         struct cat_fork *forkp,
 280                         cnid_t          *desc_cnid);
 281
 282 extern int cat_idlookup (struct hfsmount *hfsmp,
 283                         cnid_t cnid,
 284                         int allow_system_files,
 285                         struct cat_desc *outdescp,
 286                         struct cat_attr *attrp,
 287                         struct cat_fork *forkp);
 288
 289 extern int cat_findname (struct hfsmount *hfsmp,
 290                          cnid_t cnid,
 291                          struct cat_desc *outdescp);
 292
 293 extern int cat_getentriesattr(
 294                         struct hfsmount *hfsmp,
 295                         directoryhint_t *dirhint,
 296                         struct cat_entrylist *ce_list);
 297
 298 extern int cat_rename ( struct hfsmount * hfsmp,
 299                         struct cat_desc * from_cdp,
 300                         struct cat_desc * todir_cdp,
 301                         struct cat_desc * to_cdp,
 302                         struct cat_desc * cdp);
 303
 304 extern int cat_update ( struct hfsmount *hfsmp,
 305                         struct cat_desc *descp,
 306                         struct cat_attr *attrp,
 307                         struct cat_fork *dataforkp,
 308                         struct cat_fork *rsrcforkp);
 309
 310 extern int cat_getdirentries(
 311                         struct hfsmount *hfsmp,
 312                         int entrycnt,
 313                         directoryhint_t *dirhint,
 314                         uio_t uio,
 315                         int extended,
 316                         int * items,
 317                         int * eofflag);
 318
 319 extern int cat_insertfilethread (
 320                         struct hfsmount *hfsmp,
 321                         struct cat_desc *descp);
 322
 323 extern int cat_preflight(
 324                         struct hfsmount *hfsmp,
 325                         catops_t ops,
 326                         cat_cookie_t *cookie,
 327                         struct proc *p);
 328
 329 extern void cat_postflight(
 330                         struct hfsmount *hfsmp,
 331                         cat_cookie_t *cookie,
 332                         struct proc *p);
 333
 334 extern int cat_binarykeycompare(
 335                         HFSPlusCatalogKey *searchKey,
 336                         HFSPlusCatalogKey *trialKey);
 337
 338 extern int CompareCatalogKeys(
 339                         HFSCatalogKey *searchKey,
 340                         HFSCatalogKey *trialKey);
 341
 342 extern int CompareExtendedCatalogKeys(
 343                         HFSPlusCatalogKey *searchKey,
 344                         HFSPlusCatalogKey *trialKey);
 345
 346 extern void cat_convertattr(
 347                         struct hfsmount *hfsmp,
 348                         CatalogRecord * recp,
 349                         struct cat_attr *attrp,
 350                         struct cat_fork *datafp,
 351                         struct cat_fork *rsrcfp);
 352
 353 extern int cat_convertkey(
 354                         struct hfsmount *hfsmp,
 355                         CatalogKey *key,
 356                         CatalogRecord * recp,
 357                         struct cat_desc *descp);
 358
 359 extern int cat_getkeyplusattr(
 360                         struct hfsmount *hfsmp,
 361                         cnid_t cnid,
 362                         CatalogKey *key,
 363                         struct cat_attr *attrp);
 364
 365 /* Hard link functions. */
 366
 367 extern int cat_check_link_ancestry(
 368                         struct hfsmount *hfsmp,
 369                         cnid_t parentid,
 370                         cnid_t pointed_at_cnid);
 371
 372 extern int cat_set_childlinkbit(
 373                         struct hfsmount *hfsmp,
 374                         cnid_t cnid);
 375
 376 #define HFS_IGNORABLE_LINK  0x00000001
 377
 378 extern int cat_resolvelink( struct hfsmount *hfsmp,
 379                             u_int32_t linkref,
 380                             int isdirlink,
 381                             struct HFSPlusCatalogFile *recp);
 382
 383 extern int cat_createlink( struct hfsmount *hfsmp,
 384                            struct cat_desc *descp,
 385                            struct cat_attr *attr,
 386                            cnid_t nextlinkid,
 387                            cnid_t *linkfileid);
 388
 389 /* Finder Info's file type and creator for directory hard link alias */
 390 enum {
 391         kHFSAliasType    = 0x66647270,  /* 'fdrp' */
 392         kHFSAliasCreator = 0x4D414353   /* 'MACS' */
 393 };
 394
 395 extern int cat_deletelink( struct hfsmount *hfsmp,
 396                            struct cat_desc *descp);
 397
 398 extern int cat_updatelink( struct hfsmount *hfsmp,
 399                            cnid_t linkfileid,
 400                            cnid_t prevlinkid,
 401                            cnid_t nextlinkid);
 402
 403 extern int cat_lookuplink( struct hfsmount *hfsmp,
 404                            struct cat_desc *descp,
 405                            cnid_t *linkfileid,
 406                            cnid_t *prevlinkid,
 407                            cnid_t *nextlinkid);
 408
 409 extern int cat_lookuplinkbyid( struct hfsmount *hfsmp,
 410                                cnid_t linkfileid,
 411                                cnid_t *prevlinkid,
 412                                cnid_t *nextlinkid);
 413
 414
 415 #endif /* __APPLE_API_PRIVATE */
 416 #endif /* KERNEL */
 417 #endif /* __HFS_CATALOG__ */