Fix version.sh compatiblity with Solaris
[xz/debian.git] / src / liblzma / lz / lz_encoder_mf.c
blob557c2612f2a24c359bd7084300d841f1b72f45a2
1 // SPDX-License-Identifier: 0BSD
3 ///////////////////////////////////////////////////////////////////////////////
4 //
5 /// \file lz_encoder_mf.c
6 /// \brief Match finders
7 ///
8 // Authors: Igor Pavlov
9 // Lasse Collin
11 ///////////////////////////////////////////////////////////////////////////////
13 #include "lz_encoder.h"
14 #include "lz_encoder_hash.h"
15 #include "memcmplen.h"
18 /// \brief Find matches starting from the current byte
19 ///
20 /// \return The length of the longest match found
21 extern uint32_t
22 lzma_mf_find(lzma_mf *mf, uint32_t *count_ptr, lzma_match *matches)
24 // Call the match finder. It returns the number of length-distance
25 // pairs found.
26 // FIXME: Minimum count is zero, what _exactly_ is the maximum?
27 const uint32_t count = mf->find(mf, matches);
29 // Length of the longest match; assume that no matches were found
30 // and thus the maximum length is zero.
31 uint32_t len_best = 0;
33 if (count > 0) {
34 #ifndef NDEBUG
35 // Validate the matches.
36 for (uint32_t i = 0; i < count; ++i) {
37 assert(matches[i].len <= mf->nice_len);
38 assert(matches[i].dist < mf->read_pos);
39 assert(memcmp(mf_ptr(mf) - 1,
40 mf_ptr(mf) - matches[i].dist - 2,
41 matches[i].len) == 0);
43 #endif
45 // The last used element in the array contains
46 // the longest match.
47 len_best = matches[count - 1].len;
49 // If a match of maximum search length was found, try to
50 // extend the match to maximum possible length.
51 if (len_best == mf->nice_len) {
52 // The limit for the match length is either the
53 // maximum match length supported by the LZ-based
54 // encoder or the number of bytes left in the
55 // dictionary, whichever is smaller.
56 uint32_t limit = mf_avail(mf) + 1;
57 if (limit > mf->match_len_max)
58 limit = mf->match_len_max;
60 // Pointer to the byte we just ran through
61 // the match finder.
62 const uint8_t *p1 = mf_ptr(mf) - 1;
64 // Pointer to the beginning of the match. We need -1
65 // here because the match distances are zero based.
66 const uint8_t *p2 = p1 - matches[count - 1].dist - 1;
68 len_best = lzma_memcmplen(p1, p2, len_best, limit);
72 *count_ptr = count;
74 // Finally update the read position to indicate that match finder was
75 // run for this dictionary offset.
76 ++mf->read_ahead;
78 return len_best;
82 /// Hash value to indicate unused element in the hash. Since we start the
83 /// positions from dict_size + 1, zero is always too far to qualify
84 /// as usable match position.
85 #define EMPTY_HASH_VALUE 0
88 /// Normalization must be done when lzma_mf.offset + lzma_mf.read_pos
89 /// reaches MUST_NORMALIZE_POS.
90 #define MUST_NORMALIZE_POS UINT32_MAX
93 /// \brief Normalizes hash values
94 ///
95 /// The hash arrays store positions of match candidates. The positions are
96 /// relative to an arbitrary offset that is not the same as the absolute
97 /// offset in the input stream. The relative position of the current byte
98 /// is lzma_mf.offset + lzma_mf.read_pos. The distances of the matches are
99 /// the differences of the current read position and the position found from
100 /// the hash.
102 /// To prevent integer overflows of the offsets stored in the hash arrays,
103 /// we need to "normalize" the stored values now and then. During the
104 /// normalization, we drop values that indicate distance greater than the
105 /// dictionary size, thus making space for new values.
106 static void
107 normalize(lzma_mf *mf)
109 assert(mf->read_pos + mf->offset == MUST_NORMALIZE_POS);
111 // In future we may not want to touch the lowest bits, because there
112 // may be match finders that use larger resolution than one byte.
113 const uint32_t subvalue
114 = (MUST_NORMALIZE_POS - mf->cyclic_size);
115 // & ~((UINT32_C(1) << 10) - 1);
117 for (uint32_t i = 0; i < mf->hash_count; ++i) {
118 // If the distance is greater than the dictionary size,
119 // we can simply mark the hash element as empty.
120 if (mf->hash[i] <= subvalue)
121 mf->hash[i] = EMPTY_HASH_VALUE;
122 else
123 mf->hash[i] -= subvalue;
126 for (uint32_t i = 0; i < mf->sons_count; ++i) {
127 // Do the same for mf->son.
129 // NOTE: There may be uninitialized elements in mf->son.
130 // Valgrind may complain that the "if" below depends on
131 // an uninitialized value. In this case it is safe to ignore
132 // the warning. See also the comments in lz_encoder_init()
133 // in lz_encoder.c.
134 if (mf->son[i] <= subvalue)
135 mf->son[i] = EMPTY_HASH_VALUE;
136 else
137 mf->son[i] -= subvalue;
140 // Update offset to match the new locations.
141 mf->offset -= subvalue;
143 return;
147 /// Mark the current byte as processed from point of view of the match finder.
148 static void
149 move_pos(lzma_mf *mf)
151 if (++mf->cyclic_pos == mf->cyclic_size)
152 mf->cyclic_pos = 0;
154 ++mf->read_pos;
155 assert(mf->read_pos <= mf->write_pos);
157 if (unlikely(mf->read_pos + mf->offset == UINT32_MAX))
158 normalize(mf);
162 /// When flushing, we cannot run the match finder unless there is nice_len
163 /// bytes available in the dictionary. Instead, we skip running the match
164 /// finder (indicating that no match was found), and count how many bytes we
165 /// have ignored this way.
167 /// When new data is given after the flushing was completed, the match finder
168 /// is restarted by rewinding mf->read_pos backwards by mf->pending. Then
169 /// the missed bytes are added to the hash using the match finder's skip
170 /// function (with small amount of input, it may start using mf->pending
171 /// again if flushing).
173 /// Due to this rewinding, we don't touch cyclic_pos or test for
174 /// normalization. It will be done when the match finder's skip function
175 /// catches up after a flush.
176 static void
177 move_pending(lzma_mf *mf)
179 ++mf->read_pos;
180 assert(mf->read_pos <= mf->write_pos);
181 ++mf->pending;
185 /// Calculate len_limit and determine if there is enough input to run
186 /// the actual match finder code. Sets up "cur" and "pos". This macro
187 /// is used by all find functions and binary tree skip functions. Hash
188 /// chain skip function doesn't need len_limit so a simpler code is used
189 /// in them.
190 #define header(is_bt, len_min, ret_op) \
191 uint32_t len_limit = mf_avail(mf); \
192 if (mf->nice_len <= len_limit) { \
193 len_limit = mf->nice_len; \
194 } else if (len_limit < (len_min) \
195 || (is_bt && mf->action == LZMA_SYNC_FLUSH)) { \
196 assert(mf->action != LZMA_RUN); \
197 move_pending(mf); \
198 ret_op; \
200 const uint8_t *cur = mf_ptr(mf); \
201 const uint32_t pos = mf->read_pos + mf->offset
204 /// Header for find functions. "return 0" indicates that zero matches
205 /// were found.
206 #define header_find(is_bt, len_min) \
207 header(is_bt, len_min, return 0); \
208 uint32_t matches_count = 0
211 /// Header for a loop in a skip function. "continue" tells to skip the rest
212 /// of the code in the loop.
213 #define header_skip(is_bt, len_min) \
214 header(is_bt, len_min, continue)
217 /// Calls hc_find_func() or bt_find_func() and calculates the total number
218 /// of matches found. Updates the dictionary position and returns the number
219 /// of matches found.
220 #define call_find(func, len_best) \
221 do { \
222 matches_count = (uint32_t)(func(len_limit, pos, cur, cur_match, \
223 mf->depth, mf->son, \
224 mf->cyclic_pos, mf->cyclic_size, \
225 matches + matches_count, len_best) \
226 - matches); \
227 move_pos(mf); \
228 return matches_count; \
229 } while (0)
232 ////////////////
233 // Hash Chain //
234 ////////////////
236 #if defined(HAVE_MF_HC3) || defined(HAVE_MF_HC4)
239 /// \param len_limit Don't look for matches longer than len_limit.
240 /// \param pos lzma_mf.read_pos + lzma_mf.offset
241 /// \param cur Pointer to current byte (mf_ptr(mf))
242 /// \param cur_match Start position of the current match candidate
243 /// \param depth Maximum length of the hash chain
244 /// \param son lzma_mf.son (contains the hash chain)
245 /// \param cyclic_pos lzma_mf.cyclic_pos
246 /// \param cyclic_size lzma_mf_cyclic_size
247 /// \param matches Array to hold the matches.
248 /// \param len_best The length of the longest match found so far.
249 static lzma_match *
250 hc_find_func(
251 const uint32_t len_limit,
252 const uint32_t pos,
253 const uint8_t *const cur,
254 uint32_t cur_match,
255 uint32_t depth,
256 uint32_t *const son,
257 const uint32_t cyclic_pos,
258 const uint32_t cyclic_size,
259 lzma_match *matches,
260 uint32_t len_best)
262 son[cyclic_pos] = cur_match;
264 while (true) {
265 const uint32_t delta = pos - cur_match;
266 if (depth-- == 0 || delta >= cyclic_size)
267 return matches;
269 const uint8_t *const pb = cur - delta;
270 cur_match = son[cyclic_pos - delta
271 + (delta > cyclic_pos ? cyclic_size : 0)];
273 if (pb[len_best] == cur[len_best] && pb[0] == cur[0]) {
274 uint32_t len = lzma_memcmplen(pb, cur, 1, len_limit);
276 if (len_best < len) {
277 len_best = len;
278 matches->len = len;
279 matches->dist = delta - 1;
280 ++matches;
282 if (len == len_limit)
283 return matches;
290 #define hc_find(len_best) \
291 call_find(hc_find_func, len_best)
294 #define hc_skip() \
295 do { \
296 mf->son[mf->cyclic_pos] = cur_match; \
297 move_pos(mf); \
298 } while (0)
300 #endif
303 #ifdef HAVE_MF_HC3
304 extern uint32_t
305 lzma_mf_hc3_find(lzma_mf *mf, lzma_match *matches)
307 header_find(false, 3);
309 hash_3_calc();
311 const uint32_t delta2 = pos - mf->hash[hash_2_value];
312 const uint32_t cur_match = mf->hash[FIX_3_HASH_SIZE + hash_value];
314 mf->hash[hash_2_value] = pos;
315 mf->hash[FIX_3_HASH_SIZE + hash_value] = pos;
317 uint32_t len_best = 2;
319 if (delta2 < mf->cyclic_size && *(cur - delta2) == *cur) {
320 len_best = lzma_memcmplen(cur - delta2, cur,
321 len_best, len_limit);
323 matches[0].len = len_best;
324 matches[0].dist = delta2 - 1;
325 matches_count = 1;
327 if (len_best == len_limit) {
328 hc_skip();
329 return 1; // matches_count
333 hc_find(len_best);
337 extern void
338 lzma_mf_hc3_skip(lzma_mf *mf, uint32_t amount)
340 do {
341 if (mf_avail(mf) < 3) {
342 move_pending(mf);
343 continue;
346 const uint8_t *cur = mf_ptr(mf);
347 const uint32_t pos = mf->read_pos + mf->offset;
349 hash_3_calc();
351 const uint32_t cur_match
352 = mf->hash[FIX_3_HASH_SIZE + hash_value];
354 mf->hash[hash_2_value] = pos;
355 mf->hash[FIX_3_HASH_SIZE + hash_value] = pos;
357 hc_skip();
359 } while (--amount != 0);
361 #endif
364 #ifdef HAVE_MF_HC4
365 extern uint32_t
366 lzma_mf_hc4_find(lzma_mf *mf, lzma_match *matches)
368 header_find(false, 4);
370 hash_4_calc();
372 uint32_t delta2 = pos - mf->hash[hash_2_value];
373 const uint32_t delta3
374 = pos - mf->hash[FIX_3_HASH_SIZE + hash_3_value];
375 const uint32_t cur_match = mf->hash[FIX_4_HASH_SIZE + hash_value];
377 mf->hash[hash_2_value ] = pos;
378 mf->hash[FIX_3_HASH_SIZE + hash_3_value] = pos;
379 mf->hash[FIX_4_HASH_SIZE + hash_value] = pos;
381 uint32_t len_best = 1;
383 if (delta2 < mf->cyclic_size && *(cur - delta2) == *cur) {
384 len_best = 2;
385 matches[0].len = 2;
386 matches[0].dist = delta2 - 1;
387 matches_count = 1;
390 if (delta2 != delta3 && delta3 < mf->cyclic_size
391 && *(cur - delta3) == *cur) {
392 len_best = 3;
393 matches[matches_count++].dist = delta3 - 1;
394 delta2 = delta3;
397 if (matches_count != 0) {
398 len_best = lzma_memcmplen(cur - delta2, cur,
399 len_best, len_limit);
401 matches[matches_count - 1].len = len_best;
403 if (len_best == len_limit) {
404 hc_skip();
405 return matches_count;
409 if (len_best < 3)
410 len_best = 3;
412 hc_find(len_best);
416 extern void
417 lzma_mf_hc4_skip(lzma_mf *mf, uint32_t amount)
419 do {
420 if (mf_avail(mf) < 4) {
421 move_pending(mf);
422 continue;
425 const uint8_t *cur = mf_ptr(mf);
426 const uint32_t pos = mf->read_pos + mf->offset;
428 hash_4_calc();
430 const uint32_t cur_match
431 = mf->hash[FIX_4_HASH_SIZE + hash_value];
433 mf->hash[hash_2_value] = pos;
434 mf->hash[FIX_3_HASH_SIZE + hash_3_value] = pos;
435 mf->hash[FIX_4_HASH_SIZE + hash_value] = pos;
437 hc_skip();
439 } while (--amount != 0);
441 #endif
444 /////////////////
445 // Binary Tree //
446 /////////////////
448 #if defined(HAVE_MF_BT2) || defined(HAVE_MF_BT3) || defined(HAVE_MF_BT4)
449 static lzma_match *
450 bt_find_func(
451 const uint32_t len_limit,
452 const uint32_t pos,
453 const uint8_t *const cur,
454 uint32_t cur_match,
455 uint32_t depth,
456 uint32_t *const son,
457 const uint32_t cyclic_pos,
458 const uint32_t cyclic_size,
459 lzma_match *matches,
460 uint32_t len_best)
462 uint32_t *ptr0 = son + (cyclic_pos << 1) + 1;
463 uint32_t *ptr1 = son + (cyclic_pos << 1);
465 uint32_t len0 = 0;
466 uint32_t len1 = 0;
468 while (true) {
469 const uint32_t delta = pos - cur_match;
470 if (depth-- == 0 || delta >= cyclic_size) {
471 *ptr0 = EMPTY_HASH_VALUE;
472 *ptr1 = EMPTY_HASH_VALUE;
473 return matches;
476 uint32_t *const pair = son + ((cyclic_pos - delta
477 + (delta > cyclic_pos ? cyclic_size : 0))
478 << 1);
480 const uint8_t *const pb = cur - delta;
481 uint32_t len = my_min(len0, len1);
483 if (pb[len] == cur[len]) {
484 len = lzma_memcmplen(pb, cur, len + 1, len_limit);
486 if (len_best < len) {
487 len_best = len;
488 matches->len = len;
489 matches->dist = delta - 1;
490 ++matches;
492 if (len == len_limit) {
493 *ptr1 = pair[0];
494 *ptr0 = pair[1];
495 return matches;
500 if (pb[len] < cur[len]) {
501 *ptr1 = cur_match;
502 ptr1 = pair + 1;
503 cur_match = *ptr1;
504 len1 = len;
505 } else {
506 *ptr0 = cur_match;
507 ptr0 = pair;
508 cur_match = *ptr0;
509 len0 = len;
515 static void
516 bt_skip_func(
517 const uint32_t len_limit,
518 const uint32_t pos,
519 const uint8_t *const cur,
520 uint32_t cur_match,
521 uint32_t depth,
522 uint32_t *const son,
523 const uint32_t cyclic_pos,
524 const uint32_t cyclic_size)
526 uint32_t *ptr0 = son + (cyclic_pos << 1) + 1;
527 uint32_t *ptr1 = son + (cyclic_pos << 1);
529 uint32_t len0 = 0;
530 uint32_t len1 = 0;
532 while (true) {
533 const uint32_t delta = pos - cur_match;
534 if (depth-- == 0 || delta >= cyclic_size) {
535 *ptr0 = EMPTY_HASH_VALUE;
536 *ptr1 = EMPTY_HASH_VALUE;
537 return;
540 uint32_t *pair = son + ((cyclic_pos - delta
541 + (delta > cyclic_pos ? cyclic_size : 0))
542 << 1);
543 const uint8_t *pb = cur - delta;
544 uint32_t len = my_min(len0, len1);
546 if (pb[len] == cur[len]) {
547 len = lzma_memcmplen(pb, cur, len + 1, len_limit);
549 if (len == len_limit) {
550 *ptr1 = pair[0];
551 *ptr0 = pair[1];
552 return;
556 if (pb[len] < cur[len]) {
557 *ptr1 = cur_match;
558 ptr1 = pair + 1;
559 cur_match = *ptr1;
560 len1 = len;
561 } else {
562 *ptr0 = cur_match;
563 ptr0 = pair;
564 cur_match = *ptr0;
565 len0 = len;
571 #define bt_find(len_best) \
572 call_find(bt_find_func, len_best)
574 #define bt_skip() \
575 do { \
576 bt_skip_func(len_limit, pos, cur, cur_match, mf->depth, \
577 mf->son, mf->cyclic_pos, \
578 mf->cyclic_size); \
579 move_pos(mf); \
580 } while (0)
582 #endif
585 #ifdef HAVE_MF_BT2
586 extern uint32_t
587 lzma_mf_bt2_find(lzma_mf *mf, lzma_match *matches)
589 header_find(true, 2);
591 hash_2_calc();
593 const uint32_t cur_match = mf->hash[hash_value];
594 mf->hash[hash_value] = pos;
596 bt_find(1);
600 extern void
601 lzma_mf_bt2_skip(lzma_mf *mf, uint32_t amount)
603 do {
604 header_skip(true, 2);
606 hash_2_calc();
608 const uint32_t cur_match = mf->hash[hash_value];
609 mf->hash[hash_value] = pos;
611 bt_skip();
613 } while (--amount != 0);
615 #endif
618 #ifdef HAVE_MF_BT3
619 extern uint32_t
620 lzma_mf_bt3_find(lzma_mf *mf, lzma_match *matches)
622 header_find(true, 3);
624 hash_3_calc();
626 const uint32_t delta2 = pos - mf->hash[hash_2_value];
627 const uint32_t cur_match = mf->hash[FIX_3_HASH_SIZE + hash_value];
629 mf->hash[hash_2_value] = pos;
630 mf->hash[FIX_3_HASH_SIZE + hash_value] = pos;
632 uint32_t len_best = 2;
634 if (delta2 < mf->cyclic_size && *(cur - delta2) == *cur) {
635 len_best = lzma_memcmplen(
636 cur, cur - delta2, len_best, len_limit);
638 matches[0].len = len_best;
639 matches[0].dist = delta2 - 1;
640 matches_count = 1;
642 if (len_best == len_limit) {
643 bt_skip();
644 return 1; // matches_count
648 bt_find(len_best);
652 extern void
653 lzma_mf_bt3_skip(lzma_mf *mf, uint32_t amount)
655 do {
656 header_skip(true, 3);
658 hash_3_calc();
660 const uint32_t cur_match
661 = mf->hash[FIX_3_HASH_SIZE + hash_value];
663 mf->hash[hash_2_value] = pos;
664 mf->hash[FIX_3_HASH_SIZE + hash_value] = pos;
666 bt_skip();
668 } while (--amount != 0);
670 #endif
673 #ifdef HAVE_MF_BT4
674 extern uint32_t
675 lzma_mf_bt4_find(lzma_mf *mf, lzma_match *matches)
677 header_find(true, 4);
679 hash_4_calc();
681 uint32_t delta2 = pos - mf->hash[hash_2_value];
682 const uint32_t delta3
683 = pos - mf->hash[FIX_3_HASH_SIZE + hash_3_value];
684 const uint32_t cur_match = mf->hash[FIX_4_HASH_SIZE + hash_value];
686 mf->hash[hash_2_value] = pos;
687 mf->hash[FIX_3_HASH_SIZE + hash_3_value] = pos;
688 mf->hash[FIX_4_HASH_SIZE + hash_value] = pos;
690 uint32_t len_best = 1;
692 if (delta2 < mf->cyclic_size && *(cur - delta2) == *cur) {
693 len_best = 2;
694 matches[0].len = 2;
695 matches[0].dist = delta2 - 1;
696 matches_count = 1;
699 if (delta2 != delta3 && delta3 < mf->cyclic_size
700 && *(cur - delta3) == *cur) {
701 len_best = 3;
702 matches[matches_count++].dist = delta3 - 1;
703 delta2 = delta3;
706 if (matches_count != 0) {
707 len_best = lzma_memcmplen(
708 cur, cur - delta2, len_best, len_limit);
710 matches[matches_count - 1].len = len_best;
712 if (len_best == len_limit) {
713 bt_skip();
714 return matches_count;
718 if (len_best < 3)
719 len_best = 3;
721 bt_find(len_best);
725 extern void
726 lzma_mf_bt4_skip(lzma_mf *mf, uint32_t amount)
728 do {
729 header_skip(true, 4);
731 hash_4_calc();
733 const uint32_t cur_match
734 = mf->hash[FIX_4_HASH_SIZE + hash_value];
736 mf->hash[hash_2_value] = pos;
737 mf->hash[FIX_3_HASH_SIZE + hash_3_value] = pos;
738 mf->hash[FIX_4_HASH_SIZE + hash_value] = pos;
740 bt_skip();
742 } while (--amount != 0);
744 #endif