ext4: don't allow overlapping system zones
[linux-2.6-microblaze.git] / fs / ext4 / block_validity.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  *  linux/fs/ext4/block_validity.c
4  *
5  * Copyright (C) 2009
6  * Theodore Ts'o (tytso@mit.edu)
7  *
8  * Track which blocks in the filesystem are metadata blocks that
9  * should never be used as data blocks by files or directories.
10  */
11
12 #include <linux/time.h>
13 #include <linux/fs.h>
14 #include <linux/namei.h>
15 #include <linux/quotaops.h>
16 #include <linux/buffer_head.h>
17 #include <linux/swap.h>
18 #include <linux/pagemap.h>
19 #include <linux/blkdev.h>
20 #include <linux/slab.h>
21 #include "ext4.h"
22
23 struct ext4_system_zone {
24         struct rb_node  node;
25         ext4_fsblk_t    start_blk;
26         unsigned int    count;
27 };
28
29 static struct kmem_cache *ext4_system_zone_cachep;
30
31 int __init ext4_init_system_zone(void)
32 {
33         ext4_system_zone_cachep = KMEM_CACHE(ext4_system_zone, 0);
34         if (ext4_system_zone_cachep == NULL)
35                 return -ENOMEM;
36         return 0;
37 }
38
39 void ext4_exit_system_zone(void)
40 {
41         rcu_barrier();
42         kmem_cache_destroy(ext4_system_zone_cachep);
43 }
44
45 static inline int can_merge(struct ext4_system_zone *entry1,
46                      struct ext4_system_zone *entry2)
47 {
48         if ((entry1->start_blk + entry1->count) == entry2->start_blk)
49                 return 1;
50         return 0;
51 }
52
53 static void release_system_zone(struct ext4_system_blocks *system_blks)
54 {
55         struct ext4_system_zone *entry, *n;
56
57         rbtree_postorder_for_each_entry_safe(entry, n,
58                                 &system_blks->root, node)
59                 kmem_cache_free(ext4_system_zone_cachep, entry);
60 }
61
62 /*
63  * Mark a range of blocks as belonging to the "system zone" --- that
64  * is, filesystem metadata blocks which should never be used by
65  * inodes.
66  */
67 static int add_system_zone(struct ext4_system_blocks *system_blks,
68                            ext4_fsblk_t start_blk,
69                            unsigned int count)
70 {
71         struct ext4_system_zone *new_entry, *entry;
72         struct rb_node **n = &system_blks->root.rb_node, *node;
73         struct rb_node *parent = NULL, *new_node = NULL;
74
75         while (*n) {
76                 parent = *n;
77                 entry = rb_entry(parent, struct ext4_system_zone, node);
78                 if (start_blk < entry->start_blk)
79                         n = &(*n)->rb_left;
80                 else if (start_blk >= (entry->start_blk + entry->count))
81                         n = &(*n)->rb_right;
82                 else    /* Unexpected overlap of system zones. */
83                         return -EFSCORRUPTED;
84         }
85
86         new_entry = kmem_cache_alloc(ext4_system_zone_cachep,
87                                      GFP_KERNEL);
88         if (!new_entry)
89                 return -ENOMEM;
90         new_entry->start_blk = start_blk;
91         new_entry->count = count;
92         new_node = &new_entry->node;
93
94         rb_link_node(new_node, parent, n);
95         rb_insert_color(new_node, &system_blks->root);
96
97         /* Can we merge to the left? */
98         node = rb_prev(new_node);
99         if (node) {
100                 entry = rb_entry(node, struct ext4_system_zone, node);
101                 if (can_merge(entry, new_entry)) {
102                         new_entry->start_blk = entry->start_blk;
103                         new_entry->count += entry->count;
104                         rb_erase(node, &system_blks->root);
105                         kmem_cache_free(ext4_system_zone_cachep, entry);
106                 }
107         }
108
109         /* Can we merge to the right? */
110         node = rb_next(new_node);
111         if (node) {
112                 entry = rb_entry(node, struct ext4_system_zone, node);
113                 if (can_merge(new_entry, entry)) {
114                         new_entry->count += entry->count;
115                         rb_erase(node, &system_blks->root);
116                         kmem_cache_free(ext4_system_zone_cachep, entry);
117                 }
118         }
119         return 0;
120 }
121
122 static void debug_print_tree(struct ext4_sb_info *sbi)
123 {
124         struct rb_node *node;
125         struct ext4_system_zone *entry;
126         struct ext4_system_blocks *system_blks;
127         int first = 1;
128
129         printk(KERN_INFO "System zones: ");
130         rcu_read_lock();
131         system_blks = rcu_dereference(sbi->system_blks);
132         node = rb_first(&system_blks->root);
133         while (node) {
134                 entry = rb_entry(node, struct ext4_system_zone, node);
135                 printk(KERN_CONT "%s%llu-%llu", first ? "" : ", ",
136                        entry->start_blk, entry->start_blk + entry->count - 1);
137                 first = 0;
138                 node = rb_next(node);
139         }
140         rcu_read_unlock();
141         printk(KERN_CONT "\n");
142 }
143
144 /*
145  * Returns 1 if the passed-in block region (start_blk,
146  * start_blk+count) is valid; 0 if some part of the block region
147  * overlaps with filesystem metadata blocks.
148  */
149 static int ext4_data_block_valid_rcu(struct ext4_sb_info *sbi,
150                                      struct ext4_system_blocks *system_blks,
151                                      ext4_fsblk_t start_blk,
152                                      unsigned int count)
153 {
154         struct ext4_system_zone *entry;
155         struct rb_node *n;
156
157         if ((start_blk <= le32_to_cpu(sbi->s_es->s_first_data_block)) ||
158             (start_blk + count < start_blk) ||
159             (start_blk + count > ext4_blocks_count(sbi->s_es)))
160                 return 0;
161
162         if (system_blks == NULL)
163                 return 1;
164
165         n = system_blks->root.rb_node;
166         while (n) {
167                 entry = rb_entry(n, struct ext4_system_zone, node);
168                 if (start_blk + count - 1 < entry->start_blk)
169                         n = n->rb_left;
170                 else if (start_blk >= (entry->start_blk + entry->count))
171                         n = n->rb_right;
172                 else
173                         return 0;
174         }
175         return 1;
176 }
177
178 static int ext4_protect_reserved_inode(struct super_block *sb,
179                                        struct ext4_system_blocks *system_blks,
180                                        u32 ino)
181 {
182         struct inode *inode;
183         struct ext4_sb_info *sbi = EXT4_SB(sb);
184         struct ext4_map_blocks map;
185         u32 i = 0, num;
186         int err = 0, n;
187
188         if ((ino < EXT4_ROOT_INO) ||
189             (ino > le32_to_cpu(sbi->s_es->s_inodes_count)))
190                 return -EINVAL;
191         inode = ext4_iget(sb, ino, EXT4_IGET_SPECIAL);
192         if (IS_ERR(inode))
193                 return PTR_ERR(inode);
194         num = (inode->i_size + sb->s_blocksize - 1) >> sb->s_blocksize_bits;
195         while (i < num) {
196                 cond_resched();
197                 map.m_lblk = i;
198                 map.m_len = num - i;
199                 n = ext4_map_blocks(NULL, inode, &map, 0);
200                 if (n < 0) {
201                         err = n;
202                         break;
203                 }
204                 if (n == 0) {
205                         i++;
206                 } else {
207                         if (!ext4_data_block_valid_rcu(sbi, system_blks,
208                                                 map.m_pblk, n)) {
209                                 err = -EFSCORRUPTED;
210                                 __ext4_error(sb, __func__, __LINE__, -err,
211                                              map.m_pblk, "blocks %llu-%llu "
212                                              "from inode %u overlap system zone",
213                                              map.m_pblk,
214                                              map.m_pblk + map.m_len - 1, ino);
215                                 break;
216                         }
217                         err = add_system_zone(system_blks, map.m_pblk, n);
218                         if (err < 0)
219                                 break;
220                         i += n;
221                 }
222         }
223         iput(inode);
224         return err;
225 }
226
227 static void ext4_destroy_system_zone(struct rcu_head *rcu)
228 {
229         struct ext4_system_blocks *system_blks;
230
231         system_blks = container_of(rcu, struct ext4_system_blocks, rcu);
232         release_system_zone(system_blks);
233         kfree(system_blks);
234 }
235
236 /*
237  * Build system zone rbtree which is used for block validity checking.
238  *
239  * The update of system_blks pointer in this function is protected by
240  * sb->s_umount semaphore. However we have to be careful as we can be
241  * racing with ext4_data_block_valid() calls reading system_blks rbtree
242  * protected only by RCU. That's why we first build the rbtree and then
243  * swap it in place.
244  */
245 int ext4_setup_system_zone(struct super_block *sb)
246 {
247         ext4_group_t ngroups = ext4_get_groups_count(sb);
248         struct ext4_sb_info *sbi = EXT4_SB(sb);
249         struct ext4_system_blocks *system_blks;
250         struct ext4_group_desc *gdp;
251         ext4_group_t i;
252         int flex_size = ext4_flex_bg_size(sbi);
253         int ret;
254
255         if (!test_opt(sb, BLOCK_VALIDITY)) {
256                 if (sbi->system_blks)
257                         ext4_release_system_zone(sb);
258                 return 0;
259         }
260         if (sbi->system_blks)
261                 return 0;
262
263         system_blks = kzalloc(sizeof(*system_blks), GFP_KERNEL);
264         if (!system_blks)
265                 return -ENOMEM;
266
267         for (i=0; i < ngroups; i++) {
268                 cond_resched();
269                 if (ext4_bg_has_super(sb, i) &&
270                     ((i < 5) || ((i % flex_size) == 0)))
271                         add_system_zone(system_blks,
272                                         ext4_group_first_block_no(sb, i),
273                                         ext4_bg_num_gdb(sb, i) + 1);
274                 gdp = ext4_get_group_desc(sb, i, NULL);
275                 ret = add_system_zone(system_blks,
276                                 ext4_block_bitmap(sb, gdp), 1);
277                 if (ret)
278                         goto err;
279                 ret = add_system_zone(system_blks,
280                                 ext4_inode_bitmap(sb, gdp), 1);
281                 if (ret)
282                         goto err;
283                 ret = add_system_zone(system_blks,
284                                 ext4_inode_table(sb, gdp),
285                                 sbi->s_itb_per_group);
286                 if (ret)
287                         goto err;
288         }
289         if (ext4_has_feature_journal(sb) && sbi->s_es->s_journal_inum) {
290                 ret = ext4_protect_reserved_inode(sb, system_blks,
291                                 le32_to_cpu(sbi->s_es->s_journal_inum));
292                 if (ret)
293                         goto err;
294         }
295
296         /*
297          * System blks rbtree complete, announce it once to prevent racing
298          * with ext4_data_block_valid() accessing the rbtree at the same
299          * time.
300          */
301         rcu_assign_pointer(sbi->system_blks, system_blks);
302
303         if (test_opt(sb, DEBUG))
304                 debug_print_tree(sbi);
305         return 0;
306 err:
307         release_system_zone(system_blks);
308         kfree(system_blks);
309         return ret;
310 }
311
312 /*
313  * Called when the filesystem is unmounted or when remounting it with
314  * noblock_validity specified.
315  *
316  * The update of system_blks pointer in this function is protected by
317  * sb->s_umount semaphore. However we have to be careful as we can be
318  * racing with ext4_data_block_valid() calls reading system_blks rbtree
319  * protected only by RCU. So we first clear the system_blks pointer and
320  * then free the rbtree only after RCU grace period expires.
321  */
322 void ext4_release_system_zone(struct super_block *sb)
323 {
324         struct ext4_system_blocks *system_blks;
325
326         system_blks = rcu_dereference_protected(EXT4_SB(sb)->system_blks,
327                                         lockdep_is_held(&sb->s_umount));
328         rcu_assign_pointer(EXT4_SB(sb)->system_blks, NULL);
329
330         if (system_blks)
331                 call_rcu(&system_blks->rcu, ext4_destroy_system_zone);
332 }
333
334 int ext4_data_block_valid(struct ext4_sb_info *sbi, ext4_fsblk_t start_blk,
335                           unsigned int count)
336 {
337         struct ext4_system_blocks *system_blks;
338         int ret;
339
340         /*
341          * Lock the system zone to prevent it being released concurrently
342          * when doing a remount which inverse current "[no]block_validity"
343          * mount option.
344          */
345         rcu_read_lock();
346         system_blks = rcu_dereference(sbi->system_blks);
347         ret = ext4_data_block_valid_rcu(sbi, system_blks, start_blk,
348                                         count);
349         rcu_read_unlock();
350         return ret;
351 }
352
353 int ext4_check_blockref(const char *function, unsigned int line,
354                         struct inode *inode, __le32 *p, unsigned int max)
355 {
356         __le32 *bref = p;
357         unsigned int blk;
358
359         if (ext4_has_feature_journal(inode->i_sb) &&
360             (inode->i_ino ==
361              le32_to_cpu(EXT4_SB(inode->i_sb)->s_es->s_journal_inum)))
362                 return 0;
363
364         while (bref < p+max) {
365                 blk = le32_to_cpu(*bref++);
366                 if (blk &&
367                     unlikely(!ext4_data_block_valid(EXT4_SB(inode->i_sb),
368                                                     blk, 1))) {
369                         ext4_error_inode(inode, function, line, blk,
370                                          "invalid block");
371                         return -EFSCORRUPTED;
372                 }
373         }
374         return 0;
375 }
376