1ae98043fSRyusuke Konishi // SPDX-License-Identifier: GPL-2.0+
2a3d93f70SRyusuke Konishi /*
394ee1d91SRyusuke Konishi * Dummy inodes to buffer blocks for garbage collection
4a3d93f70SRyusuke Konishi *
5a3d93f70SRyusuke Konishi * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
6a3d93f70SRyusuke Konishi *
74b420ab4SRyusuke Konishi * Written by Seiji Kihara, Amagai Yoshiji, and Ryusuke Konishi.
84b420ab4SRyusuke Konishi * Revised by Ryusuke Konishi.
9a3d93f70SRyusuke Konishi *
10a3d93f70SRyusuke Konishi */
11047180f2SRyusuke Konishi /*
12047180f2SRyusuke Konishi * This file adds the cache of on-disk blocks to be moved in garbage
13047180f2SRyusuke Konishi * collection. The disk blocks are held with dummy inodes (called
14047180f2SRyusuke Konishi * gcinodes), and this file provides lookup function of the dummy
15047180f2SRyusuke Konishi * inodes and their buffer read function.
16047180f2SRyusuke Konishi *
17047180f2SRyusuke Konishi * Buffers and pages held by the dummy inodes will be released each
18047180f2SRyusuke Konishi * time after they are copied to a new log. Dirty blocks made on the
19047180f2SRyusuke Konishi * current generation and the blocks to be moved by GC never overlap
20047180f2SRyusuke Konishi * because the dirty blocks make a new generation; they rather must be
21047180f2SRyusuke Konishi * written individually.
22047180f2SRyusuke Konishi */
23a3d93f70SRyusuke Konishi
24a3d93f70SRyusuke Konishi #include <linux/buffer_head.h>
25a3d93f70SRyusuke Konishi #include <linux/mpage.h>
26a3d93f70SRyusuke Konishi #include <linux/hash.h>
275a0e3ad6STejun Heo #include <linux/slab.h>
28a3d93f70SRyusuke Konishi #include <linux/swap.h>
29a3d93f70SRyusuke Konishi #include "nilfs.h"
3005d0e94bSRyusuke Konishi #include "btree.h"
3105d0e94bSRyusuke Konishi #include "btnode.h"
32a3d93f70SRyusuke Konishi #include "page.h"
33a3d93f70SRyusuke Konishi #include "mdt.h"
34a3d93f70SRyusuke Konishi #include "dat.h"
35a3d93f70SRyusuke Konishi #include "ifile.h"
36a3d93f70SRyusuke Konishi
37a3d93f70SRyusuke Konishi /*
38a3d93f70SRyusuke Konishi * nilfs_gccache_submit_read_data() - add data buffer and submit read request
39a3d93f70SRyusuke Konishi * @inode - gc inode
40a3d93f70SRyusuke Konishi * @blkoff - dummy offset treated as the key for the page cache
41a3d93f70SRyusuke Konishi * @pbn - physical block number of the block
42a3d93f70SRyusuke Konishi * @vbn - virtual block number of the block, 0 for non-virtual block
43a3d93f70SRyusuke Konishi * @out_bh - indirect pointer to a buffer_head struct to receive the results
44a3d93f70SRyusuke Konishi *
45a3d93f70SRyusuke Konishi * Description: nilfs_gccache_submit_read_data() registers the data buffer
46a3d93f70SRyusuke Konishi * specified by @pbn to the GC pagecache with the key @blkoff.
47a3d93f70SRyusuke Konishi * This function sets @vbn (@pbn if @vbn is zero) in b_blocknr of the buffer.
48a3d93f70SRyusuke Konishi *
49a3d93f70SRyusuke Konishi * Return Value: On success, 0 is returned. On Error, one of the following
50a3d93f70SRyusuke Konishi * negative error code is returned.
51a3d93f70SRyusuke Konishi *
52a3d93f70SRyusuke Konishi * %-EIO - I/O error.
53a3d93f70SRyusuke Konishi *
54a3d93f70SRyusuke Konishi * %-ENOMEM - Insufficient amount of memory available.
55a3d93f70SRyusuke Konishi *
56a3d93f70SRyusuke Konishi * %-ENOENT - The block specified with @pbn does not exist.
57a3d93f70SRyusuke Konishi */
nilfs_gccache_submit_read_data(struct inode * inode,sector_t blkoff,sector_t pbn,__u64 vbn,struct buffer_head ** out_bh)58a3d93f70SRyusuke Konishi int nilfs_gccache_submit_read_data(struct inode *inode, sector_t blkoff,
59a3d93f70SRyusuke Konishi sector_t pbn, __u64 vbn,
60a3d93f70SRyusuke Konishi struct buffer_head **out_bh)
61a3d93f70SRyusuke Konishi {
62a3d93f70SRyusuke Konishi struct buffer_head *bh;
63a3d93f70SRyusuke Konishi int err;
64a3d93f70SRyusuke Konishi
65a3d93f70SRyusuke Konishi bh = nilfs_grab_buffer(inode, inode->i_mapping, blkoff, 0);
66a3d93f70SRyusuke Konishi if (unlikely(!bh))
67a3d93f70SRyusuke Konishi return -ENOMEM;
68a3d93f70SRyusuke Konishi
69a3d93f70SRyusuke Konishi if (buffer_uptodate(bh))
70a3d93f70SRyusuke Konishi goto out;
71a3d93f70SRyusuke Konishi
72a3d93f70SRyusuke Konishi if (pbn == 0) {
730ef28f9aSRyusuke Konishi struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
740ef28f9aSRyusuke Konishi
750ef28f9aSRyusuke Konishi err = nilfs_dat_translate(nilfs->ns_dat, vbn, &pbn);
76*7ee29facSPan Bian if (unlikely(err)) /* -EIO, -ENOMEM, -ENOENT */
77a3d93f70SRyusuke Konishi goto failed;
78a3d93f70SRyusuke Konishi }
79a3d93f70SRyusuke Konishi
80a3d93f70SRyusuke Konishi lock_buffer(bh);
81a3d93f70SRyusuke Konishi if (buffer_uptodate(bh)) {
82a3d93f70SRyusuke Konishi unlock_buffer(bh);
83a3d93f70SRyusuke Konishi goto out;
84a3d93f70SRyusuke Konishi }
85a3d93f70SRyusuke Konishi
86a3d93f70SRyusuke Konishi if (!buffer_mapped(bh)) {
870ef28f9aSRyusuke Konishi bh->b_bdev = inode->i_sb->s_bdev;
88a3d93f70SRyusuke Konishi set_buffer_mapped(bh);
89a3d93f70SRyusuke Konishi }
90a3d93f70SRyusuke Konishi bh->b_blocknr = pbn;
91a3d93f70SRyusuke Konishi bh->b_end_io = end_buffer_read_sync;
92a3d93f70SRyusuke Konishi get_bh(bh);
931420c4a5SBart Van Assche submit_bh(REQ_OP_READ, bh);
94a3d93f70SRyusuke Konishi if (vbn)
95a3d93f70SRyusuke Konishi bh->b_blocknr = vbn;
96a3d93f70SRyusuke Konishi out:
97a3d93f70SRyusuke Konishi err = 0;
98a3d93f70SRyusuke Konishi *out_bh = bh;
99a3d93f70SRyusuke Konishi
100a3d93f70SRyusuke Konishi failed:
101a3d93f70SRyusuke Konishi unlock_page(bh->b_page);
10209cbfeafSKirill A. Shutemov put_page(bh->b_page);
103*7ee29facSPan Bian if (unlikely(err))
104*7ee29facSPan Bian brelse(bh);
105a3d93f70SRyusuke Konishi return err;
106a3d93f70SRyusuke Konishi }
107a3d93f70SRyusuke Konishi
108a3d93f70SRyusuke Konishi /*
109a3d93f70SRyusuke Konishi * nilfs_gccache_submit_read_node() - add node buffer and submit read request
110a3d93f70SRyusuke Konishi * @inode - gc inode
111a3d93f70SRyusuke Konishi * @pbn - physical block number for the block
112a3d93f70SRyusuke Konishi * @vbn - virtual block number for the block
113a3d93f70SRyusuke Konishi * @out_bh - indirect pointer to a buffer_head struct to receive the results
114a3d93f70SRyusuke Konishi *
115a3d93f70SRyusuke Konishi * Description: nilfs_gccache_submit_read_node() registers the node buffer
116a3d93f70SRyusuke Konishi * specified by @vbn to the GC pagecache. @pbn can be supplied by the
117a3d93f70SRyusuke Konishi * caller to avoid translation of the disk block address.
118a3d93f70SRyusuke Konishi *
119a3d93f70SRyusuke Konishi * Return Value: On success, 0 is returned. On Error, one of the following
120a3d93f70SRyusuke Konishi * negative error code is returned.
121a3d93f70SRyusuke Konishi *
122a3d93f70SRyusuke Konishi * %-EIO - I/O error.
123a3d93f70SRyusuke Konishi *
124a3d93f70SRyusuke Konishi * %-ENOMEM - Insufficient amount of memory available.
125a3d93f70SRyusuke Konishi */
nilfs_gccache_submit_read_node(struct inode * inode,sector_t pbn,__u64 vbn,struct buffer_head ** out_bh)126a3d93f70SRyusuke Konishi int nilfs_gccache_submit_read_node(struct inode *inode, sector_t pbn,
127a3d93f70SRyusuke Konishi __u64 vbn, struct buffer_head **out_bh)
128a3d93f70SRyusuke Konishi {
129e897be17SRyusuke Konishi struct inode *btnc_inode = NILFS_I(inode)->i_assoc_inode;
13026dfdd8eSRyusuke Konishi int ret;
13126dfdd8eSRyusuke Konishi
132ed451259SBart Van Assche ret = nilfs_btnode_submit_block(btnc_inode->i_mapping, vbn ? : pbn, pbn,
133ed451259SBart Van Assche REQ_OP_READ, out_bh, &pbn);
134a3d93f70SRyusuke Konishi if (ret == -EEXIST) /* internal code (cache hit) */
135a3d93f70SRyusuke Konishi ret = 0;
136a3d93f70SRyusuke Konishi return ret;
137a3d93f70SRyusuke Konishi }
138a3d93f70SRyusuke Konishi
nilfs_gccache_wait_and_mark_dirty(struct buffer_head * bh)139a3d93f70SRyusuke Konishi int nilfs_gccache_wait_and_mark_dirty(struct buffer_head *bh)
140a3d93f70SRyusuke Konishi {
141a3d93f70SRyusuke Konishi wait_on_buffer(bh);
14239a9dccaSRyusuke Konishi if (!buffer_uptodate(bh)) {
1436ad4cd7fSMatthew Wilcox (Oracle) struct inode *inode = bh->b_folio->mapping->host;
14439a9dccaSRyusuke Konishi
145a1d0747aSJoe Perches nilfs_err(inode->i_sb,
14639a9dccaSRyusuke Konishi "I/O error reading %s block for GC (ino=%lu, vblocknr=%llu)",
14739a9dccaSRyusuke Konishi buffer_nilfs_node(bh) ? "node" : "data",
14839a9dccaSRyusuke Konishi inode->i_ino, (unsigned long long)bh->b_blocknr);
149a3d93f70SRyusuke Konishi return -EIO;
15039a9dccaSRyusuke Konishi }
151a3d93f70SRyusuke Konishi if (buffer_dirty(bh))
152a3d93f70SRyusuke Konishi return -EEXIST;
153a3d93f70SRyusuke Konishi
1545fc7b141SRyusuke Konishi if (buffer_nilfs_node(bh) && nilfs_btree_broken_node_block(bh)) {
1551d5385b9SRyusuke Konishi clear_buffer_uptodate(bh);
1561d5385b9SRyusuke Konishi return -EIO;
1571d5385b9SRyusuke Konishi }
1585fc7b141SRyusuke Konishi mark_buffer_dirty(bh);
159a3d93f70SRyusuke Konishi return 0;
160a3d93f70SRyusuke Konishi }
161a3d93f70SRyusuke Konishi
nilfs_init_gcinode(struct inode * inode)162263d90ceSRyusuke Konishi int nilfs_init_gcinode(struct inode *inode)
163a3d93f70SRyusuke Konishi {
164263d90ceSRyusuke Konishi struct nilfs_inode_info *ii = NILFS_I(inode);
165a3d93f70SRyusuke Konishi
166adbb39b5SRyusuke Konishi inode->i_mode = S_IFREG;
167adbb39b5SRyusuke Konishi mapping_set_gfp_mask(inode->i_mapping, GFP_NOFS);
168293ce0edSRyusuke Konishi inode->i_mapping->a_ops = &empty_aops;
169a3d93f70SRyusuke Konishi
170a3d93f70SRyusuke Konishi ii->i_flags = 0;
171a3d93f70SRyusuke Konishi nilfs_bmap_init_gc(ii->i_bmap);
172a3d93f70SRyusuke Konishi
173e897be17SRyusuke Konishi return nilfs_attach_btree_node_cache(inode);
174a3d93f70SRyusuke Konishi }
175a3d93f70SRyusuke Konishi
176263d90ceSRyusuke Konishi /**
177263d90ceSRyusuke Konishi * nilfs_remove_all_gcinodes() - remove all unprocessed gc inodes
178a3d93f70SRyusuke Konishi */
nilfs_remove_all_gcinodes(struct the_nilfs * nilfs)179263d90ceSRyusuke Konishi void nilfs_remove_all_gcinodes(struct the_nilfs *nilfs)
180a3d93f70SRyusuke Konishi {
181263d90ceSRyusuke Konishi struct list_head *head = &nilfs->ns_gc_inodes;
182263d90ceSRyusuke Konishi struct nilfs_inode_info *ii;
183a3d93f70SRyusuke Konishi
184263d90ceSRyusuke Konishi while (!list_empty(head)) {
185263d90ceSRyusuke Konishi ii = list_first_entry(head, struct nilfs_inode_info, i_dirty);
186263d90ceSRyusuke Konishi list_del_init(&ii->i_dirty);
187fbb24a3aSRyusuke Konishi truncate_inode_pages(&ii->vfs_inode.i_data, 0);
188e897be17SRyusuke Konishi nilfs_btnode_cache_clear(ii->i_assoc_inode->i_mapping);
189263d90ceSRyusuke Konishi iput(&ii->vfs_inode);
190a3d93f70SRyusuke Konishi }
191a3d93f70SRyusuke Konishi }
192