1 /*
2  * Copyright (c) 2023 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 _VM_COMPRESSOR_ALGORITHMS_INTERNAL_H_
30 #define _VM_COMPRESSOR_ALGORITHMS_INTERNAL_H_
31 
32 #ifdef XNU_KERNEL_PRIVATE
33 #include <vm/vm_compressor_algorithms_xnu.h>
34 
35 int metacompressor(const uint8_t *in, uint8_t *cdst, int32_t outbufsz,
36     uint16_t *codec, void *cscratch, boolean_t *, uint32_t *pop_count_p);
37 bool metadecompressor(const uint8_t *source, uint8_t *dest, uint32_t csize,
38     uint16_t ccodec, void *compressor_dscratch, uint32_t *pop_count_p);
39 
40 typedef enum {
41 	CCWK = 0, // must be 0 or 1
42 	CCLZ4 = 1, //must be 0 or 1
43 	CINVALID = 0xFFFF
44 } vm_compressor_codec_t;
45 
46 typedef enum {
47 	CMODE_WK = 0,
48 	CMODE_LZ4 = 1,
49 	CMODE_HYB = 2,
50 	VM_COMPRESSOR_DEFAULT_CODEC = 3,
51 	CMODE_INVALID = 4
52 } vm_compressor_mode_t;
53 
54 void vm_compressor_algorithm_init(void);
55 int vm_compressor_algorithm(void);
56 
57 #endif /* XNU_KERNEL_PRIVATE */
58 #endif  /* _VM_COMPRESSOR_ALGORITHMS_INTERNAL_H_ */
59