Branch data Line data Source code
1 : : // SPDX-License-Identifier: GPL-2.0
2 : : /*
3 : : * linux/fs/ext4/readpage.c
4 : : *
5 : : * Copyright (C) 2002, Linus Torvalds.
6 : : * Copyright (C) 2015, Google, Inc.
7 : : *
8 : : * This was originally taken from fs/mpage.c
9 : : *
10 : : * The intent is the ext4_mpage_readpages() function here is intended
11 : : * to replace mpage_readpages() in the general case, not just for
12 : : * encrypted files. It has some limitations (see below), where it
13 : : * will fall back to read_block_full_page(), but these limitations
14 : : * should only be hit when page_size != block_size.
15 : : *
16 : : * This will allow us to attach a callback function to support ext4
17 : : * encryption.
18 : : *
19 : : * If anything unusual happens, such as:
20 : : *
21 : : * - encountering a page which has buffers
22 : : * - encountering a page which has a non-hole after a hole
23 : : * - encountering a page with non-contiguous blocks
24 : : *
25 : : * then this code just gives up and calls the buffer_head-based read function.
26 : : * It does handle a page which has holes at the end - that is a common case:
27 : : * the end-of-file on blocksize < PAGE_SIZE setups.
28 : : *
29 : : */
30 : :
31 : : #include <linux/kernel.h>
32 : : #include <linux/export.h>
33 : : #include <linux/mm.h>
34 : : #include <linux/kdev_t.h>
35 : : #include <linux/gfp.h>
36 : : #include <linux/bio.h>
37 : : #include <linux/fs.h>
38 : : #include <linux/buffer_head.h>
39 : : #include <linux/blkdev.h>
40 : : #include <linux/highmem.h>
41 : : #include <linux/prefetch.h>
42 : : #include <linux/mpage.h>
43 : : #include <linux/writeback.h>
44 : : #include <linux/backing-dev.h>
45 : : #include <linux/pagevec.h>
46 : : #include <linux/cleancache.h>
47 : :
48 : : #include "ext4.h"
49 : :
50 : : #define NUM_PREALLOC_POST_READ_CTXS 128
51 : :
52 : : static struct kmem_cache *bio_post_read_ctx_cache;
53 : : static mempool_t *bio_post_read_ctx_pool;
54 : :
55 : : /* postprocessing steps for read bios */
56 : : enum bio_post_read_step {
57 : : STEP_INITIAL = 0,
58 : : STEP_DECRYPT,
59 : : STEP_VERITY,
60 : : STEP_MAX,
61 : : };
62 : :
63 : : struct bio_post_read_ctx {
64 : : struct bio *bio;
65 : : struct work_struct work;
66 : : unsigned int cur_step;
67 : : unsigned int enabled_steps;
68 : : };
69 : :
70 : 1182506 : static void __read_end_io(struct bio *bio)
71 : : {
72 : : struct page *page;
73 : : struct bio_vec *bv;
74 : : struct bvec_iter_all iter_all;
75 : :
76 [ + + ]: 14361398 : bio_for_each_segment_all(bv, bio, iter_all) {
77 : 11996380 : page = bv->bv_page;
78 : :
79 : : /* PG_error was set if any post_read step failed */
80 [ + + + + ]: 23992648 : if (bio->bi_status || PageError(page)) {
81 : : ClearPageUptodate(page);
82 : : /* will re-read again later */
83 : : ClearPageError(page);
84 : : } else {
85 : : SetPageUptodate(page);
86 : : }
87 : 11996450 : unlock_page(page);
88 : : }
89 [ - + ]: 1182512 : if (bio->bi_private)
90 : 0 : mempool_free(bio->bi_private, bio_post_read_ctx_pool);
91 : 1182512 : bio_put(bio);
92 : 1182498 : }
93 : :
94 : : static void bio_post_read_processing(struct bio_post_read_ctx *ctx);
95 : :
96 : 0 : static void decrypt_work(struct work_struct *work)
97 : : {
98 : : struct bio_post_read_ctx *ctx =
99 : 0 : container_of(work, struct bio_post_read_ctx, work);
100 : :
101 : 0 : fscrypt_decrypt_bio(ctx->bio);
102 : :
103 : 0 : bio_post_read_processing(ctx);
104 : 0 : }
105 : :
106 : 0 : static void verity_work(struct work_struct *work)
107 : : {
108 : : struct bio_post_read_ctx *ctx =
109 : 0 : container_of(work, struct bio_post_read_ctx, work);
110 : 0 : struct bio *bio = ctx->bio;
111 : :
112 : : /*
113 : : * fsverity_verify_bio() may call readpages() again, and although verity
114 : : * will be disabled for that, decryption may still be needed, causing
115 : : * another bio_post_read_ctx to be allocated. So to guarantee that
116 : : * mempool_alloc() never deadlocks we must free the current ctx first.
117 : : * This is safe because verity is the last post-read step.
118 : : */
119 : : BUILD_BUG_ON(STEP_VERITY + 1 != STEP_MAX);
120 : 0 : mempool_free(ctx, bio_post_read_ctx_pool);
121 : 0 : bio->bi_private = NULL;
122 : :
123 : : fsverity_verify_bio(bio);
124 : :
125 : 0 : __read_end_io(bio);
126 : 0 : }
127 : :
128 : 0 : static void bio_post_read_processing(struct bio_post_read_ctx *ctx)
129 : : {
130 : : /*
131 : : * We use different work queues for decryption and for verity because
132 : : * verity may require reading metadata pages that need decryption, and
133 : : * we shouldn't recurse to the same workqueue.
134 : : */
135 [ # # # ]: 0 : switch (++ctx->cur_step) {
136 : : case STEP_DECRYPT:
137 [ # # ]: 0 : if (ctx->enabled_steps & (1 << STEP_DECRYPT)) {
138 : 0 : INIT_WORK(&ctx->work, decrypt_work);
139 : 0 : fscrypt_enqueue_decrypt_work(&ctx->work);
140 : 0 : return;
141 : : }
142 : 0 : ctx->cur_step++;
143 : : /* fall-through */
144 : : case STEP_VERITY:
145 [ # # ]: 0 : if (ctx->enabled_steps & (1 << STEP_VERITY)) {
146 : 0 : INIT_WORK(&ctx->work, verity_work);
147 : : fsverity_enqueue_verify_work(&ctx->work);
148 : : return;
149 : : }
150 : 0 : ctx->cur_step++;
151 : : /* fall-through */
152 : : default:
153 : 0 : __read_end_io(ctx->bio);
154 : : }
155 : : }
156 : :
157 : : static bool bio_post_read_required(struct bio *bio)
158 : : {
159 [ - + # # ]: 1182480 : return bio->bi_private && !bio->bi_status;
160 : : }
161 : :
162 : : /*
163 : : * I/O completion handler for multipage BIOs.
164 : : *
165 : : * The mpage code never puts partial pages into a BIO (except for end-of-file).
166 : : * If a page does not map to a contiguous run of blocks then it simply falls
167 : : * back to block_read_full_page().
168 : : *
169 : : * Why is this? If a page's completion depends on a number of different BIOs
170 : : * which can complete in any order (or at the same time) then determining the
171 : : * status of that page is hard. See end_buffer_async_read() for the details.
172 : : * There is no point in duplicating all that complexity.
173 : : */
174 : 1182480 : static void mpage_end_io(struct bio *bio)
175 : : {
176 [ - + ]: 1182480 : if (bio_post_read_required(bio)) {
177 : : struct bio_post_read_ctx *ctx = bio->bi_private;
178 : :
179 : 0 : ctx->cur_step = STEP_INITIAL;
180 : 0 : bio_post_read_processing(ctx);
181 : 1182488 : return;
182 : : }
183 : 1182480 : __read_end_io(bio);
184 : : }
185 : :
186 : : static inline bool ext4_need_verity(const struct inode *inode, pgoff_t idx)
187 : : {
188 : : return fsverity_active(inode) &&
189 : : idx < DIV_ROUND_UP(inode->i_size, PAGE_SIZE);
190 : : }
191 : :
192 : 1182458 : static struct bio_post_read_ctx *get_bio_post_read_ctx(struct inode *inode,
193 : : struct bio *bio,
194 : : pgoff_t first_idx)
195 : : {
196 : : unsigned int post_read_steps = 0;
197 : : struct bio_post_read_ctx *ctx = NULL;
198 : :
199 [ - + # # ]: 1182458 : if (IS_ENCRYPTED(inode) && S_ISREG(inode->i_mode))
200 : : post_read_steps |= 1 << STEP_DECRYPT;
201 : :
202 : : if (ext4_need_verity(inode, first_idx))
203 : : post_read_steps |= 1 << STEP_VERITY;
204 : :
205 [ - + ]: 1182458 : if (post_read_steps) {
206 : 0 : ctx = mempool_alloc(bio_post_read_ctx_pool, GFP_NOFS);
207 [ # # ]: 0 : if (!ctx)
208 : : return ERR_PTR(-ENOMEM);
209 : 0 : ctx->bio = bio;
210 : 0 : ctx->enabled_steps = post_read_steps;
211 : 0 : bio->bi_private = ctx;
212 : : }
213 : 1182458 : return ctx;
214 : : }
215 : :
216 : : static inline loff_t ext4_readpage_limit(struct inode *inode)
217 : : {
218 : : if (IS_ENABLED(CONFIG_FS_VERITY) &&
219 : : (IS_VERITY(inode) || ext4_verity_in_progress(inode)))
220 : : return inode->i_sb->s_maxbytes;
221 : :
222 : : return i_size_read(inode);
223 : : }
224 : :
225 : 1187300 : int ext4_mpage_readpages(struct address_space *mapping,
226 : : struct list_head *pages, struct page *page,
227 : : unsigned nr_pages, bool is_readahead)
228 : : {
229 : : struct bio *bio = NULL;
230 : : sector_t last_block_in_bio = 0;
231 : :
232 : 1187300 : struct inode *inode = mapping->host;
233 : 1187300 : const unsigned blkbits = inode->i_blkbits;
234 : 1187300 : const unsigned blocks_per_page = PAGE_SIZE >> blkbits;
235 : 1187300 : const unsigned blocksize = 1 << blkbits;
236 : : sector_t block_in_file;
237 : : sector_t last_block;
238 : : sector_t last_block_in_file;
239 : : sector_t blocks[MAX_BUF_PER_PAGE];
240 : : unsigned page_block;
241 : 1187300 : struct block_device *bdev = inode->i_sb->s_bdev;
242 : : int length;
243 : : unsigned relative_block = 0;
244 : : struct ext4_map_blocks map;
245 : :
246 : 1187300 : map.m_pblk = 0;
247 : 1187300 : map.m_lblk = 0;
248 : 1187300 : map.m_len = 0;
249 : 1187300 : map.m_flags = 0;
250 : :
251 [ + + ]: 13347144 : for (; nr_pages; nr_pages--) {
252 : : int fully_mapped = 1;
253 : : unsigned first_hole = blocks_per_page;
254 : :
255 [ + + ]: 12159942 : if (pages) {
256 : 12158858 : page = lru_to_page(pages);
257 : :
258 : 12158858 : prefetchw(&page->flags);
259 : : list_del(&page->lru);
260 [ + + ]: 24316348 : if (add_to_page_cache_lru(page, mapping, page->index,
261 : : readahead_gfp_mask(mapping)))
262 : : goto next_page;
263 : : }
264 : :
265 [ + + ]: 12026624 : if (page_has_buffers(page))
266 : : goto confused;
267 : :
268 : 12026570 : block_in_file = (sector_t)page->index << (PAGE_SHIFT - blkbits);
269 : 12026570 : last_block = block_in_file + nr_pages * blocks_per_page;
270 : 24053160 : last_block_in_file = (ext4_readpage_limit(inode) +
271 : 12026580 : blocksize - 1) >> blkbits;
272 [ + + ]: 12026580 : if (last_block > last_block_in_file)
273 : : last_block = last_block_in_file;
274 : : page_block = 0;
275 : :
276 : : /*
277 : : * Map blocks using the previous result first.
278 : : */
279 [ + + + + ]: 22844272 : if ((map.m_flags & EXT4_MAP_MAPPED) &&
280 [ + + ]: 21635394 : block_in_file > map.m_lblk &&
281 : 10817702 : block_in_file < (map.m_lblk + map.m_len)) {
282 : 10817732 : unsigned map_offset = block_in_file - map.m_lblk;
283 : 10817732 : unsigned last = map.m_len - map_offset;
284 : :
285 : 10817470 : for (relative_block = 0; ; relative_block++) {
286 [ + + ]: 21635202 : if (relative_block == last) {
287 : : /* needed? */
288 : 747318 : map.m_flags &= ~EXT4_MAP_MAPPED;
289 : 747318 : break;
290 : : }
291 [ + + ]: 20887884 : if (page_block == blocks_per_page)
292 : : break;
293 : 10817470 : blocks[page_block] = map.m_pblk + map_offset +
294 : : relative_block;
295 : 10817470 : page_block++;
296 : 10817470 : block_in_file++;
297 : 10817470 : }
298 : : }
299 : :
300 : : /*
301 : : * Then do more ext4_map_blocks() calls until we are
302 : : * done with this page.
303 : : */
304 [ + + ]: 13235708 : while (page_block < blocks_per_page) {
305 [ + + ]: 1209036 : if (block_in_file < last_block) {
306 : 1208192 : map.m_lblk = block_in_file;
307 : 1208192 : map.m_len = last_block - block_in_file;
308 : :
309 [ + + ]: 1208192 : if (ext4_map_blocks(NULL, inode, &map, 0) < 0) {
310 : : set_error_page:
311 : : SetPageError(page);
312 : : zero_user_segment(page, 0,
313 : : PAGE_SIZE);
314 : 0 : unlock_page(page);
315 : 0 : goto next_page;
316 : : }
317 : : }
318 [ + + ]: 1209078 : if ((map.m_flags & EXT4_MAP_MAPPED) == 0) {
319 : : fully_mapped = 0;
320 [ + + ]: 30386 : if (first_hole == blocks_per_page)
321 : : first_hole = page_block;
322 : 30386 : page_block++;
323 : 30386 : block_in_file++;
324 : 30386 : continue;
325 : : }
326 [ + + ]: 1178692 : if (first_hole != blocks_per_page)
327 : : goto confused; /* hole -> non-hole */
328 : :
329 : : /* Contiguous blocks? */
330 [ - + # # ]: 1178672 : if (page_block && blocks[page_block-1] != map.m_pblk-1)
331 : : goto confused;
332 : 1178606 : for (relative_block = 0; ; relative_block++) {
333 [ + + ]: 2357348 : if (relative_block == map.m_len) {
334 : : /* needed? */
335 : 428984 : map.m_flags &= ~EXT4_MAP_MAPPED;
336 : 428984 : break;
337 [ + + ]: 1928364 : } else if (page_block == blocks_per_page)
338 : : break;
339 : 1178606 : blocks[page_block] = map.m_pblk+relative_block;
340 : 1178606 : page_block++;
341 : 1178606 : block_in_file++;
342 : 1178606 : }
343 : : }
344 [ + + ]: 12026672 : if (first_hole != blocks_per_page) {
345 : 30426 : zero_user_segment(page, first_hole << blkbits,
346 : : PAGE_SIZE);
347 [ + - ]: 30426 : if (first_hole == 0) {
348 : : if (ext4_need_verity(inode, page->index) &&
349 : : !fsverity_verify_page(page))
350 : : goto set_error_page;
351 : : SetPageUptodate(page);
352 : 30426 : unlock_page(page);
353 : 30426 : goto next_page;
354 : : }
355 [ + + ]: 11996246 : } else if (fully_mapped) {
356 : : SetPageMappedToDisk(page);
357 : : }
358 [ + + + - ]: 23992560 : if (fully_mapped && blocks_per_page == 1 &&
359 [ - + ]: 11996268 : !PageUptodate(page) && cleancache_get_page(page) == 0) {
360 : : SetPageUptodate(page);
361 : : goto confused;
362 : : }
363 : :
364 : : /*
365 : : * This page will go to BIO. Do we need to send this
366 : : * BIO off first?
367 : : */
368 [ + + + + ]: 11996272 : if (bio && (last_block_in_bio != blocks[0] - 1)) {
369 : : submit_and_realloc:
370 : 5730 : submit_bio(bio);
371 : : bio = NULL;
372 : : }
373 [ + + ]: 11996362 : if (bio == NULL) {
374 : : struct bio_post_read_ctx *ctx;
375 : :
376 : 1182444 : bio = bio_alloc(GFP_KERNEL,
377 : 1182444 : min_t(int, nr_pages, BIO_MAX_PAGES));
378 [ + + ]: 1182474 : if (!bio)
379 : : goto set_error_page;
380 : 1182488 : ctx = get_bio_post_read_ctx(inode, bio, page->index);
381 [ - + ]: 1182460 : if (IS_ERR(ctx)) {
382 : 0 : bio_put(bio);
383 : : bio = NULL;
384 : 0 : goto set_error_page;
385 : : }
386 [ + + ]: 2364920 : bio_set_dev(bio, bdev);
387 : 1182436 : bio->bi_iter.bi_sector = blocks[0] << (blkbits - 9);
388 : 1182436 : bio->bi_end_io = mpage_end_io;
389 : 1182436 : bio->bi_private = ctx;
390 [ + + ]: 1182436 : bio_set_op_attrs(bio, REQ_OP_READ,
391 : : is_readahead ? REQ_RAHEAD : 0);
392 : : }
393 : :
394 : 11996354 : length = first_hole << blkbits;
395 [ + + ]: 11996354 : if (bio_add_page(bio, page, length, 0) < length)
396 : : goto submit_and_realloc;
397 : :
398 [ - + # # ]: 11996330 : if (((map.m_flags & EXT4_MAP_BOUNDARY) &&
399 [ - + ]: 11996368 : (relative_block == map.m_len)) ||
400 : : (first_hole != blocks_per_page)) {
401 : 44 : submit_bio(bio);
402 : 0 : bio = NULL;
403 : : } else
404 : 11996368 : last_block_in_bio = blocks[blocks_per_page - 1];
405 : : goto next_page;
406 : : confused:
407 [ # # ]: 0 : if (bio) {
408 : 0 : submit_bio(bio);
409 : : bio = NULL;
410 : : }
411 [ # # ]: 0 : if (!PageUptodate(page))
412 : 0 : block_read_full_page(page, ext4_get_block);
413 : : else
414 : 0 : unlock_page(page);
415 : : next_page:
416 [ + + ]: 12159654 : if (pages)
417 : 12158622 : put_page(page);
418 : : }
419 [ + + - + ]: 2373176 : BUG_ON(pages && !list_empty(pages));
420 [ + + ]: 1187202 : if (bio)
421 : 1176666 : submit_bio(bio);
422 : 1187082 : return 0;
423 : : }
424 : :
425 : 404 : int __init ext4_init_post_read_processing(void)
426 : : {
427 : 404 : bio_post_read_ctx_cache =
428 : 404 : kmem_cache_create("ext4_bio_post_read_ctx",
429 : : sizeof(struct bio_post_read_ctx), 0, 0, NULL);
430 [ + - ]: 404 : if (!bio_post_read_ctx_cache)
431 : : goto fail;
432 : 404 : bio_post_read_ctx_pool =
433 : : mempool_create_slab_pool(NUM_PREALLOC_POST_READ_CTXS,
434 : : bio_post_read_ctx_cache);
435 [ - + ]: 404 : if (!bio_post_read_ctx_pool)
436 : : goto fail_free_cache;
437 : : return 0;
438 : :
439 : : fail_free_cache:
440 : 0 : kmem_cache_destroy(bio_post_read_ctx_cache);
441 : : fail:
442 : : return -ENOMEM;
443 : : }
444 : :
445 : 0 : void ext4_exit_post_read_processing(void)
446 : : {
447 : 0 : mempool_destroy(bio_post_read_ctx_pool);
448 : 0 : kmem_cache_destroy(bio_post_read_ctx_cache);
449 : 0 : }
|
