]> git.saurik.com Git - apple/hfs.git/blob - core/hfs.h
projects / apple / hfs.git / blob
? search:


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