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