7 * The author dedicates this file to the public domain.
8 * You can do whatever you want with this file.
10 * ----------------------------------------------------------------------------
12 * This is a Binary Trees (bt) based matchfinder.
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.
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.
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.
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.
45 * ----------------------------------------------------------------------------
48 #ifndef _BT_MATCHFINDER_H
49 #define _BT_MATCHFINDER_H
51 #include "wimlib/lz_extend.h"
52 #include "wimlib/lz_hash.h"
53 #include "wimlib/matchfinder_common.h"
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
60 # define BT_MATCHFINDER_HASH_ORDER 16
63 #define BT_MATCHFINDER_HASH_LENGTH (1UL << BT_MATCHFINDER_HASH_ORDER)
65 struct bt_matchfinder {
66 pos_t hash_tab[BT_MATCHFINDER_HASH_LENGTH];
68 } _aligned_attribute(MATCHFINDER_ALIGNMENT);
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. */
73 bt_matchfinder_size(size_t max_bufsize)
75 return sizeof(pos_t) * (BT_MATCHFINDER_HASH_LENGTH + (2 * max_bufsize));
78 /* Prepare the matchfinder for a new input buffer. */
80 bt_matchfinder_init(struct bt_matchfinder *mf)
82 matchfinder_init(mf->hash_tab, BT_MATCHFINDER_HASH_LENGTH);
86 bt_matchfinder_hash_3_bytes(const u8 *in_next)
88 return lz_hash_3_bytes(in_next, BT_MATCHFINDER_HASH_ORDER);
92 bt_child(struct bt_matchfinder *mf, pos_t node, int offset)
94 if (MATCHFINDER_MAX_WINDOW_ORDER < sizeof(pos_t) * 8) {
96 return &mf->child_tab[(node << 1) + offset];
98 return &mf->child_tab[((size_t)node << 1) + offset];
102 static inline pos_t *
103 bt_left_child(struct bt_matchfinder *mf, pos_t node)
105 return bt_child(mf, node, 0);
108 static inline pos_t *
109 bt_right_child(struct bt_matchfinder *mf, pos_t node)
111 return bt_child(mf, node, 1);
115 * Retrieve a list of matches with the current position.
118 * The matchfinder structure.
120 * Pointer to the beginning of the input buffer.
122 * Pointer to the next byte in the input buffer to process. This is the
123 * pointer to the sequence being matched against.
125 * Only record matches that are at least this long.
127 * The maximum permissible match length at this position.
129 * Stop searching if a match of at least this length is found.
130 * Must be <= @max_len.
132 * Limit on the number of potential matches to consider. Must be >= 1.
134 * Pointer to the hash code for the current sequence, which was computed
135 * one position in advance so that the binary tree root could be
136 * prefetched. This is an input/output parameter.
138 * The length of the longest match found is written here. (This is
139 * actually redundant with the 'struct lz_match' array, but this is easier
140 * for the compiler to optimize when inlined and the caller immediately
141 * does a check against 'best_len'.)
143 * An array in which this function will record the matches. The recorded
144 * matches will be sorted by strictly increasing length and strictly
145 * increasing offset. The maximum number of matches that may be found is
146 * 'min(nice_len, max_len) - 3 + 1'.
148 * The return value is a pointer to the next available slot in the @lz_matchptr
149 * array. (If no matches were found, this will be the same as @lz_matchptr.)
151 static inline struct lz_match *
152 bt_matchfinder_get_matches(struct bt_matchfinder * const restrict mf,
153 const u8 * const in_begin,
154 const u8 * const in_next,
155 const unsigned min_len,
156 const unsigned max_len,
157 const unsigned nice_len,
158 const unsigned max_search_depth,
159 u32 * restrict next_hash,
160 unsigned * restrict best_len_ret,
161 struct lz_match * restrict lz_matchptr)
163 unsigned depth_remaining = max_search_depth;
167 pos_t *pending_lt_ptr, *pending_gt_ptr;
168 unsigned best_lt_len, best_gt_len;
170 unsigned best_len = min_len - 1;
172 if (unlikely(max_len < LZ_HASH_REQUIRED_NBYTES + 1)) {
173 *best_len_ret = best_len;
178 *next_hash = bt_matchfinder_hash_3_bytes(in_next + 1);
179 cur_node = mf->hash_tab[hash];
180 mf->hash_tab[hash] = in_next - in_begin;
181 prefetch(&mf->hash_tab[*next_hash]);
183 pending_lt_ptr = bt_left_child(mf, in_next - in_begin);
184 pending_gt_ptr = bt_right_child(mf, in_next - in_begin);
189 if (!matchfinder_node_valid(cur_node)) {
190 *pending_lt_ptr = MATCHFINDER_NULL;
191 *pending_gt_ptr = MATCHFINDER_NULL;
192 *best_len_ret = best_len;
197 matchptr = &in_begin[cur_node];
199 if (matchptr[len] == in_next[len]) {
200 len = lz_extend(in_next, matchptr, len + 1, max_len);
201 if (len > best_len) {
203 lz_matchptr->length = len;
204 lz_matchptr->offset = in_next - matchptr;
206 if (len >= nice_len) {
207 *pending_lt_ptr = *bt_left_child(mf, cur_node);
208 *pending_gt_ptr = *bt_right_child(mf, cur_node);
209 *best_len_ret = best_len;
215 if (matchptr[len] < in_next[len]) {
216 *pending_lt_ptr = cur_node;
217 pending_lt_ptr = bt_right_child(mf, cur_node);
218 cur_node = *pending_lt_ptr;
220 if (best_gt_len < len)
223 *pending_gt_ptr = cur_node;
224 pending_gt_ptr = bt_left_child(mf, cur_node);
225 cur_node = *pending_gt_ptr;
227 if (best_lt_len < len)
231 if (!matchfinder_node_valid(cur_node) || !--depth_remaining) {
232 *pending_lt_ptr = MATCHFINDER_NULL;
233 *pending_gt_ptr = MATCHFINDER_NULL;
234 *best_len_ret = best_len;
241 * Advance the matchfinder, but don't record any matches.
244 * The matchfinder structure.
246 * Pointer to the beginning of the input buffer.
248 * Pointer to the next byte in the input buffer to process.
250 * Pointer to the end of the input buffer.
252 * Stop searching if a match of at least this length is found.
254 * Limit on the number of potential matches to consider.
256 * Pointer to the hash code for the current sequence, which was computed
257 * one position in advance so that the binary tree root could be
258 * prefetched. This is an input/output parameter.
260 * Note: this is very similar to bt_matchfinder_get_matches() because both
261 * functions must do hashing and tree re-rooting. This version just doesn't
262 * actually record any matches.
265 bt_matchfinder_skip_position(struct bt_matchfinder * const restrict mf,
266 const u8 * const in_begin,
267 const u8 * const in_next,
268 const u8 * const in_end,
269 const unsigned nice_len,
270 const unsigned max_search_depth,
271 u32 * restrict next_hash)
273 unsigned depth_remaining = max_search_depth;
277 pos_t *pending_lt_ptr, *pending_gt_ptr;
278 unsigned best_lt_len, best_gt_len;
281 if (unlikely(in_end - in_next < LZ_HASH_REQUIRED_NBYTES + 1))
285 *next_hash = bt_matchfinder_hash_3_bytes(in_next + 1);
286 cur_node = mf->hash_tab[hash];
287 mf->hash_tab[hash] = in_next - in_begin;
288 prefetch(&mf->hash_tab[*next_hash]);
290 depth_remaining = max_search_depth;
291 pending_lt_ptr = bt_left_child(mf, in_next - in_begin);
292 pending_gt_ptr = bt_right_child(mf, in_next - in_begin);
297 if (!matchfinder_node_valid(cur_node)) {
298 *pending_lt_ptr = MATCHFINDER_NULL;
299 *pending_gt_ptr = MATCHFINDER_NULL;
304 matchptr = &in_begin[cur_node];
306 if (matchptr[len] == in_next[len]) {
307 len = lz_extend(in_next, matchptr, len + 1, nice_len);
308 if (len == nice_len) {
309 *pending_lt_ptr = *bt_left_child(mf, cur_node);
310 *pending_gt_ptr = *bt_right_child(mf, cur_node);
315 if (matchptr[len] < in_next[len]) {
316 *pending_lt_ptr = cur_node;
317 pending_lt_ptr = bt_right_child(mf, cur_node);
318 cur_node = *pending_lt_ptr;
320 if (best_gt_len < len)
323 *pending_gt_ptr = cur_node;
324 pending_gt_ptr = bt_left_child(mf, cur_node);
325 cur_node = *pending_gt_ptr;
327 if (best_lt_len < len)
331 if (!matchfinder_node_valid(cur_node) || !--depth_remaining) {
332 *pending_lt_ptr = MATCHFINDER_NULL;
333 *pending_gt_ptr = MATCHFINDER_NULL;
339 #endif /* _BT_MATCHFINDER_H */