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.
432 hfs_recording_suspend(struct hfsmount
*hfsmp
)
434 HotFilesInfo hotfileinfo
;
435 hotfile_data_t
*hotdata
= NULL
;
439 if (hfsmp
->hfc_stage
== HFC_DISABLED
)
442 lck_mtx_lock(&hfsmp
->hfc_mutex
);
446 * A suspend can occur during eval/evict/adopt stage.
447 * In that case we would need to write out info and
448 * flush our HFBT vnode. Currently we just bail.
451 hotdata
= (hotfile_data_t
*)hfsmp
->hfc_recdata
;
452 if (hotdata
== NULL
|| hfsmp
->hfc_stage
!= HFC_RECORDING
) {
456 hfsmp
->hfc_stage
= HFC_BUSY
;
459 printf("hfs: suspend hot file recording on %s\n", hfsmp
->vcbVN
);
461 error
= hfc_btree_open(hfsmp
, &hfsmp
->hfc_filevp
);
463 printf("hfs_recording_suspend: err %d opening btree\n", error
);
467 if (hfs_start_transaction(hfsmp
) != 0) {
471 if (hfs_lock(VTOC(hfsmp
->hfc_filevp
), HFS_EXCLUSIVE_LOCK
) != 0) {
473 goto end_transaction
;
477 hotfileinfo
.magic
= SWAP_BE32 (HFC_MAGIC
);
478 hotfileinfo
.version
= SWAP_BE32 (HFC_VERSION
);
479 hotfileinfo
.duration
= SWAP_BE32 (HFC_DEFAULT_DURATION
);
480 hotfileinfo
.timebase
= SWAP_BE32 (hfsmp
->hfc_timebase
);
481 hotfileinfo
.timeleft
= SWAP_BE32 (hfsmp
->hfc_timeout
- tv
.tv_sec
);
482 hotfileinfo
.threshold
= SWAP_BE32 (hotdata
->threshold
);
483 hotfileinfo
.maxfileblks
= SWAP_BE32 (hotdata
->maxblocks
);
484 hotfileinfo
.maxfilecnt
= SWAP_BE32 (HFC_DEFAULT_FILE_COUNT
);
485 strlcpy((char *)hotfileinfo
.tag
, hfc_tag
, sizeof hotfileinfo
.tag
);
486 (void) BTSetUserData(VTOF(hfsmp
->hfc_filevp
), &hotfileinfo
, sizeof(hotfileinfo
));
488 hfs_unlock(VTOC(hfsmp
->hfc_filevp
));
491 hfs_end_transaction(hfsmp
);
494 if (hfsmp
->hfc_filevp
) {
495 (void) hfc_btree_close(hfsmp
, hfsmp
->hfc_filevp
);
496 hfsmp
->hfc_filevp
= NULL
;
499 FREE(hotdata
, M_TEMP
);
500 hfsmp
->hfc_recdata
= NULL
;
502 hfsmp
->hfc_stage
= HFC_DISABLED
;
503 wakeup((caddr_t
)&hfsmp
->hfc_stage
);
505 lck_mtx_unlock(&hfsmp
->hfc_mutex
);
514 hfs_recording_init(struct hfsmount
*hfsmp
)
517 CatalogRecord
* datap
;
519 HFSPlusCatalogFile
*filep
;
520 BTScanState scanstate
;
521 BTreeIterator
* iterator
= NULL
;
522 FSBufferDescriptor record
;
524 filefork_t
* filefork
;
526 struct cat_attr cattr
;
530 int inserted
= 0; /* debug variables */
534 * For now, only the boot volume is supported.
536 if ((vfs_flags(HFSTOVFS(hfsmp
)) & MNT_ROOTFS
) == 0) {
537 hfsmp
->hfc_stage
= HFC_DISABLED
;
542 * Tracking of hot files requires up-to-date access times.
543 * So if access time updates are disabled, then we disable
546 if (vfs_flags(HFSTOVFS(hfsmp
)) & MNT_NOATIME
) {
547 hfsmp
->hfc_stage
= HFC_DISABLED
;
552 * If the Hot File btree exists then metadata zone is ready.
554 cnid
= GetFileInfo(HFSTOVCB(hfsmp
), kRootDirID
, HFC_FILENAME
, &cattr
, NULL
);
555 if (cnid
!= 0 && S_ISREG(cattr
.ca_mode
)) {
556 if (hfsmp
->hfc_stage
== HFC_DISABLED
)
557 hfsmp
->hfc_stage
= HFC_IDLE
;
561 if (hfs_start_transaction(hfsmp
) != 0) {
565 error
= hfc_btree_create(hfsmp
, HFSTOVCB(hfsmp
)->blockSize
, HFC_DEFAULT_FILE_COUNT
);
568 printf("hfs: Error %d creating hot file b-tree on %s \n", error
, hfsmp
->vcbVN
);
573 * Open the Hot File B-tree file for writing.
575 if (hfsmp
->hfc_filevp
)
576 panic("hfs_recording_init: hfc_filevp exists (vp = %p)", hfsmp
->hfc_filevp
);
577 error
= hfc_btree_open(hfsmp
, &hfsmp
->hfc_filevp
);
580 printf("hfs: Error %d opening hot file b-tree on %s \n", error
, hfsmp
->vcbVN
);
584 MALLOC(iterator
, BTreeIterator
*, sizeof(*iterator
), M_TEMP
, M_WAITOK
);
585 if (iterator
== NULL
) {
587 (void) hfc_btree_close(hfsmp
, hfsmp
->hfc_filevp
);
588 hfsmp
->hfc_filevp
= NULL
;
591 bzero(iterator
, sizeof(*iterator
));
592 key
= (HotFileKey
*) &iterator
->key
;
593 key
->keyLength
= HFC_KEYLENGTH
;
595 record
.bufferAddress
= &data
;
596 record
.itemSize
= sizeof(u_int32_t
);
597 record
.itemCount
= 1;
599 printf("hfs: Evaluating space for \"%s\" metadata zone...\n", HFSTOVCB(hfsmp
)->vcbVN
);
602 * Get ready to scan the Catalog file.
604 error
= BTScanInitialize(VTOF(HFSTOVCB(hfsmp
)->catalogRefNum
), 0, 0, 0,
605 kCatSearchBufferSize
, &scanstate
);
607 printf("hfs_recording_init: err %d BTScanInit\n", error
);
612 * The writes to Hot File B-tree file are journaled.
614 if (hfs_start_transaction(hfsmp
) != 0) {
618 if (hfs_lock(VTOC(hfsmp
->hfc_filevp
), HFS_EXCLUSIVE_LOCK
) != 0) {
622 filefork
= VTOF(hfsmp
->hfc_filevp
);
625 * Visit all the catalog btree leaf records.
628 error
= BTScanNextRecord(&scanstate
, 0, (void **)&keyp
, (void **)&datap
, &dataSize
);
630 if (error
== btNotFound
)
633 printf("hfs_recording_init: err %d BTScanNext\n", error
);
636 if ((datap
->recordType
!= kHFSPlusFileRecord
) ||
637 (dataSize
!= sizeof(HFSPlusCatalogFile
))) {
640 filep
= (HFSPlusCatalogFile
*)datap
;
642 if (filep
->dataFork
.totalBlocks
== 0) {
646 * Any file that has blocks inside the hot file
647 * space is recorded for later eviction.
649 * For now, resource forks are ignored.
651 if (!hotextents(hfsmp
, &filep
->dataFork
.extents
[0])) {
654 cnid
= filep
->fileID
;
656 /* Skip over journal files. */
657 if (cnid
== hfsmp
->hfs_jnlfileid
|| cnid
== hfsmp
->hfs_jnlinfoblkid
) {
661 * XXX - need to skip quota files as well.
664 /* Insert a hot file entry. */
665 key
->keyLength
= HFC_KEYLENGTH
;
666 key
->temperature
= HFC_MINIMUM_TEMPERATURE
;
670 error
= BTInsertRecord(filefork
, iterator
, &record
, record
.itemSize
);
672 printf("hfs_recording_init: BTInsertRecord failed %d (fileid %d)\n", error
, key
->fileID
);
673 error
= MacToVFSError(error
);
677 /* Insert the corresponding thread record. */
678 key
->keyLength
= HFC_KEYLENGTH
;
679 key
->temperature
= HFC_LOOKUPTAG
;
682 data
= HFC_MINIMUM_TEMPERATURE
;
683 error
= BTInsertRecord(filefork
, iterator
, &record
, record
.itemSize
);
685 printf("hfs_recording_init: BTInsertRecord failed %d (fileid %d)\n", error
, key
->fileID
);
686 error
= MacToVFSError(error
);
691 (void) BTFlushPath(filefork
);
692 hfs_unlock(VTOC(hfsmp
->hfc_filevp
));
695 hfs_end_transaction(hfsmp
);
697 printf("hfs: %d files identified out of %d\n", inserted
, filecount
);
701 (void) BTScanTerminate(&scanstate
, &data
, &data
, &data
);
703 hfs_end_transaction(hfsmp
);
705 FREE(iterator
, M_TEMP
);
706 if (hfsmp
->hfc_filevp
) {
707 (void) hfc_btree_close(hfsmp
, hfsmp
->hfc_filevp
);
708 hfsmp
->hfc_filevp
= NULL
;
711 hfsmp
->hfc_stage
= HFC_IDLE
;
717 * Use sync to perform ocassional background work.
720 hfs_hotfilesync(struct hfsmount
*hfsmp
, vfs_context_t ctx
)
722 if (hfsmp
->hfc_stage
) {
725 lck_mtx_lock(&hfsmp
->hfc_mutex
);
727 switch (hfsmp
->hfc_stage
) {
729 (void) hfs_recording_start(hfsmp
);
734 if (tv
.tv_sec
> hfsmp
->hfc_timeout
)
735 (void) hfs_recording_stop(hfsmp
);
739 (void) hotfiles_evict(hfsmp
, ctx
);
743 (void) hotfiles_adopt(hfsmp
);
749 lck_mtx_unlock(&hfsmp
->hfc_mutex
);
755 * Add a hot file to the recording list.
757 * This can happen when a hot file gets reclaimed or at the
758 * end of the recording period for any active hot file.
760 * NOTE: Since both the data and resource fork can be hot,
761 * there can be two entries for the same file id.
763 * Note: the cnode is locked on entry.
766 hfs_addhotfile(struct vnode
*vp
)
772 if (hfsmp
->hfc_stage
!= HFC_RECORDING
)
775 lck_mtx_lock(&hfsmp
->hfc_mutex
);
776 error
= hfs_addhotfile_internal(vp
);
777 lck_mtx_unlock(&hfsmp
->hfc_mutex
);
782 hfs_addhotfile_internal(struct vnode
*vp
)
784 hotfile_data_t
*hotdata
;
785 hotfile_entry_t
*entry
;
789 u_int32_t temperature
;
792 if (hfsmp
->hfc_stage
!= HFC_RECORDING
)
795 if ((!vnode_isreg(vp
) && !vnode_islnk(vp
)) || vnode_issystem(vp
)) {
798 /* Skip resource forks for now. */
799 if (VNODE_IS_RSRC(vp
)) {
802 if ((hotdata
= (hotfile_data_t
*)hfsmp
->hfc_recdata
) == NULL
) {
808 if ((ffp
->ff_bytesread
== 0) ||
809 (ffp
->ff_blocks
== 0) ||
810 (ffp
->ff_size
== 0) ||
811 (ffp
->ff_blocks
> hotdata
->maxblocks
) ||
812 (cp
->c_flag
& (C_DELETED
| C_NOEXISTS
)) ||
813 (cp
->c_bsdflags
& UF_NODUMP
) ||
814 (cp
->c_atime
< hfsmp
->hfc_timebase
)) {
818 temperature
= ffp
->ff_bytesread
/ ffp
->ff_size
;
819 if (temperature
< hotdata
->threshold
) {
823 * If there is room or this file is hotter than
824 * the coldest one then add it to the list.
827 if ((hotdata
->activefiles
< hfsmp
->hfc_maxfiles
) ||
828 (hotdata
->coldest
== NULL
) ||
829 (temperature
> hotdata
->coldest
->temperature
)) {
831 entry
= hf_getnewentry(hotdata
);
832 entry
->temperature
= temperature
;
833 entry
->fileid
= cp
->c_fileid
;
834 entry
->blocks
= ffp
->ff_blocks
;
835 hf_insert(hotdata
, entry
);
843 * Remove a hot file from the recording list.
845 * This can happen when a hot file becomes
846 * an active vnode (active hot files are
847 * not kept in the recording list until the
848 * end of the recording period).
850 * Note: the cnode is locked on entry.
853 hfs_removehotfile(struct vnode
*vp
)
855 hotfile_data_t
*hotdata
;
859 u_int32_t temperature
;
862 if (hfsmp
->hfc_stage
!= HFC_RECORDING
)
865 if ((!vnode_isreg(vp
) && !vnode_islnk(vp
)) || vnode_issystem(vp
)) {
872 if ((ffp
->ff_bytesread
== 0) || (ffp
->ff_blocks
== 0) ||
873 (ffp
->ff_size
== 0) || (cp
->c_atime
< hfsmp
->hfc_timebase
)) {
877 lck_mtx_lock(&hfsmp
->hfc_mutex
);
878 if (hfsmp
->hfc_stage
!= HFC_RECORDING
)
880 if ((hotdata
= (hotfile_data_t
*)hfsmp
->hfc_recdata
) == NULL
)
883 temperature
= ffp
->ff_bytesread
/ ffp
->ff_size
;
884 if (temperature
< hotdata
->threshold
)
887 if (hotdata
->coldest
&& (temperature
>= hotdata
->coldest
->temperature
)) {
889 hf_delete(hotdata
, VTOC(vp
)->c_fileid
, temperature
);
893 lck_mtx_unlock(&hfsmp
->hfc_mutex
);
899 *========================================================================
900 * HOT FILE MAINTENANCE ROUTINES
901 *========================================================================
905 hotfiles_collect_callback(struct vnode
*vp
, __unused
void *cargs
)
907 if ((vnode_isreg(vp
) || vnode_islnk(vp
)) && !vnode_issystem(vp
))
908 (void) hfs_addhotfile_internal(vp
);
910 return (VNODE_RETURNED
);
914 * Add all active hot files to the recording list.
917 hotfiles_collect(struct hfsmount
*hfsmp
)
919 struct mount
*mp
= HFSTOVFS(hfsmp
);
921 if (vfs_busy(mp
, LK_NOWAIT
))
925 * hotfiles_collect_callback will be called for each vnode
926 * hung off of this mount point
928 * properly referenced and unreferenced around the callback
930 vnode_iterate(mp
, 0, hotfiles_collect_callback
, (void *)NULL
);
939 * Update the data of a btree record
940 * This is called from within BTUpdateRecord.
943 update_callback(const HotFileKey
*key
, u_int32_t
*data
, u_int32_t
*state
)
945 if (key
->temperature
== HFC_LOOKUPTAG
)
951 * Identify files already in hot area.
954 hotfiles_refine(struct hfsmount
*hfsmp
)
956 BTreeIterator
* iterator
= NULL
;
958 filefork_t
* filefork
;
959 hotfilelist_t
*listp
;
960 FSBufferDescriptor record
;
967 if ((listp
= (hotfilelist_t
*)hfsmp
->hfc_recdata
) == NULL
)
970 mp
= HFSTOVFS(hfsmp
);
972 MALLOC(iterator
, BTreeIterator
*, sizeof(*iterator
), M_TEMP
, M_WAITOK
);
973 if (iterator
== NULL
) {
977 bzero(iterator
, sizeof(*iterator
));
978 key
= (HotFileKey
*) &iterator
->key
;
980 record
.bufferAddress
= &data
;
981 record
.itemSize
= sizeof(u_int32_t
);
982 record
.itemCount
= 1;
984 if (hfs_start_transaction(hfsmp
) != 0) {
988 if (hfs_lock(VTOC(hfsmp
->hfc_filevp
), HFS_EXCLUSIVE_LOCK
) != 0) {
992 filefork
= VTOF(hfsmp
->hfc_filevp
);
994 for (i
= 0; i
< listp
->hfl_count
; ++i
) {
996 * Check if entry (thread) is already in hot area.
998 key
->keyLength
= HFC_KEYLENGTH
;
999 key
->temperature
= HFC_LOOKUPTAG
;
1000 key
->fileID
= listp
->hfl_hotfile
[i
].hf_fileid
;
1002 (void) BTInvalidateHint(iterator
);
1003 if (BTSearchRecord(filefork
, iterator
, &record
, NULL
, iterator
) != 0) {
1004 continue; /* not in hot area, so skip */
1008 * Update thread entry with latest temperature.
1010 error
= BTUpdateRecord(filefork
, iterator
,
1011 (IterateCallBackProcPtr
)update_callback
,
1012 &listp
->hfl_hotfile
[i
].hf_temperature
);
1014 printf("hfs: hotfiles_refine: BTUpdateRecord failed %d (file %d)\n", error
, key
->fileID
);
1015 error
= MacToVFSError(error
);
1019 * Re-key entry with latest temperature.
1021 key
->keyLength
= HFC_KEYLENGTH
;
1022 key
->temperature
= data
;
1023 key
->fileID
= listp
->hfl_hotfile
[i
].hf_fileid
;
1025 /* Pick up record data. */
1026 (void) BTInvalidateHint(iterator
);
1027 (void) BTSearchRecord(filefork
, iterator
, &record
, NULL
, iterator
);
1028 error
= BTDeleteRecord(filefork
, iterator
);
1030 printf("hfs: hotfiles_refine: BTDeleteRecord failed %d (file %d)\n", error
, key
->fileID
);
1031 error
= MacToVFSError(error
);
1034 key
->keyLength
= HFC_KEYLENGTH
;
1035 key
->temperature
= listp
->hfl_hotfile
[i
].hf_temperature
;
1036 key
->fileID
= listp
->hfl_hotfile
[i
].hf_fileid
;
1038 error
= BTInsertRecord(filefork
, iterator
, &record
, record
.itemSize
);
1040 printf("hfs: hotfiles_refine: BTInsertRecord failed %d (file %d)\n", error
, key
->fileID
);
1041 error
= MacToVFSError(error
);
1046 * Invalidate this entry in the list.
1048 listp
->hfl_hotfile
[i
].hf_temperature
= 0;
1049 listp
->hfl_totalblocks
-= listp
->hfl_hotfile
[i
].hf_blocks
;
1053 (void) BTFlushPath(filefork
);
1054 hfs_unlock(VTOC(hfsmp
->hfc_filevp
));
1057 hfs_end_transaction(hfsmp
);
1060 FREE(iterator
, M_TEMP
);
1065 * Move new hot files into hot area.
1067 * Requires that the hfc_mutex be held.
1070 hotfiles_adopt(struct hfsmount
*hfsmp
)
1072 BTreeIterator
* iterator
= NULL
;
1074 filefork_t
* filefork
;
1075 hotfilelist_t
*listp
;
1076 FSBufferDescriptor record
;
1079 enum hfc_stage stage
;
1085 int startedtrans
= 0;
1087 if ((listp
= (hotfilelist_t
*)hfsmp
->hfc_recdata
) == NULL
)
1090 if (hfsmp
->hfc_stage
!= HFC_ADOPTION
) {
1093 if (hfs_lock(VTOC(hfsmp
->hfc_filevp
), HFS_EXCLUSIVE_LOCK
) != 0) {
1097 MALLOC(iterator
, BTreeIterator
*, sizeof(*iterator
), M_TEMP
, M_WAITOK
);
1098 if (iterator
== NULL
) {
1099 hfs_unlock(VTOC(hfsmp
->hfc_filevp
));
1103 stage
= hfsmp
->hfc_stage
;
1104 hfsmp
->hfc_stage
= HFC_BUSY
;
1107 last
= listp
->hfl_next
+ HFC_FILESPERSYNC
;
1108 if (last
> listp
->hfl_count
)
1109 last
= listp
->hfl_count
;
1111 bzero(iterator
, sizeof(*iterator
));
1112 key
= (HotFileKey
*) &iterator
->key
;
1113 key
->keyLength
= HFC_KEYLENGTH
;
1115 record
.bufferAddress
= &data
;
1116 record
.itemSize
= sizeof(u_int32_t
);
1117 record
.itemCount
= 1;
1119 filefork
= VTOF(hfsmp
->hfc_filevp
);
1121 for (i
= listp
->hfl_next
; (i
< last
) && (blksmoved
< HFC_BLKSPERSYNC
); ++i
) {
1123 * Skip invalid entries (already in hot area).
1125 if (listp
->hfl_hotfile
[i
].hf_temperature
== 0) {
1130 * Acquire a vnode for this file.
1132 error
= hfs_vget(hfsmp
, listp
->hfl_hotfile
[i
].hf_fileid
, &vp
, 0, 0);
1134 if (error
== ENOENT
) {
1137 continue; /* stale entry, go to next */
1141 if (!vnode_isreg(vp
) && !vnode_islnk(vp
)) {
1142 printf("hfs: hotfiles_adopt: huh, not a file %d (%d)\n", listp
->hfl_hotfile
[i
].hf_fileid
, VTOC(vp
)->c_cnid
);
1143 hfs_unlock(VTOC(vp
));
1145 listp
->hfl_hotfile
[i
].hf_temperature
= 0;
1147 continue; /* stale entry, go to next */
1149 if (hotextents(hfsmp
, &VTOF(vp
)->ff_extents
[0])) {
1150 hfs_unlock(VTOC(vp
));
1152 listp
->hfl_hotfile
[i
].hf_temperature
= 0;
1154 listp
->hfl_totalblocks
-= listp
->hfl_hotfile
[i
].hf_blocks
;
1155 continue; /* stale entry, go to next */
1157 fileblocks
= VTOF(vp
)->ff_blocks
;
1158 if (fileblocks
> hfsmp
->hfs_hotfile_freeblks
) {
1159 hfs_unlock(VTOC(vp
));
1162 listp
->hfl_totalblocks
-= fileblocks
;
1163 continue; /* entry too big, go to next */
1166 if ((blksmoved
> 0) &&
1167 (blksmoved
+ fileblocks
) > HFC_BLKSPERSYNC
) {
1168 hfs_unlock(VTOC(vp
));
1170 break; /* adopt this entry the next time around */
1172 if (VTOC(vp
)->c_desc
.cd_nameptr
)
1173 data
= *(const u_int32_t
*)(VTOC(vp
)->c_desc
.cd_nameptr
);
1177 error
= hfs_relocate(vp
, hfsmp
->hfs_hotfile_start
, kauth_cred_get(), current_proc());
1178 hfs_unlock(VTOC(vp
));
1181 /* Move on to next item. */
1185 /* Keep hot file free space current. */
1186 hfsmp
->hfs_hotfile_freeblks
-= fileblocks
;
1187 listp
->hfl_totalblocks
-= fileblocks
;
1189 /* Insert hot file entry */
1190 key
->keyLength
= HFC_KEYLENGTH
;
1191 key
->temperature
= listp
->hfl_hotfile
[i
].hf_temperature
;
1192 key
->fileID
= listp
->hfl_hotfile
[i
].hf_fileid
;
1195 /* Start a new transaction before calling BTree code. */
1196 if (hfs_start_transaction(hfsmp
) != 0) {
1202 error
= BTInsertRecord(filefork
, iterator
, &record
, record
.itemSize
);
1204 printf("hfs: hotfiles_adopt: BTInsertRecord failed %d (fileid %d)\n", error
, key
->fileID
);
1205 error
= MacToVFSError(error
);
1210 /* Insert thread record */
1211 key
->keyLength
= HFC_KEYLENGTH
;
1212 key
->temperature
= HFC_LOOKUPTAG
;
1213 key
->fileID
= listp
->hfl_hotfile
[i
].hf_fileid
;
1215 data
= listp
->hfl_hotfile
[i
].hf_temperature
;
1216 error
= BTInsertRecord(filefork
, iterator
, &record
, record
.itemSize
);
1218 printf("hfs: hotfiles_adopt: BTInsertRecord failed %d (fileid %d)\n", error
, key
->fileID
);
1219 error
= MacToVFSError(error
);
1223 (void) BTFlushPath(filefork
);
1225 /* Transaction complete. */
1227 hfs_end_transaction(hfsmp
);
1231 blksmoved
+= fileblocks
;
1233 if (listp
->hfl_next
>= listp
->hfl_count
) {
1236 if (hfsmp
->hfs_hotfile_freeblks
<= 0) {
1238 printf("hfs: hotfiles_adopt: free space exhausted (%d)\n", hfsmp
->hfs_hotfile_freeblks
);
1245 printf("hfs: hotfiles_adopt: [%d] adopted %d blocks (%d left)\n", listp
->hfl_next
, blksmoved
, listp
->hfl_totalblocks
);
1247 /* Finish any outstanding transactions. */
1249 (void) BTFlushPath(filefork
);
1250 hfs_end_transaction(hfsmp
);
1253 hfs_unlock(VTOC(hfsmp
->hfc_filevp
));
1255 if ((listp
->hfl_next
>= listp
->hfl_count
) || (hfsmp
->hfs_hotfile_freeblks
<= 0)) {
1257 printf("hfs: hotfiles_adopt: all done relocating %d files\n", listp
->hfl_count
);
1258 printf("hfs: hotfiles_adopt: %d blocks free in hot file band\n", hfsmp
->hfs_hotfile_freeblks
);
1262 FREE(iterator
, M_TEMP
);
1264 if (stage
!= HFC_ADOPTION
&& hfsmp
->hfc_filevp
) {
1265 (void) hfc_btree_close(hfsmp
, hfsmp
->hfc_filevp
);
1266 hfsmp
->hfc_filevp
= NULL
;
1268 hfsmp
->hfc_stage
= stage
;
1269 wakeup((caddr_t
)&hfsmp
->hfc_stage
);
1274 * Reclaim space by evicting the coldest files.
1276 * Requires that the hfc_mutex be held.
1279 hotfiles_evict(struct hfsmount
*hfsmp
, vfs_context_t ctx
)
1281 BTreeIterator
* iterator
= NULL
;
1284 filefork_t
* filefork
;
1285 hotfilelist_t
*listp
;
1286 enum hfc_stage stage
;
1287 u_int32_t savedtemp
;
1292 int startedtrans
= 0;
1295 if (hfsmp
->hfc_stage
!= HFC_EVICTION
) {
1299 if ((listp
= (hotfilelist_t
*)hfsmp
->hfc_recdata
) == NULL
)
1302 if (hfs_lock(VTOC(hfsmp
->hfc_filevp
), HFS_EXCLUSIVE_LOCK
) != 0) {
1306 MALLOC(iterator
, BTreeIterator
*, sizeof(*iterator
), M_TEMP
, M_WAITOK
);
1307 if (iterator
== NULL
) {
1308 hfs_unlock(VTOC(hfsmp
->hfc_filevp
));
1312 stage
= hfsmp
->hfc_stage
;
1313 hfsmp
->hfc_stage
= HFC_BUSY
;
1315 filesmoved
= blksmoved
= 0;
1316 bt_op
= kBTreeFirstRecord
;
1318 bzero(iterator
, sizeof(*iterator
));
1319 key
= (HotFileKey
*) &iterator
->key
;
1321 filefork
= VTOF(hfsmp
->hfc_filevp
);
1323 while (listp
->hfl_reclaimblks
> 0 &&
1324 blksmoved
< HFC_BLKSPERSYNC
&&
1325 filesmoved
< HFC_FILESPERSYNC
) {
1328 * Obtain the first record (ie the coldest one).
1330 if (BTIterateRecord(filefork
, bt_op
, iterator
, NULL
, NULL
) != 0) {
1332 printf("hfs: hotfiles_evict: no more records\n");
1335 stage
= HFC_ADOPTION
;
1338 if (key
->keyLength
!= HFC_KEYLENGTH
) {
1339 printf("hfs: hotfiles_evict: invalid key length %d\n", key
->keyLength
);
1343 if (key
->temperature
== HFC_LOOKUPTAG
) {
1345 printf("hfs: hotfiles_evict: ran into thread records\n");
1348 stage
= HFC_ADOPTION
;
1352 * Aquire the vnode for this file.
1354 error
= hfs_vget(hfsmp
, key
->fileID
, &vp
, 0, 0);
1356 if (error
== ENOENT
) {
1357 goto delete; /* stale entry, go to next */
1359 printf("hfs: hotfiles_evict: err %d getting file %d\n",
1360 error
, key
->fileID
);
1364 if (!vnode_isreg(vp
) && !vnode_islnk(vp
)) {
1365 printf("hfs: hotfiles_evict: huh, not a file %d\n", key
->fileID
);
1366 hfs_unlock(VTOC(vp
));
1368 goto delete; /* invalid entry, go to next */
1370 fileblocks
= VTOF(vp
)->ff_blocks
;
1371 if ((blksmoved
> 0) &&
1372 (blksmoved
+ fileblocks
) > HFC_BLKSPERSYNC
) {
1373 hfs_unlock(VTOC(vp
));
1378 * Make sure file is in the hot area.
1380 if (!hotextents(hfsmp
, &VTOF(vp
)->ff_extents
[0])) {
1382 printf("hfs: hotfiles_evict: file %d isn't hot!\n", key
->fileID
);
1384 hfs_unlock(VTOC(vp
));
1386 goto delete; /* stale entry, go to next */
1390 * Relocate file out of hot area.
1392 error
= hfs_relocate(vp
, HFSTOVCB(hfsmp
)->nextAllocation
, vfs_context_ucred(ctx
), vfs_context_proc(ctx
));
1394 printf("hfs: hotfiles_evict: err %d relocating file %d\n", error
, key
->fileID
);
1395 hfs_unlock(VTOC(vp
));
1397 bt_op
= kBTreeNextRecord
;
1398 goto next
; /* go to next */
1402 // We do not believe that this call to hfs_fsync() is
1403 // necessary and it causes a journal transaction
1404 // deadlock so we are removing it.
1406 // (void) hfs_fsync(vp, MNT_WAIT, 0, p);
1408 hfs_unlock(VTOC(vp
));
1411 hfsmp
->hfs_hotfile_freeblks
+= fileblocks
;
1412 listp
->hfl_reclaimblks
-= fileblocks
;
1413 if (listp
->hfl_reclaimblks
< 0)
1414 listp
->hfl_reclaimblks
= 0;
1415 blksmoved
+= fileblocks
;
1418 /* Start a new transaction before calling BTree code. */
1419 if (hfs_start_transaction(hfsmp
) != 0) {
1425 error
= BTDeleteRecord(filefork
, iterator
);
1427 error
= MacToVFSError(error
);
1430 savedtemp
= key
->temperature
;
1431 key
->temperature
= HFC_LOOKUPTAG
;
1432 error
= BTDeleteRecord(filefork
, iterator
);
1434 error
= MacToVFSError(error
);
1437 key
->temperature
= savedtemp
;
1439 (void) BTFlushPath(filefork
);
1441 /* Transaction complete. */
1443 hfs_end_transaction(hfsmp
);
1450 printf("hfs: hotfiles_evict: moved %d files (%d blks, %d to go)\n", filesmoved
, blksmoved
, listp
->hfl_reclaimblks
);
1452 /* Finish any outstanding transactions. */
1454 (void) BTFlushPath(filefork
);
1455 hfs_end_transaction(hfsmp
);
1458 hfs_unlock(VTOC(hfsmp
->hfc_filevp
));
1461 * Move to next stage when finished.
1463 if (listp
->hfl_reclaimblks
<= 0) {
1464 stage
= HFC_ADOPTION
;
1466 printf("hfs: hotfiles_evict: %d blocks free in hot file band\n", hfsmp
->hfs_hotfile_freeblks
);
1469 FREE(iterator
, M_TEMP
);
1470 hfsmp
->hfc_stage
= stage
;
1471 wakeup((caddr_t
)&hfsmp
->hfc_stage
);
1476 * Age the existing records in the hot files b-tree.
1479 hotfiles_age(struct hfsmount
*hfsmp
)
1481 BTreeInfoRec btinfo
;
1482 BTreeIterator
* iterator
= NULL
;
1483 BTreeIterator
* prev_iterator
;
1484 FSBufferDescriptor record
;
1485 FSBufferDescriptor prev_record
;
1487 HotFileKey
* prev_key
;
1488 filefork_t
* filefork
;
1490 u_int32_t prev_data
;
1499 MALLOC(iterator
, BTreeIterator
*, 2 * sizeof(*iterator
), M_TEMP
, M_WAITOK
);
1500 if (iterator
== NULL
) {
1504 bzero(iterator
, 2 * sizeof(*iterator
));
1505 key
= (HotFileKey
*) &iterator
->key
;
1507 prev_iterator
= &iterator
[1];
1508 prev_key
= (HotFileKey
*) &prev_iterator
->key
;
1510 record
.bufferAddress
= &data
;
1511 record
.itemSize
= sizeof(data
);
1512 record
.itemCount
= 1;
1513 prev_record
.bufferAddress
= &prev_data
;
1514 prev_record
.itemSize
= sizeof(prev_data
);
1515 prev_record
.itemCount
= 1;
1518 * Capture b-tree changes inside a transaction
1520 if (hfs_start_transaction(hfsmp
) != 0) {
1524 if (hfs_lock(VTOC(hfsmp
->hfc_filevp
), HFS_EXCLUSIVE_LOCK
) != 0) {
1528 filefork
= VTOF(hfsmp
->hfc_filevp
);
1530 error
= BTGetInformation(filefork
, 0, &btinfo
);
1532 error
= MacToVFSError(error
);
1535 if (btinfo
.numRecords
< 2) {
1540 /* Only want 1st half of leaf records */
1541 numrecs
= (btinfo
.numRecords
/= 2) - 1;
1543 error
= BTIterateRecord(filefork
, kBTreeFirstRecord
, iterator
, &record
, &reclen
);
1545 printf("hfs_agehotfiles: BTIterateRecord: %d\n", error
);
1546 error
= MacToVFSError(error
);
1549 bcopy(iterator
, prev_iterator
, sizeof(BTreeIterator
));
1552 for (i
= 0; i
< numrecs
; ++i
) {
1553 error
= BTIterateRecord(filefork
, kBTreeNextRecord
, iterator
, &record
, &reclen
);
1555 if (key
->temperature
< prev_key
->temperature
) {
1556 printf("hfs_agehotfiles: out of order keys!\n");
1560 if (reclen
!= sizeof(data
)) {
1561 printf("hfs_agehotfiles: invalid record length %d\n", reclen
);
1565 if (key
->keyLength
!= HFC_KEYLENGTH
) {
1566 printf("hfs_agehotfiles: invalid key length %d\n", key
->keyLength
);
1570 } else if ((error
== fsBTEndOfIterationErr
|| error
== fsBTRecordNotFoundErr
) &&
1571 (i
== (numrecs
- 1))) {
1574 printf("hfs_agehotfiles: %d of %d BTIterateRecord: %d\n", i
, numrecs
, error
);
1575 error
= MacToVFSError(error
);
1578 if (prev_key
->temperature
== HFC_LOOKUPTAG
) {
1580 printf("hfs_agehotfiles: ran into thread record\n");
1585 error
= BTDeleteRecord(filefork
, prev_iterator
);
1587 printf("hfs_agehotfiles: BTDeleteRecord failed %d (file %d)\n", error
, prev_key
->fileID
);
1588 error
= MacToVFSError(error
);
1592 /* Age by halving the temperature (floor = 4) */
1593 newtemp
= MAX(prev_key
->temperature
>> 1, 4);
1594 prev_key
->temperature
= newtemp
;
1596 error
= BTInsertRecord(filefork
, prev_iterator
, &prev_record
, prev_record
.itemSize
);
1598 printf("hfs_agehotfiles: BTInsertRecord failed %d (file %d)\n", error
, prev_key
->fileID
);
1599 error
= MacToVFSError(error
);
1604 * Update thread entry with latest temperature.
1606 prev_key
->temperature
= HFC_LOOKUPTAG
;
1607 error
= BTUpdateRecord(filefork
, prev_iterator
,
1608 (IterateCallBackProcPtr
)update_callback
,
1611 printf("hfs_agehotfiles: %d of %d BTUpdateRecord failed %d (file %d, %d)\n",
1612 i
, numrecs
, error
, prev_key
->fileID
, newtemp
);
1613 error
= MacToVFSError(error
);
1617 bcopy(iterator
, prev_iterator
, sizeof(BTreeIterator
));
1624 printf("hfs_agehotfiles: aged %d records out of %d\n", aged
, btinfo
.numRecords
);
1626 (void) BTFlushPath(filefork
);
1628 hfs_unlock(VTOC(hfsmp
->hfc_filevp
));
1630 hfs_end_transaction(hfsmp
);
1633 FREE(iterator
, M_TEMP
);
1638 * Return true if any blocks (or all blocks if all is true)
1639 * are contained in the hot file region.
1642 hotextents(struct hfsmount
*hfsmp
, HFSPlusExtentDescriptor
* extents
)
1648 for (i
= 0; i
< kHFSPlusExtentDensity
; ++i
) {
1649 b1
= extents
[i
].startBlock
;
1652 b2
= b1
+ extents
[i
].blockCount
- 1;
1653 if ((b1
>= hfsmp
->hfs_hotfile_start
&&
1654 b2
<= hfsmp
->hfs_hotfile_end
) ||
1655 (b1
< hfsmp
->hfs_hotfile_end
&&
1656 b2
> hfsmp
->hfs_hotfile_end
)) {
1666 *========================================================================
1667 * HOT FILE B-TREE ROUTINES
1668 *========================================================================
1672 * Open the hot files b-tree for writing.
1674 * On successful exit the vnode has a reference but not an iocount.
1677 hfc_btree_open(struct hfsmount
*hfsmp
, struct vnode
**vpp
)
1681 struct cat_desc cdesc
;
1682 struct cat_attr cattr
;
1683 struct cat_fork cfork
;
1684 static char filename
[] = HFC_FILENAME
;
1688 int newvnode_flags
= 0;
1693 bzero(&cdesc
, sizeof(cdesc
));
1694 cdesc
.cd_parentcnid
= kRootDirID
;
1695 cdesc
.cd_nameptr
= (const u_int8_t
*)filename
;
1696 cdesc
.cd_namelen
= strlen(filename
);
1698 lockflags
= hfs_systemfile_lock(hfsmp
, SFL_CATALOG
, HFS_SHARED_LOCK
);
1700 error
= cat_lookup(hfsmp
, &cdesc
, 0, &cdesc
, &cattr
, &cfork
, NULL
);
1702 hfs_systemfile_unlock(hfsmp
, lockflags
);
1705 printf("hfs: hfc_btree_open: cat_lookup error %d\n", error
);
1709 cdesc
.cd_flags
|= CD_ISMETA
;
1710 error
= hfs_getnewvnode(hfsmp
, NULL
, NULL
, &cdesc
, 0, &cattr
,
1711 &cfork
, &vp
, &newvnode_flags
);
1713 printf("hfs: hfc_btree_open: hfs_getnewvnode error %d\n", error
);
1714 cat_releasedesc(&cdesc
);
1717 if (!vnode_issystem(vp
)) {
1719 printf("hfs: hfc_btree_open: file has UBC, try again\n");
1721 hfs_unlock(VTOC(vp
));
1730 /* Open the B-tree file for writing... */
1731 error
= BTOpenPath(VTOF(vp
), (KeyCompareProcPtr
) hfc_comparekeys
);
1733 printf("hfs: hfc_btree_open: BTOpenPath error %d\n", error
);
1734 error
= MacToVFSError(error
);
1737 hfs_unlock(VTOC(vp
));
1740 vnode_ref(vp
); /* keep a reference while its open */
1744 if (!vnode_issystem(vp
))
1745 panic("hfs: hfc_btree_open: not a system file (vp = %p)", vp
);
1751 * Close the hot files b-tree.
1753 * On entry the vnode has a reference.
1756 hfc_btree_close(struct hfsmount
*hfsmp
, struct vnode
*vp
)
1758 proc_t p
= current_proc();
1763 hfs_journal_flush(hfsmp
, FALSE
);
1766 if (vnode_get(vp
) == 0) {
1767 error
= hfs_lock(VTOC(vp
), HFS_EXCLUSIVE_LOCK
);
1769 (void) hfs_fsync(vp
, MNT_WAIT
, 0, p
);
1770 error
= BTClosePath(VTOF(vp
));
1771 hfs_unlock(VTOC(vp
));
1782 * Create a hot files btree file.
1786 hfc_btree_create(struct hfsmount
*hfsmp
, unsigned int nodesize
, unsigned int entries
)
1788 struct vnode
*dvp
= NULL
;
1789 struct vnode
*vp
= NULL
;
1790 struct cnode
*cp
= NULL
;
1791 vfs_context_t ctx
= vfs_context_current();
1792 struct vnode_attr va
;
1793 struct componentname cname
;
1794 static char filename
[] = HFC_FILENAME
;
1797 if (hfsmp
->hfc_filevp
)
1798 panic("hfs: hfc_btree_create: hfc_filevp exists (vp = %p)", hfsmp
->hfc_filevp
);
1800 error
= VFS_ROOT(HFSTOVFS(hfsmp
), &dvp
, ctx
);
1804 cname
.cn_nameiop
= CREATE
;
1805 cname
.cn_flags
= ISLASTCN
;
1806 cname
.cn_context
= ctx
;
1807 cname
.cn_pnbuf
= filename
;
1808 cname
.cn_pnlen
= sizeof(filename
);
1809 cname
.cn_nameptr
= filename
;
1810 cname
.cn_namelen
= strlen(filename
);
1812 cname
.cn_consume
= 0;
1815 VATTR_SET(&va
, va_type
, VREG
);
1816 VATTR_SET(&va
, va_mode
, S_IFREG
| S_IRUSR
| S_IWUSR
);
1817 VATTR_SET(&va
, va_uid
, 0);
1818 VATTR_SET(&va
, va_gid
, 0);
1820 if (hfs_start_transaction(hfsmp
) != 0) {
1825 /* call ourselves directly, ignore the higher-level VFS file creation code */
1826 error
= VNOP_CREATE(dvp
, &vp
, &cname
, &va
, ctx
);
1828 printf("hfs: error %d creating HFBT on %s\n", error
, HFSTOVCB(hfsmp
)->vcbVN
);
1835 if ((error
= hfs_lock(VTOC(vp
), HFS_EXCLUSIVE_LOCK
))) {
1840 /* Don't use non-regular files or files with links. */
1841 if (!vnode_isreg(vp
) || cp
->c_linkcount
!= 1) {
1846 printf("hfs: created HFBT on %s\n", HFSTOVCB(hfsmp
)->vcbVN
);
1848 if (VTOF(vp
)->ff_size
< nodesize
) {
1852 BTNodeDescriptor
*ndp
;
1854 HotFilesInfo
*hotfileinfo
;
1860 * Mark it invisible (truncate will pull these changes).
1862 ((FndrFileInfo
*)&cp
->c_finderinfo
[0])->fdFlags
|=
1863 SWAP_BE16 (kIsInvisible
+ kNameLocked
);
1865 if (kmem_alloc(kernel_map
, (vm_offset_t
*)&buffer
, nodesize
)) {
1869 bzero(buffer
, nodesize
);
1870 index
= (u_int16_t
*)buffer
;
1872 entirespernode
= (nodesize
- sizeof(BTNodeDescriptor
) - 2) /
1873 (sizeof(HotFileKey
) + 6);
1874 nodecnt
= 2 + howmany(entries
* 2, entirespernode
);
1875 nodecnt
= roundup(nodecnt
, 8);
1876 filesize
= nodecnt
* nodesize
;
1878 /* FILL IN THE NODE DESCRIPTOR: */
1879 ndp
= (BTNodeDescriptor
*)buffer
;
1880 ndp
->kind
= kBTHeaderNode
;
1881 ndp
->numRecords
= SWAP_BE16 (3);
1882 offset
= sizeof(BTNodeDescriptor
);
1883 index
[(nodesize
/ 2) - 1] = SWAP_BE16 (offset
);
1885 /* FILL IN THE HEADER RECORD: */
1886 bthp
= (BTHeaderRec
*)((u_int8_t
*)buffer
+ offset
);
1887 bthp
->nodeSize
= SWAP_BE16 (nodesize
);
1888 bthp
->totalNodes
= SWAP_BE32 (filesize
/ nodesize
);
1889 bthp
->freeNodes
= SWAP_BE32 (nodecnt
- 1);
1890 bthp
->clumpSize
= SWAP_BE32 (filesize
);
1891 bthp
->btreeType
= kUserBTreeType
; /* non-metadata */
1892 bthp
->attributes
|= SWAP_BE32 (kBTBigKeysMask
);
1893 bthp
->maxKeyLength
= SWAP_BE16 (HFC_KEYLENGTH
);
1894 offset
+= sizeof(BTHeaderRec
);
1895 index
[(nodesize
/ 2) - 2] = SWAP_BE16 (offset
);
1897 /* FILL IN THE USER RECORD: */
1898 hotfileinfo
= (HotFilesInfo
*)((u_int8_t
*)buffer
+ offset
);
1899 hotfileinfo
->magic
= SWAP_BE32 (HFC_MAGIC
);
1900 hotfileinfo
->version
= SWAP_BE32 (HFC_VERSION
);
1901 hotfileinfo
->duration
= SWAP_BE32 (HFC_DEFAULT_DURATION
);
1902 hotfileinfo
->timebase
= 0;
1903 hotfileinfo
->timeleft
= 0;
1904 hotfileinfo
->threshold
= SWAP_BE32 (HFC_MINIMUM_TEMPERATURE
);
1905 hotfileinfo
->maxfileblks
= SWAP_BE32 (HFC_MAXIMUM_FILESIZE
/ HFSTOVCB(hfsmp
)->blockSize
);
1906 hotfileinfo
->maxfilecnt
= SWAP_BE32 (HFC_DEFAULT_FILE_COUNT
);
1907 strlcpy((char *)hotfileinfo
->tag
, hfc_tag
,
1908 sizeof hotfileinfo
->tag
);
1909 offset
+= kBTreeHeaderUserBytes
;
1910 index
[(nodesize
/ 2) - 3] = SWAP_BE16 (offset
);
1912 /* FILL IN THE MAP RECORD (only one node in use). */
1913 *((u_int8_t
*)buffer
+ offset
) = 0x80;
1914 offset
+= nodesize
- sizeof(BTNodeDescriptor
) - sizeof(BTHeaderRec
)
1915 - kBTreeHeaderUserBytes
- (4 * sizeof(int16_t));
1916 index
[(nodesize
/ 2) - 4] = SWAP_BE16 (offset
);
1918 vnode_setnoflush(vp
);
1919 error
= hfs_truncate(vp
, (off_t
)filesize
, IO_NDELAY
, 0, 0, ctx
);
1921 printf("hfs: error %d growing HFBT on %s\n", error
, HFSTOVCB(hfsmp
)->vcbVN
);
1924 cp
->c_flag
|= C_ZFWANTSYNC
;
1925 cp
->c_zftimeout
= 1;
1928 struct vnop_write_args args
;
1931 auio
= uio_create(1, 0, UIO_SYSSPACE
, UIO_WRITE
);
1932 uio_addiov(auio
, (uintptr_t)buffer
, nodesize
);
1934 args
.a_desc
= &vnop_write_desc
;
1938 args
.a_context
= ctx
;
1943 error
= hfs_vnop_write(&args
);
1945 printf("hfs: error %d writing HFBT on %s\n", error
, HFSTOVCB(hfsmp
)->vcbVN
);
1949 kmem_free(kernel_map
, (vm_offset_t
)buffer
, nodesize
);
1952 hfs_end_transaction(hfsmp
);
1966 * Compare two hot file b-tree keys.
1968 * Result: +n search key > trial key
1969 * 0 search key = trial key
1970 * -n search key < trial key
1973 hfc_comparekeys(HotFileKey
*searchKey
, HotFileKey
*trialKey
)
1976 * Compared temperatures first.
1978 if (searchKey
->temperature
== trialKey
->temperature
) {
1980 * Temperatures are equal so compare file ids.
1982 if (searchKey
->fileID
== trialKey
->fileID
) {
1984 * File ids are equal so compare fork types.
1986 if (searchKey
->forkType
== trialKey
->forkType
) {
1988 } else if (searchKey
->forkType
> trialKey
->forkType
) {
1991 } else if (searchKey
->fileID
> trialKey
->fileID
) {
1994 } else if (searchKey
->temperature
> trialKey
->temperature
) {
2003 *========================================================================
2004 * HOT FILE DATA COLLECTING ROUTINES
2005 *========================================================================
2009 * Lookup a hot file entry in the tree.
2012 static hotfile_entry_t
*
2013 hf_lookup(hotfile_data_t
*hotdata
, u_int32_t fileid
, u_int32_t temperature
)
2015 hotfile_entry_t
*entry
= hotdata
->rootentry
;
2018 entry
->temperature
!= temperature
&&
2019 entry
->fileid
!= fileid
) {
2021 if (temperature
> entry
->temperature
)
2022 entry
= entry
->right
;
2023 else if (temperature
< entry
->temperature
)
2024 entry
= entry
->left
;
2025 else if (fileid
> entry
->fileid
)
2026 entry
= entry
->right
;
2028 entry
= entry
->left
;
2035 * Insert a hot file entry into the tree.
2038 hf_insert(hotfile_data_t
*hotdata
, hotfile_entry_t
*newentry
)
2040 hotfile_entry_t
*entry
= hotdata
->rootentry
;
2041 u_int32_t fileid
= newentry
->fileid
;
2042 u_int32_t temperature
= newentry
->temperature
;
2044 if (entry
== NULL
) {
2045 hotdata
->rootentry
= newentry
;
2046 hotdata
->coldest
= newentry
;
2047 hotdata
->activefiles
++;
2052 if (temperature
> entry
->temperature
) {
2054 entry
= entry
->right
;
2056 entry
->right
= newentry
;
2059 } else if (temperature
< entry
->temperature
) {
2061 entry
= entry
->left
;
2063 entry
->left
= newentry
;
2066 } else if (fileid
> entry
->fileid
) {
2068 entry
= entry
->right
;
2070 if (entry
->fileid
!= fileid
)
2071 entry
->right
= newentry
;
2076 entry
= entry
->left
;
2078 if (entry
->fileid
!= fileid
)
2079 entry
->left
= newentry
;
2085 hotdata
->activefiles
++;
2089 * Find the coldest entry in the tree.
2091 static hotfile_entry_t
*
2092 hf_coldest(hotfile_data_t
*hotdata
)
2094 hotfile_entry_t
*entry
= hotdata
->rootentry
;
2098 entry
= entry
->left
;
2104 * Find the hottest entry in the tree.
2106 static hotfile_entry_t
*
2107 hf_hottest(hotfile_data_t
*hotdata
)
2109 hotfile_entry_t
*entry
= hotdata
->rootentry
;
2112 while (entry
->right
)
2113 entry
= entry
->right
;
2119 * Delete a hot file entry from the tree.
2122 hf_delete(hotfile_data_t
*hotdata
, u_int32_t fileid
, u_int32_t temperature
)
2124 hotfile_entry_t
*entry
, *parent
, *next
;
2127 entry
= hotdata
->rootentry
;
2130 entry
->temperature
!= temperature
&&
2131 entry
->fileid
!= fileid
) {
2134 if (temperature
> entry
->temperature
)
2135 entry
= entry
->right
;
2136 else if (temperature
< entry
->temperature
)
2137 entry
= entry
->left
;
2138 else if (fileid
> entry
->fileid
)
2139 entry
= entry
->right
;
2141 entry
= entry
->left
;
2146 * Reorginize the sub-trees spanning from our entry.
2148 if ((next
= entry
->right
)) {
2149 hotfile_entry_t
*pnextl
, *psub
;
2151 * Tree pruning: take the left branch of the
2152 * current entry and place it at the lowest
2153 * left branch of the current right branch
2157 /* Walk the Right/Left sub tree from current entry */
2158 while ((pnextl
= psub
->left
))
2161 /* Plug the old left tree to the new ->Right leftmost entry */
2162 psub
->left
= entry
->left
;
2164 } else /* only left sub-tree, simple case */ {
2168 * Now, plug the current entry sub tree to
2169 * the good pointer of our parent entry.
2172 hotdata
->rootentry
= next
;
2173 else if (parent
->left
== entry
)
2174 parent
->left
= next
;
2176 parent
->right
= next
;
2178 /* Place entry back on the free-list */
2181 entry
->temperature
= 0;
2183 entry
->right
= hotdata
->freelist
;
2184 hotdata
->freelist
= entry
;
2185 hotdata
->activefiles
--;
2187 if (hotdata
->coldest
== entry
|| hotdata
->coldest
== NULL
) {
2188 hotdata
->coldest
= hf_coldest(hotdata
);
2195 * Get a free hot file entry.
2197 static hotfile_entry_t
*
2198 hf_getnewentry(hotfile_data_t
*hotdata
)
2200 hotfile_entry_t
* entry
;
2203 * When the free list is empty then steal the coldest one
2205 if (hotdata
->freelist
== NULL
) {
2206 entry
= hf_coldest(hotdata
);
2207 hf_delete(hotdata
, entry
->fileid
, entry
->temperature
);
2209 entry
= hotdata
->freelist
;
2210 hotdata
->freelist
= entry
->right
;
2218 * Generate a sorted list of hot files (hottest to coldest).
2220 * As a side effect, every node in the hot file tree will be
2221 * deleted (moved to the free list).
2224 hf_getsortedlist(hotfile_data_t
* hotdata
, hotfilelist_t
*sortedlist
)
2227 hotfile_entry_t
*entry
;
2229 while ((entry
= hf_hottest(hotdata
)) != NULL
) {
2230 sortedlist
->hfl_hotfile
[i
].hf_fileid
= entry
->fileid
;
2231 sortedlist
->hfl_hotfile
[i
].hf_temperature
= entry
->temperature
;
2232 sortedlist
->hfl_hotfile
[i
].hf_blocks
= entry
->blocks
;
2233 sortedlist
->hfl_totalblocks
+= entry
->blocks
;
2236 hf_delete(hotdata
, entry
->fileid
, entry
->temperature
);
2239 sortedlist
->hfl_count
= i
;
2242 printf("hfs: hf_getsortedlist returned %d entries\n", i
);
2249 hf_maxdepth(hotfile_entry_t
* root
, int depth
, int *maxdepth
)
2253 if (depth
> *maxdepth
)
2255 hf_maxdepth(root
->left
, depth
, maxdepth
);
2256 hf_maxdepth(root
->right
, depth
, maxdepth
);
2261 hf_printtree(hotfile_entry_t
* root
)
2264 hf_printtree(root
->left
);
2265 printf("hfs: temperature: % 8d, fileid %d\n", root
->temperature
, root
->fileid
);
2266 hf_printtree(root
->right
);