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