blob: 33cc6558f9d2e2c4ee1f3fba1560ce39e2f05187 [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{
Guo Chao7b0576a2013-02-21 15:16:47 -0800254 struct block_device *bdev = lo->lo_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
Martijn Coenen5795b6f2020-05-13 15:38:37 +0200256 bd_set_size(bdev, size << SECTOR_SHIFT);
Martijn Coenen716ad092020-05-13 15:38:38 +0200257
258 set_capacity_revalidate_and_notify(lo->lo_disk, size, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259}
260
261static inline int
262lo_do_transfer(struct loop_device *lo, int cmd,
263 struct page *rpage, unsigned roffs,
264 struct page *lpage, unsigned loffs,
265 int size, sector_t rblock)
266{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200267 int ret;
268
269 ret = lo->transfer(lo, cmd, rpage, roffs, lpage, loffs, size, rblock);
270 if (likely(!ret))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 return 0;
272
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200273 printk_ratelimited(KERN_ERR
274 "loop: Transfer error at byte offset %llu, length %i.\n",
275 (unsigned long long)rblock << 9, size);
276 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277}
278
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200279static int lo_write_bvec(struct file *file, struct bio_vec *bvec, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200281 struct iov_iter i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 ssize_t bw;
Al Viro283e7e52015-04-03 15:21:59 -0400283
Christoph Hellwigb6207432019-06-26 15:49:28 +0200284 iov_iter_bvec(&i, WRITE, bvec, 1, bvec->bv_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285
Al Viro03d95eb2013-03-20 13:04:20 -0400286 file_start_write(file);
Christoph Hellwigabbb65892017-05-27 11:16:52 +0300287 bw = vfs_iter_write(file, &i, ppos, 0);
Al Viro03d95eb2013-03-20 13:04:20 -0400288 file_end_write(file);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200289
290 if (likely(bw == bvec->bv_len))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 return 0;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200292
293 printk_ratelimited(KERN_ERR
294 "loop: Write error at byte offset %llu, length %i.\n",
295 (unsigned long long)*ppos, bvec->bv_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 if (bw >= 0)
297 bw = -EIO;
298 return bw;
299}
300
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200301static int lo_write_simple(struct loop_device *lo, struct request *rq,
302 loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200304 struct bio_vec bvec;
305 struct req_iterator iter;
306 int ret = 0;
307
308 rq_for_each_segment(bvec, rq, iter) {
309 ret = lo_write_bvec(lo->lo_backing_file, &bvec, &pos);
310 if (ret < 0)
311 break;
312 cond_resched();
313 }
314
315 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316}
317
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200318/*
Christoph Hellwig456be142011-10-17 12:57:20 +0200319 * This is the slow, transforming version that needs to double buffer the
320 * data as it cannot do the transformations in place without having direct
321 * access to the destination pages of the backing file.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 */
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200323static int lo_write_transfer(struct loop_device *lo, struct request *rq,
324 loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200326 struct bio_vec bvec, b;
Ming Lei30112012014-12-31 13:22:58 +0000327 struct req_iterator iter;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200328 struct page *page;
Kent Overstreet79886132013-11-23 17:19:00 -0800329 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200331 page = alloc_page(GFP_NOIO);
332 if (unlikely(!page))
333 return -ENOMEM;
Christoph Hellwig456be142011-10-17 12:57:20 +0200334
Ming Lei30112012014-12-31 13:22:58 +0000335 rq_for_each_segment(bvec, rq, iter) {
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200336 ret = lo_do_transfer(lo, WRITE, page, 0, bvec.bv_page,
337 bvec.bv_offset, bvec.bv_len, pos >> 9);
338 if (unlikely(ret))
339 break;
340
341 b.bv_page = page;
342 b.bv_offset = 0;
343 b.bv_len = bvec.bv_len;
344 ret = lo_write_bvec(lo->lo_backing_file, &b, &pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 if (ret < 0)
346 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 }
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200348
349 __free_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351}
352
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200353static int lo_read_simple(struct loop_device *lo, struct request *rq,
354 loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355{
Kent Overstreet79886132013-11-23 17:19:00 -0800356 struct bio_vec bvec;
Ming Lei30112012014-12-31 13:22:58 +0000357 struct req_iterator iter;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200358 struct iov_iter i;
359 ssize_t len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
Ming Lei30112012014-12-31 13:22:58 +0000361 rq_for_each_segment(bvec, rq, iter) {
Christoph Hellwigb6207432019-06-26 15:49:28 +0200362 iov_iter_bvec(&i, READ, &bvec, 1, bvec.bv_len);
Christoph Hellwig18e97102017-05-27 11:16:51 +0300363 len = vfs_iter_read(lo->lo_backing_file, &i, &pos, 0);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200364 if (len < 0)
365 return len;
Dave Young306df072012-02-08 22:07:19 +0100366
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200367 flush_dcache_page(bvec.bv_page);
368
369 if (len != bvec.bv_len) {
Ming Lei30112012014-12-31 13:22:58 +0000370 struct bio *bio;
371
372 __rq_for_each_bio(bio, rq)
373 zero_fill_bio(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 break;
Dave Young306df072012-02-08 22:07:19 +0100375 }
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200376 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 }
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200378
Dave Young306df072012-02-08 22:07:19 +0100379 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380}
381
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200382static int lo_read_transfer(struct loop_device *lo, struct request *rq,
383 loff_t pos)
384{
385 struct bio_vec bvec, b;
386 struct req_iterator iter;
387 struct iov_iter i;
388 struct page *page;
389 ssize_t len;
390 int ret = 0;
391
392 page = alloc_page(GFP_NOIO);
393 if (unlikely(!page))
394 return -ENOMEM;
395
396 rq_for_each_segment(bvec, rq, iter) {
397 loff_t offset = pos;
398
399 b.bv_page = page;
400 b.bv_offset = 0;
401 b.bv_len = bvec.bv_len;
402
Christoph Hellwigb6207432019-06-26 15:49:28 +0200403 iov_iter_bvec(&i, READ, &b, 1, b.bv_len);
Christoph Hellwig18e97102017-05-27 11:16:51 +0300404 len = vfs_iter_read(lo->lo_backing_file, &i, &pos, 0);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200405 if (len < 0) {
406 ret = len;
407 goto out_free_page;
408 }
409
410 ret = lo_do_transfer(lo, READ, page, 0, bvec.bv_page,
411 bvec.bv_offset, len, offset >> 9);
412 if (ret)
413 goto out_free_page;
414
415 flush_dcache_page(bvec.bv_page);
416
417 if (len != bvec.bv_len) {
418 struct bio *bio;
419
420 __rq_for_each_bio(bio, rq)
421 zero_fill_bio(bio);
422 break;
423 }
424 }
425
426 ret = 0;
427out_free_page:
428 __free_page(page);
429 return ret;
430}
431
Darrick J. Wongefcfec572019-10-30 20:29:48 -0700432static int lo_fallocate(struct loop_device *lo, struct request *rq, loff_t pos,
433 int mode)
Ming Leicf655d92014-12-31 13:22:59 +0000434{
435 /*
Darrick J. Wongefcfec572019-10-30 20:29:48 -0700436 * We use fallocate to manipulate the space mappings used by the image
437 * a.k.a. discard/zerorange. However we do not support this if
438 * encryption is enabled, because it may give an attacker useful
439 * information.
Ming Leicf655d92014-12-31 13:22:59 +0000440 */
441 struct file *file = lo->lo_backing_file;
Evan Greenc52abf52020-04-03 16:43:04 +0200442 struct request_queue *q = lo->lo_queue;
Ming Leicf655d92014-12-31 13:22:59 +0000443 int ret;
444
Darrick J. Wongefcfec572019-10-30 20:29:48 -0700445 mode |= FALLOC_FL_KEEP_SIZE;
446
Evan Greenc52abf52020-04-03 16:43:04 +0200447 if (!blk_queue_discard(q)) {
Ming Leicf655d92014-12-31 13:22:59 +0000448 ret = -EOPNOTSUPP;
449 goto out;
450 }
451
452 ret = file->f_op->fallocate(file, mode, pos, blk_rq_bytes(rq));
453 if (unlikely(ret && ret != -EINVAL && ret != -EOPNOTSUPP))
454 ret = -EIO;
455 out:
456 return ret;
457}
458
459static int lo_req_flush(struct loop_device *lo, struct request *rq)
460{
461 struct file *file = lo->lo_backing_file;
462 int ret = vfs_fsync(file, 0);
463 if (unlikely(ret && ret != -EINVAL))
464 ret = -EIO;
465
466 return ret;
467}
468
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200469static void lo_complete_rq(struct request *rq)
Ming Leibc07c102015-08-17 10:31:51 +0800470{
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200471 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
Jens Axboef9de14b2018-04-13 16:25:57 -0600472 blk_status_t ret = BLK_STS_OK;
Ming Leibc07c102015-08-17 10:31:51 +0800473
Jens Axboef9de14b2018-04-13 16:25:57 -0600474 if (!cmd->use_aio || cmd->ret < 0 || cmd->ret == blk_rq_bytes(rq) ||
475 req_op(rq) != REQ_OP_READ) {
476 if (cmd->ret < 0)
Evan Green8cd55082020-04-03 16:43:03 +0200477 ret = errno_to_blk_status(cmd->ret);
Jens Axboef9de14b2018-04-13 16:25:57 -0600478 goto end_io;
Ming Leibc07c102015-08-17 10:31:51 +0800479 }
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200480
Jens Axboef9de14b2018-04-13 16:25:57 -0600481 /*
482 * Short READ - if we got some data, advance our request and
483 * retry it. If we got no data, end the rest with EIO.
484 */
485 if (cmd->ret) {
486 blk_update_request(rq, BLK_STS_OK, cmd->ret);
487 cmd->ret = 0;
488 blk_mq_requeue_request(rq, true);
489 } else {
490 if (cmd->use_aio) {
491 struct bio *bio = rq->bio;
492
493 while (bio) {
494 zero_fill_bio(bio);
495 bio = bio->bi_next;
496 }
497 }
498 ret = BLK_STS_IOERR;
499end_io:
500 blk_mq_end_request(rq, ret);
501 }
Ming Leibc07c102015-08-17 10:31:51 +0800502}
503
Shaohua Li92d77332017-09-01 11:15:17 -0700504static void lo_rw_aio_do_completion(struct loop_cmd *cmd)
505{
Jens Axboe1894e912018-04-13 16:24:29 -0600506 struct request *rq = blk_mq_rq_from_pdu(cmd);
507
Shaohua Li92d77332017-09-01 11:15:17 -0700508 if (!atomic_dec_and_test(&cmd->ref))
509 return;
510 kfree(cmd->bvec);
511 cmd->bvec = NULL;
Christoph Hellwig15f73f52020-06-11 08:44:47 +0200512 if (likely(!blk_should_fake_timeout(rq->q)))
513 blk_mq_complete_request(rq);
Shaohua Li92d77332017-09-01 11:15:17 -0700514}
515
Ming Leibc07c102015-08-17 10:31:51 +0800516static void lo_rw_aio_complete(struct kiocb *iocb, long ret, long ret2)
517{
518 struct loop_cmd *cmd = container_of(iocb, struct loop_cmd, iocb);
Ming Leibc07c102015-08-17 10:31:51 +0800519
Shaohua Lid4478e92017-09-25 13:07:22 -0600520 if (cmd->css)
521 css_put(cmd->css);
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200522 cmd->ret = ret;
Shaohua Li92d77332017-09-01 11:15:17 -0700523 lo_rw_aio_do_completion(cmd);
Ming Leibc07c102015-08-17 10:31:51 +0800524}
525
526static int lo_rw_aio(struct loop_device *lo, struct loop_cmd *cmd,
527 loff_t pos, bool rw)
528{
529 struct iov_iter iter;
Ming Lei86af5952019-02-15 19:13:17 +0800530 struct req_iterator rq_iter;
Ming Leibc07c102015-08-17 10:31:51 +0800531 struct bio_vec *bvec;
Jens Axboe1894e912018-04-13 16:24:29 -0600532 struct request *rq = blk_mq_rq_from_pdu(cmd);
Shaohua Li40326d82017-08-31 22:09:46 -0700533 struct bio *bio = rq->bio;
Ming Leibc07c102015-08-17 10:31:51 +0800534 struct file *file = lo->lo_backing_file;
Ming Lei86af5952019-02-15 19:13:17 +0800535 struct bio_vec tmp;
Shaohua Li40326d82017-08-31 22:09:46 -0700536 unsigned int offset;
Ming Lei86af5952019-02-15 19:13:17 +0800537 int nr_bvec = 0;
Ming Leibc07c102015-08-17 10:31:51 +0800538 int ret;
539
Ming Lei86af5952019-02-15 19:13:17 +0800540 rq_for_each_bvec(tmp, rq, rq_iter)
541 nr_bvec++;
Ming Leibc07c102015-08-17 10:31:51 +0800542
Ming Lei86af5952019-02-15 19:13:17 +0800543 if (rq->bio != rq->biotail) {
544
545 bvec = kmalloc_array(nr_bvec, sizeof(struct bio_vec),
Kees Cook6da2ec52018-06-12 13:55:00 -0700546 GFP_NOIO);
Shaohua Li40326d82017-08-31 22:09:46 -0700547 if (!bvec)
548 return -EIO;
549 cmd->bvec = bvec;
550
551 /*
552 * The bios of the request may be started from the middle of
553 * the 'bvec' because of bio splitting, so we can't directly
Ming Lei86af5952019-02-15 19:13:17 +0800554 * copy bio->bi_iov_vec to new bvec. The rq_for_each_bvec
Shaohua Li40326d82017-08-31 22:09:46 -0700555 * API will take care of all details for us.
556 */
Ming Lei86af5952019-02-15 19:13:17 +0800557 rq_for_each_bvec(tmp, rq, rq_iter) {
Shaohua Li40326d82017-08-31 22:09:46 -0700558 *bvec = tmp;
559 bvec++;
560 }
561 bvec = cmd->bvec;
562 offset = 0;
563 } else {
564 /*
565 * Same here, this bio may be started from the middle of the
566 * 'bvec' because of bio splitting, so offset from the bvec
567 * must be passed to iov iterator
568 */
569 offset = bio->bi_iter.bi_bvec_done;
570 bvec = __bvec_iter_bvec(bio->bi_io_vec, bio->bi_iter);
Shaohua Li40326d82017-08-31 22:09:46 -0700571 }
Shaohua Li92d77332017-09-01 11:15:17 -0700572 atomic_set(&cmd->ref, 2);
Shaohua Li40326d82017-08-31 22:09:46 -0700573
Christoph Hellwigb6207432019-06-26 15:49:28 +0200574 iov_iter_bvec(&iter, rw, bvec, nr_bvec, blk_rq_bytes(rq));
Shaohua Li40326d82017-08-31 22:09:46 -0700575 iter.iov_offset = offset;
Ming Leibc07c102015-08-17 10:31:51 +0800576
577 cmd->iocb.ki_pos = pos;
578 cmd->iocb.ki_filp = file;
579 cmd->iocb.ki_complete = lo_rw_aio_complete;
580 cmd->iocb.ki_flags = IOCB_DIRECT;
Adam Manzanaresd9a08a92018-05-22 10:52:19 -0700581 cmd->iocb.ki_ioprio = IOPRIO_PRIO_VALUE(IOPRIO_CLASS_NONE, 0);
Shaohua Lid4478e92017-09-25 13:07:22 -0600582 if (cmd->css)
583 kthread_associate_blkcg(cmd->css);
Ming Leibc07c102015-08-17 10:31:51 +0800584
585 if (rw == WRITE)
Miklos Szeredibb7462b2017-02-20 16:51:23 +0100586 ret = call_write_iter(file, &cmd->iocb, &iter);
Ming Leibc07c102015-08-17 10:31:51 +0800587 else
Miklos Szeredibb7462b2017-02-20 16:51:23 +0100588 ret = call_read_iter(file, &cmd->iocb, &iter);
Ming Leibc07c102015-08-17 10:31:51 +0800589
Shaohua Li92d77332017-09-01 11:15:17 -0700590 lo_rw_aio_do_completion(cmd);
Shaohua Lid4478e92017-09-25 13:07:22 -0600591 kthread_associate_blkcg(NULL);
Shaohua Li92d77332017-09-01 11:15:17 -0700592
Ming Leibc07c102015-08-17 10:31:51 +0800593 if (ret != -EIOCBQUEUED)
594 cmd->iocb.ki_complete(&cmd->iocb, ret, 0);
595 return 0;
596}
597
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200598static int do_req_filebacked(struct loop_device *lo, struct request *rq)
Ming Leibc07c102015-08-17 10:31:51 +0800599{
600 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200601 loff_t pos = ((loff_t) blk_rq_pos(rq) << 9) + lo->lo_offset;
Ming Leibc07c102015-08-17 10:31:51 +0800602
603 /*
604 * lo_write_simple and lo_read_simple should have been covered
605 * by io submit style function like lo_rw_aio(), one blocker
606 * is that lo_read_simple() need to call flush_dcache_page after
607 * the page is written from kernel, and it isn't easy to handle
608 * this in io submit style function which submits all segments
609 * of the req at one time. And direct read IO doesn't need to
610 * run flush_dcache_page().
611 */
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200612 switch (req_op(rq)) {
613 case REQ_OP_FLUSH:
614 return lo_req_flush(lo, rq);
Christoph Hellwig19372e22017-04-05 19:21:15 +0200615 case REQ_OP_WRITE_ZEROES:
Darrick J. Wongefcfec572019-10-30 20:29:48 -0700616 /*
617 * If the caller doesn't want deallocation, call zeroout to
618 * write zeroes the range. Otherwise, punch them out.
619 */
620 return lo_fallocate(lo, rq, pos,
621 (rq->cmd_flags & REQ_NOUNMAP) ?
622 FALLOC_FL_ZERO_RANGE :
623 FALLOC_FL_PUNCH_HOLE);
624 case REQ_OP_DISCARD:
625 return lo_fallocate(lo, rq, pos, FALLOC_FL_PUNCH_HOLE);
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200626 case REQ_OP_WRITE:
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200627 if (lo->transfer)
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200628 return lo_write_transfer(lo, rq, pos);
629 else if (cmd->use_aio)
630 return lo_rw_aio(lo, cmd, pos, WRITE);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200631 else
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200632 return lo_write_simple(lo, rq, pos);
633 case REQ_OP_READ:
634 if (lo->transfer)
635 return lo_read_transfer(lo, rq, pos);
636 else if (cmd->use_aio)
637 return lo_rw_aio(lo, cmd, pos, READ);
638 else
639 return lo_read_simple(lo, rq, pos);
640 default:
641 WARN_ON_ONCE(1);
642 return -EIO;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200643 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644}
645
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800646static inline void loop_update_dio(struct loop_device *lo)
647{
Ira Weinyefbe3c22020-04-30 07:41:33 -0700648 __loop_update_dio(lo, (lo->lo_backing_file->f_flags & O_DIRECT) |
649 lo->use_dio);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800650}
651
Ming Lei06f0e9e2015-05-06 12:26:24 +0800652static void loop_reread_partitions(struct loop_device *lo,
653 struct block_device *bdev)
654{
655 int rc;
656
Christoph Hellwigf0b870d2019-11-14 15:34:36 +0100657 mutex_lock(&bdev->bd_mutex);
658 rc = bdev_disk_changed(bdev, false);
659 mutex_unlock(&bdev->bd_mutex);
Ming Lei06f0e9e2015-05-06 12:26:24 +0800660 if (rc)
661 pr_warn("%s: partition scan of loop%d (%s) failed (rc=%d)\n",
662 __func__, lo->lo_number, lo->lo_file_name, rc);
663}
664
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400665static inline int is_loop_device(struct file *file)
666{
667 struct inode *i = file->f_mapping->host;
668
669 return i && S_ISBLK(i->i_mode) && MAJOR(i->i_rdev) == LOOP_MAJOR;
670}
671
672static int loop_validate_file(struct file *file, struct block_device *bdev)
673{
674 struct inode *inode = file->f_mapping->host;
675 struct file *f = file;
676
677 /* Avoid recursion */
678 while (is_loop_device(f)) {
679 struct loop_device *l;
680
681 if (f->f_mapping->host->i_bdev == bdev)
682 return -EBADF;
683
684 l = f->f_mapping->host->i_bdev->bd_disk->private_data;
Dongli Zhangf7c8a412019-03-18 20:23:17 +0800685 if (l->lo_state != Lo_bound) {
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400686 return -EINVAL;
687 }
688 f = l->lo_backing_file;
689 }
690 if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
691 return -EINVAL;
692 return 0;
693}
694
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695/*
696 * loop_change_fd switched the backing store of a loopback device to
697 * a new file. This is useful for operating system installers to free up
698 * the original file and in High Availability environments to switch to
699 * an alternative location for the content in case of server meltdown.
700 * This can only work if the loop device is used read-only, and if the
701 * new backing store is the same size and type as the old backing store.
702 */
Al Virobb214882008-03-02 09:29:48 -0500703static int loop_change_fd(struct loop_device *lo, struct block_device *bdev,
704 unsigned int arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705{
Jan Kara1dded9a2018-11-08 14:01:15 +0100706 struct file *file = NULL, *old_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 int error;
Jan Kara85b0a542018-11-08 14:01:13 +0100708 bool partscan;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
Jan Karac28445f2018-11-08 14:01:16 +0100710 error = mutex_lock_killable(&loop_ctl_mutex);
Jan Karac3710772018-11-08 14:01:11 +0100711 if (error)
712 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 error = -ENXIO;
714 if (lo->lo_state != Lo_bound)
Jan Kara1dded9a2018-11-08 14:01:15 +0100715 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716
717 /* the loop device has to be read-only */
718 error = -EINVAL;
719 if (!(lo->lo_flags & LO_FLAGS_READ_ONLY))
Jan Kara1dded9a2018-11-08 14:01:15 +0100720 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721
722 error = -EBADF;
723 file = fget(arg);
724 if (!file)
Jan Kara1dded9a2018-11-08 14:01:15 +0100725 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400727 error = loop_validate_file(file, bdev);
728 if (error)
Jan Kara1dded9a2018-11-08 14:01:15 +0100729 goto out_err;
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400730
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 old_file = lo->lo_backing_file;
732
733 error = -EINVAL;
734
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 /* size of the new backing store needs to be the same */
736 if (get_loop_size(lo, file) != get_loop_size(lo, old_file))
Jan Kara1dded9a2018-11-08 14:01:15 +0100737 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738
739 /* and ... switch */
Omar Sandoval43cade802017-08-24 00:03:44 -0700740 blk_mq_freeze_queue(lo->lo_queue);
741 mapping_set_gfp_mask(old_file->f_mapping, lo->old_gfp_mask);
742 lo->lo_backing_file = file;
743 lo->old_gfp_mask = mapping_gfp_mask(file->f_mapping);
744 mapping_set_gfp_mask(file->f_mapping,
745 lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
746 loop_update_dio(lo);
747 blk_mq_unfreeze_queue(lo->lo_queue);
Jan Kara85b0a542018-11-08 14:01:13 +0100748 partscan = lo->lo_flags & LO_FLAGS_PARTSCAN;
Jan Karac3710772018-11-08 14:01:11 +0100749 mutex_unlock(&loop_ctl_mutex);
Jan Kara1dded9a2018-11-08 14:01:15 +0100750 /*
751 * We must drop file reference outside of loop_ctl_mutex as dropping
752 * the file ref can take bd_mutex which creates circular locking
753 * dependency.
754 */
755 fput(old_file);
Jan Kara85b0a542018-11-08 14:01:13 +0100756 if (partscan)
757 loop_reread_partitions(lo, bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 return 0;
759
Jan Kara1dded9a2018-11-08 14:01:15 +0100760out_err:
Jan Karac3710772018-11-08 14:01:11 +0100761 mutex_unlock(&loop_ctl_mutex);
Jan Kara1dded9a2018-11-08 14:01:15 +0100762 if (file)
763 fput(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 return error;
765}
766
Milan Brozee862732010-08-23 15:16:00 +0200767/* loop sysfs attributes */
768
769static ssize_t loop_attr_show(struct device *dev, char *page,
770 ssize_t (*callback)(struct loop_device *, char *))
771{
Kay Sievers34dd82a2011-07-31 22:08:04 +0200772 struct gendisk *disk = dev_to_disk(dev);
773 struct loop_device *lo = disk->private_data;
Milan Brozee862732010-08-23 15:16:00 +0200774
Kay Sievers34dd82a2011-07-31 22:08:04 +0200775 return callback(lo, page);
Milan Brozee862732010-08-23 15:16:00 +0200776}
777
778#define LOOP_ATTR_RO(_name) \
779static ssize_t loop_attr_##_name##_show(struct loop_device *, char *); \
780static ssize_t loop_attr_do_show_##_name(struct device *d, \
781 struct device_attribute *attr, char *b) \
782{ \
783 return loop_attr_show(d, b, loop_attr_##_name##_show); \
784} \
785static struct device_attribute loop_attr_##_name = \
Joe Perches5657a812018-05-24 13:38:59 -0600786 __ATTR(_name, 0444, loop_attr_do_show_##_name, NULL);
Milan Brozee862732010-08-23 15:16:00 +0200787
788static ssize_t loop_attr_backing_file_show(struct loop_device *lo, char *buf)
789{
790 ssize_t ret;
791 char *p = NULL;
792
Kay Sievers05eb0f22011-07-31 22:21:35 +0200793 spin_lock_irq(&lo->lo_lock);
Milan Brozee862732010-08-23 15:16:00 +0200794 if (lo->lo_backing_file)
Miklos Szeredi9bf39ab2015-06-19 10:29:13 +0200795 p = file_path(lo->lo_backing_file, buf, PAGE_SIZE - 1);
Kay Sievers05eb0f22011-07-31 22:21:35 +0200796 spin_unlock_irq(&lo->lo_lock);
Milan Brozee862732010-08-23 15:16:00 +0200797
798 if (IS_ERR_OR_NULL(p))
799 ret = PTR_ERR(p);
800 else {
801 ret = strlen(p);
802 memmove(buf, p, ret);
803 buf[ret++] = '\n';
804 buf[ret] = 0;
805 }
806
807 return ret;
808}
809
810static ssize_t loop_attr_offset_show(struct loop_device *lo, char *buf)
811{
812 return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_offset);
813}
814
815static ssize_t loop_attr_sizelimit_show(struct loop_device *lo, char *buf)
816{
817 return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_sizelimit);
818}
819
820static ssize_t loop_attr_autoclear_show(struct loop_device *lo, char *buf)
821{
822 int autoclear = (lo->lo_flags & LO_FLAGS_AUTOCLEAR);
823
824 return sprintf(buf, "%s\n", autoclear ? "1" : "0");
825}
826
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200827static ssize_t loop_attr_partscan_show(struct loop_device *lo, char *buf)
828{
829 int partscan = (lo->lo_flags & LO_FLAGS_PARTSCAN);
830
831 return sprintf(buf, "%s\n", partscan ? "1" : "0");
832}
833
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800834static ssize_t loop_attr_dio_show(struct loop_device *lo, char *buf)
835{
836 int dio = (lo->lo_flags & LO_FLAGS_DIRECT_IO);
837
838 return sprintf(buf, "%s\n", dio ? "1" : "0");
839}
840
Milan Brozee862732010-08-23 15:16:00 +0200841LOOP_ATTR_RO(backing_file);
842LOOP_ATTR_RO(offset);
843LOOP_ATTR_RO(sizelimit);
844LOOP_ATTR_RO(autoclear);
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200845LOOP_ATTR_RO(partscan);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800846LOOP_ATTR_RO(dio);
Milan Brozee862732010-08-23 15:16:00 +0200847
848static struct attribute *loop_attrs[] = {
849 &loop_attr_backing_file.attr,
850 &loop_attr_offset.attr,
851 &loop_attr_sizelimit.attr,
852 &loop_attr_autoclear.attr,
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200853 &loop_attr_partscan.attr,
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800854 &loop_attr_dio.attr,
Milan Brozee862732010-08-23 15:16:00 +0200855 NULL,
856};
857
858static struct attribute_group loop_attribute_group = {
859 .name = "loop",
860 .attrs= loop_attrs,
861};
862
Tetsuo Handad3349b62018-05-04 10:58:09 -0600863static void loop_sysfs_init(struct loop_device *lo)
Milan Brozee862732010-08-23 15:16:00 +0200864{
Tetsuo Handad3349b62018-05-04 10:58:09 -0600865 lo->sysfs_inited = !sysfs_create_group(&disk_to_dev(lo->lo_disk)->kobj,
866 &loop_attribute_group);
Milan Brozee862732010-08-23 15:16:00 +0200867}
868
869static void loop_sysfs_exit(struct loop_device *lo)
870{
Tetsuo Handad3349b62018-05-04 10:58:09 -0600871 if (lo->sysfs_inited)
872 sysfs_remove_group(&disk_to_dev(lo->lo_disk)->kobj,
873 &loop_attribute_group);
Milan Brozee862732010-08-23 15:16:00 +0200874}
875
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200876static void loop_config_discard(struct loop_device *lo)
877{
878 struct file *file = lo->lo_backing_file;
879 struct inode *inode = file->f_mapping->host;
880 struct request_queue *q = lo->lo_queue;
881
882 /*
Evan Greenc52abf52020-04-03 16:43:04 +0200883 * If the backing device is a block device, mirror its zeroing
884 * capability. Set the discard sectors to the block device's zeroing
885 * capabilities because loop discards result in blkdev_issue_zeroout(),
886 * not blkdev_issue_discard(). This maintains consistent behavior with
887 * file-backed loop devices: discarded regions read back as zero.
888 */
889 if (S_ISBLK(inode->i_mode) && !lo->lo_encrypt_key_size) {
890 struct request_queue *backingq;
891
892 backingq = bdev_get_queue(inode->i_bdev);
893 blk_queue_max_discard_sectors(q,
894 backingq->limits.max_write_zeroes_sectors);
895
896 blk_queue_max_write_zeroes_sectors(q,
897 backingq->limits.max_write_zeroes_sectors);
898
899 /*
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200900 * We use punch hole to reclaim the free space used by the
Olaf Hering12a64d22014-01-21 14:39:24 -0800901 * image a.k.a. discard. However we do not support discard if
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200902 * encryption is enabled, because it may give an attacker
903 * useful information.
904 */
Evan Greenc52abf52020-04-03 16:43:04 +0200905 } else if (!file->f_op->fallocate || lo->lo_encrypt_key_size) {
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200906 q->limits.discard_granularity = 0;
907 q->limits.discard_alignment = 0;
Jens Axboe2bb4cd52015-07-14 08:15:12 -0600908 blk_queue_max_discard_sectors(q, 0);
Christoph Hellwig19372e22017-04-05 19:21:15 +0200909 blk_queue_max_write_zeroes_sectors(q, 0);
Evan Greenc52abf52020-04-03 16:43:04 +0200910
911 } else {
912 q->limits.discard_granularity = inode->i_sb->s_blocksize;
913 q->limits.discard_alignment = 0;
914
915 blk_queue_max_discard_sectors(q, UINT_MAX >> 9);
916 blk_queue_max_write_zeroes_sectors(q, UINT_MAX >> 9);
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200917 }
918
Evan Greenc52abf52020-04-03 16:43:04 +0200919 if (q->limits.max_write_zeroes_sectors)
920 blk_queue_flag_set(QUEUE_FLAG_DISCARD, q);
921 else
922 blk_queue_flag_clear(QUEUE_FLAG_DISCARD, q);
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200923}
924
Ming Leie03a3d72015-08-17 10:31:48 +0800925static void loop_unprepare_queue(struct loop_device *lo)
926{
Petr Mladek39891442016-10-11 13:55:20 -0700927 kthread_flush_worker(&lo->worker);
Ming Leie03a3d72015-08-17 10:31:48 +0800928 kthread_stop(lo->worker_task);
929}
930
NeilBrownb2ee7d42017-06-16 15:02:09 +1000931static int loop_kthread_worker_fn(void *worker_ptr)
932{
NeilBrowna37b0712020-06-01 21:48:18 -0700933 current->flags |= PF_LOCAL_THROTTLE | PF_MEMALLOC_NOIO;
NeilBrownb2ee7d42017-06-16 15:02:09 +1000934 return kthread_worker_fn(worker_ptr);
935}
936
Ming Leie03a3d72015-08-17 10:31:48 +0800937static int loop_prepare_queue(struct loop_device *lo)
938{
Petr Mladek39891442016-10-11 13:55:20 -0700939 kthread_init_worker(&lo->worker);
NeilBrownb2ee7d42017-06-16 15:02:09 +1000940 lo->worker_task = kthread_run(loop_kthread_worker_fn,
Ming Leie03a3d72015-08-17 10:31:48 +0800941 &lo->worker, "loop%d", lo->lo_number);
942 if (IS_ERR(lo->worker_task))
943 return -ENOMEM;
944 set_user_nice(lo->worker_task, MIN_NICE);
945 return 0;
946}
947
Holger Hoffstätte56a85fd2019-02-12 15:54:24 -0700948static void loop_update_rotational(struct loop_device *lo)
949{
950 struct file *file = lo->lo_backing_file;
951 struct inode *file_inode = file->f_mapping->host;
952 struct block_device *file_bdev = file_inode->i_sb->s_bdev;
953 struct request_queue *q = lo->lo_queue;
954 bool nonrot = true;
955
956 /* not all filesystems (e.g. tmpfs) have a sb->s_bdev */
957 if (file_bdev)
958 nonrot = blk_queue_nonrot(bdev_get_queue(file_bdev));
959
960 if (nonrot)
961 blk_queue_flag_set(QUEUE_FLAG_NONROT, q);
962 else
963 blk_queue_flag_clear(QUEUE_FLAG_NONROT, q);
964}
965
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966static int
967loop_release_xfer(struct loop_device *lo)
968{
969 int err = 0;
970 struct loop_func_table *xfer = lo->lo_encryption;
971
972 if (xfer) {
973 if (xfer->release)
974 err = xfer->release(lo);
975 lo->transfer = NULL;
976 lo->lo_encryption = NULL;
977 module_put(xfer->owner);
978 }
979 return err;
980}
981
982static int
983loop_init_xfer(struct loop_device *lo, struct loop_func_table *xfer,
984 const struct loop_info64 *i)
985{
986 int err = 0;
987
988 if (xfer) {
989 struct module *owner = xfer->owner;
990
991 if (!try_module_get(owner))
992 return -EINVAL;
993 if (xfer->init)
994 err = xfer->init(lo, i);
995 if (err)
996 module_put(owner);
997 else
998 lo->lo_encryption = xfer;
999 }
1000 return err;
1001}
1002
Martijn Coenen62ab4662020-05-13 15:38:42 +02001003/**
1004 * loop_set_status_from_info - configure device from loop_info
1005 * @lo: struct loop_device to configure
1006 * @info: struct loop_info64 to configure the device with
1007 *
1008 * Configures the loop device parameters according to the passed
1009 * in loop_info64 configuration.
1010 */
1011static int
1012loop_set_status_from_info(struct loop_device *lo,
1013 const struct loop_info64 *info)
1014{
1015 int err;
1016 struct loop_func_table *xfer;
1017 kuid_t uid = current_uid();
1018
1019 if ((unsigned int) info->lo_encrypt_key_size > LO_KEY_SIZE)
1020 return -EINVAL;
1021
1022 err = loop_release_xfer(lo);
1023 if (err)
1024 return err;
1025
1026 if (info->lo_encrypt_type) {
1027 unsigned int type = info->lo_encrypt_type;
1028
1029 if (type >= MAX_LO_CRYPT)
1030 return -EINVAL;
1031 xfer = xfer_funcs[type];
1032 if (xfer == NULL)
1033 return -EINVAL;
1034 } else
1035 xfer = NULL;
1036
1037 err = loop_init_xfer(lo, xfer, info);
1038 if (err)
1039 return err;
1040
1041 lo->lo_offset = info->lo_offset;
1042 lo->lo_sizelimit = info->lo_sizelimit;
1043 memcpy(lo->lo_file_name, info->lo_file_name, LO_NAME_SIZE);
1044 memcpy(lo->lo_crypt_name, info->lo_crypt_name, LO_NAME_SIZE);
1045 lo->lo_file_name[LO_NAME_SIZE-1] = 0;
1046 lo->lo_crypt_name[LO_NAME_SIZE-1] = 0;
1047
1048 if (!xfer)
1049 xfer = &none_funcs;
1050 lo->transfer = xfer->transfer;
1051 lo->ioctl = xfer->ioctl;
1052
Martijn Coenenfaf1d252020-05-13 15:38:44 +02001053 lo->lo_flags = info->lo_flags;
Martijn Coenen62ab4662020-05-13 15:38:42 +02001054
1055 lo->lo_encrypt_key_size = info->lo_encrypt_key_size;
1056 lo->lo_init[0] = info->lo_init[0];
1057 lo->lo_init[1] = info->lo_init[1];
1058 if (info->lo_encrypt_key_size) {
1059 memcpy(lo->lo_encrypt_key, info->lo_encrypt_key,
1060 info->lo_encrypt_key_size);
1061 lo->lo_key_owner = uid;
1062 }
1063
1064 return 0;
1065}
1066
Martijn Coenen34489142020-05-13 15:38:45 +02001067static int loop_configure(struct loop_device *lo, fmode_t mode,
1068 struct block_device *bdev,
1069 const struct loop_config *config)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070{
1071 struct file *file;
1072 struct inode *inode;
1073 struct address_space *mapping;
1074 struct block_device *claimed_bdev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 int error;
1076 loff_t size;
1077 bool partscan;
Martijn Coenen34489142020-05-13 15:38:45 +02001078 unsigned short bsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079
1080 /* This is safe, since we have a reference from open(). */
1081 __module_get(THIS_MODULE);
1082
1083 error = -EBADF;
Martijn Coenen34489142020-05-13 15:38:45 +02001084 file = fget(config->fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 if (!file)
1086 goto out;
1087
1088 /*
1089 * If we don't hold exclusive handle for the device, upgrade to it
1090 * here to avoid changing device under exclusive owner.
1091 */
1092 if (!(mode & FMODE_EXCL)) {
Christoph Hellwigecbe6bc2020-07-16 16:33:09 +02001093 claimed_bdev = bdev->bd_contains;
1094 error = bd_prepare_to_claim(bdev, claimed_bdev, loop_configure);
1095 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 goto out_putf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 }
1098
1099 error = mutex_lock_killable(&loop_ctl_mutex);
1100 if (error)
1101 goto out_bdev;
1102
1103 error = -EBUSY;
1104 if (lo->lo_state != Lo_unbound)
1105 goto out_unlock;
1106
1107 error = loop_validate_file(file, bdev);
1108 if (error)
1109 goto out_unlock;
1110
1111 mapping = file->f_mapping;
1112 inode = mapping->host;
1113
Martijn Coenen34489142020-05-13 15:38:45 +02001114 size = get_loop_size(lo, file);
1115
1116 if ((config->info.lo_flags & ~LOOP_CONFIGURE_SETTABLE_FLAGS) != 0) {
1117 error = -EINVAL;
1118 goto out_unlock;
1119 }
1120
1121 if (config->block_size) {
1122 error = loop_validate_block_size(config->block_size);
1123 if (error)
1124 goto out_unlock;
1125 }
1126
1127 error = loop_set_status_from_info(lo, &config->info);
1128 if (error)
1129 goto out_unlock;
1130
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131 if (!(file->f_mode & FMODE_WRITE) || !(mode & FMODE_WRITE) ||
1132 !file->f_op->write_iter)
Martijn Coenen34489142020-05-13 15:38:45 +02001133 lo->lo_flags |= LO_FLAGS_READ_ONLY;
Martijn Coenen083a6a52020-05-13 15:38:36 +02001134
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 error = loop_prepare_queue(lo);
1136 if (error)
1137 goto out_unlock;
1138
Martijn Coenen34489142020-05-13 15:38:45 +02001139 set_device_ro(bdev, (lo->lo_flags & LO_FLAGS_READ_ONLY) != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140
Martijn Coenen34489142020-05-13 15:38:45 +02001141 lo->use_dio = lo->lo_flags & LO_FLAGS_DIRECT_IO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 lo->lo_device = bdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143 lo->lo_backing_file = file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 lo->old_gfp_mask = mapping_gfp_mask(mapping);
1145 mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
1146
Martijn Coenen34489142020-05-13 15:38:45 +02001147 if (!(lo->lo_flags & LO_FLAGS_READ_ONLY) && file->f_op->fsync)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148 blk_queue_write_cache(lo->lo_queue, true, false);
1149
Martijn Coenen34489142020-05-13 15:38:45 +02001150 if (config->block_size)
1151 bsize = config->block_size;
Linus Torvalds96ed3202020-06-02 19:45:12 -07001152 else if ((lo->lo_backing_file->f_flags & O_DIRECT) && inode->i_sb->s_bdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153 /* In case of direct I/O, match underlying block size */
Martijn Coenen34489142020-05-13 15:38:45 +02001154 bsize = bdev_logical_block_size(inode->i_sb->s_bdev);
1155 else
1156 bsize = 512;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157
Martijn Coenen34489142020-05-13 15:38:45 +02001158 blk_queue_logical_block_size(lo->lo_queue, bsize);
1159 blk_queue_physical_block_size(lo->lo_queue, bsize);
1160 blk_queue_io_min(lo->lo_queue, bsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161
1162 loop_update_rotational(lo);
1163 loop_update_dio(lo);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 loop_sysfs_init(lo);
Martijn Coenen5795b6f2020-05-13 15:38:37 +02001165 loop_set_size(lo, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166
1167 set_blocksize(bdev, S_ISBLK(inode->i_mode) ?
1168 block_size(inode->i_bdev) : PAGE_SIZE);
1169
1170 lo->lo_state = Lo_bound;
1171 if (part_shift)
1172 lo->lo_flags |= LO_FLAGS_PARTSCAN;
1173 partscan = lo->lo_flags & LO_FLAGS_PARTSCAN;
Lennart Poetteringfe6a8fc2020-08-10 19:16:32 +02001174 if (partscan)
1175 lo->lo_disk->flags &= ~GENHD_FL_NO_PART_SCAN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176
1177 /* Grab the block_device to prevent its destruction after we
1178 * put /dev/loopXX inode. Later in __loop_clr_fd() we bdput(bdev).
1179 */
1180 bdgrab(bdev);
1181 mutex_unlock(&loop_ctl_mutex);
1182 if (partscan)
1183 loop_reread_partitions(lo, bdev);
1184 if (claimed_bdev)
Martijn Coenen34489142020-05-13 15:38:45 +02001185 bd_abort_claiming(bdev, claimed_bdev, loop_configure);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 return 0;
1187
1188out_unlock:
1189 mutex_unlock(&loop_ctl_mutex);
1190out_bdev:
1191 if (claimed_bdev)
Martijn Coenen34489142020-05-13 15:38:45 +02001192 bd_abort_claiming(bdev, claimed_bdev, loop_configure);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193out_putf:
1194 fput(file);
1195out:
1196 /* This is safe: open() is still holding a reference. */
1197 module_put(THIS_MODULE);
1198 return error;
1199}
1200
Jan Kara0da03ca2018-11-08 14:01:14 +01001201static int __loop_clr_fd(struct loop_device *lo, bool release)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202{
Jan Kara7ccd0792018-11-08 14:01:07 +01001203 struct file *filp = NULL;
Al Virob4e3ca12005-10-21 03:22:34 -04001204 gfp_t gfp = lo->old_gfp_mask;
Ayan George4c823cc2011-09-21 10:02:13 +02001205 struct block_device *bdev = lo->lo_device;
Jan Kara7ccd0792018-11-08 14:01:07 +01001206 int err = 0;
Jan Kara0da03ca2018-11-08 14:01:14 +01001207 bool partscan = false;
1208 int lo_number;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209
Jan Kara7ccd0792018-11-08 14:01:07 +01001210 mutex_lock(&loop_ctl_mutex);
1211 if (WARN_ON_ONCE(lo->lo_state != Lo_rundown)) {
1212 err = -ENXIO;
1213 goto out_unlock;
1214 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215
Jan Kara7ccd0792018-11-08 14:01:07 +01001216 filp = lo->lo_backing_file;
1217 if (filp == NULL) {
1218 err = -EINVAL;
1219 goto out_unlock;
1220 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221
Ming Leif8933662015-05-06 12:26:23 +08001222 /* freeze request queue during the transition */
1223 blk_mq_freeze_queue(lo->lo_queue);
1224
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225 spin_lock_irq(&lo->lo_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 lo->lo_backing_file = NULL;
Kay Sievers05eb0f22011-07-31 22:21:35 +02001227 spin_unlock_irq(&lo->lo_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228
1229 loop_release_xfer(lo);
1230 lo->transfer = NULL;
1231 lo->ioctl = NULL;
1232 lo->lo_device = NULL;
1233 lo->lo_encryption = NULL;
1234 lo->lo_offset = 0;
1235 lo->lo_sizelimit = 0;
1236 lo->lo_encrypt_key_size = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 memset(lo->lo_encrypt_key, 0, LO_KEY_SIZE);
1238 memset(lo->lo_crypt_name, 0, LO_NAME_SIZE);
1239 memset(lo->lo_file_name, 0, LO_NAME_SIZE);
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001240 blk_queue_logical_block_size(lo->lo_queue, 512);
Omar Sandovalbf093752017-09-05 14:24:47 -07001241 blk_queue_physical_block_size(lo->lo_queue, 512);
1242 blk_queue_io_min(lo->lo_queue, 512);
Anatol Pomozovc1681bf2013-04-01 09:47:56 -07001243 if (bdev) {
1244 bdput(bdev);
Al Virobb214882008-03-02 09:29:48 -05001245 invalidate_bdev(bdev);
Jeff Laytoneedffa22018-05-21 14:35:03 -04001246 bdev->bd_inode->i_mapping->wb_err = 0;
Anatol Pomozovc1681bf2013-04-01 09:47:56 -07001247 }
Ken Chen73285082007-05-08 00:28:20 -07001248 set_capacity(lo->lo_disk, 0);
Milan Broz51a0bb02010-10-27 19:51:30 -06001249 loop_sysfs_exit(lo);
David Zeuthenc3473c62010-05-03 14:08:59 +02001250 if (bdev) {
Al Virobb214882008-03-02 09:29:48 -05001251 bd_set_size(bdev, 0);
David Zeuthenc3473c62010-05-03 14:08:59 +02001252 /* let user-space know about this change */
1253 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
1254 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 mapping_set_gfp_mask(filp->f_mapping, gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256 /* This is safe: open() is still holding a reference. */
1257 module_put(THIS_MODULE);
Ming Leif8933662015-05-06 12:26:23 +08001258 blk_mq_unfreeze_queue(lo->lo_queue);
1259
Jan Kara0da03ca2018-11-08 14:01:14 +01001260 partscan = lo->lo_flags & LO_FLAGS_PARTSCAN && bdev;
1261 lo_number = lo->lo_number;
Jan Kara0da03ca2018-11-08 14:01:14 +01001262 loop_unprepare_queue(lo);
1263out_unlock:
1264 mutex_unlock(&loop_ctl_mutex);
1265 if (partscan) {
Jan Karad57f3372018-11-08 14:01:12 +01001266 /*
1267 * bd_mutex has been held already in release path, so don't
1268 * acquire it if this function is called in such case.
1269 *
1270 * If the reread partition isn't from release path, lo_refcnt
1271 * must be at least one and it can only become zero when the
1272 * current holder is released.
1273 */
Christoph Hellwigf0b870d2019-11-14 15:34:36 +01001274 if (!release)
1275 mutex_lock(&bdev->bd_mutex);
1276 err = bdev_disk_changed(bdev, false);
1277 if (!release)
1278 mutex_unlock(&bdev->bd_mutex);
Dongli Zhang40853d62019-02-22 22:10:19 +08001279 if (err)
1280 pr_warn("%s: partition scan of loop%d failed (rc=%d)\n",
1281 __func__, lo_number, err);
Jan Karad57f3372018-11-08 14:01:12 +01001282 /* Device is gone, no point in returning error */
1283 err = 0;
1284 }
Dongli Zhang758a58d2019-02-22 22:10:20 +08001285
1286 /*
1287 * lo->lo_state is set to Lo_unbound here after above partscan has
1288 * finished.
1289 *
1290 * There cannot be anybody else entering __loop_clr_fd() as
1291 * lo->lo_backing_file is already cleared and Lo_rundown state
1292 * protects us from all the other places trying to change the 'lo'
1293 * device.
1294 */
1295 mutex_lock(&loop_ctl_mutex);
1296 lo->lo_flags = 0;
1297 if (!part_shift)
1298 lo->lo_disk->flags |= GENHD_FL_NO_PART_SCAN;
1299 lo->lo_state = Lo_unbound;
1300 mutex_unlock(&loop_ctl_mutex);
1301
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001302 /*
Tetsuo Handa310ca162018-11-08 14:01:02 +01001303 * Need not hold loop_ctl_mutex to fput backing file.
1304 * Calling fput holding loop_ctl_mutex triggers a circular
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001305 * lock dependency possibility warning as fput can take
Tetsuo Handa310ca162018-11-08 14:01:02 +01001306 * bd_mutex which is usually taken before loop_ctl_mutex.
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001307 */
Jan Kara7ccd0792018-11-08 14:01:07 +01001308 if (filp)
1309 fput(filp);
1310 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311}
1312
Jan Karaa2505b72018-11-08 14:01:06 +01001313static int loop_clr_fd(struct loop_device *lo)
1314{
Jan Kara7ccd0792018-11-08 14:01:07 +01001315 int err;
1316
Jan Karac28445f2018-11-08 14:01:16 +01001317 err = mutex_lock_killable(&loop_ctl_mutex);
Jan Kara7ccd0792018-11-08 14:01:07 +01001318 if (err)
1319 return err;
1320 if (lo->lo_state != Lo_bound) {
1321 mutex_unlock(&loop_ctl_mutex);
Jan Karaa2505b72018-11-08 14:01:06 +01001322 return -ENXIO;
Jan Kara7ccd0792018-11-08 14:01:07 +01001323 }
Jan Karaa2505b72018-11-08 14:01:06 +01001324 /*
1325 * If we've explicitly asked to tear down the loop device,
1326 * and it has an elevated reference count, set it for auto-teardown when
1327 * the last reference goes away. This stops $!~#$@ udev from
1328 * preventing teardown because it decided that it needs to run blkid on
1329 * the loopback device whenever they appear. xfstests is notorious for
1330 * failing tests because blkid via udev races with a losetup
1331 * <dev>/do something like mkfs/losetup -d <dev> causing the losetup -d
1332 * command to fail with EBUSY.
1333 */
1334 if (atomic_read(&lo->lo_refcnt) > 1) {
1335 lo->lo_flags |= LO_FLAGS_AUTOCLEAR;
1336 mutex_unlock(&loop_ctl_mutex);
1337 return 0;
1338 }
1339 lo->lo_state = Lo_rundown;
Jan Kara7ccd0792018-11-08 14:01:07 +01001340 mutex_unlock(&loop_ctl_mutex);
Jan Karaa2505b72018-11-08 14:01:06 +01001341
Jan Kara0da03ca2018-11-08 14:01:14 +01001342 return __loop_clr_fd(lo, false);
Jan Karaa2505b72018-11-08 14:01:06 +01001343}
1344
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345static int
1346loop_set_status(struct loop_device *lo, const struct loop_info64 *info)
1347{
1348 int err;
Jan Kara85b0a542018-11-08 14:01:13 +01001349 struct block_device *bdev;
Martijn Coenen0c3796c2020-05-13 15:38:41 +02001350 kuid_t uid = current_uid();
Martijn Coenenfaf1d252020-05-13 15:38:44 +02001351 int prev_lo_flags;
Jan Kara85b0a542018-11-08 14:01:13 +01001352 bool partscan = false;
Martijn Coenen0c3796c2020-05-13 15:38:41 +02001353 bool size_changed = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354
Jan Karac28445f2018-11-08 14:01:16 +01001355 err = mutex_lock_killable(&loop_ctl_mutex);
Jan Kara550df5fd2018-11-08 14:01:09 +01001356 if (err)
1357 return err;
David Howellsb0fafa82008-11-14 10:38:41 +11001358 if (lo->lo_encrypt_key_size &&
Eric W. Biedermane4849732012-02-11 11:23:51 -08001359 !uid_eq(lo->lo_key_owner, uid) &&
Jan Kara550df5fd2018-11-08 14:01:09 +01001360 !capable(CAP_SYS_ADMIN)) {
1361 err = -EPERM;
1362 goto out_unlock;
1363 }
1364 if (lo->lo_state != Lo_bound) {
1365 err = -ENXIO;
1366 goto out_unlock;
1367 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001369 if (lo->lo_offset != info->lo_offset ||
1370 lo->lo_sizelimit != info->lo_sizelimit) {
Martijn Coenen0c3796c2020-05-13 15:38:41 +02001371 size_changed = true;
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001372 sync_blockdev(lo->lo_device);
Zheng Binf4bd34b2020-06-18 12:21:37 +08001373 invalidate_bdev(lo->lo_device);
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001374 }
1375
Ming Leiecdd0952017-02-11 11:40:45 +08001376 /* I/O need to be drained during transfer transition */
1377 blk_mq_freeze_queue(lo->lo_queue);
1378
Martijn Coenen0c3796c2020-05-13 15:38:41 +02001379 if (size_changed && lo->lo_device->bd_inode->i_mapping->nrpages) {
Zheng Binf4bd34b2020-06-18 12:21:37 +08001380 /* If any pages were dirtied after invalidate_bdev(), try again */
Martijn Coenen0c3796c2020-05-13 15:38:41 +02001381 err = -EAGAIN;
1382 pr_warn("%s: loop%d (%s) has still dirty pages (nrpages=%lu)\n",
1383 __func__, lo->lo_number, lo->lo_file_name,
1384 lo->lo_device->bd_inode->i_mapping->nrpages);
1385 goto out_unfreeze;
1386 }
1387
Martijn Coenenfaf1d252020-05-13 15:38:44 +02001388 prev_lo_flags = lo->lo_flags;
1389
Martijn Coenen0c3796c2020-05-13 15:38:41 +02001390 err = loop_set_status_from_info(lo, info);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 if (err)
Jan Kara550df5fd2018-11-08 14:01:09 +01001392 goto out_unfreeze;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393
Martijn Coenenfaf1d252020-05-13 15:38:44 +02001394 /* Mask out flags that can't be set using LOOP_SET_STATUS. */
Martijn Coenen6ac92fb2020-06-04 22:25:20 +02001395 lo->lo_flags &= LOOP_SET_STATUS_SETTABLE_FLAGS;
Martijn Coenenfaf1d252020-05-13 15:38:44 +02001396 /* For those flags, use the previous values instead */
1397 lo->lo_flags |= prev_lo_flags & ~LOOP_SET_STATUS_SETTABLE_FLAGS;
1398 /* For flags that can't be cleared, use previous values too */
1399 lo->lo_flags |= prev_lo_flags & ~LOOP_SET_STATUS_CLEARABLE_FLAGS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400
Martijn Coenenb0bd1582020-05-13 15:38:39 +02001401 if (size_changed) {
1402 loff_t new_size = get_size(lo->lo_offset, lo->lo_sizelimit,
1403 lo->lo_backing_file);
1404 loop_set_size(lo, new_size);
Arnd Bergmannb040ad92017-06-09 12:19:18 +02001405 }
Guo Chao541c7422013-02-21 15:16:46 -08001406
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +02001407 loop_config_discard(lo);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408
Ming Lei2e5ab5f2015-08-17 10:31:49 +08001409 /* update dio if lo_offset or transfer is changed */
1410 __loop_update_dio(lo, lo->use_dio);
1411
Jan Kara550df5fd2018-11-08 14:01:09 +01001412out_unfreeze:
Ming Leiecdd0952017-02-11 11:40:45 +08001413 blk_mq_unfreeze_queue(lo->lo_queue);
Omar Sandovale02898b42017-03-01 10:42:38 -08001414
Martijn Coenenfaf1d252020-05-13 15:38:44 +02001415 if (!err && (lo->lo_flags & LO_FLAGS_PARTSCAN) &&
1416 !(prev_lo_flags & LO_FLAGS_PARTSCAN)) {
Omar Sandovale02898b42017-03-01 10:42:38 -08001417 lo->lo_disk->flags &= ~GENHD_FL_NO_PART_SCAN;
Jan Kara85b0a542018-11-08 14:01:13 +01001418 bdev = lo->lo_device;
1419 partscan = true;
Omar Sandovale02898b42017-03-01 10:42:38 -08001420 }
Jan Kara550df5fd2018-11-08 14:01:09 +01001421out_unlock:
1422 mutex_unlock(&loop_ctl_mutex);
Jan Kara85b0a542018-11-08 14:01:13 +01001423 if (partscan)
1424 loop_reread_partitions(lo, bdev);
Omar Sandovale02898b42017-03-01 10:42:38 -08001425
Ming Leiecdd0952017-02-11 11:40:45 +08001426 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427}
1428
1429static int
1430loop_get_status(struct loop_device *lo, struct loop_info64 *info)
1431{
Tetsuo Handab1ab5fa2018-11-08 14:01:01 +01001432 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 struct kstat stat;
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001434 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435
Jan Karac28445f2018-11-08 14:01:16 +01001436 ret = mutex_lock_killable(&loop_ctl_mutex);
Jan Kara4a5ce9b2018-11-08 14:01:08 +01001437 if (ret)
1438 return ret;
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001439 if (lo->lo_state != Lo_bound) {
Tetsuo Handa310ca162018-11-08 14:01:02 +01001440 mutex_unlock(&loop_ctl_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441 return -ENXIO;
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001442 }
1443
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444 memset(info, 0, sizeof(*info));
1445 info->lo_number = lo->lo_number;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 info->lo_offset = lo->lo_offset;
1447 info->lo_sizelimit = lo->lo_sizelimit;
1448 info->lo_flags = lo->lo_flags;
1449 memcpy(info->lo_file_name, lo->lo_file_name, LO_NAME_SIZE);
1450 memcpy(info->lo_crypt_name, lo->lo_crypt_name, LO_NAME_SIZE);
1451 info->lo_encrypt_type =
1452 lo->lo_encryption ? lo->lo_encryption->number : 0;
1453 if (lo->lo_encrypt_key_size && capable(CAP_SYS_ADMIN)) {
1454 info->lo_encrypt_key_size = lo->lo_encrypt_key_size;
1455 memcpy(info->lo_encrypt_key, lo->lo_encrypt_key,
1456 lo->lo_encrypt_key_size);
1457 }
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001458
Tetsuo Handa310ca162018-11-08 14:01:02 +01001459 /* Drop loop_ctl_mutex while we call into the filesystem. */
Tetsuo Handab1ab5fa2018-11-08 14:01:01 +01001460 path = lo->lo_backing_file->f_path;
1461 path_get(&path);
Tetsuo Handa310ca162018-11-08 14:01:02 +01001462 mutex_unlock(&loop_ctl_mutex);
Tetsuo Handab1ab5fa2018-11-08 14:01:01 +01001463 ret = vfs_getattr(&path, &stat, STATX_INO, AT_STATX_SYNC_AS_STAT);
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001464 if (!ret) {
1465 info->lo_device = huge_encode_dev(stat.dev);
1466 info->lo_inode = stat.ino;
1467 info->lo_rdevice = huge_encode_dev(stat.rdev);
1468 }
Tetsuo Handab1ab5fa2018-11-08 14:01:01 +01001469 path_put(&path);
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001470 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471}
1472
1473static void
1474loop_info64_from_old(const struct loop_info *info, struct loop_info64 *info64)
1475{
1476 memset(info64, 0, sizeof(*info64));
1477 info64->lo_number = info->lo_number;
1478 info64->lo_device = info->lo_device;
1479 info64->lo_inode = info->lo_inode;
1480 info64->lo_rdevice = info->lo_rdevice;
1481 info64->lo_offset = info->lo_offset;
1482 info64->lo_sizelimit = 0;
1483 info64->lo_encrypt_type = info->lo_encrypt_type;
1484 info64->lo_encrypt_key_size = info->lo_encrypt_key_size;
1485 info64->lo_flags = info->lo_flags;
1486 info64->lo_init[0] = info->lo_init[0];
1487 info64->lo_init[1] = info->lo_init[1];
1488 if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1489 memcpy(info64->lo_crypt_name, info->lo_name, LO_NAME_SIZE);
1490 else
1491 memcpy(info64->lo_file_name, info->lo_name, LO_NAME_SIZE);
1492 memcpy(info64->lo_encrypt_key, info->lo_encrypt_key, LO_KEY_SIZE);
1493}
1494
1495static int
1496loop_info64_to_old(const struct loop_info64 *info64, struct loop_info *info)
1497{
1498 memset(info, 0, sizeof(*info));
1499 info->lo_number = info64->lo_number;
1500 info->lo_device = info64->lo_device;
1501 info->lo_inode = info64->lo_inode;
1502 info->lo_rdevice = info64->lo_rdevice;
1503 info->lo_offset = info64->lo_offset;
1504 info->lo_encrypt_type = info64->lo_encrypt_type;
1505 info->lo_encrypt_key_size = info64->lo_encrypt_key_size;
1506 info->lo_flags = info64->lo_flags;
1507 info->lo_init[0] = info64->lo_init[0];
1508 info->lo_init[1] = info64->lo_init[1];
1509 if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1510 memcpy(info->lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1511 else
1512 memcpy(info->lo_name, info64->lo_file_name, LO_NAME_SIZE);
1513 memcpy(info->lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1514
1515 /* error in case values were truncated */
1516 if (info->lo_device != info64->lo_device ||
1517 info->lo_rdevice != info64->lo_rdevice ||
1518 info->lo_inode != info64->lo_inode ||
1519 info->lo_offset != info64->lo_offset)
1520 return -EOVERFLOW;
1521
1522 return 0;
1523}
1524
1525static int
1526loop_set_status_old(struct loop_device *lo, const struct loop_info __user *arg)
1527{
1528 struct loop_info info;
1529 struct loop_info64 info64;
1530
1531 if (copy_from_user(&info, arg, sizeof (struct loop_info)))
1532 return -EFAULT;
1533 loop_info64_from_old(&info, &info64);
1534 return loop_set_status(lo, &info64);
1535}
1536
1537static int
1538loop_set_status64(struct loop_device *lo, const struct loop_info64 __user *arg)
1539{
1540 struct loop_info64 info64;
1541
1542 if (copy_from_user(&info64, arg, sizeof (struct loop_info64)))
1543 return -EFAULT;
1544 return loop_set_status(lo, &info64);
1545}
1546
1547static int
1548loop_get_status_old(struct loop_device *lo, struct loop_info __user *arg) {
1549 struct loop_info info;
1550 struct loop_info64 info64;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001551 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552
Jan Kara4a5ce9b2018-11-08 14:01:08 +01001553 if (!arg)
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001554 return -EINVAL;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001555 err = loop_get_status(lo, &info64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556 if (!err)
1557 err = loop_info64_to_old(&info64, &info);
1558 if (!err && copy_to_user(arg, &info, sizeof(info)))
1559 err = -EFAULT;
1560
1561 return err;
1562}
1563
1564static int
1565loop_get_status64(struct loop_device *lo, struct loop_info64 __user *arg) {
1566 struct loop_info64 info64;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001567 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568
Jan Kara4a5ce9b2018-11-08 14:01:08 +01001569 if (!arg)
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001570 return -EINVAL;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001571 err = loop_get_status(lo, &info64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 if (!err && copy_to_user(arg, &info64, sizeof(info64)))
1573 err = -EFAULT;
1574
1575 return err;
1576}
1577
Hannes Reinecke51001b72017-06-08 13:46:44 +02001578static int loop_set_capacity(struct loop_device *lo)
J. R. Okajima53d66602009-03-31 15:23:43 -07001579{
Martijn Coenen0a6ed1b2020-05-13 15:38:40 +02001580 loff_t size;
1581
J. R. Okajima53d66602009-03-31 15:23:43 -07001582 if (unlikely(lo->lo_state != Lo_bound))
Guo Chao7b0576a2013-02-21 15:16:47 -08001583 return -ENXIO;
J. R. Okajima53d66602009-03-31 15:23:43 -07001584
Martijn Coenen0a6ed1b2020-05-13 15:38:40 +02001585 size = get_loop_size(lo, lo->lo_backing_file);
1586 loop_set_size(lo, size);
Martijn Coenen083a6a52020-05-13 15:38:36 +02001587
1588 return 0;
J. R. Okajima53d66602009-03-31 15:23:43 -07001589}
1590
Ming Leiab1cb272015-08-17 10:31:50 +08001591static int loop_set_dio(struct loop_device *lo, unsigned long arg)
1592{
1593 int error = -ENXIO;
1594 if (lo->lo_state != Lo_bound)
1595 goto out;
1596
1597 __loop_update_dio(lo, !!arg);
1598 if (lo->use_dio == !!arg)
1599 return 0;
1600 error = -EINVAL;
1601 out:
1602 return error;
1603}
1604
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001605static int loop_set_block_size(struct loop_device *lo, unsigned long arg)
1606{
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001607 int err = 0;
1608
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001609 if (lo->lo_state != Lo_bound)
1610 return -ENXIO;
1611
Martijn Coenen34489142020-05-13 15:38:45 +02001612 err = loop_validate_block_size(arg);
1613 if (err)
1614 return err;
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001615
Martijn Coenen7e81f992020-03-10 14:12:30 +01001616 if (lo->lo_queue->limits.logical_block_size == arg)
1617 return 0;
1618
1619 sync_blockdev(lo->lo_device);
Zheng Binf4bd34b2020-06-18 12:21:37 +08001620 invalidate_bdev(lo->lo_device);
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001621
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001622 blk_mq_freeze_queue(lo->lo_queue);
1623
Zheng Binf4bd34b2020-06-18 12:21:37 +08001624 /* invalidate_bdev should have truncated all the pages */
Martijn Coenen7e81f992020-03-10 14:12:30 +01001625 if (lo->lo_device->bd_inode->i_mapping->nrpages) {
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001626 err = -EAGAIN;
1627 pr_warn("%s: loop%d (%s) has still dirty pages (nrpages=%lu)\n",
1628 __func__, lo->lo_number, lo->lo_file_name,
1629 lo->lo_device->bd_inode->i_mapping->nrpages);
1630 goto out_unfreeze;
1631 }
1632
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001633 blk_queue_logical_block_size(lo->lo_queue, arg);
Omar Sandovalbf093752017-09-05 14:24:47 -07001634 blk_queue_physical_block_size(lo->lo_queue, arg);
1635 blk_queue_io_min(lo->lo_queue, arg);
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001636 loop_update_dio(lo);
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001637out_unfreeze:
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001638 blk_mq_unfreeze_queue(lo->lo_queue);
1639
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001640 return err;
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001641}
1642
Jan Karaa1316542018-11-08 14:01:05 +01001643static int lo_simple_ioctl(struct loop_device *lo, unsigned int cmd,
1644 unsigned long arg)
1645{
1646 int err;
1647
Jan Karac28445f2018-11-08 14:01:16 +01001648 err = mutex_lock_killable(&loop_ctl_mutex);
Jan Karaa1316542018-11-08 14:01:05 +01001649 if (err)
1650 return err;
1651 switch (cmd) {
1652 case LOOP_SET_CAPACITY:
1653 err = loop_set_capacity(lo);
1654 break;
1655 case LOOP_SET_DIRECT_IO:
1656 err = loop_set_dio(lo, arg);
1657 break;
1658 case LOOP_SET_BLOCK_SIZE:
1659 err = loop_set_block_size(lo, arg);
1660 break;
1661 default:
1662 err = lo->ioctl ? lo->ioctl(lo, cmd, arg) : -EINVAL;
1663 }
1664 mutex_unlock(&loop_ctl_mutex);
1665 return err;
1666}
1667
Al Virobb214882008-03-02 09:29:48 -05001668static int lo_ioctl(struct block_device *bdev, fmode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 unsigned int cmd, unsigned long arg)
1670{
Al Virobb214882008-03-02 09:29:48 -05001671 struct loop_device *lo = bdev->bd_disk->private_data;
Martijn Coenen571fae62020-05-13 15:38:43 +02001672 void __user *argp = (void __user *) arg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 int err;
1674
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 switch (cmd) {
Martijn Coenen34489142020-05-13 15:38:45 +02001676 case LOOP_SET_FD: {
1677 /*
1678 * Legacy case - pass in a zeroed out struct loop_config with
1679 * only the file descriptor set , which corresponds with the
1680 * default parameters we'd have used otherwise.
1681 */
1682 struct loop_config config;
1683
1684 memset(&config, 0, sizeof(config));
1685 config.fd = arg;
1686
1687 return loop_configure(lo, mode, bdev, &config);
1688 }
1689 case LOOP_CONFIGURE: {
1690 struct loop_config config;
1691
1692 if (copy_from_user(&config, argp, sizeof(config)))
1693 return -EFAULT;
1694
1695 return loop_configure(lo, mode, bdev, &config);
1696 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 case LOOP_CHANGE_FD:
Jan Karac3710772018-11-08 14:01:11 +01001698 return loop_change_fd(lo, bdev, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 case LOOP_CLR_FD:
Jan Kara7ccd0792018-11-08 14:01:07 +01001700 return loop_clr_fd(lo);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 case LOOP_SET_STATUS:
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_status_old(lo, argp);
Jan Karaa1316542018-11-08 14:01:05 +01001705 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 break;
1707 case LOOP_GET_STATUS:
Martijn Coenen571fae62020-05-13 15:38:43 +02001708 return loop_get_status_old(lo, argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709 case LOOP_SET_STATUS64:
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +01001710 err = -EPERM;
Jan Karaa1316542018-11-08 14:01:05 +01001711 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN)) {
Martijn Coenen571fae62020-05-13 15:38:43 +02001712 err = loop_set_status64(lo, argp);
Jan Karaa1316542018-11-08 14:01:05 +01001713 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714 break;
1715 case LOOP_GET_STATUS64:
Martijn Coenen571fae62020-05-13 15:38:43 +02001716 return loop_get_status64(lo, argp);
J. R. Okajima53d66602009-03-31 15:23:43 -07001717 case LOOP_SET_CAPACITY:
Ming Leiab1cb272015-08-17 10:31:50 +08001718 case LOOP_SET_DIRECT_IO:
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001719 case LOOP_SET_BLOCK_SIZE:
Jan Karaa1316542018-11-08 14:01:05 +01001720 if (!(mode & FMODE_WRITE) && !capable(CAP_SYS_ADMIN))
1721 return -EPERM;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05001722 fallthrough;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723 default:
Jan Karaa1316542018-11-08 14:01:05 +01001724 err = lo_simple_ioctl(lo, cmd, arg);
1725 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726 }
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001727
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728 return err;
1729}
1730
David Howells863d5b822006-08-29 19:06:14 +01001731#ifdef CONFIG_COMPAT
1732struct compat_loop_info {
1733 compat_int_t lo_number; /* ioctl r/o */
1734 compat_dev_t lo_device; /* ioctl r/o */
1735 compat_ulong_t lo_inode; /* ioctl r/o */
1736 compat_dev_t lo_rdevice; /* ioctl r/o */
1737 compat_int_t lo_offset;
1738 compat_int_t lo_encrypt_type;
1739 compat_int_t lo_encrypt_key_size; /* ioctl w/o */
1740 compat_int_t lo_flags; /* ioctl r/o */
1741 char lo_name[LO_NAME_SIZE];
1742 unsigned char lo_encrypt_key[LO_KEY_SIZE]; /* ioctl w/o */
1743 compat_ulong_t lo_init[2];
1744 char reserved[4];
1745};
1746
1747/*
1748 * Transfer 32-bit compatibility structure in userspace to 64-bit loop info
1749 * - noinlined to reduce stack space usage in main part of driver
1750 */
1751static noinline int
Al Viroba674cf2006-10-10 22:48:27 +01001752loop_info64_from_compat(const struct compat_loop_info __user *arg,
David Howells863d5b822006-08-29 19:06:14 +01001753 struct loop_info64 *info64)
1754{
1755 struct compat_loop_info info;
1756
1757 if (copy_from_user(&info, arg, sizeof(info)))
1758 return -EFAULT;
1759
1760 memset(info64, 0, sizeof(*info64));
1761 info64->lo_number = info.lo_number;
1762 info64->lo_device = info.lo_device;
1763 info64->lo_inode = info.lo_inode;
1764 info64->lo_rdevice = info.lo_rdevice;
1765 info64->lo_offset = info.lo_offset;
1766 info64->lo_sizelimit = 0;
1767 info64->lo_encrypt_type = info.lo_encrypt_type;
1768 info64->lo_encrypt_key_size = info.lo_encrypt_key_size;
1769 info64->lo_flags = info.lo_flags;
1770 info64->lo_init[0] = info.lo_init[0];
1771 info64->lo_init[1] = info.lo_init[1];
1772 if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1773 memcpy(info64->lo_crypt_name, info.lo_name, LO_NAME_SIZE);
1774 else
1775 memcpy(info64->lo_file_name, info.lo_name, LO_NAME_SIZE);
1776 memcpy(info64->lo_encrypt_key, info.lo_encrypt_key, LO_KEY_SIZE);
1777 return 0;
1778}
1779
1780/*
1781 * Transfer 64-bit loop info to 32-bit compatibility structure in userspace
1782 * - noinlined to reduce stack space usage in main part of driver
1783 */
1784static noinline int
1785loop_info64_to_compat(const struct loop_info64 *info64,
1786 struct compat_loop_info __user *arg)
1787{
1788 struct compat_loop_info info;
1789
1790 memset(&info, 0, sizeof(info));
1791 info.lo_number = info64->lo_number;
1792 info.lo_device = info64->lo_device;
1793 info.lo_inode = info64->lo_inode;
1794 info.lo_rdevice = info64->lo_rdevice;
1795 info.lo_offset = info64->lo_offset;
1796 info.lo_encrypt_type = info64->lo_encrypt_type;
1797 info.lo_encrypt_key_size = info64->lo_encrypt_key_size;
1798 info.lo_flags = info64->lo_flags;
1799 info.lo_init[0] = info64->lo_init[0];
1800 info.lo_init[1] = info64->lo_init[1];
1801 if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1802 memcpy(info.lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1803 else
1804 memcpy(info.lo_name, info64->lo_file_name, LO_NAME_SIZE);
1805 memcpy(info.lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1806
1807 /* error in case values were truncated */
1808 if (info.lo_device != info64->lo_device ||
1809 info.lo_rdevice != info64->lo_rdevice ||
1810 info.lo_inode != info64->lo_inode ||
1811 info.lo_offset != info64->lo_offset ||
1812 info.lo_init[0] != info64->lo_init[0] ||
1813 info.lo_init[1] != info64->lo_init[1])
1814 return -EOVERFLOW;
1815
1816 if (copy_to_user(arg, &info, sizeof(info)))
1817 return -EFAULT;
1818 return 0;
1819}
1820
1821static int
1822loop_set_status_compat(struct loop_device *lo,
1823 const struct compat_loop_info __user *arg)
1824{
1825 struct loop_info64 info64;
1826 int ret;
1827
1828 ret = loop_info64_from_compat(arg, &info64);
1829 if (ret < 0)
1830 return ret;
1831 return loop_set_status(lo, &info64);
1832}
1833
1834static int
1835loop_get_status_compat(struct loop_device *lo,
1836 struct compat_loop_info __user *arg)
1837{
1838 struct loop_info64 info64;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001839 int err;
David Howells863d5b822006-08-29 19:06:14 +01001840
Jan Kara4a5ce9b2018-11-08 14:01:08 +01001841 if (!arg)
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001842 return -EINVAL;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001843 err = loop_get_status(lo, &info64);
David Howells863d5b822006-08-29 19:06:14 +01001844 if (!err)
1845 err = loop_info64_to_compat(&info64, arg);
1846 return err;
1847}
1848
Al Virobb214882008-03-02 09:29:48 -05001849static int lo_compat_ioctl(struct block_device *bdev, fmode_t mode,
1850 unsigned int cmd, unsigned long arg)
David Howells863d5b822006-08-29 19:06:14 +01001851{
Al Virobb214882008-03-02 09:29:48 -05001852 struct loop_device *lo = bdev->bd_disk->private_data;
David Howells863d5b822006-08-29 19:06:14 +01001853 int err;
1854
David Howells863d5b822006-08-29 19:06:14 +01001855 switch(cmd) {
1856 case LOOP_SET_STATUS:
Jan Kara550df5fd2018-11-08 14:01:09 +01001857 err = loop_set_status_compat(lo,
1858 (const struct compat_loop_info __user *)arg);
David Howells863d5b822006-08-29 19:06:14 +01001859 break;
1860 case LOOP_GET_STATUS:
Jan Kara4a5ce9b2018-11-08 14:01:08 +01001861 err = loop_get_status_compat(lo,
1862 (struct compat_loop_info __user *)arg);
David Howells863d5b822006-08-29 19:06:14 +01001863 break;
J. R. Okajima53d66602009-03-31 15:23:43 -07001864 case LOOP_SET_CAPACITY:
David Howells863d5b822006-08-29 19:06:14 +01001865 case LOOP_CLR_FD:
1866 case LOOP_GET_STATUS64:
1867 case LOOP_SET_STATUS64:
Martijn Coenen34489142020-05-13 15:38:45 +02001868 case LOOP_CONFIGURE:
David Howells863d5b822006-08-29 19:06:14 +01001869 arg = (unsigned long) compat_ptr(arg);
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05001870 fallthrough;
David Howells863d5b822006-08-29 19:06:14 +01001871 case LOOP_SET_FD:
1872 case LOOP_CHANGE_FD:
Evan Green9fea4b32018-07-02 16:03:46 -07001873 case LOOP_SET_BLOCK_SIZE:
Alessio Balsinifdbe4ee2019-08-07 01:48:28 +01001874 case LOOP_SET_DIRECT_IO:
Al Virobb214882008-03-02 09:29:48 -05001875 err = lo_ioctl(bdev, mode, cmd, arg);
David Howells863d5b822006-08-29 19:06:14 +01001876 break;
1877 default:
1878 err = -ENOIOCTLCMD;
1879 break;
1880 }
David Howells863d5b822006-08-29 19:06:14 +01001881 return err;
1882}
1883#endif
1884
Al Virobb214882008-03-02 09:29:48 -05001885static int lo_open(struct block_device *bdev, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886{
Kay Sievers770fe302011-07-31 22:08:04 +02001887 struct loop_device *lo;
Jan Kara0a42e992018-11-08 14:01:04 +01001888 int err;
Kay Sievers770fe302011-07-31 22:08:04 +02001889
Jan Kara0a42e992018-11-08 14:01:04 +01001890 err = mutex_lock_killable(&loop_ctl_mutex);
1891 if (err)
1892 return err;
Kay Sievers770fe302011-07-31 22:08:04 +02001893 lo = bdev->bd_disk->private_data;
1894 if (!lo) {
1895 err = -ENXIO;
1896 goto out;
1897 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898
Ming Leif8933662015-05-06 12:26:23 +08001899 atomic_inc(&lo->lo_refcnt);
Kay Sievers770fe302011-07-31 22:08:04 +02001900out:
Jan Kara0a42e992018-11-08 14:01:04 +01001901 mutex_unlock(&loop_ctl_mutex);
Kay Sievers770fe302011-07-31 22:08:04 +02001902 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903}
1904
Jan Kara967d1dc2018-11-08 14:01:03 +01001905static void lo_release(struct gendisk *disk, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906{
Jan Kara967d1dc2018-11-08 14:01:03 +01001907 struct loop_device *lo;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908
Jan Kara0a42e992018-11-08 14:01:04 +01001909 mutex_lock(&loop_ctl_mutex);
Jan Kara967d1dc2018-11-08 14:01:03 +01001910 lo = disk->private_data;
Ming Leif8933662015-05-06 12:26:23 +08001911 if (atomic_dec_return(&lo->lo_refcnt))
Jan Kara0a42e992018-11-08 14:01:04 +01001912 goto out_unlock;
Ming Leif8933662015-05-06 12:26:23 +08001913
Milan Broz14f27932008-12-12 14:48:27 +01001914 if (lo->lo_flags & LO_FLAGS_AUTOCLEAR) {
Jan Karaa2505b72018-11-08 14:01:06 +01001915 if (lo->lo_state != Lo_bound)
1916 goto out_unlock;
1917 lo->lo_state = Lo_rundown;
Jan Kara7ccd0792018-11-08 14:01:07 +01001918 mutex_unlock(&loop_ctl_mutex);
Milan Broz14f27932008-12-12 14:48:27 +01001919 /*
1920 * In autoclear mode, stop the loop thread
1921 * and remove configuration after last close.
1922 */
Jan Kara0da03ca2018-11-08 14:01:14 +01001923 __loop_clr_fd(lo, true);
Jan Kara7ccd0792018-11-08 14:01:07 +01001924 return;
Omar Sandoval43cade802017-08-24 00:03:44 -07001925 } else if (lo->lo_state == Lo_bound) {
Milan Broz14f27932008-12-12 14:48:27 +01001926 /*
1927 * Otherwise keep thread (if running) and config,
1928 * but flush possible ongoing bios in thread.
1929 */
Omar Sandoval43cade802017-08-24 00:03:44 -07001930 blk_mq_freeze_queue(lo->lo_queue);
1931 blk_mq_unfreeze_queue(lo->lo_queue);
Milan Broz14f27932008-12-12 14:48:27 +01001932 }
David Woodhouse96c58652008-02-06 01:36:27 -08001933
Jan Kara0a42e992018-11-08 14:01:04 +01001934out_unlock:
Tetsuo Handa310ca162018-11-08 14:01:02 +01001935 mutex_unlock(&loop_ctl_mutex);
Linus Torvaldsae665012018-01-05 16:26:00 -08001936}
1937
Alexey Dobriyan83d5cde2009-09-21 17:01:13 -07001938static const struct block_device_operations lo_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939 .owner = THIS_MODULE,
Al Virobb214882008-03-02 09:29:48 -05001940 .open = lo_open,
1941 .release = lo_release,
1942 .ioctl = lo_ioctl,
David Howells863d5b822006-08-29 19:06:14 +01001943#ifdef CONFIG_COMPAT
Al Virobb214882008-03-02 09:29:48 -05001944 .compat_ioctl = lo_compat_ioctl,
David Howells863d5b822006-08-29 19:06:14 +01001945#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946};
1947
1948/*
1949 * And now the modules code and kernel interface.
1950 */
Ken Chen73285082007-05-08 00:28:20 -07001951static int max_loop;
Joe Perches5657a812018-05-24 13:38:59 -06001952module_param(max_loop, int, 0444);
Ken Chena47653f2007-06-08 13:46:44 -07001953MODULE_PARM_DESC(max_loop, "Maximum number of loop devices");
Joe Perches5657a812018-05-24 13:38:59 -06001954module_param(max_part, int, 0444);
Laurent Vivier476a4812008-03-26 12:11:53 +01001955MODULE_PARM_DESC(max_part, "Maximum number of partitions per loop device");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956MODULE_LICENSE("GPL");
1957MODULE_ALIAS_BLOCKDEV_MAJOR(LOOP_MAJOR);
1958
1959int loop_register_transfer(struct loop_func_table *funcs)
1960{
1961 unsigned int n = funcs->number;
1962
1963 if (n >= MAX_LO_CRYPT || xfer_funcs[n])
1964 return -EINVAL;
1965 xfer_funcs[n] = funcs;
1966 return 0;
1967}
1968
Kay Sievers34dd82a2011-07-31 22:08:04 +02001969static int unregister_transfer_cb(int id, void *ptr, void *data)
1970{
1971 struct loop_device *lo = ptr;
1972 struct loop_func_table *xfer = data;
1973
Tetsuo Handa310ca162018-11-08 14:01:02 +01001974 mutex_lock(&loop_ctl_mutex);
Kay Sievers34dd82a2011-07-31 22:08:04 +02001975 if (lo->lo_encryption == xfer)
1976 loop_release_xfer(lo);
Tetsuo Handa310ca162018-11-08 14:01:02 +01001977 mutex_unlock(&loop_ctl_mutex);
Kay Sievers34dd82a2011-07-31 22:08:04 +02001978 return 0;
1979}
1980
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981int loop_unregister_transfer(int number)
1982{
1983 unsigned int n = number;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984 struct loop_func_table *xfer;
1985
1986 if (n == 0 || n >= MAX_LO_CRYPT || (xfer = xfer_funcs[n]) == NULL)
1987 return -EINVAL;
1988
1989 xfer_funcs[n] = NULL;
Kay Sievers34dd82a2011-07-31 22:08:04 +02001990 idr_for_each(&loop_index_idr, &unregister_transfer_cb, xfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991 return 0;
1992}
1993
1994EXPORT_SYMBOL(loop_register_transfer);
1995EXPORT_SYMBOL(loop_unregister_transfer);
1996
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001997static blk_status_t loop_queue_rq(struct blk_mq_hw_ctx *hctx,
Ming Leib5dd2f62014-12-31 13:22:57 +00001998 const struct blk_mq_queue_data *bd)
1999{
Jens Axboe1894e912018-04-13 16:24:29 -06002000 struct request *rq = bd->rq;
2001 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
2002 struct loop_device *lo = rq->q->queuedata;
Ming Leib5dd2f62014-12-31 13:22:57 +00002003
Jens Axboe1894e912018-04-13 16:24:29 -06002004 blk_mq_start_request(rq);
Ming Leib5dd2f62014-12-31 13:22:57 +00002005
Ming Leif4aa4c72015-05-05 19:49:54 +08002006 if (lo->lo_state != Lo_bound)
Christoph Hellwigfc17b652017-06-03 09:38:05 +02002007 return BLK_STS_IOERR;
Ming Leif4aa4c72015-05-05 19:49:54 +08002008
Jens Axboe1894e912018-04-13 16:24:29 -06002009 switch (req_op(rq)) {
Christoph Hellwigf0225ca2016-08-04 16:10:00 +02002010 case REQ_OP_FLUSH:
2011 case REQ_OP_DISCARD:
Christoph Hellwig19372e22017-04-05 19:21:15 +02002012 case REQ_OP_WRITE_ZEROES:
Ming Leibc07c102015-08-17 10:31:51 +08002013 cmd->use_aio = false;
Christoph Hellwigf0225ca2016-08-04 16:10:00 +02002014 break;
2015 default:
2016 cmd->use_aio = lo->use_dio;
2017 break;
2018 }
Ming Leibc07c102015-08-17 10:31:51 +08002019
Shaohua Lid4478e92017-09-25 13:07:22 -06002020 /* always use the first bio's css */
Shaohua Li0b508bc2017-09-26 11:02:12 -07002021#ifdef CONFIG_BLK_CGROUP
Dennis Zhoudb6638d2018-12-05 12:10:35 -05002022 if (cmd->use_aio && rq->bio && rq->bio->bi_blkg) {
2023 cmd->css = &bio_blkcg(rq->bio)->css;
Shaohua Lid4478e92017-09-25 13:07:22 -06002024 css_get(cmd->css);
2025 } else
2026#endif
2027 cmd->css = NULL;
Petr Mladek39891442016-10-11 13:55:20 -07002028 kthread_queue_work(&lo->worker, &cmd->work);
Ming Leib5dd2f62014-12-31 13:22:57 +00002029
Christoph Hellwigfc17b652017-06-03 09:38:05 +02002030 return BLK_STS_OK;
Ming Leib5dd2f62014-12-31 13:22:57 +00002031}
2032
2033static void loop_handle_cmd(struct loop_cmd *cmd)
2034{
Jens Axboe1894e912018-04-13 16:24:29 -06002035 struct request *rq = blk_mq_rq_from_pdu(cmd);
2036 const bool write = op_is_write(req_op(rq));
2037 struct loop_device *lo = rq->q->queuedata;
Christoph Hellwigf4829a92015-09-27 21:01:50 +02002038 int ret = 0;
Ming Leib5dd2f62014-12-31 13:22:57 +00002039
Christoph Hellwigf4829a92015-09-27 21:01:50 +02002040 if (write && (lo->lo_flags & LO_FLAGS_READ_ONLY)) {
2041 ret = -EIO;
Ming Leib5dd2f62014-12-31 13:22:57 +00002042 goto failed;
Christoph Hellwigf4829a92015-09-27 21:01:50 +02002043 }
Ming Leib5dd2f62014-12-31 13:22:57 +00002044
Jens Axboe1894e912018-04-13 16:24:29 -06002045 ret = do_req_filebacked(lo, rq);
Ming Leib5dd2f62014-12-31 13:22:57 +00002046 failed:
Ming Leibc07c102015-08-17 10:31:51 +08002047 /* complete non-aio request */
Christoph Hellwigfe2cb292017-04-20 16:03:02 +02002048 if (!cmd->use_aio || ret) {
Evan Green8cd55082020-04-03 16:43:03 +02002049 if (ret == -EOPNOTSUPP)
2050 cmd->ret = ret;
2051 else
2052 cmd->ret = ret ? -EIO : 0;
Christoph Hellwig15f73f52020-06-11 08:44:47 +02002053 if (likely(!blk_should_fake_timeout(rq->q)))
2054 blk_mq_complete_request(rq);
Christoph Hellwigfe2cb292017-04-20 16:03:02 +02002055 }
Ming Leib5dd2f62014-12-31 13:22:57 +00002056}
2057
Ming Leie03a3d72015-08-17 10:31:48 +08002058static void loop_queue_work(struct kthread_work *work)
Ming Leib5dd2f62014-12-31 13:22:57 +00002059{
2060 struct loop_cmd *cmd =
Ming Leie03a3d72015-08-17 10:31:48 +08002061 container_of(work, struct loop_cmd, work);
Ming Leib5dd2f62014-12-31 13:22:57 +00002062
2063 loop_handle_cmd(cmd);
2064}
2065
Christoph Hellwigd6296d392017-05-01 10:19:08 -06002066static int loop_init_request(struct blk_mq_tag_set *set, struct request *rq,
2067 unsigned int hctx_idx, unsigned int numa_node)
Ming Leib5dd2f62014-12-31 13:22:57 +00002068{
2069 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
2070
Petr Mladek39891442016-10-11 13:55:20 -07002071 kthread_init_work(&cmd->work, loop_queue_work);
Ming Leib5dd2f62014-12-31 13:22:57 +00002072 return 0;
2073}
2074
Eric Biggersf363b082017-03-30 13:39:16 -07002075static const struct blk_mq_ops loop_mq_ops = {
Ming Leib5dd2f62014-12-31 13:22:57 +00002076 .queue_rq = loop_queue_rq,
Ming Leib5dd2f62014-12-31 13:22:57 +00002077 .init_request = loop_init_request,
Christoph Hellwigfe2cb292017-04-20 16:03:02 +02002078 .complete = lo_complete_rq,
Ming Leib5dd2f62014-12-31 13:22:57 +00002079};
2080
Kay Sievers34dd82a2011-07-31 22:08:04 +02002081static int loop_add(struct loop_device **l, int i)
Ken Chen73285082007-05-08 00:28:20 -07002082{
2083 struct loop_device *lo;
2084 struct gendisk *disk;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002085 int err;
Ken Chen73285082007-05-08 00:28:20 -07002086
Silva Paulo68d740d2012-07-14 15:39:58 -07002087 err = -ENOMEM;
Ken Chen73285082007-05-08 00:28:20 -07002088 lo = kzalloc(sizeof(*lo), GFP_KERNEL);
Silva Paulo68d740d2012-07-14 15:39:58 -07002089 if (!lo)
Ken Chen73285082007-05-08 00:28:20 -07002090 goto out;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002091
Mikulas Patockaef7e7c82013-10-15 14:14:38 -06002092 lo->lo_state = Lo_unbound;
2093
Tejun Heoc718aa62013-02-27 17:03:58 -08002094 /* allocate id, if @id >= 0, we're requesting that specific id */
Kay Sievers34dd82a2011-07-31 22:08:04 +02002095 if (i >= 0) {
Tejun Heoc718aa62013-02-27 17:03:58 -08002096 err = idr_alloc(&loop_index_idr, lo, i, i + 1, GFP_KERNEL);
2097 if (err == -ENOSPC)
Kay Sievers34dd82a2011-07-31 22:08:04 +02002098 err = -EEXIST;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002099 } else {
Tejun Heoc718aa62013-02-27 17:03:58 -08002100 err = idr_alloc(&loop_index_idr, lo, 0, 0, GFP_KERNEL);
Kay Sievers34dd82a2011-07-31 22:08:04 +02002101 }
2102 if (err < 0)
2103 goto out_free_dev;
Tejun Heoc718aa62013-02-27 17:03:58 -08002104 i = err;
Ken Chen73285082007-05-08 00:28:20 -07002105
Wei Yongjun183cfb52013-03-22 08:59:19 -06002106 err = -ENOMEM;
Ming Leib5dd2f62014-12-31 13:22:57 +00002107 lo->tag_set.ops = &loop_mq_ops;
2108 lo->tag_set.nr_hw_queues = 1;
2109 lo->tag_set.queue_depth = 128;
2110 lo->tag_set.numa_node = NUMA_NO_NODE;
2111 lo->tag_set.cmd_size = sizeof(struct loop_cmd);
Ming Leibf0beec2020-05-29 15:53:15 +02002112 lo->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_STACKING;
Ming Leib5dd2f62014-12-31 13:22:57 +00002113 lo->tag_set.driver_data = lo;
2114
2115 err = blk_mq_alloc_tag_set(&lo->tag_set);
2116 if (err)
Mikulas Patocka3ec981e2013-10-14 12:12:24 -04002117 goto out_free_idr;
Ken Chen73285082007-05-08 00:28:20 -07002118
Ming Leib5dd2f62014-12-31 13:22:57 +00002119 lo->lo_queue = blk_mq_init_queue(&lo->tag_set);
Chengguang Xu38a34992018-12-16 17:35:00 +08002120 if (IS_ERR(lo->lo_queue)) {
Ming Leib5dd2f62014-12-31 13:22:57 +00002121 err = PTR_ERR(lo->lo_queue);
2122 goto out_cleanup_tags;
2123 }
Mikulas Patockaef7e7c82013-10-15 14:14:38 -06002124 lo->lo_queue->queuedata = lo;
2125
Shaohua Li54bb0ad2017-08-31 22:09:45 -07002126 blk_queue_max_hw_sectors(lo->lo_queue, BLK_DEF_MAX_SECTORS);
Shaohua Li40326d82017-08-31 22:09:46 -07002127
Ming Lei5b5e20f2015-08-17 10:31:47 +08002128 /*
Shaohua Li40326d82017-08-31 22:09:46 -07002129 * By default, we do buffer IO, so it doesn't make sense to enable
2130 * merge because the I/O submitted to backing file is handled page by
2131 * page. For directio mode, merge does help to dispatch bigger request
2132 * to underlayer disk. We will enable merge once directio is enabled.
Ming Lei5b5e20f2015-08-17 10:31:47 +08002133 */
Bart Van Assche8b904b52018-03-07 17:10:10 -08002134 blk_queue_flag_set(QUEUE_FLAG_NOMERGES, lo->lo_queue);
Ming Lei5b5e20f2015-08-17 10:31:47 +08002135
Minfei Huang7a649732016-06-07 10:05:15 +08002136 err = -ENOMEM;
Laurent Vivier476a4812008-03-26 12:11:53 +01002137 disk = lo->lo_disk = alloc_disk(1 << part_shift);
Ken Chen73285082007-05-08 00:28:20 -07002138 if (!disk)
2139 goto out_free_queue;
2140
Kay Sieverse03c8dd2011-08-23 20:12:04 +02002141 /*
2142 * Disable partition scanning by default. The in-kernel partition
2143 * scanning can be requested individually per-device during its
2144 * setup. Userspace can always add and remove partitions from all
2145 * devices. The needed partition minors are allocated from the
2146 * extended minor space, the main loop device numbers will continue
2147 * to match the loop minors, regardless of the number of partitions
2148 * used.
2149 *
2150 * If max_part is given, partition scanning is globally enabled for
2151 * all loop devices. The minors for the main loop devices will be
2152 * multiples of max_part.
2153 *
2154 * Note: Global-for-all-devices, set-only-at-init, read-only module
2155 * parameteters like 'max_loop' and 'max_part' make things needlessly
2156 * complicated, are too static, inflexible and may surprise
2157 * userspace tools. Parameters like this in general should be avoided.
2158 */
2159 if (!part_shift)
2160 disk->flags |= GENHD_FL_NO_PART_SCAN;
2161 disk->flags |= GENHD_FL_EXT_DEVT;
Ming Leif8933662015-05-06 12:26:23 +08002162 atomic_set(&lo->lo_refcnt, 0);
Ken Chen73285082007-05-08 00:28:20 -07002163 lo->lo_number = i;
Ken Chen73285082007-05-08 00:28:20 -07002164 spin_lock_init(&lo->lo_lock);
2165 disk->major = LOOP_MAJOR;
Laurent Vivier476a4812008-03-26 12:11:53 +01002166 disk->first_minor = i << part_shift;
Ken Chen73285082007-05-08 00:28:20 -07002167 disk->fops = &lo_fops;
2168 disk->private_data = lo;
2169 disk->queue = lo->lo_queue;
2170 sprintf(disk->disk_name, "loop%d", i);
Kay Sievers34dd82a2011-07-31 22:08:04 +02002171 add_disk(disk);
2172 *l = lo;
2173 return lo->lo_number;
Ken Chen73285082007-05-08 00:28:20 -07002174
2175out_free_queue:
2176 blk_cleanup_queue(lo->lo_queue);
Ming Leib5dd2f62014-12-31 13:22:57 +00002177out_cleanup_tags:
2178 blk_mq_free_tag_set(&lo->tag_set);
Mikulas Patocka3ec981e2013-10-14 12:12:24 -04002179out_free_idr:
2180 idr_remove(&loop_index_idr, i);
Ken Chen73285082007-05-08 00:28:20 -07002181out_free_dev:
2182 kfree(lo);
2183out:
Kay Sievers34dd82a2011-07-31 22:08:04 +02002184 return err;
Ken Chen73285082007-05-08 00:28:20 -07002185}
2186
Kay Sievers34dd82a2011-07-31 22:08:04 +02002187static void loop_remove(struct loop_device *lo)
Ken Chen73285082007-05-08 00:28:20 -07002188{
NeilBrown6cd18e72015-04-27 14:12:22 +10002189 del_gendisk(lo->lo_disk);
Bart Van Assche0fa8ebd2018-02-28 10:15:28 -08002190 blk_cleanup_queue(lo->lo_queue);
Ming Leib5dd2f62014-12-31 13:22:57 +00002191 blk_mq_free_tag_set(&lo->tag_set);
Ken Chen73285082007-05-08 00:28:20 -07002192 put_disk(lo->lo_disk);
Ken Chen73285082007-05-08 00:28:20 -07002193 kfree(lo);
2194}
2195
Kay Sievers770fe302011-07-31 22:08:04 +02002196static int find_free_cb(int id, void *ptr, void *data)
Ken Chena47653f2007-06-08 13:46:44 -07002197{
Kay Sievers770fe302011-07-31 22:08:04 +02002198 struct loop_device *lo = ptr;
2199 struct loop_device **l = data;
Ken Chena47653f2007-06-08 13:46:44 -07002200
Kay Sievers770fe302011-07-31 22:08:04 +02002201 if (lo->lo_state == Lo_unbound) {
2202 *l = lo;
2203 return 1;
Ken Chena47653f2007-06-08 13:46:44 -07002204 }
Kay Sievers770fe302011-07-31 22:08:04 +02002205 return 0;
Ken Chena47653f2007-06-08 13:46:44 -07002206}
2207
Kay Sievers34dd82a2011-07-31 22:08:04 +02002208static int loop_lookup(struct loop_device **l, int i)
Ken Chena47653f2007-06-08 13:46:44 -07002209{
Ken Chena47653f2007-06-08 13:46:44 -07002210 struct loop_device *lo;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002211 int ret = -ENODEV;
Ken Chena47653f2007-06-08 13:46:44 -07002212
Kay Sievers770fe302011-07-31 22:08:04 +02002213 if (i < 0) {
2214 int err;
2215
2216 err = idr_for_each(&loop_index_idr, &find_free_cb, &lo);
2217 if (err == 1) {
2218 *l = lo;
2219 ret = lo->lo_number;
2220 }
2221 goto out;
2222 }
2223
2224 /* lookup and return a specific i */
Kay Sievers34dd82a2011-07-31 22:08:04 +02002225 lo = idr_find(&loop_index_idr, i);
Ken Chena47653f2007-06-08 13:46:44 -07002226 if (lo) {
Kay Sievers34dd82a2011-07-31 22:08:04 +02002227 *l = lo;
2228 ret = lo->lo_number;
Ken Chena47653f2007-06-08 13:46:44 -07002229 }
Kay Sievers770fe302011-07-31 22:08:04 +02002230out:
Kay Sievers34dd82a2011-07-31 22:08:04 +02002231 return ret;
Ken Chena47653f2007-06-08 13:46:44 -07002232}
2233
Ken Chen73285082007-05-08 00:28:20 -07002234static struct kobject *loop_probe(dev_t dev, int *part, void *data)
2235{
Al Viro705962c2007-05-13 05:52:32 -04002236 struct loop_device *lo;
Al Viro07002e92007-05-12 16:23:15 -04002237 struct kobject *kobj;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002238 int err;
Ken Chen73285082007-05-08 00:28:20 -07002239
Jan Kara0a42e992018-11-08 14:01:04 +01002240 mutex_lock(&loop_ctl_mutex);
Kay Sievers34dd82a2011-07-31 22:08:04 +02002241 err = loop_lookup(&lo, MINOR(dev) >> part_shift);
2242 if (err < 0)
2243 err = loop_add(&lo, MINOR(dev) >> part_shift);
2244 if (err < 0)
Mikulas Patockaa207f592013-10-14 12:13:24 -04002245 kobj = NULL;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002246 else
Jan Kara3079c222018-02-26 13:01:38 +01002247 kobj = get_disk_and_module(lo->lo_disk);
Jan Kara0a42e992018-11-08 14:01:04 +01002248 mutex_unlock(&loop_ctl_mutex);
Ken Chen73285082007-05-08 00:28:20 -07002249
2250 *part = 0;
Al Viro07002e92007-05-12 16:23:15 -04002251 return kobj;
Ken Chen73285082007-05-08 00:28:20 -07002252}
2253
Kay Sievers770fe302011-07-31 22:08:04 +02002254static long loop_control_ioctl(struct file *file, unsigned int cmd,
2255 unsigned long parm)
2256{
2257 struct loop_device *lo;
Jan Kara0a42e992018-11-08 14:01:04 +01002258 int ret;
Kay Sievers770fe302011-07-31 22:08:04 +02002259
Jan Kara0a42e992018-11-08 14:01:04 +01002260 ret = mutex_lock_killable(&loop_ctl_mutex);
2261 if (ret)
2262 return ret;
2263
2264 ret = -ENOSYS;
Kay Sievers770fe302011-07-31 22:08:04 +02002265 switch (cmd) {
2266 case LOOP_CTL_ADD:
2267 ret = loop_lookup(&lo, parm);
2268 if (ret >= 0) {
2269 ret = -EEXIST;
2270 break;
2271 }
2272 ret = loop_add(&lo, parm);
2273 break;
2274 case LOOP_CTL_REMOVE:
2275 ret = loop_lookup(&lo, parm);
2276 if (ret < 0)
2277 break;
Kay Sievers770fe302011-07-31 22:08:04 +02002278 if (lo->lo_state != Lo_unbound) {
2279 ret = -EBUSY;
Kay Sievers770fe302011-07-31 22:08:04 +02002280 break;
2281 }
Ming Leif8933662015-05-06 12:26:23 +08002282 if (atomic_read(&lo->lo_refcnt) > 0) {
Kay Sievers770fe302011-07-31 22:08:04 +02002283 ret = -EBUSY;
Kay Sievers770fe302011-07-31 22:08:04 +02002284 break;
2285 }
2286 lo->lo_disk->private_data = NULL;
Kay Sievers770fe302011-07-31 22:08:04 +02002287 idr_remove(&loop_index_idr, lo->lo_number);
2288 loop_remove(lo);
2289 break;
2290 case LOOP_CTL_GET_FREE:
2291 ret = loop_lookup(&lo, -1);
2292 if (ret >= 0)
2293 break;
2294 ret = loop_add(&lo, -1);
2295 }
Jan Kara0a42e992018-11-08 14:01:04 +01002296 mutex_unlock(&loop_ctl_mutex);
Kay Sievers770fe302011-07-31 22:08:04 +02002297
2298 return ret;
2299}
2300
2301static const struct file_operations loop_ctl_fops = {
2302 .open = nonseekable_open,
2303 .unlocked_ioctl = loop_control_ioctl,
2304 .compat_ioctl = loop_control_ioctl,
2305 .owner = THIS_MODULE,
2306 .llseek = noop_llseek,
2307};
2308
2309static struct miscdevice loop_misc = {
2310 .minor = LOOP_CTRL_MINOR,
2311 .name = "loop-control",
2312 .fops = &loop_ctl_fops,
2313};
2314
2315MODULE_ALIAS_MISCDEV(LOOP_CTRL_MINOR);
2316MODULE_ALIAS("devname:loop-control");
2317
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318static int __init loop_init(void)
2319{
Ken Chena47653f2007-06-08 13:46:44 -07002320 int i, nr;
2321 unsigned long range;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002322 struct loop_device *lo;
Kay Sievers770fe302011-07-31 22:08:04 +02002323 int err;
Ken Chena47653f2007-06-08 13:46:44 -07002324
Laurent Vivier476a4812008-03-26 12:11:53 +01002325 part_shift = 0;
Namhyung Kimac04fee2011-05-27 07:59:25 +02002326 if (max_part > 0) {
Laurent Vivier476a4812008-03-26 12:11:53 +01002327 part_shift = fls(max_part);
2328
Namhyung Kimac04fee2011-05-27 07:59:25 +02002329 /*
2330 * Adjust max_part according to part_shift as it is exported
2331 * to user space so that user can decide correct minor number
2332 * if [s]he want to create more devices.
2333 *
2334 * Note that -1 is required because partition 0 is reserved
2335 * for the whole disk.
2336 */
2337 max_part = (1UL << part_shift) - 1;
2338 }
2339
Guo Chaob1a66502013-02-21 15:16:49 -08002340 if ((1UL << part_shift) > DISK_MAX_PARTS) {
2341 err = -EINVAL;
Anton Volkova8c1d062017-08-07 15:37:50 +03002342 goto err_out;
Guo Chaob1a66502013-02-21 15:16:49 -08002343 }
Namhyung Kim78f4bb32011-05-24 16:48:54 +02002344
Guo Chaob1a66502013-02-21 15:16:49 -08002345 if (max_loop > 1UL << (MINORBITS - part_shift)) {
2346 err = -EINVAL;
Anton Volkova8c1d062017-08-07 15:37:50 +03002347 goto err_out;
Guo Chaob1a66502013-02-21 15:16:49 -08002348 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349
Kay Sieversd134b002011-07-31 22:08:04 +02002350 /*
2351 * If max_loop is specified, create that many devices upfront.
2352 * This also becomes a hard limit. If max_loop is not specified,
2353 * create CONFIG_BLK_DEV_LOOP_MIN_COUNT loop devices at module
2354 * init time. Loop devices can be requested on-demand with the
2355 * /dev/loop-control interface, or be instantiated by accessing
2356 * a 'dead' device node.
2357 */
Ken Chen73285082007-05-08 00:28:20 -07002358 if (max_loop) {
Ken Chena47653f2007-06-08 13:46:44 -07002359 nr = max_loop;
Namhyung Kima1c15c52011-05-24 16:48:55 +02002360 range = max_loop << part_shift;
Ken Chena47653f2007-06-08 13:46:44 -07002361 } else {
Kay Sieversd134b002011-07-31 22:08:04 +02002362 nr = CONFIG_BLK_DEV_LOOP_MIN_COUNT;
Namhyung Kima1c15c52011-05-24 16:48:55 +02002363 range = 1UL << MINORBITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364 }
Ken Chena47653f2007-06-08 13:46:44 -07002365
Anton Volkova8c1d062017-08-07 15:37:50 +03002366 err = misc_register(&loop_misc);
2367 if (err < 0)
2368 goto err_out;
2369
2370
Guo Chaob1a66502013-02-21 15:16:49 -08002371 if (register_blkdev(LOOP_MAJOR, "loop")) {
2372 err = -EIO;
2373 goto misc_out;
2374 }
Ken Chena47653f2007-06-08 13:46:44 -07002375
Ken Chena47653f2007-06-08 13:46:44 -07002376 blk_register_region(MKDEV(LOOP_MAJOR, 0), range,
2377 THIS_MODULE, loop_probe, NULL, NULL);
2378
Kay Sieversd134b002011-07-31 22:08:04 +02002379 /* pre-create number of devices given by config or max_loop */
Jan Kara0a42e992018-11-08 14:01:04 +01002380 mutex_lock(&loop_ctl_mutex);
Kay Sievers34dd82a2011-07-31 22:08:04 +02002381 for (i = 0; i < nr; i++)
2382 loop_add(&lo, i);
Jan Kara0a42e992018-11-08 14:01:04 +01002383 mutex_unlock(&loop_ctl_mutex);
Kay Sievers34dd82a2011-07-31 22:08:04 +02002384
Ken Chen73285082007-05-08 00:28:20 -07002385 printk(KERN_INFO "loop: module loaded\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386 return 0;
Guo Chaob1a66502013-02-21 15:16:49 -08002387
2388misc_out:
2389 misc_deregister(&loop_misc);
Anton Volkova8c1d062017-08-07 15:37:50 +03002390err_out:
Guo Chaob1a66502013-02-21 15:16:49 -08002391 return err;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002392}
Ken Chena47653f2007-06-08 13:46:44 -07002393
Kay Sievers34dd82a2011-07-31 22:08:04 +02002394static int loop_exit_cb(int id, void *ptr, void *data)
2395{
2396 struct loop_device *lo = ptr;
Ken Chena47653f2007-06-08 13:46:44 -07002397
Kay Sievers34dd82a2011-07-31 22:08:04 +02002398 loop_remove(lo);
2399 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400}
2401
Ken Chen73285082007-05-08 00:28:20 -07002402static void __exit loop_exit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403{
Ken Chena47653f2007-06-08 13:46:44 -07002404 unsigned long range;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405
Namhyung Kima1c15c52011-05-24 16:48:55 +02002406 range = max_loop ? max_loop << part_shift : 1UL << MINORBITS;
Ken Chena47653f2007-06-08 13:46:44 -07002407
Luis Chamberlain200f9332020-06-19 20:47:27 +00002408 mutex_lock(&loop_ctl_mutex);
2409
Kay Sievers34dd82a2011-07-31 22:08:04 +02002410 idr_for_each(&loop_index_idr, &loop_exit_cb, NULL);
Kay Sievers34dd82a2011-07-31 22:08:04 +02002411 idr_destroy(&loop_index_idr);
Ken Chen73285082007-05-08 00:28:20 -07002412
Ken Chena47653f2007-06-08 13:46:44 -07002413 blk_unregister_region(MKDEV(LOOP_MAJOR, 0), range);
Akinobu Mita00d59402007-07-17 04:03:46 -07002414 unregister_blkdev(LOOP_MAJOR, "loop");
Kay Sievers770fe302011-07-31 22:08:04 +02002415
2416 misc_deregister(&loop_misc);
Luis Chamberlain200f9332020-06-19 20:47:27 +00002417
2418 mutex_unlock(&loop_ctl_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002419}
2420
2421module_init(loop_init);
2422module_exit(loop_exit);
2423
2424#ifndef MODULE
2425static int __init max_loop_setup(char *str)
2426{
2427 max_loop = simple_strtol(str, NULL, 0);
2428 return 1;
2429}
2430
2431__setup("max_loop=", max_loop_setup);
2432#endif