drivers/s390/block/xpram.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Xpram.c -- the S/390 expanded memory RAM-disk
   4  *
   5  * significant parts of this code are based on
   6  * the sbull device driver presented in
   7  * A. Rubini: Linux Device Drivers
   8  *
   9  * Author of XPRAM specific coding: Reinhard Buendgen
  10  *                                  buendgen@de.ibm.com
  11  * Rewrite for 2.5: Martin Schwidefsky <schwidefsky@de.ibm.com>
  12  *
  13  * External interfaces:
  14  *   Interfaces to linux kernel
  15  *        xpram_setup: read kernel parameters
  16  *   Device specific file operations
  17  *        xpram_iotcl
  18  *        xpram_open
  19  *
  20  * "ad-hoc" partitioning:
  21  *    the expanded memory can be partitioned among several devices
  22  *    (with different minors). The partitioning set up can be
  23  *    set by kernel or module parameters (int devs & int sizes[])
  24  *
  25  * Potential future improvements:
  26  *   generic hard disk support to replace ad-hoc partitioning
  27  */
  28
  29 #define KMSG_COMPONENT "xpram"
  30 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
  31
  32 #include <linux/module.h>
  33 #include <linux/moduleparam.h>
  34 #include <linux/ctype.h>  /* isdigit, isxdigit */
  35 #include <linux/errno.h>
  36 #include <linux/init.h>
  37 #include <linux/blkdev.h>
  38 #include <linux/blkpg.h>
  39 #include <linux/hdreg.h>  /* HDIO_GETGEO */
  40 #include <linux/device.h>
  41 #include <linux/bio.h>
  42 #include <linux/gfp.h>
  43 #include <linux/uaccess.h>
  44
  45 #define XPRAM_NAME      "xpram"
  46 #define XPRAM_DEVS      1       /* one partition */
  47 #define XPRAM_MAX_DEVS  32      /* maximal number of devices (partitions) */
  48
  49 typedef struct {
  50         unsigned int    size;           /* size of xpram segment in pages */
  51         unsigned int    offset;         /* start page of xpram segment */
  52 } xpram_device_t;
  53
  54 static xpram_device_t xpram_devices[XPRAM_MAX_DEVS];
  55 static unsigned int xpram_sizes[XPRAM_MAX_DEVS];
  56 static struct gendisk *xpram_disks[XPRAM_MAX_DEVS];
  57 static struct request_queue *xpram_queues[XPRAM_MAX_DEVS];
  58 static unsigned int xpram_pages;
  59 static int xpram_devs;
  60
  61 /*
  62  * Parameter parsing functions.
  63  */
  64 static int devs = XPRAM_DEVS;
  65 static char *sizes[XPRAM_MAX_DEVS];
  66
  67 module_param(devs, int, 0);
  68 module_param_array(sizes, charp, NULL, 0);
  69
  70 MODULE_PARM_DESC(devs, "number of devices (\"partitions\"), " \
  71                  "the default is " __MODULE_STRING(XPRAM_DEVS) "\n");
  72 MODULE_PARM_DESC(sizes, "list of device (partition) sizes " \
  73                  "the defaults are 0s \n" \
  74                  "All devices with size 0 equally partition the "
  75                  "remaining space on the expanded strorage not "
  76                  "claimed by explicit sizes\n");
  77 MODULE_LICENSE("GPL");
  78
  79 /*
  80  * Copy expanded memory page (4kB) into main memory
  81  * Arguments
  82  *           page_addr:    address of target page
  83  *           xpage_index:  index of expandeded memory page
  84  * Return value
  85  *           0:            if operation succeeds
  86  *           -EIO:         if pgin failed
  87  *           -ENXIO:       if xpram has vanished
  88  */
  89 static int xpram_page_in (unsigned long page_addr, unsigned int xpage_index)
  90 {
  91         int cc = 2;     /* return unused cc 2 if pgin traps */
  92
  93         asm volatile(
  94                 "       .insn   rre,0xb22e0000,%1,%2\n"  /* pgin %1,%2 */
  95                 "0:     ipm     %0\n"
  96                 "       srl     %0,28\n"
  97                 "1:\n"
  98                 EX_TABLE(0b,1b)
  99                 : "+d" (cc) : "a" (__pa(page_addr)), "d" (xpage_index) : "cc");
 100         if (cc == 3)
 101                 return -ENXIO;
 102         if (cc == 2)
 103                 return -ENXIO;
 104         if (cc == 1)
 105                 return -EIO;
 106         return 0;
 107 }
 108
 109 /*
 110  * Copy a 4kB page of main memory to an expanded memory page
 111  * Arguments
 112  *           page_addr:    address of source page
 113  *           xpage_index:  index of expandeded memory page
 114  * Return value
 115  *           0:            if operation succeeds
 116  *           -EIO:         if pgout failed
 117  *           -ENXIO:       if xpram has vanished
 118  */
 119 static long xpram_page_out (unsigned long page_addr, unsigned int xpage_index)
 120 {
 121         int cc = 2;     /* return unused cc 2 if pgin traps */
 122
 123         asm volatile(
 124                 "       .insn   rre,0xb22f0000,%1,%2\n"  /* pgout %1,%2 */
 125                 "0:     ipm     %0\n"
 126                 "       srl     %0,28\n"
 127                 "1:\n"
 128                 EX_TABLE(0b,1b)
 129                 : "+d" (cc) : "a" (__pa(page_addr)), "d" (xpage_index) : "cc");
 130         if (cc == 3)
 131                 return -ENXIO;
 132         if (cc == 2)
 133                 return -ENXIO;
 134         if (cc == 1)
 135                 return -EIO;
 136         return 0;
 137 }
 138
 139 /*
 140  * Check if xpram is available.
 141  */
 142 static int __init xpram_present(void)
 143 {
 144         unsigned long mem_page;
 145         int rc;
 146
 147         mem_page = (unsigned long) __get_free_page(GFP_KERNEL);
 148         if (!mem_page)
 149                 return -ENOMEM;
 150         rc = xpram_page_in(mem_page, 0);
 151         free_page(mem_page);
 152         return rc ? -ENXIO : 0;
 153 }
 154
 155 /*
 156  * Return index of the last available xpram page.
 157  */
 158 static unsigned long __init xpram_highest_page_index(void)
 159 {
 160         unsigned int page_index, add_bit;
 161         unsigned long mem_page;
 162
 163         mem_page = (unsigned long) __get_free_page(GFP_KERNEL);
 164         if (!mem_page)
 165                 return 0;
 166
 167         page_index = 0;
 168         add_bit = 1ULL << (sizeof(unsigned int)*8 - 1);
 169         while (add_bit > 0) {
 170                 if (xpram_page_in(mem_page, page_index | add_bit) == 0)
 171                         page_index |= add_bit;
 172                 add_bit >>= 1;
 173         }
 174
 175         free_page (mem_page);
 176
 177         return page_index;
 178 }
 179
 180 /*
 181  * Block device make request function.
 182  */
 183 static blk_qc_t xpram_submit_bio(struct bio *bio)
 184 {
 185         xpram_device_t *xdev = bio->bi_bdev->bd_disk->private_data;
 186         struct bio_vec bvec;
 187         struct bvec_iter iter;
 188         unsigned int index;
 189         unsigned long page_addr;
 190         unsigned long bytes;
 191
 192         blk_queue_split(&bio);
 193
 194         if ((bio->bi_iter.bi_sector & 7) != 0 ||
 195             (bio->bi_iter.bi_size & 4095) != 0)
 196                 /* Request is not page-aligned. */
 197                 goto fail;
 198         if ((bio->bi_iter.bi_size >> 12) > xdev->size)
 199                 /* Request size is no page-aligned. */
 200                 goto fail;
 201         if ((bio->bi_iter.bi_sector >> 3) > 0xffffffffU - xdev->offset)
 202                 goto fail;
 203         index = (bio->bi_iter.bi_sector >> 3) + xdev->offset;
 204         bio_for_each_segment(bvec, bio, iter) {
 205                 page_addr = (unsigned long)
 206                         kmap(bvec.bv_page) + bvec.bv_offset;
 207                 bytes = bvec.bv_len;
 208                 if ((page_addr & 4095) != 0 || (bytes & 4095) != 0)
 209                         /* More paranoia. */
 210                         goto fail;
 211                 while (bytes > 0) {
 212                         if (bio_data_dir(bio) == READ) {
 213                                 if (xpram_page_in(page_addr, index) != 0)
 214                                         goto fail;
 215                         } else {
 216                                 if (xpram_page_out(page_addr, index) != 0)
 217                                         goto fail;
 218                         }
 219                         page_addr += 4096;
 220                         bytes -= 4096;
 221                         index++;
 222                 }
 223         }
 224         bio_endio(bio);
 225         return BLK_QC_T_NONE;
 226 fail:
 227         bio_io_error(bio);
 228         return BLK_QC_T_NONE;
 229 }
 230
 231 static int xpram_getgeo(struct block_device *bdev, struct hd_geometry *geo)
 232 {
 233         unsigned long size;
 234
 235         /*
 236          * get geometry: we have to fake one...  trim the size to a
 237          * multiple of 64 (32k): tell we have 16 sectors, 4 heads,
 238          * whatever cylinders. Tell also that data starts at sector. 4.
 239          */
 240         size = (xpram_pages * 8) & ~0x3f;
 241         geo->cylinders = size >> 6;
 242         geo->heads = 4;
 243         geo->sectors = 16;
 244         geo->start = 4;
 245         return 0;
 246 }
 247
 248 static const struct block_device_operations xpram_devops =
 249 {
 250         .owner  = THIS_MODULE,
 251         .submit_bio = xpram_submit_bio,
 252         .getgeo = xpram_getgeo,
 253 };
 254
 255 /*
 256  * Setup xpram_sizes array.
 257  */
 258 static int __init xpram_setup_sizes(unsigned long pages)
 259 {
 260         unsigned long mem_needed;
 261         unsigned long mem_auto;
 262         unsigned long long size;
 263         char *sizes_end;
 264         int mem_auto_no;
 265         int i;
 266
 267         /* Check number of devices. */
 268         if (devs <= 0 || devs > XPRAM_MAX_DEVS) {
 269                 pr_err("%d is not a valid number of XPRAM devices\n",devs);
 270                 return -EINVAL;
 271         }
 272         xpram_devs = devs;
 273
 274         /*
 275          * Copy sizes array to xpram_sizes and align partition
 276          * sizes to page boundary.
 277          */
 278         mem_needed = 0;
 279         mem_auto_no = 0;
 280         for (i = 0; i < xpram_devs; i++) {
 281                 if (sizes[i]) {
 282                         size = simple_strtoull(sizes[i], &sizes_end, 0);
 283                         switch (*sizes_end) {
 284                         case 'g':
 285                         case 'G':
 286                                 size <<= 20;
 287                                 break;
 288                         case 'm':
 289                         case 'M':
 290                                 size <<= 10;
 291                         }
 292                         xpram_sizes[i] = (size + 3) & -4UL;
 293                 }
 294                 if (xpram_sizes[i])
 295                         mem_needed += xpram_sizes[i];
 296                 else
 297                         mem_auto_no++;
 298         }
 299
 300         pr_info("  number of devices (partitions): %d \n", xpram_devs);
 301         for (i = 0; i < xpram_devs; i++) {
 302                 if (xpram_sizes[i])
 303                         pr_info("  size of partition %d: %u kB\n",
 304                                 i, xpram_sizes[i]);
 305                 else
 306                         pr_info("  size of partition %d to be set "
 307                                 "automatically\n",i);
 308         }
 309         pr_info("  memory needed (for sized partitions): %lu kB\n",
 310                 mem_needed);
 311         pr_info("  partitions to be sized automatically: %d\n",
 312                 mem_auto_no);
 313
 314         if (mem_needed > pages * 4) {
 315                 pr_err("Not enough expanded memory available\n");
 316                 return -EINVAL;
 317         }
 318
 319         /*
 320          * partitioning:
 321          * xpram_sizes[i] != 0; partition i has size xpram_sizes[i] kB
 322          * else:             ; all partitions with zero xpram_sizes[i]
 323          *                     partition equally the remaining space
 324          */
 325         if (mem_auto_no) {
 326                 mem_auto = ((pages - mem_needed / 4) / mem_auto_no) * 4;
 327                 pr_info("  automatically determined "
 328                         "partition size: %lu kB\n", mem_auto);
 329                 for (i = 0; i < xpram_devs; i++)
 330                         if (xpram_sizes[i] == 0)
 331                                 xpram_sizes[i] = mem_auto;
 332         }
 333         return 0;
 334 }
 335
 336 static int __init xpram_setup_blkdev(void)
 337 {
 338         unsigned long offset;
 339         int i, rc = -ENOMEM;
 340
 341         for (i = 0; i < xpram_devs; i++) {
 342                 xpram_disks[i] = alloc_disk(1);
 343                 if (!xpram_disks[i])
 344                         goto out;
 345                 xpram_queues[i] = blk_alloc_queue(NUMA_NO_NODE);
 346                 if (!xpram_queues[i]) {
 347                         put_disk(xpram_disks[i]);
 348                         goto out;
 349                 }
 350                 blk_queue_flag_set(QUEUE_FLAG_NONROT, xpram_queues[i]);
 351                 blk_queue_flag_clear(QUEUE_FLAG_ADD_RANDOM, xpram_queues[i]);
 352                 blk_queue_logical_block_size(xpram_queues[i], 4096);
 353         }
 354
 355         /*
 356          * Register xpram major.
 357          */
 358         rc = register_blkdev(XPRAM_MAJOR, XPRAM_NAME);
 359         if (rc < 0)
 360                 goto out;
 361
 362         /*
 363          * Setup device structures.
 364          */
 365         offset = 0;
 366         for (i = 0; i < xpram_devs; i++) {
 367                 struct gendisk *disk = xpram_disks[i];
 368
 369                 xpram_devices[i].size = xpram_sizes[i] / 4;
 370                 xpram_devices[i].offset = offset;
 371                 offset += xpram_devices[i].size;
 372                 disk->major = XPRAM_MAJOR;
 373                 disk->first_minor = i;
 374                 disk->fops = &xpram_devops;
 375                 disk->private_data = &xpram_devices[i];
 376                 disk->queue = xpram_queues[i];
 377                 sprintf(disk->disk_name, "slram%d", i);
 378                 set_capacity(disk, xpram_sizes[i] << 1);
 379                 add_disk(disk);
 380         }
 381
 382         return 0;
 383 out:
 384         while (i--) {
 385                 blk_cleanup_queue(xpram_queues[i]);
 386                 put_disk(xpram_disks[i]);
 387         }
 388         return rc;
 389 }
 390
 391 /*
 392  * Finally, the init/exit functions.
 393  */
 394 static void __exit xpram_exit(void)
 395 {
 396         int i;
 397         for (i = 0; i < xpram_devs; i++) {
 398                 del_gendisk(xpram_disks[i]);
 399                 blk_cleanup_queue(xpram_queues[i]);
 400                 put_disk(xpram_disks[i]);
 401         }
 402         unregister_blkdev(XPRAM_MAJOR, XPRAM_NAME);
 403 }
 404
 405 static int __init xpram_init(void)
 406 {
 407         int rc;
 408
 409         /* Find out size of expanded memory. */
 410         if (xpram_present() != 0) {
 411                 pr_err("No expanded memory available\n");
 412                 return -ENODEV;
 413         }
 414         xpram_pages = xpram_highest_page_index() + 1;
 415         pr_info("  %u pages expanded memory found (%lu KB).\n",
 416                 xpram_pages, (unsigned long) xpram_pages*4);
 417         rc = xpram_setup_sizes(xpram_pages);
 418         if (rc)
 419                 return rc;
 420         return xpram_setup_blkdev();
 421 }
 422
 423 module_init(xpram_init);
 424 module_exit(xpram_exit);