xref: /xnu-11215.41.3/bsd/vfs/vfs_io_compression_stats.h (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
1 /*
2  * Copyright (c) 2020 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 
29 #ifndef _MISCFS_SPECFS_IO_COMPRESSION_STATS_H_
30 #define _MISCFS_SPECFS_IO_COMPRESSION_STATS_H_
31 
32 #include <sys/buf_internal.h>
33 #include <sys/vnode.h>
34 
35 void io_compression_stats_init(void);
36 void io_compression_stats(buf_t bp);
37 
38 #define IO_COMPRESSION_STATS_DEFAULT_BLOCK_SIZE (4 * 1024)
39 #define IO_COMPRESSION_STATS_MIN_BLOCK_SIZE (4 * 1024)
40 #define IO_COMPRESSION_STATS_MAX_BLOCK_SIZE (1024 * 1024 * 1024)
41 
42 #if IO_COMPRESSION_STATS_DEBUG
43 #define io_compression_stats_dbg(fmt, ...) \
44 	printf("%s: " fmt "\n", __func__, ## __VA_ARGS__)
45 #else
46 #define io_compression_stats_dbg(fmt, ...)
47 #endif
48 
49 /* iocs_store_buffer: Buffer that captures the stats of vnode being reclaimed */
50 struct iocs_store_buffer {
51 	void*                   buffer;
52 	uint32_t                current_position;
53 	uint32_t                marked_point;
54 };
55 
56 #define IOCS_STORE_BUFFER_NUM_SLOTS 10000
57 #define IOCS_STORE_BUFFER_SIZE (IOCS_STORE_BUFFER_NUM_SLOTS * (sizeof(struct iocs_store_buffer_entry)))
58 
59 /* Notify user when the buffer is 80% full */
60 #define IOCS_STORE_BUFFER_NOTIFY_AT ((IOCS_STORE_BUFFER_SIZE * 8) / 10)
61 
62 /* Wait for the buffer to be 10% more full before notifying again */
63 #define IOCS_STORE_BUFFER_NOTIFICATION_INTERVAL (IOCS_STORE_BUFFER_SIZE / 10)
64 
65 #endif
66