2 * Copyright (c) 2003-2008 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
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.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
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.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/fcntl.h>
32 #include <sys/kernel.h>
33 #include <sys/malloc.h>
35 #include <sys/ubc_internal.h>
36 #include <sys/vnode.h>
37 #include <sys/vnode_internal.h>
38 #include <sys/kauth.h>
41 #include <hfs/hfs_endian.h>
42 #include <hfs/hfs_format.h>
43 #include <hfs/hfs_mount.h>
44 #include <hfs/hfs_hotfiles.h>
46 #include "hfscommon/headers/BTreeScanner.h"
54 * Minimum post Tiger base time.
55 * Thu Mar 31 17:00:00 2005
57 #define HFC_MIN_BASE_TIME 0x424c8f00L
60 * Hot File List (runtime).
62 typedef struct hotfileinfo
{
64 u_int32_t hf_temperature
;
68 typedef struct hotfilelist
{
70 u_int32_t hfl_version
;
71 time_t hfl_duration
; /* duration of sample period */
72 int hfl_count
; /* count of hot files recorded */
73 int hfl_next
; /* next file to move */
74 int hfl_totalblocks
; /* total hot file blocks */
75 int hfl_reclaimblks
; /* blocks to reclaim in HFV */
76 u_int32_t hfl_spare
[2];
77 hotfileinfo_t hfl_hotfile
[1]; /* array of hot files */
82 * Hot File Entry (runtime).
84 typedef struct hotfile_entry
{
85 struct hotfile_entry
*left
;
86 struct hotfile_entry
*right
;
88 u_int32_t temperature
;
93 * Hot File Recording Data (runtime).
95 typedef struct hotfile_data
{
96 struct hfsmount
*hfsmp
;
98 int activefiles
; /* active number of hot files */
101 hotfile_entry_t
*rootentry
;
102 hotfile_entry_t
*freelist
;
103 hotfile_entry_t
*coldest
;
104 hotfile_entry_t entries
[1];
107 static int hfs_recording_start (struct hfsmount
*);
108 static int hfs_recording_stop (struct hfsmount
*);
112 * Hot File Data recording functions (in-memory binary tree).
114 static void hf_insert (hotfile_data_t
*, hotfile_entry_t
*);
115 static void hf_delete (hotfile_data_t
*, u_int32_t
, u_int32_t
);
116 static hotfile_entry_t
* hf_coldest (hotfile_data_t
*);
117 static hotfile_entry_t
* hf_getnewentry (hotfile_data_t
*);
118 static void hf_getsortedlist (hotfile_data_t
*, hotfilelist_t
*);
121 static hotfile_entry_t
* hf_lookup (hotfile_data_t
*, u_int32_t
, u_int32_t
);
122 static void hf_maxdepth(hotfile_entry_t
*, int, int *);
123 static void hf_printtree (hotfile_entry_t
*);
127 * Hot File misc support functions.
129 static int hotfiles_collect (struct hfsmount
*);
130 static int hotfiles_age (struct hfsmount
*);
131 static int hotfiles_adopt (struct hfsmount
*);
132 static int hotfiles_evict (struct hfsmount
*, vfs_context_t
);
133 static int hotfiles_refine (struct hfsmount
*);
134 static int hotextents(struct hfsmount
*, HFSPlusExtentDescriptor
*);
135 static int hfs_addhotfile_internal(struct vnode
*);
139 * Hot File Cluster B-tree (on disk) functions.
141 static int hfc_btree_create (struct hfsmount
*, unsigned int, unsigned int);
142 static int hfc_btree_open (struct hfsmount
*, struct vnode
**);
143 static int hfc_btree_close (struct hfsmount
*, struct vnode
*);
144 static int hfc_comparekeys (HotFileKey
*, HotFileKey
*);
147 char hfc_tag
[] = "CLUSTERED HOT FILES B-TREE ";
151 *========================================================================
152 * HOT FILE INTERFACE ROUTINES
153 *========================================================================
157 * Start recording the hotest files on a file system.
159 * Requires that the hfc_mutex be held.
162 hfs_recording_start(struct hfsmount
*hfsmp
)
164 hotfile_data_t
*hotdata
;
171 if ((hfsmp
->hfs_flags
& HFS_READ_ONLY
) ||
172 (hfsmp
->jnl
== NULL
) ||
173 (hfsmp
->hfs_flags
& HFS_METADATA_ZONE
) == 0) {
176 if (HFSTOVCB(hfsmp
)->freeBlocks
< (2 * (u_int32_t
)hfsmp
->hfs_hotfile_maxblks
)) {
179 if (hfsmp
->hfc_stage
!= HFC_IDLE
) {
182 hfsmp
->hfc_stage
= HFC_BUSY
;
185 * Dump previous recording data.
187 if (hfsmp
->hfc_recdata
) {
190 tmp
= hfsmp
->hfc_recdata
;
191 hfsmp
->hfc_recdata
= NULL
;
195 microtime(&tv
); /* Times are base on GMT time. */
198 * On first startup check for suspended recording.
200 if (hfsmp
->hfc_timebase
== 0 &&
201 hfc_btree_open(hfsmp
, &hfsmp
->hfc_filevp
) == 0) {
202 HotFilesInfo hotfileinfo
;
204 if ((BTGetUserData(VTOF(hfsmp
->hfc_filevp
), &hotfileinfo
,
205 sizeof(hotfileinfo
)) == 0) &&
206 (SWAP_BE32 (hotfileinfo
.magic
) == HFC_MAGIC
) &&
207 (SWAP_BE32 (hotfileinfo
.timeleft
) > 0) &&
208 (SWAP_BE32 (hotfileinfo
.timebase
) > 0)) {
209 hfsmp
->hfc_maxfiles
= SWAP_BE32 (hotfileinfo
.maxfilecnt
);
210 hfsmp
->hfc_timeout
= SWAP_BE32 (hotfileinfo
.timeleft
) + tv
.tv_sec
;
211 hfsmp
->hfc_timebase
= SWAP_BE32 (hotfileinfo
.timebase
);
212 /* Fix up any bogus timebase values. */
213 if (hfsmp
->hfc_timebase
< HFC_MIN_BASE_TIME
) {
214 hfsmp
->hfc_timebase
= hfsmp
->hfc_timeout
- HFC_DEFAULT_DURATION
;
217 printf("hfs: Resume recording hot files on %s (%d secs left)\n",
218 hfsmp
->vcbVN
, SWAP_BE32 (hotfileinfo
.timeleft
));
221 hfsmp
->hfc_maxfiles
= HFC_DEFAULT_FILE_COUNT
;
222 hfsmp
->hfc_timebase
= tv
.tv_sec
+ 1;
223 hfsmp
->hfc_timeout
= hfsmp
->hfc_timebase
+ HFC_DEFAULT_DURATION
;
225 (void) hfc_btree_close(hfsmp
, hfsmp
->hfc_filevp
);
226 hfsmp
->hfc_filevp
= NULL
;
228 struct cat_attr cattr
;
232 * Make sure a btree file exists.
234 cnid
= GetFileInfo(HFSTOVCB(hfsmp
), kRootDirID
, HFC_FILENAME
, &cattr
, NULL
);
236 !S_ISREG(cattr
.ca_mode
) &&
237 (error
= hfc_btree_create(hfsmp
, HFSTOVCB(hfsmp
)->blockSize
, HFC_DEFAULT_FILE_COUNT
))) {
238 hfsmp
->hfc_stage
= HFC_IDLE
;
239 wakeup((caddr_t
)&hfsmp
->hfc_stage
);
243 printf("hfs: begin recording hot files on %s\n", hfsmp
->vcbVN
);
245 hfsmp
->hfc_maxfiles
= HFC_DEFAULT_FILE_COUNT
;
246 hfsmp
->hfc_timeout
= tv
.tv_sec
+ HFC_DEFAULT_DURATION
;
248 /* Reset time base. */
249 if (hfsmp
->hfc_timebase
== 0) {
250 hfsmp
->hfc_timebase
= tv
.tv_sec
+ 1;
252 time_t cumulativebase
;
254 cumulativebase
= hfsmp
->hfc_timeout
- (HFC_CUMULATIVE_CYCLES
* HFC_DEFAULT_DURATION
);
255 hfsmp
->hfc_timebase
= MAX(hfsmp
->hfc_timebase
, cumulativebase
);
259 if ((hfsmp
->hfc_maxfiles
== 0) ||
260 (hfsmp
->hfc_maxfiles
> HFC_MAXIMUM_FILE_COUNT
)) {
261 hfsmp
->hfc_maxfiles
= HFC_DEFAULT_FILE_COUNT
;
263 maxentries
= hfsmp
->hfc_maxfiles
;
265 size
= sizeof(hotfile_data_t
) + (maxentries
* sizeof(hotfile_entry_t
));
266 MALLOC(hotdata
, hotfile_data_t
*, size
, M_TEMP
, M_WAITOK
);
267 if (hotdata
== NULL
) {
268 hfsmp
->hfc_recdata
= NULL
;
269 hfsmp
->hfc_stage
= HFC_IDLE
;
270 wakeup((caddr_t
)&hfsmp
->hfc_stage
);
274 bzero(hotdata
, size
);
276 for (i
= 1; i
< maxentries
; i
++)
277 hotdata
->entries
[i
-1].right
= &hotdata
->entries
[i
];
279 hotdata
->freelist
= &hotdata
->entries
[0];
281 * Establish minimum temperature and maximum file size.
283 hotdata
->threshold
= HFC_MINIMUM_TEMPERATURE
;
284 hotdata
->maxblocks
= HFC_MAXIMUM_FILESIZE
/ HFSTOVCB(hfsmp
)->blockSize
;
285 hotdata
->hfsmp
= hfsmp
;
287 hfsmp
->hfc_recdata
= hotdata
;
288 hfsmp
->hfc_stage
= HFC_RECORDING
;
289 wakeup((caddr_t
)&hfsmp
->hfc_stage
);
294 * Stop recording the hotest files on a file system.
296 * Requires that the hfc_mutex be held.
299 hfs_recording_stop(struct hfsmount
*hfsmp
)
301 hotfile_data_t
*hotdata
;
302 hotfilelist_t
*listp
;
305 enum hfc_stage newstage
= HFC_IDLE
;
308 if (hfsmp
->hfc_stage
!= HFC_RECORDING
)
311 hfsmp
->hfc_stage
= HFC_BUSY
;
313 hotfiles_collect(hfsmp
);
317 * Convert hot file data into a simple file id list....
319 * then dump the sample data
322 printf("hfs: end of hot file recording on %s\n", hfsmp
->vcbVN
);
324 hotdata
= (hotfile_data_t
*)hfsmp
->hfc_recdata
;
327 hfsmp
->hfc_recdata
= NULL
;
328 hfsmp
->hfc_stage
= HFC_EVALUATION
;
329 wakeup((caddr_t
)&hfsmp
->hfc_stage
);
332 printf("hfs: curentries: %d\n", hotdata
->activefiles
);
335 * If no hot files recorded then we're done.
337 if (hotdata
->rootentry
== NULL
) {
342 /* Open the B-tree file for writing... */
343 if (hfsmp
->hfc_filevp
)
344 panic("hfs_recording_stop: hfc_filevp exists (vp = %p)", hfsmp
->hfc_filevp
);
346 error
= hfc_btree_open(hfsmp
, &hfsmp
->hfc_filevp
);
352 * Age the previous set of clustered hot files.
354 error
= hotfiles_age(hfsmp
);
356 (void) hfc_btree_close(hfsmp
, hfsmp
->hfc_filevp
);
357 hfsmp
->hfc_filevp
= NULL
;
362 * Create a sorted list of hotest files.
364 size
= sizeof(hotfilelist_t
);
365 size
+= sizeof(hotfileinfo_t
) * (hotdata
->activefiles
- 1);
366 MALLOC(listp
, hotfilelist_t
*, size
, M_TEMP
, M_WAITOK
);
369 (void) hfc_btree_close(hfsmp
, hfsmp
->hfc_filevp
);
370 hfsmp
->hfc_filevp
= NULL
;
376 hf_getsortedlist(hotdata
, listp
); /* NOTE: destroys hot file tree! */
378 listp
->hfl_duration
= tv
.tv_sec
- hfsmp
->hfc_timebase
;
379 hfsmp
->hfc_recdata
= listp
;
382 * Account for duplicates.
384 error
= hotfiles_refine(hfsmp
);
386 (void) hfc_btree_close(hfsmp
, hfsmp
->hfc_filevp
);
387 hfsmp
->hfc_filevp
= NULL
;
392 * Compute the amount of space to reclaim...
394 if (listp
->hfl_totalblocks
> hfsmp
->hfs_hotfile_freeblks
) {
395 listp
->hfl_reclaimblks
=
396 MIN(listp
->hfl_totalblocks
, hfsmp
->hfs_hotfile_maxblks
) -
397 hfsmp
->hfs_hotfile_freeblks
;
399 printf("hfs_recording_stop: need to reclaim %d blocks\n", listp
->hfl_reclaimblks
);
401 if (listp
->hfl_reclaimblks
)
402 newstage
= HFC_EVICTION
;
404 newstage
= HFC_ADOPTION
;
406 newstage
= HFC_ADOPTION
;
409 if (newstage
== HFC_ADOPTION
&& listp
->hfl_totalblocks
== 0) {
410 (void) hfc_btree_close(hfsmp
, hfsmp
->hfc_filevp
);
411 hfsmp
->hfc_filevp
= NULL
;
416 if (newstage
== HFC_EVICTION
)
417 printf("hfs: evicting coldest files\n");
418 else if (newstage
== HFC_ADOPTION
)
419 printf("hfs: adopting hotest files\n");
421 FREE(hotdata
, M_TEMP
);
423 hfsmp
->hfc_stage
= newstage
;
424 wakeup((caddr_t
)&hfsmp
->hfc_stage
);
429 * Suspend recording the hotest files on a file system.
433 hfs_recording_suspend(struct hfsmount
*hfsmp
)
435 HotFilesInfo hotfileinfo
;
436 hotfile_data_t
*hotdata
= NULL
;
440 if (hfsmp
->hfc_stage
== HFC_DISABLED
)
443 lck_mtx_lock(&hfsmp
->hfc_mutex
);
447 * A suspend can occur during eval/evict/adopt stage.
448 * In that case we would need to write out info and
449 * flush our HFBT vnode. Currently we just bail.
452 hotdata
= (hotfile_data_t
*)hfsmp
->hfc_recdata
;
453 if (hotdata
== NULL
|| hfsmp
->hfc_stage
!= HFC_RECORDING
) {
457 hfsmp
->hfc_stage
= HFC_BUSY
;
460 printf("hfs: suspend hot file recording on %s\n", hfsmp
->vcbVN
);
462 error
= hfc_btree_open(hfsmp
, &hfsmp
->hfc_filevp
);
464 printf("hfs_recording_suspend: err %d opening btree\n", error
);
468 if (hfs_start_transaction(hfsmp
) != 0) {
472 if (hfs_lock(VTOC(hfsmp
->hfc_filevp
), HFS_EXCLUSIVE_LOCK
) != 0) {
474 goto end_transaction
;
478 hotfileinfo
.magic
= SWAP_BE32 (HFC_MAGIC
);
479 hotfileinfo
.version
= SWAP_BE32 (HFC_VERSION
);
480 hotfileinfo
.duration
= SWAP_BE32 (HFC_DEFAULT_DURATION
);
481 hotfileinfo
.timebase
= SWAP_BE32 (hfsmp
->hfc_timebase
);
482 hotfileinfo
.timeleft
= SWAP_BE32 (hfsmp
->hfc_timeout
- tv
.tv_sec
);
483 hotfileinfo
.threshold
= SWAP_BE32 (hotdata
->threshold
);
484 hotfileinfo
.maxfileblks
= SWAP_BE32 (hotdata
->maxblocks
);
485 hotfileinfo
.maxfilecnt
= SWAP_BE32 (HFC_DEFAULT_FILE_COUNT
);
486 strlcpy((char *)hotfileinfo
.tag
, hfc_tag
, sizeof hotfileinfo
.tag
);
487 (void) BTSetUserData(VTOF(hfsmp
->hfc_filevp
), &hotfileinfo
, sizeof(hotfileinfo
));
489 hfs_unlock(VTOC(hfsmp
->hfc_filevp
));
492 hfs_end_transaction(hfsmp
);
495 if (hfsmp
->hfc_filevp
) {
496 (void) hfc_btree_close(hfsmp
, hfsmp
->hfc_filevp
);
497 hfsmp
->hfc_filevp
= NULL
;
500 FREE(hotdata
, M_TEMP
);
501 hfsmp
->hfc_recdata
= NULL
;
503 hfsmp
->hfc_stage
= HFC_DISABLED
;
504 wakeup((caddr_t
)&hfsmp
->hfc_stage
);
506 lck_mtx_unlock(&hfsmp
->hfc_mutex
);
516 hfs_recording_init(struct hfsmount
*hfsmp
)
519 CatalogRecord
* datap
;
521 HFSPlusCatalogFile
*filep
;
522 BTScanState scanstate
;
523 BTreeIterator
* iterator
= NULL
;
524 FSBufferDescriptor record
;
526 filefork_t
* filefork
;
528 struct cat_attr cattr
;
532 int inserted
= 0; /* debug variables */
536 * For now, only the boot volume is supported.
538 if ((vfs_flags(HFSTOVFS(hfsmp
)) & MNT_ROOTFS
) == 0) {
539 hfsmp
->hfc_stage
= HFC_DISABLED
;
544 * Tracking of hot files requires up-to-date access times.
545 * So if access time updates are disabled, then we disable
548 if (vfs_flags(HFSTOVFS(hfsmp
)) & MNT_NOATIME
) {
549 hfsmp
->hfc_stage
= HFC_DISABLED
;
554 * If the Hot File btree exists then metadata zone is ready.
556 cnid
= GetFileInfo(HFSTOVCB(hfsmp
), kRootDirID
, HFC_FILENAME
, &cattr
, NULL
);
557 if (cnid
!= 0 && S_ISREG(cattr
.ca_mode
)) {
558 if (hfsmp
->hfc_stage
== HFC_DISABLED
)
559 hfsmp
->hfc_stage
= HFC_IDLE
;
562 error
= hfc_btree_create(hfsmp
, HFSTOVCB(hfsmp
)->blockSize
, HFC_DEFAULT_FILE_COUNT
);
565 printf("hfs: Error %d creating hot file b-tree on %s \n", error
, hfsmp
->vcbVN
);
570 * Open the Hot File B-tree file for writing.
572 if (hfsmp
->hfc_filevp
)
573 panic("hfs_recording_init: hfc_filevp exists (vp = %p)", hfsmp
->hfc_filevp
);
574 error
= hfc_btree_open(hfsmp
, &hfsmp
->hfc_filevp
);
577 printf("hfs: Error %d opening hot file b-tree on %s \n", error
, hfsmp
->vcbVN
);
581 MALLOC(iterator
, BTreeIterator
*, sizeof(*iterator
), M_TEMP
, M_WAITOK
);
582 if (iterator
== NULL
) {
584 (void) hfc_btree_close(hfsmp
, hfsmp
->hfc_filevp
);
585 hfsmp
->hfc_filevp
= NULL
;
588 bzero(iterator
, sizeof(*iterator
));
589 key
= (HotFileKey
*) &iterator
->key
;
590 key
->keyLength
= HFC_KEYLENGTH
;
592 record
.bufferAddress
= &data
;
593 record
.itemSize
= sizeof(u_int32_t
);
594 record
.itemCount
= 1;
596 printf("hfs: Evaluating space for \"%s\" metadata zone...\n", HFSTOVCB(hfsmp
)->vcbVN
);
599 * Get ready to scan the Catalog file.
601 error
= BTScanInitialize(VTOF(HFSTOVCB(hfsmp
)->catalogRefNum
), 0, 0, 0,
602 kCatSearchBufferSize
, &scanstate
);
604 printf("hfs_recording_init: err %d BTScanInit\n", error
);
609 * The writes to Hot File B-tree file are journaled.
611 if (hfs_start_transaction(hfsmp
) != 0) {
615 if (hfs_lock(VTOC(hfsmp
->hfc_filevp
), HFS_EXCLUSIVE_LOCK
) != 0) {
619 filefork
= VTOF(hfsmp
->hfc_filevp
);
622 * Visit all the catalog btree leaf records.
625 error
= BTScanNextRecord(&scanstate
, 0, (void **)&keyp
, (void **)&datap
, &dataSize
);
627 if (error
== btNotFound
)
630 printf("hfs_recording_init: err %d BTScanNext\n", error
);
633 if ((datap
->recordType
!= kHFSPlusFileRecord
) ||
634 (dataSize
!= sizeof(HFSPlusCatalogFile
))) {
637 filep
= (HFSPlusCatalogFile
*)datap
;
639 if (filep
->dataFork
.totalBlocks
== 0) {
643 * Any file that has blocks inside the hot file
644 * space is recorded for later eviction.
646 * For now, resource forks are ignored.
648 if (!hotextents(hfsmp
, &filep
->dataFork
.extents
[0])) {
651 cnid
= filep
->fileID
;
653 /* Skip over journal files. */
654 if (cnid
== hfsmp
->hfs_jnlfileid
|| cnid
== hfsmp
->hfs_jnlinfoblkid
) {
658 * XXX - need to skip quota files as well.
661 /* Insert a hot file entry. */
662 key
->keyLength
= HFC_KEYLENGTH
;
663 key
->temperature
= HFC_MINIMUM_TEMPERATURE
;
667 error
= BTInsertRecord(filefork
, iterator
, &record
, record
.itemSize
);
669 printf("hfs_recording_init: BTInsertRecord failed %d (fileid %d)\n", error
, key
->fileID
);
670 error
= MacToVFSError(error
);
674 /* Insert the corresponding thread record. */
675 key
->keyLength
= HFC_KEYLENGTH
;
676 key
->temperature
= HFC_LOOKUPTAG
;
679 data
= HFC_MINIMUM_TEMPERATURE
;
680 error
= BTInsertRecord(filefork
, iterator
, &record
, record
.itemSize
);
682 printf("hfs_recording_init: BTInsertRecord failed %d (fileid %d)\n", error
, key
->fileID
);
683 error
= MacToVFSError(error
);
688 (void) BTFlushPath(filefork
);
689 hfs_unlock(VTOC(hfsmp
->hfc_filevp
));
692 hfs_end_transaction(hfsmp
);
694 printf("hfs: %d files identified out of %d\n", inserted
, filecount
);
698 (void) BTScanTerminate(&scanstate
, &data
, &data
, &data
);
701 FREE(iterator
, M_TEMP
);
702 if (hfsmp
->hfc_filevp
) {
703 (void) hfc_btree_close(hfsmp
, hfsmp
->hfc_filevp
);
704 hfsmp
->hfc_filevp
= NULL
;
707 hfsmp
->hfc_stage
= HFC_IDLE
;
713 * Use sync to perform ocassional background work.
717 hfs_hotfilesync(struct hfsmount
*hfsmp
, vfs_context_t ctx
)
719 if (hfsmp
->hfc_stage
) {
722 lck_mtx_lock(&hfsmp
->hfc_mutex
);
724 switch (hfsmp
->hfc_stage
) {
726 (void) hfs_recording_start(hfsmp
);
731 if (tv
.tv_sec
> hfsmp
->hfc_timeout
)
732 (void) hfs_recording_stop(hfsmp
);
736 (void) hotfiles_evict(hfsmp
, ctx
);
740 (void) hotfiles_adopt(hfsmp
);
746 lck_mtx_unlock(&hfsmp
->hfc_mutex
);
752 * Add a hot file to the recording list.
754 * This can happen when a hot file gets reclaimed or at the
755 * end of the recording period for any active hot file.
757 * NOTE: Since both the data and resource fork can be hot,
758 * there can be two entries for the same file id.
760 * Note: the cnode is locked on entry.
764 hfs_addhotfile(struct vnode
*vp
)
770 if (hfsmp
->hfc_stage
!= HFC_RECORDING
)
773 lck_mtx_lock(&hfsmp
->hfc_mutex
);
774 error
= hfs_addhotfile_internal(vp
);
775 lck_mtx_unlock(&hfsmp
->hfc_mutex
);
780 hfs_addhotfile_internal(struct vnode
*vp
)
782 hotfile_data_t
*hotdata
;
783 hotfile_entry_t
*entry
;
787 u_int32_t temperature
;
790 if (hfsmp
->hfc_stage
!= HFC_RECORDING
)
793 if ((!vnode_isreg(vp
) && !vnode_islnk(vp
)) || vnode_issystem(vp
)) {
796 /* Skip resource forks for now. */
797 if (VNODE_IS_RSRC(vp
)) {
800 if ((hotdata
= (hotfile_data_t
*)hfsmp
->hfc_recdata
) == NULL
) {
806 if ((ffp
->ff_bytesread
== 0) ||
807 (ffp
->ff_blocks
== 0) ||
808 (ffp
->ff_size
== 0) ||
809 (ffp
->ff_blocks
> hotdata
->maxblocks
) ||
810 (cp
->c_flag
& (C_DELETED
| C_NOEXISTS
)) ||
811 (cp
->c_flags
& UF_NODUMP
) ||
812 (cp
->c_atime
< hfsmp
->hfc_timebase
)) {
816 temperature
= ffp
->ff_bytesread
/ ffp
->ff_size
;
817 if (temperature
< hotdata
->threshold
) {
821 * If there is room or this file is hotter than
822 * the coldest one then add it to the list.
825 if ((hotdata
->activefiles
< hfsmp
->hfc_maxfiles
) ||
826 (hotdata
->coldest
== NULL
) ||
827 (temperature
> hotdata
->coldest
->temperature
)) {
829 entry
= hf_getnewentry(hotdata
);
830 entry
->temperature
= temperature
;
831 entry
->fileid
= cp
->c_fileid
;
832 entry
->blocks
= ffp
->ff_blocks
;
833 hf_insert(hotdata
, entry
);
841 * Remove a hot file from the recording list.
843 * This can happen when a hot file becomes
844 * an active vnode (active hot files are
845 * not kept in the recording list until the
846 * end of the recording period).
848 * Note: the cnode is locked on entry.
852 hfs_removehotfile(struct vnode
*vp
)
854 hotfile_data_t
*hotdata
;
858 u_int32_t temperature
;
861 if (hfsmp
->hfc_stage
!= HFC_RECORDING
)
864 if ((!vnode_isreg(vp
) && !vnode_islnk(vp
)) || vnode_issystem(vp
)) {
871 if ((ffp
->ff_bytesread
== 0) || (ffp
->ff_blocks
== 0) ||
872 (ffp
->ff_size
== 0) || (cp
->c_atime
< hfsmp
->hfc_timebase
)) {
876 lck_mtx_lock(&hfsmp
->hfc_mutex
);
877 if (hfsmp
->hfc_stage
!= HFC_RECORDING
)
879 if ((hotdata
= (hotfile_data_t
*)hfsmp
->hfc_recdata
) == NULL
)
882 temperature
= ffp
->ff_bytesread
/ ffp
->ff_size
;
883 if (temperature
< hotdata
->threshold
)
886 if (hotdata
->coldest
&& (temperature
>= hotdata
->coldest
->temperature
)) {
888 hf_delete(hotdata
, VTOC(vp
)->c_fileid
, temperature
);
892 lck_mtx_unlock(&hfsmp
->hfc_mutex
);
898 *========================================================================
899 * HOT FILE MAINTENANCE ROUTINES
900 *========================================================================
904 hotfiles_collect_callback(struct vnode
*vp
, __unused
void *cargs
)
906 if ((vnode_isreg(vp
) || vnode_islnk(vp
)) && !vnode_issystem(vp
))
907 (void) hfs_addhotfile_internal(vp
);
909 return (VNODE_RETURNED
);
913 * Add all active hot files to the recording list.
916 hotfiles_collect(struct hfsmount
*hfsmp
)
918 struct mount
*mp
= HFSTOVFS(hfsmp
);
920 if (vfs_busy(mp
, LK_NOWAIT
))
924 * hotfiles_collect_callback will be called for each vnode
925 * hung off of this mount point
927 * properly referenced and unreferenced around the callback
929 vnode_iterate(mp
, 0, hotfiles_collect_callback
, (void *)NULL
);
938 * Update the data of a btree record
939 * This is called from within BTUpdateRecord.
942 update_callback(const HotFileKey
*key
, u_int32_t
*data
, u_int32_t
*state
)
944 if (key
->temperature
== HFC_LOOKUPTAG
)
950 * Identify files already in hot area.
953 hotfiles_refine(struct hfsmount
*hfsmp
)
955 BTreeIterator
* iterator
= NULL
;
957 filefork_t
* filefork
;
958 hotfilelist_t
*listp
;
959 FSBufferDescriptor record
;
966 if ((listp
= (hotfilelist_t
*)hfsmp
->hfc_recdata
) == NULL
)
969 mp
= HFSTOVFS(hfsmp
);
971 MALLOC(iterator
, BTreeIterator
*, sizeof(*iterator
), M_TEMP
, M_WAITOK
);
972 if (iterator
== NULL
) {
976 bzero(iterator
, sizeof(*iterator
));
977 key
= (HotFileKey
*) &iterator
->key
;
979 record
.bufferAddress
= &data
;
980 record
.itemSize
= sizeof(u_int32_t
);
981 record
.itemCount
= 1;
983 if (hfs_start_transaction(hfsmp
) != 0) {
987 if (hfs_lock(VTOC(hfsmp
->hfc_filevp
), HFS_EXCLUSIVE_LOCK
) != 0) {
991 filefork
= VTOF(hfsmp
->hfc_filevp
);
993 for (i
= 0; i
< listp
->hfl_count
; ++i
) {
995 * Check if entry (thread) is already in hot area.
997 key
->keyLength
= HFC_KEYLENGTH
;
998 key
->temperature
= HFC_LOOKUPTAG
;
999 key
->fileID
= listp
->hfl_hotfile
[i
].hf_fileid
;
1001 (void) BTInvalidateHint(iterator
);
1002 if (BTSearchRecord(filefork
, iterator
, &record
, NULL
, iterator
) != 0) {
1003 continue; /* not in hot area, so skip */
1007 * Update thread entry with latest temperature.
1009 error
= BTUpdateRecord(filefork
, iterator
,
1010 (IterateCallBackProcPtr
)update_callback
,
1011 &listp
->hfl_hotfile
[i
].hf_temperature
);
1013 printf("hfs: hotfiles_refine: BTUpdateRecord failed %d (file %d)\n", error
, key
->fileID
);
1014 error
= MacToVFSError(error
);
1018 * Re-key entry with latest temperature.
1020 key
->keyLength
= HFC_KEYLENGTH
;
1021 key
->temperature
= data
;
1022 key
->fileID
= listp
->hfl_hotfile
[i
].hf_fileid
;
1024 /* Pick up record data. */
1025 (void) BTInvalidateHint(iterator
);
1026 (void) BTSearchRecord(filefork
, iterator
, &record
, NULL
, iterator
);
1027 error
= BTDeleteRecord(filefork
, iterator
);
1029 printf("hfs: hotfiles_refine: BTDeleteRecord failed %d (file %d)\n", error
, key
->fileID
);
1030 error
= MacToVFSError(error
);
1033 key
->keyLength
= HFC_KEYLENGTH
;
1034 key
->temperature
= listp
->hfl_hotfile
[i
].hf_temperature
;
1035 key
->fileID
= listp
->hfl_hotfile
[i
].hf_fileid
;
1037 error
= BTInsertRecord(filefork
, iterator
, &record
, record
.itemSize
);
1039 printf("hfs: hotfiles_refine: BTInsertRecord failed %d (file %d)\n", error
, key
->fileID
);
1040 error
= MacToVFSError(error
);
1045 * Invalidate this entry in the list.
1047 listp
->hfl_hotfile
[i
].hf_temperature
= 0;
1048 listp
->hfl_totalblocks
-= listp
->hfl_hotfile
[i
].hf_blocks
;
1052 (void) BTFlushPath(filefork
);
1053 hfs_unlock(VTOC(hfsmp
->hfc_filevp
));
1056 hfs_end_transaction(hfsmp
);
1059 FREE(iterator
, M_TEMP
);
1064 * Move new hot files into hot area.
1066 * Requires that the hfc_mutex be held.
1069 hotfiles_adopt(struct hfsmount
*hfsmp
)
1071 BTreeIterator
* iterator
= NULL
;
1073 filefork_t
* filefork
;
1074 hotfilelist_t
*listp
;
1075 FSBufferDescriptor record
;
1078 enum hfc_stage stage
;
1084 int startedtrans
= 0;
1086 if ((listp
= (hotfilelist_t
*)hfsmp
->hfc_recdata
) == NULL
)
1089 if (hfsmp
->hfc_stage
!= HFC_ADOPTION
) {
1092 if (hfs_lock(VTOC(hfsmp
->hfc_filevp
), HFS_EXCLUSIVE_LOCK
) != 0) {
1096 MALLOC(iterator
, BTreeIterator
*, sizeof(*iterator
), M_TEMP
, M_WAITOK
);
1097 if (iterator
== NULL
) {
1098 hfs_unlock(VTOC(hfsmp
->hfc_filevp
));
1102 stage
= hfsmp
->hfc_stage
;
1103 hfsmp
->hfc_stage
= HFC_BUSY
;
1106 last
= listp
->hfl_next
+ HFC_FILESPERSYNC
;
1107 if (last
> listp
->hfl_count
)
1108 last
= listp
->hfl_count
;
1110 bzero(iterator
, sizeof(*iterator
));
1111 key
= (HotFileKey
*) &iterator
->key
;
1112 key
->keyLength
= HFC_KEYLENGTH
;
1114 record
.bufferAddress
= &data
;
1115 record
.itemSize
= sizeof(u_int32_t
);
1116 record
.itemCount
= 1;
1118 filefork
= VTOF(hfsmp
->hfc_filevp
);
1120 for (i
= listp
->hfl_next
; (i
< last
) && (blksmoved
< HFC_BLKSPERSYNC
); ++i
) {
1122 * Skip invalid entries (already in hot area).
1124 if (listp
->hfl_hotfile
[i
].hf_temperature
== 0) {
1129 * Acquire a vnode for this file.
1131 error
= hfs_vget(hfsmp
, listp
->hfl_hotfile
[i
].hf_fileid
, &vp
, 0);
1133 if (error
== ENOENT
) {
1136 continue; /* stale entry, go to next */
1140 if (!vnode_isreg(vp
) && !vnode_islnk(vp
)) {
1141 printf("hfs: hotfiles_adopt: huh, not a file %d (%d)\n", listp
->hfl_hotfile
[i
].hf_fileid
, VTOC(vp
)->c_cnid
);
1142 hfs_unlock(VTOC(vp
));
1144 listp
->hfl_hotfile
[i
].hf_temperature
= 0;
1146 continue; /* stale entry, go to next */
1148 if (hotextents(hfsmp
, &VTOF(vp
)->ff_extents
[0])) {
1149 hfs_unlock(VTOC(vp
));
1151 listp
->hfl_hotfile
[i
].hf_temperature
= 0;
1153 listp
->hfl_totalblocks
-= listp
->hfl_hotfile
[i
].hf_blocks
;
1154 continue; /* stale entry, go to next */
1156 fileblocks
= VTOF(vp
)->ff_blocks
;
1157 if (fileblocks
> hfsmp
->hfs_hotfile_freeblks
) {
1158 hfs_unlock(VTOC(vp
));
1161 listp
->hfl_totalblocks
-= fileblocks
;
1162 continue; /* entry too big, go to next */
1165 if ((blksmoved
> 0) &&
1166 (blksmoved
+ fileblocks
) > HFC_BLKSPERSYNC
) {
1167 hfs_unlock(VTOC(vp
));
1169 break; /* adopt this entry the next time around */
1171 if (VTOC(vp
)->c_desc
.cd_nameptr
)
1172 data
= *(const u_int32_t
*)(VTOC(vp
)->c_desc
.cd_nameptr
);
1176 error
= hfs_relocate(vp
, hfsmp
->hfs_hotfile_start
, kauth_cred_get(), current_proc());
1177 hfs_unlock(VTOC(vp
));
1180 /* Move on to next item. */
1184 /* Keep hot file free space current. */
1185 hfsmp
->hfs_hotfile_freeblks
-= fileblocks
;
1186 listp
->hfl_totalblocks
-= fileblocks
;
1188 /* Insert hot file entry */
1189 key
->keyLength
= HFC_KEYLENGTH
;
1190 key
->temperature
= listp
->hfl_hotfile
[i
].hf_temperature
;
1191 key
->fileID
= listp
->hfl_hotfile
[i
].hf_fileid
;
1194 /* Start a new transaction before calling BTree code. */
1195 if (hfs_start_transaction(hfsmp
) != 0) {
1201 error
= BTInsertRecord(filefork
, iterator
, &record
, record
.itemSize
);
1203 printf("hfs: hotfiles_adopt: BTInsertRecord failed %d (fileid %d)\n", error
, key
->fileID
);
1204 error
= MacToVFSError(error
);
1209 /* Insert thread record */
1210 key
->keyLength
= HFC_KEYLENGTH
;
1211 key
->temperature
= HFC_LOOKUPTAG
;
1212 key
->fileID
= listp
->hfl_hotfile
[i
].hf_fileid
;
1214 data
= listp
->hfl_hotfile
[i
].hf_temperature
;
1215 error
= BTInsertRecord(filefork
, iterator
, &record
, record
.itemSize
);
1217 printf("hfs: hotfiles_adopt: BTInsertRecord failed %d (fileid %d)\n", error
, key
->fileID
);
1218 error
= MacToVFSError(error
);
1222 (void) BTFlushPath(filefork
);
1224 /* Transaction complete. */
1226 hfs_end_transaction(hfsmp
);
1230 blksmoved
+= fileblocks
;
1232 if (listp
->hfl_next
>= listp
->hfl_count
) {
1235 if (hfsmp
->hfs_hotfile_freeblks
<= 0) {
1237 printf("hfs: hotfiles_adopt: free space exhausted (%d)\n", hfsmp
->hfs_hotfile_freeblks
);
1244 printf("hfs: hotfiles_adopt: [%d] adopted %d blocks (%d left)\n", listp
->hfl_next
, blksmoved
, listp
->hfl_totalblocks
);
1246 /* Finish any outstanding transactions. */
1248 (void) BTFlushPath(filefork
);
1249 hfs_end_transaction(hfsmp
);
1252 hfs_unlock(VTOC(hfsmp
->hfc_filevp
));
1254 if ((listp
->hfl_next
>= listp
->hfl_count
) || (hfsmp
->hfs_hotfile_freeblks
<= 0)) {
1256 printf("hfs: hotfiles_adopt: all done relocating %d files\n", listp
->hfl_count
);
1257 printf("hfs: hotfiles_adopt: %d blocks free in hot file band\n", hfsmp
->hfs_hotfile_freeblks
);
1261 FREE(iterator
, M_TEMP
);
1263 if (stage
!= HFC_ADOPTION
&& hfsmp
->hfc_filevp
) {
1264 (void) hfc_btree_close(hfsmp
, hfsmp
->hfc_filevp
);
1265 hfsmp
->hfc_filevp
= NULL
;
1267 hfsmp
->hfc_stage
= stage
;
1268 wakeup((caddr_t
)&hfsmp
->hfc_stage
);
1273 * Reclaim space by evicting the coldest files.
1275 * Requires that the hfc_mutex be held.
1278 hotfiles_evict(struct hfsmount
*hfsmp
, vfs_context_t ctx
)
1280 BTreeIterator
* iterator
= NULL
;
1283 filefork_t
* filefork
;
1284 hotfilelist_t
*listp
;
1285 enum hfc_stage stage
;
1286 u_int32_t savedtemp
;
1291 int startedtrans
= 0;
1294 if (hfsmp
->hfc_stage
!= HFC_EVICTION
) {
1298 if ((listp
= (hotfilelist_t
*)hfsmp
->hfc_recdata
) == NULL
)
1301 if (hfs_lock(VTOC(hfsmp
->hfc_filevp
), HFS_EXCLUSIVE_LOCK
) != 0) {
1305 MALLOC(iterator
, BTreeIterator
*, sizeof(*iterator
), M_TEMP
, M_WAITOK
);
1306 if (iterator
== NULL
) {
1307 hfs_unlock(VTOC(hfsmp
->hfc_filevp
));
1311 stage
= hfsmp
->hfc_stage
;
1312 hfsmp
->hfc_stage
= HFC_BUSY
;
1314 filesmoved
= blksmoved
= 0;
1315 bt_op
= kBTreeFirstRecord
;
1317 bzero(iterator
, sizeof(*iterator
));
1318 key
= (HotFileKey
*) &iterator
->key
;
1320 filefork
= VTOF(hfsmp
->hfc_filevp
);
1322 while (listp
->hfl_reclaimblks
> 0 &&
1323 blksmoved
< HFC_BLKSPERSYNC
&&
1324 filesmoved
< HFC_FILESPERSYNC
) {
1327 * Obtain the first record (ie the coldest one).
1329 if (BTIterateRecord(filefork
, bt_op
, iterator
, NULL
, NULL
) != 0) {
1331 printf("hfs: hotfiles_evict: no more records\n");
1334 stage
= HFC_ADOPTION
;
1337 if (key
->keyLength
!= HFC_KEYLENGTH
) {
1338 printf("hfs: hotfiles_evict: invalid key length %d\n", key
->keyLength
);
1342 if (key
->temperature
== HFC_LOOKUPTAG
) {
1344 printf("hfs: hotfiles_evict: ran into thread records\n");
1347 stage
= HFC_ADOPTION
;
1351 * Aquire the vnode for this file.
1353 error
= hfs_vget(hfsmp
, key
->fileID
, &vp
, 0);
1355 if (error
== ENOENT
) {
1356 goto delete; /* stale entry, go to next */
1358 printf("hfs: hotfiles_evict: err %d getting file %d\n",
1359 error
, key
->fileID
);
1363 if (!vnode_isreg(vp
) && !vnode_islnk(vp
)) {
1364 printf("hfs: hotfiles_evict: huh, not a file %d\n", key
->fileID
);
1365 hfs_unlock(VTOC(vp
));
1367 goto delete; /* invalid entry, go to next */
1369 fileblocks
= VTOF(vp
)->ff_blocks
;
1370 if ((blksmoved
> 0) &&
1371 (blksmoved
+ fileblocks
) > HFC_BLKSPERSYNC
) {
1372 hfs_unlock(VTOC(vp
));
1377 * Make sure file is in the hot area.
1379 if (!hotextents(hfsmp
, &VTOF(vp
)->ff_extents
[0])) {
1381 printf("hfs: hotfiles_evict: file %d isn't hot!\n", key
->fileID
);
1383 hfs_unlock(VTOC(vp
));
1385 goto delete; /* stale entry, go to next */
1389 * Relocate file out of hot area.
1391 error
= hfs_relocate(vp
, HFSTOVCB(hfsmp
)->nextAllocation
, vfs_context_ucred(ctx
), vfs_context_proc(ctx
));
1393 printf("hfs: hotfiles_evict: err %d relocating file %d\n", error
, key
->fileID
);
1394 hfs_unlock(VTOC(vp
));
1396 bt_op
= kBTreeNextRecord
;
1397 goto next
; /* go to next */
1401 // We do not believe that this call to hfs_fsync() is
1402 // necessary and it causes a journal transaction
1403 // deadlock so we are removing it.
1405 // (void) hfs_fsync(vp, MNT_WAIT, 0, p);
1407 hfs_unlock(VTOC(vp
));
1410 hfsmp
->hfs_hotfile_freeblks
+= fileblocks
;
1411 listp
->hfl_reclaimblks
-= fileblocks
;
1412 if (listp
->hfl_reclaimblks
< 0)
1413 listp
->hfl_reclaimblks
= 0;
1414 blksmoved
+= fileblocks
;
1417 /* Start a new transaction before calling BTree code. */
1418 if (hfs_start_transaction(hfsmp
) != 0) {
1424 error
= BTDeleteRecord(filefork
, iterator
);
1426 error
= MacToVFSError(error
);
1429 savedtemp
= key
->temperature
;
1430 key
->temperature
= HFC_LOOKUPTAG
;
1431 error
= BTDeleteRecord(filefork
, iterator
);
1433 error
= MacToVFSError(error
);
1436 key
->temperature
= savedtemp
;
1438 (void) BTFlushPath(filefork
);
1440 /* Transaction complete. */
1442 hfs_end_transaction(hfsmp
);
1449 printf("hfs: hotfiles_evict: moved %d files (%d blks, %d to go)\n", filesmoved
, blksmoved
, listp
->hfl_reclaimblks
);
1451 /* Finish any outstanding transactions. */
1453 (void) BTFlushPath(filefork
);
1454 hfs_end_transaction(hfsmp
);
1457 hfs_unlock(VTOC(hfsmp
->hfc_filevp
));
1460 * Move to next stage when finished.
1462 if (listp
->hfl_reclaimblks
<= 0) {
1463 stage
= HFC_ADOPTION
;
1465 printf("hfs: hotfiles_evict: %d blocks free in hot file band\n", hfsmp
->hfs_hotfile_freeblks
);
1468 FREE(iterator
, M_TEMP
);
1469 hfsmp
->hfc_stage
= stage
;
1470 wakeup((caddr_t
)&hfsmp
->hfc_stage
);
1475 * Age the existing records in the hot files b-tree.
1478 hotfiles_age(struct hfsmount
*hfsmp
)
1480 BTreeInfoRec btinfo
;
1481 BTreeIterator
* iterator
= NULL
;
1482 BTreeIterator
* prev_iterator
;
1483 FSBufferDescriptor record
;
1484 FSBufferDescriptor prev_record
;
1486 HotFileKey
* prev_key
;
1487 filefork_t
* filefork
;
1489 u_int32_t prev_data
;
1498 MALLOC(iterator
, BTreeIterator
*, 2 * sizeof(*iterator
), M_TEMP
, M_WAITOK
);
1499 if (iterator
== NULL
) {
1503 bzero(iterator
, 2 * sizeof(*iterator
));
1504 key
= (HotFileKey
*) &iterator
->key
;
1506 prev_iterator
= &iterator
[1];
1507 prev_key
= (HotFileKey
*) &prev_iterator
->key
;
1509 record
.bufferAddress
= &data
;
1510 record
.itemSize
= sizeof(data
);
1511 record
.itemCount
= 1;
1512 prev_record
.bufferAddress
= &prev_data
;
1513 prev_record
.itemSize
= sizeof(prev_data
);
1514 prev_record
.itemCount
= 1;
1517 * Capture b-tree changes inside a transaction
1519 if (hfs_start_transaction(hfsmp
) != 0) {
1523 if (hfs_lock(VTOC(hfsmp
->hfc_filevp
), HFS_EXCLUSIVE_LOCK
) != 0) {
1527 filefork
= VTOF(hfsmp
->hfc_filevp
);
1529 error
= BTGetInformation(filefork
, 0, &btinfo
);
1531 error
= MacToVFSError(error
);
1534 if (btinfo
.numRecords
< 2) {
1539 /* Only want 1st half of leaf records */
1540 numrecs
= (btinfo
.numRecords
/= 2) - 1;
1542 error
= BTIterateRecord(filefork
, kBTreeFirstRecord
, iterator
, &record
, &reclen
);
1544 printf("hfs_agehotfiles: BTIterateRecord: %d\n", error
);
1545 error
= MacToVFSError(error
);
1548 bcopy(iterator
, prev_iterator
, sizeof(BTreeIterator
));
1551 for (i
= 0; i
< numrecs
; ++i
) {
1552 error
= BTIterateRecord(filefork
, kBTreeNextRecord
, iterator
, &record
, &reclen
);
1554 if (key
->temperature
< prev_key
->temperature
) {
1555 printf("hfs_agehotfiles: out of order keys!\n");
1559 if (reclen
!= sizeof(data
)) {
1560 printf("hfs_agehotfiles: invalid record length %d\n", reclen
);
1564 if (key
->keyLength
!= HFC_KEYLENGTH
) {
1565 printf("hfs_agehotfiles: invalid key length %d\n", key
->keyLength
);
1569 } else if ((error
== fsBTEndOfIterationErr
|| error
== fsBTRecordNotFoundErr
) &&
1570 (i
== (numrecs
- 1))) {
1573 printf("hfs_agehotfiles: %d of %d BTIterateRecord: %d\n", i
, numrecs
, error
);
1574 error
= MacToVFSError(error
);
1577 if (prev_key
->temperature
== HFC_LOOKUPTAG
) {
1579 printf("hfs_agehotfiles: ran into thread record\n");
1584 error
= BTDeleteRecord(filefork
, prev_iterator
);
1586 printf("hfs_agehotfiles: BTDeleteRecord failed %d (file %d)\n", error
, prev_key
->fileID
);
1587 error
= MacToVFSError(error
);
1591 /* Age by halving the temperature (floor = 4) */
1592 newtemp
= MAX(prev_key
->temperature
>> 1, 4);
1593 prev_key
->temperature
= newtemp
;
1595 error
= BTInsertRecord(filefork
, prev_iterator
, &prev_record
, prev_record
.itemSize
);
1597 printf("hfs_agehotfiles: BTInsertRecord failed %d (file %d)\n", error
, prev_key
->fileID
);
1598 error
= MacToVFSError(error
);
1603 * Update thread entry with latest temperature.
1605 prev_key
->temperature
= HFC_LOOKUPTAG
;
1606 error
= BTUpdateRecord(filefork
, prev_iterator
,
1607 (IterateCallBackProcPtr
)update_callback
,
1610 printf("hfs_agehotfiles: %d of %d BTUpdateRecord failed %d (file %d, %d)\n",
1611 i
, numrecs
, error
, prev_key
->fileID
, newtemp
);
1612 error
= MacToVFSError(error
);
1616 bcopy(iterator
, prev_iterator
, sizeof(BTreeIterator
));
1623 printf("hfs_agehotfiles: aged %d records out of %d\n", aged
, btinfo
.numRecords
);
1625 (void) BTFlushPath(filefork
);
1627 hfs_unlock(VTOC(hfsmp
->hfc_filevp
));
1629 hfs_end_transaction(hfsmp
);
1632 FREE(iterator
, M_TEMP
);
1637 * Return true if any blocks (or all blocks if all is true)
1638 * are contained in the hot file region.
1641 hotextents(struct hfsmount
*hfsmp
, HFSPlusExtentDescriptor
* extents
)
1647 for (i
= 0; i
< kHFSPlusExtentDensity
; ++i
) {
1648 b1
= extents
[i
].startBlock
;
1651 b2
= b1
+ extents
[i
].blockCount
- 1;
1652 if ((b1
>= hfsmp
->hfs_hotfile_start
&&
1653 b2
<= hfsmp
->hfs_hotfile_end
) ||
1654 (b1
< hfsmp
->hfs_hotfile_end
&&
1655 b2
> hfsmp
->hfs_hotfile_end
)) {
1665 *========================================================================
1666 * HOT FILE B-TREE ROUTINES
1667 *========================================================================
1671 * Open the hot files b-tree for writing.
1673 * On successful exit the vnode has a reference but not an iocount.
1676 hfc_btree_open(struct hfsmount
*hfsmp
, struct vnode
**vpp
)
1680 struct cat_desc cdesc
;
1681 struct cat_attr cattr
;
1682 struct cat_fork cfork
;
1683 static char filename
[] = HFC_FILENAME
;
1691 bzero(&cdesc
, sizeof(cdesc
));
1692 cdesc
.cd_parentcnid
= kRootDirID
;
1693 cdesc
.cd_nameptr
= (const u_int8_t
*)filename
;
1694 cdesc
.cd_namelen
= strlen(filename
);
1696 lockflags
= hfs_systemfile_lock(hfsmp
, SFL_CATALOG
, HFS_SHARED_LOCK
);
1698 error
= cat_lookup(hfsmp
, &cdesc
, 0, &cdesc
, &cattr
, &cfork
, NULL
);
1700 hfs_systemfile_unlock(hfsmp
, lockflags
);
1703 printf("hfs: hfc_btree_open: cat_lookup error %d\n", error
);
1707 cdesc
.cd_flags
|= CD_ISMETA
;
1708 error
= hfs_getnewvnode(hfsmp
, NULL
, NULL
, &cdesc
, 0, &cattr
, &cfork
, &vp
);
1710 printf("hfs: hfc_btree_open: hfs_getnewvnode error %d\n", error
);
1711 cat_releasedesc(&cdesc
);
1714 if (!vnode_issystem(vp
)) {
1716 printf("hfs: hfc_btree_open: file has UBC, try again\n");
1718 hfs_unlock(VTOC(vp
));
1727 /* Open the B-tree file for writing... */
1728 error
= BTOpenPath(VTOF(vp
), (KeyCompareProcPtr
) hfc_comparekeys
);
1730 printf("hfs: hfc_btree_open: BTOpenPath error %d\n", error
);
1731 error
= MacToVFSError(error
);
1734 hfs_unlock(VTOC(vp
));
1737 vnode_ref(vp
); /* keep a reference while its open */
1741 if (!vnode_issystem(vp
))
1742 panic("hfs: hfc_btree_open: not a system file (vp = %p)", vp
);
1748 * Close the hot files b-tree.
1750 * On entry the vnode has a reference.
1753 hfc_btree_close(struct hfsmount
*hfsmp
, struct vnode
*vp
)
1755 proc_t p
= current_proc();
1760 hfs_journal_flush(hfsmp
);
1763 if (vnode_get(vp
) == 0) {
1764 error
= hfs_lock(VTOC(vp
), HFS_EXCLUSIVE_LOCK
);
1766 (void) hfs_fsync(vp
, MNT_WAIT
, 0, p
);
1767 error
= BTClosePath(VTOF(vp
));
1768 hfs_unlock(VTOC(vp
));
1779 * Create a hot files btree file.
1783 hfc_btree_create(struct hfsmount
*hfsmp
, unsigned int nodesize
, unsigned int entries
)
1785 struct vnode
*dvp
= NULL
;
1786 struct vnode
*vp
= NULL
;
1787 struct cnode
*cp
= NULL
;
1788 vfs_context_t ctx
= vfs_context_current();
1789 struct vnode_attr va
;
1790 struct componentname cname
;
1791 static char filename
[] = HFC_FILENAME
;
1794 if (hfsmp
->hfc_filevp
)
1795 panic("hfs: hfc_btree_create: hfc_filevp exists (vp = %p)", hfsmp
->hfc_filevp
);
1797 error
= VFS_ROOT(HFSTOVFS(hfsmp
), &dvp
, ctx
);
1801 cname
.cn_nameiop
= CREATE
;
1802 cname
.cn_flags
= ISLASTCN
;
1803 cname
.cn_context
= ctx
;
1804 cname
.cn_pnbuf
= filename
;
1805 cname
.cn_pnlen
= sizeof(filename
);
1806 cname
.cn_nameptr
= filename
;
1807 cname
.cn_namelen
= strlen(filename
);
1809 cname
.cn_consume
= 0;
1812 VATTR_SET(&va
, va_type
, VREG
);
1813 VATTR_SET(&va
, va_mode
, S_IFREG
| S_IRUSR
| S_IWUSR
);
1814 VATTR_SET(&va
, va_uid
, 0);
1815 VATTR_SET(&va
, va_gid
, 0);
1817 /* call ourselves directly, ignore the higher-level VFS file creation code */
1818 error
= VNOP_CREATE(dvp
, &vp
, &cname
, &va
, ctx
);
1820 printf("hfs: error %d creating HFBT on %s\n", error
, HFSTOVCB(hfsmp
)->vcbVN
);
1827 if ((error
= hfs_lock(VTOC(vp
), HFS_EXCLUSIVE_LOCK
))) {
1832 /* Don't use non-regular files or files with links. */
1833 if (!vnode_isreg(vp
) || cp
->c_linkcount
!= 1) {
1838 printf("hfs: created HFBT on %s\n", HFSTOVCB(hfsmp
)->vcbVN
);
1840 if (VTOF(vp
)->ff_size
< nodesize
) {
1844 BTNodeDescriptor
*ndp
;
1846 HotFilesInfo
*hotfileinfo
;
1852 * Mark it invisible (truncate will pull these changes).
1854 ((FndrFileInfo
*)&cp
->c_finderinfo
[0])->fdFlags
|=
1855 SWAP_BE16 (kIsInvisible
+ kNameLocked
);
1857 if (kmem_alloc(kernel_map
, (vm_offset_t
*)&buffer
, nodesize
)) {
1861 bzero(buffer
, nodesize
);
1862 index
= (u_int16_t
*)buffer
;
1864 entirespernode
= (nodesize
- sizeof(BTNodeDescriptor
) - 2) /
1865 (sizeof(HotFileKey
) + 6);
1866 nodecnt
= 2 + howmany(entries
* 2, entirespernode
);
1867 nodecnt
= roundup(nodecnt
, 8);
1868 filesize
= nodecnt
* nodesize
;
1870 /* FILL IN THE NODE DESCRIPTOR: */
1871 ndp
= (BTNodeDescriptor
*)buffer
;
1872 ndp
->kind
= kBTHeaderNode
;
1873 ndp
->numRecords
= SWAP_BE16 (3);
1874 offset
= sizeof(BTNodeDescriptor
);
1875 index
[(nodesize
/ 2) - 1] = SWAP_BE16 (offset
);
1877 /* FILL IN THE HEADER RECORD: */
1878 bthp
= (BTHeaderRec
*)((u_int8_t
*)buffer
+ offset
);
1879 bthp
->nodeSize
= SWAP_BE16 (nodesize
);
1880 bthp
->totalNodes
= SWAP_BE32 (filesize
/ nodesize
);
1881 bthp
->freeNodes
= SWAP_BE32 (nodecnt
- 1);
1882 bthp
->clumpSize
= SWAP_BE32 (filesize
);
1883 bthp
->btreeType
= kUserBTreeType
; /* non-metadata */
1884 bthp
->attributes
|= SWAP_BE32 (kBTBigKeysMask
);
1885 bthp
->maxKeyLength
= SWAP_BE16 (HFC_KEYLENGTH
);
1886 offset
+= sizeof(BTHeaderRec
);
1887 index
[(nodesize
/ 2) - 2] = SWAP_BE16 (offset
);
1889 /* FILL IN THE USER RECORD: */
1890 hotfileinfo
= (HotFilesInfo
*)((u_int8_t
*)buffer
+ offset
);
1891 hotfileinfo
->magic
= SWAP_BE32 (HFC_MAGIC
);
1892 hotfileinfo
->version
= SWAP_BE32 (HFC_VERSION
);
1893 hotfileinfo
->duration
= SWAP_BE32 (HFC_DEFAULT_DURATION
);
1894 hotfileinfo
->timebase
= 0;
1895 hotfileinfo
->timeleft
= 0;
1896 hotfileinfo
->threshold
= SWAP_BE32 (HFC_MINIMUM_TEMPERATURE
);
1897 hotfileinfo
->maxfileblks
= SWAP_BE32 (HFC_MAXIMUM_FILESIZE
/ HFSTOVCB(hfsmp
)->blockSize
);
1898 hotfileinfo
->maxfilecnt
= SWAP_BE32 (HFC_DEFAULT_FILE_COUNT
);
1899 strlcpy((char *)hotfileinfo
->tag
, hfc_tag
,
1900 sizeof hotfileinfo
->tag
);
1901 offset
+= kBTreeHeaderUserBytes
;
1902 index
[(nodesize
/ 2) - 3] = SWAP_BE16 (offset
);
1904 /* FILL IN THE MAP RECORD (only one node in use). */
1905 *((u_int8_t
*)buffer
+ offset
) = 0x80;
1906 offset
+= nodesize
- sizeof(BTNodeDescriptor
) - sizeof(BTHeaderRec
)
1907 - kBTreeHeaderUserBytes
- (4 * sizeof(int16_t));
1908 index
[(nodesize
/ 2) - 4] = SWAP_BE16 (offset
);
1910 vnode_setnoflush(vp
);
1911 error
= hfs_truncate(vp
, (off_t
)filesize
, IO_NDELAY
, 0, 0, ctx
);
1913 printf("hfs: error %d growing HFBT on %s\n", error
, HFSTOVCB(hfsmp
)->vcbVN
);
1916 cp
->c_flag
|= C_ZFWANTSYNC
;
1917 cp
->c_zftimeout
= 1;
1920 struct vnop_write_args args
;
1923 auio
= uio_create(1, 0, UIO_SYSSPACE
, UIO_WRITE
);
1924 uio_addiov(auio
, (uintptr_t)buffer
, nodesize
);
1926 args
.a_desc
= &vnop_write_desc
;
1930 args
.a_context
= ctx
;
1935 error
= hfs_vnop_write(&args
);
1937 printf("hfs: error %d writing HFBT on %s\n", error
, HFSTOVCB(hfsmp
)->vcbVN
);
1941 kmem_free(kernel_map
, (vm_offset_t
)buffer
, nodesize
);
1957 * Compare two hot file b-tree keys.
1959 * Result: +n search key > trial key
1960 * 0 search key = trial key
1961 * -n search key < trial key
1964 hfc_comparekeys(HotFileKey
*searchKey
, HotFileKey
*trialKey
)
1967 * Compared temperatures first.
1969 if (searchKey
->temperature
== trialKey
->temperature
) {
1971 * Temperatures are equal so compare file ids.
1973 if (searchKey
->fileID
== trialKey
->fileID
) {
1975 * File ids are equal so compare fork types.
1977 if (searchKey
->forkType
== trialKey
->forkType
) {
1979 } else if (searchKey
->forkType
> trialKey
->forkType
) {
1982 } else if (searchKey
->fileID
> trialKey
->fileID
) {
1985 } else if (searchKey
->temperature
> trialKey
->temperature
) {
1994 *========================================================================
1995 * HOT FILE DATA COLLECTING ROUTINES
1996 *========================================================================
2000 * Lookup a hot file entry in the tree.
2003 static hotfile_entry_t
*
2004 hf_lookup(hotfile_data_t
*hotdata
, u_int32_t fileid
, u_int32_t temperature
)
2006 hotfile_entry_t
*entry
= hotdata
->rootentry
;
2009 entry
->temperature
!= temperature
&&
2010 entry
->fileid
!= fileid
) {
2012 if (temperature
> entry
->temperature
)
2013 entry
= entry
->right
;
2014 else if (temperature
< entry
->temperature
)
2015 entry
= entry
->left
;
2016 else if (fileid
> entry
->fileid
)
2017 entry
= entry
->right
;
2019 entry
= entry
->left
;
2026 * Insert a hot file entry into the tree.
2029 hf_insert(hotfile_data_t
*hotdata
, hotfile_entry_t
*newentry
)
2031 hotfile_entry_t
*entry
= hotdata
->rootentry
;
2032 u_int32_t fileid
= newentry
->fileid
;
2033 u_int32_t temperature
= newentry
->temperature
;
2035 if (entry
== NULL
) {
2036 hotdata
->rootentry
= newentry
;
2037 hotdata
->coldest
= newentry
;
2038 hotdata
->activefiles
++;
2043 if (temperature
> entry
->temperature
) {
2045 entry
= entry
->right
;
2047 entry
->right
= newentry
;
2050 } else if (temperature
< entry
->temperature
) {
2052 entry
= entry
->left
;
2054 entry
->left
= newentry
;
2057 } else if (fileid
> entry
->fileid
) {
2059 entry
= entry
->right
;
2061 if (entry
->fileid
!= fileid
)
2062 entry
->right
= newentry
;
2067 entry
= entry
->left
;
2069 if (entry
->fileid
!= fileid
)
2070 entry
->left
= newentry
;
2076 hotdata
->activefiles
++;
2080 * Find the coldest entry in the tree.
2082 static hotfile_entry_t
*
2083 hf_coldest(hotfile_data_t
*hotdata
)
2085 hotfile_entry_t
*entry
= hotdata
->rootentry
;
2089 entry
= entry
->left
;
2095 * Find the hottest entry in the tree.
2097 static hotfile_entry_t
*
2098 hf_hottest(hotfile_data_t
*hotdata
)
2100 hotfile_entry_t
*entry
= hotdata
->rootentry
;
2103 while (entry
->right
)
2104 entry
= entry
->right
;
2110 * Delete a hot file entry from the tree.
2113 hf_delete(hotfile_data_t
*hotdata
, u_int32_t fileid
, u_int32_t temperature
)
2115 hotfile_entry_t
*entry
, *parent
, *next
;
2118 entry
= hotdata
->rootentry
;
2121 entry
->temperature
!= temperature
&&
2122 entry
->fileid
!= fileid
) {
2125 if (temperature
> entry
->temperature
)
2126 entry
= entry
->right
;
2127 else if (temperature
< entry
->temperature
)
2128 entry
= entry
->left
;
2129 else if (fileid
> entry
->fileid
)
2130 entry
= entry
->right
;
2132 entry
= entry
->left
;
2137 * Reorginize the sub-trees spanning from our entry.
2139 if ((next
= entry
->right
)) {
2140 hotfile_entry_t
*pnextl
, *psub
;
2142 * Tree pruning: take the left branch of the
2143 * current entry and place it at the lowest
2144 * left branch of the current right branch
2148 /* Walk the Right/Left sub tree from current entry */
2149 while ((pnextl
= psub
->left
))
2152 /* Plug the old left tree to the new ->Right leftmost entry */
2153 psub
->left
= entry
->left
;
2155 } else /* only left sub-tree, simple case */ {
2159 * Now, plug the current entry sub tree to
2160 * the good pointer of our parent entry.
2163 hotdata
->rootentry
= next
;
2164 else if (parent
->left
== entry
)
2165 parent
->left
= next
;
2167 parent
->right
= next
;
2169 /* Place entry back on the free-list */
2172 entry
->temperature
= 0;
2174 entry
->right
= hotdata
->freelist
;
2175 hotdata
->freelist
= entry
;
2176 hotdata
->activefiles
--;
2178 if (hotdata
->coldest
== entry
|| hotdata
->coldest
== NULL
) {
2179 hotdata
->coldest
= hf_coldest(hotdata
);
2186 * Get a free hot file entry.
2188 static hotfile_entry_t
*
2189 hf_getnewentry(hotfile_data_t
*hotdata
)
2191 hotfile_entry_t
* entry
;
2194 * When the free list is empty then steal the coldest one
2196 if (hotdata
->freelist
== NULL
) {
2197 entry
= hf_coldest(hotdata
);
2198 hf_delete(hotdata
, entry
->fileid
, entry
->temperature
);
2200 entry
= hotdata
->freelist
;
2201 hotdata
->freelist
= entry
->right
;
2209 * Generate a sorted list of hot files (hottest to coldest).
2211 * As a side effect, every node in the hot file tree will be
2212 * deleted (moved to the free list).
2215 hf_getsortedlist(hotfile_data_t
* hotdata
, hotfilelist_t
*sortedlist
)
2218 hotfile_entry_t
*entry
;
2220 while ((entry
= hf_hottest(hotdata
)) != NULL
) {
2221 sortedlist
->hfl_hotfile
[i
].hf_fileid
= entry
->fileid
;
2222 sortedlist
->hfl_hotfile
[i
].hf_temperature
= entry
->temperature
;
2223 sortedlist
->hfl_hotfile
[i
].hf_blocks
= entry
->blocks
;
2224 sortedlist
->hfl_totalblocks
+= entry
->blocks
;
2227 hf_delete(hotdata
, entry
->fileid
, entry
->temperature
);
2230 sortedlist
->hfl_count
= i
;
2233 printf("hfs: hf_getsortedlist returned %d entries\n", i
);
2240 hf_maxdepth(hotfile_entry_t
* root
, int depth
, int *maxdepth
)
2244 if (depth
> *maxdepth
)
2246 hf_maxdepth(root
->left
, depth
, maxdepth
);
2247 hf_maxdepth(root
->right
, depth
, maxdepth
);
2252 hf_printtree(hotfile_entry_t
* root
)
2255 hf_printtree(root
->left
);
2256 printf("hfs: temperature: % 8d, fileid %d\n", root
->temperature
, root
->fileid
);
2257 hf_printtree(root
->right
);