xref: /xnu-11215.61.5/osfmk/vm/vm_compressor_algorithms_internal.h (revision 4f1223e81cd707a65cc109d0b8ad6653699da3c4)
1*4f1223e8SApple OSS Distributions /*
2*4f1223e8SApple OSS Distributions  * Copyright (c) 2023 Apple Inc. All rights reserved.
3*4f1223e8SApple OSS Distributions  *
4*4f1223e8SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*4f1223e8SApple OSS Distributions  *
6*4f1223e8SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*4f1223e8SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*4f1223e8SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*4f1223e8SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*4f1223e8SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*4f1223e8SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*4f1223e8SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*4f1223e8SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*4f1223e8SApple OSS Distributions  *
15*4f1223e8SApple OSS Distributions  * Please obtain a copy of the License at
16*4f1223e8SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*4f1223e8SApple OSS Distributions  *
18*4f1223e8SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*4f1223e8SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*4f1223e8SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*4f1223e8SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*4f1223e8SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*4f1223e8SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*4f1223e8SApple OSS Distributions  * limitations under the License.
25*4f1223e8SApple OSS Distributions  *
26*4f1223e8SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*4f1223e8SApple OSS Distributions  */
28*4f1223e8SApple OSS Distributions 
29*4f1223e8SApple OSS Distributions #ifndef _VM_COMPRESSOR_ALGORITHMS_INTERNAL_H_
30*4f1223e8SApple OSS Distributions #define _VM_COMPRESSOR_ALGORITHMS_INTERNAL_H_
31*4f1223e8SApple OSS Distributions 
32*4f1223e8SApple OSS Distributions #ifdef XNU_KERNEL_PRIVATE
33*4f1223e8SApple OSS Distributions #include <vm/vm_compressor_algorithms_xnu.h>
34*4f1223e8SApple OSS Distributions 
35*4f1223e8SApple OSS Distributions int metacompressor(const uint8_t *in, uint8_t *cdst, int32_t outbufsz,
36*4f1223e8SApple OSS Distributions     uint16_t *codec, void *cscratch, boolean_t *, uint32_t *pop_count_p);
37*4f1223e8SApple OSS Distributions bool metadecompressor(const uint8_t *source, uint8_t *dest, uint32_t csize,
38*4f1223e8SApple OSS Distributions     uint16_t ccodec, void *compressor_dscratch, uint32_t *pop_count_p);
39*4f1223e8SApple OSS Distributions 
40*4f1223e8SApple OSS Distributions typedef enum {
41*4f1223e8SApple OSS Distributions 	CCWK = 0, // must be 0 or 1
42*4f1223e8SApple OSS Distributions 	CCLZ4 = 1, //must be 0 or 1
43*4f1223e8SApple OSS Distributions 	CINVALID = 0xFFFF
44*4f1223e8SApple OSS Distributions } vm_compressor_codec_t;
45*4f1223e8SApple OSS Distributions 
46*4f1223e8SApple OSS Distributions typedef enum {
47*4f1223e8SApple OSS Distributions 	CMODE_WK = 0,
48*4f1223e8SApple OSS Distributions 	CMODE_LZ4 = 1,
49*4f1223e8SApple OSS Distributions 	CMODE_HYB = 2,
50*4f1223e8SApple OSS Distributions 	VM_COMPRESSOR_DEFAULT_CODEC = 3,
51*4f1223e8SApple OSS Distributions 	CMODE_INVALID = 4
52*4f1223e8SApple OSS Distributions } vm_compressor_mode_t;
53*4f1223e8SApple OSS Distributions 
54*4f1223e8SApple OSS Distributions void vm_compressor_algorithm_init(void);
55*4f1223e8SApple OSS Distributions int vm_compressor_algorithm(void);
56*4f1223e8SApple OSS Distributions 
57*4f1223e8SApple OSS Distributions #endif /* XNU_KERNEL_PRIVATE */
58*4f1223e8SApple OSS Distributions #endif  /* _VM_COMPRESSOR_ALGORITHMS_INTERNAL_H_ */
59