blob: f34863af332a84633eecd66c31b823eb93128c2e [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>
Al Viro83a87612013-05-12 10:14:07 -040079#include "loop.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080081#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
Kay Sievers34dd82a2011-07-31 22:08:04 +020083static DEFINE_IDR(loop_index_idr);
84static DEFINE_MUTEX(loop_index_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Laurent Vivier476a4812008-03-26 12:11:53 +010086static int max_part;
87static int part_shift;
88
Linus Torvalds1da177e2005-04-16 15:20:36 -070089static int transfer_xor(struct loop_device *lo, int cmd,
90 struct page *raw_page, unsigned raw_off,
91 struct page *loop_page, unsigned loop_off,
92 int size, sector_t real_block)
93{
Cong Wangcfd80052011-11-25 23:14:18 +080094 char *raw_buf = kmap_atomic(raw_page) + raw_off;
95 char *loop_buf = kmap_atomic(loop_page) + loop_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 char *in, *out, *key;
97 int i, keysize;
98
99 if (cmd == READ) {
100 in = raw_buf;
101 out = loop_buf;
102 } else {
103 in = loop_buf;
104 out = raw_buf;
105 }
106
107 key = lo->lo_encrypt_key;
108 keysize = lo->lo_encrypt_key_size;
109 for (i = 0; i < size; i++)
110 *out++ = *in++ ^ key[(i & 511) % keysize];
111
Cong Wangcfd80052011-11-25 23:14:18 +0800112 kunmap_atomic(loop_buf);
113 kunmap_atomic(raw_buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 cond_resched();
115 return 0;
116}
117
118static int xor_init(struct loop_device *lo, const struct loop_info64 *info)
119{
120 if (unlikely(info->lo_encrypt_key_size <= 0))
121 return -EINVAL;
122 return 0;
123}
124
125static struct loop_func_table none_funcs = {
126 .number = LO_CRYPT_NONE,
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200127};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129static struct loop_func_table xor_funcs = {
130 .number = LO_CRYPT_XOR,
131 .transfer = transfer_xor,
132 .init = xor_init
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200133};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
135/* xfer_funcs[0] is special - its release function is never called */
136static struct loop_func_table *xfer_funcs[MAX_LO_CRYPT] = {
137 &none_funcs,
138 &xor_funcs
139};
140
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100141static loff_t get_size(loff_t offset, loff_t sizelimit, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142{
Guo Chaob7a1da62013-02-21 15:16:50 -0800143 loff_t loopsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
145 /* Compute loopsize in bytes */
Guo Chaob7a1da62013-02-21 15:16:50 -0800146 loopsize = i_size_read(file->f_mapping->host);
147 if (offset > 0)
148 loopsize -= offset;
149 /* offset is beyond i_size, weird but possible */
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100150 if (loopsize < 0)
151 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100153 if (sizelimit > 0 && sizelimit < loopsize)
154 loopsize = sizelimit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 /*
156 * Unfortunately, if we want to do I/O on the device,
157 * the number of 512-byte sectors has to fit into a sector_t.
158 */
159 return loopsize >> 9;
160}
161
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100162static loff_t get_loop_size(struct loop_device *lo, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163{
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100164 return get_size(lo->lo_offset, lo->lo_sizelimit, file);
165}
166
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800167static void __loop_update_dio(struct loop_device *lo, bool dio)
168{
169 struct file *file = lo->lo_backing_file;
170 struct address_space *mapping = file->f_mapping;
171 struct inode *inode = mapping->host;
172 unsigned short sb_bsize = 0;
173 unsigned dio_align = 0;
174 bool use_dio;
175
176 if (inode->i_sb->s_bdev) {
177 sb_bsize = bdev_logical_block_size(inode->i_sb->s_bdev);
178 dio_align = sb_bsize - 1;
179 }
180
181 /*
182 * We support direct I/O only if lo_offset is aligned with the
183 * logical I/O size of backing device, and the logical block
184 * size of loop is bigger than the backing device's and the loop
185 * needn't transform transfer.
186 *
187 * TODO: the above condition may be loosed in the future, and
188 * direct I/O may be switched runtime at that time because most
Masahiro Yamada89d790a2017-02-27 14:29:01 -0800189 * of requests in sane applications should be PAGE_SIZE aligned
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800190 */
191 if (dio) {
192 if (queue_logical_block_size(lo->lo_queue) >= sb_bsize &&
193 !(lo->lo_offset & dio_align) &&
194 mapping->a_ops->direct_IO &&
195 !lo->transfer)
196 use_dio = true;
197 else
198 use_dio = false;
199 } else {
200 use_dio = false;
201 }
202
203 if (lo->use_dio == use_dio)
204 return;
205
206 /* flush dirty pages before changing direct IO */
207 vfs_fsync(file, 0);
208
209 /*
210 * The flag of LO_FLAGS_DIRECT_IO is handled similarly with
211 * LO_FLAGS_READ_ONLY, both are set from kernel, and losetup
212 * will get updated by ioctl(LOOP_GET_STATUS)
213 */
214 blk_mq_freeze_queue(lo->lo_queue);
215 lo->use_dio = use_dio;
Shaohua Li40326d82017-08-31 22:09:46 -0700216 if (use_dio) {
Bart Van Assche8b904b52018-03-07 17:10:10 -0800217 blk_queue_flag_clear(QUEUE_FLAG_NOMERGES, lo->lo_queue);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800218 lo->lo_flags |= LO_FLAGS_DIRECT_IO;
Shaohua Li40326d82017-08-31 22:09:46 -0700219 } else {
Bart Van Assche8b904b52018-03-07 17:10:10 -0800220 blk_queue_flag_set(QUEUE_FLAG_NOMERGES, lo->lo_queue);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800221 lo->lo_flags &= ~LO_FLAGS_DIRECT_IO;
Shaohua Li40326d82017-08-31 22:09:46 -0700222 }
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800223 blk_mq_unfreeze_queue(lo->lo_queue);
224}
225
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100226static int
Omar Sandoval1e6ec9e2017-08-23 14:54:59 -0700227figure_loop_size(struct loop_device *lo, loff_t offset, loff_t sizelimit)
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100228{
229 loff_t size = get_size(offset, sizelimit, lo->lo_backing_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 sector_t x = (sector_t)size;
Guo Chao7b0576a2013-02-21 15:16:47 -0800231 struct block_device *bdev = lo->lo_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
233 if (unlikely((loff_t)x != size))
234 return -EFBIG;
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100235 if (lo->lo_offset != offset)
236 lo->lo_offset = offset;
237 if (lo->lo_sizelimit != sizelimit)
238 lo->lo_sizelimit = sizelimit;
Ken Chen73285082007-05-08 00:28:20 -0700239 set_capacity(lo->lo_disk, x);
Guo Chao7b0576a2013-02-21 15:16:47 -0800240 bd_set_size(bdev, (loff_t)get_capacity(bdev->bd_disk) << 9);
241 /* let user-space know about the new size */
242 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +0100243 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244}
245
246static inline int
247lo_do_transfer(struct loop_device *lo, int cmd,
248 struct page *rpage, unsigned roffs,
249 struct page *lpage, unsigned loffs,
250 int size, sector_t rblock)
251{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200252 int ret;
253
254 ret = lo->transfer(lo, cmd, rpage, roffs, lpage, loffs, size, rblock);
255 if (likely(!ret))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 return 0;
257
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200258 printk_ratelimited(KERN_ERR
259 "loop: Transfer error at byte offset %llu, length %i.\n",
260 (unsigned long long)rblock << 9, size);
261 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262}
263
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200264static int lo_write_bvec(struct file *file, struct bio_vec *bvec, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200266 struct iov_iter i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 ssize_t bw;
Al Viro283e7e52015-04-03 15:21:59 -0400268
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200269 iov_iter_bvec(&i, ITER_BVEC, bvec, 1, bvec->bv_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
Al Viro03d95eb2013-03-20 13:04:20 -0400271 file_start_write(file);
Christoph Hellwigabbb65892017-05-27 11:16:52 +0300272 bw = vfs_iter_write(file, &i, ppos, 0);
Al Viro03d95eb2013-03-20 13:04:20 -0400273 file_end_write(file);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200274
275 if (likely(bw == bvec->bv_len))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 return 0;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200277
278 printk_ratelimited(KERN_ERR
279 "loop: Write error at byte offset %llu, length %i.\n",
280 (unsigned long long)*ppos, bvec->bv_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 if (bw >= 0)
282 bw = -EIO;
283 return bw;
284}
285
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200286static int lo_write_simple(struct loop_device *lo, struct request *rq,
287 loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200289 struct bio_vec bvec;
290 struct req_iterator iter;
291 int ret = 0;
292
293 rq_for_each_segment(bvec, rq, iter) {
294 ret = lo_write_bvec(lo->lo_backing_file, &bvec, &pos);
295 if (ret < 0)
296 break;
297 cond_resched();
298 }
299
300 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301}
302
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200303/*
Christoph Hellwig456be142011-10-17 12:57:20 +0200304 * This is the slow, transforming version that needs to double buffer the
305 * data as it cannot do the transformations in place without having direct
306 * access to the destination pages of the backing file.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 */
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200308static int lo_write_transfer(struct loop_device *lo, struct request *rq,
309 loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310{
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200311 struct bio_vec bvec, b;
Ming Lei30112012014-12-31 13:22:58 +0000312 struct req_iterator iter;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200313 struct page *page;
Kent Overstreet79886132013-11-23 17:19:00 -0800314 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200316 page = alloc_page(GFP_NOIO);
317 if (unlikely(!page))
318 return -ENOMEM;
Christoph Hellwig456be142011-10-17 12:57:20 +0200319
Ming Lei30112012014-12-31 13:22:58 +0000320 rq_for_each_segment(bvec, rq, iter) {
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200321 ret = lo_do_transfer(lo, WRITE, page, 0, bvec.bv_page,
322 bvec.bv_offset, bvec.bv_len, pos >> 9);
323 if (unlikely(ret))
324 break;
325
326 b.bv_page = page;
327 b.bv_offset = 0;
328 b.bv_len = bvec.bv_len;
329 ret = lo_write_bvec(lo->lo_backing_file, &b, &pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 if (ret < 0)
331 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 }
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200333
334 __free_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336}
337
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200338static int lo_read_simple(struct loop_device *lo, struct request *rq,
339 loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340{
Kent Overstreet79886132013-11-23 17:19:00 -0800341 struct bio_vec bvec;
Ming Lei30112012014-12-31 13:22:58 +0000342 struct req_iterator iter;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200343 struct iov_iter i;
344 ssize_t len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
Ming Lei30112012014-12-31 13:22:58 +0000346 rq_for_each_segment(bvec, rq, iter) {
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200347 iov_iter_bvec(&i, ITER_BVEC, &bvec, 1, bvec.bv_len);
Christoph Hellwig18e97102017-05-27 11:16:51 +0300348 len = vfs_iter_read(lo->lo_backing_file, &i, &pos, 0);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200349 if (len < 0)
350 return len;
Dave Young306df072012-02-08 22:07:19 +0100351
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200352 flush_dcache_page(bvec.bv_page);
353
354 if (len != bvec.bv_len) {
Ming Lei30112012014-12-31 13:22:58 +0000355 struct bio *bio;
356
357 __rq_for_each_bio(bio, rq)
358 zero_fill_bio(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 break;
Dave Young306df072012-02-08 22:07:19 +0100360 }
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200361 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 }
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200363
Dave Young306df072012-02-08 22:07:19 +0100364 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365}
366
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200367static int lo_read_transfer(struct loop_device *lo, struct request *rq,
368 loff_t pos)
369{
370 struct bio_vec bvec, b;
371 struct req_iterator iter;
372 struct iov_iter i;
373 struct page *page;
374 ssize_t len;
375 int ret = 0;
376
377 page = alloc_page(GFP_NOIO);
378 if (unlikely(!page))
379 return -ENOMEM;
380
381 rq_for_each_segment(bvec, rq, iter) {
382 loff_t offset = pos;
383
384 b.bv_page = page;
385 b.bv_offset = 0;
386 b.bv_len = bvec.bv_len;
387
388 iov_iter_bvec(&i, ITER_BVEC, &b, 1, b.bv_len);
Christoph Hellwig18e97102017-05-27 11:16:51 +0300389 len = vfs_iter_read(lo->lo_backing_file, &i, &pos, 0);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200390 if (len < 0) {
391 ret = len;
392 goto out_free_page;
393 }
394
395 ret = lo_do_transfer(lo, READ, page, 0, bvec.bv_page,
396 bvec.bv_offset, len, offset >> 9);
397 if (ret)
398 goto out_free_page;
399
400 flush_dcache_page(bvec.bv_page);
401
402 if (len != bvec.bv_len) {
403 struct bio *bio;
404
405 __rq_for_each_bio(bio, rq)
406 zero_fill_bio(bio);
407 break;
408 }
409 }
410
411 ret = 0;
412out_free_page:
413 __free_page(page);
414 return ret;
415}
416
Ming Leicf655d92014-12-31 13:22:59 +0000417static int lo_discard(struct loop_device *lo, struct request *rq, loff_t pos)
418{
419 /*
420 * We use punch hole to reclaim the free space used by the
421 * image a.k.a. discard. However we do not support discard if
422 * encryption is enabled, because it may give an attacker
423 * useful information.
424 */
425 struct file *file = lo->lo_backing_file;
426 int mode = FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE;
427 int ret;
428
429 if ((!file->f_op->fallocate) || lo->lo_encrypt_key_size) {
430 ret = -EOPNOTSUPP;
431 goto out;
432 }
433
434 ret = file->f_op->fallocate(file, mode, pos, blk_rq_bytes(rq));
435 if (unlikely(ret && ret != -EINVAL && ret != -EOPNOTSUPP))
436 ret = -EIO;
437 out:
438 return ret;
439}
440
441static int lo_req_flush(struct loop_device *lo, struct request *rq)
442{
443 struct file *file = lo->lo_backing_file;
444 int ret = vfs_fsync(file, 0);
445 if (unlikely(ret && ret != -EINVAL))
446 ret = -EIO;
447
448 return ret;
449}
450
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200451static void lo_complete_rq(struct request *rq)
Ming Leibc07c102015-08-17 10:31:51 +0800452{
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200453 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
Ming Leibc07c102015-08-17 10:31:51 +0800454
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200455 if (unlikely(req_op(cmd->rq) == REQ_OP_READ && cmd->use_aio &&
456 cmd->ret >= 0 && cmd->ret < blk_rq_bytes(cmd->rq))) {
Ming Leibc07c102015-08-17 10:31:51 +0800457 struct bio *bio = cmd->rq->bio;
458
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200459 bio_advance(bio, cmd->ret);
Ming Leibc07c102015-08-17 10:31:51 +0800460 zero_fill_bio(bio);
461 }
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200462
Christoph Hellwig2a842ac2017-06-03 09:38:04 +0200463 blk_mq_end_request(rq, cmd->ret < 0 ? BLK_STS_IOERR : BLK_STS_OK);
Ming Leibc07c102015-08-17 10:31:51 +0800464}
465
Shaohua Li92d77332017-09-01 11:15:17 -0700466static void lo_rw_aio_do_completion(struct loop_cmd *cmd)
467{
468 if (!atomic_dec_and_test(&cmd->ref))
469 return;
470 kfree(cmd->bvec);
471 cmd->bvec = NULL;
472 blk_mq_complete_request(cmd->rq);
473}
474
Ming Leibc07c102015-08-17 10:31:51 +0800475static void lo_rw_aio_complete(struct kiocb *iocb, long ret, long ret2)
476{
477 struct loop_cmd *cmd = container_of(iocb, struct loop_cmd, iocb);
Ming Leibc07c102015-08-17 10:31:51 +0800478
Shaohua Lid4478e92017-09-25 13:07:22 -0600479 if (cmd->css)
480 css_put(cmd->css);
Christoph Hellwigfe2cb292017-04-20 16:03:02 +0200481 cmd->ret = ret;
Shaohua Li92d77332017-09-01 11:15:17 -0700482 lo_rw_aio_do_completion(cmd);
Ming Leibc07c102015-08-17 10:31:51 +0800483}
484
485static int lo_rw_aio(struct loop_device *lo, struct loop_cmd *cmd,
486 loff_t pos, bool rw)
487{
488 struct iov_iter iter;
489 struct bio_vec *bvec;
Shaohua Li40326d82017-08-31 22:09:46 -0700490 struct request *rq = cmd->rq;
491 struct bio *bio = rq->bio;
Ming Leibc07c102015-08-17 10:31:51 +0800492 struct file *file = lo->lo_backing_file;
Shaohua Li40326d82017-08-31 22:09:46 -0700493 unsigned int offset;
494 int segments = 0;
Ming Leibc07c102015-08-17 10:31:51 +0800495 int ret;
496
Shaohua Li40326d82017-08-31 22:09:46 -0700497 if (rq->bio != rq->biotail) {
498 struct req_iterator iter;
499 struct bio_vec tmp;
Ming Leibc07c102015-08-17 10:31:51 +0800500
Shaohua Li40326d82017-08-31 22:09:46 -0700501 __rq_for_each_bio(bio, rq)
502 segments += bio_segments(bio);
503 bvec = kmalloc(sizeof(struct bio_vec) * segments, GFP_NOIO);
504 if (!bvec)
505 return -EIO;
506 cmd->bvec = bvec;
507
508 /*
509 * The bios of the request may be started from the middle of
510 * the 'bvec' because of bio splitting, so we can't directly
511 * copy bio->bi_iov_vec to new bvec. The rq_for_each_segment
512 * API will take care of all details for us.
513 */
514 rq_for_each_segment(tmp, rq, iter) {
515 *bvec = tmp;
516 bvec++;
517 }
518 bvec = cmd->bvec;
519 offset = 0;
520 } else {
521 /*
522 * Same here, this bio may be started from the middle of the
523 * 'bvec' because of bio splitting, so offset from the bvec
524 * must be passed to iov iterator
525 */
526 offset = bio->bi_iter.bi_bvec_done;
527 bvec = __bvec_iter_bvec(bio->bi_io_vec, bio->bi_iter);
528 segments = bio_segments(bio);
529 }
Shaohua Li92d77332017-09-01 11:15:17 -0700530 atomic_set(&cmd->ref, 2);
Shaohua Li40326d82017-08-31 22:09:46 -0700531
Ming Leibc07c102015-08-17 10:31:51 +0800532 iov_iter_bvec(&iter, ITER_BVEC | rw, bvec,
Shaohua Li40326d82017-08-31 22:09:46 -0700533 segments, blk_rq_bytes(rq));
534 iter.iov_offset = offset;
Ming Leibc07c102015-08-17 10:31:51 +0800535
536 cmd->iocb.ki_pos = pos;
537 cmd->iocb.ki_filp = file;
538 cmd->iocb.ki_complete = lo_rw_aio_complete;
539 cmd->iocb.ki_flags = IOCB_DIRECT;
Shaohua Lid4478e92017-09-25 13:07:22 -0600540 if (cmd->css)
541 kthread_associate_blkcg(cmd->css);
Ming Leibc07c102015-08-17 10:31:51 +0800542
543 if (rw == WRITE)
Miklos Szeredibb7462b2017-02-20 16:51:23 +0100544 ret = call_write_iter(file, &cmd->iocb, &iter);
Ming Leibc07c102015-08-17 10:31:51 +0800545 else
Miklos Szeredibb7462b2017-02-20 16:51:23 +0100546 ret = call_read_iter(file, &cmd->iocb, &iter);
Ming Leibc07c102015-08-17 10:31:51 +0800547
Shaohua Li92d77332017-09-01 11:15:17 -0700548 lo_rw_aio_do_completion(cmd);
Shaohua Lid4478e92017-09-25 13:07:22 -0600549 kthread_associate_blkcg(NULL);
Shaohua Li92d77332017-09-01 11:15:17 -0700550
Ming Leibc07c102015-08-17 10:31:51 +0800551 if (ret != -EIOCBQUEUED)
552 cmd->iocb.ki_complete(&cmd->iocb, ret, 0);
553 return 0;
554}
555
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200556static int do_req_filebacked(struct loop_device *lo, struct request *rq)
Ming Leibc07c102015-08-17 10:31:51 +0800557{
558 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200559 loff_t pos = ((loff_t) blk_rq_pos(rq) << 9) + lo->lo_offset;
Ming Leibc07c102015-08-17 10:31:51 +0800560
561 /*
562 * lo_write_simple and lo_read_simple should have been covered
563 * by io submit style function like lo_rw_aio(), one blocker
564 * is that lo_read_simple() need to call flush_dcache_page after
565 * the page is written from kernel, and it isn't easy to handle
566 * this in io submit style function which submits all segments
567 * of the req at one time. And direct read IO doesn't need to
568 * run flush_dcache_page().
569 */
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200570 switch (req_op(rq)) {
571 case REQ_OP_FLUSH:
572 return lo_req_flush(lo, rq);
573 case REQ_OP_DISCARD:
Christoph Hellwig19372e22017-04-05 19:21:15 +0200574 case REQ_OP_WRITE_ZEROES:
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200575 return lo_discard(lo, rq, pos);
576 case REQ_OP_WRITE:
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200577 if (lo->transfer)
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200578 return lo_write_transfer(lo, rq, pos);
579 else if (cmd->use_aio)
580 return lo_rw_aio(lo, cmd, pos, WRITE);
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200581 else
Christoph Hellwigc1c87c22016-08-04 16:10:01 +0200582 return lo_write_simple(lo, rq, pos);
583 case REQ_OP_READ:
584 if (lo->transfer)
585 return lo_read_transfer(lo, rq, pos);
586 else if (cmd->use_aio)
587 return lo_rw_aio(lo, cmd, pos, READ);
588 else
589 return lo_read_simple(lo, rq, pos);
590 default:
591 WARN_ON_ONCE(1);
592 return -EIO;
593 break;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200594 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595}
596
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800597static inline void loop_update_dio(struct loop_device *lo)
598{
599 __loop_update_dio(lo, io_is_direct(lo->lo_backing_file) |
600 lo->use_dio);
601}
602
Ming Lei06f0e9e2015-05-06 12:26:24 +0800603static void loop_reread_partitions(struct loop_device *lo,
604 struct block_device *bdev)
605{
606 int rc;
607
608 /*
609 * bd_mutex has been held already in release path, so don't
610 * acquire it if this function is called in such case.
611 *
612 * If the reread partition isn't from release path, lo_refcnt
613 * must be at least one and it can only become zero when the
614 * current holder is released.
615 */
616 if (!atomic_read(&lo->lo_refcnt))
617 rc = __blkdev_reread_part(bdev);
618 else
619 rc = blkdev_reread_part(bdev);
620 if (rc)
621 pr_warn("%s: partition scan of loop%d (%s) failed (rc=%d)\n",
622 __func__, lo->lo_number, lo->lo_file_name, rc);
623}
624
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625/*
626 * loop_change_fd switched the backing store of a loopback device to
627 * a new file. This is useful for operating system installers to free up
628 * the original file and in High Availability environments to switch to
629 * an alternative location for the content in case of server meltdown.
630 * This can only work if the loop device is used read-only, and if the
631 * new backing store is the same size and type as the old backing store.
632 */
Al Virobb214882008-03-02 09:29:48 -0500633static int loop_change_fd(struct loop_device *lo, struct block_device *bdev,
634 unsigned int arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635{
636 struct file *file, *old_file;
637 struct inode *inode;
638 int error;
639
640 error = -ENXIO;
641 if (lo->lo_state != Lo_bound)
642 goto out;
643
644 /* the loop device has to be read-only */
645 error = -EINVAL;
646 if (!(lo->lo_flags & LO_FLAGS_READ_ONLY))
647 goto out;
648
649 error = -EBADF;
650 file = fget(arg);
651 if (!file)
652 goto out;
653
654 inode = file->f_mapping->host;
655 old_file = lo->lo_backing_file;
656
657 error = -EINVAL;
658
659 if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
660 goto out_putf;
661
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 /* size of the new backing store needs to be the same */
663 if (get_loop_size(lo, file) != get_loop_size(lo, old_file))
664 goto out_putf;
665
666 /* and ... switch */
Omar Sandoval43cade802017-08-24 00:03:44 -0700667 blk_mq_freeze_queue(lo->lo_queue);
668 mapping_set_gfp_mask(old_file->f_mapping, lo->old_gfp_mask);
669 lo->lo_backing_file = file;
670 lo->old_gfp_mask = mapping_gfp_mask(file->f_mapping);
671 mapping_set_gfp_mask(file->f_mapping,
672 lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
673 loop_update_dio(lo);
674 blk_mq_unfreeze_queue(lo->lo_queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675
676 fput(old_file);
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200677 if (lo->lo_flags & LO_FLAGS_PARTSCAN)
Ming Lei06f0e9e2015-05-06 12:26:24 +0800678 loop_reread_partitions(lo, bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 return 0;
680
681 out_putf:
682 fput(file);
683 out:
684 return error;
685}
686
687static inline int is_loop_device(struct file *file)
688{
689 struct inode *i = file->f_mapping->host;
690
691 return i && S_ISBLK(i->i_mode) && MAJOR(i->i_rdev) == LOOP_MAJOR;
692}
693
Milan Brozee862732010-08-23 15:16:00 +0200694/* loop sysfs attributes */
695
696static ssize_t loop_attr_show(struct device *dev, char *page,
697 ssize_t (*callback)(struct loop_device *, char *))
698{
Kay Sievers34dd82a2011-07-31 22:08:04 +0200699 struct gendisk *disk = dev_to_disk(dev);
700 struct loop_device *lo = disk->private_data;
Milan Brozee862732010-08-23 15:16:00 +0200701
Kay Sievers34dd82a2011-07-31 22:08:04 +0200702 return callback(lo, page);
Milan Brozee862732010-08-23 15:16:00 +0200703}
704
705#define LOOP_ATTR_RO(_name) \
706static ssize_t loop_attr_##_name##_show(struct loop_device *, char *); \
707static ssize_t loop_attr_do_show_##_name(struct device *d, \
708 struct device_attribute *attr, char *b) \
709{ \
710 return loop_attr_show(d, b, loop_attr_##_name##_show); \
711} \
712static struct device_attribute loop_attr_##_name = \
713 __ATTR(_name, S_IRUGO, loop_attr_do_show_##_name, NULL);
714
715static ssize_t loop_attr_backing_file_show(struct loop_device *lo, char *buf)
716{
717 ssize_t ret;
718 char *p = NULL;
719
Kay Sievers05eb0f22011-07-31 22:21:35 +0200720 spin_lock_irq(&lo->lo_lock);
Milan Brozee862732010-08-23 15:16:00 +0200721 if (lo->lo_backing_file)
Miklos Szeredi9bf39ab2015-06-19 10:29:13 +0200722 p = file_path(lo->lo_backing_file, buf, PAGE_SIZE - 1);
Kay Sievers05eb0f22011-07-31 22:21:35 +0200723 spin_unlock_irq(&lo->lo_lock);
Milan Brozee862732010-08-23 15:16:00 +0200724
725 if (IS_ERR_OR_NULL(p))
726 ret = PTR_ERR(p);
727 else {
728 ret = strlen(p);
729 memmove(buf, p, ret);
730 buf[ret++] = '\n';
731 buf[ret] = 0;
732 }
733
734 return ret;
735}
736
737static ssize_t loop_attr_offset_show(struct loop_device *lo, char *buf)
738{
739 return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_offset);
740}
741
742static ssize_t loop_attr_sizelimit_show(struct loop_device *lo, char *buf)
743{
744 return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_sizelimit);
745}
746
747static ssize_t loop_attr_autoclear_show(struct loop_device *lo, char *buf)
748{
749 int autoclear = (lo->lo_flags & LO_FLAGS_AUTOCLEAR);
750
751 return sprintf(buf, "%s\n", autoclear ? "1" : "0");
752}
753
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200754static ssize_t loop_attr_partscan_show(struct loop_device *lo, char *buf)
755{
756 int partscan = (lo->lo_flags & LO_FLAGS_PARTSCAN);
757
758 return sprintf(buf, "%s\n", partscan ? "1" : "0");
759}
760
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800761static ssize_t loop_attr_dio_show(struct loop_device *lo, char *buf)
762{
763 int dio = (lo->lo_flags & LO_FLAGS_DIRECT_IO);
764
765 return sprintf(buf, "%s\n", dio ? "1" : "0");
766}
767
Milan Brozee862732010-08-23 15:16:00 +0200768LOOP_ATTR_RO(backing_file);
769LOOP_ATTR_RO(offset);
770LOOP_ATTR_RO(sizelimit);
771LOOP_ATTR_RO(autoclear);
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200772LOOP_ATTR_RO(partscan);
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800773LOOP_ATTR_RO(dio);
Milan Brozee862732010-08-23 15:16:00 +0200774
775static struct attribute *loop_attrs[] = {
776 &loop_attr_backing_file.attr,
777 &loop_attr_offset.attr,
778 &loop_attr_sizelimit.attr,
779 &loop_attr_autoclear.attr,
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200780 &loop_attr_partscan.attr,
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800781 &loop_attr_dio.attr,
Milan Brozee862732010-08-23 15:16:00 +0200782 NULL,
783};
784
785static struct attribute_group loop_attribute_group = {
786 .name = "loop",
787 .attrs= loop_attrs,
788};
789
790static int loop_sysfs_init(struct loop_device *lo)
791{
792 return sysfs_create_group(&disk_to_dev(lo->lo_disk)->kobj,
793 &loop_attribute_group);
794}
795
796static void loop_sysfs_exit(struct loop_device *lo)
797{
798 sysfs_remove_group(&disk_to_dev(lo->lo_disk)->kobj,
799 &loop_attribute_group);
800}
801
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200802static void loop_config_discard(struct loop_device *lo)
803{
804 struct file *file = lo->lo_backing_file;
805 struct inode *inode = file->f_mapping->host;
806 struct request_queue *q = lo->lo_queue;
807
808 /*
809 * We use punch hole to reclaim the free space used by the
Olaf Hering12a64d22014-01-21 14:39:24 -0800810 * image a.k.a. discard. However we do not support discard if
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200811 * encryption is enabled, because it may give an attacker
812 * useful information.
813 */
814 if ((!file->f_op->fallocate) ||
815 lo->lo_encrypt_key_size) {
816 q->limits.discard_granularity = 0;
817 q->limits.discard_alignment = 0;
Jens Axboe2bb4cd52015-07-14 08:15:12 -0600818 blk_queue_max_discard_sectors(q, 0);
Christoph Hellwig19372e22017-04-05 19:21:15 +0200819 blk_queue_max_write_zeroes_sectors(q, 0);
Bart Van Assche8b904b52018-03-07 17:10:10 -0800820 blk_queue_flag_clear(QUEUE_FLAG_DISCARD, q);
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200821 return;
822 }
823
824 q->limits.discard_granularity = inode->i_sb->s_blocksize;
Lukas Czernerdfaf3c02011-12-02 14:47:03 +0100825 q->limits.discard_alignment = 0;
Hannes Reineckef2c6df72017-06-08 13:46:45 +0200826
Omar Sandoval1e6ec9e2017-08-23 14:54:59 -0700827 blk_queue_max_discard_sectors(q, UINT_MAX >> 9);
828 blk_queue_max_write_zeroes_sectors(q, UINT_MAX >> 9);
Bart Van Assche8b904b52018-03-07 17:10:10 -0800829 blk_queue_flag_set(QUEUE_FLAG_DISCARD, q);
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +0200830}
831
Ming Leie03a3d72015-08-17 10:31:48 +0800832static void loop_unprepare_queue(struct loop_device *lo)
833{
Petr Mladek39891442016-10-11 13:55:20 -0700834 kthread_flush_worker(&lo->worker);
Ming Leie03a3d72015-08-17 10:31:48 +0800835 kthread_stop(lo->worker_task);
836}
837
NeilBrownb2ee7d42017-06-16 15:02:09 +1000838static int loop_kthread_worker_fn(void *worker_ptr)
839{
840 current->flags |= PF_LESS_THROTTLE;
841 return kthread_worker_fn(worker_ptr);
842}
843
Ming Leie03a3d72015-08-17 10:31:48 +0800844static int loop_prepare_queue(struct loop_device *lo)
845{
Petr Mladek39891442016-10-11 13:55:20 -0700846 kthread_init_worker(&lo->worker);
NeilBrownb2ee7d42017-06-16 15:02:09 +1000847 lo->worker_task = kthread_run(loop_kthread_worker_fn,
Ming Leie03a3d72015-08-17 10:31:48 +0800848 &lo->worker, "loop%d", lo->lo_number);
849 if (IS_ERR(lo->worker_task))
850 return -ENOMEM;
851 set_user_nice(lo->worker_task, MIN_NICE);
852 return 0;
853}
854
Al Virobb214882008-03-02 09:29:48 -0500855static int loop_set_fd(struct loop_device *lo, fmode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 struct block_device *bdev, unsigned int arg)
857{
858 struct file *file, *f;
859 struct inode *inode;
860 struct address_space *mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 int lo_flags = 0;
862 int error;
863 loff_t size;
864
865 /* This is safe, since we have a reference from open(). */
866 __module_get(THIS_MODULE);
867
868 error = -EBADF;
869 file = fget(arg);
870 if (!file)
871 goto out;
872
873 error = -EBUSY;
874 if (lo->lo_state != Lo_unbound)
875 goto out_putf;
876
877 /* Avoid recursion */
878 f = file;
879 while (is_loop_device(f)) {
880 struct loop_device *l;
881
Al Virobb214882008-03-02 09:29:48 -0500882 if (f->f_mapping->host->i_bdev == bdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 goto out_putf;
884
885 l = f->f_mapping->host->i_bdev->bd_disk->private_data;
886 if (l->lo_state == Lo_unbound) {
887 error = -EINVAL;
888 goto out_putf;
889 }
890 f = l->lo_backing_file;
891 }
892
893 mapping = file->f_mapping;
894 inode = mapping->host;
895
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 error = -EINVAL;
Christoph Hellwig456be142011-10-17 12:57:20 +0200897 if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 goto out_putf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899
Christoph Hellwig456be142011-10-17 12:57:20 +0200900 if (!(file->f_mode & FMODE_WRITE) || !(mode & FMODE_WRITE) ||
Al Viro283e7e52015-04-03 15:21:59 -0400901 !file->f_op->write_iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 lo_flags |= LO_FLAGS_READ_ONLY;
903
Christoph Hellwig456be142011-10-17 12:57:20 +0200904 error = -EFBIG;
905 size = get_loop_size(lo, file);
906 if ((loff_t)(sector_t)size != size)
907 goto out_putf;
Ming Leie03a3d72015-08-17 10:31:48 +0800908 error = loop_prepare_queue(lo);
909 if (error)
Ming Leif4aa4c72015-05-05 19:49:54 +0800910 goto out_putf;
Christoph Hellwig456be142011-10-17 12:57:20 +0200911
912 error = 0;
913
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 set_device_ro(bdev, (lo_flags & LO_FLAGS_READ_ONLY) != 0);
915
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800916 lo->use_dio = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 lo->lo_device = bdev;
918 lo->lo_flags = lo_flags;
919 lo->lo_backing_file = file;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +0200920 lo->transfer = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 lo->ioctl = NULL;
922 lo->lo_sizelimit = 0;
923 lo->old_gfp_mask = mapping_gfp_mask(mapping);
924 mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
925
Nikanth Karthikesan68db1962009-03-24 12:29:54 +0100926 if (!(lo_flags & LO_FLAGS_READ_ONLY) && file->f_op->fsync)
Jens Axboe21d07272016-03-30 10:09:35 -0600927 blk_queue_write_cache(lo->lo_queue, true, false);
Nikanth Karthikesan68db1962009-03-24 12:29:54 +0100928
Ming Lei2e5ab5f2015-08-17 10:31:49 +0800929 loop_update_dio(lo);
Ken Chen73285082007-05-08 00:28:20 -0700930 set_capacity(lo->lo_disk, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 bd_set_size(bdev, size << 9);
Milan Brozee862732010-08-23 15:16:00 +0200932 loop_sysfs_init(lo);
David Zeuthenc3473c62010-05-03 14:08:59 +0200933 /* let user-space know about the new size */
934 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935
Omar Sandoval8a0740c2017-08-24 00:03:41 -0700936 set_blocksize(bdev, S_ISBLK(inode->i_mode) ?
937 block_size(inode->i_bdev) : PAGE_SIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
Serge E. Hallyn6c997912006-09-29 01:59:11 -0700939 lo->lo_state = Lo_bound;
Kay Sieverse03c8dd2011-08-23 20:12:04 +0200940 if (part_shift)
941 lo->lo_flags |= LO_FLAGS_PARTSCAN;
942 if (lo->lo_flags & LO_FLAGS_PARTSCAN)
Ming Lei06f0e9e2015-05-06 12:26:24 +0800943 loop_reread_partitions(lo, bdev);
Anatol Pomozovc1681bf2013-04-01 09:47:56 -0700944
945 /* Grab the block_device to prevent its destruction after we
946 * put /dev/loopXX inode. Later in loop_clr_fd() we bdput(bdev).
947 */
948 bdgrab(bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 return 0;
950
951 out_putf:
952 fput(file);
953 out:
954 /* This is safe: open() is still holding a reference. */
955 module_put(THIS_MODULE);
956 return error;
957}
958
959static int
960loop_release_xfer(struct loop_device *lo)
961{
962 int err = 0;
963 struct loop_func_table *xfer = lo->lo_encryption;
964
965 if (xfer) {
966 if (xfer->release)
967 err = xfer->release(lo);
968 lo->transfer = NULL;
969 lo->lo_encryption = NULL;
970 module_put(xfer->owner);
971 }
972 return err;
973}
974
975static int
976loop_init_xfer(struct loop_device *lo, struct loop_func_table *xfer,
977 const struct loop_info64 *i)
978{
979 int err = 0;
980
981 if (xfer) {
982 struct module *owner = xfer->owner;
983
984 if (!try_module_get(owner))
985 return -EINVAL;
986 if (xfer->init)
987 err = xfer->init(lo, i);
988 if (err)
989 module_put(owner);
990 else
991 lo->lo_encryption = xfer;
992 }
993 return err;
994}
995
Ayan George4c823cc2011-09-21 10:02:13 +0200996static int loop_clr_fd(struct loop_device *lo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997{
998 struct file *filp = lo->lo_backing_file;
Al Virob4e3ca12005-10-21 03:22:34 -0400999 gfp_t gfp = lo->old_gfp_mask;
Ayan George4c823cc2011-09-21 10:02:13 +02001000 struct block_device *bdev = lo->lo_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001
1002 if (lo->lo_state != Lo_bound)
1003 return -ENXIO;
1004
Dave Chinnera1ecac32012-09-28 10:42:23 +02001005 /*
1006 * If we've explicitly asked to tear down the loop device,
1007 * and it has an elevated reference count, set it for auto-teardown when
1008 * the last reference goes away. This stops $!~#$@ udev from
1009 * preventing teardown because it decided that it needs to run blkid on
1010 * the loopback device whenever they appear. xfstests is notorious for
1011 * failing tests because blkid via udev races with a losetup
1012 * <dev>/do something like mkfs/losetup -d <dev> causing the losetup -d
1013 * command to fail with EBUSY.
1014 */
Ming Leif8933662015-05-06 12:26:23 +08001015 if (atomic_read(&lo->lo_refcnt) > 1) {
Dave Chinnera1ecac32012-09-28 10:42:23 +02001016 lo->lo_flags |= LO_FLAGS_AUTOCLEAR;
1017 mutex_unlock(&lo->lo_ctl_mutex);
1018 return 0;
1019 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020
1021 if (filp == NULL)
1022 return -EINVAL;
1023
Ming Leif8933662015-05-06 12:26:23 +08001024 /* freeze request queue during the transition */
1025 blk_mq_freeze_queue(lo->lo_queue);
1026
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 spin_lock_irq(&lo->lo_lock);
1028 lo->lo_state = Lo_rundown;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029 lo->lo_backing_file = NULL;
Kay Sievers05eb0f22011-07-31 22:21:35 +02001030 spin_unlock_irq(&lo->lo_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031
1032 loop_release_xfer(lo);
1033 lo->transfer = NULL;
1034 lo->ioctl = NULL;
1035 lo->lo_device = NULL;
1036 lo->lo_encryption = NULL;
1037 lo->lo_offset = 0;
1038 lo->lo_sizelimit = 0;
1039 lo->lo_encrypt_key_size = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 memset(lo->lo_encrypt_key, 0, LO_KEY_SIZE);
1041 memset(lo->lo_crypt_name, 0, LO_NAME_SIZE);
1042 memset(lo->lo_file_name, 0, LO_NAME_SIZE);
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001043 blk_queue_logical_block_size(lo->lo_queue, 512);
Omar Sandovalbf093752017-09-05 14:24:47 -07001044 blk_queue_physical_block_size(lo->lo_queue, 512);
1045 blk_queue_io_min(lo->lo_queue, 512);
Anatol Pomozovc1681bf2013-04-01 09:47:56 -07001046 if (bdev) {
1047 bdput(bdev);
Al Virobb214882008-03-02 09:29:48 -05001048 invalidate_bdev(bdev);
Anatol Pomozovc1681bf2013-04-01 09:47:56 -07001049 }
Ken Chen73285082007-05-08 00:28:20 -07001050 set_capacity(lo->lo_disk, 0);
Milan Broz51a0bb02010-10-27 19:51:30 -06001051 loop_sysfs_exit(lo);
David Zeuthenc3473c62010-05-03 14:08:59 +02001052 if (bdev) {
Al Virobb214882008-03-02 09:29:48 -05001053 bd_set_size(bdev, 0);
David Zeuthenc3473c62010-05-03 14:08:59 +02001054 /* let user-space know about this change */
1055 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
1056 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 mapping_set_gfp_mask(filp->f_mapping, gfp);
1058 lo->lo_state = Lo_unbound;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 /* This is safe: open() is still holding a reference. */
1060 module_put(THIS_MODULE);
Ming Leif8933662015-05-06 12:26:23 +08001061 blk_mq_unfreeze_queue(lo->lo_queue);
1062
Jens Axboec2fccc12013-04-08 10:12:11 +02001063 if (lo->lo_flags & LO_FLAGS_PARTSCAN && bdev)
Ming Lei06f0e9e2015-05-06 12:26:24 +08001064 loop_reread_partitions(lo, bdev);
Kay Sieverse03c8dd2011-08-23 20:12:04 +02001065 lo->lo_flags = 0;
1066 if (!part_shift)
1067 lo->lo_disk->flags |= GENHD_FL_NO_PART_SCAN;
Ming Leie03a3d72015-08-17 10:31:48 +08001068 loop_unprepare_queue(lo);
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001069 mutex_unlock(&lo->lo_ctl_mutex);
1070 /*
1071 * Need not hold lo_ctl_mutex to fput backing file.
1072 * Calling fput holding lo_ctl_mutex triggers a circular
1073 * lock dependency possibility warning as fput can take
1074 * bd_mutex which is usually taken before lo_ctl_mutex.
1075 */
1076 fput(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 return 0;
1078}
1079
1080static int
1081loop_set_status(struct loop_device *lo, const struct loop_info64 *info)
1082{
1083 int err;
1084 struct loop_func_table *xfer;
Eric W. Biedermane4849732012-02-11 11:23:51 -08001085 kuid_t uid = current_uid();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086
David Howellsb0fafa82008-11-14 10:38:41 +11001087 if (lo->lo_encrypt_key_size &&
Eric W. Biedermane4849732012-02-11 11:23:51 -08001088 !uid_eq(lo->lo_key_owner, uid) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 !capable(CAP_SYS_ADMIN))
1090 return -EPERM;
1091 if (lo->lo_state != Lo_bound)
1092 return -ENXIO;
1093 if ((unsigned int) info->lo_encrypt_key_size > LO_KEY_SIZE)
1094 return -EINVAL;
1095
Ming Leiecdd0952017-02-11 11:40:45 +08001096 /* I/O need to be drained during transfer transition */
1097 blk_mq_freeze_queue(lo->lo_queue);
1098
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 err = loop_release_xfer(lo);
1100 if (err)
Ming Leiecdd0952017-02-11 11:40:45 +08001101 goto exit;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102
1103 if (info->lo_encrypt_type) {
1104 unsigned int type = info->lo_encrypt_type;
1105
1106 if (type >= MAX_LO_CRYPT)
1107 return -EINVAL;
1108 xfer = xfer_funcs[type];
1109 if (xfer == NULL)
1110 return -EINVAL;
1111 } else
1112 xfer = NULL;
1113
1114 err = loop_init_xfer(lo, xfer, info);
1115 if (err)
Ming Leiecdd0952017-02-11 11:40:45 +08001116 goto exit;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117
1118 if (lo->lo_offset != info->lo_offset ||
Omar Sandoval1e6ec9e2017-08-23 14:54:59 -07001119 lo->lo_sizelimit != info->lo_sizelimit) {
1120 if (figure_loop_size(lo, info->lo_offset, info->lo_sizelimit)) {
Ming Leiecdd0952017-02-11 11:40:45 +08001121 err = -EFBIG;
1122 goto exit;
1123 }
Arnd Bergmannb040ad92017-06-09 12:19:18 +02001124 }
Guo Chao541c7422013-02-21 15:16:46 -08001125
Lukas Czernerdfaa2ef2011-08-19 14:50:46 +02001126 loop_config_discard(lo);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127
1128 memcpy(lo->lo_file_name, info->lo_file_name, LO_NAME_SIZE);
1129 memcpy(lo->lo_crypt_name, info->lo_crypt_name, LO_NAME_SIZE);
1130 lo->lo_file_name[LO_NAME_SIZE-1] = 0;
1131 lo->lo_crypt_name[LO_NAME_SIZE-1] = 0;
1132
1133 if (!xfer)
1134 xfer = &none_funcs;
1135 lo->transfer = xfer->transfer;
1136 lo->ioctl = xfer->ioctl;
1137
David Woodhouse96c58652008-02-06 01:36:27 -08001138 if ((lo->lo_flags & LO_FLAGS_AUTOCLEAR) !=
1139 (info->lo_flags & LO_FLAGS_AUTOCLEAR))
1140 lo->lo_flags ^= LO_FLAGS_AUTOCLEAR;
1141
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 lo->lo_encrypt_key_size = info->lo_encrypt_key_size;
1143 lo->lo_init[0] = info->lo_init[0];
1144 lo->lo_init[1] = info->lo_init[1];
1145 if (info->lo_encrypt_key_size) {
1146 memcpy(lo->lo_encrypt_key, info->lo_encrypt_key,
1147 info->lo_encrypt_key_size);
David Howellsb0fafa82008-11-14 10:38:41 +11001148 lo->lo_key_owner = uid;
Christoph Hellwigaa4d8612015-04-07 18:23:29 +02001149 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150
Ming Lei2e5ab5f2015-08-17 10:31:49 +08001151 /* update dio if lo_offset or transfer is changed */
1152 __loop_update_dio(lo, lo->use_dio);
1153
Ming Leiecdd0952017-02-11 11:40:45 +08001154 exit:
1155 blk_mq_unfreeze_queue(lo->lo_queue);
Omar Sandovale02898b42017-03-01 10:42:38 -08001156
1157 if (!err && (info->lo_flags & LO_FLAGS_PARTSCAN) &&
1158 !(lo->lo_flags & LO_FLAGS_PARTSCAN)) {
1159 lo->lo_flags |= LO_FLAGS_PARTSCAN;
1160 lo->lo_disk->flags &= ~GENHD_FL_NO_PART_SCAN;
1161 loop_reread_partitions(lo, lo->lo_device);
1162 }
1163
Ming Leiecdd0952017-02-11 11:40:45 +08001164 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165}
1166
1167static int
1168loop_get_status(struct loop_device *lo, struct loop_info64 *info)
1169{
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001170 struct file *file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 struct kstat stat;
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001172 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001174 if (lo->lo_state != Lo_bound) {
1175 mutex_unlock(&lo->lo_ctl_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176 return -ENXIO;
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001177 }
1178
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 memset(info, 0, sizeof(*info));
1180 info->lo_number = lo->lo_number;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 info->lo_offset = lo->lo_offset;
1182 info->lo_sizelimit = lo->lo_sizelimit;
1183 info->lo_flags = lo->lo_flags;
1184 memcpy(info->lo_file_name, lo->lo_file_name, LO_NAME_SIZE);
1185 memcpy(info->lo_crypt_name, lo->lo_crypt_name, LO_NAME_SIZE);
1186 info->lo_encrypt_type =
1187 lo->lo_encryption ? lo->lo_encryption->number : 0;
1188 if (lo->lo_encrypt_key_size && capable(CAP_SYS_ADMIN)) {
1189 info->lo_encrypt_key_size = lo->lo_encrypt_key_size;
1190 memcpy(info->lo_encrypt_key, lo->lo_encrypt_key,
1191 lo->lo_encrypt_key_size);
1192 }
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001193
1194 /* Drop lo_ctl_mutex while we call into the filesystem. */
1195 file = get_file(lo->lo_backing_file);
1196 mutex_unlock(&lo->lo_ctl_mutex);
1197 ret = vfs_getattr(&file->f_path, &stat, STATX_INO,
1198 AT_STATX_SYNC_AS_STAT);
1199 if (!ret) {
1200 info->lo_device = huge_encode_dev(stat.dev);
1201 info->lo_inode = stat.ino;
1202 info->lo_rdevice = huge_encode_dev(stat.rdev);
1203 }
1204 fput(file);
1205 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206}
1207
1208static void
1209loop_info64_from_old(const struct loop_info *info, struct loop_info64 *info64)
1210{
1211 memset(info64, 0, sizeof(*info64));
1212 info64->lo_number = info->lo_number;
1213 info64->lo_device = info->lo_device;
1214 info64->lo_inode = info->lo_inode;
1215 info64->lo_rdevice = info->lo_rdevice;
1216 info64->lo_offset = info->lo_offset;
1217 info64->lo_sizelimit = 0;
1218 info64->lo_encrypt_type = info->lo_encrypt_type;
1219 info64->lo_encrypt_key_size = info->lo_encrypt_key_size;
1220 info64->lo_flags = info->lo_flags;
1221 info64->lo_init[0] = info->lo_init[0];
1222 info64->lo_init[1] = info->lo_init[1];
1223 if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1224 memcpy(info64->lo_crypt_name, info->lo_name, LO_NAME_SIZE);
1225 else
1226 memcpy(info64->lo_file_name, info->lo_name, LO_NAME_SIZE);
1227 memcpy(info64->lo_encrypt_key, info->lo_encrypt_key, LO_KEY_SIZE);
1228}
1229
1230static int
1231loop_info64_to_old(const struct loop_info64 *info64, struct loop_info *info)
1232{
1233 memset(info, 0, sizeof(*info));
1234 info->lo_number = info64->lo_number;
1235 info->lo_device = info64->lo_device;
1236 info->lo_inode = info64->lo_inode;
1237 info->lo_rdevice = info64->lo_rdevice;
1238 info->lo_offset = info64->lo_offset;
1239 info->lo_encrypt_type = info64->lo_encrypt_type;
1240 info->lo_encrypt_key_size = info64->lo_encrypt_key_size;
1241 info->lo_flags = info64->lo_flags;
1242 info->lo_init[0] = info64->lo_init[0];
1243 info->lo_init[1] = info64->lo_init[1];
1244 if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1245 memcpy(info->lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1246 else
1247 memcpy(info->lo_name, info64->lo_file_name, LO_NAME_SIZE);
1248 memcpy(info->lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1249
1250 /* error in case values were truncated */
1251 if (info->lo_device != info64->lo_device ||
1252 info->lo_rdevice != info64->lo_rdevice ||
1253 info->lo_inode != info64->lo_inode ||
1254 info->lo_offset != info64->lo_offset)
1255 return -EOVERFLOW;
1256
1257 return 0;
1258}
1259
1260static int
1261loop_set_status_old(struct loop_device *lo, const struct loop_info __user *arg)
1262{
1263 struct loop_info info;
1264 struct loop_info64 info64;
1265
1266 if (copy_from_user(&info, arg, sizeof (struct loop_info)))
1267 return -EFAULT;
1268 loop_info64_from_old(&info, &info64);
1269 return loop_set_status(lo, &info64);
1270}
1271
1272static int
1273loop_set_status64(struct loop_device *lo, const struct loop_info64 __user *arg)
1274{
1275 struct loop_info64 info64;
1276
1277 if (copy_from_user(&info64, arg, sizeof (struct loop_info64)))
1278 return -EFAULT;
1279 return loop_set_status(lo, &info64);
1280}
1281
1282static int
1283loop_get_status_old(struct loop_device *lo, struct loop_info __user *arg) {
1284 struct loop_info info;
1285 struct loop_info64 info64;
1286 int err = 0;
1287
1288 if (!arg)
1289 err = -EINVAL;
1290 if (!err)
1291 err = loop_get_status(lo, &info64);
1292 if (!err)
1293 err = loop_info64_to_old(&info64, &info);
1294 if (!err && copy_to_user(arg, &info, sizeof(info)))
1295 err = -EFAULT;
1296
1297 return err;
1298}
1299
1300static int
1301loop_get_status64(struct loop_device *lo, struct loop_info64 __user *arg) {
1302 struct loop_info64 info64;
1303 int err = 0;
1304
1305 if (!arg)
1306 err = -EINVAL;
1307 if (!err)
1308 err = loop_get_status(lo, &info64);
1309 if (!err && copy_to_user(arg, &info64, sizeof(info64)))
1310 err = -EFAULT;
1311
1312 return err;
1313}
1314
Hannes Reinecke51001b72017-06-08 13:46:44 +02001315static int loop_set_capacity(struct loop_device *lo)
J. R. Okajima53d66602009-03-31 15:23:43 -07001316{
J. R. Okajima53d66602009-03-31 15:23:43 -07001317 if (unlikely(lo->lo_state != Lo_bound))
Guo Chao7b0576a2013-02-21 15:16:47 -08001318 return -ENXIO;
J. R. Okajima53d66602009-03-31 15:23:43 -07001319
Omar Sandoval1e6ec9e2017-08-23 14:54:59 -07001320 return figure_loop_size(lo, lo->lo_offset, lo->lo_sizelimit);
J. R. Okajima53d66602009-03-31 15:23:43 -07001321}
1322
Ming Leiab1cb272015-08-17 10:31:50 +08001323static int loop_set_dio(struct loop_device *lo, unsigned long arg)
1324{
1325 int error = -ENXIO;
1326 if (lo->lo_state != Lo_bound)
1327 goto out;
1328
1329 __loop_update_dio(lo, !!arg);
1330 if (lo->use_dio == !!arg)
1331 return 0;
1332 error = -EINVAL;
1333 out:
1334 return error;
1335}
1336
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001337static int loop_set_block_size(struct loop_device *lo, unsigned long arg)
1338{
1339 if (lo->lo_state != Lo_bound)
1340 return -ENXIO;
1341
1342 if (arg < 512 || arg > PAGE_SIZE || !is_power_of_2(arg))
1343 return -EINVAL;
1344
1345 blk_mq_freeze_queue(lo->lo_queue);
1346
1347 blk_queue_logical_block_size(lo->lo_queue, arg);
Omar Sandovalbf093752017-09-05 14:24:47 -07001348 blk_queue_physical_block_size(lo->lo_queue, arg);
1349 blk_queue_io_min(lo->lo_queue, arg);
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001350 loop_update_dio(lo);
1351
1352 blk_mq_unfreeze_queue(lo->lo_queue);
1353
1354 return 0;
1355}
1356
Al Virobb214882008-03-02 09:29:48 -05001357static int lo_ioctl(struct block_device *bdev, fmode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 unsigned int cmd, unsigned long arg)
1359{
Al Virobb214882008-03-02 09:29:48 -05001360 struct loop_device *lo = bdev->bd_disk->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 int err;
1362
Omar Sandoval3148ffb2018-03-26 21:39:12 -07001363 err = mutex_lock_killable_nested(&lo->lo_ctl_mutex, 1);
1364 if (err)
1365 goto out_unlocked;
1366
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 switch (cmd) {
1368 case LOOP_SET_FD:
Al Virobb214882008-03-02 09:29:48 -05001369 err = loop_set_fd(lo, mode, bdev, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 break;
1371 case LOOP_CHANGE_FD:
Al Virobb214882008-03-02 09:29:48 -05001372 err = loop_change_fd(lo, bdev, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 break;
1374 case LOOP_CLR_FD:
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001375 /* loop_clr_fd would have unlocked lo_ctl_mutex on success */
Ayan George4c823cc2011-09-21 10:02:13 +02001376 err = loop_clr_fd(lo);
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001377 if (!err)
1378 goto out_unlocked;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 break;
1380 case LOOP_SET_STATUS:
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +01001381 err = -EPERM;
1382 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1383 err = loop_set_status_old(lo,
1384 (struct loop_info __user *)arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 break;
1386 case LOOP_GET_STATUS:
1387 err = loop_get_status_old(lo, (struct loop_info __user *) arg);
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001388 /* loop_get_status() unlocks lo_ctl_mutex */
1389 goto out_unlocked;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 case LOOP_SET_STATUS64:
Dmitry Monakhov7035b5d2011-11-16 09:21:49 +01001391 err = -EPERM;
1392 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1393 err = loop_set_status64(lo,
1394 (struct loop_info64 __user *) arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 break;
1396 case LOOP_GET_STATUS64:
1397 err = loop_get_status64(lo, (struct loop_info64 __user *) arg);
Omar Sandoval2d1d4c12018-03-26 21:39:11 -07001398 /* loop_get_status() unlocks lo_ctl_mutex */
1399 goto out_unlocked;
J. R. Okajima53d66602009-03-31 15:23:43 -07001400 case LOOP_SET_CAPACITY:
1401 err = -EPERM;
1402 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
Hannes Reinecke51001b72017-06-08 13:46:44 +02001403 err = loop_set_capacity(lo);
J. R. Okajima53d66602009-03-31 15:23:43 -07001404 break;
Ming Leiab1cb272015-08-17 10:31:50 +08001405 case LOOP_SET_DIRECT_IO:
1406 err = -EPERM;
1407 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1408 err = loop_set_dio(lo, arg);
1409 break;
Omar Sandoval89e4fde2017-08-24 00:03:43 -07001410 case LOOP_SET_BLOCK_SIZE:
1411 err = -EPERM;
1412 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1413 err = loop_set_block_size(lo, arg);
1414 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415 default:
1416 err = lo->ioctl ? lo->ioctl(lo, cmd, arg) : -EINVAL;
1417 }
Ingo Molnarf85221d2006-03-23 03:00:38 -08001418 mutex_unlock(&lo->lo_ctl_mutex);
Nikanth Karthikesanf028f3b2009-03-24 12:33:41 +01001419
1420out_unlocked:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 return err;
1422}
1423
David Howells863d5b822006-08-29 19:06:14 +01001424#ifdef CONFIG_COMPAT
1425struct compat_loop_info {
1426 compat_int_t lo_number; /* ioctl r/o */
1427 compat_dev_t lo_device; /* ioctl r/o */
1428 compat_ulong_t lo_inode; /* ioctl r/o */
1429 compat_dev_t lo_rdevice; /* ioctl r/o */
1430 compat_int_t lo_offset;
1431 compat_int_t lo_encrypt_type;
1432 compat_int_t lo_encrypt_key_size; /* ioctl w/o */
1433 compat_int_t lo_flags; /* ioctl r/o */
1434 char lo_name[LO_NAME_SIZE];
1435 unsigned char lo_encrypt_key[LO_KEY_SIZE]; /* ioctl w/o */
1436 compat_ulong_t lo_init[2];
1437 char reserved[4];
1438};
1439
1440/*
1441 * Transfer 32-bit compatibility structure in userspace to 64-bit loop info
1442 * - noinlined to reduce stack space usage in main part of driver
1443 */
1444static noinline int
Al Viroba674cf2006-10-10 22:48:27 +01001445loop_info64_from_compat(const struct compat_loop_info __user *arg,
David Howells863d5b822006-08-29 19:06:14 +01001446 struct loop_info64 *info64)
1447{
1448 struct compat_loop_info info;
1449
1450 if (copy_from_user(&info, arg, sizeof(info)))
1451 return -EFAULT;
1452
1453 memset(info64, 0, sizeof(*info64));
1454 info64->lo_number = info.lo_number;
1455 info64->lo_device = info.lo_device;
1456 info64->lo_inode = info.lo_inode;
1457 info64->lo_rdevice = info.lo_rdevice;
1458 info64->lo_offset = info.lo_offset;
1459 info64->lo_sizelimit = 0;
1460 info64->lo_encrypt_type = info.lo_encrypt_type;
1461 info64->lo_encrypt_key_size = info.lo_encrypt_key_size;
1462 info64->lo_flags = info.lo_flags;
1463 info64->lo_init[0] = info.lo_init[0];
1464 info64->lo_init[1] = info.lo_init[1];
1465 if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1466 memcpy(info64->lo_crypt_name, info.lo_name, LO_NAME_SIZE);
1467 else
1468 memcpy(info64->lo_file_name, info.lo_name, LO_NAME_SIZE);
1469 memcpy(info64->lo_encrypt_key, info.lo_encrypt_key, LO_KEY_SIZE);
1470 return 0;
1471}
1472
1473/*
1474 * Transfer 64-bit loop info to 32-bit compatibility structure in userspace
1475 * - noinlined to reduce stack space usage in main part of driver
1476 */
1477static noinline int
1478loop_info64_to_compat(const struct loop_info64 *info64,
1479 struct compat_loop_info __user *arg)
1480{
1481 struct compat_loop_info info;
1482
1483 memset(&info, 0, sizeof(info));
1484 info.lo_number = info64->lo_number;
1485 info.lo_device = info64->lo_device;
1486 info.lo_inode = info64->lo_inode;
1487 info.lo_rdevice = info64->lo_rdevice;
1488 info.lo_offset = info64->lo_offset;
1489 info.lo_encrypt_type = info64->lo_encrypt_type;
1490 info.lo_encrypt_key_size = info64->lo_encrypt_key_size;
1491 info.lo_flags = info64->lo_flags;
1492 info.lo_init[0] = info64->lo_init[0];
1493 info.lo_init[1] = info64->lo_init[1];
1494 if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1495 memcpy(info.lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1496 else
1497 memcpy(info.lo_name, info64->lo_file_name, LO_NAME_SIZE);
1498 memcpy(info.lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1499
1500 /* error in case values were truncated */
1501 if (info.lo_device != info64->lo_device ||
1502 info.lo_rdevice != info64->lo_rdevice ||
1503 info.lo_inode != info64->lo_inode ||
1504 info.lo_offset != info64->lo_offset ||
1505 info.lo_init[0] != info64->lo_init[0] ||
1506 info.lo_init[1] != info64->lo_init[1])
1507 return -EOVERFLOW;
1508
1509 if (copy_to_user(arg, &info, sizeof(info)))
1510 return -EFAULT;
1511 return 0;
1512}
1513
1514static int
1515loop_set_status_compat(struct loop_device *lo,
1516 const struct compat_loop_info __user *arg)
1517{
1518 struct loop_info64 info64;
1519 int ret;
1520
1521 ret = loop_info64_from_compat(arg, &info64);
1522 if (ret < 0)
1523 return ret;
1524 return loop_set_status(lo, &info64);
1525}
1526
1527static int
1528loop_get_status_compat(struct loop_device *lo,
1529 struct compat_loop_info __user *arg)
1530{
1531 struct loop_info64 info64;
1532 int err = 0;
1533
1534 if (!arg)
1535 err = -EINVAL;
1536 if (!err)
1537 err = loop_get_status(lo, &info64);
1538 if (!err)
1539 err = loop_info64_to_compat(&info64, arg);
1540 return err;
1541}
1542
Al Virobb214882008-03-02 09:29:48 -05001543static int lo_compat_ioctl(struct block_device *bdev, fmode_t mode,
1544 unsigned int cmd, unsigned long arg)
David Howells863d5b822006-08-29 19:06:14 +01001545{
Al Virobb214882008-03-02 09:29:48 -05001546 struct loop_device *lo = bdev->bd_disk->private_data;
David Howells863d5b822006-08-29 19:06:14 +01001547 int err;
1548
David Howells863d5b822006-08-29 19:06:14 +01001549 switch(cmd) {
1550 case LOOP_SET_STATUS:
Omar Sandoval3148ffb2018-03-26 21:39:12 -07001551 err = mutex_lock_killable(&lo->lo_ctl_mutex);
1552 if (!err) {
1553 err = loop_set_status_compat(lo,
1554 (const struct compat_loop_info __user *)arg);
1555 mutex_unlock(&lo->lo_ctl_mutex);
1556 }
David Howells863d5b822006-08-29 19:06:14 +01001557 break;
1558 case LOOP_GET_STATUS:
Omar Sandoval3148ffb2018-03-26 21:39:12 -07001559 err = mutex_lock_killable(&lo->lo_ctl_mutex);
1560 if (!err) {
1561 err = loop_get_status_compat(lo,
1562 (struct compat_loop_info __user *)arg);
1563 /* loop_get_status() unlocks lo_ctl_mutex */
1564 }
David Howells863d5b822006-08-29 19:06:14 +01001565 break;
J. R. Okajima53d66602009-03-31 15:23:43 -07001566 case LOOP_SET_CAPACITY:
David Howells863d5b822006-08-29 19:06:14 +01001567 case LOOP_CLR_FD:
1568 case LOOP_GET_STATUS64:
1569 case LOOP_SET_STATUS64:
1570 arg = (unsigned long) compat_ptr(arg);
1571 case LOOP_SET_FD:
1572 case LOOP_CHANGE_FD:
Al Virobb214882008-03-02 09:29:48 -05001573 err = lo_ioctl(bdev, mode, cmd, arg);
David Howells863d5b822006-08-29 19:06:14 +01001574 break;
1575 default:
1576 err = -ENOIOCTLCMD;
1577 break;
1578 }
David Howells863d5b822006-08-29 19:06:14 +01001579 return err;
1580}
1581#endif
1582
Al Virobb214882008-03-02 09:29:48 -05001583static int lo_open(struct block_device *bdev, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584{
Kay Sievers770fe302011-07-31 22:08:04 +02001585 struct loop_device *lo;
1586 int err = 0;
1587
1588 mutex_lock(&loop_index_mutex);
1589 lo = bdev->bd_disk->private_data;
1590 if (!lo) {
1591 err = -ENXIO;
1592 goto out;
1593 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594
Ming Leif8933662015-05-06 12:26:23 +08001595 atomic_inc(&lo->lo_refcnt);
Kay Sievers770fe302011-07-31 22:08:04 +02001596out:
1597 mutex_unlock(&loop_index_mutex);
1598 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599}
1600
Linus Torvaldsae665012018-01-05 16:26:00 -08001601static void __lo_release(struct loop_device *lo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602{
Alexander Beregalovffcd7dc2009-04-07 13:48:21 +02001603 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604
Ming Leif8933662015-05-06 12:26:23 +08001605 if (atomic_dec_return(&lo->lo_refcnt))
1606 return;
1607
Ingo Molnarf85221d2006-03-23 03:00:38 -08001608 mutex_lock(&lo->lo_ctl_mutex);
Milan Broz14f27932008-12-12 14:48:27 +01001609 if (lo->lo_flags & LO_FLAGS_AUTOCLEAR) {
1610 /*
1611 * In autoclear mode, stop the loop thread
1612 * and remove configuration after last close.
1613 */
Ayan George4c823cc2011-09-21 10:02:13 +02001614 err = loop_clr_fd(lo);
Alexander Beregalovffcd7dc2009-04-07 13:48:21 +02001615 if (!err)
Al Virodb2a1442013-05-05 21:52:57 -04001616 return;
Omar Sandoval43cade802017-08-24 00:03:44 -07001617 } else if (lo->lo_state == Lo_bound) {
Milan Broz14f27932008-12-12 14:48:27 +01001618 /*
1619 * Otherwise keep thread (if running) and config,
1620 * but flush possible ongoing bios in thread.
1621 */
Omar Sandoval43cade802017-08-24 00:03:44 -07001622 blk_mq_freeze_queue(lo->lo_queue);
1623 blk_mq_unfreeze_queue(lo->lo_queue);
Milan Broz14f27932008-12-12 14:48:27 +01001624 }
David Woodhouse96c58652008-02-06 01:36:27 -08001625
Ingo Molnarf85221d2006-03-23 03:00:38 -08001626 mutex_unlock(&lo->lo_ctl_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627}
1628
Linus Torvaldsae665012018-01-05 16:26:00 -08001629static void lo_release(struct gendisk *disk, fmode_t mode)
1630{
1631 mutex_lock(&loop_index_mutex);
1632 __lo_release(disk->private_data);
1633 mutex_unlock(&loop_index_mutex);
1634}
1635
Alexey Dobriyan83d5cde2009-09-21 17:01:13 -07001636static const struct block_device_operations lo_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 .owner = THIS_MODULE,
Al Virobb214882008-03-02 09:29:48 -05001638 .open = lo_open,
1639 .release = lo_release,
1640 .ioctl = lo_ioctl,
David Howells863d5b822006-08-29 19:06:14 +01001641#ifdef CONFIG_COMPAT
Al Virobb214882008-03-02 09:29:48 -05001642 .compat_ioctl = lo_compat_ioctl,
David Howells863d5b822006-08-29 19:06:14 +01001643#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644};
1645
1646/*
1647 * And now the modules code and kernel interface.
1648 */
Ken Chen73285082007-05-08 00:28:20 -07001649static int max_loop;
Namhyung Kimac04fee2011-05-27 07:59:25 +02001650module_param(max_loop, int, S_IRUGO);
Ken Chena47653f2007-06-08 13:46:44 -07001651MODULE_PARM_DESC(max_loop, "Maximum number of loop devices");
Namhyung Kimac04fee2011-05-27 07:59:25 +02001652module_param(max_part, int, S_IRUGO);
Laurent Vivier476a4812008-03-26 12:11:53 +01001653MODULE_PARM_DESC(max_part, "Maximum number of partitions per loop device");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654MODULE_LICENSE("GPL");
1655MODULE_ALIAS_BLOCKDEV_MAJOR(LOOP_MAJOR);
1656
1657int loop_register_transfer(struct loop_func_table *funcs)
1658{
1659 unsigned int n = funcs->number;
1660
1661 if (n >= MAX_LO_CRYPT || xfer_funcs[n])
1662 return -EINVAL;
1663 xfer_funcs[n] = funcs;
1664 return 0;
1665}
1666
Kay Sievers34dd82a2011-07-31 22:08:04 +02001667static int unregister_transfer_cb(int id, void *ptr, void *data)
1668{
1669 struct loop_device *lo = ptr;
1670 struct loop_func_table *xfer = data;
1671
1672 mutex_lock(&lo->lo_ctl_mutex);
1673 if (lo->lo_encryption == xfer)
1674 loop_release_xfer(lo);
1675 mutex_unlock(&lo->lo_ctl_mutex);
1676 return 0;
1677}
1678
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679int loop_unregister_transfer(int number)
1680{
1681 unsigned int n = number;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 struct loop_func_table *xfer;
1683
1684 if (n == 0 || n >= MAX_LO_CRYPT || (xfer = xfer_funcs[n]) == NULL)
1685 return -EINVAL;
1686
1687 xfer_funcs[n] = NULL;
Kay Sievers34dd82a2011-07-31 22:08:04 +02001688 idr_for_each(&loop_index_idr, &unregister_transfer_cb, xfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689 return 0;
1690}
1691
1692EXPORT_SYMBOL(loop_register_transfer);
1693EXPORT_SYMBOL(loop_unregister_transfer);
1694
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001695static blk_status_t loop_queue_rq(struct blk_mq_hw_ctx *hctx,
Ming Leib5dd2f62014-12-31 13:22:57 +00001696 const struct blk_mq_queue_data *bd)
1697{
1698 struct loop_cmd *cmd = blk_mq_rq_to_pdu(bd->rq);
Ming Leif4aa4c72015-05-05 19:49:54 +08001699 struct loop_device *lo = cmd->rq->q->queuedata;
Ming Leib5dd2f62014-12-31 13:22:57 +00001700
1701 blk_mq_start_request(bd->rq);
1702
Ming Leif4aa4c72015-05-05 19:49:54 +08001703 if (lo->lo_state != Lo_bound)
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001704 return BLK_STS_IOERR;
Ming Leif4aa4c72015-05-05 19:49:54 +08001705
Christoph Hellwigf0225ca2016-08-04 16:10:00 +02001706 switch (req_op(cmd->rq)) {
1707 case REQ_OP_FLUSH:
1708 case REQ_OP_DISCARD:
Christoph Hellwig19372e22017-04-05 19:21:15 +02001709 case REQ_OP_WRITE_ZEROES:
Ming Leibc07c102015-08-17 10:31:51 +08001710 cmd->use_aio = false;
Christoph Hellwigf0225ca2016-08-04 16:10:00 +02001711 break;
1712 default:
1713 cmd->use_aio = lo->use_dio;
1714 break;
1715 }
Ming Leibc07c102015-08-17 10:31:51 +08001716
Shaohua Lid4478e92017-09-25 13:07:22 -06001717 /* always use the first bio's css */
Shaohua Li0b508bc2017-09-26 11:02:12 -07001718#ifdef CONFIG_BLK_CGROUP
Shaohua Lid4478e92017-09-25 13:07:22 -06001719 if (cmd->use_aio && cmd->rq->bio && cmd->rq->bio->bi_css) {
1720 cmd->css = cmd->rq->bio->bi_css;
1721 css_get(cmd->css);
1722 } else
1723#endif
1724 cmd->css = NULL;
Petr Mladek39891442016-10-11 13:55:20 -07001725 kthread_queue_work(&lo->worker, &cmd->work);
Ming Leib5dd2f62014-12-31 13:22:57 +00001726
Christoph Hellwigfc17b652017-06-03 09:38:05 +02001727 return BLK_STS_OK;
Ming Leib5dd2f62014-12-31 13:22:57 +00001728}
1729
1730static void loop_handle_cmd(struct loop_cmd *cmd)
1731{
Mike Christiea8ebb052016-06-05 14:31:45 -05001732 const bool write = op_is_write(req_op(cmd->rq));
Ming Leib5dd2f62014-12-31 13:22:57 +00001733 struct loop_device *lo = cmd->rq->q->queuedata;
Christoph Hellwigf4829a92015-09-27 21:01:50 +02001734 int ret = 0;
Ming Leib5dd2f62014-12-31 13:22:57 +00001735
Christoph Hellwigf4829a92015-09-27 21:01:50 +02001736 if (write && (lo->lo_flags & LO_FLAGS_READ_ONLY)) {
1737 ret = -EIO;
Ming Leib5dd2f62014-12-31 13:22:57 +00001738 goto failed;
Christoph Hellwigf4829a92015-09-27 21:01:50 +02001739 }
Ming Leib5dd2f62014-12-31 13:22:57 +00001740
Ming Lei30112012014-12-31 13:22:58 +00001741 ret = do_req_filebacked(lo, cmd->rq);
Ming Leib5dd2f62014-12-31 13:22:57 +00001742 failed:
Ming Leibc07c102015-08-17 10:31:51 +08001743 /* complete non-aio request */
Christoph Hellwigfe2cb292017-04-20 16:03:02 +02001744 if (!cmd->use_aio || ret) {
1745 cmd->ret = ret ? -EIO : 0;
Christoph Hellwig08e00292017-04-20 16:03:09 +02001746 blk_mq_complete_request(cmd->rq);
Christoph Hellwigfe2cb292017-04-20 16:03:02 +02001747 }
Ming Leib5dd2f62014-12-31 13:22:57 +00001748}
1749
Ming Leie03a3d72015-08-17 10:31:48 +08001750static void loop_queue_work(struct kthread_work *work)
Ming Leib5dd2f62014-12-31 13:22:57 +00001751{
1752 struct loop_cmd *cmd =
Ming Leie03a3d72015-08-17 10:31:48 +08001753 container_of(work, struct loop_cmd, work);
Ming Leib5dd2f62014-12-31 13:22:57 +00001754
1755 loop_handle_cmd(cmd);
1756}
1757
Christoph Hellwigd6296d392017-05-01 10:19:08 -06001758static int loop_init_request(struct blk_mq_tag_set *set, struct request *rq,
1759 unsigned int hctx_idx, unsigned int numa_node)
Ming Leib5dd2f62014-12-31 13:22:57 +00001760{
1761 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
1762
1763 cmd->rq = rq;
Petr Mladek39891442016-10-11 13:55:20 -07001764 kthread_init_work(&cmd->work, loop_queue_work);
Ming Leib5dd2f62014-12-31 13:22:57 +00001765
1766 return 0;
1767}
1768
Eric Biggersf363b082017-03-30 13:39:16 -07001769static const struct blk_mq_ops loop_mq_ops = {
Ming Leib5dd2f62014-12-31 13:22:57 +00001770 .queue_rq = loop_queue_rq,
Ming Leib5dd2f62014-12-31 13:22:57 +00001771 .init_request = loop_init_request,
Christoph Hellwigfe2cb292017-04-20 16:03:02 +02001772 .complete = lo_complete_rq,
Ming Leib5dd2f62014-12-31 13:22:57 +00001773};
1774
Kay Sievers34dd82a2011-07-31 22:08:04 +02001775static int loop_add(struct loop_device **l, int i)
Ken Chen73285082007-05-08 00:28:20 -07001776{
1777 struct loop_device *lo;
1778 struct gendisk *disk;
Kay Sievers34dd82a2011-07-31 22:08:04 +02001779 int err;
Ken Chen73285082007-05-08 00:28:20 -07001780
Silva Paulo68d740d2012-07-14 15:39:58 -07001781 err = -ENOMEM;
Ken Chen73285082007-05-08 00:28:20 -07001782 lo = kzalloc(sizeof(*lo), GFP_KERNEL);
Silva Paulo68d740d2012-07-14 15:39:58 -07001783 if (!lo)
Ken Chen73285082007-05-08 00:28:20 -07001784 goto out;
Kay Sievers34dd82a2011-07-31 22:08:04 +02001785
Mikulas Patockaef7e7c82013-10-15 14:14:38 -06001786 lo->lo_state = Lo_unbound;
1787
Tejun Heoc718aa62013-02-27 17:03:58 -08001788 /* allocate id, if @id >= 0, we're requesting that specific id */
Kay Sievers34dd82a2011-07-31 22:08:04 +02001789 if (i >= 0) {
Tejun Heoc718aa62013-02-27 17:03:58 -08001790 err = idr_alloc(&loop_index_idr, lo, i, i + 1, GFP_KERNEL);
1791 if (err == -ENOSPC)
Kay Sievers34dd82a2011-07-31 22:08:04 +02001792 err = -EEXIST;
Kay Sievers34dd82a2011-07-31 22:08:04 +02001793 } else {
Tejun Heoc718aa62013-02-27 17:03:58 -08001794 err = idr_alloc(&loop_index_idr, lo, 0, 0, GFP_KERNEL);
Kay Sievers34dd82a2011-07-31 22:08:04 +02001795 }
1796 if (err < 0)
1797 goto out_free_dev;
Tejun Heoc718aa62013-02-27 17:03:58 -08001798 i = err;
Ken Chen73285082007-05-08 00:28:20 -07001799
Wei Yongjun183cfb52013-03-22 08:59:19 -06001800 err = -ENOMEM;
Ming Leib5dd2f62014-12-31 13:22:57 +00001801 lo->tag_set.ops = &loop_mq_ops;
1802 lo->tag_set.nr_hw_queues = 1;
1803 lo->tag_set.queue_depth = 128;
1804 lo->tag_set.numa_node = NUMA_NO_NODE;
1805 lo->tag_set.cmd_size = sizeof(struct loop_cmd);
1806 lo->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
1807 lo->tag_set.driver_data = lo;
1808
1809 err = blk_mq_alloc_tag_set(&lo->tag_set);
1810 if (err)
Mikulas Patocka3ec981e2013-10-14 12:12:24 -04001811 goto out_free_idr;
Ken Chen73285082007-05-08 00:28:20 -07001812
Ming Leib5dd2f62014-12-31 13:22:57 +00001813 lo->lo_queue = blk_mq_init_queue(&lo->tag_set);
1814 if (IS_ERR_OR_NULL(lo->lo_queue)) {
1815 err = PTR_ERR(lo->lo_queue);
1816 goto out_cleanup_tags;
1817 }
Mikulas Patockaef7e7c82013-10-15 14:14:38 -06001818 lo->lo_queue->queuedata = lo;
1819
Shaohua Li54bb0ad2017-08-31 22:09:45 -07001820 blk_queue_max_hw_sectors(lo->lo_queue, BLK_DEF_MAX_SECTORS);
Shaohua Li40326d82017-08-31 22:09:46 -07001821
Ming Lei5b5e20f2015-08-17 10:31:47 +08001822 /*
Shaohua Li40326d82017-08-31 22:09:46 -07001823 * By default, we do buffer IO, so it doesn't make sense to enable
1824 * merge because the I/O submitted to backing file is handled page by
1825 * page. For directio mode, merge does help to dispatch bigger request
1826 * to underlayer disk. We will enable merge once directio is enabled.
Ming Lei5b5e20f2015-08-17 10:31:47 +08001827 */
Bart Van Assche8b904b52018-03-07 17:10:10 -08001828 blk_queue_flag_set(QUEUE_FLAG_NOMERGES, lo->lo_queue);
Ming Lei5b5e20f2015-08-17 10:31:47 +08001829
Minfei Huang7a649732016-06-07 10:05:15 +08001830 err = -ENOMEM;
Laurent Vivier476a4812008-03-26 12:11:53 +01001831 disk = lo->lo_disk = alloc_disk(1 << part_shift);
Ken Chen73285082007-05-08 00:28:20 -07001832 if (!disk)
1833 goto out_free_queue;
1834
Kay Sieverse03c8dd2011-08-23 20:12:04 +02001835 /*
1836 * Disable partition scanning by default. The in-kernel partition
1837 * scanning can be requested individually per-device during its
1838 * setup. Userspace can always add and remove partitions from all
1839 * devices. The needed partition minors are allocated from the
1840 * extended minor space, the main loop device numbers will continue
1841 * to match the loop minors, regardless of the number of partitions
1842 * used.
1843 *
1844 * If max_part is given, partition scanning is globally enabled for
1845 * all loop devices. The minors for the main loop devices will be
1846 * multiples of max_part.
1847 *
1848 * Note: Global-for-all-devices, set-only-at-init, read-only module
1849 * parameteters like 'max_loop' and 'max_part' make things needlessly
1850 * complicated, are too static, inflexible and may surprise
1851 * userspace tools. Parameters like this in general should be avoided.
1852 */
1853 if (!part_shift)
1854 disk->flags |= GENHD_FL_NO_PART_SCAN;
1855 disk->flags |= GENHD_FL_EXT_DEVT;
Ken Chen73285082007-05-08 00:28:20 -07001856 mutex_init(&lo->lo_ctl_mutex);
Ming Leif8933662015-05-06 12:26:23 +08001857 atomic_set(&lo->lo_refcnt, 0);
Ken Chen73285082007-05-08 00:28:20 -07001858 lo->lo_number = i;
Ken Chen73285082007-05-08 00:28:20 -07001859 spin_lock_init(&lo->lo_lock);
1860 disk->major = LOOP_MAJOR;
Laurent Vivier476a4812008-03-26 12:11:53 +01001861 disk->first_minor = i << part_shift;
Ken Chen73285082007-05-08 00:28:20 -07001862 disk->fops = &lo_fops;
1863 disk->private_data = lo;
1864 disk->queue = lo->lo_queue;
1865 sprintf(disk->disk_name, "loop%d", i);
Kay Sievers34dd82a2011-07-31 22:08:04 +02001866 add_disk(disk);
1867 *l = lo;
1868 return lo->lo_number;
Ken Chen73285082007-05-08 00:28:20 -07001869
1870out_free_queue:
1871 blk_cleanup_queue(lo->lo_queue);
Ming Leib5dd2f62014-12-31 13:22:57 +00001872out_cleanup_tags:
1873 blk_mq_free_tag_set(&lo->tag_set);
Mikulas Patocka3ec981e2013-10-14 12:12:24 -04001874out_free_idr:
1875 idr_remove(&loop_index_idr, i);
Ken Chen73285082007-05-08 00:28:20 -07001876out_free_dev:
1877 kfree(lo);
1878out:
Kay Sievers34dd82a2011-07-31 22:08:04 +02001879 return err;
Ken Chen73285082007-05-08 00:28:20 -07001880}
1881
Kay Sievers34dd82a2011-07-31 22:08:04 +02001882static void loop_remove(struct loop_device *lo)
Ken Chen73285082007-05-08 00:28:20 -07001883{
NeilBrown6cd18e72015-04-27 14:12:22 +10001884 del_gendisk(lo->lo_disk);
Bart Van Assche0fa8ebd2018-02-28 10:15:28 -08001885 blk_cleanup_queue(lo->lo_queue);
Ming Leib5dd2f62014-12-31 13:22:57 +00001886 blk_mq_free_tag_set(&lo->tag_set);
Ken Chen73285082007-05-08 00:28:20 -07001887 put_disk(lo->lo_disk);
Ken Chen73285082007-05-08 00:28:20 -07001888 kfree(lo);
1889}
1890
Kay Sievers770fe302011-07-31 22:08:04 +02001891static int find_free_cb(int id, void *ptr, void *data)
Ken Chena47653f2007-06-08 13:46:44 -07001892{
Kay Sievers770fe302011-07-31 22:08:04 +02001893 struct loop_device *lo = ptr;
1894 struct loop_device **l = data;
Ken Chena47653f2007-06-08 13:46:44 -07001895
Kay Sievers770fe302011-07-31 22:08:04 +02001896 if (lo->lo_state == Lo_unbound) {
1897 *l = lo;
1898 return 1;
Ken Chena47653f2007-06-08 13:46:44 -07001899 }
Kay Sievers770fe302011-07-31 22:08:04 +02001900 return 0;
Ken Chena47653f2007-06-08 13:46:44 -07001901}
1902
Kay Sievers34dd82a2011-07-31 22:08:04 +02001903static int loop_lookup(struct loop_device **l, int i)
Ken Chena47653f2007-06-08 13:46:44 -07001904{
Ken Chena47653f2007-06-08 13:46:44 -07001905 struct loop_device *lo;
Kay Sievers34dd82a2011-07-31 22:08:04 +02001906 int ret = -ENODEV;
Ken Chena47653f2007-06-08 13:46:44 -07001907
Kay Sievers770fe302011-07-31 22:08:04 +02001908 if (i < 0) {
1909 int err;
1910
1911 err = idr_for_each(&loop_index_idr, &find_free_cb, &lo);
1912 if (err == 1) {
1913 *l = lo;
1914 ret = lo->lo_number;
1915 }
1916 goto out;
1917 }
1918
1919 /* lookup and return a specific i */
Kay Sievers34dd82a2011-07-31 22:08:04 +02001920 lo = idr_find(&loop_index_idr, i);
Ken Chena47653f2007-06-08 13:46:44 -07001921 if (lo) {
Kay Sievers34dd82a2011-07-31 22:08:04 +02001922 *l = lo;
1923 ret = lo->lo_number;
Ken Chena47653f2007-06-08 13:46:44 -07001924 }
Kay Sievers770fe302011-07-31 22:08:04 +02001925out:
Kay Sievers34dd82a2011-07-31 22:08:04 +02001926 return ret;
Ken Chena47653f2007-06-08 13:46:44 -07001927}
1928
Ken Chen73285082007-05-08 00:28:20 -07001929static struct kobject *loop_probe(dev_t dev, int *part, void *data)
1930{
Al Viro705962c2007-05-13 05:52:32 -04001931 struct loop_device *lo;
Al Viro07002e92007-05-12 16:23:15 -04001932 struct kobject *kobj;
Kay Sievers34dd82a2011-07-31 22:08:04 +02001933 int err;
Ken Chen73285082007-05-08 00:28:20 -07001934
Kay Sievers34dd82a2011-07-31 22:08:04 +02001935 mutex_lock(&loop_index_mutex);
1936 err = loop_lookup(&lo, MINOR(dev) >> part_shift);
1937 if (err < 0)
1938 err = loop_add(&lo, MINOR(dev) >> part_shift);
1939 if (err < 0)
Mikulas Patockaa207f592013-10-14 12:13:24 -04001940 kobj = NULL;
Kay Sievers34dd82a2011-07-31 22:08:04 +02001941 else
Jan Kara3079c222018-02-26 13:01:38 +01001942 kobj = get_disk_and_module(lo->lo_disk);
Kay Sievers34dd82a2011-07-31 22:08:04 +02001943 mutex_unlock(&loop_index_mutex);
Ken Chen73285082007-05-08 00:28:20 -07001944
1945 *part = 0;
Al Viro07002e92007-05-12 16:23:15 -04001946 return kobj;
Ken Chen73285082007-05-08 00:28:20 -07001947}
1948
Kay Sievers770fe302011-07-31 22:08:04 +02001949static long loop_control_ioctl(struct file *file, unsigned int cmd,
1950 unsigned long parm)
1951{
1952 struct loop_device *lo;
1953 int ret = -ENOSYS;
1954
1955 mutex_lock(&loop_index_mutex);
1956 switch (cmd) {
1957 case LOOP_CTL_ADD:
1958 ret = loop_lookup(&lo, parm);
1959 if (ret >= 0) {
1960 ret = -EEXIST;
1961 break;
1962 }
1963 ret = loop_add(&lo, parm);
1964 break;
1965 case LOOP_CTL_REMOVE:
1966 ret = loop_lookup(&lo, parm);
1967 if (ret < 0)
1968 break;
Omar Sandoval3148ffb2018-03-26 21:39:12 -07001969 ret = mutex_lock_killable(&lo->lo_ctl_mutex);
1970 if (ret)
1971 break;
Kay Sievers770fe302011-07-31 22:08:04 +02001972 if (lo->lo_state != Lo_unbound) {
1973 ret = -EBUSY;
1974 mutex_unlock(&lo->lo_ctl_mutex);
1975 break;
1976 }
Ming Leif8933662015-05-06 12:26:23 +08001977 if (atomic_read(&lo->lo_refcnt) > 0) {
Kay Sievers770fe302011-07-31 22:08:04 +02001978 ret = -EBUSY;
1979 mutex_unlock(&lo->lo_ctl_mutex);
1980 break;
1981 }
1982 lo->lo_disk->private_data = NULL;
1983 mutex_unlock(&lo->lo_ctl_mutex);
1984 idr_remove(&loop_index_idr, lo->lo_number);
1985 loop_remove(lo);
1986 break;
1987 case LOOP_CTL_GET_FREE:
1988 ret = loop_lookup(&lo, -1);
1989 if (ret >= 0)
1990 break;
1991 ret = loop_add(&lo, -1);
1992 }
1993 mutex_unlock(&loop_index_mutex);
1994
1995 return ret;
1996}
1997
1998static const struct file_operations loop_ctl_fops = {
1999 .open = nonseekable_open,
2000 .unlocked_ioctl = loop_control_ioctl,
2001 .compat_ioctl = loop_control_ioctl,
2002 .owner = THIS_MODULE,
2003 .llseek = noop_llseek,
2004};
2005
2006static struct miscdevice loop_misc = {
2007 .minor = LOOP_CTRL_MINOR,
2008 .name = "loop-control",
2009 .fops = &loop_ctl_fops,
2010};
2011
2012MODULE_ALIAS_MISCDEV(LOOP_CTRL_MINOR);
2013MODULE_ALIAS("devname:loop-control");
2014
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015static int __init loop_init(void)
2016{
Ken Chena47653f2007-06-08 13:46:44 -07002017 int i, nr;
2018 unsigned long range;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002019 struct loop_device *lo;
Kay Sievers770fe302011-07-31 22:08:04 +02002020 int err;
Ken Chena47653f2007-06-08 13:46:44 -07002021
Laurent Vivier476a4812008-03-26 12:11:53 +01002022 part_shift = 0;
Namhyung Kimac04fee2011-05-27 07:59:25 +02002023 if (max_part > 0) {
Laurent Vivier476a4812008-03-26 12:11:53 +01002024 part_shift = fls(max_part);
2025
Namhyung Kimac04fee2011-05-27 07:59:25 +02002026 /*
2027 * Adjust max_part according to part_shift as it is exported
2028 * to user space so that user can decide correct minor number
2029 * if [s]he want to create more devices.
2030 *
2031 * Note that -1 is required because partition 0 is reserved
2032 * for the whole disk.
2033 */
2034 max_part = (1UL << part_shift) - 1;
2035 }
2036
Guo Chaob1a66502013-02-21 15:16:49 -08002037 if ((1UL << part_shift) > DISK_MAX_PARTS) {
2038 err = -EINVAL;
Anton Volkova8c1d062017-08-07 15:37:50 +03002039 goto err_out;
Guo Chaob1a66502013-02-21 15:16:49 -08002040 }
Namhyung Kim78f4bb32011-05-24 16:48:54 +02002041
Guo Chaob1a66502013-02-21 15:16:49 -08002042 if (max_loop > 1UL << (MINORBITS - part_shift)) {
2043 err = -EINVAL;
Anton Volkova8c1d062017-08-07 15:37:50 +03002044 goto err_out;
Guo Chaob1a66502013-02-21 15:16:49 -08002045 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046
Kay Sieversd134b002011-07-31 22:08:04 +02002047 /*
2048 * If max_loop is specified, create that many devices upfront.
2049 * This also becomes a hard limit. If max_loop is not specified,
2050 * create CONFIG_BLK_DEV_LOOP_MIN_COUNT loop devices at module
2051 * init time. Loop devices can be requested on-demand with the
2052 * /dev/loop-control interface, or be instantiated by accessing
2053 * a 'dead' device node.
2054 */
Ken Chen73285082007-05-08 00:28:20 -07002055 if (max_loop) {
Ken Chena47653f2007-06-08 13:46:44 -07002056 nr = max_loop;
Namhyung Kima1c15c52011-05-24 16:48:55 +02002057 range = max_loop << part_shift;
Ken Chena47653f2007-06-08 13:46:44 -07002058 } else {
Kay Sieversd134b002011-07-31 22:08:04 +02002059 nr = CONFIG_BLK_DEV_LOOP_MIN_COUNT;
Namhyung Kima1c15c52011-05-24 16:48:55 +02002060 range = 1UL << MINORBITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061 }
Ken Chena47653f2007-06-08 13:46:44 -07002062
Anton Volkova8c1d062017-08-07 15:37:50 +03002063 err = misc_register(&loop_misc);
2064 if (err < 0)
2065 goto err_out;
2066
2067
Guo Chaob1a66502013-02-21 15:16:49 -08002068 if (register_blkdev(LOOP_MAJOR, "loop")) {
2069 err = -EIO;
2070 goto misc_out;
2071 }
Ken Chena47653f2007-06-08 13:46:44 -07002072
Ken Chena47653f2007-06-08 13:46:44 -07002073 blk_register_region(MKDEV(LOOP_MAJOR, 0), range,
2074 THIS_MODULE, loop_probe, NULL, NULL);
2075
Kay Sieversd134b002011-07-31 22:08:04 +02002076 /* pre-create number of devices given by config or max_loop */
Kay Sievers34dd82a2011-07-31 22:08:04 +02002077 mutex_lock(&loop_index_mutex);
2078 for (i = 0; i < nr; i++)
2079 loop_add(&lo, i);
2080 mutex_unlock(&loop_index_mutex);
2081
Ken Chen73285082007-05-08 00:28:20 -07002082 printk(KERN_INFO "loop: module loaded\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 return 0;
Guo Chaob1a66502013-02-21 15:16:49 -08002084
2085misc_out:
2086 misc_deregister(&loop_misc);
Anton Volkova8c1d062017-08-07 15:37:50 +03002087err_out:
Guo Chaob1a66502013-02-21 15:16:49 -08002088 return err;
Kay Sievers34dd82a2011-07-31 22:08:04 +02002089}
Ken Chena47653f2007-06-08 13:46:44 -07002090
Kay Sievers34dd82a2011-07-31 22:08:04 +02002091static int loop_exit_cb(int id, void *ptr, void *data)
2092{
2093 struct loop_device *lo = ptr;
Ken Chena47653f2007-06-08 13:46:44 -07002094
Kay Sievers34dd82a2011-07-31 22:08:04 +02002095 loop_remove(lo);
2096 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097}
2098
Ken Chen73285082007-05-08 00:28:20 -07002099static void __exit loop_exit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100{
Ken Chena47653f2007-06-08 13:46:44 -07002101 unsigned long range;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102
Namhyung Kima1c15c52011-05-24 16:48:55 +02002103 range = max_loop ? max_loop << part_shift : 1UL << MINORBITS;
Ken Chena47653f2007-06-08 13:46:44 -07002104
Kay Sievers34dd82a2011-07-31 22:08:04 +02002105 idr_for_each(&loop_index_idr, &loop_exit_cb, NULL);
Kay Sievers34dd82a2011-07-31 22:08:04 +02002106 idr_destroy(&loop_index_idr);
Ken Chen73285082007-05-08 00:28:20 -07002107
Ken Chena47653f2007-06-08 13:46:44 -07002108 blk_unregister_region(MKDEV(LOOP_MAJOR, 0), range);
Akinobu Mita00d59402007-07-17 04:03:46 -07002109 unregister_blkdev(LOOP_MAJOR, "loop");
Kay Sievers770fe302011-07-31 22:08:04 +02002110
2111 misc_deregister(&loop_misc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112}
2113
2114module_init(loop_init);
2115module_exit(loop_exit);
2116
2117#ifndef MODULE
2118static int __init max_loop_setup(char *str)
2119{
2120 max_loop = simple_strtol(str, NULL, 0);
2121 return 1;
2122}
2123
2124__setup("max_loop=", max_loop_setup);
2125#endif