core/hfs.h

   1 /*
   2  * Copyright (c) 2000-2015 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 #define HFS_TMPDBG 0
  47
  48 #include <sys/appleapiopts.h>
  49
  50 #ifdef KERNEL
  51 #ifdef __APPLE_API_PRIVATE
  52 #include <sys/param.h>
  53 #include <sys/queue.h>
  54 #include <sys/mount.h>
  55 #include <sys/vnode.h>
  56 #include <sys/quota.h>
  57 #include <sys/dirent.h>
  58 #include <sys/event.h>
  59 #include <sys/disk.h>
  60 #include <kern/thread_call.h>
  61 #include <kern/locks.h>
  62 #include <vm/vm_kern.h>
  63 #include <sys/sysctl.h>
  64 #include <uuid/uuid.h>
  65
  66 #include "../hfs_encodings/hfs_encodings.h"
  67
  68 #include "hfs_journal.h"
  69 #include "hfs_format.h"
  70 #include "hfs_catalog.h"
  71 #include "hfs_cnode.h"
  72 #include "hfs_macos_defs.h"
  73 #include "hfs_hotfiles.h"
  74 #include "hfs_fsctl.h"
  75
  76 __BEGIN_DECLS
  77
  78 #if CONFIG_PROTECT
  79 /* Forward declare the cprotect struct */
  80 struct cprotect;
  81 #endif
  82
  83 /*
  84  *      Just reported via MIG interface.
  85  */
  86 #define VERSION_STRING  "hfs-2 (4-12-99)"
  87
  88 #define HFS_LINK_MAX    32767
  89
  90 #define HFS_MAX_DEFERED_ALLOC   (1024*1024)
  91
  92 #define HFS_MAX_FILES   (UINT32_MAX - kHFSFirstUserCatalogNodeID)
  93
  94 // 400 megs is a "big" file (i.e. one that when deleted
  95 // would touch enough data that we should break it into
  96 // multiple separate transactions)
  97 #define HFS_BIGFILE_SIZE (400LL * 1024LL * 1024LL)
  98
  99 enum { kMDBSize = 512 };                                /* Size of I/O transfer to read entire MDB */
 100
 101 enum { kMasterDirectoryBlock = 2 };                     /* MDB offset on disk in 512-byte blocks */
 102 enum { kMDBOffset = kMasterDirectoryBlock * 512 };      /* MDB offset on disk in bytes */
 103
 104 #define kRootDirID kHFSRootFolderID
 105
 106
 107 /* number of locked buffer caches to hold for b-tree meta data */
 108 #define kMaxLockedMetaBuffers           32
 109
 110 extern struct timezone gTimeZone;
 111
 112
 113 /* How many free extents to cache per volume */
 114 #define kMaxFreeExtents         10
 115
 116 /* Maximum file size that we're willing to defrag on open */
 117 #define HFS_MAX_DEFRAG_SIZE 104857600   // 100 * 1024 * 1024 (100MB)
 118 #define HFS_INITIAL_DEFRAG_SIZE 20971520 // 20 * 1024 * 1024 (20MB)
 119
 120
 121 /* The maximum time hfs locks can be held while performing hfs statistics gathering */
 122 #define HFS_FSINFO_MAX_LOCKHELD_TIME    20 * 1000000ULL /* at most 20 milliseconds. */
 123
 124 /*
 125  * HFS_MINFREE gives the minimum acceptable percentage
 126  * of file system blocks which may be free (but this
 127  * minimum will never exceed HFS_MAXRESERVE bytes). If
 128  * the free block count drops below this level only the
 129  * superuser may continue to allocate blocks.
 130  */
 131 #define HFS_MINFREE             1
 132 #define HFS_MAXRESERVE          ((u_int64_t)(250*1024*1024))
 133 #define HFS_BT_MAXRESERVE       ((u_int64_t)(10*1024*1024))
 134
 135 /*
 136  * The system distinguishes between the desirable low-disk
 137  * notifiaction levels for root volumes and non-root volumes.
 138  * The various thresholds are computed as a fraction of the
 139  * volume size, all capped at a certain fixed level
 140  */
 141
 142 #define HFS_ROOTVERYLOWDISKTRIGGERFRACTION 5
 143 #define HFS_ROOTVERYLOWDISKTRIGGERLEVEL ((u_int64_t)(512*1024*1024))
 144 #define HFS_ROOTLOWDISKTRIGGERFRACTION 10
 145 #define HFS_ROOTLOWDISKTRIGGERLEVEL ((u_int64_t)(1024*1024*1024))
 146 #define HFS_ROOTNEARLOWDISKTRIGGERFRACTION 10.5
 147 #define HFS_ROOTNEARLOWDISKTRIGGERLEVEL ((u_int64_t)(1024*1024*1024 + 100*1024*1024))
 148 #define HFS_ROOTLOWDISKSHUTOFFFRACTION 11
 149 #define HFS_ROOTLOWDISKSHUTOFFLEVEL ((u_int64_t)(1024*1024*1024 + 250*1024*1024))
 150
 151 #define HFS_VERYLOWDISKTRIGGERFRACTION 1
 152 #define HFS_VERYLOWDISKTRIGGERLEVEL ((u_int64_t)(150*1024*1024))
 153 #define HFS_LOWDISKTRIGGERFRACTION 2
 154 #define HFS_LOWDISKTRIGGERLEVEL ((u_int64_t)(500*1024*1024))
 155 #define HFS_NEARLOWDISKTRIGGERFRACTION 10
 156 #define HFS_NEARLOWDISKTRIGGERLEVEL ((uint64_t)(1024*1024*1024))
 157 #define HFS_LOWDISKSHUTOFFFRACTION 12
 158 #define HFS_LOWDISKSHUTOFFLEVEL ((u_int64_t)(1024*1024*1024 + 200*1024*1024))
 159
 160 /* Internal Data structures*/
 161
 162 /* This structure describes the HFS specific mount structure data. */
 163 typedef struct hfsmount {
 164         u_int32_t     hfs_flags;              /* see below */
 165
 166         /* Physical Description */
 167         u_int32_t     hfs_logical_block_size;   /* Logical block size of the disk as reported by ioctl(DKIOCGETBLOCKSIZE), always a multiple of 512 */
 168         daddr64_t     hfs_logical_block_count;  /* Number of logical blocks on the disk, as reported by ioctl(DKIOCGETBLOCKCOUNT) */
 169         u_int64_t     hfs_logical_bytes;        /* Number of bytes on the disk device this HFS is mounted on (blockcount * blocksize) */
 170         /*
 171          * Regarding the two AVH sector fields below:
 172          * Under normal circumstances, the filesystem's notion of the "right" location for the AVH is such that
 173          * the partition and filesystem's are in sync.  However, during a filesystem resize, HFS proactively
 174          * writes a new AVH at the end of the filesystem, assuming that the partition will be resized accordingly.
 175          *
 176          * However, it is not technically a corruption if the partition size is never modified.  As a result, we need
 177          * to keep two copies of the AVH around "just in case" the partition size is not modified.
 178          */
 179         daddr64_t       hfs_partition_avh_sector;       /* location of Alt VH w.r.t partition size */
 180         daddr64_t       hfs_fs_avh_sector;      /* location of Alt VH w.r.t filesystem size */
 181
 182         u_int32_t     hfs_physical_block_size;  /* Physical block size of the disk as reported by ioctl(DKIOCGETPHYSICALBLOCKSIZE) */
 183         u_int32_t     hfs_log_per_phys;         /* Number of logical blocks per physical block size */
 184
 185         /* Access to VFS and devices */
 186         struct mount            *hfs_mp;                                /* filesystem vfs structure */
 187         struct vnode            *hfs_devvp;                             /* block device mounted vnode */
 188         struct vnode *          hfs_extents_vp;
 189         struct vnode *          hfs_catalog_vp;
 190         struct vnode *          hfs_allocation_vp;
 191         struct vnode *          hfs_attribute_vp;
 192         struct vnode *          hfs_startup_vp;
 193         struct vnode *          hfs_attrdata_vp;   /* pseudo file */
 194         struct cnode *          hfs_extents_cp;
 195         struct cnode *          hfs_catalog_cp;
 196         struct cnode *          hfs_allocation_cp;
 197         struct cnode *          hfs_attribute_cp;
 198         struct cnode *          hfs_startup_cp;
 199         dev_t                   hfs_raw_dev;                    /* device mounted */
 200         u_int32_t               hfs_logBlockSize;               /* Size of buffer cache buffer for I/O */
 201
 202         /* Default values for HFS standard and non-init access */
 203         uid_t         hfs_uid;            /* uid to set as owner of the files */
 204         gid_t         hfs_gid;            /* gid to set as owner of the files */
 205         mode_t        hfs_dir_mask;       /* mask to and with directory protection bits */
 206         mode_t        hfs_file_mask;      /* mask to and with file protection bits */
 207         u_int32_t        hfs_encoding;       /* Default encoding for non hfs+ volumes */
 208
 209         /* Persistent fields (on disk, dynamic) */
 210         time_t        hfs_mtime;          /* file system last modification time */
 211         u_int32_t     hfs_filecount;      /* number of files in file system */
 212         u_int32_t     hfs_dircount;       /* number of directories in file system */
 213         u_int32_t     freeBlocks;                 /* free allocation blocks */
 214         u_int32_t         reclaimBlocks;          /* number of blocks we are reclaiming during resize */
 215         u_int32_t         tentativeBlocks;        /* tentative allocation blocks -- see note below */
 216         u_int32_t     nextAllocation;     /* start of next allocation search */
 217         u_int32_t     sparseAllocation;   /* start of allocations for sparse devices */
 218         u_int32_t     vcbNxtCNID;         /* next unused catalog node ID - protected by catalog lock */
 219         u_int32_t     vcbWrCnt;           /* file system write count */
 220         u_int64_t     encodingsBitmap;    /* in-use encodings */
 221         u_int16_t     vcbNmFls;           /* HFS Only - root dir file count */
 222         u_int16_t     vcbNmRtDirs;        /* HFS Only - root dir directory count */
 223
 224         /* Persistent fields (on disk, static) */
 225         u_int16_t                       vcbSigWord;
 226
 227         // Volume will be inconsistent if header is not flushed
 228         bool                            hfs_header_dirty;
 229
 230         // Volume header is dirty, but won't be inconsistent if not flushed
 231         bool                            hfs_header_minor_change;
 232
 233         u_int32_t                       vcbAtrb;
 234         u_int32_t                       vcbJinfoBlock;
 235         u_int32_t                       localCreateDate;/* volume create time from volume header (For HFS+, value is in local time) */
 236         time_t                          hfs_itime;      /* file system creation time (creation date of the root folder) */
 237         time_t                          hfs_btime;      /* file system last backup time */
 238         u_int32_t                       blockSize;      /* size of allocation blocks */
 239         u_int32_t                       totalBlocks;    /* total allocation blocks */
 240         u_int32_t                       allocLimit;     /* Do not allocate this block or beyond */
 241         /*
 242          * NOTE: When resizing a volume to make it smaller, allocLimit is set to the allocation
 243          * block number which will contain the new alternate volume header.  At all other times,
 244          * allocLimit is set to totalBlocks.  The allocation code uses allocLimit instead of
 245          * totalBlocks to limit which blocks may be allocated, so that during a resize, we don't
 246          * put new content into the blocks we're trying to truncate away.
 247          */
 248         int32_t                         vcbClpSiz;
 249         u_int32_t     vcbFndrInfo[8];
 250         int16_t                         vcbVBMSt;               /* HFS only */
 251         int16_t                         vcbAlBlSt;              /* HFS only */
 252
 253         /* vcb stuff */
 254         u_int8_t                        vcbVN[256];             /* volume name in UTF-8 */
 255         u_int32_t                       volumeNameEncodingHint;
 256         u_int32_t                       hfsPlusIOPosOffset;     /* Disk block where HFS+ starts */
 257         u_int32_t                       vcbVBMIOSize;           /* volume bitmap I/O size */
 258
 259         /* cache of largest known free extents */
 260         u_int32_t                       vcbFreeExtCnt;
 261         HFSPlusExtentDescriptor vcbFreeExt[kMaxFreeExtents];
 262         lck_spin_t                      vcbFreeExtLock;
 263
 264         /* Summary Table */
 265         u_int8_t                        *hfs_summary_table; /* Each bit is 1 vcbVBMIOSize of bitmap, byte indexed */
 266         u_int32_t                       hfs_summary_size;       /* number of BITS in summary table defined above (not bytes!) */
 267         u_int32_t                       hfs_summary_bytes;      /* number of BYTES in summary table */
 268
 269         u_int32_t                       scan_var;                       /* For initializing the summary table */
 270
 271
 272         u_int32_t               reserveBlocks;          /* free block reserve */
 273         u_int32_t               loanedBlocks;           /* blocks on loan for delayed allocations */
 274         u_int32_t               lockedBlocks;           /* blocks reserved and locked */
 275
 276         /*
 277          * HFS+ Private system directories (two). Any access
 278          * (besides looking at the cd_cnid) requires holding
 279          * the Catalog File lock.
 280          */
 281         struct cat_desc     hfs_private_desc[2];
 282         struct cat_attr     hfs_private_attr[2];
 283
 284         u_int32_t               hfs_metadata_createdate;
 285 #if CONFIG_HFS_STD
 286         hfs_to_unicode_func_t   hfs_get_unicode;
 287         unicode_to_hfs_func_t   hfs_get_hfsname;
 288 #endif
 289
 290         /* Quota variables: */
 291         struct quotafile        hfs_qfiles[MAXQUOTAS];    /* quota files */
 292
 293         /* Journaling variables: */
 294         struct journal      *jnl;           // the journal for this volume (if one exists)
 295         struct vnode        *jvp;           // device where the journal lives (may be equal to devvp)
 296         u_int32_t            jnl_start;     // start block of the journal file (so we don't delete it)
 297         u_int32_t            jnl_size;
 298         u_int32_t            hfs_jnlfileid;
 299         u_int32_t            hfs_jnlinfoblkid;
 300         lck_rw_t                 hfs_global_lock;
 301         thread_t                         hfs_global_lockowner;
 302         u_int32_t            hfs_transaction_nesting;
 303
 304         /*
 305          * Notification variables
 306          * See comments in hfs mount code for what the
 307          * default levels are set to.
 308          */
 309         u_int32_t               hfs_notification_conditions;
 310         u_int32_t               hfs_freespace_notify_dangerlimit;
 311         u_int32_t               hfs_freespace_notify_warninglimit;
 312         u_int32_t               hfs_freespace_notify_nearwarninglimit;
 313         u_int32_t               hfs_freespace_notify_desiredlevel;
 314
 315         /* time mounted and last mounted mod time "snapshot" */
 316         time_t          hfs_mount_time;
 317         time_t          hfs_last_mounted_mtime;
 318
 319         /* Metadata allocation zone variables: */
 320         u_int32_t       hfs_metazone_start;
 321         u_int32_t       hfs_metazone_end;
 322         u_int32_t       hfs_hotfile_start;
 323         u_int32_t       hfs_hotfile_end;
 324         u_int32_t       hfs_min_alloc_start;
 325         u_int32_t       hfs_freed_block_count;
 326         u_int64_t       hfs_cs_hotfile_size;     // in bytes
 327         int             hfs_hotfile_freeblks;
 328         int             hfs_hotfile_blk_adjust; // since we pass this to OSAddAtomic, this needs to be 4-byte aligned
 329         int             hfs_hotfile_maxblks;
 330         int             hfs_overflow_maxblks;
 331         int             hfs_catalog_maxblks;
 332
 333         /* Hot File Clustering variables: */
 334         lck_mtx_t       hfc_mutex;      /* serialize hot file stages */
 335         enum hfc_stage  hfc_stage;      /* what are we up to... */
 336         time_t          hfc_timebase;   /* recording period start time */
 337         time_t          hfc_timeout;    /* recording period stop time */
 338         struct hotfile_data *hfc_recdata;
 339         struct hotfilelist *hfc_filelist;
 340         uint32_t        hfc_maxfiles;   /* maximum files to track */
 341         struct vnode *  hfc_filevp;
 342
 343         /* defrag-on-open variables */
 344         int             hfs_defrag_nowait;  //issue defrags now, regardless of whether or not we've gone past 3 min.
 345         uint64_t                hfs_defrag_max; //maximum file size we'll defragment on this mount
 346
 347 #if HFS_SPARSE_DEV
 348         /* Sparse device variables: */
 349         struct vnode * hfs_backingvp;
 350         u_int32_t      hfs_last_backingstatfs;
 351         u_int32_t      hfs_sparsebandblks;
 352         u_int64_t      hfs_backingfs_maxblocks;
 353 #endif
 354         size_t         hfs_max_inline_attrsize;
 355
 356         lck_mtx_t      hfs_mutex;      /* protects access to hfsmount data */
 357
 358         uint32_t       hfs_syncers;     // Count of the number of syncers running
 359         enum {
 360                 HFS_THAWED,
 361                 HFS_WANT_TO_FREEZE,     // This state stops hfs_sync from starting
 362                 HFS_FREEZING,           // We're in this state whilst we're flushing
 363                 HFS_FROZEN                      // Everything gets blocked in hfs_lock_global
 364         } hfs_freeze_state;
 365         union {
 366                 /*
 367                  * When we're freezing (HFS_FREEZING) but not yet
 368                  * frozen (HFS_FROZEN), we record the freezing thread
 369                  * so that we stop other threads from taking locks,
 370                  * but allow the freezing thread.
 371                  */
 372                 const struct thread *hfs_freezing_thread;
 373                 /*
 374                  * Once we have frozen (HFS_FROZEN), we record the
 375                  * process so that if it dies, we can automatically
 376                  * unfreeze.
 377                  */
 378                 proc_t hfs_freezing_proc;
 379         };
 380
 381         thread_t                hfs_downgrading_thread; /* thread who's downgrading to rdonly */
 382
 383         /* Resize variables: */
 384         u_int32_t               hfs_resize_blocksmoved;
 385         u_int32_t               hfs_resize_totalblocks;
 386         u_int32_t               hfs_resize_progress;
 387 #if CONFIG_PROTECT
 388         /* Data Protection fields */
 389         cpx_t                   hfs_resize_cpx;
 390         u_int16_t               hfs_running_cp_major_vers;
 391         uint32_t                default_cp_class; /* default effective class value */
 392         uint64_t                cproot_flags;
 393         uint8_t                 cp_crypto_generation;
 394         cp_lock_state_t hfs_cp_lock_state;  /* per-mount device lock state info */
 395 #if HFS_CONFIG_KEY_ROLL
 396         uint32_t                hfs_auto_roll_min_key_os_version;
 397         uint32_t                hfs_auto_roll_max_key_os_version;
 398 #endif
 399 #if HFS_TMPDBG
 400 #if !SECURE_KERNEL
 401         boolean_t               hfs_cp_verbose;
 402 #endif
 403 #endif
 404
 405 #endif
 406
 407         /* the full UUID of the volume, not the one stored in finderinfo */
 408         uuid_t           hfs_full_uuid;
 409
 410         /* Per mount cnode hash variables: */
 411         lck_mtx_t      hfs_chash_mutex; /* protects access to cnode hash table */
 412         u_long         hfs_cnodehash;   /* size of cnode hash table - 1 */
 413         LIST_HEAD(cnodehashhead, cnode) *hfs_cnodehashtbl;      /* base of cnode hash */
 414
 415         /* Per mount fileid hash variables  (protected by catalog lock!) */
 416         u_long hfs_idhash; /* size of cnid/fileid hash table -1 */
 417         LIST_HEAD(idhashhead, cat_preflightid) *hfs_idhashtbl; /* base of ID hash */
 418
 419     // Records the oldest outstanding sync request
 420     struct timeval      hfs_sync_req_oldest;
 421
 422     /* Records the syncer thread so that we can avoid the syncer
 423        queing more syncs. */
 424     thread_t            hfs_syncer_thread;
 425
 426         // Not currently used except for debugging purposes
 427         // Since we pass this to OSAddAtomic, this needs to be 4-byte aligned.
 428         uint32_t        hfs_active_threads;
 429
 430         enum {
 431                 // These are indices into the array below
 432
 433                 // Tentative ranges can be claimed back at any time
 434                 HFS_TENTATIVE_BLOCKS    = 0,
 435
 436                 // Locked ranges cannot be claimed back, but the allocation
 437                 // won't have been written to disk yet
 438                 HFS_LOCKED_BLOCKS               = 1,
 439         };
 440         // These lists are not sorted like a range list usually is
 441         struct rl_head hfs_reserved_ranges[2];
 442 } hfsmount_t;
 443
 444 /*
 445  * HFS_META_DELAY is a duration (in usecs) used for triggering the
 446  * hfs_syncer() routine. We will back off if writes are in
 447  * progress, but...
 448  * HFS_MAX_META_DELAY is the maximum time we will allow the
 449  * syncer to be delayed.
 450  */
 451 enum {
 452     HFS_META_DELAY     = 100  * 1000,   // 0.1 secs
 453     HFS_MAX_META_DELAY = 5000 * 1000    // 5 secs
 454 };
 455
 456 #define HFS_META_DELAY_TS \
 457         (struct timespec){ 0, HFS_META_DELAY * NSEC_PER_USEC }
 458
 459 typedef hfsmount_t  ExtendedVCB;
 460
 461 /* Aliases for legacy (Mac OS 9) field names */
 462 #define vcbLsMod           hfs_mtime
 463 #define vcbVolBkUp         hfs_btime
 464 #define extentsRefNum      hfs_extents_vp
 465 #define catalogRefNum      hfs_catalog_vp
 466 #define allocationsRefNum  hfs_allocation_vp
 467 #define vcbFilCnt          hfs_filecount
 468 #define vcbDirCnt          hfs_dircount
 469
 470 static inline void MarkVCBDirty(hfsmount_t *hfsmp)
 471 {
 472         hfsmp->hfs_header_dirty = true;
 473 }
 474
 475 static inline void MarkVCBClean(hfsmount_t *hfsmp)
 476 {
 477         hfsmp->hfs_header_dirty = false;
 478         hfsmp->hfs_header_minor_change = false;
 479 }
 480
 481 static inline bool IsVCBDirty(ExtendedVCB *vcb)
 482 {
 483         return vcb->hfs_header_minor_change || vcb->hfs_header_dirty;
 484 }
 485
 486 // Header is changed but won't be inconsistent if we don't write it
 487 static inline void hfs_note_header_minor_change(hfsmount_t *hfsmp)
 488 {
 489         hfsmp->hfs_header_minor_change = true;
 490 }
 491
 492 // Must header be flushed for volume to be consistent?
 493 static inline bool hfs_header_needs_flushing(hfsmount_t *hfsmp)
 494 {
 495         return (hfsmp->hfs_header_dirty
 496                         || ISSET(hfsmp->hfs_catalog_cp->c_flag, C_MODIFIED)
 497                         || ISSET(hfsmp->hfs_extents_cp->c_flag, C_MODIFIED)
 498                         || (hfsmp->hfs_attribute_cp
 499                                 && ISSET(hfsmp->hfs_attribute_cp->c_flag, C_MODIFIED))
 500                         || (hfsmp->hfs_allocation_cp
 501                                 && ISSET(hfsmp->hfs_allocation_cp->c_flag, C_MODIFIED))
 502                         || (hfsmp->hfs_startup_cp
 503                                 && ISSET(hfsmp->hfs_startup_cp->c_flag, C_MODIFIED)));
 504 }
 505
 506 /*
 507  * There are two private directories in HFS+.
 508  *
 509  * One contains inodes for files that are hardlinked or open/unlinked.
 510  * The other contains inodes for directories that are hardlinked.
 511  */
 512 enum privdirtype {FILE_HARDLINKS, DIR_HARDLINKS};
 513
 514 #define HFS_ALLOCATOR_SCAN_INFLIGHT     0x0001          /* scan started */
 515 #define HFS_ALLOCATOR_SCAN_COMPLETED 0x0002             /* initial scan was completed */
 516
 517 /* HFS mount point flags */
 518 #define HFS_READ_ONLY             0x00001
 519 #define HFS_UNKNOWN_PERMS         0x00002
 520 #define HFS_WRITEABLE_MEDIA       0x00004
 521 #define HFS_CLEANED_ORPHANS       0x00008
 522 #define HFS_X                     0x00010
 523 #define HFS_CASE_SENSITIVE        0x00020
 524 #define HFS_STANDARD              0x00040
 525 #define HFS_METADATA_ZONE         0x00080
 526 #define HFS_FRAGMENTED_FREESPACE  0x00100
 527 #define HFS_NEED_JNL_RESET        0x00200
 528 #define HFS_HAS_SPARSE_DEVICE     0x00400
 529 #define HFS_RESIZE_IN_PROGRESS    0x00800
 530 #define HFS_QUOTAS                0x01000
 531 #define HFS_CREATING_BTREE        0x02000
 532 /* When set, do not update nextAllocation in the mount structure */
 533 #define HFS_SKIP_UPDATE_NEXT_ALLOCATION 0x04000
 534 /* When set, the file system supports extent-based extended attributes */
 535 #define HFS_XATTR_EXTENTS         0x08000
 536 #define HFS_FOLDERCOUNT           0x10000
 537 /* When set, the file system exists on a virtual device, like disk image */
 538 #define HFS_VIRTUAL_DEVICE        0x20000
 539 /* When set, we're in hfs_changefs, so hfs_sync should do nothing. */
 540 #define HFS_IN_CHANGEFS           0x40000
 541 /* When set, we are in process of downgrading or have downgraded to read-only,
 542  * so hfs_start_transaction should return EROFS.
 543  */
 544 #define HFS_RDONLY_DOWNGRADE      0x80000
 545 #define HFS_DID_CONTIG_SCAN      0x100000
 546 #define HFS_UNMAP                0x200000
 547 #define HFS_SSD                  0x400000
 548 #define HFS_SUMMARY_TABLE        0x800000
 549 #define HFS_CS                  0x1000000
 550 #define HFS_CS_METADATA_PIN     0x2000000
 551 #define HFS_CS_HOTFILE_PIN      0x4000000       /* cooperative fusion (enables a hotfile variant) */
 552 #define HFS_FEATURE_BARRIER     0x8000000       /* device supports barrier-only flush */
 553 #define HFS_CS_SWAPFILE_PIN    0x10000000
 554 #define HFS_RUN_SYNCER             0x20000000
 555
 556 /* Macro to update next allocation block in the HFS mount structure.  If
 557  * the HFS_SKIP_UPDATE_NEXT_ALLOCATION is set, do not update
 558  * nextAllocation block.
 559  */
 560 #define HFS_UPDATE_NEXT_ALLOCATION(hfsmp, new_nextAllocation)                   \
 561         {                                                               \
 562                 if ((hfsmp->hfs_flags & HFS_SKIP_UPDATE_NEXT_ALLOCATION) == 0)\
 563                         hfsmp->nextAllocation = new_nextAllocation;     \
 564         }                                                               \
 565
 566 /* Macro for incrementing and decrementing the folder count in a cnode
 567  * attribute only if the HFS_FOLDERCOUNT bit is set in the mount flags
 568  * and kHFSHasFolderCount bit is set in the cnode flags.  Currently these
 569  * bits are only set for case sensitive HFS+ volumes.
 570  */
 571 #define INC_FOLDERCOUNT(hfsmp, cattr)                           \
 572         if ((hfsmp->hfs_flags & HFS_FOLDERCOUNT) &&             \
 573             (cattr.ca_recflags & kHFSHasFolderCountMask)) {     \
 574                 cattr.ca_dircount++;                            \
 575         }                                                       \
 576
 577 #define DEC_FOLDERCOUNT(hfsmp, cattr)                           \
 578         if ((hfsmp->hfs_flags & HFS_FOLDERCOUNT) &&             \
 579             (cattr.ca_recflags & kHFSHasFolderCountMask) &&     \
 580             (cattr.ca_dircount > 0)) {                          \
 581                 cattr.ca_dircount--;                            \
 582         }                                                       \
 583
 584 typedef struct filefork FCB;
 585
 586 /*
 587  * Macros for creating item names for our special/private directories.
 588  */
 589 #define MAKE_INODE_NAME(name, size, linkno) \
 590             (void) snprintf((name), size, "%s%d", HFS_INODE_PREFIX, (linkno))
 591 #define HFS_INODE_PREFIX_LEN    5
 592
 593 #define MAKE_DIRINODE_NAME(name, size, linkno) \
 594             (void) snprintf((name), size, "%s%d", HFS_DIRINODE_PREFIX, (linkno))
 595 #define HFS_DIRINODE_PREFIX_LEN   4
 596
 597 #define MAKE_DELETED_NAME(NAME, size, FID) \
 598             (void) snprintf((NAME), size, "%s%d", HFS_DELETE_PREFIX, (FID))
 599 #define HFS_DELETE_PREFIX_LEN   4
 600
 601
 602 #define HFS_AVERAGE_NAME_SIZE   22
 603 #define AVERAGE_HFSDIRENTRY_SIZE  (8+HFS_AVERAGE_NAME_SIZE+4)
 604
 605 #define STD_DIRENT_LEN(namlen) \
 606         ((sizeof(struct dirent) - (NAME_MAX+1)) + (((namlen)+1 + 3) &~ 3))
 607
 608 #define EXT_DIRENT_LEN(namlen) \
 609         ((sizeof(struct direntry) + (namlen) - (MAXPATHLEN-1) + 7) & ~7)
 610
 611
 612 enum { kHFSPlusMaxFileNameBytes = kHFSPlusMaxFileNameChars * 3 };
 613
 614
 615 /* macro to determine if hfs or hfsplus */
 616 #define ISHFSPLUS(VCB) ((VCB)->vcbSigWord == kHFSPlusSigWord)
 617 #define ISHFS(VCB) ((VCB)->vcbSigWord == kHFSSigWord)
 618
 619
 620 /*
 621  * Various ways to acquire a VFS mount point pointer:
 622  */
 623 #define VTOVFS(VP)  vnode_mount((VP))
 624 #define HFSTOVFS(HFSMP) ((HFSMP)->hfs_mp)
 625 #define VCBTOVFS(VCB)   HFSTOVFS(VCB)
 626
 627 /*
 628  * Various ways to acquire an HFS mount point pointer:
 629  */
 630 #define VTOHFS(VP)  ((struct hfsmount *)vfs_fsprivate(vnode_mount((VP))))
 631 #define VFSTOHFS(MP)  ((struct hfsmount *)vfs_fsprivate((MP)))
 632 #define VCBTOHFS(VCB) (VCB)
 633 #define FCBTOHFS(FCB)  ((struct hfsmount *)vfs_fsprivate(vnode_mount((FCB)->ff_cp->c_vp)))
 634
 635 /*
 636  * Various ways to acquire a VCB (legacy) pointer:
 637  */
 638 #define VTOVCB(VP)       VTOHFS(VP)
 639 #define VFSTOVCB(MP)     VFSTOHFS(MP)
 640 #define HFSTOVCB(HFSMP)  (HFSMP)
 641 #define FCBTOVCB(FCB)    FCBTOHFS(FCB)
 642
 643
 644 #define E_NONE  0
 645 #define kHFSBlockSize 512
 646
 647 /*
 648  * Macros for getting the MDB/VH sector and offset
 649  */
 650 #define HFS_PRI_SECTOR(blksize)          (1024 / (blksize))
 651 #define HFS_PRI_OFFSET(blksize)          ((blksize) > 1024 ? 1024 : 0)
 652
 653 #define HFS_ALT_SECTOR(blksize, blkcnt)  (((blkcnt) - 1) - (512 / (blksize)))
 654 #define HFS_ALT_OFFSET(blksize)          ((blksize) > 1024 ? (blksize) - 1024 : 0)
 655
 656 /* Convert the logical sector number to be aligned on physical block size boundary.
 657  * We are assuming the partition is a multiple of physical block size.
 658  */
 659 #define HFS_PHYSBLK_ROUNDDOWN(sector_num, log_per_phys) ((sector_num / log_per_phys) * log_per_phys)
 660
 661 /*
 662  * HFS specific fcntl()'s
 663  */
 664 #define HFS_GET_BOOT_INFO   (FCNTL_FS_SPECIFIC_BASE + 0x00004)
 665 #define HFS_SET_BOOT_INFO   (FCNTL_FS_SPECIFIC_BASE + 0x00005)
 666 /* See HFSIOC_EXT_BULKACCESS and friends for HFS specific fsctls*/
 667
 668
 669
 670 /*
 671  *      This is the straight GMT conversion constant:
 672  *      00:00:00 January 1, 1970 - 00:00:00 January 1, 1904
 673  *      (3600 * 24 * ((365 * (1970 - 1904)) + (((1970 - 1904) / 4) + 1)))
 674  */
 675 #define MAC_GMT_FACTOR          2082844800UL
 676
 677 static inline __attribute__((const))
 678 off_t hfs_blk_to_bytes(uint32_t blk, uint32_t blk_size)
 679 {
 680         return (off_t)blk * blk_size;           // Avoid the overflow
 681 }
 682
 683 /*
 684  * For now, we use EIO to indicate consistency issues.  It is safe to
 685  * return or assign an error value to HFS_EINCONSISTENT but it is
 686  * *not* safe to compare against it because EIO can be generated for
 687  * other reasons.  We take advantage of the fact that == has
 688  * left-to-right associativity and so any uses of:
 689  *
 690  *    if (error == HFS_EINCONSISTENT)
 691  *
 692  * will produce a compiler warning: "comparison between pointer and
 693  * integer".
 694  *
 695  * Note that not everwhere is consistent with the use of
 696  * HFS_EINCONSISTENT.  Some places return EINVAL, EIO directly or
 697  * other error codes.
 698  */
 699 #define HFS_EINCONSISTENT               (void *)0 == (void *)0 ? EIO : EIO
 700
 701 #define HFS_ERESERVEDNAME               -8
 702
 703 extern int (**hfs_specop_p)(void *);
 704
 705 /*****************************************************************************
 706         FUNCTION PROTOTYPES
 707 ******************************************************************************/
 708
 709 /*****************************************************************************
 710         hfs_vnop_xxx functions from different files
 711 ******************************************************************************/
 712 int hfs_vnop_readdirattr(struct vnop_readdirattr_args *);  /* in hfs_attrlist.c */
 713 int hfs_vnop_getattrlistbulk(struct vnop_getattrlistbulk_args *);  /* in hfs_attrlist.c */
 714
 715 int hfs_vnop_inactive(struct vnop_inactive_args *);        /* in hfs_cnode.c */
 716 int hfs_vnop_reclaim(struct vnop_reclaim_args *);          /* in hfs_cnode.c */
 717
 718 int hfs_set_backingstore (struct vnode *vp, int val);                           /* in hfs_cnode.c */
 719 int hfs_is_backingstore (struct vnode *vp, int *val);           /* in hfs_cnode.c */
 720
 721 int hfs_vnop_link(struct vnop_link_args *);                /* in hfs_link.c */
 722
 723 int hfs_vnop_lookup(struct vnop_lookup_args *);            /* in hfs_lookup.c */
 724
 725 int hfs_vnop_search(struct vnop_searchfs_args *);          /* in hfs_search.c */
 726
 727 int hfs_vnop_read(struct vnop_read_args *);           /* in hfs_readwrite.c */
 728 int hfs_vnop_write(struct vnop_write_args *);         /* in hfs_readwrite.c */
 729 int hfs_vnop_ioctl(struct vnop_ioctl_args *);         /* in hfs_readwrite.c */
 730 int hfs_vnop_select(struct vnop_select_args *);       /* in hfs_readwrite.c */
 731 int hfs_vnop_strategy(struct vnop_strategy_args *);   /* in hfs_readwrite.c */
 732 int hfs_vnop_allocate(struct vnop_allocate_args *);   /* in hfs_readwrite.c */
 733 int hfs_vnop_pagein(struct vnop_pagein_args *);       /* in hfs_readwrite.c */
 734 int hfs_vnop_pageout(struct vnop_pageout_args *);     /* in hfs_readwrite.c */
 735 int hfs_vnop_bwrite(struct vnop_bwrite_args *);       /* in hfs_readwrite.c */
 736 int hfs_vnop_blktooff(struct vnop_blktooff_args *);   /* in hfs_readwrite.c */
 737 int hfs_vnop_offtoblk(struct vnop_offtoblk_args *);   /* in hfs_readwrite.c */
 738 int hfs_vnop_blockmap(struct vnop_blockmap_args *);   /* in hfs_readwrite.c */
 739 errno_t hfs_flush_invalid_ranges(vnode_t vp);             /* in hfs_readwrite.c */
 740
 741 int hfs_vnop_getxattr(struct vnop_getxattr_args *);        /* in hfs_xattr.c */
 742 int hfs_vnop_setxattr(struct vnop_setxattr_args *);        /* in hfs_xattr.c */
 743 int hfs_vnop_removexattr(struct vnop_removexattr_args *);  /* in hfs_xattr.c */
 744 int hfs_vnop_listxattr(struct vnop_listxattr_args *);      /* in hfs_xattr.c */
 745 #if NAMEDSTREAMS
 746 extern int hfs_vnop_getnamedstream(struct vnop_getnamedstream_args*);
 747 extern int hfs_vnop_makenamedstream(struct vnop_makenamedstream_args*);
 748 extern int hfs_vnop_removenamedstream(struct vnop_removenamedstream_args*);
 749 #endif
 750
 751
 752 /*****************************************************************************
 753         Functions from MacOSStubs.c
 754 ******************************************************************************/
 755 time_t to_bsd_time(u_int32_t hfs_time);
 756
 757 u_int32_t to_hfs_time(time_t bsd_time);
 758
 759
 760 /*****************************************************************************
 761         Functions from hfs_notifications.c
 762 ******************************************************************************/
 763 void hfs_generate_volume_notifications(struct hfsmount *hfsmp);
 764
 765
 766 /*****************************************************************************
 767         Functions from hfs_readwrite.c
 768 ******************************************************************************/
 769 extern int  hfs_relocate(struct  vnode *, u_int32_t, kauth_cred_t, struct  proc *);
 770
 771 /* flags for hfs_pin_block_range() and hfs_pin_vnode() */
 772 #define HFS_PIN_IT       0x0001
 773 #define HFS_UNPIN_IT     0x0002
 774 #define HFS_TEMP_PIN     0x0004
 775 #define HFS_EVICT_PIN    0x0008
 776 #define HFS_DATALESS_PIN 0x0010
 777
 778 //
 779 // pin/un-pin an explicit range of blocks to the "fast" (usually ssd) device
 780 //
 781 int hfs_pin_block_range(struct hfsmount *hfsmp, int pin_state, uint32_t start_block, uint32_t nblocks);
 782
 783 //
 784 // pin/un-pin all the extents belonging to a vnode.
 785 // also, if it is non-null, "num_blocks_pinned" returns the number of blocks pin/unpinned by the function
 786 //
 787 int hfs_pin_vnode(struct hfsmount *hfsmp, struct vnode *vp, int pin_state, uint32_t *num_blocks_pinned);
 788
 789
 790 int hfs_pin_overflow_extents (struct hfsmount *hfsmp, uint32_t fileid, uint8_t forktype, uint32_t *pinned);
 791
 792
 793 /* Flags for HFS truncate */
 794 #define HFS_TRUNCATE_SKIPTIMES          0x00000002 /* implied by skipupdate; it is a subset */
 795
 796
 797 extern int hfs_truncate(struct vnode *, off_t, int, int, vfs_context_t);
 798
 799 extern int hfs_release_storage (struct hfsmount *hfsmp, struct filefork *datafork,
 800                                                                 struct filefork *rsrcfork,  u_int32_t fileid);
 801
 802 extern int hfs_prepare_release_storage (struct hfsmount *hfsmp, struct vnode *vp);
 803
 804 extern int hfs_bmap(struct vnode *, daddr_t, struct vnode **, daddr64_t *, unsigned int *);
 805
 806 extern errno_t hfs_ubc_setsize(vnode_t vp, off_t len, bool have_cnode_lock);
 807
 808
 809 /*****************************************************************************
 810         Functions from hfs_resize.c
 811 ******************************************************************************/
 812 int hfs_extendfs(struct hfsmount *hfsmp, u_int64_t newsize, vfs_context_t context);
 813 int hfs_truncatefs(struct hfsmount *hfsmp, u_int64_t newsize, vfs_context_t context);
 814
 815
 816 /*****************************************************************************
 817         Functions from hfs_vfsops.c
 818 ******************************************************************************/
 819
 820 extern void hfs_getvoluuid(struct hfsmount *hfsmp, uuid_t result);
 821
 822 /* used as a callback by the journaling code */
 823 extern void hfs_sync_metadata(void *arg);
 824
 825 extern int hfs_vget(struct hfsmount *, cnid_t, struct vnode **, int, int);
 826
 827 extern void hfs_setencodingbits(struct hfsmount *hfsmp, u_int32_t encoding);
 828
 829 enum volop {VOL_UPDATE, VOL_MKDIR, VOL_RMDIR, VOL_MKFILE, VOL_RMFILE};
 830 extern int hfs_volupdate(struct hfsmount *hfsmp, enum volop op, int inroot);
 831
 832 enum {
 833         HFS_FVH_WAIT                                    = 0x0001,
 834         HFS_FVH_WRITE_ALT                               = 0x0002,
 835         HFS_FVH_FLUSH_IF_DIRTY                  = 0x0004,
 836 };
 837 typedef uint32_t hfs_flush_volume_header_options_t;
 838 int hfs_flushvolumeheader(struct hfsmount *hfsmp, hfs_flush_volume_header_options_t);
 839
 840 extern int  hfs_extendfs(struct hfsmount *, u_int64_t, vfs_context_t);
 841 extern int  hfs_truncatefs(struct hfsmount *, u_int64_t, vfs_context_t);
 842 extern int  hfs_resize_progress(struct hfsmount *, u_int32_t *);
 843
 844 /* If a runtime corruption is detected, mark the volume inconsistent
 845  * bit in the volume attributes.
 846  */
 847
 848 typedef enum {
 849         HFS_INCONSISTENCY_DETECTED,
 850
 851         // Used when unable to rollback an operation that failed
 852         HFS_ROLLBACK_FAILED,
 853
 854         // Used when the latter part of an operation failed, but we chose not to roll back
 855         HFS_OP_INCOMPLETE,
 856
 857         // Used when someone told us to force an fsck on next mount
 858         HFS_FSCK_FORCED,
 859 } hfs_inconsistency_reason_t;
 860
 861 void hfs_mark_inconsistent(struct hfsmount *hfsmp,
 862                                                    hfs_inconsistency_reason_t reason);
 863
 864 void hfs_scan_blocks (struct hfsmount *hfsmp);
 865 int hfs_vfs_root(struct mount *mp, struct vnode **vpp, vfs_context_t context);
 866
 867 /*****************************************************************************
 868         Functions from hfs_vfsutils.c
 869 ******************************************************************************/
 870 u_int32_t BestBlockSizeFit(u_int32_t allocationBlockSize,
 871                                u_int32_t blockSizeLimit,
 872                                u_int32_t baseMultiple);
 873
 874 #if CONFIG_HFS_STD
 875 OSErr   hfs_MountHFSVolume(struct hfsmount *hfsmp, HFSMasterDirectoryBlock *mdb,
 876                 struct proc *p);
 877 #endif
 878 OSErr   hfs_MountHFSPlusVolume(struct hfsmount *hfsmp, HFSPlusVolumeHeader *vhp,
 879                 off_t embeddedOffset, u_int64_t disksize, struct proc *p, void *args, kauth_cred_t cred);
 880
 881 OSErr hfs_ValidateHFSPlusVolumeHeader(struct hfsmount *hfsmp, HFSPlusVolumeHeader *vhp);
 882
 883 extern int hfsUnmount(struct hfsmount *hfsmp, struct proc *p);
 884
 885 extern bool overflow_extents(struct filefork *fp);
 886
 887 extern int hfs_owner_rights(struct hfsmount *hfsmp, uid_t cnode_uid, kauth_cred_t cred,
 888                 struct proc *p, int invokesuperuserstatus);
 889
 890 extern int check_for_dataless_file(struct vnode *vp, uint64_t op_type);
 891 extern int hfs_generate_document_id(struct hfsmount *hfsmp, uint32_t *docid);
 892 extern void hfs_pin_fs_metadata(struct hfsmount *hfsmp);
 893
 894 /* Return information about number of metadata blocks for volume */
 895 extern int hfs_getinfo_metadata_blocks(struct hfsmount *hfsmp, struct hfsinfo_metadata *hinfo);
 896
 897 /*
 898  * Journal lock function prototypes
 899  */
 900 int hfs_lock_global (struct hfsmount *hfsmp, enum hfs_locktype locktype);
 901 void hfs_unlock_global (struct hfsmount *hfsmp);
 902
 903 /* HFS mount lock/unlock prototypes */
 904 void hfs_lock_mount (struct hfsmount *hfsmp);
 905 void hfs_unlock_mount (struct hfsmount *hfsmp);
 906
 907
 908 /* HFS System file locking */
 909 #define SFL_CATALOG     0x0001
 910 #define SFL_EXTENTS     0x0002
 911 #define SFL_BITMAP      0x0004
 912 #define SFL_ATTRIBUTE   0x0008
 913 #define SFL_STARTUP     0x0010
 914 #define SFL_VM_PRIV     0x0020
 915 #define SFL_VALIDMASK   (SFL_CATALOG | SFL_EXTENTS | SFL_BITMAP | SFL_ATTRIBUTE | SFL_STARTUP | SFL_VM_PRIV)
 916
 917 extern u_int32_t  GetFileInfo(ExtendedVCB *vcb, u_int32_t dirid, const char *name,
 918                                                    struct cat_attr *fattr, struct cat_fork *forkinfo);
 919
 920 extern void hfs_remove_orphans(struct hfsmount *);
 921
 922 u_int32_t GetLogicalBlockSize(struct vnode *vp);
 923
 924 extern u_int32_t hfs_free_cnids(struct hfsmount * hfsmp);
 925 extern u_int32_t hfs_freeblks(struct hfsmount * hfsmp, int wantreserve);
 926
 927 short MacToVFSError(OSErr err);
 928
 929 void hfs_metadatazone_init(struct hfsmount *hfsmp, int disable);
 930
 931 /* HFS directory hint functions. */
 932 extern directoryhint_t * hfs_getdirhint(struct cnode *, int, int);
 933 extern void  hfs_reldirhint(struct cnode *, directoryhint_t *);
 934 extern void  hfs_reldirhints(struct cnode *, int);
 935 extern void  hfs_insertdirhint(struct cnode *, directoryhint_t *);
 936
 937 extern int hfs_namecmp(const u_int8_t *str1, size_t len1, const u_int8_t *str2, size_t len2);
 938
 939 extern int     hfs_early_journal_init(struct hfsmount *hfsmp, HFSPlusVolumeHeader *vhp,
 940                            void *_args, off_t embeddedOffset, daddr64_t mdb_offset,
 941                            HFSMasterDirectoryBlock *mdbp, kauth_cred_t cred);
 942
 943 extern int  hfs_virtualmetafile(struct cnode *);
 944
 945 extern int hfs_start_transaction(struct hfsmount *hfsmp);
 946 extern int hfs_end_transaction(struct hfsmount *hfsmp);
 947 extern void hfs_journal_lock(struct hfsmount *hfsmp);
 948 extern void hfs_journal_unlock(struct hfsmount *hfsmp);
 949 extern void hfs_syncer_lock(struct hfsmount *hfsmp);
 950 extern void hfs_syncer_unlock(struct hfsmount *hfsmp);
 951 extern void hfs_syncer_wait(struct hfsmount *hfsmp, struct timespec *ts);
 952 extern void hfs_syncer_wakeup(struct hfsmount *hfsmp);
 953 extern void hfs_syncer(void *arg, wait_result_t);
 954 extern void hfs_sync_ejectable(struct hfsmount *hfsmp);
 955
 956 typedef enum hfs_flush_mode {
 957         HFS_FLUSH_JOURNAL,              // Flush journal
 958         HFS_FLUSH_JOURNAL_META,         // Flush journal and metadata blocks
 959         HFS_FLUSH_FULL,                 // Flush journal and does a cache flush
 960         HFS_FLUSH_CACHE,                // Flush track cache to media
 961         HFS_FLUSH_BARRIER,              // Barrier-only flush to ensure write order
 962         HFS_FLUSH_JOURNAL_BARRIER       // Flush journal with barrier
 963 } hfs_flush_mode_t;
 964
 965 extern errno_t hfs_flush(struct hfsmount *hfsmp, hfs_flush_mode_t mode);
 966
 967 extern void hfs_trim_callback(void *arg, uint32_t extent_count, const dk_extent_t *extents);
 968
 969 /* Erase unused Catalog nodes due to <rdar://problem/6947811>. */
 970 extern int hfs_erase_unused_nodes(struct hfsmount *hfsmp);
 971
 972 extern uint64_t hfs_usecs_to_deadline(uint64_t usecs);
 973
 974 extern int hfs_freeze(struct hfsmount *hfsmp);
 975 extern int hfs_thaw(struct hfsmount *hfsmp, const struct proc *process);
 976
 977 void hfs_close_jvp(hfsmount_t *hfsmp);
 978
 979 // Return a heap address suitable for logging or tracing
 980 uintptr_t obfuscate_addr(void *addr);
 981
 982 #if CONFIG_HFS_STD
 983 int hfs_to_utf8(ExtendedVCB *vcb, const Str31 hfs_str, ByteCount maxDstLen,
 984                                 ByteCount *actualDstLen, unsigned char* dstStr);
 985 int utf8_to_hfs(ExtendedVCB *vcb, ByteCount srcLen, const unsigned char* srcStr,
 986                                 Str31 dstStr);
 987 int unicode_to_hfs(ExtendedVCB *vcb, ByteCount srcLen, u_int16_t* srcStr, Str31 dstStr, int retry);
 988 #endif
 989
 990 void *hfs_malloc(size_t size);
 991 void hfs_free(void *ptr, size_t size);
 992 void *hfs_mallocz(size_t size);
 993
 994 typedef enum {
 995         HFS_CNODE_ZONE,
 996         HFS_FILEFORK_ZONE,
 997         HFS_DIRHINT_ZONE,
 998         HFS_NUM_ZONES
 999 } hfs_zone_kind_t;
1000
1001 typedef struct hfs_zone_entry {
1002         hfs_zone_kind_t hze_kind;
1003         size_t                  hze_elem_size;
1004         const char *    hze_name;
1005         boolean_t               hze_noencrypt;
1006 } hfs_zone_entry_t;
1007
1008 typedef struct hfs_zone {
1009         zone_t hz_zone;
1010         size_t hz_elem_size;
1011 } hfs_zone_t;
1012
1013 void hfs_init_zones(void);
1014 void *hfs_zalloc(hfs_zone_kind_t type);
1015 void hfs_zfree(void *ptr, hfs_zone_kind_t type);
1016
1017 void hfs_sysctl_register(void);
1018 void hfs_sysctl_unregister(void);
1019
1020 #if HFS_MALLOC_DEBUG
1021
1022 void hfs_alloc_trace_disable(void);
1023 void hfs_alloc_trace_enable(void);
1024 bool hfs_dump_allocations(void);
1025
1026 #endif // HFS_MALLOC_DEBUG
1027
1028 /*****************************************************************************
1029         Functions from hfs_vnops.c
1030 ******************************************************************************/
1031 int hfs_write_access(struct vnode *vp, kauth_cred_t cred, struct proc *p, Boolean considerFlags);
1032
1033 int hfs_chmod(struct vnode *vp, int mode, kauth_cred_t cred, struct proc *p);
1034
1035 int hfs_chown(struct vnode *vp, uid_t uid, gid_t gid, kauth_cred_t cred, struct proc *p);
1036
1037 int hfs_vnop_create(struct vnop_create_args *ap);
1038
1039 int hfs_vnop_remove(struct vnop_remove_args*);
1040
1041 #define  kMaxSecsForFsync       5
1042 #define  HFS_SYNCTRANS          1
1043 extern int hfs_btsync(struct vnode *vp, int sync_transaction);
1044
1045 extern void replace_desc(struct cnode *cp, struct cat_desc *cdp);
1046
1047 extern int hfs_vgetrsrc(struct hfsmount *hfsmp, struct vnode *vp,
1048                                                 struct vnode **rvpp);
1049
1050 typedef enum {
1051         // Push all modifications to disk (including minor ones)
1052         HFS_UPDATE_FORCE = 0x01,
1053 } hfs_update_options_t;
1054
1055 extern int hfs_update(struct vnode *, int options);
1056
1057 typedef enum hfs_sync_mode {
1058         HFS_FSYNC,
1059         HFS_FSYNC_FULL,
1060         HFS_FSYNC_BARRIER
1061 } hfs_fsync_mode_t;
1062
1063 extern int hfs_fsync(struct vnode *, int, hfs_fsync_mode_t, struct proc *);
1064
1065 const struct cat_fork *
1066 hfs_prepare_fork_for_update(filefork_t *ff,
1067                                                         const struct cat_fork *cf,
1068                                                         struct cat_fork *cf_buf,
1069                                                         uint32_t block_size);
1070
1071 struct decmpfs_cnode;
1072 struct decmpfs_cnode *hfs_lazy_init_decmpfs_cnode (struct cnode *cp);
1073
1074 /*****************************************************************************
1075         Functions from hfs_xattr.c
1076 ******************************************************************************/
1077
1078 /*
1079  * Maximum extended attribute size supported for all extended attributes except
1080  * resource fork and finder info.
1081  */
1082 #define HFS_XATTR_MAXSIZE       INT32_MAX
1083
1084 /* Number of bits used to represent maximum extended attribute size */
1085 #define HFS_XATTR_SIZE_BITS     31
1086
1087 int  hfs_attrkeycompare(HFSPlusAttrKey *searchKey, HFSPlusAttrKey *trialKey);
1088 int  hfs_buildattrkey(u_int32_t fileID, const char *attrname, HFSPlusAttrKey *key);
1089 void hfs_xattr_init(struct hfsmount * hfsmp);
1090 int file_attribute_exist(struct hfsmount *hfsmp, uint32_t fileID);
1091 int init_attrdata_vnode(struct hfsmount *hfsmp);
1092 int hfs_xattr_read(vnode_t vp, const char *name, void *data, size_t *size);
1093 int hfs_getxattr_internal(cnode_t *, struct vnop_getxattr_args *,
1094                           struct hfsmount *, u_int32_t);
1095 int hfs_xattr_write(vnode_t vp, const char *name, const void *data, size_t size);
1096 int hfs_setxattr_internal(struct cnode *, const void *, size_t,
1097                           struct vnop_setxattr_args *, struct hfsmount *, u_int32_t);
1098 extern int hfs_removeallattr(struct hfsmount *hfsmp, u_int32_t fileid,
1099                                                          bool *open_transaction);
1100
1101 int hfs_removexattr_by_id (struct hfsmount *hfsmp, uint32_t fileid, const char *xattr_name );
1102
1103 extern int hfs_set_volxattr(struct hfsmount *hfsmp, unsigned int xattrtype, int state);
1104
1105
1106
1107 /*****************************************************************************
1108         Functions from hfs_link.c
1109 ******************************************************************************/
1110
1111 extern int  hfs_unlink(struct hfsmount *hfsmp, struct vnode *dvp, struct vnode *vp,
1112                        struct componentname *cnp, int skip_reserve);
1113 extern int  hfs_lookup_siblinglinks(struct hfsmount *hfsmp, cnid_t linkfileid,
1114                            cnid_t *prevlinkid,  cnid_t *nextlinkid);
1115 extern int  hfs_lookup_lastlink(struct hfsmount *hfsmp, cnid_t linkfileid,
1116                            cnid_t *nextlinkid, struct cat_desc *cdesc);
1117 extern void  hfs_privatedir_init(struct hfsmount *, enum privdirtype);
1118
1119 extern void  hfs_savelinkorigin(cnode_t *cp, cnid_t parentcnid);
1120 extern void  hfs_relorigins(struct cnode *cp);
1121 extern void  hfs_relorigin(struct cnode *cp, cnid_t parentcnid);
1122 extern int   hfs_haslinkorigin(cnode_t *cp);
1123 extern cnid_t  hfs_currentparent(cnode_t *cp, bool have_lock);
1124 extern cnid_t  hfs_currentcnid(cnode_t *cp);
1125 errno_t hfs_first_link(hfsmount_t *hfsmp, cnode_t *cp, cnid_t *link_id);
1126
1127
1128 /*****************************************************************************
1129         Functions from VolumeAllocation.c
1130  ******************************************************************************/
1131 extern int hfs_isallocated(struct hfsmount *hfsmp, u_int32_t startingBlock, u_int32_t numBlocks);
1132
1133 extern int hfs_count_allocated(struct hfsmount *hfsmp, u_int32_t startBlock,
1134                 u_int32_t numBlocks, u_int32_t *alloc_count);
1135
1136 extern int hfs_isrbtree_active (struct hfsmount *hfsmp);
1137
1138 /*****************************************************************************
1139         Functions from hfs_fsinfo.c
1140  ******************************************************************************/
1141 extern errno_t hfs_get_fsinfo(struct hfsmount *hfsmp, void *a_data);
1142 extern void hfs_fsinfo_data_add(struct hfs_fsinfo_data *fsinfo, uint64_t entry);
1143
1144 struct hfs_sysctl_chain {
1145         struct sysctl_oid *oid;
1146         struct hfs_sysctl_chain *next;
1147 };
1148
1149 extern struct hfs_sysctl_chain *sysctl_list;
1150
1151 SYSCTL_DECL(_vfs_generic_hfs);
1152
1153 #define HFS_SYSCTL(kind, parent, flags, name, ...)                                                      \
1154         SYSCTL_##kind(parent, flags, name, __VA_ARGS__)                                                 \
1155         struct hfs_sysctl_chain hfs_sysctl_##parent##_##name##_chain = {                \
1156                 .oid = &sysctl_##parent##_##name                                                                        \
1157         };                                                                                                                                              \
1158         static __attribute__((__constructor__)) void                                                    \
1159         hfs_sysctl_register_##parent##_##name(void) {                                                   \
1160                 hfs_sysctl_##parent##_##name##_chain.next = sysctl_list;                        \
1161                 sysctl_list = &hfs_sysctl_##parent##_##name##_chain;                            \
1162         }
1163
1164 __END_DECLS
1165
1166 #undef assert
1167 #define assert         Do_not_use_assert__Use_hfs_assert_instead
1168
1169 #endif /* __APPLE_API_PRIVATE */
1170 #endif /* KERNEL */
1171 #endif /* __HFS__ */