1d30e36216a05876e8074956b3b7dfe4de2e012c
[wimlib] / include / wimlib / bt_matchfinder.h
1 /*
2  * bt_matchfinder.h
3  *
4  * Author:      Eric Biggers
5  * Year:        2014, 2015
6  *
7  * The author dedicates this file to the public domain.
8  * You can do whatever you want with this file.
9  *
10  * ----------------------------------------------------------------------------
11  *
12  * This is a Binary Trees (bt) based matchfinder.
13  *
14  * The data structure is a hash table where each hash bucket contains a binary
15  * tree of sequences whose first 3 bytes share the same hash code.  Each
16  * sequence is identified by its starting position in the input buffer.  Each
17  * binary tree is always sorted such that each left child represents a sequence
18  * lexicographically lesser than its parent and each right child represents a
19  * sequence lexicographically greater than its parent.
20  *
21  * The algorithm processes the input buffer sequentially.  At each byte
22  * position, the hash code of the first 3 bytes of the sequence beginning at
23  * that position (the sequence being matched against) is computed.  This
24  * identifies the hash bucket to use for that position.  Then, a new binary tree
25  * node is created to represent the current sequence.  Then, in a single tree
26  * traversal, the hash bucket's binary tree is searched for matches and is
27  * re-rooted at the new node.
28  *
29  * Compared to the simpler algorithm that uses linked lists instead of binary
30  * trees (see hc_matchfinder.h), the binary tree version gains more information
31  * at each node visitation.  Ideally, the binary tree version will examine only
32  * 'log(n)' nodes to find the same matches that the linked list version will
33  * find by examining 'n' nodes.  In addition, the binary tree version can
34  * examine fewer bytes at each node by taking advantage of the common prefixes
35  * that result from the sort order, whereas the linked list version may have to
36  * examine up to the full length of the match at each node.
37  *
38  * However, it is not always best to use the binary tree version.  It requires
39  * nearly twice as much memory as the linked list version, and it takes time to
40  * keep the binary trees sorted, even at positions where the compressor does not
41  * need matches.  Generally, when doing fast compression on small buffers,
42  * binary trees are the wrong approach.  They are best suited for thorough
43  * compression and/or large buffers.
44  *
45  * ----------------------------------------------------------------------------
46  */
47
48 #ifndef _BT_MATCHFINDER_H
49 #define _BT_MATCHFINDER_H
50
51 #include "wimlib/lz_extend.h"
52 #include "wimlib/lz_hash.h"
53 #include "wimlib/matchfinder_common.h"
54
55 #if MATCHFINDER_MAX_WINDOW_ORDER < 13
56 #  define BT_MATCHFINDER_HASH_ORDER 14
57 #elif MATCHFINDER_MAX_WINDOW_ORDER < 15
58 #  define BT_MATCHFINDER_HASH_ORDER 15
59 #else
60 #  define BT_MATCHFINDER_HASH_ORDER 16
61 #endif
62
63 #define BT_MATCHFINDER_HASH_LENGTH      (1UL << BT_MATCHFINDER_HASH_ORDER)
64
65 struct bt_matchfinder {
66         pos_t hash_tab[BT_MATCHFINDER_HASH_LENGTH];
67         pos_t child_tab[];
68 } _aligned_attribute(MATCHFINDER_ALIGNMENT);
69
70 /* Return the number of bytes that must be allocated for a 'bt_matchfinder' that
71  * can work with buffers up to the specified size.  */
72 static inline size_t
73 bt_matchfinder_size(size_t max_bufsize)
74 {
75         return sizeof(pos_t) * (BT_MATCHFINDER_HASH_LENGTH + (2 * max_bufsize));
76 }
77
78 /* Prepare the matchfinder for a new input buffer.  */
79 static inline void
80 bt_matchfinder_init(struct bt_matchfinder *mf)
81 {
82         matchfinder_init(mf->hash_tab, BT_MATCHFINDER_HASH_LENGTH);
83 }
84
85 static inline u32
86 bt_matchfinder_hash_3_bytes(const u8 *in_next)
87 {
88         return lz_hash_3_bytes(in_next, BT_MATCHFINDER_HASH_ORDER);
89 }
90
91 static inline pos_t *
92 bt_child(struct bt_matchfinder *mf, pos_t node, int offset)
93 {
94         if (MATCHFINDER_MAX_WINDOW_ORDER < sizeof(pos_t) * 8) {
95                 /* no cast needed */
96                 return &mf->child_tab[(node << 1) + offset];
97         } else {
98                 return &mf->child_tab[((size_t)node << 1) + offset];
99         }
100 }
101
102 static inline pos_t *
103 bt_left_child(struct bt_matchfinder *mf, pos_t node)
104 {
105         return bt_child(mf, node, 0);
106 }
107
108 static inline pos_t *
109 bt_right_child(struct bt_matchfinder *mf, pos_t node)
110 {
111         return bt_child(mf, node, 1);
112 }
113
114 /*
115  * Retrieve a list of matches with the current position.
116  *
117  * @mf
118  *      The matchfinder structure.
119  * @in_begin
120  *      Pointer to the beginning of the input buffer.
121  * @in_next
122  *      Pointer to the next byte in the input buffer to process.  This is the
123  *      pointer to the sequence being matched against.
124  * @min_len
125  *      Only record matches that are at least this long.
126  * @max_len
127  *      The maximum permissible match length at this position.
128  * @nice_len
129  *      Stop searching if a match of at least this length is found.
130  * @max_search_depth
131  *      Limit on the number of potential matches to consider.
132  * @next_hash
133  *      Pointer to the hash code for the current sequence, which was computed
134  *      one position in advance so that the binary tree root could be
135  *      prefetched.  This is an input/output parameter.
136  * @best_len_ret
137  *      The length of the longest match found is written here.  (This is
138  *      actually redundant with the 'struct lz_match' array, but this is easier
139  *      for the compiler to optimize when inlined and the caller immediately
140  *      does a check against 'best_len'.)
141  * @lz_matchptr
142  *      An array in which this function will record the matches.  The recorded
143  *      matches will be sorted by strictly increasing length and strictly
144  *      increasing offset.  The maximum number of matches that may be found is
145  *      'min(nice_len, max_len) - 3 + 1'.
146  *
147  * The return value is a pointer to the next available slot in the @lz_matchptr
148  * array.  (If no matches were found, this will be the same as @lz_matchptr.)
149  */
150 static inline struct lz_match *
151 bt_matchfinder_get_matches(struct bt_matchfinder * const restrict mf,
152                            const u8 * const in_begin,
153                            const u8 * const in_next,
154                            const unsigned min_len,
155                            const unsigned max_len,
156                            const unsigned nice_len,
157                            const unsigned max_search_depth,
158                            u32 * restrict next_hash,
159                            unsigned * restrict best_len_ret,
160                            struct lz_match * restrict lz_matchptr)
161 {
162         unsigned depth_remaining = max_search_depth;
163         u32 hash;
164         pos_t cur_node;
165         const u8 *matchptr;
166         pos_t *pending_lt_ptr, *pending_gt_ptr;
167         unsigned best_lt_len, best_gt_len;
168         unsigned len;
169         unsigned best_len = min_len - 1;
170
171         if (unlikely(max_len < LZ_HASH_REQUIRED_NBYTES + 1)) {
172                 *best_len_ret = best_len;
173                 return lz_matchptr;
174         }
175
176         hash = *next_hash;
177         *next_hash = bt_matchfinder_hash_3_bytes(in_next + 1);
178         cur_node = mf->hash_tab[hash];
179         mf->hash_tab[hash] = in_next - in_begin;
180         prefetch(&mf->hash_tab[*next_hash]);
181
182         pending_lt_ptr = bt_left_child(mf, in_next - in_begin);
183         pending_gt_ptr = bt_right_child(mf, in_next - in_begin);
184         best_lt_len = 0;
185         best_gt_len = 0;
186         len = 0;
187
188         if (!matchfinder_node_valid(cur_node)) {
189                 *pending_lt_ptr = MATCHFINDER_NULL;
190                 *pending_gt_ptr = MATCHFINDER_NULL;
191                 *best_len_ret = best_len;
192                 return lz_matchptr;
193         }
194
195         for (;;) {
196                 matchptr = &in_begin[cur_node];
197
198                 if (matchptr[len] == in_next[len]) {
199                         len = lz_extend(in_next, matchptr, len + 1, max_len);
200                         if (len > best_len) {
201                                 best_len = len;
202                                 lz_matchptr->length = len;
203                                 lz_matchptr->offset = in_next - matchptr;
204                                 lz_matchptr++;
205                                 if (len >= nice_len) {
206                                         *pending_lt_ptr = *bt_left_child(mf, cur_node);
207                                         *pending_gt_ptr = *bt_right_child(mf, cur_node);
208                                         *best_len_ret = best_len;
209                                         return lz_matchptr;
210                                 }
211                         }
212                 }
213
214                 if (matchptr[len] < in_next[len]) {
215                         *pending_lt_ptr = cur_node;
216                         pending_lt_ptr = bt_right_child(mf, cur_node);
217                         cur_node = *pending_lt_ptr;
218                         best_lt_len = len;
219                         if (best_gt_len < len)
220                                 len = best_gt_len;
221                 } else {
222                         *pending_gt_ptr = cur_node;
223                         pending_gt_ptr = bt_left_child(mf, cur_node);
224                         cur_node = *pending_gt_ptr;
225                         best_gt_len = len;
226                         if (best_lt_len < len)
227                                 len = best_lt_len;
228                 }
229
230                 if (!matchfinder_node_valid(cur_node) || !--depth_remaining) {
231                         *pending_lt_ptr = MATCHFINDER_NULL;
232                         *pending_gt_ptr = MATCHFINDER_NULL;
233                         *best_len_ret = best_len;
234                         return lz_matchptr;
235                 }
236         }
237 }
238
239 /*
240  * Advance the matchfinder, but don't record any matches.
241  *
242  * @mf
243  *      The matchfinder structure.
244  * @in_begin
245  *      Pointer to the beginning of the input buffer.
246  * @in_next
247  *      Pointer to the next byte in the input buffer to process.
248  * @in_end
249  *      Pointer to the end of the input buffer.
250  * @nice_len
251  *      Stop searching if a match of at least this length is found.
252  * @max_search_depth
253  *      Limit on the number of potential matches to consider.
254  * @next_hash
255  *      Pointer to the hash code for the current sequence, which was computed
256  *      one position in advance so that the binary tree root could be
257  *      prefetched.  This is an input/output parameter.
258  *
259  * Note: this is very similar to bt_matchfinder_get_matches() because both
260  * functions must do hashing and tree re-rooting.  This version just doesn't
261  * actually record any matches.
262  */
263 static inline void
264 bt_matchfinder_skip_position(struct bt_matchfinder * const restrict mf,
265                              const u8 * const in_begin,
266                              const u8 * const in_next,
267                              const u8 * const in_end,
268                              const unsigned nice_len,
269                              const unsigned max_search_depth,
270                              u32 * restrict next_hash)
271 {
272         unsigned depth_remaining = max_search_depth;
273         u32 hash;
274         pos_t cur_node;
275         const u8 *matchptr;
276         pos_t *pending_lt_ptr, *pending_gt_ptr;
277         unsigned best_lt_len, best_gt_len;
278         unsigned len;
279
280         if (unlikely(in_end - in_next < LZ_HASH_REQUIRED_NBYTES + 1))
281                 return;
282
283         hash = *next_hash;
284         *next_hash = bt_matchfinder_hash_3_bytes(in_next + 1);
285         cur_node = mf->hash_tab[hash];
286         mf->hash_tab[hash] = in_next - in_begin;
287         prefetch(&mf->hash_tab[*next_hash]);
288
289         depth_remaining = max_search_depth;
290         pending_lt_ptr = bt_left_child(mf, in_next - in_begin);
291         pending_gt_ptr = bt_right_child(mf, in_next - in_begin);
292         best_lt_len = 0;
293         best_gt_len = 0;
294         len = 0;
295
296         if (!matchfinder_node_valid(cur_node)) {
297                 *pending_lt_ptr = MATCHFINDER_NULL;
298                 *pending_gt_ptr = MATCHFINDER_NULL;
299                 return;
300         }
301
302         for (;;) {
303                 matchptr = &in_begin[cur_node];
304
305                 if (matchptr[len] == in_next[len]) {
306                         len = lz_extend(in_next, matchptr, len + 1, nice_len);
307                         if (len == nice_len) {
308                                 *pending_lt_ptr = *bt_left_child(mf, cur_node);
309                                 *pending_gt_ptr = *bt_right_child(mf, cur_node);
310                                 return;
311                         }
312                 }
313
314                 if (matchptr[len] < in_next[len]) {
315                         *pending_lt_ptr = cur_node;
316                         pending_lt_ptr = bt_right_child(mf, cur_node);
317                         cur_node = *pending_lt_ptr;
318                         best_lt_len = len;
319                         if (best_gt_len < len)
320                                 len = best_gt_len;
321                 } else {
322                         *pending_gt_ptr = cur_node;
323                         pending_gt_ptr = bt_left_child(mf, cur_node);
324                         cur_node = *pending_gt_ptr;
325                         best_gt_len = len;
326                         if (best_lt_len < len)
327                                 len = best_lt_len;
328                 }
329
330                 if (!matchfinder_node_valid(cur_node) || !--depth_remaining) {
331                         *pending_lt_ptr = MATCHFINDER_NULL;
332                         *pending_gt_ptr = MATCHFINDER_NULL;
333                         return;
334                 }
335         }
336 }
337
338 #endif /* _BT_MATCHFINDER_H */