2 * Character device driver for extended error reporting.
4 * Copyright (C) 2005 IBM Corporation
5 * extended error reporting for DASD ECKD devices
6 * Author(s): Stefan Weinhuber <wein@de.ibm.com>
9 #include <linux/init.h>
11 #include <linux/kernel.h>
12 #include <linux/miscdevice.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/device.h>
16 #include <linux/poll.h>
18 #include <asm/uaccess.h>
19 #include <asm/semaphore.h>
20 #include <asm/atomic.h>
21 #include <asm/ebcdic.h>
24 #include "dasd_eckd.h"
28 #endif /* PRINTK_HEADER */
29 #define PRINTK_HEADER "dasd(eer):"
32 * SECTION: the internal buffer
36 * The internal buffer is meant to store obaque blobs of data, so it does
37 * not know of higher level concepts like triggers.
38 * It consists of a number of pages that are used as a ringbuffer. Each data
39 * blob is stored in a simple record that consists of an integer, which
40 * contains the size of the following data, and the data bytes themselfes.
42 * To allow for multiple independent readers we create one internal buffer
43 * each time the device is opened and destroy the buffer when the file is
44 * closed again. The number of pages used for this buffer is determined by
45 * the module parmeter eer_pages.
47 * One record can be written to a buffer by using the functions
48 * - dasd_eer_start_record (one time per record to write the size to the
49 * buffer and reserve the space for the data)
50 * - dasd_eer_write_buffer (one or more times per record to write the data)
51 * The data can be written in several steps but you will have to compute
52 * the total size up front for the invocation of dasd_eer_start_record.
53 * If the ringbuffer is full, dasd_eer_start_record will remove the required
54 * number of old records.
56 * A record is typically read in two steps, first read the integer that
57 * specifies the size of the following data, then read the data.
59 * - dasd_eer_read_buffer
61 * For all mentioned functions you need to get the bufferlock first and keep
62 * it until a complete record is written or read.
64 * All information necessary to keep track of an internal buffer is kept in
65 * a struct eerbuffer. The buffer specific to a file pointer is strored in
66 * the private_data field of that file. To be able to write data to all
67 * existing buffers, each buffer is also added to the bufferlist.
68 * If the user does not want to read a complete record in one go, we have to
69 * keep track of the rest of the record. residual stores the number of bytes
70 * that are still to deliver. If the rest of the record is invalidated between
71 * two reads then residual will be set to -1 so that the next read will fail.
72 * All entries in the eerbuffer structure are protected with the bufferlock.
73 * To avoid races between writing to a buffer on the one side and creating
74 * and destroying buffers on the other side, the bufferlock must also be used
75 * to protect the bufferlist.
78 static int eer_pages = 5;
79 module_param(eer_pages, int, S_IRUGO|S_IWUSR);
82 struct list_head list;
85 int buffer_page_count;
91 static LIST_HEAD(bufferlist);
92 static DEFINE_SPINLOCK(bufferlock);
93 static DECLARE_WAIT_QUEUE_HEAD(dasd_eer_read_wait_queue);
96 * How many free bytes are available on the buffer.
97 * Needs to be called with bufferlock held.
99 static int dasd_eer_get_free_bytes(struct eerbuffer *eerb)
101 if (eerb->head < eerb->tail)
102 return eerb->tail - eerb->head - 1;
103 return eerb->buffersize - eerb->head + eerb->tail -1;
107 * How many bytes of buffer space are used.
108 * Needs to be called with bufferlock held.
110 static int dasd_eer_get_filled_bytes(struct eerbuffer *eerb)
113 if (eerb->head >= eerb->tail)
114 return eerb->head - eerb->tail;
115 return eerb->buffersize - eerb->tail + eerb->head;
119 * The dasd_eer_write_buffer function just copies count bytes of data
120 * to the buffer. Make sure to call dasd_eer_start_record first, to
121 * make sure that enough free space is available.
122 * Needs to be called with bufferlock held.
124 static void dasd_eer_write_buffer(struct eerbuffer *eerb,
125 char *data, int count)
128 unsigned long headindex,localhead;
129 unsigned long rest, len;
135 headindex = eerb->head / PAGE_SIZE;
136 localhead = eerb->head % PAGE_SIZE;
137 len = min(rest, PAGE_SIZE - localhead);
138 memcpy(eerb->buffer[headindex]+localhead, nextdata, len);
142 if (eerb->head == eerb->buffersize)
143 eerb->head = 0; /* wrap around */
144 BUG_ON(eerb->head > eerb->buffersize);
149 * Needs to be called with bufferlock held.
151 static int dasd_eer_read_buffer(struct eerbuffer *eerb, char *data, int count)
154 unsigned long tailindex,localtail;
155 unsigned long rest, len, finalcount;
158 finalcount = min(count, dasd_eer_get_filled_bytes(eerb));
162 tailindex = eerb->tail / PAGE_SIZE;
163 localtail = eerb->tail % PAGE_SIZE;
164 len = min(rest, PAGE_SIZE - localtail);
165 memcpy(nextdata, eerb->buffer[tailindex] + localtail, len);
169 if (eerb->tail == eerb->buffersize)
170 eerb->tail = 0; /* wrap around */
171 BUG_ON(eerb->tail > eerb->buffersize);
177 * Whenever you want to write a blob of data to the internal buffer you
178 * have to start by using this function first. It will write the number
179 * of bytes that will be written to the buffer. If necessary it will remove
180 * old records to make room for the new one.
181 * Needs to be called with bufferlock held.
183 static int dasd_eer_start_record(struct eerbuffer *eerb, int count)
187 if (count + sizeof(count) > eerb->buffersize)
189 while (dasd_eer_get_free_bytes(eerb) < count + sizeof(count)) {
190 if (eerb->residual > 0) {
191 eerb->tail += eerb->residual;
192 if (eerb->tail >= eerb->buffersize)
193 eerb->tail -= eerb->buffersize;
196 dasd_eer_read_buffer(eerb, (char *) &tailcount,
198 eerb->tail += tailcount;
199 if (eerb->tail >= eerb->buffersize)
200 eerb->tail -= eerb->buffersize;
202 dasd_eer_write_buffer(eerb, (char*) &count, sizeof(count));
208 * Release pages that are not used anymore.
210 static void dasd_eer_free_buffer_pages(char **buf, int no_pages)
214 for (i = 0; i < no_pages; i++)
215 free_page((unsigned long) buf[i]);
219 * Allocate a new set of memory pages.
221 static int dasd_eer_allocate_buffer_pages(char **buf, int no_pages)
225 for (i = 0; i < no_pages; i++) {
226 buf[i] = (char *) get_zeroed_page(GFP_KERNEL);
228 dasd_eer_free_buffer_pages(buf, i);
236 * SECTION: The extended error reporting functionality
240 * When a DASD device driver wants to report an error, it calls the
241 * function dasd_eer_write and gives the respective trigger ID as
242 * parameter. Currently there are four kinds of triggers:
244 * DASD_EER_FATALERROR: all kinds of unrecoverable I/O problems
245 * DASD_EER_PPRCSUSPEND: PPRC was suspended
246 * DASD_EER_NOPATH: There is no path to the device left.
247 * DASD_EER_STATECHANGE: The state of the device has changed.
249 * For the first three triggers all required information can be supplied by
250 * the caller. For these triggers a record is written by the function
251 * dasd_eer_write_standard_trigger.
253 * The DASD_EER_STATECHANGE trigger is special since a sense subsystem
254 * status ccw need to be executed to gather the necessary sense data first.
255 * The dasd_eer_snss function will queue the SNSS request and the request
256 * callback will then call dasd_eer_write with the DASD_EER_STATCHANGE
259 * To avoid memory allocations at runtime, the necessary memory is allocated
260 * when the extended error reporting is enabled for a device (by
261 * dasd_eer_probe). There is one sense subsystem status request for each
262 * eer enabled DASD device. The presence of the cqr in device->eer_cqr
263 * indicates that eer is enable for the device. The use of the snss request
264 * is protected by the DASD_FLAG_EER_IN_USE bit. When this flag indicates
265 * that the cqr is currently in use, dasd_eer_snss cannot start a second
266 * request but sets the DASD_FLAG_EER_SNSS flag instead. The callback of
267 * the SNSS request will check the bit and call dasd_eer_snss again.
270 #define SNSS_DATA_SIZE 44
272 #define DASD_EER_BUSID_SIZE 10
273 struct dasd_eer_header {
278 char busid[DASD_EER_BUSID_SIZE];
279 } __attribute__ ((packed));
282 * The following function can be used for those triggers that have
283 * all necessary data available when the function is called.
284 * If the parameter cqr is not NULL, the chain of requests will be searched
285 * for valid sense data, and all valid sense data sets will be added to
288 static void dasd_eer_write_standard_trigger(struct dasd_device *device,
289 struct dasd_ccw_req *cqr,
292 struct dasd_ccw_req *temp_cqr;
295 struct dasd_eer_header header;
297 struct eerbuffer *eerb;
299 /* go through cqr chain and count the valid sense data sets */
301 for (temp_cqr = cqr; temp_cqr; temp_cqr = temp_cqr->refers)
302 if (temp_cqr->irb.esw.esw0.erw.cons)
305 header.total_size = sizeof(header) + data_size + 4; /* "EOR" */
306 header.trigger = trigger;
307 do_gettimeofday(&tv);
308 header.tv_sec = tv.tv_sec;
309 header.tv_usec = tv.tv_usec;
310 strncpy(header.busid, device->cdev->dev.bus_id, DASD_EER_BUSID_SIZE);
312 spin_lock_irqsave(&bufferlock, flags);
313 list_for_each_entry(eerb, &bufferlist, list) {
314 dasd_eer_start_record(eerb, header.total_size);
315 dasd_eer_write_buffer(eerb, (char *) &header, sizeof(header));
316 for (temp_cqr = cqr; temp_cqr; temp_cqr = temp_cqr->refers)
317 if (temp_cqr->irb.esw.esw0.erw.cons)
318 dasd_eer_write_buffer(eerb, cqr->irb.ecw, 32);
319 dasd_eer_write_buffer(eerb, "EOR", 4);
321 spin_unlock_irqrestore(&bufferlock, flags);
322 wake_up_interruptible(&dasd_eer_read_wait_queue);
326 * This function writes a DASD_EER_STATECHANGE trigger.
328 static void dasd_eer_write_snss_trigger(struct dasd_device *device,
329 struct dasd_ccw_req *cqr,
335 struct dasd_eer_header header;
337 struct eerbuffer *eerb;
339 snss_rc = (cqr->status == DASD_CQR_FAILED) ? -EIO : 0;
343 data_size = SNSS_DATA_SIZE;
345 header.total_size = sizeof(header) + data_size + 4; /* "EOR" */
346 header.trigger = DASD_EER_STATECHANGE;
347 do_gettimeofday(&tv);
348 header.tv_sec = tv.tv_sec;
349 header.tv_usec = tv.tv_usec;
350 strncpy(header.busid, device->cdev->dev.bus_id, DASD_EER_BUSID_SIZE);
352 spin_lock_irqsave(&bufferlock, flags);
353 list_for_each_entry(eerb, &bufferlist, list) {
354 dasd_eer_start_record(eerb, header.total_size);
355 dasd_eer_write_buffer(eerb, (char *) &header , sizeof(header));
357 dasd_eer_write_buffer(eerb, cqr->data, SNSS_DATA_SIZE);
358 dasd_eer_write_buffer(eerb, "EOR", 4);
360 spin_unlock_irqrestore(&bufferlock, flags);
361 wake_up_interruptible(&dasd_eer_read_wait_queue);
365 * This function is called for all triggers. It calls the appropriate
366 * function that writes the actual trigger records.
368 void dasd_eer_write(struct dasd_device *device, struct dasd_ccw_req *cqr,
371 if (!device->eer_cqr)
374 case DASD_EER_FATALERROR:
375 case DASD_EER_PPRCSUSPEND:
376 dasd_eer_write_standard_trigger(device, cqr, id);
378 case DASD_EER_NOPATH:
379 dasd_eer_write_standard_trigger(device, NULL, id);
381 case DASD_EER_STATECHANGE:
382 dasd_eer_write_snss_trigger(device, cqr, id);
384 default: /* unknown trigger, so we write it without any sense data */
385 dasd_eer_write_standard_trigger(device, NULL, id);
389 EXPORT_SYMBOL(dasd_eer_write);
392 * Start a sense subsystem status request.
393 * Needs to be called with the device held.
395 void dasd_eer_snss(struct dasd_device *device)
397 struct dasd_ccw_req *cqr;
399 cqr = device->eer_cqr;
400 if (!cqr) /* Device not eer enabled. */
402 if (test_and_set_bit(DASD_FLAG_EER_IN_USE, &device->flags)) {
403 /* Sense subsystem status request in use. */
404 set_bit(DASD_FLAG_EER_SNSS, &device->flags);
407 clear_bit(DASD_FLAG_EER_SNSS, &device->flags);
408 cqr->status = DASD_CQR_QUEUED;
409 list_add(&cqr->list, &device->ccw_queue);
410 dasd_schedule_bh(device);
414 * Callback function for use with sense subsystem status request.
416 static void dasd_eer_snss_cb(struct dasd_ccw_req *cqr, void *data)
418 struct dasd_device *device = cqr->device;
421 dasd_eer_write(device, cqr, DASD_EER_STATECHANGE);
422 spin_lock_irqsave(get_ccwdev_lock(device->cdev), flags);
423 if (device->eer_cqr == cqr) {
424 clear_bit(DASD_FLAG_EER_IN_USE, &device->flags);
425 if (test_bit(DASD_FLAG_EER_SNSS, &device->flags))
426 /* Another SNSS has been requested in the meantime. */
427 dasd_eer_snss(device);
430 spin_unlock_irqrestore(get_ccwdev_lock(device->cdev), flags);
433 * Extended error recovery has been switched off while
434 * the SNSS request was running. It could even have
435 * been switched off and on again in which case there
436 * is a new ccw in device->eer_cqr. Free the "old"
439 dasd_kfree_request(cqr, device);
443 * Enable error reporting on a given device.
445 int dasd_eer_enable(struct dasd_device *device)
447 struct dasd_ccw_req *cqr;
453 if (!device->discipline || strcmp(device->discipline->name, "ECKD"))
454 return -EPERM; /* FIXME: -EMEDIUMTYPE ? */
456 cqr = dasd_kmalloc_request("ECKD", 1 /* SNSS */,
457 SNSS_DATA_SIZE, device);
461 cqr->device = device;
463 cqr->expires = 10 * HZ;
465 cqr->cpaddr->cmd_code = DASD_ECKD_CCW_SNSS;
466 cqr->cpaddr->count = SNSS_DATA_SIZE;
467 cqr->cpaddr->flags = 0;
468 cqr->cpaddr->cda = (__u32)(addr_t) cqr->data;
470 cqr->buildclk = get_clock();
471 cqr->status = DASD_CQR_FILLED;
472 cqr->callback = dasd_eer_snss_cb;
474 spin_lock_irqsave(get_ccwdev_lock(device->cdev), flags);
475 if (!device->eer_cqr) {
476 device->eer_cqr = cqr;
479 spin_unlock_irqrestore(get_ccwdev_lock(device->cdev), flags);
481 dasd_kfree_request(cqr, device);
486 * Disable error reporting on a given device.
488 void dasd_eer_disable(struct dasd_device *device)
490 struct dasd_ccw_req *cqr;
494 if (!device->eer_cqr)
496 spin_lock_irqsave(get_ccwdev_lock(device->cdev), flags);
497 cqr = device->eer_cqr;
498 device->eer_cqr = NULL;
499 clear_bit(DASD_FLAG_EER_SNSS, &device->flags);
500 in_use = test_and_clear_bit(DASD_FLAG_EER_IN_USE, &device->flags);
501 spin_unlock_irqrestore(get_ccwdev_lock(device->cdev), flags);
503 dasd_kfree_request(cqr, device);
507 * SECTION: the device operations
511 * On the one side we need a lock to access our internal buffer, on the
512 * other side a copy_to_user can sleep. So we need to copy the data we have
513 * to transfer in a readbuffer, which is protected by the readbuffer_mutex.
515 static char readbuffer[PAGE_SIZE];
516 static DECLARE_MUTEX(readbuffer_mutex);
518 static int dasd_eer_open(struct inode *inp, struct file *filp)
520 struct eerbuffer *eerb;
523 eerb = kzalloc(sizeof(struct eerbuffer), GFP_KERNEL);
526 eerb->buffer_page_count = eer_pages;
527 if (eerb->buffer_page_count < 1 ||
528 eerb->buffer_page_count > INT_MAX / PAGE_SIZE) {
530 MESSAGE(KERN_WARNING, "can't open device since module "
531 "parameter eer_pages is smaller then 1 or"
532 " bigger then %d", (int)(INT_MAX / PAGE_SIZE));
535 eerb->buffersize = eerb->buffer_page_count * PAGE_SIZE;
536 eerb->buffer = kmalloc(eerb->buffer_page_count * sizeof(char *),
542 if (dasd_eer_allocate_buffer_pages(eerb->buffer,
543 eerb->buffer_page_count)) {
548 filp->private_data = eerb;
549 spin_lock_irqsave(&bufferlock, flags);
550 list_add(&eerb->list, &bufferlist);
551 spin_unlock_irqrestore(&bufferlock, flags);
553 return nonseekable_open(inp,filp);
556 static int dasd_eer_close(struct inode *inp, struct file *filp)
558 struct eerbuffer *eerb;
561 eerb = (struct eerbuffer *) filp->private_data;
562 spin_lock_irqsave(&bufferlock, flags);
563 list_del(&eerb->list);
564 spin_unlock_irqrestore(&bufferlock, flags);
565 dasd_eer_free_buffer_pages(eerb->buffer, eerb->buffer_page_count);
572 static ssize_t dasd_eer_read(struct file *filp, char __user *buf,
573 size_t count, loff_t *ppos)
576 int tailcount,effective_count;
578 struct eerbuffer *eerb;
580 eerb = (struct eerbuffer *) filp->private_data;
581 if (down_interruptible(&readbuffer_mutex))
584 spin_lock_irqsave(&bufferlock, flags);
586 if (eerb->residual < 0) { /* the remainder of this record */
587 /* has been deleted */
589 spin_unlock_irqrestore(&bufferlock, flags);
590 up(&readbuffer_mutex);
592 } else if (eerb->residual > 0) {
593 /* OK we still have a second half of a record to deliver */
594 effective_count = min(eerb->residual, (int) count);
595 eerb->residual -= effective_count;
599 tc = dasd_eer_read_buffer(eerb, (char *) &tailcount,
602 /* no data available */
603 spin_unlock_irqrestore(&bufferlock, flags);
604 up(&readbuffer_mutex);
605 if (filp->f_flags & O_NONBLOCK)
607 rc = wait_event_interruptible(
608 dasd_eer_read_wait_queue,
609 eerb->head != eerb->tail);
612 if (down_interruptible(&readbuffer_mutex))
614 spin_lock_irqsave(&bufferlock, flags);
617 WARN_ON(tc != sizeof(tailcount));
618 effective_count = min(tailcount,(int)count);
619 eerb->residual = tailcount - effective_count;
622 tc = dasd_eer_read_buffer(eerb, readbuffer, effective_count);
623 WARN_ON(tc != effective_count);
625 spin_unlock_irqrestore(&bufferlock, flags);
627 if (copy_to_user(buf, readbuffer, effective_count)) {
628 up(&readbuffer_mutex);
632 up(&readbuffer_mutex);
633 return effective_count;
636 static unsigned int dasd_eer_poll(struct file *filp, poll_table *ptable)
640 struct eerbuffer *eerb;
642 eerb = (struct eerbuffer *) filp->private_data;
643 poll_wait(filp, &dasd_eer_read_wait_queue, ptable);
644 spin_lock_irqsave(&bufferlock, flags);
645 if (eerb->head != eerb->tail)
646 mask = POLLIN | POLLRDNORM ;
649 spin_unlock_irqrestore(&bufferlock, flags);
653 static struct file_operations dasd_eer_fops = {
654 .open = &dasd_eer_open,
655 .release = &dasd_eer_close,
656 .read = &dasd_eer_read,
657 .poll = &dasd_eer_poll,
658 .owner = THIS_MODULE,
661 static struct miscdevice dasd_eer_dev = {
662 .minor = MISC_DYNAMIC_MINOR,
664 .fops = &dasd_eer_fops,
667 int __init dasd_eer_init(void)
671 rc = misc_register(&dasd_eer_dev);
673 MESSAGE(KERN_ERR, "%s", "dasd_eer_init could not "
674 "register misc device");
681 void __exit dasd_eer_exit(void)
683 WARN_ON(misc_deregister(&dasd_eer_dev) != 0);