Compress-LZF/lzf_c.c

/*
 * Copyright (c) 2000-2007 Marc Alexander Lehmann <schmorp@schmorp.de>
 * 
 * Redistribution and use in source and binary forms, with or without modifica-
 * tion, are permitted provided that the following conditions are met:
 * 
 *   1.  Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 * 
 *   2.  Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO
 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
 * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * the GNU General Public License ("GPL") version 2 or any later version,
 * in which case the provisions of the GPL are applicable instead of
 * the above. If you wish to allow the use of your version of this file
 * only under the terms of the GPL and not to allow others to use your
 * version of this file under the BSD license, indicate your decision
 * by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL. If you do not delete the
 * provisions above, a recipient may use your version of this file under
 * either the BSD or the GPL.
 */

#include "lzfP.h"

#define HSIZE (1 << (HLOG))

/*
 * don't play with this unless you benchmark!
 * decompression is not dependent on the hash function
 * the hashing function might seem strange, just believe me
 * it works ;)
 */
#ifndef FRST
# define FRST(p) (((p[0]) << 8) | p[1])
# define NEXT(v,p) (((v) << 8) | p[2])
# if ULTRA_FAST
#  define IDX(h) ((( h             >> (3*8 - HLOG)) - h  ) & (HSIZE - 1))
# elif VERY_FAST
#  define IDX(h) ((( h             >> (3*8 - HLOG)) - h*5) & (HSIZE - 1))
# else
#  define IDX(h) ((((h ^ (h << 5)) >> (3*8 - HLOG)) - h*5) & (HSIZE - 1))
# endif
#endif
/*
 * IDX works because it is very similar to a multiplicative hash, e.g.
 * ((h * 57321 >> (3*8 - HLOG)) & (HSIZE - 1))
 * the latter is also quite fast on newer CPUs, and compresses similarly.
 *
 * the next one is also quite good, albeit slow ;)
 * (int)(cos(h & 0xffffff) * 1e6)
 */

#if 0
/* original lzv-like hash function, much worse and thus slower */
# define FRST(p) (p[0] << 5) ^ p[1]
# define NEXT(v,p) ((v) << 5) ^ p[2]
# define IDX(h) ((h) & (HSIZE - 1))
#endif

#define        MAX_LIT        (1 <<  5)
#define        MAX_OFF        (1 << 13)
#define        MAX_REF        ((1 << 8) + (1 << 3))

#if __GNUC__ >= 3
# define expect(expr,value)         __builtin_expect ((expr),(value))
# define inline                     inline
#else
# define expect(expr,value)         (expr)
# define inline                     static
#endif

#define expect_false(expr) expect ((expr) != 0, 0)
#define expect_true(expr)  expect ((expr) != 0, 1)

/*
 * compressed format
 *
 * 000LLLLL <L+1>    ; literal
 * LLLooooo oooooooo ; backref L
 * 111ooooo LLLLLLLL oooooooo ; backref L+7
 *
 */

unsigned int
lzf_compress (const void *const in_data, unsigned int in_len,
              void *out_data, unsigned int out_len
#if LZF_STATE_ARG
              , LZF_STATE htab
#endif
              )
{
#if !LZF_STATE_ARG
  LZF_STATE htab;
#endif
  const u8 **hslot;
  const u8 *ip = (const u8 *)in_data;
        u8 *op = (u8 *)out_data;
  const u8 *in_end  = ip + in_len;
        u8 *out_end = op + out_len;
  const u8 *ref;

  unsigned int hval;
  unsigned long off;
  int lit;

  if (!in_len || !out_len)
    return 0;

#if INIT_HTAB
  memset (htab, 0, sizeof (htab));
# if 0
  for (hslot = htab; hslot < htab + HSIZE; hslot++)
    *hslot++ = ip;
# endif
#endif

  lit = 0; op++; /* start run */

  hval = FRST (ip);
  while (ip < in_end - 2)
    {
      hval = NEXT (hval, ip);
      hslot = htab + IDX (hval);
      ref = *hslot; *hslot = ip;

      if (1
#if INIT_HTAB
          && ref < ip /* the next test will actually take care of this, but this is faster */
#endif
          && (off = ip - ref - 1) < MAX_OFF
          && ip + 4 < in_end
          && ref > (u8 *)in_data
#if STRICT_ALIGN
          && ref[0] == ip[0]
          && ref[1] == ip[1]
          && ref[2] == ip[2]
#else
          && *(u16 *)ref == *(u16 *)ip
          && ref[2] == ip[2]
#endif
        )
        {
          /* match found at *ref++ */
          unsigned int len = 2;
          unsigned int maxlen = in_end - ip - len;
          maxlen = maxlen > MAX_REF ? MAX_REF : maxlen;

          op [- lit - 1] = lit - 1; /* stop run */
          op -= !lit; /* undo run if length is zero */

          if (expect_false (op + 3 + 1 >= out_end))
            return 0;

          for (;;)
            {
              if (expect_true (maxlen > 16))
                {
                  len++; if (ref [len] != ip [len]) break;
                  len++; if (ref [len] != ip [len]) break;
                  len++; if (ref [len] != ip [len]) break;
                  len++; if (ref [len] != ip [len]) break;

                  len++; if (ref [len] != ip [len]) break;
                  len++; if (ref [len] != ip [len]) break;
                  len++; if (ref [len] != ip [len]) break;
                  len++; if (ref [len] != ip [len]) break;

                  len++; if (ref [len] != ip [len]) break;
                  len++; if (ref [len] != ip [len]) break;
                  len++; if (ref [len] != ip [len]) break;
                  len++; if (ref [len] != ip [len]) break;

                  len++; if (ref [len] != ip [len]) break;
                  len++; if (ref [len] != ip [len]) break;
                  len++; if (ref [len] != ip [len]) break;
                  len++; if (ref [len] != ip [len]) break;
                }

              do
                len++;
              while (len < maxlen && ref[len] == ip[len]);

              break;
            }

          len -= 2;
          ip++;

          if (len < 7)
            {
              *op++ = (off >> 8) + (len << 5);
            }
          else
            {
              *op++ = (off >> 8) + (  7 << 5);
              *op++ = len - 7;
            }

          *op++ = off;

#if ULTRA_FAST || VERY_FAST
          ip += len;
#if VERY_FAST && !ULTRA_FAST
          --ip;
#endif
          hval = FRST (ip);

          hval = NEXT (hval, ip);
          htab[IDX (hval)] = ip;
          ip++;

#if VERY_FAST && !ULTRA_FAST
          hval = NEXT (hval, ip);
          htab[IDX (hval)] = ip;
          ip++;
#endif
#else
          do
            {
              hval = NEXT (hval, ip);
              htab[IDX (hval)] = ip;
              ip++;
            }
          while (len--);
#endif

          lit = 0; op++; /* start run */
        }
      else
        {
          /* one more literal byte we must copy */
          if (expect_false (op >= out_end))
            return 0;

          lit++; *op++ = *ip++;

          if (expect_false (lit == MAX_LIT))
            {
              op [- lit - 1] = lit - 1; /* stop run */
              lit = 0; op++; /* start run */
            }
        }
    }

  if (op + 3 > out_end) /* at most 3 bytes can be missing here */
    return 0;

  while (ip < in_end)
    {
      lit++; *op++ = *ip++;

      if (expect_false (lit == MAX_LIT))
        {
          op [- lit - 1] = lit - 1; /* stop run */
          lit = 0; op++; /* start run */
        }
    }

  op [- lit - 1] = lit - 1; /* end run */
  op -= !lit; /* undo run if length is zero */

  return op - (u8 *)out_data;
}

Revision:	1.9
Committed:	Fri Nov 30 10:37:41 2007 UTC (18 years, 9 months ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-3_1, rel-3_11
Changes since 1.8:	+8 -2 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.1	/*
2	root	1.8	* Copyright (c) 2000-2007 Marc Alexander Lehmann <schmorp@schmorp.de>
3	root	1.1	*
4			* Redistribution and use in source and binary forms, with or without modifica-
5			* tion, are permitted provided that the following conditions are met:
6			*
7			* 1. Redistributions of source code must retain the above copyright notice,
8			* this list of conditions and the following disclaimer.
9			*
10			* 2. Redistributions in binary form must reproduce the above copyright
11			* notice, this list of conditions and the following disclaimer in the
12			* documentation and/or other materials provided with the distribution.
13			*
14			* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
15			* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
16			* CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
17			* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
18			* CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19			* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
20			* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
21			* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
22			* ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
23			* OF THE POSSIBILITY OF SUCH DAMAGE.
24	pcg	1.2	*
25			* Alternatively, the contents of this file may be used under the terms of
26	root	1.8	* the GNU General Public License ("GPL") version 2 or any later version,
27			* in which case the provisions of the GPL are applicable instead of
28			* the above. If you wish to allow the use of your version of this file
29			* only under the terms of the GPL and not to allow others to use your
30			* version of this file under the BSD license, indicate your decision
31			* by deleting the provisions above and replace them with the notice
32			* and other provisions required by the GPL. If you do not delete the
33			* provisions above, a recipient may use your version of this file under
34			* either the BSD or the GPL.
35	root	1.1	*/
36
37			#include "lzfP.h"
38
39			#define HSIZE (1 << (HLOG))
40
41			/*
42			* don't play with this unless you benchmark!
43			* decompression is not dependent on the hash function
44			* the hashing function might seem strange, just believe me
45			* it works ;)
46			*/
47	root	1.5	#ifndef FRST
48			# define FRST(p) (((p[0]) << 8) \| p[1])
49			# define NEXT(v,p) (((v) << 8) \| p[2])
50	root	1.8	# if ULTRA_FAST
51			# define IDX(h) ((( h >> (3*8 - HLOG)) - h ) & (HSIZE - 1))
52			# elif VERY_FAST
53			# define IDX(h) ((( h >> (38 - HLOG)) - h5) & (HSIZE - 1))
54			# else
55			# define IDX(h) ((((h ^ (h << 5)) >> (38 - HLOG)) - h5) & (HSIZE - 1))
56			# endif
57	root	1.5	#endif
58	root	1.1	/*
59			* IDX works because it is very similar to a multiplicative hash, e.g.
60	pcg	1.2	* ((h * 57321 >> (3*8 - HLOG)) & (HSIZE - 1))
61	root	1.7	* the latter is also quite fast on newer CPUs, and compresses similarly.
62	pcg	1.2	*
63	root	1.1	* the next one is also quite good, albeit slow ;)
64			* (int)(cos(h & 0xffffff) * 1e6)
65			*/
66
67			#if 0
68	pcg	1.2	/* original lzv-like hash function, much worse and thus slower */
69	root	1.1	# define FRST(p) (p[0] << 5) ^ p[1]
70	pcg	1.2	# define NEXT(v,p) ((v) << 5) ^ p[2]
71			# define IDX(h) ((h) & (HSIZE - 1))
72	root	1.1	#endif
73
74			#define MAX_LIT (1 << 5)
75			#define MAX_OFF (1 << 13)
76	root	1.7	#define MAX_REF ((1 << 8) + (1 << 3))
77
78	root	1.8	#if __GNUC__ >= 3
79			# define expect(expr,value) __builtin_expect ((expr),(value))
80			# define inline inline
81			#else
82			# define expect(expr,value) (expr)
83			# define inline static
84	root	1.7	#endif
85	root	1.1
86	root	1.8	#define expect_false(expr) expect ((expr) != 0, 0)
87			#define expect_true(expr) expect ((expr) != 0, 1)
88
89	root	1.1	/*
90			* compressed format
91			*
92			* 000LLLLL <L+1> ; literal
93	root	1.5	* LLLooooo oooooooo ; backref L
94			* 111ooooo LLLLLLLL oooooooo ; backref L+7
95	root	1.1	*
96			*/
97
98			unsigned int
99			lzf_compress (const void *const in_data, unsigned int in_len,
100	pcg	1.2	void *out_data, unsigned int out_len
101			#if LZF_STATE_ARG
102	root	1.6	, LZF_STATE htab
103	pcg	1.2	#endif
104			)
105	root	1.1	{
106	pcg	1.2	#if !LZF_STATE_ARG
107			LZF_STATE htab;
108			#endif
109			const u8 **hslot;
110			const u8 ip = (const u8 )in_data;
111			u8 op = (u8 )out_data;
112	root	1.1	const u8 *in_end = ip + in_len;
113			u8 *out_end = op + out_len;
114			const u8 *ref;
115
116	root	1.8	unsigned int hval;
117	pcg	1.2	unsigned long off;
118	root	1.8	int lit;
119
120			if (!in_len \|\| !out_len)
121			return 0;
122	root	1.1
123			#if INIT_HTAB
124	root	1.7	memset (htab, 0, sizeof (htab));
125			# if 0
126			for (hslot = htab; hslot < htab + HSIZE; hslot++)
127			*hslot++ = ip;
128	root	1.1	# endif
129			#endif
130
131	root	1.8	lit = 0; op++; /* start run */
132
133			hval = FRST (ip);
134			while (ip < in_end - 2)
135	root	1.1	{
136	root	1.8	hval = NEXT (hval, ip);
137			hslot = htab + IDX (hval);
138			ref = hslot; hslot = ip;
139	root	1.1
140	root	1.8	if (1
141	root	1.9	#if INIT_HTAB
142	root	1.8	&& ref < ip /* the next test will actually take care of this, but this is faster */
143	root	1.1	#endif
144	root	1.8	&& (off = ip - ref - 1) < MAX_OFF
145			&& ip + 4 < in_end
146			&& ref > (u8 *)in_data
147	root	1.1	#if STRICT_ALIGN
148	root	1.8	&& ref[0] == ip[0]
149			&& ref[1] == ip[1]
150			&& ref[2] == ip[2]
151	root	1.1	#else
152	root	1.8	&& (u16 )ref == (u16 )ip
153			&& ref[2] == ip[2]
154	root	1.1	#endif
155	root	1.8	)
156			{
157			/* match found at ref++ /
158			unsigned int len = 2;
159			unsigned int maxlen = in_end - ip - len;
160			maxlen = maxlen > MAX_REF ? MAX_REF : maxlen;
161
162			op [- lit - 1] = lit - 1; /* stop run */
163			op -= !lit; /* undo run if length is zero */
164
165			if (expect_false (op + 3 + 1 >= out_end))
166			return 0;
167
168			for (;;)
169	pcg	1.2	{
170	root	1.8	if (expect_true (maxlen > 16))
171			{
172			len++; if (ref [len] != ip [len]) break;
173			len++; if (ref [len] != ip [len]) break;
174			len++; if (ref [len] != ip [len]) break;
175			len++; if (ref [len] != ip [len]) break;
176
177			len++; if (ref [len] != ip [len]) break;
178			len++; if (ref [len] != ip [len]) break;
179			len++; if (ref [len] != ip [len]) break;
180			len++; if (ref [len] != ip [len]) break;
181
182			len++; if (ref [len] != ip [len]) break;
183			len++; if (ref [len] != ip [len]) break;
184			len++; if (ref [len] != ip [len]) break;
185			len++; if (ref [len] != ip [len]) break;
186
187			len++; if (ref [len] != ip [len]) break;
188			len++; if (ref [len] != ip [len]) break;
189			len++; if (ref [len] != ip [len]) break;
190			len++; if (ref [len] != ip [len]) break;
191			}
192	root	1.4
193	pcg	1.2	do
194			len++;
195			while (len < maxlen && ref[len] == ip[len]);
196
197	root	1.8	break;
198			}
199	pcg	1.2
200	root	1.8	len -= 2;
201			ip++;
202	pcg	1.2
203	root	1.8	if (len < 7)
204			{
205			*op++ = (off >> 8) + (len << 5);
206			}
207			else
208			{
209			*op++ = (off >> 8) + ( 7 << 5);
210			*op++ = len - 7;
211			}
212	root	1.1
213	root	1.8	*op++ = off;
214	root	1.1
215	root	1.4	#if ULTRA_FAST \|\| VERY_FAST
216	root	1.8	ip += len;
217	root	1.4	#if VERY_FAST && !ULTRA_FAST
218	root	1.8	--ip;
219	root	1.4	#endif
220	root	1.8	hval = FRST (ip);
221	root	1.4
222	root	1.8	hval = NEXT (hval, ip);
223			htab[IDX (hval)] = ip;
224			ip++;
225	root	1.4
226			#if VERY_FAST && !ULTRA_FAST
227	root	1.8	hval = NEXT (hval, ip);
228			htab[IDX (hval)] = ip;
229			ip++;
230			#endif
231			#else
232			do
233			{
234	pcg	1.2	hval = NEXT (hval, ip);
235			htab[IDX (hval)] = ip;
236			ip++;
237	root	1.8	}
238			while (len--);
239	root	1.4	#endif
240	root	1.8
241			lit = 0; op++; /* start run */
242	pcg	1.2	}
243	root	1.8	else
244	pcg	1.2	{
245	root	1.8	/* one more literal byte we must copy */
246			if (expect_false (op >= out_end))
247	pcg	1.2	return 0;
248	root	1.1
249	root	1.8	lit++; op++ = ip++;
250	root	1.7
251	root	1.8	if (expect_false (lit == MAX_LIT))
252			{
253			op [- lit - 1] = lit - 1; /* stop run */
254			lit = 0; op++; /* start run */
255			}
256	pcg	1.2	}
257	root	1.1	}
258
259	root	1.9	if (op + 3 > out_end) /* at most 3 bytes can be missing here */
260	root	1.8	return 0;
261
262			while (ip < in_end)
263	root	1.1	{
264	root	1.8	lit++; op++ = ip++;
265	root	1.9
266			if (expect_false (lit == MAX_LIT))
267			{
268			op [- lit - 1] = lit - 1; /* stop run */
269			lit = 0; op++; /* start run */
270			}
271	root	1.8	}
272	root	1.1
273	root	1.8	op [- lit - 1] = lit - 1; /* end run */
274			op -= !lit; /* undo run if length is zero */
275	root	1.1
276	root	1.8	return op - (u8 *)out_data;
277	root	1.1	}
278	root	1.7