blob: e66f4040d84bb2a77e70979ede4a2ca76811cb84 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Copyright (C) 2001, 2002 Sistina Software (UK) Limited.
Milan Broz784aae72009-01-06 03:05:12 +00003 * Copyright (C) 2004-2008 Red Hat, Inc. All rights reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
5 * This file is released under the GPL.
6 */
7
Mike Snitzer4cc96132016-05-12 16:28:10 -04008#include "dm-core.h"
9#include "dm-rq.h"
Mike Anderson51e5b2b2007-10-19 22:48:00 +010010#include "dm-uevent.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
12#include <linux/init.h>
13#include <linux/module.h>
Arjan van de Ven48c9c272006-03-27 01:18:20 -080014#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/blkpg.h>
16#include <linux/bio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/mempool.h>
18#include <linux/slab.h>
19#include <linux/idr.h>
Darrick J. Wong3ac51e72006-03-27 01:17:54 -080020#include <linux/hdreg.h>
Kiyoshi Ueda3f77316d2010-08-12 04:13:56 +010021#include <linux/delay.h>
Mike Snitzerffcc3932014-10-28 18:34:52 -040022#include <linux/wait.h>
Christoph Hellwig71cdb692015-10-15 14:10:51 +020023#include <linux/pr.h>
Li Zefan55782132009-06-09 13:43:05 +080024
Alasdair G Kergon72d94862006-06-26 00:27:35 -070025#define DM_MSG_PREFIX "core"
26
Namhyung Kim71a16732011-10-31 20:18:54 +000027#ifdef CONFIG_PRINTK
28/*
29 * ratelimit state to be used in DMXXX_LIMIT().
30 */
31DEFINE_RATELIMIT_STATE(dm_ratelimit_state,
32 DEFAULT_RATELIMIT_INTERVAL,
33 DEFAULT_RATELIMIT_BURST);
34EXPORT_SYMBOL(dm_ratelimit_state);
35#endif
36
Milan Broz60935eb2009-06-22 10:12:30 +010037/*
38 * Cookies are numeric values sent with CHANGE and REMOVE
39 * uevents while resuming, removing or renaming the device.
40 */
41#define DM_COOKIE_ENV_VAR_NAME "DM_COOKIE"
42#define DM_COOKIE_LENGTH 24
43
Linus Torvalds1da177e2005-04-16 15:20:36 -070044static const char *_name = DM_NAME;
45
46static unsigned int major = 0;
47static unsigned int _major = 0;
48
Alasdair G Kergond15b7742011-08-02 12:32:01 +010049static DEFINE_IDR(_minor_idr);
50
Jeff Mahoneyf32c10b2006-06-26 00:27:22 -070051static DEFINE_SPINLOCK(_minor_lock);
Mikulas Patocka2c140a22013-11-01 18:27:41 -040052
53static void do_deferred_remove(struct work_struct *w);
54
55static DECLARE_WORK(deferred_remove_work, do_deferred_remove);
56
Mikulas Patockaacfe0ad2014-06-14 13:44:31 -040057static struct workqueue_struct *deferred_remove_workqueue;
58
Linus Torvalds1da177e2005-04-16 15:20:36 -070059/*
60 * One of these is allocated per bio.
61 */
62struct dm_io {
63 struct mapped_device *md;
64 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 atomic_t io_count;
Richard Kennedy6ae2fa62008-07-21 12:00:28 +010066 struct bio *bio;
Jun'ichi "Nick" Nomura3eaf8402006-02-01 03:04:53 -080067 unsigned long start_time;
Kiyoshi Uedaf88fb982009-10-16 23:18:15 +010068 spinlock_t endio_lock;
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -040069 struct dm_stats_aux stats_aux;
Linus Torvalds1da177e2005-04-16 15:20:36 -070070};
71
Jeff Mahoneyba61fdd2006-06-26 00:27:21 -070072#define MINOR_ALLOCED ((void *)-1)
73
Linus Torvalds1da177e2005-04-16 15:20:36 -070074/*
75 * Bits for the md->flags field.
76 */
Alasdair G Kergon1eb787e2009-04-09 00:27:14 +010077#define DMF_BLOCK_IO_FOR_SUSPEND 0
Linus Torvalds1da177e2005-04-16 15:20:36 -070078#define DMF_SUSPENDED 1
Alasdair G Kergonaa8d7c22006-01-06 00:20:06 -080079#define DMF_FROZEN 2
Jeff Mahoneyfba9f902006-06-26 00:27:23 -070080#define DMF_FREEING 3
Alasdair G Kergon5c6bd752006-06-26 00:27:34 -070081#define DMF_DELETING 4
Kiyoshi Ueda2e93ccc2006-12-08 02:41:09 -080082#define DMF_NOFLUSH_SUSPENDING 5
Kent Overstreet8ae12662015-04-27 23:48:34 -070083#define DMF_DEFERRED_REMOVE 6
84#define DMF_SUSPENDED_INTERNALLY 7
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Mike Snitzer115485e2016-02-22 12:16:21 -050086#define DM_NUMA_NODE NUMA_NO_NODE
Mike Snitzer115485e2016-02-22 12:16:21 -050087static int dm_numa_node = DM_NUMA_NODE;
Mike Snitzerfaad87d2016-01-28 16:52:56 -050088
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010089/*
90 * For mempools pre-allocation at the table loading time.
91 */
92struct dm_md_mempools {
93 mempool_t *io_pool;
Mike Snitzer1ae49ea2014-12-05 17:11:05 -050094 mempool_t *rq_pool;
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010095 struct bio_set *bs;
96};
97
Benjamin Marzinski86f11522014-08-13 13:53:43 -050098struct table_device {
99 struct list_head list;
100 atomic_t count;
101 struct dm_dev dm_dev;
102};
103
Christoph Lametere18b8902006-12-06 20:33:20 -0800104static struct kmem_cache *_io_cache;
Kiyoshi Ueda8fbf26a2009-01-06 03:05:06 +0000105static struct kmem_cache *_rq_tio_cache;
Mike Snitzer1ae49ea2014-12-05 17:11:05 -0500106static struct kmem_cache *_rq_cache;
Kent Overstreet94818742012-09-07 13:44:01 -0700107
Mike Snitzerf4790822013-09-12 18:06:12 -0400108/*
Mike Snitzere8603132013-09-12 18:06:12 -0400109 * Bio-based DM's mempools' reserved IOs set by the user.
110 */
Mike Snitzer4cc96132016-05-12 16:28:10 -0400111#define RESERVED_BIO_BASED_IOS 16
Mike Snitzere8603132013-09-12 18:06:12 -0400112static unsigned reserved_bio_based_ios = RESERVED_BIO_BASED_IOS;
113
Mike Snitzer115485e2016-02-22 12:16:21 -0500114static int __dm_get_module_param_int(int *module_param, int min, int max)
115{
116 int param = ACCESS_ONCE(*module_param);
117 int modified_param = 0;
118 bool modified = true;
119
120 if (param < min)
121 modified_param = min;
122 else if (param > max)
123 modified_param = max;
124 else
125 modified = false;
126
127 if (modified) {
128 (void)cmpxchg(module_param, param, modified_param);
129 param = modified_param;
130 }
131
132 return param;
133}
134
Mike Snitzer4cc96132016-05-12 16:28:10 -0400135unsigned __dm_get_module_param(unsigned *module_param,
136 unsigned def, unsigned max)
Mike Snitzerf4790822013-09-12 18:06:12 -0400137{
Mike Snitzer09c2d532015-02-27 22:25:26 -0500138 unsigned param = ACCESS_ONCE(*module_param);
139 unsigned modified_param = 0;
Mike Snitzerf4790822013-09-12 18:06:12 -0400140
Mike Snitzer09c2d532015-02-27 22:25:26 -0500141 if (!param)
142 modified_param = def;
143 else if (param > max)
144 modified_param = max;
Mike Snitzerf4790822013-09-12 18:06:12 -0400145
Mike Snitzer09c2d532015-02-27 22:25:26 -0500146 if (modified_param) {
147 (void)cmpxchg(module_param, param, modified_param);
148 param = modified_param;
Mike Snitzerf4790822013-09-12 18:06:12 -0400149 }
150
Mike Snitzer09c2d532015-02-27 22:25:26 -0500151 return param;
Mike Snitzerf4790822013-09-12 18:06:12 -0400152}
153
Mike Snitzere8603132013-09-12 18:06:12 -0400154unsigned dm_get_reserved_bio_based_ios(void)
155{
Mike Snitzer09c2d532015-02-27 22:25:26 -0500156 return __dm_get_module_param(&reserved_bio_based_ios,
Mike Snitzer4cc96132016-05-12 16:28:10 -0400157 RESERVED_BIO_BASED_IOS, DM_RESERVED_MAX_IOS);
Mike Snitzere8603132013-09-12 18:06:12 -0400158}
159EXPORT_SYMBOL_GPL(dm_get_reserved_bio_based_ios);
160
Mike Snitzer115485e2016-02-22 12:16:21 -0500161static unsigned dm_get_numa_node(void)
162{
163 return __dm_get_module_param_int(&dm_numa_node,
164 DM_NUMA_NODE, num_online_nodes() - 1);
165}
166
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167static int __init local_init(void)
168{
Kiyoshi Ueda51157b42008-10-21 17:45:08 +0100169 int r = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 /* allocate a slab for the dm_ios */
Alasdair G Kergon028867a2007-07-12 17:26:32 +0100172 _io_cache = KMEM_CACHE(dm_io, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 if (!_io_cache)
Kiyoshi Ueda51157b42008-10-21 17:45:08 +0100174 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
Kiyoshi Ueda8fbf26a2009-01-06 03:05:06 +0000176 _rq_tio_cache = KMEM_CACHE(dm_rq_target_io, 0);
177 if (!_rq_tio_cache)
Mikulas Patockadba14162012-10-12 21:02:15 +0100178 goto out_free_io_cache;
Kiyoshi Ueda8fbf26a2009-01-06 03:05:06 +0000179
Mike Snitzereca7ee62016-02-20 13:45:38 -0500180 _rq_cache = kmem_cache_create("dm_old_clone_request", sizeof(struct request),
Mike Snitzer1ae49ea2014-12-05 17:11:05 -0500181 __alignof__(struct request), 0, NULL);
182 if (!_rq_cache)
183 goto out_free_rq_tio_cache;
184
Mike Anderson51e5b2b2007-10-19 22:48:00 +0100185 r = dm_uevent_init();
Kiyoshi Ueda51157b42008-10-21 17:45:08 +0100186 if (r)
Mike Snitzer1ae49ea2014-12-05 17:11:05 -0500187 goto out_free_rq_cache;
Mike Anderson51e5b2b2007-10-19 22:48:00 +0100188
Mikulas Patockaacfe0ad2014-06-14 13:44:31 -0400189 deferred_remove_workqueue = alloc_workqueue("kdmremove", WQ_UNBOUND, 1);
190 if (!deferred_remove_workqueue) {
191 r = -ENOMEM;
192 goto out_uevent_exit;
193 }
194
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 _major = major;
196 r = register_blkdev(_major, _name);
Kiyoshi Ueda51157b42008-10-21 17:45:08 +0100197 if (r < 0)
Mikulas Patockaacfe0ad2014-06-14 13:44:31 -0400198 goto out_free_workqueue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
200 if (!_major)
201 _major = r;
202
203 return 0;
Kiyoshi Ueda51157b42008-10-21 17:45:08 +0100204
Mikulas Patockaacfe0ad2014-06-14 13:44:31 -0400205out_free_workqueue:
206 destroy_workqueue(deferred_remove_workqueue);
Kiyoshi Ueda51157b42008-10-21 17:45:08 +0100207out_uevent_exit:
208 dm_uevent_exit();
Mike Snitzer1ae49ea2014-12-05 17:11:05 -0500209out_free_rq_cache:
210 kmem_cache_destroy(_rq_cache);
Kiyoshi Ueda8fbf26a2009-01-06 03:05:06 +0000211out_free_rq_tio_cache:
212 kmem_cache_destroy(_rq_tio_cache);
Kiyoshi Ueda51157b42008-10-21 17:45:08 +0100213out_free_io_cache:
214 kmem_cache_destroy(_io_cache);
215
216 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217}
218
219static void local_exit(void)
220{
Mikulas Patocka2c140a22013-11-01 18:27:41 -0400221 flush_scheduled_work();
Mikulas Patockaacfe0ad2014-06-14 13:44:31 -0400222 destroy_workqueue(deferred_remove_workqueue);
Mikulas Patocka2c140a22013-11-01 18:27:41 -0400223
Mike Snitzer1ae49ea2014-12-05 17:11:05 -0500224 kmem_cache_destroy(_rq_cache);
Kiyoshi Ueda8fbf26a2009-01-06 03:05:06 +0000225 kmem_cache_destroy(_rq_tio_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 kmem_cache_destroy(_io_cache);
Akinobu Mita00d59402007-07-17 04:03:46 -0700227 unregister_blkdev(_major, _name);
Mike Anderson51e5b2b2007-10-19 22:48:00 +0100228 dm_uevent_exit();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
230 _major = 0;
231
232 DMINFO("cleaned up");
233}
234
Alasdair G Kergonb9249e52008-02-08 02:09:51 +0000235static int (*_inits[])(void) __initdata = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 local_init,
237 dm_target_init,
238 dm_linear_init,
239 dm_stripe_init,
Mikulas Patocka952b3552009-12-10 23:51:57 +0000240 dm_io_init,
Mikulas Patocka945fa4d2008-04-24 21:43:49 +0100241 dm_kcopyd_init,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 dm_interface_init,
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400243 dm_statistics_init,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244};
245
Alasdair G Kergonb9249e52008-02-08 02:09:51 +0000246static void (*_exits[])(void) = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 local_exit,
248 dm_target_exit,
249 dm_linear_exit,
250 dm_stripe_exit,
Mikulas Patocka952b3552009-12-10 23:51:57 +0000251 dm_io_exit,
Mikulas Patocka945fa4d2008-04-24 21:43:49 +0100252 dm_kcopyd_exit,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 dm_interface_exit,
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400254 dm_statistics_exit,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255};
256
257static int __init dm_init(void)
258{
259 const int count = ARRAY_SIZE(_inits);
260
261 int r, i;
262
263 for (i = 0; i < count; i++) {
264 r = _inits[i]();
265 if (r)
266 goto bad;
267 }
268
269 return 0;
270
271 bad:
272 while (i--)
273 _exits[i]();
274
275 return r;
276}
277
278static void __exit dm_exit(void)
279{
280 int i = ARRAY_SIZE(_exits);
281
282 while (i--)
283 _exits[i]();
Alasdair G Kergond15b7742011-08-02 12:32:01 +0100284
285 /*
286 * Should be empty by this point.
287 */
Alasdair G Kergond15b7742011-08-02 12:32:01 +0100288 idr_destroy(&_minor_idr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289}
290
291/*
292 * Block device functions
293 */
Mike Anderson432a2122009-12-10 23:52:20 +0000294int dm_deleting_md(struct mapped_device *md)
295{
296 return test_bit(DMF_DELETING, &md->flags);
297}
298
Al Virofe5f9f22008-03-02 10:29:31 -0500299static int dm_blk_open(struct block_device *bdev, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300{
301 struct mapped_device *md;
302
Jeff Mahoneyfba9f902006-06-26 00:27:23 -0700303 spin_lock(&_minor_lock);
304
Al Virofe5f9f22008-03-02 10:29:31 -0500305 md = bdev->bd_disk->private_data;
Jeff Mahoneyfba9f902006-06-26 00:27:23 -0700306 if (!md)
307 goto out;
308
Alasdair G Kergon5c6bd752006-06-26 00:27:34 -0700309 if (test_bit(DMF_FREEING, &md->flags) ||
Mike Anderson432a2122009-12-10 23:52:20 +0000310 dm_deleting_md(md)) {
Jeff Mahoneyfba9f902006-06-26 00:27:23 -0700311 md = NULL;
312 goto out;
313 }
314
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 dm_get(md);
Alasdair G Kergon5c6bd752006-06-26 00:27:34 -0700316 atomic_inc(&md->open_count);
Jeff Mahoneyfba9f902006-06-26 00:27:23 -0700317out:
318 spin_unlock(&_minor_lock);
319
320 return md ? 0 : -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321}
322
Al Virodb2a1442013-05-05 21:52:57 -0400323static void dm_blk_close(struct gendisk *disk, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324{
Mike Snitzer63a4f062015-03-23 17:01:43 -0400325 struct mapped_device *md;
Arnd Bergmann6e9624b2010-08-07 18:25:34 +0200326
Milan Broz4a1aeb92011-01-13 19:59:48 +0000327 spin_lock(&_minor_lock);
328
Mike Snitzer63a4f062015-03-23 17:01:43 -0400329 md = disk->private_data;
330 if (WARN_ON(!md))
331 goto out;
332
Mikulas Patocka2c140a22013-11-01 18:27:41 -0400333 if (atomic_dec_and_test(&md->open_count) &&
334 (test_bit(DMF_DEFERRED_REMOVE, &md->flags)))
Mikulas Patockaacfe0ad2014-06-14 13:44:31 -0400335 queue_work(deferred_remove_workqueue, &deferred_remove_work);
Mikulas Patocka2c140a22013-11-01 18:27:41 -0400336
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 dm_put(md);
Mike Snitzer63a4f062015-03-23 17:01:43 -0400338out:
Milan Broz4a1aeb92011-01-13 19:59:48 +0000339 spin_unlock(&_minor_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340}
341
Alasdair G Kergon5c6bd752006-06-26 00:27:34 -0700342int dm_open_count(struct mapped_device *md)
343{
344 return atomic_read(&md->open_count);
345}
346
347/*
348 * Guarantees nothing is using the device before it's deleted.
349 */
Mikulas Patocka2c140a22013-11-01 18:27:41 -0400350int dm_lock_for_deletion(struct mapped_device *md, bool mark_deferred, bool only_deferred)
Alasdair G Kergon5c6bd752006-06-26 00:27:34 -0700351{
352 int r = 0;
353
354 spin_lock(&_minor_lock);
355
Mikulas Patocka2c140a22013-11-01 18:27:41 -0400356 if (dm_open_count(md)) {
Alasdair G Kergon5c6bd752006-06-26 00:27:34 -0700357 r = -EBUSY;
Mikulas Patocka2c140a22013-11-01 18:27:41 -0400358 if (mark_deferred)
359 set_bit(DMF_DEFERRED_REMOVE, &md->flags);
360 } else if (only_deferred && !test_bit(DMF_DEFERRED_REMOVE, &md->flags))
361 r = -EEXIST;
Alasdair G Kergon5c6bd752006-06-26 00:27:34 -0700362 else
363 set_bit(DMF_DELETING, &md->flags);
364
365 spin_unlock(&_minor_lock);
366
367 return r;
368}
369
Mikulas Patocka2c140a22013-11-01 18:27:41 -0400370int dm_cancel_deferred_remove(struct mapped_device *md)
371{
372 int r = 0;
373
374 spin_lock(&_minor_lock);
375
376 if (test_bit(DMF_DELETING, &md->flags))
377 r = -EBUSY;
378 else
379 clear_bit(DMF_DEFERRED_REMOVE, &md->flags);
380
381 spin_unlock(&_minor_lock);
382
383 return r;
384}
385
386static void do_deferred_remove(struct work_struct *w)
387{
388 dm_deferred_remove();
389}
390
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400391sector_t dm_get_size(struct mapped_device *md)
392{
393 return get_capacity(md->disk);
394}
395
Mike Snitzer9974fa22014-02-28 15:33:43 +0100396struct request_queue *dm_get_md_queue(struct mapped_device *md)
397{
398 return md->queue;
399}
400
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400401struct dm_stats *dm_get_stats(struct mapped_device *md)
402{
403 return &md->stats;
404}
405
Darrick J. Wong3ac51e72006-03-27 01:17:54 -0800406static int dm_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
407{
408 struct mapped_device *md = bdev->bd_disk->private_data;
409
410 return dm_get_geometry(md, geo);
411}
412
Mike Snitzer956a4022016-02-18 16:13:51 -0500413static int dm_grab_bdev_for_ioctl(struct mapped_device *md,
414 struct block_device **bdev,
415 fmode_t *mode)
Milan Brozaa129a22006-10-03 01:15:15 -0700416{
Mike Snitzer66482022016-02-18 15:44:39 -0500417 struct dm_target *tgt;
Hannes Reinecke6c182cd2013-07-10 23:41:15 +0100418 struct dm_table *map;
Mike Snitzer956a4022016-02-18 16:13:51 -0500419 int srcu_idx, r;
Milan Brozaa129a22006-10-03 01:15:15 -0700420
Hannes Reinecke6c182cd2013-07-10 23:41:15 +0100421retry:
Christoph Hellwige56f81e2015-10-15 14:10:50 +0200422 r = -ENOTTY;
Mike Snitzer956a4022016-02-18 16:13:51 -0500423 map = dm_get_live_table(md, &srcu_idx);
Milan Brozaa129a22006-10-03 01:15:15 -0700424 if (!map || !dm_table_get_size(map))
425 goto out;
426
427 /* We only support devices that have a single target */
428 if (dm_table_get_num_targets(map) != 1)
429 goto out;
430
Mike Snitzer66482022016-02-18 15:44:39 -0500431 tgt = dm_table_get_target(map, 0);
432 if (!tgt->type->prepare_ioctl)
Mike Snitzer4d341d82014-11-16 14:21:47 -0500433 goto out;
Milan Brozaa129a22006-10-03 01:15:15 -0700434
Kiyoshi Ueda4f186f82009-12-10 23:52:26 +0000435 if (dm_suspended_md(md)) {
Milan Brozaa129a22006-10-03 01:15:15 -0700436 r = -EAGAIN;
437 goto out;
438 }
439
Mike Snitzer66482022016-02-18 15:44:39 -0500440 r = tgt->type->prepare_ioctl(tgt, bdev, mode);
Christoph Hellwige56f81e2015-10-15 14:10:50 +0200441 if (r < 0)
442 goto out;
443
Mike Snitzer956a4022016-02-18 16:13:51 -0500444 bdgrab(*bdev);
445 dm_put_live_table(md, srcu_idx);
Christoph Hellwige56f81e2015-10-15 14:10:50 +0200446 return r;
Milan Brozaa129a22006-10-03 01:15:15 -0700447
448out:
Mike Snitzer956a4022016-02-18 16:13:51 -0500449 dm_put_live_table(md, srcu_idx);
Junichi Nomura5bbbfdf2015-11-17 09:39:26 +0000450 if (r == -ENOTCONN && !fatal_signal_pending(current)) {
Hannes Reinecke6c182cd2013-07-10 23:41:15 +0100451 msleep(10);
452 goto retry;
453 }
Christoph Hellwige56f81e2015-10-15 14:10:50 +0200454 return r;
455}
Hannes Reinecke6c182cd2013-07-10 23:41:15 +0100456
Christoph Hellwige56f81e2015-10-15 14:10:50 +0200457static int dm_blk_ioctl(struct block_device *bdev, fmode_t mode,
458 unsigned int cmd, unsigned long arg)
459{
460 struct mapped_device *md = bdev->bd_disk->private_data;
Mike Snitzer956a4022016-02-18 16:13:51 -0500461 int r;
Christoph Hellwige56f81e2015-10-15 14:10:50 +0200462
Mike Snitzer956a4022016-02-18 16:13:51 -0500463 r = dm_grab_bdev_for_ioctl(md, &bdev, &mode);
Christoph Hellwige56f81e2015-10-15 14:10:50 +0200464 if (r < 0)
465 return r;
466
467 if (r > 0) {
468 /*
469 * Target determined this ioctl is being issued against
470 * a logical partition of the parent bdev; so extra
471 * validation is needed.
472 */
473 r = scsi_verify_blk_ioctl(NULL, cmd);
474 if (r)
475 goto out;
476 }
477
Mike Snitzer66482022016-02-18 15:44:39 -0500478 r = __blkdev_driver_ioctl(bdev, mode, cmd, arg);
Christoph Hellwige56f81e2015-10-15 14:10:50 +0200479out:
Mike Snitzer956a4022016-02-18 16:13:51 -0500480 bdput(bdev);
Milan Brozaa129a22006-10-03 01:15:15 -0700481 return r;
482}
483
Alasdair G Kergon028867a2007-07-12 17:26:32 +0100484static struct dm_io *alloc_io(struct mapped_device *md)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485{
486 return mempool_alloc(md->io_pool, GFP_NOIO);
487}
488
Alasdair G Kergon028867a2007-07-12 17:26:32 +0100489static void free_io(struct mapped_device *md, struct dm_io *io)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490{
491 mempool_free(io, md->io_pool);
492}
493
Mike Snitzercfae7522016-04-11 12:05:38 -0400494static void free_tio(struct dm_target_io *tio)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495{
Mikulas Patockadba14162012-10-12 21:02:15 +0100496 bio_put(&tio->clone);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497}
498
Mike Snitzer4cc96132016-05-12 16:28:10 -0400499int md_in_flight(struct mapped_device *md)
Kiyoshi Ueda90abb8c2009-12-10 23:52:13 +0000500{
501 return atomic_read(&md->pending[READ]) +
502 atomic_read(&md->pending[WRITE]);
503}
504
Jun'ichi "Nick" Nomura3eaf8402006-02-01 03:04:53 -0800505static void start_io_acct(struct dm_io *io)
506{
507 struct mapped_device *md = io->md;
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400508 struct bio *bio = io->bio;
Tejun Heoc9959052008-08-25 19:47:21 +0900509 int cpu;
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400510 int rw = bio_data_dir(bio);
Jun'ichi "Nick" Nomura3eaf8402006-02-01 03:04:53 -0800511
512 io->start_time = jiffies;
513
Tejun Heo074a7ac2008-08-25 19:56:14 +0900514 cpu = part_stat_lock();
515 part_round_stats(cpu, &dm_disk(md)->part0);
516 part_stat_unlock();
Shaohua Li1e9bb882011-03-22 08:35:35 +0100517 atomic_set(&dm_disk(md)->part0.in_flight[rw],
518 atomic_inc_return(&md->pending[rw]));
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400519
520 if (unlikely(dm_stats_used(&md->stats)))
Mike Christie528ec5a2016-06-05 14:32:03 -0500521 dm_stats_account_io(&md->stats, bio_data_dir(bio),
522 bio->bi_iter.bi_sector, bio_sectors(bio),
523 false, 0, &io->stats_aux);
Jun'ichi "Nick" Nomura3eaf8402006-02-01 03:04:53 -0800524}
525
Mikulas Patockad221d2e2008-11-13 23:39:10 +0000526static void end_io_acct(struct dm_io *io)
Jun'ichi "Nick" Nomura3eaf8402006-02-01 03:04:53 -0800527{
528 struct mapped_device *md = io->md;
529 struct bio *bio = io->bio;
530 unsigned long duration = jiffies - io->start_time;
Gu Zheng18c0b222014-11-24 11:05:26 +0800531 int pending;
Jun'ichi "Nick" Nomura3eaf8402006-02-01 03:04:53 -0800532 int rw = bio_data_dir(bio);
533
Gu Zheng18c0b222014-11-24 11:05:26 +0800534 generic_end_io_acct(rw, &dm_disk(md)->part0, io->start_time);
Jun'ichi "Nick" Nomura3eaf8402006-02-01 03:04:53 -0800535
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400536 if (unlikely(dm_stats_used(&md->stats)))
Mike Christie528ec5a2016-06-05 14:32:03 -0500537 dm_stats_account_io(&md->stats, bio_data_dir(bio),
538 bio->bi_iter.bi_sector, bio_sectors(bio),
539 true, duration, &io->stats_aux);
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400540
Mikulas Patockaaf7e4662009-04-09 00:27:16 +0100541 /*
542 * After this is decremented the bio must not be touched if it is
Tejun Heod87f4c12010-09-03 11:56:19 +0200543 * a flush.
Mikulas Patockaaf7e4662009-04-09 00:27:16 +0100544 */
Shaohua Li1e9bb882011-03-22 08:35:35 +0100545 pending = atomic_dec_return(&md->pending[rw]);
546 atomic_set(&dm_disk(md)->part0.in_flight[rw], pending);
Nikanth Karthikesan316d3152009-10-06 20:16:55 +0200547 pending += atomic_read(&md->pending[rw^0x1]);
Jun'ichi "Nick" Nomura3eaf8402006-02-01 03:04:53 -0800548
Mikulas Patockad221d2e2008-11-13 23:39:10 +0000549 /* nudge anyone waiting on suspend queue */
550 if (!pending)
551 wake_up(&md->wait);
Jun'ichi "Nick" Nomura3eaf8402006-02-01 03:04:53 -0800552}
553
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554/*
555 * Add the bio to the list of deferred io.
556 */
Mikulas Patocka92c63902009-04-09 00:27:15 +0100557static void queue_io(struct mapped_device *md, struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558{
Kiyoshi Ueda054474202010-09-08 18:07:01 +0200559 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560
Kiyoshi Ueda054474202010-09-08 18:07:01 +0200561 spin_lock_irqsave(&md->deferred_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 bio_list_add(&md->deferred, bio);
Kiyoshi Ueda054474202010-09-08 18:07:01 +0200563 spin_unlock_irqrestore(&md->deferred_lock, flags);
Tejun Heo6a8736d2010-09-08 18:07:00 +0200564 queue_work(md->wq, &md->work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565}
566
567/*
568 * Everyone (including functions in this file), should use this
569 * function to access the md->map field, and make sure they call
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +0100570 * dm_put_live_table() when finished.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 */
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +0100572struct dm_table *dm_get_live_table(struct mapped_device *md, int *srcu_idx) __acquires(md->io_barrier)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573{
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +0100574 *srcu_idx = srcu_read_lock(&md->io_barrier);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +0100576 return srcu_dereference(md->map, &md->io_barrier);
577}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +0100579void dm_put_live_table(struct mapped_device *md, int srcu_idx) __releases(md->io_barrier)
580{
581 srcu_read_unlock(&md->io_barrier, srcu_idx);
582}
583
584void dm_sync_table(struct mapped_device *md)
585{
586 synchronize_srcu(&md->io_barrier);
587 synchronize_rcu_expedited();
588}
589
590/*
591 * A fast alternative to dm_get_live_table/dm_put_live_table.
592 * The caller must not block between these two functions.
593 */
594static struct dm_table *dm_get_live_table_fast(struct mapped_device *md) __acquires(RCU)
595{
596 rcu_read_lock();
597 return rcu_dereference(md->map);
598}
599
600static void dm_put_live_table_fast(struct mapped_device *md) __releases(RCU)
601{
602 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603}
604
Darrick J. Wong3ac51e72006-03-27 01:17:54 -0800605/*
Benjamin Marzinski86f11522014-08-13 13:53:43 -0500606 * Open a table device so we can use it as a map destination.
607 */
608static int open_table_device(struct table_device *td, dev_t dev,
609 struct mapped_device *md)
610{
611 static char *_claim_ptr = "I belong to device-mapper";
612 struct block_device *bdev;
613
614 int r;
615
616 BUG_ON(td->dm_dev.bdev);
617
618 bdev = blkdev_get_by_dev(dev, td->dm_dev.mode | FMODE_EXCL, _claim_ptr);
619 if (IS_ERR(bdev))
620 return PTR_ERR(bdev);
621
622 r = bd_link_disk_holder(bdev, dm_disk(md));
623 if (r) {
624 blkdev_put(bdev, td->dm_dev.mode | FMODE_EXCL);
625 return r;
626 }
627
628 td->dm_dev.bdev = bdev;
629 return 0;
630}
631
632/*
633 * Close a table device that we've been using.
634 */
635static void close_table_device(struct table_device *td, struct mapped_device *md)
636{
637 if (!td->dm_dev.bdev)
638 return;
639
640 bd_unlink_disk_holder(td->dm_dev.bdev, dm_disk(md));
641 blkdev_put(td->dm_dev.bdev, td->dm_dev.mode | FMODE_EXCL);
642 td->dm_dev.bdev = NULL;
643}
644
645static struct table_device *find_table_device(struct list_head *l, dev_t dev,
646 fmode_t mode) {
647 struct table_device *td;
648
649 list_for_each_entry(td, l, list)
650 if (td->dm_dev.bdev->bd_dev == dev && td->dm_dev.mode == mode)
651 return td;
652
653 return NULL;
654}
655
656int dm_get_table_device(struct mapped_device *md, dev_t dev, fmode_t mode,
657 struct dm_dev **result) {
658 int r;
659 struct table_device *td;
660
661 mutex_lock(&md->table_devices_lock);
662 td = find_table_device(&md->table_devices, dev, mode);
663 if (!td) {
Mike Snitzer115485e2016-02-22 12:16:21 -0500664 td = kmalloc_node(sizeof(*td), GFP_KERNEL, md->numa_node_id);
Benjamin Marzinski86f11522014-08-13 13:53:43 -0500665 if (!td) {
666 mutex_unlock(&md->table_devices_lock);
667 return -ENOMEM;
668 }
669
670 td->dm_dev.mode = mode;
671 td->dm_dev.bdev = NULL;
672
673 if ((r = open_table_device(td, dev, md))) {
674 mutex_unlock(&md->table_devices_lock);
675 kfree(td);
676 return r;
677 }
678
679 format_dev_t(td->dm_dev.name, dev);
680
681 atomic_set(&td->count, 0);
682 list_add(&td->list, &md->table_devices);
683 }
684 atomic_inc(&td->count);
685 mutex_unlock(&md->table_devices_lock);
686
687 *result = &td->dm_dev;
688 return 0;
689}
690EXPORT_SYMBOL_GPL(dm_get_table_device);
691
692void dm_put_table_device(struct mapped_device *md, struct dm_dev *d)
693{
694 struct table_device *td = container_of(d, struct table_device, dm_dev);
695
696 mutex_lock(&md->table_devices_lock);
697 if (atomic_dec_and_test(&td->count)) {
698 close_table_device(td, md);
699 list_del(&td->list);
700 kfree(td);
701 }
702 mutex_unlock(&md->table_devices_lock);
703}
704EXPORT_SYMBOL(dm_put_table_device);
705
706static void free_table_devices(struct list_head *devices)
707{
708 struct list_head *tmp, *next;
709
710 list_for_each_safe(tmp, next, devices) {
711 struct table_device *td = list_entry(tmp, struct table_device, list);
712
713 DMWARN("dm_destroy: %s still exists with %d references",
714 td->dm_dev.name, atomic_read(&td->count));
715 kfree(td);
716 }
717}
718
719/*
Darrick J. Wong3ac51e72006-03-27 01:17:54 -0800720 * Get the geometry associated with a dm device
721 */
722int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo)
723{
724 *geo = md->geometry;
725
726 return 0;
727}
728
729/*
730 * Set the geometry of a device.
731 */
732int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo)
733{
734 sector_t sz = (sector_t)geo->cylinders * geo->heads * geo->sectors;
735
736 if (geo->start > sz) {
737 DMWARN("Start sector is beyond the geometry limits.");
738 return -EINVAL;
739 }
740
741 md->geometry = *geo;
742
743 return 0;
744}
745
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746/*-----------------------------------------------------------------
747 * CRUD START:
748 * A more elegant soln is in the works that uses the queue
749 * merge fn, unfortunately there are a couple of changes to
750 * the block layer that I want to make for this. So in the
751 * interests of getting something for people to use I give
752 * you this clearly demarcated crap.
753 *---------------------------------------------------------------*/
754
Kiyoshi Ueda2e93ccc2006-12-08 02:41:09 -0800755static int __noflush_suspending(struct mapped_device *md)
756{
757 return test_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
758}
759
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760/*
761 * Decrements the number of outstanding ios that a bio has been
762 * cloned into, completing the original io if necc.
763 */
Arjan van de Ven858119e2006-01-14 13:20:43 -0800764static void dec_pending(struct dm_io *io, int error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765{
Kiyoshi Ueda2e93ccc2006-12-08 02:41:09 -0800766 unsigned long flags;
Milan Brozb35f8ca2009-03-16 17:44:36 +0000767 int io_error;
768 struct bio *bio;
769 struct mapped_device *md = io->md;
Kiyoshi Ueda2e93ccc2006-12-08 02:41:09 -0800770
771 /* Push-back supersedes any I/O errors */
Kiyoshi Uedaf88fb982009-10-16 23:18:15 +0100772 if (unlikely(error)) {
773 spin_lock_irqsave(&io->endio_lock, flags);
774 if (!(io->error > 0 && __noflush_suspending(md)))
775 io->error = error;
776 spin_unlock_irqrestore(&io->endio_lock, flags);
777 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778
779 if (atomic_dec_and_test(&io->io_count)) {
Kiyoshi Ueda2e93ccc2006-12-08 02:41:09 -0800780 if (io->error == DM_ENDIO_REQUEUE) {
781 /*
782 * Target requested pushing back the I/O.
Kiyoshi Ueda2e93ccc2006-12-08 02:41:09 -0800783 */
Mikulas Patocka022c2612009-04-02 19:55:39 +0100784 spin_lock_irqsave(&md->deferred_lock, flags);
Tejun Heo6a8736d2010-09-08 18:07:00 +0200785 if (__noflush_suspending(md))
786 bio_list_add_head(&md->deferred, io->bio);
787 else
Kiyoshi Ueda2e93ccc2006-12-08 02:41:09 -0800788 /* noflush suspend was interrupted. */
789 io->error = -EIO;
Mikulas Patocka022c2612009-04-02 19:55:39 +0100790 spin_unlock_irqrestore(&md->deferred_lock, flags);
Kiyoshi Ueda2e93ccc2006-12-08 02:41:09 -0800791 }
792
Milan Brozb35f8ca2009-03-16 17:44:36 +0000793 io_error = io->error;
794 bio = io->bio;
Tejun Heo6a8736d2010-09-08 18:07:00 +0200795 end_io_acct(io);
796 free_io(md, io);
Jens Axboe2056a782006-03-23 20:00:26 +0100797
Tejun Heo6a8736d2010-09-08 18:07:00 +0200798 if (io_error == DM_ENDIO_REQUEUE)
799 return;
800
Jens Axboe1eff9d32016-08-05 15:35:16 -0600801 if ((bio->bi_opf & REQ_PREFLUSH) && bio->bi_iter.bi_size) {
Mikulas Patockaaf7e4662009-04-09 00:27:16 +0100802 /*
Tejun Heo6a8736d2010-09-08 18:07:00 +0200803 * Preflush done for flush with data, reissue
Mike Christie28a8f0d2016-06-05 14:32:25 -0500804 * without REQ_PREFLUSH.
Mikulas Patockaaf7e4662009-04-09 00:27:16 +0100805 */
Jens Axboe1eff9d32016-08-05 15:35:16 -0600806 bio->bi_opf &= ~REQ_PREFLUSH;
Tejun Heo6a8736d2010-09-08 18:07:00 +0200807 queue_io(md, bio);
Mikulas Patockaaf7e4662009-04-09 00:27:16 +0100808 } else {
Mike Snitzerb372d362010-09-08 18:07:01 +0200809 /* done with normal IO or empty flush */
Linus Torvalds0a82a8d2013-04-18 09:00:26 -0700810 trace_block_bio_complete(md->queue, bio, io_error);
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200811 bio->bi_error = io_error;
812 bio_endio(bio);
Kiyoshi Ueda2e93ccc2006-12-08 02:41:09 -0800813 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 }
815}
816
Mike Snitzer4cc96132016-05-12 16:28:10 -0400817void disable_write_same(struct mapped_device *md)
Mike Snitzer7eee4ae2014-06-02 15:50:06 -0400818{
819 struct queue_limits *limits = dm_get_queue_limits(md);
820
821 /* device doesn't really support WRITE SAME, disable it */
822 limits->max_write_same_sectors = 0;
823}
824
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200825static void clone_endio(struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826{
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200827 int error = bio->bi_error;
zhendong chen5164bec2014-12-17 14:37:04 +0800828 int r = error;
Mikulas Patockabfc6d412014-03-04 18:24:49 -0500829 struct dm_target_io *tio = container_of(bio, struct dm_target_io, clone);
Milan Brozb35f8ca2009-03-16 17:44:36 +0000830 struct dm_io *io = tio->io;
Stefan Bader9faf4002006-10-03 01:15:41 -0700831 struct mapped_device *md = tio->io->md;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 dm_endio_fn endio = tio->ti->type->end_io;
833
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 if (endio) {
Mikulas Patocka7de3ee52012-12-21 20:23:41 +0000835 r = endio(tio->ti, bio, error);
Kiyoshi Ueda2e93ccc2006-12-08 02:41:09 -0800836 if (r < 0 || r == DM_ENDIO_REQUEUE)
837 /*
838 * error and requeue request are handled
839 * in dec_pending().
840 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 error = r;
Kiyoshi Ueda45cbcd72006-12-08 02:41:05 -0800842 else if (r == DM_ENDIO_INCOMPLETE)
843 /* The target will handle the io */
NeilBrown6712ecf2007-09-27 12:47:43 +0200844 return;
Kiyoshi Ueda45cbcd72006-12-08 02:41:05 -0800845 else if (r) {
846 DMWARN("unimplemented target endio return value: %d", r);
847 BUG();
848 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 }
850
Mike Christiee6047142016-06-05 14:32:04 -0500851 if (unlikely(r == -EREMOTEIO && (bio_op(bio) == REQ_OP_WRITE_SAME) &&
Mike Snitzer7eee4ae2014-06-02 15:50:06 -0400852 !bdev_get_queue(bio->bi_bdev)->limits.max_write_same_sectors))
853 disable_write_same(md);
854
Mike Snitzercfae7522016-04-11 12:05:38 -0400855 free_tio(tio);
Milan Brozb35f8ca2009-03-16 17:44:36 +0000856 dec_pending(io, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857}
858
Mike Snitzer78d8e582015-06-26 10:01:13 -0400859/*
Mike Snitzer56a67df2010-08-12 04:14:10 +0100860 * Return maximum size of I/O possible at the supplied sector up to the current
861 * target boundary.
862 */
863static sector_t max_io_len_target_boundary(sector_t sector, struct dm_target *ti)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864{
Mike Snitzer56a67df2010-08-12 04:14:10 +0100865 sector_t target_offset = dm_target_offset(ti, sector);
866
867 return ti->len - target_offset;
868}
869
870static sector_t max_io_len(sector_t sector, struct dm_target *ti)
871{
872 sector_t len = max_io_len_target_boundary(sector, ti);
Mike Snitzer542f9032012-07-27 15:08:00 +0100873 sector_t offset, max_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
875 /*
Mike Snitzer542f9032012-07-27 15:08:00 +0100876 * Does the target need to split even further?
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 */
Mike Snitzer542f9032012-07-27 15:08:00 +0100878 if (ti->max_io_len) {
879 offset = dm_target_offset(ti, sector);
880 if (unlikely(ti->max_io_len & (ti->max_io_len - 1)))
881 max_len = sector_div(offset, ti->max_io_len);
882 else
883 max_len = offset & (ti->max_io_len - 1);
884 max_len = ti->max_io_len - max_len;
885
886 if (len > max_len)
887 len = max_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 }
889
890 return len;
891}
892
Mike Snitzer542f9032012-07-27 15:08:00 +0100893int dm_set_target_max_io_len(struct dm_target *ti, sector_t len)
894{
895 if (len > UINT_MAX) {
896 DMERR("Specified maximum size of target IO (%llu) exceeds limit (%u)",
897 (unsigned long long)len, UINT_MAX);
898 ti->error = "Maximum size of target IO is too large";
899 return -EINVAL;
900 }
901
902 ti->max_io_len = (uint32_t) len;
903
904 return 0;
905}
906EXPORT_SYMBOL_GPL(dm_set_target_max_io_len);
907
Toshi Kani545ed202016-06-22 17:54:53 -0600908static long dm_blk_direct_access(struct block_device *bdev, sector_t sector,
Linus Torvaldsf0c98eb2016-07-28 17:22:07 -0700909 void **kaddr, pfn_t *pfn, long size)
Toshi Kani545ed202016-06-22 17:54:53 -0600910{
911 struct mapped_device *md = bdev->bd_disk->private_data;
912 struct dm_table *map;
913 struct dm_target *ti;
914 int srcu_idx;
915 long len, ret = -EIO;
916
917 map = dm_get_live_table(md, &srcu_idx);
918 if (!map)
919 goto out;
920
921 ti = dm_table_find_target(map, sector);
922 if (!dm_target_is_valid(ti))
923 goto out;
924
925 len = max_io_len(sector, ti) << SECTOR_SHIFT;
926 size = min(len, size);
927
928 if (ti->type->direct_access)
929 ret = ti->type->direct_access(ti, sector, kaddr, pfn, size);
930out:
931 dm_put_live_table(md, srcu_idx);
932 return min(ret, size);
933}
934
Mikulas Patocka1dd40c32014-03-14 18:41:24 -0400935/*
936 * A target may call dm_accept_partial_bio only from the map routine. It is
Mike Christie28a8f0d2016-06-05 14:32:25 -0500937 * allowed for all bio types except REQ_PREFLUSH.
Mikulas Patocka1dd40c32014-03-14 18:41:24 -0400938 *
939 * dm_accept_partial_bio informs the dm that the target only wants to process
940 * additional n_sectors sectors of the bio and the rest of the data should be
941 * sent in a next bio.
942 *
943 * A diagram that explains the arithmetics:
944 * +--------------------+---------------+-------+
945 * | 1 | 2 | 3 |
946 * +--------------------+---------------+-------+
947 *
948 * <-------------- *tio->len_ptr --------------->
949 * <------- bi_size ------->
950 * <-- n_sectors -->
951 *
952 * Region 1 was already iterated over with bio_advance or similar function.
953 * (it may be empty if the target doesn't use bio_advance)
954 * Region 2 is the remaining bio size that the target wants to process.
955 * (it may be empty if region 1 is non-empty, although there is no reason
956 * to make it empty)
957 * The target requires that region 3 is to be sent in the next bio.
958 *
959 * If the target wants to receive multiple copies of the bio (via num_*bios, etc),
960 * the partially processed part (the sum of regions 1+2) must be the same for all
961 * copies of the bio.
962 */
963void dm_accept_partial_bio(struct bio *bio, unsigned n_sectors)
964{
965 struct dm_target_io *tio = container_of(bio, struct dm_target_io, clone);
966 unsigned bi_size = bio->bi_iter.bi_size >> SECTOR_SHIFT;
Jens Axboe1eff9d32016-08-05 15:35:16 -0600967 BUG_ON(bio->bi_opf & REQ_PREFLUSH);
Mikulas Patocka1dd40c32014-03-14 18:41:24 -0400968 BUG_ON(bi_size > *tio->len_ptr);
969 BUG_ON(n_sectors > bi_size);
970 *tio->len_ptr -= bi_size - n_sectors;
971 bio->bi_iter.bi_size = n_sectors << SECTOR_SHIFT;
972}
973EXPORT_SYMBOL_GPL(dm_accept_partial_bio);
974
Mikulas Patocka21582cd2017-02-15 11:26:10 -0500975/*
976 * Flush current->bio_list when the target map method blocks.
977 * This fixes deadlocks in snapshot and possibly in other targets.
978 */
979struct dm_offload {
980 struct blk_plug plug;
981 struct blk_plug_cb cb;
982};
983
984static void flush_current_bio_list(struct blk_plug_cb *cb, bool from_schedule)
985{
986 struct dm_offload *o = container_of(cb, struct dm_offload, cb);
987 struct bio_list list;
988 struct bio *bio;
NeilBrown5959cde2017-03-10 17:00:47 +1100989 int i;
Mikulas Patocka21582cd2017-02-15 11:26:10 -0500990
991 INIT_LIST_HEAD(&o->cb.list);
992
993 if (unlikely(!current->bio_list))
994 return;
995
NeilBrown5959cde2017-03-10 17:00:47 +1100996 for (i = 0; i < 2; i++) {
997 list = current->bio_list[i];
998 bio_list_init(&current->bio_list[i]);
Mikulas Patocka21582cd2017-02-15 11:26:10 -0500999
NeilBrown5959cde2017-03-10 17:00:47 +11001000 while ((bio = bio_list_pop(&list))) {
1001 struct bio_set *bs = bio->bi_pool;
1002 if (unlikely(!bs) || bs == fs_bio_set) {
1003 bio_list_add(&current->bio_list[i], bio);
1004 continue;
1005 }
1006
1007 spin_lock(&bs->rescue_lock);
1008 bio_list_add(&bs->rescue_list, bio);
1009 queue_work(bs->rescue_workqueue, &bs->rescue_work);
1010 spin_unlock(&bs->rescue_lock);
Mikulas Patocka21582cd2017-02-15 11:26:10 -05001011 }
Mikulas Patocka21582cd2017-02-15 11:26:10 -05001012 }
1013}
1014
1015static void dm_offload_start(struct dm_offload *o)
1016{
1017 blk_start_plug(&o->plug);
1018 o->cb.callback = flush_current_bio_list;
1019 list_add(&o->cb.list, &current->plug->cb_list);
1020}
1021
1022static void dm_offload_end(struct dm_offload *o)
1023{
1024 list_del(&o->cb.list);
1025 blk_finish_plug(&o->plug);
1026}
1027
Alasdair G Kergonbd2a49b2013-03-01 22:45:46 +00001028static void __map_bio(struct dm_target_io *tio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029{
1030 int r;
Jens Axboe2056a782006-03-23 20:00:26 +01001031 sector_t sector;
Mikulas Patocka21582cd2017-02-15 11:26:10 -05001032 struct dm_offload o;
Mikulas Patockadba14162012-10-12 21:02:15 +01001033 struct bio *clone = &tio->clone;
Alasdair G Kergonbd2a49b2013-03-01 22:45:46 +00001034 struct dm_target *ti = tio->ti;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 clone->bi_end_io = clone_endio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037
1038 /*
1039 * Map the clone. If r == 0 we don't need to do
1040 * anything, the target has assumed ownership of
1041 * this io.
1042 */
1043 atomic_inc(&tio->io->io_count);
Kent Overstreet4f024f32013-10-11 15:44:27 -07001044 sector = clone->bi_iter.bi_sector;
Mikulas Patocka21582cd2017-02-15 11:26:10 -05001045
1046 dm_offload_start(&o);
Mikulas Patocka7de3ee52012-12-21 20:23:41 +00001047 r = ti->type->map(ti, clone);
Mikulas Patocka21582cd2017-02-15 11:26:10 -05001048 dm_offload_end(&o);
1049
Kiyoshi Ueda45cbcd72006-12-08 02:41:05 -08001050 if (r == DM_MAPIO_REMAPPED) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 /* the bio has been remapped so dispatch it */
Jens Axboe2056a782006-03-23 20:00:26 +01001052
Mike Snitzerd07335e2010-11-16 12:52:38 +01001053 trace_block_bio_remap(bdev_get_queue(clone->bi_bdev), clone,
1054 tio->io->bio->bi_bdev->bd_dev, sector);
Jens Axboe2056a782006-03-23 20:00:26 +01001055
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 generic_make_request(clone);
Kiyoshi Ueda2e93ccc2006-12-08 02:41:09 -08001057 } else if (r < 0 || r == DM_MAPIO_REQUEUE) {
1058 /* error the io and bail out, or requeue it if needed */
Stefan Bader9faf4002006-10-03 01:15:41 -07001059 dec_pending(tio->io, r);
Mike Snitzercfae7522016-04-11 12:05:38 -04001060 free_tio(tio);
Mikulas Patockaab378442015-07-01 17:30:36 -04001061 } else if (r != DM_MAPIO_SUBMITTED) {
Kiyoshi Ueda45cbcd72006-12-08 02:41:05 -08001062 DMWARN("unimplemented target map return value: %d", r);
1063 BUG();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 }
1065}
1066
1067struct clone_info {
1068 struct mapped_device *md;
1069 struct dm_table *map;
1070 struct bio *bio;
1071 struct dm_io *io;
1072 sector_t sector;
Mikulas Patockae0d66092014-03-14 18:40:39 -04001073 unsigned sector_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074};
1075
Mikulas Patockae0d66092014-03-14 18:40:39 -04001076static void bio_setup_sector(struct bio *bio, sector_t sector, unsigned len)
Alasdair G Kergonbd2a49b2013-03-01 22:45:46 +00001077{
Kent Overstreet4f024f32013-10-11 15:44:27 -07001078 bio->bi_iter.bi_sector = sector;
1079 bio->bi_iter.bi_size = to_bytes(len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080}
1081
1082/*
1083 * Creates a bio that consists of range of complete bvecs.
1084 */
Mike Snitzerc80914e2016-03-02 12:33:03 -05001085static int clone_bio(struct dm_target_io *tio, struct bio *bio,
1086 sector_t sector, unsigned len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087{
Mikulas Patockadba14162012-10-12 21:02:15 +01001088 struct bio *clone = &tio->clone;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089
Kent Overstreet1c3b13e2013-10-29 17:17:49 -07001090 __bio_clone_fast(clone, bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091
Mike Snitzerc80914e2016-03-02 12:33:03 -05001092 if (bio_integrity(bio)) {
1093 int r = bio_integrity_clone(clone, bio, GFP_NOIO);
1094 if (r < 0)
1095 return r;
1096 }
Kent Overstreet1c3b13e2013-10-29 17:17:49 -07001097
1098 bio_advance(clone, to_bytes(sector - clone->bi_iter.bi_sector));
1099 clone->bi_iter.bi_size = to_bytes(len);
1100
1101 if (bio_integrity(bio))
1102 bio_integrity_trim(clone, 0, len);
Mike Snitzerc80914e2016-03-02 12:33:03 -05001103
1104 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105}
1106
Alasdair G Kergon9015df22009-06-22 10:12:21 +01001107static struct dm_target_io *alloc_tio(struct clone_info *ci,
Junichi Nomura99778272014-10-03 11:55:16 +00001108 struct dm_target *ti,
Alasdair G Kergon55a62ee2013-03-01 22:45:47 +00001109 unsigned target_bio_nr)
Mikulas Patockaf9ab94c2009-06-22 10:12:20 +01001110{
Mikulas Patockadba14162012-10-12 21:02:15 +01001111 struct dm_target_io *tio;
1112 struct bio *clone;
1113
Junichi Nomura99778272014-10-03 11:55:16 +00001114 clone = bio_alloc_bioset(GFP_NOIO, 0, ci->md->bs);
Mikulas Patockadba14162012-10-12 21:02:15 +01001115 tio = container_of(clone, struct dm_target_io, clone);
Mikulas Patockaf9ab94c2009-06-22 10:12:20 +01001116
1117 tio->io = ci->io;
1118 tio->ti = ti;
Alasdair G Kergon55a62ee2013-03-01 22:45:47 +00001119 tio->target_bio_nr = target_bio_nr;
Alasdair G Kergon9015df22009-06-22 10:12:21 +01001120
1121 return tio;
1122}
1123
Alasdair G Kergon14fe5942013-03-01 22:45:47 +00001124static void __clone_and_map_simple_bio(struct clone_info *ci,
1125 struct dm_target *ti,
Mikulas Patocka1dd40c32014-03-14 18:41:24 -04001126 unsigned target_bio_nr, unsigned *len)
Alasdair G Kergon9015df22009-06-22 10:12:21 +01001127{
Junichi Nomura99778272014-10-03 11:55:16 +00001128 struct dm_target_io *tio = alloc_tio(ci, ti, target_bio_nr);
Mikulas Patockadba14162012-10-12 21:02:15 +01001129 struct bio *clone = &tio->clone;
Alasdair G Kergon9015df22009-06-22 10:12:21 +01001130
Mikulas Patocka1dd40c32014-03-14 18:41:24 -04001131 tio->len_ptr = len;
1132
Junichi Nomura99778272014-10-03 11:55:16 +00001133 __bio_clone_fast(clone, ci->bio);
Alasdair G Kergonbd2a49b2013-03-01 22:45:46 +00001134 if (len)
Mikulas Patocka1dd40c32014-03-14 18:41:24 -04001135 bio_setup_sector(clone, ci->sector, *len);
Mikulas Patockaf9ab94c2009-06-22 10:12:20 +01001136
Alasdair G Kergonbd2a49b2013-03-01 22:45:46 +00001137 __map_bio(tio);
Mikulas Patockaf9ab94c2009-06-22 10:12:20 +01001138}
1139
Alasdair G Kergon14fe5942013-03-01 22:45:47 +00001140static void __send_duplicate_bios(struct clone_info *ci, struct dm_target *ti,
Mikulas Patocka1dd40c32014-03-14 18:41:24 -04001141 unsigned num_bios, unsigned *len)
Mike Snitzer06a426c2010-08-12 04:14:09 +01001142{
Alasdair G Kergon55a62ee2013-03-01 22:45:47 +00001143 unsigned target_bio_nr;
Mike Snitzer06a426c2010-08-12 04:14:09 +01001144
Alasdair G Kergon55a62ee2013-03-01 22:45:47 +00001145 for (target_bio_nr = 0; target_bio_nr < num_bios; target_bio_nr++)
Alasdair G Kergon14fe5942013-03-01 22:45:47 +00001146 __clone_and_map_simple_bio(ci, ti, target_bio_nr, len);
Mike Snitzer06a426c2010-08-12 04:14:09 +01001147}
1148
Alasdair G Kergon14fe5942013-03-01 22:45:47 +00001149static int __send_empty_flush(struct clone_info *ci)
Mikulas Patockaf9ab94c2009-06-22 10:12:20 +01001150{
Mike Snitzer06a426c2010-08-12 04:14:09 +01001151 unsigned target_nr = 0;
Mikulas Patockaf9ab94c2009-06-22 10:12:20 +01001152 struct dm_target *ti;
1153
Mike Snitzerb372d362010-09-08 18:07:01 +02001154 BUG_ON(bio_has_data(ci->bio));
Mikulas Patockaf9ab94c2009-06-22 10:12:20 +01001155 while ((ti = dm_table_get_target(ci->map, target_nr++)))
Mikulas Patocka1dd40c32014-03-14 18:41:24 -04001156 __send_duplicate_bios(ci, ti, ti->num_flush_bios, NULL);
Mikulas Patockaf9ab94c2009-06-22 10:12:20 +01001157
Mikulas Patockaf9ab94c2009-06-22 10:12:20 +01001158 return 0;
1159}
1160
Mike Snitzerc80914e2016-03-02 12:33:03 -05001161static int __clone_and_map_data_bio(struct clone_info *ci, struct dm_target *ti,
Mikulas Patocka1dd40c32014-03-14 18:41:24 -04001162 sector_t sector, unsigned *len)
Mike Snitzer5ae89a82010-08-12 04:14:08 +01001163{
Mikulas Patockadba14162012-10-12 21:02:15 +01001164 struct bio *bio = ci->bio;
Mike Snitzer5ae89a82010-08-12 04:14:08 +01001165 struct dm_target_io *tio;
Alasdair G Kergonb0d8ed42013-03-01 22:45:49 +00001166 unsigned target_bio_nr;
1167 unsigned num_target_bios = 1;
Mike Snitzerc80914e2016-03-02 12:33:03 -05001168 int r = 0;
Mike Snitzer5ae89a82010-08-12 04:14:08 +01001169
Alasdair G Kergonb0d8ed42013-03-01 22:45:49 +00001170 /*
1171 * Does the target want to receive duplicate copies of the bio?
1172 */
1173 if (bio_data_dir(bio) == WRITE && ti->num_write_bios)
1174 num_target_bios = ti->num_write_bios(ti, bio);
Alasdair G Kergone4c93812013-03-01 22:45:47 +00001175
Alasdair G Kergonb0d8ed42013-03-01 22:45:49 +00001176 for (target_bio_nr = 0; target_bio_nr < num_target_bios; target_bio_nr++) {
Junichi Nomura99778272014-10-03 11:55:16 +00001177 tio = alloc_tio(ci, ti, target_bio_nr);
Mikulas Patocka1dd40c32014-03-14 18:41:24 -04001178 tio->len_ptr = len;
Mike Snitzerc80914e2016-03-02 12:33:03 -05001179 r = clone_bio(tio, bio, sector, *len);
Mikulas Patocka072623d2016-04-09 12:48:18 -04001180 if (r < 0) {
Mike Snitzercfae7522016-04-11 12:05:38 -04001181 free_tio(tio);
Mike Snitzerc80914e2016-03-02 12:33:03 -05001182 break;
Mikulas Patocka072623d2016-04-09 12:48:18 -04001183 }
Alasdair G Kergonb0d8ed42013-03-01 22:45:49 +00001184 __map_bio(tio);
1185 }
Mike Snitzerc80914e2016-03-02 12:33:03 -05001186
1187 return r;
Mike Snitzer5ae89a82010-08-12 04:14:08 +01001188}
1189
Alasdair G Kergon55a62ee2013-03-01 22:45:47 +00001190typedef unsigned (*get_num_bios_fn)(struct dm_target *ti);
Mike Snitzer23508a92012-12-21 20:23:37 +00001191
Alasdair G Kergon55a62ee2013-03-01 22:45:47 +00001192static unsigned get_num_discard_bios(struct dm_target *ti)
Mike Snitzer23508a92012-12-21 20:23:37 +00001193{
Alasdair G Kergon55a62ee2013-03-01 22:45:47 +00001194 return ti->num_discard_bios;
Mike Snitzer23508a92012-12-21 20:23:37 +00001195}
1196
Alasdair G Kergon55a62ee2013-03-01 22:45:47 +00001197static unsigned get_num_write_same_bios(struct dm_target *ti)
Mike Snitzer23508a92012-12-21 20:23:37 +00001198{
Alasdair G Kergon55a62ee2013-03-01 22:45:47 +00001199 return ti->num_write_same_bios;
Mike Snitzer23508a92012-12-21 20:23:37 +00001200}
1201
1202typedef bool (*is_split_required_fn)(struct dm_target *ti);
1203
1204static bool is_split_required_for_discard(struct dm_target *ti)
1205{
Alasdair G Kergon55a62ee2013-03-01 22:45:47 +00001206 return ti->split_discard_bios;
Mike Snitzer23508a92012-12-21 20:23:37 +00001207}
1208
Alasdair G Kergon14fe5942013-03-01 22:45:47 +00001209static int __send_changing_extent_only(struct clone_info *ci,
1210 get_num_bios_fn get_num_bios,
1211 is_split_required_fn is_split_required)
Mike Snitzer5ae89a82010-08-12 04:14:08 +01001212{
1213 struct dm_target *ti;
Mikulas Patockae0d66092014-03-14 18:40:39 -04001214 unsigned len;
Alasdair G Kergon55a62ee2013-03-01 22:45:47 +00001215 unsigned num_bios;
Mike Snitzer5ae89a82010-08-12 04:14:08 +01001216
Mike Snitzera79245b2010-08-12 04:14:24 +01001217 do {
1218 ti = dm_table_find_target(ci->map, ci->sector);
1219 if (!dm_target_is_valid(ti))
1220 return -EIO;
Mike Snitzer5ae89a82010-08-12 04:14:08 +01001221
Mike Snitzer5ae89a82010-08-12 04:14:08 +01001222 /*
Mike Snitzer23508a92012-12-21 20:23:37 +00001223 * Even though the device advertised support for this type of
1224 * request, that does not mean every target supports it, and
Mike Snitzer936688d2011-08-02 12:32:01 +01001225 * reconfiguration might also have changed that since the
Mike Snitzera79245b2010-08-12 04:14:24 +01001226 * check was performed.
Mike Snitzer5ae89a82010-08-12 04:14:08 +01001227 */
Alasdair G Kergon55a62ee2013-03-01 22:45:47 +00001228 num_bios = get_num_bios ? get_num_bios(ti) : 0;
1229 if (!num_bios)
Mike Snitzera79245b2010-08-12 04:14:24 +01001230 return -EOPNOTSUPP;
Mike Snitzer5ae89a82010-08-12 04:14:08 +01001231
Mike Snitzer23508a92012-12-21 20:23:37 +00001232 if (is_split_required && !is_split_required(ti))
Mikulas Patockae0d66092014-03-14 18:40:39 -04001233 len = min((sector_t)ci->sector_count, max_io_len_target_boundary(ci->sector, ti));
Mikulas Patocka7acf0272012-07-27 15:08:03 +01001234 else
Mikulas Patockae0d66092014-03-14 18:40:39 -04001235 len = min((sector_t)ci->sector_count, max_io_len(ci->sector, ti));
Mike Snitzer06a426c2010-08-12 04:14:09 +01001236
Mikulas Patocka1dd40c32014-03-14 18:41:24 -04001237 __send_duplicate_bios(ci, ti, num_bios, &len);
Mike Snitzera79245b2010-08-12 04:14:24 +01001238
1239 ci->sector += len;
1240 } while (ci->sector_count -= len);
Mike Snitzer5ae89a82010-08-12 04:14:08 +01001241
1242 return 0;
1243}
1244
Alasdair G Kergon14fe5942013-03-01 22:45:47 +00001245static int __send_discard(struct clone_info *ci)
Mike Snitzer23508a92012-12-21 20:23:37 +00001246{
Alasdair G Kergon14fe5942013-03-01 22:45:47 +00001247 return __send_changing_extent_only(ci, get_num_discard_bios,
1248 is_split_required_for_discard);
Mike Snitzer23508a92012-12-21 20:23:37 +00001249}
1250
Alasdair G Kergon14fe5942013-03-01 22:45:47 +00001251static int __send_write_same(struct clone_info *ci)
Mike Snitzer23508a92012-12-21 20:23:37 +00001252{
Alasdair G Kergon14fe5942013-03-01 22:45:47 +00001253 return __send_changing_extent_only(ci, get_num_write_same_bios, NULL);
Mike Snitzer23508a92012-12-21 20:23:37 +00001254}
1255
Alasdair G Kergone4c93812013-03-01 22:45:47 +00001256/*
Alasdair G Kergone4c93812013-03-01 22:45:47 +00001257 * Select the correct strategy for processing a non-flush bio.
1258 */
Alasdair G Kergon14fe5942013-03-01 22:45:47 +00001259static int __split_and_process_non_flush(struct clone_info *ci)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260{
Mikulas Patockadba14162012-10-12 21:02:15 +01001261 struct bio *bio = ci->bio;
Jun'ichi Nomura512875b2007-12-13 14:15:25 +00001262 struct dm_target *ti;
Kent Overstreet1c3b13e2013-10-29 17:17:49 -07001263 unsigned len;
Mike Snitzerc80914e2016-03-02 12:33:03 -05001264 int r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265
Mike Christiee6047142016-06-05 14:32:04 -05001266 if (unlikely(bio_op(bio) == REQ_OP_DISCARD))
Alasdair G Kergon14fe5942013-03-01 22:45:47 +00001267 return __send_discard(ci);
Mike Christiee6047142016-06-05 14:32:04 -05001268 else if (unlikely(bio_op(bio) == REQ_OP_WRITE_SAME))
Alasdair G Kergon14fe5942013-03-01 22:45:47 +00001269 return __send_write_same(ci);
Mike Snitzer5ae89a82010-08-12 04:14:08 +01001270
Jun'ichi Nomura512875b2007-12-13 14:15:25 +00001271 ti = dm_table_find_target(ci->map, ci->sector);
1272 if (!dm_target_is_valid(ti))
1273 return -EIO;
1274
Kent Overstreet1c3b13e2013-10-29 17:17:49 -07001275 len = min_t(sector_t, max_io_len(ci->sector, ti), ci->sector_count);
Jun'ichi Nomura512875b2007-12-13 14:15:25 +00001276
Mike Snitzerc80914e2016-03-02 12:33:03 -05001277 r = __clone_and_map_data_bio(ci, ti, ci->sector, &len);
1278 if (r < 0)
1279 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280
Kent Overstreet1c3b13e2013-10-29 17:17:49 -07001281 ci->sector += len;
1282 ci->sector_count -= len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283
Kent Overstreet1c3b13e2013-10-29 17:17:49 -07001284 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285}
1286
1287/*
Alasdair G Kergon14fe5942013-03-01 22:45:47 +00001288 * Entry point to split a bio into clones and submit them to the targets.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 */
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01001290static void __split_and_process_bio(struct mapped_device *md,
1291 struct dm_table *map, struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292{
1293 struct clone_info ci;
Jun'ichi Nomura512875b2007-12-13 14:15:25 +00001294 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01001296 if (unlikely(!map)) {
Tejun Heo6a8736d2010-09-08 18:07:00 +02001297 bio_io_error(bio);
Mikulas Patockaf0b9a452009-04-02 19:55:38 +01001298 return;
1299 }
Mikulas Patocka692d0eb2009-04-09 00:27:13 +01001300
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01001301 ci.map = map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302 ci.md = md;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 ci.io = alloc_io(md);
1304 ci.io->error = 0;
1305 atomic_set(&ci.io->io_count, 1);
1306 ci.io->bio = bio;
1307 ci.io->md = md;
Kiyoshi Uedaf88fb982009-10-16 23:18:15 +01001308 spin_lock_init(&ci.io->endio_lock);
Kent Overstreet4f024f32013-10-11 15:44:27 -07001309 ci.sector = bio->bi_iter.bi_sector;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310
Jun'ichi "Nick" Nomura3eaf8402006-02-01 03:04:53 -08001311 start_io_acct(ci.io);
Alasdair G Kergonbd2a49b2013-03-01 22:45:46 +00001312
Jens Axboe1eff9d32016-08-05 15:35:16 -06001313 if (bio->bi_opf & REQ_PREFLUSH) {
Mike Snitzerb372d362010-09-08 18:07:01 +02001314 ci.bio = &ci.md->flush_bio;
1315 ci.sector_count = 0;
Alasdair G Kergon14fe5942013-03-01 22:45:47 +00001316 error = __send_empty_flush(&ci);
Mike Snitzerb372d362010-09-08 18:07:01 +02001317 /* dec_pending submits any data associated with flush */
1318 } else {
Tejun Heo6a8736d2010-09-08 18:07:00 +02001319 ci.bio = bio;
Tejun Heod87f4c12010-09-03 11:56:19 +02001320 ci.sector_count = bio_sectors(bio);
Mike Snitzerb372d362010-09-08 18:07:01 +02001321 while (ci.sector_count && !error)
Alasdair G Kergon14fe5942013-03-01 22:45:47 +00001322 error = __split_and_process_non_flush(&ci);
Tejun Heod87f4c12010-09-03 11:56:19 +02001323 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324
1325 /* drop the extra reference count */
Jun'ichi Nomura512875b2007-12-13 14:15:25 +00001326 dec_pending(ci.io, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327}
1328/*-----------------------------------------------------------------
1329 * CRUD END
1330 *---------------------------------------------------------------*/
1331
1332/*
1333 * The request function that just remaps the bio built up by
1334 * dm_merge_bvec.
1335 */
Jens Axboedece1632015-11-05 10:41:16 -07001336static blk_qc_t dm_make_request(struct request_queue *q, struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337{
Kevin Corry12f03a42006-02-01 03:04:52 -08001338 int rw = bio_data_dir(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 struct mapped_device *md = q->queuedata;
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01001340 int srcu_idx;
1341 struct dm_table *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01001343 map = dm_get_live_table(md, &srcu_idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344
Gu Zheng18c0b222014-11-24 11:05:26 +08001345 generic_start_io_acct(rw, bio_sectors(bio), &dm_disk(md)->part0);
Kevin Corry12f03a42006-02-01 03:04:52 -08001346
Tejun Heo6a8736d2010-09-08 18:07:00 +02001347 /* if we're suspended, we have to queue this io for later */
1348 if (unlikely(test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags))) {
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01001349 dm_put_live_table(md, srcu_idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350
Jens Axboe1eff9d32016-08-05 15:35:16 -06001351 if (!(bio->bi_opf & REQ_RAHEAD))
Tejun Heo6a8736d2010-09-08 18:07:00 +02001352 queue_io(md, bio);
1353 else
Alasdair G Kergon54d9a1b2009-04-09 00:27:14 +01001354 bio_io_error(bio);
Jens Axboedece1632015-11-05 10:41:16 -07001355 return BLK_QC_T_NONE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 }
1357
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01001358 __split_and_process_bio(md, map, bio);
1359 dm_put_live_table(md, srcu_idx);
Jens Axboedece1632015-11-05 10:41:16 -07001360 return BLK_QC_T_NONE;
Kiyoshi Uedacec47e32009-06-22 10:12:35 +01001361}
1362
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363static int dm_any_congested(void *congested_data, int bdi_bits)
1364{
Chandra Seetharaman8a57dfc2008-11-13 23:39:14 +00001365 int r = bdi_bits;
1366 struct mapped_device *md = congested_data;
1367 struct dm_table *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368
Alasdair G Kergon1eb787e2009-04-09 00:27:14 +01001369 if (!test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) {
Mike Snitzere522c032016-02-02 22:35:06 -05001370 if (dm_request_based(md)) {
Kiyoshi Uedacec47e32009-06-22 10:12:35 +01001371 /*
Mike Snitzere522c032016-02-02 22:35:06 -05001372 * With request-based DM we only need to check the
1373 * top-level queue for congestion.
Kiyoshi Uedacec47e32009-06-22 10:12:35 +01001374 */
Mike Snitzere522c032016-02-02 22:35:06 -05001375 r = md->queue->backing_dev_info.wb.state & bdi_bits;
1376 } else {
1377 map = dm_get_live_table_fast(md);
1378 if (map)
Kiyoshi Uedacec47e32009-06-22 10:12:35 +01001379 r = dm_table_any_congested(map, bdi_bits);
Mike Snitzere522c032016-02-02 22:35:06 -05001380 dm_put_live_table_fast(md);
Chandra Seetharaman8a57dfc2008-11-13 23:39:14 +00001381 }
1382 }
1383
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 return r;
1385}
1386
1387/*-----------------------------------------------------------------
1388 * An IDR is used to keep track of allocated minor numbers.
1389 *---------------------------------------------------------------*/
Alasdair G Kergon2b06cff2006-06-26 00:27:32 -07001390static void free_minor(int minor)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391{
Jeff Mahoneyf32c10b2006-06-26 00:27:22 -07001392 spin_lock(&_minor_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 idr_remove(&_minor_idr, minor);
Jeff Mahoneyf32c10b2006-06-26 00:27:22 -07001394 spin_unlock(&_minor_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395}
1396
1397/*
1398 * See if the device with a specific minor # is free.
1399 */
Frederik Deweerdtcf13ab82008-04-24 22:10:59 +01001400static int specific_minor(int minor)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401{
Tejun Heoc9d76be2013-02-27 17:04:26 -08001402 int r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403
1404 if (minor >= (1 << MINORBITS))
1405 return -EINVAL;
1406
Tejun Heoc9d76be2013-02-27 17:04:26 -08001407 idr_preload(GFP_KERNEL);
Jeff Mahoneyf32c10b2006-06-26 00:27:22 -07001408 spin_lock(&_minor_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409
Tejun Heoc9d76be2013-02-27 17:04:26 -08001410 r = idr_alloc(&_minor_idr, MINOR_ALLOCED, minor, minor + 1, GFP_NOWAIT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411
Jeff Mahoneyf32c10b2006-06-26 00:27:22 -07001412 spin_unlock(&_minor_lock);
Tejun Heoc9d76be2013-02-27 17:04:26 -08001413 idr_preload_end();
1414 if (r < 0)
1415 return r == -ENOSPC ? -EBUSY : r;
1416 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417}
1418
Frederik Deweerdtcf13ab82008-04-24 22:10:59 +01001419static int next_free_minor(int *minor)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420{
Tejun Heoc9d76be2013-02-27 17:04:26 -08001421 int r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422
Tejun Heoc9d76be2013-02-27 17:04:26 -08001423 idr_preload(GFP_KERNEL);
Jeff Mahoneyf32c10b2006-06-26 00:27:22 -07001424 spin_lock(&_minor_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425
Tejun Heoc9d76be2013-02-27 17:04:26 -08001426 r = idr_alloc(&_minor_idr, MINOR_ALLOCED, 0, 1 << MINORBITS, GFP_NOWAIT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427
Jeff Mahoneyf32c10b2006-06-26 00:27:22 -07001428 spin_unlock(&_minor_lock);
Tejun Heoc9d76be2013-02-27 17:04:26 -08001429 idr_preload_end();
1430 if (r < 0)
1431 return r;
1432 *minor = r;
1433 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434}
1435
Alexey Dobriyan83d5cde2009-09-21 17:01:13 -07001436static const struct block_device_operations dm_blk_dops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437
Mikulas Patocka53d59142009-04-02 19:55:37 +01001438static void dm_wq_work(struct work_struct *work);
1439
Mike Snitzer4cc96132016-05-12 16:28:10 -04001440void dm_init_md_queue(struct mapped_device *md)
Mike Snitzer4a0b4dd2010-08-12 04:14:02 +01001441{
1442 /*
1443 * Request-based dm devices cannot be stacked on top of bio-based dm
Mike Snitzerbfebd1c2015-03-08 00:51:47 -05001444 * devices. The type of this dm device may not have been decided yet.
Mike Snitzer4a0b4dd2010-08-12 04:14:02 +01001445 * The type is decided at the first table loading time.
1446 * To prevent problematic device stacking, clear the queue flag
1447 * for request stacking support until then.
1448 *
1449 * This queue is new, so no concurrency on the queue_flags.
1450 */
1451 queue_flag_clear_unlocked(QUEUE_FLAG_STACKABLE, md->queue);
Mikulas Patockaad5f4982015-10-27 19:06:55 -04001452
1453 /*
1454 * Initialize data that will only be used by a non-blk-mq DM queue
1455 * - must do so here (in alloc_dev callchain) before queue is used
1456 */
1457 md->queue->queuedata = md;
1458 md->queue->backing_dev_info.congested_data = md;
Mike Snitzerbfebd1c2015-03-08 00:51:47 -05001459}
Mike Snitzer4a0b4dd2010-08-12 04:14:02 +01001460
Mike Snitzer4cc96132016-05-12 16:28:10 -04001461void dm_init_normal_md_queue(struct mapped_device *md)
Mike Snitzerbfebd1c2015-03-08 00:51:47 -05001462{
Mike Snitzer17e149b2015-03-11 15:01:09 -04001463 md->use_blk_mq = false;
Mike Snitzerbfebd1c2015-03-08 00:51:47 -05001464 dm_init_md_queue(md);
1465
1466 /*
1467 * Initialize aspects of queue that aren't relevant for blk-mq
1468 */
Mike Snitzer4a0b4dd2010-08-12 04:14:02 +01001469 md->queue->backing_dev_info.congested_fn = dm_any_congested;
Mike Snitzer4a0b4dd2010-08-12 04:14:02 +01001470 blk_queue_bounce_limit(md->queue, BLK_BOUNCE_ANY);
Mike Snitzer4a0b4dd2010-08-12 04:14:02 +01001471}
1472
Mike Snitzer0f209722015-04-28 11:50:29 -04001473static void cleanup_mapped_device(struct mapped_device *md)
1474{
Mike Snitzer0f209722015-04-28 11:50:29 -04001475 if (md->wq)
1476 destroy_workqueue(md->wq);
1477 if (md->kworker_task)
1478 kthread_stop(md->kworker_task);
Julia Lawall6f659852015-09-13 14:15:05 +02001479 mempool_destroy(md->io_pool);
1480 mempool_destroy(md->rq_pool);
Mike Snitzer0f209722015-04-28 11:50:29 -04001481 if (md->bs)
1482 bioset_free(md->bs);
1483
1484 if (md->disk) {
1485 spin_lock(&_minor_lock);
1486 md->disk->private_data = NULL;
1487 spin_unlock(&_minor_lock);
Mike Snitzer0f209722015-04-28 11:50:29 -04001488 del_gendisk(md->disk);
1489 put_disk(md->disk);
1490 }
1491
1492 if (md->queue)
1493 blk_cleanup_queue(md->queue);
1494
Tahsin Erdogand09960b2016-10-10 05:35:19 -07001495 cleanup_srcu_struct(&md->io_barrier);
1496
Mike Snitzer0f209722015-04-28 11:50:29 -04001497 if (md->bdev) {
1498 bdput(md->bdev);
1499 md->bdev = NULL;
1500 }
Mike Snitzer4cc96132016-05-12 16:28:10 -04001501
1502 dm_mq_cleanup_mapped_device(md);
Mike Snitzer0f209722015-04-28 11:50:29 -04001503}
1504
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505/*
1506 * Allocate and initialise a blank device with a given minor.
1507 */
Alasdair G Kergon2b06cff2006-06-26 00:27:32 -07001508static struct mapped_device *alloc_dev(int minor)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509{
Mike Snitzer115485e2016-02-22 12:16:21 -05001510 int r, numa_node_id = dm_get_numa_node();
1511 struct mapped_device *md;
Jeff Mahoneyba61fdd2006-06-26 00:27:21 -07001512 void *old_md;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513
Mike Snitzer115485e2016-02-22 12:16:21 -05001514 md = kzalloc_node(sizeof(*md), GFP_KERNEL, numa_node_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 if (!md) {
1516 DMWARN("unable to allocate device, out of memory.");
1517 return NULL;
1518 }
1519
Jeff Mahoney10da4f72006-06-26 00:27:25 -07001520 if (!try_module_get(THIS_MODULE))
Milan Broz6ed7ade2008-02-08 02:10:19 +00001521 goto bad_module_get;
Jeff Mahoney10da4f72006-06-26 00:27:25 -07001522
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523 /* get a minor number for the dev */
Alasdair G Kergon2b06cff2006-06-26 00:27:32 -07001524 if (minor == DM_ANY_MINOR)
Frederik Deweerdtcf13ab82008-04-24 22:10:59 +01001525 r = next_free_minor(&minor);
Alasdair G Kergon2b06cff2006-06-26 00:27:32 -07001526 else
Frederik Deweerdtcf13ab82008-04-24 22:10:59 +01001527 r = specific_minor(minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 if (r < 0)
Milan Broz6ed7ade2008-02-08 02:10:19 +00001529 goto bad_minor;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01001531 r = init_srcu_struct(&md->io_barrier);
1532 if (r < 0)
1533 goto bad_io_barrier;
1534
Mike Snitzer115485e2016-02-22 12:16:21 -05001535 md->numa_node_id = numa_node_id;
Mike Snitzer4cc96132016-05-12 16:28:10 -04001536 md->use_blk_mq = dm_use_blk_mq_default();
Mike Snitzer591ddcf2016-01-31 12:05:42 -05001537 md->init_tio_pdu = false;
Mike Snitzera5664da2010-08-12 04:14:01 +01001538 md->type = DM_TYPE_NONE;
Daniel Walkere61290a2008-02-08 02:10:08 +00001539 mutex_init(&md->suspend_lock);
Mike Snitzera5664da2010-08-12 04:14:01 +01001540 mutex_init(&md->type_lock);
Benjamin Marzinski86f11522014-08-13 13:53:43 -05001541 mutex_init(&md->table_devices_lock);
Mikulas Patocka022c2612009-04-02 19:55:39 +01001542 spin_lock_init(&md->deferred_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 atomic_set(&md->holders, 1);
Alasdair G Kergon5c6bd752006-06-26 00:27:34 -07001544 atomic_set(&md->open_count, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 atomic_set(&md->event_nr, 0);
Mike Anderson7a8c3d32007-10-19 22:48:01 +01001546 atomic_set(&md->uevent_seq, 0);
1547 INIT_LIST_HEAD(&md->uevent_list);
Benjamin Marzinski86f11522014-08-13 13:53:43 -05001548 INIT_LIST_HEAD(&md->table_devices);
Mike Anderson7a8c3d32007-10-19 22:48:01 +01001549 spin_lock_init(&md->uevent_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550
Mike Snitzer115485e2016-02-22 12:16:21 -05001551 md->queue = blk_alloc_queue_node(GFP_KERNEL, numa_node_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552 if (!md->queue)
Mike Snitzer0f209722015-04-28 11:50:29 -04001553 goto bad;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554
Mike Snitzer4a0b4dd2010-08-12 04:14:02 +01001555 dm_init_md_queue(md);
Stefan Bader9faf4002006-10-03 01:15:41 -07001556
Mike Snitzer115485e2016-02-22 12:16:21 -05001557 md->disk = alloc_disk_node(1, numa_node_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 if (!md->disk)
Mike Snitzer0f209722015-04-28 11:50:29 -04001559 goto bad;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560
Nikanth Karthikesan316d3152009-10-06 20:16:55 +02001561 atomic_set(&md->pending[0], 0);
1562 atomic_set(&md->pending[1], 0);
Jeff Mahoneyf0b04112006-06-26 00:27:25 -07001563 init_waitqueue_head(&md->wait);
Mikulas Patocka53d59142009-04-02 19:55:37 +01001564 INIT_WORK(&md->work, dm_wq_work);
Jeff Mahoneyf0b04112006-06-26 00:27:25 -07001565 init_waitqueue_head(&md->eventq);
Mikulas Patocka2995fa72014-01-13 19:37:54 -05001566 init_completion(&md->kobj_holder.completion);
Keith Busch2eb6e1e2014-10-17 17:46:36 -06001567 md->kworker_task = NULL;
Jeff Mahoneyf0b04112006-06-26 00:27:25 -07001568
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 md->disk->major = _major;
1570 md->disk->first_minor = minor;
1571 md->disk->fops = &dm_blk_dops;
1572 md->disk->queue = md->queue;
1573 md->disk->private_data = md;
1574 sprintf(md->disk->disk_name, "dm-%d", minor);
1575 add_disk(md->disk);
Mike Anderson7e51f252006-03-27 01:17:52 -08001576 format_dev_t(md->name, MKDEV(_major, minor));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577
Tejun Heo670368a2013-07-30 08:40:21 -04001578 md->wq = alloc_workqueue("kdmflush", WQ_MEM_RECLAIM, 0);
Milan Broz304f3f62008-02-08 02:11:17 +00001579 if (!md->wq)
Mike Snitzer0f209722015-04-28 11:50:29 -04001580 goto bad;
Milan Broz304f3f62008-02-08 02:11:17 +00001581
Mikulas Patocka32a926d2009-06-22 10:12:17 +01001582 md->bdev = bdget_disk(md->disk, 0);
1583 if (!md->bdev)
Mike Snitzer0f209722015-04-28 11:50:29 -04001584 goto bad;
Mikulas Patocka32a926d2009-06-22 10:12:17 +01001585
Tejun Heo6a8736d2010-09-08 18:07:00 +02001586 bio_init(&md->flush_bio);
1587 md->flush_bio.bi_bdev = md->bdev;
Mike Christiee6047142016-06-05 14:32:04 -05001588 bio_set_op_attrs(&md->flush_bio, REQ_OP_WRITE, WRITE_FLUSH);
Tejun Heo6a8736d2010-09-08 18:07:00 +02001589
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -04001590 dm_stats_init(&md->stats);
1591
Jeff Mahoneyba61fdd2006-06-26 00:27:21 -07001592 /* Populate the mapping, nobody knows we exist yet */
Jeff Mahoneyf32c10b2006-06-26 00:27:22 -07001593 spin_lock(&_minor_lock);
Jeff Mahoneyba61fdd2006-06-26 00:27:21 -07001594 old_md = idr_replace(&_minor_idr, md, minor);
Jeff Mahoneyf32c10b2006-06-26 00:27:22 -07001595 spin_unlock(&_minor_lock);
Jeff Mahoneyba61fdd2006-06-26 00:27:21 -07001596
1597 BUG_ON(old_md != MINOR_ALLOCED);
1598
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 return md;
1600
Mike Snitzer0f209722015-04-28 11:50:29 -04001601bad:
1602 cleanup_mapped_device(md);
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01001603bad_io_barrier:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 free_minor(minor);
Milan Broz6ed7ade2008-02-08 02:10:19 +00001605bad_minor:
Jeff Mahoney10da4f72006-06-26 00:27:25 -07001606 module_put(THIS_MODULE);
Milan Broz6ed7ade2008-02-08 02:10:19 +00001607bad_module_get:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 kfree(md);
1609 return NULL;
1610}
1611
Jun'ichi Nomuraae9da832007-10-19 22:38:43 +01001612static void unlock_fs(struct mapped_device *md);
1613
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614static void free_dev(struct mapped_device *md)
1615{
Tejun Heof331c022008-09-03 09:01:48 +02001616 int minor = MINOR(disk_devt(md->disk));
Jun'ichi Nomura63d94e42006-02-24 13:04:25 -08001617
Mikulas Patocka32a926d2009-06-22 10:12:17 +01001618 unlock_fs(md);
Keith Busch2eb6e1e2014-10-17 17:46:36 -06001619
Mike Snitzer0f209722015-04-28 11:50:29 -04001620 cleanup_mapped_device(md);
Mike Snitzer0f209722015-04-28 11:50:29 -04001621
1622 free_table_devices(&md->table_devices);
1623 dm_stats_cleanup(&md->stats);
Mike Snitzer63a4f062015-03-23 17:01:43 -04001624 free_minor(minor);
1625
Jeff Mahoney10da4f72006-06-26 00:27:25 -07001626 module_put(THIS_MODULE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627 kfree(md);
1628}
1629
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01001630static void __bind_mempools(struct mapped_device *md, struct dm_table *t)
1631{
Mikulas Patockac0820cf2012-12-21 20:23:38 +00001632 struct dm_md_mempools *p = dm_table_get_md_mempools(t);
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01001633
Mike Snitzer4e6e36c2015-06-26 09:42:57 -04001634 if (md->bs) {
1635 /* The md already has necessary mempools. */
Toshi Kani545ed202016-06-22 17:54:53 -06001636 if (dm_table_bio_based(t)) {
Jun'ichi Nomura16245bd2013-03-01 22:45:44 +00001637 /*
1638 * Reload bioset because front_pad may have changed
1639 * because a different table was loaded.
1640 */
1641 bioset_free(md->bs);
1642 md->bs = p->bs;
1643 p->bs = NULL;
Jun'ichi Nomura16245bd2013-03-01 22:45:44 +00001644 }
Mike Snitzer4e6e36c2015-06-26 09:42:57 -04001645 /*
1646 * There's no need to reload with request-based dm
1647 * because the size of front_pad doesn't change.
1648 * Note for future: If you are to reload bioset,
1649 * prep-ed requests in the queue may refer
1650 * to bio from the old bioset, so you must walk
1651 * through the queue to unprep.
1652 */
1653 goto out;
Mikulas Patockac0820cf2012-12-21 20:23:38 +00001654 }
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01001655
Mike Snitzercbc4e3c2015-04-27 16:37:50 -04001656 BUG_ON(!p || md->io_pool || md->rq_pool || md->bs);
1657
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01001658 md->io_pool = p->io_pool;
1659 p->io_pool = NULL;
Mike Snitzer1ae49ea2014-12-05 17:11:05 -05001660 md->rq_pool = p->rq_pool;
1661 p->rq_pool = NULL;
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01001662 md->bs = p->bs;
1663 p->bs = NULL;
Mike Snitzer4e6e36c2015-06-26 09:42:57 -04001664
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01001665out:
Mike Snitzer02233342015-03-10 23:49:26 -04001666 /* mempool bind completed, no longer need any mempools in the table */
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01001667 dm_table_free_md_mempools(t);
1668}
1669
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670/*
1671 * Bind a table to the device.
1672 */
1673static void event_callback(void *context)
1674{
Mike Anderson7a8c3d32007-10-19 22:48:01 +01001675 unsigned long flags;
1676 LIST_HEAD(uevents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 struct mapped_device *md = (struct mapped_device *) context;
1678
Mike Anderson7a8c3d32007-10-19 22:48:01 +01001679 spin_lock_irqsave(&md->uevent_lock, flags);
1680 list_splice_init(&md->uevent_list, &uevents);
1681 spin_unlock_irqrestore(&md->uevent_lock, flags);
1682
Tejun Heoed9e1982008-08-25 19:56:05 +09001683 dm_send_uevents(&uevents, &disk_to_dev(md->disk)->kobj);
Mike Anderson7a8c3d32007-10-19 22:48:01 +01001684
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 atomic_inc(&md->event_nr);
1686 wake_up(&md->eventq);
1687}
1688
Mike Snitzerc2176492011-01-13 19:53:46 +00001689/*
1690 * Protected by md->suspend_lock obtained by dm_swap_table().
1691 */
Alasdair G Kergon4e90188be2005-07-28 21:15:59 -07001692static void __set_size(struct mapped_device *md, sector_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693{
Alasdair G Kergon4e90188be2005-07-28 21:15:59 -07001694 set_capacity(md->disk, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695
Mikulas Patockadb8fef42009-06-22 10:12:15 +01001696 i_size_write(md->bdev->bd_inode, (loff_t)size << SECTOR_SHIFT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697}
1698
Alasdair G Kergon042d2a92009-12-10 23:52:24 +00001699/*
1700 * Returns old map, which caller must destroy.
1701 */
1702static struct dm_table *__bind(struct mapped_device *md, struct dm_table *t,
1703 struct queue_limits *limits)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704{
Alasdair G Kergon042d2a92009-12-10 23:52:24 +00001705 struct dm_table *old_map;
Jens Axboe165125e2007-07-24 09:28:11 +02001706 struct request_queue *q = md->queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707 sector_t size;
1708
Bart Van Assche5a8f1f82016-08-31 15:17:04 -07001709 lockdep_assert_held(&md->suspend_lock);
1710
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711 size = dm_table_get_size(t);
Darrick J. Wong3ac51e72006-03-27 01:17:54 -08001712
1713 /*
1714 * Wipe any geometry if the size of the table changed.
1715 */
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -04001716 if (size != dm_get_size(md))
Darrick J. Wong3ac51e72006-03-27 01:17:54 -08001717 memset(&md->geometry, 0, sizeof(md->geometry));
1718
Mikulas Patocka32a926d2009-06-22 10:12:17 +01001719 __set_size(md, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720
Alasdair G Kergoncf222b32005-07-28 21:15:57 -07001721 dm_table_event_callback(t, event_callback, md);
Alasdair G Kergon2ca33102005-07-28 21:16:00 -07001722
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01001723 /*
1724 * The queue hasn't been stopped yet, if the old table type wasn't
1725 * for request-based during suspension. So stop it to prevent
1726 * I/O mapping before resume.
1727 * This must be done before setting the queue restrictions,
1728 * because request-based dm may be run just after the setting.
1729 */
Mike Snitzer16f12262016-01-31 17:22:27 -05001730 if (dm_table_request_based(t)) {
Mike Snitzereca7ee62016-02-20 13:45:38 -05001731 dm_stop_queue(q);
Mike Snitzer16f12262016-01-31 17:22:27 -05001732 /*
1733 * Leverage the fact that request-based DM targets are
1734 * immutable singletons and establish md->immutable_target
1735 * - used to optimize both dm_request_fn and dm_mq_queue_rq
1736 */
1737 md->immutable_target = dm_table_get_immutable_target(t);
1738 }
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01001739
1740 __bind_mempools(md, t);
1741
Eric Dumazeta12f5d42014-11-23 09:34:29 -08001742 old_map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
Mike Snitzer1d3aa6f2016-02-22 14:14:24 -05001743 rcu_assign_pointer(md->map, (void *)t);
Alasdair G Kergon36a04562011-10-31 20:19:04 +00001744 md->immutable_target_type = dm_table_get_immutable_target_type(t);
1745
Mike Snitzer754c5fc2009-06-22 10:12:34 +01001746 dm_table_set_restrictions(t, q, limits);
Hannes Reinecke41abc4e2014-11-05 14:35:50 +01001747 if (old_map)
1748 dm_sync_table(md);
Alasdair G Kergon2ca33102005-07-28 21:16:00 -07001749
Alasdair G Kergon042d2a92009-12-10 23:52:24 +00001750 return old_map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751}
1752
Alasdair G Kergona7940152009-12-10 23:52:23 +00001753/*
1754 * Returns unbound table for the caller to free.
1755 */
1756static struct dm_table *__unbind(struct mapped_device *md)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757{
Eric Dumazeta12f5d42014-11-23 09:34:29 -08001758 struct dm_table *map = rcu_dereference_protected(md->map, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759
1760 if (!map)
Alasdair G Kergona7940152009-12-10 23:52:23 +00001761 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762
1763 dm_table_event_callback(map, NULL, NULL);
Monam Agarwal9cdb8522014-03-23 23:58:27 +05301764 RCU_INIT_POINTER(md->map, NULL);
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01001765 dm_sync_table(md);
Alasdair G Kergona7940152009-12-10 23:52:23 +00001766
1767 return map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768}
1769
1770/*
1771 * Constructor for a new device.
1772 */
Alasdair G Kergon2b06cff2006-06-26 00:27:32 -07001773int dm_create(int minor, struct mapped_device **result)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774{
1775 struct mapped_device *md;
1776
Alasdair G Kergon2b06cff2006-06-26 00:27:32 -07001777 md = alloc_dev(minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778 if (!md)
1779 return -ENXIO;
1780
Milan Broz784aae72009-01-06 03:05:12 +00001781 dm_sysfs_init(md);
1782
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783 *result = md;
1784 return 0;
1785}
1786
Mike Snitzera5664da2010-08-12 04:14:01 +01001787/*
1788 * Functions to manage md->type.
1789 * All are required to hold md->type_lock.
1790 */
1791void dm_lock_md_type(struct mapped_device *md)
1792{
1793 mutex_lock(&md->type_lock);
1794}
1795
1796void dm_unlock_md_type(struct mapped_device *md)
1797{
1798 mutex_unlock(&md->type_lock);
1799}
1800
1801void dm_set_md_type(struct mapped_device *md, unsigned type)
1802{
Mike Snitzer00c4fc32013-08-27 18:57:03 -04001803 BUG_ON(!mutex_is_locked(&md->type_lock));
Mike Snitzera5664da2010-08-12 04:14:01 +01001804 md->type = type;
1805}
1806
1807unsigned dm_get_md_type(struct mapped_device *md)
1808{
1809 return md->type;
1810}
1811
Alasdair G Kergon36a04562011-10-31 20:19:04 +00001812struct target_type *dm_get_immutable_target_type(struct mapped_device *md)
1813{
1814 return md->immutable_target_type;
1815}
1816
Mike Snitzer4a0b4dd2010-08-12 04:14:02 +01001817/*
Mike Snitzerf84cb8a2013-09-19 12:13:58 -04001818 * The queue_limits are only valid as long as you have a reference
1819 * count on 'md'.
1820 */
1821struct queue_limits *dm_get_queue_limits(struct mapped_device *md)
1822{
1823 BUG_ON(!atomic_read(&md->holders));
1824 return &md->queue->limits;
1825}
1826EXPORT_SYMBOL_GPL(dm_get_queue_limits);
1827
Mike Snitzer4a0b4dd2010-08-12 04:14:02 +01001828/*
1829 * Setup the DM device's queue based on md's type
1830 */
Mike Snitzer591ddcf2016-01-31 12:05:42 -05001831int dm_setup_md_queue(struct mapped_device *md, struct dm_table *t)
Mike Snitzer4a0b4dd2010-08-12 04:14:02 +01001832{
Mike Snitzerbfebd1c2015-03-08 00:51:47 -05001833 int r;
Toshi Kani545ed202016-06-22 17:54:53 -06001834 unsigned type = dm_get_md_type(md);
Mike Snitzerbfebd1c2015-03-08 00:51:47 -05001835
Toshi Kani545ed202016-06-22 17:54:53 -06001836 switch (type) {
Mike Snitzerbfebd1c2015-03-08 00:51:47 -05001837 case DM_TYPE_REQUEST_BASED:
Mike Snitzereca7ee62016-02-20 13:45:38 -05001838 r = dm_old_init_request_queue(md);
Mike Snitzerbfebd1c2015-03-08 00:51:47 -05001839 if (r) {
Mike Snitzereca7ee62016-02-20 13:45:38 -05001840 DMERR("Cannot initialize queue for request-based mapped device");
Mike Snitzerbfebd1c2015-03-08 00:51:47 -05001841 return r;
Mike Snitzerff36ab32015-02-23 17:56:37 -05001842 }
Mike Snitzerbfebd1c2015-03-08 00:51:47 -05001843 break;
1844 case DM_TYPE_MQ_REQUEST_BASED:
Mike Snitzere83068a2016-05-24 21:16:51 -04001845 r = dm_mq_init_request_queue(md, t);
Mike Snitzerbfebd1c2015-03-08 00:51:47 -05001846 if (r) {
Mike Snitzereca7ee62016-02-20 13:45:38 -05001847 DMERR("Cannot initialize queue for request-based dm-mq mapped device");
Mike Snitzerbfebd1c2015-03-08 00:51:47 -05001848 return r;
1849 }
1850 break;
1851 case DM_TYPE_BIO_BASED:
Toshi Kani545ed202016-06-22 17:54:53 -06001852 case DM_TYPE_DAX_BIO_BASED:
Mike Snitzereca7ee62016-02-20 13:45:38 -05001853 dm_init_normal_md_queue(md);
Mike Snitzerff36ab32015-02-23 17:56:37 -05001854 blk_queue_make_request(md->queue, dm_make_request);
Mikulas Patockadbba42d2015-10-21 16:34:20 -04001855 /*
1856 * DM handles splitting bios as needed. Free the bio_split bioset
1857 * since it won't be used (saves 1 process per bio-based DM device).
1858 */
1859 bioset_free(md->queue->bio_split);
1860 md->queue->bio_split = NULL;
Toshi Kani545ed202016-06-22 17:54:53 -06001861
1862 if (type == DM_TYPE_DAX_BIO_BASED)
1863 queue_flag_set_unlocked(QUEUE_FLAG_DAX, md->queue);
Mike Snitzerbfebd1c2015-03-08 00:51:47 -05001864 break;
Mike Snitzer4a0b4dd2010-08-12 04:14:02 +01001865 }
1866
1867 return 0;
1868}
1869
Mikulas Patocka2bec1f42015-02-17 14:30:53 -05001870struct mapped_device *dm_get_md(dev_t dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871{
1872 struct mapped_device *md;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873 unsigned minor = MINOR(dev);
1874
1875 if (MAJOR(dev) != _major || minor >= (1 << MINORBITS))
1876 return NULL;
1877
Jeff Mahoneyf32c10b2006-06-26 00:27:22 -07001878 spin_lock(&_minor_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879
1880 md = idr_find(&_minor_idr, minor);
Mikulas Patocka2bec1f42015-02-17 14:30:53 -05001881 if (md) {
1882 if ((md == MINOR_ALLOCED ||
1883 (MINOR(disk_devt(dm_disk(md))) != minor) ||
1884 dm_deleting_md(md) ||
1885 test_bit(DMF_FREEING, &md->flags))) {
1886 md = NULL;
1887 goto out;
1888 }
1889 dm_get(md);
Jeff Mahoneyfba9f902006-06-26 00:27:23 -07001890 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891
Jeff Mahoneyfba9f902006-06-26 00:27:23 -07001892out:
Jeff Mahoneyf32c10b2006-06-26 00:27:22 -07001893 spin_unlock(&_minor_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894
David Teigland637842c2006-01-06 00:20:00 -08001895 return md;
1896}
Alasdair G Kergon3cf2e4b2011-10-31 20:19:06 +00001897EXPORT_SYMBOL_GPL(dm_get_md);
David Teiglandd229a952006-01-06 00:20:01 -08001898
Alasdair G Kergon9ade92a2006-03-27 01:17:53 -08001899void *dm_get_mdptr(struct mapped_device *md)
David Teigland637842c2006-01-06 00:20:00 -08001900{
Alasdair G Kergon9ade92a2006-03-27 01:17:53 -08001901 return md->interface_ptr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902}
1903
1904void dm_set_mdptr(struct mapped_device *md, void *ptr)
1905{
1906 md->interface_ptr = ptr;
1907}
1908
1909void dm_get(struct mapped_device *md)
1910{
1911 atomic_inc(&md->holders);
Kiyoshi Ueda3f77316d2010-08-12 04:13:56 +01001912 BUG_ON(test_bit(DMF_FREEING, &md->flags));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913}
1914
Mikulas Patocka09ee96b2015-02-26 11:41:28 -05001915int dm_hold(struct mapped_device *md)
1916{
1917 spin_lock(&_minor_lock);
1918 if (test_bit(DMF_FREEING, &md->flags)) {
1919 spin_unlock(&_minor_lock);
1920 return -EBUSY;
1921 }
1922 dm_get(md);
1923 spin_unlock(&_minor_lock);
1924 return 0;
1925}
1926EXPORT_SYMBOL_GPL(dm_hold);
1927
Alasdair G Kergon72d94862006-06-26 00:27:35 -07001928const char *dm_device_name(struct mapped_device *md)
1929{
1930 return md->name;
1931}
1932EXPORT_SYMBOL_GPL(dm_device_name);
1933
Kiyoshi Ueda3f77316d2010-08-12 04:13:56 +01001934static void __dm_destroy(struct mapped_device *md, bool wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935{
Bart Van Assche3b785fb2016-08-31 15:17:49 -07001936 struct request_queue *q = dm_get_md_queue(md);
Mike Anderson1134e5a2006-03-27 01:17:54 -08001937 struct dm_table *map;
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01001938 int srcu_idx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939
Kiyoshi Ueda3f77316d2010-08-12 04:13:56 +01001940 might_sleep();
Jeff Mahoneyfba9f902006-06-26 00:27:23 -07001941
Mike Snitzer63a4f062015-03-23 17:01:43 -04001942 spin_lock(&_minor_lock);
Kiyoshi Ueda3f77316d2010-08-12 04:13:56 +01001943 idr_replace(&_minor_idr, MINOR_ALLOCED, MINOR(disk_devt(dm_disk(md))));
1944 set_bit(DMF_FREEING, &md->flags);
1945 spin_unlock(&_minor_lock);
1946
Bart Van Assche3b785fb2016-08-31 15:17:49 -07001947 spin_lock_irq(q->queue_lock);
1948 queue_flag_set(QUEUE_FLAG_DYING, q);
1949 spin_unlock_irq(q->queue_lock);
1950
Mike Snitzer02233342015-03-10 23:49:26 -04001951 if (dm_request_based(md) && md->kworker_task)
Petr Mladek39891442016-10-11 13:55:20 -07001952 kthread_flush_worker(&md->kworker);
Keith Busch2eb6e1e2014-10-17 17:46:36 -06001953
Mikulas Patockaab7c7bb2015-02-27 14:04:27 -05001954 /*
1955 * Take suspend_lock so that presuspend and postsuspend methods
1956 * do not race with internal suspend.
1957 */
1958 mutex_lock(&md->suspend_lock);
Junichi Nomura2a708cf2015-10-01 08:31:51 +00001959 map = dm_get_live_table(md, &srcu_idx);
Kiyoshi Ueda3f77316d2010-08-12 04:13:56 +01001960 if (!dm_suspended_md(md)) {
1961 dm_table_presuspend_targets(map);
1962 dm_table_postsuspend_targets(map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963 }
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01001964 /* dm_put_live_table must be before msleep, otherwise deadlock is possible */
1965 dm_put_live_table(md, srcu_idx);
Junichi Nomura2a708cf2015-10-01 08:31:51 +00001966 mutex_unlock(&md->suspend_lock);
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01001967
Kiyoshi Ueda3f77316d2010-08-12 04:13:56 +01001968 /*
1969 * Rare, but there may be I/O requests still going to complete,
1970 * for example. Wait for all references to disappear.
1971 * No one should increment the reference count of the mapped_device,
1972 * after the mapped_device state becomes DMF_FREEING.
1973 */
1974 if (wait)
1975 while (atomic_read(&md->holders))
1976 msleep(1);
1977 else if (atomic_read(&md->holders))
1978 DMWARN("%s: Forcibly removing mapped_device still in use! (%d users)",
1979 dm_device_name(md), atomic_read(&md->holders));
1980
1981 dm_sysfs_exit(md);
Kiyoshi Ueda3f77316d2010-08-12 04:13:56 +01001982 dm_table_destroy(__unbind(md));
1983 free_dev(md);
1984}
1985
1986void dm_destroy(struct mapped_device *md)
1987{
1988 __dm_destroy(md, true);
1989}
1990
1991void dm_destroy_immediate(struct mapped_device *md)
1992{
1993 __dm_destroy(md, false);
1994}
1995
1996void dm_put(struct mapped_device *md)
1997{
1998 atomic_dec(&md->holders);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999}
Edward Goggin79eb8852007-05-09 02:32:56 -07002000EXPORT_SYMBOL_GPL(dm_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001
Bart Van Asscheb48633f2016-08-31 15:16:02 -07002002static int dm_wait_for_completion(struct mapped_device *md, long task_state)
Milan Broz46125c12008-02-08 02:10:30 +00002003{
2004 int r = 0;
Bart Van Assche9f4c3f82016-08-31 15:16:43 -07002005 DEFINE_WAIT(wait);
Milan Broz46125c12008-02-08 02:10:30 +00002006
2007 while (1) {
Bart Van Assche9f4c3f82016-08-31 15:16:43 -07002008 prepare_to_wait(&md->wait, &wait, task_state);
Milan Broz46125c12008-02-08 02:10:30 +00002009
Kiyoshi Uedab4324fe2009-12-10 23:52:16 +00002010 if (!md_in_flight(md))
Milan Broz46125c12008-02-08 02:10:30 +00002011 break;
2012
Bart Van Asschee3fabdf2016-08-31 15:16:22 -07002013 if (signal_pending_state(task_state, current)) {
Milan Broz46125c12008-02-08 02:10:30 +00002014 r = -EINTR;
2015 break;
2016 }
2017
2018 io_schedule();
2019 }
Bart Van Assche9f4c3f82016-08-31 15:16:43 -07002020 finish_wait(&md->wait, &wait);
Mikulas Patockab44ebeb2009-04-02 19:55:39 +01002021
Milan Broz46125c12008-02-08 02:10:30 +00002022 return r;
2023}
2024
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025/*
2026 * Process the deferred bios
2027 */
Mikulas Patockaef208582009-04-02 19:55:38 +01002028static void dm_wq_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029{
Mikulas Patockaef208582009-04-02 19:55:38 +01002030 struct mapped_device *md = container_of(work, struct mapped_device,
2031 work);
Milan Broz6d6f10d2008-02-08 02:10:22 +00002032 struct bio *c;
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01002033 int srcu_idx;
2034 struct dm_table *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01002036 map = dm_get_live_table(md, &srcu_idx);
Mikulas Patockaef208582009-04-02 19:55:38 +01002037
Mikulas Patocka3b00b202009-04-09 00:27:15 +01002038 while (!test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) {
Alasdair G Kergondf12ee92009-04-09 00:27:13 +01002039 spin_lock_irq(&md->deferred_lock);
2040 c = bio_list_pop(&md->deferred);
2041 spin_unlock_irq(&md->deferred_lock);
Mikulas Patocka022c2612009-04-02 19:55:39 +01002042
Tejun Heo6a8736d2010-09-08 18:07:00 +02002043 if (!c)
Alasdair G Kergondf12ee92009-04-09 00:27:13 +01002044 break;
Alasdair G Kergondf12ee92009-04-09 00:27:13 +01002045
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01002046 if (dm_request_based(md))
2047 generic_make_request(c);
Tejun Heo6a8736d2010-09-08 18:07:00 +02002048 else
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01002049 __split_and_process_bio(md, map, c);
Mikulas Patocka022c2612009-04-02 19:55:39 +01002050 }
Milan Broz73d410c2008-02-08 02:10:25 +00002051
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01002052 dm_put_live_table(md, srcu_idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053}
2054
Mikulas Patocka9a1fb462009-04-02 19:55:36 +01002055static void dm_queue_flush(struct mapped_device *md)
Milan Broz304f3f62008-02-08 02:11:17 +00002056{
Mikulas Patocka3b00b202009-04-09 00:27:15 +01002057 clear_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002058 smp_mb__after_atomic();
Mikulas Patocka53d59142009-04-02 19:55:37 +01002059 queue_work(md->wq, &md->work);
Milan Broz304f3f62008-02-08 02:11:17 +00002060}
2061
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062/*
Alasdair G Kergon042d2a92009-12-10 23:52:24 +00002063 * Swap in a new table, returning the old one for the caller to destroy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 */
Alasdair G Kergon042d2a92009-12-10 23:52:24 +00002065struct dm_table *dm_swap_table(struct mapped_device *md, struct dm_table *table)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066{
Mike Christie87eb5b22013-03-01 22:45:48 +00002067 struct dm_table *live_map = NULL, *map = ERR_PTR(-EINVAL);
Mike Snitzer754c5fc2009-06-22 10:12:34 +01002068 struct queue_limits limits;
Alasdair G Kergon042d2a92009-12-10 23:52:24 +00002069 int r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070
Daniel Walkere61290a2008-02-08 02:10:08 +00002071 mutex_lock(&md->suspend_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072
2073 /* device must be suspended */
Kiyoshi Ueda4f186f82009-12-10 23:52:26 +00002074 if (!dm_suspended_md(md))
Alasdair G Kergon93c534a2005-07-12 15:53:05 -07002075 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076
Mike Snitzer3ae70652012-09-26 23:45:45 +01002077 /*
2078 * If the new table has no data devices, retain the existing limits.
2079 * This helps multipath with queue_if_no_path if all paths disappear,
2080 * then new I/O is queued based on these limits, and then some paths
2081 * reappear.
2082 */
2083 if (dm_table_has_no_data_devices(table)) {
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01002084 live_map = dm_get_live_table_fast(md);
Mike Snitzer3ae70652012-09-26 23:45:45 +01002085 if (live_map)
2086 limits = md->queue->limits;
Mikulas Patocka83d5e5b2013-07-10 23:41:18 +01002087 dm_put_live_table_fast(md);
Mike Snitzer3ae70652012-09-26 23:45:45 +01002088 }
2089
Mike Christie87eb5b22013-03-01 22:45:48 +00002090 if (!live_map) {
2091 r = dm_calculate_queue_limits(table, &limits);
2092 if (r) {
2093 map = ERR_PTR(r);
2094 goto out;
2095 }
Alasdair G Kergon042d2a92009-12-10 23:52:24 +00002096 }
Mike Snitzer754c5fc2009-06-22 10:12:34 +01002097
Alasdair G Kergon042d2a92009-12-10 23:52:24 +00002098 map = __bind(md, table, &limits);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099
Alasdair G Kergon93c534a2005-07-12 15:53:05 -07002100out:
Daniel Walkere61290a2008-02-08 02:10:08 +00002101 mutex_unlock(&md->suspend_lock);
Alasdair G Kergon042d2a92009-12-10 23:52:24 +00002102 return map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103}
2104
2105/*
2106 * Functions to lock and unlock any filesystem running on the
2107 * device.
2108 */
Alasdair G Kergon2ca33102005-07-28 21:16:00 -07002109static int lock_fs(struct mapped_device *md)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110{
Alasdair G Kergone39e2e92006-01-06 00:20:05 -08002111 int r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112
2113 WARN_ON(md->frozen_sb);
Alasdair G Kergondfbe03f2005-05-05 16:16:04 -07002114
Mikulas Patockadb8fef42009-06-22 10:12:15 +01002115 md->frozen_sb = freeze_bdev(md->bdev);
Alasdair G Kergondfbe03f2005-05-05 16:16:04 -07002116 if (IS_ERR(md->frozen_sb)) {
Alasdair G Kergoncf222b32005-07-28 21:15:57 -07002117 r = PTR_ERR(md->frozen_sb);
Alasdair G Kergone39e2e92006-01-06 00:20:05 -08002118 md->frozen_sb = NULL;
2119 return r;
Alasdair G Kergondfbe03f2005-05-05 16:16:04 -07002120 }
2121
Alasdair G Kergonaa8d7c22006-01-06 00:20:06 -08002122 set_bit(DMF_FROZEN, &md->flags);
2123
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124 return 0;
2125}
2126
Alasdair G Kergon2ca33102005-07-28 21:16:00 -07002127static void unlock_fs(struct mapped_device *md)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128{
Alasdair G Kergonaa8d7c22006-01-06 00:20:06 -08002129 if (!test_bit(DMF_FROZEN, &md->flags))
2130 return;
2131
Mikulas Patockadb8fef42009-06-22 10:12:15 +01002132 thaw_bdev(md->bdev, md->frozen_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 md->frozen_sb = NULL;
Alasdair G Kergonaa8d7c22006-01-06 00:20:06 -08002134 clear_bit(DMF_FROZEN, &md->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135}
2136
2137/*
Bart Van Asscheb48633f2016-08-31 15:16:02 -07002138 * @suspend_flags: DM_SUSPEND_LOCKFS_FLAG and/or DM_SUSPEND_NOFLUSH_FLAG
2139 * @task_state: e.g. TASK_INTERRUPTIBLE or TASK_UNINTERRUPTIBLE
2140 * @dmf_suspended_flag: DMF_SUSPENDED or DMF_SUSPENDED_INTERNALLY
2141 *
Mike Snitzerffcc3932014-10-28 18:34:52 -04002142 * If __dm_suspend returns 0, the device is completely quiescent
2143 * now. There is no request-processing activity. All new requests
2144 * are being added to md->deferred list.
Kiyoshi Uedacec47e32009-06-22 10:12:35 +01002145 *
Mike Snitzerffcc3932014-10-28 18:34:52 -04002146 * Caller must hold md->suspend_lock
Kiyoshi Uedacec47e32009-06-22 10:12:35 +01002147 */
Mike Snitzerffcc3932014-10-28 18:34:52 -04002148static int __dm_suspend(struct mapped_device *md, struct dm_table *map,
Bart Van Asscheb48633f2016-08-31 15:16:02 -07002149 unsigned suspend_flags, long task_state,
Mike Snitzereaf9a732016-08-02 13:07:20 -04002150 int dmf_suspended_flag)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151{
Mike Snitzerffcc3932014-10-28 18:34:52 -04002152 bool do_lockfs = suspend_flags & DM_SUSPEND_LOCKFS_FLAG;
2153 bool noflush = suspend_flags & DM_SUSPEND_NOFLUSH_FLAG;
2154 int r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155
Bart Van Assche5a8f1f82016-08-31 15:17:04 -07002156 lockdep_assert_held(&md->suspend_lock);
2157
Kiyoshi Ueda2e93ccc2006-12-08 02:41:09 -08002158 /*
2159 * DMF_NOFLUSH_SUSPENDING must be set before presuspend.
2160 * This flag is cleared before dm_suspend returns.
2161 */
2162 if (noflush)
2163 set_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
2164
Mike Snitzerd67ee212014-10-28 20:13:31 -04002165 /*
2166 * This gets reverted if there's an error later and the targets
2167 * provide the .presuspend_undo hook.
2168 */
Alasdair G Kergoncf222b32005-07-28 21:15:57 -07002169 dm_table_presuspend_targets(map);
2170
Mikulas Patocka32a926d2009-06-22 10:12:17 +01002171 /*
Kiyoshi Ueda9f518b22009-12-10 23:52:16 +00002172 * Flush I/O to the device.
2173 * Any I/O submitted after lock_fs() may not be flushed.
2174 * noflush takes precedence over do_lockfs.
2175 * (lock_fs() flushes I/Os and waits for them to complete.)
Mikulas Patocka32a926d2009-06-22 10:12:17 +01002176 */
2177 if (!noflush && do_lockfs) {
2178 r = lock_fs(md);
Mike Snitzerd67ee212014-10-28 20:13:31 -04002179 if (r) {
2180 dm_table_presuspend_undo_targets(map);
Mike Snitzerffcc3932014-10-28 18:34:52 -04002181 return r;
Mike Snitzerd67ee212014-10-28 20:13:31 -04002182 }
Alasdair G Kergonaa8d7c22006-01-06 00:20:06 -08002183 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184
2185 /*
Mikulas Patocka3b00b202009-04-09 00:27:15 +01002186 * Here we must make sure that no processes are submitting requests
2187 * to target drivers i.e. no one may be executing
2188 * __split_and_process_bio. This is called from dm_request and
2189 * dm_wq_work.
2190 *
2191 * To get all processes out of __split_and_process_bio in dm_request,
2192 * we take the write lock. To prevent any process from reentering
Tejun Heo6a8736d2010-09-08 18:07:00 +02002193 * __split_and_process_bio from dm_request and quiesce the thread
2194 * (dm_wq_work), we set BMF_BLOCK_IO_FOR_SUSPEND and call
2195 * flush_workqueue(md->wq).
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196 */
Alasdair G Kergon1eb787e2009-04-09 00:27:14 +01002197 set_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
Hannes Reinecke41abc4e2014-11-05 14:35:50 +01002198 if (map)
2199 synchronize_srcu(&md->io_barrier);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200
Kiyoshi Uedad0bcb872009-12-10 23:52:18 +00002201 /*
Tejun Heo29e40132010-09-08 18:07:00 +02002202 * Stop md->queue before flushing md->wq in case request-based
2203 * dm defers requests to md->wq from md->queue.
Kiyoshi Uedad0bcb872009-12-10 23:52:18 +00002204 */
Keith Busch2eb6e1e2014-10-17 17:46:36 -06002205 if (dm_request_based(md)) {
Mike Snitzereca7ee62016-02-20 13:45:38 -05002206 dm_stop_queue(md->queue);
Mike Snitzer02233342015-03-10 23:49:26 -04002207 if (md->kworker_task)
Petr Mladek39891442016-10-11 13:55:20 -07002208 kthread_flush_worker(&md->kworker);
Keith Busch2eb6e1e2014-10-17 17:46:36 -06002209 }
Kiyoshi Uedacec47e32009-06-22 10:12:35 +01002210
Kiyoshi Uedad0bcb872009-12-10 23:52:18 +00002211 flush_workqueue(md->wq);
2212
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213 /*
Mikulas Patocka3b00b202009-04-09 00:27:15 +01002214 * At this point no more requests are entering target request routines.
2215 * We call dm_wait_for_completion to wait for all existing requests
2216 * to finish.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 */
Bart Van Asscheb48633f2016-08-31 15:16:02 -07002218 r = dm_wait_for_completion(md, task_state);
Mike Snitzereaf9a732016-08-02 13:07:20 -04002219 if (!r)
2220 set_bit(dmf_suspended_flag, &md->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221
Milan Broz6d6f10d2008-02-08 02:10:22 +00002222 if (noflush)
Mikulas Patocka022c2612009-04-02 19:55:39 +01002223 clear_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
Hannes Reinecke41abc4e2014-11-05 14:35:50 +01002224 if (map)
2225 synchronize_srcu(&md->io_barrier);
Kiyoshi Ueda2e93ccc2006-12-08 02:41:09 -08002226
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227 /* were we interrupted ? */
Milan Broz46125c12008-02-08 02:10:30 +00002228 if (r < 0) {
Mikulas Patocka9a1fb462009-04-02 19:55:36 +01002229 dm_queue_flush(md);
Milan Broz73d410c2008-02-08 02:10:25 +00002230
Kiyoshi Uedacec47e32009-06-22 10:12:35 +01002231 if (dm_request_based(md))
Mike Snitzereca7ee62016-02-20 13:45:38 -05002232 dm_start_queue(md->queue);
Kiyoshi Uedacec47e32009-06-22 10:12:35 +01002233
Alasdair G Kergon2ca33102005-07-28 21:16:00 -07002234 unlock_fs(md);
Mike Snitzerd67ee212014-10-28 20:13:31 -04002235 dm_table_presuspend_undo_targets(map);
Mike Snitzerffcc3932014-10-28 18:34:52 -04002236 /* pushback list is already flushed, so skip flush */
Alasdair G Kergon2ca33102005-07-28 21:16:00 -07002237 }
Alasdair G Kergon2ca33102005-07-28 21:16:00 -07002238
Mike Snitzerffcc3932014-10-28 18:34:52 -04002239 return r;
2240}
2241
2242/*
2243 * We need to be able to change a mapping table under a mounted
2244 * filesystem. For example we might want to move some data in
2245 * the background. Before the table can be swapped with
2246 * dm_bind_table, dm_suspend must be called to flush any in
2247 * flight bios and ensure that any further io gets deferred.
2248 */
2249/*
2250 * Suspend mechanism in request-based dm.
2251 *
2252 * 1. Flush all I/Os by lock_fs() if needed.
2253 * 2. Stop dispatching any I/O by stopping the request_queue.
2254 * 3. Wait for all in-flight I/Os to be completed or requeued.
2255 *
2256 * To abort suspend, start the request_queue.
2257 */
2258int dm_suspend(struct mapped_device *md, unsigned suspend_flags)
2259{
2260 struct dm_table *map = NULL;
2261 int r = 0;
2262
2263retry:
2264 mutex_lock_nested(&md->suspend_lock, SINGLE_DEPTH_NESTING);
2265
2266 if (dm_suspended_md(md)) {
2267 r = -EINVAL;
2268 goto out_unlock;
2269 }
2270
2271 if (dm_suspended_internally_md(md)) {
2272 /* already internally suspended, wait for internal resume */
2273 mutex_unlock(&md->suspend_lock);
2274 r = wait_on_bit(&md->flags, DMF_SUSPENDED_INTERNALLY, TASK_INTERRUPTIBLE);
2275 if (r)
2276 return r;
2277 goto retry;
2278 }
2279
Eric Dumazeta12f5d42014-11-23 09:34:29 -08002280 map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
Mike Snitzerffcc3932014-10-28 18:34:52 -04002281
Mike Snitzereaf9a732016-08-02 13:07:20 -04002282 r = __dm_suspend(md, map, suspend_flags, TASK_INTERRUPTIBLE, DMF_SUSPENDED);
Mike Snitzerffcc3932014-10-28 18:34:52 -04002283 if (r)
2284 goto out_unlock;
Mikulas Patocka3b00b202009-04-09 00:27:15 +01002285
Kiyoshi Ueda4d4471c2009-12-10 23:52:26 +00002286 dm_table_postsuspend_targets(map);
2287
Alasdair G Kergond2874832006-11-08 17:44:43 -08002288out_unlock:
Daniel Walkere61290a2008-02-08 02:10:08 +00002289 mutex_unlock(&md->suspend_lock);
Alasdair G Kergoncf222b32005-07-28 21:15:57 -07002290 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291}
2292
Mike Snitzerffcc3932014-10-28 18:34:52 -04002293static int __dm_resume(struct mapped_device *md, struct dm_table *map)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002294{
Mike Snitzerffcc3932014-10-28 18:34:52 -04002295 if (map) {
2296 int r = dm_table_resume_targets(map);
2297 if (r)
2298 return r;
2299 }
Alasdair G Kergon2ca33102005-07-28 21:16:00 -07002300
Mikulas Patocka9a1fb462009-04-02 19:55:36 +01002301 dm_queue_flush(md);
Alasdair G Kergon2ca33102005-07-28 21:16:00 -07002302
Kiyoshi Uedacec47e32009-06-22 10:12:35 +01002303 /*
2304 * Flushing deferred I/Os must be done after targets are resumed
2305 * so that mapping of targets can work correctly.
2306 * Request-based dm is queueing the deferred I/Os in its request_queue.
2307 */
2308 if (dm_request_based(md))
Mike Snitzereca7ee62016-02-20 13:45:38 -05002309 dm_start_queue(md->queue);
Kiyoshi Uedacec47e32009-06-22 10:12:35 +01002310
Alasdair G Kergon2ca33102005-07-28 21:16:00 -07002311 unlock_fs(md);
2312
Mike Snitzerffcc3932014-10-28 18:34:52 -04002313 return 0;
2314}
2315
2316int dm_resume(struct mapped_device *md)
2317{
Minfei Huang8dc23652016-09-06 16:00:29 +08002318 int r;
Mike Snitzerffcc3932014-10-28 18:34:52 -04002319 struct dm_table *map = NULL;
2320
2321retry:
Minfei Huang8dc23652016-09-06 16:00:29 +08002322 r = -EINVAL;
Mike Snitzerffcc3932014-10-28 18:34:52 -04002323 mutex_lock_nested(&md->suspend_lock, SINGLE_DEPTH_NESTING);
2324
2325 if (!dm_suspended_md(md))
2326 goto out;
2327
2328 if (dm_suspended_internally_md(md)) {
2329 /* already internally suspended, wait for internal resume */
2330 mutex_unlock(&md->suspend_lock);
2331 r = wait_on_bit(&md->flags, DMF_SUSPENDED_INTERNALLY, TASK_INTERRUPTIBLE);
2332 if (r)
2333 return r;
2334 goto retry;
2335 }
2336
Eric Dumazeta12f5d42014-11-23 09:34:29 -08002337 map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
Mike Snitzerffcc3932014-10-28 18:34:52 -04002338 if (!map || !dm_table_get_size(map))
2339 goto out;
2340
2341 r = __dm_resume(md, map);
2342 if (r)
2343 goto out;
2344
Alasdair G Kergon2ca33102005-07-28 21:16:00 -07002345 clear_bit(DMF_SUSPENDED, &md->flags);
Alasdair G Kergoncf222b32005-07-28 21:15:57 -07002346out:
Daniel Walkere61290a2008-02-08 02:10:08 +00002347 mutex_unlock(&md->suspend_lock);
Alasdair G Kergon2ca33102005-07-28 21:16:00 -07002348
Alasdair G Kergoncf222b32005-07-28 21:15:57 -07002349 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350}
2351
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -04002352/*
2353 * Internal suspend/resume works like userspace-driven suspend. It waits
2354 * until all bios finish and prevents issuing new bios to the target drivers.
2355 * It may be used only from the kernel.
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -04002356 */
2357
Mike Snitzerffcc3932014-10-28 18:34:52 -04002358static void __dm_internal_suspend(struct mapped_device *md, unsigned suspend_flags)
2359{
2360 struct dm_table *map = NULL;
2361
Mikulas Patocka96b26c82015-01-08 18:52:26 -05002362 if (md->internal_suspend_count++)
Mike Snitzerffcc3932014-10-28 18:34:52 -04002363 return; /* nested internal suspend */
2364
2365 if (dm_suspended_md(md)) {
2366 set_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
2367 return; /* nest suspend */
2368 }
2369
Eric Dumazeta12f5d42014-11-23 09:34:29 -08002370 map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
Mike Snitzerffcc3932014-10-28 18:34:52 -04002371
2372 /*
2373 * Using TASK_UNINTERRUPTIBLE because only NOFLUSH internal suspend is
2374 * supported. Properly supporting a TASK_INTERRUPTIBLE internal suspend
2375 * would require changing .presuspend to return an error -- avoid this
2376 * until there is a need for more elaborate variants of internal suspend.
2377 */
Mike Snitzereaf9a732016-08-02 13:07:20 -04002378 (void) __dm_suspend(md, map, suspend_flags, TASK_UNINTERRUPTIBLE,
2379 DMF_SUSPENDED_INTERNALLY);
Mike Snitzerffcc3932014-10-28 18:34:52 -04002380
2381 dm_table_postsuspend_targets(map);
2382}
2383
2384static void __dm_internal_resume(struct mapped_device *md)
2385{
Mikulas Patocka96b26c82015-01-08 18:52:26 -05002386 BUG_ON(!md->internal_suspend_count);
2387
2388 if (--md->internal_suspend_count)
Mike Snitzerffcc3932014-10-28 18:34:52 -04002389 return; /* resume from nested internal suspend */
2390
2391 if (dm_suspended_md(md))
2392 goto done; /* resume from nested suspend */
2393
2394 /*
2395 * NOTE: existing callers don't need to call dm_table_resume_targets
2396 * (which may fail -- so best to avoid it for now by passing NULL map)
2397 */
2398 (void) __dm_resume(md, NULL);
2399
2400done:
2401 clear_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
2402 smp_mb__after_atomic();
2403 wake_up_bit(&md->flags, DMF_SUSPENDED_INTERNALLY);
2404}
2405
2406void dm_internal_suspend_noflush(struct mapped_device *md)
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -04002407{
2408 mutex_lock(&md->suspend_lock);
Mike Snitzerffcc3932014-10-28 18:34:52 -04002409 __dm_internal_suspend(md, DM_SUSPEND_NOFLUSH_FLAG);
2410 mutex_unlock(&md->suspend_lock);
2411}
2412EXPORT_SYMBOL_GPL(dm_internal_suspend_noflush);
2413
2414void dm_internal_resume(struct mapped_device *md)
2415{
2416 mutex_lock(&md->suspend_lock);
2417 __dm_internal_resume(md);
2418 mutex_unlock(&md->suspend_lock);
2419}
2420EXPORT_SYMBOL_GPL(dm_internal_resume);
2421
2422/*
2423 * Fast variants of internal suspend/resume hold md->suspend_lock,
2424 * which prevents interaction with userspace-driven suspend.
2425 */
2426
2427void dm_internal_suspend_fast(struct mapped_device *md)
2428{
2429 mutex_lock(&md->suspend_lock);
2430 if (dm_suspended_md(md) || dm_suspended_internally_md(md))
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -04002431 return;
2432
2433 set_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
2434 synchronize_srcu(&md->io_barrier);
2435 flush_workqueue(md->wq);
2436 dm_wait_for_completion(md, TASK_UNINTERRUPTIBLE);
2437}
Mikulas Patockab735fed2015-02-26 11:40:35 -05002438EXPORT_SYMBOL_GPL(dm_internal_suspend_fast);
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -04002439
Mike Snitzerffcc3932014-10-28 18:34:52 -04002440void dm_internal_resume_fast(struct mapped_device *md)
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -04002441{
Mike Snitzerffcc3932014-10-28 18:34:52 -04002442 if (dm_suspended_md(md) || dm_suspended_internally_md(md))
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -04002443 goto done;
2444
2445 dm_queue_flush(md);
2446
2447done:
2448 mutex_unlock(&md->suspend_lock);
2449}
Mikulas Patockab735fed2015-02-26 11:40:35 -05002450EXPORT_SYMBOL_GPL(dm_internal_resume_fast);
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -04002451
Linus Torvalds1da177e2005-04-16 15:20:36 -07002452/*-----------------------------------------------------------------
2453 * Event notification.
2454 *---------------------------------------------------------------*/
Peter Rajnoha3abf85b2010-03-06 02:32:31 +00002455int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
Milan Broz60935eb2009-06-22 10:12:30 +01002456 unsigned cookie)
Alasdair G Kergon69267a32007-12-13 14:15:57 +00002457{
Milan Broz60935eb2009-06-22 10:12:30 +01002458 char udev_cookie[DM_COOKIE_LENGTH];
2459 char *envp[] = { udev_cookie, NULL };
2460
2461 if (!cookie)
Peter Rajnoha3abf85b2010-03-06 02:32:31 +00002462 return kobject_uevent(&disk_to_dev(md->disk)->kobj, action);
Milan Broz60935eb2009-06-22 10:12:30 +01002463 else {
2464 snprintf(udev_cookie, DM_COOKIE_LENGTH, "%s=%u",
2465 DM_COOKIE_ENV_VAR_NAME, cookie);
Peter Rajnoha3abf85b2010-03-06 02:32:31 +00002466 return kobject_uevent_env(&disk_to_dev(md->disk)->kobj,
2467 action, envp);
Milan Broz60935eb2009-06-22 10:12:30 +01002468 }
Alasdair G Kergon69267a32007-12-13 14:15:57 +00002469}
2470
Mike Anderson7a8c3d32007-10-19 22:48:01 +01002471uint32_t dm_next_uevent_seq(struct mapped_device *md)
2472{
2473 return atomic_add_return(1, &md->uevent_seq);
2474}
2475
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476uint32_t dm_get_event_nr(struct mapped_device *md)
2477{
2478 return atomic_read(&md->event_nr);
2479}
2480
2481int dm_wait_event(struct mapped_device *md, int event_nr)
2482{
2483 return wait_event_interruptible(md->eventq,
2484 (event_nr != atomic_read(&md->event_nr)));
2485}
2486
Mike Anderson7a8c3d32007-10-19 22:48:01 +01002487void dm_uevent_add(struct mapped_device *md, struct list_head *elist)
2488{
2489 unsigned long flags;
2490
2491 spin_lock_irqsave(&md->uevent_lock, flags);
2492 list_add(elist, &md->uevent_list);
2493 spin_unlock_irqrestore(&md->uevent_lock, flags);
2494}
2495
Linus Torvalds1da177e2005-04-16 15:20:36 -07002496/*
2497 * The gendisk is only valid as long as you have a reference
2498 * count on 'md'.
2499 */
2500struct gendisk *dm_disk(struct mapped_device *md)
2501{
2502 return md->disk;
2503}
Sami Tolvanen65ff5b72015-03-18 15:52:14 +00002504EXPORT_SYMBOL_GPL(dm_disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002505
Milan Broz784aae72009-01-06 03:05:12 +00002506struct kobject *dm_kobject(struct mapped_device *md)
2507{
Mikulas Patocka2995fa72014-01-13 19:37:54 -05002508 return &md->kobj_holder.kobj;
Milan Broz784aae72009-01-06 03:05:12 +00002509}
2510
Milan Broz784aae72009-01-06 03:05:12 +00002511struct mapped_device *dm_get_from_kobject(struct kobject *kobj)
2512{
2513 struct mapped_device *md;
2514
Mikulas Patocka2995fa72014-01-13 19:37:54 -05002515 md = container_of(kobj, struct mapped_device, kobj_holder.kobj);
Milan Broz784aae72009-01-06 03:05:12 +00002516
Milan Broz4d89b7b2009-06-22 10:12:11 +01002517 if (test_bit(DMF_FREEING, &md->flags) ||
Mike Anderson432a2122009-12-10 23:52:20 +00002518 dm_deleting_md(md))
Milan Broz4d89b7b2009-06-22 10:12:11 +01002519 return NULL;
2520
Milan Broz784aae72009-01-06 03:05:12 +00002521 dm_get(md);
2522 return md;
2523}
2524
Kiyoshi Ueda4f186f82009-12-10 23:52:26 +00002525int dm_suspended_md(struct mapped_device *md)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002526{
2527 return test_bit(DMF_SUSPENDED, &md->flags);
2528}
2529
Mike Snitzerffcc3932014-10-28 18:34:52 -04002530int dm_suspended_internally_md(struct mapped_device *md)
2531{
2532 return test_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
2533}
2534
Mikulas Patocka2c140a22013-11-01 18:27:41 -04002535int dm_test_deferred_remove_flag(struct mapped_device *md)
2536{
2537 return test_bit(DMF_DEFERRED_REMOVE, &md->flags);
2538}
2539
Kiyoshi Ueda64dbce52009-12-10 23:52:27 +00002540int dm_suspended(struct dm_target *ti)
2541{
Kiyoshi Uedaecdb2e22010-03-06 02:29:52 +00002542 return dm_suspended_md(dm_table_get_md(ti->table));
Kiyoshi Ueda64dbce52009-12-10 23:52:27 +00002543}
2544EXPORT_SYMBOL_GPL(dm_suspended);
2545
Kiyoshi Ueda2e93ccc2006-12-08 02:41:09 -08002546int dm_noflush_suspending(struct dm_target *ti)
2547{
Kiyoshi Uedaecdb2e22010-03-06 02:29:52 +00002548 return __noflush_suspending(dm_table_get_md(ti->table));
Kiyoshi Ueda2e93ccc2006-12-08 02:41:09 -08002549}
2550EXPORT_SYMBOL_GPL(dm_noflush_suspending);
2551
Mike Snitzer78d8e582015-06-26 10:01:13 -04002552struct dm_md_mempools *dm_alloc_md_mempools(struct mapped_device *md, unsigned type,
Mike Snitzer30187e12016-01-31 13:28:26 -05002553 unsigned integrity, unsigned per_io_data_size)
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01002554{
Mike Snitzer115485e2016-02-22 12:16:21 -05002555 struct dm_md_mempools *pools = kzalloc_node(sizeof(*pools), GFP_KERNEL, md->numa_node_id);
Mike Snitzer78d8e582015-06-26 10:01:13 -04002556 struct kmem_cache *cachep = NULL;
2557 unsigned int pool_size = 0;
Jun'ichi Nomura5f015202013-03-01 22:45:48 +00002558 unsigned int front_pad;
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01002559
2560 if (!pools)
Mike Snitzer4e6e36c2015-06-26 09:42:57 -04002561 return NULL;
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01002562
Mike Snitzer78d8e582015-06-26 10:01:13 -04002563 switch (type) {
2564 case DM_TYPE_BIO_BASED:
Toshi Kani545ed202016-06-22 17:54:53 -06002565 case DM_TYPE_DAX_BIO_BASED:
Mike Snitzer78d8e582015-06-26 10:01:13 -04002566 cachep = _io_cache;
2567 pool_size = dm_get_reserved_bio_based_ios();
Mike Snitzer30187e12016-01-31 13:28:26 -05002568 front_pad = roundup(per_io_data_size, __alignof__(struct dm_target_io)) + offsetof(struct dm_target_io, clone);
Mike Snitzer78d8e582015-06-26 10:01:13 -04002569 break;
2570 case DM_TYPE_REQUEST_BASED:
2571 cachep = _rq_tio_cache;
2572 pool_size = dm_get_reserved_rq_based_ios();
2573 pools->rq_pool = mempool_create_slab_pool(pool_size, _rq_cache);
2574 if (!pools->rq_pool)
2575 goto out;
2576 /* fall through to setup remaining rq-based pools */
2577 case DM_TYPE_MQ_REQUEST_BASED:
2578 if (!pool_size)
2579 pool_size = dm_get_reserved_rq_based_ios();
2580 front_pad = offsetof(struct dm_rq_clone_bio_info, clone);
Mike Snitzer591ddcf2016-01-31 12:05:42 -05002581 /* per_io_data_size is used for blk-mq pdu at queue allocation */
Mike Snitzer78d8e582015-06-26 10:01:13 -04002582 break;
2583 default:
2584 BUG();
2585 }
2586
2587 if (cachep) {
2588 pools->io_pool = mempool_create_slab_pool(pool_size, cachep);
2589 if (!pools->io_pool)
2590 goto out;
2591 }
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01002592
Junichi Nomura3d8aab22014-10-03 11:55:26 +00002593 pools->bs = bioset_create_nobvec(pool_size, front_pad);
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01002594 if (!pools->bs)
Jun'ichi Nomura5f015202013-03-01 22:45:48 +00002595 goto out;
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01002596
Martin K. Petersena91a2782011-03-17 11:11:05 +01002597 if (integrity && bioset_integrity_create(pools->bs, pool_size))
Jun'ichi Nomura5f015202013-03-01 22:45:48 +00002598 goto out;
Martin K. Petersena91a2782011-03-17 11:11:05 +01002599
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01002600 return pools;
Mike Snitzer78d8e582015-06-26 10:01:13 -04002601
Jun'ichi Nomura5f015202013-03-01 22:45:48 +00002602out:
2603 dm_free_md_mempools(pools);
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01002604
Mike Snitzer4e6e36c2015-06-26 09:42:57 -04002605 return NULL;
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01002606}
2607
2608void dm_free_md_mempools(struct dm_md_mempools *pools)
2609{
2610 if (!pools)
2611 return;
2612
Julia Lawall6f659852015-09-13 14:15:05 +02002613 mempool_destroy(pools->io_pool);
2614 mempool_destroy(pools->rq_pool);
Mike Snitzer1ae49ea2014-12-05 17:11:05 -05002615
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +01002616 if (pools->bs)
2617 bioset_free(pools->bs);
2618
2619 kfree(pools);
2620}
2621
Christoph Hellwig9c72bad2016-07-08 21:23:51 +09002622struct dm_pr {
2623 u64 old_key;
2624 u64 new_key;
2625 u32 flags;
2626 bool fail_early;
2627};
2628
2629static int dm_call_pr(struct block_device *bdev, iterate_devices_callout_fn fn,
2630 void *data)
2631{
2632 struct mapped_device *md = bdev->bd_disk->private_data;
2633 struct dm_table *table;
2634 struct dm_target *ti;
2635 int ret = -ENOTTY, srcu_idx;
2636
2637 table = dm_get_live_table(md, &srcu_idx);
2638 if (!table || !dm_table_get_size(table))
2639 goto out;
2640
2641 /* We only support devices that have a single target */
2642 if (dm_table_get_num_targets(table) != 1)
2643 goto out;
2644 ti = dm_table_get_target(table, 0);
2645
2646 ret = -EINVAL;
2647 if (!ti->type->iterate_devices)
2648 goto out;
2649
2650 ret = ti->type->iterate_devices(ti, fn, data);
2651out:
2652 dm_put_live_table(md, srcu_idx);
2653 return ret;
2654}
2655
2656/*
2657 * For register / unregister we need to manually call out to every path.
2658 */
2659static int __dm_pr_register(struct dm_target *ti, struct dm_dev *dev,
2660 sector_t start, sector_t len, void *data)
2661{
2662 struct dm_pr *pr = data;
2663 const struct pr_ops *ops = dev->bdev->bd_disk->fops->pr_ops;
2664
2665 if (!ops || !ops->pr_register)
2666 return -EOPNOTSUPP;
2667 return ops->pr_register(dev->bdev, pr->old_key, pr->new_key, pr->flags);
2668}
2669
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002670static int dm_pr_register(struct block_device *bdev, u64 old_key, u64 new_key,
Mike Snitzer956a4022016-02-18 16:13:51 -05002671 u32 flags)
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002672{
Christoph Hellwig9c72bad2016-07-08 21:23:51 +09002673 struct dm_pr pr = {
2674 .old_key = old_key,
2675 .new_key = new_key,
2676 .flags = flags,
2677 .fail_early = true,
2678 };
2679 int ret;
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002680
Christoph Hellwig9c72bad2016-07-08 21:23:51 +09002681 ret = dm_call_pr(bdev, __dm_pr_register, &pr);
2682 if (ret && new_key) {
2683 /* unregister all paths if we failed to register any path */
2684 pr.old_key = new_key;
2685 pr.new_key = 0;
2686 pr.flags = 0;
2687 pr.fail_early = false;
2688 dm_call_pr(bdev, __dm_pr_register, &pr);
2689 }
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002690
Christoph Hellwig9c72bad2016-07-08 21:23:51 +09002691 return ret;
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002692}
2693
2694static int dm_pr_reserve(struct block_device *bdev, u64 key, enum pr_type type,
Mike Snitzer956a4022016-02-18 16:13:51 -05002695 u32 flags)
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002696{
2697 struct mapped_device *md = bdev->bd_disk->private_data;
2698 const struct pr_ops *ops;
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002699 fmode_t mode;
Mike Snitzer956a4022016-02-18 16:13:51 -05002700 int r;
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002701
Mike Snitzer956a4022016-02-18 16:13:51 -05002702 r = dm_grab_bdev_for_ioctl(md, &bdev, &mode);
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002703 if (r < 0)
2704 return r;
2705
2706 ops = bdev->bd_disk->fops->pr_ops;
2707 if (ops && ops->pr_reserve)
2708 r = ops->pr_reserve(bdev, key, type, flags);
2709 else
2710 r = -EOPNOTSUPP;
2711
Mike Snitzer956a4022016-02-18 16:13:51 -05002712 bdput(bdev);
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002713 return r;
2714}
2715
2716static int dm_pr_release(struct block_device *bdev, u64 key, enum pr_type type)
2717{
2718 struct mapped_device *md = bdev->bd_disk->private_data;
2719 const struct pr_ops *ops;
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002720 fmode_t mode;
Mike Snitzer956a4022016-02-18 16:13:51 -05002721 int r;
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002722
Mike Snitzer956a4022016-02-18 16:13:51 -05002723 r = dm_grab_bdev_for_ioctl(md, &bdev, &mode);
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002724 if (r < 0)
2725 return r;
2726
2727 ops = bdev->bd_disk->fops->pr_ops;
2728 if (ops && ops->pr_release)
2729 r = ops->pr_release(bdev, key, type);
2730 else
2731 r = -EOPNOTSUPP;
2732
Mike Snitzer956a4022016-02-18 16:13:51 -05002733 bdput(bdev);
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002734 return r;
2735}
2736
2737static int dm_pr_preempt(struct block_device *bdev, u64 old_key, u64 new_key,
Mike Snitzer956a4022016-02-18 16:13:51 -05002738 enum pr_type type, bool abort)
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002739{
2740 struct mapped_device *md = bdev->bd_disk->private_data;
2741 const struct pr_ops *ops;
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002742 fmode_t mode;
Mike Snitzer956a4022016-02-18 16:13:51 -05002743 int r;
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002744
Mike Snitzer956a4022016-02-18 16:13:51 -05002745 r = dm_grab_bdev_for_ioctl(md, &bdev, &mode);
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002746 if (r < 0)
2747 return r;
2748
2749 ops = bdev->bd_disk->fops->pr_ops;
2750 if (ops && ops->pr_preempt)
2751 r = ops->pr_preempt(bdev, old_key, new_key, type, abort);
2752 else
2753 r = -EOPNOTSUPP;
2754
Mike Snitzer956a4022016-02-18 16:13:51 -05002755 bdput(bdev);
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002756 return r;
2757}
2758
2759static int dm_pr_clear(struct block_device *bdev, u64 key)
2760{
2761 struct mapped_device *md = bdev->bd_disk->private_data;
2762 const struct pr_ops *ops;
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002763 fmode_t mode;
Mike Snitzer956a4022016-02-18 16:13:51 -05002764 int r;
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002765
Mike Snitzer956a4022016-02-18 16:13:51 -05002766 r = dm_grab_bdev_for_ioctl(md, &bdev, &mode);
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002767 if (r < 0)
2768 return r;
2769
2770 ops = bdev->bd_disk->fops->pr_ops;
2771 if (ops && ops->pr_clear)
2772 r = ops->pr_clear(bdev, key);
2773 else
2774 r = -EOPNOTSUPP;
2775
Mike Snitzer956a4022016-02-18 16:13:51 -05002776 bdput(bdev);
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002777 return r;
2778}
2779
2780static const struct pr_ops dm_pr_ops = {
2781 .pr_register = dm_pr_register,
2782 .pr_reserve = dm_pr_reserve,
2783 .pr_release = dm_pr_release,
2784 .pr_preempt = dm_pr_preempt,
2785 .pr_clear = dm_pr_clear,
2786};
2787
Alexey Dobriyan83d5cde2009-09-21 17:01:13 -07002788static const struct block_device_operations dm_blk_dops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002789 .open = dm_blk_open,
2790 .release = dm_blk_close,
Milan Brozaa129a22006-10-03 01:15:15 -07002791 .ioctl = dm_blk_ioctl,
Toshi Kani545ed202016-06-22 17:54:53 -06002792 .direct_access = dm_blk_direct_access,
Darrick J. Wong3ac51e72006-03-27 01:17:54 -08002793 .getgeo = dm_blk_getgeo,
Christoph Hellwig71cdb692015-10-15 14:10:51 +02002794 .pr_ops = &dm_pr_ops,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795 .owner = THIS_MODULE
2796};
2797
Linus Torvalds1da177e2005-04-16 15:20:36 -07002798/*
2799 * module hooks
2800 */
2801module_init(dm_init);
2802module_exit(dm_exit);
2803
2804module_param(major, uint, 0);
2805MODULE_PARM_DESC(major, "The major number of the device mapper");
Mike Snitzerf4790822013-09-12 18:06:12 -04002806
Mike Snitzere8603132013-09-12 18:06:12 -04002807module_param(reserved_bio_based_ios, uint, S_IRUGO | S_IWUSR);
2808MODULE_PARM_DESC(reserved_bio_based_ios, "Reserved IOs in bio-based mempools");
2809
Mike Snitzer115485e2016-02-22 12:16:21 -05002810module_param(dm_numa_node, int, S_IRUGO | S_IWUSR);
2811MODULE_PARM_DESC(dm_numa_node, "NUMA node for DM device memory allocations");
2812
Linus Torvalds1da177e2005-04-16 15:20:36 -07002813MODULE_DESCRIPTION(DM_NAME " driver");
2814MODULE_AUTHOR("Joe Thornber <dm-devel@redhat.com>");
2815MODULE_LICENSE("GPL");