drivers/block/brd.c

   1 /*
   2  * Ram backed block device driver.
   3  *
   4  * Copyright (C) 2007 Nick Piggin
   5  * Copyright (C) 2007 Novell Inc.
   6  *
   7  * Parts derived from drivers/block/rd.c, and drivers/block/loop.c, copyright
   8  * of their respective owners.
   9  */
  10
  11 #include <linux/init.h>
  12 #include <linux/initrd.h>
  13 #include <linux/module.h>
  14 #include <linux/moduleparam.h>
  15 #include <linux/major.h>
  16 #include <linux/blkdev.h>
  17 #include <linux/bio.h>
  18 #include <linux/highmem.h>
  19 #include <linux/mutex.h>
  20 #include <linux/radix-tree.h>
  21 #include <linux/fs.h>
  22 #include <linux/slab.h>
  23 #include <linux/backing-dev.h>
  24 #ifdef CONFIG_BLK_DEV_RAM_DAX
  25 #include <linux/pfn_t.h>
  26 #include <linux/dax.h>
  27 #include <linux/uio.h>
  28 #endif
  29
  30 #include <linux/uaccess.h>
  31
  32 #define SECTOR_SHIFT            9
  33 #define PAGE_SECTORS_SHIFT      (PAGE_SHIFT - SECTOR_SHIFT)
  34 #define PAGE_SECTORS            (1 << PAGE_SECTORS_SHIFT)
  35
  36 /*
  37  * Each block ramdisk device has a radix_tree brd_pages of pages that stores
  38  * the pages containing the block device's contents. A brd page's ->index is
  39  * its offset in PAGE_SIZE units. This is similar to, but in no way connected
  40  * with, the kernel's pagecache or buffer cache (which sit above our block
  41  * device).
  42  */
  43 struct brd_device {
  44         int             brd_number;
  45
  46         struct request_queue    *brd_queue;
  47         struct gendisk          *brd_disk;
  48 #ifdef CONFIG_BLK_DEV_RAM_DAX
  49         struct dax_device       *dax_dev;
  50 #endif
  51         struct list_head        brd_list;
  52
  53         /*
  54          * Backing store of pages and lock to protect it. This is the contents
  55          * of the block device.
  56          */
  57         spinlock_t              brd_lock;
  58         struct radix_tree_root  brd_pages;
  59 };
  60
  61 /*
  62  * Look up and return a brd's page for a given sector.
  63  */
  64 static struct page *brd_lookup_page(struct brd_device *brd, sector_t sector)
  65 {
  66         pgoff_t idx;
  67         struct page *page;
  68
  69         /*
  70          * The page lifetime is protected by the fact that we have opened the
  71          * device node -- brd pages will never be deleted under us, so we
  72          * don't need any further locking or refcounting.
  73          *
  74          * This is strictly true for the radix-tree nodes as well (ie. we
  75          * don't actually need the rcu_read_lock()), however that is not a
  76          * documented feature of the radix-tree API so it is better to be
  77          * safe here (we don't have total exclusion from radix tree updates
  78          * here, only deletes).
  79          */
  80         rcu_read_lock();
  81         idx = sector >> PAGE_SECTORS_SHIFT; /* sector to page index */
  82         page = radix_tree_lookup(&brd->brd_pages, idx);
  83         rcu_read_unlock();
  84
  85         BUG_ON(page && page->index != idx);
  86
  87         return page;
  88 }
  89
  90 /*
  91  * Look up and return a brd's page for a given sector.
  92  * If one does not exist, allocate an empty page, and insert that. Then
  93  * return it.
  94  */
  95 static struct page *brd_insert_page(struct brd_device *brd, sector_t sector)
  96 {
  97         pgoff_t idx;
  98         struct page *page;
  99         gfp_t gfp_flags;
 100
 101         page = brd_lookup_page(brd, sector);
 102         if (page)
 103                 return page;
 104
 105         /*
 106          * Must use NOIO because we don't want to recurse back into the
 107          * block or filesystem layers from page reclaim.
 108          *
 109          * Cannot support DAX and highmem, because our ->direct_access
 110          * routine for DAX must return memory that is always addressable.
 111          * If DAX was reworked to use pfns and kmap throughout, this
 112          * restriction might be able to be lifted.
 113          */
 114         gfp_flags = GFP_NOIO | __GFP_ZERO;
 115 #ifndef CONFIG_BLK_DEV_RAM_DAX
 116         gfp_flags |= __GFP_HIGHMEM;
 117 #endif
 118         page = alloc_page(gfp_flags);
 119         if (!page)
 120                 return NULL;
 121
 122         if (radix_tree_preload(GFP_NOIO)) {
 123                 __free_page(page);
 124                 return NULL;
 125         }
 126
 127         spin_lock(&brd->brd_lock);
 128         idx = sector >> PAGE_SECTORS_SHIFT;
 129         page->index = idx;
 130         if (radix_tree_insert(&brd->brd_pages, idx, page)) {
 131                 __free_page(page);
 132                 page = radix_tree_lookup(&brd->brd_pages, idx);
 133                 BUG_ON(!page);
 134                 BUG_ON(page->index != idx);
 135         }
 136         spin_unlock(&brd->brd_lock);
 137
 138         radix_tree_preload_end();
 139
 140         return page;
 141 }
 142
 143 /*
 144  * Free all backing store pages and radix tree. This must only be called when
 145  * there are no other users of the device.
 146  */
 147 #define FREE_BATCH 16
 148 static void brd_free_pages(struct brd_device *brd)
 149 {
 150         unsigned long pos = 0;
 151         struct page *pages[FREE_BATCH];
 152         int nr_pages;
 153
 154         do {
 155                 int i;
 156
 157                 nr_pages = radix_tree_gang_lookup(&brd->brd_pages,
 158                                 (void **)pages, pos, FREE_BATCH);
 159
 160                 for (i = 0; i < nr_pages; i++) {
 161                         void *ret;
 162
 163                         BUG_ON(pages[i]->index < pos);
 164                         pos = pages[i]->index;
 165                         ret = radix_tree_delete(&brd->brd_pages, pos);
 166                         BUG_ON(!ret || ret != pages[i]);
 167                         __free_page(pages[i]);
 168                 }
 169
 170                 pos++;
 171
 172                 /*
 173                  * This assumes radix_tree_gang_lookup always returns as
 174                  * many pages as possible. If the radix-tree code changes,
 175                  * so will this have to.
 176                  */
 177         } while (nr_pages == FREE_BATCH);
 178 }
 179
 180 /*
 181  * copy_to_brd_setup must be called before copy_to_brd. It may sleep.
 182  */
 183 static int copy_to_brd_setup(struct brd_device *brd, sector_t sector, size_t n)
 184 {
 185         unsigned int offset = (sector & (PAGE_SECTORS-1)) << SECTOR_SHIFT;
 186         size_t copy;
 187
 188         copy = min_t(size_t, n, PAGE_SIZE - offset);
 189         if (!brd_insert_page(brd, sector))
 190                 return -ENOSPC;
 191         if (copy < n) {
 192                 sector += copy >> SECTOR_SHIFT;
 193                 if (!brd_insert_page(brd, sector))
 194                         return -ENOSPC;
 195         }
 196         return 0;
 197 }
 198
 199 /*
 200  * Copy n bytes from src to the brd starting at sector. Does not sleep.
 201  */
 202 static void copy_to_brd(struct brd_device *brd, const void *src,
 203                         sector_t sector, size_t n)
 204 {
 205         struct page *page;
 206         void *dst;
 207         unsigned int offset = (sector & (PAGE_SECTORS-1)) << SECTOR_SHIFT;
 208         size_t copy;
 209
 210         copy = min_t(size_t, n, PAGE_SIZE - offset);
 211         page = brd_lookup_page(brd, sector);
 212         BUG_ON(!page);
 213
 214         dst = kmap_atomic(page);
 215         memcpy(dst + offset, src, copy);
 216         kunmap_atomic(dst);
 217
 218         if (copy < n) {
 219                 src += copy;
 220                 sector += copy >> SECTOR_SHIFT;
 221                 copy = n - copy;
 222                 page = brd_lookup_page(brd, sector);
 223                 BUG_ON(!page);
 224
 225                 dst = kmap_atomic(page);
 226                 memcpy(dst, src, copy);
 227                 kunmap_atomic(dst);
 228         }
 229 }
 230
 231 /*
 232  * Copy n bytes to dst from the brd starting at sector. Does not sleep.
 233  */
 234 static void copy_from_brd(void *dst, struct brd_device *brd,
 235                         sector_t sector, size_t n)
 236 {
 237         struct page *page;
 238         void *src;
 239         unsigned int offset = (sector & (PAGE_SECTORS-1)) << SECTOR_SHIFT;
 240         size_t copy;
 241
 242         copy = min_t(size_t, n, PAGE_SIZE - offset);
 243         page = brd_lookup_page(brd, sector);
 244         if (page) {
 245                 src = kmap_atomic(page);
 246                 memcpy(dst, src + offset, copy);
 247                 kunmap_atomic(src);
 248         } else
 249                 memset(dst, 0, copy);
 250
 251         if (copy < n) {
 252                 dst += copy;
 253                 sector += copy >> SECTOR_SHIFT;
 254                 copy = n - copy;
 255                 page = brd_lookup_page(brd, sector);
 256                 if (page) {
 257                         src = kmap_atomic(page);
 258                         memcpy(dst, src, copy);
 259                         kunmap_atomic(src);
 260                 } else
 261                         memset(dst, 0, copy);
 262         }
 263 }
 264
 265 /*
 266  * Process a single bvec of a bio.
 267  */
 268 static int brd_do_bvec(struct brd_device *brd, struct page *page,
 269                         unsigned int len, unsigned int off, bool is_write,
 270                         sector_t sector)
 271 {
 272         void *mem;
 273         int err = 0;
 274
 275         if (is_write) {
 276                 err = copy_to_brd_setup(brd, sector, len);
 277                 if (err)
 278                         goto out;
 279         }
 280
 281         mem = kmap_atomic(page);
 282         if (!is_write) {
 283                 copy_from_brd(mem + off, brd, sector, len);
 284                 flush_dcache_page(page);
 285         } else {
 286                 flush_dcache_page(page);
 287                 copy_to_brd(brd, mem + off, sector, len);
 288         }
 289         kunmap_atomic(mem);
 290
 291 out:
 292         return err;
 293 }
 294
 295 static blk_qc_t brd_make_request(struct request_queue *q, struct bio *bio)
 296 {
 297         struct brd_device *brd = bio->bi_disk->private_data;
 298         struct bio_vec bvec;
 299         sector_t sector;
 300         struct bvec_iter iter;
 301
 302         sector = bio->bi_iter.bi_sector;
 303         if (bio_end_sector(bio) > get_capacity(bio->bi_disk))
 304                 goto io_error;
 305
 306         bio_for_each_segment(bvec, bio, iter) {
 307                 unsigned int len = bvec.bv_len;
 308                 int err;
 309
 310                 err = brd_do_bvec(brd, bvec.bv_page, len, bvec.bv_offset,
 311                                         op_is_write(bio_op(bio)), sector);
 312                 if (err)
 313                         goto io_error;
 314                 sector += len >> SECTOR_SHIFT;
 315         }
 316
 317         bio_endio(bio);
 318         return BLK_QC_T_NONE;
 319 io_error:
 320         bio_io_error(bio);
 321         return BLK_QC_T_NONE;
 322 }
 323
 324 static int brd_rw_page(struct block_device *bdev, sector_t sector,
 325                        struct page *page, bool is_write)
 326 {
 327         struct brd_device *brd = bdev->bd_disk->private_data;
 328         int err;
 329
 330         if (PageTransHuge(page))
 331                 return -ENOTSUPP;
 332         err = brd_do_bvec(brd, page, PAGE_SIZE, 0, is_write, sector);
 333         page_endio(page, is_write, err);
 334         return err;
 335 }
 336
 337 #ifdef CONFIG_BLK_DEV_RAM_DAX
 338 static long __brd_direct_access(struct brd_device *brd, pgoff_t pgoff,
 339                 long nr_pages, void **kaddr, pfn_t *pfn)
 340 {
 341         struct page *page;
 342
 343         if (!brd)
 344                 return -ENODEV;
 345         page = brd_insert_page(brd, (sector_t)pgoff << PAGE_SECTORS_SHIFT);
 346         if (!page)
 347                 return -ENOSPC;
 348         *kaddr = page_address(page);
 349         *pfn = page_to_pfn_t(page);
 350
 351         return 1;
 352 }
 353
 354 static long brd_dax_direct_access(struct dax_device *dax_dev,
 355                 pgoff_t pgoff, long nr_pages, void **kaddr, pfn_t *pfn)
 356 {
 357         struct brd_device *brd = dax_get_private(dax_dev);
 358
 359         return __brd_direct_access(brd, pgoff, nr_pages, kaddr, pfn);
 360 }
 361
 362 static size_t brd_dax_copy_from_iter(struct dax_device *dax_dev, pgoff_t pgoff,
 363                 void *addr, size_t bytes, struct iov_iter *i)
 364 {
 365         return copy_from_iter(addr, bytes, i);
 366 }
 367
 368 static const struct dax_operations brd_dax_ops = {
 369         .direct_access = brd_dax_direct_access,
 370         .copy_from_iter = brd_dax_copy_from_iter,
 371 };
 372 #endif
 373
 374 static const struct block_device_operations brd_fops = {
 375         .owner =                THIS_MODULE,
 376         .rw_page =              brd_rw_page,
 377 };
 378
 379 /*
 380  * And now the modules code and kernel interface.
 381  */
 382 static int rd_nr = CONFIG_BLK_DEV_RAM_COUNT;
 383 module_param(rd_nr, int, S_IRUGO);
 384 MODULE_PARM_DESC(rd_nr, "Maximum number of brd devices");
 385
 386 unsigned long rd_size = CONFIG_BLK_DEV_RAM_SIZE;
 387 module_param(rd_size, ulong, S_IRUGO);
 388 MODULE_PARM_DESC(rd_size, "Size of each RAM disk in kbytes.");
 389
 390 static int max_part = 1;
 391 module_param(max_part, int, S_IRUGO);
 392 MODULE_PARM_DESC(max_part, "Num Minors to reserve between devices");
 393
 394 MODULE_LICENSE("GPL");
 395 MODULE_ALIAS_BLOCKDEV_MAJOR(RAMDISK_MAJOR);
 396 MODULE_ALIAS("rd");
 397
 398 #ifndef MODULE
 399 /* Legacy boot options - nonmodular */
 400 static int __init ramdisk_size(char *str)
 401 {
 402         rd_size = simple_strtol(str, NULL, 0);
 403         return 1;
 404 }
 405 __setup("ramdisk_size=", ramdisk_size);
 406 #endif
 407
 408 /*
 409  * The device scheme is derived from loop.c. Keep them in synch where possible
 410  * (should share code eventually).
 411  */
 412 static LIST_HEAD(brd_devices);
 413 static DEFINE_MUTEX(brd_devices_mutex);
 414
 415 static struct brd_device *brd_alloc(int i)
 416 {
 417         struct brd_device *brd;
 418         struct gendisk *disk;
 419
 420         brd = kzalloc(sizeof(*brd), GFP_KERNEL);
 421         if (!brd)
 422                 goto out;
 423         brd->brd_number         = i;
 424         spin_lock_init(&brd->brd_lock);
 425         INIT_RADIX_TREE(&brd->brd_pages, GFP_ATOMIC);
 426
 427         brd->brd_queue = blk_alloc_queue(GFP_KERNEL);
 428         if (!brd->brd_queue)
 429                 goto out_free_dev;
 430
 431         blk_queue_make_request(brd->brd_queue, brd_make_request);
 432         blk_queue_max_hw_sectors(brd->brd_queue, 1024);
 433
 434         /* This is so fdisk will align partitions on 4k, because of
 435          * direct_access API needing 4k alignment, returning a PFN
 436          * (This is only a problem on very small devices <= 4M,
 437          *  otherwise fdisk will align on 1M. Regardless this call
 438          *  is harmless)
 439          */
 440         blk_queue_physical_block_size(brd->brd_queue, PAGE_SIZE);
 441         disk = brd->brd_disk = alloc_disk(max_part);
 442         if (!disk)
 443                 goto out_free_queue;
 444         disk->major             = RAMDISK_MAJOR;
 445         disk->first_minor       = i * max_part;
 446         disk->fops              = &brd_fops;
 447         disk->private_data      = brd;
 448         disk->queue             = brd->brd_queue;
 449         disk->flags             = GENHD_FL_EXT_DEVT;
 450         sprintf(disk->disk_name, "ram%d", i);
 451         set_capacity(disk, rd_size * 2);
 452         disk->queue->backing_dev_info->capabilities |= BDI_CAP_SYNCHRONOUS_IO;
 453
 454 #ifdef CONFIG_BLK_DEV_RAM_DAX
 455         queue_flag_set_unlocked(QUEUE_FLAG_DAX, brd->brd_queue);
 456         brd->dax_dev = alloc_dax(brd, disk->disk_name, &brd_dax_ops);
 457         if (!brd->dax_dev)
 458                 goto out_free_inode;
 459 #endif
 460
 461
 462         return brd;
 463
 464 #ifdef CONFIG_BLK_DEV_RAM_DAX
 465 out_free_inode:
 466         kill_dax(brd->dax_dev);
 467         put_dax(brd->dax_dev);
 468 #endif
 469 out_free_queue:
 470         blk_cleanup_queue(brd->brd_queue);
 471 out_free_dev:
 472         kfree(brd);
 473 out:
 474         return NULL;
 475 }
 476
 477 static void brd_free(struct brd_device *brd)
 478 {
 479         put_disk(brd->brd_disk);
 480         blk_cleanup_queue(brd->brd_queue);
 481         brd_free_pages(brd);
 482         kfree(brd);
 483 }
 484
 485 static struct brd_device *brd_init_one(int i, bool *new)
 486 {
 487         struct brd_device *brd;
 488
 489         *new = false;
 490         list_for_each_entry(brd, &brd_devices, brd_list) {
 491                 if (brd->brd_number == i)
 492                         goto out;
 493         }
 494
 495         brd = brd_alloc(i);
 496         if (brd) {
 497                 add_disk(brd->brd_disk);
 498                 list_add_tail(&brd->brd_list, &brd_devices);
 499         }
 500         *new = true;
 501 out:
 502         return brd;
 503 }
 504
 505 static void brd_del_one(struct brd_device *brd)
 506 {
 507         list_del(&brd->brd_list);
 508 #ifdef CONFIG_BLK_DEV_RAM_DAX
 509         kill_dax(brd->dax_dev);
 510         put_dax(brd->dax_dev);
 511 #endif
 512         del_gendisk(brd->brd_disk);
 513         brd_free(brd);
 514 }
 515
 516 static struct kobject *brd_probe(dev_t dev, int *part, void *data)
 517 {
 518         struct brd_device *brd;
 519         struct kobject *kobj;
 520         bool new;
 521
 522         mutex_lock(&brd_devices_mutex);
 523         brd = brd_init_one(MINOR(dev) / max_part, &new);
 524         kobj = brd ? get_disk(brd->brd_disk) : NULL;
 525         mutex_unlock(&brd_devices_mutex);
 526
 527         if (new)
 528                 *part = 0;
 529
 530         return kobj;
 531 }
 532
 533 static int __init brd_init(void)
 534 {
 535         struct brd_device *brd, *next;
 536         int i;
 537
 538         /*
 539          * brd module now has a feature to instantiate underlying device
 540          * structure on-demand, provided that there is an access dev node.
 541          *
 542          * (1) if rd_nr is specified, create that many upfront. else
 543          *     it defaults to CONFIG_BLK_DEV_RAM_COUNT
 544          * (2) User can further extend brd devices by create dev node themselves
 545          *     and have kernel automatically instantiate actual device
 546          *     on-demand. Example:
 547          *              mknod /path/devnod_name b 1 X   # 1 is the rd major
 548          *              fdisk -l /path/devnod_name
 549          *      If (X / max_part) was not already created it will be created
 550          *      dynamically.
 551          */
 552
 553         if (register_blkdev(RAMDISK_MAJOR, "ramdisk"))
 554                 return -EIO;
 555
 556         if (unlikely(!max_part))
 557                 max_part = 1;
 558
 559         for (i = 0; i < rd_nr; i++) {
 560                 brd = brd_alloc(i);
 561                 if (!brd)
 562                         goto out_free;
 563                 list_add_tail(&brd->brd_list, &brd_devices);
 564         }
 565
 566         /* point of no return */
 567
 568         list_for_each_entry(brd, &brd_devices, brd_list)
 569                 add_disk(brd->brd_disk);
 570
 571         blk_register_region(MKDEV(RAMDISK_MAJOR, 0), 1UL << MINORBITS,
 572                                   THIS_MODULE, brd_probe, NULL, NULL);
 573
 574         pr_info("brd: module loaded\n");
 575         return 0;
 576
 577 out_free:
 578         list_for_each_entry_safe(brd, next, &brd_devices, brd_list) {
 579                 list_del(&brd->brd_list);
 580                 brd_free(brd);
 581         }
 582         unregister_blkdev(RAMDISK_MAJOR, "ramdisk");
 583
 584         pr_info("brd: module NOT loaded !!!\n");
 585         return -ENOMEM;
 586 }
 587
 588 static void __exit brd_exit(void)
 589 {
 590         struct brd_device *brd, *next;
 591
 592         list_for_each_entry_safe(brd, next, &brd_devices, brd_list)
 593                 brd_del_one(brd);
 594
 595         blk_unregister_region(MKDEV(RAMDISK_MAJOR, 0), 1UL << MINORBITS);
 596         unregister_blkdev(RAMDISK_MAJOR, "ramdisk");
 597
 598         pr_info("brd: module unloaded\n");
 599 }
 600
 601 module_init(brd_init);
 602 module_exit(brd_exit);
 603