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