1 // SPDX-License-Identifier: GPL-2.0
10 #include <linux/zlib.h>
11 #include <linux/zstd.h>
25 static struct bbuf __bounce_alloc(struct bch_fs *c, unsigned size, int rw)
29 BUG_ON(size > c->opts.encoded_extent_max);
31 b = kmalloc(size, GFP_NOFS|__GFP_NOWARN);
33 return (struct bbuf) { .b = b, .type = BB_KMALLOC, .rw = rw };
35 b = mempool_alloc(&c->compression_bounce[rw], GFP_NOFS);
37 return (struct bbuf) { .b = b, .type = BB_MEMPOOL, .rw = rw };
42 static bool bio_phys_contig(struct bio *bio, struct bvec_iter start)
45 struct bvec_iter iter;
46 void *expected_start = NULL;
48 __bio_for_each_bvec(bv, bio, iter, start) {
50 expected_start != page_address(bv.bv_page) + bv.bv_offset)
53 expected_start = page_address(bv.bv_page) +
54 bv.bv_offset + bv.bv_len;
60 static struct bbuf __bio_map_or_bounce(struct bch_fs *c, struct bio *bio,
61 struct bvec_iter start, int rw)
65 struct bvec_iter iter;
66 unsigned nr_pages = 0;
67 struct page *stack_pages[16];
68 struct page **pages = NULL;
71 BUG_ON(start.bi_size > c->opts.encoded_extent_max);
73 if (!PageHighMem(bio_iter_page(bio, start)) &&
74 bio_phys_contig(bio, start))
75 return (struct bbuf) {
76 .b = page_address(bio_iter_page(bio, start)) +
77 bio_iter_offset(bio, start),
78 .type = BB_NONE, .rw = rw
81 /* check if we can map the pages contiguously: */
82 __bio_for_each_segment(bv, bio, iter, start) {
83 if (iter.bi_size != start.bi_size &&
87 if (bv.bv_len < iter.bi_size &&
88 bv.bv_offset + bv.bv_len < PAGE_SIZE)
94 BUG_ON(DIV_ROUND_UP(start.bi_size, PAGE_SIZE) > nr_pages);
96 pages = nr_pages > ARRAY_SIZE(stack_pages)
97 ? kmalloc_array(nr_pages, sizeof(struct page *), GFP_NOFS)
103 __bio_for_each_segment(bv, bio, iter, start)
104 pages[nr_pages++] = bv.bv_page;
106 data = vmap(pages, nr_pages, VM_MAP, PAGE_KERNEL);
107 if (pages != stack_pages)
111 return (struct bbuf) {
112 .b = data + bio_iter_offset(bio, start),
113 .type = BB_VMAP, .rw = rw
116 ret = __bounce_alloc(c, start.bi_size, rw);
119 memcpy_from_bio(ret.b, bio, start);
124 static struct bbuf bio_map_or_bounce(struct bch_fs *c, struct bio *bio, int rw)
126 return __bio_map_or_bounce(c, bio, bio->bi_iter, rw);
129 static void bio_unmap_or_unbounce(struct bch_fs *c, struct bbuf buf)
135 vunmap((void *) ((unsigned long) buf.b & PAGE_MASK));
141 mempool_free(buf.b, &c->compression_bounce[buf.rw]);
146 static inline void zlib_set_workspace(z_stream *strm, void *workspace)
149 strm->workspace = workspace;
153 static int __bio_uncompress(struct bch_fs *c, struct bio *src,
154 void *dst_data, struct bch_extent_crc_unpacked crc)
156 struct bbuf src_data = { NULL };
157 size_t src_len = src->bi_iter.bi_size;
158 size_t dst_len = crc.uncompressed_size << 9;
162 src_data = bio_map_or_bounce(c, src, READ);
164 switch (crc.compression_type) {
165 case BCH_COMPRESSION_TYPE_lz4_old:
166 case BCH_COMPRESSION_TYPE_lz4:
167 ret = LZ4_decompress_safe_partial(src_data.b, dst_data,
168 src_len, dst_len, dst_len);
172 case BCH_COMPRESSION_TYPE_gzip: {
174 .next_in = src_data.b,
176 .next_out = dst_data,
177 .avail_out = dst_len,
180 workspace = mempool_alloc(&c->decompress_workspace, GFP_NOFS);
182 zlib_set_workspace(&strm, workspace);
183 zlib_inflateInit2(&strm, -MAX_WBITS);
184 ret = zlib_inflate(&strm, Z_FINISH);
186 mempool_free(workspace, &c->decompress_workspace);
188 if (ret != Z_STREAM_END)
192 case BCH_COMPRESSION_TYPE_zstd: {
194 size_t real_src_len = le32_to_cpup(src_data.b);
196 if (real_src_len > src_len - 4)
199 workspace = mempool_alloc(&c->decompress_workspace, GFP_NOFS);
200 ctx = zstd_init_dctx(workspace, zstd_dctx_workspace_bound());
202 ret = zstd_decompress_dctx(ctx,
204 src_data.b + 4, real_src_len);
206 mempool_free(workspace, &c->decompress_workspace);
217 bio_unmap_or_unbounce(c, src_data);
224 int bch2_bio_uncompress_inplace(struct bch_fs *c, struct bio *bio,
225 struct bch_extent_crc_unpacked *crc)
227 struct bbuf data = { NULL };
228 size_t dst_len = crc->uncompressed_size << 9;
230 /* bio must own its pages: */
231 BUG_ON(!bio->bi_vcnt);
232 BUG_ON(DIV_ROUND_UP(crc->live_size, PAGE_SECTORS) > bio->bi_max_vecs);
234 if (crc->uncompressed_size << 9 > c->opts.encoded_extent_max ||
235 crc->compressed_size << 9 > c->opts.encoded_extent_max) {
236 bch_err(c, "error rewriting existing data: extent too big");
240 data = __bounce_alloc(c, dst_len, WRITE);
242 if (__bio_uncompress(c, bio, data.b, *crc)) {
243 bch_err(c, "error rewriting existing data: decompression error");
244 bio_unmap_or_unbounce(c, data);
249 * XXX: don't have a good way to assert that the bio was allocated with
250 * enough space, we depend on bch2_move_extent doing the right thing
252 bio->bi_iter.bi_size = crc->live_size << 9;
254 memcpy_to_bio(bio, bio->bi_iter, data.b + (crc->offset << 9));
257 crc->compression_type = 0;
258 crc->compressed_size = crc->live_size;
259 crc->uncompressed_size = crc->live_size;
261 crc->csum = (struct bch_csum) { 0, 0 };
263 bio_unmap_or_unbounce(c, data);
267 int bch2_bio_uncompress(struct bch_fs *c, struct bio *src,
268 struct bio *dst, struct bvec_iter dst_iter,
269 struct bch_extent_crc_unpacked crc)
271 struct bbuf dst_data = { NULL };
272 size_t dst_len = crc.uncompressed_size << 9;
275 if (crc.uncompressed_size << 9 > c->opts.encoded_extent_max ||
276 crc.compressed_size << 9 > c->opts.encoded_extent_max)
279 dst_data = dst_len == dst_iter.bi_size
280 ? __bio_map_or_bounce(c, dst, dst_iter, WRITE)
281 : __bounce_alloc(c, dst_len, WRITE);
283 ret = __bio_uncompress(c, src, dst_data.b, crc);
287 if (dst_data.type != BB_NONE &&
288 dst_data.type != BB_VMAP)
289 memcpy_to_bio(dst, dst_iter, dst_data.b + (crc.offset << 9));
291 bio_unmap_or_unbounce(c, dst_data);
295 static int attempt_compress(struct bch_fs *c,
297 void *dst, size_t dst_len,
298 void *src, size_t src_len,
299 struct bch_compression_opt compression)
301 enum bch_compression_type compression_type =
302 __bch2_compression_opt_to_type[compression.type];
304 switch (compression_type) {
305 case BCH_COMPRESSION_TYPE_lz4:
306 if (compression.level < LZ4HC_MIN_CLEVEL) {
308 int ret = LZ4_compress_destSize(
317 int ret = LZ4_compress_HC(
325 case BCH_COMPRESSION_TYPE_gzip: {
330 .avail_out = dst_len,
333 zlib_set_workspace(&strm, workspace);
334 zlib_deflateInit2(&strm,
336 ? clamp_t(unsigned, compression.level,
337 Z_BEST_SPEED, Z_BEST_COMPRESSION)
338 : Z_DEFAULT_COMPRESSION,
339 Z_DEFLATED, -MAX_WBITS, DEF_MEM_LEVEL,
342 if (zlib_deflate(&strm, Z_FINISH) != Z_STREAM_END)
345 if (zlib_deflateEnd(&strm) != Z_OK)
348 return strm.total_out;
350 case BCH_COMPRESSION_TYPE_zstd: {
353 * zstd max compression level is 22, our max level is 15
355 unsigned level = min((compression.level * 3) / 2, zstd_max_clevel());
356 ZSTD_parameters params = zstd_get_params(level, c->opts.encoded_extent_max);
357 ZSTD_CCtx *ctx = zstd_init_cctx(workspace,
358 zstd_cctx_workspace_bound(¶ms.cParams));
361 * ZSTD requires that when we decompress we pass in the exact
362 * compressed size - rounding it up to the nearest sector
363 * doesn't work, so we use the first 4 bytes of the buffer for
366 * Additionally, the ZSTD code seems to have a bug where it will
367 * write just past the end of the buffer - so subtract a fudge
368 * factor (7 bytes) from the dst buffer size to account for
371 size_t len = zstd_compress_cctx(ctx,
372 dst + 4, dst_len - 4 - 7,
375 if (zstd_is_error(len))
378 *((__le32 *) dst) = cpu_to_le32(len);
386 static unsigned __bio_compress(struct bch_fs *c,
387 struct bio *dst, size_t *dst_len,
388 struct bio *src, size_t *src_len,
389 struct bch_compression_opt compression)
391 struct bbuf src_data = { NULL }, dst_data = { NULL };
393 enum bch_compression_type compression_type =
394 __bch2_compression_opt_to_type[compression.type];
398 BUG_ON(compression_type >= BCH_COMPRESSION_TYPE_NR);
399 BUG_ON(!mempool_initialized(&c->compress_workspace[compression_type]));
401 /* If it's only one block, don't bother trying to compress: */
402 if (src->bi_iter.bi_size <= c->opts.block_size)
403 return BCH_COMPRESSION_TYPE_incompressible;
405 dst_data = bio_map_or_bounce(c, dst, WRITE);
406 src_data = bio_map_or_bounce(c, src, READ);
408 workspace = mempool_alloc(&c->compress_workspace[compression_type], GFP_NOFS);
410 *src_len = src->bi_iter.bi_size;
411 *dst_len = dst->bi_iter.bi_size;
414 * XXX: this algorithm sucks when the compression code doesn't tell us
415 * how much would fit, like LZ4 does:
418 if (*src_len <= block_bytes(c)) {
423 ret = attempt_compress(c, workspace,
424 dst_data.b, *dst_len,
425 src_data.b, *src_len,
433 /* Didn't fit: should we retry with a smaller amount? */
434 if (*src_len <= *dst_len) {
440 * If ret is negative, it's a hint as to how much data would fit
442 BUG_ON(-ret >= *src_len);
447 *src_len -= (*src_len - *dst_len) / 2;
448 *src_len = round_down(*src_len, block_bytes(c));
451 mempool_free(workspace, &c->compress_workspace[compression_type]);
456 /* Didn't get smaller: */
457 if (round_up(*dst_len, block_bytes(c)) >= *src_len)
460 pad = round_up(*dst_len, block_bytes(c)) - *dst_len;
462 memset(dst_data.b + *dst_len, 0, pad);
465 if (dst_data.type != BB_NONE &&
466 dst_data.type != BB_VMAP)
467 memcpy_to_bio(dst, dst->bi_iter, dst_data.b);
469 BUG_ON(!*dst_len || *dst_len > dst->bi_iter.bi_size);
470 BUG_ON(!*src_len || *src_len > src->bi_iter.bi_size);
471 BUG_ON(*dst_len & (block_bytes(c) - 1));
472 BUG_ON(*src_len & (block_bytes(c) - 1));
473 ret = compression_type;
475 bio_unmap_or_unbounce(c, src_data);
476 bio_unmap_or_unbounce(c, dst_data);
479 ret = BCH_COMPRESSION_TYPE_incompressible;
483 unsigned bch2_bio_compress(struct bch_fs *c,
484 struct bio *dst, size_t *dst_len,
485 struct bio *src, size_t *src_len,
486 unsigned compression_opt)
488 unsigned orig_dst = dst->bi_iter.bi_size;
489 unsigned orig_src = src->bi_iter.bi_size;
490 unsigned compression_type;
492 /* Don't consume more than BCH_ENCODED_EXTENT_MAX from @src: */
493 src->bi_iter.bi_size = min_t(unsigned, src->bi_iter.bi_size,
494 c->opts.encoded_extent_max);
495 /* Don't generate a bigger output than input: */
496 dst->bi_iter.bi_size = min(dst->bi_iter.bi_size, src->bi_iter.bi_size);
499 __bio_compress(c, dst, dst_len, src, src_len,
500 bch2_compression_decode(compression_opt));
502 dst->bi_iter.bi_size = orig_dst;
503 src->bi_iter.bi_size = orig_src;
504 return compression_type;
507 static int __bch2_fs_compress_init(struct bch_fs *, u64);
509 #define BCH_FEATURE_none 0
511 static const unsigned bch2_compression_opt_to_feature[] = {
512 #define x(t, n) [BCH_COMPRESSION_OPT_##t] = BCH_FEATURE_##t,
513 BCH_COMPRESSION_OPTS()
517 #undef BCH_FEATURE_none
519 static int __bch2_check_set_has_compressed_data(struct bch_fs *c, u64 f)
523 if ((c->sb.features & f) == f)
526 mutex_lock(&c->sb_lock);
528 if ((c->sb.features & f) == f) {
529 mutex_unlock(&c->sb_lock);
533 ret = __bch2_fs_compress_init(c, c->sb.features|f);
535 mutex_unlock(&c->sb_lock);
539 c->disk_sb.sb->features[0] |= cpu_to_le64(f);
541 mutex_unlock(&c->sb_lock);
546 int bch2_check_set_has_compressed_data(struct bch_fs *c,
547 unsigned compression_opt)
549 unsigned compression_type = bch2_compression_decode(compression_opt).type;
551 BUG_ON(compression_type >= ARRAY_SIZE(bch2_compression_opt_to_feature));
553 return compression_type
554 ? __bch2_check_set_has_compressed_data(c,
555 1ULL << bch2_compression_opt_to_feature[compression_type])
559 void bch2_fs_compress_exit(struct bch_fs *c)
563 mempool_exit(&c->decompress_workspace);
564 for (i = 0; i < ARRAY_SIZE(c->compress_workspace); i++)
565 mempool_exit(&c->compress_workspace[i]);
566 mempool_exit(&c->compression_bounce[WRITE]);
567 mempool_exit(&c->compression_bounce[READ]);
570 static int __bch2_fs_compress_init(struct bch_fs *c, u64 features)
572 size_t decompress_workspace_size = 0;
573 bool decompress_workspace_needed;
574 ZSTD_parameters params = zstd_get_params(zstd_max_clevel(),
575 c->opts.encoded_extent_max);
578 enum bch_compression_type type;
579 size_t compress_workspace;
580 size_t decompress_workspace;
581 } compression_types[] = {
582 { BCH_FEATURE_lz4, BCH_COMPRESSION_TYPE_lz4,
583 max_t(size_t, LZ4_MEM_COMPRESS, LZ4HC_MEM_COMPRESS) },
584 { BCH_FEATURE_gzip, BCH_COMPRESSION_TYPE_gzip,
585 zlib_deflate_workspacesize(MAX_WBITS, DEF_MEM_LEVEL),
586 zlib_inflate_workspacesize(), },
587 { BCH_FEATURE_zstd, BCH_COMPRESSION_TYPE_zstd,
588 zstd_cctx_workspace_bound(¶ms.cParams),
589 zstd_dctx_workspace_bound() },
591 bool have_compressed = false;
593 c->zstd_params = params;
595 for (i = compression_types;
596 i < compression_types + ARRAY_SIZE(compression_types);
598 have_compressed |= (features & (1 << i->feature)) != 0;
600 if (!have_compressed)
603 if (!mempool_initialized(&c->compression_bounce[READ]) &&
604 mempool_init_kvpmalloc_pool(&c->compression_bounce[READ],
605 1, c->opts.encoded_extent_max))
606 return -BCH_ERR_ENOMEM_compression_bounce_read_init;
608 if (!mempool_initialized(&c->compression_bounce[WRITE]) &&
609 mempool_init_kvpmalloc_pool(&c->compression_bounce[WRITE],
610 1, c->opts.encoded_extent_max))
611 return -BCH_ERR_ENOMEM_compression_bounce_write_init;
613 for (i = compression_types;
614 i < compression_types + ARRAY_SIZE(compression_types);
616 decompress_workspace_size =
617 max(decompress_workspace_size, i->decompress_workspace);
619 if (!(features & (1 << i->feature)))
622 if (i->decompress_workspace)
623 decompress_workspace_needed = true;
625 if (mempool_initialized(&c->compress_workspace[i->type]))
628 if (mempool_init_kvpmalloc_pool(
629 &c->compress_workspace[i->type],
630 1, i->compress_workspace))
631 return -BCH_ERR_ENOMEM_compression_workspace_init;
634 if (!mempool_initialized(&c->decompress_workspace) &&
635 mempool_init_kvpmalloc_pool(&c->decompress_workspace,
636 1, decompress_workspace_size))
637 return -BCH_ERR_ENOMEM_decompression_workspace_init;
642 static u64 compression_opt_to_feature(unsigned v)
644 unsigned type = bch2_compression_decode(v).type;
645 return 1ULL << bch2_compression_opt_to_feature[type];
648 int bch2_fs_compress_init(struct bch_fs *c)
650 u64 f = c->sb.features;
652 f |= compression_opt_to_feature(c->opts.compression);
653 f |= compression_opt_to_feature(c->opts.background_compression);
655 return __bch2_fs_compress_init(c, f);
658 int bch2_opt_compression_parse(struct bch_fs *c, const char *_val, u64 *res,
659 struct printbuf *err)
661 char *val = kstrdup(_val, GFP_KERNEL);
662 char *p = val, *type_str, *level_str;
663 struct bch_compression_opt opt = { 0 };
669 type_str = strsep(&p, ":");
672 ret = match_string(bch2_compression_opts, -1, type_str);
674 prt_str(err, "invalid compression type");
683 ret = kstrtouint(level_str, 10, &level);
684 if (!ret && !opt.type && level)
686 if (!ret && level > 15)
689 prt_str(err, "invalid compression level");
696 *res = bch2_compression_encode(opt);
702 void bch2_opt_compression_to_text(struct printbuf *out,
707 struct bch_compression_opt opt = bch2_compression_decode(v);
709 prt_str(out, bch2_compression_opts[opt.type]);
711 prt_printf(out, ":%u", opt.level);