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);
60 static unsigned int offset_in_cluster(struct compress_ctx *cc, pgoff_t index)
62 return index & (cc->cluster_size - 1);
65 static pgoff_t cluster_idx(struct compress_ctx *cc, pgoff_t index)
67 return index >> cc->log_cluster_size;
70 static pgoff_t start_idx_of_cluster(struct compress_ctx *cc)
72 return cc->cluster_idx << cc->log_cluster_size;
75 bool f2fs_is_compressed_page(struct page *page)
77 if (!PagePrivate(page))
79 if (!page_private(page))
81 if (page_private_nonpointer(page))
84 f2fs_bug_on(F2FS_M_SB(page->mapping),
85 *((u32 *)page_private(page)) != F2FS_COMPRESSED_PAGE_MAGIC);
89 static void f2fs_set_compressed_page(struct page *page,
90 struct inode *inode, pgoff_t index, void *data)
92 attach_page_private(page, (void *)data);
94 /* i_crypto_info and iv index */
96 page->mapping = inode->i_mapping;
99 static void f2fs_drop_rpages(struct compress_ctx *cc, int len, bool unlock)
103 for (i = 0; i < len; i++) {
107 unlock_page(cc->rpages[i]);
109 put_page(cc->rpages[i]);
113 static void f2fs_put_rpages(struct compress_ctx *cc)
115 f2fs_drop_rpages(cc, cc->cluster_size, false);
118 static void f2fs_unlock_rpages(struct compress_ctx *cc, int len)
120 f2fs_drop_rpages(cc, len, true);
123 static void f2fs_put_rpages_wbc(struct compress_ctx *cc,
124 struct writeback_control *wbc, bool redirty, int unlock)
128 for (i = 0; i < cc->cluster_size; i++) {
132 redirty_page_for_writepage(wbc, cc->rpages[i]);
133 f2fs_put_page(cc->rpages[i], unlock);
137 struct page *f2fs_compress_control_page(struct page *page)
139 return ((struct compress_io_ctx *)page_private(page))->rpages[0];
142 int f2fs_init_compress_ctx(struct compress_ctx *cc)
147 cc->rpages = page_array_alloc(cc->inode, cc->cluster_size);
148 return cc->rpages ? 0 : -ENOMEM;
151 void f2fs_destroy_compress_ctx(struct compress_ctx *cc, bool reuse)
153 page_array_free(cc->inode, cc->rpages, cc->cluster_size);
157 cc->valid_nr_cpages = 0;
159 cc->cluster_idx = NULL_CLUSTER;
162 void f2fs_compress_ctx_add_page(struct compress_ctx *cc, struct page *page)
164 unsigned int cluster_ofs;
166 if (!f2fs_cluster_can_merge_page(cc, page->index))
167 f2fs_bug_on(F2FS_I_SB(cc->inode), 1);
169 cluster_ofs = offset_in_cluster(cc, page->index);
170 cc->rpages[cluster_ofs] = page;
172 cc->cluster_idx = cluster_idx(cc, page->index);
175 #ifdef CONFIG_F2FS_FS_LZO
176 static int lzo_init_compress_ctx(struct compress_ctx *cc)
178 cc->private = f2fs_kvmalloc(F2FS_I_SB(cc->inode),
179 LZO1X_MEM_COMPRESS, GFP_NOFS);
183 cc->clen = lzo1x_worst_compress(PAGE_SIZE << cc->log_cluster_size);
187 static void lzo_destroy_compress_ctx(struct compress_ctx *cc)
193 static int lzo_compress_pages(struct compress_ctx *cc)
197 ret = lzo1x_1_compress(cc->rbuf, cc->rlen, cc->cbuf->cdata,
198 &cc->clen, cc->private);
199 if (ret != LZO_E_OK) {
200 printk_ratelimited("%sF2FS-fs (%s): lzo compress failed, ret:%d\n",
201 KERN_ERR, F2FS_I_SB(cc->inode)->sb->s_id, ret);
207 static int lzo_decompress_pages(struct decompress_io_ctx *dic)
211 ret = lzo1x_decompress_safe(dic->cbuf->cdata, dic->clen,
212 dic->rbuf, &dic->rlen);
213 if (ret != LZO_E_OK) {
214 printk_ratelimited("%sF2FS-fs (%s): lzo decompress failed, ret:%d\n",
215 KERN_ERR, F2FS_I_SB(dic->inode)->sb->s_id, ret);
219 if (dic->rlen != PAGE_SIZE << dic->log_cluster_size) {
220 printk_ratelimited("%sF2FS-fs (%s): lzo invalid rlen:%zu, "
221 "expected:%lu\n", KERN_ERR,
222 F2FS_I_SB(dic->inode)->sb->s_id,
224 PAGE_SIZE << dic->log_cluster_size);
230 static const struct f2fs_compress_ops f2fs_lzo_ops = {
231 .init_compress_ctx = lzo_init_compress_ctx,
232 .destroy_compress_ctx = lzo_destroy_compress_ctx,
233 .compress_pages = lzo_compress_pages,
234 .decompress_pages = lzo_decompress_pages,
238 #ifdef CONFIG_F2FS_FS_LZ4
239 static int lz4_init_compress_ctx(struct compress_ctx *cc)
241 unsigned int size = LZ4_MEM_COMPRESS;
243 #ifdef CONFIG_F2FS_FS_LZ4HC
244 if (F2FS_I(cc->inode)->i_compress_flag >> COMPRESS_LEVEL_OFFSET)
245 size = LZ4HC_MEM_COMPRESS;
248 cc->private = f2fs_kvmalloc(F2FS_I_SB(cc->inode), size, GFP_NOFS);
253 * we do not change cc->clen to LZ4_compressBound(inputsize) to
254 * adapt worst compress case, because lz4 compressor can handle
255 * output budget properly.
257 cc->clen = cc->rlen - PAGE_SIZE - COMPRESS_HEADER_SIZE;
261 static void lz4_destroy_compress_ctx(struct compress_ctx *cc)
267 #ifdef CONFIG_F2FS_FS_LZ4HC
268 static int lz4hc_compress_pages(struct compress_ctx *cc)
270 unsigned char level = F2FS_I(cc->inode)->i_compress_flag >>
271 COMPRESS_LEVEL_OFFSET;
275 len = LZ4_compress_HC(cc->rbuf, cc->cbuf->cdata, cc->rlen,
276 cc->clen, level, cc->private);
278 len = LZ4_compress_default(cc->rbuf, cc->cbuf->cdata, cc->rlen,
279 cc->clen, cc->private);
288 static int lz4_compress_pages(struct compress_ctx *cc)
292 #ifdef CONFIG_F2FS_FS_LZ4HC
293 return lz4hc_compress_pages(cc);
295 len = LZ4_compress_default(cc->rbuf, cc->cbuf->cdata, cc->rlen,
296 cc->clen, cc->private);
304 static int lz4_decompress_pages(struct decompress_io_ctx *dic)
308 ret = LZ4_decompress_safe(dic->cbuf->cdata, dic->rbuf,
309 dic->clen, dic->rlen);
311 printk_ratelimited("%sF2FS-fs (%s): lz4 decompress failed, ret:%d\n",
312 KERN_ERR, F2FS_I_SB(dic->inode)->sb->s_id, ret);
316 if (ret != PAGE_SIZE << dic->log_cluster_size) {
317 printk_ratelimited("%sF2FS-fs (%s): lz4 invalid ret:%d, "
318 "expected:%lu\n", KERN_ERR,
319 F2FS_I_SB(dic->inode)->sb->s_id, ret,
320 PAGE_SIZE << dic->log_cluster_size);
326 static const struct f2fs_compress_ops f2fs_lz4_ops = {
327 .init_compress_ctx = lz4_init_compress_ctx,
328 .destroy_compress_ctx = lz4_destroy_compress_ctx,
329 .compress_pages = lz4_compress_pages,
330 .decompress_pages = lz4_decompress_pages,
334 #ifdef CONFIG_F2FS_FS_ZSTD
335 #define F2FS_ZSTD_DEFAULT_CLEVEL 1
337 static int zstd_init_compress_ctx(struct compress_ctx *cc)
339 zstd_parameters params;
340 zstd_cstream *stream;
342 unsigned int workspace_size;
343 unsigned char level = F2FS_I(cc->inode)->i_compress_flag >>
344 COMPRESS_LEVEL_OFFSET;
347 level = F2FS_ZSTD_DEFAULT_CLEVEL;
349 params = zstd_get_params(F2FS_ZSTD_DEFAULT_CLEVEL, cc->rlen);
350 workspace_size = zstd_cstream_workspace_bound(¶ms.cParams);
352 workspace = f2fs_kvmalloc(F2FS_I_SB(cc->inode),
353 workspace_size, GFP_NOFS);
357 stream = zstd_init_cstream(¶ms, 0, workspace, workspace_size);
359 printk_ratelimited("%sF2FS-fs (%s): %s zstd_init_cstream failed\n",
360 KERN_ERR, F2FS_I_SB(cc->inode)->sb->s_id,
366 cc->private = workspace;
367 cc->private2 = stream;
369 cc->clen = cc->rlen - PAGE_SIZE - COMPRESS_HEADER_SIZE;
373 static void zstd_destroy_compress_ctx(struct compress_ctx *cc)
380 static int zstd_compress_pages(struct compress_ctx *cc)
382 zstd_cstream *stream = cc->private2;
383 zstd_in_buffer inbuf;
384 zstd_out_buffer outbuf;
385 int src_size = cc->rlen;
386 int dst_size = src_size - PAGE_SIZE - COMPRESS_HEADER_SIZE;
390 inbuf.src = cc->rbuf;
391 inbuf.size = src_size;
394 outbuf.dst = cc->cbuf->cdata;
395 outbuf.size = dst_size;
397 ret = zstd_compress_stream(stream, &outbuf, &inbuf);
398 if (zstd_is_error(ret)) {
399 printk_ratelimited("%sF2FS-fs (%s): %s zstd_compress_stream failed, ret: %d\n",
400 KERN_ERR, F2FS_I_SB(cc->inode)->sb->s_id,
401 __func__, zstd_get_error_code(ret));
405 ret = zstd_end_stream(stream, &outbuf);
406 if (zstd_is_error(ret)) {
407 printk_ratelimited("%sF2FS-fs (%s): %s zstd_end_stream returned %d\n",
408 KERN_ERR, F2FS_I_SB(cc->inode)->sb->s_id,
409 __func__, zstd_get_error_code(ret));
414 * there is compressed data remained in intermediate buffer due to
415 * no more space in cbuf.cdata
420 cc->clen = outbuf.pos;
424 static int zstd_init_decompress_ctx(struct decompress_io_ctx *dic)
426 zstd_dstream *stream;
428 unsigned int workspace_size;
429 unsigned int max_window_size =
430 MAX_COMPRESS_WINDOW_SIZE(dic->log_cluster_size);
432 workspace_size = zstd_dstream_workspace_bound(max_window_size);
434 workspace = f2fs_kvmalloc(F2FS_I_SB(dic->inode),
435 workspace_size, GFP_NOFS);
439 stream = zstd_init_dstream(max_window_size, workspace, workspace_size);
441 printk_ratelimited("%sF2FS-fs (%s): %s zstd_init_dstream failed\n",
442 KERN_ERR, F2FS_I_SB(dic->inode)->sb->s_id,
448 dic->private = workspace;
449 dic->private2 = stream;
454 static void zstd_destroy_decompress_ctx(struct decompress_io_ctx *dic)
456 kvfree(dic->private);
458 dic->private2 = NULL;
461 static int zstd_decompress_pages(struct decompress_io_ctx *dic)
463 zstd_dstream *stream = dic->private2;
464 zstd_in_buffer inbuf;
465 zstd_out_buffer outbuf;
469 inbuf.src = dic->cbuf->cdata;
470 inbuf.size = dic->clen;
473 outbuf.dst = dic->rbuf;
474 outbuf.size = dic->rlen;
476 ret = zstd_decompress_stream(stream, &outbuf, &inbuf);
477 if (zstd_is_error(ret)) {
478 printk_ratelimited("%sF2FS-fs (%s): %s zstd_decompress_stream failed, ret: %d\n",
479 KERN_ERR, F2FS_I_SB(dic->inode)->sb->s_id,
480 __func__, zstd_get_error_code(ret));
484 if (dic->rlen != outbuf.pos) {
485 printk_ratelimited("%sF2FS-fs (%s): %s ZSTD invalid rlen:%zu, "
486 "expected:%lu\n", KERN_ERR,
487 F2FS_I_SB(dic->inode)->sb->s_id,
489 PAGE_SIZE << dic->log_cluster_size);
496 static const struct f2fs_compress_ops f2fs_zstd_ops = {
497 .init_compress_ctx = zstd_init_compress_ctx,
498 .destroy_compress_ctx = zstd_destroy_compress_ctx,
499 .compress_pages = zstd_compress_pages,
500 .init_decompress_ctx = zstd_init_decompress_ctx,
501 .destroy_decompress_ctx = zstd_destroy_decompress_ctx,
502 .decompress_pages = zstd_decompress_pages,
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 static mempool_t *compress_page_pool;
562 static int num_compress_pages = 512;
563 module_param(num_compress_pages, uint, 0444);
564 MODULE_PARM_DESC(num_compress_pages,
565 "Number of intermediate compress pages to preallocate");
567 int f2fs_init_compress_mempool(void)
569 compress_page_pool = mempool_create_page_pool(num_compress_pages, 0);
570 if (!compress_page_pool)
576 void f2fs_destroy_compress_mempool(void)
578 mempool_destroy(compress_page_pool);
581 static struct page *f2fs_compress_alloc_page(void)
585 page = mempool_alloc(compress_page_pool, GFP_NOFS);
591 static void f2fs_compress_free_page(struct page *page)
595 detach_page_private(page);
596 page->mapping = NULL;
598 mempool_free(page, compress_page_pool);
601 #define MAX_VMAP_RETRIES 3
603 static void *f2fs_vmap(struct page **pages, unsigned int count)
608 for (i = 0; i < MAX_VMAP_RETRIES; i++) {
609 buf = vm_map_ram(pages, count, -1);
617 static int f2fs_compress_pages(struct compress_ctx *cc)
619 struct f2fs_inode_info *fi = F2FS_I(cc->inode);
620 const struct f2fs_compress_ops *cops =
621 f2fs_cops[fi->i_compress_algorithm];
622 unsigned int max_len, new_nr_cpages;
626 trace_f2fs_compress_pages_start(cc->inode, cc->cluster_idx,
627 cc->cluster_size, fi->i_compress_algorithm);
629 if (cops->init_compress_ctx) {
630 ret = cops->init_compress_ctx(cc);
635 max_len = COMPRESS_HEADER_SIZE + cc->clen;
636 cc->nr_cpages = DIV_ROUND_UP(max_len, PAGE_SIZE);
637 cc->valid_nr_cpages = cc->nr_cpages;
639 cc->cpages = page_array_alloc(cc->inode, cc->nr_cpages);
642 goto destroy_compress_ctx;
645 for (i = 0; i < cc->nr_cpages; i++) {
646 cc->cpages[i] = f2fs_compress_alloc_page();
647 if (!cc->cpages[i]) {
649 goto out_free_cpages;
653 cc->rbuf = f2fs_vmap(cc->rpages, cc->cluster_size);
656 goto out_free_cpages;
659 cc->cbuf = f2fs_vmap(cc->cpages, cc->nr_cpages);
662 goto out_vunmap_rbuf;
665 ret = cops->compress_pages(cc);
667 goto out_vunmap_cbuf;
669 max_len = PAGE_SIZE * (cc->cluster_size - 1) - COMPRESS_HEADER_SIZE;
671 if (cc->clen > max_len) {
673 goto out_vunmap_cbuf;
676 cc->cbuf->clen = cpu_to_le32(cc->clen);
678 if (fi->i_compress_flag & 1 << COMPRESS_CHKSUM)
679 chksum = f2fs_crc32(F2FS_I_SB(cc->inode),
680 cc->cbuf->cdata, cc->clen);
681 cc->cbuf->chksum = cpu_to_le32(chksum);
683 for (i = 0; i < COMPRESS_DATA_RESERVED_SIZE; i++)
684 cc->cbuf->reserved[i] = cpu_to_le32(0);
686 new_nr_cpages = DIV_ROUND_UP(cc->clen + COMPRESS_HEADER_SIZE, PAGE_SIZE);
688 /* zero out any unused part of the last page */
689 memset(&cc->cbuf->cdata[cc->clen], 0,
690 (new_nr_cpages * PAGE_SIZE) -
691 (cc->clen + COMPRESS_HEADER_SIZE));
693 vm_unmap_ram(cc->cbuf, cc->nr_cpages);
694 vm_unmap_ram(cc->rbuf, cc->cluster_size);
696 for (i = 0; i < cc->nr_cpages; i++) {
697 if (i < new_nr_cpages)
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) {
768 ret = cops->decompress_pages(dic);
770 if (!ret && (fi->i_compress_flag & 1 << COMPRESS_CHKSUM)) {
771 u32 provided = le32_to_cpu(dic->cbuf->chksum);
772 u32 calculated = f2fs_crc32(sbi, dic->cbuf->cdata, dic->clen);
774 if (provided != calculated) {
775 if (!is_inode_flag_set(dic->inode, FI_COMPRESS_CORRUPT)) {
776 set_inode_flag(dic->inode, FI_COMPRESS_CORRUPT);
778 "%sF2FS-fs (%s): checksum invalid, nid = %lu, %x vs %x",
779 KERN_INFO, sbi->sb->s_id, dic->inode->i_ino,
780 provided, calculated);
782 set_sbi_flag(sbi, SBI_NEED_FSCK);
787 f2fs_release_decomp_mem(dic, bypass_callback, false);
790 trace_f2fs_decompress_pages_end(dic->inode, dic->cluster_idx,
792 f2fs_decompress_end_io(dic, ret, in_task);
796 * This is called when a page of a compressed cluster has been read from disk
797 * (or failed to be read from disk). It checks whether this page was the last
798 * page being waited on in the cluster, and if so, it decompresses the cluster
799 * (or in the case of a failure, cleans up without actually decompressing).
801 void f2fs_end_read_compressed_page(struct page *page, bool failed,
802 block_t blkaddr, bool in_task)
804 struct decompress_io_ctx *dic =
805 (struct decompress_io_ctx *)page_private(page);
806 struct f2fs_sb_info *sbi = F2FS_I_SB(dic->inode);
808 dec_page_count(sbi, F2FS_RD_DATA);
811 WRITE_ONCE(dic->failed, true);
812 else if (blkaddr && in_task)
813 f2fs_cache_compressed_page(sbi, page,
814 dic->inode->i_ino, blkaddr);
816 if (atomic_dec_and_test(&dic->remaining_pages))
817 f2fs_decompress_cluster(dic, in_task);
820 static bool is_page_in_cluster(struct compress_ctx *cc, pgoff_t index)
822 if (cc->cluster_idx == NULL_CLUSTER)
824 return cc->cluster_idx == cluster_idx(cc, index);
827 bool f2fs_cluster_is_empty(struct compress_ctx *cc)
829 return cc->nr_rpages == 0;
832 static bool f2fs_cluster_is_full(struct compress_ctx *cc)
834 return cc->cluster_size == cc->nr_rpages;
837 bool f2fs_cluster_can_merge_page(struct compress_ctx *cc, pgoff_t index)
839 if (f2fs_cluster_is_empty(cc))
841 return is_page_in_cluster(cc, index);
844 bool f2fs_all_cluster_page_ready(struct compress_ctx *cc, struct page **pages,
845 int index, int nr_pages, bool uptodate)
847 unsigned long pgidx = pages[index]->index;
848 int i = uptodate ? 0 : 1;
851 * when uptodate set to true, try to check all pages in cluster is
854 if (uptodate && (pgidx % cc->cluster_size))
857 if (nr_pages - index < cc->cluster_size)
860 for (; i < cc->cluster_size; i++) {
861 if (pages[index + i]->index != pgidx + i)
863 if (uptodate && !PageUptodate(pages[index + i]))
870 static bool cluster_has_invalid_data(struct compress_ctx *cc)
872 loff_t i_size = i_size_read(cc->inode);
873 unsigned nr_pages = DIV_ROUND_UP(i_size, PAGE_SIZE);
876 for (i = 0; i < cc->cluster_size; i++) {
877 struct page *page = cc->rpages[i];
879 f2fs_bug_on(F2FS_I_SB(cc->inode), !page);
882 if (page->index >= nr_pages)
888 bool f2fs_sanity_check_cluster(struct dnode_of_data *dn)
890 struct f2fs_sb_info *sbi = F2FS_I_SB(dn->inode);
891 unsigned int cluster_size = F2FS_I(dn->inode)->i_cluster_size;
892 bool compressed = dn->data_blkaddr == COMPRESS_ADDR;
900 /* [..., COMPR_ADDR, ...] */
901 if (dn->ofs_in_node % cluster_size) {
902 reason = "[*|C|*|*]";
906 for (i = 1; i < cluster_size; i++) {
907 block_t blkaddr = data_blkaddr(dn->inode, dn->node_page,
908 dn->ofs_in_node + i);
910 /* [COMPR_ADDR, ..., COMPR_ADDR] */
911 if (blkaddr == COMPRESS_ADDR) {
912 reason = "[C|*|C|*]";
916 if (!__is_valid_data_blkaddr(blkaddr)) {
921 /* [COMPR_ADDR, NULL_ADDR or NEW_ADDR, valid_blkaddr] */
923 reason = "[C|N|N|V]";
930 f2fs_warn(sbi, "access invalid cluster, ino:%lu, nid:%u, ofs_in_node:%u, reason:%s",
931 dn->inode->i_ino, dn->nid, dn->ofs_in_node, reason);
932 set_sbi_flag(sbi, SBI_NEED_FSCK);
936 static int __f2fs_cluster_blocks(struct inode *inode,
937 unsigned int cluster_idx, bool compr)
939 struct dnode_of_data dn;
940 unsigned int cluster_size = F2FS_I(inode)->i_cluster_size;
941 unsigned int start_idx = cluster_idx <<
942 F2FS_I(inode)->i_log_cluster_size;
945 set_new_dnode(&dn, inode, NULL, NULL, 0);
946 ret = f2fs_get_dnode_of_data(&dn, start_idx, LOOKUP_NODE);
953 if (f2fs_sanity_check_cluster(&dn)) {
958 if (dn.data_blkaddr == COMPRESS_ADDR) {
962 for (i = 1; i < cluster_size; i++) {
965 blkaddr = data_blkaddr(dn.inode,
966 dn.node_page, dn.ofs_in_node + i);
968 if (__is_valid_data_blkaddr(blkaddr))
971 if (blkaddr != NULL_ADDR)
976 f2fs_bug_on(F2FS_I_SB(inode),
977 !compr && ret != cluster_size &&
978 !is_inode_flag_set(inode, FI_COMPRESS_RELEASED));
985 /* return # of compressed blocks in compressed cluster */
986 static int f2fs_compressed_blocks(struct compress_ctx *cc)
988 return __f2fs_cluster_blocks(cc->inode, cc->cluster_idx, true);
991 /* return # of valid blocks in compressed cluster */
992 int f2fs_is_compressed_cluster(struct inode *inode, pgoff_t index)
994 return __f2fs_cluster_blocks(inode,
995 index >> F2FS_I(inode)->i_log_cluster_size,
999 static bool cluster_may_compress(struct compress_ctx *cc)
1001 if (!f2fs_need_compress_data(cc->inode))
1003 if (f2fs_is_atomic_file(cc->inode))
1005 if (!f2fs_cluster_is_full(cc))
1007 if (unlikely(f2fs_cp_error(F2FS_I_SB(cc->inode))))
1009 return !cluster_has_invalid_data(cc);
1012 static void set_cluster_writeback(struct compress_ctx *cc)
1016 for (i = 0; i < cc->cluster_size; i++) {
1018 set_page_writeback(cc->rpages[i]);
1022 static void set_cluster_dirty(struct compress_ctx *cc)
1026 for (i = 0; i < cc->cluster_size; i++)
1028 set_page_dirty(cc->rpages[i]);
1031 static int prepare_compress_overwrite(struct compress_ctx *cc,
1032 struct page **pagep, pgoff_t index, void **fsdata)
1034 struct f2fs_sb_info *sbi = F2FS_I_SB(cc->inode);
1035 struct address_space *mapping = cc->inode->i_mapping;
1037 sector_t last_block_in_bio;
1038 unsigned fgp_flag = FGP_LOCK | FGP_WRITE | FGP_CREAT;
1039 pgoff_t start_idx = start_idx_of_cluster(cc);
1043 ret = f2fs_is_compressed_cluster(cc->inode, start_idx);
1047 ret = f2fs_init_compress_ctx(cc);
1051 /* keep page reference to avoid page reclaim */
1052 for (i = 0; i < cc->cluster_size; i++) {
1053 page = f2fs_pagecache_get_page(mapping, start_idx + i,
1054 fgp_flag, GFP_NOFS);
1060 if (PageUptodate(page))
1061 f2fs_put_page(page, 1);
1063 f2fs_compress_ctx_add_page(cc, page);
1066 if (!f2fs_cluster_is_empty(cc)) {
1067 struct bio *bio = NULL;
1069 ret = f2fs_read_multi_pages(cc, &bio, cc->cluster_size,
1070 &last_block_in_bio, false, true);
1071 f2fs_put_rpages(cc);
1072 f2fs_destroy_compress_ctx(cc, true);
1076 f2fs_submit_bio(sbi, bio, DATA);
1078 ret = f2fs_init_compress_ctx(cc);
1083 for (i = 0; i < cc->cluster_size; i++) {
1084 f2fs_bug_on(sbi, cc->rpages[i]);
1086 page = find_lock_page(mapping, start_idx + i);
1088 /* page can be truncated */
1089 goto release_and_retry;
1092 f2fs_wait_on_page_writeback(page, DATA, true, true);
1093 f2fs_compress_ctx_add_page(cc, page);
1095 if (!PageUptodate(page)) {
1097 f2fs_put_rpages(cc);
1098 f2fs_unlock_rpages(cc, i + 1);
1099 f2fs_destroy_compress_ctx(cc, true);
1105 *fsdata = cc->rpages;
1106 *pagep = cc->rpages[offset_in_cluster(cc, index)];
1107 return cc->cluster_size;
1111 f2fs_put_rpages(cc);
1112 f2fs_unlock_rpages(cc, i);
1113 f2fs_destroy_compress_ctx(cc, true);
1118 int f2fs_prepare_compress_overwrite(struct inode *inode,
1119 struct page **pagep, pgoff_t index, void **fsdata)
1121 struct compress_ctx cc = {
1123 .log_cluster_size = F2FS_I(inode)->i_log_cluster_size,
1124 .cluster_size = F2FS_I(inode)->i_cluster_size,
1125 .cluster_idx = index >> F2FS_I(inode)->i_log_cluster_size,
1130 return prepare_compress_overwrite(&cc, pagep, index, fsdata);
1133 bool f2fs_compress_write_end(struct inode *inode, void *fsdata,
1134 pgoff_t index, unsigned copied)
1137 struct compress_ctx cc = {
1139 .log_cluster_size = F2FS_I(inode)->i_log_cluster_size,
1140 .cluster_size = F2FS_I(inode)->i_cluster_size,
1143 bool first_index = (index == cc.rpages[0]->index);
1146 set_cluster_dirty(&cc);
1148 f2fs_put_rpages_wbc(&cc, NULL, false, 1);
1149 f2fs_destroy_compress_ctx(&cc, false);
1154 int f2fs_truncate_partial_cluster(struct inode *inode, u64 from, bool lock)
1156 void *fsdata = NULL;
1158 int log_cluster_size = F2FS_I(inode)->i_log_cluster_size;
1159 pgoff_t start_idx = from >> (PAGE_SHIFT + log_cluster_size) <<
1163 err = f2fs_is_compressed_cluster(inode, start_idx);
1167 /* truncate normal cluster */
1169 return f2fs_do_truncate_blocks(inode, from, lock);
1171 /* truncate compressed cluster */
1172 err = f2fs_prepare_compress_overwrite(inode, &pagep,
1173 start_idx, &fsdata);
1175 /* should not be a normal cluster */
1176 f2fs_bug_on(F2FS_I_SB(inode), err == 0);
1182 struct page **rpages = fsdata;
1183 int cluster_size = F2FS_I(inode)->i_cluster_size;
1186 for (i = cluster_size - 1; i >= 0; i--) {
1187 loff_t start = rpages[i]->index << PAGE_SHIFT;
1189 if (from <= start) {
1190 zero_user_segment(rpages[i], 0, PAGE_SIZE);
1192 zero_user_segment(rpages[i], from - start,
1198 f2fs_compress_write_end(inode, fsdata, start_idx, true);
1203 static int f2fs_write_compressed_pages(struct compress_ctx *cc,
1205 struct writeback_control *wbc,
1206 enum iostat_type io_type)
1208 struct inode *inode = cc->inode;
1209 struct f2fs_sb_info *sbi = F2FS_I_SB(inode);
1210 struct f2fs_inode_info *fi = F2FS_I(inode);
1211 struct f2fs_io_info fio = {
1213 .ino = cc->inode->i_ino,
1216 .op_flags = wbc_to_write_flags(wbc),
1217 .old_blkaddr = NEW_ADDR,
1219 .encrypted_page = NULL,
1220 .compressed_page = NULL,
1224 .encrypted = fscrypt_inode_uses_fs_layer_crypto(cc->inode),
1226 struct dnode_of_data dn;
1227 struct node_info ni;
1228 struct compress_io_ctx *cic;
1229 pgoff_t start_idx = start_idx_of_cluster(cc);
1230 unsigned int last_index = cc->cluster_size - 1;
1234 /* we should bypass data pages to proceed the kworkder jobs */
1235 if (unlikely(f2fs_cp_error(sbi))) {
1236 mapping_set_error(cc->rpages[0]->mapping, -EIO);
1240 if (IS_NOQUOTA(inode)) {
1242 * We need to wait for node_write to avoid block allocation during
1243 * checkpoint. This can only happen to quota writes which can cause
1244 * the below discard race condition.
1246 f2fs_down_read(&sbi->node_write);
1247 } else if (!f2fs_trylock_op(sbi)) {
1251 set_new_dnode(&dn, cc->inode, NULL, NULL, 0);
1253 err = f2fs_get_dnode_of_data(&dn, start_idx, LOOKUP_NODE);
1257 for (i = 0; i < cc->cluster_size; i++) {
1258 if (data_blkaddr(dn.inode, dn.node_page,
1259 dn.ofs_in_node + i) == NULL_ADDR)
1263 psize = (loff_t)(cc->rpages[last_index]->index + 1) << PAGE_SHIFT;
1265 err = f2fs_get_node_info(fio.sbi, dn.nid, &ni, false);
1269 fio.version = ni.version;
1271 cic = f2fs_kmem_cache_alloc(cic_entry_slab, GFP_F2FS_ZERO, false, sbi);
1275 cic->magic = F2FS_COMPRESSED_PAGE_MAGIC;
1277 atomic_set(&cic->pending_pages, cc->valid_nr_cpages);
1278 cic->rpages = page_array_alloc(cc->inode, cc->cluster_size);
1282 cic->nr_rpages = cc->cluster_size;
1284 for (i = 0; i < cc->valid_nr_cpages; i++) {
1285 f2fs_set_compressed_page(cc->cpages[i], inode,
1286 cc->rpages[i + 1]->index, cic);
1287 fio.compressed_page = cc->cpages[i];
1289 fio.old_blkaddr = data_blkaddr(dn.inode, dn.node_page,
1290 dn.ofs_in_node + i + 1);
1292 /* wait for GCed page writeback via META_MAPPING */
1293 f2fs_wait_on_block_writeback(inode, fio.old_blkaddr);
1295 if (fio.encrypted) {
1296 fio.page = cc->rpages[i + 1];
1297 err = f2fs_encrypt_one_page(&fio);
1299 goto out_destroy_crypt;
1300 cc->cpages[i] = fio.encrypted_page;
1304 set_cluster_writeback(cc);
1306 for (i = 0; i < cc->cluster_size; i++)
1307 cic->rpages[i] = cc->rpages[i];
1309 for (i = 0; i < cc->cluster_size; i++, dn.ofs_in_node++) {
1312 blkaddr = f2fs_data_blkaddr(&dn);
1313 fio.page = cc->rpages[i];
1314 fio.old_blkaddr = blkaddr;
1316 /* cluster header */
1318 if (blkaddr == COMPRESS_ADDR)
1320 if (__is_valid_data_blkaddr(blkaddr))
1321 f2fs_invalidate_blocks(sbi, blkaddr);
1322 f2fs_update_data_blkaddr(&dn, COMPRESS_ADDR);
1323 goto unlock_continue;
1326 if (fio.compr_blocks && __is_valid_data_blkaddr(blkaddr))
1329 if (i > cc->valid_nr_cpages) {
1330 if (__is_valid_data_blkaddr(blkaddr)) {
1331 f2fs_invalidate_blocks(sbi, blkaddr);
1332 f2fs_update_data_blkaddr(&dn, NEW_ADDR);
1334 goto unlock_continue;
1337 f2fs_bug_on(fio.sbi, blkaddr == NULL_ADDR);
1340 fio.encrypted_page = cc->cpages[i - 1];
1342 fio.compressed_page = cc->cpages[i - 1];
1344 cc->cpages[i - 1] = NULL;
1345 f2fs_outplace_write_data(&dn, &fio);
1348 inode_dec_dirty_pages(cc->inode);
1349 unlock_page(fio.page);
1352 if (fio.compr_blocks)
1353 f2fs_i_compr_blocks_update(inode, fio.compr_blocks - 1, false);
1354 f2fs_i_compr_blocks_update(inode, cc->valid_nr_cpages, true);
1355 add_compr_block_stat(inode, cc->valid_nr_cpages);
1357 set_inode_flag(cc->inode, FI_APPEND_WRITE);
1358 if (cc->cluster_idx == 0)
1359 set_inode_flag(inode, FI_FIRST_BLOCK_WRITTEN);
1361 f2fs_put_dnode(&dn);
1362 if (IS_NOQUOTA(inode))
1363 f2fs_up_read(&sbi->node_write);
1365 f2fs_unlock_op(sbi);
1367 spin_lock(&fi->i_size_lock);
1368 if (fi->last_disk_size < psize)
1369 fi->last_disk_size = psize;
1370 spin_unlock(&fi->i_size_lock);
1372 f2fs_put_rpages(cc);
1373 page_array_free(cc->inode, cc->cpages, cc->nr_cpages);
1375 f2fs_destroy_compress_ctx(cc, false);
1379 page_array_free(cc->inode, cic->rpages, cc->cluster_size);
1381 for (--i; i >= 0; i--)
1382 fscrypt_finalize_bounce_page(&cc->cpages[i]);
1384 kmem_cache_free(cic_entry_slab, cic);
1386 f2fs_put_dnode(&dn);
1388 if (IS_NOQUOTA(inode))
1389 f2fs_up_read(&sbi->node_write);
1391 f2fs_unlock_op(sbi);
1393 for (i = 0; i < cc->valid_nr_cpages; i++) {
1394 f2fs_compress_free_page(cc->cpages[i]);
1395 cc->cpages[i] = NULL;
1397 page_array_free(cc->inode, cc->cpages, cc->nr_cpages);
1402 void f2fs_compress_write_end_io(struct bio *bio, struct page *page)
1404 struct f2fs_sb_info *sbi = bio->bi_private;
1405 struct compress_io_ctx *cic =
1406 (struct compress_io_ctx *)page_private(page);
1409 if (unlikely(bio->bi_status))
1410 mapping_set_error(cic->inode->i_mapping, -EIO);
1412 f2fs_compress_free_page(page);
1414 dec_page_count(sbi, F2FS_WB_DATA);
1416 if (atomic_dec_return(&cic->pending_pages))
1419 for (i = 0; i < cic->nr_rpages; i++) {
1420 WARN_ON(!cic->rpages[i]);
1421 clear_page_private_gcing(cic->rpages[i]);
1422 end_page_writeback(cic->rpages[i]);
1425 page_array_free(cic->inode, cic->rpages, cic->nr_rpages);
1426 kmem_cache_free(cic_entry_slab, cic);
1429 static int f2fs_write_raw_pages(struct compress_ctx *cc,
1431 struct writeback_control *wbc,
1432 enum iostat_type io_type)
1434 struct address_space *mapping = cc->inode->i_mapping;
1435 int _submitted, compr_blocks, ret, i;
1437 compr_blocks = f2fs_compressed_blocks(cc);
1439 for (i = 0; i < cc->cluster_size; i++) {
1443 redirty_page_for_writepage(wbc, cc->rpages[i]);
1444 unlock_page(cc->rpages[i]);
1447 if (compr_blocks < 0)
1448 return compr_blocks;
1450 for (i = 0; i < cc->cluster_size; i++) {
1454 lock_page(cc->rpages[i]);
1456 if (cc->rpages[i]->mapping != mapping) {
1458 unlock_page(cc->rpages[i]);
1462 if (!PageDirty(cc->rpages[i]))
1463 goto continue_unlock;
1465 if (!clear_page_dirty_for_io(cc->rpages[i]))
1466 goto continue_unlock;
1468 ret = f2fs_write_single_data_page(cc->rpages[i], &_submitted,
1469 NULL, NULL, wbc, io_type,
1470 compr_blocks, false);
1472 if (ret == AOP_WRITEPAGE_ACTIVATE) {
1473 unlock_page(cc->rpages[i]);
1475 } else if (ret == -EAGAIN) {
1477 * for quota file, just redirty left pages to
1478 * avoid deadlock caused by cluster update race
1479 * from foreground operation.
1481 if (IS_NOQUOTA(cc->inode))
1484 f2fs_io_schedule_timeout(DEFAULT_IO_TIMEOUT);
1490 *submitted += _submitted;
1493 f2fs_balance_fs(F2FS_M_SB(mapping), true);
1498 int f2fs_write_multi_pages(struct compress_ctx *cc,
1500 struct writeback_control *wbc,
1501 enum iostat_type io_type)
1506 if (cluster_may_compress(cc)) {
1507 err = f2fs_compress_pages(cc);
1508 if (err == -EAGAIN) {
1509 add_compr_block_stat(cc->inode, cc->cluster_size);
1512 f2fs_put_rpages_wbc(cc, wbc, true, 1);
1516 err = f2fs_write_compressed_pages(cc, submitted,
1520 f2fs_bug_on(F2FS_I_SB(cc->inode), err != -EAGAIN);
1523 f2fs_bug_on(F2FS_I_SB(cc->inode), *submitted);
1525 err = f2fs_write_raw_pages(cc, submitted, wbc, io_type);
1526 f2fs_put_rpages_wbc(cc, wbc, false, 0);
1528 f2fs_destroy_compress_ctx(cc, false);
1532 static inline bool allow_memalloc_for_decomp(struct f2fs_sb_info *sbi,
1535 return pre_alloc ^ f2fs_low_mem_mode(sbi);
1538 static int f2fs_prepare_decomp_mem(struct decompress_io_ctx *dic,
1541 const struct f2fs_compress_ops *cops =
1542 f2fs_cops[F2FS_I(dic->inode)->i_compress_algorithm];
1545 if (!allow_memalloc_for_decomp(F2FS_I_SB(dic->inode), pre_alloc))
1548 dic->tpages = page_array_alloc(dic->inode, dic->cluster_size);
1552 for (i = 0; i < dic->cluster_size; i++) {
1553 if (dic->rpages[i]) {
1554 dic->tpages[i] = dic->rpages[i];
1558 dic->tpages[i] = f2fs_compress_alloc_page();
1559 if (!dic->tpages[i])
1563 dic->rbuf = f2fs_vmap(dic->tpages, dic->cluster_size);
1567 dic->cbuf = f2fs_vmap(dic->cpages, dic->nr_cpages);
1571 if (cops->init_decompress_ctx) {
1572 int ret = cops->init_decompress_ctx(dic);
1581 static void f2fs_release_decomp_mem(struct decompress_io_ctx *dic,
1582 bool bypass_destroy_callback, bool pre_alloc)
1584 const struct f2fs_compress_ops *cops =
1585 f2fs_cops[F2FS_I(dic->inode)->i_compress_algorithm];
1587 if (!allow_memalloc_for_decomp(F2FS_I_SB(dic->inode), pre_alloc))
1590 if (!bypass_destroy_callback && cops->destroy_decompress_ctx)
1591 cops->destroy_decompress_ctx(dic);
1594 vm_unmap_ram(dic->cbuf, dic->nr_cpages);
1597 vm_unmap_ram(dic->rbuf, dic->cluster_size);
1600 static void f2fs_free_dic(struct decompress_io_ctx *dic,
1601 bool bypass_destroy_callback);
1603 struct decompress_io_ctx *f2fs_alloc_dic(struct compress_ctx *cc)
1605 struct decompress_io_ctx *dic;
1606 pgoff_t start_idx = start_idx_of_cluster(cc);
1607 struct f2fs_sb_info *sbi = F2FS_I_SB(cc->inode);
1610 dic = f2fs_kmem_cache_alloc(dic_entry_slab, GFP_F2FS_ZERO, false, sbi);
1612 return ERR_PTR(-ENOMEM);
1614 dic->rpages = page_array_alloc(cc->inode, cc->cluster_size);
1616 kmem_cache_free(dic_entry_slab, dic);
1617 return ERR_PTR(-ENOMEM);
1620 dic->magic = F2FS_COMPRESSED_PAGE_MAGIC;
1621 dic->inode = cc->inode;
1622 atomic_set(&dic->remaining_pages, cc->nr_cpages);
1623 dic->cluster_idx = cc->cluster_idx;
1624 dic->cluster_size = cc->cluster_size;
1625 dic->log_cluster_size = cc->log_cluster_size;
1626 dic->nr_cpages = cc->nr_cpages;
1627 refcount_set(&dic->refcnt, 1);
1628 dic->failed = false;
1629 dic->need_verity = f2fs_need_verity(cc->inode, start_idx);
1631 for (i = 0; i < dic->cluster_size; i++)
1632 dic->rpages[i] = cc->rpages[i];
1633 dic->nr_rpages = cc->cluster_size;
1635 dic->cpages = page_array_alloc(dic->inode, dic->nr_cpages);
1641 for (i = 0; i < dic->nr_cpages; i++) {
1644 page = f2fs_compress_alloc_page();
1650 f2fs_set_compressed_page(page, cc->inode,
1651 start_idx + i + 1, dic);
1652 dic->cpages[i] = page;
1655 ret = f2fs_prepare_decomp_mem(dic, true);
1662 f2fs_free_dic(dic, true);
1663 return ERR_PTR(ret);
1666 static void f2fs_free_dic(struct decompress_io_ctx *dic,
1667 bool bypass_destroy_callback)
1671 f2fs_release_decomp_mem(dic, bypass_destroy_callback, true);
1674 for (i = 0; i < dic->cluster_size; i++) {
1677 if (!dic->tpages[i])
1679 f2fs_compress_free_page(dic->tpages[i]);
1681 page_array_free(dic->inode, dic->tpages, dic->cluster_size);
1685 for (i = 0; i < dic->nr_cpages; i++) {
1686 if (!dic->cpages[i])
1688 f2fs_compress_free_page(dic->cpages[i]);
1690 page_array_free(dic->inode, dic->cpages, dic->nr_cpages);
1693 page_array_free(dic->inode, dic->rpages, dic->nr_rpages);
1694 kmem_cache_free(dic_entry_slab, dic);
1697 static void f2fs_late_free_dic(struct work_struct *work)
1699 struct decompress_io_ctx *dic =
1700 container_of(work, struct decompress_io_ctx, free_work);
1702 f2fs_free_dic(dic, false);
1705 static void f2fs_put_dic(struct decompress_io_ctx *dic, bool in_task)
1707 if (refcount_dec_and_test(&dic->refcnt)) {
1709 f2fs_free_dic(dic, false);
1711 INIT_WORK(&dic->free_work, f2fs_late_free_dic);
1712 queue_work(F2FS_I_SB(dic->inode)->post_read_wq,
1719 * Update and unlock the cluster's pagecache pages, and release the reference to
1720 * the decompress_io_ctx that was being held for I/O completion.
1722 static void __f2fs_decompress_end_io(struct decompress_io_ctx *dic, bool failed,
1727 for (i = 0; i < dic->cluster_size; i++) {
1728 struct page *rpage = dic->rpages[i];
1733 /* PG_error was set if verity failed. */
1734 if (failed || PageError(rpage)) {
1735 ClearPageUptodate(rpage);
1736 /* will re-read again later */
1737 ClearPageError(rpage);
1739 SetPageUptodate(rpage);
1744 f2fs_put_dic(dic, in_task);
1747 static void f2fs_verify_cluster(struct work_struct *work)
1749 struct decompress_io_ctx *dic =
1750 container_of(work, struct decompress_io_ctx, verity_work);
1753 /* Verify the cluster's decompressed pages with fs-verity. */
1754 for (i = 0; i < dic->cluster_size; i++) {
1755 struct page *rpage = dic->rpages[i];
1757 if (rpage && !fsverity_verify_page(rpage))
1758 SetPageError(rpage);
1761 __f2fs_decompress_end_io(dic, false, true);
1765 * This is called when a compressed cluster has been decompressed
1766 * (or failed to be read and/or decompressed).
1768 void f2fs_decompress_end_io(struct decompress_io_ctx *dic, bool failed,
1771 if (!failed && dic->need_verity) {
1773 * Note that to avoid deadlocks, the verity work can't be done
1774 * on the decompression workqueue. This is because verifying
1775 * the data pages can involve reading metadata pages from the
1776 * file, and these metadata pages may be compressed.
1778 INIT_WORK(&dic->verity_work, f2fs_verify_cluster);
1779 fsverity_enqueue_verify_work(&dic->verity_work);
1781 __f2fs_decompress_end_io(dic, failed, in_task);
1786 * Put a reference to a compressed page's decompress_io_ctx.
1788 * This is called when the page is no longer needed and can be freed.
1790 void f2fs_put_page_dic(struct page *page, bool in_task)
1792 struct decompress_io_ctx *dic =
1793 (struct decompress_io_ctx *)page_private(page);
1795 f2fs_put_dic(dic, in_task);
1799 * check whether cluster blocks are contiguous, and add extent cache entry
1800 * only if cluster blocks are logically and physically contiguous.
1802 unsigned int f2fs_cluster_blocks_are_contiguous(struct dnode_of_data *dn)
1804 bool compressed = f2fs_data_blkaddr(dn) == COMPRESS_ADDR;
1805 int i = compressed ? 1 : 0;
1806 block_t first_blkaddr = data_blkaddr(dn->inode, dn->node_page,
1807 dn->ofs_in_node + i);
1809 for (i += 1; i < F2FS_I(dn->inode)->i_cluster_size; i++) {
1810 block_t blkaddr = data_blkaddr(dn->inode, dn->node_page,
1811 dn->ofs_in_node + i);
1813 if (!__is_valid_data_blkaddr(blkaddr))
1815 if (first_blkaddr + i - (compressed ? 1 : 0) != blkaddr)
1819 return compressed ? i - 1 : i;
1822 const struct address_space_operations f2fs_compress_aops = {
1823 .release_folio = f2fs_release_folio,
1824 .invalidate_folio = f2fs_invalidate_folio,
1827 struct address_space *COMPRESS_MAPPING(struct f2fs_sb_info *sbi)
1829 return sbi->compress_inode->i_mapping;
1832 void f2fs_invalidate_compress_page(struct f2fs_sb_info *sbi, block_t blkaddr)
1834 if (!sbi->compress_inode)
1836 invalidate_mapping_pages(COMPRESS_MAPPING(sbi), blkaddr, blkaddr);
1839 void f2fs_cache_compressed_page(struct f2fs_sb_info *sbi, struct page *page,
1840 nid_t ino, block_t blkaddr)
1845 if (!test_opt(sbi, COMPRESS_CACHE))
1848 if (!f2fs_is_valid_blkaddr(sbi, blkaddr, DATA_GENERIC_ENHANCE_READ))
1851 if (!f2fs_available_free_memory(sbi, COMPRESS_PAGE))
1854 cpage = find_get_page(COMPRESS_MAPPING(sbi), blkaddr);
1856 f2fs_put_page(cpage, 0);
1860 cpage = alloc_page(__GFP_NOWARN | __GFP_IO);
1864 ret = add_to_page_cache_lru(cpage, COMPRESS_MAPPING(sbi),
1867 f2fs_put_page(cpage, 0);
1871 set_page_private_data(cpage, ino);
1873 if (!f2fs_is_valid_blkaddr(sbi, blkaddr, DATA_GENERIC_ENHANCE_READ))
1876 memcpy(page_address(cpage), page_address(page), PAGE_SIZE);
1877 SetPageUptodate(cpage);
1879 f2fs_put_page(cpage, 1);
1882 bool f2fs_load_compressed_page(struct f2fs_sb_info *sbi, struct page *page,
1886 bool hitted = false;
1888 if (!test_opt(sbi, COMPRESS_CACHE))
1891 cpage = f2fs_pagecache_get_page(COMPRESS_MAPPING(sbi),
1892 blkaddr, FGP_LOCK | FGP_NOWAIT, GFP_NOFS);
1894 if (PageUptodate(cpage)) {
1895 atomic_inc(&sbi->compress_page_hit);
1896 memcpy(page_address(page),
1897 page_address(cpage), PAGE_SIZE);
1900 f2fs_put_page(cpage, 1);
1906 void f2fs_invalidate_compress_pages(struct f2fs_sb_info *sbi, nid_t ino)
1908 struct address_space *mapping = sbi->compress_inode->i_mapping;
1909 struct folio_batch fbatch;
1911 pgoff_t end = MAX_BLKADDR(sbi);
1913 if (!mapping->nrpages)
1916 folio_batch_init(&fbatch);
1921 nr = filemap_get_folios(mapping, &index, end - 1, &fbatch);
1925 for (i = 0; i < nr; i++) {
1926 struct folio *folio = fbatch.folios[i];
1929 if (folio->mapping != mapping) {
1930 folio_unlock(folio);
1934 if (ino != get_page_private_data(&folio->page)) {
1935 folio_unlock(folio);
1939 generic_error_remove_page(mapping, &folio->page);
1940 folio_unlock(folio);
1942 folio_batch_release(&fbatch);
1944 } while (index < end);
1947 int f2fs_init_compress_inode(struct f2fs_sb_info *sbi)
1949 struct inode *inode;
1951 if (!test_opt(sbi, COMPRESS_CACHE))
1954 inode = f2fs_iget(sbi->sb, F2FS_COMPRESS_INO(sbi));
1956 return PTR_ERR(inode);
1957 sbi->compress_inode = inode;
1959 sbi->compress_percent = COMPRESS_PERCENT;
1960 sbi->compress_watermark = COMPRESS_WATERMARK;
1962 atomic_set(&sbi->compress_page_hit, 0);
1967 void f2fs_destroy_compress_inode(struct f2fs_sb_info *sbi)
1969 if (!sbi->compress_inode)
1971 iput(sbi->compress_inode);
1972 sbi->compress_inode = NULL;
1975 int f2fs_init_page_array_cache(struct f2fs_sb_info *sbi)
1977 dev_t dev = sbi->sb->s_bdev->bd_dev;
1980 if (!f2fs_sb_has_compression(sbi))
1983 sprintf(slab_name, "f2fs_page_array_entry-%u:%u", MAJOR(dev), MINOR(dev));
1985 sbi->page_array_slab_size = sizeof(struct page *) <<
1986 F2FS_OPTION(sbi).compress_log_size;
1988 sbi->page_array_slab = f2fs_kmem_cache_create(slab_name,
1989 sbi->page_array_slab_size);
1990 if (!sbi->page_array_slab)
1995 void f2fs_destroy_page_array_cache(struct f2fs_sb_info *sbi)
1997 kmem_cache_destroy(sbi->page_array_slab);
2000 static int __init f2fs_init_cic_cache(void)
2002 cic_entry_slab = f2fs_kmem_cache_create("f2fs_cic_entry",
2003 sizeof(struct compress_io_ctx));
2004 if (!cic_entry_slab)
2009 static void f2fs_destroy_cic_cache(void)
2011 kmem_cache_destroy(cic_entry_slab);
2014 static int __init f2fs_init_dic_cache(void)
2016 dic_entry_slab = f2fs_kmem_cache_create("f2fs_dic_entry",
2017 sizeof(struct decompress_io_ctx));
2018 if (!dic_entry_slab)
2023 static void f2fs_destroy_dic_cache(void)
2025 kmem_cache_destroy(dic_entry_slab);
2028 int __init f2fs_init_compress_cache(void)
2032 err = f2fs_init_cic_cache();
2035 err = f2fs_init_dic_cache();
2040 f2fs_destroy_cic_cache();
2045 void f2fs_destroy_compress_cache(void)
2047 f2fs_destroy_dic_cache();
2048 f2fs_destroy_cic_cache();