2 * dcssblk.c -- the S/390 block driver for dcss memory
4 * Authors: Carsten Otte, Stefan Weinhuber, Gerald Schaefer
7 #include <linux/module.h>
8 #include <linux/moduleparam.h>
9 #include <linux/ctype.h>
10 #include <linux/errno.h>
11 #include <linux/init.h>
12 #include <linux/slab.h>
13 #include <linux/blkdev.h>
14 #include <asm/extmem.h>
16 #include <linux/completion.h>
17 #include <linux/interrupt.h>
18 #include <asm/s390_rdev.h>
20 //#define DCSSBLK_DEBUG /* Debug messages on/off */
21 #define DCSSBLK_NAME "dcssblk"
22 #define DCSSBLK_MINORS_PER_DISK 1
23 #define DCSSBLK_PARM_LEN 400
26 #define PRINT_DEBUG(x...) printk(KERN_DEBUG DCSSBLK_NAME " debug: " x)
28 #define PRINT_DEBUG(x...) do {} while (0)
30 #define PRINT_INFO(x...) printk(KERN_INFO DCSSBLK_NAME " info: " x)
31 #define PRINT_WARN(x...) printk(KERN_WARNING DCSSBLK_NAME " warning: " x)
32 #define PRINT_ERR(x...) printk(KERN_ERR DCSSBLK_NAME " error: " x)
35 static int dcssblk_open(struct inode *inode, struct file *filp);
36 static int dcssblk_release(struct inode *inode, struct file *filp);
37 static int dcssblk_make_request(struct request_queue *q, struct bio *bio);
38 static int dcssblk_direct_access(struct block_device *bdev, sector_t secnum,
41 static char dcssblk_segments[DCSSBLK_PARM_LEN] = "\0";
43 static int dcssblk_major;
44 static struct block_device_operations dcssblk_devops = {
47 .release = dcssblk_release,
48 .direct_access = dcssblk_direct_access,
51 static ssize_t dcssblk_add_store(struct device * dev, struct device_attribute *attr, const char * buf,
53 static ssize_t dcssblk_remove_store(struct device * dev, struct device_attribute *attr, const char * buf,
55 static ssize_t dcssblk_save_store(struct device * dev, struct device_attribute *attr, const char * buf,
57 static ssize_t dcssblk_save_show(struct device *dev, struct device_attribute *attr, char *buf);
58 static ssize_t dcssblk_shared_store(struct device * dev, struct device_attribute *attr, const char * buf,
60 static ssize_t dcssblk_shared_show(struct device *dev, struct device_attribute *attr, char *buf);
62 static DEVICE_ATTR(add, S_IWUSR, NULL, dcssblk_add_store);
63 static DEVICE_ATTR(remove, S_IWUSR, NULL, dcssblk_remove_store);
64 static DEVICE_ATTR(save, S_IWUSR | S_IRUGO, dcssblk_save_show,
66 static DEVICE_ATTR(shared, S_IWUSR | S_IRUGO, dcssblk_shared_show,
67 dcssblk_shared_store);
69 static struct device *dcssblk_root_dev;
71 struct dcssblk_dev_info {
74 char segment_name[BUS_ID_SIZE];
80 unsigned char save_pending;
81 unsigned char is_shared;
82 struct request_queue *dcssblk_queue;
85 static LIST_HEAD(dcssblk_devices);
86 static struct rw_semaphore dcssblk_devices_sem;
89 * release function for segment device.
92 dcssblk_release_segment(struct device *dev)
94 PRINT_DEBUG("segment release fn called for %s\n", dev->bus_id);
95 kfree(container_of(dev, struct dcssblk_dev_info, dev));
96 module_put(THIS_MODULE);
100 * get a minor number. needs to be called with
101 * down_write(&dcssblk_devices_sem) and the
102 * device needs to be enqueued before the semaphore is
106 dcssblk_assign_free_minor(struct dcssblk_dev_info *dev_info)
109 struct dcssblk_dev_info *entry;
111 if (dev_info == NULL)
113 for (minor = 0; minor < (1<<MINORBITS); minor++) {
115 // test if minor available
116 list_for_each_entry(entry, &dcssblk_devices, lh)
117 if (minor == entry->gd->first_minor)
119 if (!found) break; // got unused minor
123 dev_info->gd->first_minor = minor;
128 * get the struct dcssblk_dev_info from dcssblk_devices
129 * for the given name.
130 * down_read(&dcssblk_devices_sem) must be held.
132 static struct dcssblk_dev_info *
133 dcssblk_get_device_by_name(char *name)
135 struct dcssblk_dev_info *entry;
137 list_for_each_entry(entry, &dcssblk_devices, lh) {
138 if (!strcmp(name, entry->segment_name)) {
146 * print appropriate error message for segment_load()/segment_type()
150 dcssblk_segment_warn(int rc, char* seg_name)
154 PRINT_WARN("cannot load/query segment %s, does not exist\n",
158 PRINT_WARN("cannot load/query segment %s, not running on VM\n",
162 PRINT_WARN("cannot load/query segment %s, hardware error\n",
166 PRINT_WARN("cannot load/query segment %s, is a multi-part "
167 "segment\n", seg_name);
170 PRINT_WARN("cannot load/query segment %s, overlaps with "
171 "storage\n", seg_name);
174 PRINT_WARN("cannot load/query segment %s, overlaps with "
175 "already loaded dcss\n", seg_name);
178 PRINT_WARN("cannot load/query segment %s, already loaded in "
179 "incompatible mode\n", seg_name);
182 PRINT_WARN("cannot load/query segment %s, out of memory\n",
186 PRINT_WARN("cannot load/query segment %s, exceeds kernel "
187 "mapping range\n", seg_name);
190 PRINT_WARN("cannot load/query segment %s, return value %i\n",
196 static void dcssblk_unregister_callback(struct device *dev)
198 device_unregister(dev);
203 * device attribute for switching shared/nonshared (exclusive)
204 * operation (show + store)
207 dcssblk_shared_show(struct device *dev, struct device_attribute *attr, char *buf)
209 struct dcssblk_dev_info *dev_info;
211 dev_info = container_of(dev, struct dcssblk_dev_info, dev);
212 return sprintf(buf, dev_info->is_shared ? "1\n" : "0\n");
216 dcssblk_shared_store(struct device *dev, struct device_attribute *attr, const char *inbuf, size_t count)
218 struct dcssblk_dev_info *dev_info;
221 if ((count > 1) && (inbuf[1] != '\n') && (inbuf[1] != '\0')) {
222 PRINT_WARN("Invalid value, must be 0 or 1\n");
225 down_write(&dcssblk_devices_sem);
226 dev_info = container_of(dev, struct dcssblk_dev_info, dev);
227 if (atomic_read(&dev_info->use_count)) {
228 PRINT_ERR("share: segment %s is busy!\n",
229 dev_info->segment_name);
233 if (inbuf[0] == '1') {
234 // reload segment in shared mode
235 rc = segment_modify_shared(dev_info->segment_name,
238 BUG_ON(rc == -EINVAL);
242 dev_info->is_shared = 1;
243 switch (dev_info->segment_type) {
247 set_disk_ro(dev_info->gd,1);
250 } else if (inbuf[0] == '0') {
251 // reload segment in exclusive mode
252 if (dev_info->segment_type == SEG_TYPE_SC) {
253 PRINT_ERR("Segment type SC (%s) cannot be loaded in "
254 "non-shared mode\n", dev_info->segment_name);
258 rc = segment_modify_shared(dev_info->segment_name,
261 BUG_ON(rc == -EINVAL);
265 dev_info->is_shared = 0;
266 set_disk_ro(dev_info->gd, 0);
269 PRINT_WARN("Invalid value, must be 0 or 1\n");
277 PRINT_ERR("Could not reload segment %s, removing it now!\n",
278 dev_info->segment_name);
279 list_del(&dev_info->lh);
281 del_gendisk(dev_info->gd);
282 blk_cleanup_queue(dev_info->dcssblk_queue);
283 dev_info->gd->queue = NULL;
284 put_disk(dev_info->gd);
285 rc = device_schedule_callback(dev, dcssblk_unregister_callback);
287 up_write(&dcssblk_devices_sem);
292 * device attribute for save operation on current copy
293 * of the segment. If the segment is busy, saving will
294 * become pending until it gets released, which can be
295 * undone by storing a non-true value to this entry.
299 dcssblk_save_show(struct device *dev, struct device_attribute *attr, char *buf)
301 struct dcssblk_dev_info *dev_info;
303 dev_info = container_of(dev, struct dcssblk_dev_info, dev);
304 return sprintf(buf, dev_info->save_pending ? "1\n" : "0\n");
308 dcssblk_save_store(struct device *dev, struct device_attribute *attr, const char *inbuf, size_t count)
310 struct dcssblk_dev_info *dev_info;
312 if ((count > 1) && (inbuf[1] != '\n') && (inbuf[1] != '\0')) {
313 PRINT_WARN("Invalid value, must be 0 or 1\n");
316 dev_info = container_of(dev, struct dcssblk_dev_info, dev);
318 down_write(&dcssblk_devices_sem);
319 if (inbuf[0] == '1') {
320 if (atomic_read(&dev_info->use_count) == 0) {
321 // device is idle => we save immediately
322 PRINT_INFO("Saving segment %s\n",
323 dev_info->segment_name);
324 segment_save(dev_info->segment_name);
326 // device is busy => we save it when it becomes
327 // idle in dcssblk_release
328 PRINT_INFO("Segment %s is currently busy, it will "
329 "be saved when it becomes idle...\n",
330 dev_info->segment_name);
331 dev_info->save_pending = 1;
333 } else if (inbuf[0] == '0') {
334 if (dev_info->save_pending) {
335 // device is busy & the user wants to undo his save
337 dev_info->save_pending = 0;
338 PRINT_INFO("Pending save for segment %s deactivated\n",
339 dev_info->segment_name);
342 up_write(&dcssblk_devices_sem);
343 PRINT_WARN("Invalid value, must be 0 or 1\n");
346 up_write(&dcssblk_devices_sem);
351 * device attribute for adding devices
354 dcssblk_add_store(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
357 struct dcssblk_dev_info *dev_info;
359 unsigned long seg_byte_size;
362 if (dev != dcssblk_root_dev) {
366 local_buf = kmalloc(count + 1, GFP_KERNEL);
367 if (local_buf == NULL) {
374 for (i = 0; ((buf[i] != '\0') && (buf[i] != '\n') && i < count); i++) {
375 local_buf[i] = toupper(buf[i]);
378 if ((i == 0) || (i > 8)) {
385 down_read(&dcssblk_devices_sem);
386 dev_info = dcssblk_get_device_by_name(local_buf);
387 up_read(&dcssblk_devices_sem);
388 if (dev_info != NULL) {
389 PRINT_WARN("Segment %s already loaded!\n", local_buf);
394 * get a struct dcssblk_dev_info
396 dev_info = kzalloc(sizeof(struct dcssblk_dev_info), GFP_KERNEL);
397 if (dev_info == NULL) {
402 strcpy(dev_info->segment_name, local_buf);
403 strlcpy(dev_info->dev.bus_id, local_buf, BUS_ID_SIZE);
404 dev_info->dev.release = dcssblk_release_segment;
405 INIT_LIST_HEAD(&dev_info->lh);
407 dev_info->gd = alloc_disk(DCSSBLK_MINORS_PER_DISK);
408 if (dev_info->gd == NULL) {
412 dev_info->gd->major = dcssblk_major;
413 dev_info->gd->fops = &dcssblk_devops;
414 dev_info->dcssblk_queue = blk_alloc_queue(GFP_KERNEL);
415 dev_info->gd->queue = dev_info->dcssblk_queue;
416 dev_info->gd->private_data = dev_info;
417 dev_info->gd->driverfs_dev = &dev_info->dev;
421 rc = segment_load(local_buf, SEGMENT_SHARED,
422 &dev_info->start, &dev_info->end);
424 dcssblk_segment_warn(rc, dev_info->segment_name);
425 goto dealloc_gendisk;
427 seg_byte_size = (dev_info->end - dev_info->start + 1);
428 set_capacity(dev_info->gd, seg_byte_size >> 9); // size in sectors
429 PRINT_INFO("Loaded segment %s, size = %lu Byte, "
430 "capacity = %lu (512 Byte) sectors\n", local_buf,
431 seg_byte_size, seg_byte_size >> 9);
433 dev_info->segment_type = rc;
434 dev_info->save_pending = 0;
435 dev_info->is_shared = 1;
436 dev_info->dev.parent = dcssblk_root_dev;
439 * get minor, add to list
441 down_write(&dcssblk_devices_sem);
442 rc = dcssblk_assign_free_minor(dev_info);
444 up_write(&dcssblk_devices_sem);
445 PRINT_ERR("No free minor number available! "
446 "Unloading segment...\n");
449 sprintf(dev_info->gd->disk_name, "dcssblk%d",
450 dev_info->gd->first_minor);
451 list_add_tail(&dev_info->lh, &dcssblk_devices);
453 if (!try_module_get(THIS_MODULE)) {
458 * register the device
460 rc = device_register(&dev_info->dev);
462 PRINT_ERR("Segment %s could not be registered RC=%d\n",
464 module_put(THIS_MODULE);
467 get_device(&dev_info->dev);
468 rc = device_create_file(&dev_info->dev, &dev_attr_shared);
471 rc = device_create_file(&dev_info->dev, &dev_attr_save);
475 blk_queue_make_request(dev_info->dcssblk_queue, dcssblk_make_request);
476 blk_queue_hardsect_size(dev_info->dcssblk_queue, 4096);
478 add_disk(dev_info->gd);
480 switch (dev_info->segment_type) {
484 set_disk_ro(dev_info->gd,1);
487 set_disk_ro(dev_info->gd,0);
490 PRINT_DEBUG("Segment %s loaded successfully\n", local_buf);
491 up_write(&dcssblk_devices_sem);
496 PRINT_ERR("device_create_file() failed!\n");
497 list_del(&dev_info->lh);
498 blk_cleanup_queue(dev_info->dcssblk_queue);
499 dev_info->gd->queue = NULL;
500 put_disk(dev_info->gd);
501 device_unregister(&dev_info->dev);
502 segment_unload(dev_info->segment_name);
503 put_device(&dev_info->dev);
504 up_write(&dcssblk_devices_sem);
507 list_del(&dev_info->lh);
508 up_write(&dcssblk_devices_sem);
510 segment_unload(local_buf);
512 blk_cleanup_queue(dev_info->dcssblk_queue);
513 dev_info->gd->queue = NULL;
514 put_disk(dev_info->gd);
524 * device attribute for removing devices
527 dcssblk_remove_store(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
529 struct dcssblk_dev_info *dev_info;
533 if (dev != dcssblk_root_dev) {
536 local_buf = kmalloc(count + 1, GFP_KERNEL);
537 if (local_buf == NULL) {
543 for (i = 0; ((*(buf+i)!='\0') && (*(buf+i)!='\n') && i < count); i++) {
544 local_buf[i] = toupper(buf[i]);
547 if ((i == 0) || (i > 8)) {
552 down_write(&dcssblk_devices_sem);
553 dev_info = dcssblk_get_device_by_name(local_buf);
554 if (dev_info == NULL) {
555 up_write(&dcssblk_devices_sem);
556 PRINT_WARN("Segment %s is not loaded!\n", local_buf);
560 if (atomic_read(&dev_info->use_count) != 0) {
561 up_write(&dcssblk_devices_sem);
562 PRINT_WARN("Segment %s is in use!\n", local_buf);
566 list_del(&dev_info->lh);
568 del_gendisk(dev_info->gd);
569 blk_cleanup_queue(dev_info->dcssblk_queue);
570 dev_info->gd->queue = NULL;
571 put_disk(dev_info->gd);
572 device_unregister(&dev_info->dev);
573 segment_unload(dev_info->segment_name);
574 PRINT_DEBUG("Segment %s unloaded successfully\n",
575 dev_info->segment_name);
576 put_device(&dev_info->dev);
577 up_write(&dcssblk_devices_sem);
586 dcssblk_open(struct inode *inode, struct file *filp)
588 struct dcssblk_dev_info *dev_info;
591 dev_info = inode->i_bdev->bd_disk->private_data;
592 if (NULL == dev_info) {
596 atomic_inc(&dev_info->use_count);
597 inode->i_bdev->bd_block_size = 4096;
604 dcssblk_release(struct inode *inode, struct file *filp)
606 struct dcssblk_dev_info *dev_info;
609 dev_info = inode->i_bdev->bd_disk->private_data;
610 if (NULL == dev_info) {
614 down_write(&dcssblk_devices_sem);
615 if (atomic_dec_and_test(&dev_info->use_count)
616 && (dev_info->save_pending)) {
617 PRINT_INFO("Segment %s became idle and is being saved now\n",
618 dev_info->segment_name);
619 segment_save(dev_info->segment_name);
620 dev_info->save_pending = 0;
622 up_write(&dcssblk_devices_sem);
629 dcssblk_make_request(struct request_queue *q, struct bio *bio)
631 struct dcssblk_dev_info *dev_info;
632 struct bio_vec *bvec;
634 unsigned long page_addr;
635 unsigned long source_addr;
636 unsigned long bytes_done;
640 dev_info = bio->bi_bdev->bd_disk->private_data;
641 if (dev_info == NULL)
643 if ((bio->bi_sector & 7) != 0 || (bio->bi_size & 4095) != 0)
644 /* Request is not page-aligned. */
646 if (((bio->bi_size >> 9) + bio->bi_sector)
647 > get_capacity(bio->bi_bdev->bd_disk)) {
648 /* Request beyond end of DCSS segment. */
651 /* verify data transfer direction */
652 if (dev_info->is_shared) {
653 switch (dev_info->segment_type) {
657 /* cannot write to these segments */
658 if (bio_data_dir(bio) == WRITE) {
659 PRINT_WARN("rejecting write to ro segment %s\n", dev_info->dev.bus_id);
665 index = (bio->bi_sector >> 3);
666 bio_for_each_segment(bvec, bio, i) {
667 page_addr = (unsigned long)
668 page_address(bvec->bv_page) + bvec->bv_offset;
669 source_addr = dev_info->start + (index<<12) + bytes_done;
670 if (unlikely(page_addr & 4095) != 0 || (bvec->bv_len & 4095) != 0)
673 if (bio_data_dir(bio) == READ) {
674 memcpy((void*)page_addr, (void*)source_addr,
677 memcpy((void*)source_addr, (void*)page_addr,
680 bytes_done += bvec->bv_len;
690 dcssblk_direct_access (struct block_device *bdev, sector_t secnum,
693 struct dcssblk_dev_info *dev_info;
696 dev_info = bdev->bd_disk->private_data;
699 if (secnum % (PAGE_SIZE/512))
701 pgoff = secnum / (PAGE_SIZE / 512);
702 if ((pgoff+1)*PAGE_SIZE-1 > dev_info->end - dev_info->start)
704 *data = (unsigned long) (dev_info->start+pgoff*PAGE_SIZE);
709 dcssblk_check_params(void)
713 struct dcssblk_dev_info *dev_info;
715 for (i = 0; (i < DCSSBLK_PARM_LEN) && (dcssblk_segments[i] != '\0');
717 for (j = i; (dcssblk_segments[j] != ',') &&
718 (dcssblk_segments[j] != '\0') &&
719 (dcssblk_segments[j] != '(') &&
722 buf[j-i] = dcssblk_segments[j];
725 rc = dcssblk_add_store(dcssblk_root_dev, NULL, buf, j-i);
726 if ((rc >= 0) && (dcssblk_segments[j] == '(')) {
727 for (k = 0; buf[k] != '\0'; k++)
728 buf[k] = toupper(buf[k]);
729 if (!strncmp(&dcssblk_segments[j], "(local)", 7)) {
730 down_read(&dcssblk_devices_sem);
731 dev_info = dcssblk_get_device_by_name(buf);
732 up_read(&dcssblk_devices_sem);
734 dcssblk_shared_store(&dev_info->dev,
738 while ((dcssblk_segments[j] != ',') &&
739 (dcssblk_segments[j] != '\0'))
743 if (dcssblk_segments[j] == '\0')
750 * The init/exit functions.
755 PRINT_DEBUG("DCSSBLOCK EXIT...\n");
756 s390_root_dev_unregister(dcssblk_root_dev);
757 unregister_blkdev(dcssblk_major, DCSSBLK_NAME);
758 PRINT_DEBUG("...finished!\n");
766 PRINT_DEBUG("DCSSBLOCK INIT...\n");
767 dcssblk_root_dev = s390_root_dev_register("dcssblk");
768 if (IS_ERR(dcssblk_root_dev)) {
769 PRINT_ERR("device_register() failed!\n");
770 return PTR_ERR(dcssblk_root_dev);
772 rc = device_create_file(dcssblk_root_dev, &dev_attr_add);
774 PRINT_ERR("device_create_file(add) failed!\n");
775 s390_root_dev_unregister(dcssblk_root_dev);
778 rc = device_create_file(dcssblk_root_dev, &dev_attr_remove);
780 PRINT_ERR("device_create_file(remove) failed!\n");
781 s390_root_dev_unregister(dcssblk_root_dev);
784 rc = register_blkdev(0, DCSSBLK_NAME);
786 PRINT_ERR("Can't get dynamic major!\n");
787 s390_root_dev_unregister(dcssblk_root_dev);
791 init_rwsem(&dcssblk_devices_sem);
793 dcssblk_check_params();
795 PRINT_DEBUG("...finished!\n");
799 module_init(dcssblk_init);
800 module_exit(dcssblk_exit);
802 module_param_string(segments, dcssblk_segments, DCSSBLK_PARM_LEN, 0444);
803 MODULE_PARM_DESC(segments, "Name of DCSS segment(s) to be loaded, "
804 "comma-separated list, each name max. 8 chars.\n"
805 "Adding \"(local)\" to segment name equals echoing 0 to "
806 "/sys/devices/dcssblk/<segment name>/shared after loading "
808 "e.g. segments=\"mydcss1,mydcss2,mydcss3(local)\"");
810 MODULE_LICENSE("GPL");