liblzf/lzf_c.c

/*
 * Copyright (c) 2000-2010,2012 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!
 * the data format is not dependent on the hash function.
 * the hash 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 MULTIPLICATION_IS_SLOW
#  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
# else
/* this one was developed with sesse,
 * and is very similar to the one in snappy.
 * it does need a modern enough cpu with a fast multiplication.
 */
#  define IDX(h) (((h * 0x1e35a7bdU) >> (32 - HLOG - 8)) & (HSIZE - 1))
# endif
#endif

#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

#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, L+1=1..33 octets
 * LLLooooo oooooooo ; backref L+1=1..7 octets, o+1=1..4096 offset
 * 111ooooo LLLLLLLL oooooooo ; backref L+8 octets, o+1=1..4096 offset
 *
 */

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 *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;

  /* off requires a type wide enough to hold a general pointer difference.
   * ISO C doesn't have that (size_t might not be enough and ptrdiff_t only
   * works for differences within a single object). We also assume that
   * no bit pattern traps. Since the only platform that is both non-POSIX
   * and fails to support both assumptions is windows 64 bit, we make a
   * special workaround for it.
   */
#if defined (_WIN32) && defined (_M_X64)
  /* workaround for missing POSIX compliance */
  #if __GNUC__
    unsigned long long off;
  #else
    unsigned __int64 off;
  #endif
#else
  unsigned long off;
#endif
  unsigned int hval;
  int lit;

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

#if INIT_HTAB
  memset (htab, 0, sizeof (LZF_STATE));
#endif

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

  hval = FRST (ip);
  while (ip < in_end - 2)
    {
      LZF_HSLOT *hslot;

      hval = NEXT (hval, ip);
      hslot = htab + IDX (hval);
      ref = *hslot + LZF_HSLOT_BIAS; *hslot = ip - LZF_HSLOT_BIAS;

      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) < LZF_MAX_OFF
          && ref > (u8 *)in_data
          && ref[2] == ip[2]
#if STRICT_ALIGN
          && ((ref[1] << 8) | ref[0]) == ((ip[1] << 8) | ip[0])
#else
          && *(u16 *)ref == *(u16 *)ip
#endif
        )
        {
          /* match found at *ref++ */
          unsigned int len = 2;
          unsigned int maxlen = in_end - ip - len;
          maxlen = maxlen > LZF_MAX_REF ? LZF_MAX_REF : maxlen;

          if (expect_false (op + 3 + 1 >= out_end)) /* first a faster conservative test */
            if (op - !lit + 3 + 1 >= out_end) /* second the exact but rare test */
              return 0;

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

          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; /* len is now #octets - 1 */
          ip++;

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

          *op++ = off;

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

          ip += len + 1;

          if (expect_false (ip >= in_end - 2))
            break;

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

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

# if VERY_FAST && !ULTRA_FAST
          hval = NEXT (hval, ip);
          htab[IDX (hval)] = ip - LZF_HSLOT_BIAS;
          ip++;
# endif
#else
          ip -= len + 1;

          do
            {
              hval = NEXT (hval, ip);
              htab[IDX (hval)] = ip - LZF_HSLOT_BIAS;
              ip++;
            }
          while (len--);
#endif
        }
      else
        {
          /* one more literal byte we must copy */
          if (expect_false (op >= out_end))
            return 0;

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

          if (expect_false (lit == LZF_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 == LZF_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.51
Committed:	Wed May 24 18:37:18 2017 UTC (6 years, 11 months ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.50:	+1 -1 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.1	/*
2	root	1.47	* Copyright (c) 2000-2010,2012 Marc Alexander Lehmann <schmorp@schmorp.de>
3	root	1.49	*
4	root	1.1	* Redistribution and use in source and binary forms, with or without modifica-
5			* tion, are permitted provided that the following conditions are met:
6	root	1.49	*
7	root	1.1	* 1. Redistributions of source code must retain the above copyright notice,
8			* this list of conditions and the following disclaimer.
9	root	1.49	*
10	root	1.1	* 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	root	1.49	*
14	root	1.1	* 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.6	*
25			* Alternatively, the contents of this file may be used under the terms of
26	root	1.16	* 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	root	1.41	* the data format is not dependent on the hash function.
44			* the hash function might seem strange, just believe me,
45	root	1.1	* it works ;)
46			*/
47	root	1.10	#ifndef FRST
48			# define FRST(p) (((p[0]) << 8) \| p[1])
49			# define NEXT(v,p) (((v) << 8) \| p[2])
50	root	1.45	# if MULTIPLICATION_IS_SLOW
51			# if ULTRA_FAST
52			# define IDX(h) ((( h >> (3*8 - HLOG)) - h ) & (HSIZE - 1))
53			# elif VERY_FAST
54			# define IDX(h) ((( h >> (38 - HLOG)) - h5) & (HSIZE - 1))
55			# else
56			# define IDX(h) ((((h ^ (h << 5)) >> (38 - HLOG)) - h5) & (HSIZE - 1))
57			# endif
58	root	1.22	# else
59	root	1.45	/* this one was developed with sesse,
60			* and is very similar to the one in snappy.
61			* it does need a modern enough cpu with a fast multiplication.
62			*/
63			# define IDX(h) (((h * 0x1e35a7bdU) >> (32 - HLOG - 8)) & (HSIZE - 1))
64	root	1.22	# endif
65	root	1.10	#endif
66	root	1.1
67			#if 0
68	root	1.7	/* original lzv-like hash function, much worse and thus slower */
69	root	1.1	# define FRST(p) (p[0] << 5) ^ p[1]
70	root	1.2	# define NEXT(v,p) ((v) << 5) ^ p[2]
71			# define IDX(h) ((h) & (HSIZE - 1))
72	root	1.1	#endif
73
74	root	1.17	#if __GNUC__ >= 3
75			# define expect(expr,value) __builtin_expect ((expr),(value))
76			# define inline inline
77			#else
78			# define expect(expr,value) (expr)
79			# define inline static
80			#endif
81
82			#define expect_false(expr) expect ((expr) != 0, 0)
83			#define expect_true(expr) expect ((expr) != 0, 1)
84
85	root	1.1	/*
86			* compressed format
87			*
88	root	1.38	* 000LLLLL <L+1> ; literal, L+1=1..33 octets
89			* LLLooooo oooooooo ; backref L+1=1..7 octets, o+1=1..4096 offset
90			* 111ooooo LLLLLLLL oooooooo ; backref L+8 octets, o+1=1..4096 offset
91	root	1.1	*
92			*/
93
94			unsigned int
95			lzf_compress (const void *const in_data, unsigned int in_len,
96	pcg	1.4	void *out_data, unsigned int out_len
97	pcg	1.5	#if LZF_STATE_ARG
98	root	1.11	, LZF_STATE htab
99	pcg	1.4	#endif
100			)
101	root	1.1	{
102	pcg	1.5	#if !LZF_STATE_ARG
103	pcg	1.4	LZF_STATE htab;
104			#endif
105			const u8 ip = (const u8 )in_data;
106			u8 op = (u8 )out_data;
107	root	1.1	const u8 *in_end = ip + in_len;
108			u8 *out_end = op + out_len;
109			const u8 *ref;
110
111	root	1.32	/* off requires a type wide enough to hold a general pointer difference.
112			* ISO C doesn't have that (size_t might not be enough and ptrdiff_t only
113	root	1.46	* works for differences within a single object). We also assume that
114	root	1.32	* no bit pattern traps. Since the only platform that is both non-POSIX
115			* and fails to support both assumptions is windows 64 bit, we make a
116			* special workaround for it.
117			*/
118	root	1.47	#if defined (_WIN32) && defined (_M_X64)
119			/* workaround for missing POSIX compliance */
120	root	1.48	#if __GNUC__
121	root	1.47	unsigned long long off;
122			#else
123			unsigned __int64 off;
124			#endif
125	root	1.31	#else
126	root	1.1	unsigned long off;
127	root	1.31	#endif
128	root	1.32	unsigned int hval;
129	root	1.22	int lit;
130
131			if (!in_len \|\| !out_len)
132			return 0;
133	root	1.1
134			#if INIT_HTAB
135	root	1.51	memset (htab, 0, sizeof (LZF_STATE));
136	root	1.1	#endif
137
138	root	1.22	lit = 0; op++; /* start run */
139
140			hval = FRST (ip);
141			while (ip < in_end - 2)
142	root	1.1	{
143	root	1.42	LZF_HSLOT *hslot;
144
145	root	1.22	hval = NEXT (hval, ip);
146			hslot = htab + IDX (hval);
147	root	1.42	ref = hslot + LZF_HSLOT_BIAS; hslot = ip - LZF_HSLOT_BIAS;
148	root	1.1
149	root	1.22	if (1
150	ayin	1.27	#if INIT_HTAB
151	root	1.22	&& ref < ip /* the next test will actually take care of this, but this is faster */
152	root	1.1	#endif
153	root	1.50	&& (off = ip - ref - 1) < LZF_MAX_OFF
154	root	1.22	&& ref > (u8 *)in_data
155	root	1.40	&& ref[2] == ip[2]
156	root	1.1	#if STRICT_ALIGN
157	root	1.43	&& ((ref[1] << 8) \| ref[0]) == ((ip[1] << 8) \| ip[0])
158	root	1.1	#else
159	root	1.22	&& (u16 )ref == (u16 )ip
160	root	1.1	#endif
161	root	1.22	)
162			{
163			/* match found at ref++ /
164			unsigned int len = 2;
165			unsigned int maxlen = in_end - ip - len;
166	root	1.50	maxlen = maxlen > LZF_MAX_REF ? LZF_MAX_REF : maxlen;
167	root	1.22
168	root	1.36	if (expect_false (op + 3 + 1 >= out_end)) /* first a faster conservative test */
169			if (op - !lit + 3 + 1 >= out_end) /* second the exact but rare test */
170			return 0;
171
172	root	1.22	op [- lit - 1] = lit - 1; /* stop run */
173			op -= !lit; /* undo run if length is zero */
174	root	1.9
175	root	1.22	for (;;)
176			{
177			if (expect_true (maxlen > 16))
178	pcg	1.5	{
179	root	1.22	len++; if (ref [len] != ip [len]) break;
180			len++; if (ref [len] != ip [len]) break;
181			len++; if (ref [len] != ip [len]) break;
182			len++; if (ref [len] != ip [len]) break;
183
184			len++; if (ref [len] != ip [len]) break;
185			len++; if (ref [len] != ip [len]) break;
186			len++; if (ref [len] != ip [len]) break;
187			len++; if (ref [len] != ip [len]) break;
188
189			len++; if (ref [len] != ip [len]) break;
190			len++; if (ref [len] != ip [len]) break;
191			len++; if (ref [len] != ip [len]) break;
192			len++; if (ref [len] != ip [len]) break;
193
194			len++; if (ref [len] != ip [len]) break;
195			len++; if (ref [len] != ip [len]) break;
196			len++; if (ref [len] != ip [len]) break;
197			len++; if (ref [len] != ip [len]) break;
198	pcg	1.5	}
199
200	root	1.22	do
201			len++;
202			while (len < maxlen && ref[len] == ip[len]);
203	root	1.18
204	root	1.22	break;
205			}
206	root	1.18
207	root	1.33	len -= 2; /* len is now #octets - 1 */
208	root	1.22	ip++;
209	pcg	1.5
210	root	1.22	if (len < 7)
211			{
212			*op++ = (off >> 8) + (len << 5);
213			}
214			else
215			{
216			*op++ = (off >> 8) + ( 7 << 5);
217			*op++ = len - 7;
218			}
219	root	1.1
220	root	1.22	*op++ = off;
221	root	1.44
222	root	1.34	lit = 0; op++; /* start run */
223
224			ip += len + 1;
225
226	root	1.35	if (expect_false (ip >= in_end - 2))
227	root	1.34	break;
228	root	1.1
229	root	1.9	#if ULTRA_FAST \|\| VERY_FAST
230	root	1.34	--ip;
231	root	1.33	# if VERY_FAST && !ULTRA_FAST
232	root	1.34	--ip;
233	root	1.33	# endif
234	root	1.34	hval = FRST (ip);
235	root	1.9
236	root	1.34	hval = NEXT (hval, ip);
237	root	1.42	htab[IDX (hval)] = ip - LZF_HSLOT_BIAS;
238	root	1.34	ip++;
239	root	1.9
240	root	1.33	# if VERY_FAST && !ULTRA_FAST
241	root	1.34	hval = NEXT (hval, ip);
242	root	1.42	htab[IDX (hval)] = ip - LZF_HSLOT_BIAS;
243	root	1.34	ip++;
244			# endif
245			#else
246			ip -= len + 1;
247
248			do
249			{
250	pcg	1.5	hval = NEXT (hval, ip);
251	root	1.42	htab[IDX (hval)] = ip - LZF_HSLOT_BIAS;
252	pcg	1.5	ip++;
253	root	1.34	}
254			while (len--);
255	root	1.33	#endif
256	pcg	1.5	}
257	root	1.26	else
258	pcg	1.5	{
259	root	1.26	/* one more literal byte we must copy */
260			if (expect_false (op >= out_end))
261			return 0;
262
263			lit++; op++ = ip++;
264
265	root	1.50	if (expect_false (lit == LZF_MAX_LIT))
266	root	1.26	{
267			op [- lit - 1] = lit - 1; /* stop run */
268			lit = 0; op++; /* start run */
269			}
270	pcg	1.5	}
271	root	1.1	}
272
273	root	1.29	if (op + 3 > out_end) /* at most 3 bytes can be missing here */
274	root	1.22	return 0;
275
276			while (ip < in_end)
277	root	1.1	{
278	root	1.26	lit++; op++ = ip++;
279	root	1.28
280	root	1.50	if (expect_false (lit == LZF_MAX_LIT))
281	root	1.28	{
282			op [- lit - 1] = lit - 1; /* stop run */
283			lit = 0; op++; /* start run */
284			}
285	root	1.22	}
286	root	1.1
287	root	1.24	op [- lit - 1] = lit - 1; /* end run */
288			op -= !lit; /* undo run if length is zero */
289	root	1.1
290	root	1.22	return op - (u8 *)out_data;
291	root	1.1	}
292	root	1.14