xref: /xnu-8796.101.5/osfmk/vm/WKdm_new.h (revision aca3beaa3dfbd42498b42c5e5ce20a938e6554e5) !
1*aca3beaaSApple OSS Distributions /*
2*aca3beaaSApple OSS Distributions  * Copyright (c) 2000-2013 Apple Inc. All rights reserved.
3*aca3beaaSApple OSS Distributions  *
4*aca3beaaSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*aca3beaaSApple OSS Distributions  *
6*aca3beaaSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*aca3beaaSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*aca3beaaSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*aca3beaaSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*aca3beaaSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*aca3beaaSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*aca3beaaSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*aca3beaaSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*aca3beaaSApple OSS Distributions  *
15*aca3beaaSApple OSS Distributions  * Please obtain a copy of the License at
16*aca3beaaSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*aca3beaaSApple OSS Distributions  *
18*aca3beaaSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*aca3beaaSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*aca3beaaSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*aca3beaaSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*aca3beaaSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*aca3beaaSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*aca3beaaSApple OSS Distributions  * limitations under the License.
25*aca3beaaSApple OSS Distributions  *
26*aca3beaaSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*aca3beaaSApple OSS Distributions  */
28*aca3beaaSApple OSS Distributions 
29*aca3beaaSApple OSS Distributions /* direct-mapped partial matching compressor with simple 22/10 split
30*aca3beaaSApple OSS Distributions  *
31*aca3beaaSApple OSS Distributions  *  Compresses buffers using a dictionary based match and partial match
32*aca3beaaSApple OSS Distributions  *  (high bits only or full match) scheme.
33*aca3beaaSApple OSS Distributions  *
34*aca3beaaSApple OSS Distributions  *  Paul Wilson -- [email protected]
35*aca3beaaSApple OSS Distributions  *  Scott F. Kaplan -- [email protected]
36*aca3beaaSApple OSS Distributions  *  September 1997
37*aca3beaaSApple OSS Distributions  */
38*aca3beaaSApple OSS Distributions 
39*aca3beaaSApple OSS Distributions /* compressed output format, in memory order
40*aca3beaaSApple OSS Distributions  *  1. a four-word HEADER containing four one-word values:
41*aca3beaaSApple OSS Distributions  *     i.   a one-word code saying what algorithm compressed the data
42*aca3beaaSApple OSS Distributions  *     ii.  an integer WORD offset into the page saying
43*aca3beaaSApple OSS Distributions  *          where the queue position area starts
44*aca3beaaSApple OSS Distributions  *     iii. an integer WORD offset into the page saying where
45*aca3beaaSApple OSS Distributions  *          the low-bits area starts
46*aca3beaaSApple OSS Distributions  *     iv.  an integer WORD offset into the page saying where the
47*aca3beaaSApple OSS Distributions  *          low-bits area ends
48*aca3beaaSApple OSS Distributions  *
49*aca3beaaSApple OSS Distributions  *  2. a 64-word TAGS AREA holding one two-bit tag for each word in
50*aca3beaaSApple OSS Distributions  *     the original (1024-word) page, packed 16 per word
51*aca3beaaSApple OSS Distributions  *
52*aca3beaaSApple OSS Distributions  *  3. a variable-sized FULL WORDS AREA (always word aligned and an
53*aca3beaaSApple OSS Distributions  *     integral number of words) holding full-word patterns that
54*aca3beaaSApple OSS Distributions  *     were not in the dictionary when encoded (i.e., dictionary misses)
55*aca3beaaSApple OSS Distributions  *
56*aca3beaaSApple OSS Distributions  *  4. a variable-sized QUEUE POSITIONS AREA (always word aligned and
57*aca3beaaSApple OSS Distributions  *     an integral number of words) holding four-bit queue positions,
58*aca3beaaSApple OSS Distributions  *     packed eight per word.
59*aca3beaaSApple OSS Distributions  *
60*aca3beaaSApple OSS Distributions  *  5. a variable-sized LOW BITS AREA (always word aligned and an
61*aca3beaaSApple OSS Distributions  *     integral number of words) holding ten-bit low-bit patterns
62*aca3beaaSApple OSS Distributions  *     (from partial matches), packed three per word.
63*aca3beaaSApple OSS Distributions  */
64*aca3beaaSApple OSS Distributions 
65*aca3beaaSApple OSS Distributions #ifdef __cplusplus
66*aca3beaaSApple OSS Distributions extern "C" {
67*aca3beaaSApple OSS Distributions #endif
68*aca3beaaSApple OSS Distributions 
69*aca3beaaSApple OSS Distributions #include <mach/vm_param.h>
70*aca3beaaSApple OSS Distributions 
71*aca3beaaSApple OSS Distributions 
72*aca3beaaSApple OSS Distributions #define WKdm_SCRATCH_BUF_SIZE_INTERNAL  PAGE_SIZE
73*aca3beaaSApple OSS Distributions 
74*aca3beaaSApple OSS Distributions typedef unsigned int WK_word;
75*aca3beaaSApple OSS Distributions 
76*aca3beaaSApple OSS Distributions #if defined(__arm64__)
77*aca3beaaSApple OSS Distributions 
78*aca3beaaSApple OSS Distributions void
79*aca3beaaSApple OSS Distributions WKdm_decompress_4k(const WK_word* src_buf,
80*aca3beaaSApple OSS Distributions     WK_word* dest_buf,
81*aca3beaaSApple OSS Distributions     WK_word* scratch,
82*aca3beaaSApple OSS Distributions     unsigned int bytes);
83*aca3beaaSApple OSS Distributions int
84*aca3beaaSApple OSS Distributions WKdm_compress_4k(const WK_word* src_buf,
85*aca3beaaSApple OSS Distributions     WK_word* dest_buf,
86*aca3beaaSApple OSS Distributions     WK_word* scratch,
87*aca3beaaSApple OSS Distributions     unsigned int limit);
88*aca3beaaSApple OSS Distributions 
89*aca3beaaSApple OSS Distributions void
90*aca3beaaSApple OSS Distributions WKdm_decompress_16k(WK_word* src_buf,
91*aca3beaaSApple OSS Distributions     WK_word* dest_buf,
92*aca3beaaSApple OSS Distributions     WK_word* scratch,
93*aca3beaaSApple OSS Distributions     unsigned int bytes);
94*aca3beaaSApple OSS Distributions int
95*aca3beaaSApple OSS Distributions WKdm_compress_16k(WK_word* src_buf,
96*aca3beaaSApple OSS Distributions     WK_word* dest_buf,
97*aca3beaaSApple OSS Distributions     WK_word* scratch,
98*aca3beaaSApple OSS Distributions     unsigned int limit);
99*aca3beaaSApple OSS Distributions #else
100*aca3beaaSApple OSS Distributions 
101*aca3beaaSApple OSS Distributions void
102*aca3beaaSApple OSS Distributions WKdm_decompress_new(WK_word* src_buf,
103*aca3beaaSApple OSS Distributions     WK_word* dest_buf,
104*aca3beaaSApple OSS Distributions     WK_word* scratch,
105*aca3beaaSApple OSS Distributions     unsigned int bytes);
106*aca3beaaSApple OSS Distributions int
107*aca3beaaSApple OSS Distributions WKdm_compress_new(const WK_word* src_buf,
108*aca3beaaSApple OSS Distributions     WK_word* dest_buf,
109*aca3beaaSApple OSS Distributions     WK_word* scratch,
110*aca3beaaSApple OSS Distributions     unsigned int limit);
111*aca3beaaSApple OSS Distributions #endif
112*aca3beaaSApple OSS Distributions 
113*aca3beaaSApple OSS Distributions #ifdef __cplusplus
114*aca3beaaSApple OSS Distributions } /* extern "C" */
115*aca3beaaSApple OSS Distributions #endif
116