1 // SPDX-License-Identifier: GPL-2.0
3 * f2fs compress support
5 * Copyright (c) 2019 Chao Yu <chao@kernel.org>
9 #include <linux/f2fs_fs.h>
10 #include <linux/moduleparam.h>
11 #include <linux/writeback.h>
12 #include <linux/backing-dev.h>
13 #include <linux/lzo.h>
14 #include <linux/lz4.h>
15 #include <linux/zstd.h>
16 #include <linux/pagevec.h>
21 #include <trace/events/f2fs.h>
23 static struct kmem_cache *cic_entry_slab;
24 static struct kmem_cache *dic_entry_slab;
26 static void *page_array_alloc(struct inode *inode, int nr)
28 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
29 unsigned int size = sizeof(struct page *) * nr;
31 if (likely(size <= sbi->page_array_slab_size))
32 return f2fs_kmem_cache_alloc(sbi->page_array_slab,
33 GFP_F2FS_ZERO, false, F2FS_I_SB(inode));
34 return f2fs_kzalloc(sbi, size, GFP_NOFS);
37 static void page_array_free(struct inode *inode, void *pages, int nr)
39 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
40 unsigned int size = sizeof(struct page *) * nr;
45 if (likely(size <= sbi->page_array_slab_size))
46 kmem_cache_free(sbi->page_array_slab, pages);
51 struct f2fs_compress_ops {
52 int (*init_compress_ctx)(struct compress_ctx *cc);
53 void (*destroy_compress_ctx)(struct compress_ctx *cc);
54 int (*compress_pages)(struct compress_ctx *cc);
55 int (*init_decompress_ctx)(struct decompress_io_ctx *dic);
56 void (*destroy_decompress_ctx)(struct decompress_io_ctx *dic);
57 int (*decompress_pages)(struct decompress_io_ctx *dic);
58 bool (*is_level_valid)(int level);
61 static unsigned int offset_in_cluster(struct compress_ctx *cc, pgoff_t index)
63 return index & (cc->cluster_size - 1);
66 static pgoff_t cluster_idx(struct compress_ctx *cc, pgoff_t index)
68 return index >> cc->log_cluster_size;
71 static pgoff_t start_idx_of_cluster(struct compress_ctx *cc)
73 return cc->cluster_idx << cc->log_cluster_size;
76 bool f2fs_is_compressed_page(struct page *page)
78 if (!PagePrivate(page))
80 if (!page_private(page))
82 if (page_private_nonpointer(page))
85 f2fs_bug_on(F2FS_M_SB(page->mapping),
86 *((u32 *)page_private(page)) != F2FS_COMPRESSED_PAGE_MAGIC);
90 static void f2fs_set_compressed_page(struct page *page,
91 struct inode *inode, pgoff_t index, void *data)
93 attach_page_private(page, (void *)data);
95 /* i_crypto_info and iv index */
97 page->mapping = inode->i_mapping;
100 static void f2fs_drop_rpages(struct compress_ctx *cc, int len, bool unlock)
104 for (i = 0; i < len; i++) {
108 unlock_page(cc->rpages[i]);
110 put_page(cc->rpages[i]);
114 static void f2fs_put_rpages(struct compress_ctx *cc)
116 f2fs_drop_rpages(cc, cc->cluster_size, false);
119 static void f2fs_unlock_rpages(struct compress_ctx *cc, int len)
121 f2fs_drop_rpages(cc, len, true);
124 static void f2fs_put_rpages_wbc(struct compress_ctx *cc,
125 struct writeback_control *wbc, bool redirty, int unlock)
129 for (i = 0; i < cc->cluster_size; i++) {
133 redirty_page_for_writepage(wbc, cc->rpages[i]);
134 f2fs_put_page(cc->rpages[i], unlock);
138 struct page *f2fs_compress_control_page(struct page *page)
140 return ((struct compress_io_ctx *)page_private(page))->rpages[0];
143 int f2fs_init_compress_ctx(struct compress_ctx *cc)
148 cc->rpages = page_array_alloc(cc->inode, cc->cluster_size);
149 return cc->rpages ? 0 : -ENOMEM;
152 void f2fs_destroy_compress_ctx(struct compress_ctx *cc, bool reuse)
154 page_array_free(cc->inode, cc->rpages, cc->cluster_size);
158 cc->valid_nr_cpages = 0;
160 cc->cluster_idx = NULL_CLUSTER;
163 void f2fs_compress_ctx_add_page(struct compress_ctx *cc, struct page *page)
165 unsigned int cluster_ofs;
167 if (!f2fs_cluster_can_merge_page(cc, page->index))
168 f2fs_bug_on(F2FS_I_SB(cc->inode), 1);
170 cluster_ofs = offset_in_cluster(cc, page->index);
171 cc->rpages[cluster_ofs] = page;
173 cc->cluster_idx = cluster_idx(cc, page->index);
176 #ifdef CONFIG_F2FS_FS_LZO
177 static int lzo_init_compress_ctx(struct compress_ctx *cc)
179 cc->private = f2fs_kvmalloc(F2FS_I_SB(cc->inode),
180 LZO1X_MEM_COMPRESS, GFP_NOFS);
184 cc->clen = lzo1x_worst_compress(PAGE_SIZE << cc->log_cluster_size);
188 static void lzo_destroy_compress_ctx(struct compress_ctx *cc)
194 static int lzo_compress_pages(struct compress_ctx *cc)
198 ret = lzo1x_1_compress(cc->rbuf, cc->rlen, cc->cbuf->cdata,
199 &cc->clen, cc->private);
200 if (ret != LZO_E_OK) {
201 printk_ratelimited("%sF2FS-fs (%s): lzo compress failed, ret:%d\n",
202 KERN_ERR, F2FS_I_SB(cc->inode)->sb->s_id, ret);
208 static int lzo_decompress_pages(struct decompress_io_ctx *dic)
212 ret = lzo1x_decompress_safe(dic->cbuf->cdata, dic->clen,
213 dic->rbuf, &dic->rlen);
214 if (ret != LZO_E_OK) {
215 printk_ratelimited("%sF2FS-fs (%s): lzo decompress failed, ret:%d\n",
216 KERN_ERR, F2FS_I_SB(dic->inode)->sb->s_id, ret);
220 if (dic->rlen != PAGE_SIZE << dic->log_cluster_size) {
221 printk_ratelimited("%sF2FS-fs (%s): lzo invalid rlen:%zu, "
222 "expected:%lu\n", KERN_ERR,
223 F2FS_I_SB(dic->inode)->sb->s_id,
225 PAGE_SIZE << dic->log_cluster_size);
231 static const struct f2fs_compress_ops f2fs_lzo_ops = {
232 .init_compress_ctx = lzo_init_compress_ctx,
233 .destroy_compress_ctx = lzo_destroy_compress_ctx,
234 .compress_pages = lzo_compress_pages,
235 .decompress_pages = lzo_decompress_pages,
239 #ifdef CONFIG_F2FS_FS_LZ4
240 static int lz4_init_compress_ctx(struct compress_ctx *cc)
242 unsigned int size = LZ4_MEM_COMPRESS;
244 #ifdef CONFIG_F2FS_FS_LZ4HC
245 if (F2FS_I(cc->inode)->i_compress_level)
246 size = LZ4HC_MEM_COMPRESS;
249 cc->private = f2fs_kvmalloc(F2FS_I_SB(cc->inode), size, GFP_NOFS);
254 * we do not change cc->clen to LZ4_compressBound(inputsize) to
255 * adapt worst compress case, because lz4 compressor can handle
256 * output budget properly.
258 cc->clen = cc->rlen - PAGE_SIZE - COMPRESS_HEADER_SIZE;
262 static void lz4_destroy_compress_ctx(struct compress_ctx *cc)
268 static int lz4_compress_pages(struct compress_ctx *cc)
271 unsigned char level = F2FS_I(cc->inode)->i_compress_level;
274 len = LZ4_compress_default(cc->rbuf, cc->cbuf->cdata, cc->rlen,
275 cc->clen, cc->private);
276 #ifdef CONFIG_F2FS_FS_LZ4HC
278 len = LZ4_compress_HC(cc->rbuf, cc->cbuf->cdata, cc->rlen,
279 cc->clen, level, cc->private);
290 static int lz4_decompress_pages(struct decompress_io_ctx *dic)
294 ret = LZ4_decompress_safe(dic->cbuf->cdata, dic->rbuf,
295 dic->clen, dic->rlen);
297 printk_ratelimited("%sF2FS-fs (%s): lz4 decompress failed, ret:%d\n",
298 KERN_ERR, F2FS_I_SB(dic->inode)->sb->s_id, ret);
302 if (ret != PAGE_SIZE << dic->log_cluster_size) {
303 printk_ratelimited("%sF2FS-fs (%s): lz4 invalid ret:%d, "
304 "expected:%lu\n", KERN_ERR,
305 F2FS_I_SB(dic->inode)->sb->s_id, ret,
306 PAGE_SIZE << dic->log_cluster_size);
312 static bool lz4_is_level_valid(int lvl)
314 #ifdef CONFIG_F2FS_FS_LZ4HC
315 return !lvl || (lvl >= LZ4HC_MIN_CLEVEL && lvl <= LZ4HC_MAX_CLEVEL);
321 static const struct f2fs_compress_ops f2fs_lz4_ops = {
322 .init_compress_ctx = lz4_init_compress_ctx,
323 .destroy_compress_ctx = lz4_destroy_compress_ctx,
324 .compress_pages = lz4_compress_pages,
325 .decompress_pages = lz4_decompress_pages,
326 .is_level_valid = lz4_is_level_valid,
330 #ifdef CONFIG_F2FS_FS_ZSTD
331 static int zstd_init_compress_ctx(struct compress_ctx *cc)
333 zstd_parameters params;
334 zstd_cstream *stream;
336 unsigned int workspace_size;
337 unsigned char level = F2FS_I(cc->inode)->i_compress_level;
339 /* Need to remain this for backward compatibility */
341 level = F2FS_ZSTD_DEFAULT_CLEVEL;
343 params = zstd_get_params(level, cc->rlen);
344 workspace_size = zstd_cstream_workspace_bound(¶ms.cParams);
346 workspace = f2fs_kvmalloc(F2FS_I_SB(cc->inode),
347 workspace_size, GFP_NOFS);
351 stream = zstd_init_cstream(¶ms, 0, workspace, workspace_size);
353 printk_ratelimited("%sF2FS-fs (%s): %s zstd_init_cstream failed\n",
354 KERN_ERR, F2FS_I_SB(cc->inode)->sb->s_id,
360 cc->private = workspace;
361 cc->private2 = stream;
363 cc->clen = cc->rlen - PAGE_SIZE - COMPRESS_HEADER_SIZE;
367 static void zstd_destroy_compress_ctx(struct compress_ctx *cc)
374 static int zstd_compress_pages(struct compress_ctx *cc)
376 zstd_cstream *stream = cc->private2;
377 zstd_in_buffer inbuf;
378 zstd_out_buffer outbuf;
379 int src_size = cc->rlen;
380 int dst_size = src_size - PAGE_SIZE - COMPRESS_HEADER_SIZE;
384 inbuf.src = cc->rbuf;
385 inbuf.size = src_size;
388 outbuf.dst = cc->cbuf->cdata;
389 outbuf.size = dst_size;
391 ret = zstd_compress_stream(stream, &outbuf, &inbuf);
392 if (zstd_is_error(ret)) {
393 printk_ratelimited("%sF2FS-fs (%s): %s zstd_compress_stream failed, ret: %d\n",
394 KERN_ERR, F2FS_I_SB(cc->inode)->sb->s_id,
395 __func__, zstd_get_error_code(ret));
399 ret = zstd_end_stream(stream, &outbuf);
400 if (zstd_is_error(ret)) {
401 printk_ratelimited("%sF2FS-fs (%s): %s zstd_end_stream returned %d\n",
402 KERN_ERR, F2FS_I_SB(cc->inode)->sb->s_id,
403 __func__, zstd_get_error_code(ret));
408 * there is compressed data remained in intermediate buffer due to
409 * no more space in cbuf.cdata
414 cc->clen = outbuf.pos;
418 static int zstd_init_decompress_ctx(struct decompress_io_ctx *dic)
420 zstd_dstream *stream;
422 unsigned int workspace_size;
423 unsigned int max_window_size =
424 MAX_COMPRESS_WINDOW_SIZE(dic->log_cluster_size);
426 workspace_size = zstd_dstream_workspace_bound(max_window_size);
428 workspace = f2fs_kvmalloc(F2FS_I_SB(dic->inode),
429 workspace_size, GFP_NOFS);
433 stream = zstd_init_dstream(max_window_size, workspace, workspace_size);
435 printk_ratelimited("%sF2FS-fs (%s): %s zstd_init_dstream failed\n",
436 KERN_ERR, F2FS_I_SB(dic->inode)->sb->s_id,
442 dic->private = workspace;
443 dic->private2 = stream;
448 static void zstd_destroy_decompress_ctx(struct decompress_io_ctx *dic)
450 kvfree(dic->private);
452 dic->private2 = NULL;
455 static int zstd_decompress_pages(struct decompress_io_ctx *dic)
457 zstd_dstream *stream = dic->private2;
458 zstd_in_buffer inbuf;
459 zstd_out_buffer outbuf;
463 inbuf.src = dic->cbuf->cdata;
464 inbuf.size = dic->clen;
467 outbuf.dst = dic->rbuf;
468 outbuf.size = dic->rlen;
470 ret = zstd_decompress_stream(stream, &outbuf, &inbuf);
471 if (zstd_is_error(ret)) {
472 printk_ratelimited("%sF2FS-fs (%s): %s zstd_decompress_stream failed, ret: %d\n",
473 KERN_ERR, F2FS_I_SB(dic->inode)->sb->s_id,
474 __func__, zstd_get_error_code(ret));
478 if (dic->rlen != outbuf.pos) {
479 printk_ratelimited("%sF2FS-fs (%s): %s ZSTD invalid rlen:%zu, "
480 "expected:%lu\n", KERN_ERR,
481 F2FS_I_SB(dic->inode)->sb->s_id,
483 PAGE_SIZE << dic->log_cluster_size);
490 static bool zstd_is_level_valid(int lvl)
492 return lvl >= zstd_min_clevel() && lvl <= zstd_max_clevel();
495 static const struct f2fs_compress_ops f2fs_zstd_ops = {
496 .init_compress_ctx = zstd_init_compress_ctx,
497 .destroy_compress_ctx = zstd_destroy_compress_ctx,
498 .compress_pages = zstd_compress_pages,
499 .init_decompress_ctx = zstd_init_decompress_ctx,
500 .destroy_decompress_ctx = zstd_destroy_decompress_ctx,
501 .decompress_pages = zstd_decompress_pages,
502 .is_level_valid = zstd_is_level_valid,
506 #ifdef CONFIG_F2FS_FS_LZO
507 #ifdef CONFIG_F2FS_FS_LZORLE
508 static int lzorle_compress_pages(struct compress_ctx *cc)
512 ret = lzorle1x_1_compress(cc->rbuf, cc->rlen, cc->cbuf->cdata,
513 &cc->clen, cc->private);
514 if (ret != LZO_E_OK) {
515 printk_ratelimited("%sF2FS-fs (%s): lzo-rle compress failed, ret:%d\n",
516 KERN_ERR, F2FS_I_SB(cc->inode)->sb->s_id, ret);
522 static const struct f2fs_compress_ops f2fs_lzorle_ops = {
523 .init_compress_ctx = lzo_init_compress_ctx,
524 .destroy_compress_ctx = lzo_destroy_compress_ctx,
525 .compress_pages = lzorle_compress_pages,
526 .decompress_pages = lzo_decompress_pages,
531 static const struct f2fs_compress_ops *f2fs_cops[COMPRESS_MAX] = {
532 #ifdef CONFIG_F2FS_FS_LZO
537 #ifdef CONFIG_F2FS_FS_LZ4
542 #ifdef CONFIG_F2FS_FS_ZSTD
547 #if defined(CONFIG_F2FS_FS_LZO) && defined(CONFIG_F2FS_FS_LZORLE)
554 bool f2fs_is_compress_backend_ready(struct inode *inode)
556 if (!f2fs_compressed_file(inode))
558 return f2fs_cops[F2FS_I(inode)->i_compress_algorithm];
561 bool f2fs_is_compress_level_valid(int alg, int lvl)
563 const struct f2fs_compress_ops *cops = f2fs_cops[alg];
565 if (cops->is_level_valid)
566 return cops->is_level_valid(lvl);
571 static mempool_t *compress_page_pool;
572 static int num_compress_pages = 512;
573 module_param(num_compress_pages, uint, 0444);
574 MODULE_PARM_DESC(num_compress_pages,
575 "Number of intermediate compress pages to preallocate");
577 int __init f2fs_init_compress_mempool(void)
579 compress_page_pool = mempool_create_page_pool(num_compress_pages, 0);
580 return compress_page_pool ? 0 : -ENOMEM;
583 void f2fs_destroy_compress_mempool(void)
585 mempool_destroy(compress_page_pool);
588 static struct page *f2fs_compress_alloc_page(void)
592 page = mempool_alloc(compress_page_pool, GFP_NOFS);
598 static void f2fs_compress_free_page(struct page *page)
602 detach_page_private(page);
603 page->mapping = NULL;
605 mempool_free(page, compress_page_pool);
608 #define MAX_VMAP_RETRIES 3
610 static void *f2fs_vmap(struct page **pages, unsigned int count)
615 for (i = 0; i < MAX_VMAP_RETRIES; i++) {
616 buf = vm_map_ram(pages, count, -1);
624 static int f2fs_compress_pages(struct compress_ctx *cc)
626 struct f2fs_inode_info *fi = F2FS_I(cc->inode);
627 const struct f2fs_compress_ops *cops =
628 f2fs_cops[fi->i_compress_algorithm];
629 unsigned int max_len, new_nr_cpages;
633 trace_f2fs_compress_pages_start(cc->inode, cc->cluster_idx,
634 cc->cluster_size, fi->i_compress_algorithm);
636 if (cops->init_compress_ctx) {
637 ret = cops->init_compress_ctx(cc);
642 max_len = COMPRESS_HEADER_SIZE + cc->clen;
643 cc->nr_cpages = DIV_ROUND_UP(max_len, PAGE_SIZE);
644 cc->valid_nr_cpages = cc->nr_cpages;
646 cc->cpages = page_array_alloc(cc->inode, cc->nr_cpages);
649 goto destroy_compress_ctx;
652 for (i = 0; i < cc->nr_cpages; i++)
653 cc->cpages[i] = f2fs_compress_alloc_page();
655 cc->rbuf = f2fs_vmap(cc->rpages, cc->cluster_size);
658 goto out_free_cpages;
661 cc->cbuf = f2fs_vmap(cc->cpages, cc->nr_cpages);
664 goto out_vunmap_rbuf;
667 ret = cops->compress_pages(cc);
669 goto out_vunmap_cbuf;
671 max_len = PAGE_SIZE * (cc->cluster_size - 1) - COMPRESS_HEADER_SIZE;
673 if (cc->clen > max_len) {
675 goto out_vunmap_cbuf;
678 cc->cbuf->clen = cpu_to_le32(cc->clen);
680 if (fi->i_compress_flag & BIT(COMPRESS_CHKSUM))
681 chksum = f2fs_crc32(F2FS_I_SB(cc->inode),
682 cc->cbuf->cdata, cc->clen);
683 cc->cbuf->chksum = cpu_to_le32(chksum);
685 for (i = 0; i < COMPRESS_DATA_RESERVED_SIZE; i++)
686 cc->cbuf->reserved[i] = cpu_to_le32(0);
688 new_nr_cpages = DIV_ROUND_UP(cc->clen + COMPRESS_HEADER_SIZE, PAGE_SIZE);
690 /* zero out any unused part of the last page */
691 memset(&cc->cbuf->cdata[cc->clen], 0,
692 (new_nr_cpages * PAGE_SIZE) -
693 (cc->clen + COMPRESS_HEADER_SIZE));
695 vm_unmap_ram(cc->cbuf, cc->nr_cpages);
696 vm_unmap_ram(cc->rbuf, cc->cluster_size);
698 for (i = new_nr_cpages; i < cc->nr_cpages; i++) {
699 f2fs_compress_free_page(cc->cpages[i]);
700 cc->cpages[i] = NULL;
703 if (cops->destroy_compress_ctx)
704 cops->destroy_compress_ctx(cc);
706 cc->valid_nr_cpages = new_nr_cpages;
708 trace_f2fs_compress_pages_end(cc->inode, cc->cluster_idx,
713 vm_unmap_ram(cc->cbuf, cc->nr_cpages);
715 vm_unmap_ram(cc->rbuf, cc->cluster_size);
717 for (i = 0; i < cc->nr_cpages; i++) {
719 f2fs_compress_free_page(cc->cpages[i]);
721 page_array_free(cc->inode, cc->cpages, cc->nr_cpages);
723 destroy_compress_ctx:
724 if (cops->destroy_compress_ctx)
725 cops->destroy_compress_ctx(cc);
727 trace_f2fs_compress_pages_end(cc->inode, cc->cluster_idx,
732 static int f2fs_prepare_decomp_mem(struct decompress_io_ctx *dic,
734 static void f2fs_release_decomp_mem(struct decompress_io_ctx *dic,
735 bool bypass_destroy_callback, bool pre_alloc);
737 void f2fs_decompress_cluster(struct decompress_io_ctx *dic, bool in_task)
739 struct f2fs_sb_info *sbi = F2FS_I_SB(dic->inode);
740 struct f2fs_inode_info *fi = F2FS_I(dic->inode);
741 const struct f2fs_compress_ops *cops =
742 f2fs_cops[fi->i_compress_algorithm];
743 bool bypass_callback = false;
746 trace_f2fs_decompress_pages_start(dic->inode, dic->cluster_idx,
747 dic->cluster_size, fi->i_compress_algorithm);
754 ret = f2fs_prepare_decomp_mem(dic, false);
756 bypass_callback = true;
760 dic->clen = le32_to_cpu(dic->cbuf->clen);
761 dic->rlen = PAGE_SIZE << dic->log_cluster_size;
763 if (dic->clen > PAGE_SIZE * dic->nr_cpages - COMPRESS_HEADER_SIZE) {
766 /* Avoid f2fs_commit_super in irq context */
768 f2fs_handle_error_async(sbi, ERROR_FAIL_DECOMPRESSION);
770 f2fs_handle_error(sbi, ERROR_FAIL_DECOMPRESSION);
774 ret = cops->decompress_pages(dic);
776 if (!ret && (fi->i_compress_flag & BIT(COMPRESS_CHKSUM))) {
777 u32 provided = le32_to_cpu(dic->cbuf->chksum);
778 u32 calculated = f2fs_crc32(sbi, dic->cbuf->cdata, dic->clen);
780 if (provided != calculated) {
781 if (!is_inode_flag_set(dic->inode, FI_COMPRESS_CORRUPT)) {
782 set_inode_flag(dic->inode, FI_COMPRESS_CORRUPT);
784 "%sF2FS-fs (%s): checksum invalid, nid = %lu, %x vs %x",
785 KERN_INFO, sbi->sb->s_id, dic->inode->i_ino,
786 provided, calculated);
788 set_sbi_flag(sbi, SBI_NEED_FSCK);
793 f2fs_release_decomp_mem(dic, bypass_callback, false);
796 trace_f2fs_decompress_pages_end(dic->inode, dic->cluster_idx,
798 f2fs_decompress_end_io(dic, ret, in_task);
802 * This is called when a page of a compressed cluster has been read from disk
803 * (or failed to be read from disk). It checks whether this page was the last
804 * page being waited on in the cluster, and if so, it decompresses the cluster
805 * (or in the case of a failure, cleans up without actually decompressing).
807 void f2fs_end_read_compressed_page(struct page *page, bool failed,
808 block_t blkaddr, bool in_task)
810 struct decompress_io_ctx *dic =
811 (struct decompress_io_ctx *)page_private(page);
812 struct f2fs_sb_info *sbi = F2FS_I_SB(dic->inode);
814 dec_page_count(sbi, F2FS_RD_DATA);
817 WRITE_ONCE(dic->failed, true);
818 else if (blkaddr && in_task)
819 f2fs_cache_compressed_page(sbi, page,
820 dic->inode->i_ino, blkaddr);
822 if (atomic_dec_and_test(&dic->remaining_pages))
823 f2fs_decompress_cluster(dic, in_task);
826 static bool is_page_in_cluster(struct compress_ctx *cc, pgoff_t index)
828 if (cc->cluster_idx == NULL_CLUSTER)
830 return cc->cluster_idx == cluster_idx(cc, index);
833 bool f2fs_cluster_is_empty(struct compress_ctx *cc)
835 return cc->nr_rpages == 0;
838 static bool f2fs_cluster_is_full(struct compress_ctx *cc)
840 return cc->cluster_size == cc->nr_rpages;
843 bool f2fs_cluster_can_merge_page(struct compress_ctx *cc, pgoff_t index)
845 if (f2fs_cluster_is_empty(cc))
847 return is_page_in_cluster(cc, index);
850 bool f2fs_all_cluster_page_ready(struct compress_ctx *cc, struct page **pages,
851 int index, int nr_pages, bool uptodate)
853 unsigned long pgidx = pages[index]->index;
854 int i = uptodate ? 0 : 1;
857 * when uptodate set to true, try to check all pages in cluster is
860 if (uptodate && (pgidx % cc->cluster_size))
863 if (nr_pages - index < cc->cluster_size)
866 for (; i < cc->cluster_size; i++) {
867 if (pages[index + i]->index != pgidx + i)
869 if (uptodate && !PageUptodate(pages[index + i]))
876 static bool cluster_has_invalid_data(struct compress_ctx *cc)
878 loff_t i_size = i_size_read(cc->inode);
879 unsigned nr_pages = DIV_ROUND_UP(i_size, PAGE_SIZE);
882 for (i = 0; i < cc->cluster_size; i++) {
883 struct page *page = cc->rpages[i];
885 f2fs_bug_on(F2FS_I_SB(cc->inode), !page);
888 if (page->index >= nr_pages)
894 bool f2fs_sanity_check_cluster(struct dnode_of_data *dn)
896 #ifdef CONFIG_F2FS_CHECK_FS
897 struct f2fs_sb_info *sbi = F2FS_I_SB(dn->inode);
898 unsigned int cluster_size = F2FS_I(dn->inode)->i_cluster_size;
904 if (dn->data_blkaddr != COMPRESS_ADDR)
907 /* [..., COMPR_ADDR, ...] */
908 if (dn->ofs_in_node % cluster_size) {
909 reason = "[*|C|*|*]";
913 for (i = 1, count = 1; i < cluster_size; i++, count++) {
914 block_t blkaddr = data_blkaddr(dn->inode, dn->node_page,
915 dn->ofs_in_node + i);
917 /* [COMPR_ADDR, ..., COMPR_ADDR] */
918 if (blkaddr == COMPRESS_ADDR) {
919 reason = "[C|*|C|*]";
922 if (!__is_valid_data_blkaddr(blkaddr)) {
927 /* [COMPR_ADDR, NULL_ADDR or NEW_ADDR, valid_blkaddr] */
929 reason = "[C|N|N|V]";
934 f2fs_bug_on(F2FS_I_SB(dn->inode), count != cluster_size &&
935 !is_inode_flag_set(dn->inode, FI_COMPRESS_RELEASED));
939 f2fs_warn(sbi, "access invalid cluster, ino:%lu, nid:%u, ofs_in_node:%u, reason:%s",
940 dn->inode->i_ino, dn->nid, dn->ofs_in_node, reason);
941 set_sbi_flag(sbi, SBI_NEED_FSCK);
948 static int __f2fs_get_cluster_blocks(struct inode *inode,
949 struct dnode_of_data *dn)
951 unsigned int cluster_size = F2FS_I(inode)->i_cluster_size;
954 for (i = 1, count = 1; i < cluster_size; i++) {
955 block_t blkaddr = data_blkaddr(dn->inode, dn->node_page,
956 dn->ofs_in_node + i);
958 if (__is_valid_data_blkaddr(blkaddr))
965 static int __f2fs_cluster_blocks(struct inode *inode,
966 unsigned int cluster_idx, bool compr_blks)
968 struct dnode_of_data dn;
969 unsigned int start_idx = cluster_idx <<
970 F2FS_I(inode)->i_log_cluster_size;
973 set_new_dnode(&dn, inode, NULL, NULL, 0);
974 ret = f2fs_get_dnode_of_data(&dn, start_idx, LOOKUP_NODE);
981 if (f2fs_sanity_check_cluster(&dn)) {
986 if (dn.data_blkaddr == COMPRESS_ADDR) {
988 ret = __f2fs_get_cluster_blocks(inode, &dn);
997 /* return # of compressed blocks in compressed cluster */
998 static int f2fs_compressed_blocks(struct compress_ctx *cc)
1000 return __f2fs_cluster_blocks(cc->inode, cc->cluster_idx, true);
1003 /* return whether cluster is compressed one or not */
1004 int f2fs_is_compressed_cluster(struct inode *inode, pgoff_t index)
1006 return __f2fs_cluster_blocks(inode,
1007 index >> F2FS_I(inode)->i_log_cluster_size,
1011 static bool cluster_may_compress(struct compress_ctx *cc)
1013 if (!f2fs_need_compress_data(cc->inode))
1015 if (f2fs_is_atomic_file(cc->inode))
1017 if (!f2fs_cluster_is_full(cc))
1019 if (unlikely(f2fs_cp_error(F2FS_I_SB(cc->inode))))
1021 return !cluster_has_invalid_data(cc);
1024 static void set_cluster_writeback(struct compress_ctx *cc)
1028 for (i = 0; i < cc->cluster_size; i++) {
1030 set_page_writeback(cc->rpages[i]);
1034 static void set_cluster_dirty(struct compress_ctx *cc)
1038 for (i = 0; i < cc->cluster_size; i++)
1040 set_page_dirty(cc->rpages[i]);
1043 static int prepare_compress_overwrite(struct compress_ctx *cc,
1044 struct page **pagep, pgoff_t index, void **fsdata)
1046 struct f2fs_sb_info *sbi = F2FS_I_SB(cc->inode);
1047 struct address_space *mapping = cc->inode->i_mapping;
1049 sector_t last_block_in_bio;
1050 fgf_t fgp_flag = FGP_LOCK | FGP_WRITE | FGP_CREAT;
1051 pgoff_t start_idx = start_idx_of_cluster(cc);
1055 ret = f2fs_is_compressed_cluster(cc->inode, start_idx);
1059 ret = f2fs_init_compress_ctx(cc);
1063 /* keep page reference to avoid page reclaim */
1064 for (i = 0; i < cc->cluster_size; i++) {
1065 page = f2fs_pagecache_get_page(mapping, start_idx + i,
1066 fgp_flag, GFP_NOFS);
1072 if (PageUptodate(page))
1073 f2fs_put_page(page, 1);
1075 f2fs_compress_ctx_add_page(cc, page);
1078 if (!f2fs_cluster_is_empty(cc)) {
1079 struct bio *bio = NULL;
1081 ret = f2fs_read_multi_pages(cc, &bio, cc->cluster_size,
1082 &last_block_in_bio, false, true);
1083 f2fs_put_rpages(cc);
1084 f2fs_destroy_compress_ctx(cc, true);
1088 f2fs_submit_read_bio(sbi, bio, DATA);
1090 ret = f2fs_init_compress_ctx(cc);
1095 for (i = 0; i < cc->cluster_size; i++) {
1096 f2fs_bug_on(sbi, cc->rpages[i]);
1098 page = find_lock_page(mapping, start_idx + i);
1100 /* page can be truncated */
1101 goto release_and_retry;
1104 f2fs_wait_on_page_writeback(page, DATA, true, true);
1105 f2fs_compress_ctx_add_page(cc, page);
1107 if (!PageUptodate(page)) {
1109 f2fs_put_rpages(cc);
1110 f2fs_unlock_rpages(cc, i + 1);
1111 f2fs_destroy_compress_ctx(cc, true);
1117 *fsdata = cc->rpages;
1118 *pagep = cc->rpages[offset_in_cluster(cc, index)];
1119 return cc->cluster_size;
1123 f2fs_put_rpages(cc);
1124 f2fs_unlock_rpages(cc, i);
1125 f2fs_destroy_compress_ctx(cc, true);
1130 int f2fs_prepare_compress_overwrite(struct inode *inode,
1131 struct page **pagep, pgoff_t index, void **fsdata)
1133 struct compress_ctx cc = {
1135 .log_cluster_size = F2FS_I(inode)->i_log_cluster_size,
1136 .cluster_size = F2FS_I(inode)->i_cluster_size,
1137 .cluster_idx = index >> F2FS_I(inode)->i_log_cluster_size,
1142 return prepare_compress_overwrite(&cc, pagep, index, fsdata);
1145 bool f2fs_compress_write_end(struct inode *inode, void *fsdata,
1146 pgoff_t index, unsigned copied)
1149 struct compress_ctx cc = {
1151 .log_cluster_size = F2FS_I(inode)->i_log_cluster_size,
1152 .cluster_size = F2FS_I(inode)->i_cluster_size,
1155 bool first_index = (index == cc.rpages[0]->index);
1158 set_cluster_dirty(&cc);
1160 f2fs_put_rpages_wbc(&cc, NULL, false, 1);
1161 f2fs_destroy_compress_ctx(&cc, false);
1166 int f2fs_truncate_partial_cluster(struct inode *inode, u64 from, bool lock)
1168 void *fsdata = NULL;
1170 int log_cluster_size = F2FS_I(inode)->i_log_cluster_size;
1171 pgoff_t start_idx = from >> (PAGE_SHIFT + log_cluster_size) <<
1175 err = f2fs_is_compressed_cluster(inode, start_idx);
1179 /* truncate normal cluster */
1181 return f2fs_do_truncate_blocks(inode, from, lock);
1183 /* truncate compressed cluster */
1184 err = f2fs_prepare_compress_overwrite(inode, &pagep,
1185 start_idx, &fsdata);
1187 /* should not be a normal cluster */
1188 f2fs_bug_on(F2FS_I_SB(inode), err == 0);
1194 struct page **rpages = fsdata;
1195 int cluster_size = F2FS_I(inode)->i_cluster_size;
1198 for (i = cluster_size - 1; i >= 0; i--) {
1199 loff_t start = rpages[i]->index << PAGE_SHIFT;
1201 if (from <= start) {
1202 zero_user_segment(rpages[i], 0, PAGE_SIZE);
1204 zero_user_segment(rpages[i], from - start,
1210 f2fs_compress_write_end(inode, fsdata, start_idx, true);
1215 static int f2fs_write_compressed_pages(struct compress_ctx *cc,
1217 struct writeback_control *wbc,
1218 enum iostat_type io_type)
1220 struct inode *inode = cc->inode;
1221 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
1222 struct f2fs_inode_info *fi = F2FS_I(inode);
1223 struct f2fs_io_info fio = {
1225 .ino = cc->inode->i_ino,
1228 .op_flags = wbc_to_write_flags(wbc),
1229 .old_blkaddr = NEW_ADDR,
1231 .encrypted_page = NULL,
1232 .compressed_page = NULL,
1236 .encrypted = fscrypt_inode_uses_fs_layer_crypto(cc->inode) ?
1239 struct dnode_of_data dn;
1240 struct node_info ni;
1241 struct compress_io_ctx *cic;
1242 pgoff_t start_idx = start_idx_of_cluster(cc);
1243 unsigned int last_index = cc->cluster_size - 1;
1246 bool quota_inode = IS_NOQUOTA(inode);
1248 /* we should bypass data pages to proceed the kworker jobs */
1249 if (unlikely(f2fs_cp_error(sbi))) {
1250 mapping_set_error(cc->rpages[0]->mapping, -EIO);
1256 * We need to wait for node_write to avoid block allocation during
1257 * checkpoint. This can only happen to quota writes which can cause
1258 * the below discard race condition.
1260 f2fs_down_read(&sbi->node_write);
1261 } else if (!f2fs_trylock_op(sbi)) {
1265 set_new_dnode(&dn, cc->inode, NULL, NULL, 0);
1267 err = f2fs_get_dnode_of_data(&dn, start_idx, LOOKUP_NODE);
1271 for (i = 0; i < cc->cluster_size; i++) {
1272 if (data_blkaddr(dn.inode, dn.node_page,
1273 dn.ofs_in_node + i) == NULL_ADDR)
1277 psize = (loff_t)(cc->rpages[last_index]->index + 1) << PAGE_SHIFT;
1279 err = f2fs_get_node_info(fio.sbi, dn.nid, &ni, false);
1283 fio.version = ni.version;
1285 cic = f2fs_kmem_cache_alloc(cic_entry_slab, GFP_F2FS_ZERO, false, sbi);
1289 cic->magic = F2FS_COMPRESSED_PAGE_MAGIC;
1291 atomic_set(&cic->pending_pages, cc->valid_nr_cpages);
1292 cic->rpages = page_array_alloc(cc->inode, cc->cluster_size);
1296 cic->nr_rpages = cc->cluster_size;
1298 for (i = 0; i < cc->valid_nr_cpages; i++) {
1299 f2fs_set_compressed_page(cc->cpages[i], inode,
1300 cc->rpages[i + 1]->index, cic);
1301 fio.compressed_page = cc->cpages[i];
1303 fio.old_blkaddr = data_blkaddr(dn.inode, dn.node_page,
1304 dn.ofs_in_node + i + 1);
1306 /* wait for GCed page writeback via META_MAPPING */
1307 f2fs_wait_on_block_writeback(inode, fio.old_blkaddr);
1309 if (fio.encrypted) {
1310 fio.page = cc->rpages[i + 1];
1311 err = f2fs_encrypt_one_page(&fio);
1313 goto out_destroy_crypt;
1314 cc->cpages[i] = fio.encrypted_page;
1318 set_cluster_writeback(cc);
1320 for (i = 0; i < cc->cluster_size; i++)
1321 cic->rpages[i] = cc->rpages[i];
1323 for (i = 0; i < cc->cluster_size; i++, dn.ofs_in_node++) {
1326 blkaddr = f2fs_data_blkaddr(&dn);
1327 fio.page = cc->rpages[i];
1328 fio.old_blkaddr = blkaddr;
1330 /* cluster header */
1332 if (blkaddr == COMPRESS_ADDR)
1334 if (__is_valid_data_blkaddr(blkaddr))
1335 f2fs_invalidate_blocks(sbi, blkaddr);
1336 f2fs_update_data_blkaddr(&dn, COMPRESS_ADDR);
1337 goto unlock_continue;
1340 if (fio.compr_blocks && __is_valid_data_blkaddr(blkaddr))
1343 if (i > cc->valid_nr_cpages) {
1344 if (__is_valid_data_blkaddr(blkaddr)) {
1345 f2fs_invalidate_blocks(sbi, blkaddr);
1346 f2fs_update_data_blkaddr(&dn, NEW_ADDR);
1348 goto unlock_continue;
1351 f2fs_bug_on(fio.sbi, blkaddr == NULL_ADDR);
1354 fio.encrypted_page = cc->cpages[i - 1];
1356 fio.compressed_page = cc->cpages[i - 1];
1358 cc->cpages[i - 1] = NULL;
1359 f2fs_outplace_write_data(&dn, &fio);
1362 inode_dec_dirty_pages(cc->inode);
1363 unlock_page(fio.page);
1366 if (fio.compr_blocks)
1367 f2fs_i_compr_blocks_update(inode, fio.compr_blocks - 1, false);
1368 f2fs_i_compr_blocks_update(inode, cc->valid_nr_cpages, true);
1369 add_compr_block_stat(inode, cc->valid_nr_cpages);
1371 set_inode_flag(cc->inode, FI_APPEND_WRITE);
1372 if (cc->cluster_idx == 0)
1373 set_inode_flag(inode, FI_FIRST_BLOCK_WRITTEN);
1375 f2fs_put_dnode(&dn);
1377 f2fs_up_read(&sbi->node_write);
1379 f2fs_unlock_op(sbi);
1381 spin_lock(&fi->i_size_lock);
1382 if (fi->last_disk_size < psize)
1383 fi->last_disk_size = psize;
1384 spin_unlock(&fi->i_size_lock);
1386 f2fs_put_rpages(cc);
1387 page_array_free(cc->inode, cc->cpages, cc->nr_cpages);
1389 f2fs_destroy_compress_ctx(cc, false);
1393 page_array_free(cc->inode, cic->rpages, cc->cluster_size);
1395 for (--i; i >= 0; i--)
1396 fscrypt_finalize_bounce_page(&cc->cpages[i]);
1398 kmem_cache_free(cic_entry_slab, cic);
1400 f2fs_put_dnode(&dn);
1403 f2fs_up_read(&sbi->node_write);
1405 f2fs_unlock_op(sbi);
1407 for (i = 0; i < cc->valid_nr_cpages; i++) {
1408 f2fs_compress_free_page(cc->cpages[i]);
1409 cc->cpages[i] = NULL;
1411 page_array_free(cc->inode, cc->cpages, cc->nr_cpages);
1416 void f2fs_compress_write_end_io(struct bio *bio, struct page *page)
1418 struct f2fs_sb_info *sbi = bio->bi_private;
1419 struct compress_io_ctx *cic =
1420 (struct compress_io_ctx *)page_private(page);
1423 if (unlikely(bio->bi_status))
1424 mapping_set_error(cic->inode->i_mapping, -EIO);
1426 f2fs_compress_free_page(page);
1428 dec_page_count(sbi, F2FS_WB_DATA);
1430 if (atomic_dec_return(&cic->pending_pages))
1433 for (i = 0; i < cic->nr_rpages; i++) {
1434 WARN_ON(!cic->rpages[i]);
1435 clear_page_private_gcing(cic->rpages[i]);
1436 end_page_writeback(cic->rpages[i]);
1439 page_array_free(cic->inode, cic->rpages, cic->nr_rpages);
1440 kmem_cache_free(cic_entry_slab, cic);
1443 static int f2fs_write_raw_pages(struct compress_ctx *cc,
1445 struct writeback_control *wbc,
1446 enum iostat_type io_type)
1448 struct address_space *mapping = cc->inode->i_mapping;
1449 int _submitted, compr_blocks, ret, i;
1451 compr_blocks = f2fs_compressed_blocks(cc);
1453 for (i = 0; i < cc->cluster_size; i++) {
1457 redirty_page_for_writepage(wbc, cc->rpages[i]);
1458 unlock_page(cc->rpages[i]);
1461 if (compr_blocks < 0)
1462 return compr_blocks;
1464 for (i = 0; i < cc->cluster_size; i++) {
1468 lock_page(cc->rpages[i]);
1470 if (cc->rpages[i]->mapping != mapping) {
1472 unlock_page(cc->rpages[i]);
1476 if (!PageDirty(cc->rpages[i]))
1477 goto continue_unlock;
1479 if (PageWriteback(cc->rpages[i])) {
1480 if (wbc->sync_mode == WB_SYNC_NONE)
1481 goto continue_unlock;
1482 f2fs_wait_on_page_writeback(cc->rpages[i], DATA, true, true);
1485 if (!clear_page_dirty_for_io(cc->rpages[i]))
1486 goto continue_unlock;
1488 ret = f2fs_write_single_data_page(cc->rpages[i], &_submitted,
1489 NULL, NULL, wbc, io_type,
1490 compr_blocks, false);
1492 if (ret == AOP_WRITEPAGE_ACTIVATE) {
1493 unlock_page(cc->rpages[i]);
1495 } else if (ret == -EAGAIN) {
1497 * for quota file, just redirty left pages to
1498 * avoid deadlock caused by cluster update race
1499 * from foreground operation.
1501 if (IS_NOQUOTA(cc->inode))
1504 f2fs_io_schedule_timeout(DEFAULT_IO_TIMEOUT);
1510 *submitted += _submitted;
1513 f2fs_balance_fs(F2FS_M_SB(mapping), true);
1518 int f2fs_write_multi_pages(struct compress_ctx *cc,
1520 struct writeback_control *wbc,
1521 enum iostat_type io_type)
1526 if (cluster_may_compress(cc)) {
1527 err = f2fs_compress_pages(cc);
1528 if (err == -EAGAIN) {
1529 add_compr_block_stat(cc->inode, cc->cluster_size);
1532 f2fs_put_rpages_wbc(cc, wbc, true, 1);
1536 err = f2fs_write_compressed_pages(cc, submitted,
1540 f2fs_bug_on(F2FS_I_SB(cc->inode), err != -EAGAIN);
1543 f2fs_bug_on(F2FS_I_SB(cc->inode), *submitted);
1545 err = f2fs_write_raw_pages(cc, submitted, wbc, io_type);
1546 f2fs_put_rpages_wbc(cc, wbc, false, 0);
1548 f2fs_destroy_compress_ctx(cc, false);
1552 static inline bool allow_memalloc_for_decomp(struct f2fs_sb_info *sbi,
1555 return pre_alloc ^ f2fs_low_mem_mode(sbi);
1558 static int f2fs_prepare_decomp_mem(struct decompress_io_ctx *dic,
1561 const struct f2fs_compress_ops *cops =
1562 f2fs_cops[F2FS_I(dic->inode)->i_compress_algorithm];
1565 if (!allow_memalloc_for_decomp(F2FS_I_SB(dic->inode), pre_alloc))
1568 dic->tpages = page_array_alloc(dic->inode, dic->cluster_size);
1572 for (i = 0; i < dic->cluster_size; i++) {
1573 if (dic->rpages[i]) {
1574 dic->tpages[i] = dic->rpages[i];
1578 dic->tpages[i] = f2fs_compress_alloc_page();
1581 dic->rbuf = f2fs_vmap(dic->tpages, dic->cluster_size);
1585 dic->cbuf = f2fs_vmap(dic->cpages, dic->nr_cpages);
1589 if (cops->init_decompress_ctx)
1590 return cops->init_decompress_ctx(dic);
1595 static void f2fs_release_decomp_mem(struct decompress_io_ctx *dic,
1596 bool bypass_destroy_callback, bool pre_alloc)
1598 const struct f2fs_compress_ops *cops =
1599 f2fs_cops[F2FS_I(dic->inode)->i_compress_algorithm];
1601 if (!allow_memalloc_for_decomp(F2FS_I_SB(dic->inode), pre_alloc))
1604 if (!bypass_destroy_callback && cops->destroy_decompress_ctx)
1605 cops->destroy_decompress_ctx(dic);
1608 vm_unmap_ram(dic->cbuf, dic->nr_cpages);
1611 vm_unmap_ram(dic->rbuf, dic->cluster_size);
1614 static void f2fs_free_dic(struct decompress_io_ctx *dic,
1615 bool bypass_destroy_callback);
1617 struct decompress_io_ctx *f2fs_alloc_dic(struct compress_ctx *cc)
1619 struct decompress_io_ctx *dic;
1620 pgoff_t start_idx = start_idx_of_cluster(cc);
1621 struct f2fs_sb_info *sbi = F2FS_I_SB(cc->inode);
1624 dic = f2fs_kmem_cache_alloc(dic_entry_slab, GFP_F2FS_ZERO, false, sbi);
1626 return ERR_PTR(-ENOMEM);
1628 dic->rpages = page_array_alloc(cc->inode, cc->cluster_size);
1630 kmem_cache_free(dic_entry_slab, dic);
1631 return ERR_PTR(-ENOMEM);
1634 dic->magic = F2FS_COMPRESSED_PAGE_MAGIC;
1635 dic->inode = cc->inode;
1636 atomic_set(&dic->remaining_pages, cc->nr_cpages);
1637 dic->cluster_idx = cc->cluster_idx;
1638 dic->cluster_size = cc->cluster_size;
1639 dic->log_cluster_size = cc->log_cluster_size;
1640 dic->nr_cpages = cc->nr_cpages;
1641 refcount_set(&dic->refcnt, 1);
1642 dic->failed = false;
1643 dic->need_verity = f2fs_need_verity(cc->inode, start_idx);
1645 for (i = 0; i < dic->cluster_size; i++)
1646 dic->rpages[i] = cc->rpages[i];
1647 dic->nr_rpages = cc->cluster_size;
1649 dic->cpages = page_array_alloc(dic->inode, dic->nr_cpages);
1655 for (i = 0; i < dic->nr_cpages; i++) {
1658 page = f2fs_compress_alloc_page();
1659 f2fs_set_compressed_page(page, cc->inode,
1660 start_idx + i + 1, dic);
1661 dic->cpages[i] = page;
1664 ret = f2fs_prepare_decomp_mem(dic, true);
1671 f2fs_free_dic(dic, true);
1672 return ERR_PTR(ret);
1675 static void f2fs_free_dic(struct decompress_io_ctx *dic,
1676 bool bypass_destroy_callback)
1680 f2fs_release_decomp_mem(dic, bypass_destroy_callback, true);
1683 for (i = 0; i < dic->cluster_size; i++) {
1686 if (!dic->tpages[i])
1688 f2fs_compress_free_page(dic->tpages[i]);
1690 page_array_free(dic->inode, dic->tpages, dic->cluster_size);
1694 for (i = 0; i < dic->nr_cpages; i++) {
1695 if (!dic->cpages[i])
1697 f2fs_compress_free_page(dic->cpages[i]);
1699 page_array_free(dic->inode, dic->cpages, dic->nr_cpages);
1702 page_array_free(dic->inode, dic->rpages, dic->nr_rpages);
1703 kmem_cache_free(dic_entry_slab, dic);
1706 static void f2fs_late_free_dic(struct work_struct *work)
1708 struct decompress_io_ctx *dic =
1709 container_of(work, struct decompress_io_ctx, free_work);
1711 f2fs_free_dic(dic, false);
1714 static void f2fs_put_dic(struct decompress_io_ctx *dic, bool in_task)
1716 if (refcount_dec_and_test(&dic->refcnt)) {
1718 f2fs_free_dic(dic, false);
1720 INIT_WORK(&dic->free_work, f2fs_late_free_dic);
1721 queue_work(F2FS_I_SB(dic->inode)->post_read_wq,
1727 static void f2fs_verify_cluster(struct work_struct *work)
1729 struct decompress_io_ctx *dic =
1730 container_of(work, struct decompress_io_ctx, verity_work);
1733 /* Verify, update, and unlock the decompressed pages. */
1734 for (i = 0; i < dic->cluster_size; i++) {
1735 struct page *rpage = dic->rpages[i];
1740 if (fsverity_verify_page(rpage))
1741 SetPageUptodate(rpage);
1743 ClearPageUptodate(rpage);
1747 f2fs_put_dic(dic, true);
1751 * This is called when a compressed cluster has been decompressed
1752 * (or failed to be read and/or decompressed).
1754 void f2fs_decompress_end_io(struct decompress_io_ctx *dic, bool failed,
1759 if (!failed && dic->need_verity) {
1761 * Note that to avoid deadlocks, the verity work can't be done
1762 * on the decompression workqueue. This is because verifying
1763 * the data pages can involve reading metadata pages from the
1764 * file, and these metadata pages may be compressed.
1766 INIT_WORK(&dic->verity_work, f2fs_verify_cluster);
1767 fsverity_enqueue_verify_work(&dic->verity_work);
1771 /* Update and unlock the cluster's pagecache pages. */
1772 for (i = 0; i < dic->cluster_size; i++) {
1773 struct page *rpage = dic->rpages[i];
1779 ClearPageUptodate(rpage);
1781 SetPageUptodate(rpage);
1786 * Release the reference to the decompress_io_ctx that was being held
1787 * for I/O completion.
1789 f2fs_put_dic(dic, in_task);
1793 * Put a reference to a compressed page's decompress_io_ctx.
1795 * This is called when the page is no longer needed and can be freed.
1797 void f2fs_put_page_dic(struct page *page, bool in_task)
1799 struct decompress_io_ctx *dic =
1800 (struct decompress_io_ctx *)page_private(page);
1802 f2fs_put_dic(dic, in_task);
1806 * check whether cluster blocks are contiguous, and add extent cache entry
1807 * only if cluster blocks are logically and physically contiguous.
1809 unsigned int f2fs_cluster_blocks_are_contiguous(struct dnode_of_data *dn)
1811 bool compressed = f2fs_data_blkaddr(dn) == COMPRESS_ADDR;
1812 int i = compressed ? 1 : 0;
1813 block_t first_blkaddr = data_blkaddr(dn->inode, dn->node_page,
1814 dn->ofs_in_node + i);
1816 for (i += 1; i < F2FS_I(dn->inode)->i_cluster_size; i++) {
1817 block_t blkaddr = data_blkaddr(dn->inode, dn->node_page,
1818 dn->ofs_in_node + i);
1820 if (!__is_valid_data_blkaddr(blkaddr))
1822 if (first_blkaddr + i - (compressed ? 1 : 0) != blkaddr)
1826 return compressed ? i - 1 : i;
1829 const struct address_space_operations f2fs_compress_aops = {
1830 .release_folio = f2fs_release_folio,
1831 .invalidate_folio = f2fs_invalidate_folio,
1832 .migrate_folio = filemap_migrate_folio,
1835 struct address_space *COMPRESS_MAPPING(struct f2fs_sb_info *sbi)
1837 return sbi->compress_inode->i_mapping;
1840 void f2fs_invalidate_compress_page(struct f2fs_sb_info *sbi, block_t blkaddr)
1842 if (!sbi->compress_inode)
1844 invalidate_mapping_pages(COMPRESS_MAPPING(sbi), blkaddr, blkaddr);
1847 void f2fs_cache_compressed_page(struct f2fs_sb_info *sbi, struct page *page,
1848 nid_t ino, block_t blkaddr)
1853 if (!test_opt(sbi, COMPRESS_CACHE))
1856 if (!f2fs_is_valid_blkaddr(sbi, blkaddr, DATA_GENERIC_ENHANCE_READ))
1859 if (!f2fs_available_free_memory(sbi, COMPRESS_PAGE))
1862 cpage = find_get_page(COMPRESS_MAPPING(sbi), blkaddr);
1864 f2fs_put_page(cpage, 0);
1868 cpage = alloc_page(__GFP_NOWARN | __GFP_IO);
1872 ret = add_to_page_cache_lru(cpage, COMPRESS_MAPPING(sbi),
1875 f2fs_put_page(cpage, 0);
1879 set_page_private_data(cpage, ino);
1881 if (!f2fs_is_valid_blkaddr(sbi, blkaddr, DATA_GENERIC_ENHANCE_READ))
1884 memcpy(page_address(cpage), page_address(page), PAGE_SIZE);
1885 SetPageUptodate(cpage);
1887 f2fs_put_page(cpage, 1);
1890 bool f2fs_load_compressed_page(struct f2fs_sb_info *sbi, struct page *page,
1894 bool hitted = false;
1896 if (!test_opt(sbi, COMPRESS_CACHE))
1899 cpage = f2fs_pagecache_get_page(COMPRESS_MAPPING(sbi),
1900 blkaddr, FGP_LOCK | FGP_NOWAIT, GFP_NOFS);
1902 if (PageUptodate(cpage)) {
1903 atomic_inc(&sbi->compress_page_hit);
1904 memcpy(page_address(page),
1905 page_address(cpage), PAGE_SIZE);
1908 f2fs_put_page(cpage, 1);
1914 void f2fs_invalidate_compress_pages(struct f2fs_sb_info *sbi, nid_t ino)
1916 struct address_space *mapping = COMPRESS_MAPPING(sbi);
1917 struct folio_batch fbatch;
1919 pgoff_t end = MAX_BLKADDR(sbi);
1921 if (!mapping->nrpages)
1924 folio_batch_init(&fbatch);
1929 nr = filemap_get_folios(mapping, &index, end - 1, &fbatch);
1933 for (i = 0; i < nr; i++) {
1934 struct folio *folio = fbatch.folios[i];
1937 if (folio->mapping != mapping) {
1938 folio_unlock(folio);
1942 if (ino != get_page_private_data(&folio->page)) {
1943 folio_unlock(folio);
1947 generic_error_remove_page(mapping, &folio->page);
1948 folio_unlock(folio);
1950 folio_batch_release(&fbatch);
1952 } while (index < end);
1955 int f2fs_init_compress_inode(struct f2fs_sb_info *sbi)
1957 struct inode *inode;
1959 if (!test_opt(sbi, COMPRESS_CACHE))
1962 inode = f2fs_iget(sbi->sb, F2FS_COMPRESS_INO(sbi));
1964 return PTR_ERR(inode);
1965 sbi->compress_inode = inode;
1967 sbi->compress_percent = COMPRESS_PERCENT;
1968 sbi->compress_watermark = COMPRESS_WATERMARK;
1970 atomic_set(&sbi->compress_page_hit, 0);
1975 void f2fs_destroy_compress_inode(struct f2fs_sb_info *sbi)
1977 if (!sbi->compress_inode)
1979 iput(sbi->compress_inode);
1980 sbi->compress_inode = NULL;
1983 int f2fs_init_page_array_cache(struct f2fs_sb_info *sbi)
1985 dev_t dev = sbi->sb->s_bdev->bd_dev;
1988 if (!f2fs_sb_has_compression(sbi))
1991 sprintf(slab_name, "f2fs_page_array_entry-%u:%u", MAJOR(dev), MINOR(dev));
1993 sbi->page_array_slab_size = sizeof(struct page *) <<
1994 F2FS_OPTION(sbi).compress_log_size;
1996 sbi->page_array_slab = f2fs_kmem_cache_create(slab_name,
1997 sbi->page_array_slab_size);
1998 return sbi->page_array_slab ? 0 : -ENOMEM;
2001 void f2fs_destroy_page_array_cache(struct f2fs_sb_info *sbi)
2003 kmem_cache_destroy(sbi->page_array_slab);
2006 int __init f2fs_init_compress_cache(void)
2008 cic_entry_slab = f2fs_kmem_cache_create("f2fs_cic_entry",
2009 sizeof(struct compress_io_ctx));
2010 if (!cic_entry_slab)
2012 dic_entry_slab = f2fs_kmem_cache_create("f2fs_dic_entry",
2013 sizeof(struct decompress_io_ctx));
2014 if (!dic_entry_slab)
2018 kmem_cache_destroy(cic_entry_slab);
2022 void f2fs_destroy_compress_cache(void)
2024 kmem_cache_destroy(dic_entry_slab);
2025 kmem_cache_destroy(cic_entry_slab);