1 // SPDX-License-Identifier: GPL-2.0
3 * Utility functions for file contents encryption/decryption on
4 * block device-based filesystems.
6 * Copyright (C) 2015, Google, Inc.
7 * Copyright (C) 2015, Motorola Mobility
10 #include <linux/pagemap.h>
11 #include <linux/module.h>
12 #include <linux/bio.h>
13 #include <linux/namei.h>
14 #include "fscrypt_private.h"
17 * fscrypt_decrypt_bio() - decrypt the contents of a bio
18 * @bio: the bio to decrypt
20 * Decrypt the contents of a "read" bio following successful completion of the
21 * underlying disk read. The bio must be reading a whole number of blocks of an
22 * encrypted file directly into the page cache. If the bio is reading the
23 * ciphertext into bounce pages instead of the page cache (for example, because
24 * the file is also compressed, so decompression is required after decryption),
25 * then this function isn't applicable. This function may sleep, so it must be
26 * called from a workqueue rather than from the bio's bi_end_io callback.
28 * This function sets PG_error on any pages that contain any blocks that failed
29 * to be decrypted. The filesystem must not mark such pages uptodate.
31 void fscrypt_decrypt_bio(struct bio *bio)
34 struct bvec_iter_all iter_all;
36 bio_for_each_segment_all(bv, bio, iter_all) {
37 struct page *page = bv->bv_page;
38 int ret = fscrypt_decrypt_pagecache_blocks(page, bv->bv_len,
44 EXPORT_SYMBOL(fscrypt_decrypt_bio);
46 static int fscrypt_zeroout_range_inline_crypt(const struct inode *inode,
47 pgoff_t lblk, sector_t pblk,
50 const unsigned int blockbits = inode->i_blkbits;
51 const unsigned int blocks_per_page = 1 << (PAGE_SHIFT - blockbits);
56 /* This always succeeds since __GFP_DIRECT_RECLAIM is set. */
57 bio = bio_alloc(GFP_NOFS, BIO_MAX_VECS);
60 unsigned int blocks_this_page = min(len, blocks_per_page);
61 unsigned int bytes_this_page = blocks_this_page << blockbits;
64 fscrypt_set_bio_crypt_ctx(bio, inode, lblk, GFP_NOFS);
65 bio_set_dev(bio, inode->i_sb->s_bdev);
66 bio->bi_iter.bi_sector =
67 pblk << (blockbits - SECTOR_SHIFT);
68 bio_set_op_attrs(bio, REQ_OP_WRITE, 0);
70 ret = bio_add_page(bio, ZERO_PAGE(0), bytes_this_page, 0);
71 if (WARN_ON(ret != bytes_this_page)) {
76 len -= blocks_this_page;
77 lblk += blocks_this_page;
78 pblk += blocks_this_page;
79 if (num_pages == BIO_MAX_VECS || !len ||
80 !fscrypt_mergeable_bio(bio, inode, lblk)) {
81 err = submit_bio_wait(bio);
94 * fscrypt_zeroout_range() - zero out a range of blocks in an encrypted file
95 * @inode: the file's inode
96 * @lblk: the first file logical block to zero out
97 * @pblk: the first filesystem physical block to zero out
98 * @len: number of blocks to zero out
100 * Zero out filesystem blocks in an encrypted regular file on-disk, i.e. write
101 * ciphertext blocks which decrypt to the all-zeroes block. The blocks must be
102 * both logically and physically contiguous. It's also assumed that the
103 * filesystem only uses a single block device, ->s_bdev.
105 * Note that since each block uses a different IV, this involves writing a
106 * different ciphertext to each block; we can't simply reuse the same one.
108 * Return: 0 on success; -errno on failure.
110 int fscrypt_zeroout_range(const struct inode *inode, pgoff_t lblk,
111 sector_t pblk, unsigned int len)
113 const unsigned int blockbits = inode->i_blkbits;
114 const unsigned int blocksize = 1 << blockbits;
115 const unsigned int blocks_per_page_bits = PAGE_SHIFT - blockbits;
116 const unsigned int blocks_per_page = 1 << blocks_per_page_bits;
117 struct page *pages[16]; /* write up to 16 pages at a time */
118 unsigned int nr_pages;
127 if (fscrypt_inode_uses_inline_crypto(inode))
128 return fscrypt_zeroout_range_inline_crypt(inode, lblk, pblk,
131 BUILD_BUG_ON(ARRAY_SIZE(pages) > BIO_MAX_VECS);
132 nr_pages = min_t(unsigned int, ARRAY_SIZE(pages),
133 (len + blocks_per_page - 1) >> blocks_per_page_bits);
136 * We need at least one page for ciphertext. Allocate the first one
137 * from a mempool, with __GFP_DIRECT_RECLAIM set so that it can't fail.
139 * Any additional page allocations are allowed to fail, as they only
140 * help performance, and waiting on the mempool for them could deadlock.
142 for (i = 0; i < nr_pages; i++) {
143 pages[i] = fscrypt_alloc_bounce_page(i == 0 ? GFP_NOFS :
144 GFP_NOWAIT | __GFP_NOWARN);
149 if (WARN_ON(nr_pages <= 0))
152 /* This always succeeds since __GFP_DIRECT_RECLAIM is set. */
153 bio = bio_alloc(GFP_NOFS, nr_pages);
156 bio_set_dev(bio, inode->i_sb->s_bdev);
157 bio->bi_iter.bi_sector = pblk << (blockbits - 9);
158 bio_set_op_attrs(bio, REQ_OP_WRITE, 0);
163 err = fscrypt_crypt_block(inode, FS_ENCRYPT, lblk,
164 ZERO_PAGE(0), pages[i],
165 blocksize, offset, GFP_NOFS);
172 if (offset == PAGE_SIZE || len == 0) {
173 ret = bio_add_page(bio, pages[i++], offset, 0);
174 if (WARN_ON(ret != offset)) {
180 } while (i != nr_pages && len != 0);
182 err = submit_bio_wait(bio);
190 for (i = 0; i < nr_pages; i++)
191 fscrypt_free_bounce_page(pages[i]);
194 EXPORT_SYMBOL(fscrypt_zeroout_range);