blob: 4fb1f9530d5a5559c4d9fc71d1ce95b3671ee687 [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>
Matthew Wilcox (Oracle)4ee60ec2021-05-06 18:02:27 -070056#include <linux/pagemap.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070057#include <linux/file.h>
58#include <linux/stat.h>
59#include <linux/errno.h>
60#include <linux/major.h>
61#include <linux/wait.h>
62#include <linux/blkdev.h>
63#include <linux/blkpg.h>
64#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070065#include <linux/swap.h>
66#include <linux/slab.h>
David Howells863d5b822006-08-29 19:06:14 +010067#include <linux/compat.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070068#include <linux/suspend.h>
Rafael J. Wysocki83144182007-07-17 04:03:35 -070069#include <linux/freezer.h>
Arnd Bergmann2a48fc02010-06-02 14:28:52 +020070#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070071#include <linux/writeback.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070072#include <linux/completion.h>
73#include <linux/highmem.h>
Serge E. Hallyn6c997912006-09-29 01:59:11 -070074#include <linux/kthread.h>
Jens Axboed6b29d72007-06-04 09:59:47 +020075#include <linux/splice.h>
Milan Brozee862732010-08-23 15:16:00 +020076#include <linux/sysfs.h>
Kay Sievers770fe302011-07-31 22:08:04 +020077#include <linux/miscdevice.h>
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +020078#include <linux/falloc.h>
Al Viro283e7e52015-04-03 15:21:59 -040079#include <linux/uio.h>
Adam Manzanaresd9a08a92018-05-22 10:52:19 -070080#include <linux/ioprio.h>
Dennis Zhoudb6638d2018-12-05 12:10:35 -050081#include <linux/blk-cgroup.h>
Adam Manzanaresd9a08a92018-05-22 10:52:19 -070082
Al Viro83a87612013-05-12 10:14:07 -040083#include "loop.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080085#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
Kay Sievers34dd82a2011-07-31 22:08:04 +020087static DEFINE_IDR(loop_index_idr);
Tetsuo Handa310ca162018-11-08 14:01:02 +010088static DEFINE_MUTEX(loop_ctl_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
Laurent Vivier476a4812008-03-26 12:11:53 +010090static int max_part;
91static int part_shift;
92
Linus Torvalds1da177e2005-04-16 15:20:36 -070093static int transfer_xor(struct loop_device *lo, int cmd,
94 struct page *raw_page, unsigned raw_off,
95 struct page *loop_page, unsigned loop_off,
96 int size, sector_t real_block)
97{
Cong Wangcfd80052011-11-25 23:14:18 +080098 char *raw_buf = kmap_atomic(raw_page) + raw_off;
99 char *loop_buf = kmap_atomic(loop_page) + loop_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 char *in, *out, *key;
101 int i, keysize;
102
103 if (cmd == READ) {
104 in = raw_buf;
105 out = loop_buf;
106 } else {
107 in = loop_buf;
108 out = raw_buf;
109 }
110
111 key = lo->lo_encrypt_key;
112 keysize = lo->lo_encrypt_key_size;
113 for (i = 0; i < size; i++)
114 *out++ = *in++ ^ key[(i & 511) % keysize];
115
Cong Wangcfd80052011-11-25 23:14:18 +0800116 kunmap_atomic(loop_buf);
117 kunmap_atomic(raw_buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 cond_resched();
119 return 0;
120}
121
122static int xor_init(struct loop_device *lo, const struct loop_info64 *info)
123{
124 if (unlikely(info->lo_encrypt_key_size <= 0))
125 return -EINVAL;
126 return 0;
127}
128
129static struct loop_func_table none_funcs = {
130 .number = LO_CRYPT_NONE,
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200131};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
133static struct loop_func_table xor_funcs = {
134 .number = LO_CRYPT_XOR,
135 .transfer = transfer_xor,
136 .init = xor_init
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200137};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
139/* xfer_funcs[0] is special - its release function is never called */
140static struct loop_func_table *xfer_funcs[MAX_LO_CRYPT] = {
141 &none_funcs,
142 &xor_funcs
143};
144
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100145static loff_t get_size(loff_t offset, loff_t sizelimit, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146{
Guo Chaob7a1da62013-02-21 15:16:50 -0800147 loff_t loopsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
149 /* Compute loopsize in bytes */
Guo Chaob7a1da62013-02-21 15:16:50 -0800150 loopsize = i_size_read(file->f_mapping->host);
151 if (offset > 0)
152 loopsize -= offset;
153 /* offset is beyond i_size, weird but possible */
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100154 if (loopsize < 0)
155 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100157 if (sizelimit > 0 && sizelimit < loopsize)
158 loopsize = sizelimit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 /*
160 * Unfortunately, if we want to do I/O on the device,
161 * the number of 512-byte sectors has to fit into a sector_t.
162 */
163 return loopsize >> 9;
164}
165
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100166static loff_t get_loop_size(struct loop_device *lo, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167{
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100168 return get_size(lo->lo_offset, lo->lo_sizelimit, file);
169}
170
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800171static void __loop_update_dio(struct loop_device *lo, bool dio)
172{
173 struct file *file = lo->lo_backing_file;
174 struct address_space *mapping = file->f_mapping;
175 struct inode *inode = mapping->host;
176 unsigned short sb_bsize = 0;
177 unsigned dio_align = 0;
178 bool use_dio;
179
180 if (inode->i_sb->s_bdev) {
181 sb_bsize = bdev_logical_block_size(inode->i_sb->s_bdev);
182 dio_align = sb_bsize - 1;
183 }
184
185 /*
186 * We support direct I/O only if lo_offset is aligned with the
187 * logical I/O size of backing device, and the logical block
188 * size of loop is bigger than the backing device's and the loop
189 * needn't transform transfer.
190 *
191 * TODO: the above condition may be loosed in the future, and
192 * direct I/O may be switched runtime at that time because most
Masahiro Yamada89d790a2017-02-27 14:29:01 -0800193 * of requests in sane applications should be PAGE_SIZE aligned
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800194 */
195 if (dio) {
196 if (queue_logical_block_size(lo->lo_queue) >= sb_bsize &&
197 !(lo->lo_offset & dio_align) &&
198 mapping->a_ops->direct_IO &&
199 !lo->transfer)
200 use_dio = true;
201 else
202 use_dio = false;
203 } else {
204 use_dio = false;
205 }
206
207 if (lo->use_dio == use_dio)
208 return;
209
210 /* flush dirty pages before changing direct IO */
211 vfs_fsync(file, 0);
212
213 /*
214 * The flag of LO_FLAGS_DIRECT_IO is handled similarly with
215 * LO_FLAGS_READ_ONLY, both are set from kernel, and losetup
216 * will get updated by ioctl(LOOP_GET_STATUS)
217 */
Martijn Coenen0fbcf572020-03-10 14:06:54 +0100218 if (lo->lo_state == Lo_bound)
219 blk_mq_freeze_queue(lo->lo_queue);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800220 lo->use_dio = use_dio;
Shaohua Li40326d82017-08-31 22:09:46 -0700221 if (use_dio) {
Bart Van Assche8b904b52018-03-07 17:10:10 -0800222 blk_queue_flag_clear(QUEUE_FLAG_NOMERGES, lo->lo_queue);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800223 lo->lo_flags |= LO_FLAGS_DIRECT_IO;
Shaohua Li40326d82017-08-31 22:09:46 -0700224 } else {
Bart Van Assche8b904b52018-03-07 17:10:10 -0800225 blk_queue_flag_set(QUEUE_FLAG_NOMERGES, lo->lo_queue);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800226 lo->lo_flags &= ~LO_FLAGS_DIRECT_IO;
Shaohua Li40326d82017-08-31 22:09:46 -0700227 }
Martijn Coenen0fbcf572020-03-10 14:06:54 +0100228 if (lo->lo_state == Lo_bound)
229 blk_mq_unfreeze_queue(lo->lo_queue);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800230}
231
Martijn Coenen5795b6f2020-05-13 15:38:37 +0200232/**
Martijn Coenen34489142020-05-13 15:38:45 +0200233 * loop_validate_block_size() - validates the passed in block size
234 * @bsize: size to validate
235 */
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100236static int
Martijn Coenen34489142020-05-13 15:38:45 +0200237loop_validate_block_size(unsigned short bsize)
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100238{
Martijn Coenen34489142020-05-13 15:38:45 +0200239 if (bsize < 512 || bsize > PAGE_SIZE || !is_power_of_2(bsize))
240 return -EINVAL;
241
242 return 0;
243}
244
245/**
Martijn Coenen5795b6f2020-05-13 15:38:37 +0200246 * loop_set_size() - sets device size and notifies userspace
247 * @lo: struct loop_device to set the size for
248 * @size: new size of the loop device
249 *
250 * Callers must validate that the size passed into this function fits into
251 * a sector_t, eg using loop_validate_size()
252 */
253static void loop_set_size(struct loop_device *lo, loff_t size)
254{
Christoph Hellwig449f4ec2020-11-16 15:56:56 +0100255 if (!set_capacity_and_notify(lo->lo_disk, size))
Christoph Hellwig3b4f85d2020-11-16 15:56:53 +0100256 kobject_uevent(&disk_to_dev(lo->lo_disk)->kobj, KOBJ_CHANGE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257}
258
259static inline int
260lo_do_transfer(struct loop_device *lo, int cmd,
261 struct page *rpage, unsigned roffs,
262 struct page *lpage, unsigned loffs,
263 int size, sector_t rblock)
264{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200265 int ret;
266
267 ret = lo->transfer(lo, cmd, rpage, roffs, lpage, loffs, size, rblock);
268 if (likely(!ret))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 return 0;
270
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200271 printk_ratelimited(KERN_ERR
272 "loop: Transfer error at byte offset %llu, length %i.\n",
273 (unsigned long long)rblock << 9, size);
274 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275}
276
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200277static int lo_write_bvec(struct file *file, struct bio_vec *bvec, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200279 struct iov_iter i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 ssize_t bw;
Al Viro283e7e52015-04-03 15:21:59 -0400281
Christoph Hellwigb6207432019-06-26 15:49:28 +0200282 iov_iter_bvec(&i, WRITE, bvec, 1, bvec->bv_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283
Al Viro03d95eb2013-03-20 13:04:20 -0400284 file_start_write(file);
Christoph Hellwigabbb65892017-05-27 11:16:52 +0300285 bw = vfs_iter_write(file, &i, ppos, 0);
Al Viro03d95eb2013-03-20 13:04:20 -0400286 file_end_write(file);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200287
288 if (likely(bw == bvec->bv_len))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 return 0;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200290
291 printk_ratelimited(KERN_ERR
292 "loop: Write error at byte offset %llu, length %i.\n",
293 (unsigned long long)*ppos, bvec->bv_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 if (bw >= 0)
295 bw = -EIO;
296 return bw;
297}
298
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200299static int lo_write_simple(struct loop_device *lo, struct request *rq,
300 loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200302 struct bio_vec bvec;
303 struct req_iterator iter;
304 int ret = 0;
305
306 rq_for_each_segment(bvec, rq, iter) {
307 ret = lo_write_bvec(lo->lo_backing_file, &bvec, &pos);
308 if (ret < 0)
309 break;
310 cond_resched();
311 }
312
313 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314}
315
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200316/*
Christoph Hellwig456be142011-10-17 12:57:20 +0200317 * This is the slow, transforming version that needs to double buffer the
318 * data as it cannot do the transformations in place without having direct
319 * access to the destination pages of the backing file.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 */
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200321static int lo_write_transfer(struct loop_device *lo, struct request *rq,
322 loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200324 struct bio_vec bvec, b;
Ming Lei30112012014-12-31 13:22:58 +0000325 struct req_iterator iter;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200326 struct page *page;
Kent Overstreet79886132013-11-23 17:19:00 -0800327 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200329 page = alloc_page(GFP_NOIO);
330 if (unlikely(!page))
331 return -ENOMEM;
Christoph Hellwig456be142011-10-17 12:57:20 +0200332
Ming Lei30112012014-12-31 13:22:58 +0000333 rq_for_each_segment(bvec, rq, iter) {
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200334 ret = lo_do_transfer(lo, WRITE, page, 0, bvec.bv_page,
335 bvec.bv_offset, bvec.bv_len, pos >> 9);
336 if (unlikely(ret))
337 break;
338
339 b.bv_page = page;
340 b.bv_offset = 0;
341 b.bv_len = bvec.bv_len;
342 ret = lo_write_bvec(lo->lo_backing_file, &b, &pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 if (ret < 0)
344 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 }
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200346
347 __free_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349}
350
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200351static int lo_read_simple(struct loop_device *lo, struct request *rq,
352 loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353{
Kent Overstreet79886132013-11-23 17:19:00 -0800354 struct bio_vec bvec;
Ming Lei30112012014-12-31 13:22:58 +0000355 struct req_iterator iter;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200356 struct iov_iter i;
357 ssize_t len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Ming Lei30112012014-12-31 13:22:58 +0000359 rq_for_each_segment(bvec, rq, iter) {
Christoph Hellwigb6207432019-06-26 15:49:28 +0200360 iov_iter_bvec(&i, READ, &bvec, 1, bvec.bv_len);
Christoph Hellwig18e97102017-05-27 11:16:51 +0300361 len = vfs_iter_read(lo->lo_backing_file, &i, &pos, 0);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200362 if (len < 0)
363 return len;
Dave Young306df072012-02-08 22:07:19 +0100364
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200365 flush_dcache_page(bvec.bv_page);
366
367 if (len != bvec.bv_len) {
Ming Lei30112012014-12-31 13:22:58 +0000368 struct bio *bio;
369
370 __rq_for_each_bio(bio, rq)
371 zero_fill_bio(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 break;
Dave Young306df072012-02-08 22:07:19 +0100373 }
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200374 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 }
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200376
Dave Young306df072012-02-08 22:07:19 +0100377 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378}
379
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200380static int lo_read_transfer(struct loop_device *lo, struct request *rq,
381 loff_t pos)
382{
383 struct bio_vec bvec, b;
384 struct req_iterator iter;
385 struct iov_iter i;
386 struct page *page;
387 ssize_t len;
388 int ret = 0;
389
390 page = alloc_page(GFP_NOIO);
391 if (unlikely(!page))
392 return -ENOMEM;
393
394 rq_for_each_segment(bvec, rq, iter) {
395 loff_t offset = pos;
396
397 b.bv_page = page;
398 b.bv_offset = 0;
399 b.bv_len = bvec.bv_len;
400
Christoph Hellwigb6207432019-06-26 15:49:28 +0200401 iov_iter_bvec(&i, READ, &b, 1, b.bv_len);
Christoph Hellwig18e97102017-05-27 11:16:51 +0300402 len = vfs_iter_read(lo->lo_backing_file, &i, &pos, 0);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200403 if (len < 0) {
404 ret = len;
405 goto out_free_page;
406 }
407
408 ret = lo_do_transfer(lo, READ, page, 0, bvec.bv_page,
409 bvec.bv_offset, len, offset >> 9);
410 if (ret)
411 goto out_free_page;
412
413 flush_dcache_page(bvec.bv_page);
414
415 if (len != bvec.bv_len) {
416 struct bio *bio;
417
418 __rq_for_each_bio(bio, rq)
419 zero_fill_bio(bio);
420 break;
421 }
422 }
423
424 ret = 0;
425out_free_page:
426 __free_page(page);
427 return ret;
428}
429
Darrick J. Wongefcfec572019-10-30 20:29:48 -0700430static int lo_fallocate(struct loop_device *lo, struct request *rq, loff_t pos,
431 int mode)
Ming Leicf655d92014-12-31 13:22:59 +0000432{
433 /*
Darrick J. Wongefcfec572019-10-30 20:29:48 -0700434 * We use fallocate to manipulate the space mappings used by the image
435 * a.k.a. discard/zerorange. However we do not support this if
436 * encryption is enabled, because it may give an attacker useful
437 * information.
Ming Leicf655d92014-12-31 13:22:59 +0000438 */
439 struct file *file = lo->lo_backing_file;
Evan Greenc52abf52020-04-03 16:43:04 +0200440 struct request_queue *q = lo->lo_queue;
Ming Leicf655d92014-12-31 13:22:59 +0000441 int ret;
442
Darrick J. Wongefcfec572019-10-30 20:29:48 -0700443 mode |= FALLOC_FL_KEEP_SIZE;
444
Evan Greenc52abf52020-04-03 16:43:04 +0200445 if (!blk_queue_discard(q)) {
Ming Leicf655d92014-12-31 13:22:59 +0000446 ret = -EOPNOTSUPP;
447 goto out;
448 }
449
450 ret = file->f_op->fallocate(file, mode, pos, blk_rq_bytes(rq));
451 if (unlikely(ret && ret != -EINVAL && ret != -EOPNOTSUPP))
452 ret = -EIO;
453 out:
454 return ret;
455}
456
457static int lo_req_flush(struct loop_device *lo, struct request *rq)
458{
459 struct file *file = lo->lo_backing_file;
460 int ret = vfs_fsync(file, 0);
461 if (unlikely(ret && ret != -EINVAL))
462 ret = -EIO;
463
464 return ret;
465}
466
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200467static void lo_complete_rq(struct request *rq)
Ming Leibc07c102015-08-17 10:31:51 +0800468{
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200469 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
Jens Axboef9de14b2018-04-13 16:25:57 -0600470 blk_status_t ret = BLK_STS_OK;
Ming Leibc07c102015-08-17 10:31:51 +0800471
Jens Axboef9de14b2018-04-13 16:25:57 -0600472 if (!cmd->use_aio || cmd->ret < 0 || cmd->ret == blk_rq_bytes(rq) ||
473 req_op(rq) != REQ_OP_READ) {
474 if (cmd->ret < 0)
Evan Green8cd55082020-04-03 16:43:03 +0200475 ret = errno_to_blk_status(cmd->ret);
Jens Axboef9de14b2018-04-13 16:25:57 -0600476 goto end_io;
Ming Leibc07c102015-08-17 10:31:51 +0800477 }
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200478
Jens Axboef9de14b2018-04-13 16:25:57 -0600479 /*
480 * Short READ - if we got some data, advance our request and
481 * retry it. If we got no data, end the rest with EIO.
482 */
483 if (cmd->ret) {
484 blk_update_request(rq, BLK_STS_OK, cmd->ret);
485 cmd->ret = 0;
486 blk_mq_requeue_request(rq, true);
487 } else {
488 if (cmd->use_aio) {
489 struct bio *bio = rq->bio;
490
491 while (bio) {
492 zero_fill_bio(bio);
493 bio = bio->bi_next;
494 }
495 }
496 ret = BLK_STS_IOERR;
497end_io:
498 blk_mq_end_request(rq, ret);
499 }
Ming Leibc07c102015-08-17 10:31:51 +0800500}
501
Shaohua Li92d77332017-09-01 11:15:17 -0700502static void lo_rw_aio_do_completion(struct loop_cmd *cmd)
503{
Jens Axboe1894e912018-04-13 16:24:29 -0600504 struct request *rq = blk_mq_rq_from_pdu(cmd);
505
Shaohua Li92d77332017-09-01 11:15:17 -0700506 if (!atomic_dec_and_test(&cmd->ref))
507 return;
508 kfree(cmd->bvec);
509 cmd->bvec = NULL;
Christoph Hellwig15f73f52020-06-11 08:44:47 +0200510 if (likely(!blk_should_fake_timeout(rq->q)))
511 blk_mq_complete_request(rq);
Shaohua Li92d77332017-09-01 11:15:17 -0700512}
513
Ming Leibc07c102015-08-17 10:31:51 +0800514static void lo_rw_aio_complete(struct kiocb *iocb, long ret, long ret2)
515{
516 struct loop_cmd *cmd = container_of(iocb, struct loop_cmd, iocb);
Ming Leibc07c102015-08-17 10:31:51 +0800517
Shaohua Lid4478e92017-09-25 13:07:22 -0600518 if (cmd->css)
519 css_put(cmd->css);
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200520 cmd->ret = ret;
Shaohua Li92d77332017-09-01 11:15:17 -0700521 lo_rw_aio_do_completion(cmd);
Ming Leibc07c102015-08-17 10:31:51 +0800522}
523
524static int lo_rw_aio(struct loop_device *lo, struct loop_cmd *cmd,
525 loff_t pos, bool rw)
526{
527 struct iov_iter iter;
Ming Lei86af5952019-02-15 19:13:17 +0800528 struct req_iterator rq_iter;
Ming Leibc07c102015-08-17 10:31:51 +0800529 struct bio_vec *bvec;
Jens Axboe1894e912018-04-13 16:24:29 -0600530 struct request *rq = blk_mq_rq_from_pdu(cmd);
Shaohua Li40326d82017-08-31 22:09:46 -0700531 struct bio *bio = rq->bio;
Ming Leibc07c102015-08-17 10:31:51 +0800532 struct file *file = lo->lo_backing_file;
Ming Lei86af5952019-02-15 19:13:17 +0800533 struct bio_vec tmp;
Shaohua Li40326d82017-08-31 22:09:46 -0700534 unsigned int offset;
Ming Lei86af5952019-02-15 19:13:17 +0800535 int nr_bvec = 0;
Ming Leibc07c102015-08-17 10:31:51 +0800536 int ret;
537
Ming Lei86af5952019-02-15 19:13:17 +0800538 rq_for_each_bvec(tmp, rq, rq_iter)
539 nr_bvec++;
Ming Leibc07c102015-08-17 10:31:51 +0800540
Ming Lei86af5952019-02-15 19:13:17 +0800541 if (rq->bio != rq->biotail) {
542
543 bvec = kmalloc_array(nr_bvec, sizeof(struct bio_vec),
Kees Cook6da2ec52018-06-12 13:55:00 -0700544 GFP_NOIO);
Shaohua Li40326d82017-08-31 22:09:46 -0700545 if (!bvec)
546 return -EIO;
547 cmd->bvec = bvec;
548
549 /*
550 * The bios of the request may be started from the middle of
551 * the 'bvec' because of bio splitting, so we can't directly
Ming Lei86af5952019-02-15 19:13:17 +0800552 * copy bio->bi_iov_vec to new bvec. The rq_for_each_bvec
Shaohua Li40326d82017-08-31 22:09:46 -0700553 * API will take care of all details for us.
554 */
Ming Lei86af5952019-02-15 19:13:17 +0800555 rq_for_each_bvec(tmp, rq, rq_iter) {
Shaohua Li40326d82017-08-31 22:09:46 -0700556 *bvec = tmp;
557 bvec++;
558 }
559 bvec = cmd->bvec;
560 offset = 0;
561 } else {
562 /*
563 * Same here, this bio may be started from the middle of the
564 * 'bvec' because of bio splitting, so offset from the bvec
565 * must be passed to iov iterator
566 */
567 offset = bio->bi_iter.bi_bvec_done;
568 bvec = __bvec_iter_bvec(bio->bi_io_vec, bio->bi_iter);
Shaohua Li40326d82017-08-31 22:09:46 -0700569 }
Shaohua Li92d77332017-09-01 11:15:17 -0700570 atomic_set(&cmd->ref, 2);
Shaohua Li40326d82017-08-31 22:09:46 -0700571
Christoph Hellwigb6207432019-06-26 15:49:28 +0200572 iov_iter_bvec(&iter, rw, bvec, nr_bvec, blk_rq_bytes(rq));
Shaohua Li40326d82017-08-31 22:09:46 -0700573 iter.iov_offset = offset;
Ming Leibc07c102015-08-17 10:31:51 +0800574
575 cmd->iocb.ki_pos = pos;
576 cmd->iocb.ki_filp = file;
577 cmd->iocb.ki_complete = lo_rw_aio_complete;
578 cmd->iocb.ki_flags = IOCB_DIRECT;
Adam Manzanaresd9a08a92018-05-22 10:52:19 -0700579 cmd->iocb.ki_ioprio = IOPRIO_PRIO_VALUE(IOPRIO_CLASS_NONE, 0);
Shaohua Lid4478e92017-09-25 13:07:22 -0600580 if (cmd->css)
581 kthread_associate_blkcg(cmd->css);
Ming Leibc07c102015-08-17 10:31:51 +0800582
583 if (rw == WRITE)
Miklos Szeredibb7462b2017-02-20 16:51:23 +0100584 ret = call_write_iter(file, &cmd->iocb, &iter);
Ming Leibc07c102015-08-17 10:31:51 +0800585 else
Miklos Szeredibb7462b2017-02-20 16:51:23 +0100586 ret = call_read_iter(file, &cmd->iocb, &iter);
Ming Leibc07c102015-08-17 10:31:51 +0800587
Shaohua Li92d77332017-09-01 11:15:17 -0700588 lo_rw_aio_do_completion(cmd);
Shaohua Lid4478e92017-09-25 13:07:22 -0600589 kthread_associate_blkcg(NULL);
Shaohua Li92d77332017-09-01 11:15:17 -0700590
Ming Leibc07c102015-08-17 10:31:51 +0800591 if (ret != -EIOCBQUEUED)
592 cmd->iocb.ki_complete(&cmd->iocb, ret, 0);
593 return 0;
594}
595
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200596static int do_req_filebacked(struct loop_device *lo, struct request *rq)
Ming Leibc07c102015-08-17 10:31:51 +0800597{
598 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200599 loff_t pos = ((loff_t) blk_rq_pos(rq) << 9) + lo->lo_offset;
Ming Leibc07c102015-08-17 10:31:51 +0800600
601 /*
602 * lo_write_simple and lo_read_simple should have been covered
603 * by io submit style function like lo_rw_aio(), one blocker
604 * is that lo_read_simple() need to call flush_dcache_page after
605 * the page is written from kernel, and it isn't easy to handle
606 * this in io submit style function which submits all segments
607 * of the req at one time. And direct read IO doesn't need to
608 * run flush_dcache_page().
609 */
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200610 switch (req_op(rq)) {
611 case REQ_OP_FLUSH:
612 return lo_req_flush(lo, rq);
Christoph Hellwig19372e22017-04-05 19:21:15 +0200613 case REQ_OP_WRITE_ZEROES:
Darrick J. Wongefcfec572019-10-30 20:29:48 -0700614 /*
615 * If the caller doesn't want deallocation, call zeroout to
616 * write zeroes the range. Otherwise, punch them out.
617 */
618 return lo_fallocate(lo, rq, pos,
619 (rq->cmd_flags & REQ_NOUNMAP) ?
620 FALLOC_FL_ZERO_RANGE :
621 FALLOC_FL_PUNCH_HOLE);
622 case REQ_OP_DISCARD:
623 return lo_fallocate(lo, rq, pos, FALLOC_FL_PUNCH_HOLE);
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200624 case REQ_OP_WRITE:
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200625 if (lo->transfer)
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200626 return lo_write_transfer(lo, rq, pos);
627 else if (cmd->use_aio)
628 return lo_rw_aio(lo, cmd, pos, WRITE);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200629 else
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200630 return lo_write_simple(lo, rq, pos);
631 case REQ_OP_READ:
632 if (lo->transfer)
633 return lo_read_transfer(lo, rq, pos);
634 else if (cmd->use_aio)
635 return lo_rw_aio(lo, cmd, pos, READ);
636 else
637 return lo_read_simple(lo, rq, pos);
638 default:
639 WARN_ON_ONCE(1);
640 return -EIO;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200641 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642}
643
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800644static inline void loop_update_dio(struct loop_device *lo)
645{
Ira Weinyefbe3c22020-04-30 07:41:33 -0700646 __loop_update_dio(lo, (lo->lo_backing_file->f_flags & O_DIRECT) |
647 lo->use_dio);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800648}
649
Christoph Hellwig03842642021-06-24 14:32:40 +0200650static void loop_reread_partitions(struct loop_device *lo)
Ming Lei06f0e9e2015-05-06 12:26:24 +0800651{
652 int rc;
653
Christoph Hellwig03842642021-06-24 14:32:40 +0200654 mutex_lock(&lo->lo_disk->open_mutex);
655 rc = bdev_disk_changed(lo->lo_disk, false);
656 mutex_unlock(&lo->lo_disk->open_mutex);
Ming Lei06f0e9e2015-05-06 12:26:24 +0800657 if (rc)
658 pr_warn("%s: partition scan of loop%d (%s) failed (rc=%d)\n",
659 __func__, lo->lo_number, lo->lo_file_name, rc);
660}
661
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400662static inline int is_loop_device(struct file *file)
663{
664 struct inode *i = file->f_mapping->host;
665
Al Viro6f247842021-01-31 19:23:55 -0500666 return i && S_ISBLK(i->i_mode) && imajor(i) == LOOP_MAJOR;
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400667}
668
669static int loop_validate_file(struct file *file, struct block_device *bdev)
670{
671 struct inode *inode = file->f_mapping->host;
672 struct file *f = file;
673
674 /* Avoid recursion */
675 while (is_loop_device(f)) {
676 struct loop_device *l;
677
Christoph Hellwig4e7b5672020-11-23 13:38:40 +0100678 if (f->f_mapping->host->i_rdev == bdev->bd_dev)
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400679 return -EBADF;
680
Christoph Hellwig4e7b5672020-11-23 13:38:40 +0100681 l = I_BDEV(f->f_mapping->host)->bd_disk->private_data;
Dongli Zhangf7c8a412019-03-18 20:23:17 +0800682 if (l->lo_state != Lo_bound) {
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400683 return -EINVAL;
684 }
685 f = l->lo_backing_file;
686 }
687 if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
688 return -EINVAL;
689 return 0;
690}
691
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692/*
693 * loop_change_fd switched the backing store of a loopback device to
694 * a new file. This is useful for operating system installers to free up
695 * the original file and in High Availability environments to switch to
696 * an alternative location for the content in case of server meltdown.
697 * This can only work if the loop device is used read-only, and if the
698 * new backing store is the same size and type as the old backing store.
699 */
Al Virobb214882008-03-02 09:29:48 -0500700static int loop_change_fd(struct loop_device *lo, struct block_device *bdev,
701 unsigned int arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702{
Jan Kara1dded9a2018-11-08 14:01:15 +0100703 struct file *file = NULL, *old_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 int error;
Jan Kara85b0a542018-11-08 14:01:13 +0100705 bool partscan;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706
Pavel Tatashin6cc8e742021-01-26 09:46:30 -0500707 error = mutex_lock_killable(&lo->lo_mutex);
Jan Karac3710772018-11-08 14:01:11 +0100708 if (error)
709 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 error = -ENXIO;
711 if (lo->lo_state != Lo_bound)
Jan Kara1dded9a2018-11-08 14:01:15 +0100712 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
714 /* the loop device has to be read-only */
715 error = -EINVAL;
716 if (!(lo->lo_flags & LO_FLAGS_READ_ONLY))
Jan Kara1dded9a2018-11-08 14:01:15 +0100717 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718
719 error = -EBADF;
720 file = fget(arg);
721 if (!file)
Jan Kara1dded9a2018-11-08 14:01:15 +0100722 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400724 error = loop_validate_file(file, bdev);
725 if (error)
Jan Kara1dded9a2018-11-08 14:01:15 +0100726 goto out_err;
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400727
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 old_file = lo->lo_backing_file;
729
730 error = -EINVAL;
731
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 /* size of the new backing store needs to be the same */
733 if (get_loop_size(lo, file) != get_loop_size(lo, old_file))
Jan Kara1dded9a2018-11-08 14:01:15 +0100734 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735
736 /* and ... switch */
Omar Sandoval43cade802017-08-24 00:03:44 -0700737 blk_mq_freeze_queue(lo->lo_queue);
738 mapping_set_gfp_mask(old_file->f_mapping, lo->old_gfp_mask);
739 lo->lo_backing_file = file;
740 lo->old_gfp_mask = mapping_gfp_mask(file->f_mapping);
741 mapping_set_gfp_mask(file->f_mapping,
742 lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
743 loop_update_dio(lo);
744 blk_mq_unfreeze_queue(lo->lo_queue);
Jan Kara85b0a542018-11-08 14:01:13 +0100745 partscan = lo->lo_flags & LO_FLAGS_PARTSCAN;
Pavel Tatashin6cc8e742021-01-26 09:46:30 -0500746 mutex_unlock(&lo->lo_mutex);
Jan Kara1dded9a2018-11-08 14:01:15 +0100747 /*
Pavel Tatashin6cc8e742021-01-26 09:46:30 -0500748 * We must drop file reference outside of lo_mutex as dropping
Christoph Hellwiga8698702021-05-25 08:12:56 +0200749 * the file ref can take open_mutex which creates circular locking
Jan Kara1dded9a2018-11-08 14:01:15 +0100750 * dependency.
751 */
752 fput(old_file);
Jan Kara85b0a542018-11-08 14:01:13 +0100753 if (partscan)
Christoph Hellwig03842642021-06-24 14:32:40 +0200754 loop_reread_partitions(lo);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 return 0;
756
Jan Kara1dded9a2018-11-08 14:01:15 +0100757out_err:
Pavel Tatashin6cc8e742021-01-26 09:46:30 -0500758 mutex_unlock(&lo->lo_mutex);
Jan Kara1dded9a2018-11-08 14:01:15 +0100759 if (file)
760 fput(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 return error;
762}
763
Milan Brozee862732010-08-23 15:16:00 +0200764/* loop sysfs attributes */
765
766static ssize_t loop_attr_show(struct device *dev, char *page,
767 ssize_t (*callback)(struct loop_device *, char *))
768{
Kay Sievers34dd82a2011-07-31 22:08:04 +0200769 struct gendisk *disk = dev_to_disk(dev);
770 struct loop_device *lo = disk->private_data;
Milan Brozee862732010-08-23 15:16:00 +0200771
Kay Sievers34dd82a2011-07-31 22:08:04 +0200772 return callback(lo, page);
Milan Brozee862732010-08-23 15:16:00 +0200773}
774
775#define LOOP_ATTR_RO(_name) \
776static ssize_t loop_attr_##_name##_show(struct loop_device *, char *); \
777static ssize_t loop_attr_do_show_##_name(struct device *d, \
778 struct device_attribute *attr, char *b) \
779{ \
780 return loop_attr_show(d, b, loop_attr_##_name##_show); \
781} \
782static struct device_attribute loop_attr_##_name = \
Joe Perches5657a812018-05-24 13:38:59 -0600783 __ATTR(_name, 0444, loop_attr_do_show_##_name, NULL);
Milan Brozee862732010-08-23 15:16:00 +0200784
785static ssize_t loop_attr_backing_file_show(struct loop_device *lo, char *buf)
786{
787 ssize_t ret;
788 char *p = NULL;
789
Kay Sievers05eb0f22011-07-31 22:21:35 +0200790 spin_lock_irq(&lo->lo_lock);
Milan Brozee862732010-08-23 15:16:00 +0200791 if (lo->lo_backing_file)
Miklos Szeredi9bf39ab2015-06-19 10:29:13 +0200792 p = file_path(lo->lo_backing_file, buf, PAGE_SIZE - 1);
Kay Sievers05eb0f22011-07-31 22:21:35 +0200793 spin_unlock_irq(&lo->lo_lock);
Milan Brozee862732010-08-23 15:16:00 +0200794
795 if (IS_ERR_OR_NULL(p))
796 ret = PTR_ERR(p);
797 else {
798 ret = strlen(p);
799 memmove(buf, p, ret);
800 buf[ret++] = '\n';
801 buf[ret] = 0;
802 }
803
804 return ret;
805}
806
807static ssize_t loop_attr_offset_show(struct loop_device *lo, char *buf)
808{
809 return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_offset);
810}
811
812static ssize_t loop_attr_sizelimit_show(struct loop_device *lo, char *buf)
813{
814 return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_sizelimit);
815}
816
817static ssize_t loop_attr_autoclear_show(struct loop_device *lo, char *buf)
818{
819 int autoclear = (lo->lo_flags & LO_FLAGS_AUTOCLEAR);
820
821 return sprintf(buf, "%s\n", autoclear ? "1" : "0");
822}
823
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200824static ssize_t loop_attr_partscan_show(struct loop_device *lo, char *buf)
825{
826 int partscan = (lo->lo_flags & LO_FLAGS_PARTSCAN);
827
828 return sprintf(buf, "%s\n", partscan ? "1" : "0");
829}
830
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800831static ssize_t loop_attr_dio_show(struct loop_device *lo, char *buf)
832{
833 int dio = (lo->lo_flags & LO_FLAGS_DIRECT_IO);
834
835 return sprintf(buf, "%s\n", dio ? "1" : "0");
836}
837
Milan Brozee862732010-08-23 15:16:00 +0200838LOOP_ATTR_RO(backing_file);
839LOOP_ATTR_RO(offset);
840LOOP_ATTR_RO(sizelimit);
841LOOP_ATTR_RO(autoclear);
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200842LOOP_ATTR_RO(partscan);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800843LOOP_ATTR_RO(dio);
Milan Brozee862732010-08-23 15:16:00 +0200844
845static struct attribute *loop_attrs[] = {
846 &loop_attr_backing_file.attr,
847 &loop_attr_offset.attr,
848 &loop_attr_sizelimit.attr,
849 &loop_attr_autoclear.attr,
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200850 &loop_attr_partscan.attr,
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800851 &loop_attr_dio.attr,
Milan Brozee862732010-08-23 15:16:00 +0200852 NULL,
853};
854
855static struct attribute_group loop_attribute_group = {
856 .name = "loop",
857 .attrs= loop_attrs,
858};
859
Tetsuo Handad3349b62018-05-04 10:58:09 -0600860static void loop_sysfs_init(struct loop_device *lo)
Milan Brozee862732010-08-23 15:16:00 +0200861{
Tetsuo Handad3349b62018-05-04 10:58:09 -0600862 lo->sysfs_inited = !sysfs_create_group(&disk_to_dev(lo->lo_disk)->kobj,
863 &loop_attribute_group);
Milan Brozee862732010-08-23 15:16:00 +0200864}
865
866static void loop_sysfs_exit(struct loop_device *lo)
867{
Tetsuo Handad3349b62018-05-04 10:58:09 -0600868 if (lo->sysfs_inited)
869 sysfs_remove_group(&disk_to_dev(lo->lo_disk)->kobj,
870 &loop_attribute_group);
Milan Brozee862732010-08-23 15:16:00 +0200871}
872
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200873static void loop_config_discard(struct loop_device *lo)
874{
875 struct file *file = lo->lo_backing_file;
876 struct inode *inode = file->f_mapping->host;
877 struct request_queue *q = lo->lo_queue;
Ming Leibcb21c82020-08-17 18:01:30 +0800878 u32 granularity, max_discard_sectors;
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200879
880 /*
Evan Greenc52abf52020-04-03 16:43:04 +0200881 * If the backing device is a block device, mirror its zeroing
882 * capability. Set the discard sectors to the block device's zeroing
883 * capabilities because loop discards result in blkdev_issue_zeroout(),
884 * not blkdev_issue_discard(). This maintains consistent behavior with
885 * file-backed loop devices: discarded regions read back as zero.
886 */
887 if (S_ISBLK(inode->i_mode) && !lo->lo_encrypt_key_size) {
Christoph Hellwig4e7b5672020-11-23 13:38:40 +0100888 struct request_queue *backingq = bdev_get_queue(I_BDEV(inode));
Evan Greenc52abf52020-04-03 16:43:04 +0200889
Ming Leibcb21c82020-08-17 18:01:30 +0800890 max_discard_sectors = backingq->limits.max_write_zeroes_sectors;
891 granularity = backingq->limits.discard_granularity ?:
892 queue_physical_block_size(backingq);
Evan Greenc52abf52020-04-03 16:43:04 +0200893
894 /*
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200895 * We use punch hole to reclaim the free space used by the
Olaf Hering12a64d22014-01-21 14:39:24 -0800896 * image a.k.a. discard. However we do not support discard if
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200897 * encryption is enabled, because it may give an attacker
898 * useful information.
899 */
Evan Greenc52abf52020-04-03 16:43:04 +0200900 } else if (!file->f_op->fallocate || lo->lo_encrypt_key_size) {
Ming Leibcb21c82020-08-17 18:01:30 +0800901 max_discard_sectors = 0;
902 granularity = 0;
Evan Greenc52abf52020-04-03 16:43:04 +0200903
904 } else {
Ming Leibcb21c82020-08-17 18:01:30 +0800905 max_discard_sectors = UINT_MAX >> 9;
906 granularity = inode->i_sb->s_blocksize;
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200907 }
908
Ming Leibcb21c82020-08-17 18:01:30 +0800909 if (max_discard_sectors) {
910 q->limits.discard_granularity = granularity;
911 blk_queue_max_discard_sectors(q, max_discard_sectors);
912 blk_queue_max_write_zeroes_sectors(q, max_discard_sectors);
Evan Greenc52abf52020-04-03 16:43:04 +0200913 blk_queue_flag_set(QUEUE_FLAG_DISCARD, q);
Ming Leibcb21c82020-08-17 18:01:30 +0800914 } else {
915 q->limits.discard_granularity = 0;
916 blk_queue_max_discard_sectors(q, 0);
917 blk_queue_max_write_zeroes_sectors(q, 0);
Evan Greenc52abf52020-04-03 16:43:04 +0200918 blk_queue_flag_clear(QUEUE_FLAG_DISCARD, q);
Ming Leibcb21c82020-08-17 18:01:30 +0800919 }
920 q->limits.discard_alignment = 0;
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200921}
922
Ming Leie03a3d72015-08-17 10:31:48 +0800923static void loop_unprepare_queue(struct loop_device *lo)
924{
Petr Mladek39891442016-10-11 13:55:20 -0700925 kthread_flush_worker(&lo->worker);
Ming Leie03a3d72015-08-17 10:31:48 +0800926 kthread_stop(lo->worker_task);
927}
928
NeilBrownb2ee7d42017-06-16 15:02:09 +1000929static int loop_kthread_worker_fn(void *worker_ptr)
930{
NeilBrowna37b0712020-06-01 21:48:18 -0700931 current->flags |= PF_LOCAL_THROTTLE | PF_MEMALLOC_NOIO;
NeilBrownb2ee7d42017-06-16 15:02:09 +1000932 return kthread_worker_fn(worker_ptr);
933}
934
Ming Leie03a3d72015-08-17 10:31:48 +0800935static int loop_prepare_queue(struct loop_device *lo)
936{
Petr Mladek39891442016-10-11 13:55:20 -0700937 kthread_init_worker(&lo->worker);
NeilBrownb2ee7d42017-06-16 15:02:09 +1000938 lo->worker_task = kthread_run(loop_kthread_worker_fn,
Ming Leie03a3d72015-08-17 10:31:48 +0800939 &lo->worker, "loop%d", lo->lo_number);
940 if (IS_ERR(lo->worker_task))
941 return -ENOMEM;
942 set_user_nice(lo->worker_task, MIN_NICE);
943 return 0;
944}
945
Holger Hoffstätte56a85fd2019-02-12 15:54:24 -0700946static void loop_update_rotational(struct loop_device *lo)
947{
948 struct file *file = lo->lo_backing_file;
949 struct inode *file_inode = file->f_mapping->host;
950 struct block_device *file_bdev = file_inode->i_sb->s_bdev;
951 struct request_queue *q = lo->lo_queue;
952 bool nonrot = true;
953
954 /* not all filesystems (e.g. tmpfs) have a sb->s_bdev */
955 if (file_bdev)
956 nonrot = blk_queue_nonrot(bdev_get_queue(file_bdev));
957
958 if (nonrot)
959 blk_queue_flag_set(QUEUE_FLAG_NONROT, q);
960 else
961 blk_queue_flag_clear(QUEUE_FLAG_NONROT, q);
962}
963
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964static int
965loop_release_xfer(struct loop_device *lo)
966{
967 int err = 0;
968 struct loop_func_table *xfer = lo->lo_encryption;
969
970 if (xfer) {
971 if (xfer->release)
972 err = xfer->release(lo);
973 lo->transfer = NULL;
974 lo->lo_encryption = NULL;
975 module_put(xfer->owner);
976 }
977 return err;
978}
979
980static int
981loop_init_xfer(struct loop_device *lo, struct loop_func_table *xfer,
982 const struct loop_info64 *i)
983{
984 int err = 0;
985
986 if (xfer) {
987 struct module *owner = xfer->owner;
988
989 if (!try_module_get(owner))
990 return -EINVAL;
991 if (xfer->init)
992 err = xfer->init(lo, i);
993 if (err)
994 module_put(owner);
995 else
996 lo->lo_encryption = xfer;
997 }
998 return err;
999}
1000
Martijn Coenen62ab4662020-05-13 15:38:42 +02001001/**
1002 * loop_set_status_from_info - configure device from loop_info
1003 * @lo: struct loop_device to configure
1004 * @info: struct loop_info64 to configure the device with
1005 *
1006 * Configures the loop device parameters according to the passed
1007 * in loop_info64 configuration.
1008 */
1009static int
1010loop_set_status_from_info(struct loop_device *lo,
1011 const struct loop_info64 *info)
1012{
1013 int err;
1014 struct loop_func_table *xfer;
1015 kuid_t uid = current_uid();
1016
1017 if ((unsigned int) info->lo_encrypt_key_size > LO_KEY_SIZE)
1018 return -EINVAL;
1019
1020 err = loop_release_xfer(lo);
1021 if (err)
1022 return err;
1023
1024 if (info->lo_encrypt_type) {
1025 unsigned int type = info->lo_encrypt_type;
1026
1027 if (type >= MAX_LO_CRYPT)
1028 return -EINVAL;
1029 xfer = xfer_funcs[type];
1030 if (xfer == NULL)
1031 return -EINVAL;
1032 } else
1033 xfer = NULL;
1034
1035 err = loop_init_xfer(lo, xfer, info);
1036 if (err)
1037 return err;
1038
1039 lo->lo_offset = info->lo_offset;
1040 lo->lo_sizelimit = info->lo_sizelimit;
1041 memcpy(lo->lo_file_name, info->lo_file_name, LO_NAME_SIZE);
1042 memcpy(lo->lo_crypt_name, info->lo_crypt_name, LO_NAME_SIZE);
1043 lo->lo_file_name[LO_NAME_SIZE-1] = 0;
1044 lo->lo_crypt_name[LO_NAME_SIZE-1] = 0;
1045
1046 if (!xfer)
1047 xfer = &none_funcs;
1048 lo->transfer = xfer->transfer;
1049 lo->ioctl = xfer->ioctl;
1050
Martijn Coenenfaf1d252020-05-13 15:38:44 +02001051 lo->lo_flags = info->lo_flags;
Martijn Coenen62ab4662020-05-13 15:38:42 +02001052
1053 lo->lo_encrypt_key_size = info->lo_encrypt_key_size;
1054 lo->lo_init[0] = info->lo_init[0];
1055 lo->lo_init[1] = info->lo_init[1];
1056 if (info->lo_encrypt_key_size) {
1057 memcpy(lo->lo_encrypt_key, info->lo_encrypt_key,
1058 info->lo_encrypt_key_size);
1059 lo->lo_key_owner = uid;
1060 }
1061
1062 return 0;
1063}
1064
Martijn Coenen34489142020-05-13 15:38:45 +02001065static int loop_configure(struct loop_device *lo, fmode_t mode,
1066 struct block_device *bdev,
1067 const struct loop_config *config)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068{
1069 struct file *file;
1070 struct inode *inode;
1071 struct address_space *mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 int error;
1073 loff_t size;
1074 bool partscan;
Martijn Coenen34489142020-05-13 15:38:45 +02001075 unsigned short bsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076
1077 /* This is safe, since we have a reference from open(). */
1078 __module_get(THIS_MODULE);
1079
1080 error = -EBADF;
Martijn Coenen34489142020-05-13 15:38:45 +02001081 file = fget(config->fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 if (!file)
1083 goto out;
1084
1085 /*
1086 * If we don't hold exclusive handle for the device, upgrade to it
1087 * here to avoid changing device under exclusive owner.
1088 */
1089 if (!(mode & FMODE_EXCL)) {
Christoph Hellwig37c3fc92020-11-25 21:20:08 +01001090 error = bd_prepare_to_claim(bdev, loop_configure);
Christoph Hellwigecbe6bc2020-07-16 16:33:09 +02001091 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092 goto out_putf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 }
1094
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001095 error = mutex_lock_killable(&lo->lo_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 if (error)
1097 goto out_bdev;
1098
1099 error = -EBUSY;
1100 if (lo->lo_state != Lo_unbound)
1101 goto out_unlock;
1102
1103 error = loop_validate_file(file, bdev);
1104 if (error)
1105 goto out_unlock;
1106
1107 mapping = file->f_mapping;
1108 inode = mapping->host;
1109
Martijn Coenen34489142020-05-13 15:38:45 +02001110 if ((config->info.lo_flags & ~LOOP_CONFIGURE_SETTABLE_FLAGS) != 0) {
1111 error = -EINVAL;
1112 goto out_unlock;
1113 }
1114
1115 if (config->block_size) {
1116 error = loop_validate_block_size(config->block_size);
1117 if (error)
1118 goto out_unlock;
1119 }
1120
1121 error = loop_set_status_from_info(lo, &config->info);
1122 if (error)
1123 goto out_unlock;
1124
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 if (!(file->f_mode & FMODE_WRITE) || !(mode & FMODE_WRITE) ||
1126 !file->f_op->write_iter)
Martijn Coenen34489142020-05-13 15:38:45 +02001127 lo->lo_flags |= LO_FLAGS_READ_ONLY;
Martijn Coenen083a6a52020-05-13 15:38:36 +02001128
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129 error = loop_prepare_queue(lo);
1130 if (error)
1131 goto out_unlock;
1132
Christoph Hellwig7a2f0ce2020-11-03 11:00:16 +01001133 set_disk_ro(lo->lo_disk, (lo->lo_flags & LO_FLAGS_READ_ONLY) != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134
Martijn Coenen34489142020-05-13 15:38:45 +02001135 lo->use_dio = lo->lo_flags & LO_FLAGS_DIRECT_IO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 lo->lo_device = bdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137 lo->lo_backing_file = file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 lo->old_gfp_mask = mapping_gfp_mask(mapping);
1139 mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
1140
Martijn Coenen34489142020-05-13 15:38:45 +02001141 if (!(lo->lo_flags & LO_FLAGS_READ_ONLY) && file->f_op->fsync)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 blk_queue_write_cache(lo->lo_queue, true, false);
1143
Martijn Coenen34489142020-05-13 15:38:45 +02001144 if (config->block_size)
1145 bsize = config->block_size;
Linus Torvalds96ed3202020-06-02 19:45:12 -07001146 else if ((lo->lo_backing_file->f_flags & O_DIRECT) && inode->i_sb->s_bdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147 /* In case of direct I/O, match underlying block size */
Martijn Coenen34489142020-05-13 15:38:45 +02001148 bsize = bdev_logical_block_size(inode->i_sb->s_bdev);
1149 else
1150 bsize = 512;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151
Martijn Coenen34489142020-05-13 15:38:45 +02001152 blk_queue_logical_block_size(lo->lo_queue, bsize);
1153 blk_queue_physical_block_size(lo->lo_queue, bsize);
1154 blk_queue_io_min(lo->lo_queue, bsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155
1156 loop_update_rotational(lo);
1157 loop_update_dio(lo);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 loop_sysfs_init(lo);
Martijn Coenen79e5dc52020-08-25 09:18:29 +02001159
1160 size = get_loop_size(lo, file);
Martijn Coenen5795b6f2020-05-13 15:38:37 +02001161 loop_set_size(lo, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 lo->lo_state = Lo_bound;
1164 if (part_shift)
1165 lo->lo_flags |= LO_FLAGS_PARTSCAN;
1166 partscan = lo->lo_flags & LO_FLAGS_PARTSCAN;
Lennart Poetteringfe6a8fc2020-08-10 19:16:32 +02001167 if (partscan)
1168 lo->lo_disk->flags &= ~GENHD_FL_NO_PART_SCAN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169
1170 /* Grab the block_device to prevent its destruction after we
1171 * put /dev/loopXX inode. Later in __loop_clr_fd() we bdput(bdev).
1172 */
1173 bdgrab(bdev);
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001174 mutex_unlock(&lo->lo_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 if (partscan)
Christoph Hellwig03842642021-06-24 14:32:40 +02001176 loop_reread_partitions(lo);
Christoph Hellwig37c3fc92020-11-25 21:20:08 +01001177 if (!(mode & FMODE_EXCL))
1178 bd_abort_claiming(bdev, loop_configure);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 return 0;
1180
1181out_unlock:
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001182 mutex_unlock(&lo->lo_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183out_bdev:
Christoph Hellwig37c3fc92020-11-25 21:20:08 +01001184 if (!(mode & FMODE_EXCL))
1185 bd_abort_claiming(bdev, loop_configure);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186out_putf:
1187 fput(file);
1188out:
1189 /* This is safe: open() is still holding a reference. */
1190 module_put(THIS_MODULE);
1191 return error;
1192}
1193
Jan Kara0da03ca2018-11-08 14:01:14 +01001194static int __loop_clr_fd(struct loop_device *lo, bool release)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195{
Jan Kara7ccd0792018-11-08 14:01:07 +01001196 struct file *filp = NULL;
Al Virob4e3ca12005-10-21 03:22:34 -04001197 gfp_t gfp = lo->old_gfp_mask;
Ayan George4c823cc2011-09-21 10:02:13 +02001198 struct block_device *bdev = lo->lo_device;
Jan Kara7ccd0792018-11-08 14:01:07 +01001199 int err = 0;
Jan Kara0da03ca2018-11-08 14:01:14 +01001200 bool partscan = false;
1201 int lo_number;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001203 mutex_lock(&lo->lo_mutex);
Jan Kara7ccd0792018-11-08 14:01:07 +01001204 if (WARN_ON_ONCE(lo->lo_state != Lo_rundown)) {
1205 err = -ENXIO;
1206 goto out_unlock;
1207 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208
Jan Kara7ccd0792018-11-08 14:01:07 +01001209 filp = lo->lo_backing_file;
1210 if (filp == NULL) {
1211 err = -EINVAL;
1212 goto out_unlock;
1213 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214
Mauricio Faria de Oliveira4ceddce2021-02-22 12:41:23 -03001215 if (test_bit(QUEUE_FLAG_WC, &lo->lo_queue->queue_flags))
1216 blk_queue_write_cache(lo->lo_queue, false, false);
1217
Ming Leif8933662015-05-06 12:26:23 +08001218 /* freeze request queue during the transition */
1219 blk_mq_freeze_queue(lo->lo_queue);
1220
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 spin_lock_irq(&lo->lo_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 lo->lo_backing_file = NULL;
Kay Sievers05eb0f22011-07-31 22:21:35 +02001223 spin_unlock_irq(&lo->lo_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224
1225 loop_release_xfer(lo);
1226 lo->transfer = NULL;
1227 lo->ioctl = NULL;
1228 lo->lo_device = NULL;
1229 lo->lo_encryption = NULL;
1230 lo->lo_offset = 0;
1231 lo->lo_sizelimit = 0;
1232 lo->lo_encrypt_key_size = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 memset(lo->lo_encrypt_key, 0, LO_KEY_SIZE);
1234 memset(lo->lo_crypt_name, 0, LO_NAME_SIZE);
1235 memset(lo->lo_file_name, 0, LO_NAME_SIZE);
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001236 blk_queue_logical_block_size(lo->lo_queue, 512);
Omar Sandovalbf093752017-09-05 14:24:47 -07001237 blk_queue_physical_block_size(lo->lo_queue, 512);
1238 blk_queue_io_min(lo->lo_queue, 512);
Anatol Pomozovc1681bf2013-04-01 09:47:56 -07001239 if (bdev) {
1240 bdput(bdev);
Al Virobb214882008-03-02 09:29:48 -05001241 invalidate_bdev(bdev);
Jeff Laytoneedffa22018-05-21 14:35:03 -04001242 bdev->bd_inode->i_mapping->wb_err = 0;
Anatol Pomozovc1681bf2013-04-01 09:47:56 -07001243 }
Ken Chen73285082007-05-08 00:28:20 -07001244 set_capacity(lo->lo_disk, 0);
Milan Broz51a0bb02010-10-27 19:51:30 -06001245 loop_sysfs_exit(lo);
David Zeuthenc3473c62010-05-03 14:08:59 +02001246 if (bdev) {
David Zeuthenc3473c62010-05-03 14:08:59 +02001247 /* let user-space know about this change */
1248 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
1249 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250 mapping_set_gfp_mask(filp->f_mapping, gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251 /* This is safe: open() is still holding a reference. */
1252 module_put(THIS_MODULE);
Ming Leif8933662015-05-06 12:26:23 +08001253 blk_mq_unfreeze_queue(lo->lo_queue);
1254
Jan Kara0da03ca2018-11-08 14:01:14 +01001255 partscan = lo->lo_flags & LO_FLAGS_PARTSCAN && bdev;
1256 lo_number = lo->lo_number;
Jan Kara0da03ca2018-11-08 14:01:14 +01001257 loop_unprepare_queue(lo);
1258out_unlock:
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001259 mutex_unlock(&lo->lo_mutex);
Jan Kara0da03ca2018-11-08 14:01:14 +01001260 if (partscan) {
Jan Karad57f3372018-11-08 14:01:12 +01001261 /*
Christoph Hellwiga8698702021-05-25 08:12:56 +02001262 * open_mutex has been held already in release path, so don't
Jan Karad57f3372018-11-08 14:01:12 +01001263 * acquire it if this function is called in such case.
1264 *
1265 * If the reread partition isn't from release path, lo_refcnt
1266 * must be at least one and it can only become zero when the
1267 * current holder is released.
1268 */
Christoph Hellwigf0b870d2019-11-14 15:34:36 +01001269 if (!release)
Christoph Hellwig03842642021-06-24 14:32:40 +02001270 mutex_lock(&lo->lo_disk->open_mutex);
1271 err = bdev_disk_changed(lo->lo_disk, false);
Christoph Hellwigf0b870d2019-11-14 15:34:36 +01001272 if (!release)
Christoph Hellwig03842642021-06-24 14:32:40 +02001273 mutex_unlock(&lo->lo_disk->open_mutex);
Dongli Zhang40853d62019-02-22 22:10:19 +08001274 if (err)
1275 pr_warn("%s: partition scan of loop%d failed (rc=%d)\n",
1276 __func__, lo_number, err);
Jan Karad57f3372018-11-08 14:01:12 +01001277 /* Device is gone, no point in returning error */
1278 err = 0;
1279 }
Dongli Zhang758a58d2019-02-22 22:10:20 +08001280
1281 /*
1282 * lo->lo_state is set to Lo_unbound here after above partscan has
1283 * finished.
1284 *
1285 * There cannot be anybody else entering __loop_clr_fd() as
1286 * lo->lo_backing_file is already cleared and Lo_rundown state
1287 * protects us from all the other places trying to change the 'lo'
1288 * device.
1289 */
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001290 mutex_lock(&lo->lo_mutex);
Dongli Zhang758a58d2019-02-22 22:10:20 +08001291 lo->lo_flags = 0;
1292 if (!part_shift)
1293 lo->lo_disk->flags |= GENHD_FL_NO_PART_SCAN;
1294 lo->lo_state = Lo_unbound;
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001295 mutex_unlock(&lo->lo_mutex);
Dongli Zhang758a58d2019-02-22 22:10:20 +08001296
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001297 /*
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001298 * Need not hold lo_mutex to fput backing file. Calling fput holding
1299 * lo_mutex triggers a circular lock dependency possibility warning as
Christoph Hellwiga8698702021-05-25 08:12:56 +02001300 * fput can take open_mutex which is usually taken before lo_mutex.
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001301 */
Jan Kara7ccd0792018-11-08 14:01:07 +01001302 if (filp)
1303 fput(filp);
1304 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305}
1306
Jan Karaa2505b72018-11-08 14:01:06 +01001307static int loop_clr_fd(struct loop_device *lo)
1308{
Jan Kara7ccd0792018-11-08 14:01:07 +01001309 int err;
1310
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001311 err = mutex_lock_killable(&lo->lo_mutex);
Jan Kara7ccd0792018-11-08 14:01:07 +01001312 if (err)
1313 return err;
1314 if (lo->lo_state != Lo_bound) {
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001315 mutex_unlock(&lo->lo_mutex);
Jan Karaa2505b72018-11-08 14:01:06 +01001316 return -ENXIO;
Jan Kara7ccd0792018-11-08 14:01:07 +01001317 }
Jan Karaa2505b72018-11-08 14:01:06 +01001318 /*
1319 * If we've explicitly asked to tear down the loop device,
1320 * and it has an elevated reference count, set it for auto-teardown when
1321 * the last reference goes away. This stops $!~#$@ udev from
1322 * preventing teardown because it decided that it needs to run blkid on
1323 * the loopback device whenever they appear. xfstests is notorious for
1324 * failing tests because blkid via udev races with a losetup
1325 * <dev>/do something like mkfs/losetup -d <dev> causing the losetup -d
1326 * command to fail with EBUSY.
1327 */
1328 if (atomic_read(&lo->lo_refcnt) > 1) {
1329 lo->lo_flags |= LO_FLAGS_AUTOCLEAR;
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001330 mutex_unlock(&lo->lo_mutex);
Jan Karaa2505b72018-11-08 14:01:06 +01001331 return 0;
1332 }
1333 lo->lo_state = Lo_rundown;
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001334 mutex_unlock(&lo->lo_mutex);
Jan Karaa2505b72018-11-08 14:01:06 +01001335
Jan Kara0da03ca2018-11-08 14:01:14 +01001336 return __loop_clr_fd(lo, false);
Jan Karaa2505b72018-11-08 14:01:06 +01001337}
1338
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339static int
1340loop_set_status(struct loop_device *lo, const struct loop_info64 *info)
1341{
1342 int err;
Jan Kara85b0a542018-11-08 14:01:13 +01001343 struct block_device *bdev;
Martijn Coenen0c3796c2020-05-13 15:38:41 +02001344 kuid_t uid = current_uid();
Martijn Coenenfaf1d252020-05-13 15:38:44 +02001345 int prev_lo_flags;
Jan Kara85b0a542018-11-08 14:01:13 +01001346 bool partscan = false;
Martijn Coenen0c3796c2020-05-13 15:38:41 +02001347 bool size_changed = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001349 err = mutex_lock_killable(&lo->lo_mutex);
Jan Kara550df5fd2018-11-08 14:01:09 +01001350 if (err)
1351 return err;
David Howellsb0fafa82008-11-14 10:38:41 +11001352 if (lo->lo_encrypt_key_size &&
Eric W. Biedermane4849732012-02-11 11:23:51 -08001353 !uid_eq(lo->lo_key_owner, uid) &&
Jan Kara550df5fd2018-11-08 14:01:09 +01001354 !capable(CAP_SYS_ADMIN)) {
1355 err = -EPERM;
1356 goto out_unlock;
1357 }
1358 if (lo->lo_state != Lo_bound) {
1359 err = -ENXIO;
1360 goto out_unlock;
1361 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001363 if (lo->lo_offset != info->lo_offset ||
1364 lo->lo_sizelimit != info->lo_sizelimit) {
Martijn Coenen0c3796c2020-05-13 15:38:41 +02001365 size_changed = true;
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001366 sync_blockdev(lo->lo_device);
Zheng Binf4bd34b2020-06-18 12:21:37 +08001367 invalidate_bdev(lo->lo_device);
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001368 }
1369
Ming Leiecdd0952017-02-11 11:40:45 +08001370 /* I/O need to be drained during transfer transition */
1371 blk_mq_freeze_queue(lo->lo_queue);
1372
Martijn Coenen0c3796c2020-05-13 15:38:41 +02001373 if (size_changed && lo->lo_device->bd_inode->i_mapping->nrpages) {
Zheng Binf4bd34b2020-06-18 12:21:37 +08001374 /* If any pages were dirtied after invalidate_bdev(), try again */
Martijn Coenen0c3796c2020-05-13 15:38:41 +02001375 err = -EAGAIN;
1376 pr_warn("%s: loop%d (%s) has still dirty pages (nrpages=%lu)\n",
1377 __func__, lo->lo_number, lo->lo_file_name,
1378 lo->lo_device->bd_inode->i_mapping->nrpages);
1379 goto out_unfreeze;
1380 }
1381
Martijn Coenenfaf1d252020-05-13 15:38:44 +02001382 prev_lo_flags = lo->lo_flags;
1383
Martijn Coenen0c3796c2020-05-13 15:38:41 +02001384 err = loop_set_status_from_info(lo, info);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 if (err)
Jan Kara550df5fd2018-11-08 14:01:09 +01001386 goto out_unfreeze;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387
Martijn Coenenfaf1d252020-05-13 15:38:44 +02001388 /* Mask out flags that can't be set using LOOP_SET_STATUS. */
Martijn Coenen6ac92fb2020-06-04 22:25:20 +02001389 lo->lo_flags &= LOOP_SET_STATUS_SETTABLE_FLAGS;
Martijn Coenenfaf1d252020-05-13 15:38:44 +02001390 /* For those flags, use the previous values instead */
1391 lo->lo_flags |= prev_lo_flags & ~LOOP_SET_STATUS_SETTABLE_FLAGS;
1392 /* For flags that can't be cleared, use previous values too */
1393 lo->lo_flags |= prev_lo_flags & ~LOOP_SET_STATUS_CLEARABLE_FLAGS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394
Martijn Coenenb0bd1582020-05-13 15:38:39 +02001395 if (size_changed) {
1396 loff_t new_size = get_size(lo->lo_offset, lo->lo_sizelimit,
1397 lo->lo_backing_file);
1398 loop_set_size(lo, new_size);
Arnd Bergmannb040ad92017-06-09 12:19:18 +02001399 }
Guo Chao541c7422013-02-21 15:16:46 -08001400
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +02001401 loop_config_discard(lo);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402
Ming Lei2e5ab5f2015-08-17 10:31:49 +08001403 /* update dio if lo_offset or transfer is changed */
1404 __loop_update_dio(lo, lo->use_dio);
1405
Jan Kara550df5fd2018-11-08 14:01:09 +01001406out_unfreeze:
Ming Leiecdd0952017-02-11 11:40:45 +08001407 blk_mq_unfreeze_queue(lo->lo_queue);
Omar Sandovale02898b42017-03-01 10:42:38 -08001408
Martijn Coenenfaf1d252020-05-13 15:38:44 +02001409 if (!err && (lo->lo_flags & LO_FLAGS_PARTSCAN) &&
1410 !(prev_lo_flags & LO_FLAGS_PARTSCAN)) {
Omar Sandovale02898b42017-03-01 10:42:38 -08001411 lo->lo_disk->flags &= ~GENHD_FL_NO_PART_SCAN;
Jan Kara85b0a542018-11-08 14:01:13 +01001412 bdev = lo->lo_device;
1413 partscan = true;
Omar Sandovale02898b42017-03-01 10:42:38 -08001414 }
Jan Kara550df5fd2018-11-08 14:01:09 +01001415out_unlock:
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001416 mutex_unlock(&lo->lo_mutex);
Jan Kara85b0a542018-11-08 14:01:13 +01001417 if (partscan)
Christoph Hellwig03842642021-06-24 14:32:40 +02001418 loop_reread_partitions(lo);
Omar Sandovale02898b42017-03-01 10:42:38 -08001419
Ming Leiecdd0952017-02-11 11:40:45 +08001420 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421}
1422
1423static int
1424loop_get_status(struct loop_device *lo, struct loop_info64 *info)
1425{
Tetsuo Handab1ab5fa2018-11-08 14:01:01 +01001426 struct path path;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 struct kstat stat;
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001428 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001430 ret = mutex_lock_killable(&lo->lo_mutex);
Jan Kara4a5ce9b2018-11-08 14:01:08 +01001431 if (ret)
1432 return ret;
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001433 if (lo->lo_state != Lo_bound) {
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001434 mutex_unlock(&lo->lo_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435 return -ENXIO;
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001436 }
1437
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 memset(info, 0, sizeof(*info));
1439 info->lo_number = lo->lo_number;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 info->lo_offset = lo->lo_offset;
1441 info->lo_sizelimit = lo->lo_sizelimit;
1442 info->lo_flags = lo->lo_flags;
1443 memcpy(info->lo_file_name, lo->lo_file_name, LO_NAME_SIZE);
1444 memcpy(info->lo_crypt_name, lo->lo_crypt_name, LO_NAME_SIZE);
1445 info->lo_encrypt_type =
1446 lo->lo_encryption ? lo->lo_encryption->number : 0;
1447 if (lo->lo_encrypt_key_size && capable(CAP_SYS_ADMIN)) {
1448 info->lo_encrypt_key_size = lo->lo_encrypt_key_size;
1449 memcpy(info->lo_encrypt_key, lo->lo_encrypt_key,
1450 lo->lo_encrypt_key_size);
1451 }
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001452
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001453 /* Drop lo_mutex while we call into the filesystem. */
Tetsuo Handab1ab5fa2018-11-08 14:01:01 +01001454 path = lo->lo_backing_file->f_path;
1455 path_get(&path);
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001456 mutex_unlock(&lo->lo_mutex);
Tetsuo Handab1ab5fa2018-11-08 14:01:01 +01001457 ret = vfs_getattr(&path, &stat, STATX_INO, AT_STATX_SYNC_AS_STAT);
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001458 if (!ret) {
1459 info->lo_device = huge_encode_dev(stat.dev);
1460 info->lo_inode = stat.ino;
1461 info->lo_rdevice = huge_encode_dev(stat.rdev);
1462 }
Tetsuo Handab1ab5fa2018-11-08 14:01:01 +01001463 path_put(&path);
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001464 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465}
1466
1467static void
1468loop_info64_from_old(const struct loop_info *info, struct loop_info64 *info64)
1469{
1470 memset(info64, 0, sizeof(*info64));
1471 info64->lo_number = info->lo_number;
1472 info64->lo_device = info->lo_device;
1473 info64->lo_inode = info->lo_inode;
1474 info64->lo_rdevice = info->lo_rdevice;
1475 info64->lo_offset = info->lo_offset;
1476 info64->lo_sizelimit = 0;
1477 info64->lo_encrypt_type = info->lo_encrypt_type;
1478 info64->lo_encrypt_key_size = info->lo_encrypt_key_size;
1479 info64->lo_flags = info->lo_flags;
1480 info64->lo_init[0] = info->lo_init[0];
1481 info64->lo_init[1] = info->lo_init[1];
1482 if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1483 memcpy(info64->lo_crypt_name, info->lo_name, LO_NAME_SIZE);
1484 else
1485 memcpy(info64->lo_file_name, info->lo_name, LO_NAME_SIZE);
1486 memcpy(info64->lo_encrypt_key, info->lo_encrypt_key, LO_KEY_SIZE);
1487}
1488
1489static int
1490loop_info64_to_old(const struct loop_info64 *info64, struct loop_info *info)
1491{
1492 memset(info, 0, sizeof(*info));
1493 info->lo_number = info64->lo_number;
1494 info->lo_device = info64->lo_device;
1495 info->lo_inode = info64->lo_inode;
1496 info->lo_rdevice = info64->lo_rdevice;
1497 info->lo_offset = info64->lo_offset;
1498 info->lo_encrypt_type = info64->lo_encrypt_type;
1499 info->lo_encrypt_key_size = info64->lo_encrypt_key_size;
1500 info->lo_flags = info64->lo_flags;
1501 info->lo_init[0] = info64->lo_init[0];
1502 info->lo_init[1] = info64->lo_init[1];
1503 if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1504 memcpy(info->lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1505 else
1506 memcpy(info->lo_name, info64->lo_file_name, LO_NAME_SIZE);
1507 memcpy(info->lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1508
1509 /* error in case values were truncated */
1510 if (info->lo_device != info64->lo_device ||
1511 info->lo_rdevice != info64->lo_rdevice ||
1512 info->lo_inode != info64->lo_inode ||
1513 info->lo_offset != info64->lo_offset)
1514 return -EOVERFLOW;
1515
1516 return 0;
1517}
1518
1519static int
1520loop_set_status_old(struct loop_device *lo, const struct loop_info __user *arg)
1521{
1522 struct loop_info info;
1523 struct loop_info64 info64;
1524
1525 if (copy_from_user(&info, arg, sizeof (struct loop_info)))
1526 return -EFAULT;
1527 loop_info64_from_old(&info, &info64);
1528 return loop_set_status(lo, &info64);
1529}
1530
1531static int
1532loop_set_status64(struct loop_device *lo, const struct loop_info64 __user *arg)
1533{
1534 struct loop_info64 info64;
1535
1536 if (copy_from_user(&info64, arg, sizeof (struct loop_info64)))
1537 return -EFAULT;
1538 return loop_set_status(lo, &info64);
1539}
1540
1541static int
1542loop_get_status_old(struct loop_device *lo, struct loop_info __user *arg) {
1543 struct loop_info info;
1544 struct loop_info64 info64;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001545 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546
Jan Kara4a5ce9b2018-11-08 14:01:08 +01001547 if (!arg)
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001548 return -EINVAL;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001549 err = loop_get_status(lo, &info64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 if (!err)
1551 err = loop_info64_to_old(&info64, &info);
1552 if (!err && copy_to_user(arg, &info, sizeof(info)))
1553 err = -EFAULT;
1554
1555 return err;
1556}
1557
1558static int
1559loop_get_status64(struct loop_device *lo, struct loop_info64 __user *arg) {
1560 struct loop_info64 info64;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001561 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562
Jan Kara4a5ce9b2018-11-08 14:01:08 +01001563 if (!arg)
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001564 return -EINVAL;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001565 err = loop_get_status(lo, &info64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 if (!err && copy_to_user(arg, &info64, sizeof(info64)))
1567 err = -EFAULT;
1568
1569 return err;
1570}
1571
Hannes Reinecke51001b72017-06-08 13:46:44 +02001572static int loop_set_capacity(struct loop_device *lo)
J. R. Okajima53d66602009-03-31 15:23:43 -07001573{
Martijn Coenen0a6ed1b2020-05-13 15:38:40 +02001574 loff_t size;
1575
J. R. Okajima53d66602009-03-31 15:23:43 -07001576 if (unlikely(lo->lo_state != Lo_bound))
Guo Chao7b0576a2013-02-21 15:16:47 -08001577 return -ENXIO;
J. R. Okajima53d66602009-03-31 15:23:43 -07001578
Martijn Coenen0a6ed1b2020-05-13 15:38:40 +02001579 size = get_loop_size(lo, lo->lo_backing_file);
1580 loop_set_size(lo, size);
Martijn Coenen083a6a52020-05-13 15:38:36 +02001581
1582 return 0;
J. R. Okajima53d66602009-03-31 15:23:43 -07001583}
1584
Ming Leiab1cb272015-08-17 10:31:50 +08001585static int loop_set_dio(struct loop_device *lo, unsigned long arg)
1586{
1587 int error = -ENXIO;
1588 if (lo->lo_state != Lo_bound)
1589 goto out;
1590
1591 __loop_update_dio(lo, !!arg);
1592 if (lo->use_dio == !!arg)
1593 return 0;
1594 error = -EINVAL;
1595 out:
1596 return error;
1597}
1598
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001599static int loop_set_block_size(struct loop_device *lo, unsigned long arg)
1600{
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001601 int err = 0;
1602
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001603 if (lo->lo_state != Lo_bound)
1604 return -ENXIO;
1605
Martijn Coenen34489142020-05-13 15:38:45 +02001606 err = loop_validate_block_size(arg);
1607 if (err)
1608 return err;
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001609
Martijn Coenen7e81f992020-03-10 14:12:30 +01001610 if (lo->lo_queue->limits.logical_block_size == arg)
1611 return 0;
1612
1613 sync_blockdev(lo->lo_device);
Zheng Binf4bd34b2020-06-18 12:21:37 +08001614 invalidate_bdev(lo->lo_device);
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001615
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001616 blk_mq_freeze_queue(lo->lo_queue);
1617
Zheng Binf4bd34b2020-06-18 12:21:37 +08001618 /* invalidate_bdev should have truncated all the pages */
Martijn Coenen7e81f992020-03-10 14:12:30 +01001619 if (lo->lo_device->bd_inode->i_mapping->nrpages) {
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001620 err = -EAGAIN;
1621 pr_warn("%s: loop%d (%s) has still dirty pages (nrpages=%lu)\n",
1622 __func__, lo->lo_number, lo->lo_file_name,
1623 lo->lo_device->bd_inode->i_mapping->nrpages);
1624 goto out_unfreeze;
1625 }
1626
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001627 blk_queue_logical_block_size(lo->lo_queue, arg);
Omar Sandovalbf093752017-09-05 14:24:47 -07001628 blk_queue_physical_block_size(lo->lo_queue, arg);
1629 blk_queue_io_min(lo->lo_queue, arg);
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001630 loop_update_dio(lo);
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001631out_unfreeze:
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001632 blk_mq_unfreeze_queue(lo->lo_queue);
1633
Jaegeuk Kim5db470e2019-01-09 19:17:14 -08001634 return err;
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001635}
1636
Jan Karaa1316542018-11-08 14:01:05 +01001637static int lo_simple_ioctl(struct loop_device *lo, unsigned int cmd,
1638 unsigned long arg)
1639{
1640 int err;
1641
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001642 err = mutex_lock_killable(&lo->lo_mutex);
Jan Karaa1316542018-11-08 14:01:05 +01001643 if (err)
1644 return err;
1645 switch (cmd) {
1646 case LOOP_SET_CAPACITY:
1647 err = loop_set_capacity(lo);
1648 break;
1649 case LOOP_SET_DIRECT_IO:
1650 err = loop_set_dio(lo, arg);
1651 break;
1652 case LOOP_SET_BLOCK_SIZE:
1653 err = loop_set_block_size(lo, arg);
1654 break;
1655 default:
1656 err = lo->ioctl ? lo->ioctl(lo, cmd, arg) : -EINVAL;
1657 }
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001658 mutex_unlock(&lo->lo_mutex);
Jan Karaa1316542018-11-08 14:01:05 +01001659 return err;
1660}
1661
Al Virobb214882008-03-02 09:29:48 -05001662static int lo_ioctl(struct block_device *bdev, fmode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 unsigned int cmd, unsigned long arg)
1664{
Al Virobb214882008-03-02 09:29:48 -05001665 struct loop_device *lo = bdev->bd_disk->private_data;
Martijn Coenen571fae62020-05-13 15:38:43 +02001666 void __user *argp = (void __user *) arg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667 int err;
1668
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 switch (cmd) {
Martijn Coenen34489142020-05-13 15:38:45 +02001670 case LOOP_SET_FD: {
1671 /*
1672 * Legacy case - pass in a zeroed out struct loop_config with
1673 * only the file descriptor set , which corresponds with the
1674 * default parameters we'd have used otherwise.
1675 */
1676 struct loop_config config;
1677
1678 memset(&config, 0, sizeof(config));
1679 config.fd = arg;
1680
1681 return loop_configure(lo, mode, bdev, &config);
1682 }
1683 case LOOP_CONFIGURE: {
1684 struct loop_config config;
1685
1686 if (copy_from_user(&config, argp, sizeof(config)))
1687 return -EFAULT;
1688
1689 return loop_configure(lo, mode, bdev, &config);
1690 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691 case LOOP_CHANGE_FD:
Jan Karac3710772018-11-08 14:01:11 +01001692 return loop_change_fd(lo, bdev, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 case LOOP_CLR_FD:
Jan Kara7ccd0792018-11-08 14:01:07 +01001694 return loop_clr_fd(lo);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695 case LOOP_SET_STATUS:
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +01001696 err = -EPERM;
Jan Karaa1316542018-11-08 14:01:05 +01001697 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN)) {
Martijn Coenen571fae62020-05-13 15:38:43 +02001698 err = loop_set_status_old(lo, argp);
Jan Karaa1316542018-11-08 14:01:05 +01001699 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700 break;
1701 case LOOP_GET_STATUS:
Martijn Coenen571fae62020-05-13 15:38:43 +02001702 return loop_get_status_old(lo, argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 case LOOP_SET_STATUS64:
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +01001704 err = -EPERM;
Jan Karaa1316542018-11-08 14:01:05 +01001705 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN)) {
Martijn Coenen571fae62020-05-13 15:38:43 +02001706 err = loop_set_status64(lo, argp);
Jan Karaa1316542018-11-08 14:01:05 +01001707 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708 break;
1709 case LOOP_GET_STATUS64:
Martijn Coenen571fae62020-05-13 15:38:43 +02001710 return loop_get_status64(lo, argp);
J. R. Okajima53d66602009-03-31 15:23:43 -07001711 case LOOP_SET_CAPACITY:
Ming Leiab1cb272015-08-17 10:31:50 +08001712 case LOOP_SET_DIRECT_IO:
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001713 case LOOP_SET_BLOCK_SIZE:
Jan Karaa1316542018-11-08 14:01:05 +01001714 if (!(mode & FMODE_WRITE) && !capable(CAP_SYS_ADMIN))
1715 return -EPERM;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05001716 fallthrough;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717 default:
Jan Karaa1316542018-11-08 14:01:05 +01001718 err = lo_simple_ioctl(lo, cmd, arg);
1719 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720 }
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001721
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722 return err;
1723}
1724
David Howells863d5b822006-08-29 19:06:14 +01001725#ifdef CONFIG_COMPAT
1726struct compat_loop_info {
1727 compat_int_t lo_number; /* ioctl r/o */
1728 compat_dev_t lo_device; /* ioctl r/o */
1729 compat_ulong_t lo_inode; /* ioctl r/o */
1730 compat_dev_t lo_rdevice; /* ioctl r/o */
1731 compat_int_t lo_offset;
1732 compat_int_t lo_encrypt_type;
1733 compat_int_t lo_encrypt_key_size; /* ioctl w/o */
1734 compat_int_t lo_flags; /* ioctl r/o */
1735 char lo_name[LO_NAME_SIZE];
1736 unsigned char lo_encrypt_key[LO_KEY_SIZE]; /* ioctl w/o */
1737 compat_ulong_t lo_init[2];
1738 char reserved[4];
1739};
1740
1741/*
1742 * Transfer 32-bit compatibility structure in userspace to 64-bit loop info
1743 * - noinlined to reduce stack space usage in main part of driver
1744 */
1745static noinline int
Al Viroba674cf2006-10-10 22:48:27 +01001746loop_info64_from_compat(const struct compat_loop_info __user *arg,
David Howells863d5b822006-08-29 19:06:14 +01001747 struct loop_info64 *info64)
1748{
1749 struct compat_loop_info info;
1750
1751 if (copy_from_user(&info, arg, sizeof(info)))
1752 return -EFAULT;
1753
1754 memset(info64, 0, sizeof(*info64));
1755 info64->lo_number = info.lo_number;
1756 info64->lo_device = info.lo_device;
1757 info64->lo_inode = info.lo_inode;
1758 info64->lo_rdevice = info.lo_rdevice;
1759 info64->lo_offset = info.lo_offset;
1760 info64->lo_sizelimit = 0;
1761 info64->lo_encrypt_type = info.lo_encrypt_type;
1762 info64->lo_encrypt_key_size = info.lo_encrypt_key_size;
1763 info64->lo_flags = info.lo_flags;
1764 info64->lo_init[0] = info.lo_init[0];
1765 info64->lo_init[1] = info.lo_init[1];
1766 if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1767 memcpy(info64->lo_crypt_name, info.lo_name, LO_NAME_SIZE);
1768 else
1769 memcpy(info64->lo_file_name, info.lo_name, LO_NAME_SIZE);
1770 memcpy(info64->lo_encrypt_key, info.lo_encrypt_key, LO_KEY_SIZE);
1771 return 0;
1772}
1773
1774/*
1775 * Transfer 64-bit loop info to 32-bit compatibility structure in userspace
1776 * - noinlined to reduce stack space usage in main part of driver
1777 */
1778static noinline int
1779loop_info64_to_compat(const struct loop_info64 *info64,
1780 struct compat_loop_info __user *arg)
1781{
1782 struct compat_loop_info info;
1783
1784 memset(&info, 0, sizeof(info));
1785 info.lo_number = info64->lo_number;
1786 info.lo_device = info64->lo_device;
1787 info.lo_inode = info64->lo_inode;
1788 info.lo_rdevice = info64->lo_rdevice;
1789 info.lo_offset = info64->lo_offset;
1790 info.lo_encrypt_type = info64->lo_encrypt_type;
1791 info.lo_encrypt_key_size = info64->lo_encrypt_key_size;
1792 info.lo_flags = info64->lo_flags;
1793 info.lo_init[0] = info64->lo_init[0];
1794 info.lo_init[1] = info64->lo_init[1];
1795 if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1796 memcpy(info.lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1797 else
1798 memcpy(info.lo_name, info64->lo_file_name, LO_NAME_SIZE);
1799 memcpy(info.lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1800
1801 /* error in case values were truncated */
1802 if (info.lo_device != info64->lo_device ||
1803 info.lo_rdevice != info64->lo_rdevice ||
1804 info.lo_inode != info64->lo_inode ||
1805 info.lo_offset != info64->lo_offset ||
1806 info.lo_init[0] != info64->lo_init[0] ||
1807 info.lo_init[1] != info64->lo_init[1])
1808 return -EOVERFLOW;
1809
1810 if (copy_to_user(arg, &info, sizeof(info)))
1811 return -EFAULT;
1812 return 0;
1813}
1814
1815static int
1816loop_set_status_compat(struct loop_device *lo,
1817 const struct compat_loop_info __user *arg)
1818{
1819 struct loop_info64 info64;
1820 int ret;
1821
1822 ret = loop_info64_from_compat(arg, &info64);
1823 if (ret < 0)
1824 return ret;
1825 return loop_set_status(lo, &info64);
1826}
1827
1828static int
1829loop_get_status_compat(struct loop_device *lo,
1830 struct compat_loop_info __user *arg)
1831{
1832 struct loop_info64 info64;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001833 int err;
David Howells863d5b822006-08-29 19:06:14 +01001834
Jan Kara4a5ce9b2018-11-08 14:01:08 +01001835 if (!arg)
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001836 return -EINVAL;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001837 err = loop_get_status(lo, &info64);
David Howells863d5b822006-08-29 19:06:14 +01001838 if (!err)
1839 err = loop_info64_to_compat(&info64, arg);
1840 return err;
1841}
1842
Al Virobb214882008-03-02 09:29:48 -05001843static int lo_compat_ioctl(struct block_device *bdev, fmode_t mode,
1844 unsigned int cmd, unsigned long arg)
David Howells863d5b822006-08-29 19:06:14 +01001845{
Al Virobb214882008-03-02 09:29:48 -05001846 struct loop_device *lo = bdev->bd_disk->private_data;
David Howells863d5b822006-08-29 19:06:14 +01001847 int err;
1848
David Howells863d5b822006-08-29 19:06:14 +01001849 switch(cmd) {
1850 case LOOP_SET_STATUS:
Jan Kara550df5fd2018-11-08 14:01:09 +01001851 err = loop_set_status_compat(lo,
1852 (const struct compat_loop_info __user *)arg);
David Howells863d5b822006-08-29 19:06:14 +01001853 break;
1854 case LOOP_GET_STATUS:
Jan Kara4a5ce9b2018-11-08 14:01:08 +01001855 err = loop_get_status_compat(lo,
1856 (struct compat_loop_info __user *)arg);
David Howells863d5b822006-08-29 19:06:14 +01001857 break;
J. R. Okajima53d66602009-03-31 15:23:43 -07001858 case LOOP_SET_CAPACITY:
David Howells863d5b822006-08-29 19:06:14 +01001859 case LOOP_CLR_FD:
1860 case LOOP_GET_STATUS64:
1861 case LOOP_SET_STATUS64:
Martijn Coenen34489142020-05-13 15:38:45 +02001862 case LOOP_CONFIGURE:
David Howells863d5b822006-08-29 19:06:14 +01001863 arg = (unsigned long) compat_ptr(arg);
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05001864 fallthrough;
David Howells863d5b822006-08-29 19:06:14 +01001865 case LOOP_SET_FD:
1866 case LOOP_CHANGE_FD:
Evan Green9fea4b32018-07-02 16:03:46 -07001867 case LOOP_SET_BLOCK_SIZE:
Alessio Balsinifdbe4ee2019-08-07 01:48:28 +01001868 case LOOP_SET_DIRECT_IO:
Al Virobb214882008-03-02 09:29:48 -05001869 err = lo_ioctl(bdev, mode, cmd, arg);
David Howells863d5b822006-08-29 19:06:14 +01001870 break;
1871 default:
1872 err = -ENOIOCTLCMD;
1873 break;
1874 }
David Howells863d5b822006-08-29 19:06:14 +01001875 return err;
1876}
1877#endif
1878
Al Virobb214882008-03-02 09:29:48 -05001879static int lo_open(struct block_device *bdev, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880{
Kay Sievers770fe302011-07-31 22:08:04 +02001881 struct loop_device *lo;
Jan Kara0a42e992018-11-08 14:01:04 +01001882 int err;
Kay Sievers770fe302011-07-31 22:08:04 +02001883
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001884 /*
1885 * take loop_ctl_mutex to protect lo pointer from race with
1886 * loop_control_ioctl(LOOP_CTL_REMOVE), however, to reduce contention
1887 * release it prior to updating lo->lo_refcnt.
1888 */
Jan Kara0a42e992018-11-08 14:01:04 +01001889 err = mutex_lock_killable(&loop_ctl_mutex);
1890 if (err)
1891 return err;
Kay Sievers770fe302011-07-31 22:08:04 +02001892 lo = bdev->bd_disk->private_data;
1893 if (!lo) {
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001894 mutex_unlock(&loop_ctl_mutex);
1895 return -ENXIO;
Kay Sievers770fe302011-07-31 22:08:04 +02001896 }
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001897 err = mutex_lock_killable(&lo->lo_mutex);
Jan Kara0a42e992018-11-08 14:01:04 +01001898 mutex_unlock(&loop_ctl_mutex);
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001899 if (err)
1900 return err;
1901 atomic_inc(&lo->lo_refcnt);
1902 mutex_unlock(&lo->lo_mutex);
1903 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904}
1905
Jan Kara967d1dc2018-11-08 14:01:03 +01001906static void lo_release(struct gendisk *disk, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907{
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001908 struct loop_device *lo = disk->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001910 mutex_lock(&lo->lo_mutex);
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;
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001918 mutex_unlock(&lo->lo_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:
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001935 mutex_unlock(&lo->lo_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
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001974 mutex_lock(&lo->lo_mutex);
Kay Sievers34dd82a2011-07-31 22:08:04 +02001975 if (lo->lo_encryption == xfer)
1976 loop_release_xfer(lo);
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05001977 mutex_unlock(&lo->lo_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
Christoph Hellwig1c995022021-06-02 09:53:33 +03002119 disk = lo->lo_disk = blk_mq_alloc_disk(&lo->tag_set, lo);
2120 if (IS_ERR(disk)) {
2121 err = PTR_ERR(disk);
Ming Leib5dd2f62014-12-31 13:22:57 +00002122 goto out_cleanup_tags;
2123 }
Christoph Hellwig1c995022021-06-02 09:53:33 +03002124 lo->lo_queue = lo->lo_disk->queue;
Mikulas Patockaef7e7c82013-10-15 14:14:38 -06002125
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
Kay Sieverse03c8dd2011-08-23 20:12:04 +02002136 /*
2137 * Disable partition scanning by default. The in-kernel partition
2138 * scanning can be requested individually per-device during its
2139 * setup. Userspace can always add and remove partitions from all
2140 * devices. The needed partition minors are allocated from the
2141 * extended minor space, the main loop device numbers will continue
2142 * to match the loop minors, regardless of the number of partitions
2143 * used.
2144 *
2145 * If max_part is given, partition scanning is globally enabled for
2146 * all loop devices. The minors for the main loop devices will be
2147 * multiples of max_part.
2148 *
2149 * Note: Global-for-all-devices, set-only-at-init, read-only module
2150 * parameteters like 'max_loop' and 'max_part' make things needlessly
2151 * complicated, are too static, inflexible and may surprise
2152 * userspace tools. Parameters like this in general should be avoided.
2153 */
2154 if (!part_shift)
2155 disk->flags |= GENHD_FL_NO_PART_SCAN;
2156 disk->flags |= GENHD_FL_EXT_DEVT;
Ming Leif8933662015-05-06 12:26:23 +08002157 atomic_set(&lo->lo_refcnt, 0);
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05002158 mutex_init(&lo->lo_mutex);
Ken Chen73285082007-05-08 00:28:20 -07002159 lo->lo_number = i;
Ken Chen73285082007-05-08 00:28:20 -07002160 spin_lock_init(&lo->lo_lock);
2161 disk->major = LOOP_MAJOR;
Laurent Vivier476a4812008-03-26 12:11:53 +01002162 disk->first_minor = i << part_shift;
Christoph Hellwig1c995022021-06-02 09:53:33 +03002163 disk->minors = 1 << part_shift;
Ken Chen73285082007-05-08 00:28:20 -07002164 disk->fops = &lo_fops;
2165 disk->private_data = lo;
2166 disk->queue = lo->lo_queue;
2167 sprintf(disk->disk_name, "loop%d", i);
Kay Sievers34dd82a2011-07-31 22:08:04 +02002168 add_disk(disk);
2169 *l = lo;
2170 return lo->lo_number;
Ken Chen73285082007-05-08 00:28:20 -07002171
Ming Leib5dd2f62014-12-31 13:22:57 +00002172out_cleanup_tags:
2173 blk_mq_free_tag_set(&lo->tag_set);
Mikulas Patocka3ec981e2013-10-14 12:12:24 -04002174out_free_idr:
2175 idr_remove(&loop_index_idr, i);
Ken Chen73285082007-05-08 00:28:20 -07002176out_free_dev:
2177 kfree(lo);
2178out:
Kay Sievers34dd82a2011-07-31 22:08:04 +02002179 return err;
Ken Chen73285082007-05-08 00:28:20 -07002180}
2181
Kay Sievers34dd82a2011-07-31 22:08:04 +02002182static void loop_remove(struct loop_device *lo)
Ken Chen73285082007-05-08 00:28:20 -07002183{
NeilBrown6cd18e72015-04-27 14:12:22 +10002184 del_gendisk(lo->lo_disk);
Christoph Hellwig1c995022021-06-02 09:53:33 +03002185 blk_cleanup_disk(lo->lo_disk);
Christoph Hellwig6a03cd982021-06-16 09:15:47 +02002186 blk_mq_free_tag_set(&lo->tag_set);
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05002187 mutex_destroy(&lo->lo_mutex);
Ken Chen73285082007-05-08 00:28:20 -07002188 kfree(lo);
2189}
2190
Kay Sievers770fe302011-07-31 22:08:04 +02002191static int find_free_cb(int id, void *ptr, void *data)
Ken Chena47653f2007-06-08 13:46:44 -07002192{
Kay Sievers770fe302011-07-31 22:08:04 +02002193 struct loop_device *lo = ptr;
2194 struct loop_device **l = data;
Ken Chena47653f2007-06-08 13:46:44 -07002195
Kay Sievers770fe302011-07-31 22:08:04 +02002196 if (lo->lo_state == Lo_unbound) {
2197 *l = lo;
2198 return 1;
Ken Chena47653f2007-06-08 13:46:44 -07002199 }
Kay Sievers770fe302011-07-31 22:08:04 +02002200 return 0;
Ken Chena47653f2007-06-08 13:46:44 -07002201}
2202
Kay Sievers34dd82a2011-07-31 22:08:04 +02002203static int loop_lookup(struct loop_device **l, int i)
Ken Chena47653f2007-06-08 13:46:44 -07002204{
Ken Chena47653f2007-06-08 13:46:44 -07002205 struct loop_device *lo;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002206 int ret = -ENODEV;
Ken Chena47653f2007-06-08 13:46:44 -07002207
Kay Sievers770fe302011-07-31 22:08:04 +02002208 if (i < 0) {
2209 int err;
2210
2211 err = idr_for_each(&loop_index_idr, &find_free_cb, &lo);
2212 if (err == 1) {
2213 *l = lo;
2214 ret = lo->lo_number;
2215 }
2216 goto out;
2217 }
2218
2219 /* lookup and return a specific i */
Kay Sievers34dd82a2011-07-31 22:08:04 +02002220 lo = idr_find(&loop_index_idr, i);
Ken Chena47653f2007-06-08 13:46:44 -07002221 if (lo) {
Kay Sievers34dd82a2011-07-31 22:08:04 +02002222 *l = lo;
2223 ret = lo->lo_number;
Ken Chena47653f2007-06-08 13:46:44 -07002224 }
Kay Sievers770fe302011-07-31 22:08:04 +02002225out:
Kay Sievers34dd82a2011-07-31 22:08:04 +02002226 return ret;
Ken Chena47653f2007-06-08 13:46:44 -07002227}
2228
Christoph Hellwig8410d382020-10-29 15:58:33 +01002229static void loop_probe(dev_t dev)
Ken Chen73285082007-05-08 00:28:20 -07002230{
Christoph Hellwig8410d382020-10-29 15:58:33 +01002231 int idx = MINOR(dev) >> part_shift;
Al Viro705962c2007-05-13 05:52:32 -04002232 struct loop_device *lo;
Christoph Hellwig8410d382020-10-29 15:58:33 +01002233
2234 if (max_loop && idx >= max_loop)
2235 return;
Ken Chen73285082007-05-08 00:28:20 -07002236
Jan Kara0a42e992018-11-08 14:01:04 +01002237 mutex_lock(&loop_ctl_mutex);
Christoph Hellwig8410d382020-10-29 15:58:33 +01002238 if (loop_lookup(&lo, idx) < 0)
2239 loop_add(&lo, idx);
Jan Kara0a42e992018-11-08 14:01:04 +01002240 mutex_unlock(&loop_ctl_mutex);
Ken Chen73285082007-05-08 00:28:20 -07002241}
2242
Kay Sievers770fe302011-07-31 22:08:04 +02002243static long loop_control_ioctl(struct file *file, unsigned int cmd,
2244 unsigned long parm)
2245{
2246 struct loop_device *lo;
Jan Kara0a42e992018-11-08 14:01:04 +01002247 int ret;
Kay Sievers770fe302011-07-31 22:08:04 +02002248
Jan Kara0a42e992018-11-08 14:01:04 +01002249 ret = mutex_lock_killable(&loop_ctl_mutex);
2250 if (ret)
2251 return ret;
2252
2253 ret = -ENOSYS;
Kay Sievers770fe302011-07-31 22:08:04 +02002254 switch (cmd) {
2255 case LOOP_CTL_ADD:
2256 ret = loop_lookup(&lo, parm);
2257 if (ret >= 0) {
2258 ret = -EEXIST;
2259 break;
2260 }
2261 ret = loop_add(&lo, parm);
2262 break;
2263 case LOOP_CTL_REMOVE:
2264 ret = loop_lookup(&lo, parm);
2265 if (ret < 0)
2266 break;
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05002267 ret = mutex_lock_killable(&lo->lo_mutex);
2268 if (ret)
2269 break;
Kay Sievers770fe302011-07-31 22:08:04 +02002270 if (lo->lo_state != Lo_unbound) {
2271 ret = -EBUSY;
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05002272 mutex_unlock(&lo->lo_mutex);
Kay Sievers770fe302011-07-31 22:08:04 +02002273 break;
2274 }
Ming Leif8933662015-05-06 12:26:23 +08002275 if (atomic_read(&lo->lo_refcnt) > 0) {
Kay Sievers770fe302011-07-31 22:08:04 +02002276 ret = -EBUSY;
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05002277 mutex_unlock(&lo->lo_mutex);
Kay Sievers770fe302011-07-31 22:08:04 +02002278 break;
2279 }
2280 lo->lo_disk->private_data = NULL;
Pavel Tatashin6cc8e742021-01-26 09:46:30 -05002281 mutex_unlock(&lo->lo_mutex);
Kay Sievers770fe302011-07-31 22:08:04 +02002282 idr_remove(&loop_index_idr, lo->lo_number);
2283 loop_remove(lo);
2284 break;
2285 case LOOP_CTL_GET_FREE:
2286 ret = loop_lookup(&lo, -1);
2287 if (ret >= 0)
2288 break;
2289 ret = loop_add(&lo, -1);
2290 }
Jan Kara0a42e992018-11-08 14:01:04 +01002291 mutex_unlock(&loop_ctl_mutex);
Kay Sievers770fe302011-07-31 22:08:04 +02002292
2293 return ret;
2294}
2295
2296static const struct file_operations loop_ctl_fops = {
2297 .open = nonseekable_open,
2298 .unlocked_ioctl = loop_control_ioctl,
2299 .compat_ioctl = loop_control_ioctl,
2300 .owner = THIS_MODULE,
2301 .llseek = noop_llseek,
2302};
2303
2304static struct miscdevice loop_misc = {
2305 .minor = LOOP_CTRL_MINOR,
2306 .name = "loop-control",
2307 .fops = &loop_ctl_fops,
2308};
2309
2310MODULE_ALIAS_MISCDEV(LOOP_CTRL_MINOR);
2311MODULE_ALIAS("devname:loop-control");
2312
Linus Torvalds1da177e2005-04-16 15:20:36 -07002313static int __init loop_init(void)
2314{
Ken Chena47653f2007-06-08 13:46:44 -07002315 int i, nr;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002316 struct loop_device *lo;
Kay Sievers770fe302011-07-31 22:08:04 +02002317 int err;
Ken Chena47653f2007-06-08 13:46:44 -07002318
Laurent Vivier476a4812008-03-26 12:11:53 +01002319 part_shift = 0;
Namhyung Kimac04fee2011-05-27 07:59:25 +02002320 if (max_part > 0) {
Laurent Vivier476a4812008-03-26 12:11:53 +01002321 part_shift = fls(max_part);
2322
Namhyung Kimac04fee2011-05-27 07:59:25 +02002323 /*
2324 * Adjust max_part according to part_shift as it is exported
2325 * to user space so that user can decide correct minor number
2326 * if [s]he want to create more devices.
2327 *
2328 * Note that -1 is required because partition 0 is reserved
2329 * for the whole disk.
2330 */
2331 max_part = (1UL << part_shift) - 1;
2332 }
2333
Guo Chaob1a66502013-02-21 15:16:49 -08002334 if ((1UL << part_shift) > DISK_MAX_PARTS) {
2335 err = -EINVAL;
Anton Volkova8c1d062017-08-07 15:37:50 +03002336 goto err_out;
Guo Chaob1a66502013-02-21 15:16:49 -08002337 }
Namhyung Kim78f4bb32011-05-24 16:48:54 +02002338
Guo Chaob1a66502013-02-21 15:16:49 -08002339 if (max_loop > 1UL << (MINORBITS - part_shift)) {
2340 err = -EINVAL;
Anton Volkova8c1d062017-08-07 15:37:50 +03002341 goto err_out;
Guo Chaob1a66502013-02-21 15:16:49 -08002342 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343
Kay Sieversd134b002011-07-31 22:08:04 +02002344 /*
2345 * If max_loop is specified, create that many devices upfront.
2346 * This also becomes a hard limit. If max_loop is not specified,
2347 * create CONFIG_BLK_DEV_LOOP_MIN_COUNT loop devices at module
2348 * init time. Loop devices can be requested on-demand with the
2349 * /dev/loop-control interface, or be instantiated by accessing
2350 * a 'dead' device node.
2351 */
Lukas Bulwahnaeb2b0b2020-12-12 06:13:02 +01002352 if (max_loop)
Ken Chena47653f2007-06-08 13:46:44 -07002353 nr = max_loop;
Lukas Bulwahnaeb2b0b2020-12-12 06:13:02 +01002354 else
Kay Sieversd134b002011-07-31 22:08:04 +02002355 nr = CONFIG_BLK_DEV_LOOP_MIN_COUNT;
Ken Chena47653f2007-06-08 13:46:44 -07002356
Anton Volkova8c1d062017-08-07 15:37:50 +03002357 err = misc_register(&loop_misc);
2358 if (err < 0)
2359 goto err_out;
2360
2361
Christoph Hellwig8410d382020-10-29 15:58:33 +01002362 if (__register_blkdev(LOOP_MAJOR, "loop", loop_probe)) {
Guo Chaob1a66502013-02-21 15:16:49 -08002363 err = -EIO;
2364 goto misc_out;
2365 }
Ken Chena47653f2007-06-08 13:46:44 -07002366
Kay Sieversd134b002011-07-31 22:08:04 +02002367 /* pre-create number of devices given by config or max_loop */
Jan Kara0a42e992018-11-08 14:01:04 +01002368 mutex_lock(&loop_ctl_mutex);
Kay Sievers34dd82a2011-07-31 22:08:04 +02002369 for (i = 0; i < nr; i++)
2370 loop_add(&lo, i);
Jan Kara0a42e992018-11-08 14:01:04 +01002371 mutex_unlock(&loop_ctl_mutex);
Kay Sievers34dd82a2011-07-31 22:08:04 +02002372
Ken Chen73285082007-05-08 00:28:20 -07002373 printk(KERN_INFO "loop: module loaded\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374 return 0;
Guo Chaob1a66502013-02-21 15:16:49 -08002375
2376misc_out:
2377 misc_deregister(&loop_misc);
Anton Volkova8c1d062017-08-07 15:37:50 +03002378err_out:
Guo Chaob1a66502013-02-21 15:16:49 -08002379 return err;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002380}
Ken Chena47653f2007-06-08 13:46:44 -07002381
Kay Sievers34dd82a2011-07-31 22:08:04 +02002382static int loop_exit_cb(int id, void *ptr, void *data)
2383{
2384 struct loop_device *lo = ptr;
Ken Chena47653f2007-06-08 13:46:44 -07002385
Kay Sievers34dd82a2011-07-31 22:08:04 +02002386 loop_remove(lo);
2387 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388}
2389
Ken Chen73285082007-05-08 00:28:20 -07002390static void __exit loop_exit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391{
Luis Chamberlain200f9332020-06-19 20:47:27 +00002392 mutex_lock(&loop_ctl_mutex);
2393
Kay Sievers34dd82a2011-07-31 22:08:04 +02002394 idr_for_each(&loop_index_idr, &loop_exit_cb, NULL);
Kay Sievers34dd82a2011-07-31 22:08:04 +02002395 idr_destroy(&loop_index_idr);
Ken Chen73285082007-05-08 00:28:20 -07002396
Akinobu Mita00d59402007-07-17 04:03:46 -07002397 unregister_blkdev(LOOP_MAJOR, "loop");
Kay Sievers770fe302011-07-31 22:08:04 +02002398
2399 misc_deregister(&loop_misc);
Luis Chamberlain200f9332020-06-19 20:47:27 +00002400
2401 mutex_unlock(&loop_ctl_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402}
2403
2404module_init(loop_init);
2405module_exit(loop_exit);
2406
2407#ifndef MODULE
2408static int __init max_loop_setup(char *str)
2409{
2410 max_loop = simple_strtol(str, NULL, 0);
2411 return 1;
2412}
2413
2414__setup("max_loop=", max_loop_setup);
2415#endif