bsd/hfs/hfs.h

   1 /*
   2  * Copyright (c) 2000-2010 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
  29 #ifndef __HFS__
  30 #define __HFS__
  31
  32 /* If set to 1, enables the code to allocate blocks from the start
  33  * of the disk instead of the nextAllocation for sparse devices like
  34  * sparse disk images or sparsebundle images.  The free extent cache
  35  * for such volumes is also maintained based on the start block instead
  36  * of number of contiguous allocation blocks.  These devices prefer
  37  * allocation of blocks near the start of the disk to avoid the
  38  * increasing the image size, but it can also result in file fragmentation.
  39  */
  40 #define HFS_SPARSE_DEV 1
  41
  42 #if DEBUG
  43 #define HFS_CHECK_LOCK_ORDER 1
  44 #endif
  45
  46 #include <sys/appleapiopts.h>
  47
  48 #ifdef KERNEL
  49 #ifdef __APPLE_API_PRIVATE
  50 #include <sys/param.h>
  51 #include <sys/queue.h>
  52 #include <sys/mount.h>
  53 #include <sys/vnode.h>
  54 #include <sys/quota.h>
  55 #include <sys/dirent.h>
  56 #include <sys/event.h>
  57 #include <sys/disk.h>
  58 #include <kern/thread_call.h>
  59
  60 #include <kern/locks.h>
  61
  62 #include <vfs/vfs_journal.h>
  63
  64 #include <hfs/hfs_format.h>
  65 #include <hfs/hfs_catalog.h>
  66 #include <hfs/hfs_cnode.h>
  67 #include <hfs/hfs_macos_defs.h>
  68 #include <hfs/hfs_encodings.h>
  69 #include <hfs/hfs_hotfiles.h>
  70
  71 #if CONFIG_HFS_ALLOC_RBTREE
  72 #include <hfs/hfscommon/headers/HybridAllocator.h>
  73 #endif
  74
  75 /*
  76  *      Just reported via MIG interface.
  77  */
  78 #define VERSION_STRING  "hfs-2 (4-12-99)"
  79
  80 #define HFS_LINK_MAX    32767
  81
  82 #define HFS_MAX_DEFERED_ALLOC   (1024*1024)
  83
  84 // 400 megs is a "big" file (i.e. one that when deleted
  85 // would touch enough data that we should break it into
  86 // multiple separate transactions)
  87 #define HFS_BIGFILE_SIZE (400LL * 1024LL * 1024LL)
  88
  89
  90 enum { kMDBSize = 512 };                                /* Size of I/O transfer to read entire MDB */
  91
  92 enum { kMasterDirectoryBlock = 2 };                     /* MDB offset on disk in 512-byte blocks */
  93 enum { kMDBOffset = kMasterDirectoryBlock * 512 };      /* MDB offset on disk in bytes */
  94
  95 #define kRootDirID kHFSRootFolderID
  96
  97
  98 /* number of locked buffer caches to hold for b-tree meta data */
  99 #define kMaxLockedMetaBuffers           32
 100
 101 extern struct timezone gTimeZone;
 102
 103
 104 /* How many free extents to cache per volume */
 105 #define kMaxFreeExtents         10
 106
 107 /*
 108  * HFS_MINFREE gives the minimum acceptable percentage
 109  * of file system blocks which may be free (but this
 110  * minimum will never exceed HFS_MAXRESERVE bytes). If
 111  * the free block count drops below this level only the
 112  * superuser may continue to allocate blocks.
 113  */
 114 #define HFS_MINFREE             1
 115 #define HFS_MAXRESERVE          ((u_int64_t)(250*1024*1024))
 116
 117 /*
 118  * The system distinguishes between the desirable low-disk
 119  * notifiaction levels for root volumes and non-root volumes.
 120  * The various thresholds are computed as a fraction of the
 121  * volume size, all capped at a certain fixed level
 122  */
 123
 124 #define HFS_ROOTVERYLOWDISKTRIGGERFRACTION 5
 125 #define HFS_ROOTVERYLOWDISKTRIGGERLEVEL ((u_int64_t)(512*1024*1024))
 126 #define HFS_ROOTLOWDISKTRIGGERFRACTION 10
 127 #define HFS_ROOTLOWDISKTRIGGERLEVEL ((u_int64_t)(1024*1024*1024))
 128 #define HFS_ROOTLOWDISKSHUTOFFFRACTION 11
 129 #define HFS_ROOTLOWDISKSHUTOFFLEVEL ((u_int64_t)(1024*1024*1024 + 250*1024*1024))
 130
 131 #define HFS_VERYLOWDISKTRIGGERFRACTION 1
 132 #define HFS_VERYLOWDISKTRIGGERLEVEL ((u_int64_t)(100*1024*1024))
 133 #define HFS_LOWDISKTRIGGERFRACTION 2
 134 #define HFS_LOWDISKTRIGGERLEVEL ((u_int64_t)(150*1024*1024))
 135 #define HFS_LOWDISKSHUTOFFFRACTION 3
 136 #define HFS_LOWDISKSHUTOFFLEVEL ((u_int64_t)(200*1024*1024))
 137
 138 /* Internal Data structures*/
 139
 140 /* This structure describes the HFS specific mount structure data. */
 141 typedef struct hfsmount {
 142         u_int32_t     hfs_flags;              /* see below */
 143
 144         /* Physical Description */
 145         u_int32_t     hfs_logical_block_size;   /* Logical block size of the disk as reported by ioctl(DKIOCGETBLOCKSIZE), always a multiple of 512 */
 146         daddr64_t     hfs_logical_block_count;  /* Number of logical blocks on the disk */
 147         daddr64_t     hfs_alt_id_sector;        /* location of alternate VH/MDB */
 148         u_int32_t     hfs_physical_block_size;  /* Physical block size of the disk as reported by ioctl(DKIOCGETPHYSICALBLOCKSIZE) */
 149         u_int32_t     hfs_log_per_phys;         /* Number of logical blocks per physical block size */
 150
 151         /* Access to VFS and devices */
 152         struct mount            *hfs_mp;                                /* filesystem vfs structure */
 153         struct vnode            *hfs_devvp;                             /* block device mounted vnode */
 154         struct vnode *          hfs_extents_vp;
 155         struct vnode *          hfs_catalog_vp;
 156         struct vnode *          hfs_allocation_vp;
 157         struct vnode *          hfs_attribute_vp;
 158         struct vnode *          hfs_startup_vp;
 159         struct vnode *          hfs_attrdata_vp;   /* pseudo file */
 160         struct cnode *          hfs_extents_cp;
 161         struct cnode *          hfs_catalog_cp;
 162         struct cnode *          hfs_allocation_cp;
 163         struct cnode *          hfs_attribute_cp;
 164         struct cnode *          hfs_startup_cp;
 165         dev_t                   hfs_raw_dev;                    /* device mounted */
 166         u_int32_t               hfs_logBlockSize;               /* Size of buffer cache buffer for I/O */
 167
 168         /* Default values for HFS standard and non-init access */
 169         uid_t         hfs_uid;            /* uid to set as owner of the files */
 170         gid_t         hfs_gid;            /* gid to set as owner of the files */
 171         mode_t        hfs_dir_mask;       /* mask to and with directory protection bits */
 172         mode_t        hfs_file_mask;      /* mask to and with file protection bits */
 173         u_int32_t        hfs_encoding;       /* Default encoding for non hfs+ volumes */
 174
 175         /* Persistent fields (on disk, dynamic) */
 176         time_t        hfs_mtime;          /* file system last modification time */
 177         u_int32_t     hfs_filecount;      /* number of files in file system */
 178         u_int32_t     hfs_dircount;       /* number of directories in file system */
 179         u_int32_t     freeBlocks;         /* free allocation blocks */
 180         u_int32_t     nextAllocation;     /* start of next allocation search */
 181         u_int32_t     sparseAllocation;   /* start of allocations for sparse devices */
 182         u_int32_t     vcbNxtCNID;         /* next unused catalog node ID - protected by catalog lock */
 183         u_int32_t     vcbWrCnt;           /* file system write count */
 184         u_int64_t     encodingsBitmap;    /* in-use encodings */
 185         u_int16_t     vcbNmFls;           /* HFS Only - root dir file count */
 186         u_int16_t     vcbNmRtDirs;        /* HFS Only - root dir directory count */
 187
 188         /* Persistent fields (on disk, static) */
 189         u_int16_t                       vcbSigWord;
 190         int16_t                         vcbFlags; /* Runtime flag to indicate if volume is dirty/clean */
 191         u_int32_t                       vcbAtrb;
 192         u_int32_t                       vcbJinfoBlock;
 193         u_int32_t                       localCreateDate;/* volume create time from volume header (For HFS+, value is in local time) */
 194         time_t                          hfs_itime;      /* file system creation time (creation date of the root folder) */
 195         time_t                          hfs_btime;      /* file system last backup time */
 196         u_int32_t                       blockSize;      /* size of allocation blocks */
 197         u_int32_t                       totalBlocks;    /* total allocation blocks */
 198         u_int32_t                       allocLimit;     /* Do not allocate this block or beyond */
 199         /*
 200          * NOTE: When resizing a volume to make it smaller, allocLimit is set to the allocation
 201          * block number which will contain the new alternate volume header.  At all other times,
 202          * allocLimit is set to totalBlocks.  The allocation code uses allocLimit instead of
 203          * totalBlocks to limit which blocks may be allocated, so that during a resize, we don't
 204          * put new content into the blocks we're trying to truncate away.
 205          */
 206         int32_t                         vcbClpSiz;
 207         u_int32_t     vcbFndrInfo[8];
 208         int16_t                         vcbVBMSt;               /* HFS only */
 209         int16_t                         vcbAlBlSt;              /* HFS only */
 210
 211         /* vcb stuff */
 212         u_int8_t                        vcbVN[256];             /* volume name in UTF-8 */
 213         u_int32_t                       volumeNameEncodingHint;
 214         u_int32_t                       hfsPlusIOPosOffset;     /* Disk block where HFS+ starts */
 215         u_int32_t                       vcbVBMIOSize;           /* volume bitmap I/O size */
 216
 217         /* cache of largest known free extents */
 218         u_int32_t                       vcbFreeExtCnt;
 219         HFSPlusExtentDescriptor vcbFreeExt[kMaxFreeExtents];
 220         lck_spin_t                      vcbFreeExtLock;
 221
 222 #if CONFIG_HFS_ALLOC_RBTREE
 223         /*
 224          * Access to these fields should only be done
 225          * after acquiring the bitmap lock.  Note that the
 226          * "offset_block_end" field indicates the portion of
 227          * the bitmap that is currently managed by the red-black tree.
 228          */
 229
 230         /* Normal Allocation Tree */
 231         extent_tree_offset_t offset_tree;
 232         u_int32_t                       offset_free_extents;  /* number of free extents managed by tree */
 233         u_int32_t                       offset_block_end;
 234 #endif
 235
 236         /*
 237          * For setting persistent in-mount fields that relate
 238          * to the use of the extent trees.  See HFS Red-Black
 239          * Tree Allocator Flags below.
 240          */
 241         u_int32_t extent_tree_flags;
 242
 243
 244         u_int32_t               reserveBlocks;          /* free block reserve */
 245         u_int32_t               loanedBlocks;           /* blocks on loan for delayed allocations */
 246
 247
 248         /*
 249          * HFS+ Private system directories (two). Any access
 250          * (besides looking at the cd_cnid) requires holding
 251          * the Catalog File lock.
 252          */
 253         struct cat_desc     hfs_private_desc[2];
 254         struct cat_attr     hfs_private_attr[2];
 255
 256         u_int32_t               hfs_metadata_createdate;
 257         hfs_to_unicode_func_t   hfs_get_unicode;
 258         unicode_to_hfs_func_t   hfs_get_hfsname;
 259
 260         /* Quota variables: */
 261         struct quotafile        hfs_qfiles[MAXQUOTAS];    /* quota files */
 262
 263         /* Journaling variables: */
 264         void                *jnl;           // the journal for this volume (if one exists)
 265         struct vnode        *jvp;           // device where the journal lives (may be equal to devvp)
 266         u_int32_t            jnl_start;     // start block of the journal file (so we don't delete it)
 267         u_int32_t            jnl_size;
 268         u_int32_t            hfs_jnlfileid;
 269         u_int32_t            hfs_jnlinfoblkid;
 270         lck_rw_t                hfs_global_lock;
 271         u_int32_t            hfs_global_lock_nesting;
 272         void*                           hfs_global_lockowner;
 273
 274         /* Notification variables: */
 275         u_int32_t               hfs_notification_conditions;
 276         u_int32_t               hfs_freespace_notify_dangerlimit;
 277         u_int32_t               hfs_freespace_notify_warninglimit;
 278         u_int32_t               hfs_freespace_notify_desiredlevel;
 279
 280         /* time mounted and last mounted mod time "snapshot" */
 281         time_t          hfs_mount_time;
 282         time_t          hfs_last_mounted_mtime;
 283
 284         /* Metadata allocation zone variables: */
 285         u_int32_t       hfs_metazone_start;
 286         u_int32_t       hfs_metazone_end;
 287         u_int32_t       hfs_hotfile_start;
 288         u_int32_t       hfs_hotfile_end;
 289         u_int32_t       hfs_min_alloc_start;
 290         u_int32_t       hfs_freed_block_count;
 291         int             hfs_hotfile_freeblks;
 292         int             hfs_hotfile_maxblks;
 293         int             hfs_overflow_maxblks;
 294         int             hfs_catalog_maxblks;
 295
 296         /* Hot File Clustering variables: */
 297         lck_mtx_t       hfc_mutex;      /* serialize hot file stages */
 298         enum hfc_stage  hfc_stage;      /* what are we up to... */
 299         time_t          hfc_timebase;   /* recording period start time */
 300         time_t          hfc_timeout;    /* recording period stop time */
 301         void *          hfc_recdata;    /* recording data (opaque) */
 302         int             hfc_maxfiles;   /* maximum files to track */
 303         struct vnode *  hfc_filevp;
 304
 305 #if HFS_SPARSE_DEV
 306         /* Sparse device variables: */
 307         struct vnode * hfs_backingfs_rootvp;
 308         u_int32_t      hfs_last_backingstatfs;
 309         int            hfs_sparsebandblks;
 310         u_int64_t      hfs_backingfs_maxblocks;
 311 #endif
 312         size_t         hfs_max_inline_attrsize;
 313
 314         lck_mtx_t      hfs_mutex;      /* protects access to hfsmount data */
 315         void          *hfs_freezing_proc;  /* who froze the fs */
 316         void          *hfs_downgrading_proc; /* process who's downgrading to rdonly */
 317         lck_rw_t       hfs_insync;     /* protects sync/freeze interaction */
 318
 319         /* Resize variables: */
 320         u_int32_t               hfs_resize_blocksmoved;
 321         u_int32_t               hfs_resize_totalblocks;
 322         u_int32_t               hfs_resize_progress;
 323
 324         /* Per mount cnode hash variables: */
 325         lck_mtx_t      hfs_chash_mutex; /* protects access to cnode hash table */
 326         u_long         hfs_cnodehash;   /* size of cnode hash table - 1 */
 327         LIST_HEAD(cnodehashhead, cnode) *hfs_cnodehashtbl;      /* base of cnode hash */
 328
 329
 330         /*
 331          * About the sync counters:
 332          * hfs_sync_scheduled  keeps track whether a timer was scheduled but we
 333          *                     haven't started processing the callback (i.e. we
 334          *                     haven't begun the flush).  This will be non-zero
 335          *                     even if the callback has been invoked, before we
 336          *                    start the flush.
 337          * hfs_sync_incomplete keeps track of the number of callbacks that have
 338          *                     not completed yet (including callbacks not yet
 339          *                     invoked).  We cannot safely unmount until this
 340          *                     drops to zero.
 341          *
 342          * In both cases, we use counters, not flags, so that we can avoid
 343          * taking locks.
 344          */
 345         int32_t         hfs_sync_scheduled;
 346         int32_t         hfs_sync_incomplete;
 347         u_int64_t       hfs_last_sync_request_time;
 348         u_int64_t       hfs_last_sync_time;
 349         u_int32_t       hfs_active_threads;
 350         u_int64_t       hfs_max_pending_io;
 351
 352         thread_call_t   hfs_syncer;           // removeable devices get sync'ed by this guy
 353
 354 } hfsmount_t;
 355
 356 #define HFS_META_DELAY     (100)
 357 #define HFS_MILLISEC_SCALE (1000*1000)
 358
 359 typedef hfsmount_t  ExtendedVCB;
 360
 361 /* Aliases for legacy (Mac OS 9) field names */
 362 #define vcbLsMod           hfs_mtime
 363 #define vcbVolBkUp         hfs_btime
 364 #define extentsRefNum      hfs_extents_vp
 365 #define catalogRefNum      hfs_catalog_vp
 366 #define allocationsRefNum  hfs_allocation_vp
 367 #define vcbFilCnt          hfs_filecount
 368 #define vcbDirCnt          hfs_dircount
 369
 370 /* Inline functions to set/reset vcbFlags.  Upper 8 bits indicate if the volume
 371  * header/VCB is clean/dirty --- if set, volume header is dirty, and
 372  * if clear, volume header is clean.  This value is checked to determine
 373  * if the in-memory copy of volume header should be flushed to the disk
 374  * or not.
 375  */
 376 /* Set runtime flag to indicate that volume is dirty */
 377 static __inline__ void MarkVCBDirty(ExtendedVCB *vcb)
 378 {
 379         vcb->vcbFlags |= 0xFF00;
 380 }
 381
 382 /* Clear runtime flag to indicate that volume is dirty */
 383 static __inline__ void MarkVCBClean(ExtendedVCB *vcb)
 384 {
 385         vcb->vcbFlags &= 0x00FF;
 386 }
 387
 388 /* Check runtime flag to determine if the volume is dirty or not */
 389 static __inline__ Boolean IsVCBDirty(ExtendedVCB *vcb)
 390 {
 391         return (vcb->vcbFlags & 0xFF00 ? true  : false);
 392 }
 393
 394 /*
 395  * There are two private directories in HFS+.
 396  *
 397  * One contains inodes for files that are hardlinked or open/unlinked.
 398  * The other contains inodes for directories that are hardlinked.
 399  */
 400 enum privdirtype {FILE_HARDLINKS, DIR_HARDLINKS};
 401
 402 /* HFS Red-Black Tree Allocator Flags */
 403 #define HFS_ALLOC_RB_ENABLED            0x000001        /* trees in use */
 404 #define HFS_ALLOC_RB_ERRORED            0x000002        /* tree hit error; disabled for the mount */
 405 #define HFS_ALLOC_RB_MZACTIVE           0x000004        /* metazone tree has finished building */
 406 #define HFS_ALLOC_RB_ACTIVE                     0x000008        /* normalzone tree finished building */
 407
 408 /* HFS Red-Black Unmount Synch. Flags */
 409 #define HFS_ALLOC_TREEBUILD_INFLIGHT    0x000010
 410 #define HFS_ALLOC_TEARDOWN_INFLIGHT             0x000020
 411
 412 /* HFS mount point flags */
 413 #define HFS_READ_ONLY             0x00001
 414 #define HFS_UNKNOWN_PERMS         0x00002
 415 #define HFS_WRITEABLE_MEDIA       0x00004
 416 #define HFS_CLEANED_ORPHANS       0x00008
 417 #define HFS_X                     0x00010
 418 #define HFS_CASE_SENSITIVE        0x00020
 419 #define HFS_STANDARD              0x00040
 420 #define HFS_METADATA_ZONE         0x00080
 421 #define HFS_FRAGMENTED_FREESPACE  0x00100
 422 #define HFS_NEED_JNL_RESET        0x00200
 423 #define HFS_HAS_SPARSE_DEVICE     0x00400
 424 #define HFS_RESIZE_IN_PROGRESS    0x00800
 425 #define HFS_QUOTAS                0x01000
 426 #define HFS_CREATING_BTREE        0x02000
 427 /* When set, do not update nextAllocation in the mount structure */
 428 #define HFS_SKIP_UPDATE_NEXT_ALLOCATION 0x04000
 429 /* When set, the file system supports extent-based extended attributes */
 430 #define HFS_XATTR_EXTENTS         0x08000
 431 #define HFS_FOLDERCOUNT           0x10000
 432 /* When set, the file system exists on a virtual device, like disk image */
 433 #define HFS_VIRTUAL_DEVICE        0x20000
 434 /* When set, we're in hfs_changefs, so hfs_sync should do nothing. */
 435 #define HFS_IN_CHANGEFS           0x40000
 436 /* When set, we are in process of downgrading or have downgraded to read-only,
 437  * so hfs_start_transaction should return EROFS.
 438  */
 439 #define HFS_RDONLY_DOWNGRADE      0x80000
 440 #define HFS_DID_CONTIG_SCAN      0x100000
 441 #define HFS_SSD                                  0x400000
 442
 443
 444 /* Macro to update next allocation block in the HFS mount structure.  If
 445  * the HFS_SKIP_UPDATE_NEXT_ALLOCATION is set, do not update
 446  * nextAllocation block.
 447  */
 448 #define HFS_UPDATE_NEXT_ALLOCATION(hfsmp, new_nextAllocation)                   \
 449         {                                                               \
 450                 if ((hfsmp->hfs_flags & HFS_SKIP_UPDATE_NEXT_ALLOCATION) == 0)\
 451                         hfsmp->nextAllocation = new_nextAllocation;     \
 452         }                                                               \
 453
 454 #define HFS_MOUNT_LOCK(hfsmp, metadata)                      \
 455         {                                                    \
 456                 if ((metadata) && 1)                         \
 457                         lck_mtx_lock(&(hfsmp)->hfs_mutex);   \
 458         }                                                    \
 459
 460 #define HFS_MOUNT_UNLOCK(hfsmp, metadata)                    \
 461         {                                                    \
 462                 if ((metadata) && 1)                         \
 463                         lck_mtx_unlock(&(hfsmp)->hfs_mutex); \
 464         }                                                    \
 465
 466 /* Macro for incrementing and decrementing the folder count in a cnode
 467  * attribute only if the HFS_FOLDERCOUNT bit is set in the mount flags
 468  * and kHFSHasFolderCount bit is set in the cnode flags.  Currently these
 469  * bits are only set for case sensitive HFS+ volumes.
 470  */
 471 #define INC_FOLDERCOUNT(hfsmp, cattr)                           \
 472         if ((hfsmp->hfs_flags & HFS_FOLDERCOUNT) &&             \
 473             (cattr.ca_recflags & kHFSHasFolderCountMask)) {     \
 474                 cattr.ca_dircount++;                            \
 475         }                                                       \
 476
 477 #define DEC_FOLDERCOUNT(hfsmp, cattr)                           \
 478         if ((hfsmp->hfs_flags & HFS_FOLDERCOUNT) &&             \
 479             (cattr.ca_recflags & kHFSHasFolderCountMask) &&     \
 480             (cattr.ca_dircount > 0)) {                          \
 481                 cattr.ca_dircount--;                            \
 482         }                                                       \
 483
 484 typedef struct filefork FCB;
 485
 486 /*
 487  * Macros for creating item names for our special/private directories.
 488  */
 489 #define MAKE_INODE_NAME(name, size, linkno) \
 490             (void) snprintf((name), size, "%s%d", HFS_INODE_PREFIX, (linkno))
 491 #define HFS_INODE_PREFIX_LEN    5
 492
 493 #define MAKE_DIRINODE_NAME(name, size, linkno) \
 494             (void) snprintf((name), size, "%s%d", HFS_DIRINODE_PREFIX, (linkno))
 495 #define HFS_DIRINODE_PREFIX_LEN   4
 496
 497 #define MAKE_DELETED_NAME(NAME, size, FID) \
 498             (void) snprintf((NAME), size, "%s%d", HFS_DELETE_PREFIX, (FID))
 499 #define HFS_DELETE_PREFIX_LEN   4
 500
 501
 502 #define HFS_AVERAGE_NAME_SIZE   22
 503 #define AVERAGE_HFSDIRENTRY_SIZE  (8+HFS_AVERAGE_NAME_SIZE+4)
 504
 505 #define STD_DIRENT_LEN(namlen) \
 506         ((sizeof(struct dirent) - (NAME_MAX+1)) + (((namlen)+1 + 3) &~ 3))
 507
 508 #define EXT_DIRENT_LEN(namlen) \
 509         ((sizeof(struct direntry) + (namlen) - (MAXPATHLEN-1) + 3) & ~3)
 510
 511
 512 enum { kHFSPlusMaxFileNameBytes = kHFSPlusMaxFileNameChars * 3 };
 513
 514
 515 /* macro to determine if hfs or hfsplus */
 516 #define ISHFSPLUS(VCB) ((VCB)->vcbSigWord == kHFSPlusSigWord)
 517 #define ISHFS(VCB) ((VCB)->vcbSigWord == kHFSSigWord)
 518
 519
 520 /*
 521  * Various ways to acquire a VFS mount point pointer:
 522  */
 523 #define VTOVFS(VP)  vnode_mount((VP))
 524 #define HFSTOVFS(HFSMP) ((HFSMP)->hfs_mp)
 525 #define VCBTOVFS(VCB)   HFSTOVFS(VCB)
 526
 527 /*
 528  * Various ways to acquire an HFS mount point pointer:
 529  */
 530 #define VTOHFS(VP)  ((struct hfsmount *)vfs_fsprivate(vnode_mount((VP))))
 531 #define VFSTOHFS(MP)  ((struct hfsmount *)vfs_fsprivate((MP)))
 532 #define VCBTOHFS(VCB) (VCB)
 533 #define FCBTOHFS(FCB)  ((struct hfsmount *)vfs_fsprivate(vnode_mount((FCB)->ff_cp->c_vp)))
 534
 535 /*
 536  * Various ways to acquire a VCB (legacy) pointer:
 537  */
 538 #define VTOVCB(VP)       VTOHFS(VP)
 539 #define VFSTOVCB(MP)     VFSTOHFS(MP)
 540 #define HFSTOVCB(HFSMP)  (HFSMP)
 541 #define FCBTOVCB(FCB)    FCBTOHFS(FCB)
 542
 543
 544 #define E_NONE  0
 545 #define kHFSBlockSize 512
 546
 547 /*
 548  * Macros for getting the MDB/VH sector and offset
 549  */
 550 #define HFS_PRI_SECTOR(blksize)          (1024 / (blksize))
 551 #define HFS_PRI_OFFSET(blksize)          ((blksize) > 1024 ? 1024 : 0)
 552
 553 #define HFS_ALT_SECTOR(blksize, blkcnt)  (((blkcnt) - 1) - (512 / (blksize)))
 554 #define HFS_ALT_OFFSET(blksize)          ((blksize) > 1024 ? (blksize) - 1024 : 0)
 555
 556 /* Convert the logical sector number to be aligned on physical block size boundary.
 557  * We are assuming the partition is a multiple of physical block size.
 558  */
 559 #define HFS_PHYSBLK_ROUNDDOWN(sector_num, log_per_phys) ((sector_num / log_per_phys) * log_per_phys)
 560
 561 /*
 562  * HFS specific fcntl()'s
 563  */
 564 #define HFS_GET_BOOT_INFO   (FCNTL_FS_SPECIFIC_BASE + 0x00004)
 565 #define HFS_SET_BOOT_INFO   (FCNTL_FS_SPECIFIC_BASE + 0x00005)
 566 /* See HFSIOC_EXT_BULKACCESS and friends for HFS specific fsctls*/
 567
 568
 569
 570 /*
 571  *      This is the straight GMT conversion constant:
 572  *      00:00:00 January 1, 1970 - 00:00:00 January 1, 1904
 573  *      (3600 * 24 * ((365 * (1970 - 1904)) + (((1970 - 1904) / 4) + 1)))
 574  */
 575 #define MAC_GMT_FACTOR          2082844800UL
 576
 577
 578 /*****************************************************************************
 579         FUNCTION PROTOTYPES
 580 ******************************************************************************/
 581
 582 /*****************************************************************************
 583         hfs_vnop_xxx functions from different files
 584 ******************************************************************************/
 585 int hfs_vnop_readdirattr(struct vnop_readdirattr_args *);  /* in hfs_attrlist.c */
 586
 587 int hfs_vnop_inactive(struct vnop_inactive_args *);        /* in hfs_cnode.c */
 588 int hfs_vnop_reclaim(struct vnop_reclaim_args *);          /* in hfs_cnode.c */
 589 int hfs_set_backingstore (struct vnode *vp, int val);                           /* in hfs_cnode.c */
 590 int hfs_is_backingstore (struct vnode *vp, int *val);           /* in hfs_cnode.c */
 591
 592
 593 int hfs_vnop_link(struct vnop_link_args *);                /* in hfs_link.c */
 594
 595 int hfs_vnop_lookup(struct vnop_lookup_args *);            /* in hfs_lookup.c */
 596
 597 int hfs_vnop_search(struct vnop_searchfs_args *);          /* in hfs_search.c */
 598
 599 int hfs_vnop_read(struct vnop_read_args *);           /* in hfs_readwrite.c */
 600 int hfs_vnop_write(struct vnop_write_args *);         /* in hfs_readwrite.c */
 601 int hfs_vnop_ioctl(struct vnop_ioctl_args *);         /* in hfs_readwrite.c */
 602 int hfs_vnop_select(struct vnop_select_args *);       /* in hfs_readwrite.c */
 603 int hfs_vnop_strategy(struct vnop_strategy_args *);   /* in hfs_readwrite.c */
 604 int hfs_vnop_allocate(struct vnop_allocate_args *);   /* in hfs_readwrite.c */
 605 int hfs_vnop_pagein(struct vnop_pagein_args *);       /* in hfs_readwrite.c */
 606 int hfs_vnop_pageout(struct vnop_pageout_args *);     /* in hfs_readwrite.c */
 607 int hfs_vnop_bwrite(struct vnop_bwrite_args *);       /* in hfs_readwrite.c */
 608 int hfs_vnop_blktooff(struct vnop_blktooff_args *);   /* in hfs_readwrite.c */
 609 int hfs_vnop_offtoblk(struct vnop_offtoblk_args *);   /* in hfs_readwrite.c */
 610 int hfs_vnop_blockmap(struct vnop_blockmap_args *);   /* in hfs_readwrite.c */
 611
 612 int hfs_vnop_getxattr(struct vnop_getxattr_args *);        /* in hfs_xattr.c */
 613 int hfs_vnop_setxattr(struct vnop_setxattr_args *);        /* in hfs_xattr.c */
 614 int hfs_vnop_removexattr(struct vnop_removexattr_args *);  /* in hfs_xattr.c */
 615 int hfs_vnop_listxattr(struct vnop_listxattr_args *);      /* in hfs_xattr.c */
 616 #if NAMEDSTREAMS
 617 extern int hfs_vnop_getnamedstream(struct vnop_getnamedstream_args*);
 618 extern int hfs_vnop_makenamedstream(struct vnop_makenamedstream_args*);
 619 extern int hfs_vnop_removenamedstream(struct vnop_removenamedstream_args*);
 620 #endif
 621
 622
 623 /*****************************************************************************
 624         Functions from MacOSStubs.c
 625 ******************************************************************************/
 626 time_t to_bsd_time(u_int32_t hfs_time);
 627
 628 u_int32_t to_hfs_time(time_t bsd_time);
 629
 630
 631 /*****************************************************************************
 632         Functions from hfs_encodinghint.c
 633 ******************************************************************************/
 634 u_int32_t hfs_pickencoding(const u_int16_t *src, int len);
 635
 636 u_int32_t hfs_getencodingbias(void);
 637
 638 void hfs_setencodingbias(u_int32_t bias);
 639
 640
 641 /*****************************************************************************
 642         Functions from hfs_encodings.c
 643 ******************************************************************************/
 644 void hfs_converterinit(void);
 645
 646 int hfs_getconverter(u_int32_t encoding, hfs_to_unicode_func_t *get_unicode,
 647                      unicode_to_hfs_func_t *get_hfsname);
 648
 649 int hfs_relconverter(u_int32_t encoding);
 650
 651 int hfs_to_utf8(ExtendedVCB *vcb, const Str31 hfs_str, ByteCount maxDstLen,
 652                 ByteCount *actualDstLen, unsigned char* dstStr);
 653
 654 int utf8_to_hfs(ExtendedVCB *vcb, ByteCount srcLen, const unsigned char* srcStr,
 655                 Str31 dstStr);
 656
 657 int mac_roman_to_utf8(const Str31 hfs_str, ByteCount maxDstLen, ByteCount *actualDstLen,
 658                 unsigned char* dstStr);
 659
 660 int utf8_to_mac_roman(ByteCount srcLen, const unsigned char* srcStr, Str31 dstStr);
 661
 662 int mac_roman_to_unicode(const Str31 hfs_str, UniChar *uni_str, u_int32_t maxCharLen, u_int32_t *usedCharLen);
 663
 664 int unicode_to_hfs(ExtendedVCB *vcb, ByteCount srcLen, u_int16_t* srcStr, Str31 dstStr, int retry);
 665
 666
 667 /*****************************************************************************
 668         Functions from hfs_notifications.c
 669 ******************************************************************************/
 670 void hfs_generate_volume_notifications(struct hfsmount *hfsmp);
 671
 672
 673 /*****************************************************************************
 674         Functions from hfs_readwrite.c
 675 ******************************************************************************/
 676 extern int  hfs_relocate(struct  vnode *, u_int32_t, kauth_cred_t, struct  proc *);
 677
 678 extern int hfs_truncate(struct vnode *, off_t, int, int, int, vfs_context_t);
 679
 680 extern int hfs_release_storage (struct hfsmount *hfsmp, struct filefork *datafork,
 681                                                                 struct filefork *rsrcfork,  u_int32_t fileid);
 682
 683 extern int hfs_prepare_release_storage (struct hfsmount *hfsmp, struct vnode *vp);
 684
 685 extern int hfs_bmap(struct vnode *, daddr_t, struct vnode **, daddr64_t *, unsigned int *);
 686
 687 extern int hfs_fsync(struct vnode *, int, int, struct proc *);
 688
 689 extern int hfs_access(struct vnode *, mode_t, kauth_cred_t, struct proc *);
 690
 691 extern int hfs_removeallattr(struct hfsmount *hfsmp, u_int32_t fileid);
 692
 693 extern int hfs_set_volxattr(struct hfsmount *hfsmp, unsigned int xattrtype, int state);
 694
 695 extern int hfs_isallocated(struct hfsmount *hfsmp, u_int32_t startingBlock, u_int32_t numBlocks);
 696
 697 extern int hfs_count_allocated(struct hfsmount *hfsmp, u_int32_t startBlock,
 698                 u_int32_t numBlocks, u_int32_t *alloc_count);
 699
 700 extern int hfs_isrbtree_active (struct hfsmount *hfsmp);
 701
 702
 703 /*****************************************************************************
 704         Functions from hfs_vfsops.c
 705 ******************************************************************************/
 706 int hfs_mountroot(mount_t mp, vnode_t rvp, vfs_context_t context);
 707
 708 /* used as a callback by the journaling code */
 709 extern void hfs_sync_metadata(void *arg);
 710
 711 extern int hfs_vget(struct hfsmount *, cnid_t, struct vnode **, int, int);
 712
 713 extern void hfs_setencodingbits(struct hfsmount *hfsmp, u_int32_t encoding);
 714
 715 enum volop {VOL_UPDATE, VOL_MKDIR, VOL_RMDIR, VOL_MKFILE, VOL_RMFILE};
 716 extern int hfs_volupdate(struct hfsmount *hfsmp, enum volop op, int inroot);
 717
 718 int hfs_flushvolumeheader(struct hfsmount *hfsmp, int waitfor, int altflush);
 719 #define HFS_ALTFLUSH    1
 720
 721 extern int  hfs_extendfs(struct hfsmount *, u_int64_t, vfs_context_t);
 722 extern int  hfs_truncatefs(struct hfsmount *, u_int64_t, vfs_context_t);
 723 extern int  hfs_resize_progress(struct hfsmount *, u_int32_t *);
 724
 725 /* If a runtime corruption is detected, mark the volume inconsistent
 726  * bit in the volume attributes.
 727  */
 728 void hfs_mark_volume_inconsistent(struct hfsmount *hfsmp);
 729
 730 /*****************************************************************************
 731         Functions from hfs_vfsutils.c
 732 ******************************************************************************/
 733 u_int32_t BestBlockSizeFit(u_int32_t allocationBlockSize,
 734                                u_int32_t blockSizeLimit,
 735                                u_int32_t baseMultiple);
 736
 737 OSErr   hfs_MountHFSVolume(struct hfsmount *hfsmp, HFSMasterDirectoryBlock *mdb,
 738                 struct proc *p);
 739 OSErr   hfs_MountHFSPlusVolume(struct hfsmount *hfsmp, HFSPlusVolumeHeader *vhp,
 740                 off_t embeddedOffset, u_int64_t disksize, struct proc *p, void *args, kauth_cred_t cred);
 741
 742 extern int hfsUnmount(struct hfsmount *hfsmp, struct proc *p);
 743
 744 extern int overflow_extents(struct filefork *fp);
 745
 746 extern int hfs_owner_rights(struct hfsmount *hfsmp, uid_t cnode_uid, kauth_cred_t cred,
 747                 struct proc *p, int invokesuperuserstatus);
 748
 749 extern int check_for_tracked_file(struct vnode *vp, time_t ctime, uint64_t op_type, void *arg);
 750 extern int check_for_dataless_file(struct vnode *vp, uint64_t op_type);
 751
 752 /*
 753  * Journal lock function prototypes
 754  */
 755 int hfs_lock_global (struct hfsmount *hfsmp, enum hfslocktype locktype);
 756 void hfs_unlock_global (struct hfsmount *hfsmp);
 757
 758
 759 /* HFS System file locking */
 760 #define SFL_CATALOG     0x0001
 761 #define SFL_EXTENTS     0x0002
 762 #define SFL_BITMAP      0x0004
 763 #define SFL_ATTRIBUTE   0x0008
 764 #define SFL_STARTUP     0x0010
 765 #define SFL_VALIDMASK   (SFL_CATALOG | SFL_EXTENTS | SFL_BITMAP | SFL_ATTRIBUTE | SFL_STARTUP)
 766
 767 extern int  hfs_systemfile_lock(struct hfsmount *, int, enum hfslocktype);
 768 extern void hfs_systemfile_unlock(struct hfsmount *, int);
 769
 770 extern u_int32_t  GetFileInfo(ExtendedVCB *vcb, u_int32_t dirid, const char *name,
 771                                                    struct cat_attr *fattr, struct cat_fork *forkinfo);
 772
 773 extern void hfs_remove_orphans(struct hfsmount *);
 774
 775 u_int32_t GetLogicalBlockSize(struct vnode *vp);
 776
 777 extern u_int32_t hfs_freeblks(struct hfsmount * hfsmp, int wantreserve);
 778
 779 short MacToVFSError(OSErr err);
 780
 781 void hfs_metadatazone_init(struct hfsmount *hfsmp, int disable);
 782
 783 /* HFS directory hint functions. */
 784 extern directoryhint_t * hfs_getdirhint(struct cnode *, int, int);
 785 extern void  hfs_reldirhint(struct cnode *, directoryhint_t *);
 786 extern void  hfs_reldirhints(struct cnode *, int);
 787 extern void  hfs_insertdirhint(struct cnode *, directoryhint_t *);
 788
 789 extern int hfs_namecmp(const u_int8_t *str1, size_t len1, const u_int8_t *str2, size_t len2);
 790
 791 extern int     hfs_early_journal_init(struct hfsmount *hfsmp, HFSPlusVolumeHeader *vhp,
 792                            void *_args, off_t embeddedOffset, daddr64_t mdb_offset,
 793                            HFSMasterDirectoryBlock *mdbp, kauth_cred_t cred);
 794
 795 extern int  hfs_virtualmetafile(struct cnode *);
 796
 797 extern int hfs_start_transaction(struct hfsmount *hfsmp);
 798 extern int hfs_end_transaction(struct hfsmount *hfsmp);
 799 extern int hfs_journal_flush(struct hfsmount *hfsmp, boolean_t wait_for_IO);
 800 extern void hfs_sync_ejectable(struct hfsmount *hfsmp);
 801
 802 extern void hfs_trim_callback(void *arg, uint32_t extent_count, const dk_extent_t *extents);
 803
 804 /* Erase unused Catalog nodes due to <rdar://problem/6947811>. */
 805 extern int hfs_erase_unused_nodes(struct hfsmount *hfsmp);
 806
 807
 808 /*****************************************************************************
 809         Functions from hfs_vnops.c
 810 ******************************************************************************/
 811 int hfs_write_access(struct vnode *vp, kauth_cred_t cred, struct proc *p, Boolean considerFlags);
 812
 813 int hfs_chmod(struct vnode *vp, int mode, kauth_cred_t cred, struct proc *p);
 814
 815 int hfs_chown(struct vnode *vp, uid_t uid, gid_t gid, kauth_cred_t cred, struct proc *p);
 816
 817 #define  kMaxSecsForFsync       5
 818 #define  HFS_SYNCTRANS          1
 819 extern int hfs_btsync(struct vnode *vp, int sync_transaction);
 820
 821 extern void replace_desc(struct cnode *cp, struct cat_desc *cdp);
 822
 823 extern int hfs_vgetrsrc(struct hfsmount *hfsmp, struct vnode *vp,
 824                         struct vnode **rvpp, int can_drop_lock, int error_on_unlink);
 825
 826 extern int hfs_update(struct vnode *, int);
 827
 828
 829 /*****************************************************************************
 830         Functions from hfs_xattr.c
 831 ******************************************************************************/
 832
 833 /* Maximum extended attribute size supported for all extended attributes except
 834  * resource fork and finder info.
 835  */
 836 #define HFS_XATTR_MAXSIZE       (128 * 1024)
 837
 838 /* Number of bits used to represent maximum extended attribute size */
 839 #define HFS_XATTR_SIZE_BITS     18
 840
 841 int  hfs_attrkeycompare(HFSPlusAttrKey *searchKey, HFSPlusAttrKey *trialKey);
 842 int  hfs_buildattrkey(u_int32_t fileID, const char *attrname, HFSPlusAttrKey *key);
 843 void hfs_xattr_init(struct hfsmount * hfsmp);
 844 int file_attribute_exist(struct hfsmount *hfsmp, uint32_t fileID);
 845 int init_attrdata_vnode(struct hfsmount *hfsmp);
 846 int hfs_getxattr_internal(struct cnode *, struct vnop_getxattr_args *,
 847                                                         struct hfsmount *, u_int32_t);
 848 int hfs_setxattr_internal(struct cnode *, caddr_t, size_t,
 849                                                   struct vnop_setxattr_args *, struct hfsmount *, u_int32_t);
 850
 851
 852
 853 /*****************************************************************************
 854         Functions from hfs_link.c
 855 ******************************************************************************/
 856
 857 extern int  hfs_unlink(struct hfsmount *hfsmp, struct vnode *dvp, struct vnode *vp,
 858                        struct componentname *cnp, int skip_reserve);
 859 extern int  hfs_lookup_siblinglinks(struct hfsmount *hfsmp, cnid_t linkfileid,
 860                            cnid_t *prevlinkid,  cnid_t *nextlinkid);
 861 extern void  hfs_privatedir_init(struct hfsmount *, enum privdirtype);
 862
 863 extern void  hfs_savelinkorigin(cnode_t *cp, cnid_t parentcnid);
 864 extern void  hfs_relorigins(struct cnode *cp);
 865 extern void  hfs_relorigin(struct cnode *cp, cnid_t parentcnid);
 866 extern int   hfs_haslinkorigin(cnode_t *cp);
 867 extern cnid_t  hfs_currentparent(cnode_t *cp);
 868 extern cnid_t  hfs_currentcnid(cnode_t *cp);
 869
 870
 871 #endif /* __APPLE_API_PRIVATE */
 872 #endif /* KERNEL */
 873 #endif /* __HFS__ */