[apple/xnu.git] / libkern / mkext.c

/*
 * Copyright (c) 2000-2016 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
#include <stdint.h> // For uintptr_t.
#include <string.h>
#include <libkern/mkext.h>


#define BASE 65521L /* largest prime smaller than 65536 */
#define NMAX 5552  // the largest n such that 255n(n+1)/2 + (n+1)(BASE-1) <= 2^32-1

#define DO1(buf, i)  {s1 += buf[i]; s2 += s1;}
#define DO2(buf, i)  DO1(buf,i); DO1(buf,i+1);
#define DO4(buf, i)  DO2(buf,i); DO2(buf,i+2);
#define DO8(buf, i)  DO4(buf,i); DO4(buf,i+4);
#define DO16(buf)   DO8(buf,0); DO8(buf,8);

u_int32_t
mkext_adler32(uint8_t *buf, int32_t len)
{
	unsigned long s1 = 1; // adler & 0xffff;
	unsigned long s2 = 0; // (adler >> 16) & 0xffff;
	int k;


	while (len > 0) {
		k = len < NMAX ? len : NMAX;
		len -= k;
		while (k >= 16) {
			DO16(buf);
			buf += 16;
			k -= 16;
		}
		if (k != 0) {
			do {
				s1 += *buf++;
				s2 += s1;
			} while (--k);
		}
		s1 %= BASE;
		s2 %= BASE;
	}
	return (u_int32_t)((s2 << 16) | s1);
}


/**************************************************************
*   LZSS.C -- A Data Compression Program
***************************************************************
*    4/6/1989 Haruhiko Okumura
*    Use, distribute, and modify this program freely.
*    Please send me your improved versions.
*        PC-VAN      SCIENCE
*        NIFTY-Serve PAF01022
*        CompuServe  74050,1022
*
**************************************************************/

#define N         4096  /* size of ring buffer - must be power of 2 */
#define F         18    /* upper limit for match_length */
#define THRESHOLD 2     /* encode string into position and length
	                 *  if match_length is greater than this */
#if !KERNEL
#define NIL       N     /* index for root of binary search trees */
#endif

struct encode_state {
	/*
	 * left & right children & parent. These constitute binary search trees.
	 */
	int lchild[N + 1], rchild[N + 257], parent[N + 1];

	/* ring buffer of size N, with extra F-1 bytes to aid string comparison */
	u_int8_t text_buf[N + F - 1];

	/*
	 * match_length of longest match.
	 * These are set by the insert_node() procedure.
	 */
	int match_position, match_length;
};


int
decompress_lzss(u_int8_t *dst, u_int32_t dstlen, u_int8_t *src, u_int32_t srclen)
{
	/* ring buffer of size N, with extra F-1 bytes to aid string comparison */
	u_int8_t text_buf[N + F - 1];
	u_int8_t *dststart = dst;
	u_int8_t *dstend = dst + dstlen;
	u_int8_t *srcend = src + srclen;
	int  i, j, k, r;
	u_int8_t c;
	unsigned int flags;

	dst = dststart;
	srcend = src + srclen;
	for (i = 0; i < N - F; i++) {
		text_buf[i] = ' ';
	}
	r = N - F;
	flags = 0;
	for (;;) {
		if (((flags >>= 1) & 0x100) == 0) {
			if (src < srcend) {
				c = *src++;
			} else {
				break;
			}
			flags = c | 0xFF00; /* uses higher byte cleverly */
		} /* to count eight */
		if (flags & 1) {
			if (src < srcend) {
				c = *src++;
			} else {
				break;
			}
			*dst++ = c;
			if (dst >= dstend) {
				goto finish;
			}
			text_buf[r++] = c;
			r &= (N - 1);
		} else {
			if (src < srcend) {
				i = *src++;
			} else {
				break;
			}
			if (src < srcend) {
				j = *src++;
			} else {
				break;
			}
			i |= ((j & 0xF0) << 4);
			j  =  (j & 0x0F) + THRESHOLD;
			for (k = 0; k <= j; k++) {
				c = text_buf[(i + k) & (N - 1)];
				*dst++ = c;
				if (dst >= dstend) {
					goto finish;
				}
				text_buf[r++] = c;
				r &= (N - 1);
			}
		}
	}
finish:
	return (int)(dst - dststart);
}

#if !KERNEL

/*
 * initialize state, mostly the trees
 *
 * For i = 0 to N - 1, rchild[i] and lchild[i] will be the right and left
 * children of node i.  These nodes need not be initialized.  Also, parent[i]
 * is the parent of node i.  These are initialized to NIL (= N), which stands
 * for 'not used.'  For i = 0 to 255, rchild[N + i + 1] is the root of the
 * tree for strings that begin with character i.  These are initialized to NIL.
 * Note there are 256 trees. */
static void
init_state(struct encode_state *sp)
{
	int  i;

	bzero(sp, sizeof(*sp));

	for (i = 0; i < N - F; i++) {
		sp->text_buf[i] = ' ';
	}
	for (i = N + 1; i <= N + 256; i++) {
		sp->rchild[i] = NIL;
	}
	for (i = 0; i < N; i++) {
		sp->parent[i] = NIL;
	}
}

/*
 * Inserts string of length F, text_buf[r..r+F-1], into one of the trees
 * (text_buf[r]'th tree) and returns the longest-match position and length
 * via the global variables match_position and match_length.
 * If match_length = F, then removes the old node in favor of the new one,
 * because the old one will be deleted sooner. Note r plays double role,
 * as tree node and position in buffer.
 */
static void
insert_node(struct encode_state *sp, int r)
{
	int  i, p, cmp;
	u_int8_t  *key;

	cmp = 1;
	key = &sp->text_buf[r];
	p = N + 1 + key[0];
	sp->rchild[r] = sp->lchild[r] = NIL;
	sp->match_length = 0;
	for (;;) {
		if (cmp >= 0) {
			if (sp->rchild[p] != NIL) {
				p = sp->rchild[p];
			} else {
				sp->rchild[p] = r;
				sp->parent[r] = p;
				return;
			}
		} else {
			if (sp->lchild[p] != NIL) {
				p = sp->lchild[p];
			} else {
				sp->lchild[p] = r;
				sp->parent[r] = p;
				return;
			}
		}
		for (i = 1; i < F; i++) {
			if ((cmp = key[i] - sp->text_buf[p + i]) != 0) {
				break;
			}
		}
		if (i > sp->match_length) {
			sp->match_position = p;
			if ((sp->match_length = i) >= F) {
				break;
			}
		}
	}
	sp->parent[r] = sp->parent[p];
	sp->lchild[r] = sp->lchild[p];
	sp->rchild[r] = sp->rchild[p];
	sp->parent[sp->lchild[p]] = r;
	sp->parent[sp->rchild[p]] = r;
	if (sp->rchild[sp->parent[p]] == p) {
		sp->rchild[sp->parent[p]] = r;
	} else {
		sp->lchild[sp->parent[p]] = r;
	}
	sp->parent[p] = NIL; /* remove p */
}

/* deletes node p from tree */
static void
delete_node(struct encode_state *sp, int p)
{
	int  q;

	if (sp->parent[p] == NIL) {
		return; /* not in tree */
	}
	if (sp->rchild[p] == NIL) {
		q = sp->lchild[p];
	} else if (sp->lchild[p] == NIL) {
		q = sp->rchild[p];
	} else {
		q = sp->lchild[p];
		if (sp->rchild[q] != NIL) {
			do {
				q = sp->rchild[q];
			} while (sp->rchild[q] != NIL);
			sp->rchild[sp->parent[q]] = sp->lchild[q];
			sp->parent[sp->lchild[q]] = sp->parent[q];
			sp->lchild[q] = sp->lchild[p];
			sp->parent[sp->lchild[p]] = q;
		}
		sp->rchild[q] = sp->rchild[p];
		sp->parent[sp->rchild[p]] = q;
	}
	sp->parent[q] = sp->parent[p];
	if (sp->rchild[sp->parent[p]] == p) {
		sp->rchild[sp->parent[p]] = q;
	} else {
		sp->lchild[sp->parent[p]] = q;
	}
	sp->parent[p] = NIL;
}

#endif /* !KERNEL */
Commit	Line	Data
1c79356b	1	/*
39037602	2	* Copyright (c) 2000-2016 Apple Computer, Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
f427ee49	5	*
2d21ac55 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
f427ee49	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
2d21ac55 A	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
f427ee49	17	*
2d21ac55 A	18	* The Original Code and all software distributed under the License are
2d21ac55 A	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
f427ee49	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b	27	*/
b7266188	28	#include <stdint.h> // For uintptr_t.
1c79356b	29	#include <string.h>
b0d623f7	30	#include <libkern/mkext.h>
1c79356b	31
b7266188	32
91447636	33	#define BASE 65521L /* largest prime smaller than 65536 */
b7266188	34	#define NMAX 5552 // the largest n such that 255n(n+1)/2 + (n+1)(BASE-1) <= 2^32-1
91447636	35
f427ee49 A	36	#define DO1(buf, i) {s1 += buf[i]; s2 += s1;}
	37	#define DO2(buf, i) DO1(buf,i); DO1(buf,i+1);
	38	#define DO4(buf, i) DO2(buf,i); DO2(buf,i+2);
	39	#define DO8(buf, i) DO4(buf,i); DO4(buf,i+4);
91447636	40	#define DO16(buf) DO8(buf,0); DO8(buf,8);
1c79356b	41
b0d623f7 A	42	u_int32_t
b0d623f7 A	43	mkext_adler32(uint8_t *buf, int32_t len)
1c79356b	44	{
f427ee49 A	45	unsigned long s1 = 1; // adler & 0xffff;
	46	unsigned long s2 = 0; // (adler >> 16) & 0xffff;
	47	int k;
91447636	48
b7266188	49
f427ee49 A	50	while (len > 0) {
	51	k = len < NMAX ? len : NMAX;
	52	len -= k;
	53	while (k >= 16) {
	54	DO16(buf);
	55	buf += 16;
	56	k -= 16;
	57	}
	58	if (k != 0) {
	59	do {
	60	s1 += *buf++;
	61	s2 += s1;
	62	} while (--k);
	63	}
	64	s1 %= BASE;
	65	s2 %= BASE;
	66	}
	67	return (u_int32_t)((s2 << 16) \| s1);
1c79356b A	68	}
1c79356b A	69
91447636	70
1c79356b	71	/**************************************************************
f427ee49	72	* LZSS.C -- A Data Compression Program
1c79356b	73	***************************************************************
f427ee49 A	74	* 4/6/1989 Haruhiko Okumura
	75	* Use, distribute, and modify this program freely.
	76	* Please send me your improved versions.
	77	* PC-VAN SCIENCE
	78	* NIFTY-Serve PAF01022
	79	* CompuServe 74050,1022
	80	*
1c79356b A	81	**************************************************************/
	82
	83	#define N 4096 /* size of ring buffer - must be power of 2 */
	84	#define F 18 /* upper limit for match_length */
	85	#define THRESHOLD 2 /* encode string into position and length
f427ee49	86	* if match_length is greater than this */
39037602	87	#if !KERNEL
1c79356b	88	#define NIL N /* index for root of binary search trees */
39037602	89	#endif
1c79356b A	90
1c79356b A	91	struct encode_state {
f427ee49 A	92	/*
	93	* left & right children & parent. These constitute binary search trees.
	94	*/
	95	int lchild[N + 1], rchild[N + 257], parent[N + 1];
1c79356b	96
f427ee49 A	97	/* ring buffer of size N, with extra F-1 bytes to aid string comparison */
f427ee49 A	98	u_int8_t text_buf[N + F - 1];
1c79356b	99
f427ee49 A	100	/*
	101	* match_length of longest match.
	102	* These are set by the insert_node() procedure.
	103	*/
	104	int match_position, match_length;
1c79356b A	105	};
	106
	107
b0d623f7 A	108	int
b0d623f7 A	109	decompress_lzss(u_int8_t dst, u_int32_t dstlen, u_int8_t src, u_int32_t srclen)
1c79356b	110	{
f427ee49 A	111	/* ring buffer of size N, with extra F-1 bytes to aid string comparison */
	112	u_int8_t text_buf[N + F - 1];
	113	u_int8_t *dststart = dst;
b0d623f7	114	u_int8_t *dstend = dst + dstlen;
f427ee49 A	115	u_int8_t *srcend = src + srclen;
	116	int i, j, k, r;
	117	u_int8_t c;
	118	unsigned int flags;
	119
	120	dst = dststart;
	121	srcend = src + srclen;
	122	for (i = 0; i < N - F; i++) {
	123	text_buf[i] = ' ';
	124	}
	125	r = N - F;
	126	flags = 0;
	127	for (;;) {
	128	if (((flags >>= 1) & 0x100) == 0) {
	129	if (src < srcend) {
	130	c = *src++;
	131	} else {
	132	break;
	133	}
	134	flags = c \| 0xFF00; /* uses higher byte cleverly */
	135	} /* to count eight */
	136	if (flags & 1) {
	137	if (src < srcend) {
	138	c = *src++;
	139	} else {
	140	break;
	141	}
	142	*dst++ = c;
b0d623f7 A	143	if (dst >= dstend) {
	144	goto finish;
	145	}
f427ee49 A	146	text_buf[r++] = c;
	147	r &= (N - 1);
	148	} else {
	149	if (src < srcend) {
	150	i = *src++;
	151	} else {
	152	break;
	153	}
	154	if (src < srcend) {
	155	j = *src++;
	156	} else {
	157	break;
	158	}
	159	i \|= ((j & 0xF0) << 4);
	160	j = (j & 0x0F) + THRESHOLD;
	161	for (k = 0; k <= j; k++) {
	162	c = text_buf[(i + k) & (N - 1)];
	163	*dst++ = c;
b0d623f7 A	164	if (dst >= dstend) {
	165	goto finish;
	166	}
f427ee49 A	167	text_buf[r++] = c;
	168	r &= (N - 1);
	169	}
	170	}
	171	}
b0d623f7	172	finish:
f427ee49	173	return (int)(dst - dststart);
1c79356b A	174	}
	175
	176	#if !KERNEL
	177
	178	/*
	179	* initialize state, mostly the trees
	180	*
f427ee49 A	181	* For i = 0 to N - 1, rchild[i] and lchild[i] will be the right and left
	182	* children of node i. These nodes need not be initialized. Also, parent[i]
	183	* is the parent of node i. These are initialized to NIL (= N), which stands
	184	* for 'not used.' For i = 0 to 255, rchild[N + i + 1] is the root of the
	185	* tree for strings that begin with character i. These are initialized to NIL.
1c79356b	186	* Note there are 256 trees. */
f427ee49 A	187	static void
f427ee49 A	188	init_state(struct encode_state *sp)
1c79356b	189	{
f427ee49	190	int i;
1c79356b	191
f427ee49	192	bzero(sp, sizeof(*sp));
1c79356b	193
f427ee49 A	194	for (i = 0; i < N - F; i++) {
	195	sp->text_buf[i] = ' ';
	196	}
	197	for (i = N + 1; i <= N + 256; i++) {
	198	sp->rchild[i] = NIL;
	199	}
	200	for (i = 0; i < N; i++) {
	201	sp->parent[i] = NIL;
	202	}
1c79356b A	203	}
	204
	205	/*
	206	* Inserts string of length F, text_buf[r..r+F-1], into one of the trees
	207	* (text_buf[r]'th tree) and returns the longest-match position and length
	208	* via the global variables match_position and match_length.
	209	* If match_length = F, then removes the old node in favor of the new one,
	210	* because the old one will be deleted sooner. Note r plays double role,
	211	* as tree node and position in buffer.
	212	*/
f427ee49 A	213	static void
f427ee49 A	214	insert_node(struct encode_state *sp, int r)
1c79356b	215	{
f427ee49 A	216	int i, p, cmp;
f427ee49 A	217	u_int8_t *key;
1c79356b	218
f427ee49 A	219	cmp = 1;
	220	key = &sp->text_buf[r];
	221	p = N + 1 + key[0];
	222	sp->rchild[r] = sp->lchild[r] = NIL;
	223	sp->match_length = 0;
	224	for (;;) {
	225	if (cmp >= 0) {
	226	if (sp->rchild[p] != NIL) {
	227	p = sp->rchild[p];
	228	} else {
	229	sp->rchild[p] = r;
	230	sp->parent[r] = p;
	231	return;
	232	}
	233	} else {
	234	if (sp->lchild[p] != NIL) {
	235	p = sp->lchild[p];
	236	} else {
	237	sp->lchild[p] = r;
	238	sp->parent[r] = p;
	239	return;
	240	}
	241	}
	242	for (i = 1; i < F; i++) {
	243	if ((cmp = key[i] - sp->text_buf[p + i]) != 0) {
	244	break;
	245	}
	246	}
	247	if (i > sp->match_length) {
	248	sp->match_position = p;
	249	if ((sp->match_length = i) >= F) {
	250	break;
	251	}
	252	}
	253	}
	254	sp->parent[r] = sp->parent[p];
	255	sp->lchild[r] = sp->lchild[p];
	256	sp->rchild[r] = sp->rchild[p];
	257	sp->parent[sp->lchild[p]] = r;
	258	sp->parent[sp->rchild[p]] = r;
	259	if (sp->rchild[sp->parent[p]] == p) {
	260	sp->rchild[sp->parent[p]] = r;
	261	} else {
	262	sp->lchild[sp->parent[p]] = r;
	263	}
	264	sp->parent[p] = NIL; /* remove p */
1c79356b A	265	}
	266
	267	/* deletes node p from tree */
f427ee49 A	268	static void
f427ee49 A	269	delete_node(struct encode_state *sp, int p)
1c79356b	270	{
f427ee49 A	271	int q;
	272
	273	if (sp->parent[p] == NIL) {
	274	return; /* not in tree */
	275	}
	276	if (sp->rchild[p] == NIL) {
	277	q = sp->lchild[p];
	278	} else if (sp->lchild[p] == NIL) {
	279	q = sp->rchild[p];
	280	} else {
	281	q = sp->lchild[p];
	282	if (sp->rchild[q] != NIL) {
	283	do {
	284	q = sp->rchild[q];
	285	} while (sp->rchild[q] != NIL);
	286	sp->rchild[sp->parent[q]] = sp->lchild[q];
	287	sp->parent[sp->lchild[q]] = sp->parent[q];
	288	sp->lchild[q] = sp->lchild[p];
	289	sp->parent[sp->lchild[p]] = q;
	290	}
	291	sp->rchild[q] = sp->rchild[p];
	292	sp->parent[sp->rchild[p]] = q;
	293	}
	294	sp->parent[q] = sp->parent[p];
	295	if (sp->rchild[sp->parent[p]] == p) {
	296	sp->rchild[sp->parent[p]] = q;
	297	} else {
	298	sp->lchild[sp->parent[p]] = q;
	299	}
	300	sp->parent[p] = NIL;
1c79356b A	301	}
1c79356b A	302
1c79356b	303	#endif /* !KERNEL */