blob: b51330017ce10fab946713bdeb123ed6d7cc114d [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/drivers/block/loop.c
3 *
4 * Written by Theodore Ts'o, 3/29/93
5 *
6 * Copyright 1993 by Theodore Ts'o. Redistribution of this file is
7 * permitted under the GNU General Public License.
8 *
9 * DES encryption plus some minor changes by Werner Almesberger, 30-MAY-1993
10 * more DES encryption plus IDEA encryption by Nicholas J. Leon, June 20, 1996
11 *
12 * Modularized and updated for 1.1.16 kernel - Mitch Dsouza 28th May 1994
13 * Adapted for 1.3.59 kernel - Andries Brouwer, 1 Feb 1996
14 *
15 * Fixed do_loop_request() re-entrancy - Vincent.Renardias@waw.com Mar 20, 1997
16 *
17 * Added devfs support - Richard Gooch <rgooch@atnf.csiro.au> 16-Jan-1998
18 *
19 * Handle sparse backing files correctly - Kenn Humborg, Jun 28, 1998
20 *
21 * Loadable modules and other fixes by AK, 1998
22 *
23 * Make real block number available to downstream transfer functions, enables
24 * CBC (and relatives) mode encryption requiring unique IVs per data block.
25 * Reed H. Petty, rhp@draper.net
26 *
27 * Maximum number of loop devices now dynamic via max_loop module parameter.
28 * Russell Kroll <rkroll@exploits.org> 19990701
29 *
30 * Maximum number of loop devices when compiled-in now selectable by passing
31 * max_loop=<1-255> to the kernel on boot.
Jan Engelhardt96de0e22007-10-19 23:21:04 +020032 * Erik I. Bolsø, <eriki@himolde.no>, Oct 31, 1999
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 *
34 * Completely rewrite request handling to be make_request_fn style and
35 * non blocking, pushing work to a helper thread. Lots of fixes from
36 * Al Viro too.
37 * Jens Axboe <axboe@suse.de>, Nov 2000
38 *
39 * Support up to 256 loop devices
40 * Heinz Mauelshagen <mge@sistina.com>, Feb 2002
41 *
42 * Support for falling back on the write file operation when the address space
Nick Piggin4e02ed42008-10-29 14:00:55 -070043 * operations write_begin is not available on the backing filesystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 * Anton Altaparmakov, 16 Feb 2005
45 *
46 * Still To Fix:
47 * - Advisory locking is ignored here.
48 * - Should use an own CAP_* category instead of CAP_SYS_ADMIN
49 *
50 */
51
Linus Torvalds1da177e2005-04-16 15:20:36 -070052#include <linux/module.h>
53#include <linux/moduleparam.h>
54#include <linux/sched.h>
55#include <linux/fs.h>
56#include <linux/file.h>
57#include <linux/stat.h>
58#include <linux/errno.h>
59#include <linux/major.h>
60#include <linux/wait.h>
61#include <linux/blkdev.h>
62#include <linux/blkpg.h>
63#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070064#include <linux/swap.h>
65#include <linux/slab.h>
David Howells863d5b822006-08-29 19:06:14 +010066#include <linux/compat.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#include <linux/suspend.h>
Rafael J. Wysocki83144182007-07-17 04:03:35 -070068#include <linux/freezer.h>
Arnd Bergmann2a48fc02010-06-02 14:28:52 +020069#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070070#include <linux/writeback.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070071#include <linux/completion.h>
72#include <linux/highmem.h>
Serge E. Hallyn6c997912006-09-29 01:59:11 -070073#include <linux/kthread.h>
Jens Axboed6b29d72007-06-04 09:59:47 +020074#include <linux/splice.h>
Milan Brozee862732010-08-23 15:16:00 +020075#include <linux/sysfs.h>
Kay Sievers770fe302011-07-31 22:08:04 +020076#include <linux/miscdevice.h>
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +020077#include <linux/falloc.h>
Al Viro283e7e52015-04-03 15:21:59 -040078#include <linux/uio.h>
Adam Manzanaresd9a08a92018-05-22 10:52:19 -070079#include <linux/ioprio.h>
Dennis Zhoudb6638d2018-12-05 12:10:35 -050080#include <linux/blk-cgroup.h>
Adam Manzanaresd9a08a92018-05-22 10:52:19 -070081
Al Viro83a87612013-05-12 10:14:07 -040082#include "loop.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070083
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080084#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Kay Sievers34dd82a2011-07-31 22:08:04 +020086static DEFINE_IDR(loop_index_idr);
Tetsuo Handa310ca162018-11-08 14:01:02 +010087static DEFINE_MUTEX(loop_ctl_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Laurent Vivier476a4812008-03-26 12:11:53 +010089static int max_part;
90static int part_shift;
91
Linus Torvalds1da177e2005-04-16 15:20:36 -070092static int transfer_xor(struct loop_device *lo, int cmd,
93 struct page *raw_page, unsigned raw_off,
94 struct page *loop_page, unsigned loop_off,
95 int size, sector_t real_block)
96{
Cong Wangcfd80052011-11-25 23:14:18 +080097 char *raw_buf = kmap_atomic(raw_page) + raw_off;
98 char *loop_buf = kmap_atomic(loop_page) + loop_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 char *in, *out, *key;
100 int i, keysize;
101
102 if (cmd == READ) {
103 in = raw_buf;
104 out = loop_buf;
105 } else {
106 in = loop_buf;
107 out = raw_buf;
108 }
109
110 key = lo->lo_encrypt_key;
111 keysize = lo->lo_encrypt_key_size;
112 for (i = 0; i < size; i++)
113 *out++ = *in++ ^ key[(i & 511) % keysize];
114
Cong Wangcfd80052011-11-25 23:14:18 +0800115 kunmap_atomic(loop_buf);
116 kunmap_atomic(raw_buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 cond_resched();
118 return 0;
119}
120
121static int xor_init(struct loop_device *lo, const struct loop_info64 *info)
122{
123 if (unlikely(info->lo_encrypt_key_size <= 0))
124 return -EINVAL;
125 return 0;
126}
127
128static struct loop_func_table none_funcs = {
129 .number = LO_CRYPT_NONE,
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200130};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
132static struct loop_func_table xor_funcs = {
133 .number = LO_CRYPT_XOR,
134 .transfer = transfer_xor,
135 .init = xor_init
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200136};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138/* xfer_funcs[0] is special - its release function is never called */
139static struct loop_func_table *xfer_funcs[MAX_LO_CRYPT] = {
140 &none_funcs,
141 &xor_funcs
142};
143
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100144static loff_t get_size(loff_t offset, loff_t sizelimit, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145{
Guo Chaob7a1da62013-02-21 15:16:50 -0800146 loff_t loopsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
148 /* Compute loopsize in bytes */
Guo Chaob7a1da62013-02-21 15:16:50 -0800149 loopsize = i_size_read(file->f_mapping->host);
150 if (offset > 0)
151 loopsize -= offset;
152 /* offset is beyond i_size, weird but possible */
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100153 if (loopsize < 0)
154 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100156 if (sizelimit > 0 && sizelimit < loopsize)
157 loopsize = sizelimit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 /*
159 * Unfortunately, if we want to do I/O on the device,
160 * the number of 512-byte sectors has to fit into a sector_t.
161 */
162 return loopsize >> 9;
163}
164
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100165static loff_t get_loop_size(struct loop_device *lo, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166{
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100167 return get_size(lo->lo_offset, lo->lo_sizelimit, file);
168}
169
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800170static void __loop_update_dio(struct loop_device *lo, bool dio)
171{
172 struct file *file = lo->lo_backing_file;
173 struct address_space *mapping = file->f_mapping;
174 struct inode *inode = mapping->host;
175 unsigned short sb_bsize = 0;
176 unsigned dio_align = 0;
177 bool use_dio;
178
179 if (inode->i_sb->s_bdev) {
180 sb_bsize = bdev_logical_block_size(inode->i_sb->s_bdev);
181 dio_align = sb_bsize - 1;
182 }
183
184 /*
185 * We support direct I/O only if lo_offset is aligned with the
186 * logical I/O size of backing device, and the logical block
187 * size of loop is bigger than the backing device's and the loop
188 * needn't transform transfer.
189 *
190 * TODO: the above condition may be loosed in the future, and
191 * direct I/O may be switched runtime at that time because most
Masahiro Yamada89d790a2017-02-27 14:29:01 -0800192 * of requests in sane applications should be PAGE_SIZE aligned
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800193 */
194 if (dio) {
195 if (queue_logical_block_size(lo->lo_queue) >= sb_bsize &&
196 !(lo->lo_offset & dio_align) &&
197 mapping->a_ops->direct_IO &&
198 !lo->transfer)
199 use_dio = true;
200 else
201 use_dio = false;
202 } else {
203 use_dio = false;
204 }
205
206 if (lo->use_dio == use_dio)
207 return;
208
209 /* flush dirty pages before changing direct IO */
210 vfs_fsync(file, 0);
211
212 /*
213 * The flag of LO_FLAGS_DIRECT_IO is handled similarly with
214 * LO_FLAGS_READ_ONLY, both are set from kernel, and losetup
215 * will get updated by ioctl(LOOP_GET_STATUS)
216 */
Martijn Coenen0fbcf572020-03-10 14:06:54 +0100217 if (lo->lo_state == Lo_bound)
218 blk_mq_freeze_queue(lo->lo_queue);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800219 lo->use_dio = use_dio;
Shaohua Li40326d82017-08-31 22:09:46 -0700220 if (use_dio) {
Bart Van Assche8b904b52018-03-07 17:10:10 -0800221 blk_queue_flag_clear(QUEUE_FLAG_NOMERGES, lo->lo_queue);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800222 lo->lo_flags |= LO_FLAGS_DIRECT_IO;
Shaohua Li40326d82017-08-31 22:09:46 -0700223 } else {
Bart Van Assche8b904b52018-03-07 17:10:10 -0800224 blk_queue_flag_set(QUEUE_FLAG_NOMERGES, lo->lo_queue);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800225 lo->lo_flags &= ~LO_FLAGS_DIRECT_IO;
Shaohua Li40326d82017-08-31 22:09:46 -0700226 }
Martijn Coenen0fbcf572020-03-10 14:06:54 +0100227 if (lo->lo_state == Lo_bound)
228 blk_mq_unfreeze_queue(lo->lo_queue);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800229}
230
Martijn Coenen5795b6f2020-05-13 15:38:37 +0200231/**
Martijn Coenen34489142020-05-13 15:38:45 +0200232 * loop_validate_block_size() - validates the passed in block size
233 * @bsize: size to validate
234 */
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100235static int
Martijn Coenen34489142020-05-13 15:38:45 +0200236loop_validate_block_size(unsigned short bsize)
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100237{
Martijn Coenen34489142020-05-13 15:38:45 +0200238 if (bsize < 512 || bsize > PAGE_SIZE || !is_power_of_2(bsize))
239 return -EINVAL;
240
241 return 0;
242}
243
244/**
Martijn Coenen5795b6f2020-05-13 15:38:37 +0200245 * loop_set_size() - sets device size and notifies userspace
246 * @lo: struct loop_device to set the size for
247 * @size: new size of the loop device
248 *
249 * Callers must validate that the size passed into this function fits into
250 * a sector_t, eg using loop_validate_size()
251 */
252static void loop_set_size(struct loop_device *lo, loff_t size)
253{
Christoph Hellwig449f4ec2020-11-16 15:56:56 +0100254 if (!set_capacity_and_notify(lo->lo_disk, size))
Christoph Hellwig3b4f85d2020-11-16 15:56:53 +0100255 kobject_uevent(&disk_to_dev(lo->lo_disk)->kobj, KOBJ_CHANGE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256}
257
258static inline int
259lo_do_transfer(struct loop_device *lo, int cmd,
260 struct page *rpage, unsigned roffs,
261 struct page *lpage, unsigned loffs,
262 int size, sector_t rblock)
263{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200264 int ret;
265
266 ret = lo->transfer(lo, cmd, rpage, roffs, lpage, loffs, size, rblock);
267 if (likely(!ret))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 return 0;
269
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200270 printk_ratelimited(KERN_ERR
271 "loop: Transfer error at byte offset %llu, length %i.\n",
272 (unsigned long long)rblock << 9, size);
273 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274}
275
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200276static int lo_write_bvec(struct file *file, struct bio_vec *bvec, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200278 struct iov_iter i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 ssize_t bw;
Al Viro283e7e52015-04-03 15:21:59 -0400280
Christoph Hellwigb6207432019-06-26 15:49:28 +0200281 iov_iter_bvec(&i, WRITE, bvec, 1, bvec->bv_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
Al Viro03d95eb2013-03-20 13:04:20 -0400283 file_start_write(file);
Christoph Hellwigabbb65892017-05-27 11:16:52 +0300284 bw = vfs_iter_write(file, &i, ppos, 0);
Al Viro03d95eb2013-03-20 13:04:20 -0400285 file_end_write(file);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200286
287 if (likely(bw == bvec->bv_len))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 return 0;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200289
290 printk_ratelimited(KERN_ERR
291 "loop: Write error at byte offset %llu, length %i.\n",
292 (unsigned long long)*ppos, bvec->bv_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 if (bw >= 0)
294 bw = -EIO;
295 return bw;
296}
297
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200298static int lo_write_simple(struct loop_device *lo, struct request *rq,
299 loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200301 struct bio_vec bvec;
302 struct req_iterator iter;
303 int ret = 0;
304
305 rq_for_each_segment(bvec, rq, iter) {
306 ret = lo_write_bvec(lo->lo_backing_file, &bvec, &pos);
307 if (ret < 0)
308 break;
309 cond_resched();
310 }
311
312 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313}
314
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200315/*
Christoph Hellwig456be142011-10-17 12:57:20 +0200316 * This is the slow, transforming version that needs to double buffer the
317 * data as it cannot do the transformations in place without having direct
318 * access to the destination pages of the backing file.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 */
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200320static int lo_write_transfer(struct loop_device *lo, struct request *rq,
321 loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200323 struct bio_vec bvec, b;
Ming Lei30112012014-12-31 13:22:58 +0000324 struct req_iterator iter;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200325 struct page *page;
Kent Overstreet79886132013-11-23 17:19:00 -0800326 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200328 page = alloc_page(GFP_NOIO);
329 if (unlikely(!page))
330 return -ENOMEM;
Christoph Hellwig456be142011-10-17 12:57:20 +0200331
Ming Lei30112012014-12-31 13:22:58 +0000332 rq_for_each_segment(bvec, rq, iter) {
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200333 ret = lo_do_transfer(lo, WRITE, page, 0, bvec.bv_page,
334 bvec.bv_offset, bvec.bv_len, pos >> 9);
335 if (unlikely(ret))
336 break;
337
338 b.bv_page = page;
339 b.bv_offset = 0;
340 b.bv_len = bvec.bv_len;
341 ret = lo_write_bvec(lo->lo_backing_file, &b, &pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 if (ret < 0)
343 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 }
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200345
346 __free_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348}
349
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200350static int lo_read_simple(struct loop_device *lo, struct request *rq,
351 loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352{
Kent Overstreet79886132013-11-23 17:19:00 -0800353 struct bio_vec bvec;
Ming Lei30112012014-12-31 13:22:58 +0000354 struct req_iterator iter;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200355 struct iov_iter i;
356 ssize_t len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357
Ming Lei30112012014-12-31 13:22:58 +0000358 rq_for_each_segment(bvec, rq, iter) {
Christoph Hellwigb6207432019-06-26 15:49:28 +0200359 iov_iter_bvec(&i, READ, &bvec, 1, bvec.bv_len);
Christoph Hellwig18e97102017-05-27 11:16:51 +0300360 len = vfs_iter_read(lo->lo_backing_file, &i, &pos, 0);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200361 if (len < 0)
362 return len;
Dave Young306df072012-02-08 22:07:19 +0100363
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200364 flush_dcache_page(bvec.bv_page);
365
366 if (len != bvec.bv_len) {
Ming Lei30112012014-12-31 13:22:58 +0000367 struct bio *bio;
368
369 __rq_for_each_bio(bio, rq)
370 zero_fill_bio(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 break;
Dave Young306df072012-02-08 22:07:19 +0100372 }
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200373 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 }
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200375
Dave Young306df072012-02-08 22:07:19 +0100376 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377}
378
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200379static int lo_read_transfer(struct loop_device *lo, struct request *rq,
380 loff_t pos)
381{
382 struct bio_vec bvec, b;
383 struct req_iterator iter;
384 struct iov_iter i;
385 struct page *page;
386 ssize_t len;
387 int ret = 0;
388
389 page = alloc_page(GFP_NOIO);
390 if (unlikely(!page))
391 return -ENOMEM;
392
393 rq_for_each_segment(bvec, rq, iter) {
394 loff_t offset = pos;
395
396 b.bv_page = page;
397 b.bv_offset = 0;
398 b.bv_len = bvec.bv_len;
399
Christoph Hellwigb6207432019-06-26 15:49:28 +0200400 iov_iter_bvec(&i, READ, &b, 1, b.bv_len);
Christoph Hellwig18e97102017-05-27 11:16:51 +0300401 len = vfs_iter_read(lo->lo_backing_file, &i, &pos, 0);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200402 if (len < 0) {
403 ret = len;
404 goto out_free_page;
405 }
406
407 ret = lo_do_transfer(lo, READ, page, 0, bvec.bv_page,
408 bvec.bv_offset, len, offset >> 9);
409 if (ret)
410 goto out_free_page;
411
412 flush_dcache_page(bvec.bv_page);
413
414 if (len != bvec.bv_len) {
415 struct bio *bio;
416
417 __rq_for_each_bio(bio, rq)
418 zero_fill_bio(bio);
419 break;
420 }
421 }
422
423 ret = 0;
424out_free_page:
425 __free_page(page);
426 return ret;
427}
428
Darrick J. Wongefcfec572019-10-30 20:29:48 -0700429static int lo_fallocate(struct loop_device *lo, struct request *rq, loff_t pos,
430 int mode)
Ming Leicf655d92014-12-31 13:22:59 +0000431{
432 /*
Darrick J. Wongefcfec572019-10-30 20:29:48 -0700433 * We use fallocate to manipulate the space mappings used by the image
434 * a.k.a. discard/zerorange. However we do not support this if
435 * encryption is enabled, because it may give an attacker useful
436 * information.
Ming Leicf655d92014-12-31 13:22:59 +0000437 */
438 struct file *file = lo->lo_backing_file;
Evan Greenc52abf52020-04-03 16:43:04 +0200439 struct request_queue *q = lo->lo_queue;
Ming Leicf655d92014-12-31 13:22:59 +0000440 int ret;
441
Darrick J. Wongefcfec572019-10-30 20:29:48 -0700442 mode |= FALLOC_FL_KEEP_SIZE;
443
Evan Greenc52abf52020-04-03 16:43:04 +0200444 if (!blk_queue_discard(q)) {
Ming Leicf655d92014-12-31 13:22:59 +0000445 ret = -EOPNOTSUPP;
446 goto out;
447 }
448
449 ret = file->f_op->fallocate(file, mode, pos, blk_rq_bytes(rq));
450 if (unlikely(ret && ret != -EINVAL && ret != -EOPNOTSUPP))
451 ret = -EIO;
452 out:
453 return ret;
454}
455
456static int lo_req_flush(struct loop_device *lo, struct request *rq)
457{
458 struct file *file = lo->lo_backing_file;
459 int ret = vfs_fsync(file, 0);
460 if (unlikely(ret && ret != -EINVAL))
461 ret = -EIO;
462
463 return ret;
464}
465
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200466static void lo_complete_rq(struct request *rq)
Ming Leibc07c102015-08-17 10:31:51 +0800467{
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200468 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
Jens Axboef9de14b2018-04-13 16:25:57 -0600469 blk_status_t ret = BLK_STS_OK;
Ming Leibc07c102015-08-17 10:31:51 +0800470
Jens Axboef9de14b2018-04-13 16:25:57 -0600471 if (!cmd->use_aio || cmd->ret < 0 || cmd->ret == blk_rq_bytes(rq) ||
472 req_op(rq) != REQ_OP_READ) {
473 if (cmd->ret < 0)
Evan Green8cd55082020-04-03 16:43:03 +0200474 ret = errno_to_blk_status(cmd->ret);
Jens Axboef9de14b2018-04-13 16:25:57 -0600475 goto end_io;
Ming Leibc07c102015-08-17 10:31:51 +0800476 }
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200477
Jens Axboef9de14b2018-04-13 16:25:57 -0600478 /*
479 * Short READ - if we got some data, advance our request and
480 * retry it. If we got no data, end the rest with EIO.
481 */
482 if (cmd->ret) {
483 blk_update_request(rq, BLK_STS_OK, cmd->ret);
484 cmd->ret = 0;
485 blk_mq_requeue_request(rq, true);
486 } else {
487 if (cmd->use_aio) {
488 struct bio *bio = rq->bio;
489
490 while (bio) {
491 zero_fill_bio(bio);
492 bio = bio->bi_next;
493 }
494 }
495 ret = BLK_STS_IOERR;
496end_io:
497 blk_mq_end_request(rq, ret);
498 }
Ming Leibc07c102015-08-17 10:31:51 +0800499}
500
Shaohua Li92d77332017-09-01 11:15:17 -0700501static void lo_rw_aio_do_completion(struct loop_cmd *cmd)
502{
Jens Axboe1894e912018-04-13 16:24:29 -0600503 struct request *rq = blk_mq_rq_from_pdu(cmd);
504
Shaohua Li92d77332017-09-01 11:15:17 -0700505 if (!atomic_dec_and_test(&cmd->ref))
506 return;
507 kfree(cmd->bvec);
508 cmd->bvec = NULL;
Christoph Hellwig15f73f52020-06-11 08:44:47 +0200509 if (likely(!blk_should_fake_timeout(rq->q)))
510 blk_mq_complete_request(rq);
Shaohua Li92d77332017-09-01 11:15:17 -0700511}
512
Ming Leibc07c102015-08-17 10:31:51 +0800513static void lo_rw_aio_complete(struct kiocb *iocb, long ret, long ret2)
514{
515 struct loop_cmd *cmd = container_of(iocb, struct loop_cmd, iocb);
Ming Leibc07c102015-08-17 10:31:51 +0800516
Shaohua Lid4478e92017-09-25 13:07:22 -0600517 if (cmd->css)
518 css_put(cmd->css);
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200519 cmd->ret = ret;
Shaohua Li92d77332017-09-01 11:15:17 -0700520 lo_rw_aio_do_completion(cmd);
Ming Leibc07c102015-08-17 10:31:51 +0800521}
522
523static int lo_rw_aio(struct loop_device *lo, struct loop_cmd *cmd,
524 loff_t pos, bool rw)
525{
526 struct iov_iter iter;
Ming Lei86af5952019-02-15 19:13:17 +0800527 struct req_iterator rq_iter;
Ming Leibc07c102015-08-17 10:31:51 +0800528 struct bio_vec *bvec;
Jens Axboe1894e912018-04-13 16:24:29 -0600529 struct request *rq = blk_mq_rq_from_pdu(cmd);
Shaohua Li40326d82017-08-31 22:09:46 -0700530 struct bio *bio = rq->bio;
Ming Leibc07c102015-08-17 10:31:51 +0800531 struct file *file = lo->lo_backing_file;
Ming Lei86af5952019-02-15 19:13:17 +0800532 struct bio_vec tmp;
Shaohua Li40326d82017-08-31 22:09:46 -0700533 unsigned int offset;
Ming Lei86af5952019-02-15 19:13:17 +0800534 int nr_bvec = 0;
Ming Leibc07c102015-08-17 10:31:51 +0800535 int ret;
536
Ming Lei86af5952019-02-15 19:13:17 +0800537 rq_for_each_bvec(tmp, rq, rq_iter)
538 nr_bvec++;
Ming Leibc07c102015-08-17 10:31:51 +0800539
Ming Lei86af5952019-02-15 19:13:17 +0800540 if (rq->bio != rq->biotail) {
541
542 bvec = kmalloc_array(nr_bvec, sizeof(struct bio_vec),
Kees Cook6da2ec52018-06-12 13:55:00 -0700543 GFP_NOIO);
Shaohua Li40326d82017-08-31 22:09:46 -0700544 if (!bvec)
545 return -EIO;
546 cmd->bvec = bvec;
547
548 /*
549 * The bios of the request may be started from the middle of
550 * the 'bvec' because of bio splitting, so we can't directly
Ming Lei86af5952019-02-15 19:13:17 +0800551 * copy bio->bi_iov_vec to new bvec. The rq_for_each_bvec
Shaohua Li40326d82017-08-31 22:09:46 -0700552 * API will take care of all details for us.
553 */
Ming Lei86af5952019-02-15 19:13:17 +0800554 rq_for_each_bvec(tmp, rq, rq_iter) {
Shaohua Li40326d82017-08-31 22:09:46 -0700555 *bvec = tmp;
556 bvec++;
557 }
558 bvec = cmd->bvec;
559 offset = 0;
560 } else {
561 /*
562 * Same here, this bio may be started from the middle of the
563 * 'bvec' because of bio splitting, so offset from the bvec
564 * must be passed to iov iterator
565 */
566 offset = bio->bi_iter.bi_bvec_done;
567 bvec = __bvec_iter_bvec(bio->bi_io_vec, bio->bi_iter);
Shaohua Li40326d82017-08-31 22:09:46 -0700568 }
Shaohua Li92d77332017-09-01 11:15:17 -0700569 atomic_set(&cmd->ref, 2);
Shaohua Li40326d82017-08-31 22:09:46 -0700570
Christoph Hellwigb6207432019-06-26 15:49:28 +0200571 iov_iter_bvec(&iter, rw, bvec, nr_bvec, blk_rq_bytes(rq));
Shaohua Li40326d82017-08-31 22:09:46 -0700572 iter.iov_offset = offset;
Ming Leibc07c102015-08-17 10:31:51 +0800573
574 cmd->iocb.ki_pos = pos;
575 cmd->iocb.ki_filp = file;
576 cmd->iocb.ki_complete = lo_rw_aio_complete;
577 cmd->iocb.ki_flags = IOCB_DIRECT;
Adam Manzanaresd9a08a92018-05-22 10:52:19 -0700578 cmd->iocb.ki_ioprio = IOPRIO_PRIO_VALUE(IOPRIO_CLASS_NONE, 0);
Shaohua Lid4478e92017-09-25 13:07:22 -0600579 if (cmd->css)
580 kthread_associate_blkcg(cmd->css);
Ming Leibc07c102015-08-17 10:31:51 +0800581
582 if (rw == WRITE)
Miklos Szeredibb7462b2017-02-20 16:51:23 +0100583 ret = call_write_iter(file, &cmd->iocb, &iter);
Ming Leibc07c102015-08-17 10:31:51 +0800584 else
Miklos Szeredibb7462b2017-02-20 16:51:23 +0100585 ret = call_read_iter(file, &cmd->iocb, &iter);
Ming Leibc07c102015-08-17 10:31:51 +0800586
Shaohua Li92d77332017-09-01 11:15:17 -0700587 lo_rw_aio_do_completion(cmd);
Shaohua Lid4478e92017-09-25 13:07:22 -0600588 kthread_associate_blkcg(NULL);
Shaohua Li92d77332017-09-01 11:15:17 -0700589
Ming Leibc07c102015-08-17 10:31:51 +0800590 if (ret != -EIOCBQUEUED)
591 cmd->iocb.ki_complete(&cmd->iocb, ret, 0);
592 return 0;
593}
594
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200595static int do_req_filebacked(struct loop_device *lo, struct request *rq)
Ming Leibc07c102015-08-17 10:31:51 +0800596{
597 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200598 loff_t pos = ((loff_t) blk_rq_pos(rq) << 9) + lo->lo_offset;
Ming Leibc07c102015-08-17 10:31:51 +0800599
600 /*
601 * lo_write_simple and lo_read_simple should have been covered
602 * by io submit style function like lo_rw_aio(), one blocker
603 * is that lo_read_simple() need to call flush_dcache_page after
604 * the page is written from kernel, and it isn't easy to handle
605 * this in io submit style function which submits all segments
606 * of the req at one time. And direct read IO doesn't need to
607 * run flush_dcache_page().
608 */
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200609 switch (req_op(rq)) {
610 case REQ_OP_FLUSH:
611 return lo_req_flush(lo, rq);
Christoph Hellwig19372e22017-04-05 19:21:15 +0200612 case REQ_OP_WRITE_ZEROES:
Darrick J. Wongefcfec572019-10-30 20:29:48 -0700613 /*
614 * If the caller doesn't want deallocation, call zeroout to
615 * write zeroes the range. Otherwise, punch them out.
616 */
617 return lo_fallocate(lo, rq, pos,
618 (rq->cmd_flags & REQ_NOUNMAP) ?
619 FALLOC_FL_ZERO_RANGE :
620 FALLOC_FL_PUNCH_HOLE);
621 case REQ_OP_DISCARD:
622 return lo_fallocate(lo, rq, pos, FALLOC_FL_PUNCH_HOLE);
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200623 case REQ_OP_WRITE:
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200624 if (lo->transfer)
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200625 return lo_write_transfer(lo, rq, pos);
626 else if (cmd->use_aio)
627 return lo_rw_aio(lo, cmd, pos, WRITE);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200628 else
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200629 return lo_write_simple(lo, rq, pos);
630 case REQ_OP_READ:
631 if (lo->transfer)
632 return lo_read_transfer(lo, rq, pos);
633 else if (cmd->use_aio)
634 return lo_rw_aio(lo, cmd, pos, READ);
635 else
636 return lo_read_simple(lo, rq, pos);
637 default:
638 WARN_ON_ONCE(1);
639 return -EIO;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200640 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641}
642
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800643static inline void loop_update_dio(struct loop_device *lo)
644{
Ira Weinyefbe3c22020-04-30 07:41:33 -0700645 __loop_update_dio(lo, (lo->lo_backing_file->f_flags & O_DIRECT) |
646 lo->use_dio);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800647}
648
Ming Lei06f0e9e2015-05-06 12:26:24 +0800649static void loop_reread_partitions(struct loop_device *lo,
650 struct block_device *bdev)
651{
652 int rc;
653
Christoph Hellwigf0b870d2019-11-14 15:34:36 +0100654 mutex_lock(&bdev->bd_mutex);
655 rc = bdev_disk_changed(bdev, false);
656 mutex_unlock(&bdev->bd_mutex);
Ming Lei06f0e9e2015-05-06 12:26:24 +0800657 if (rc)
658 pr_warn("%s: partition scan of loop%d (%s) failed (rc=%d)\n",
659 __func__, lo->lo_number, lo->lo_file_name, rc);
660}
661
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400662static inline int is_loop_device(struct file *file)
663{
664 struct inode *i = file->f_mapping->host;
665
Al Viro6f247842021-01-31 19:23:55 -0500666 return i && S_ISBLK(i->i_mode) && imajor(i) == LOOP_MAJOR;
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400667}
668
669static int loop_validate_file(struct file *file, struct block_device *bdev)
670{
671 struct inode *inode = file->f_mapping->host;
672 struct file *f = file;
673
674 /* Avoid recursion */
675 while (is_loop_device(f)) {
676 struct loop_device *l;
677
Christoph Hellwig4e7b5672020-11-23 13:38:40 +0100678 if (f->f_mapping->host->i_rdev == bdev->bd_dev)
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400679 return -EBADF;
680
Christoph Hellwig4e7b5672020-11-23 13:38:40 +0100681 l = I_BDEV(f->f_mapping->host)->bd_disk->private_data;
Dongli Zhangf7c8a412019-03-18 20:23:17 +0800682 if (l->lo_state != Lo_bound) {
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400683 return -EINVAL;
684 }
685 f = l->lo_backing_file;
686 }
687 if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
688 return -EINVAL;
689 return 0;
690}
691
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692/*
693 * loop_change_fd switched the backing store of a loopback device to
694 * a new file. This is useful for operating system installers to free up
695 * the original file and in High Availability environments to switch to
696 * an alternative location for the content in case of server meltdown.
697 * This can only work if the loop device is used read-only, and if the
698 * new backing store is the same size and type as the old backing store.
699 */
Al Virobb214882008-03-02 09:29:48 -0500700static int loop_change_fd(struct loop_device *lo, struct block_device *bdev,
701 unsigned int arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702{
Jan Kara1dded9a2018-11-08 14:01:15 +0100703 struct file *file = NULL, *old_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 int error;
Jan Kara85b0a542018-11-08 14:01:13 +0100705 bool partscan;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706
Jan Karac28445f2018-11-08 14:01:16 +0100707 error = mutex_lock_killable(&loop_ctl_mutex);
Jan Karac3710772018-11-08 14:01:11 +0100708 if (error)
709 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 error = -ENXIO;
711 if (lo->lo_state != Lo_bound)
Jan Kara1dded9a2018-11-08 14:01:15 +0100712 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
714 /* the loop device has to be read-only */
715 error = -EINVAL;
716 if (!(lo->lo_flags & LO_FLAGS_READ_ONLY))
Jan Kara1dded9a2018-11-08 14:01:15 +0100717 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718
719 error = -EBADF;
720 file = fget(arg);
721 if (!file)
Jan Kara1dded9a2018-11-08 14:01:15 +0100722 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400724 error = loop_validate_file(file, bdev);
725 if (error)
Jan Kara1dded9a2018-11-08 14:01:15 +0100726 goto out_err;
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400727
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 old_file = lo->lo_backing_file;
729
730 error = -EINVAL;
731
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 /* size of the new backing store needs to be the same */
733 if (get_loop_size(lo, file) != get_loop_size(lo, old_file))
Jan Kara1dded9a2018-11-08 14:01:15 +0100734 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735
736 /* and ... switch */
Omar Sandoval43cade802017-08-24 00:03:44 -0700737 blk_mq_freeze_queue(lo->lo_queue);
738 mapping_set_gfp_mask(old_file->f_mapping, lo->old_gfp_mask);
739 lo->lo_backing_file = file;
740 lo->old_gfp_mask = mapping_gfp_mask(file->f_mapping);
741 mapping_set_gfp_mask(file->f_mapping,
742 lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
743 loop_update_dio(lo);
744 blk_mq_unfreeze_queue(lo->lo_queue);
Jan Kara85b0a542018-11-08 14:01:13 +0100745 partscan = lo->lo_flags & LO_FLAGS_PARTSCAN;
Jan Karac3710772018-11-08 14:01:11 +0100746 mutex_unlock(&loop_ctl_mutex);
Jan Kara1dded9a2018-11-08 14:01:15 +0100747 /*
748 * We must drop file reference outside of loop_ctl_mutex as dropping
749 * the file ref can take bd_mutex which creates circular locking
750 * dependency.
751 */
752 fput(old_file);
Jan Kara85b0a542018-11-08 14:01:13 +0100753 if (partscan)
754 loop_reread_partitions(lo, bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 return 0;
756
Jan Kara1dded9a2018-11-08 14:01:15 +0100757out_err:
Jan Karac3710772018-11-08 14:01:11 +0100758 mutex_unlock(&loop_ctl_mutex);
Jan Kara1dded9a2018-11-08 14:01:15 +0100759 if (file)
760 fput(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 return error;
762}
763
Milan Brozee862732010-08-23 15:16:00 +0200764/* loop sysfs attributes */
765
766static ssize_t loop_attr_show(struct device *dev, char *page,
767 ssize_t (*callback)(struct loop_device *, char *))
768{
Kay Sievers34dd82a2011-07-31 22:08:04 +0200769 struct gendisk *disk = dev_to_disk(dev);
770 struct loop_device *lo = disk->private_data;
Milan Brozee862732010-08-23 15:16:00 +0200771
Kay Sievers34dd82a2011-07-31 22:08:04 +0200772 return callback(lo, page);
Milan Brozee862732010-08-23 15:16:00 +0200773}
774
775#define LOOP_ATTR_RO(_name) \
776static ssize_t loop_attr_##_name##_show(struct loop_device *, char *); \
777static ssize_t loop_attr_do_show_##_name(struct device *d, \
778 struct device_attribute *attr, char *b) \
779{ \
780 return loop_attr_show(d, b, loop_attr_##_name##_show); \
781} \
782static struct device_attribute loop_attr_##_name = \
Joe Perches5657a812018-05-24 13:38:59 -0600783 __ATTR(_name, 0444, loop_attr_do_show_##_name, NULL);
Milan Brozee862732010-08-23 15:16:00 +0200784
785static ssize_t loop_attr_backing_file_show(struct loop_device *lo, char *buf)
786{
787 ssize_t ret;
788 char *p = NULL;
789
Kay Sievers05eb0f22011-07-31 22:21:35 +0200790 spin_lock_irq(&lo->lo_lock);
Milan Brozee862732010-08-23 15:16:00 +0200791 if (lo->lo_backing_file)
Miklos Szeredi9bf39ab2015-06-19 10:29:13 +0200792 p = file_path(lo->lo_backing_file, buf, PAGE_SIZE - 1);
Kay Sievers05eb0f22011-07-31 22:21:35 +0200793 spin_unlock_irq(&lo->lo_lock);
Milan Brozee862732010-08-23 15:16:00 +0200794
795 if (IS_ERR_OR_NULL(p))
796 ret = PTR_ERR(p);
797 else {
798 ret = strlen(p);
799 memmove(buf, p, ret);
800 buf[ret++] = '\n';
801 buf[ret] = 0;
802 }
803
804 return ret;
805}
806
807static ssize_t loop_attr_offset_show(struct loop_device *lo, char *buf)
808{
809 return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_offset);
810}
811
812static ssize_t loop_attr_sizelimit_show(struct loop_device *lo, char *buf)
813{
814 return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_sizelimit);
815}
816
817static ssize_t loop_attr_autoclear_show(struct loop_device *lo, char *buf)
818{
819 int autoclear = (lo->lo_flags & LO_FLAGS_AUTOCLEAR);
820
821 return sprintf(buf, "%s\n", autoclear ? "1" : "0");
822}
823
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200824static ssize_t loop_attr_partscan_show(struct loop_device *lo, char *buf)
825{
826 int partscan = (lo->lo_flags & LO_FLAGS_PARTSCAN);
827
828 return sprintf(buf, "%s\n", partscan ? "1" : "0");
829}
830
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800831static ssize_t loop_attr_dio_show(struct loop_device *lo, char *buf)
832{
833 int dio = (lo->lo_flags & LO_FLAGS_DIRECT_IO);
834
835 return sprintf(buf, "%s\n", dio ? "1" : "0");
836}
837
Milan Brozee862732010-08-23 15:16:00 +0200838LOOP_ATTR_RO(backing_file);
839LOOP_ATTR_RO(offset);
840LOOP_ATTR_RO(sizelimit);
841LOOP_ATTR_RO(autoclear);
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200842LOOP_ATTR_RO(partscan);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800843LOOP_ATTR_RO(dio);
Milan Brozee862732010-08-23 15:16:00 +0200844
845static struct attribute *loop_attrs[] = {
846 &loop_attr_backing_file.attr,
847 &loop_attr_offset.attr,
848 &loop_attr_sizelimit.attr,
849 &loop_attr_autoclear.attr,
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200850 &loop_attr_partscan.attr,
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800851 &loop_attr_dio.attr,
Milan Brozee862732010-08-23 15:16:00 +0200852 NULL,
853};
854
855static struct attribute_group loop_attribute_group = {
856 .name = "loop",
857 .attrs= loop_attrs,
858};
859
Tetsuo Handad3349b62018-05-04 10:58:09 -0600860static void loop_sysfs_init(struct loop_device *lo)
Milan Brozee862732010-08-23 15:16:00 +0200861{
Tetsuo Handad3349b62018-05-04 10:58:09 -0600862 lo->sysfs_inited = !sysfs_create_group(&disk_to_dev(lo->lo_disk)->kobj,
863 &loop_attribute_group);
Milan Brozee862732010-08-23 15:16:00 +0200864}
865
866static void loop_sysfs_exit(struct loop_device *lo)
867{
Tetsuo Handad3349b62018-05-04 10:58:09 -0600868 if (lo->sysfs_inited)
869 sysfs_remove_group(&disk_to_dev(lo->lo_disk)->kobj,
870 &loop_attribute_group);
Milan Brozee862732010-08-23 15:16:00 +0200871}
872
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200873static void loop_config_discard(struct loop_device *lo)
874{
875 struct file *file = lo->lo_backing_file;
876 struct inode *inode = file->f_mapping->host;
877 struct request_queue *q = lo->lo_queue;
Ming Leibcb21c82020-08-17 18:01:30 +0800878 u32 granularity, max_discard_sectors;
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200879
880 /*
Evan Greenc52abf52020-04-03 16:43:04 +0200881 * If the backing device is a block device, mirror its zeroing
882 * capability. Set the discard sectors to the block device's zeroing
883 * capabilities because loop discards result in blkdev_issue_zeroout(),
884 * not blkdev_issue_discard(). This maintains consistent behavior with
885 * file-backed loop devices: discarded regions read back as zero.
886 */
887 if (S_ISBLK(inode->i_mode) && !lo->lo_encrypt_key_size) {
Christoph Hellwig4e7b5672020-11-23 13:38:40 +0100888 struct request_queue *backingq = bdev_get_queue(I_BDEV(inode));
Evan Greenc52abf52020-04-03 16:43:04 +0200889
Ming Leibcb21c82020-08-17 18:01:30 +0800890 max_discard_sectors = backingq->limits.max_write_zeroes_sectors;
891 granularity = backingq->limits.discard_granularity ?:
892 queue_physical_block_size(backingq);
Evan Greenc52abf52020-04-03 16:43:04 +0200893
894 /*
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200895 * We use punch hole to reclaim the free space used by the
Olaf Hering12a64d22014-01-21 14:39:24 -0800896 * image a.k.a. discard. However we do not support discard if
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200897 * encryption is enabled, because it may give an attacker
898 * useful information.
899 */
Evan Greenc52abf52020-04-03 16:43:04 +0200900 } else if (!file->f_op->fallocate || lo->lo_encrypt_key_size) {
Ming Leibcb21c82020-08-17 18:01:30 +0800901 max_discard_sectors = 0;
902 granularity = 0;
Evan Greenc52abf52020-04-03 16:43:04 +0200903
904 } else {
Ming Leibcb21c82020-08-17 18:01:30 +0800905 max_discard_sectors = UINT_MAX >> 9;
906 granularity = inode->i_sb->s_blocksize;
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200907 }
908
Ming Leibcb21c82020-08-17 18:01:30 +0800909 if (max_discard_sectors) {
910 q->limits.discard_granularity = granularity;
911 blk_queue_max_discard_sectors(q, max_discard_sectors);
912 blk_queue_max_write_zeroes_sectors(q, max_discard_sectors);
Evan Greenc52abf52020-04-03 16:43:04 +0200913 blk_queue_flag_set(QUEUE_FLAG_DISCARD, q);
Ming Leibcb21c82020-08-17 18:01:30 +0800914 } else {
915 q->limits.discard_granularity = 0;
916 blk_queue_max_discard_sectors(q, 0);
917 blk_queue_max_write_zeroes_sectors(q, 0);
Evan Greenc52abf52020-04-03 16:43:04 +0200918 blk_queue_flag_clear(QUEUE_FLAG_DISCARD, q);
Ming Leibcb21c82020-08-17 18:01:30 +0800919 }
920 q->limits.discard_alignment = 0;
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200921}
922
Ming Leie03a3d72015-08-17 10:31:48 +0800923static void loop_unprepare_queue(struct loop_device *lo)
924{
Petr Mladek39891442016-10-11 13:55:20 -0700925 kthread_flush_worker(&lo->worker);
Ming Leie03a3d72015-08-17 10:31:48 +0800926 kthread_stop(lo->worker_task);
927}
928
NeilBrownb2ee7d42017-06-16 15:02:09 +1000929static int loop_kthread_worker_fn(void *worker_ptr)
930{
NeilBrowna37b0712020-06-01 21:48:18 -0700931 current->flags |= PF_LOCAL_THROTTLE | PF_MEMALLOC_NOIO;
NeilBrownb2ee7d42017-06-16 15:02:09 +1000932 return kthread_worker_fn(worker_ptr);
933}
934
Ming Leie03a3d72015-08-17 10:31:48 +0800935static int loop_prepare_queue(struct loop_device *lo)
936{
Petr Mladek39891442016-10-11 13:55:20 -0700937 kthread_init_worker(&lo->worker);
NeilBrownb2ee7d42017-06-16 15:02:09 +1000938 lo->worker_task = kthread_run(loop_kthread_worker_fn,
Ming Leie03a3d72015-08-17 10:31:48 +0800939 &lo->worker, "loop%d", lo->lo_number);
940 if (IS_ERR(lo->worker_task))
941 return -ENOMEM;
942 set_user_nice(lo->worker_task, MIN_NICE);
943 return 0;
944}
945
Holger Hoffstätte56a85fd2019-02-12 15:54:24 -0700946static void loop_update_rotational(struct loop_device *lo)
947{
948 struct file *file = lo->lo_backing_file;
949 struct inode *file_inode = file->f_mapping->host;
950 struct block_device *file_bdev = file_inode->i_sb->s_bdev;
951 struct request_queue *q = lo->lo_queue;
952 bool nonrot = true;
953
954 /* not all filesystems (e.g. tmpfs) have a sb->s_bdev */
955 if (file_bdev)
956 nonrot = blk_queue_nonrot(bdev_get_queue(file_bdev));
957
958 if (nonrot)
959 blk_queue_flag_set(QUEUE_FLAG_NONROT, q);
960 else
961 blk_queue_flag_clear(QUEUE_FLAG_NONROT, q);
962}
963
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964static int
965loop_release_xfer(struct loop_device *lo)
966{
967 int err = 0;
968 struct loop_func_table *xfer = lo->lo_encryption;
969
970 if (xfer) {
971 if (xfer->release)
972 err = xfer->release(lo);
973 lo->transfer = NULL;
974 lo->lo_encryption = NULL;
975 module_put(xfer->owner);
976 }
977 return err;
978}
979
980static int
981loop_init_xfer(struct loop_device *lo, struct loop_func_table *xfer,
982 const struct loop_info64 *i)
983{
984 int err = 0;
985
986 if (xfer) {
987 struct module *owner = xfer->owner;
988
989 if (!try_module_get(owner))
990 return -EINVAL;
991 if (xfer->init)
992 err = xfer->init(lo, i);
993 if (err)
994 module_put(owner);
995 else
996 lo->lo_encryption = xfer;
997 }
998 return err;
999}
1000
Martijn Coenen62ab4662020-05-13 15:38:42 +02001001/**
1002 * loop_set_status_from_info - configure device from loop_info
1003 * @lo: struct loop_device to configure
1004 * @info: struct loop_info64 to configure the device with
1005 *
1006 * Configures the loop device parameters according to the passed
1007 * in loop_info64 configuration.
1008 */
1009static int
1010loop_set_status_from_info(struct loop_device *lo,
1011 const struct loop_info64 *info)
1012{
1013 int err;
1014 struct loop_func_table *xfer;
1015 kuid_t uid = current_uid();
1016
1017 if ((unsigned int) info->lo_encrypt_key_size > LO_KEY_SIZE)
1018 return -EINVAL;
1019
1020 err = loop_release_xfer(lo);
1021 if (err)
1022 return err;
1023
1024 if (info->lo_encrypt_type) {
1025 unsigned int type = info->lo_encrypt_type;
1026
1027 if (type >= MAX_LO_CRYPT)
1028 return -EINVAL;
1029 xfer = xfer_funcs[type];
1030 if (xfer == NULL)
1031 return -EINVAL;
1032 } else
1033 xfer = NULL;
1034
1035 err = loop_init_xfer(lo, xfer, info);
1036 if (err)
1037 return err;
1038
1039 lo->lo_offset = info->lo_offset;
1040 lo->lo_sizelimit = info->lo_sizelimit;
1041 memcpy(lo->lo_file_name, info->lo_file_name, LO_NAME_SIZE);
1042 memcpy(lo->lo_crypt_name, info->lo_crypt_name, LO_NAME_SIZE);
1043 lo->lo_file_name[LO_NAME_SIZE-1] = 0;
1044 lo->lo_crypt_name[LO_NAME_SIZE-1] = 0;
1045
1046 if (!xfer)
1047 xfer = &none_funcs;
1048 lo->transfer = xfer->transfer;
1049 lo->ioctl = xfer->ioctl;
1050
Martijn Coenenfaf1d252020-05-13 15:38:44 +02001051 lo->lo_flags = info->lo_flags;
Martijn Coenen62ab4662020-05-13 15:38:42 +02001052
1053 lo->lo_encrypt_key_size = info->lo_encrypt_key_size;
1054 lo->lo_init[0] = info->lo_init[0];
1055 lo->lo_init[1] = info->lo_init[1];
1056 if (info->lo_encrypt_key_size) {
1057 memcpy(lo->lo_encrypt_key, info->lo_encrypt_key,
1058 info->lo_encrypt_key_size);
1059 lo->lo_key_owner = uid;
1060 }
1061
1062 return 0;
1063}
1064
Martijn Coenen34489142020-05-13 15:38:45 +02001065static int loop_configure(struct loop_device *lo, fmode_t mode,
1066 struct block_device *bdev,
1067 const struct loop_config *config)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068{
1069 struct file *file;
1070 struct inode *inode;
1071 struct address_space *mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 int error;
1073 loff_t size;
1074 bool partscan;
Martijn Coenen34489142020-05-13 15:38:45 +02001075 unsigned short bsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076
1077 /* This is safe, since we have a reference from open(). */
1078 __module_get(THIS_MODULE);
1079
1080 error = -EBADF;
Martijn Coenen34489142020-05-13 15:38:45 +02001081 file = fget(config->fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 if (!file)
1083 goto out;
1084
1085 /*
1086 * If we don't hold exclusive handle for the device, upgrade to it
1087 * here to avoid changing device under exclusive owner.
1088 */
1089 if (!(mode & FMODE_EXCL)) {
Christoph Hellwig37c3fc92020-11-25 21:20:08 +01001090 error = bd_prepare_to_claim(bdev, loop_configure);
Christoph Hellwigecbe6bc2020-07-16 16:33:09 +02001091 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092 goto out_putf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 }
1094
1095 error = mutex_lock_killable(&loop_ctl_mutex);
1096 if (error)
1097 goto out_bdev;
1098
1099 error = -EBUSY;
1100 if (lo->lo_state != Lo_unbound)
1101 goto out_unlock;
1102
1103 error = loop_validate_file(file, bdev);
1104 if (error)
1105 goto out_unlock;
1106
1107 mapping = file->f_mapping;
1108 inode = mapping->host;
1109
Martijn Coenen34489142020-05-13 15:38:45 +02001110 if ((config->info.lo_flags & ~LOOP_CONFIGURE_SETTABLE_FLAGS) != 0) {
1111 error = -EINVAL;
1112 goto out_unlock;
1113 }
1114
1115 if (config->block_size) {
1116 error = loop_validate_block_size(config->block_size);
1117 if (error)
1118 goto out_unlock;
1119 }
1120
1121 error = loop_set_status_from_info(lo, &config->info);
1122 if (error)
1123 goto out_unlock;
1124
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 if (!(file->f_mode & FMODE_WRITE) || !(mode & FMODE_WRITE) ||
1126 !file->f_op->write_iter)
Martijn Coenen34489142020-05-13 15:38:45 +02001127 lo->lo_flags |= LO_FLAGS_READ_ONLY;
Martijn Coenen083a6a52020-05-13 15:38:36 +02001128
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129 error = loop_prepare_queue(lo);
1130 if (error)
1131 goto out_unlock;
1132
Christoph Hellwig7a2f0ce2020-11-03 11:00:16 +01001133 set_disk_ro(lo->lo_disk, (lo->lo_flags & LO_FLAGS_READ_ONLY) != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134
Martijn Coenen34489142020-05-13 15:38:45 +02001135 lo->use_dio = lo->lo_flags & LO_FLAGS_DIRECT_IO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 lo->lo_device = bdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137 lo->lo_backing_file = file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 lo->old_gfp_mask = mapping_gfp_mask(mapping);
1139 mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
1140
Martijn Coenen34489142020-05-13 15:38:45 +02001141 if (!(lo->lo_flags & LO_FLAGS_READ_ONLY) && file->f_op->fsync)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 blk_queue_write_cache(lo->lo_queue, true, false);
1143
Martijn Coenen34489142020-05-13 15:38:45 +02001144 if (config->block_size)
1145 bsize = config->block_size;
Linus Torvalds96ed3202020-06-02 19:45:12 -07001146 else if ((lo->lo_backing_file->f_flags & O_DIRECT) && inode->i_sb->s_bdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147 /* In case of direct I/O, match underlying block size */
Martijn Coenen34489142020-05-13 15:38:45 +02001148 bsize = bdev_logical_block_size(inode->i_sb->s_bdev);
1149 else
1150 bsize = 512;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151
Martijn Coenen34489142020-05-13 15:38:45 +02001152 blk_queue_logical_block_size(lo->lo_queue, bsize);
1153 blk_queue_physical_block_size(lo->lo_queue, bsize);
1154 blk_queue_io_min(lo->lo_queue, bsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155
1156 loop_update_rotational(lo);
1157 loop_update_dio(lo);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 loop_sysfs_init(lo);
Martijn Coenen79e5dc52020-08-25 09:18:29 +02001159
1160 size = get_loop_size(lo, file);
Martijn Coenen5795b6f2020-05-13 15:38:37 +02001161 loop_set_size(lo, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 lo->lo_state = Lo_bound;
1164 if (part_shift)
1165 lo->lo_flags |= LO_FLAGS_PARTSCAN;
1166 partscan = lo->lo_flags & LO_FLAGS_PARTSCAN;
Lennart Poetteringfe6a8fc2020-08-10 19:16:32 +02001167 if (partscan)
1168 lo->lo_disk->flags &= ~GENHD_FL_NO_PART_SCAN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169
1170 /* Grab the block_device to prevent its destruction after we
1171 * put /dev/loopXX inode. Later in __loop_clr_fd() we bdput(bdev).
1172 */
1173 bdgrab(bdev);
1174 mutex_unlock(&loop_ctl_mutex);
1175 if (partscan)
1176 loop_reread_partitions(lo, bdev);
Christoph Hellwig37c3fc92020-11-25 21:20:08 +01001177 if (!(mode & FMODE_EXCL))
1178 bd_abort_claiming(bdev, loop_configure);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 return 0;
1180
1181out_unlock:
1182 mutex_unlock(&loop_ctl_mutex);
1183out_bdev:
Christoph Hellwig37c3fc92020-11-25 21:20:08 +01001184 if (!(mode & FMODE_EXCL))
1185 bd_abort_claiming(bdev, loop_configure);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186out_putf:
1187 fput(file);
1188out:
1189 /* This is safe: open() is still holding a reference. */
1190 module_put(THIS_MODULE);
1191 return error;
1192}
1193
Jan Kara0da03ca2018-11-08 14:01:14 +01001194static int __loop_clr_fd(struct loop_device *lo, bool release)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195{
Jan Kara7ccd0792018-11-08 14:01:07 +01001196 struct file *filp = NULL;
Al Virob4e3ca12005-10-21 03:22:34 -04001197 gfp_t gfp = lo->old_gfp_mask;
Ayan George4c823cc2011-09-21 10:02:13 +02001198 struct block_device *bdev = lo->lo_device;
Jan Kara7ccd0792018-11-08 14:01:07 +01001199 int err = 0;
Jan Kara0da03ca2018-11-08 14:01:14 +01001200 bool partscan = false;
1201 int lo_number;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202
Jan Kara7ccd0792018-11-08 14:01:07 +01001203 mutex_lock(&loop_ctl_mutex);
1204 if (WARN_ON_ONCE(lo->lo_state != Lo_rundown)) {
1205 err = -ENXIO;
1206 goto out_unlock;
1207 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208
Jan Kara7ccd0792018-11-08 14:01:07 +01001209 filp = lo->lo_backing_file;
1210 if (filp == NULL) {
1211 err = -EINVAL;
1212 goto out_unlock;
1213 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214
Ming Leif8933662015-05-06 12:26:23 +08001215 /* freeze request queue during the transition */
1216 blk_mq_freeze_queue(lo->lo_queue);
1217
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 spin_lock_irq(&lo->lo_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 lo->lo_backing_file = NULL;
Kay Sievers05eb0f22011-07-31 22:21:35 +02001220 spin_unlock_irq(&lo->lo_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221
1222 loop_release_xfer(lo);
1223 lo->transfer = NULL;
1224 lo->ioctl = NULL;
1225 lo->lo_device = NULL;
1226 lo->lo_encryption = NULL;
1227 lo->lo_offset = 0;
1228 lo->lo_sizelimit = 0;
1229 lo->lo_encrypt_key_size = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 memset(lo->lo_encrypt_key, 0, LO_KEY_SIZE);
1231 memset(lo->lo_crypt_name, 0, LO_NAME_SIZE);
1232 memset(lo->lo_file_name, 0, LO_NAME_SIZE);
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001233 blk_queue_logical_block_size(lo->lo_queue, 512);
Omar Sandovalbf093752017-09-05 14:24:47 -07001234 blk_queue_physical_block_size(lo->lo_queue, 512);
1235 blk_queue_io_min(lo->lo_queue, 512);
Anatol Pomozovc1681bf2013-04-01 09:47:56 -07001236 if (bdev) {
1237 bdput(bdev);
Al Virobb214882008-03-02 09:29:48 -05001238 invalidate_bdev(bdev);
Jeff Laytoneedffa22018-05-21 14:35:03 -04001239 bdev->bd_inode->i_mapping->wb_err = 0;
Anatol Pomozovc1681bf2013-04-01 09:47:56 -07001240 }
Ken Chen73285082007-05-08 00:28:20 -07001241 set_capacity(lo->lo_disk, 0);
Milan Broz51a0bb02010-10-27 19:51:30 -06001242 loop_sysfs_exit(lo);
David Zeuthenc3473c62010-05-03 14:08:59 +02001243 if (bdev) {
David Zeuthenc3473c62010-05-03 14:08:59 +02001244 /* let user-space know about this change */
1245 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
1246 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 mapping_set_gfp_mask(filp->f_mapping, gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 /* This is safe: open() is still holding a reference. */
1249 module_put(THIS_MODULE);
Ming Leif8933662015-05-06 12:26:23 +08001250 blk_mq_unfreeze_queue(lo->lo_queue);
1251
Jan Kara0da03ca2018-11-08 14:01:14 +01001252 partscan = lo->lo_flags & LO_FLAGS_PARTSCAN && bdev;
1253 lo_number = lo->lo_number;
Jan Kara0da03ca2018-11-08 14:01:14 +01001254 loop_unprepare_queue(lo);
1255out_unlock:
1256 mutex_unlock(&loop_ctl_mutex);
1257 if (partscan) {
Jan Karad57f3372018-11-08 14:01:12 +01001258 /*
1259 * bd_mutex has been held already in release path, so don't
1260 * acquire it if this function is called in such case.
1261 *
1262 * If the reread partition isn't from release path, lo_refcnt
1263 * must be at least one and it can only become zero when the
1264 * current holder is released.
1265 */
Christoph Hellwigf0b870d2019-11-14 15:34:36 +01001266 if (!release)
1267 mutex_lock(&bdev->bd_mutex);
1268 err = bdev_disk_changed(bdev, false);
1269 if (!release)
1270 mutex_unlock(&bdev->bd_mutex);
Dongli Zhang40853d62019-02-22 22:10:19 +08001271 if (err)
1272 pr_warn("%s: partition scan of loop%d failed (rc=%d)\n",
1273 __func__, lo_number, err);
Jan Karad57f3372018-11-08 14:01:12 +01001274 /* Device is gone, no point in returning error */
1275 err = 0;
1276 }
Dongli Zhang758a58d2019-02-22 22:10:20 +08001277
1278 /*
1279 * lo->lo_state is set to Lo_unbound here after above partscan has
1280 * finished.
1281 *
1282 * There cannot be anybody else entering __loop_clr_fd() as
1283 * lo->lo_backing_file is already cleared and Lo_rundown state
1284 * protects us from all the other places trying to change the 'lo'
1285 * device.
1286 */
1287 mutex_lock(&loop_ctl_mutex);
1288 lo->lo_flags = 0;
1289 if (!part_shift)
1290 lo->lo_disk->flags |= GENHD_FL_NO_PART_SCAN;
1291 lo->lo_state = Lo_unbound;
1292 mutex_unlock(&loop_ctl_mutex);
1293
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001294 /*
Tetsuo Handa310ca162018-11-08 14:01:02 +01001295 * Need not hold loop_ctl_mutex to fput backing file.
1296 * Calling fput holding loop_ctl_mutex triggers a circular
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001297 * lock dependency possibility warning as fput can take
Tetsuo Handa310ca162018-11-08 14:01:02 +01001298 * bd_mutex which is usually taken before loop_ctl_mutex.
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001299 */
Jan Kara7ccd0792018-11-08 14:01:07 +01001300 if (filp)
1301 fput(filp);
1302 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303}
1304
Jan Karaa2505b72018-11-08 14:01:06 +01001305static int loop_clr_fd(struct loop_device *lo)
1306{
Jan Kara7ccd0792018-11-08 14:01:07 +01001307 int err;
1308
Jan Karac28445f2018-11-08 14:01:16 +01001309 err = mutex_lock_killable(&loop_ctl_mutex);
Jan Kara7ccd0792018-11-08 14:01:07 +01001310 if (err)
1311 return err;
1312 if (lo->lo_state != Lo_bound) {
1313 mutex_unlock(&loop_ctl_mutex);
Jan Karaa2505b72018-11-08 14:01:06 +01001314 return -ENXIO;
Jan Kara7ccd0792018-11-08 14:01:07 +01001315 }
Jan Karaa2505b72018-11-08 14:01:06 +01001316 /*
1317 * If we've explicitly asked to tear down the loop device,
1318 * and it has an elevated reference count, set it for auto-teardown when
1319 * the last reference goes away. This stops $!~#$@ udev from
1320 * preventing teardown because it decided that it needs to run blkid on
1321 * the loopback device whenever they appear. xfstests is notorious for
1322 * failing tests because blkid via udev races with a losetup
1323 * <dev>/do something like mkfs/losetup -d <dev> causing the losetup -d
1324 * command to fail with EBUSY.
1325 */
1326 if (atomic_read(&lo->lo_refcnt) > 1) {
1327 lo->lo_flags |= LO_FLAGS_AUTOCLEAR;
1328 mutex_unlock(&loop_ctl_mutex);
1329 return 0;
1330 }
1331 lo->lo_state = Lo_rundown;
Jan Kara7ccd0792018-11-08 14:01:07 +01001332 mutex_unlock(&loop_ctl_mutex);
Jan Karaa2505b72018-11-08 14:01:06 +01001333
Jan Kara0da03ca2018-11-08 14:01:14 +01001334 return __loop_clr_fd(lo, false);
Jan Karaa2505b72018-11-08 14:01:06 +01001335}
1336
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337static int
1338loop_set_status(struct loop_device *lo, const struct loop_info64 *info)
1339{
1340 int err;
Jan Kara85b0a542018-11-08 14:01:13 +01001341 struct block_device *bdev;
Martijn Coenen0c3796c2020-05-13 15:38:41 +02001342 kuid_t uid = current_uid();
Martijn Coenenfaf1d252020-05-13 15:38:44 +02001343 int prev_lo_flags;
Jan Kara85b0a542018-11-08 14:01:13 +01001344 bool partscan = false;
Martijn Coenen0c3796c2020-05-13 15:38:41 +02001345 bool size_changed = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346
Jan Karac28445f2018-11-08 14:01:16 +01001347 err = mutex_lock_killable(&loop_ctl_mutex);
Jan Kara550df5fd2018-11-08 14:01:09 +01001348 if (err)
1349 return err;
David Howellsb0fafa82008-11-14 10:38:41 +11001350 if (lo->lo_encrypt_key_size &&
Eric W. Biedermane4849732012-02-11 11:23:51 -08001351 !uid_eq(lo->lo_key_owner, uid) &&
Jan Kara550df5fd2018-11-08 14:01:09 +01001352 !capable(CAP_SYS_ADMIN)) {
1353 err = -EPERM;
1354 goto out_unlock;
1355 }
1356 if (lo->lo_state != Lo_bound) {
1357 err = -ENXIO;
1358 goto out_unlock;
1359 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001361 if (lo->lo_offset != info->lo_offset ||
1362 lo->lo_sizelimit != info->lo_sizelimit) {
Martijn Coenen0c3796c2020-05-13 15:38:41 +02001363 size_changed = true;
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001364 sync_blockdev(lo->lo_device);
Zheng Binf4bd34b2020-06-18 12:21:37 +08001365 invalidate_bdev(lo->lo_device);
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001366 }
1367
Ming Leiecdd0952017-02-11 11:40:45 +08001368 /* I/O need to be drained during transfer transition */
1369 blk_mq_freeze_queue(lo->lo_queue);
1370
Martijn Coenen0c3796c2020-05-13 15:38:41 +02001371 if (size_changed && lo->lo_device->bd_inode->i_mapping->nrpages) {
Zheng Binf4bd34b2020-06-18 12:21:37 +08001372 /* If any pages were dirtied after invalidate_bdev(), try again */
Martijn Coenen0c3796c2020-05-13 15:38:41 +02001373 err = -EAGAIN;
1374 pr_warn("%s: loop%d (%s) has still dirty pages (nrpages=%lu)\n",
1375 __func__, lo->lo_number, lo->lo_file_name,
1376 lo->lo_device->bd_inode->i_mapping->nrpages);
1377 goto out_unfreeze;
1378 }
1379
Martijn Coenenfaf1d252020-05-13 15:38:44 +02001380 prev_lo_flags = lo->lo_flags;
1381
Martijn Coenen0c3796c2020-05-13 15:38:41 +02001382 err = loop_set_status_from_info(lo, info);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 if (err)
Jan Kara550df5fd2018-11-08 14:01:09 +01001384 goto out_unfreeze;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385
Martijn Coenenfaf1d252020-05-13 15:38:44 +02001386 /* Mask out flags that can't be set using LOOP_SET_STATUS. */
Martijn Coenen6ac92fb2020-06-04 22:25:20 +02001387 lo->lo_flags &= LOOP_SET_STATUS_SETTABLE_FLAGS;
Martijn Coenenfaf1d252020-05-13 15:38:44 +02001388 /* For those flags, use the previous values instead */
1389 lo->lo_flags |= prev_lo_flags & ~LOOP_SET_STATUS_SETTABLE_FLAGS;
1390 /* For flags that can't be cleared, use previous values too */
1391 lo->lo_flags |= prev_lo_flags & ~LOOP_SET_STATUS_CLEARABLE_FLAGS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392
Martijn Coenenb0bd1582020-05-13 15:38:39 +02001393 if (size_changed) {
1394 loff_t new_size = get_size(lo->lo_offset, lo->lo_sizelimit,
1395 lo->lo_backing_file);
1396 loop_set_size(lo, new_size);
Arnd Bergmannb040ad92017-06-09 12:19:18 +02001397 }
Guo Chao541c7422013-02-21 15:16:46 -08001398
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +02001399 loop_config_discard(lo);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400
Ming Lei2e5ab5f2015-08-17 10:31:49 +08001401 /* update dio if lo_offset or transfer is changed */
1402 __loop_update_dio(lo, lo->use_dio);
1403
Jan Kara550df5fd2018-11-08 14:01:09 +01001404out_unfreeze:
Ming Leiecdd0952017-02-11 11:40:45 +08001405 blk_mq_unfreeze_queue(lo->lo_queue);
Omar Sandovale02898b42017-03-01 10:42:38 -08001406
Martijn Coenenfaf1d252020-05-13 15:38:44 +02001407 if (!err && (lo->lo_flags & LO_FLAGS_PARTSCAN) &&
1408 !(prev_lo_flags & LO_FLAGS_PARTSCAN)) {
Omar Sandovale02898b42017-03-01 10:42:38 -08001409 lo->lo_disk->flags &= ~GENHD_FL_NO_PART_SCAN;
Jan Kara85b0a542018-11-08 14:01:13 +01001410 bdev = lo->lo_device;
1411 partscan = true;
Omar Sandovale02898b42017-03-01 10:42:38 -08001412 }
Jan Kara550df5fd2018-11-08 14:01:09 +01001413out_unlock:
1414 mutex_unlock(&loop_ctl_mutex);
Jan Kara85b0a542018-11-08 14:01:13 +01001415 if (partscan)
1416 loop_reread_partitions(lo, bdev);
Omar Sandovale02898b42017-03-01 10:42:38 -08001417
Ming Leiecdd0952017-02-11 11:40:45 +08001418 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419}
1420
1421static int
1422loop_get_status(struct loop_device *lo, struct loop_info64 *info)
1423{
Tetsuo Handab1ab5fa2018-11-08 14:01:01 +01001424 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 struct kstat stat;
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001426 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427
Jan Karac28445f2018-11-08 14:01:16 +01001428 ret = mutex_lock_killable(&loop_ctl_mutex);
Jan Kara4a5ce9b2018-11-08 14:01:08 +01001429 if (ret)
1430 return ret;
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001431 if (lo->lo_state != Lo_bound) {
Tetsuo Handa310ca162018-11-08 14:01:02 +01001432 mutex_unlock(&loop_ctl_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 return -ENXIO;
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001434 }
1435
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436 memset(info, 0, sizeof(*info));
1437 info->lo_number = lo->lo_number;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 info->lo_offset = lo->lo_offset;
1439 info->lo_sizelimit = lo->lo_sizelimit;
1440 info->lo_flags = lo->lo_flags;
1441 memcpy(info->lo_file_name, lo->lo_file_name, LO_NAME_SIZE);
1442 memcpy(info->lo_crypt_name, lo->lo_crypt_name, LO_NAME_SIZE);
1443 info->lo_encrypt_type =
1444 lo->lo_encryption ? lo->lo_encryption->number : 0;
1445 if (lo->lo_encrypt_key_size && capable(CAP_SYS_ADMIN)) {
1446 info->lo_encrypt_key_size = lo->lo_encrypt_key_size;
1447 memcpy(info->lo_encrypt_key, lo->lo_encrypt_key,
1448 lo->lo_encrypt_key_size);
1449 }
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001450
Tetsuo Handa310ca162018-11-08 14:01:02 +01001451 /* Drop loop_ctl_mutex while we call into the filesystem. */
Tetsuo Handab1ab5fa2018-11-08 14:01:01 +01001452 path = lo->lo_backing_file->f_path;
1453 path_get(&path);
Tetsuo Handa310ca162018-11-08 14:01:02 +01001454 mutex_unlock(&loop_ctl_mutex);
Tetsuo Handab1ab5fa2018-11-08 14:01:01 +01001455 ret = vfs_getattr(&path, &stat, STATX_INO, AT_STATX_SYNC_AS_STAT);
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001456 if (!ret) {
1457 info->lo_device = huge_encode_dev(stat.dev);
1458 info->lo_inode = stat.ino;
1459 info->lo_rdevice = huge_encode_dev(stat.rdev);
1460 }
Tetsuo Handab1ab5fa2018-11-08 14:01:01 +01001461 path_put(&path);
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001462 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463}
1464
1465static void
1466loop_info64_from_old(const struct loop_info *info, struct loop_info64 *info64)
1467{
1468 memset(info64, 0, sizeof(*info64));
1469 info64->lo_number = info->lo_number;
1470 info64->lo_device = info->lo_device;
1471 info64->lo_inode = info->lo_inode;
1472 info64->lo_rdevice = info->lo_rdevice;
1473 info64->lo_offset = info->lo_offset;
1474 info64->lo_sizelimit = 0;
1475 info64->lo_encrypt_type = info->lo_encrypt_type;
1476 info64->lo_encrypt_key_size = info->lo_encrypt_key_size;
1477 info64->lo_flags = info->lo_flags;
1478 info64->lo_init[0] = info->lo_init[0];
1479 info64->lo_init[1] = info->lo_init[1];
1480 if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1481 memcpy(info64->lo_crypt_name, info->lo_name, LO_NAME_SIZE);
1482 else
1483 memcpy(info64->lo_file_name, info->lo_name, LO_NAME_SIZE);
1484 memcpy(info64->lo_encrypt_key, info->lo_encrypt_key, LO_KEY_SIZE);
1485}
1486
1487static int
1488loop_info64_to_old(const struct loop_info64 *info64, struct loop_info *info)
1489{
1490 memset(info, 0, sizeof(*info));
1491 info->lo_number = info64->lo_number;
1492 info->lo_device = info64->lo_device;
1493 info->lo_inode = info64->lo_inode;
1494 info->lo_rdevice = info64->lo_rdevice;
1495 info->lo_offset = info64->lo_offset;
1496 info->lo_encrypt_type = info64->lo_encrypt_type;
1497 info->lo_encrypt_key_size = info64->lo_encrypt_key_size;
1498 info->lo_flags = info64->lo_flags;
1499 info->lo_init[0] = info64->lo_init[0];
1500 info->lo_init[1] = info64->lo_init[1];
1501 if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1502 memcpy(info->lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1503 else
1504 memcpy(info->lo_name, info64->lo_file_name, LO_NAME_SIZE);
1505 memcpy(info->lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1506
1507 /* error in case values were truncated */
1508 if (info->lo_device != info64->lo_device ||
1509 info->lo_rdevice != info64->lo_rdevice ||
1510 info->lo_inode != info64->lo_inode ||
1511 info->lo_offset != info64->lo_offset)
1512 return -EOVERFLOW;
1513
1514 return 0;
1515}
1516
1517static int
1518loop_set_status_old(struct loop_device *lo, const struct loop_info __user *arg)
1519{
1520 struct loop_info info;
1521 struct loop_info64 info64;
1522
1523 if (copy_from_user(&info, arg, sizeof (struct loop_info)))
1524 return -EFAULT;
1525 loop_info64_from_old(&info, &info64);
1526 return loop_set_status(lo, &info64);
1527}
1528
1529static int
1530loop_set_status64(struct loop_device *lo, const struct loop_info64 __user *arg)
1531{
1532 struct loop_info64 info64;
1533
1534 if (copy_from_user(&info64, arg, sizeof (struct loop_info64)))
1535 return -EFAULT;
1536 return loop_set_status(lo, &info64);
1537}
1538
1539static int
1540loop_get_status_old(struct loop_device *lo, struct loop_info __user *arg) {
1541 struct loop_info info;
1542 struct loop_info64 info64;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001543 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544
Jan Kara4a5ce9b2018-11-08 14:01:08 +01001545 if (!arg)
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001546 return -EINVAL;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001547 err = loop_get_status(lo, &info64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 if (!err)
1549 err = loop_info64_to_old(&info64, &info);
1550 if (!err && copy_to_user(arg, &info, sizeof(info)))
1551 err = -EFAULT;
1552
1553 return err;
1554}
1555
1556static int
1557loop_get_status64(struct loop_device *lo, struct loop_info64 __user *arg) {
1558 struct loop_info64 info64;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001559 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560
Jan Kara4a5ce9b2018-11-08 14:01:08 +01001561 if (!arg)
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001562 return -EINVAL;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001563 err = loop_get_status(lo, &info64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 if (!err && copy_to_user(arg, &info64, sizeof(info64)))
1565 err = -EFAULT;
1566
1567 return err;
1568}
1569
Hannes Reinecke51001b72017-06-08 13:46:44 +02001570static int loop_set_capacity(struct loop_device *lo)
J. R. Okajima53d66602009-03-31 15:23:43 -07001571{
Martijn Coenen0a6ed1b2020-05-13 15:38:40 +02001572 loff_t size;
1573
J. R. Okajima53d66602009-03-31 15:23:43 -07001574 if (unlikely(lo->lo_state != Lo_bound))
Guo Chao7b0576a2013-02-21 15:16:47 -08001575 return -ENXIO;
J. R. Okajima53d66602009-03-31 15:23:43 -07001576
Martijn Coenen0a6ed1b2020-05-13 15:38:40 +02001577 size = get_loop_size(lo, lo->lo_backing_file);
1578 loop_set_size(lo, size);
Martijn Coenen083a6a52020-05-13 15:38:36 +02001579
1580 return 0;
J. R. Okajima53d66602009-03-31 15:23:43 -07001581}
1582
Ming Leiab1cb272015-08-17 10:31:50 +08001583static int loop_set_dio(struct loop_device *lo, unsigned long arg)
1584{
1585 int error = -ENXIO;
1586 if (lo->lo_state != Lo_bound)
1587 goto out;
1588
1589 __loop_update_dio(lo, !!arg);
1590 if (lo->use_dio == !!arg)
1591 return 0;
1592 error = -EINVAL;
1593 out:
1594 return error;
1595}
1596
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001597static int loop_set_block_size(struct loop_device *lo, unsigned long arg)
1598{
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001599 int err = 0;
1600
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001601 if (lo->lo_state != Lo_bound)
1602 return -ENXIO;
1603
Martijn Coenen34489142020-05-13 15:38:45 +02001604 err = loop_validate_block_size(arg);
1605 if (err)
1606 return err;
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001607
Martijn Coenen7e81f992020-03-10 14:12:30 +01001608 if (lo->lo_queue->limits.logical_block_size == arg)
1609 return 0;
1610
1611 sync_blockdev(lo->lo_device);
Zheng Binf4bd34b2020-06-18 12:21:37 +08001612 invalidate_bdev(lo->lo_device);
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001613
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001614 blk_mq_freeze_queue(lo->lo_queue);
1615
Zheng Binf4bd34b2020-06-18 12:21:37 +08001616 /* invalidate_bdev should have truncated all the pages */
Martijn Coenen7e81f992020-03-10 14:12:30 +01001617 if (lo->lo_device->bd_inode->i_mapping->nrpages) {
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001618 err = -EAGAIN;
1619 pr_warn("%s: loop%d (%s) has still dirty pages (nrpages=%lu)\n",
1620 __func__, lo->lo_number, lo->lo_file_name,
1621 lo->lo_device->bd_inode->i_mapping->nrpages);
1622 goto out_unfreeze;
1623 }
1624
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001625 blk_queue_logical_block_size(lo->lo_queue, arg);
Omar Sandovalbf093752017-09-05 14:24:47 -07001626 blk_queue_physical_block_size(lo->lo_queue, arg);
1627 blk_queue_io_min(lo->lo_queue, arg);
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001628 loop_update_dio(lo);
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001629out_unfreeze:
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001630 blk_mq_unfreeze_queue(lo->lo_queue);
1631
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001632 return err;
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001633}
1634
Jan Karaa1316542018-11-08 14:01:05 +01001635static int lo_simple_ioctl(struct loop_device *lo, unsigned int cmd,
1636 unsigned long arg)
1637{
1638 int err;
1639
Jan Karac28445f2018-11-08 14:01:16 +01001640 err = mutex_lock_killable(&loop_ctl_mutex);
Jan Karaa1316542018-11-08 14:01:05 +01001641 if (err)
1642 return err;
1643 switch (cmd) {
1644 case LOOP_SET_CAPACITY:
1645 err = loop_set_capacity(lo);
1646 break;
1647 case LOOP_SET_DIRECT_IO:
1648 err = loop_set_dio(lo, arg);
1649 break;
1650 case LOOP_SET_BLOCK_SIZE:
1651 err = loop_set_block_size(lo, arg);
1652 break;
1653 default:
1654 err = lo->ioctl ? lo->ioctl(lo, cmd, arg) : -EINVAL;
1655 }
1656 mutex_unlock(&loop_ctl_mutex);
1657 return err;
1658}
1659
Al Virobb214882008-03-02 09:29:48 -05001660static int lo_ioctl(struct block_device *bdev, fmode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 unsigned int cmd, unsigned long arg)
1662{
Al Virobb214882008-03-02 09:29:48 -05001663 struct loop_device *lo = bdev->bd_disk->private_data;
Martijn Coenen571fae62020-05-13 15:38:43 +02001664 void __user *argp = (void __user *) arg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665 int err;
1666
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667 switch (cmd) {
Martijn Coenen34489142020-05-13 15:38:45 +02001668 case LOOP_SET_FD: {
1669 /*
1670 * Legacy case - pass in a zeroed out struct loop_config with
1671 * only the file descriptor set , which corresponds with the
1672 * default parameters we'd have used otherwise.
1673 */
1674 struct loop_config config;
1675
1676 memset(&config, 0, sizeof(config));
1677 config.fd = arg;
1678
1679 return loop_configure(lo, mode, bdev, &config);
1680 }
1681 case LOOP_CONFIGURE: {
1682 struct loop_config config;
1683
1684 if (copy_from_user(&config, argp, sizeof(config)))
1685 return -EFAULT;
1686
1687 return loop_configure(lo, mode, bdev, &config);
1688 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689 case LOOP_CHANGE_FD:
Jan Karac3710772018-11-08 14:01:11 +01001690 return loop_change_fd(lo, bdev, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691 case LOOP_CLR_FD:
Jan Kara7ccd0792018-11-08 14:01:07 +01001692 return loop_clr_fd(lo);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 case LOOP_SET_STATUS:
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +01001694 err = -EPERM;
Jan Karaa1316542018-11-08 14:01:05 +01001695 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN)) {
Martijn Coenen571fae62020-05-13 15:38:43 +02001696 err = loop_set_status_old(lo, argp);
Jan Karaa1316542018-11-08 14:01:05 +01001697 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698 break;
1699 case LOOP_GET_STATUS:
Martijn Coenen571fae62020-05-13 15:38:43 +02001700 return loop_get_status_old(lo, argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 case LOOP_SET_STATUS64:
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +01001702 err = -EPERM;
Jan Karaa1316542018-11-08 14:01:05 +01001703 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN)) {
Martijn Coenen571fae62020-05-13 15:38:43 +02001704 err = loop_set_status64(lo, argp);
Jan Karaa1316542018-11-08 14:01:05 +01001705 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 break;
1707 case LOOP_GET_STATUS64:
Martijn Coenen571fae62020-05-13 15:38:43 +02001708 return loop_get_status64(lo, argp);
J. R. Okajima53d66602009-03-31 15:23:43 -07001709 case LOOP_SET_CAPACITY:
Ming Leiab1cb272015-08-17 10:31:50 +08001710 case LOOP_SET_DIRECT_IO:
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001711 case LOOP_SET_BLOCK_SIZE:
Jan Karaa1316542018-11-08 14:01:05 +01001712 if (!(mode & FMODE_WRITE) && !capable(CAP_SYS_ADMIN))
1713 return -EPERM;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05001714 fallthrough;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715 default:
Jan Karaa1316542018-11-08 14:01:05 +01001716 err = lo_simple_ioctl(lo, cmd, arg);
1717 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718 }
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001719
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720 return err;
1721}
1722
David Howells863d5b822006-08-29 19:06:14 +01001723#ifdef CONFIG_COMPAT
1724struct compat_loop_info {
1725 compat_int_t lo_number; /* ioctl r/o */
1726 compat_dev_t lo_device; /* ioctl r/o */
1727 compat_ulong_t lo_inode; /* ioctl r/o */
1728 compat_dev_t lo_rdevice; /* ioctl r/o */
1729 compat_int_t lo_offset;
1730 compat_int_t lo_encrypt_type;
1731 compat_int_t lo_encrypt_key_size; /* ioctl w/o */
1732 compat_int_t lo_flags; /* ioctl r/o */
1733 char lo_name[LO_NAME_SIZE];
1734 unsigned char lo_encrypt_key[LO_KEY_SIZE]; /* ioctl w/o */
1735 compat_ulong_t lo_init[2];
1736 char reserved[4];
1737};
1738
1739/*
1740 * Transfer 32-bit compatibility structure in userspace to 64-bit loop info
1741 * - noinlined to reduce stack space usage in main part of driver
1742 */
1743static noinline int
Al Viroba674cf2006-10-10 22:48:27 +01001744loop_info64_from_compat(const struct compat_loop_info __user *arg,
David Howells863d5b822006-08-29 19:06:14 +01001745 struct loop_info64 *info64)
1746{
1747 struct compat_loop_info info;
1748
1749 if (copy_from_user(&info, arg, sizeof(info)))
1750 return -EFAULT;
1751
1752 memset(info64, 0, sizeof(*info64));
1753 info64->lo_number = info.lo_number;
1754 info64->lo_device = info.lo_device;
1755 info64->lo_inode = info.lo_inode;
1756 info64->lo_rdevice = info.lo_rdevice;
1757 info64->lo_offset = info.lo_offset;
1758 info64->lo_sizelimit = 0;
1759 info64->lo_encrypt_type = info.lo_encrypt_type;
1760 info64->lo_encrypt_key_size = info.lo_encrypt_key_size;
1761 info64->lo_flags = info.lo_flags;
1762 info64->lo_init[0] = info.lo_init[0];
1763 info64->lo_init[1] = info.lo_init[1];
1764 if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1765 memcpy(info64->lo_crypt_name, info.lo_name, LO_NAME_SIZE);
1766 else
1767 memcpy(info64->lo_file_name, info.lo_name, LO_NAME_SIZE);
1768 memcpy(info64->lo_encrypt_key, info.lo_encrypt_key, LO_KEY_SIZE);
1769 return 0;
1770}
1771
1772/*
1773 * Transfer 64-bit loop info to 32-bit compatibility structure in userspace
1774 * - noinlined to reduce stack space usage in main part of driver
1775 */
1776static noinline int
1777loop_info64_to_compat(const struct loop_info64 *info64,
1778 struct compat_loop_info __user *arg)
1779{
1780 struct compat_loop_info info;
1781
1782 memset(&info, 0, sizeof(info));
1783 info.lo_number = info64->lo_number;
1784 info.lo_device = info64->lo_device;
1785 info.lo_inode = info64->lo_inode;
1786 info.lo_rdevice = info64->lo_rdevice;
1787 info.lo_offset = info64->lo_offset;
1788 info.lo_encrypt_type = info64->lo_encrypt_type;
1789 info.lo_encrypt_key_size = info64->lo_encrypt_key_size;
1790 info.lo_flags = info64->lo_flags;
1791 info.lo_init[0] = info64->lo_init[0];
1792 info.lo_init[1] = info64->lo_init[1];
1793 if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1794 memcpy(info.lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1795 else
1796 memcpy(info.lo_name, info64->lo_file_name, LO_NAME_SIZE);
1797 memcpy(info.lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1798
1799 /* error in case values were truncated */
1800 if (info.lo_device != info64->lo_device ||
1801 info.lo_rdevice != info64->lo_rdevice ||
1802 info.lo_inode != info64->lo_inode ||
1803 info.lo_offset != info64->lo_offset ||
1804 info.lo_init[0] != info64->lo_init[0] ||
1805 info.lo_init[1] != info64->lo_init[1])
1806 return -EOVERFLOW;
1807
1808 if (copy_to_user(arg, &info, sizeof(info)))
1809 return -EFAULT;
1810 return 0;
1811}
1812
1813static int
1814loop_set_status_compat(struct loop_device *lo,
1815 const struct compat_loop_info __user *arg)
1816{
1817 struct loop_info64 info64;
1818 int ret;
1819
1820 ret = loop_info64_from_compat(arg, &info64);
1821 if (ret < 0)
1822 return ret;
1823 return loop_set_status(lo, &info64);
1824}
1825
1826static int
1827loop_get_status_compat(struct loop_device *lo,
1828 struct compat_loop_info __user *arg)
1829{
1830 struct loop_info64 info64;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001831 int err;
David Howells863d5b822006-08-29 19:06:14 +01001832
Jan Kara4a5ce9b2018-11-08 14:01:08 +01001833 if (!arg)
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001834 return -EINVAL;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001835 err = loop_get_status(lo, &info64);
David Howells863d5b822006-08-29 19:06:14 +01001836 if (!err)
1837 err = loop_info64_to_compat(&info64, arg);
1838 return err;
1839}
1840
Al Virobb214882008-03-02 09:29:48 -05001841static int lo_compat_ioctl(struct block_device *bdev, fmode_t mode,
1842 unsigned int cmd, unsigned long arg)
David Howells863d5b822006-08-29 19:06:14 +01001843{
Al Virobb214882008-03-02 09:29:48 -05001844 struct loop_device *lo = bdev->bd_disk->private_data;
David Howells863d5b822006-08-29 19:06:14 +01001845 int err;
1846
David Howells863d5b822006-08-29 19:06:14 +01001847 switch(cmd) {
1848 case LOOP_SET_STATUS:
Jan Kara550df5fd2018-11-08 14:01:09 +01001849 err = loop_set_status_compat(lo,
1850 (const struct compat_loop_info __user *)arg);
David Howells863d5b822006-08-29 19:06:14 +01001851 break;
1852 case LOOP_GET_STATUS:
Jan Kara4a5ce9b2018-11-08 14:01:08 +01001853 err = loop_get_status_compat(lo,
1854 (struct compat_loop_info __user *)arg);
David Howells863d5b822006-08-29 19:06:14 +01001855 break;
J. R. Okajima53d66602009-03-31 15:23:43 -07001856 case LOOP_SET_CAPACITY:
David Howells863d5b822006-08-29 19:06:14 +01001857 case LOOP_CLR_FD:
1858 case LOOP_GET_STATUS64:
1859 case LOOP_SET_STATUS64:
Martijn Coenen34489142020-05-13 15:38:45 +02001860 case LOOP_CONFIGURE:
David Howells863d5b822006-08-29 19:06:14 +01001861 arg = (unsigned long) compat_ptr(arg);
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05001862 fallthrough;
David Howells863d5b822006-08-29 19:06:14 +01001863 case LOOP_SET_FD:
1864 case LOOP_CHANGE_FD:
Evan Green9fea4b32018-07-02 16:03:46 -07001865 case LOOP_SET_BLOCK_SIZE:
Alessio Balsinifdbe4ee2019-08-07 01:48:28 +01001866 case LOOP_SET_DIRECT_IO:
Al Virobb214882008-03-02 09:29:48 -05001867 err = lo_ioctl(bdev, mode, cmd, arg);
David Howells863d5b822006-08-29 19:06:14 +01001868 break;
1869 default:
1870 err = -ENOIOCTLCMD;
1871 break;
1872 }
David Howells863d5b822006-08-29 19:06:14 +01001873 return err;
1874}
1875#endif
1876
Al Virobb214882008-03-02 09:29:48 -05001877static int lo_open(struct block_device *bdev, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878{
Kay Sievers770fe302011-07-31 22:08:04 +02001879 struct loop_device *lo;
Jan Kara0a42e992018-11-08 14:01:04 +01001880 int err;
Kay Sievers770fe302011-07-31 22:08:04 +02001881
Jan Kara0a42e992018-11-08 14:01:04 +01001882 err = mutex_lock_killable(&loop_ctl_mutex);
1883 if (err)
1884 return err;
Kay Sievers770fe302011-07-31 22:08:04 +02001885 lo = bdev->bd_disk->private_data;
1886 if (!lo) {
1887 err = -ENXIO;
1888 goto out;
1889 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890
Ming Leif8933662015-05-06 12:26:23 +08001891 atomic_inc(&lo->lo_refcnt);
Kay Sievers770fe302011-07-31 22:08:04 +02001892out:
Jan Kara0a42e992018-11-08 14:01:04 +01001893 mutex_unlock(&loop_ctl_mutex);
Kay Sievers770fe302011-07-31 22:08:04 +02001894 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895}
1896
Jan Kara967d1dc2018-11-08 14:01:03 +01001897static void lo_release(struct gendisk *disk, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898{
Jan Kara967d1dc2018-11-08 14:01:03 +01001899 struct loop_device *lo;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900
Jan Kara0a42e992018-11-08 14:01:04 +01001901 mutex_lock(&loop_ctl_mutex);
Jan Kara967d1dc2018-11-08 14:01:03 +01001902 lo = disk->private_data;
Ming Leif8933662015-05-06 12:26:23 +08001903 if (atomic_dec_return(&lo->lo_refcnt))
Jan Kara0a42e992018-11-08 14:01:04 +01001904 goto out_unlock;
Ming Leif8933662015-05-06 12:26:23 +08001905
Milan Broz14f27932008-12-12 14:48:27 +01001906 if (lo->lo_flags & LO_FLAGS_AUTOCLEAR) {
Jan Karaa2505b72018-11-08 14:01:06 +01001907 if (lo->lo_state != Lo_bound)
1908 goto out_unlock;
1909 lo->lo_state = Lo_rundown;
Jan Kara7ccd0792018-11-08 14:01:07 +01001910 mutex_unlock(&loop_ctl_mutex);
Milan Broz14f27932008-12-12 14:48:27 +01001911 /*
1912 * In autoclear mode, stop the loop thread
1913 * and remove configuration after last close.
1914 */
Jan Kara0da03ca2018-11-08 14:01:14 +01001915 __loop_clr_fd(lo, true);
Jan Kara7ccd0792018-11-08 14:01:07 +01001916 return;
Omar Sandoval43cade802017-08-24 00:03:44 -07001917 } else if (lo->lo_state == Lo_bound) {
Milan Broz14f27932008-12-12 14:48:27 +01001918 /*
1919 * Otherwise keep thread (if running) and config,
1920 * but flush possible ongoing bios in thread.
1921 */
Omar Sandoval43cade802017-08-24 00:03:44 -07001922 blk_mq_freeze_queue(lo->lo_queue);
1923 blk_mq_unfreeze_queue(lo->lo_queue);
Milan Broz14f27932008-12-12 14:48:27 +01001924 }
David Woodhouse96c58652008-02-06 01:36:27 -08001925
Jan Kara0a42e992018-11-08 14:01:04 +01001926out_unlock:
Tetsuo Handa310ca162018-11-08 14:01:02 +01001927 mutex_unlock(&loop_ctl_mutex);
Linus Torvaldsae665012018-01-05 16:26:00 -08001928}
1929
Alexey Dobriyan83d5cde2009-09-21 17:01:13 -07001930static const struct block_device_operations lo_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 .owner = THIS_MODULE,
Al Virobb214882008-03-02 09:29:48 -05001932 .open = lo_open,
1933 .release = lo_release,
1934 .ioctl = lo_ioctl,
David Howells863d5b822006-08-29 19:06:14 +01001935#ifdef CONFIG_COMPAT
Al Virobb214882008-03-02 09:29:48 -05001936 .compat_ioctl = lo_compat_ioctl,
David Howells863d5b822006-08-29 19:06:14 +01001937#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938};
1939
1940/*
1941 * And now the modules code and kernel interface.
1942 */
Ken Chen73285082007-05-08 00:28:20 -07001943static int max_loop;
Joe Perches5657a812018-05-24 13:38:59 -06001944module_param(max_loop, int, 0444);
Ken Chena47653f2007-06-08 13:46:44 -07001945MODULE_PARM_DESC(max_loop, "Maximum number of loop devices");
Joe Perches5657a812018-05-24 13:38:59 -06001946module_param(max_part, int, 0444);
Laurent Vivier476a4812008-03-26 12:11:53 +01001947MODULE_PARM_DESC(max_part, "Maximum number of partitions per loop device");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948MODULE_LICENSE("GPL");
1949MODULE_ALIAS_BLOCKDEV_MAJOR(LOOP_MAJOR);
1950
1951int loop_register_transfer(struct loop_func_table *funcs)
1952{
1953 unsigned int n = funcs->number;
1954
1955 if (n >= MAX_LO_CRYPT || xfer_funcs[n])
1956 return -EINVAL;
1957 xfer_funcs[n] = funcs;
1958 return 0;
1959}
1960
Kay Sievers34dd82a2011-07-31 22:08:04 +02001961static int unregister_transfer_cb(int id, void *ptr, void *data)
1962{
1963 struct loop_device *lo = ptr;
1964 struct loop_func_table *xfer = data;
1965
Tetsuo Handa310ca162018-11-08 14:01:02 +01001966 mutex_lock(&loop_ctl_mutex);
Kay Sievers34dd82a2011-07-31 22:08:04 +02001967 if (lo->lo_encryption == xfer)
1968 loop_release_xfer(lo);
Tetsuo Handa310ca162018-11-08 14:01:02 +01001969 mutex_unlock(&loop_ctl_mutex);
Kay Sievers34dd82a2011-07-31 22:08:04 +02001970 return 0;
1971}
1972
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973int loop_unregister_transfer(int number)
1974{
1975 unsigned int n = number;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976 struct loop_func_table *xfer;
1977
1978 if (n == 0 || n >= MAX_LO_CRYPT || (xfer = xfer_funcs[n]) == NULL)
1979 return -EINVAL;
1980
1981 xfer_funcs[n] = NULL;
Kay Sievers34dd82a2011-07-31 22:08:04 +02001982 idr_for_each(&loop_index_idr, &unregister_transfer_cb, xfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983 return 0;
1984}
1985
1986EXPORT_SYMBOL(loop_register_transfer);
1987EXPORT_SYMBOL(loop_unregister_transfer);
1988
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001989static blk_status_t loop_queue_rq(struct blk_mq_hw_ctx *hctx,
Ming Leib5dd2f62014-12-31 13:22:57 +00001990 const struct blk_mq_queue_data *bd)
1991{
Jens Axboe1894e912018-04-13 16:24:29 -06001992 struct request *rq = bd->rq;
1993 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
1994 struct loop_device *lo = rq->q->queuedata;
Ming Leib5dd2f62014-12-31 13:22:57 +00001995
Jens Axboe1894e912018-04-13 16:24:29 -06001996 blk_mq_start_request(rq);
Ming Leib5dd2f62014-12-31 13:22:57 +00001997
Ming Leif4aa4c72015-05-05 19:49:54 +08001998 if (lo->lo_state != Lo_bound)
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001999 return BLK_STS_IOERR;
Ming Leif4aa4c72015-05-05 19:49:54 +08002000
Jens Axboe1894e912018-04-13 16:24:29 -06002001 switch (req_op(rq)) {
Christoph Hellwigf0225ca2016-08-04 16:10:00 +02002002 case REQ_OP_FLUSH:
2003 case REQ_OP_DISCARD:
Christoph Hellwig19372e22017-04-05 19:21:15 +02002004 case REQ_OP_WRITE_ZEROES:
Ming Leibc07c102015-08-17 10:31:51 +08002005 cmd->use_aio = false;
Christoph Hellwigf0225ca2016-08-04 16:10:00 +02002006 break;
2007 default:
2008 cmd->use_aio = lo->use_dio;
2009 break;
2010 }
Ming Leibc07c102015-08-17 10:31:51 +08002011
Shaohua Lid4478e92017-09-25 13:07:22 -06002012 /* always use the first bio's css */
Shaohua Li0b508bc2017-09-26 11:02:12 -07002013#ifdef CONFIG_BLK_CGROUP
Dennis Zhoudb6638d2018-12-05 12:10:35 -05002014 if (cmd->use_aio && rq->bio && rq->bio->bi_blkg) {
2015 cmd->css = &bio_blkcg(rq->bio)->css;
Shaohua Lid4478e92017-09-25 13:07:22 -06002016 css_get(cmd->css);
2017 } else
2018#endif
2019 cmd->css = NULL;
Petr Mladek39891442016-10-11 13:55:20 -07002020 kthread_queue_work(&lo->worker, &cmd->work);
Ming Leib5dd2f62014-12-31 13:22:57 +00002021
Christoph Hellwigfc17b652017-06-03 09:38:05 +02002022 return BLK_STS_OK;
Ming Leib5dd2f62014-12-31 13:22:57 +00002023}
2024
2025static void loop_handle_cmd(struct loop_cmd *cmd)
2026{
Jens Axboe1894e912018-04-13 16:24:29 -06002027 struct request *rq = blk_mq_rq_from_pdu(cmd);
2028 const bool write = op_is_write(req_op(rq));
2029 struct loop_device *lo = rq->q->queuedata;
Christoph Hellwigf4829a92015-09-27 21:01:50 +02002030 int ret = 0;
Ming Leib5dd2f62014-12-31 13:22:57 +00002031
Christoph Hellwigf4829a92015-09-27 21:01:50 +02002032 if (write && (lo->lo_flags & LO_FLAGS_READ_ONLY)) {
2033 ret = -EIO;
Ming Leib5dd2f62014-12-31 13:22:57 +00002034 goto failed;
Christoph Hellwigf4829a92015-09-27 21:01:50 +02002035 }
Ming Leib5dd2f62014-12-31 13:22:57 +00002036
Jens Axboe1894e912018-04-13 16:24:29 -06002037 ret = do_req_filebacked(lo, rq);
Ming Leib5dd2f62014-12-31 13:22:57 +00002038 failed:
Ming Leibc07c102015-08-17 10:31:51 +08002039 /* complete non-aio request */
Christoph Hellwigfe2cb292017-04-20 16:03:02 +02002040 if (!cmd->use_aio || ret) {
Evan Green8cd55082020-04-03 16:43:03 +02002041 if (ret == -EOPNOTSUPP)
2042 cmd->ret = ret;
2043 else
2044 cmd->ret = ret ? -EIO : 0;
Christoph Hellwig15f73f52020-06-11 08:44:47 +02002045 if (likely(!blk_should_fake_timeout(rq->q)))
2046 blk_mq_complete_request(rq);
Christoph Hellwigfe2cb292017-04-20 16:03:02 +02002047 }
Ming Leib5dd2f62014-12-31 13:22:57 +00002048}
2049
Ming Leie03a3d72015-08-17 10:31:48 +08002050static void loop_queue_work(struct kthread_work *work)
Ming Leib5dd2f62014-12-31 13:22:57 +00002051{
2052 struct loop_cmd *cmd =
Ming Leie03a3d72015-08-17 10:31:48 +08002053 container_of(work, struct loop_cmd, work);
Ming Leib5dd2f62014-12-31 13:22:57 +00002054
2055 loop_handle_cmd(cmd);
2056}
2057
Christoph Hellwigd6296d392017-05-01 10:19:08 -06002058static int loop_init_request(struct blk_mq_tag_set *set, struct request *rq,
2059 unsigned int hctx_idx, unsigned int numa_node)
Ming Leib5dd2f62014-12-31 13:22:57 +00002060{
2061 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
2062
Petr Mladek39891442016-10-11 13:55:20 -07002063 kthread_init_work(&cmd->work, loop_queue_work);
Ming Leib5dd2f62014-12-31 13:22:57 +00002064 return 0;
2065}
2066
Eric Biggersf363b082017-03-30 13:39:16 -07002067static const struct blk_mq_ops loop_mq_ops = {
Ming Leib5dd2f62014-12-31 13:22:57 +00002068 .queue_rq = loop_queue_rq,
Ming Leib5dd2f62014-12-31 13:22:57 +00002069 .init_request = loop_init_request,
Christoph Hellwigfe2cb292017-04-20 16:03:02 +02002070 .complete = lo_complete_rq,
Ming Leib5dd2f62014-12-31 13:22:57 +00002071};
2072
Kay Sievers34dd82a2011-07-31 22:08:04 +02002073static int loop_add(struct loop_device **l, int i)
Ken Chen73285082007-05-08 00:28:20 -07002074{
2075 struct loop_device *lo;
2076 struct gendisk *disk;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002077 int err;
Ken Chen73285082007-05-08 00:28:20 -07002078
Silva Paulo68d740d2012-07-14 15:39:58 -07002079 err = -ENOMEM;
Ken Chen73285082007-05-08 00:28:20 -07002080 lo = kzalloc(sizeof(*lo), GFP_KERNEL);
Silva Paulo68d740d2012-07-14 15:39:58 -07002081 if (!lo)
Ken Chen73285082007-05-08 00:28:20 -07002082 goto out;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002083
Mikulas Patockaef7e7c82013-10-15 14:14:38 -06002084 lo->lo_state = Lo_unbound;
2085
Tejun Heoc718aa62013-02-27 17:03:58 -08002086 /* allocate id, if @id >= 0, we're requesting that specific id */
Kay Sievers34dd82a2011-07-31 22:08:04 +02002087 if (i >= 0) {
Tejun Heoc718aa62013-02-27 17:03:58 -08002088 err = idr_alloc(&loop_index_idr, lo, i, i + 1, GFP_KERNEL);
2089 if (err == -ENOSPC)
Kay Sievers34dd82a2011-07-31 22:08:04 +02002090 err = -EEXIST;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002091 } else {
Tejun Heoc718aa62013-02-27 17:03:58 -08002092 err = idr_alloc(&loop_index_idr, lo, 0, 0, GFP_KERNEL);
Kay Sievers34dd82a2011-07-31 22:08:04 +02002093 }
2094 if (err < 0)
2095 goto out_free_dev;
Tejun Heoc718aa62013-02-27 17:03:58 -08002096 i = err;
Ken Chen73285082007-05-08 00:28:20 -07002097
Wei Yongjun183cfb52013-03-22 08:59:19 -06002098 err = -ENOMEM;
Ming Leib5dd2f62014-12-31 13:22:57 +00002099 lo->tag_set.ops = &loop_mq_ops;
2100 lo->tag_set.nr_hw_queues = 1;
2101 lo->tag_set.queue_depth = 128;
2102 lo->tag_set.numa_node = NUMA_NO_NODE;
2103 lo->tag_set.cmd_size = sizeof(struct loop_cmd);
Ming Leibf0beec2020-05-29 15:53:15 +02002104 lo->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_STACKING;
Ming Leib5dd2f62014-12-31 13:22:57 +00002105 lo->tag_set.driver_data = lo;
2106
2107 err = blk_mq_alloc_tag_set(&lo->tag_set);
2108 if (err)
Mikulas Patocka3ec981e2013-10-14 12:12:24 -04002109 goto out_free_idr;
Ken Chen73285082007-05-08 00:28:20 -07002110
Ming Leib5dd2f62014-12-31 13:22:57 +00002111 lo->lo_queue = blk_mq_init_queue(&lo->tag_set);
Chengguang Xu38a34992018-12-16 17:35:00 +08002112 if (IS_ERR(lo->lo_queue)) {
Ming Leib5dd2f62014-12-31 13:22:57 +00002113 err = PTR_ERR(lo->lo_queue);
2114 goto out_cleanup_tags;
2115 }
Mikulas Patockaef7e7c82013-10-15 14:14:38 -06002116 lo->lo_queue->queuedata = lo;
2117
Shaohua Li54bb0ad2017-08-31 22:09:45 -07002118 blk_queue_max_hw_sectors(lo->lo_queue, BLK_DEF_MAX_SECTORS);
Shaohua Li40326d82017-08-31 22:09:46 -07002119
Ming Lei5b5e20f2015-08-17 10:31:47 +08002120 /*
Shaohua Li40326d82017-08-31 22:09:46 -07002121 * By default, we do buffer IO, so it doesn't make sense to enable
2122 * merge because the I/O submitted to backing file is handled page by
2123 * page. For directio mode, merge does help to dispatch bigger request
2124 * to underlayer disk. We will enable merge once directio is enabled.
Ming Lei5b5e20f2015-08-17 10:31:47 +08002125 */
Bart Van Assche8b904b52018-03-07 17:10:10 -08002126 blk_queue_flag_set(QUEUE_FLAG_NOMERGES, lo->lo_queue);
Ming Lei5b5e20f2015-08-17 10:31:47 +08002127
Minfei Huang7a649732016-06-07 10:05:15 +08002128 err = -ENOMEM;
Laurent Vivier476a4812008-03-26 12:11:53 +01002129 disk = lo->lo_disk = alloc_disk(1 << part_shift);
Ken Chen73285082007-05-08 00:28:20 -07002130 if (!disk)
2131 goto out_free_queue;
2132
Kay Sieverse03c8dd2011-08-23 20:12:04 +02002133 /*
2134 * Disable partition scanning by default. The in-kernel partition
2135 * scanning can be requested individually per-device during its
2136 * setup. Userspace can always add and remove partitions from all
2137 * devices. The needed partition minors are allocated from the
2138 * extended minor space, the main loop device numbers will continue
2139 * to match the loop minors, regardless of the number of partitions
2140 * used.
2141 *
2142 * If max_part is given, partition scanning is globally enabled for
2143 * all loop devices. The minors for the main loop devices will be
2144 * multiples of max_part.
2145 *
2146 * Note: Global-for-all-devices, set-only-at-init, read-only module
2147 * parameteters like 'max_loop' and 'max_part' make things needlessly
2148 * complicated, are too static, inflexible and may surprise
2149 * userspace tools. Parameters like this in general should be avoided.
2150 */
2151 if (!part_shift)
2152 disk->flags |= GENHD_FL_NO_PART_SCAN;
2153 disk->flags |= GENHD_FL_EXT_DEVT;
Ming Leif8933662015-05-06 12:26:23 +08002154 atomic_set(&lo->lo_refcnt, 0);
Ken Chen73285082007-05-08 00:28:20 -07002155 lo->lo_number = i;
Ken Chen73285082007-05-08 00:28:20 -07002156 spin_lock_init(&lo->lo_lock);
2157 disk->major = LOOP_MAJOR;
Laurent Vivier476a4812008-03-26 12:11:53 +01002158 disk->first_minor = i << part_shift;
Ken Chen73285082007-05-08 00:28:20 -07002159 disk->fops = &lo_fops;
2160 disk->private_data = lo;
2161 disk->queue = lo->lo_queue;
2162 sprintf(disk->disk_name, "loop%d", i);
Kay Sievers34dd82a2011-07-31 22:08:04 +02002163 add_disk(disk);
2164 *l = lo;
2165 return lo->lo_number;
Ken Chen73285082007-05-08 00:28:20 -07002166
2167out_free_queue:
2168 blk_cleanup_queue(lo->lo_queue);
Ming Leib5dd2f62014-12-31 13:22:57 +00002169out_cleanup_tags:
2170 blk_mq_free_tag_set(&lo->tag_set);
Mikulas Patocka3ec981e2013-10-14 12:12:24 -04002171out_free_idr:
2172 idr_remove(&loop_index_idr, i);
Ken Chen73285082007-05-08 00:28:20 -07002173out_free_dev:
2174 kfree(lo);
2175out:
Kay Sievers34dd82a2011-07-31 22:08:04 +02002176 return err;
Ken Chen73285082007-05-08 00:28:20 -07002177}
2178
Kay Sievers34dd82a2011-07-31 22:08:04 +02002179static void loop_remove(struct loop_device *lo)
Ken Chen73285082007-05-08 00:28:20 -07002180{
NeilBrown6cd18e72015-04-27 14:12:22 +10002181 del_gendisk(lo->lo_disk);
Bart Van Assche0fa8ebd2018-02-28 10:15:28 -08002182 blk_cleanup_queue(lo->lo_queue);
Ming Leib5dd2f62014-12-31 13:22:57 +00002183 blk_mq_free_tag_set(&lo->tag_set);
Ken Chen73285082007-05-08 00:28:20 -07002184 put_disk(lo->lo_disk);
Ken Chen73285082007-05-08 00:28:20 -07002185 kfree(lo);
2186}
2187
Kay Sievers770fe302011-07-31 22:08:04 +02002188static int find_free_cb(int id, void *ptr, void *data)
Ken Chena47653f2007-06-08 13:46:44 -07002189{
Kay Sievers770fe302011-07-31 22:08:04 +02002190 struct loop_device *lo = ptr;
2191 struct loop_device **l = data;
Ken Chena47653f2007-06-08 13:46:44 -07002192
Kay Sievers770fe302011-07-31 22:08:04 +02002193 if (lo->lo_state == Lo_unbound) {
2194 *l = lo;
2195 return 1;
Ken Chena47653f2007-06-08 13:46:44 -07002196 }
Kay Sievers770fe302011-07-31 22:08:04 +02002197 return 0;
Ken Chena47653f2007-06-08 13:46:44 -07002198}
2199
Kay Sievers34dd82a2011-07-31 22:08:04 +02002200static int loop_lookup(struct loop_device **l, int i)
Ken Chena47653f2007-06-08 13:46:44 -07002201{
Ken Chena47653f2007-06-08 13:46:44 -07002202 struct loop_device *lo;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002203 int ret = -ENODEV;
Ken Chena47653f2007-06-08 13:46:44 -07002204
Kay Sievers770fe302011-07-31 22:08:04 +02002205 if (i < 0) {
2206 int err;
2207
2208 err = idr_for_each(&loop_index_idr, &find_free_cb, &lo);
2209 if (err == 1) {
2210 *l = lo;
2211 ret = lo->lo_number;
2212 }
2213 goto out;
2214 }
2215
2216 /* lookup and return a specific i */
Kay Sievers34dd82a2011-07-31 22:08:04 +02002217 lo = idr_find(&loop_index_idr, i);
Ken Chena47653f2007-06-08 13:46:44 -07002218 if (lo) {
Kay Sievers34dd82a2011-07-31 22:08:04 +02002219 *l = lo;
2220 ret = lo->lo_number;
Ken Chena47653f2007-06-08 13:46:44 -07002221 }
Kay Sievers770fe302011-07-31 22:08:04 +02002222out:
Kay Sievers34dd82a2011-07-31 22:08:04 +02002223 return ret;
Ken Chena47653f2007-06-08 13:46:44 -07002224}
2225
Christoph Hellwig8410d382020-10-29 15:58:33 +01002226static void loop_probe(dev_t dev)
Ken Chen73285082007-05-08 00:28:20 -07002227{
Christoph Hellwig8410d382020-10-29 15:58:33 +01002228 int idx = MINOR(dev) >> part_shift;
Al Viro705962c2007-05-13 05:52:32 -04002229 struct loop_device *lo;
Christoph Hellwig8410d382020-10-29 15:58:33 +01002230
2231 if (max_loop && idx >= max_loop)
2232 return;
Ken Chen73285082007-05-08 00:28:20 -07002233
Jan Kara0a42e992018-11-08 14:01:04 +01002234 mutex_lock(&loop_ctl_mutex);
Christoph Hellwig8410d382020-10-29 15:58:33 +01002235 if (loop_lookup(&lo, idx) < 0)
2236 loop_add(&lo, idx);
Jan Kara0a42e992018-11-08 14:01:04 +01002237 mutex_unlock(&loop_ctl_mutex);
Ken Chen73285082007-05-08 00:28:20 -07002238}
2239
Kay Sievers770fe302011-07-31 22:08:04 +02002240static long loop_control_ioctl(struct file *file, unsigned int cmd,
2241 unsigned long parm)
2242{
2243 struct loop_device *lo;
Jan Kara0a42e992018-11-08 14:01:04 +01002244 int ret;
Kay Sievers770fe302011-07-31 22:08:04 +02002245
Jan Kara0a42e992018-11-08 14:01:04 +01002246 ret = mutex_lock_killable(&loop_ctl_mutex);
2247 if (ret)
2248 return ret;
2249
2250 ret = -ENOSYS;
Kay Sievers770fe302011-07-31 22:08:04 +02002251 switch (cmd) {
2252 case LOOP_CTL_ADD:
2253 ret = loop_lookup(&lo, parm);
2254 if (ret >= 0) {
2255 ret = -EEXIST;
2256 break;
2257 }
2258 ret = loop_add(&lo, parm);
2259 break;
2260 case LOOP_CTL_REMOVE:
2261 ret = loop_lookup(&lo, parm);
2262 if (ret < 0)
2263 break;
Kay Sievers770fe302011-07-31 22:08:04 +02002264 if (lo->lo_state != Lo_unbound) {
2265 ret = -EBUSY;
Kay Sievers770fe302011-07-31 22:08:04 +02002266 break;
2267 }
Ming Leif8933662015-05-06 12:26:23 +08002268 if (atomic_read(&lo->lo_refcnt) > 0) {
Kay Sievers770fe302011-07-31 22:08:04 +02002269 ret = -EBUSY;
Kay Sievers770fe302011-07-31 22:08:04 +02002270 break;
2271 }
2272 lo->lo_disk->private_data = NULL;
Kay Sievers770fe302011-07-31 22:08:04 +02002273 idr_remove(&loop_index_idr, lo->lo_number);
2274 loop_remove(lo);
2275 break;
2276 case LOOP_CTL_GET_FREE:
2277 ret = loop_lookup(&lo, -1);
2278 if (ret >= 0)
2279 break;
2280 ret = loop_add(&lo, -1);
2281 }
Jan Kara0a42e992018-11-08 14:01:04 +01002282 mutex_unlock(&loop_ctl_mutex);
Kay Sievers770fe302011-07-31 22:08:04 +02002283
2284 return ret;
2285}
2286
2287static const struct file_operations loop_ctl_fops = {
2288 .open = nonseekable_open,
2289 .unlocked_ioctl = loop_control_ioctl,
2290 .compat_ioctl = loop_control_ioctl,
2291 .owner = THIS_MODULE,
2292 .llseek = noop_llseek,
2293};
2294
2295static struct miscdevice loop_misc = {
2296 .minor = LOOP_CTRL_MINOR,
2297 .name = "loop-control",
2298 .fops = &loop_ctl_fops,
2299};
2300
2301MODULE_ALIAS_MISCDEV(LOOP_CTRL_MINOR);
2302MODULE_ALIAS("devname:loop-control");
2303
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304static int __init loop_init(void)
2305{
Ken Chena47653f2007-06-08 13:46:44 -07002306 int i, nr;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002307 struct loop_device *lo;
Kay Sievers770fe302011-07-31 22:08:04 +02002308 int err;
Ken Chena47653f2007-06-08 13:46:44 -07002309
Laurent Vivier476a4812008-03-26 12:11:53 +01002310 part_shift = 0;
Namhyung Kimac04fee2011-05-27 07:59:25 +02002311 if (max_part > 0) {
Laurent Vivier476a4812008-03-26 12:11:53 +01002312 part_shift = fls(max_part);
2313
Namhyung Kimac04fee2011-05-27 07:59:25 +02002314 /*
2315 * Adjust max_part according to part_shift as it is exported
2316 * to user space so that user can decide correct minor number
2317 * if [s]he want to create more devices.
2318 *
2319 * Note that -1 is required because partition 0 is reserved
2320 * for the whole disk.
2321 */
2322 max_part = (1UL << part_shift) - 1;
2323 }
2324
Guo Chaob1a66502013-02-21 15:16:49 -08002325 if ((1UL << part_shift) > DISK_MAX_PARTS) {
2326 err = -EINVAL;
Anton Volkova8c1d062017-08-07 15:37:50 +03002327 goto err_out;
Guo Chaob1a66502013-02-21 15:16:49 -08002328 }
Namhyung Kim78f4bb32011-05-24 16:48:54 +02002329
Guo Chaob1a66502013-02-21 15:16:49 -08002330 if (max_loop > 1UL << (MINORBITS - part_shift)) {
2331 err = -EINVAL;
Anton Volkova8c1d062017-08-07 15:37:50 +03002332 goto err_out;
Guo Chaob1a66502013-02-21 15:16:49 -08002333 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334
Kay Sieversd134b002011-07-31 22:08:04 +02002335 /*
2336 * If max_loop is specified, create that many devices upfront.
2337 * This also becomes a hard limit. If max_loop is not specified,
2338 * create CONFIG_BLK_DEV_LOOP_MIN_COUNT loop devices at module
2339 * init time. Loop devices can be requested on-demand with the
2340 * /dev/loop-control interface, or be instantiated by accessing
2341 * a 'dead' device node.
2342 */
Lukas Bulwahnaeb2b0b2020-12-12 06:13:02 +01002343 if (max_loop)
Ken Chena47653f2007-06-08 13:46:44 -07002344 nr = max_loop;
Lukas Bulwahnaeb2b0b2020-12-12 06:13:02 +01002345 else
Kay Sieversd134b002011-07-31 22:08:04 +02002346 nr = CONFIG_BLK_DEV_LOOP_MIN_COUNT;
Ken Chena47653f2007-06-08 13:46:44 -07002347
Anton Volkova8c1d062017-08-07 15:37:50 +03002348 err = misc_register(&loop_misc);
2349 if (err < 0)
2350 goto err_out;
2351
2352
Christoph Hellwig8410d382020-10-29 15:58:33 +01002353 if (__register_blkdev(LOOP_MAJOR, "loop", loop_probe)) {
Guo Chaob1a66502013-02-21 15:16:49 -08002354 err = -EIO;
2355 goto misc_out;
2356 }
Ken Chena47653f2007-06-08 13:46:44 -07002357
Kay Sieversd134b002011-07-31 22:08:04 +02002358 /* pre-create number of devices given by config or max_loop */
Jan Kara0a42e992018-11-08 14:01:04 +01002359 mutex_lock(&loop_ctl_mutex);
Kay Sievers34dd82a2011-07-31 22:08:04 +02002360 for (i = 0; i < nr; i++)
2361 loop_add(&lo, i);
Jan Kara0a42e992018-11-08 14:01:04 +01002362 mutex_unlock(&loop_ctl_mutex);
Kay Sievers34dd82a2011-07-31 22:08:04 +02002363
Ken Chen73285082007-05-08 00:28:20 -07002364 printk(KERN_INFO "loop: module loaded\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365 return 0;
Guo Chaob1a66502013-02-21 15:16:49 -08002366
2367misc_out:
2368 misc_deregister(&loop_misc);
Anton Volkova8c1d062017-08-07 15:37:50 +03002369err_out:
Guo Chaob1a66502013-02-21 15:16:49 -08002370 return err;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002371}
Ken Chena47653f2007-06-08 13:46:44 -07002372
Kay Sievers34dd82a2011-07-31 22:08:04 +02002373static int loop_exit_cb(int id, void *ptr, void *data)
2374{
2375 struct loop_device *lo = ptr;
Ken Chena47653f2007-06-08 13:46:44 -07002376
Kay Sievers34dd82a2011-07-31 22:08:04 +02002377 loop_remove(lo);
2378 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379}
2380
Ken Chen73285082007-05-08 00:28:20 -07002381static void __exit loop_exit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002382{
Luis Chamberlain200f9332020-06-19 20:47:27 +00002383 mutex_lock(&loop_ctl_mutex);
2384
Kay Sievers34dd82a2011-07-31 22:08:04 +02002385 idr_for_each(&loop_index_idr, &loop_exit_cb, NULL);
Kay Sievers34dd82a2011-07-31 22:08:04 +02002386 idr_destroy(&loop_index_idr);
Ken Chen73285082007-05-08 00:28:20 -07002387
Akinobu Mita00d59402007-07-17 04:03:46 -07002388 unregister_blkdev(LOOP_MAJOR, "loop");
Kay Sievers770fe302011-07-31 22:08:04 +02002389
2390 misc_deregister(&loop_misc);
Luis Chamberlain200f9332020-06-19 20:47:27 +00002391
2392 mutex_unlock(&loop_ctl_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002393}
2394
2395module_init(loop_init);
2396module_exit(loop_exit);
2397
2398#ifndef MODULE
2399static int __init max_loop_setup(char *str)
2400{
2401 max_loop = simple_strtol(str, NULL, 0);
2402 return 1;
2403}
2404
2405__setup("max_loop=", max_loop_setup);
2406#endif