bsd/hfs/hfs.h

   1 /*
   2  * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 #ifndef __HFS__
  30 #define __HFS__
  31
  32 #define HFS_SPARSE_DEV 1
  33
  34 #ifdef DEBUG
  35 #define HFS_CHECK_LOCK_ORDER 1
  36 #endif
  37
  38 #include <sys/appleapiopts.h>
  39
  40 #ifdef KERNEL
  41 #ifdef __APPLE_API_PRIVATE
  42 #include <sys/param.h>
  43 #include <sys/queue.h>
  44 #include <sys/mount.h>
  45 #include <sys/vnode.h>
  46 #include <sys/quota.h>
  47 #include <sys/dirent.h>
  48 #include <sys/event.h>
  49
  50 #include <kern/locks.h>
  51
  52 #include <vfs/vfs_journal.h>
  53
  54 #include <hfs/hfs_format.h>
  55 #include <hfs/hfs_catalog.h>
  56 #include <hfs/hfs_cnode.h>
  57 #include <hfs/hfs_macos_defs.h>
  58 #include <hfs/hfs_encodings.h>
  59 #include <hfs/hfs_hotfiles.h>
  60
  61 /*
  62  *      Just reported via MIG interface.
  63  */
  64 #define VERSION_STRING  "hfs-2 (4-12-99)"
  65
  66 #define HFS_LINK_MAX    32767
  67
  68 #define HFS_MAX_DEFERED_ALLOC   (1024*1024)
  69
  70 // 400 megs is a "big" file (i.e. one that when deleted
  71 // would touch enough data that we should break it into
  72 // multiple separate transactions)
  73 #define HFS_BIGFILE_SIZE (400LL * 1024LL * 1024LL)
  74
  75
  76 enum { kMDBSize = 512 };                                /* Size of I/O transfer to read entire MDB */
  77
  78 enum { kMasterDirectoryBlock = 2 };                     /* MDB offset on disk in 512-byte blocks */
  79 enum { kMDBOffset = kMasterDirectoryBlock * 512 };      /* MDB offset on disk in bytes */
  80
  81 #define kRootDirID kHFSRootFolderID
  82
  83
  84 /* number of locked buffer caches to hold for b-tree meta data */
  85 #define kMaxLockedMetaBuffers           32
  86
  87 extern struct timezone gTimeZone;
  88
  89
  90 /* How many free extents to cache per volume */
  91 #define kMaxFreeExtents         10
  92
  93 /*
  94  * HFS_MINFREE gives the minimum acceptable percentage
  95  * of file system blocks which may be free (but this
  96  * minimum will never exceed HFS_MAXRESERVE bytes). If
  97  * the free block count drops below this level only the
  98  * superuser may continue to allocate blocks.
  99  */
 100 #define HFS_MINFREE             1
 101 #define HFS_MAXRESERVE          ((u_int64_t)(250*1024*1024))
 102
 103 /*
 104  * The system distinguishes between the desirable low-disk
 105  * notifiaction levels for root volumes and non-root volumes.
 106  * The various thresholds are computed as a fraction of the
 107  * volume size, all capped at a certain fixed level
 108  */
 109
 110 #define HFS_ROOTLOWDISKTRIGGERFRACTION 5
 111 #define HFS_ROOTLOWDISKTRIGGERLEVEL ((u_int64_t)(250*1024*1024))
 112 #define HFS_ROOTLOWDISKSHUTOFFFRACTION 6
 113 #define HFS_ROOTLOWDISKSHUTOFFLEVEL ((u_int64_t)(375*1024*1024))
 114
 115 #define HFS_LOWDISKTRIGGERFRACTION 1
 116 #define HFS_LOWDISKTRIGGERLEVEL ((u_int64_t)(50*1024*1024))
 117 #define HFS_LOWDISKSHUTOFFFRACTION 2
 118 #define HFS_LOWDISKSHUTOFFLEVEL ((u_int64_t)(75*1024*1024))
 119
 120 /* Internal Data structures*/
 121
 122 /* This structure describes the HFS specific mount structure data. */
 123 typedef struct hfsmount {
 124         u_int32_t     hfs_flags;              /* see below */
 125
 126         /* Physical Description */
 127         u_int32_t     hfs_logical_block_size;   /* Logical block size of the disk as reported by ioctl(DKIOCGETBLOCKSIZE), always a multiple of 512 */
 128         daddr64_t     hfs_logical_block_count;  /* Number of logical blocks on the disk */
 129         daddr64_t     hfs_alt_id_sector;        /* location of alternate VH/MDB */
 130         u_int32_t     hfs_physical_block_size;  /* Physical block size of the disk as reported by ioctl(DKIOCGETPHYSICALBLOCKSIZE) */
 131         u_int32_t     hfs_log_per_phys;         /* Number of logical blocks per physical block size */
 132
 133         /* Access to VFS and devices */
 134         struct mount            *hfs_mp;                                /* filesystem vfs structure */
 135         struct vnode            *hfs_devvp;                             /* block device mounted vnode */
 136         struct vnode *          hfs_extents_vp;
 137         struct vnode *          hfs_catalog_vp;
 138         struct vnode *          hfs_allocation_vp;
 139         struct vnode *          hfs_attribute_vp;
 140         struct vnode *          hfs_startup_vp;
 141         struct vnode *          hfs_attrdata_vp;   /* pseudo file */
 142         struct cnode *          hfs_extents_cp;
 143         struct cnode *          hfs_catalog_cp;
 144         struct cnode *          hfs_allocation_cp;
 145         struct cnode *          hfs_attribute_cp;
 146         struct cnode *          hfs_startup_cp;
 147         dev_t                   hfs_raw_dev;                    /* device mounted */
 148         u_int32_t               hfs_logBlockSize;               /* Size of buffer cache buffer for I/O */
 149
 150         /* Default values for HFS standard and non-init access */
 151         uid_t         hfs_uid;            /* uid to set as owner of the files */
 152         gid_t         hfs_gid;            /* gid to set as owner of the files */
 153         mode_t        hfs_dir_mask;       /* mask to and with directory protection bits */
 154         mode_t        hfs_file_mask;      /* mask to and with file protection bits */
 155         u_long        hfs_encoding;       /* Default encoding for non hfs+ volumes */
 156
 157         /* Persistent fields (on disk, dynamic) */
 158         time_t        hfs_mtime;          /* file system last modification time */
 159         u_int32_t     hfs_filecount;      /* number of files in file system */
 160         u_int32_t     hfs_dircount;       /* number of directories in file system */
 161         u_int32_t     freeBlocks;         /* free allocation blocks */
 162         u_int32_t     nextAllocation;     /* start of next allocation search */
 163         u_int32_t     vcbNxtCNID;         /* next unused catalog node ID - protected by catalog lock */
 164         u_int32_t     vcbWrCnt;           /* file system write count */
 165         u_int64_t     encodingsBitmap;    /* in-use encodings */
 166         u_int16_t     vcbNmFls;           /* HFS Only - root dir file count */
 167         u_int16_t     vcbNmRtDirs;        /* HFS Only - root dir directory count */
 168
 169         /* Persistent fields (on disk, static) */
 170         u_int16_t                       vcbSigWord;
 171         int16_t                         vcbFlags; /* Runtime flag to indicate if volume is dirty/clean */
 172         u_int32_t                       vcbAtrb;
 173         u_int32_t                       vcbJinfoBlock;
 174         time_t        hfs_itime;   /* file system creation time */
 175         time_t        hfs_btime;   /* file system last backup time */
 176         u_int32_t                       blockSize;      /* size of allocation blocks */
 177         u_int32_t                       totalBlocks;    /* total allocation blocks */
 178         u_int32_t                       allocLimit;     /* Do not allocate this block or beyond */
 179         /*
 180          * NOTE: When resizing a volume to make it smaller, allocLimit is set to the allocation
 181          * block number which will contain the new alternate volume header.  At all other times,
 182          * allocLimit is set to totalBlocks.  The allocation code uses allocLimit instead of
 183          * totalBlocks to limit which blocks may be allocated, so that during a resize, we don't
 184          * put new content into the blocks we're trying to truncate away.
 185          */
 186         int32_t                         vcbClpSiz;
 187         u_int32_t     vcbFndrInfo[8];
 188         int16_t                         vcbVBMSt;               /* HFS only */
 189         int16_t                         vcbAlBlSt;              /* HFS only */
 190
 191         /* vcb stuff */
 192         u_int8_t                        vcbVN[256];             /* volume name in UTF-8 */
 193         u_int32_t                       volumeNameEncodingHint;
 194         u_int32_t                       hfsPlusIOPosOffset;     /* Disk block where HFS+ starts */
 195         u_int32_t                       vcbVBMIOSize;           /* volume bitmap I/O size */
 196
 197         /* cache of largest known free extents */
 198         u_int32_t                       vcbFreeExtCnt;
 199         HFSPlusExtentDescriptor vcbFreeExt[kMaxFreeExtents];
 200
 201         u_int32_t               reserveBlocks;          /* free block reserve */
 202         u_int32_t               loanedBlocks;           /* blocks on loan for delayed allocations */
 203
 204         u_int32_t                       localCreateDate;        /* creation times for HFS+ volumes are in local time */
 205
 206         /*
 207          * HFS+ Private system directories (two). Any access
 208          * (besides looking at the cd_cnid) requires holding
 209          * the Catalog File lock.
 210          */
 211         struct cat_desc     hfs_private_desc[2];
 212         struct cat_attr     hfs_private_attr[2];
 213
 214         u_int32_t               hfs_metadata_createdate;
 215         hfs_to_unicode_func_t   hfs_get_unicode;
 216         unicode_to_hfs_func_t   hfs_get_hfsname;
 217
 218         /* Quota variables: */
 219         struct quotafile        hfs_qfiles[MAXQUOTAS];    /* quota files */
 220
 221         /* Journaling variables: */
 222         void                *jnl;           // the journal for this volume (if one exists)
 223         struct vnode        *jvp;           // device where the journal lives (may be equal to devvp)
 224         u_int32_t            jnl_start;     // start block of the journal file (so we don't delete it)
 225         u_int32_t            jnl_size;
 226         u_int32_t            hfs_jnlfileid;
 227         u_int32_t            hfs_jnlinfoblkid;
 228         lck_rw_t             hfs_global_lock;
 229         u_int32_t            hfs_global_lock_nesting;
 230
 231         /* Notification variables: */
 232         unsigned long           hfs_notification_conditions;
 233         u_int32_t               hfs_freespace_notify_warninglimit;
 234         u_int32_t               hfs_freespace_notify_desiredlevel;
 235
 236         /* time mounted and last mounted mod time "snapshot" */
 237         time_t          hfs_mount_time;
 238         time_t          hfs_last_mounted_mtime;
 239
 240         /* Metadata allocation zone variables: */
 241         u_int32_t       hfs_metazone_start;
 242         u_int32_t       hfs_metazone_end;
 243         u_int32_t       hfs_hotfile_start;
 244         u_int32_t       hfs_hotfile_end;
 245         int             hfs_hotfile_freeblks;
 246         int             hfs_hotfile_maxblks;
 247         int             hfs_overflow_maxblks;
 248         int             hfs_catalog_maxblks;
 249
 250         /* Hot File Clustering variables: */
 251         lck_mtx_t       hfc_mutex;      /* serialize hot file stages */
 252         enum hfc_stage  hfc_stage;      /* what are we up to... */
 253         time_t          hfc_timebase;   /* recording period start time */
 254         time_t          hfc_timeout;    /* recording period stop time */
 255         void *          hfc_recdata;    /* recording data (opaque) */
 256         int             hfc_maxfiles;   /* maximum files to track */
 257         struct vnode *  hfc_filevp;
 258
 259 #ifdef HFS_SPARSE_DEV
 260         /* Sparse device variables: */
 261         struct vnode * hfs_backingfs_rootvp;
 262         u_int32_t      hfs_last_backingstatfs;
 263         int            hfs_sparsebandblks;
 264 #endif
 265         size_t         hfs_max_inline_attrsize;
 266
 267         lck_mtx_t      hfs_mutex;      /* protects access to hfsmount data */
 268         void          *hfs_freezing_proc;  /* who froze the fs */
 269         lck_rw_t       hfs_insync;     /* protects sync/freeze interaction */
 270
 271         /* Resize variables: */
 272         u_int32_t               hfs_resize_filesmoved;
 273         u_int32_t               hfs_resize_totalfiles;
 274 } hfsmount_t;
 275
 276 typedef hfsmount_t  ExtendedVCB;
 277
 278 /* Aliases for legacy (Mac OS 9) field names */
 279 #define vcbCrDate          hfs_itime
 280 #define vcbLsMod           hfs_mtime
 281 #define vcbVolBkUp         hfs_btime
 282 #define extentsRefNum      hfs_extents_vp
 283 #define catalogRefNum      hfs_catalog_vp
 284 #define allocationsRefNum  hfs_allocation_vp
 285 #define vcbFilCnt          hfs_filecount
 286 #define vcbDirCnt          hfs_dircount
 287
 288 /* Inline functions to set/reset vcbFlags.  Upper 8 bits indicate if the volume
 289  * header/VCB is clean/dirty --- if set, volume header is dirty, and
 290  * if clear, volume header is clean.  This value is checked to determine
 291  * if the in-memory copy of volume header should be flushed to the disk
 292  * or not.
 293  */
 294 /* Set runtime flag to indicate that volume is dirty */
 295 static __inline__ void MarkVCBDirty(ExtendedVCB *vcb)
 296 {
 297         vcb->vcbFlags |= 0xFF00;
 298 }
 299
 300 /* Clear runtime flag to indicate that volume is dirty */
 301 static __inline__ void MarkVCBClean(ExtendedVCB *vcb)
 302 {
 303         vcb->vcbFlags &= 0x00FF;
 304 }
 305
 306 /* Check runtime flag to determine if the volume is dirty or not */
 307 static __inline__ Boolean IsVCBDirty(ExtendedVCB *vcb)
 308 {
 309         return (vcb->vcbFlags & 0xFF00 ? true  : false);
 310 }
 311
 312 /*
 313  * There are two private directories in HFS+.
 314  *
 315  * One contains inodes for files that are hardlinked or open/unlinked.
 316  * The other contains inodes for directories that are hardlinked.
 317  */
 318 enum privdirtype {FILE_HARDLINKS, DIR_HARDLINKS};
 319
 320
 321 /* HFS mount point flags */
 322 #define HFS_READ_ONLY             0x00001
 323 #define HFS_UNKNOWN_PERMS         0x00002
 324 #define HFS_WRITEABLE_MEDIA       0x00004
 325 #define HFS_CLEANED_ORPHANS       0x00008
 326 #define HFS_X                     0x00010
 327 #define HFS_CASE_SENSITIVE        0x00020
 328 #define HFS_STANDARD              0x00040
 329 #define HFS_METADATA_ZONE         0x00080
 330 #define HFS_FRAGMENTED_FREESPACE  0x00100
 331 #define HFS_NEED_JNL_RESET        0x00200
 332 #define HFS_HAS_SPARSE_DEVICE     0x00400
 333 #define HFS_RESIZE_IN_PROGRESS    0x00800
 334 #define HFS_QUOTAS                0x01000
 335 #define HFS_CREATING_BTREE        0x02000
 336 /* When set, do not update nextAllocation in the mount structure */
 337 #define HFS_SKIP_UPDATE_NEXT_ALLOCATION 0x04000
 338 #define HFS_XATTR_EXTENTS         0x08000
 339 #define HFS_FOLDERCOUNT           0x10000
 340 /* When set, the file system exists on a virtual device, like disk image */
 341 #define HFS_VIRTUAL_DEVICE        0x20000
 342 /* When set, we're in hfs_changefs, so hfs_sync should do nothing. */
 343 #define HFS_IN_CHANGEFS           0x40000
 344
 345
 346 /* Macro to update next allocation block in the HFS mount structure.  If
 347  * the HFS_SKIP_UPDATE_NEXT_ALLOCATION is set, do not update
 348  * nextAllocation block.
 349  */
 350 #define HFS_UPDATE_NEXT_ALLOCATION(hfsmp, new_nextAllocation)                   \
 351         {                                                               \
 352                 if ((hfsmp->hfs_flags & HFS_SKIP_UPDATE_NEXT_ALLOCATION) == 0)\
 353                         hfsmp->nextAllocation = new_nextAllocation;     \
 354         }                                                               \
 355
 356 #define HFS_MOUNT_LOCK(hfsmp, metadata)                      \
 357         {                                                    \
 358                 if ((metadata) && 1)                         \
 359                         lck_mtx_lock(&(hfsmp)->hfs_mutex);   \
 360         }                                                    \
 361
 362 #define HFS_MOUNT_UNLOCK(hfsmp, metadata)                    \
 363         {                                                    \
 364                 if ((metadata) && 1)                         \
 365                         lck_mtx_unlock(&(hfsmp)->hfs_mutex); \
 366         }                                                    \
 367
 368 #define hfs_global_exclusive_lock_acquire(hfsmp) lck_rw_lock_exclusive(&(hfsmp)->hfs_global_lock)
 369 #define hfs_global_exclusive_lock_release(hfsmp) lck_rw_unlock_exclusive(&(hfsmp)->hfs_global_lock)
 370
 371 /* Macro for incrementing and decrementing the folder count in a cnode
 372  * attribute only if the HFS_FOLDERCOUNT bit is set in the mount flags
 373  * and kHFSHasFolderCount bit is set in the cnode flags.  Currently these
 374  * bits are only set for case sensitive HFS+ volumes.
 375  */
 376 #define INC_FOLDERCOUNT(hfsmp, cattr)                           \
 377         if ((hfsmp->hfs_flags & HFS_FOLDERCOUNT) &&             \
 378             (cattr.ca_recflags & kHFSHasFolderCountMask)) {     \
 379                 cattr.ca_dircount++;                            \
 380         }                                                       \
 381
 382 #define DEC_FOLDERCOUNT(hfsmp, cattr)                           \
 383         if ((hfsmp->hfs_flags & HFS_FOLDERCOUNT) &&             \
 384             (cattr.ca_recflags & kHFSHasFolderCountMask) &&     \
 385             (cattr.ca_dircount > 0)) {                          \
 386                 cattr.ca_dircount--;                            \
 387         }                                                       \
 388
 389 typedef struct filefork FCB;
 390
 391 /*
 392  * Macros for creating item names for our special/private directories.
 393  */
 394 #define MAKE_INODE_NAME(name, size, linkno) \
 395             (void) snprintf((name), size, "%s%d", HFS_INODE_PREFIX, (linkno))
 396 #define HFS_INODE_PREFIX_LEN    5
 397
 398 #define MAKE_DIRINODE_NAME(name, size, linkno) \
 399             (void) snprintf((name), size, "%s%d", HFS_DIRINODE_PREFIX, (linkno))
 400 #define HFS_DIRINODE_PREFIX_LEN   4
 401
 402 #define MAKE_DELETED_NAME(NAME, size, FID) \
 403             (void) snprintf((NAME), size, "%s%d", HFS_DELETE_PREFIX, (FID))
 404 #define HFS_DELETE_PREFIX_LEN   4
 405
 406
 407 #define HFS_AVERAGE_NAME_SIZE   22
 408 #define AVERAGE_HFSDIRENTRY_SIZE  (8+HFS_AVERAGE_NAME_SIZE+4)
 409
 410 #define STD_DIRENT_LEN(namlen) \
 411         ((sizeof(struct dirent) - (NAME_MAX+1)) + (((namlen)+1 + 3) &~ 3))
 412
 413 #define EXT_DIRENT_LEN(namlen) \
 414         ((sizeof(struct direntry) + (namlen) - (MAXPATHLEN-1) + 3) & ~3)
 415
 416
 417 enum { kHFSPlusMaxFileNameBytes = kHFSPlusMaxFileNameChars * 3 };
 418
 419
 420 /* macro to determine if hfs or hfsplus */
 421 #define ISHFSPLUS(VCB) ((VCB)->vcbSigWord == kHFSPlusSigWord)
 422 #define ISHFS(VCB) ((VCB)->vcbSigWord == kHFSSigWord)
 423
 424
 425 /*
 426  * Various ways to acquire a VFS mount point pointer:
 427  */
 428 #define VTOVFS(VP)  vnode_mount((VP))
 429 #define HFSTOVFS(HFSMP) ((HFSMP)->hfs_mp)
 430 #define VCBTOVFS(VCB)   HFSTOVFS(VCB)
 431
 432 /*
 433  * Various ways to acquire an HFS mount point pointer:
 434  */
 435 #define VTOHFS(VP)  ((struct hfsmount *)vfs_fsprivate(vnode_mount((VP))))
 436 #define VFSTOHFS(MP)  ((struct hfsmount *)vfs_fsprivate((MP)))
 437 #define VCBTOHFS(VCB) (VCB)
 438 #define FCBTOHFS(FCB)  ((struct hfsmount *)vfs_fsprivate(vnode_mount((FCB)->ff_cp->c_vp)))
 439
 440 /*
 441  * Various ways to acquire a VCB (legacy) pointer:
 442  */
 443 #define VTOVCB(VP)       VTOHFS(VP)
 444 #define VFSTOVCB(MP)     VFSTOHFS(MP)
 445 #define HFSTOVCB(HFSMP)  (HFSMP)
 446 #define FCBTOVCB(FCB)    FCBTOHFS(FCB)
 447
 448
 449 #define HFS_KNOTE(vp, hint) KNOTE(&VTOC(vp)->c_knotes, (hint))
 450
 451
 452 #define E_NONE  0
 453 #define kHFSBlockSize 512
 454
 455 /*
 456  * Macros for getting the MDB/VH sector and offset
 457  */
 458 #define HFS_PRI_SECTOR(blksize)          (1024 / (blksize))
 459 #define HFS_PRI_OFFSET(blksize)          ((blksize) > 1024 ? 1024 : 0)
 460
 461 #define HFS_ALT_SECTOR(blksize, blkcnt)  (((blkcnt) - 1) - (512 / (blksize)))
 462 #define HFS_ALT_OFFSET(blksize)          ((blksize) > 1024 ? (blksize) - 1024 : 0)
 463
 464 /* Convert the logical sector number to be aligned on physical block size boundary.
 465  * We are assuming the partition is a multiple of physical block size.
 466  */
 467 #define HFS_PHYSBLK_ROUNDDOWN(sector_num, log_per_phys) ((sector_num / log_per_phys) * log_per_phys)
 468
 469 /*
 470  * HFS specific fcntl()'s
 471  */
 472 #define HFS_BULKACCESS      (FCNTL_FS_SPECIFIC_BASE + 0x00001)
 473 #define HFS_GET_MOUNT_TIME  (FCNTL_FS_SPECIFIC_BASE + 0x00002)
 474 #define HFS_GET_LAST_MTIME  (FCNTL_FS_SPECIFIC_BASE + 0x00003)
 475 #define HFS_GET_BOOT_INFO   (FCNTL_FS_SPECIFIC_BASE + 0x00004)
 476 #define HFS_SET_BOOT_INFO   (FCNTL_FS_SPECIFIC_BASE + 0x00005)
 477 #define HFS_EXT_BULKACCESS  (FCNTL_FS_SPECIFIC_BASE + 0x00006)
 478
 479
 480 /*
 481  *      This is the straight GMT conversion constant:
 482  *      00:00:00 January 1, 1970 - 00:00:00 January 1, 1904
 483  *      (3600 * 24 * ((365 * (1970 - 1904)) + (((1970 - 1904) / 4) + 1)))
 484  */
 485 #define MAC_GMT_FACTOR          2082844800UL
 486
 487
 488 /*****************************************************************************
 489         FUNCTION PROTOTYPES
 490 ******************************************************************************/
 491
 492
 493 /*****************************************************************************
 494         hfs_vnop_xxx functions from different files
 495 ******************************************************************************/
 496 int hfs_vnop_readdirattr(struct vnop_readdirattr_args *);  /* in hfs_attrlist.c */
 497
 498 int hfs_vnop_inactive(struct vnop_inactive_args *);        /* in hfs_cnode.c */
 499 int hfs_vnop_reclaim(struct vnop_reclaim_args *);          /* in hfs_cnode.c */
 500
 501 int hfs_vnop_link(struct vnop_link_args *);                /* in hfs_link.c */
 502
 503 int hfs_vnop_lookup(struct vnop_lookup_args *);            /* in hfs_lookup.c */
 504
 505 int hfs_vnop_search(struct vnop_searchfs_args *);          /* in hfs_search.c */
 506
 507 int hfs_vnop_read(struct vnop_read_args *);           /* in hfs_readwrite.c */
 508 int hfs_vnop_write(struct vnop_write_args *);         /* in hfs_readwrite.c */
 509 int hfs_vnop_ioctl(struct vnop_ioctl_args *);         /* in hfs_readwrite.c */
 510 int hfs_vnop_select(struct vnop_select_args *);       /* in hfs_readwrite.c */
 511 int hfs_vnop_strategy(struct vnop_strategy_args *);   /* in hfs_readwrite.c */
 512 int hfs_vnop_allocate(struct vnop_allocate_args *);   /* in hfs_readwrite.c */
 513 int hfs_vnop_pagein(struct vnop_pagein_args *);       /* in hfs_readwrite.c */
 514 int hfs_vnop_pageout(struct vnop_pageout_args *);     /* in hfs_readwrite.c */
 515 int hfs_vnop_bwrite(struct vnop_bwrite_args *);       /* in hfs_readwrite.c */
 516 int hfs_vnop_blktooff(struct vnop_blktooff_args *);   /* in hfs_readwrite.c */
 517 int hfs_vnop_offtoblk(struct vnop_offtoblk_args *);   /* in hfs_readwrite.c */
 518 int hfs_vnop_blockmap(struct vnop_blockmap_args *);   /* in hfs_readwrite.c */
 519
 520 int hfs_vnop_getxattr(struct vnop_getxattr_args *);        /* in hfs_xattr.c */
 521 int hfs_vnop_setxattr(struct vnop_setxattr_args *);        /* in hfs_xattr.c */
 522 int hfs_vnop_removexattr(struct vnop_removexattr_args *);  /* in hfs_xattr.c */
 523 int hfs_vnop_listxattr(struct vnop_listxattr_args *);      /* in hfs_xattr.c */
 524 #if NAMEDSTREAMS
 525 extern int hfs_vnop_getnamedstream(struct vnop_getnamedstream_args*);
 526 extern int hfs_vnop_makenamedstream(struct vnop_makenamedstream_args*);
 527 extern int hfs_vnop_removenamedstream(struct vnop_removenamedstream_args*);
 528 #endif
 529
 530
 531 /*****************************************************************************
 532         Functions from MacOSStubs.c
 533 ******************************************************************************/
 534 time_t to_bsd_time(u_int32_t hfs_time);
 535
 536 u_int32_t to_hfs_time(time_t bsd_time);
 537
 538
 539 /*****************************************************************************
 540         Functions from hfs_encodinghint.c
 541 ******************************************************************************/
 542 u_int32_t hfs_pickencoding(const u_int16_t *src, int len);
 543
 544 u_int32_t hfs_getencodingbias(void);
 545
 546 void hfs_setencodingbias(u_int32_t bias);
 547
 548
 549 /*****************************************************************************
 550         Functions from hfs_encodings.c
 551 ******************************************************************************/
 552 void hfs_converterinit(void);
 553
 554 int hfs_getconverter(u_int32_t encoding, hfs_to_unicode_func_t *get_unicode,
 555                      unicode_to_hfs_func_t *get_hfsname);
 556
 557 int hfs_relconverter(u_int32_t encoding);
 558
 559 int hfs_to_utf8(ExtendedVCB *vcb, const Str31 hfs_str, ByteCount maxDstLen,
 560                 ByteCount *actualDstLen, unsigned char* dstStr);
 561
 562 int utf8_to_hfs(ExtendedVCB *vcb, ByteCount srcLen, const unsigned char* srcStr,
 563                 Str31 dstStr);
 564
 565 int mac_roman_to_utf8(const Str31 hfs_str, ByteCount maxDstLen, ByteCount *actualDstLen,
 566                 unsigned char* dstStr);
 567
 568 int utf8_to_mac_roman(ByteCount srcLen, const unsigned char* srcStr, Str31 dstStr);
 569
 570 int mac_roman_to_unicode(const Str31 hfs_str, UniChar *uni_str, u_int32_t maxCharLen, u_int32_t *usedCharLen);
 571
 572 int unicode_to_hfs(ExtendedVCB *vcb, ByteCount srcLen, u_int16_t* srcStr, Str31 dstStr, int retry);
 573
 574
 575 /*****************************************************************************
 576         Functions from hfs_notifications.c
 577 ******************************************************************************/
 578 void hfs_generate_volume_notifications(struct hfsmount *hfsmp);
 579
 580
 581 /*****************************************************************************
 582         Functions from hfs_readwrite.c
 583 ******************************************************************************/
 584 extern int  hfs_relocate(struct  vnode *, u_int32_t, kauth_cred_t, struct  proc *);
 585
 586 extern int hfs_truncate(struct vnode *, off_t, int, int, vfs_context_t);
 587
 588 extern int hfs_bmap(struct vnode *, daddr_t, struct vnode **, daddr64_t *, unsigned int *);
 589
 590 extern int hfs_fsync(struct vnode *, int, int, struct proc *);
 591
 592 extern int hfs_access(struct vnode *, mode_t, kauth_cred_t, struct proc *);
 593
 594 extern int hfs_removeallattr(struct hfsmount *hfsmp, u_int32_t fileid);
 595
 596 extern int hfs_set_volxattr(struct hfsmount *hfsmp, unsigned int xattrtype, int state);
 597
 598 extern void hfs_check_volxattr(struct hfsmount *hfsmp, unsigned int xattrtype);
 599
 600 extern int  hfs_isallocated(struct hfsmount *, u_long, u_long);
 601
 602
 603 /*****************************************************************************
 604         Functions from hfs_vfsops.c
 605 ******************************************************************************/
 606 int hfs_mountroot(mount_t mp, vnode_t rvp, vfs_context_t context);
 607
 608 /* used as a callback by the journaling code */
 609 extern void hfs_sync_metadata(void *arg);
 610
 611 extern int hfs_vget(struct hfsmount *, cnid_t, struct vnode **, int);
 612
 613 extern void hfs_setencodingbits(struct hfsmount *hfsmp, u_int32_t encoding);
 614
 615 enum volop {VOL_UPDATE, VOL_MKDIR, VOL_RMDIR, VOL_MKFILE, VOL_RMFILE};
 616 extern int hfs_volupdate(struct hfsmount *hfsmp, enum volop op, int inroot);
 617
 618 int hfs_flushvolumeheader(struct hfsmount *hfsmp, int waitfor, int altflush);
 619 #define HFS_ALTFLUSH    1
 620
 621 extern int  hfs_extendfs(struct hfsmount *, u_int64_t, vfs_context_t);
 622 extern int  hfs_truncatefs(struct hfsmount *, u_int64_t, vfs_context_t);
 623 extern int  hfs_resize_progress(struct hfsmount *, u_int32_t *);
 624
 625 /* If a runtime corruption is detected, mark the volume inconsistent
 626  * bit in the volume attributes.
 627  */
 628 void hfs_mark_volume_inconsistent(struct hfsmount *hfsmp);
 629
 630 /*****************************************************************************
 631         Functions from hfs_vfsutils.c
 632 ******************************************************************************/
 633 unsigned long BestBlockSizeFit(unsigned long allocationBlockSize,
 634                                unsigned long blockSizeLimit,
 635                                unsigned long baseMultiple);
 636
 637 OSErr   hfs_MountHFSVolume(struct hfsmount *hfsmp, HFSMasterDirectoryBlock *mdb,
 638                 struct proc *p);
 639 OSErr   hfs_MountHFSPlusVolume(struct hfsmount *hfsmp, HFSPlusVolumeHeader *vhp,
 640                 off_t embeddedOffset, u_int64_t disksize, struct proc *p, void *args, kauth_cred_t cred);
 641
 642 extern int hfsUnmount(struct hfsmount *hfsmp, struct proc *p);
 643
 644 extern int overflow_extents(struct filefork *fp);
 645
 646 extern int hfs_owner_rights(struct hfsmount *hfsmp, uid_t cnode_uid, kauth_cred_t cred,
 647                 struct proc *p, int invokesuperuserstatus);
 648
 649
 650 /* HFS System file locking */
 651 #define SFL_CATALOG     0x0001
 652 #define SFL_EXTENTS     0x0002
 653 #define SFL_BITMAP      0x0004
 654 #define SFL_ATTRIBUTE   0x0008
 655 #define SFL_STARTUP     0x0010
 656 #define SFL_VALIDMASK   (SFL_CATALOG | SFL_EXTENTS | SFL_BITMAP | SFL_ATTRIBUTE | SFL_STARTUP)
 657
 658 extern int  hfs_systemfile_lock(struct hfsmount *, int, enum hfslocktype);
 659 extern void hfs_systemfile_unlock(struct hfsmount *, int);
 660
 661 extern u_long  GetFileInfo(ExtendedVCB *vcb, u_int32_t dirid, const char *name,
 662                                                    struct cat_attr *fattr, struct cat_fork *forkinfo);
 663
 664 extern void hfs_remove_orphans(struct hfsmount *);
 665
 666 u_int32_t GetLogicalBlockSize(struct vnode *vp);
 667
 668 extern u_int32_t hfs_freeblks(struct hfsmount * hfsmp, int wantreserve);
 669
 670 short MacToVFSError(OSErr err);
 671
 672 /* HFS directory hint functions. */
 673 extern directoryhint_t * hfs_getdirhint(struct cnode *, int, int);
 674 extern void  hfs_reldirhint(struct cnode *, directoryhint_t *);
 675 extern void  hfs_reldirhints(struct cnode *, int);
 676 extern void  hfs_insertdirhint(struct cnode *, directoryhint_t *);
 677
 678 extern int hfs_namecmp(const u_int8_t *str1, size_t len1, const u_int8_t *str2, size_t len2);
 679
 680 extern int     hfs_early_journal_init(struct hfsmount *hfsmp, HFSPlusVolumeHeader *vhp,
 681                            void *_args, off_t embeddedOffset, daddr64_t mdb_offset,
 682                            HFSMasterDirectoryBlock *mdbp, kauth_cred_t cred);
 683
 684 extern int  hfs_virtualmetafile(struct cnode *);
 685
 686 extern int hfs_start_transaction(struct hfsmount *hfsmp);
 687 extern int hfs_end_transaction(struct hfsmount *hfsmp);
 688
 689
 690 /*****************************************************************************
 691         Functions from hfs_vnops.c
 692 ******************************************************************************/
 693 int hfs_write_access(struct vnode *vp, kauth_cred_t cred, struct proc *p, Boolean considerFlags);
 694
 695 int hfs_chmod(struct vnode *vp, int mode, kauth_cred_t cred, struct proc *p);
 696
 697 int hfs_chown(struct vnode *vp, uid_t uid, gid_t gid, kauth_cred_t cred, struct proc *p);
 698
 699 #define  kMaxSecsForFsync       5
 700 #define  HFS_SYNCTRANS          1
 701 extern int hfs_btsync(struct vnode *vp, int sync_transaction);
 702
 703 extern void replace_desc(struct cnode *cp, struct cat_desc *cdp);
 704
 705 extern int hfs_vgetrsrc(struct hfsmount *hfsmp, struct vnode *vp,
 706                         struct vnode **rvpp, int can_drop_lock);
 707
 708 extern int hfs_update(struct vnode *, int);
 709
 710
 711 /*****************************************************************************
 712         Functions from hfs_xattr.c
 713 ******************************************************************************/
 714 int  hfs_attrkeycompare(HFSPlusAttrKey *searchKey, HFSPlusAttrKey *trialKey);
 715 int  hfs_buildattrkey(u_int32_t fileID, const char *attrname, HFSPlusAttrKey *key);
 716 void hfs_xattr_init(struct hfsmount * hfsmp);
 717 int file_attribute_exist(struct hfsmount *hfsmp, uint32_t fileID);
 718
 719
 720
 721 /*****************************************************************************
 722         Functions from hfs_link.c
 723 ******************************************************************************/
 724
 725 extern int  hfs_unlink(struct hfsmount *hfsmp, struct vnode *dvp, struct vnode *vp,
 726                        struct componentname *cnp, int skip_reserve);
 727 extern int  hfs_lookuplink(struct hfsmount *hfsmp, cnid_t linkfileid,
 728                            cnid_t *prevlinkid,  cnid_t *nextlinkid);
 729 extern void  hfs_privatedir_init(struct hfsmount *, enum privdirtype);
 730
 731 extern void  hfs_savelinkorigin(cnode_t *cp, cnid_t parentcnid);
 732 extern void  hfs_relorigins(struct cnode *cp);
 733 extern void  hfs_relorigin(struct cnode *cp, cnid_t parentcnid);
 734 extern int   hfs_haslinkorigin(cnode_t *cp);
 735 extern cnid_t  hfs_currentparent(cnode_t *cp);
 736 extern cnid_t  hfs_currentcnid(cnode_t *cp);
 737
 738
 739 #endif /* __APPLE_API_PRIVATE */
 740 #endif /* KERNEL */
 741 #endif /* __HFS__ */