blob: d6b6f434fd4bb7652faf597ef9ab6c7b6dd7c362 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/drivers/block/loop.c
3 *
4 * Written by Theodore Ts'o, 3/29/93
5 *
6 * Copyright 1993 by Theodore Ts'o. Redistribution of this file is
7 * permitted under the GNU General Public License.
8 *
9 * DES encryption plus some minor changes by Werner Almesberger, 30-MAY-1993
10 * more DES encryption plus IDEA encryption by Nicholas J. Leon, June 20, 1996
11 *
12 * Modularized and updated for 1.1.16 kernel - Mitch Dsouza 28th May 1994
13 * Adapted for 1.3.59 kernel - Andries Brouwer, 1 Feb 1996
14 *
15 * Fixed do_loop_request() re-entrancy - Vincent.Renardias@waw.com Mar 20, 1997
16 *
17 * Added devfs support - Richard Gooch <rgooch@atnf.csiro.au> 16-Jan-1998
18 *
19 * Handle sparse backing files correctly - Kenn Humborg, Jun 28, 1998
20 *
21 * Loadable modules and other fixes by AK, 1998
22 *
23 * Make real block number available to downstream transfer functions, enables
24 * CBC (and relatives) mode encryption requiring unique IVs per data block.
25 * Reed H. Petty, rhp@draper.net
26 *
27 * Maximum number of loop devices now dynamic via max_loop module parameter.
28 * Russell Kroll <rkroll@exploits.org> 19990701
29 *
30 * Maximum number of loop devices when compiled-in now selectable by passing
31 * max_loop=<1-255> to the kernel on boot.
Jan Engelhardt96de0e22007-10-19 23:21:04 +020032 * Erik I. Bolsø, <eriki@himolde.no>, Oct 31, 1999
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 *
34 * Completely rewrite request handling to be make_request_fn style and
35 * non blocking, pushing work to a helper thread. Lots of fixes from
36 * Al Viro too.
37 * Jens Axboe <axboe@suse.de>, Nov 2000
38 *
39 * Support up to 256 loop devices
40 * Heinz Mauelshagen <mge@sistina.com>, Feb 2002
41 *
42 * Support for falling back on the write file operation when the address space
Nick Piggin4e02ed42008-10-29 14:00:55 -070043 * operations write_begin is not available on the backing filesystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 * Anton Altaparmakov, 16 Feb 2005
45 *
46 * Still To Fix:
47 * - Advisory locking is ignored here.
48 * - Should use an own CAP_* category instead of CAP_SYS_ADMIN
49 *
50 */
51
Linus Torvalds1da177e2005-04-16 15:20:36 -070052#include <linux/module.h>
53#include <linux/moduleparam.h>
54#include <linux/sched.h>
55#include <linux/fs.h>
56#include <linux/file.h>
57#include <linux/stat.h>
58#include <linux/errno.h>
59#include <linux/major.h>
60#include <linux/wait.h>
61#include <linux/blkdev.h>
62#include <linux/blkpg.h>
63#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070064#include <linux/swap.h>
65#include <linux/slab.h>
David Howells863d5b822006-08-29 19:06:14 +010066#include <linux/compat.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#include <linux/suspend.h>
Rafael J. Wysocki83144182007-07-17 04:03:35 -070068#include <linux/freezer.h>
Arnd Bergmann2a48fc02010-06-02 14:28:52 +020069#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070070#include <linux/writeback.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070071#include <linux/completion.h>
72#include <linux/highmem.h>
Serge E. Hallyn6c997912006-09-29 01:59:11 -070073#include <linux/kthread.h>
Jens Axboed6b29d72007-06-04 09:59:47 +020074#include <linux/splice.h>
Milan Brozee862732010-08-23 15:16:00 +020075#include <linux/sysfs.h>
Kay Sievers770fe302011-07-31 22:08:04 +020076#include <linux/miscdevice.h>
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +020077#include <linux/falloc.h>
Al Viro283e7e52015-04-03 15:21:59 -040078#include <linux/uio.h>
Adam Manzanaresd9a08a92018-05-22 10:52:19 -070079#include <linux/ioprio.h>
80
Al Viro83a87612013-05-12 10:14:07 -040081#include "loop.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080083#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
Kay Sievers34dd82a2011-07-31 22:08:04 +020085static DEFINE_IDR(loop_index_idr);
86static DEFINE_MUTEX(loop_index_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
Laurent Vivier476a4812008-03-26 12:11:53 +010088static int max_part;
89static int part_shift;
90
Linus Torvalds1da177e2005-04-16 15:20:36 -070091static int transfer_xor(struct loop_device *lo, int cmd,
92 struct page *raw_page, unsigned raw_off,
93 struct page *loop_page, unsigned loop_off,
94 int size, sector_t real_block)
95{
Cong Wangcfd80052011-11-25 23:14:18 +080096 char *raw_buf = kmap_atomic(raw_page) + raw_off;
97 char *loop_buf = kmap_atomic(loop_page) + loop_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 char *in, *out, *key;
99 int i, keysize;
100
101 if (cmd == READ) {
102 in = raw_buf;
103 out = loop_buf;
104 } else {
105 in = loop_buf;
106 out = raw_buf;
107 }
108
109 key = lo->lo_encrypt_key;
110 keysize = lo->lo_encrypt_key_size;
111 for (i = 0; i < size; i++)
112 *out++ = *in++ ^ key[(i & 511) % keysize];
113
Cong Wangcfd80052011-11-25 23:14:18 +0800114 kunmap_atomic(loop_buf);
115 kunmap_atomic(raw_buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 cond_resched();
117 return 0;
118}
119
120static int xor_init(struct loop_device *lo, const struct loop_info64 *info)
121{
122 if (unlikely(info->lo_encrypt_key_size <= 0))
123 return -EINVAL;
124 return 0;
125}
126
127static struct loop_func_table none_funcs = {
128 .number = LO_CRYPT_NONE,
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200129};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
131static struct loop_func_table xor_funcs = {
132 .number = LO_CRYPT_XOR,
133 .transfer = transfer_xor,
134 .init = xor_init
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200135};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
137/* xfer_funcs[0] is special - its release function is never called */
138static struct loop_func_table *xfer_funcs[MAX_LO_CRYPT] = {
139 &none_funcs,
140 &xor_funcs
141};
142
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100143static loff_t get_size(loff_t offset, loff_t sizelimit, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144{
Guo Chaob7a1da62013-02-21 15:16:50 -0800145 loff_t loopsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
147 /* Compute loopsize in bytes */
Guo Chaob7a1da62013-02-21 15:16:50 -0800148 loopsize = i_size_read(file->f_mapping->host);
149 if (offset > 0)
150 loopsize -= offset;
151 /* offset is beyond i_size, weird but possible */
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100152 if (loopsize < 0)
153 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100155 if (sizelimit > 0 && sizelimit < loopsize)
156 loopsize = sizelimit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 /*
158 * Unfortunately, if we want to do I/O on the device,
159 * the number of 512-byte sectors has to fit into a sector_t.
160 */
161 return loopsize >> 9;
162}
163
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100164static loff_t get_loop_size(struct loop_device *lo, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165{
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100166 return get_size(lo->lo_offset, lo->lo_sizelimit, file);
167}
168
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800169static void __loop_update_dio(struct loop_device *lo, bool dio)
170{
171 struct file *file = lo->lo_backing_file;
172 struct address_space *mapping = file->f_mapping;
173 struct inode *inode = mapping->host;
174 unsigned short sb_bsize = 0;
175 unsigned dio_align = 0;
176 bool use_dio;
177
178 if (inode->i_sb->s_bdev) {
179 sb_bsize = bdev_logical_block_size(inode->i_sb->s_bdev);
180 dio_align = sb_bsize - 1;
181 }
182
183 /*
184 * We support direct I/O only if lo_offset is aligned with the
185 * logical I/O size of backing device, and the logical block
186 * size of loop is bigger than the backing device's and the loop
187 * needn't transform transfer.
188 *
189 * TODO: the above condition may be loosed in the future, and
190 * direct I/O may be switched runtime at that time because most
Masahiro Yamada89d790a2017-02-27 14:29:01 -0800191 * of requests in sane applications should be PAGE_SIZE aligned
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800192 */
193 if (dio) {
194 if (queue_logical_block_size(lo->lo_queue) >= sb_bsize &&
195 !(lo->lo_offset & dio_align) &&
196 mapping->a_ops->direct_IO &&
197 !lo->transfer)
198 use_dio = true;
199 else
200 use_dio = false;
201 } else {
202 use_dio = false;
203 }
204
205 if (lo->use_dio == use_dio)
206 return;
207
208 /* flush dirty pages before changing direct IO */
209 vfs_fsync(file, 0);
210
211 /*
212 * The flag of LO_FLAGS_DIRECT_IO is handled similarly with
213 * LO_FLAGS_READ_ONLY, both are set from kernel, and losetup
214 * will get updated by ioctl(LOOP_GET_STATUS)
215 */
216 blk_mq_freeze_queue(lo->lo_queue);
217 lo->use_dio = use_dio;
Shaohua Li40326d82017-08-31 22:09:46 -0700218 if (use_dio) {
Bart Van Assche8b904b52018-03-07 17:10:10 -0800219 blk_queue_flag_clear(QUEUE_FLAG_NOMERGES, lo->lo_queue);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800220 lo->lo_flags |= LO_FLAGS_DIRECT_IO;
Shaohua Li40326d82017-08-31 22:09:46 -0700221 } else {
Bart Van Assche8b904b52018-03-07 17:10:10 -0800222 blk_queue_flag_set(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 }
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800225 blk_mq_unfreeze_queue(lo->lo_queue);
226}
227
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100228static int
Omar Sandoval1e6ec9e2017-08-23 14:54:59 -0700229figure_loop_size(struct loop_device *lo, loff_t offset, loff_t sizelimit)
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100230{
231 loff_t size = get_size(offset, sizelimit, lo->lo_backing_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 sector_t x = (sector_t)size;
Guo Chao7b0576a2013-02-21 15:16:47 -0800233 struct block_device *bdev = lo->lo_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
235 if (unlikely((loff_t)x != size))
236 return -EFBIG;
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100237 if (lo->lo_offset != offset)
238 lo->lo_offset = offset;
239 if (lo->lo_sizelimit != sizelimit)
240 lo->lo_sizelimit = sizelimit;
Ken Chen73285082007-05-08 00:28:20 -0700241 set_capacity(lo->lo_disk, x);
Guo Chao7b0576a2013-02-21 15:16:47 -0800242 bd_set_size(bdev, (loff_t)get_capacity(bdev->bd_disk) << 9);
243 /* let user-space know about the new size */
244 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100245 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246}
247
248static inline int
249lo_do_transfer(struct loop_device *lo, int cmd,
250 struct page *rpage, unsigned roffs,
251 struct page *lpage, unsigned loffs,
252 int size, sector_t rblock)
253{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200254 int ret;
255
256 ret = lo->transfer(lo, cmd, rpage, roffs, lpage, loffs, size, rblock);
257 if (likely(!ret))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 return 0;
259
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200260 printk_ratelimited(KERN_ERR
261 "loop: Transfer error at byte offset %llu, length %i.\n",
262 (unsigned long long)rblock << 9, size);
263 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264}
265
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200266static int lo_write_bvec(struct file *file, struct bio_vec *bvec, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200268 struct iov_iter i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 ssize_t bw;
Al Viro283e7e52015-04-03 15:21:59 -0400270
Ross Zwisler1d037572018-03-09 08:36:36 -0700271 iov_iter_bvec(&i, ITER_BVEC | WRITE, bvec, 1, bvec->bv_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
Al Viro03d95eb2013-03-20 13:04:20 -0400273 file_start_write(file);
Christoph Hellwigabbb65892017-05-27 11:16:52 +0300274 bw = vfs_iter_write(file, &i, ppos, 0);
Al Viro03d95eb2013-03-20 13:04:20 -0400275 file_end_write(file);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200276
277 if (likely(bw == bvec->bv_len))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 return 0;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200279
280 printk_ratelimited(KERN_ERR
281 "loop: Write error at byte offset %llu, length %i.\n",
282 (unsigned long long)*ppos, bvec->bv_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 if (bw >= 0)
284 bw = -EIO;
285 return bw;
286}
287
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200288static int lo_write_simple(struct loop_device *lo, struct request *rq,
289 loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200291 struct bio_vec bvec;
292 struct req_iterator iter;
293 int ret = 0;
294
295 rq_for_each_segment(bvec, rq, iter) {
296 ret = lo_write_bvec(lo->lo_backing_file, &bvec, &pos);
297 if (ret < 0)
298 break;
299 cond_resched();
300 }
301
302 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303}
304
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200305/*
Christoph Hellwig456be142011-10-17 12:57:20 +0200306 * This is the slow, transforming version that needs to double buffer the
307 * data as it cannot do the transformations in place without having direct
308 * access to the destination pages of the backing file.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 */
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200310static int lo_write_transfer(struct loop_device *lo, struct request *rq,
311 loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200313 struct bio_vec bvec, b;
Ming Lei30112012014-12-31 13:22:58 +0000314 struct req_iterator iter;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200315 struct page *page;
Kent Overstreet79886132013-11-23 17:19:00 -0800316 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200318 page = alloc_page(GFP_NOIO);
319 if (unlikely(!page))
320 return -ENOMEM;
Christoph Hellwig456be142011-10-17 12:57:20 +0200321
Ming Lei30112012014-12-31 13:22:58 +0000322 rq_for_each_segment(bvec, rq, iter) {
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200323 ret = lo_do_transfer(lo, WRITE, page, 0, bvec.bv_page,
324 bvec.bv_offset, bvec.bv_len, pos >> 9);
325 if (unlikely(ret))
326 break;
327
328 b.bv_page = page;
329 b.bv_offset = 0;
330 b.bv_len = bvec.bv_len;
331 ret = lo_write_bvec(lo->lo_backing_file, &b, &pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 if (ret < 0)
333 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 }
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200335
336 __free_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338}
339
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200340static int lo_read_simple(struct loop_device *lo, struct request *rq,
341 loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342{
Kent Overstreet79886132013-11-23 17:19:00 -0800343 struct bio_vec bvec;
Ming Lei30112012014-12-31 13:22:58 +0000344 struct req_iterator iter;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200345 struct iov_iter i;
346 ssize_t len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
Ming Lei30112012014-12-31 13:22:58 +0000348 rq_for_each_segment(bvec, rq, iter) {
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200349 iov_iter_bvec(&i, ITER_BVEC, &bvec, 1, bvec.bv_len);
Christoph Hellwig18e97102017-05-27 11:16:51 +0300350 len = vfs_iter_read(lo->lo_backing_file, &i, &pos, 0);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200351 if (len < 0)
352 return len;
Dave Young306df072012-02-08 22:07:19 +0100353
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200354 flush_dcache_page(bvec.bv_page);
355
356 if (len != bvec.bv_len) {
Ming Lei30112012014-12-31 13:22:58 +0000357 struct bio *bio;
358
359 __rq_for_each_bio(bio, rq)
360 zero_fill_bio(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 break;
Dave Young306df072012-02-08 22:07:19 +0100362 }
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200363 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 }
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200365
Dave Young306df072012-02-08 22:07:19 +0100366 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367}
368
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200369static int lo_read_transfer(struct loop_device *lo, struct request *rq,
370 loff_t pos)
371{
372 struct bio_vec bvec, b;
373 struct req_iterator iter;
374 struct iov_iter i;
375 struct page *page;
376 ssize_t len;
377 int ret = 0;
378
379 page = alloc_page(GFP_NOIO);
380 if (unlikely(!page))
381 return -ENOMEM;
382
383 rq_for_each_segment(bvec, rq, iter) {
384 loff_t offset = pos;
385
386 b.bv_page = page;
387 b.bv_offset = 0;
388 b.bv_len = bvec.bv_len;
389
390 iov_iter_bvec(&i, ITER_BVEC, &b, 1, b.bv_len);
Christoph Hellwig18e97102017-05-27 11:16:51 +0300391 len = vfs_iter_read(lo->lo_backing_file, &i, &pos, 0);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200392 if (len < 0) {
393 ret = len;
394 goto out_free_page;
395 }
396
397 ret = lo_do_transfer(lo, READ, page, 0, bvec.bv_page,
398 bvec.bv_offset, len, offset >> 9);
399 if (ret)
400 goto out_free_page;
401
402 flush_dcache_page(bvec.bv_page);
403
404 if (len != bvec.bv_len) {
405 struct bio *bio;
406
407 __rq_for_each_bio(bio, rq)
408 zero_fill_bio(bio);
409 break;
410 }
411 }
412
413 ret = 0;
414out_free_page:
415 __free_page(page);
416 return ret;
417}
418
Ming Leicf655d92014-12-31 13:22:59 +0000419static int lo_discard(struct loop_device *lo, struct request *rq, loff_t pos)
420{
421 /*
422 * We use punch hole to reclaim the free space used by the
423 * image a.k.a. discard. However we do not support discard if
424 * encryption is enabled, because it may give an attacker
425 * useful information.
426 */
427 struct file *file = lo->lo_backing_file;
428 int mode = FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE;
429 int ret;
430
431 if ((!file->f_op->fallocate) || lo->lo_encrypt_key_size) {
432 ret = -EOPNOTSUPP;
433 goto out;
434 }
435
436 ret = file->f_op->fallocate(file, mode, pos, blk_rq_bytes(rq));
437 if (unlikely(ret && ret != -EINVAL && ret != -EOPNOTSUPP))
438 ret = -EIO;
439 out:
440 return ret;
441}
442
443static int lo_req_flush(struct loop_device *lo, struct request *rq)
444{
445 struct file *file = lo->lo_backing_file;
446 int ret = vfs_fsync(file, 0);
447 if (unlikely(ret && ret != -EINVAL))
448 ret = -EIO;
449
450 return ret;
451}
452
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200453static void lo_complete_rq(struct request *rq)
Ming Leibc07c102015-08-17 10:31:51 +0800454{
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200455 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
Jens Axboef9de14b2018-04-13 16:25:57 -0600456 blk_status_t ret = BLK_STS_OK;
Ming Leibc07c102015-08-17 10:31:51 +0800457
Jens Axboef9de14b2018-04-13 16:25:57 -0600458 if (!cmd->use_aio || cmd->ret < 0 || cmd->ret == blk_rq_bytes(rq) ||
459 req_op(rq) != REQ_OP_READ) {
460 if (cmd->ret < 0)
461 ret = BLK_STS_IOERR;
462 goto end_io;
Ming Leibc07c102015-08-17 10:31:51 +0800463 }
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200464
Jens Axboef9de14b2018-04-13 16:25:57 -0600465 /*
466 * Short READ - if we got some data, advance our request and
467 * retry it. If we got no data, end the rest with EIO.
468 */
469 if (cmd->ret) {
470 blk_update_request(rq, BLK_STS_OK, cmd->ret);
471 cmd->ret = 0;
472 blk_mq_requeue_request(rq, true);
473 } else {
474 if (cmd->use_aio) {
475 struct bio *bio = rq->bio;
476
477 while (bio) {
478 zero_fill_bio(bio);
479 bio = bio->bi_next;
480 }
481 }
482 ret = BLK_STS_IOERR;
483end_io:
484 blk_mq_end_request(rq, ret);
485 }
Ming Leibc07c102015-08-17 10:31:51 +0800486}
487
Shaohua Li92d77332017-09-01 11:15:17 -0700488static void lo_rw_aio_do_completion(struct loop_cmd *cmd)
489{
Jens Axboe1894e912018-04-13 16:24:29 -0600490 struct request *rq = blk_mq_rq_from_pdu(cmd);
491
Shaohua Li92d77332017-09-01 11:15:17 -0700492 if (!atomic_dec_and_test(&cmd->ref))
493 return;
494 kfree(cmd->bvec);
495 cmd->bvec = NULL;
Jens Axboe1894e912018-04-13 16:24:29 -0600496 blk_mq_complete_request(rq);
Shaohua Li92d77332017-09-01 11:15:17 -0700497}
498
Ming Leibc07c102015-08-17 10:31:51 +0800499static void lo_rw_aio_complete(struct kiocb *iocb, long ret, long ret2)
500{
501 struct loop_cmd *cmd = container_of(iocb, struct loop_cmd, iocb);
Ming Leibc07c102015-08-17 10:31:51 +0800502
Shaohua Lid4478e92017-09-25 13:07:22 -0600503 if (cmd->css)
504 css_put(cmd->css);
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200505 cmd->ret = ret;
Shaohua Li92d77332017-09-01 11:15:17 -0700506 lo_rw_aio_do_completion(cmd);
Ming Leibc07c102015-08-17 10:31:51 +0800507}
508
509static int lo_rw_aio(struct loop_device *lo, struct loop_cmd *cmd,
510 loff_t pos, bool rw)
511{
512 struct iov_iter iter;
513 struct bio_vec *bvec;
Jens Axboe1894e912018-04-13 16:24:29 -0600514 struct request *rq = blk_mq_rq_from_pdu(cmd);
Shaohua Li40326d82017-08-31 22:09:46 -0700515 struct bio *bio = rq->bio;
Ming Leibc07c102015-08-17 10:31:51 +0800516 struct file *file = lo->lo_backing_file;
Shaohua Li40326d82017-08-31 22:09:46 -0700517 unsigned int offset;
518 int segments = 0;
Ming Leibc07c102015-08-17 10:31:51 +0800519 int ret;
520
Shaohua Li40326d82017-08-31 22:09:46 -0700521 if (rq->bio != rq->biotail) {
522 struct req_iterator iter;
523 struct bio_vec tmp;
Ming Leibc07c102015-08-17 10:31:51 +0800524
Shaohua Li40326d82017-08-31 22:09:46 -0700525 __rq_for_each_bio(bio, rq)
526 segments += bio_segments(bio);
Kees Cook6da2ec52018-06-12 13:55:00 -0700527 bvec = kmalloc_array(segments, sizeof(struct bio_vec),
528 GFP_NOIO);
Shaohua Li40326d82017-08-31 22:09:46 -0700529 if (!bvec)
530 return -EIO;
531 cmd->bvec = bvec;
532
533 /*
534 * The bios of the request may be started from the middle of
535 * the 'bvec' because of bio splitting, so we can't directly
536 * copy bio->bi_iov_vec to new bvec. The rq_for_each_segment
537 * API will take care of all details for us.
538 */
539 rq_for_each_segment(tmp, rq, iter) {
540 *bvec = tmp;
541 bvec++;
542 }
543 bvec = cmd->bvec;
544 offset = 0;
545 } else {
546 /*
547 * Same here, this bio may be started from the middle of the
548 * 'bvec' because of bio splitting, so offset from the bvec
549 * must be passed to iov iterator
550 */
551 offset = bio->bi_iter.bi_bvec_done;
552 bvec = __bvec_iter_bvec(bio->bi_io_vec, bio->bi_iter);
553 segments = bio_segments(bio);
554 }
Shaohua Li92d77332017-09-01 11:15:17 -0700555 atomic_set(&cmd->ref, 2);
Shaohua Li40326d82017-08-31 22:09:46 -0700556
Ming Leibc07c102015-08-17 10:31:51 +0800557 iov_iter_bvec(&iter, ITER_BVEC | rw, bvec,
Shaohua Li40326d82017-08-31 22:09:46 -0700558 segments, blk_rq_bytes(rq));
559 iter.iov_offset = offset;
Ming Leibc07c102015-08-17 10:31:51 +0800560
561 cmd->iocb.ki_pos = pos;
562 cmd->iocb.ki_filp = file;
563 cmd->iocb.ki_complete = lo_rw_aio_complete;
564 cmd->iocb.ki_flags = IOCB_DIRECT;
Adam Manzanaresd9a08a92018-05-22 10:52:19 -0700565 cmd->iocb.ki_ioprio = IOPRIO_PRIO_VALUE(IOPRIO_CLASS_NONE, 0);
Shaohua Lid4478e92017-09-25 13:07:22 -0600566 if (cmd->css)
567 kthread_associate_blkcg(cmd->css);
Ming Leibc07c102015-08-17 10:31:51 +0800568
569 if (rw == WRITE)
Miklos Szeredibb7462b2017-02-20 16:51:23 +0100570 ret = call_write_iter(file, &cmd->iocb, &iter);
Ming Leibc07c102015-08-17 10:31:51 +0800571 else
Miklos Szeredibb7462b2017-02-20 16:51:23 +0100572 ret = call_read_iter(file, &cmd->iocb, &iter);
Ming Leibc07c102015-08-17 10:31:51 +0800573
Shaohua Li92d77332017-09-01 11:15:17 -0700574 lo_rw_aio_do_completion(cmd);
Shaohua Lid4478e92017-09-25 13:07:22 -0600575 kthread_associate_blkcg(NULL);
Shaohua Li92d77332017-09-01 11:15:17 -0700576
Ming Leibc07c102015-08-17 10:31:51 +0800577 if (ret != -EIOCBQUEUED)
578 cmd->iocb.ki_complete(&cmd->iocb, ret, 0);
579 return 0;
580}
581
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200582static int do_req_filebacked(struct loop_device *lo, struct request *rq)
Ming Leibc07c102015-08-17 10:31:51 +0800583{
584 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200585 loff_t pos = ((loff_t) blk_rq_pos(rq) << 9) + lo->lo_offset;
Ming Leibc07c102015-08-17 10:31:51 +0800586
587 /*
588 * lo_write_simple and lo_read_simple should have been covered
589 * by io submit style function like lo_rw_aio(), one blocker
590 * is that lo_read_simple() need to call flush_dcache_page after
591 * the page is written from kernel, and it isn't easy to handle
592 * this in io submit style function which submits all segments
593 * of the req at one time. And direct read IO doesn't need to
594 * run flush_dcache_page().
595 */
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200596 switch (req_op(rq)) {
597 case REQ_OP_FLUSH:
598 return lo_req_flush(lo, rq);
599 case REQ_OP_DISCARD:
Christoph Hellwig19372e22017-04-05 19:21:15 +0200600 case REQ_OP_WRITE_ZEROES:
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200601 return lo_discard(lo, rq, pos);
602 case REQ_OP_WRITE:
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200603 if (lo->transfer)
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200604 return lo_write_transfer(lo, rq, pos);
605 else if (cmd->use_aio)
606 return lo_rw_aio(lo, cmd, pos, WRITE);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200607 else
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200608 return lo_write_simple(lo, rq, pos);
609 case REQ_OP_READ:
610 if (lo->transfer)
611 return lo_read_transfer(lo, rq, pos);
612 else if (cmd->use_aio)
613 return lo_rw_aio(lo, cmd, pos, READ);
614 else
615 return lo_read_simple(lo, rq, pos);
616 default:
617 WARN_ON_ONCE(1);
618 return -EIO;
619 break;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200620 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621}
622
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800623static inline void loop_update_dio(struct loop_device *lo)
624{
625 __loop_update_dio(lo, io_is_direct(lo->lo_backing_file) |
626 lo->use_dio);
627}
628
Ming Lei06f0e9e2015-05-06 12:26:24 +0800629static void loop_reread_partitions(struct loop_device *lo,
630 struct block_device *bdev)
631{
632 int rc;
633
634 /*
635 * bd_mutex has been held already in release path, so don't
636 * acquire it if this function is called in such case.
637 *
638 * If the reread partition isn't from release path, lo_refcnt
639 * must be at least one and it can only become zero when the
640 * current holder is released.
641 */
642 if (!atomic_read(&lo->lo_refcnt))
643 rc = __blkdev_reread_part(bdev);
644 else
645 rc = blkdev_reread_part(bdev);
646 if (rc)
647 pr_warn("%s: partition scan of loop%d (%s) failed (rc=%d)\n",
648 __func__, lo->lo_number, lo->lo_file_name, rc);
649}
650
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400651static inline int is_loop_device(struct file *file)
652{
653 struct inode *i = file->f_mapping->host;
654
655 return i && S_ISBLK(i->i_mode) && MAJOR(i->i_rdev) == LOOP_MAJOR;
656}
657
658static int loop_validate_file(struct file *file, struct block_device *bdev)
659{
660 struct inode *inode = file->f_mapping->host;
661 struct file *f = file;
662
663 /* Avoid recursion */
664 while (is_loop_device(f)) {
665 struct loop_device *l;
666
667 if (f->f_mapping->host->i_bdev == bdev)
668 return -EBADF;
669
670 l = f->f_mapping->host->i_bdev->bd_disk->private_data;
671 if (l->lo_state == Lo_unbound) {
672 return -EINVAL;
673 }
674 f = l->lo_backing_file;
675 }
676 if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
677 return -EINVAL;
678 return 0;
679}
680
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681/*
682 * loop_change_fd switched the backing store of a loopback device to
683 * a new file. This is useful for operating system installers to free up
684 * the original file and in High Availability environments to switch to
685 * an alternative location for the content in case of server meltdown.
686 * This can only work if the loop device is used read-only, and if the
687 * new backing store is the same size and type as the old backing store.
688 */
Al Virobb214882008-03-02 09:29:48 -0500689static int loop_change_fd(struct loop_device *lo, struct block_device *bdev,
690 unsigned int arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691{
692 struct file *file, *old_file;
693 struct inode *inode;
694 int error;
695
696 error = -ENXIO;
697 if (lo->lo_state != Lo_bound)
698 goto out;
699
700 /* the loop device has to be read-only */
701 error = -EINVAL;
702 if (!(lo->lo_flags & LO_FLAGS_READ_ONLY))
703 goto out;
704
705 error = -EBADF;
706 file = fget(arg);
707 if (!file)
708 goto out;
709
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400710 error = loop_validate_file(file, bdev);
711 if (error)
712 goto out_putf;
713
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 inode = file->f_mapping->host;
715 old_file = lo->lo_backing_file;
716
717 error = -EINVAL;
718
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 /* size of the new backing store needs to be the same */
720 if (get_loop_size(lo, file) != get_loop_size(lo, old_file))
721 goto out_putf;
722
723 /* and ... switch */
Omar Sandoval43cade802017-08-24 00:03:44 -0700724 blk_mq_freeze_queue(lo->lo_queue);
725 mapping_set_gfp_mask(old_file->f_mapping, lo->old_gfp_mask);
726 lo->lo_backing_file = file;
727 lo->old_gfp_mask = mapping_gfp_mask(file->f_mapping);
728 mapping_set_gfp_mask(file->f_mapping,
729 lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
730 loop_update_dio(lo);
731 blk_mq_unfreeze_queue(lo->lo_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732
733 fput(old_file);
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200734 if (lo->lo_flags & LO_FLAGS_PARTSCAN)
Ming Lei06f0e9e2015-05-06 12:26:24 +0800735 loop_reread_partitions(lo, bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 return 0;
737
738 out_putf:
739 fput(file);
740 out:
741 return error;
742}
743
Milan Brozee862732010-08-23 15:16:00 +0200744/* loop sysfs attributes */
745
746static ssize_t loop_attr_show(struct device *dev, char *page,
747 ssize_t (*callback)(struct loop_device *, char *))
748{
Kay Sievers34dd82a2011-07-31 22:08:04 +0200749 struct gendisk *disk = dev_to_disk(dev);
750 struct loop_device *lo = disk->private_data;
Milan Brozee862732010-08-23 15:16:00 +0200751
Kay Sievers34dd82a2011-07-31 22:08:04 +0200752 return callback(lo, page);
Milan Brozee862732010-08-23 15:16:00 +0200753}
754
755#define LOOP_ATTR_RO(_name) \
756static ssize_t loop_attr_##_name##_show(struct loop_device *, char *); \
757static ssize_t loop_attr_do_show_##_name(struct device *d, \
758 struct device_attribute *attr, char *b) \
759{ \
760 return loop_attr_show(d, b, loop_attr_##_name##_show); \
761} \
762static struct device_attribute loop_attr_##_name = \
Joe Perches5657a812018-05-24 13:38:59 -0600763 __ATTR(_name, 0444, loop_attr_do_show_##_name, NULL);
Milan Brozee862732010-08-23 15:16:00 +0200764
765static ssize_t loop_attr_backing_file_show(struct loop_device *lo, char *buf)
766{
767 ssize_t ret;
768 char *p = NULL;
769
Kay Sievers05eb0f22011-07-31 22:21:35 +0200770 spin_lock_irq(&lo->lo_lock);
Milan Brozee862732010-08-23 15:16:00 +0200771 if (lo->lo_backing_file)
Miklos Szeredi9bf39ab2015-06-19 10:29:13 +0200772 p = file_path(lo->lo_backing_file, buf, PAGE_SIZE - 1);
Kay Sievers05eb0f22011-07-31 22:21:35 +0200773 spin_unlock_irq(&lo->lo_lock);
Milan Brozee862732010-08-23 15:16:00 +0200774
775 if (IS_ERR_OR_NULL(p))
776 ret = PTR_ERR(p);
777 else {
778 ret = strlen(p);
779 memmove(buf, p, ret);
780 buf[ret++] = '\n';
781 buf[ret] = 0;
782 }
783
784 return ret;
785}
786
787static ssize_t loop_attr_offset_show(struct loop_device *lo, char *buf)
788{
789 return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_offset);
790}
791
792static ssize_t loop_attr_sizelimit_show(struct loop_device *lo, char *buf)
793{
794 return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_sizelimit);
795}
796
797static ssize_t loop_attr_autoclear_show(struct loop_device *lo, char *buf)
798{
799 int autoclear = (lo->lo_flags & LO_FLAGS_AUTOCLEAR);
800
801 return sprintf(buf, "%s\n", autoclear ? "1" : "0");
802}
803
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200804static ssize_t loop_attr_partscan_show(struct loop_device *lo, char *buf)
805{
806 int partscan = (lo->lo_flags & LO_FLAGS_PARTSCAN);
807
808 return sprintf(buf, "%s\n", partscan ? "1" : "0");
809}
810
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800811static ssize_t loop_attr_dio_show(struct loop_device *lo, char *buf)
812{
813 int dio = (lo->lo_flags & LO_FLAGS_DIRECT_IO);
814
815 return sprintf(buf, "%s\n", dio ? "1" : "0");
816}
817
Milan Brozee862732010-08-23 15:16:00 +0200818LOOP_ATTR_RO(backing_file);
819LOOP_ATTR_RO(offset);
820LOOP_ATTR_RO(sizelimit);
821LOOP_ATTR_RO(autoclear);
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200822LOOP_ATTR_RO(partscan);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800823LOOP_ATTR_RO(dio);
Milan Brozee862732010-08-23 15:16:00 +0200824
825static struct attribute *loop_attrs[] = {
826 &loop_attr_backing_file.attr,
827 &loop_attr_offset.attr,
828 &loop_attr_sizelimit.attr,
829 &loop_attr_autoclear.attr,
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200830 &loop_attr_partscan.attr,
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800831 &loop_attr_dio.attr,
Milan Brozee862732010-08-23 15:16:00 +0200832 NULL,
833};
834
835static struct attribute_group loop_attribute_group = {
836 .name = "loop",
837 .attrs= loop_attrs,
838};
839
Tetsuo Handad3349b62018-05-04 10:58:09 -0600840static void loop_sysfs_init(struct loop_device *lo)
Milan Brozee862732010-08-23 15:16:00 +0200841{
Tetsuo Handad3349b62018-05-04 10:58:09 -0600842 lo->sysfs_inited = !sysfs_create_group(&disk_to_dev(lo->lo_disk)->kobj,
843 &loop_attribute_group);
Milan Brozee862732010-08-23 15:16:00 +0200844}
845
846static void loop_sysfs_exit(struct loop_device *lo)
847{
Tetsuo Handad3349b62018-05-04 10:58:09 -0600848 if (lo->sysfs_inited)
849 sysfs_remove_group(&disk_to_dev(lo->lo_disk)->kobj,
850 &loop_attribute_group);
Milan Brozee862732010-08-23 15:16:00 +0200851}
852
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200853static void loop_config_discard(struct loop_device *lo)
854{
855 struct file *file = lo->lo_backing_file;
856 struct inode *inode = file->f_mapping->host;
857 struct request_queue *q = lo->lo_queue;
858
859 /*
860 * We use punch hole to reclaim the free space used by the
Olaf Hering12a64d22014-01-21 14:39:24 -0800861 * image a.k.a. discard. However we do not support discard if
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200862 * encryption is enabled, because it may give an attacker
863 * useful information.
864 */
865 if ((!file->f_op->fallocate) ||
866 lo->lo_encrypt_key_size) {
867 q->limits.discard_granularity = 0;
868 q->limits.discard_alignment = 0;
Jens Axboe2bb4cd52015-07-14 08:15:12 -0600869 blk_queue_max_discard_sectors(q, 0);
Christoph Hellwig19372e22017-04-05 19:21:15 +0200870 blk_queue_max_write_zeroes_sectors(q, 0);
Bart Van Assche8b904b52018-03-07 17:10:10 -0800871 blk_queue_flag_clear(QUEUE_FLAG_DISCARD, q);
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200872 return;
873 }
874
875 q->limits.discard_granularity = inode->i_sb->s_blocksize;
Lukas Czernerdfaf3c02011-12-02 14:47:03 +0100876 q->limits.discard_alignment = 0;
Hannes Reineckef2c6df72017-06-08 13:46:45 +0200877
Omar Sandoval1e6ec9e2017-08-23 14:54:59 -0700878 blk_queue_max_discard_sectors(q, UINT_MAX >> 9);
879 blk_queue_max_write_zeroes_sectors(q, UINT_MAX >> 9);
Bart Van Assche8b904b52018-03-07 17:10:10 -0800880 blk_queue_flag_set(QUEUE_FLAG_DISCARD, q);
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200881}
882
Ming Leie03a3d72015-08-17 10:31:48 +0800883static void loop_unprepare_queue(struct loop_device *lo)
884{
Petr Mladek39891442016-10-11 13:55:20 -0700885 kthread_flush_worker(&lo->worker);
Ming Leie03a3d72015-08-17 10:31:48 +0800886 kthread_stop(lo->worker_task);
887}
888
NeilBrownb2ee7d42017-06-16 15:02:09 +1000889static int loop_kthread_worker_fn(void *worker_ptr)
890{
891 current->flags |= PF_LESS_THROTTLE;
892 return kthread_worker_fn(worker_ptr);
893}
894
Ming Leie03a3d72015-08-17 10:31:48 +0800895static int loop_prepare_queue(struct loop_device *lo)
896{
Petr Mladek39891442016-10-11 13:55:20 -0700897 kthread_init_worker(&lo->worker);
NeilBrownb2ee7d42017-06-16 15:02:09 +1000898 lo->worker_task = kthread_run(loop_kthread_worker_fn,
Ming Leie03a3d72015-08-17 10:31:48 +0800899 &lo->worker, "loop%d", lo->lo_number);
900 if (IS_ERR(lo->worker_task))
901 return -ENOMEM;
902 set_user_nice(lo->worker_task, MIN_NICE);
903 return 0;
904}
905
Al Virobb214882008-03-02 09:29:48 -0500906static int loop_set_fd(struct loop_device *lo, fmode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 struct block_device *bdev, unsigned int arg)
908{
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400909 struct file *file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 struct inode *inode;
911 struct address_space *mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 int lo_flags = 0;
913 int error;
914 loff_t size;
915
916 /* This is safe, since we have a reference from open(). */
917 __module_get(THIS_MODULE);
918
919 error = -EBADF;
920 file = fget(arg);
921 if (!file)
922 goto out;
923
924 error = -EBUSY;
925 if (lo->lo_state != Lo_unbound)
926 goto out_putf;
927
Theodore Ts'od2ac8382018-05-07 11:37:58 -0400928 error = loop_validate_file(file, bdev);
929 if (error)
930 goto out_putf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931
932 mapping = file->f_mapping;
933 inode = mapping->host;
934
Christoph Hellwig456be142011-10-17 12:57:20 +0200935 if (!(file->f_mode & FMODE_WRITE) || !(mode & FMODE_WRITE) ||
Al Viro283e7e52015-04-03 15:21:59 -0400936 !file->f_op->write_iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 lo_flags |= LO_FLAGS_READ_ONLY;
938
Christoph Hellwig456be142011-10-17 12:57:20 +0200939 error = -EFBIG;
940 size = get_loop_size(lo, file);
941 if ((loff_t)(sector_t)size != size)
942 goto out_putf;
Ming Leie03a3d72015-08-17 10:31:48 +0800943 error = loop_prepare_queue(lo);
944 if (error)
Ming Leif4aa4c72015-05-05 19:49:54 +0800945 goto out_putf;
Christoph Hellwig456be142011-10-17 12:57:20 +0200946
947 error = 0;
948
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 set_device_ro(bdev, (lo_flags & LO_FLAGS_READ_ONLY) != 0);
950
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800951 lo->use_dio = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 lo->lo_device = bdev;
953 lo->lo_flags = lo_flags;
954 lo->lo_backing_file = file;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200955 lo->transfer = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 lo->ioctl = NULL;
957 lo->lo_sizelimit = 0;
958 lo->old_gfp_mask = mapping_gfp_mask(mapping);
959 mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
960
Nikanth Karthikesan68db1962009-03-24 12:29:54 +0100961 if (!(lo_flags & LO_FLAGS_READ_ONLY) && file->f_op->fsync)
Jens Axboe21d07272016-03-30 10:09:35 -0600962 blk_queue_write_cache(lo->lo_queue, true, false);
Nikanth Karthikesan68db1962009-03-24 12:29:54 +0100963
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800964 loop_update_dio(lo);
Ken Chen73285082007-05-08 00:28:20 -0700965 set_capacity(lo->lo_disk, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 bd_set_size(bdev, size << 9);
Milan Brozee862732010-08-23 15:16:00 +0200967 loop_sysfs_init(lo);
David Zeuthenc3473c62010-05-03 14:08:59 +0200968 /* let user-space know about the new size */
969 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970
Omar Sandoval8a0740c2017-08-24 00:03:41 -0700971 set_blocksize(bdev, S_ISBLK(inode->i_mode) ?
972 block_size(inode->i_bdev) : PAGE_SIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973
Serge E. Hallyn6c997912006-09-29 01:59:11 -0700974 lo->lo_state = Lo_bound;
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200975 if (part_shift)
976 lo->lo_flags |= LO_FLAGS_PARTSCAN;
977 if (lo->lo_flags & LO_FLAGS_PARTSCAN)
Ming Lei06f0e9e2015-05-06 12:26:24 +0800978 loop_reread_partitions(lo, bdev);
Anatol Pomozovc1681bf2013-04-01 09:47:56 -0700979
980 /* Grab the block_device to prevent its destruction after we
981 * put /dev/loopXX inode. Later in loop_clr_fd() we bdput(bdev).
982 */
983 bdgrab(bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 return 0;
985
986 out_putf:
987 fput(file);
988 out:
989 /* This is safe: open() is still holding a reference. */
990 module_put(THIS_MODULE);
991 return error;
992}
993
994static int
995loop_release_xfer(struct loop_device *lo)
996{
997 int err = 0;
998 struct loop_func_table *xfer = lo->lo_encryption;
999
1000 if (xfer) {
1001 if (xfer->release)
1002 err = xfer->release(lo);
1003 lo->transfer = NULL;
1004 lo->lo_encryption = NULL;
1005 module_put(xfer->owner);
1006 }
1007 return err;
1008}
1009
1010static int
1011loop_init_xfer(struct loop_device *lo, struct loop_func_table *xfer,
1012 const struct loop_info64 *i)
1013{
1014 int err = 0;
1015
1016 if (xfer) {
1017 struct module *owner = xfer->owner;
1018
1019 if (!try_module_get(owner))
1020 return -EINVAL;
1021 if (xfer->init)
1022 err = xfer->init(lo, i);
1023 if (err)
1024 module_put(owner);
1025 else
1026 lo->lo_encryption = xfer;
1027 }
1028 return err;
1029}
1030
Ayan George4c823cc2011-09-21 10:02:13 +02001031static int loop_clr_fd(struct loop_device *lo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032{
1033 struct file *filp = lo->lo_backing_file;
Al Virob4e3ca12005-10-21 03:22:34 -04001034 gfp_t gfp = lo->old_gfp_mask;
Ayan George4c823cc2011-09-21 10:02:13 +02001035 struct block_device *bdev = lo->lo_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036
1037 if (lo->lo_state != Lo_bound)
1038 return -ENXIO;
1039
Dave Chinnera1ecac32012-09-28 10:42:23 +02001040 /*
1041 * If we've explicitly asked to tear down the loop device,
1042 * and it has an elevated reference count, set it for auto-teardown when
1043 * the last reference goes away. This stops $!~#$@ udev from
1044 * preventing teardown because it decided that it needs to run blkid on
1045 * the loopback device whenever they appear. xfstests is notorious for
1046 * failing tests because blkid via udev races with a losetup
1047 * <dev>/do something like mkfs/losetup -d <dev> causing the losetup -d
1048 * command to fail with EBUSY.
1049 */
Ming Leif8933662015-05-06 12:26:23 +08001050 if (atomic_read(&lo->lo_refcnt) > 1) {
Dave Chinnera1ecac32012-09-28 10:42:23 +02001051 lo->lo_flags |= LO_FLAGS_AUTOCLEAR;
1052 mutex_unlock(&lo->lo_ctl_mutex);
1053 return 0;
1054 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055
1056 if (filp == NULL)
1057 return -EINVAL;
1058
Ming Leif8933662015-05-06 12:26:23 +08001059 /* freeze request queue during the transition */
1060 blk_mq_freeze_queue(lo->lo_queue);
1061
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 spin_lock_irq(&lo->lo_lock);
1063 lo->lo_state = Lo_rundown;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 lo->lo_backing_file = NULL;
Kay Sievers05eb0f22011-07-31 22:21:35 +02001065 spin_unlock_irq(&lo->lo_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066
1067 loop_release_xfer(lo);
1068 lo->transfer = NULL;
1069 lo->ioctl = NULL;
1070 lo->lo_device = NULL;
1071 lo->lo_encryption = NULL;
1072 lo->lo_offset = 0;
1073 lo->lo_sizelimit = 0;
1074 lo->lo_encrypt_key_size = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 memset(lo->lo_encrypt_key, 0, LO_KEY_SIZE);
1076 memset(lo->lo_crypt_name, 0, LO_NAME_SIZE);
1077 memset(lo->lo_file_name, 0, LO_NAME_SIZE);
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001078 blk_queue_logical_block_size(lo->lo_queue, 512);
Omar Sandovalbf093752017-09-05 14:24:47 -07001079 blk_queue_physical_block_size(lo->lo_queue, 512);
1080 blk_queue_io_min(lo->lo_queue, 512);
Anatol Pomozovc1681bf2013-04-01 09:47:56 -07001081 if (bdev) {
1082 bdput(bdev);
Al Virobb214882008-03-02 09:29:48 -05001083 invalidate_bdev(bdev);
Jeff Laytoneedffa22018-05-21 14:35:03 -04001084 bdev->bd_inode->i_mapping->wb_err = 0;
Anatol Pomozovc1681bf2013-04-01 09:47:56 -07001085 }
Ken Chen73285082007-05-08 00:28:20 -07001086 set_capacity(lo->lo_disk, 0);
Milan Broz51a0bb02010-10-27 19:51:30 -06001087 loop_sysfs_exit(lo);
David Zeuthenc3473c62010-05-03 14:08:59 +02001088 if (bdev) {
Al Virobb214882008-03-02 09:29:48 -05001089 bd_set_size(bdev, 0);
David Zeuthenc3473c62010-05-03 14:08:59 +02001090 /* let user-space know about this change */
1091 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
1092 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 mapping_set_gfp_mask(filp->f_mapping, gfp);
1094 lo->lo_state = Lo_unbound;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 /* This is safe: open() is still holding a reference. */
1096 module_put(THIS_MODULE);
Ming Leif8933662015-05-06 12:26:23 +08001097 blk_mq_unfreeze_queue(lo->lo_queue);
1098
Jens Axboec2fccc12013-04-08 10:12:11 +02001099 if (lo->lo_flags & LO_FLAGS_PARTSCAN && bdev)
Ming Lei06f0e9e2015-05-06 12:26:24 +08001100 loop_reread_partitions(lo, bdev);
Kay Sieverse03c8dd2011-08-23 20:12:04 +02001101 lo->lo_flags = 0;
1102 if (!part_shift)
1103 lo->lo_disk->flags |= GENHD_FL_NO_PART_SCAN;
Ming Leie03a3d72015-08-17 10:31:48 +08001104 loop_unprepare_queue(lo);
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001105 mutex_unlock(&lo->lo_ctl_mutex);
1106 /*
1107 * Need not hold lo_ctl_mutex to fput backing file.
1108 * Calling fput holding lo_ctl_mutex triggers a circular
1109 * lock dependency possibility warning as fput can take
1110 * bd_mutex which is usually taken before lo_ctl_mutex.
1111 */
1112 fput(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 return 0;
1114}
1115
1116static int
1117loop_set_status(struct loop_device *lo, const struct loop_info64 *info)
1118{
1119 int err;
1120 struct loop_func_table *xfer;
Eric W. Biedermane4849732012-02-11 11:23:51 -08001121 kuid_t uid = current_uid();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122
David Howellsb0fafa82008-11-14 10:38:41 +11001123 if (lo->lo_encrypt_key_size &&
Eric W. Biedermane4849732012-02-11 11:23:51 -08001124 !uid_eq(lo->lo_key_owner, uid) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 !capable(CAP_SYS_ADMIN))
1126 return -EPERM;
1127 if (lo->lo_state != Lo_bound)
1128 return -ENXIO;
1129 if ((unsigned int) info->lo_encrypt_key_size > LO_KEY_SIZE)
1130 return -EINVAL;
1131
Ming Leiecdd0952017-02-11 11:40:45 +08001132 /* I/O need to be drained during transfer transition */
1133 blk_mq_freeze_queue(lo->lo_queue);
1134
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 err = loop_release_xfer(lo);
1136 if (err)
Ming Leiecdd0952017-02-11 11:40:45 +08001137 goto exit;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138
1139 if (info->lo_encrypt_type) {
1140 unsigned int type = info->lo_encrypt_type;
1141
Tetsuo Handa1e047ea2018-04-06 10:03:17 +09001142 if (type >= MAX_LO_CRYPT) {
1143 err = -EINVAL;
1144 goto exit;
1145 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 xfer = xfer_funcs[type];
Tetsuo Handa1e047ea2018-04-06 10:03:17 +09001147 if (xfer == NULL) {
1148 err = -EINVAL;
1149 goto exit;
1150 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 } else
1152 xfer = NULL;
1153
1154 err = loop_init_xfer(lo, xfer, info);
1155 if (err)
Ming Leiecdd0952017-02-11 11:40:45 +08001156 goto exit;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157
1158 if (lo->lo_offset != info->lo_offset ||
Omar Sandoval1e6ec9e2017-08-23 14:54:59 -07001159 lo->lo_sizelimit != info->lo_sizelimit) {
1160 if (figure_loop_size(lo, info->lo_offset, info->lo_sizelimit)) {
Ming Leiecdd0952017-02-11 11:40:45 +08001161 err = -EFBIG;
1162 goto exit;
1163 }
Arnd Bergmannb040ad92017-06-09 12:19:18 +02001164 }
Guo Chao541c7422013-02-21 15:16:46 -08001165
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +02001166 loop_config_discard(lo);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167
1168 memcpy(lo->lo_file_name, info->lo_file_name, LO_NAME_SIZE);
1169 memcpy(lo->lo_crypt_name, info->lo_crypt_name, LO_NAME_SIZE);
1170 lo->lo_file_name[LO_NAME_SIZE-1] = 0;
1171 lo->lo_crypt_name[LO_NAME_SIZE-1] = 0;
1172
1173 if (!xfer)
1174 xfer = &none_funcs;
1175 lo->transfer = xfer->transfer;
1176 lo->ioctl = xfer->ioctl;
1177
David Woodhouse96c58652008-02-06 01:36:27 -08001178 if ((lo->lo_flags & LO_FLAGS_AUTOCLEAR) !=
1179 (info->lo_flags & LO_FLAGS_AUTOCLEAR))
1180 lo->lo_flags ^= LO_FLAGS_AUTOCLEAR;
1181
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 lo->lo_encrypt_key_size = info->lo_encrypt_key_size;
1183 lo->lo_init[0] = info->lo_init[0];
1184 lo->lo_init[1] = info->lo_init[1];
1185 if (info->lo_encrypt_key_size) {
1186 memcpy(lo->lo_encrypt_key, info->lo_encrypt_key,
1187 info->lo_encrypt_key_size);
David Howellsb0fafa82008-11-14 10:38:41 +11001188 lo->lo_key_owner = uid;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +02001189 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190
Ming Lei2e5ab5f2015-08-17 10:31:49 +08001191 /* update dio if lo_offset or transfer is changed */
1192 __loop_update_dio(lo, lo->use_dio);
1193
Ming Leiecdd0952017-02-11 11:40:45 +08001194 exit:
1195 blk_mq_unfreeze_queue(lo->lo_queue);
Omar Sandovale02898b42017-03-01 10:42:38 -08001196
1197 if (!err && (info->lo_flags & LO_FLAGS_PARTSCAN) &&
1198 !(lo->lo_flags & LO_FLAGS_PARTSCAN)) {
1199 lo->lo_flags |= LO_FLAGS_PARTSCAN;
1200 lo->lo_disk->flags &= ~GENHD_FL_NO_PART_SCAN;
1201 loop_reread_partitions(lo, lo->lo_device);
1202 }
1203
Ming Leiecdd0952017-02-11 11:40:45 +08001204 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205}
1206
1207static int
1208loop_get_status(struct loop_device *lo, struct loop_info64 *info)
1209{
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001210 struct file *file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 struct kstat stat;
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001212 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001214 if (lo->lo_state != Lo_bound) {
1215 mutex_unlock(&lo->lo_ctl_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 return -ENXIO;
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001217 }
1218
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 memset(info, 0, sizeof(*info));
1220 info->lo_number = lo->lo_number;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 info->lo_offset = lo->lo_offset;
1222 info->lo_sizelimit = lo->lo_sizelimit;
1223 info->lo_flags = lo->lo_flags;
1224 memcpy(info->lo_file_name, lo->lo_file_name, LO_NAME_SIZE);
1225 memcpy(info->lo_crypt_name, lo->lo_crypt_name, LO_NAME_SIZE);
1226 info->lo_encrypt_type =
1227 lo->lo_encryption ? lo->lo_encryption->number : 0;
1228 if (lo->lo_encrypt_key_size && capable(CAP_SYS_ADMIN)) {
1229 info->lo_encrypt_key_size = lo->lo_encrypt_key_size;
1230 memcpy(info->lo_encrypt_key, lo->lo_encrypt_key,
1231 lo->lo_encrypt_key_size);
1232 }
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001233
1234 /* Drop lo_ctl_mutex while we call into the filesystem. */
1235 file = get_file(lo->lo_backing_file);
1236 mutex_unlock(&lo->lo_ctl_mutex);
1237 ret = vfs_getattr(&file->f_path, &stat, STATX_INO,
1238 AT_STATX_SYNC_AS_STAT);
1239 if (!ret) {
1240 info->lo_device = huge_encode_dev(stat.dev);
1241 info->lo_inode = stat.ino;
1242 info->lo_rdevice = huge_encode_dev(stat.rdev);
1243 }
1244 fput(file);
1245 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246}
1247
1248static void
1249loop_info64_from_old(const struct loop_info *info, struct loop_info64 *info64)
1250{
1251 memset(info64, 0, sizeof(*info64));
1252 info64->lo_number = info->lo_number;
1253 info64->lo_device = info->lo_device;
1254 info64->lo_inode = info->lo_inode;
1255 info64->lo_rdevice = info->lo_rdevice;
1256 info64->lo_offset = info->lo_offset;
1257 info64->lo_sizelimit = 0;
1258 info64->lo_encrypt_type = info->lo_encrypt_type;
1259 info64->lo_encrypt_key_size = info->lo_encrypt_key_size;
1260 info64->lo_flags = info->lo_flags;
1261 info64->lo_init[0] = info->lo_init[0];
1262 info64->lo_init[1] = info->lo_init[1];
1263 if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1264 memcpy(info64->lo_crypt_name, info->lo_name, LO_NAME_SIZE);
1265 else
1266 memcpy(info64->lo_file_name, info->lo_name, LO_NAME_SIZE);
1267 memcpy(info64->lo_encrypt_key, info->lo_encrypt_key, LO_KEY_SIZE);
1268}
1269
1270static int
1271loop_info64_to_old(const struct loop_info64 *info64, struct loop_info *info)
1272{
1273 memset(info, 0, sizeof(*info));
1274 info->lo_number = info64->lo_number;
1275 info->lo_device = info64->lo_device;
1276 info->lo_inode = info64->lo_inode;
1277 info->lo_rdevice = info64->lo_rdevice;
1278 info->lo_offset = info64->lo_offset;
1279 info->lo_encrypt_type = info64->lo_encrypt_type;
1280 info->lo_encrypt_key_size = info64->lo_encrypt_key_size;
1281 info->lo_flags = info64->lo_flags;
1282 info->lo_init[0] = info64->lo_init[0];
1283 info->lo_init[1] = info64->lo_init[1];
1284 if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1285 memcpy(info->lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1286 else
1287 memcpy(info->lo_name, info64->lo_file_name, LO_NAME_SIZE);
1288 memcpy(info->lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1289
1290 /* error in case values were truncated */
1291 if (info->lo_device != info64->lo_device ||
1292 info->lo_rdevice != info64->lo_rdevice ||
1293 info->lo_inode != info64->lo_inode ||
1294 info->lo_offset != info64->lo_offset)
1295 return -EOVERFLOW;
1296
1297 return 0;
1298}
1299
1300static int
1301loop_set_status_old(struct loop_device *lo, const struct loop_info __user *arg)
1302{
1303 struct loop_info info;
1304 struct loop_info64 info64;
1305
1306 if (copy_from_user(&info, arg, sizeof (struct loop_info)))
1307 return -EFAULT;
1308 loop_info64_from_old(&info, &info64);
1309 return loop_set_status(lo, &info64);
1310}
1311
1312static int
1313loop_set_status64(struct loop_device *lo, const struct loop_info64 __user *arg)
1314{
1315 struct loop_info64 info64;
1316
1317 if (copy_from_user(&info64, arg, sizeof (struct loop_info64)))
1318 return -EFAULT;
1319 return loop_set_status(lo, &info64);
1320}
1321
1322static int
1323loop_get_status_old(struct loop_device *lo, struct loop_info __user *arg) {
1324 struct loop_info info;
1325 struct loop_info64 info64;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001326 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001328 if (!arg) {
1329 mutex_unlock(&lo->lo_ctl_mutex);
1330 return -EINVAL;
1331 }
1332 err = loop_get_status(lo, &info64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 if (!err)
1334 err = loop_info64_to_old(&info64, &info);
1335 if (!err && copy_to_user(arg, &info, sizeof(info)))
1336 err = -EFAULT;
1337
1338 return err;
1339}
1340
1341static int
1342loop_get_status64(struct loop_device *lo, struct loop_info64 __user *arg) {
1343 struct loop_info64 info64;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001344 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001346 if (!arg) {
1347 mutex_unlock(&lo->lo_ctl_mutex);
1348 return -EINVAL;
1349 }
1350 err = loop_get_status(lo, &info64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 if (!err && copy_to_user(arg, &info64, sizeof(info64)))
1352 err = -EFAULT;
1353
1354 return err;
1355}
1356
Hannes Reinecke51001b72017-06-08 13:46:44 +02001357static int loop_set_capacity(struct loop_device *lo)
J. R. Okajima53d66602009-03-31 15:23:43 -07001358{
J. R. Okajima53d66602009-03-31 15:23:43 -07001359 if (unlikely(lo->lo_state != Lo_bound))
Guo Chao7b0576a2013-02-21 15:16:47 -08001360 return -ENXIO;
J. R. Okajima53d66602009-03-31 15:23:43 -07001361
Omar Sandoval1e6ec9e2017-08-23 14:54:59 -07001362 return figure_loop_size(lo, lo->lo_offset, lo->lo_sizelimit);
J. R. Okajima53d66602009-03-31 15:23:43 -07001363}
1364
Ming Leiab1cb272015-08-17 10:31:50 +08001365static int loop_set_dio(struct loop_device *lo, unsigned long arg)
1366{
1367 int error = -ENXIO;
1368 if (lo->lo_state != Lo_bound)
1369 goto out;
1370
1371 __loop_update_dio(lo, !!arg);
1372 if (lo->use_dio == !!arg)
1373 return 0;
1374 error = -EINVAL;
1375 out:
1376 return error;
1377}
1378
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001379static int loop_set_block_size(struct loop_device *lo, unsigned long arg)
1380{
1381 if (lo->lo_state != Lo_bound)
1382 return -ENXIO;
1383
1384 if (arg < 512 || arg > PAGE_SIZE || !is_power_of_2(arg))
1385 return -EINVAL;
1386
1387 blk_mq_freeze_queue(lo->lo_queue);
1388
1389 blk_queue_logical_block_size(lo->lo_queue, arg);
Omar Sandovalbf093752017-09-05 14:24:47 -07001390 blk_queue_physical_block_size(lo->lo_queue, arg);
1391 blk_queue_io_min(lo->lo_queue, arg);
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001392 loop_update_dio(lo);
1393
1394 blk_mq_unfreeze_queue(lo->lo_queue);
1395
1396 return 0;
1397}
1398
Al Virobb214882008-03-02 09:29:48 -05001399static int lo_ioctl(struct block_device *bdev, fmode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 unsigned int cmd, unsigned long arg)
1401{
Al Virobb214882008-03-02 09:29:48 -05001402 struct loop_device *lo = bdev->bd_disk->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 int err;
1404
Omar Sandoval3148ffb2018-03-26 21:39:12 -07001405 err = mutex_lock_killable_nested(&lo->lo_ctl_mutex, 1);
1406 if (err)
1407 goto out_unlocked;
1408
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409 switch (cmd) {
1410 case LOOP_SET_FD:
Al Virobb214882008-03-02 09:29:48 -05001411 err = loop_set_fd(lo, mode, bdev, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412 break;
1413 case LOOP_CHANGE_FD:
Al Virobb214882008-03-02 09:29:48 -05001414 err = loop_change_fd(lo, bdev, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415 break;
1416 case LOOP_CLR_FD:
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001417 /* loop_clr_fd would have unlocked lo_ctl_mutex on success */
Ayan George4c823cc2011-09-21 10:02:13 +02001418 err = loop_clr_fd(lo);
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001419 if (!err)
1420 goto out_unlocked;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 break;
1422 case LOOP_SET_STATUS:
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +01001423 err = -EPERM;
1424 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1425 err = loop_set_status_old(lo,
1426 (struct loop_info __user *)arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 break;
1428 case LOOP_GET_STATUS:
1429 err = loop_get_status_old(lo, (struct loop_info __user *) arg);
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001430 /* loop_get_status() unlocks lo_ctl_mutex */
1431 goto out_unlocked;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 case LOOP_SET_STATUS64:
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +01001433 err = -EPERM;
1434 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1435 err = loop_set_status64(lo,
1436 (struct loop_info64 __user *) arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 break;
1438 case LOOP_GET_STATUS64:
1439 err = loop_get_status64(lo, (struct loop_info64 __user *) arg);
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001440 /* loop_get_status() unlocks lo_ctl_mutex */
1441 goto out_unlocked;
J. R. Okajima53d66602009-03-31 15:23:43 -07001442 case LOOP_SET_CAPACITY:
1443 err = -EPERM;
1444 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
Hannes Reinecke51001b72017-06-08 13:46:44 +02001445 err = loop_set_capacity(lo);
J. R. Okajima53d66602009-03-31 15:23:43 -07001446 break;
Ming Leiab1cb272015-08-17 10:31:50 +08001447 case LOOP_SET_DIRECT_IO:
1448 err = -EPERM;
1449 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1450 err = loop_set_dio(lo, arg);
1451 break;
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001452 case LOOP_SET_BLOCK_SIZE:
1453 err = -EPERM;
1454 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1455 err = loop_set_block_size(lo, arg);
1456 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 default:
1458 err = lo->ioctl ? lo->ioctl(lo, cmd, arg) : -EINVAL;
1459 }
Ingo Molnarf85221d2006-03-23 03:00:38 -08001460 mutex_unlock(&lo->lo_ctl_mutex);
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001461
1462out_unlocked:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 return err;
1464}
1465
David Howells863d5b822006-08-29 19:06:14 +01001466#ifdef CONFIG_COMPAT
1467struct compat_loop_info {
1468 compat_int_t lo_number; /* ioctl r/o */
1469 compat_dev_t lo_device; /* ioctl r/o */
1470 compat_ulong_t lo_inode; /* ioctl r/o */
1471 compat_dev_t lo_rdevice; /* ioctl r/o */
1472 compat_int_t lo_offset;
1473 compat_int_t lo_encrypt_type;
1474 compat_int_t lo_encrypt_key_size; /* ioctl w/o */
1475 compat_int_t lo_flags; /* ioctl r/o */
1476 char lo_name[LO_NAME_SIZE];
1477 unsigned char lo_encrypt_key[LO_KEY_SIZE]; /* ioctl w/o */
1478 compat_ulong_t lo_init[2];
1479 char reserved[4];
1480};
1481
1482/*
1483 * Transfer 32-bit compatibility structure in userspace to 64-bit loop info
1484 * - noinlined to reduce stack space usage in main part of driver
1485 */
1486static noinline int
Al Viroba674cf2006-10-10 22:48:27 +01001487loop_info64_from_compat(const struct compat_loop_info __user *arg,
David Howells863d5b822006-08-29 19:06:14 +01001488 struct loop_info64 *info64)
1489{
1490 struct compat_loop_info info;
1491
1492 if (copy_from_user(&info, arg, sizeof(info)))
1493 return -EFAULT;
1494
1495 memset(info64, 0, sizeof(*info64));
1496 info64->lo_number = info.lo_number;
1497 info64->lo_device = info.lo_device;
1498 info64->lo_inode = info.lo_inode;
1499 info64->lo_rdevice = info.lo_rdevice;
1500 info64->lo_offset = info.lo_offset;
1501 info64->lo_sizelimit = 0;
1502 info64->lo_encrypt_type = info.lo_encrypt_type;
1503 info64->lo_encrypt_key_size = info.lo_encrypt_key_size;
1504 info64->lo_flags = info.lo_flags;
1505 info64->lo_init[0] = info.lo_init[0];
1506 info64->lo_init[1] = info.lo_init[1];
1507 if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1508 memcpy(info64->lo_crypt_name, info.lo_name, LO_NAME_SIZE);
1509 else
1510 memcpy(info64->lo_file_name, info.lo_name, LO_NAME_SIZE);
1511 memcpy(info64->lo_encrypt_key, info.lo_encrypt_key, LO_KEY_SIZE);
1512 return 0;
1513}
1514
1515/*
1516 * Transfer 64-bit loop info to 32-bit compatibility structure in userspace
1517 * - noinlined to reduce stack space usage in main part of driver
1518 */
1519static noinline int
1520loop_info64_to_compat(const struct loop_info64 *info64,
1521 struct compat_loop_info __user *arg)
1522{
1523 struct compat_loop_info info;
1524
1525 memset(&info, 0, sizeof(info));
1526 info.lo_number = info64->lo_number;
1527 info.lo_device = info64->lo_device;
1528 info.lo_inode = info64->lo_inode;
1529 info.lo_rdevice = info64->lo_rdevice;
1530 info.lo_offset = info64->lo_offset;
1531 info.lo_encrypt_type = info64->lo_encrypt_type;
1532 info.lo_encrypt_key_size = info64->lo_encrypt_key_size;
1533 info.lo_flags = info64->lo_flags;
1534 info.lo_init[0] = info64->lo_init[0];
1535 info.lo_init[1] = info64->lo_init[1];
1536 if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1537 memcpy(info.lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1538 else
1539 memcpy(info.lo_name, info64->lo_file_name, LO_NAME_SIZE);
1540 memcpy(info.lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1541
1542 /* error in case values were truncated */
1543 if (info.lo_device != info64->lo_device ||
1544 info.lo_rdevice != info64->lo_rdevice ||
1545 info.lo_inode != info64->lo_inode ||
1546 info.lo_offset != info64->lo_offset ||
1547 info.lo_init[0] != info64->lo_init[0] ||
1548 info.lo_init[1] != info64->lo_init[1])
1549 return -EOVERFLOW;
1550
1551 if (copy_to_user(arg, &info, sizeof(info)))
1552 return -EFAULT;
1553 return 0;
1554}
1555
1556static int
1557loop_set_status_compat(struct loop_device *lo,
1558 const struct compat_loop_info __user *arg)
1559{
1560 struct loop_info64 info64;
1561 int ret;
1562
1563 ret = loop_info64_from_compat(arg, &info64);
1564 if (ret < 0)
1565 return ret;
1566 return loop_set_status(lo, &info64);
1567}
1568
1569static int
1570loop_get_status_compat(struct loop_device *lo,
1571 struct compat_loop_info __user *arg)
1572{
1573 struct loop_info64 info64;
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001574 int err;
David Howells863d5b822006-08-29 19:06:14 +01001575
Omar Sandovalbdac616db2018-04-06 09:57:03 -07001576 if (!arg) {
1577 mutex_unlock(&lo->lo_ctl_mutex);
1578 return -EINVAL;
1579 }
1580 err = loop_get_status(lo, &info64);
David Howells863d5b822006-08-29 19:06:14 +01001581 if (!err)
1582 err = loop_info64_to_compat(&info64, arg);
1583 return err;
1584}
1585
Al Virobb214882008-03-02 09:29:48 -05001586static int lo_compat_ioctl(struct block_device *bdev, fmode_t mode,
1587 unsigned int cmd, unsigned long arg)
David Howells863d5b822006-08-29 19:06:14 +01001588{
Al Virobb214882008-03-02 09:29:48 -05001589 struct loop_device *lo = bdev->bd_disk->private_data;
David Howells863d5b822006-08-29 19:06:14 +01001590 int err;
1591
David Howells863d5b822006-08-29 19:06:14 +01001592 switch(cmd) {
1593 case LOOP_SET_STATUS:
Omar Sandoval3148ffb2018-03-26 21:39:12 -07001594 err = mutex_lock_killable(&lo->lo_ctl_mutex);
1595 if (!err) {
1596 err = loop_set_status_compat(lo,
1597 (const struct compat_loop_info __user *)arg);
1598 mutex_unlock(&lo->lo_ctl_mutex);
1599 }
David Howells863d5b822006-08-29 19:06:14 +01001600 break;
1601 case LOOP_GET_STATUS:
Omar Sandoval3148ffb2018-03-26 21:39:12 -07001602 err = mutex_lock_killable(&lo->lo_ctl_mutex);
1603 if (!err) {
1604 err = loop_get_status_compat(lo,
1605 (struct compat_loop_info __user *)arg);
1606 /* loop_get_status() unlocks lo_ctl_mutex */
1607 }
David Howells863d5b822006-08-29 19:06:14 +01001608 break;
J. R. Okajima53d66602009-03-31 15:23:43 -07001609 case LOOP_SET_CAPACITY:
David Howells863d5b822006-08-29 19:06:14 +01001610 case LOOP_CLR_FD:
1611 case LOOP_GET_STATUS64:
1612 case LOOP_SET_STATUS64:
1613 arg = (unsigned long) compat_ptr(arg);
1614 case LOOP_SET_FD:
1615 case LOOP_CHANGE_FD:
Al Virobb214882008-03-02 09:29:48 -05001616 err = lo_ioctl(bdev, mode, cmd, arg);
David Howells863d5b822006-08-29 19:06:14 +01001617 break;
1618 default:
1619 err = -ENOIOCTLCMD;
1620 break;
1621 }
David Howells863d5b822006-08-29 19:06:14 +01001622 return err;
1623}
1624#endif
1625
Al Virobb214882008-03-02 09:29:48 -05001626static int lo_open(struct block_device *bdev, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627{
Kay Sievers770fe302011-07-31 22:08:04 +02001628 struct loop_device *lo;
1629 int err = 0;
1630
1631 mutex_lock(&loop_index_mutex);
1632 lo = bdev->bd_disk->private_data;
1633 if (!lo) {
1634 err = -ENXIO;
1635 goto out;
1636 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637
Ming Leif8933662015-05-06 12:26:23 +08001638 atomic_inc(&lo->lo_refcnt);
Kay Sievers770fe302011-07-31 22:08:04 +02001639out:
1640 mutex_unlock(&loop_index_mutex);
1641 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642}
1643
Linus Torvaldsae665012018-01-05 16:26:00 -08001644static void __lo_release(struct loop_device *lo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645{
Alexander Beregalovffcd7dc2009-04-07 13:48:21 +02001646 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647
Ming Leif8933662015-05-06 12:26:23 +08001648 if (atomic_dec_return(&lo->lo_refcnt))
1649 return;
1650
Ingo Molnarf85221d2006-03-23 03:00:38 -08001651 mutex_lock(&lo->lo_ctl_mutex);
Milan Broz14f27932008-12-12 14:48:27 +01001652 if (lo->lo_flags & LO_FLAGS_AUTOCLEAR) {
1653 /*
1654 * In autoclear mode, stop the loop thread
1655 * and remove configuration after last close.
1656 */
Ayan George4c823cc2011-09-21 10:02:13 +02001657 err = loop_clr_fd(lo);
Alexander Beregalovffcd7dc2009-04-07 13:48:21 +02001658 if (!err)
Al Virodb2a1442013-05-05 21:52:57 -04001659 return;
Omar Sandoval43cade802017-08-24 00:03:44 -07001660 } else if (lo->lo_state == Lo_bound) {
Milan Broz14f27932008-12-12 14:48:27 +01001661 /*
1662 * Otherwise keep thread (if running) and config,
1663 * but flush possible ongoing bios in thread.
1664 */
Omar Sandoval43cade802017-08-24 00:03:44 -07001665 blk_mq_freeze_queue(lo->lo_queue);
1666 blk_mq_unfreeze_queue(lo->lo_queue);
Milan Broz14f27932008-12-12 14:48:27 +01001667 }
David Woodhouse96c58652008-02-06 01:36:27 -08001668
Ingo Molnarf85221d2006-03-23 03:00:38 -08001669 mutex_unlock(&lo->lo_ctl_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670}
1671
Linus Torvaldsae665012018-01-05 16:26:00 -08001672static void lo_release(struct gendisk *disk, fmode_t mode)
1673{
1674 mutex_lock(&loop_index_mutex);
1675 __lo_release(disk->private_data);
1676 mutex_unlock(&loop_index_mutex);
1677}
1678
Alexey Dobriyan83d5cde2009-09-21 17:01:13 -07001679static const struct block_device_operations lo_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 .owner = THIS_MODULE,
Al Virobb214882008-03-02 09:29:48 -05001681 .open = lo_open,
1682 .release = lo_release,
1683 .ioctl = lo_ioctl,
David Howells863d5b822006-08-29 19:06:14 +01001684#ifdef CONFIG_COMPAT
Al Virobb214882008-03-02 09:29:48 -05001685 .compat_ioctl = lo_compat_ioctl,
David Howells863d5b822006-08-29 19:06:14 +01001686#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687};
1688
1689/*
1690 * And now the modules code and kernel interface.
1691 */
Ken Chen73285082007-05-08 00:28:20 -07001692static int max_loop;
Joe Perches5657a812018-05-24 13:38:59 -06001693module_param(max_loop, int, 0444);
Ken Chena47653f2007-06-08 13:46:44 -07001694MODULE_PARM_DESC(max_loop, "Maximum number of loop devices");
Joe Perches5657a812018-05-24 13:38:59 -06001695module_param(max_part, int, 0444);
Laurent Vivier476a4812008-03-26 12:11:53 +01001696MODULE_PARM_DESC(max_part, "Maximum number of partitions per loop device");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697MODULE_LICENSE("GPL");
1698MODULE_ALIAS_BLOCKDEV_MAJOR(LOOP_MAJOR);
1699
1700int loop_register_transfer(struct loop_func_table *funcs)
1701{
1702 unsigned int n = funcs->number;
1703
1704 if (n >= MAX_LO_CRYPT || xfer_funcs[n])
1705 return -EINVAL;
1706 xfer_funcs[n] = funcs;
1707 return 0;
1708}
1709
Kay Sievers34dd82a2011-07-31 22:08:04 +02001710static int unregister_transfer_cb(int id, void *ptr, void *data)
1711{
1712 struct loop_device *lo = ptr;
1713 struct loop_func_table *xfer = data;
1714
1715 mutex_lock(&lo->lo_ctl_mutex);
1716 if (lo->lo_encryption == xfer)
1717 loop_release_xfer(lo);
1718 mutex_unlock(&lo->lo_ctl_mutex);
1719 return 0;
1720}
1721
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722int loop_unregister_transfer(int number)
1723{
1724 unsigned int n = number;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725 struct loop_func_table *xfer;
1726
1727 if (n == 0 || n >= MAX_LO_CRYPT || (xfer = xfer_funcs[n]) == NULL)
1728 return -EINVAL;
1729
1730 xfer_funcs[n] = NULL;
Kay Sievers34dd82a2011-07-31 22:08:04 +02001731 idr_for_each(&loop_index_idr, &unregister_transfer_cb, xfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732 return 0;
1733}
1734
1735EXPORT_SYMBOL(loop_register_transfer);
1736EXPORT_SYMBOL(loop_unregister_transfer);
1737
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001738static blk_status_t loop_queue_rq(struct blk_mq_hw_ctx *hctx,
Ming Leib5dd2f62014-12-31 13:22:57 +00001739 const struct blk_mq_queue_data *bd)
1740{
Jens Axboe1894e912018-04-13 16:24:29 -06001741 struct request *rq = bd->rq;
1742 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
1743 struct loop_device *lo = rq->q->queuedata;
Ming Leib5dd2f62014-12-31 13:22:57 +00001744
Jens Axboe1894e912018-04-13 16:24:29 -06001745 blk_mq_start_request(rq);
Ming Leib5dd2f62014-12-31 13:22:57 +00001746
Ming Leif4aa4c72015-05-05 19:49:54 +08001747 if (lo->lo_state != Lo_bound)
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001748 return BLK_STS_IOERR;
Ming Leif4aa4c72015-05-05 19:49:54 +08001749
Jens Axboe1894e912018-04-13 16:24:29 -06001750 switch (req_op(rq)) {
Christoph Hellwigf0225ca2016-08-04 16:10:00 +02001751 case REQ_OP_FLUSH:
1752 case REQ_OP_DISCARD:
Christoph Hellwig19372e22017-04-05 19:21:15 +02001753 case REQ_OP_WRITE_ZEROES:
Ming Leibc07c102015-08-17 10:31:51 +08001754 cmd->use_aio = false;
Christoph Hellwigf0225ca2016-08-04 16:10:00 +02001755 break;
1756 default:
1757 cmd->use_aio = lo->use_dio;
1758 break;
1759 }
Ming Leibc07c102015-08-17 10:31:51 +08001760
Shaohua Lid4478e92017-09-25 13:07:22 -06001761 /* always use the first bio's css */
Shaohua Li0b508bc2017-09-26 11:02:12 -07001762#ifdef CONFIG_BLK_CGROUP
Jens Axboe1894e912018-04-13 16:24:29 -06001763 if (cmd->use_aio && rq->bio && rq->bio->bi_css) {
1764 cmd->css = rq->bio->bi_css;
Shaohua Lid4478e92017-09-25 13:07:22 -06001765 css_get(cmd->css);
1766 } else
1767#endif
1768 cmd->css = NULL;
Petr Mladek39891442016-10-11 13:55:20 -07001769 kthread_queue_work(&lo->worker, &cmd->work);
Ming Leib5dd2f62014-12-31 13:22:57 +00001770
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001771 return BLK_STS_OK;
Ming Leib5dd2f62014-12-31 13:22:57 +00001772}
1773
1774static void loop_handle_cmd(struct loop_cmd *cmd)
1775{
Jens Axboe1894e912018-04-13 16:24:29 -06001776 struct request *rq = blk_mq_rq_from_pdu(cmd);
1777 const bool write = op_is_write(req_op(rq));
1778 struct loop_device *lo = rq->q->queuedata;
Christoph Hellwigf4829a92015-09-27 21:01:50 +02001779 int ret = 0;
Ming Leib5dd2f62014-12-31 13:22:57 +00001780
Christoph Hellwigf4829a92015-09-27 21:01:50 +02001781 if (write && (lo->lo_flags & LO_FLAGS_READ_ONLY)) {
1782 ret = -EIO;
Ming Leib5dd2f62014-12-31 13:22:57 +00001783 goto failed;
Christoph Hellwigf4829a92015-09-27 21:01:50 +02001784 }
Ming Leib5dd2f62014-12-31 13:22:57 +00001785
Jens Axboe1894e912018-04-13 16:24:29 -06001786 ret = do_req_filebacked(lo, rq);
Ming Leib5dd2f62014-12-31 13:22:57 +00001787 failed:
Ming Leibc07c102015-08-17 10:31:51 +08001788 /* complete non-aio request */
Christoph Hellwigfe2cb292017-04-20 16:03:02 +02001789 if (!cmd->use_aio || ret) {
1790 cmd->ret = ret ? -EIO : 0;
Jens Axboe1894e912018-04-13 16:24:29 -06001791 blk_mq_complete_request(rq);
Christoph Hellwigfe2cb292017-04-20 16:03:02 +02001792 }
Ming Leib5dd2f62014-12-31 13:22:57 +00001793}
1794
Ming Leie03a3d72015-08-17 10:31:48 +08001795static void loop_queue_work(struct kthread_work *work)
Ming Leib5dd2f62014-12-31 13:22:57 +00001796{
1797 struct loop_cmd *cmd =
Ming Leie03a3d72015-08-17 10:31:48 +08001798 container_of(work, struct loop_cmd, work);
Ming Leib5dd2f62014-12-31 13:22:57 +00001799
1800 loop_handle_cmd(cmd);
1801}
1802
Christoph Hellwigd6296d392017-05-01 10:19:08 -06001803static int loop_init_request(struct blk_mq_tag_set *set, struct request *rq,
1804 unsigned int hctx_idx, unsigned int numa_node)
Ming Leib5dd2f62014-12-31 13:22:57 +00001805{
1806 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
1807
Petr Mladek39891442016-10-11 13:55:20 -07001808 kthread_init_work(&cmd->work, loop_queue_work);
Ming Leib5dd2f62014-12-31 13:22:57 +00001809 return 0;
1810}
1811
Eric Biggersf363b082017-03-30 13:39:16 -07001812static const struct blk_mq_ops loop_mq_ops = {
Ming Leib5dd2f62014-12-31 13:22:57 +00001813 .queue_rq = loop_queue_rq,
Ming Leib5dd2f62014-12-31 13:22:57 +00001814 .init_request = loop_init_request,
Christoph Hellwigfe2cb292017-04-20 16:03:02 +02001815 .complete = lo_complete_rq,
Ming Leib5dd2f62014-12-31 13:22:57 +00001816};
1817
Kay Sievers34dd82a2011-07-31 22:08:04 +02001818static int loop_add(struct loop_device **l, int i)
Ken Chen73285082007-05-08 00:28:20 -07001819{
1820 struct loop_device *lo;
1821 struct gendisk *disk;
Kay Sievers34dd82a2011-07-31 22:08:04 +02001822 int err;
Ken Chen73285082007-05-08 00:28:20 -07001823
Silva Paulo68d740d2012-07-14 15:39:58 -07001824 err = -ENOMEM;
Ken Chen73285082007-05-08 00:28:20 -07001825 lo = kzalloc(sizeof(*lo), GFP_KERNEL);
Silva Paulo68d740d2012-07-14 15:39:58 -07001826 if (!lo)
Ken Chen73285082007-05-08 00:28:20 -07001827 goto out;
Kay Sievers34dd82a2011-07-31 22:08:04 +02001828
Mikulas Patockaef7e7c82013-10-15 14:14:38 -06001829 lo->lo_state = Lo_unbound;
1830
Tejun Heoc718aa62013-02-27 17:03:58 -08001831 /* allocate id, if @id >= 0, we're requesting that specific id */
Kay Sievers34dd82a2011-07-31 22:08:04 +02001832 if (i >= 0) {
Tejun Heoc718aa62013-02-27 17:03:58 -08001833 err = idr_alloc(&loop_index_idr, lo, i, i + 1, GFP_KERNEL);
1834 if (err == -ENOSPC)
Kay Sievers34dd82a2011-07-31 22:08:04 +02001835 err = -EEXIST;
Kay Sievers34dd82a2011-07-31 22:08:04 +02001836 } else {
Tejun Heoc718aa62013-02-27 17:03:58 -08001837 err = idr_alloc(&loop_index_idr, lo, 0, 0, GFP_KERNEL);
Kay Sievers34dd82a2011-07-31 22:08:04 +02001838 }
1839 if (err < 0)
1840 goto out_free_dev;
Tejun Heoc718aa62013-02-27 17:03:58 -08001841 i = err;
Ken Chen73285082007-05-08 00:28:20 -07001842
Wei Yongjun183cfb52013-03-22 08:59:19 -06001843 err = -ENOMEM;
Ming Leib5dd2f62014-12-31 13:22:57 +00001844 lo->tag_set.ops = &loop_mq_ops;
1845 lo->tag_set.nr_hw_queues = 1;
1846 lo->tag_set.queue_depth = 128;
1847 lo->tag_set.numa_node = NUMA_NO_NODE;
1848 lo->tag_set.cmd_size = sizeof(struct loop_cmd);
1849 lo->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
1850 lo->tag_set.driver_data = lo;
1851
1852 err = blk_mq_alloc_tag_set(&lo->tag_set);
1853 if (err)
Mikulas Patocka3ec981e2013-10-14 12:12:24 -04001854 goto out_free_idr;
Ken Chen73285082007-05-08 00:28:20 -07001855
Ming Leib5dd2f62014-12-31 13:22:57 +00001856 lo->lo_queue = blk_mq_init_queue(&lo->tag_set);
1857 if (IS_ERR_OR_NULL(lo->lo_queue)) {
1858 err = PTR_ERR(lo->lo_queue);
1859 goto out_cleanup_tags;
1860 }
Mikulas Patockaef7e7c82013-10-15 14:14:38 -06001861 lo->lo_queue->queuedata = lo;
1862
Shaohua Li54bb0ad2017-08-31 22:09:45 -07001863 blk_queue_max_hw_sectors(lo->lo_queue, BLK_DEF_MAX_SECTORS);
Shaohua Li40326d82017-08-31 22:09:46 -07001864
Ming Lei5b5e20f2015-08-17 10:31:47 +08001865 /*
Shaohua Li40326d82017-08-31 22:09:46 -07001866 * By default, we do buffer IO, so it doesn't make sense to enable
1867 * merge because the I/O submitted to backing file is handled page by
1868 * page. For directio mode, merge does help to dispatch bigger request
1869 * to underlayer disk. We will enable merge once directio is enabled.
Ming Lei5b5e20f2015-08-17 10:31:47 +08001870 */
Bart Van Assche8b904b52018-03-07 17:10:10 -08001871 blk_queue_flag_set(QUEUE_FLAG_NOMERGES, lo->lo_queue);
Ming Lei5b5e20f2015-08-17 10:31:47 +08001872
Minfei Huang7a649732016-06-07 10:05:15 +08001873 err = -ENOMEM;
Laurent Vivier476a4812008-03-26 12:11:53 +01001874 disk = lo->lo_disk = alloc_disk(1 << part_shift);
Ken Chen73285082007-05-08 00:28:20 -07001875 if (!disk)
1876 goto out_free_queue;
1877
Kay Sieverse03c8dd2011-08-23 20:12:04 +02001878 /*
1879 * Disable partition scanning by default. The in-kernel partition
1880 * scanning can be requested individually per-device during its
1881 * setup. Userspace can always add and remove partitions from all
1882 * devices. The needed partition minors are allocated from the
1883 * extended minor space, the main loop device numbers will continue
1884 * to match the loop minors, regardless of the number of partitions
1885 * used.
1886 *
1887 * If max_part is given, partition scanning is globally enabled for
1888 * all loop devices. The minors for the main loop devices will be
1889 * multiples of max_part.
1890 *
1891 * Note: Global-for-all-devices, set-only-at-init, read-only module
1892 * parameteters like 'max_loop' and 'max_part' make things needlessly
1893 * complicated, are too static, inflexible and may surprise
1894 * userspace tools. Parameters like this in general should be avoided.
1895 */
1896 if (!part_shift)
1897 disk->flags |= GENHD_FL_NO_PART_SCAN;
1898 disk->flags |= GENHD_FL_EXT_DEVT;
Ken Chen73285082007-05-08 00:28:20 -07001899 mutex_init(&lo->lo_ctl_mutex);
Ming Leif8933662015-05-06 12:26:23 +08001900 atomic_set(&lo->lo_refcnt, 0);
Ken Chen73285082007-05-08 00:28:20 -07001901 lo->lo_number = i;
Ken Chen73285082007-05-08 00:28:20 -07001902 spin_lock_init(&lo->lo_lock);
1903 disk->major = LOOP_MAJOR;
Laurent Vivier476a4812008-03-26 12:11:53 +01001904 disk->first_minor = i << part_shift;
Ken Chen73285082007-05-08 00:28:20 -07001905 disk->fops = &lo_fops;
1906 disk->private_data = lo;
1907 disk->queue = lo->lo_queue;
1908 sprintf(disk->disk_name, "loop%d", i);
Kay Sievers34dd82a2011-07-31 22:08:04 +02001909 add_disk(disk);
1910 *l = lo;
1911 return lo->lo_number;
Ken Chen73285082007-05-08 00:28:20 -07001912
1913out_free_queue:
1914 blk_cleanup_queue(lo->lo_queue);
Ming Leib5dd2f62014-12-31 13:22:57 +00001915out_cleanup_tags:
1916 blk_mq_free_tag_set(&lo->tag_set);
Mikulas Patocka3ec981e2013-10-14 12:12:24 -04001917out_free_idr:
1918 idr_remove(&loop_index_idr, i);
Ken Chen73285082007-05-08 00:28:20 -07001919out_free_dev:
1920 kfree(lo);
1921out:
Kay Sievers34dd82a2011-07-31 22:08:04 +02001922 return err;
Ken Chen73285082007-05-08 00:28:20 -07001923}
1924
Kay Sievers34dd82a2011-07-31 22:08:04 +02001925static void loop_remove(struct loop_device *lo)
Ken Chen73285082007-05-08 00:28:20 -07001926{
NeilBrown6cd18e72015-04-27 14:12:22 +10001927 del_gendisk(lo->lo_disk);
Bart Van Assche0fa8ebd2018-02-28 10:15:28 -08001928 blk_cleanup_queue(lo->lo_queue);
Ming Leib5dd2f62014-12-31 13:22:57 +00001929 blk_mq_free_tag_set(&lo->tag_set);
Ken Chen73285082007-05-08 00:28:20 -07001930 put_disk(lo->lo_disk);
Ken Chen73285082007-05-08 00:28:20 -07001931 kfree(lo);
1932}
1933
Kay Sievers770fe302011-07-31 22:08:04 +02001934static int find_free_cb(int id, void *ptr, void *data)
Ken Chena47653f2007-06-08 13:46:44 -07001935{
Kay Sievers770fe302011-07-31 22:08:04 +02001936 struct loop_device *lo = ptr;
1937 struct loop_device **l = data;
Ken Chena47653f2007-06-08 13:46:44 -07001938
Kay Sievers770fe302011-07-31 22:08:04 +02001939 if (lo->lo_state == Lo_unbound) {
1940 *l = lo;
1941 return 1;
Ken Chena47653f2007-06-08 13:46:44 -07001942 }
Kay Sievers770fe302011-07-31 22:08:04 +02001943 return 0;
Ken Chena47653f2007-06-08 13:46:44 -07001944}
1945
Kay Sievers34dd82a2011-07-31 22:08:04 +02001946static int loop_lookup(struct loop_device **l, int i)
Ken Chena47653f2007-06-08 13:46:44 -07001947{
Ken Chena47653f2007-06-08 13:46:44 -07001948 struct loop_device *lo;
Kay Sievers34dd82a2011-07-31 22:08:04 +02001949 int ret = -ENODEV;
Ken Chena47653f2007-06-08 13:46:44 -07001950
Kay Sievers770fe302011-07-31 22:08:04 +02001951 if (i < 0) {
1952 int err;
1953
1954 err = idr_for_each(&loop_index_idr, &find_free_cb, &lo);
1955 if (err == 1) {
1956 *l = lo;
1957 ret = lo->lo_number;
1958 }
1959 goto out;
1960 }
1961
1962 /* lookup and return a specific i */
Kay Sievers34dd82a2011-07-31 22:08:04 +02001963 lo = idr_find(&loop_index_idr, i);
Ken Chena47653f2007-06-08 13:46:44 -07001964 if (lo) {
Kay Sievers34dd82a2011-07-31 22:08:04 +02001965 *l = lo;
1966 ret = lo->lo_number;
Ken Chena47653f2007-06-08 13:46:44 -07001967 }
Kay Sievers770fe302011-07-31 22:08:04 +02001968out:
Kay Sievers34dd82a2011-07-31 22:08:04 +02001969 return ret;
Ken Chena47653f2007-06-08 13:46:44 -07001970}
1971
Ken Chen73285082007-05-08 00:28:20 -07001972static struct kobject *loop_probe(dev_t dev, int *part, void *data)
1973{
Al Viro705962c2007-05-13 05:52:32 -04001974 struct loop_device *lo;
Al Viro07002e92007-05-12 16:23:15 -04001975 struct kobject *kobj;
Kay Sievers34dd82a2011-07-31 22:08:04 +02001976 int err;
Ken Chen73285082007-05-08 00:28:20 -07001977
Kay Sievers34dd82a2011-07-31 22:08:04 +02001978 mutex_lock(&loop_index_mutex);
1979 err = loop_lookup(&lo, MINOR(dev) >> part_shift);
1980 if (err < 0)
1981 err = loop_add(&lo, MINOR(dev) >> part_shift);
1982 if (err < 0)
Mikulas Patockaa207f592013-10-14 12:13:24 -04001983 kobj = NULL;
Kay Sievers34dd82a2011-07-31 22:08:04 +02001984 else
Jan Kara3079c222018-02-26 13:01:38 +01001985 kobj = get_disk_and_module(lo->lo_disk);
Kay Sievers34dd82a2011-07-31 22:08:04 +02001986 mutex_unlock(&loop_index_mutex);
Ken Chen73285082007-05-08 00:28:20 -07001987
1988 *part = 0;
Al Viro07002e92007-05-12 16:23:15 -04001989 return kobj;
Ken Chen73285082007-05-08 00:28:20 -07001990}
1991
Kay Sievers770fe302011-07-31 22:08:04 +02001992static long loop_control_ioctl(struct file *file, unsigned int cmd,
1993 unsigned long parm)
1994{
1995 struct loop_device *lo;
1996 int ret = -ENOSYS;
1997
1998 mutex_lock(&loop_index_mutex);
1999 switch (cmd) {
2000 case LOOP_CTL_ADD:
2001 ret = loop_lookup(&lo, parm);
2002 if (ret >= 0) {
2003 ret = -EEXIST;
2004 break;
2005 }
2006 ret = loop_add(&lo, parm);
2007 break;
2008 case LOOP_CTL_REMOVE:
2009 ret = loop_lookup(&lo, parm);
2010 if (ret < 0)
2011 break;
Omar Sandoval3148ffb2018-03-26 21:39:12 -07002012 ret = mutex_lock_killable(&lo->lo_ctl_mutex);
2013 if (ret)
2014 break;
Kay Sievers770fe302011-07-31 22:08:04 +02002015 if (lo->lo_state != Lo_unbound) {
2016 ret = -EBUSY;
2017 mutex_unlock(&lo->lo_ctl_mutex);
2018 break;
2019 }
Ming Leif8933662015-05-06 12:26:23 +08002020 if (atomic_read(&lo->lo_refcnt) > 0) {
Kay Sievers770fe302011-07-31 22:08:04 +02002021 ret = -EBUSY;
2022 mutex_unlock(&lo->lo_ctl_mutex);
2023 break;
2024 }
2025 lo->lo_disk->private_data = NULL;
2026 mutex_unlock(&lo->lo_ctl_mutex);
2027 idr_remove(&loop_index_idr, lo->lo_number);
2028 loop_remove(lo);
2029 break;
2030 case LOOP_CTL_GET_FREE:
2031 ret = loop_lookup(&lo, -1);
2032 if (ret >= 0)
2033 break;
2034 ret = loop_add(&lo, -1);
2035 }
2036 mutex_unlock(&loop_index_mutex);
2037
2038 return ret;
2039}
2040
2041static const struct file_operations loop_ctl_fops = {
2042 .open = nonseekable_open,
2043 .unlocked_ioctl = loop_control_ioctl,
2044 .compat_ioctl = loop_control_ioctl,
2045 .owner = THIS_MODULE,
2046 .llseek = noop_llseek,
2047};
2048
2049static struct miscdevice loop_misc = {
2050 .minor = LOOP_CTRL_MINOR,
2051 .name = "loop-control",
2052 .fops = &loop_ctl_fops,
2053};
2054
2055MODULE_ALIAS_MISCDEV(LOOP_CTRL_MINOR);
2056MODULE_ALIAS("devname:loop-control");
2057
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058static int __init loop_init(void)
2059{
Ken Chena47653f2007-06-08 13:46:44 -07002060 int i, nr;
2061 unsigned long range;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002062 struct loop_device *lo;
Kay Sievers770fe302011-07-31 22:08:04 +02002063 int err;
Ken Chena47653f2007-06-08 13:46:44 -07002064
Laurent Vivier476a4812008-03-26 12:11:53 +01002065 part_shift = 0;
Namhyung Kimac04fee2011-05-27 07:59:25 +02002066 if (max_part > 0) {
Laurent Vivier476a4812008-03-26 12:11:53 +01002067 part_shift = fls(max_part);
2068
Namhyung Kimac04fee2011-05-27 07:59:25 +02002069 /*
2070 * Adjust max_part according to part_shift as it is exported
2071 * to user space so that user can decide correct minor number
2072 * if [s]he want to create more devices.
2073 *
2074 * Note that -1 is required because partition 0 is reserved
2075 * for the whole disk.
2076 */
2077 max_part = (1UL << part_shift) - 1;
2078 }
2079
Guo Chaob1a66502013-02-21 15:16:49 -08002080 if ((1UL << part_shift) > DISK_MAX_PARTS) {
2081 err = -EINVAL;
Anton Volkova8c1d062017-08-07 15:37:50 +03002082 goto err_out;
Guo Chaob1a66502013-02-21 15:16:49 -08002083 }
Namhyung Kim78f4bb32011-05-24 16:48:54 +02002084
Guo Chaob1a66502013-02-21 15:16:49 -08002085 if (max_loop > 1UL << (MINORBITS - part_shift)) {
2086 err = -EINVAL;
Anton Volkova8c1d062017-08-07 15:37:50 +03002087 goto err_out;
Guo Chaob1a66502013-02-21 15:16:49 -08002088 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089
Kay Sieversd134b002011-07-31 22:08:04 +02002090 /*
2091 * If max_loop is specified, create that many devices upfront.
2092 * This also becomes a hard limit. If max_loop is not specified,
2093 * create CONFIG_BLK_DEV_LOOP_MIN_COUNT loop devices at module
2094 * init time. Loop devices can be requested on-demand with the
2095 * /dev/loop-control interface, or be instantiated by accessing
2096 * a 'dead' device node.
2097 */
Ken Chen73285082007-05-08 00:28:20 -07002098 if (max_loop) {
Ken Chena47653f2007-06-08 13:46:44 -07002099 nr = max_loop;
Namhyung Kima1c15c52011-05-24 16:48:55 +02002100 range = max_loop << part_shift;
Ken Chena47653f2007-06-08 13:46:44 -07002101 } else {
Kay Sieversd134b002011-07-31 22:08:04 +02002102 nr = CONFIG_BLK_DEV_LOOP_MIN_COUNT;
Namhyung Kima1c15c52011-05-24 16:48:55 +02002103 range = 1UL << MINORBITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 }
Ken Chena47653f2007-06-08 13:46:44 -07002105
Anton Volkova8c1d062017-08-07 15:37:50 +03002106 err = misc_register(&loop_misc);
2107 if (err < 0)
2108 goto err_out;
2109
2110
Guo Chaob1a66502013-02-21 15:16:49 -08002111 if (register_blkdev(LOOP_MAJOR, "loop")) {
2112 err = -EIO;
2113 goto misc_out;
2114 }
Ken Chena47653f2007-06-08 13:46:44 -07002115
Ken Chena47653f2007-06-08 13:46:44 -07002116 blk_register_region(MKDEV(LOOP_MAJOR, 0), range,
2117 THIS_MODULE, loop_probe, NULL, NULL);
2118
Kay Sieversd134b002011-07-31 22:08:04 +02002119 /* pre-create number of devices given by config or max_loop */
Kay Sievers34dd82a2011-07-31 22:08:04 +02002120 mutex_lock(&loop_index_mutex);
2121 for (i = 0; i < nr; i++)
2122 loop_add(&lo, i);
2123 mutex_unlock(&loop_index_mutex);
2124
Ken Chen73285082007-05-08 00:28:20 -07002125 printk(KERN_INFO "loop: module loaded\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126 return 0;
Guo Chaob1a66502013-02-21 15:16:49 -08002127
2128misc_out:
2129 misc_deregister(&loop_misc);
Anton Volkova8c1d062017-08-07 15:37:50 +03002130err_out:
Guo Chaob1a66502013-02-21 15:16:49 -08002131 return err;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002132}
Ken Chena47653f2007-06-08 13:46:44 -07002133
Kay Sievers34dd82a2011-07-31 22:08:04 +02002134static int loop_exit_cb(int id, void *ptr, void *data)
2135{
2136 struct loop_device *lo = ptr;
Ken Chena47653f2007-06-08 13:46:44 -07002137
Kay Sievers34dd82a2011-07-31 22:08:04 +02002138 loop_remove(lo);
2139 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140}
2141
Ken Chen73285082007-05-08 00:28:20 -07002142static void __exit loop_exit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143{
Ken Chena47653f2007-06-08 13:46:44 -07002144 unsigned long range;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145
Namhyung Kima1c15c52011-05-24 16:48:55 +02002146 range = max_loop ? max_loop << part_shift : 1UL << MINORBITS;
Ken Chena47653f2007-06-08 13:46:44 -07002147
Kay Sievers34dd82a2011-07-31 22:08:04 +02002148 idr_for_each(&loop_index_idr, &loop_exit_cb, NULL);
Kay Sievers34dd82a2011-07-31 22:08:04 +02002149 idr_destroy(&loop_index_idr);
Ken Chen73285082007-05-08 00:28:20 -07002150
Ken Chena47653f2007-06-08 13:46:44 -07002151 blk_unregister_region(MKDEV(LOOP_MAJOR, 0), range);
Akinobu Mita00d59402007-07-17 04:03:46 -07002152 unregister_blkdev(LOOP_MAJOR, "loop");
Kay Sievers770fe302011-07-31 22:08:04 +02002153
2154 misc_deregister(&loop_misc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155}
2156
2157module_init(loop_init);
2158module_exit(loop_exit);
2159
2160#ifndef MODULE
2161static int __init max_loop_setup(char *str)
2162{
2163 max_loop = simple_strtol(str, NULL, 0);
2164 return 1;
2165}
2166
2167__setup("max_loop=", max_loop_setup);
2168#endif