snappy 0.3.0-java → 0.5.0-java

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/main.yml +2 -2
  3. data/.github/workflows/publish.yml +7 -13
  4. data/Dockerfile +1 -1
  5. data/Gemfile +1 -0
  6. data/README.md +20 -1
  7. data/Rakefile +1 -1
  8. data/ext/extconf.rb +13 -11
  9. data/lib/snappy/shim.rb +3 -23
  10. data/lib/snappy/version.rb +1 -1
  11. data/lib/snappy/writer.rb +1 -1
  12. data/lib/snappy_ext.jar +0 -0
  13. data/snappy.gemspec +1 -0
  14. data/test/snappy_test.rb +29 -4
  15. data/vendor/snappy/BUILD.bazel +211 -0
  16. data/vendor/snappy/CMakeLists.txt +176 -31
  17. data/vendor/snappy/CONTRIBUTING.md +9 -4
  18. data/vendor/snappy/MODULE.bazel +23 -0
  19. data/vendor/snappy/NEWS +27 -0
  20. data/vendor/snappy/README.md +52 -35
  21. data/vendor/snappy/WORKSPACE +27 -0
  22. data/vendor/snappy/WORKSPACE.bzlmod +0 -0
  23. data/vendor/snappy/cmake/config.h.in +30 -23
  24. data/vendor/snappy/snappy-internal.h +218 -25
  25. data/vendor/snappy/snappy-sinksource.cc +26 -9
  26. data/vendor/snappy/snappy-sinksource.h +11 -11
  27. data/vendor/snappy/snappy-stubs-internal.cc +1 -1
  28. data/vendor/snappy/snappy-stubs-internal.h +231 -306
  29. data/vendor/snappy/snappy-stubs-public.h.in +0 -11
  30. data/vendor/snappy/snappy-test.cc +88 -198
  31. data/vendor/snappy/snappy-test.h +102 -285
  32. data/vendor/snappy/snappy.cc +1412 -425
  33. data/vendor/snappy/snappy.h +60 -10
  34. data/vendor/snappy/snappy_benchmark.cc +398 -0
  35. data/vendor/snappy/snappy_compress_fuzzer.cc +21 -16
  36. data/vendor/snappy/snappy_test_data.cc +57 -0
  37. data/vendor/snappy/snappy_test_data.h +68 -0
  38. data/vendor/snappy/snappy_test_tool.cc +471 -0
  39. data/vendor/snappy/snappy_uncompress_fuzzer.cc +3 -2
  40. data/vendor/snappy/snappy_unittest.cc +183 -666
  41. metadata +13 -8
@@ -26,21 +26,9 @@
26
26
  // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27
27
  // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
28
 
29
- #include "snappy.h"
30
29
  #include "snappy-internal.h"
31
30
  #include "snappy-sinksource.h"
32
-
33
- #if !defined(SNAPPY_HAVE_SSSE3)
34
- // __SSSE3__ is defined by GCC and Clang. Visual Studio doesn't target SIMD
35
- // support between SSE2 and AVX (so SSSE3 instructions require AVX support), and
36
- // defines __AVX__ when AVX support is available.
37
- #if defined(__SSSE3__) || defined(__AVX__)
38
- #define SNAPPY_HAVE_SSSE3 1
39
- #else
40
- #define SNAPPY_HAVE_SSSE3 0
41
- #endif
42
- #endif // !defined(SNAPPY_HAVE_SSSE3)
43
-
31
+ #include "snappy.h"
44
32
  #if !defined(SNAPPY_HAVE_BMI2)
45
33
  // __BMI2__ is defined by GCC and Clang. Visual Studio doesn't target BMI2
46
34
  // specifically, but it does define __AVX2__ when AVX2 support is available.
@@ -56,46 +44,157 @@
56
44
  #endif
57
45
  #endif // !defined(SNAPPY_HAVE_BMI2)
58
46
 
59
- #if SNAPPY_HAVE_SSSE3
60
- // Please do not replace with <x86intrin.h>. or with headers that assume more
61
- // advanced SSE versions without checking with all the OWNERS.
62
- #include <tmmintrin.h>
47
+ #if !defined(SNAPPY_HAVE_X86_CRC32)
48
+ #if defined(__SSE4_2__)
49
+ #define SNAPPY_HAVE_X86_CRC32 1
50
+ #else
51
+ #define SNAPPY_HAVE_X86_CRC32 0
63
52
  #endif
53
+ #endif // !defined(SNAPPY_HAVE_X86_CRC32)
64
54
 
65
- #if SNAPPY_HAVE_BMI2
55
+ #if !defined(SNAPPY_HAVE_NEON_CRC32)
56
+ #if SNAPPY_HAVE_NEON && defined(__ARM_FEATURE_CRC32)
57
+ #define SNAPPY_HAVE_NEON_CRC32 1
58
+ #else
59
+ #define SNAPPY_HAVE_NEON_CRC32 0
60
+ #endif
61
+ #endif // !defined(SNAPPY_HAVE_NEON_CRC32)
62
+
63
+ #if SNAPPY_HAVE_BMI2 || SNAPPY_HAVE_X86_CRC32
66
64
  // Please do not replace with <x86intrin.h>. or with headers that assume more
67
65
  // advanced SSE versions without checking with all the OWNERS.
68
66
  #include <immintrin.h>
67
+ #elif SNAPPY_HAVE_NEON_CRC32
68
+ #include <arm_acle.h>
69
69
  #endif
70
70
 
71
- #include <stdio.h>
72
-
73
71
  #include <algorithm>
72
+ #include <array>
73
+ #include <cstddef>
74
+ #include <cstdint>
75
+ #include <cstdio>
76
+ #include <cstring>
77
+ #include <functional>
78
+ #include <memory>
74
79
  #include <string>
80
+ #include <utility>
75
81
  #include <vector>
76
82
 
77
83
  namespace snappy {
78
84
 
85
+ namespace {
86
+
87
+ // The amount of slop bytes writers are using for unconditional copies.
88
+ constexpr int kSlopBytes = 64;
89
+
90
+ using internal::char_table;
79
91
  using internal::COPY_1_BYTE_OFFSET;
80
92
  using internal::COPY_2_BYTE_OFFSET;
81
- using internal::LITERAL;
82
- using internal::char_table;
93
+ using internal::COPY_4_BYTE_OFFSET;
83
94
  using internal::kMaximumTagLength;
95
+ using internal::LITERAL;
96
+ #if SNAPPY_HAVE_VECTOR_BYTE_SHUFFLE
97
+ using internal::V128;
98
+ using internal::V128_Load;
99
+ using internal::V128_LoadU;
100
+ using internal::V128_Shuffle;
101
+ using internal::V128_StoreU;
102
+ using internal::V128_DupChar;
103
+ #endif
84
104
 
85
- // Any hash function will produce a valid compressed bitstream, but a good
86
- // hash function reduces the number of collisions and thus yields better
87
- // compression for compressible input, and more speed for incompressible
88
- // input. Of course, it doesn't hurt if the hash function is reasonably fast
89
- // either, as it gets called a lot.
90
- static inline uint32 HashBytes(uint32 bytes, int shift) {
91
- uint32 kMul = 0x1e35a7bd;
92
- return (bytes * kMul) >> shift;
105
+ // We translate the information encoded in a tag through a lookup table to a
106
+ // format that requires fewer instructions to decode. Effectively we store
107
+ // the length minus the tag part of the offset. The lowest significant byte
108
+ // thus stores the length. While total length - offset is given by
109
+ // entry - ExtractOffset(type). The nice thing is that the subtraction
110
+ // immediately sets the flags for the necessary check that offset >= length.
111
+ // This folds the cmp with sub. We engineer the long literals and copy-4 to
112
+ // always fail this check, so their presence doesn't affect the fast path.
113
+ // To prevent literals from triggering the guard against offset < length (offset
114
+ // does not apply to literals) the table is giving them a spurious offset of
115
+ // 256.
116
+ inline constexpr int16_t MakeEntry(int16_t len, int16_t offset) {
117
+ return len - (offset << 8);
93
118
  }
94
- static inline uint32 Hash(const char* p, int shift) {
95
- return HashBytes(UNALIGNED_LOAD32(p), shift);
119
+
120
+ inline constexpr int16_t LengthMinusOffset(int data, int type) {
121
+ return type == 3 ? 0xFF // copy-4 (or type == 3)
122
+ : type == 2 ? MakeEntry(data + 1, 0) // copy-2
123
+ : type == 1 ? MakeEntry((data & 7) + 4, data >> 3) // copy-1
124
+ : data < 60 ? MakeEntry(data + 1, 1) // note spurious offset.
125
+ : 0xFF; // long literal
126
+ }
127
+
128
+ inline constexpr int16_t LengthMinusOffset(uint8_t tag) {
129
+ return LengthMinusOffset(tag >> 2, tag & 3);
96
130
  }
97
131
 
98
- size_t MaxCompressedLength(size_t source_len) {
132
+ template <size_t... Ints>
133
+ struct index_sequence {};
134
+
135
+ template <std::size_t N, size_t... Is>
136
+ struct make_index_sequence : make_index_sequence<N - 1, N - 1, Is...> {};
137
+
138
+ template <size_t... Is>
139
+ struct make_index_sequence<0, Is...> : index_sequence<Is...> {};
140
+
141
+ template <size_t... seq>
142
+ constexpr std::array<int16_t, 256> MakeTable(index_sequence<seq...>) {
143
+ return std::array<int16_t, 256>{LengthMinusOffset(seq)...};
144
+ }
145
+
146
+ alignas(64) const std::array<int16_t, 256> kLengthMinusOffset =
147
+ MakeTable(make_index_sequence<256>{});
148
+
149
+ // Given a table of uint16_t whose size is mask / 2 + 1, return a pointer to the
150
+ // relevant entry, if any, for the given bytes. Any hash function will do,
151
+ // but a good hash function reduces the number of collisions and thus yields
152
+ // better compression for compressible input.
153
+ //
154
+ // REQUIRES: mask is 2 * (table_size - 1), and table_size is a power of two.
155
+ inline uint16_t* TableEntry(uint16_t* table, uint32_t bytes, uint32_t mask) {
156
+ // Our choice is quicker-and-dirtier than the typical hash function;
157
+ // empirically, that seems beneficial. The upper bits of kMagic * bytes are a
158
+ // higher-quality hash than the lower bits, so when using kMagic * bytes we
159
+ // also shift right to get a higher-quality end result. There's no similar
160
+ // issue with a CRC because all of the output bits of a CRC are equally good
161
+ // "hashes." So, a CPU instruction for CRC, if available, tends to be a good
162
+ // choice.
163
+ #if SNAPPY_HAVE_NEON_CRC32
164
+ // We use mask as the second arg to the CRC function, as it's about to
165
+ // be used anyway; it'd be equally correct to use 0 or some constant.
166
+ // Mathematically, _mm_crc32_u32 (or similar) is a function of the
167
+ // xor of its arguments.
168
+ const uint32_t hash = __crc32cw(bytes, mask);
169
+ #elif SNAPPY_HAVE_X86_CRC32
170
+ const uint32_t hash = _mm_crc32_u32(bytes, mask);
171
+ #else
172
+ constexpr uint32_t kMagic = 0x1e35a7bd;
173
+ const uint32_t hash = (kMagic * bytes) >> (31 - kMaxHashTableBits);
174
+ #endif
175
+ return reinterpret_cast<uint16_t*>(reinterpret_cast<uintptr_t>(table) +
176
+ (hash & mask));
177
+ }
178
+
179
+ inline uint16_t* TableEntry4ByteMatch(uint16_t* table, uint32_t bytes,
180
+ uint32_t mask) {
181
+ constexpr uint32_t kMagic = 2654435761U;
182
+ const uint32_t hash = (kMagic * bytes) >> (32 - kMaxHashTableBits);
183
+ return reinterpret_cast<uint16_t*>(reinterpret_cast<uintptr_t>(table) +
184
+ (hash & mask));
185
+ }
186
+
187
+ inline uint16_t* TableEntry8ByteMatch(uint16_t* table, uint64_t bytes,
188
+ uint32_t mask) {
189
+ constexpr uint64_t kMagic = 58295818150454627ULL;
190
+ const uint32_t hash = (kMagic * bytes) >> (64 - kMaxHashTableBits);
191
+ return reinterpret_cast<uint16_t*>(reinterpret_cast<uintptr_t>(table) +
192
+ (hash & mask));
193
+ }
194
+
195
+ } // namespace
196
+
197
+ size_t MaxCompressedLength(size_t source_bytes) {
99
198
  // Compressed data can be defined as:
100
199
  // compressed := item* literal*
101
200
  // item := literal* copy
@@ -116,24 +215,34 @@ size_t MaxCompressedLength(size_t source_len) {
116
215
  // I.e., 6 bytes of input turn into 7 bytes of "compressed" data.
117
216
  //
118
217
  // This last factor dominates the blowup, so the final estimate is:
119
- return 32 + source_len + source_len/6;
218
+ return 32 + source_bytes + source_bytes / 6;
120
219
  }
121
220
 
122
221
  namespace {
123
222
 
124
223
  void UnalignedCopy64(const void* src, void* dst) {
125
224
  char tmp[8];
126
- memcpy(tmp, src, 8);
127
- memcpy(dst, tmp, 8);
225
+ std::memcpy(tmp, src, 8);
226
+ std::memcpy(dst, tmp, 8);
128
227
  }
129
228
 
130
229
  void UnalignedCopy128(const void* src, void* dst) {
131
- // memcpy gets vectorized when the appropriate compiler options are used.
132
- // For example, x86 compilers targeting SSE2+ will optimize to an SSE2 load
133
- // and store.
230
+ // std::memcpy() gets vectorized when the appropriate compiler options are
231
+ // used. For example, x86 compilers targeting SSE2+ will optimize to an SSE2
232
+ // load and store.
134
233
  char tmp[16];
135
- memcpy(tmp, src, 16);
136
- memcpy(dst, tmp, 16);
234
+ std::memcpy(tmp, src, 16);
235
+ std::memcpy(dst, tmp, 16);
236
+ }
237
+
238
+ template <bool use_16bytes_chunk>
239
+ inline void ConditionalUnalignedCopy128(const char* src, char* dst) {
240
+ if (use_16bytes_chunk) {
241
+ UnalignedCopy128(src, dst);
242
+ } else {
243
+ UnalignedCopy64(src, dst);
244
+ UnalignedCopy64(src + 8, dst + 8);
245
+ }
137
246
  }
138
247
 
139
248
  // Copy [src, src+(op_limit-op)) to [op, (op_limit-op)) a byte at a time. Used
@@ -145,7 +254,8 @@ void UnalignedCopy128(const void* src, void* dst) {
145
254
  // After IncrementalCopySlow(src, op, op_limit), the result will have eleven
146
255
  // copies of "ab"
147
256
  // ababababababababababab
148
- // Note that this does not match the semantics of either memcpy() or memmove().
257
+ // Note that this does not match the semantics of either std::memcpy() or
258
+ // std::memmove().
149
259
  inline char* IncrementalCopySlow(const char* src, char* op,
150
260
  char* const op_limit) {
151
261
  // TODO: Remove pragma when LLVM is aware this
@@ -160,39 +270,179 @@ inline char* IncrementalCopySlow(const char* src, char* op,
160
270
  return op_limit;
161
271
  }
162
272
 
163
- #if SNAPPY_HAVE_SSSE3
273
+ #if SNAPPY_HAVE_VECTOR_BYTE_SHUFFLE
274
+
275
+ // Computes the bytes for shuffle control mask (please read comments on
276
+ // 'pattern_generation_masks' as well) for the given index_offset and
277
+ // pattern_size. For example, when the 'offset' is 6, it will generate a
278
+ // repeating pattern of size 6. So, the first 16 byte indexes will correspond to
279
+ // the pattern-bytes {0, 1, 2, 3, 4, 5, 0, 1, 2, 3, 4, 5, 0, 1, 2, 3} and the
280
+ // next 16 byte indexes will correspond to the pattern-bytes {4, 5, 0, 1, 2, 3,
281
+ // 4, 5, 0, 1, 2, 3, 4, 5, 0, 1}. These byte index sequences are generated by
282
+ // calling MakePatternMaskBytes(0, 6, index_sequence<16>()) and
283
+ // MakePatternMaskBytes(16, 6, index_sequence<16>()) respectively.
284
+ template <size_t... indexes>
285
+ inline constexpr std::array<char, sizeof...(indexes)> MakePatternMaskBytes(
286
+ int index_offset, int pattern_size, index_sequence<indexes...>) {
287
+ return {static_cast<char>((index_offset + indexes) % pattern_size)...};
288
+ }
289
+
290
+ // Computes the shuffle control mask bytes array for given pattern-sizes and
291
+ // returns an array.
292
+ template <size_t... pattern_sizes_minus_one>
293
+ inline constexpr std::array<std::array<char, sizeof(V128)>,
294
+ sizeof...(pattern_sizes_minus_one)>
295
+ MakePatternMaskBytesTable(int index_offset,
296
+ index_sequence<pattern_sizes_minus_one...>) {
297
+ return {
298
+ MakePatternMaskBytes(index_offset, pattern_sizes_minus_one + 1,
299
+ make_index_sequence</*indexes=*/sizeof(V128)>())...};
300
+ }
164
301
 
165
- // This is a table of shuffle control masks that can be used as the source
302
+ // This is an array of shuffle control masks that can be used as the source
166
303
  // operand for PSHUFB to permute the contents of the destination XMM register
167
304
  // into a repeating byte pattern.
168
- alignas(16) const char pshufb_fill_patterns[7][16] = {
169
- {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
170
- {0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1},
171
- {0, 1, 2, 0, 1, 2, 0, 1, 2, 0, 1, 2, 0, 1, 2, 0},
172
- {0, 1, 2, 3, 0, 1, 2, 3, 0, 1, 2, 3, 0, 1, 2, 3},
173
- {0, 1, 2, 3, 4, 0, 1, 2, 3, 4, 0, 1, 2, 3, 4, 0},
174
- {0, 1, 2, 3, 4, 5, 0, 1, 2, 3, 4, 5, 0, 1, 2, 3},
175
- {0, 1, 2, 3, 4, 5, 6, 0, 1, 2, 3, 4, 5, 6, 0, 1},
176
- };
305
+ alignas(16) constexpr std::array<std::array<char, sizeof(V128)>,
306
+ 16> pattern_generation_masks =
307
+ MakePatternMaskBytesTable(
308
+ /*index_offset=*/0,
309
+ /*pattern_sizes_minus_one=*/make_index_sequence<16>());
310
+
311
+ // Similar to 'pattern_generation_masks', this table is used to "rotate" the
312
+ // pattern so that we can copy the *next 16 bytes* consistent with the pattern.
313
+ // Basically, pattern_reshuffle_masks is a continuation of
314
+ // pattern_generation_masks. It follows that, pattern_reshuffle_masks is same as
315
+ // pattern_generation_masks for offsets 1, 2, 4, 8 and 16.
316
+ alignas(16) constexpr std::array<std::array<char, sizeof(V128)>,
317
+ 16> pattern_reshuffle_masks =
318
+ MakePatternMaskBytesTable(
319
+ /*index_offset=*/16,
320
+ /*pattern_sizes_minus_one=*/make_index_sequence<16>());
321
+
322
+ SNAPPY_ATTRIBUTE_ALWAYS_INLINE
323
+ static inline V128 LoadPattern(const char* src, const size_t pattern_size) {
324
+ V128 generation_mask = V128_Load(reinterpret_cast<const V128*>(
325
+ pattern_generation_masks[pattern_size - 1].data()));
326
+ // Uninitialized bytes are masked out by the shuffle mask.
327
+ // TODO: remove annotation and macro defs once MSan is fixed.
328
+ SNAPPY_ANNOTATE_MEMORY_IS_INITIALIZED(src + pattern_size, 16 - pattern_size);
329
+ return V128_Shuffle(V128_LoadU(reinterpret_cast<const V128*>(src)),
330
+ generation_mask);
331
+ }
332
+
333
+ SNAPPY_ATTRIBUTE_ALWAYS_INLINE
334
+ static inline std::pair<V128 /* pattern */, V128 /* reshuffle_mask */>
335
+ LoadPatternAndReshuffleMask(const char* src, const size_t pattern_size) {
336
+ V128 pattern = LoadPattern(src, pattern_size);
337
+
338
+ // This mask will generate the next 16 bytes in-place. Doing so enables us to
339
+ // write data by at most 4 V128_StoreU.
340
+ //
341
+ // For example, suppose pattern is: abcdefabcdefabcd
342
+ // Shuffling with this mask will generate: efabcdefabcdefab
343
+ // Shuffling again will generate: cdefabcdefabcdef
344
+ V128 reshuffle_mask = V128_Load(reinterpret_cast<const V128*>(
345
+ pattern_reshuffle_masks[pattern_size - 1].data()));
346
+ return {pattern, reshuffle_mask};
347
+ }
348
+
349
+ #endif // SNAPPY_HAVE_VECTOR_BYTE_SHUFFLE
350
+
351
+ // Fallback for when we need to copy while extending the pattern, for example
352
+ // copying 10 bytes from 3 positions back abc -> abcabcabcabca.
353
+ //
354
+ // REQUIRES: [dst - offset, dst + 64) is a valid address range.
355
+ SNAPPY_ATTRIBUTE_ALWAYS_INLINE
356
+ static inline bool Copy64BytesWithPatternExtension(char* dst, size_t offset) {
357
+ #if SNAPPY_HAVE_VECTOR_BYTE_SHUFFLE
358
+ if (SNAPPY_PREDICT_TRUE(offset <= 16)) {
359
+ switch (offset) {
360
+ case 0:
361
+ return false;
362
+ case 1: {
363
+ // TODO: Ideally we should memset, move back once the
364
+ // codegen issues are fixed.
365
+ V128 pattern = V128_DupChar(dst[-1]);
366
+ for (int i = 0; i < 4; i++) {
367
+ V128_StoreU(reinterpret_cast<V128*>(dst + 16 * i), pattern);
368
+ }
369
+ return true;
370
+ }
371
+ case 2:
372
+ case 4:
373
+ case 8:
374
+ case 16: {
375
+ V128 pattern = LoadPattern(dst - offset, offset);
376
+ for (int i = 0; i < 4; i++) {
377
+ V128_StoreU(reinterpret_cast<V128*>(dst + 16 * i), pattern);
378
+ }
379
+ return true;
380
+ }
381
+ default: {
382
+ auto pattern_and_reshuffle_mask =
383
+ LoadPatternAndReshuffleMask(dst - offset, offset);
384
+ V128 pattern = pattern_and_reshuffle_mask.first;
385
+ V128 reshuffle_mask = pattern_and_reshuffle_mask.second;
386
+ for (int i = 0; i < 4; i++) {
387
+ V128_StoreU(reinterpret_cast<V128*>(dst + 16 * i), pattern);
388
+ pattern = V128_Shuffle(pattern, reshuffle_mask);
389
+ }
390
+ return true;
391
+ }
392
+ }
393
+ }
394
+ #else
395
+ if (SNAPPY_PREDICT_TRUE(offset < 16)) {
396
+ if (SNAPPY_PREDICT_FALSE(offset == 0)) return false;
397
+ // Extend the pattern to the first 16 bytes.
398
+ // The simpler formulation of `dst[i - offset]` induces undefined behavior.
399
+ for (int i = 0; i < 16; i++) dst[i] = (dst - offset)[i];
400
+ // Find a multiple of pattern >= 16.
401
+ static std::array<uint8_t, 16> pattern_sizes = []() {
402
+ std::array<uint8_t, 16> res;
403
+ for (int i = 1; i < 16; i++) res[i] = (16 / i + 1) * i;
404
+ return res;
405
+ }();
406
+ offset = pattern_sizes[offset];
407
+ for (int i = 1; i < 4; i++) {
408
+ std::memcpy(dst + i * 16, dst + i * 16 - offset, 16);
409
+ }
410
+ return true;
411
+ }
412
+ #endif // SNAPPY_HAVE_VECTOR_BYTE_SHUFFLE
177
413
 
178
- #endif // SNAPPY_HAVE_SSSE3
414
+ // Very rare.
415
+ for (int i = 0; i < 4; i++) {
416
+ std::memcpy(dst + i * 16, dst + i * 16 - offset, 16);
417
+ }
418
+ return true;
419
+ }
179
420
 
180
- // Copy [src, src+(op_limit-op)) to [op, (op_limit-op)) but faster than
421
+ // Copy [src, src+(op_limit-op)) to [op, op_limit) but faster than
181
422
  // IncrementalCopySlow. buf_limit is the address past the end of the writable
182
423
  // region of the buffer.
183
424
  inline char* IncrementalCopy(const char* src, char* op, char* const op_limit,
184
425
  char* const buf_limit) {
426
+ #if SNAPPY_HAVE_VECTOR_BYTE_SHUFFLE
427
+ constexpr int big_pattern_size_lower_bound = 16;
428
+ #else
429
+ constexpr int big_pattern_size_lower_bound = 8;
430
+ #endif
431
+
185
432
  // Terminology:
186
433
  //
187
434
  // slop = buf_limit - op
188
435
  // pat = op - src
189
- // len = limit - op
436
+ // len = op_limit - op
190
437
  assert(src < op);
191
- assert(op <= op_limit);
438
+ assert(op < op_limit);
192
439
  assert(op_limit <= buf_limit);
193
- // NOTE: The compressor always emits 4 <= len <= 64. It is ok to assume that
194
- // to optimize this function but we have to also handle other cases in case
195
- // the input does not satisfy these conditions.
440
+ // NOTE: The copy tags use 3 or 6 bits to store the copy length, so len <= 64.
441
+ assert(op_limit - op <= 64);
442
+ // NOTE: In practice the compressor always emits len >= 4, so it is ok to
443
+ // assume that to optimize this function, but this is not guaranteed by the
444
+ // compression format, so we have to also handle len < 4 in case the input
445
+ // does not satisfy these conditions.
196
446
 
197
447
  size_t pattern_size = op - src;
198
448
  // The cases are split into different branches to allow the branch predictor,
@@ -216,43 +466,78 @@ inline char* IncrementalCopy(const char* src, char* op, char* const op_limit,
216
466
  // input. In general if we always predict len <= 16 it would be an ok
217
467
  // prediction.
218
468
  //
219
- // In order to be fast we want a pattern >= 8 bytes and an unrolled loop
220
- // copying 2x 8 bytes at a time.
221
-
222
- // Handle the uncommon case where pattern is less than 8 bytes.
223
- if (SNAPPY_PREDICT_FALSE(pattern_size < 8)) {
224
- #if SNAPPY_HAVE_SSSE3
469
+ // In order to be fast we want a pattern >= 16 bytes (or 8 bytes in non-SSE)
470
+ // and an unrolled loop copying 1x 16 bytes (or 2x 8 bytes in non-SSE) at a
471
+ // time.
472
+
473
+ // Handle the uncommon case where pattern is less than 16 (or 8 in non-SSE)
474
+ // bytes.
475
+ if (pattern_size < big_pattern_size_lower_bound) {
476
+ #if SNAPPY_HAVE_VECTOR_BYTE_SHUFFLE
225
477
  // Load the first eight bytes into an 128-bit XMM register, then use PSHUFB
226
478
  // to permute the register's contents in-place into a repeating sequence of
227
479
  // the first "pattern_size" bytes.
228
480
  // For example, suppose:
229
481
  // src == "abc"
230
482
  // op == op + 3
231
- // After _mm_shuffle_epi8(), "pattern" will have five copies of "abc"
483
+ // After V128_Shuffle(), "pattern" will have five copies of "abc"
232
484
  // followed by one byte of slop: abcabcabcabcabca.
233
485
  //
234
486
  // The non-SSE fallback implementation suffers from store-forwarding stalls
235
487
  // because its loads and stores partly overlap. By expanding the pattern
236
488
  // in-place, we avoid the penalty.
237
- if (SNAPPY_PREDICT_TRUE(op <= buf_limit - 16)) {
238
- const __m128i shuffle_mask = _mm_load_si128(
239
- reinterpret_cast<const __m128i*>(pshufb_fill_patterns)
240
- + pattern_size - 1);
241
- const __m128i pattern = _mm_shuffle_epi8(
242
- _mm_loadl_epi64(reinterpret_cast<const __m128i*>(src)), shuffle_mask);
243
- // Uninitialized bytes are masked out by the shuffle mask.
244
- // TODO: remove annotation and macro defs once MSan is fixed.
245
- SNAPPY_ANNOTATE_MEMORY_IS_INITIALIZED(&pattern, sizeof(pattern));
246
- pattern_size *= 16 / pattern_size;
247
- char* op_end = std::min(op_limit, buf_limit - 15);
248
- while (op < op_end) {
249
- _mm_storeu_si128(reinterpret_cast<__m128i*>(op), pattern);
250
- op += pattern_size;
489
+
490
+ // Typically, the op_limit is the gating factor so try to simplify the loop
491
+ // based on that.
492
+ if (SNAPPY_PREDICT_TRUE(op_limit <= buf_limit - 15)) {
493
+ auto pattern_and_reshuffle_mask =
494
+ LoadPatternAndReshuffleMask(src, pattern_size);
495
+ V128 pattern = pattern_and_reshuffle_mask.first;
496
+ V128 reshuffle_mask = pattern_and_reshuffle_mask.second;
497
+
498
+ // There is at least one, and at most four 16-byte blocks. Writing four
499
+ // conditionals instead of a loop allows FDO to layout the code with
500
+ // respect to the actual probabilities of each length.
501
+ // TODO: Replace with loop with trip count hint.
502
+ V128_StoreU(reinterpret_cast<V128*>(op), pattern);
503
+
504
+ if (op + 16 < op_limit) {
505
+ pattern = V128_Shuffle(pattern, reshuffle_mask);
506
+ V128_StoreU(reinterpret_cast<V128*>(op + 16), pattern);
251
507
  }
252
- if (SNAPPY_PREDICT_TRUE(op >= op_limit)) return op_limit;
508
+ if (op + 32 < op_limit) {
509
+ pattern = V128_Shuffle(pattern, reshuffle_mask);
510
+ V128_StoreU(reinterpret_cast<V128*>(op + 32), pattern);
511
+ }
512
+ if (op + 48 < op_limit) {
513
+ pattern = V128_Shuffle(pattern, reshuffle_mask);
514
+ V128_StoreU(reinterpret_cast<V128*>(op + 48), pattern);
515
+ }
516
+ return op_limit;
517
+ }
518
+ char* const op_end = buf_limit - 15;
519
+ if (SNAPPY_PREDICT_TRUE(op < op_end)) {
520
+ auto pattern_and_reshuffle_mask =
521
+ LoadPatternAndReshuffleMask(src, pattern_size);
522
+ V128 pattern = pattern_and_reshuffle_mask.first;
523
+ V128 reshuffle_mask = pattern_and_reshuffle_mask.second;
524
+
525
+ // This code path is relatively cold however so we save code size
526
+ // by avoiding unrolling and vectorizing.
527
+ //
528
+ // TODO: Remove pragma when when cold regions don't get
529
+ // vectorized or unrolled.
530
+ #ifdef __clang__
531
+ #pragma clang loop unroll(disable)
532
+ #endif
533
+ do {
534
+ V128_StoreU(reinterpret_cast<V128*>(op), pattern);
535
+ pattern = V128_Shuffle(pattern, reshuffle_mask);
536
+ op += 16;
537
+ } while (SNAPPY_PREDICT_TRUE(op < op_end));
253
538
  }
254
- return IncrementalCopySlow(src, op, op_limit);
255
- #else // !SNAPPY_HAVE_SSSE3
539
+ return IncrementalCopySlow(op - pattern_size, op, op_limit);
540
+ #else // !SNAPPY_HAVE_VECTOR_BYTE_SHUFFLE
256
541
  // If plenty of buffer space remains, expand the pattern to at least 8
257
542
  // bytes. The way the following loop is written, we need 8 bytes of buffer
258
543
  // space if pattern_size >= 4, 11 bytes if pattern_size is 1 or 3, and 10
@@ -269,36 +554,32 @@ inline char* IncrementalCopy(const char* src, char* op, char* const op_limit,
269
554
  } else {
270
555
  return IncrementalCopySlow(src, op, op_limit);
271
556
  }
272
- #endif // SNAPPY_HAVE_SSSE3
557
+ #endif // SNAPPY_HAVE_VECTOR_BYTE_SHUFFLE
273
558
  }
274
- assert(pattern_size >= 8);
559
+ assert(pattern_size >= big_pattern_size_lower_bound);
560
+ constexpr bool use_16bytes_chunk = big_pattern_size_lower_bound == 16;
275
561
 
276
- // Copy 2x 8 bytes at a time. Because op - src can be < 16, a single
277
- // UnalignedCopy128 might overwrite data in op. UnalignedCopy64 is safe
278
- // because expanding the pattern to at least 8 bytes guarantees that
279
- // op - src >= 8.
562
+ // Copy 1x 16 bytes (or 2x 8 bytes in non-SSE) at a time. Because op - src can
563
+ // be < 16 in non-SSE, a single UnalignedCopy128 might overwrite data in op.
564
+ // UnalignedCopy64 is safe because expanding the pattern to at least 8 bytes
565
+ // guarantees that op - src >= 8.
280
566
  //
281
567
  // Typically, the op_limit is the gating factor so try to simplify the loop
282
568
  // based on that.
283
- if (SNAPPY_PREDICT_TRUE(op_limit <= buf_limit - 16)) {
569
+ if (SNAPPY_PREDICT_TRUE(op_limit <= buf_limit - 15)) {
284
570
  // There is at least one, and at most four 16-byte blocks. Writing four
285
571
  // conditionals instead of a loop allows FDO to layout the code with respect
286
572
  // to the actual probabilities of each length.
287
573
  // TODO: Replace with loop with trip count hint.
288
- UnalignedCopy64(src, op);
289
- UnalignedCopy64(src + 8, op + 8);
290
-
574
+ ConditionalUnalignedCopy128<use_16bytes_chunk>(src, op);
291
575
  if (op + 16 < op_limit) {
292
- UnalignedCopy64(src + 16, op + 16);
293
- UnalignedCopy64(src + 24, op + 24);
576
+ ConditionalUnalignedCopy128<use_16bytes_chunk>(src + 16, op + 16);
294
577
  }
295
578
  if (op + 32 < op_limit) {
296
- UnalignedCopy64(src + 32, op + 32);
297
- UnalignedCopy64(src + 40, op + 40);
579
+ ConditionalUnalignedCopy128<use_16bytes_chunk>(src + 32, op + 32);
298
580
  }
299
581
  if (op + 48 < op_limit) {
300
- UnalignedCopy64(src + 48, op + 48);
301
- UnalignedCopy64(src + 56, op + 56);
582
+ ConditionalUnalignedCopy128<use_16bytes_chunk>(src + 48, op + 48);
302
583
  }
303
584
  return op_limit;
304
585
  }
@@ -312,12 +593,10 @@ inline char* IncrementalCopy(const char* src, char* op, char* const op_limit,
312
593
  #ifdef __clang__
313
594
  #pragma clang loop unroll(disable)
314
595
  #endif
315
- for (char *op_end = buf_limit - 16; op < op_end; op += 16, src += 16) {
316
- UnalignedCopy64(src, op);
317
- UnalignedCopy64(src + 8, op + 8);
596
+ for (char* op_end = buf_limit - 16; op < op_end; op += 16, src += 16) {
597
+ ConditionalUnalignedCopy128<use_16bytes_chunk>(src, op);
318
598
  }
319
- if (op >= op_limit)
320
- return op_limit;
599
+ if (op >= op_limit) return op_limit;
321
600
 
322
601
  // We only take this branch if we didn't have enough slop and we can do a
323
602
  // single 8 byte copy.
@@ -332,11 +611,9 @@ inline char* IncrementalCopy(const char* src, char* op, char* const op_limit,
332
611
  } // namespace
333
612
 
334
613
  template <bool allow_fast_path>
335
- static inline char* EmitLiteral(char* op,
336
- const char* literal,
337
- int len) {
614
+ static inline char* EmitLiteral(char* op, const char* literal, int len) {
338
615
  // The vast majority of copies are below 16 bytes, for which a
339
- // call to memcpy is overkill. This fast path can sometimes
616
+ // call to std::memcpy() is overkill. This fast path can sometimes
340
617
  // copy up to 15 bytes too much, but that is okay in the
341
618
  // main loop, since we have a bit to go on for both sides:
342
619
  //
@@ -345,7 +622,7 @@ static inline char* EmitLiteral(char* op,
345
622
  // if not, allow_fast_path = false.
346
623
  // - The output will always have 32 spare bytes (see
347
624
  // MaxCompressedLength).
348
- assert(len > 0); // Zero-length literals are disallowed
625
+ assert(len > 0); // Zero-length literals are disallowed
349
626
  int n = len - 1;
350
627
  if (allow_fast_path && len <= 16) {
351
628
  // Fits in tag byte
@@ -366,11 +643,23 @@ static inline char* EmitLiteral(char* op,
366
643
  // Encode in upcoming bytes.
367
644
  // Write 4 bytes, though we may care about only 1 of them. The output buffer
368
645
  // is guaranteed to have at least 3 more spaces left as 'len >= 61' holds
369
- // here and there is a memcpy of size 'len' below.
646
+ // here and there is a std::memcpy() of size 'len' below.
370
647
  LittleEndian::Store32(op, n);
371
648
  op += count;
372
649
  }
373
- memcpy(op, literal, len);
650
+ // When allow_fast_path is true, we can overwrite up to 16 bytes.
651
+ if (allow_fast_path) {
652
+ char* destination = op;
653
+ const char* source = literal;
654
+ const char* end = destination + len;
655
+ do {
656
+ std::memcpy(destination, source, 16);
657
+ destination += 16;
658
+ source += 16;
659
+ } while (destination < end);
660
+ } else {
661
+ std::memcpy(op, literal, len);
662
+ }
374
663
  return op + len;
375
664
  }
376
665
 
@@ -381,15 +670,22 @@ static inline char* EmitCopyAtMost64(char* op, size_t offset, size_t len) {
381
670
  assert(offset < 65536);
382
671
  assert(len_less_than_12 == (len < 12));
383
672
 
384
- if (len_less_than_12 && SNAPPY_PREDICT_TRUE(offset < 2048)) {
385
- // offset fits in 11 bits. The 3 highest go in the top of the first byte,
386
- // and the rest go in the second byte.
387
- *op++ = COPY_1_BYTE_OFFSET + ((len - 4) << 2) + ((offset >> 3) & 0xe0);
388
- *op++ = offset & 0xff;
673
+ if (len_less_than_12) {
674
+ uint32_t u = (len << 2) + (offset << 8);
675
+ uint32_t copy1 = COPY_1_BYTE_OFFSET - (4 << 2) + ((offset >> 3) & 0xe0);
676
+ uint32_t copy2 = COPY_2_BYTE_OFFSET - (1 << 2);
677
+ // It turns out that offset < 2048 is a difficult to predict branch.
678
+ // `perf record` shows this is the highest percentage of branch misses in
679
+ // benchmarks. This code produces branch free code, the data dependency
680
+ // chain that bottlenecks the throughput is so long that a few extra
681
+ // instructions are completely free (IPC << 6 because of data deps).
682
+ u += offset < 2048 ? copy1 : copy2;
683
+ LittleEndian::Store32(op, u);
684
+ op += offset < 2048 ? 2 : 3;
389
685
  } else {
390
686
  // Write 4 bytes, though we only care about 3 of them. The output buffer
391
687
  // is required to have some slack, so the extra byte won't overrun it.
392
- uint32 u = COPY_2_BYTE_OFFSET + ((len - 1) << 2) + (offset << 8);
688
+ uint32_t u = COPY_2_BYTE_OFFSET + ((len - 1) << 2) + (offset << 8);
393
689
  LittleEndian::Store32(op, u);
394
690
  op += 3;
395
691
  }
@@ -428,7 +724,7 @@ static inline char* EmitCopy(char* op, size_t offset, size_t len) {
428
724
  }
429
725
 
430
726
  bool GetUncompressedLength(const char* start, size_t n, size_t* result) {
431
- uint32 v = 0;
727
+ uint32_t v = 0;
432
728
  const char* limit = start + n;
433
729
  if (Varint::Parse32WithLimit(start, limit, &v) != NULL) {
434
730
  *result = v;
@@ -439,7 +735,7 @@ bool GetUncompressedLength(const char* start, size_t n, size_t* result) {
439
735
  }
440
736
 
441
737
  namespace {
442
- uint32 CalculateTableSize(uint32 input_size) {
738
+ uint32_t CalculateTableSize(uint32_t input_size) {
443
739
  static_assert(
444
740
  kMaxHashTableSize >= kMinHashTableSize,
445
741
  "kMaxHashTableSize should be greater or equal to kMinHashTableSize.");
@@ -462,7 +758,7 @@ WorkingMemory::WorkingMemory(size_t input_size) {
462
758
  size_ = table_size * sizeof(*table_) + max_fragment_size +
463
759
  MaxCompressedLength(max_fragment_size);
464
760
  mem_ = std::allocator<char>().allocate(size_);
465
- table_ = reinterpret_cast<uint16*>(mem_);
761
+ table_ = reinterpret_cast<uint16_t*>(mem_);
466
762
  input_ = mem_ + table_size * sizeof(*table_);
467
763
  output_ = input_ + max_fragment_size;
468
764
  }
@@ -471,8 +767,8 @@ WorkingMemory::~WorkingMemory() {
471
767
  std::allocator<char>().deallocate(mem_, size_);
472
768
  }
473
769
 
474
- uint16* WorkingMemory::GetHashTable(size_t fragment_size,
475
- int* table_size) const {
770
+ uint16_t* WorkingMemory::GetHashTable(size_t fragment_size,
771
+ int* table_size) const {
476
772
  const size_t htsize = CalculateTableSize(fragment_size);
477
773
  memset(table_, 0, htsize * sizeof(*table_));
478
774
  *table_size = htsize;
@@ -480,49 +776,6 @@ uint16* WorkingMemory::GetHashTable(size_t fragment_size,
480
776
  }
481
777
  } // end namespace internal
482
778
 
483
- // For 0 <= offset <= 4, GetUint32AtOffset(GetEightBytesAt(p), offset) will
484
- // equal UNALIGNED_LOAD32(p + offset). Motivation: On x86-64 hardware we have
485
- // empirically found that overlapping loads such as
486
- // UNALIGNED_LOAD32(p) ... UNALIGNED_LOAD32(p+1) ... UNALIGNED_LOAD32(p+2)
487
- // are slower than UNALIGNED_LOAD64(p) followed by shifts and casts to uint32.
488
- //
489
- // We have different versions for 64- and 32-bit; ideally we would avoid the
490
- // two functions and just inline the UNALIGNED_LOAD64 call into
491
- // GetUint32AtOffset, but GCC (at least not as of 4.6) is seemingly not clever
492
- // enough to avoid loading the value multiple times then. For 64-bit, the load
493
- // is done when GetEightBytesAt() is called, whereas for 32-bit, the load is
494
- // done at GetUint32AtOffset() time.
495
-
496
- #ifdef ARCH_K8
497
-
498
- typedef uint64 EightBytesReference;
499
-
500
- static inline EightBytesReference GetEightBytesAt(const char* ptr) {
501
- return UNALIGNED_LOAD64(ptr);
502
- }
503
-
504
- static inline uint32 GetUint32AtOffset(uint64 v, int offset) {
505
- assert(offset >= 0);
506
- assert(offset <= 4);
507
- return v >> (LittleEndian::IsLittleEndian() ? 8 * offset : 32 - 8 * offset);
508
- }
509
-
510
- #else
511
-
512
- typedef const char* EightBytesReference;
513
-
514
- static inline EightBytesReference GetEightBytesAt(const char* ptr) {
515
- return ptr;
516
- }
517
-
518
- static inline uint32 GetUint32AtOffset(const char* v, int offset) {
519
- assert(offset >= 0);
520
- assert(offset <= 4);
521
- return UNALIGNED_LOAD32(v + offset);
522
- }
523
-
524
- #endif
525
-
526
779
  // Flat array compression that does not emit the "uncompressed length"
527
780
  // prefix. Compresses "input" string to the "*op" buffer.
528
781
  //
@@ -535,29 +788,25 @@ static inline uint32 GetUint32AtOffset(const char* v, int offset) {
535
788
  // Returns an "end" pointer into "op" buffer.
536
789
  // "end - op" is the compressed size of "input".
537
790
  namespace internal {
538
- char* CompressFragment(const char* input,
539
- size_t input_size,
540
- char* op,
541
- uint16* table,
542
- const int table_size) {
791
+ char* CompressFragment(const char* input, size_t input_size, char* op,
792
+ uint16_t* table, const int table_size) {
543
793
  // "ip" is the input pointer, and "op" is the output pointer.
544
794
  const char* ip = input;
545
795
  assert(input_size <= kBlockSize);
546
796
  assert((table_size & (table_size - 1)) == 0); // table must be power of two
547
- const int shift = 32 - Bits::Log2Floor(table_size);
548
- assert(static_cast<int>(kuint32max >> shift) == table_size - 1);
797
+ const uint32_t mask = 2 * (table_size - 1);
549
798
  const char* ip_end = input + input_size;
550
799
  const char* base_ip = ip;
551
- // Bytes in [next_emit, ip) will be emitted as literal bytes. Or
552
- // [next_emit, ip_end) after the main loop.
553
- const char* next_emit = ip;
554
800
 
555
801
  const size_t kInputMarginBytes = 15;
556
802
  if (SNAPPY_PREDICT_TRUE(input_size >= kInputMarginBytes)) {
557
803
  const char* ip_limit = input + input_size - kInputMarginBytes;
558
804
 
559
- for (uint32 next_hash = Hash(++ip, shift); ; ) {
560
- assert(next_emit < ip);
805
+ for (uint32_t preload = LittleEndian::Load32(ip + 1);;) {
806
+ // Bytes in [next_emit, ip) will be emitted as literal bytes. Or
807
+ // [next_emit, ip_end) after the main loop.
808
+ const char* next_emit = ip++;
809
+ uint64_t data = LittleEndian::Load64(ip);
561
810
  // The body of this loop calls EmitLiteral once and then EmitCopy one or
562
811
  // more times. (The exception is that when we're close to exhausting
563
812
  // the input we goto emit_remainder.)
@@ -583,28 +832,60 @@ char* CompressFragment(const char* input,
583
832
  // The "skip" variable keeps track of how many bytes there are since the
584
833
  // last match; dividing it by 32 (ie. right-shifting by five) gives the
585
834
  // number of bytes to move ahead for each iteration.
586
- uint32 skip = 32;
835
+ uint32_t skip = 32;
587
836
 
588
- const char* next_ip = ip;
589
837
  const char* candidate;
590
- do {
591
- ip = next_ip;
592
- uint32 hash = next_hash;
593
- assert(hash == Hash(ip, shift));
594
- uint32 bytes_between_hash_lookups = skip >> 5;
838
+ if (ip_limit - ip >= 16) {
839
+ auto delta = ip - base_ip;
840
+ for (int j = 0; j < 4; ++j) {
841
+ for (int k = 0; k < 4; ++k) {
842
+ int i = 4 * j + k;
843
+ // These for-loops are meant to be unrolled. So we can freely
844
+ // special case the first iteration to use the value already
845
+ // loaded in preload.
846
+ uint32_t dword = i == 0 ? preload : static_cast<uint32_t>(data);
847
+ assert(dword == LittleEndian::Load32(ip + i));
848
+ uint16_t* table_entry = TableEntry(table, dword, mask);
849
+ candidate = base_ip + *table_entry;
850
+ assert(candidate >= base_ip);
851
+ assert(candidate < ip + i);
852
+ *table_entry = delta + i;
853
+ if (SNAPPY_PREDICT_FALSE(LittleEndian::Load32(candidate) == dword)) {
854
+ *op = LITERAL | (i << 2);
855
+ UnalignedCopy128(next_emit, op + 1);
856
+ ip += i;
857
+ op = op + i + 2;
858
+ goto emit_match;
859
+ }
860
+ data >>= 8;
861
+ }
862
+ data = LittleEndian::Load64(ip + 4 * j + 4);
863
+ }
864
+ ip += 16;
865
+ skip += 16;
866
+ }
867
+ while (true) {
868
+ assert(static_cast<uint32_t>(data) == LittleEndian::Load32(ip));
869
+ uint16_t* table_entry = TableEntry(table, data, mask);
870
+ uint32_t bytes_between_hash_lookups = skip >> 5;
595
871
  skip += bytes_between_hash_lookups;
596
- next_ip = ip + bytes_between_hash_lookups;
872
+ const char* next_ip = ip + bytes_between_hash_lookups;
597
873
  if (SNAPPY_PREDICT_FALSE(next_ip > ip_limit)) {
874
+ ip = next_emit;
598
875
  goto emit_remainder;
599
876
  }
600
- next_hash = Hash(next_ip, shift);
601
- candidate = base_ip + table[hash];
877
+ candidate = base_ip + *table_entry;
602
878
  assert(candidate >= base_ip);
603
879
  assert(candidate < ip);
604
880
 
605
- table[hash] = ip - base_ip;
606
- } while (SNAPPY_PREDICT_TRUE(UNALIGNED_LOAD32(ip) !=
607
- UNALIGNED_LOAD32(candidate)));
881
+ *table_entry = ip - base_ip;
882
+ if (SNAPPY_PREDICT_FALSE(static_cast<uint32_t>(data) ==
883
+ LittleEndian::Load32(candidate))) {
884
+ break;
885
+ }
886
+ data = LittleEndian::Load32(next_ip);
887
+ ip = next_ip;
888
+ }
608
889
 
609
890
  // Step 2: A 4-byte match has been found. We'll later see if more
610
891
  // than 4 bytes match. But, prior to the match, input
@@ -620,15 +901,13 @@ char* CompressFragment(const char* input,
620
901
  // though we don't yet know how big the literal will be. We handle that
621
902
  // by proceeding to the next iteration of the main loop. We also can exit
622
903
  // this loop via goto if we get close to exhausting the input.
623
- EightBytesReference input_bytes;
624
- uint32 candidate_bytes = 0;
625
-
904
+ emit_match:
626
905
  do {
627
906
  // We have a 4-byte match at ip, and no need to emit any
628
907
  // "literal bytes" prior to ip.
629
908
  const char* base = ip;
630
909
  std::pair<size_t, bool> p =
631
- FindMatchLength(candidate + 4, ip + 4, ip_end);
910
+ FindMatchLength(candidate + 4, ip + 4, ip_end, &data);
632
911
  size_t matched = 4 + p.first;
633
912
  ip += matched;
634
913
  size_t offset = base - candidate;
@@ -638,41 +917,223 @@ char* CompressFragment(const char* input,
638
917
  } else {
639
918
  op = EmitCopy</*len_less_than_12=*/false>(op, offset, matched);
640
919
  }
641
- next_emit = ip;
642
920
  if (SNAPPY_PREDICT_FALSE(ip >= ip_limit)) {
643
921
  goto emit_remainder;
644
922
  }
923
+ // Expect 5 bytes to match
924
+ assert((data & 0xFFFFFFFFFF) ==
925
+ (LittleEndian::Load64(ip) & 0xFFFFFFFFFF));
645
926
  // We are now looking for a 4-byte match again. We read
646
- // table[Hash(ip, shift)] for that. To improve compression,
647
- // we also update table[Hash(ip - 1, shift)] and table[Hash(ip, shift)].
648
- input_bytes = GetEightBytesAt(ip - 1);
649
- uint32 prev_hash = HashBytes(GetUint32AtOffset(input_bytes, 0), shift);
650
- table[prev_hash] = ip - base_ip - 1;
651
- uint32 cur_hash = HashBytes(GetUint32AtOffset(input_bytes, 1), shift);
652
- candidate = base_ip + table[cur_hash];
653
- candidate_bytes = UNALIGNED_LOAD32(candidate);
654
- table[cur_hash] = ip - base_ip;
655
- } while (GetUint32AtOffset(input_bytes, 1) == candidate_bytes);
656
-
657
- next_hash = HashBytes(GetUint32AtOffset(input_bytes, 2), shift);
658
- ++ip;
927
+ // table[Hash(ip, mask)] for that. To improve compression,
928
+ // we also update table[Hash(ip - 1, mask)] and table[Hash(ip, mask)].
929
+ *TableEntry(table, LittleEndian::Load32(ip - 1), mask) =
930
+ ip - base_ip - 1;
931
+ uint16_t* table_entry = TableEntry(table, data, mask);
932
+ candidate = base_ip + *table_entry;
933
+ *table_entry = ip - base_ip;
934
+ // Measurements on the benchmarks have shown the following probabilities
935
+ // for the loop to exit (ie. avg. number of iterations is reciprocal).
936
+ // BM_Flat/6 txt1 p = 0.3-0.4
937
+ // BM_Flat/7 txt2 p = 0.35
938
+ // BM_Flat/8 txt3 p = 0.3-0.4
939
+ // BM_Flat/9 txt3 p = 0.34-0.4
940
+ // BM_Flat/10 pb p = 0.4
941
+ // BM_Flat/11 gaviota p = 0.1
942
+ // BM_Flat/12 cp p = 0.5
943
+ // BM_Flat/13 c p = 0.3
944
+ } while (static_cast<uint32_t>(data) == LittleEndian::Load32(candidate));
945
+ // Because the least significant 5 bytes matched, we can utilize data
946
+ // for the next iteration.
947
+ preload = data >> 8;
659
948
  }
660
949
  }
661
950
 
662
- emit_remainder:
951
+ emit_remainder:
663
952
  // Emit the remaining bytes as a literal
664
- if (next_emit < ip_end) {
665
- op = EmitLiteral</*allow_fast_path=*/false>(op, next_emit,
666
- ip_end - next_emit);
953
+ if (ip < ip_end) {
954
+ op = EmitLiteral</*allow_fast_path=*/false>(op, ip, ip_end - ip);
955
+ }
956
+
957
+ return op;
958
+ }
959
+
960
+ char* CompressFragmentDoubleHash(const char* input, size_t input_size, char* op,
961
+ uint16_t* table, const int table_size,
962
+ uint16_t* table2, const int table_size2) {
963
+ (void)table_size2;
964
+ assert(table_size == table_size2);
965
+ // "ip" is the input pointer, and "op" is the output pointer.
966
+ const char* ip = input;
967
+ assert(input_size <= kBlockSize);
968
+ assert((table_size & (table_size - 1)) == 0); // table must be power of two
969
+ const uint32_t mask = 2 * (table_size - 1);
970
+ const char* ip_end = input + input_size;
971
+ const char* base_ip = ip;
972
+
973
+ const size_t kInputMarginBytes = 15;
974
+ if (SNAPPY_PREDICT_TRUE(input_size >= kInputMarginBytes)) {
975
+ const char* ip_limit = input + input_size - kInputMarginBytes;
976
+
977
+ for (;;) {
978
+ const char* next_emit = ip++;
979
+ uint64_t data = LittleEndian::Load64(ip);
980
+ uint32_t skip = 512;
981
+
982
+ const char* candidate;
983
+ uint32_t candidate_length;
984
+ while (true) {
985
+ assert(static_cast<uint32_t>(data) == LittleEndian::Load32(ip));
986
+ uint16_t* table_entry2 = TableEntry8ByteMatch(table2, data, mask);
987
+ uint32_t bytes_between_hash_lookups = skip >> 9;
988
+ skip++;
989
+ const char* next_ip = ip + bytes_between_hash_lookups;
990
+ if (SNAPPY_PREDICT_FALSE(next_ip > ip_limit)) {
991
+ ip = next_emit;
992
+ goto emit_remainder;
993
+ }
994
+ candidate = base_ip + *table_entry2;
995
+ assert(candidate >= base_ip);
996
+ assert(candidate < ip);
997
+
998
+ *table_entry2 = ip - base_ip;
999
+ if (SNAPPY_PREDICT_FALSE(static_cast<uint32_t>(data) ==
1000
+ LittleEndian::Load32(candidate))) {
1001
+ candidate_length =
1002
+ FindMatchLengthPlain(candidate + 4, ip + 4, ip_end) + 4;
1003
+ break;
1004
+ }
1005
+
1006
+ uint16_t* table_entry = TableEntry4ByteMatch(table, data, mask);
1007
+ candidate = base_ip + *table_entry;
1008
+ assert(candidate >= base_ip);
1009
+ assert(candidate < ip);
1010
+
1011
+ *table_entry = ip - base_ip;
1012
+ if (SNAPPY_PREDICT_FALSE(static_cast<uint32_t>(data) ==
1013
+ LittleEndian::Load32(candidate))) {
1014
+ candidate_length =
1015
+ FindMatchLengthPlain(candidate + 4, ip + 4, ip_end) + 4;
1016
+ table_entry2 =
1017
+ TableEntry8ByteMatch(table2, LittleEndian::Load64(ip + 1), mask);
1018
+ auto candidate2 = base_ip + *table_entry2;
1019
+ size_t candidate_length2 =
1020
+ FindMatchLengthPlain(candidate2, ip + 1, ip_end);
1021
+ if (candidate_length2 > candidate_length) {
1022
+ *table_entry2 = ip - base_ip;
1023
+ candidate = candidate2;
1024
+ candidate_length = candidate_length2;
1025
+ ++ip;
1026
+ }
1027
+ break;
1028
+ }
1029
+ data = LittleEndian::Load64(next_ip);
1030
+ ip = next_ip;
1031
+ }
1032
+ // Backtrack to the point it matches fully.
1033
+ while (ip > next_emit && candidate > base_ip &&
1034
+ *(ip - 1) == *(candidate - 1)) {
1035
+ --ip;
1036
+ --candidate;
1037
+ ++candidate_length;
1038
+ }
1039
+ *TableEntry8ByteMatch(table2, LittleEndian::Load64(ip + 1), mask) =
1040
+ ip - base_ip + 1;
1041
+ *TableEntry8ByteMatch(table2, LittleEndian::Load64(ip + 2), mask) =
1042
+ ip - base_ip + 2;
1043
+ *TableEntry4ByteMatch(table, LittleEndian::Load32(ip + 1), mask) =
1044
+ ip - base_ip + 1;
1045
+ // Step 2: A 4-byte or 8-byte match has been found.
1046
+ // We'll later see if more than 4 bytes match. But, prior to the match,
1047
+ // input bytes [next_emit, ip) are unmatched. Emit them as
1048
+ // "literal bytes."
1049
+ assert(next_emit + 16 <= ip_end);
1050
+ if (ip - next_emit > 0) {
1051
+ op = EmitLiteral</*allow_fast_path=*/true>(op, next_emit,
1052
+ ip - next_emit);
1053
+ }
1054
+ // Step 3: Call EmitCopy, and then see if another EmitCopy could
1055
+ // be our next move. Repeat until we find no match for the
1056
+ // input immediately after what was consumed by the last EmitCopy call.
1057
+ //
1058
+ // If we exit this loop normally then we need to call EmitLiteral next,
1059
+ // though we don't yet know how big the literal will be. We handle that
1060
+ // by proceeding to the next iteration of the main loop. We also can exit
1061
+ // this loop via goto if we get close to exhausting the input.
1062
+ do {
1063
+ // We have a 4-byte match at ip, and no need to emit any
1064
+ // "literal bytes" prior to ip.
1065
+ const char* base = ip;
1066
+ ip += candidate_length;
1067
+ size_t offset = base - candidate;
1068
+ if (candidate_length < 12) {
1069
+ op =
1070
+ EmitCopy</*len_less_than_12=*/true>(op, offset, candidate_length);
1071
+ } else {
1072
+ op = EmitCopy</*len_less_than_12=*/false>(op, offset,
1073
+ candidate_length);
1074
+ }
1075
+ if (SNAPPY_PREDICT_FALSE(ip >= ip_limit)) {
1076
+ goto emit_remainder;
1077
+ }
1078
+ // We are now looking for a 4-byte match again. We read
1079
+ // table[Hash(ip, mask)] for that. To improve compression,
1080
+ // we also update several previous table entries.
1081
+ if (ip - base_ip > 7) {
1082
+ *TableEntry8ByteMatch(table2, LittleEndian::Load64(ip - 7), mask) =
1083
+ ip - base_ip - 7;
1084
+ *TableEntry8ByteMatch(table2, LittleEndian::Load64(ip - 4), mask) =
1085
+ ip - base_ip - 4;
1086
+ }
1087
+ *TableEntry8ByteMatch(table2, LittleEndian::Load64(ip - 3), mask) =
1088
+ ip - base_ip - 3;
1089
+ *TableEntry8ByteMatch(table2, LittleEndian::Load64(ip - 2), mask) =
1090
+ ip - base_ip - 2;
1091
+ *TableEntry4ByteMatch(table, LittleEndian::Load32(ip - 2), mask) =
1092
+ ip - base_ip - 2;
1093
+ *TableEntry4ByteMatch(table, LittleEndian::Load32(ip - 1), mask) =
1094
+ ip - base_ip - 1;
1095
+
1096
+ uint16_t* table_entry =
1097
+ TableEntry8ByteMatch(table2, LittleEndian::Load64(ip), mask);
1098
+ candidate = base_ip + *table_entry;
1099
+ *table_entry = ip - base_ip;
1100
+ if (LittleEndian::Load32(ip) == LittleEndian::Load32(candidate)) {
1101
+ candidate_length =
1102
+ FindMatchLengthPlain(candidate + 4, ip + 4, ip_end) + 4;
1103
+ continue;
1104
+ }
1105
+ table_entry =
1106
+ TableEntry4ByteMatch(table, LittleEndian::Load32(ip), mask);
1107
+ candidate = base_ip + *table_entry;
1108
+ *table_entry = ip - base_ip;
1109
+ if (LittleEndian::Load32(ip) == LittleEndian::Load32(candidate)) {
1110
+ candidate_length =
1111
+ FindMatchLengthPlain(candidate + 4, ip + 4, ip_end) + 4;
1112
+ continue;
1113
+ }
1114
+ break;
1115
+ } while (true);
1116
+ }
1117
+ }
1118
+
1119
+ emit_remainder:
1120
+ // Emit the remaining bytes as a literal
1121
+ if (ip < ip_end) {
1122
+ op = EmitLiteral</*allow_fast_path=*/false>(op, ip, ip_end - ip);
667
1123
  }
668
1124
 
669
1125
  return op;
670
1126
  }
671
1127
  } // end namespace internal
672
1128
 
673
- // Called back at avery compression call to trace parameters and sizes.
674
- static inline void Report(const char *algorithm, size_t compressed_size,
675
- size_t uncompressed_size) {}
1129
+ static inline void Report(int token, const char *algorithm, size_t
1130
+ compressed_size, size_t uncompressed_size) {
1131
+ // TODO: Switch to [[maybe_unused]] when we can assume C++17.
1132
+ (void)token;
1133
+ (void)algorithm;
1134
+ (void)compressed_size;
1135
+ (void)uncompressed_size;
1136
+ }
676
1137
 
677
1138
  // Signature of output types needed by decompression code.
678
1139
  // The decompression code is templatized on a type that obeys this
@@ -684,12 +1145,28 @@ static inline void Report(const char *algorithm, size_t compressed_size,
684
1145
  // // Called before decompression
685
1146
  // void SetExpectedLength(size_t length);
686
1147
  //
1148
+ // // For performance a writer may choose to donate the cursor variable to the
1149
+ // // decompression function. The decompression will inject it in all its
1150
+ // // function calls to the writer. Keeping the important output cursor as a
1151
+ // // function local stack variable allows the compiler to keep it in
1152
+ // // register, which greatly aids performance by avoiding loads and stores of
1153
+ // // this variable in the fast path loop iterations.
1154
+ // T GetOutputPtr() const;
1155
+ //
1156
+ // // At end of decompression the loop donates the ownership of the cursor
1157
+ // // variable back to the writer by calling this function.
1158
+ // void SetOutputPtr(T op);
1159
+ //
687
1160
  // // Called after decompression
688
1161
  // bool CheckLength() const;
689
1162
  //
690
1163
  // // Called repeatedly during decompression
691
- // bool Append(const char* ip, size_t length);
692
- // bool AppendFromSelf(uint32 offset, size_t length);
1164
+ // // Each function get a pointer to the op (output pointer), that the writer
1165
+ // // can use and update. Note it's important that these functions get fully
1166
+ // // inlined so that no actual address of the local variable needs to be
1167
+ // // taken.
1168
+ // bool Append(const char* ip, size_t length, T* op);
1169
+ // bool AppendFromSelf(uint32_t offset, size_t length, T* op);
693
1170
  //
694
1171
  // // The rules for how TryFastAppend differs from Append are somewhat
695
1172
  // // convoluted:
@@ -711,25 +1188,25 @@ static inline void Report(const char *algorithm, size_t compressed_size,
711
1188
  // // as it is unlikely that one would implement a fast path accepting
712
1189
  // // this much data.
713
1190
  // //
714
- // bool TryFastAppend(const char* ip, size_t available, size_t length);
1191
+ // bool TryFastAppend(const char* ip, size_t available, size_t length, T* op);
715
1192
  // };
716
1193
 
717
- static inline uint32 ExtractLowBytes(uint32 v, int n) {
1194
+ static inline uint32_t ExtractLowBytes(const uint32_t& v, int n) {
718
1195
  assert(n >= 0);
719
1196
  assert(n <= 4);
720
1197
  #if SNAPPY_HAVE_BMI2
721
1198
  return _bzhi_u32(v, 8 * n);
722
1199
  #else
723
- // This needs to be wider than uint32 otherwise `mask << 32` will be
1200
+ // This needs to be wider than uint32_t otherwise `mask << 32` will be
724
1201
  // undefined.
725
- uint64 mask = 0xffffffff;
1202
+ uint64_t mask = 0xffffffff;
726
1203
  return v & ~(mask << (8 * n));
727
1204
  #endif
728
1205
  }
729
1206
 
730
- static inline bool LeftShiftOverflows(uint8 value, uint32 shift) {
1207
+ static inline bool LeftShiftOverflows(uint8_t value, uint32_t shift) {
731
1208
  assert(shift < 32);
732
- static const uint8 masks[] = {
1209
+ static const uint8_t masks[] = {
733
1210
  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, //
734
1211
  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, //
735
1212
  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, //
@@ -737,15 +1214,294 @@ static inline bool LeftShiftOverflows(uint8 value, uint32 shift) {
737
1214
  return (value & masks[shift]) != 0;
738
1215
  }
739
1216
 
1217
+ inline bool Copy64BytesWithPatternExtension(ptrdiff_t dst, size_t offset) {
1218
+ // TODO: Switch to [[maybe_unused]] when we can assume C++17.
1219
+ (void)dst;
1220
+ return offset != 0;
1221
+ }
1222
+
1223
+ // Copies between size bytes and 64 bytes from src to dest. size cannot exceed
1224
+ // 64. More than size bytes, but never exceeding 64, might be copied if doing
1225
+ // so gives better performance. [src, src + size) must not overlap with
1226
+ // [dst, dst + size), but [src, src + 64) may overlap with [dst, dst + 64).
1227
+ void MemCopy64(char* dst, const void* src, size_t size) {
1228
+ // Always copy this many bytes. If that's below size then copy the full 64.
1229
+ constexpr int kShortMemCopy = 32;
1230
+
1231
+ assert(size <= 64);
1232
+ assert(std::less_equal<const void*>()(static_cast<const char*>(src) + size,
1233
+ dst) ||
1234
+ std::less_equal<const void*>()(dst + size, src));
1235
+
1236
+ // We know that src and dst are at least size bytes apart. However, because we
1237
+ // might copy more than size bytes the copy still might overlap past size.
1238
+ // E.g. if src and dst appear consecutively in memory (src + size >= dst).
1239
+ // TODO: Investigate wider copies on other platforms.
1240
+ #if defined(__x86_64__) && defined(__AVX__)
1241
+ assert(kShortMemCopy <= 32);
1242
+ __m256i data = _mm256_lddqu_si256(static_cast<const __m256i *>(src));
1243
+ _mm256_storeu_si256(reinterpret_cast<__m256i *>(dst), data);
1244
+ // Profiling shows that nearly all copies are short.
1245
+ if (SNAPPY_PREDICT_FALSE(size > kShortMemCopy)) {
1246
+ data = _mm256_lddqu_si256(static_cast<const __m256i *>(src) + 1);
1247
+ _mm256_storeu_si256(reinterpret_cast<__m256i *>(dst) + 1, data);
1248
+ }
1249
+ #else
1250
+ std::memmove(dst, src, kShortMemCopy);
1251
+ // Profiling shows that nearly all copies are short.
1252
+ if (SNAPPY_PREDICT_FALSE(size > kShortMemCopy)) {
1253
+ std::memmove(dst + kShortMemCopy,
1254
+ static_cast<const uint8_t*>(src) + kShortMemCopy,
1255
+ 64 - kShortMemCopy);
1256
+ }
1257
+ #endif
1258
+ }
1259
+
1260
+ void MemCopy64(ptrdiff_t dst, const void* src, size_t size) {
1261
+ // TODO: Switch to [[maybe_unused]] when we can assume C++17.
1262
+ (void)dst;
1263
+ (void)src;
1264
+ (void)size;
1265
+ }
1266
+
1267
+ void ClearDeferred(const void** deferred_src, size_t* deferred_length,
1268
+ uint8_t* safe_source) {
1269
+ *deferred_src = safe_source;
1270
+ *deferred_length = 0;
1271
+ }
1272
+
1273
+ void DeferMemCopy(const void** deferred_src, size_t* deferred_length,
1274
+ const void* src, size_t length) {
1275
+ *deferred_src = src;
1276
+ *deferred_length = length;
1277
+ }
1278
+
1279
+ SNAPPY_ATTRIBUTE_ALWAYS_INLINE
1280
+ inline size_t AdvanceToNextTagARMOptimized(const uint8_t** ip_p, size_t* tag) {
1281
+ const uint8_t*& ip = *ip_p;
1282
+ // This section is crucial for the throughput of the decompression loop.
1283
+ // The latency of an iteration is fundamentally constrained by the
1284
+ // following data chain on ip.
1285
+ // ip -> c = Load(ip) -> delta1 = (c & 3) -> ip += delta1 or delta2
1286
+ // delta2 = ((c >> 2) + 1) ip++
1287
+ // This is different from X86 optimizations because ARM has conditional add
1288
+ // instruction (csinc) and it removes several register moves.
1289
+ const size_t tag_type = *tag & 3;
1290
+ const bool is_literal = (tag_type == 0);
1291
+ if (is_literal) {
1292
+ size_t next_literal_tag = (*tag >> 2) + 1;
1293
+ *tag = ip[next_literal_tag];
1294
+ ip += next_literal_tag + 1;
1295
+ } else {
1296
+ *tag = ip[tag_type];
1297
+ ip += tag_type + 1;
1298
+ }
1299
+ return tag_type;
1300
+ }
1301
+
1302
+ SNAPPY_ATTRIBUTE_ALWAYS_INLINE
1303
+ inline size_t AdvanceToNextTagX86Optimized(const uint8_t** ip_p, size_t* tag) {
1304
+ const uint8_t*& ip = *ip_p;
1305
+ // This section is crucial for the throughput of the decompression loop.
1306
+ // The latency of an iteration is fundamentally constrained by the
1307
+ // following data chain on ip.
1308
+ // ip -> c = Load(ip) -> ip1 = ip + 1 + (c & 3) -> ip = ip1 or ip2
1309
+ // ip2 = ip + 2 + (c >> 2)
1310
+ // This amounts to 8 cycles.
1311
+ // 5 (load) + 1 (c & 3) + 1 (lea ip1, [ip + (c & 3) + 1]) + 1 (cmov)
1312
+ size_t literal_len = *tag >> 2;
1313
+ size_t tag_type = *tag;
1314
+ bool is_literal;
1315
+ #if defined(__GCC_ASM_FLAG_OUTPUTS__) && defined(__x86_64__)
1316
+ // TODO clang misses the fact that the (c & 3) already correctly
1317
+ // sets the zero flag.
1318
+ asm("and $3, %k[tag_type]\n\t"
1319
+ : [tag_type] "+r"(tag_type), "=@ccz"(is_literal)
1320
+ :: "cc");
1321
+ #else
1322
+ tag_type &= 3;
1323
+ is_literal = (tag_type == 0);
1324
+ #endif
1325
+ // TODO
1326
+ // This is code is subtle. Loading the values first and then cmov has less
1327
+ // latency then cmov ip and then load. However clang would move the loads
1328
+ // in an optimization phase, volatile prevents this transformation.
1329
+ // Note that we have enough slop bytes (64) that the loads are always valid.
1330
+ size_t tag_literal =
1331
+ static_cast<const volatile uint8_t*>(ip)[1 + literal_len];
1332
+ size_t tag_copy = static_cast<const volatile uint8_t*>(ip)[tag_type];
1333
+ *tag = is_literal ? tag_literal : tag_copy;
1334
+ const uint8_t* ip_copy = ip + 1 + tag_type;
1335
+ const uint8_t* ip_literal = ip + 2 + literal_len;
1336
+ ip = is_literal ? ip_literal : ip_copy;
1337
+ #if defined(__GNUC__) && defined(__x86_64__)
1338
+ // TODO Clang is "optimizing" zero-extension (a totally free
1339
+ // operation) this means that after the cmov of tag, it emits another movzb
1340
+ // tag, byte(tag). It really matters as it's on the core chain. This dummy
1341
+ // asm, persuades clang to do the zero-extension at the load (it's automatic)
1342
+ // removing the expensive movzb.
1343
+ asm("" ::"r"(tag_copy));
1344
+ #endif
1345
+ return tag_type;
1346
+ }
1347
+
1348
+ // Extract the offset for copy-1 and copy-2 returns 0 for literals or copy-4.
1349
+ inline uint32_t ExtractOffset(uint32_t val, size_t tag_type) {
1350
+ // For x86 non-static storage works better. For ARM static storage is better.
1351
+ // TODO: Once the array is recognized as a register, improve the
1352
+ // readability for x86.
1353
+ #if defined(__x86_64__)
1354
+ constexpr uint64_t kExtractMasksCombined = 0x0000FFFF00FF0000ull;
1355
+ uint16_t result;
1356
+ memcpy(&result,
1357
+ reinterpret_cast<const char*>(&kExtractMasksCombined) + 2 * tag_type,
1358
+ sizeof(result));
1359
+ return val & result;
1360
+ #elif defined(__aarch64__)
1361
+ constexpr uint64_t kExtractMasksCombined = 0x0000FFFF00FF0000ull;
1362
+ return val & static_cast<uint32_t>(
1363
+ (kExtractMasksCombined >> (tag_type * 16)) & 0xFFFF);
1364
+ #else
1365
+ static constexpr uint32_t kExtractMasks[4] = {0, 0xFF, 0xFFFF, 0};
1366
+ return val & kExtractMasks[tag_type];
1367
+ #endif
1368
+ };
1369
+
1370
+ // Core decompression loop, when there is enough data available.
1371
+ // Decompresses the input buffer [ip, ip_limit) into the output buffer
1372
+ // [op, op_limit_min_slop). Returning when either we are too close to the end
1373
+ // of the input buffer, or we exceed op_limit_min_slop or when a exceptional
1374
+ // tag is encountered (literal of length > 60) or a copy-4.
1375
+ // Returns {ip, op} at the points it stopped decoding.
1376
+ // TODO This function probably does not need to be inlined, as it
1377
+ // should decode large chunks at a time. This allows runtime dispatch to
1378
+ // implementations based on CPU capability (BMI2 / perhaps 32 / 64 byte memcpy).
1379
+ template <typename T>
1380
+ std::pair<const uint8_t*, ptrdiff_t> DecompressBranchless(
1381
+ const uint8_t* ip, const uint8_t* ip_limit, ptrdiff_t op, T op_base,
1382
+ ptrdiff_t op_limit_min_slop) {
1383
+ // If deferred_src is invalid point it here.
1384
+ uint8_t safe_source[64];
1385
+ const void* deferred_src;
1386
+ size_t deferred_length;
1387
+ ClearDeferred(&deferred_src, &deferred_length, safe_source);
1388
+
1389
+ // We unroll the inner loop twice so we need twice the spare room.
1390
+ op_limit_min_slop -= kSlopBytes;
1391
+ if (2 * (kSlopBytes + 1) < ip_limit - ip && op < op_limit_min_slop) {
1392
+ const uint8_t* const ip_limit_min_slop = ip_limit - 2 * kSlopBytes - 1;
1393
+ ip++;
1394
+ // ip points just past the tag and we are touching at maximum kSlopBytes
1395
+ // in an iteration.
1396
+ size_t tag = ip[-1];
1397
+ #if defined(__clang__) && defined(__aarch64__)
1398
+ // Workaround for https://bugs.llvm.org/show_bug.cgi?id=51317
1399
+ // when loading 1 byte, clang for aarch64 doesn't realize that it(ldrb)
1400
+ // comes with free zero-extension, so clang generates another
1401
+ // 'and xn, xm, 0xff' before it use that as the offset. This 'and' is
1402
+ // redundant and can be removed by adding this dummy asm, which gives
1403
+ // clang a hint that we're doing the zero-extension at the load.
1404
+ asm("" ::"r"(tag));
1405
+ #endif
1406
+ do {
1407
+ // The throughput is limited by instructions, unrolling the inner loop
1408
+ // twice reduces the amount of instructions checking limits and also
1409
+ // leads to reduced mov's.
1410
+
1411
+ SNAPPY_PREFETCH(ip + 128);
1412
+ for (int i = 0; i < 2; i++) {
1413
+ const uint8_t* old_ip = ip;
1414
+ assert(tag == ip[-1]);
1415
+ // For literals tag_type = 0, hence we will always obtain 0 from
1416
+ // ExtractLowBytes. For literals offset will thus be kLiteralOffset.
1417
+ ptrdiff_t len_minus_offset = kLengthMinusOffset[tag];
1418
+ uint32_t next;
1419
+ #if defined(__aarch64__)
1420
+ size_t tag_type = AdvanceToNextTagARMOptimized(&ip, &tag);
1421
+ // We never need more than 16 bits. Doing a Load16 allows the compiler
1422
+ // to elide the masking operation in ExtractOffset.
1423
+ next = LittleEndian::Load16(old_ip);
1424
+ #else
1425
+ size_t tag_type = AdvanceToNextTagX86Optimized(&ip, &tag);
1426
+ next = LittleEndian::Load32(old_ip);
1427
+ #endif
1428
+ size_t len = len_minus_offset & 0xFF;
1429
+ ptrdiff_t extracted = ExtractOffset(next, tag_type);
1430
+ ptrdiff_t len_min_offset = len_minus_offset - extracted;
1431
+ if (SNAPPY_PREDICT_FALSE(len_minus_offset > extracted)) {
1432
+ if (SNAPPY_PREDICT_FALSE(len & 0x80)) {
1433
+ // Exceptional case (long literal or copy 4).
1434
+ // Actually doing the copy here is negatively impacting the main
1435
+ // loop due to compiler incorrectly allocating a register for
1436
+ // this fallback. Hence we just break.
1437
+ break_loop:
1438
+ ip = old_ip;
1439
+ goto exit;
1440
+ }
1441
+ // Only copy-1 or copy-2 tags can get here.
1442
+ assert(tag_type == 1 || tag_type == 2);
1443
+ std::ptrdiff_t delta = (op + deferred_length) + len_min_offset - len;
1444
+ // Guard against copies before the buffer start.
1445
+ // Execute any deferred MemCopy since we write to dst here.
1446
+ MemCopy64(op_base + op, deferred_src, deferred_length);
1447
+ op += deferred_length;
1448
+ ClearDeferred(&deferred_src, &deferred_length, safe_source);
1449
+ if (SNAPPY_PREDICT_FALSE(delta < 0 ||
1450
+ !Copy64BytesWithPatternExtension(
1451
+ op_base + op, len - len_min_offset))) {
1452
+ goto break_loop;
1453
+ }
1454
+ // We aren't deferring this copy so add length right away.
1455
+ op += len;
1456
+ continue;
1457
+ }
1458
+ std::ptrdiff_t delta = (op + deferred_length) + len_min_offset - len;
1459
+ if (SNAPPY_PREDICT_FALSE(delta < 0)) {
1460
+ // Due to the spurious offset in literals have this will trigger
1461
+ // at the start of a block when op is still smaller than 256.
1462
+ if (tag_type != 0) goto break_loop;
1463
+ MemCopy64(op_base + op, deferred_src, deferred_length);
1464
+ op += deferred_length;
1465
+ DeferMemCopy(&deferred_src, &deferred_length, old_ip, len);
1466
+ continue;
1467
+ }
1468
+
1469
+ // For copies we need to copy from op_base + delta, for literals
1470
+ // we need to copy from ip instead of from the stream.
1471
+ const void* from =
1472
+ tag_type ? reinterpret_cast<void*>(op_base + delta) : old_ip;
1473
+ MemCopy64(op_base + op, deferred_src, deferred_length);
1474
+ op += deferred_length;
1475
+ DeferMemCopy(&deferred_src, &deferred_length, from, len);
1476
+ }
1477
+ } while (ip < ip_limit_min_slop &&
1478
+ static_cast<ptrdiff_t>(op + deferred_length) < op_limit_min_slop);
1479
+ exit:
1480
+ ip--;
1481
+ assert(ip <= ip_limit);
1482
+ }
1483
+ // If we deferred a copy then we can perform. If we are up to date then we
1484
+ // might not have enough slop bytes and could run past the end.
1485
+ if (deferred_length) {
1486
+ MemCopy64(op_base + op, deferred_src, deferred_length);
1487
+ op += deferred_length;
1488
+ ClearDeferred(&deferred_src, &deferred_length, safe_source);
1489
+ }
1490
+ return {ip, op};
1491
+ }
1492
+
740
1493
  // Helper class for decompression
741
1494
  class SnappyDecompressor {
742
1495
  private:
743
- Source* reader_; // Underlying source of bytes to decompress
744
- const char* ip_; // Points to next buffered byte
745
- const char* ip_limit_; // Points just past buffered bytes
746
- uint32 peeked_; // Bytes peeked from reader (need to skip)
747
- bool eof_; // Hit end of input without an error?
748
- char scratch_[kMaximumTagLength]; // See RefillTag().
1496
+ Source* reader_; // Underlying source of bytes to decompress
1497
+ const char* ip_; // Points to next buffered byte
1498
+ const char* ip_limit_; // Points just past buffered bytes
1499
+ // If ip < ip_limit_min_maxtaglen_ it's safe to read kMaxTagLength from
1500
+ // buffer.
1501
+ const char* ip_limit_min_maxtaglen_;
1502
+ uint64_t peeked_; // Bytes peeked from reader (need to skip)
1503
+ bool eof_; // Hit end of input without an error?
1504
+ char scratch_[kMaximumTagLength]; // See RefillTag().
749
1505
 
750
1506
  // Ensure that all of the tag metadata for the next tag is available
751
1507
  // in [ip_..ip_limit_-1]. Also ensures that [ip,ip+4] is readable even
@@ -754,14 +1510,14 @@ class SnappyDecompressor {
754
1510
  // Returns true on success, false on error or end of input.
755
1511
  bool RefillTag();
756
1512
 
1513
+ void ResetLimit(const char* ip) {
1514
+ ip_limit_min_maxtaglen_ =
1515
+ ip_limit_ - std::min<ptrdiff_t>(ip_limit_ - ip, kMaximumTagLength - 1);
1516
+ }
1517
+
757
1518
  public:
758
1519
  explicit SnappyDecompressor(Source* reader)
759
- : reader_(reader),
760
- ip_(NULL),
761
- ip_limit_(NULL),
762
- peeked_(0),
763
- eof_(false) {
764
- }
1520
+ : reader_(reader), ip_(NULL), ip_limit_(NULL), peeked_(0), eof_(false) {}
765
1521
 
766
1522
  ~SnappyDecompressor() {
767
1523
  // Advance past any bytes we peeked at from the reader
@@ -769,18 +1525,16 @@ class SnappyDecompressor {
769
1525
  }
770
1526
 
771
1527
  // Returns true iff we have hit the end of the input without an error.
772
- bool eof() const {
773
- return eof_;
774
- }
1528
+ bool eof() const { return eof_; }
775
1529
 
776
1530
  // Read the uncompressed length stored at the start of the compressed data.
777
1531
  // On success, stores the length in *result and returns true.
778
1532
  // On failure, returns false.
779
- bool ReadUncompressedLength(uint32* result) {
780
- assert(ip_ == NULL); // Must not have read anything yet
1533
+ bool ReadUncompressedLength(uint32_t* result) {
1534
+ assert(ip_ == NULL); // Must not have read anything yet
781
1535
  // Length is encoded in 1..5 bytes
782
1536
  *result = 0;
783
- uint32 shift = 0;
1537
+ uint32_t shift = 0;
784
1538
  while (true) {
785
1539
  if (shift >= 32) return false;
786
1540
  size_t n;
@@ -788,8 +1542,8 @@ class SnappyDecompressor {
788
1542
  if (n == 0) return false;
789
1543
  const unsigned char c = *(reinterpret_cast<const unsigned char*>(ip));
790
1544
  reader_->Skip(1);
791
- uint32 val = c & 0x7f;
792
- if (LeftShiftOverflows(static_cast<uint8>(val), shift)) return false;
1545
+ uint32_t val = c & 0x7f;
1546
+ if (LeftShiftOverflows(static_cast<uint8_t>(val), shift)) return false;
793
1547
  *result |= val << shift;
794
1548
  if (c < 128) {
795
1549
  break;
@@ -805,38 +1559,44 @@ class SnappyDecompressor {
805
1559
  #if defined(__GNUC__) && defined(__x86_64__)
806
1560
  __attribute__((aligned(32)))
807
1561
  #endif
808
- void DecompressAllTags(Writer* writer) {
809
- // In x86, pad the function body to start 16 bytes later. This function has
810
- // a couple of hotspots that are highly sensitive to alignment: we have
811
- // observed regressions by more than 20% in some metrics just by moving the
812
- // exact same code to a different position in the benchmark binary.
813
- //
814
- // Putting this code on a 32-byte-aligned boundary + 16 bytes makes us hit
815
- // the "lucky" case consistently. Unfortunately, this is a very brittle
816
- // workaround, and future differences in code generation may reintroduce
817
- // this regression. If you experience a big, difficult to explain, benchmark
818
- // performance regression here, first try removing this hack.
819
- #if defined(__GNUC__) && defined(__x86_64__)
820
- // Two 8-byte "NOP DWORD ptr [EAX + EAX*1 + 00000000H]" instructions.
821
- asm(".byte 0x0f, 0x1f, 0x84, 0x00, 0x00, 0x00, 0x00, 0x00");
822
- asm(".byte 0x0f, 0x1f, 0x84, 0x00, 0x00, 0x00, 0x00, 0x00");
823
- #endif
824
-
1562
+ void
1563
+ DecompressAllTags(Writer* writer) {
825
1564
  const char* ip = ip_;
1565
+ ResetLimit(ip);
1566
+ auto op = writer->GetOutputPtr();
826
1567
  // We could have put this refill fragment only at the beginning of the loop.
827
1568
  // However, duplicating it at the end of each branch gives the compiler more
828
1569
  // scope to optimize the <ip_limit_ - ip> expression based on the local
829
1570
  // context, which overall increases speed.
830
- #define MAYBE_REFILL() \
831
- if (ip_limit_ - ip < kMaximumTagLength) { \
832
- ip_ = ip; \
833
- if (!RefillTag()) return; \
834
- ip = ip_; \
835
- }
836
-
1571
+ #define MAYBE_REFILL() \
1572
+ if (SNAPPY_PREDICT_FALSE(ip >= ip_limit_min_maxtaglen_)) { \
1573
+ ip_ = ip; \
1574
+ if (SNAPPY_PREDICT_FALSE(!RefillTag())) goto exit; \
1575
+ ip = ip_; \
1576
+ ResetLimit(ip); \
1577
+ } \
1578
+ preload = static_cast<uint8_t>(*ip)
1579
+
1580
+ // At the start of the for loop below the least significant byte of preload
1581
+ // contains the tag.
1582
+ uint32_t preload;
837
1583
  MAYBE_REFILL();
838
- for ( ;; ) {
839
- const unsigned char c = *(reinterpret_cast<const unsigned char*>(ip++));
1584
+ for (;;) {
1585
+ {
1586
+ ptrdiff_t op_limit_min_slop;
1587
+ auto op_base = writer->GetBase(&op_limit_min_slop);
1588
+ if (op_base) {
1589
+ auto res =
1590
+ DecompressBranchless(reinterpret_cast<const uint8_t*>(ip),
1591
+ reinterpret_cast<const uint8_t*>(ip_limit_),
1592
+ op - op_base, op_base, op_limit_min_slop);
1593
+ ip = reinterpret_cast<const char*>(res.first);
1594
+ op = op_base + res.second;
1595
+ MAYBE_REFILL();
1596
+ }
1597
+ }
1598
+ const uint8_t c = static_cast<uint8_t>(preload);
1599
+ ip++;
840
1600
 
841
1601
  // Ratio of iterations that have LITERAL vs non-LITERAL for different
842
1602
  // inputs.
@@ -852,12 +1612,13 @@ class SnappyDecompressor {
852
1612
  // bin 24% 76%
853
1613
  if (SNAPPY_PREDICT_FALSE((c & 0x3) == LITERAL)) {
854
1614
  size_t literal_length = (c >> 2) + 1u;
855
- if (writer->TryFastAppend(ip, ip_limit_ - ip, literal_length)) {
1615
+ if (writer->TryFastAppend(ip, ip_limit_ - ip, literal_length, &op)) {
856
1616
  assert(literal_length < 61);
857
1617
  ip += literal_length;
858
1618
  // NOTE: There is no MAYBE_REFILL() here, as TryFastAppend()
859
1619
  // will not return true unless there's already at least five spare
860
1620
  // bytes in addition to the literal.
1621
+ preload = static_cast<uint8_t>(*ip);
861
1622
  continue;
862
1623
  }
863
1624
  if (SNAPPY_PREDICT_FALSE(literal_length >= 61)) {
@@ -871,48 +1632,80 @@ class SnappyDecompressor {
871
1632
 
872
1633
  size_t avail = ip_limit_ - ip;
873
1634
  while (avail < literal_length) {
874
- if (!writer->Append(ip, avail)) return;
1635
+ if (!writer->Append(ip, avail, &op)) goto exit;
875
1636
  literal_length -= avail;
876
1637
  reader_->Skip(peeked_);
877
1638
  size_t n;
878
1639
  ip = reader_->Peek(&n);
879
1640
  avail = n;
880
1641
  peeked_ = avail;
881
- if (avail == 0) return; // Premature end of input
1642
+ if (avail == 0) goto exit;
882
1643
  ip_limit_ = ip + avail;
1644
+ ResetLimit(ip);
883
1645
  }
884
- if (!writer->Append(ip, literal_length)) {
885
- return;
886
- }
1646
+ if (!writer->Append(ip, literal_length, &op)) goto exit;
887
1647
  ip += literal_length;
888
1648
  MAYBE_REFILL();
889
1649
  } else {
890
- const size_t entry = char_table[c];
891
- const size_t trailer =
892
- ExtractLowBytes(LittleEndian::Load32(ip), entry >> 11);
893
- const size_t length = entry & 0xff;
894
- ip += entry >> 11;
895
-
896
- // copy_offset/256 is encoded in bits 8..10. By just fetching
897
- // those bits, we get copy_offset (since the bit-field starts at
898
- // bit 8).
899
- const size_t copy_offset = entry & 0x700;
900
- if (!writer->AppendFromSelf(copy_offset + trailer, length)) {
901
- return;
1650
+ if (SNAPPY_PREDICT_FALSE((c & 3) == COPY_4_BYTE_OFFSET)) {
1651
+ const size_t copy_offset = LittleEndian::Load32(ip);
1652
+ const size_t length = (c >> 2) + 1;
1653
+ ip += 4;
1654
+
1655
+ if (!writer->AppendFromSelf(copy_offset, length, &op)) goto exit;
1656
+ } else {
1657
+ const ptrdiff_t entry = kLengthMinusOffset[c];
1658
+ preload = LittleEndian::Load32(ip);
1659
+ const uint32_t trailer = ExtractLowBytes(preload, c & 3);
1660
+ const uint32_t length = entry & 0xff;
1661
+ assert(length > 0);
1662
+
1663
+ // copy_offset/256 is encoded in bits 8..10. By just fetching
1664
+ // those bits, we get copy_offset (since the bit-field starts at
1665
+ // bit 8).
1666
+ const uint32_t copy_offset = trailer - entry + length;
1667
+ if (!writer->AppendFromSelf(copy_offset, length, &op)) goto exit;
1668
+
1669
+ ip += (c & 3);
1670
+ // By using the result of the previous load we reduce the critical
1671
+ // dependency chain of ip to 4 cycles.
1672
+ preload >>= (c & 3) * 8;
1673
+ if (ip < ip_limit_min_maxtaglen_) continue;
902
1674
  }
903
1675
  MAYBE_REFILL();
904
1676
  }
905
1677
  }
906
-
907
1678
  #undef MAYBE_REFILL
1679
+ exit:
1680
+ writer->SetOutputPtr(op);
908
1681
  }
909
1682
  };
910
1683
 
1684
+ constexpr uint32_t CalculateNeeded(uint8_t tag) {
1685
+ return ((tag & 3) == 0 && tag >= (60 * 4))
1686
+ ? (tag >> 2) - 58
1687
+ : (0x05030201 >> ((tag * 8) & 31)) & 0xFF;
1688
+ }
1689
+
1690
+ #if __cplusplus >= 201402L
1691
+ constexpr bool VerifyCalculateNeeded() {
1692
+ for (int i = 0; i < 1; i++) {
1693
+ if (CalculateNeeded(i) != static_cast<uint32_t>((char_table[i] >> 11)) + 1)
1694
+ return false;
1695
+ }
1696
+ return true;
1697
+ }
1698
+
1699
+ // Make sure CalculateNeeded is correct by verifying it against the established
1700
+ // table encoding the number of added bytes needed.
1701
+ static_assert(VerifyCalculateNeeded(), "");
1702
+ #endif // c++14
1703
+
911
1704
  bool SnappyDecompressor::RefillTag() {
912
1705
  const char* ip = ip_;
913
1706
  if (ip == ip_limit_) {
914
1707
  // Fetch a new fragment from the reader
915
- reader_->Skip(peeked_); // All peeked bytes are used up
1708
+ reader_->Skip(peeked_); // All peeked bytes are used up
916
1709
  size_t n;
917
1710
  ip = reader_->Peek(&n);
918
1711
  peeked_ = n;
@@ -924,26 +1717,31 @@ bool SnappyDecompressor::RefillTag() {
924
1717
  // Read the tag character
925
1718
  assert(ip < ip_limit_);
926
1719
  const unsigned char c = *(reinterpret_cast<const unsigned char*>(ip));
927
- const uint32 entry = char_table[c];
928
- const uint32 needed = (entry >> 11) + 1; // +1 byte for 'c'
1720
+ // At this point make sure that the data for the next tag is consecutive.
1721
+ // For copy 1 this means the next 2 bytes (tag and 1 byte offset)
1722
+ // For copy 2 the next 3 bytes (tag and 2 byte offset)
1723
+ // For copy 4 the next 5 bytes (tag and 4 byte offset)
1724
+ // For all small literals we only need 1 byte buf for literals 60...63 the
1725
+ // length is encoded in 1...4 extra bytes.
1726
+ const uint32_t needed = CalculateNeeded(c);
929
1727
  assert(needed <= sizeof(scratch_));
930
1728
 
931
1729
  // Read more bytes from reader if needed
932
- uint32 nbuf = ip_limit_ - ip;
1730
+ uint64_t nbuf = ip_limit_ - ip;
933
1731
  if (nbuf < needed) {
934
1732
  // Stitch together bytes from ip and reader to form the word
935
1733
  // contents. We store the needed bytes in "scratch_". They
936
1734
  // will be consumed immediately by the caller since we do not
937
1735
  // read more than we need.
938
- memmove(scratch_, ip, nbuf);
1736
+ std::memmove(scratch_, ip, nbuf);
939
1737
  reader_->Skip(peeked_); // All peeked bytes are used up
940
1738
  peeked_ = 0;
941
1739
  while (nbuf < needed) {
942
1740
  size_t length;
943
1741
  const char* src = reader_->Peek(&length);
944
1742
  if (length == 0) return false;
945
- uint32 to_add = std::min<uint32>(needed - nbuf, length);
946
- memcpy(scratch_ + nbuf, src, to_add);
1743
+ uint64_t to_add = std::min<uint64_t>(needed - nbuf, length);
1744
+ std::memcpy(scratch_ + nbuf, src, to_add);
947
1745
  nbuf += to_add;
948
1746
  reader_->Skip(to_add);
949
1747
  }
@@ -953,7 +1751,7 @@ bool SnappyDecompressor::RefillTag() {
953
1751
  } else if (nbuf < kMaximumTagLength) {
954
1752
  // Have enough bytes, but move into scratch_ so that we do not
955
1753
  // read past end of input
956
- memmove(scratch_, ip, nbuf);
1754
+ std::memmove(scratch_, ip, nbuf);
957
1755
  reader_->Skip(peeked_); // All peeked bytes are used up
958
1756
  peeked_ = 0;
959
1757
  ip_ = scratch_;
@@ -969,7 +1767,7 @@ template <typename Writer>
969
1767
  static bool InternalUncompress(Source* r, Writer* writer) {
970
1768
  // Read the uncompressed length from the front of the compressed input
971
1769
  SnappyDecompressor decompressor(r);
972
- uint32 uncompressed_len = 0;
1770
+ uint32_t uncompressed_len = 0;
973
1771
  if (!decompressor.ReadUncompressedLength(&uncompressed_len)) return false;
974
1772
 
975
1773
  return InternalUncompressAllTags(&decompressor, writer, r->Available(),
@@ -978,10 +1776,10 @@ static bool InternalUncompress(Source* r, Writer* writer) {
978
1776
 
979
1777
  template <typename Writer>
980
1778
  static bool InternalUncompressAllTags(SnappyDecompressor* decompressor,
981
- Writer* writer,
982
- uint32 compressed_len,
983
- uint32 uncompressed_len) {
984
- Report("snappy_uncompress", compressed_len, uncompressed_len);
1779
+ Writer* writer, uint32_t compressed_len,
1780
+ uint32_t uncompressed_len) {
1781
+ int token = 0;
1782
+ Report(token, "snappy_uncompress", compressed_len, uncompressed_len);
985
1783
 
986
1784
  writer->SetExpectedLength(uncompressed_len);
987
1785
 
@@ -991,18 +1789,25 @@ static bool InternalUncompressAllTags(SnappyDecompressor* decompressor,
991
1789
  return (decompressor->eof() && writer->CheckLength());
992
1790
  }
993
1791
 
994
- bool GetUncompressedLength(Source* source, uint32* result) {
1792
+ bool GetUncompressedLength(Source* source, uint32_t* result) {
995
1793
  SnappyDecompressor decompressor(source);
996
1794
  return decompressor.ReadUncompressedLength(result);
997
1795
  }
998
1796
 
999
1797
  size_t Compress(Source* reader, Sink* writer) {
1798
+ return Compress(reader, writer, CompressionOptions{});
1799
+ }
1800
+
1801
+ size_t Compress(Source* reader, Sink* writer, CompressionOptions options) {
1802
+ assert(options.level == 1 || options.level == 2);
1803
+ int token = 0;
1000
1804
  size_t written = 0;
1001
1805
  size_t N = reader->Available();
1806
+ assert(N <= 0xFFFFFFFFu);
1002
1807
  const size_t uncompressed_size = N;
1003
1808
  char ulength[Varint::kMax32];
1004
1809
  char* p = Varint::Encode32(ulength, N);
1005
- writer->Append(ulength, p-ulength);
1810
+ writer->Append(ulength, p - ulength);
1006
1811
  written += (p - ulength);
1007
1812
 
1008
1813
  internal::WorkingMemory wmem(N);
@@ -1022,13 +1827,13 @@ size_t Compress(Source* reader, Sink* writer) {
1022
1827
  fragment_size = num_to_read;
1023
1828
  } else {
1024
1829
  char* scratch = wmem.GetScratchInput();
1025
- memcpy(scratch, fragment, bytes_read);
1830
+ std::memcpy(scratch, fragment, bytes_read);
1026
1831
  reader->Skip(bytes_read);
1027
1832
 
1028
1833
  while (bytes_read < num_to_read) {
1029
1834
  fragment = reader->Peek(&fragment_size);
1030
1835
  size_t n = std::min<size_t>(fragment_size, num_to_read - bytes_read);
1031
- memcpy(scratch + bytes_read, fragment, n);
1836
+ std::memcpy(scratch + bytes_read, fragment, n);
1032
1837
  bytes_read += n;
1033
1838
  reader->Skip(n);
1034
1839
  }
@@ -1040,20 +1845,26 @@ size_t Compress(Source* reader, Sink* writer) {
1040
1845
 
1041
1846
  // Get encoding table for compression
1042
1847
  int table_size;
1043
- uint16* table = wmem.GetHashTable(num_to_read, &table_size);
1848
+ uint16_t* table = wmem.GetHashTable(num_to_read, &table_size);
1044
1849
 
1045
1850
  // Compress input_fragment and append to dest
1046
- const int max_output = MaxCompressedLength(num_to_read);
1047
-
1048
- // Need a scratch buffer for the output, in case the byte sink doesn't
1049
- // have room for us directly.
1851
+ int max_output = MaxCompressedLength(num_to_read);
1050
1852
 
1051
1853
  // Since we encode kBlockSize regions followed by a region
1052
1854
  // which is <= kBlockSize in length, a previously allocated
1053
1855
  // scratch_output[] region is big enough for this iteration.
1856
+ // Need a scratch buffer for the output, in case the byte sink doesn't
1857
+ // have room for us directly.
1054
1858
  char* dest = writer->GetAppendBuffer(max_output, wmem.GetScratchOutput());
1055
- char* end = internal::CompressFragment(fragment, fragment_size, dest, table,
1056
- table_size);
1859
+ char* end = nullptr;
1860
+ if (options.level == 1) {
1861
+ end = internal::CompressFragment(fragment, fragment_size, dest, table,
1862
+ table_size);
1863
+ } else if (options.level == 2) {
1864
+ end = internal::CompressFragmentDoubleHash(
1865
+ fragment, fragment_size, dest, table, table_size >> 1,
1866
+ table + (table_size >> 1), table_size >> 1);
1867
+ }
1057
1868
  writer->Append(dest, end - dest);
1058
1869
  written += (end - dest);
1059
1870
 
@@ -1061,8 +1872,7 @@ size_t Compress(Source* reader, Sink* writer) {
1061
1872
  reader->Skip(pending_advance);
1062
1873
  }
1063
1874
 
1064
- Report("snappy_compress", written, uncompressed_size);
1065
-
1875
+ Report(token, "snappy_compress", written, uncompressed_size);
1066
1876
  return written;
1067
1877
  }
1068
1878
 
@@ -1070,6 +1880,67 @@ size_t Compress(Source* reader, Sink* writer) {
1070
1880
  // IOVec interfaces
1071
1881
  // -----------------------------------------------------------------------
1072
1882
 
1883
+ // A `Source` implementation that yields the contents of an `iovec` array. Note
1884
+ // that `total_size` is the total number of bytes to be read from the elements
1885
+ // of `iov` (_not_ the total number of elements in `iov`).
1886
+ class SnappyIOVecReader : public Source {
1887
+ public:
1888
+ SnappyIOVecReader(const struct iovec* iov, size_t total_size)
1889
+ : curr_iov_(iov),
1890
+ curr_pos_(total_size > 0 ? reinterpret_cast<const char*>(iov->iov_base)
1891
+ : nullptr),
1892
+ curr_size_remaining_(total_size > 0 ? iov->iov_len : 0),
1893
+ total_size_remaining_(total_size) {
1894
+ // Skip empty leading `iovec`s.
1895
+ if (total_size > 0 && curr_size_remaining_ == 0) Advance();
1896
+ }
1897
+
1898
+ ~SnappyIOVecReader() override = default;
1899
+
1900
+ size_t Available() const override { return total_size_remaining_; }
1901
+
1902
+ const char* Peek(size_t* len) override {
1903
+ *len = curr_size_remaining_;
1904
+ return curr_pos_;
1905
+ }
1906
+
1907
+ void Skip(size_t n) override {
1908
+ while (n >= curr_size_remaining_ && n > 0) {
1909
+ n -= curr_size_remaining_;
1910
+ Advance();
1911
+ }
1912
+ curr_size_remaining_ -= n;
1913
+ total_size_remaining_ -= n;
1914
+ curr_pos_ += n;
1915
+ }
1916
+
1917
+ private:
1918
+ // Advances to the next nonempty `iovec` and updates related variables.
1919
+ void Advance() {
1920
+ do {
1921
+ assert(total_size_remaining_ >= curr_size_remaining_);
1922
+ total_size_remaining_ -= curr_size_remaining_;
1923
+ if (total_size_remaining_ == 0) {
1924
+ curr_pos_ = nullptr;
1925
+ curr_size_remaining_ = 0;
1926
+ return;
1927
+ }
1928
+ ++curr_iov_;
1929
+ curr_pos_ = reinterpret_cast<const char*>(curr_iov_->iov_base);
1930
+ curr_size_remaining_ = curr_iov_->iov_len;
1931
+ } while (curr_size_remaining_ == 0);
1932
+ }
1933
+
1934
+ // The `iovec` currently being read.
1935
+ const struct iovec* curr_iov_;
1936
+ // The location in `curr_iov_` currently being read.
1937
+ const char* curr_pos_;
1938
+ // The amount of unread data in `curr_iov_`.
1939
+ size_t curr_size_remaining_;
1940
+ // The amount of unread data in the entire input array.
1941
+ size_t total_size_remaining_;
1942
+ };
1943
+
1073
1944
  // A type that writes to an iovec.
1074
1945
  // Note that this is not a "ByteSink", but a type that matches the
1075
1946
  // Writer template argument to SnappyDecompressor::DecompressAllTags().
@@ -1115,17 +1986,14 @@ class SnappyIOVecWriter {
1115
1986
  : nullptr),
1116
1987
  curr_iov_remaining_(iov_count ? iov->iov_len : 0),
1117
1988
  total_written_(0),
1118
- output_limit_(-1) {}
1119
-
1120
- inline void SetExpectedLength(size_t len) {
1121
- output_limit_ = len;
1989
+ output_limit_(-1) {
1122
1990
  }
1123
1991
 
1124
- inline bool CheckLength() const {
1125
- return total_written_ == output_limit_;
1126
- }
1992
+ inline void SetExpectedLength(size_t len) { output_limit_ = len; }
1127
1993
 
1128
- inline bool Append(const char* ip, size_t len) {
1994
+ inline bool CheckLength() const { return total_written_ == output_limit_; }
1995
+
1996
+ inline bool Append(const char* ip, size_t len, char**) {
1129
1997
  if (total_written_ + len > output_limit_) {
1130
1998
  return false;
1131
1999
  }
@@ -1133,6 +2001,13 @@ class SnappyIOVecWriter {
1133
2001
  return AppendNoCheck(ip, len);
1134
2002
  }
1135
2003
 
2004
+ char* GetOutputPtr() { return nullptr; }
2005
+ char* GetBase(ptrdiff_t*) { return nullptr; }
2006
+ void SetOutputPtr(char* op) {
2007
+ // TODO: Switch to [[maybe_unused]] when we can assume C++17.
2008
+ (void)op;
2009
+ }
2010
+
1136
2011
  inline bool AppendNoCheck(const char* ip, size_t len) {
1137
2012
  while (len > 0) {
1138
2013
  if (curr_iov_remaining_ == 0) {
@@ -1146,7 +2021,7 @@ class SnappyIOVecWriter {
1146
2021
  }
1147
2022
 
1148
2023
  const size_t to_write = std::min(len, curr_iov_remaining_);
1149
- memcpy(curr_iov_output_, ip, to_write);
2024
+ std::memcpy(curr_iov_output_, ip, to_write);
1150
2025
  curr_iov_output_ += to_write;
1151
2026
  curr_iov_remaining_ -= to_write;
1152
2027
  total_written_ += to_write;
@@ -1157,7 +2032,8 @@ class SnappyIOVecWriter {
1157
2032
  return true;
1158
2033
  }
1159
2034
 
1160
- inline bool TryFastAppend(const char* ip, size_t available, size_t len) {
2035
+ inline bool TryFastAppend(const char* ip, size_t available, size_t len,
2036
+ char**) {
1161
2037
  const size_t space_left = output_limit_ - total_written_;
1162
2038
  if (len <= 16 && available >= 16 + kMaximumTagLength && space_left >= 16 &&
1163
2039
  curr_iov_remaining_ >= 16) {
@@ -1172,7 +2048,7 @@ class SnappyIOVecWriter {
1172
2048
  return false;
1173
2049
  }
1174
2050
 
1175
- inline bool AppendFromSelf(size_t offset, size_t len) {
2051
+ inline bool AppendFromSelf(size_t offset, size_t len, char**) {
1176
2052
  // See SnappyArrayWriter::AppendFromSelf for an explanation of
1177
2053
  // the "offset - 1u" trick.
1178
2054
  if (offset - 1u >= total_written_) {
@@ -1228,6 +2104,7 @@ class SnappyIOVecWriter {
1228
2104
  if (to_copy > len) {
1229
2105
  to_copy = len;
1230
2106
  }
2107
+ assert(to_copy > 0);
1231
2108
 
1232
2109
  IncrementalCopy(GetIOVecPointer(from_iov, from_iov_offset),
1233
2110
  curr_iov_output_, curr_iov_output_ + to_copy,
@@ -1270,59 +2147,74 @@ class SnappyArrayWriter {
1270
2147
  char* base_;
1271
2148
  char* op_;
1272
2149
  char* op_limit_;
2150
+ // If op < op_limit_min_slop_ then it's safe to unconditionally write
2151
+ // kSlopBytes starting at op.
2152
+ char* op_limit_min_slop_;
1273
2153
 
1274
2154
  public:
1275
2155
  inline explicit SnappyArrayWriter(char* dst)
1276
2156
  : base_(dst),
1277
2157
  op_(dst),
1278
- op_limit_(dst) {
1279
- }
2158
+ op_limit_(dst),
2159
+ op_limit_min_slop_(dst) {} // Safe default see invariant.
1280
2160
 
1281
2161
  inline void SetExpectedLength(size_t len) {
1282
2162
  op_limit_ = op_ + len;
2163
+ // Prevent pointer from being past the buffer.
2164
+ op_limit_min_slop_ = op_limit_ - std::min<size_t>(kSlopBytes - 1, len);
1283
2165
  }
1284
2166
 
1285
- inline bool CheckLength() const {
1286
- return op_ == op_limit_;
2167
+ inline bool CheckLength() const { return op_ == op_limit_; }
2168
+
2169
+ char* GetOutputPtr() { return op_; }
2170
+ char* GetBase(ptrdiff_t* op_limit_min_slop) {
2171
+ *op_limit_min_slop = op_limit_min_slop_ - base_;
2172
+ return base_;
1287
2173
  }
2174
+ void SetOutputPtr(char* op) { op_ = op; }
1288
2175
 
1289
- inline bool Append(const char* ip, size_t len) {
1290
- char* op = op_;
2176
+ inline bool Append(const char* ip, size_t len, char** op_p) {
2177
+ char* op = *op_p;
1291
2178
  const size_t space_left = op_limit_ - op;
1292
- if (space_left < len) {
1293
- return false;
1294
- }
1295
- memcpy(op, ip, len);
1296
- op_ = op + len;
2179
+ if (space_left < len) return false;
2180
+ std::memcpy(op, ip, len);
2181
+ *op_p = op + len;
1297
2182
  return true;
1298
2183
  }
1299
2184
 
1300
- inline bool TryFastAppend(const char* ip, size_t available, size_t len) {
1301
- char* op = op_;
2185
+ inline bool TryFastAppend(const char* ip, size_t available, size_t len,
2186
+ char** op_p) {
2187
+ char* op = *op_p;
1302
2188
  const size_t space_left = op_limit_ - op;
1303
2189
  if (len <= 16 && available >= 16 + kMaximumTagLength && space_left >= 16) {
1304
2190
  // Fast path, used for the majority (about 95%) of invocations.
1305
2191
  UnalignedCopy128(ip, op);
1306
- op_ = op + len;
2192
+ *op_p = op + len;
1307
2193
  return true;
1308
2194
  } else {
1309
2195
  return false;
1310
2196
  }
1311
2197
  }
1312
2198
 
1313
- inline bool AppendFromSelf(size_t offset, size_t len) {
1314
- char* const op_end = op_ + len;
2199
+ SNAPPY_ATTRIBUTE_ALWAYS_INLINE
2200
+ inline bool AppendFromSelf(size_t offset, size_t len, char** op_p) {
2201
+ assert(len > 0);
2202
+ char* const op = *op_p;
2203
+ assert(op >= base_);
2204
+ char* const op_end = op + len;
1315
2205
 
1316
2206
  // Check if we try to append from before the start of the buffer.
1317
- // Normally this would just be a check for "produced < offset",
1318
- // but "produced <= offset - 1u" is equivalent for every case
1319
- // except the one where offset==0, where the right side will wrap around
1320
- // to a very big number. This is convenient, as offset==0 is another
1321
- // invalid case that we also want to catch, so that we do not go
1322
- // into an infinite loop.
1323
- if (Produced() <= offset - 1u || op_end > op_limit_) return false;
1324
- op_ = IncrementalCopy(op_ - offset, op_, op_end, op_limit_);
2207
+ if (SNAPPY_PREDICT_FALSE(static_cast<size_t>(op - base_) < offset))
2208
+ return false;
1325
2209
 
2210
+ if (SNAPPY_PREDICT_FALSE((kSlopBytes < 64 && len > kSlopBytes) ||
2211
+ op >= op_limit_min_slop_ || offset < len)) {
2212
+ if (op_end > op_limit_ || offset == 0) return false;
2213
+ *op_p = IncrementalCopy(op - offset, op, op_end, op_limit_);
2214
+ return true;
2215
+ }
2216
+ std::memmove(op, op - offset, kSlopBytes);
2217
+ *op_p = op_end;
1326
2218
  return true;
1327
2219
  }
1328
2220
  inline size_t Produced() const {
@@ -1332,8 +2224,9 @@ class SnappyArrayWriter {
1332
2224
  inline void Flush() {}
1333
2225
  };
1334
2226
 
1335
- bool RawUncompress(const char* compressed, size_t n, char* uncompressed) {
1336
- ByteArraySource reader(compressed, n);
2227
+ bool RawUncompress(const char* compressed, size_t compressed_length,
2228
+ char* uncompressed) {
2229
+ ByteArraySource reader(compressed, compressed_length);
1337
2230
  return RawUncompress(&reader, uncompressed);
1338
2231
  }
1339
2232
 
@@ -1342,9 +2235,10 @@ bool RawUncompress(Source* compressed, char* uncompressed) {
1342
2235
  return InternalUncompress(compressed, &output);
1343
2236
  }
1344
2237
 
1345
- bool Uncompress(const char* compressed, size_t n, std::string* uncompressed) {
2238
+ bool Uncompress(const char* compressed, size_t compressed_length,
2239
+ std::string* uncompressed) {
1346
2240
  size_t ulength;
1347
- if (!GetUncompressedLength(compressed, n, &ulength)) {
2241
+ if (!GetUncompressedLength(compressed, compressed_length, &ulength)) {
1348
2242
  return false;
1349
2243
  }
1350
2244
  // On 32-bit builds: max_size() < kuint32max. Check for that instead
@@ -1353,7 +2247,8 @@ bool Uncompress(const char* compressed, size_t n, std::string* uncompressed) {
1353
2247
  return false;
1354
2248
  }
1355
2249
  STLStringResizeUninitialized(uncompressed, ulength);
1356
- return RawUncompress(compressed, n, string_as_array(uncompressed));
2250
+ return RawUncompress(compressed, compressed_length,
2251
+ string_as_array(uncompressed));
1357
2252
  }
1358
2253
 
1359
2254
  // A Writer that drops everything on the floor and just does validation
@@ -1363,32 +2258,44 @@ class SnappyDecompressionValidator {
1363
2258
  size_t produced_;
1364
2259
 
1365
2260
  public:
1366
- inline SnappyDecompressionValidator() : expected_(0), produced_(0) { }
1367
- inline void SetExpectedLength(size_t len) {
1368
- expected_ = len;
2261
+ inline SnappyDecompressionValidator() : expected_(0), produced_(0) {}
2262
+ inline void SetExpectedLength(size_t len) { expected_ = len; }
2263
+ size_t GetOutputPtr() { return produced_; }
2264
+ size_t GetBase(ptrdiff_t* op_limit_min_slop) {
2265
+ *op_limit_min_slop = std::numeric_limits<ptrdiff_t>::max() - kSlopBytes + 1;
2266
+ return 1;
1369
2267
  }
1370
- inline bool CheckLength() const {
1371
- return expected_ == produced_;
2268
+ void SetOutputPtr(size_t op) { produced_ = op; }
2269
+ inline bool CheckLength() const { return expected_ == produced_; }
2270
+ inline bool Append(const char* ip, size_t len, size_t* produced) {
2271
+ // TODO: Switch to [[maybe_unused]] when we can assume C++17.
2272
+ (void)ip;
2273
+
2274
+ *produced += len;
2275
+ return *produced <= expected_;
1372
2276
  }
1373
- inline bool Append(const char* ip, size_t len) {
1374
- produced_ += len;
1375
- return produced_ <= expected_;
1376
- }
1377
- inline bool TryFastAppend(const char* ip, size_t available, size_t length) {
2277
+ inline bool TryFastAppend(const char* ip, size_t available, size_t length,
2278
+ size_t* produced) {
2279
+ // TODO: Switch to [[maybe_unused]] when we can assume C++17.
2280
+ (void)ip;
2281
+ (void)available;
2282
+ (void)length;
2283
+ (void)produced;
2284
+
1378
2285
  return false;
1379
2286
  }
1380
- inline bool AppendFromSelf(size_t offset, size_t len) {
2287
+ inline bool AppendFromSelf(size_t offset, size_t len, size_t* produced) {
1381
2288
  // See SnappyArrayWriter::AppendFromSelf for an explanation of
1382
2289
  // the "offset - 1u" trick.
1383
- if (produced_ <= offset - 1u) return false;
1384
- produced_ += len;
1385
- return produced_ <= expected_;
2290
+ if (*produced <= offset - 1u) return false;
2291
+ *produced += len;
2292
+ return *produced <= expected_;
1386
2293
  }
1387
2294
  inline void Flush() {}
1388
2295
  };
1389
2296
 
1390
- bool IsValidCompressedBuffer(const char* compressed, size_t n) {
1391
- ByteArraySource reader(compressed, n);
2297
+ bool IsValidCompressedBuffer(const char* compressed, size_t compressed_length) {
2298
+ ByteArraySource reader(compressed, compressed_length);
1392
2299
  SnappyDecompressionValidator writer;
1393
2300
  return InternalUncompress(&reader, &writer);
1394
2301
  }
@@ -1398,27 +2305,77 @@ bool IsValidCompressed(Source* compressed) {
1398
2305
  return InternalUncompress(compressed, &writer);
1399
2306
  }
1400
2307
 
1401
- void RawCompress(const char* input,
1402
- size_t input_length,
1403
- char* compressed,
2308
+ void RawCompress(const char* input, size_t input_length, char* compressed,
1404
2309
  size_t* compressed_length) {
2310
+ RawCompress(input, input_length, compressed, compressed_length,
2311
+ CompressionOptions{});
2312
+ }
2313
+
2314
+ void RawCompress(const char* input, size_t input_length, char* compressed,
2315
+ size_t* compressed_length, CompressionOptions options) {
1405
2316
  ByteArraySource reader(input, input_length);
1406
2317
  UncheckedByteArraySink writer(compressed);
1407
- Compress(&reader, &writer);
2318
+ Compress(&reader, &writer, options);
1408
2319
 
1409
2320
  // Compute how many bytes were added
1410
2321
  *compressed_length = (writer.CurrentDestination() - compressed);
1411
2322
  }
1412
2323
 
2324
+ void RawCompressFromIOVec(const struct iovec* iov, size_t uncompressed_length,
2325
+ char* compressed, size_t* compressed_length) {
2326
+ RawCompressFromIOVec(iov, uncompressed_length, compressed, compressed_length,
2327
+ CompressionOptions{});
2328
+ }
2329
+
2330
+ void RawCompressFromIOVec(const struct iovec* iov, size_t uncompressed_length,
2331
+ char* compressed, size_t* compressed_length,
2332
+ CompressionOptions options) {
2333
+ SnappyIOVecReader reader(iov, uncompressed_length);
2334
+ UncheckedByteArraySink writer(compressed);
2335
+ Compress(&reader, &writer, options);
2336
+
2337
+ // Compute how many bytes were added.
2338
+ *compressed_length = writer.CurrentDestination() - compressed;
2339
+ }
2340
+
1413
2341
  size_t Compress(const char* input, size_t input_length,
1414
2342
  std::string* compressed) {
2343
+ return Compress(input, input_length, compressed, CompressionOptions{});
2344
+ }
2345
+
2346
+ size_t Compress(const char* input, size_t input_length, std::string* compressed,
2347
+ CompressionOptions options) {
1415
2348
  // Pre-grow the buffer to the max length of the compressed output
1416
2349
  STLStringResizeUninitialized(compressed, MaxCompressedLength(input_length));
1417
2350
 
1418
2351
  size_t compressed_length;
1419
2352
  RawCompress(input, input_length, string_as_array(compressed),
1420
- &compressed_length);
1421
- compressed->resize(compressed_length);
2353
+ &compressed_length, options);
2354
+ compressed->erase(compressed_length);
2355
+ return compressed_length;
2356
+ }
2357
+
2358
+ size_t CompressFromIOVec(const struct iovec* iov, size_t iov_cnt,
2359
+ std::string* compressed) {
2360
+ return CompressFromIOVec(iov, iov_cnt, compressed, CompressionOptions{});
2361
+ }
2362
+
2363
+ size_t CompressFromIOVec(const struct iovec* iov, size_t iov_cnt,
2364
+ std::string* compressed, CompressionOptions options) {
2365
+ // Compute the number of bytes to be compressed.
2366
+ size_t uncompressed_length = 0;
2367
+ for (size_t i = 0; i < iov_cnt; ++i) {
2368
+ uncompressed_length += iov[i].iov_len;
2369
+ }
2370
+
2371
+ // Pre-grow the buffer to the max length of the compressed output.
2372
+ STLStringResizeUninitialized(compressed, MaxCompressedLength(
2373
+ uncompressed_length));
2374
+
2375
+ size_t compressed_length;
2376
+ RawCompressFromIOVec(iov, uncompressed_length, string_as_array(compressed),
2377
+ &compressed_length, options);
2378
+ compressed->erase(compressed_length);
1422
2379
  return compressed_length;
1423
2380
  }
1424
2381
 
@@ -1443,13 +2400,14 @@ class SnappyScatteredWriter {
1443
2400
  size_t full_size_;
1444
2401
 
1445
2402
  // Pointer into current output block
1446
- char* op_base_; // Base of output block
1447
- char* op_ptr_; // Pointer to next unfilled byte in block
1448
- char* op_limit_; // Pointer just past block
2403
+ char* op_base_; // Base of output block
2404
+ char* op_ptr_; // Pointer to next unfilled byte in block
2405
+ char* op_limit_; // Pointer just past block
2406
+ // If op < op_limit_min_slop_ then it's safe to unconditionally write
2407
+ // kSlopBytes starting at op.
2408
+ char* op_limit_min_slop_;
1449
2409
 
1450
- inline size_t Size() const {
1451
- return full_size_ + (op_ptr_ - op_base_);
1452
- }
2410
+ inline size_t Size() const { return full_size_ + (op_ptr_ - op_base_); }
1453
2411
 
1454
2412
  bool SlowAppend(const char* ip, size_t len);
1455
2413
  bool SlowAppendFromSelf(size_t offset, size_t len);
@@ -1460,60 +2418,79 @@ class SnappyScatteredWriter {
1460
2418
  full_size_(0),
1461
2419
  op_base_(NULL),
1462
2420
  op_ptr_(NULL),
1463
- op_limit_(NULL) {
2421
+ op_limit_(NULL),
2422
+ op_limit_min_slop_(NULL) {}
2423
+ char* GetOutputPtr() { return op_ptr_; }
2424
+ char* GetBase(ptrdiff_t* op_limit_min_slop) {
2425
+ *op_limit_min_slop = op_limit_min_slop_ - op_base_;
2426
+ return op_base_;
1464
2427
  }
2428
+ void SetOutputPtr(char* op) { op_ptr_ = op; }
1465
2429
 
1466
2430
  inline void SetExpectedLength(size_t len) {
1467
2431
  assert(blocks_.empty());
1468
2432
  expected_ = len;
1469
2433
  }
1470
2434
 
1471
- inline bool CheckLength() const {
1472
- return Size() == expected_;
1473
- }
2435
+ inline bool CheckLength() const { return Size() == expected_; }
1474
2436
 
1475
2437
  // Return the number of bytes actually uncompressed so far
1476
- inline size_t Produced() const {
1477
- return Size();
1478
- }
2438
+ inline size_t Produced() const { return Size(); }
1479
2439
 
1480
- inline bool Append(const char* ip, size_t len) {
1481
- size_t avail = op_limit_ - op_ptr_;
2440
+ inline bool Append(const char* ip, size_t len, char** op_p) {
2441
+ char* op = *op_p;
2442
+ size_t avail = op_limit_ - op;
1482
2443
  if (len <= avail) {
1483
2444
  // Fast path
1484
- memcpy(op_ptr_, ip, len);
1485
- op_ptr_ += len;
2445
+ std::memcpy(op, ip, len);
2446
+ *op_p = op + len;
1486
2447
  return true;
1487
2448
  } else {
1488
- return SlowAppend(ip, len);
2449
+ op_ptr_ = op;
2450
+ bool res = SlowAppend(ip, len);
2451
+ *op_p = op_ptr_;
2452
+ return res;
1489
2453
  }
1490
2454
  }
1491
2455
 
1492
- inline bool TryFastAppend(const char* ip, size_t available, size_t length) {
1493
- char* op = op_ptr_;
2456
+ inline bool TryFastAppend(const char* ip, size_t available, size_t length,
2457
+ char** op_p) {
2458
+ char* op = *op_p;
1494
2459
  const int space_left = op_limit_ - op;
1495
2460
  if (length <= 16 && available >= 16 + kMaximumTagLength &&
1496
2461
  space_left >= 16) {
1497
2462
  // Fast path, used for the majority (about 95%) of invocations.
1498
2463
  UnalignedCopy128(ip, op);
1499
- op_ptr_ = op + length;
2464
+ *op_p = op + length;
1500
2465
  return true;
1501
2466
  } else {
1502
2467
  return false;
1503
2468
  }
1504
2469
  }
1505
2470
 
1506
- inline bool AppendFromSelf(size_t offset, size_t len) {
1507
- char* const op_end = op_ptr_ + len;
1508
- // See SnappyArrayWriter::AppendFromSelf for an explanation of
1509
- // the "offset - 1u" trick.
1510
- if (SNAPPY_PREDICT_TRUE(offset - 1u < op_ptr_ - op_base_ &&
1511
- op_end <= op_limit_)) {
1512
- // Fast path: src and dst in current block.
1513
- op_ptr_ = IncrementalCopy(op_ptr_ - offset, op_ptr_, op_end, op_limit_);
2471
+ inline bool AppendFromSelf(size_t offset, size_t len, char** op_p) {
2472
+ char* op = *op_p;
2473
+ assert(op >= op_base_);
2474
+ // Check if we try to append from before the start of the buffer.
2475
+ if (SNAPPY_PREDICT_FALSE((kSlopBytes < 64 && len > kSlopBytes) ||
2476
+ static_cast<size_t>(op - op_base_) < offset ||
2477
+ op >= op_limit_min_slop_ || offset < len)) {
2478
+ if (offset == 0) return false;
2479
+ if (SNAPPY_PREDICT_FALSE(static_cast<size_t>(op - op_base_) < offset ||
2480
+ op + len > op_limit_)) {
2481
+ op_ptr_ = op;
2482
+ bool res = SlowAppendFromSelf(offset, len);
2483
+ *op_p = op_ptr_;
2484
+ return res;
2485
+ }
2486
+ *op_p = IncrementalCopy(op - offset, op, op + len, op_limit_);
1514
2487
  return true;
1515
2488
  }
1516
- return SlowAppendFromSelf(offset, len);
2489
+ // Fast path
2490
+ char* const op_end = op + len;
2491
+ std::memmove(op, op - offset, kSlopBytes);
2492
+ *op_p = op_end;
2493
+ return true;
1517
2494
  }
1518
2495
 
1519
2496
  // Called at the end of the decompress. We ask the allocator
@@ -1521,12 +2498,12 @@ class SnappyScatteredWriter {
1521
2498
  inline void Flush() { allocator_.Flush(Produced()); }
1522
2499
  };
1523
2500
 
1524
- template<typename Allocator>
2501
+ template <typename Allocator>
1525
2502
  bool SnappyScatteredWriter<Allocator>::SlowAppend(const char* ip, size_t len) {
1526
2503
  size_t avail = op_limit_ - op_ptr_;
1527
2504
  while (len > avail) {
1528
2505
  // Completely fill this block
1529
- memcpy(op_ptr_, ip, avail);
2506
+ std::memcpy(op_ptr_, ip, avail);
1530
2507
  op_ptr_ += avail;
1531
2508
  assert(op_limit_ - op_ptr_ == 0);
1532
2509
  full_size_ += (op_ptr_ - op_base_);
@@ -1534,25 +2511,25 @@ bool SnappyScatteredWriter<Allocator>::SlowAppend(const char* ip, size_t len) {
1534
2511
  ip += avail;
1535
2512
 
1536
2513
  // Bounds check
1537
- if (full_size_ + len > expected_) {
1538
- return false;
1539
- }
2514
+ if (full_size_ + len > expected_) return false;
1540
2515
 
1541
2516
  // Make new block
1542
2517
  size_t bsize = std::min<size_t>(kBlockSize, expected_ - full_size_);
1543
2518
  op_base_ = allocator_.Allocate(bsize);
1544
2519
  op_ptr_ = op_base_;
1545
2520
  op_limit_ = op_base_ + bsize;
2521
+ op_limit_min_slop_ = op_limit_ - std::min<size_t>(kSlopBytes - 1, bsize);
2522
+
1546
2523
  blocks_.push_back(op_base_);
1547
2524
  avail = bsize;
1548
2525
  }
1549
2526
 
1550
- memcpy(op_ptr_, ip, len);
2527
+ std::memcpy(op_ptr_, ip, len);
1551
2528
  op_ptr_ += len;
1552
2529
  return true;
1553
2530
  }
1554
2531
 
1555
- template<typename Allocator>
2532
+ template <typename Allocator>
1556
2533
  bool SnappyScatteredWriter<Allocator>::SlowAppendFromSelf(size_t offset,
1557
2534
  size_t len) {
1558
2535
  // Overflow check
@@ -1567,19 +2544,26 @@ bool SnappyScatteredWriter<Allocator>::SlowAppendFromSelf(size_t offset,
1567
2544
  // nice if we do not rely on that, since we can get better compression if we
1568
2545
  // allow cross-block copies and thus might want to change the compressor in
1569
2546
  // the future.
2547
+ // TODO Replace this with a properly optimized path. This is not
2548
+ // triggered right now. But this is so super slow, that it would regress
2549
+ // performance unacceptably if triggered.
1570
2550
  size_t src = cur - offset;
2551
+ char* op = op_ptr_;
1571
2552
  while (len-- > 0) {
1572
- char c = blocks_[src >> kBlockLog][src & (kBlockSize-1)];
1573
- Append(&c, 1);
2553
+ char c = blocks_[src >> kBlockLog][src & (kBlockSize - 1)];
2554
+ if (!Append(&c, 1, &op)) {
2555
+ op_ptr_ = op;
2556
+ return false;
2557
+ }
1574
2558
  src++;
1575
2559
  }
2560
+ op_ptr_ = op;
1576
2561
  return true;
1577
2562
  }
1578
2563
 
1579
2564
  class SnappySinkAllocator {
1580
2565
  public:
1581
- explicit SnappySinkAllocator(Sink* dest): dest_(dest) {}
1582
- ~SnappySinkAllocator() {}
2566
+ explicit SnappySinkAllocator(Sink* dest) : dest_(dest) {}
1583
2567
 
1584
2568
  char* Allocate(int size) {
1585
2569
  Datablock block(new char[size], size);
@@ -1594,10 +2578,9 @@ class SnappySinkAllocator {
1594
2578
  // to the blocks.
1595
2579
  void Flush(size_t size) {
1596
2580
  size_t size_written = 0;
1597
- size_t block_size;
1598
- for (int i = 0; i < blocks_.size(); ++i) {
1599
- block_size = std::min<size_t>(blocks_[i].size, size - size_written);
1600
- dest_->AppendAndTakeOwnership(blocks_[i].data, block_size,
2581
+ for (Datablock& block : blocks_) {
2582
+ size_t block_size = std::min<size_t>(block.size, size - size_written);
2583
+ dest_->AppendAndTakeOwnership(block.data, block_size,
1601
2584
  &SnappySinkAllocator::Deleter, NULL);
1602
2585
  size_written += block_size;
1603
2586
  }
@@ -1612,6 +2595,10 @@ class SnappySinkAllocator {
1612
2595
  };
1613
2596
 
1614
2597
  static void Deleter(void* arg, const char* bytes, size_t size) {
2598
+ // TODO: Switch to [[maybe_unused]] when we can assume C++17.
2599
+ (void)arg;
2600
+ (void)size;
2601
+
1615
2602
  delete[] bytes;
1616
2603
  }
1617
2604
 
@@ -1631,15 +2618,15 @@ size_t UncompressAsMuchAsPossible(Source* compressed, Sink* uncompressed) {
1631
2618
  bool Uncompress(Source* compressed, Sink* uncompressed) {
1632
2619
  // Read the uncompressed length from the front of the compressed input
1633
2620
  SnappyDecompressor decompressor(compressed);
1634
- uint32 uncompressed_len = 0;
2621
+ uint32_t uncompressed_len = 0;
1635
2622
  if (!decompressor.ReadUncompressedLength(&uncompressed_len)) {
1636
2623
  return false;
1637
2624
  }
1638
2625
 
1639
2626
  char c;
1640
2627
  size_t allocated_size;
1641
- char* buf = uncompressed->GetAppendBufferVariable(
1642
- 1, uncompressed_len, &c, 1, &allocated_size);
2628
+ char* buf = uncompressed->GetAppendBufferVariable(1, uncompressed_len, &c, 1,
2629
+ &allocated_size);
1643
2630
 
1644
2631
  const size_t compressed_len = compressed->Available();
1645
2632
  // If we can get a flat buffer, then use it, otherwise do block by block