Loading...
1/*
2 * History:
3 * Started: Aug 9 by Lawrence Foard (entropy@world.std.com),
4 * to allow user process control of SCSI devices.
5 * Development Sponsored by Killy Corp. NY NY
6 *
7 * Original driver (sg.c):
8 * Copyright (C) 1992 Lawrence Foard
9 * Version 2 and 3 extensions to driver:
10 * Copyright (C) 1998 - 2005 Douglas Gilbert
11 *
12 * Modified 19-JAN-1998 Richard Gooch <rgooch@atnf.csiro.au> Devfs support
13 *
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
17 * any later version.
18 *
19 */
20
21static int sg_version_num = 30534; /* 2 digits for each component */
22#define SG_VERSION_STR "3.5.34"
23
24/*
25 * D. P. Gilbert (dgilbert@interlog.com, dougg@triode.net.au), notes:
26 * - scsi logging is available via SCSI_LOG_TIMEOUT macros. First
27 * the kernel/module needs to be built with CONFIG_SCSI_LOGGING
28 * (otherwise the macros compile to empty statements).
29 *
30 */
31#include <linux/module.h>
32
33#include <linux/fs.h>
34#include <linux/kernel.h>
35#include <linux/sched.h>
36#include <linux/string.h>
37#include <linux/mm.h>
38#include <linux/errno.h>
39#include <linux/mtio.h>
40#include <linux/ioctl.h>
41#include <linux/slab.h>
42#include <linux/fcntl.h>
43#include <linux/init.h>
44#include <linux/poll.h>
45#include <linux/moduleparam.h>
46#include <linux/cdev.h>
47#include <linux/idr.h>
48#include <linux/seq_file.h>
49#include <linux/blkdev.h>
50#include <linux/delay.h>
51#include <linux/blktrace_api.h>
52#include <linux/mutex.h>
53#include <linux/ratelimit.h>
54
55#include "scsi.h"
56#include <scsi/scsi_dbg.h>
57#include <scsi/scsi_host.h>
58#include <scsi/scsi_driver.h>
59#include <scsi/scsi_ioctl.h>
60#include <scsi/sg.h>
61
62#include "scsi_logging.h"
63
64#ifdef CONFIG_SCSI_PROC_FS
65#include <linux/proc_fs.h>
66static char *sg_version_date = "20061027";
67
68static int sg_proc_init(void);
69static void sg_proc_cleanup(void);
70#endif
71
72#define SG_ALLOW_DIO_DEF 0
73
74#define SG_MAX_DEVS 32768
75
76/*
77 * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
78 * Then when using 32 bit integers x * m may overflow during the calculation.
79 * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
80 * calculates the same, but prevents the overflow when both m and d
81 * are "small" numbers (like HZ and USER_HZ).
82 * Of course an overflow is inavoidable if the result of muldiv doesn't fit
83 * in 32 bits.
84 */
85#define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))
86
87#define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
88
89int sg_big_buff = SG_DEF_RESERVED_SIZE;
90/* N.B. This variable is readable and writeable via
91 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
92 of this size (or less if there is not enough memory) will be reserved
93 for use by this file descriptor. [Deprecated usage: this variable is also
94 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
95 the kernel (i.e. it is not a module).] */
96static int def_reserved_size = -1; /* picks up init parameter */
97static int sg_allow_dio = SG_ALLOW_DIO_DEF;
98
99static int scatter_elem_sz = SG_SCATTER_SZ;
100static int scatter_elem_sz_prev = SG_SCATTER_SZ;
101
102#define SG_SECTOR_SZ 512
103
104static int sg_add(struct device *, struct class_interface *);
105static void sg_remove(struct device *, struct class_interface *);
106
107static DEFINE_SPINLOCK(sg_open_exclusive_lock);
108
109static DEFINE_IDR(sg_index_idr);
110static DEFINE_RWLOCK(sg_index_lock); /* Also used to lock
111 file descriptor list for device */
112
113static struct class_interface sg_interface = {
114 .add_dev = sg_add,
115 .remove_dev = sg_remove,
116};
117
118typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
119 unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
120 unsigned sglist_len; /* size of malloc'd scatter-gather list ++ */
121 unsigned bufflen; /* Size of (aggregate) data buffer */
122 struct page **pages;
123 int page_order;
124 char dio_in_use; /* 0->indirect IO (or mmap), 1->dio */
125 unsigned char cmd_opcode; /* first byte of command */
126} Sg_scatter_hold;
127
128struct sg_device; /* forward declarations */
129struct sg_fd;
130
131typedef struct sg_request { /* SG_MAX_QUEUE requests outstanding per file */
132 struct sg_request *nextrp; /* NULL -> tail request (slist) */
133 struct sg_fd *parentfp; /* NULL -> not in use */
134 Sg_scatter_hold data; /* hold buffer, perhaps scatter list */
135 sg_io_hdr_t header; /* scsi command+info, see <scsi/sg.h> */
136 unsigned char sense_b[SCSI_SENSE_BUFFERSIZE];
137 char res_used; /* 1 -> using reserve buffer, 0 -> not ... */
138 char orphan; /* 1 -> drop on sight, 0 -> normal */
139 char sg_io_owned; /* 1 -> packet belongs to SG_IO */
140 /* done protected by rq_list_lock */
141 char done; /* 0->before bh, 1->before read, 2->read */
142 struct request *rq;
143 struct bio *bio;
144 struct execute_work ew;
145} Sg_request;
146
147typedef struct sg_fd { /* holds the state of a file descriptor */
148 /* sfd_siblings is protected by sg_index_lock */
149 struct list_head sfd_siblings;
150 struct sg_device *parentdp; /* owning device */
151 wait_queue_head_t read_wait; /* queue read until command done */
152 rwlock_t rq_list_lock; /* protect access to list in req_arr */
153 int timeout; /* defaults to SG_DEFAULT_TIMEOUT */
154 int timeout_user; /* defaults to SG_DEFAULT_TIMEOUT_USER */
155 Sg_scatter_hold reserve; /* buffer held for this file descriptor */
156 unsigned save_scat_len; /* original length of trunc. scat. element */
157 Sg_request *headrp; /* head of request slist, NULL->empty */
158 struct fasync_struct *async_qp; /* used by asynchronous notification */
159 Sg_request req_arr[SG_MAX_QUEUE]; /* used as singly-linked list */
160 char low_dma; /* as in parent but possibly overridden to 1 */
161 char force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
162 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
163 char next_cmd_len; /* 0 -> automatic (def), >0 -> use on next write() */
164 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
165 char mmap_called; /* 0 -> mmap() never called on this fd */
166 struct kref f_ref;
167 struct execute_work ew;
168} Sg_fd;
169
170typedef struct sg_device { /* holds the state of each scsi generic device */
171 struct scsi_device *device;
172 wait_queue_head_t o_excl_wait; /* queue open() when O_EXCL in use */
173 int sg_tablesize; /* adapter's max scatter-gather table size */
174 u32 index; /* device index number */
175 /* sfds is protected by sg_index_lock */
176 struct list_head sfds;
177 volatile char detached; /* 0->attached, 1->detached pending removal */
178 /* exclude protected by sg_open_exclusive_lock */
179 char exclude; /* opened for exclusive access */
180 char sgdebug; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
181 struct gendisk *disk;
182 struct cdev * cdev; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
183 struct kref d_ref;
184} Sg_device;
185
186/* tasklet or soft irq callback */
187static void sg_rq_end_io(struct request *rq, int uptodate);
188static int sg_start_req(Sg_request *srp, unsigned char *cmd);
189static int sg_finish_rem_req(Sg_request * srp);
190static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
191static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
192 Sg_request * srp);
193static ssize_t sg_new_write(Sg_fd *sfp, struct file *file,
194 const char __user *buf, size_t count, int blocking,
195 int read_only, int sg_io_owned, Sg_request **o_srp);
196static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
197 unsigned char *cmnd, int timeout, int blocking);
198static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
199static void sg_remove_scat(Sg_scatter_hold * schp);
200static void sg_build_reserve(Sg_fd * sfp, int req_size);
201static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
202static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
203static Sg_fd *sg_add_sfp(Sg_device * sdp, int dev);
204static void sg_remove_sfp(struct kref *);
205static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
206static Sg_request *sg_add_request(Sg_fd * sfp);
207static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
208static int sg_res_in_use(Sg_fd * sfp);
209static Sg_device *sg_get_dev(int dev);
210static void sg_put_dev(Sg_device *sdp);
211
212#define SZ_SG_HEADER sizeof(struct sg_header)
213#define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
214#define SZ_SG_IOVEC sizeof(sg_iovec_t)
215#define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
216
217static int sg_allow_access(struct file *filp, unsigned char *cmd)
218{
219 struct sg_fd *sfp = filp->private_data;
220
221 if (sfp->parentdp->device->type == TYPE_SCANNER)
222 return 0;
223
224 return blk_verify_command(cmd, filp->f_mode & FMODE_WRITE);
225}
226
227static int get_exclude(Sg_device *sdp)
228{
229 unsigned long flags;
230 int ret;
231
232 spin_lock_irqsave(&sg_open_exclusive_lock, flags);
233 ret = sdp->exclude;
234 spin_unlock_irqrestore(&sg_open_exclusive_lock, flags);
235 return ret;
236}
237
238static int set_exclude(Sg_device *sdp, char val)
239{
240 unsigned long flags;
241
242 spin_lock_irqsave(&sg_open_exclusive_lock, flags);
243 sdp->exclude = val;
244 spin_unlock_irqrestore(&sg_open_exclusive_lock, flags);
245 return val;
246}
247
248static int sfds_list_empty(Sg_device *sdp)
249{
250 unsigned long flags;
251 int ret;
252
253 read_lock_irqsave(&sg_index_lock, flags);
254 ret = list_empty(&sdp->sfds);
255 read_unlock_irqrestore(&sg_index_lock, flags);
256 return ret;
257}
258
259static int
260sg_open(struct inode *inode, struct file *filp)
261{
262 int dev = iminor(inode);
263 int flags = filp->f_flags;
264 struct request_queue *q;
265 Sg_device *sdp;
266 Sg_fd *sfp;
267 int res;
268 int retval;
269
270 nonseekable_open(inode, filp);
271 SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev, flags));
272 sdp = sg_get_dev(dev);
273 if (IS_ERR(sdp)) {
274 retval = PTR_ERR(sdp);
275 sdp = NULL;
276 goto sg_put;
277 }
278
279 /* This driver's module count bumped by fops_get in <linux/fs.h> */
280 /* Prevent the device driver from vanishing while we sleep */
281 retval = scsi_device_get(sdp->device);
282 if (retval)
283 goto sg_put;
284
285 retval = scsi_autopm_get_device(sdp->device);
286 if (retval)
287 goto sdp_put;
288
289 if (!((flags & O_NONBLOCK) ||
290 scsi_block_when_processing_errors(sdp->device))) {
291 retval = -ENXIO;
292 /* we are in error recovery for this device */
293 goto error_out;
294 }
295
296 if (flags & O_EXCL) {
297 if (O_RDONLY == (flags & O_ACCMODE)) {
298 retval = -EPERM; /* Can't lock it with read only access */
299 goto error_out;
300 }
301 if (!sfds_list_empty(sdp) && (flags & O_NONBLOCK)) {
302 retval = -EBUSY;
303 goto error_out;
304 }
305 res = wait_event_interruptible(sdp->o_excl_wait,
306 ((!sfds_list_empty(sdp) || get_exclude(sdp)) ? 0 : set_exclude(sdp, 1)));
307 if (res) {
308 retval = res; /* -ERESTARTSYS because signal hit process */
309 goto error_out;
310 }
311 } else if (get_exclude(sdp)) { /* some other fd has an exclusive lock on dev */
312 if (flags & O_NONBLOCK) {
313 retval = -EBUSY;
314 goto error_out;
315 }
316 res = wait_event_interruptible(sdp->o_excl_wait, !get_exclude(sdp));
317 if (res) {
318 retval = res; /* -ERESTARTSYS because signal hit process */
319 goto error_out;
320 }
321 }
322 if (sdp->detached) {
323 retval = -ENODEV;
324 goto error_out;
325 }
326 if (sfds_list_empty(sdp)) { /* no existing opens on this device */
327 sdp->sgdebug = 0;
328 q = sdp->device->request_queue;
329 sdp->sg_tablesize = queue_max_segments(q);
330 }
331 if ((sfp = sg_add_sfp(sdp, dev)))
332 filp->private_data = sfp;
333 else {
334 if (flags & O_EXCL) {
335 set_exclude(sdp, 0); /* undo if error */
336 wake_up_interruptible(&sdp->o_excl_wait);
337 }
338 retval = -ENOMEM;
339 goto error_out;
340 }
341 retval = 0;
342error_out:
343 if (retval) {
344 scsi_autopm_put_device(sdp->device);
345sdp_put:
346 scsi_device_put(sdp->device);
347 }
348sg_put:
349 if (sdp)
350 sg_put_dev(sdp);
351 return retval;
352}
353
354/* Following function was formerly called 'sg_close' */
355static int
356sg_release(struct inode *inode, struct file *filp)
357{
358 Sg_device *sdp;
359 Sg_fd *sfp;
360
361 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
362 return -ENXIO;
363 SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp->disk->disk_name));
364
365 set_exclude(sdp, 0);
366 wake_up_interruptible(&sdp->o_excl_wait);
367
368 scsi_autopm_put_device(sdp->device);
369 kref_put(&sfp->f_ref, sg_remove_sfp);
370 return 0;
371}
372
373static ssize_t
374sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
375{
376 Sg_device *sdp;
377 Sg_fd *sfp;
378 Sg_request *srp;
379 int req_pack_id = -1;
380 sg_io_hdr_t *hp;
381 struct sg_header *old_hdr = NULL;
382 int retval = 0;
383
384 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
385 return -ENXIO;
386 SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
387 sdp->disk->disk_name, (int) count));
388
389 if (!access_ok(VERIFY_WRITE, buf, count))
390 return -EFAULT;
391 if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
392 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
393 if (!old_hdr)
394 return -ENOMEM;
395 if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
396 retval = -EFAULT;
397 goto free_old_hdr;
398 }
399 if (old_hdr->reply_len < 0) {
400 if (count >= SZ_SG_IO_HDR) {
401 sg_io_hdr_t *new_hdr;
402 new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
403 if (!new_hdr) {
404 retval = -ENOMEM;
405 goto free_old_hdr;
406 }
407 retval =__copy_from_user
408 (new_hdr, buf, SZ_SG_IO_HDR);
409 req_pack_id = new_hdr->pack_id;
410 kfree(new_hdr);
411 if (retval) {
412 retval = -EFAULT;
413 goto free_old_hdr;
414 }
415 }
416 } else
417 req_pack_id = old_hdr->pack_id;
418 }
419 srp = sg_get_rq_mark(sfp, req_pack_id);
420 if (!srp) { /* now wait on packet to arrive */
421 if (sdp->detached) {
422 retval = -ENODEV;
423 goto free_old_hdr;
424 }
425 if (filp->f_flags & O_NONBLOCK) {
426 retval = -EAGAIN;
427 goto free_old_hdr;
428 }
429 retval = wait_event_interruptible(sfp->read_wait,
430 (sdp->detached ||
431 (srp = sg_get_rq_mark(sfp, req_pack_id))));
432 if (sdp->detached) {
433 retval = -ENODEV;
434 goto free_old_hdr;
435 }
436 if (retval) {
437 /* -ERESTARTSYS as signal hit process */
438 goto free_old_hdr;
439 }
440 }
441 if (srp->header.interface_id != '\0') {
442 retval = sg_new_read(sfp, buf, count, srp);
443 goto free_old_hdr;
444 }
445
446 hp = &srp->header;
447 if (old_hdr == NULL) {
448 old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
449 if (! old_hdr) {
450 retval = -ENOMEM;
451 goto free_old_hdr;
452 }
453 }
454 memset(old_hdr, 0, SZ_SG_HEADER);
455 old_hdr->reply_len = (int) hp->timeout;
456 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
457 old_hdr->pack_id = hp->pack_id;
458 old_hdr->twelve_byte =
459 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
460 old_hdr->target_status = hp->masked_status;
461 old_hdr->host_status = hp->host_status;
462 old_hdr->driver_status = hp->driver_status;
463 if ((CHECK_CONDITION & hp->masked_status) ||
464 (DRIVER_SENSE & hp->driver_status))
465 memcpy(old_hdr->sense_buffer, srp->sense_b,
466 sizeof (old_hdr->sense_buffer));
467 switch (hp->host_status) {
468 /* This setup of 'result' is for backward compatibility and is best
469 ignored by the user who should use target, host + driver status */
470 case DID_OK:
471 case DID_PASSTHROUGH:
472 case DID_SOFT_ERROR:
473 old_hdr->result = 0;
474 break;
475 case DID_NO_CONNECT:
476 case DID_BUS_BUSY:
477 case DID_TIME_OUT:
478 old_hdr->result = EBUSY;
479 break;
480 case DID_BAD_TARGET:
481 case DID_ABORT:
482 case DID_PARITY:
483 case DID_RESET:
484 case DID_BAD_INTR:
485 old_hdr->result = EIO;
486 break;
487 case DID_ERROR:
488 old_hdr->result = (srp->sense_b[0] == 0 &&
489 hp->masked_status == GOOD) ? 0 : EIO;
490 break;
491 default:
492 old_hdr->result = EIO;
493 break;
494 }
495
496 /* Now copy the result back to the user buffer. */
497 if (count >= SZ_SG_HEADER) {
498 if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
499 retval = -EFAULT;
500 goto free_old_hdr;
501 }
502 buf += SZ_SG_HEADER;
503 if (count > old_hdr->reply_len)
504 count = old_hdr->reply_len;
505 if (count > SZ_SG_HEADER) {
506 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
507 retval = -EFAULT;
508 goto free_old_hdr;
509 }
510 }
511 } else
512 count = (old_hdr->result == 0) ? 0 : -EIO;
513 sg_finish_rem_req(srp);
514 retval = count;
515free_old_hdr:
516 kfree(old_hdr);
517 return retval;
518}
519
520static ssize_t
521sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
522{
523 sg_io_hdr_t *hp = &srp->header;
524 int err = 0;
525 int len;
526
527 if (count < SZ_SG_IO_HDR) {
528 err = -EINVAL;
529 goto err_out;
530 }
531 hp->sb_len_wr = 0;
532 if ((hp->mx_sb_len > 0) && hp->sbp) {
533 if ((CHECK_CONDITION & hp->masked_status) ||
534 (DRIVER_SENSE & hp->driver_status)) {
535 int sb_len = SCSI_SENSE_BUFFERSIZE;
536 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
537 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
538 len = (len > sb_len) ? sb_len : len;
539 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
540 err = -EFAULT;
541 goto err_out;
542 }
543 hp->sb_len_wr = len;
544 }
545 }
546 if (hp->masked_status || hp->host_status || hp->driver_status)
547 hp->info |= SG_INFO_CHECK;
548 if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
549 err = -EFAULT;
550 goto err_out;
551 }
552err_out:
553 err = sg_finish_rem_req(srp);
554 return (0 == err) ? count : err;
555}
556
557static ssize_t
558sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
559{
560 int mxsize, cmd_size, k;
561 int input_size, blocking;
562 unsigned char opcode;
563 Sg_device *sdp;
564 Sg_fd *sfp;
565 Sg_request *srp;
566 struct sg_header old_hdr;
567 sg_io_hdr_t *hp;
568 unsigned char cmnd[MAX_COMMAND_SIZE];
569
570 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
571 return -ENXIO;
572 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
573 sdp->disk->disk_name, (int) count));
574 if (sdp->detached)
575 return -ENODEV;
576 if (!((filp->f_flags & O_NONBLOCK) ||
577 scsi_block_when_processing_errors(sdp->device)))
578 return -ENXIO;
579
580 if (!access_ok(VERIFY_READ, buf, count))
581 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
582 if (count < SZ_SG_HEADER)
583 return -EIO;
584 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
585 return -EFAULT;
586 blocking = !(filp->f_flags & O_NONBLOCK);
587 if (old_hdr.reply_len < 0)
588 return sg_new_write(sfp, filp, buf, count,
589 blocking, 0, 0, NULL);
590 if (count < (SZ_SG_HEADER + 6))
591 return -EIO; /* The minimum scsi command length is 6 bytes. */
592
593 if (!(srp = sg_add_request(sfp))) {
594 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
595 return -EDOM;
596 }
597 buf += SZ_SG_HEADER;
598 __get_user(opcode, buf);
599 if (sfp->next_cmd_len > 0) {
600 if (sfp->next_cmd_len > MAX_COMMAND_SIZE) {
601 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
602 sfp->next_cmd_len = 0;
603 sg_remove_request(sfp, srp);
604 return -EIO;
605 }
606 cmd_size = sfp->next_cmd_len;
607 sfp->next_cmd_len = 0; /* reset so only this write() effected */
608 } else {
609 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
610 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
611 cmd_size = 12;
612 }
613 SCSI_LOG_TIMEOUT(4, printk(
614 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
615/* Determine buffer size. */
616 input_size = count - cmd_size;
617 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
618 mxsize -= SZ_SG_HEADER;
619 input_size -= SZ_SG_HEADER;
620 if (input_size < 0) {
621 sg_remove_request(sfp, srp);
622 return -EIO; /* User did not pass enough bytes for this command. */
623 }
624 hp = &srp->header;
625 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
626 hp->cmd_len = (unsigned char) cmd_size;
627 hp->iovec_count = 0;
628 hp->mx_sb_len = 0;
629 if (input_size > 0)
630 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
631 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
632 else
633 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
634 hp->dxfer_len = mxsize;
635 if (hp->dxfer_direction == SG_DXFER_TO_DEV)
636 hp->dxferp = (char __user *)buf + cmd_size;
637 else
638 hp->dxferp = NULL;
639 hp->sbp = NULL;
640 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
641 hp->flags = input_size; /* structure abuse ... */
642 hp->pack_id = old_hdr.pack_id;
643 hp->usr_ptr = NULL;
644 if (__copy_from_user(cmnd, buf, cmd_size))
645 return -EFAULT;
646 /*
647 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
648 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
649 * is a non-zero input_size, so emit a warning.
650 */
651 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV) {
652 static char cmd[TASK_COMM_LEN];
653 if (strcmp(current->comm, cmd)) {
654 printk_ratelimited(KERN_WARNING
655 "sg_write: data in/out %d/%d bytes "
656 "for SCSI command 0x%x-- guessing "
657 "data in;\n program %s not setting "
658 "count and/or reply_len properly\n",
659 old_hdr.reply_len - (int)SZ_SG_HEADER,
660 input_size, (unsigned int) cmnd[0],
661 current->comm);
662 strcpy(cmd, current->comm);
663 }
664 }
665 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
666 return (k < 0) ? k : count;
667}
668
669static ssize_t
670sg_new_write(Sg_fd *sfp, struct file *file, const char __user *buf,
671 size_t count, int blocking, int read_only, int sg_io_owned,
672 Sg_request **o_srp)
673{
674 int k;
675 Sg_request *srp;
676 sg_io_hdr_t *hp;
677 unsigned char cmnd[MAX_COMMAND_SIZE];
678 int timeout;
679 unsigned long ul_timeout;
680
681 if (count < SZ_SG_IO_HDR)
682 return -EINVAL;
683 if (!access_ok(VERIFY_READ, buf, count))
684 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
685
686 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
687 if (!(srp = sg_add_request(sfp))) {
688 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
689 return -EDOM;
690 }
691 srp->sg_io_owned = sg_io_owned;
692 hp = &srp->header;
693 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
694 sg_remove_request(sfp, srp);
695 return -EFAULT;
696 }
697 if (hp->interface_id != 'S') {
698 sg_remove_request(sfp, srp);
699 return -ENOSYS;
700 }
701 if (hp->flags & SG_FLAG_MMAP_IO) {
702 if (hp->dxfer_len > sfp->reserve.bufflen) {
703 sg_remove_request(sfp, srp);
704 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
705 }
706 if (hp->flags & SG_FLAG_DIRECT_IO) {
707 sg_remove_request(sfp, srp);
708 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
709 }
710 if (sg_res_in_use(sfp)) {
711 sg_remove_request(sfp, srp);
712 return -EBUSY; /* reserve buffer already being used */
713 }
714 }
715 ul_timeout = msecs_to_jiffies(srp->header.timeout);
716 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
717 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
718 sg_remove_request(sfp, srp);
719 return -EMSGSIZE;
720 }
721 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
722 sg_remove_request(sfp, srp);
723 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
724 }
725 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
726 sg_remove_request(sfp, srp);
727 return -EFAULT;
728 }
729 if (read_only && sg_allow_access(file, cmnd)) {
730 sg_remove_request(sfp, srp);
731 return -EPERM;
732 }
733 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
734 if (k < 0)
735 return k;
736 if (o_srp)
737 *o_srp = srp;
738 return count;
739}
740
741static int
742sg_common_write(Sg_fd * sfp, Sg_request * srp,
743 unsigned char *cmnd, int timeout, int blocking)
744{
745 int k, data_dir;
746 Sg_device *sdp = sfp->parentdp;
747 sg_io_hdr_t *hp = &srp->header;
748
749 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
750 hp->status = 0;
751 hp->masked_status = 0;
752 hp->msg_status = 0;
753 hp->info = 0;
754 hp->host_status = 0;
755 hp->driver_status = 0;
756 hp->resid = 0;
757 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
758 (int) cmnd[0], (int) hp->cmd_len));
759
760 k = sg_start_req(srp, cmnd);
761 if (k) {
762 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: start_req err=%d\n", k));
763 sg_finish_rem_req(srp);
764 return k; /* probably out of space --> ENOMEM */
765 }
766 if (sdp->detached) {
767 if (srp->bio)
768 blk_end_request_all(srp->rq, -EIO);
769 sg_finish_rem_req(srp);
770 return -ENODEV;
771 }
772
773 switch (hp->dxfer_direction) {
774 case SG_DXFER_TO_FROM_DEV:
775 case SG_DXFER_FROM_DEV:
776 data_dir = DMA_FROM_DEVICE;
777 break;
778 case SG_DXFER_TO_DEV:
779 data_dir = DMA_TO_DEVICE;
780 break;
781 case SG_DXFER_UNKNOWN:
782 data_dir = DMA_BIDIRECTIONAL;
783 break;
784 default:
785 data_dir = DMA_NONE;
786 break;
787 }
788 hp->duration = jiffies_to_msecs(jiffies);
789
790 srp->rq->timeout = timeout;
791 kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
792 blk_execute_rq_nowait(sdp->device->request_queue, sdp->disk,
793 srp->rq, 1, sg_rq_end_io);
794 return 0;
795}
796
797static int srp_done(Sg_fd *sfp, Sg_request *srp)
798{
799 unsigned long flags;
800 int ret;
801
802 read_lock_irqsave(&sfp->rq_list_lock, flags);
803 ret = srp->done;
804 read_unlock_irqrestore(&sfp->rq_list_lock, flags);
805 return ret;
806}
807
808static long
809sg_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
810{
811 void __user *p = (void __user *)arg;
812 int __user *ip = p;
813 int result, val, read_only;
814 Sg_device *sdp;
815 Sg_fd *sfp;
816 Sg_request *srp;
817 unsigned long iflags;
818
819 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
820 return -ENXIO;
821
822 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
823 sdp->disk->disk_name, (int) cmd_in));
824 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
825
826 switch (cmd_in) {
827 case SG_IO:
828 if (sdp->detached)
829 return -ENODEV;
830 if (!scsi_block_when_processing_errors(sdp->device))
831 return -ENXIO;
832 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
833 return -EFAULT;
834 result = sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
835 1, read_only, 1, &srp);
836 if (result < 0)
837 return result;
838 result = wait_event_interruptible(sfp->read_wait,
839 (srp_done(sfp, srp) || sdp->detached));
840 if (sdp->detached)
841 return -ENODEV;
842 write_lock_irq(&sfp->rq_list_lock);
843 if (srp->done) {
844 srp->done = 2;
845 write_unlock_irq(&sfp->rq_list_lock);
846 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
847 return (result < 0) ? result : 0;
848 }
849 srp->orphan = 1;
850 write_unlock_irq(&sfp->rq_list_lock);
851 return result; /* -ERESTARTSYS because signal hit process */
852 case SG_SET_TIMEOUT:
853 result = get_user(val, ip);
854 if (result)
855 return result;
856 if (val < 0)
857 return -EIO;
858 if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
859 val = MULDIV (INT_MAX, USER_HZ, HZ);
860 sfp->timeout_user = val;
861 sfp->timeout = MULDIV (val, HZ, USER_HZ);
862
863 return 0;
864 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
865 /* strange ..., for backward compatibility */
866 return sfp->timeout_user;
867 case SG_SET_FORCE_LOW_DMA:
868 result = get_user(val, ip);
869 if (result)
870 return result;
871 if (val) {
872 sfp->low_dma = 1;
873 if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
874 val = (int) sfp->reserve.bufflen;
875 sg_remove_scat(&sfp->reserve);
876 sg_build_reserve(sfp, val);
877 }
878 } else {
879 if (sdp->detached)
880 return -ENODEV;
881 sfp->low_dma = sdp->device->host->unchecked_isa_dma;
882 }
883 return 0;
884 case SG_GET_LOW_DMA:
885 return put_user((int) sfp->low_dma, ip);
886 case SG_GET_SCSI_ID:
887 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
888 return -EFAULT;
889 else {
890 sg_scsi_id_t __user *sg_idp = p;
891
892 if (sdp->detached)
893 return -ENODEV;
894 __put_user((int) sdp->device->host->host_no,
895 &sg_idp->host_no);
896 __put_user((int) sdp->device->channel,
897 &sg_idp->channel);
898 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
899 __put_user((int) sdp->device->lun, &sg_idp->lun);
900 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
901 __put_user((short) sdp->device->host->cmd_per_lun,
902 &sg_idp->h_cmd_per_lun);
903 __put_user((short) sdp->device->queue_depth,
904 &sg_idp->d_queue_depth);
905 __put_user(0, &sg_idp->unused[0]);
906 __put_user(0, &sg_idp->unused[1]);
907 return 0;
908 }
909 case SG_SET_FORCE_PACK_ID:
910 result = get_user(val, ip);
911 if (result)
912 return result;
913 sfp->force_packid = val ? 1 : 0;
914 return 0;
915 case SG_GET_PACK_ID:
916 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
917 return -EFAULT;
918 read_lock_irqsave(&sfp->rq_list_lock, iflags);
919 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
920 if ((1 == srp->done) && (!srp->sg_io_owned)) {
921 read_unlock_irqrestore(&sfp->rq_list_lock,
922 iflags);
923 __put_user(srp->header.pack_id, ip);
924 return 0;
925 }
926 }
927 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
928 __put_user(-1, ip);
929 return 0;
930 case SG_GET_NUM_WAITING:
931 read_lock_irqsave(&sfp->rq_list_lock, iflags);
932 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
933 if ((1 == srp->done) && (!srp->sg_io_owned))
934 ++val;
935 }
936 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
937 return put_user(val, ip);
938 case SG_GET_SG_TABLESIZE:
939 return put_user(sdp->sg_tablesize, ip);
940 case SG_SET_RESERVED_SIZE:
941 result = get_user(val, ip);
942 if (result)
943 return result;
944 if (val < 0)
945 return -EINVAL;
946 val = min_t(int, val,
947 queue_max_sectors(sdp->device->request_queue) * 512);
948 if (val != sfp->reserve.bufflen) {
949 if (sg_res_in_use(sfp) || sfp->mmap_called)
950 return -EBUSY;
951 sg_remove_scat(&sfp->reserve);
952 sg_build_reserve(sfp, val);
953 }
954 return 0;
955 case SG_GET_RESERVED_SIZE:
956 val = min_t(int, sfp->reserve.bufflen,
957 queue_max_sectors(sdp->device->request_queue) * 512);
958 return put_user(val, ip);
959 case SG_SET_COMMAND_Q:
960 result = get_user(val, ip);
961 if (result)
962 return result;
963 sfp->cmd_q = val ? 1 : 0;
964 return 0;
965 case SG_GET_COMMAND_Q:
966 return put_user((int) sfp->cmd_q, ip);
967 case SG_SET_KEEP_ORPHAN:
968 result = get_user(val, ip);
969 if (result)
970 return result;
971 sfp->keep_orphan = val;
972 return 0;
973 case SG_GET_KEEP_ORPHAN:
974 return put_user((int) sfp->keep_orphan, ip);
975 case SG_NEXT_CMD_LEN:
976 result = get_user(val, ip);
977 if (result)
978 return result;
979 sfp->next_cmd_len = (val > 0) ? val : 0;
980 return 0;
981 case SG_GET_VERSION_NUM:
982 return put_user(sg_version_num, ip);
983 case SG_GET_ACCESS_COUNT:
984 /* faked - we don't have a real access count anymore */
985 val = (sdp->device ? 1 : 0);
986 return put_user(val, ip);
987 case SG_GET_REQUEST_TABLE:
988 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
989 return -EFAULT;
990 else {
991 sg_req_info_t *rinfo;
992 unsigned int ms;
993
994 rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
995 GFP_KERNEL);
996 if (!rinfo)
997 return -ENOMEM;
998 read_lock_irqsave(&sfp->rq_list_lock, iflags);
999 for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
1000 ++val, srp = srp ? srp->nextrp : srp) {
1001 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
1002 if (srp) {
1003 rinfo[val].req_state = srp->done + 1;
1004 rinfo[val].problem =
1005 srp->header.masked_status &
1006 srp->header.host_status &
1007 srp->header.driver_status;
1008 if (srp->done)
1009 rinfo[val].duration =
1010 srp->header.duration;
1011 else {
1012 ms = jiffies_to_msecs(jiffies);
1013 rinfo[val].duration =
1014 (ms > srp->header.duration) ?
1015 (ms - srp->header.duration) : 0;
1016 }
1017 rinfo[val].orphan = srp->orphan;
1018 rinfo[val].sg_io_owned =
1019 srp->sg_io_owned;
1020 rinfo[val].pack_id =
1021 srp->header.pack_id;
1022 rinfo[val].usr_ptr =
1023 srp->header.usr_ptr;
1024 }
1025 }
1026 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1027 result = __copy_to_user(p, rinfo,
1028 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1029 result = result ? -EFAULT : 0;
1030 kfree(rinfo);
1031 return result;
1032 }
1033 case SG_EMULATED_HOST:
1034 if (sdp->detached)
1035 return -ENODEV;
1036 return put_user(sdp->device->host->hostt->emulated, ip);
1037 case SG_SCSI_RESET:
1038 if (sdp->detached)
1039 return -ENODEV;
1040 if (filp->f_flags & O_NONBLOCK) {
1041 if (scsi_host_in_recovery(sdp->device->host))
1042 return -EBUSY;
1043 } else if (!scsi_block_when_processing_errors(sdp->device))
1044 return -EBUSY;
1045 result = get_user(val, ip);
1046 if (result)
1047 return result;
1048 if (SG_SCSI_RESET_NOTHING == val)
1049 return 0;
1050 switch (val) {
1051 case SG_SCSI_RESET_DEVICE:
1052 val = SCSI_TRY_RESET_DEVICE;
1053 break;
1054 case SG_SCSI_RESET_TARGET:
1055 val = SCSI_TRY_RESET_TARGET;
1056 break;
1057 case SG_SCSI_RESET_BUS:
1058 val = SCSI_TRY_RESET_BUS;
1059 break;
1060 case SG_SCSI_RESET_HOST:
1061 val = SCSI_TRY_RESET_HOST;
1062 break;
1063 default:
1064 return -EINVAL;
1065 }
1066 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1067 return -EACCES;
1068 return (scsi_reset_provider(sdp->device, val) ==
1069 SUCCESS) ? 0 : -EIO;
1070 case SCSI_IOCTL_SEND_COMMAND:
1071 if (sdp->detached)
1072 return -ENODEV;
1073 if (read_only) {
1074 unsigned char opcode = WRITE_6;
1075 Scsi_Ioctl_Command __user *siocp = p;
1076
1077 if (copy_from_user(&opcode, siocp->data, 1))
1078 return -EFAULT;
1079 if (sg_allow_access(filp, &opcode))
1080 return -EPERM;
1081 }
1082 return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
1083 case SG_SET_DEBUG:
1084 result = get_user(val, ip);
1085 if (result)
1086 return result;
1087 sdp->sgdebug = (char) val;
1088 return 0;
1089 case SCSI_IOCTL_GET_IDLUN:
1090 case SCSI_IOCTL_GET_BUS_NUMBER:
1091 case SCSI_IOCTL_PROBE_HOST:
1092 case SG_GET_TRANSFORM:
1093 if (sdp->detached)
1094 return -ENODEV;
1095 return scsi_ioctl(sdp->device, cmd_in, p);
1096 case BLKSECTGET:
1097 return put_user(queue_max_sectors(sdp->device->request_queue) * 512,
1098 ip);
1099 case BLKTRACESETUP:
1100 return blk_trace_setup(sdp->device->request_queue,
1101 sdp->disk->disk_name,
1102 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
1103 NULL,
1104 (char *)arg);
1105 case BLKTRACESTART:
1106 return blk_trace_startstop(sdp->device->request_queue, 1);
1107 case BLKTRACESTOP:
1108 return blk_trace_startstop(sdp->device->request_queue, 0);
1109 case BLKTRACETEARDOWN:
1110 return blk_trace_remove(sdp->device->request_queue);
1111 default:
1112 if (read_only)
1113 return -EPERM; /* don't know so take safe approach */
1114 return scsi_ioctl(sdp->device, cmd_in, p);
1115 }
1116}
1117
1118#ifdef CONFIG_COMPAT
1119static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1120{
1121 Sg_device *sdp;
1122 Sg_fd *sfp;
1123 struct scsi_device *sdev;
1124
1125 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1126 return -ENXIO;
1127
1128 sdev = sdp->device;
1129 if (sdev->host->hostt->compat_ioctl) {
1130 int ret;
1131
1132 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1133
1134 return ret;
1135 }
1136
1137 return -ENOIOCTLCMD;
1138}
1139#endif
1140
1141static unsigned int
1142sg_poll(struct file *filp, poll_table * wait)
1143{
1144 unsigned int res = 0;
1145 Sg_device *sdp;
1146 Sg_fd *sfp;
1147 Sg_request *srp;
1148 int count = 0;
1149 unsigned long iflags;
1150
1151 sfp = filp->private_data;
1152 if (!sfp)
1153 return POLLERR;
1154 sdp = sfp->parentdp;
1155 if (!sdp)
1156 return POLLERR;
1157 poll_wait(filp, &sfp->read_wait, wait);
1158 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1159 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1160 /* if any read waiting, flag it */
1161 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1162 res = POLLIN | POLLRDNORM;
1163 ++count;
1164 }
1165 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1166
1167 if (sdp->detached)
1168 res |= POLLHUP;
1169 else if (!sfp->cmd_q) {
1170 if (0 == count)
1171 res |= POLLOUT | POLLWRNORM;
1172 } else if (count < SG_MAX_QUEUE)
1173 res |= POLLOUT | POLLWRNORM;
1174 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1175 sdp->disk->disk_name, (int) res));
1176 return res;
1177}
1178
1179static int
1180sg_fasync(int fd, struct file *filp, int mode)
1181{
1182 Sg_device *sdp;
1183 Sg_fd *sfp;
1184
1185 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1186 return -ENXIO;
1187 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1188 sdp->disk->disk_name, mode));
1189
1190 return fasync_helper(fd, filp, mode, &sfp->async_qp);
1191}
1192
1193static int
1194sg_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
1195{
1196 Sg_fd *sfp;
1197 unsigned long offset, len, sa;
1198 Sg_scatter_hold *rsv_schp;
1199 int k, length;
1200
1201 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
1202 return VM_FAULT_SIGBUS;
1203 rsv_schp = &sfp->reserve;
1204 offset = vmf->pgoff << PAGE_SHIFT;
1205 if (offset >= rsv_schp->bufflen)
1206 return VM_FAULT_SIGBUS;
1207 SCSI_LOG_TIMEOUT(3, printk("sg_vma_fault: offset=%lu, scatg=%d\n",
1208 offset, rsv_schp->k_use_sg));
1209 sa = vma->vm_start;
1210 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1211 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1212 len = vma->vm_end - sa;
1213 len = (len < length) ? len : length;
1214 if (offset < len) {
1215 struct page *page = nth_page(rsv_schp->pages[k],
1216 offset >> PAGE_SHIFT);
1217 get_page(page); /* increment page count */
1218 vmf->page = page;
1219 return 0; /* success */
1220 }
1221 sa += len;
1222 offset -= len;
1223 }
1224
1225 return VM_FAULT_SIGBUS;
1226}
1227
1228static const struct vm_operations_struct sg_mmap_vm_ops = {
1229 .fault = sg_vma_fault,
1230};
1231
1232static int
1233sg_mmap(struct file *filp, struct vm_area_struct *vma)
1234{
1235 Sg_fd *sfp;
1236 unsigned long req_sz, len, sa;
1237 Sg_scatter_hold *rsv_schp;
1238 int k, length;
1239
1240 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1241 return -ENXIO;
1242 req_sz = vma->vm_end - vma->vm_start;
1243 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1244 (void *) vma->vm_start, (int) req_sz));
1245 if (vma->vm_pgoff)
1246 return -EINVAL; /* want no offset */
1247 rsv_schp = &sfp->reserve;
1248 if (req_sz > rsv_schp->bufflen)
1249 return -ENOMEM; /* cannot map more than reserved buffer */
1250
1251 sa = vma->vm_start;
1252 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1253 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1254 len = vma->vm_end - sa;
1255 len = (len < length) ? len : length;
1256 sa += len;
1257 }
1258
1259 sfp->mmap_called = 1;
1260 vma->vm_flags |= VM_RESERVED;
1261 vma->vm_private_data = sfp;
1262 vma->vm_ops = &sg_mmap_vm_ops;
1263 return 0;
1264}
1265
1266static void sg_rq_end_io_usercontext(struct work_struct *work)
1267{
1268 struct sg_request *srp = container_of(work, struct sg_request, ew.work);
1269 struct sg_fd *sfp = srp->parentfp;
1270
1271 sg_finish_rem_req(srp);
1272 kref_put(&sfp->f_ref, sg_remove_sfp);
1273}
1274
1275/*
1276 * This function is a "bottom half" handler that is called by the mid
1277 * level when a command is completed (or has failed).
1278 */
1279static void sg_rq_end_io(struct request *rq, int uptodate)
1280{
1281 struct sg_request *srp = rq->end_io_data;
1282 Sg_device *sdp;
1283 Sg_fd *sfp;
1284 unsigned long iflags;
1285 unsigned int ms;
1286 char *sense;
1287 int result, resid, done = 1;
1288
1289 if (WARN_ON(srp->done != 0))
1290 return;
1291
1292 sfp = srp->parentfp;
1293 if (WARN_ON(sfp == NULL))
1294 return;
1295
1296 sdp = sfp->parentdp;
1297 if (unlikely(sdp->detached))
1298 printk(KERN_INFO "sg_rq_end_io: device detached\n");
1299
1300 sense = rq->sense;
1301 result = rq->errors;
1302 resid = rq->resid_len;
1303
1304 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
1305 sdp->disk->disk_name, srp->header.pack_id, result));
1306 srp->header.resid = resid;
1307 ms = jiffies_to_msecs(jiffies);
1308 srp->header.duration = (ms > srp->header.duration) ?
1309 (ms - srp->header.duration) : 0;
1310 if (0 != result) {
1311 struct scsi_sense_hdr sshdr;
1312
1313 srp->header.status = 0xff & result;
1314 srp->header.masked_status = status_byte(result);
1315 srp->header.msg_status = msg_byte(result);
1316 srp->header.host_status = host_byte(result);
1317 srp->header.driver_status = driver_byte(result);
1318 if ((sdp->sgdebug > 0) &&
1319 ((CHECK_CONDITION == srp->header.masked_status) ||
1320 (COMMAND_TERMINATED == srp->header.masked_status)))
1321 __scsi_print_sense("sg_cmd_done", sense,
1322 SCSI_SENSE_BUFFERSIZE);
1323
1324 /* Following if statement is a patch supplied by Eric Youngdale */
1325 if (driver_byte(result) != 0
1326 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
1327 && !scsi_sense_is_deferred(&sshdr)
1328 && sshdr.sense_key == UNIT_ATTENTION
1329 && sdp->device->removable) {
1330 /* Detected possible disc change. Set the bit - this */
1331 /* may be used if there are filesystems using this device */
1332 sdp->device->changed = 1;
1333 }
1334 }
1335 /* Rely on write phase to clean out srp status values, so no "else" */
1336
1337 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1338 if (unlikely(srp->orphan)) {
1339 if (sfp->keep_orphan)
1340 srp->sg_io_owned = 0;
1341 else
1342 done = 0;
1343 }
1344 srp->done = done;
1345 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1346
1347 if (likely(done)) {
1348 /* Now wake up any sg_read() that is waiting for this
1349 * packet.
1350 */
1351 wake_up_interruptible(&sfp->read_wait);
1352 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
1353 kref_put(&sfp->f_ref, sg_remove_sfp);
1354 } else {
1355 INIT_WORK(&srp->ew.work, sg_rq_end_io_usercontext);
1356 schedule_work(&srp->ew.work);
1357 }
1358}
1359
1360static const struct file_operations sg_fops = {
1361 .owner = THIS_MODULE,
1362 .read = sg_read,
1363 .write = sg_write,
1364 .poll = sg_poll,
1365 .unlocked_ioctl = sg_ioctl,
1366#ifdef CONFIG_COMPAT
1367 .compat_ioctl = sg_compat_ioctl,
1368#endif
1369 .open = sg_open,
1370 .mmap = sg_mmap,
1371 .release = sg_release,
1372 .fasync = sg_fasync,
1373 .llseek = no_llseek,
1374};
1375
1376static struct class *sg_sysfs_class;
1377
1378static int sg_sysfs_valid = 0;
1379
1380static Sg_device *sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
1381{
1382 struct request_queue *q = scsidp->request_queue;
1383 Sg_device *sdp;
1384 unsigned long iflags;
1385 int error;
1386 u32 k;
1387
1388 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
1389 if (!sdp) {
1390 printk(KERN_WARNING "kmalloc Sg_device failure\n");
1391 return ERR_PTR(-ENOMEM);
1392 }
1393
1394 if (!idr_pre_get(&sg_index_idr, GFP_KERNEL)) {
1395 printk(KERN_WARNING "idr expansion Sg_device failure\n");
1396 error = -ENOMEM;
1397 goto out;
1398 }
1399
1400 write_lock_irqsave(&sg_index_lock, iflags);
1401
1402 error = idr_get_new(&sg_index_idr, sdp, &k);
1403 if (error) {
1404 write_unlock_irqrestore(&sg_index_lock, iflags);
1405 printk(KERN_WARNING "idr allocation Sg_device failure: %d\n",
1406 error);
1407 goto out;
1408 }
1409
1410 if (unlikely(k >= SG_MAX_DEVS))
1411 goto overflow;
1412
1413 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k));
1414 sprintf(disk->disk_name, "sg%d", k);
1415 disk->first_minor = k;
1416 sdp->disk = disk;
1417 sdp->device = scsidp;
1418 INIT_LIST_HEAD(&sdp->sfds);
1419 init_waitqueue_head(&sdp->o_excl_wait);
1420 sdp->sg_tablesize = queue_max_segments(q);
1421 sdp->index = k;
1422 kref_init(&sdp->d_ref);
1423
1424 write_unlock_irqrestore(&sg_index_lock, iflags);
1425
1426 error = 0;
1427 out:
1428 if (error) {
1429 kfree(sdp);
1430 return ERR_PTR(error);
1431 }
1432 return sdp;
1433
1434 overflow:
1435 idr_remove(&sg_index_idr, k);
1436 write_unlock_irqrestore(&sg_index_lock, iflags);
1437 sdev_printk(KERN_WARNING, scsidp,
1438 "Unable to attach sg device type=%d, minor "
1439 "number exceeds %d\n", scsidp->type, SG_MAX_DEVS - 1);
1440 error = -ENODEV;
1441 goto out;
1442}
1443
1444static int
1445sg_add(struct device *cl_dev, struct class_interface *cl_intf)
1446{
1447 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1448 struct gendisk *disk;
1449 Sg_device *sdp = NULL;
1450 struct cdev * cdev = NULL;
1451 int error;
1452 unsigned long iflags;
1453
1454 disk = alloc_disk(1);
1455 if (!disk) {
1456 printk(KERN_WARNING "alloc_disk failed\n");
1457 return -ENOMEM;
1458 }
1459 disk->major = SCSI_GENERIC_MAJOR;
1460
1461 error = -ENOMEM;
1462 cdev = cdev_alloc();
1463 if (!cdev) {
1464 printk(KERN_WARNING "cdev_alloc failed\n");
1465 goto out;
1466 }
1467 cdev->owner = THIS_MODULE;
1468 cdev->ops = &sg_fops;
1469
1470 sdp = sg_alloc(disk, scsidp);
1471 if (IS_ERR(sdp)) {
1472 printk(KERN_WARNING "sg_alloc failed\n");
1473 error = PTR_ERR(sdp);
1474 goto out;
1475 }
1476
1477 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
1478 if (error)
1479 goto cdev_add_err;
1480
1481 sdp->cdev = cdev;
1482 if (sg_sysfs_valid) {
1483 struct device *sg_class_member;
1484
1485 sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
1486 MKDEV(SCSI_GENERIC_MAJOR,
1487 sdp->index),
1488 sdp, "%s", disk->disk_name);
1489 if (IS_ERR(sg_class_member)) {
1490 printk(KERN_ERR "sg_add: "
1491 "device_create failed\n");
1492 error = PTR_ERR(sg_class_member);
1493 goto cdev_add_err;
1494 }
1495 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1496 &sg_class_member->kobj, "generic");
1497 if (error)
1498 printk(KERN_ERR "sg_add: unable to make symlink "
1499 "'generic' back to sg%d\n", sdp->index);
1500 } else
1501 printk(KERN_WARNING "sg_add: sg_sys Invalid\n");
1502
1503 sdev_printk(KERN_NOTICE, scsidp,
1504 "Attached scsi generic sg%d type %d\n", sdp->index,
1505 scsidp->type);
1506
1507 dev_set_drvdata(cl_dev, sdp);
1508
1509 return 0;
1510
1511cdev_add_err:
1512 write_lock_irqsave(&sg_index_lock, iflags);
1513 idr_remove(&sg_index_idr, sdp->index);
1514 write_unlock_irqrestore(&sg_index_lock, iflags);
1515 kfree(sdp);
1516
1517out:
1518 put_disk(disk);
1519 if (cdev)
1520 cdev_del(cdev);
1521 return error;
1522}
1523
1524static void sg_device_destroy(struct kref *kref)
1525{
1526 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1527 unsigned long flags;
1528
1529 /* CAUTION! Note that the device can still be found via idr_find()
1530 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1531 * any other cleanup.
1532 */
1533
1534 write_lock_irqsave(&sg_index_lock, flags);
1535 idr_remove(&sg_index_idr, sdp->index);
1536 write_unlock_irqrestore(&sg_index_lock, flags);
1537
1538 SCSI_LOG_TIMEOUT(3,
1539 printk("sg_device_destroy: %s\n",
1540 sdp->disk->disk_name));
1541
1542 put_disk(sdp->disk);
1543 kfree(sdp);
1544}
1545
1546static void sg_remove(struct device *cl_dev, struct class_interface *cl_intf)
1547{
1548 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1549 Sg_device *sdp = dev_get_drvdata(cl_dev);
1550 unsigned long iflags;
1551 Sg_fd *sfp;
1552
1553 if (!sdp || sdp->detached)
1554 return;
1555
1556 SCSI_LOG_TIMEOUT(3, printk("sg_remove: %s\n", sdp->disk->disk_name));
1557
1558 /* Need a write lock to set sdp->detached. */
1559 write_lock_irqsave(&sg_index_lock, iflags);
1560 sdp->detached = 1;
1561 list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
1562 wake_up_interruptible(&sfp->read_wait);
1563 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
1564 }
1565 write_unlock_irqrestore(&sg_index_lock, iflags);
1566
1567 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
1568 device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
1569 cdev_del(sdp->cdev);
1570 sdp->cdev = NULL;
1571
1572 sg_put_dev(sdp);
1573}
1574
1575module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1576module_param_named(def_reserved_size, def_reserved_size, int,
1577 S_IRUGO | S_IWUSR);
1578module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1579
1580MODULE_AUTHOR("Douglas Gilbert");
1581MODULE_DESCRIPTION("SCSI generic (sg) driver");
1582MODULE_LICENSE("GPL");
1583MODULE_VERSION(SG_VERSION_STR);
1584MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
1585
1586MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1587 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1588MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1589MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1590
1591static int __init
1592init_sg(void)
1593{
1594 int rc;
1595
1596 if (scatter_elem_sz < PAGE_SIZE) {
1597 scatter_elem_sz = PAGE_SIZE;
1598 scatter_elem_sz_prev = scatter_elem_sz;
1599 }
1600 if (def_reserved_size >= 0)
1601 sg_big_buff = def_reserved_size;
1602 else
1603 def_reserved_size = sg_big_buff;
1604
1605 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1606 SG_MAX_DEVS, "sg");
1607 if (rc)
1608 return rc;
1609 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
1610 if ( IS_ERR(sg_sysfs_class) ) {
1611 rc = PTR_ERR(sg_sysfs_class);
1612 goto err_out;
1613 }
1614 sg_sysfs_valid = 1;
1615 rc = scsi_register_interface(&sg_interface);
1616 if (0 == rc) {
1617#ifdef CONFIG_SCSI_PROC_FS
1618 sg_proc_init();
1619#endif /* CONFIG_SCSI_PROC_FS */
1620 return 0;
1621 }
1622 class_destroy(sg_sysfs_class);
1623err_out:
1624 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1625 return rc;
1626}
1627
1628static void __exit
1629exit_sg(void)
1630{
1631#ifdef CONFIG_SCSI_PROC_FS
1632 sg_proc_cleanup();
1633#endif /* CONFIG_SCSI_PROC_FS */
1634 scsi_unregister_interface(&sg_interface);
1635 class_destroy(sg_sysfs_class);
1636 sg_sysfs_valid = 0;
1637 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1638 SG_MAX_DEVS);
1639 idr_destroy(&sg_index_idr);
1640}
1641
1642static int sg_start_req(Sg_request *srp, unsigned char *cmd)
1643{
1644 int res;
1645 struct request *rq;
1646 Sg_fd *sfp = srp->parentfp;
1647 sg_io_hdr_t *hp = &srp->header;
1648 int dxfer_len = (int) hp->dxfer_len;
1649 int dxfer_dir = hp->dxfer_direction;
1650 unsigned int iov_count = hp->iovec_count;
1651 Sg_scatter_hold *req_schp = &srp->data;
1652 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1653 struct request_queue *q = sfp->parentdp->device->request_queue;
1654 struct rq_map_data *md, map_data;
1655 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;
1656
1657 SCSI_LOG_TIMEOUT(4, printk(KERN_INFO "sg_start_req: dxfer_len=%d\n",
1658 dxfer_len));
1659
1660 rq = blk_get_request(q, rw, GFP_ATOMIC);
1661 if (!rq)
1662 return -ENOMEM;
1663
1664 memcpy(rq->cmd, cmd, hp->cmd_len);
1665
1666 rq->cmd_len = hp->cmd_len;
1667 rq->cmd_type = REQ_TYPE_BLOCK_PC;
1668
1669 srp->rq = rq;
1670 rq->end_io_data = srp;
1671 rq->sense = srp->sense_b;
1672 rq->retries = SG_DEFAULT_RETRIES;
1673
1674 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1675 return 0;
1676
1677 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1678 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1679 !sfp->parentdp->device->host->unchecked_isa_dma &&
1680 blk_rq_aligned(q, (unsigned long)hp->dxferp, dxfer_len))
1681 md = NULL;
1682 else
1683 md = &map_data;
1684
1685 if (md) {
1686 if (!sg_res_in_use(sfp) && dxfer_len <= rsv_schp->bufflen)
1687 sg_link_reserve(sfp, srp, dxfer_len);
1688 else {
1689 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1690 if (res)
1691 return res;
1692 }
1693
1694 md->pages = req_schp->pages;
1695 md->page_order = req_schp->page_order;
1696 md->nr_entries = req_schp->k_use_sg;
1697 md->offset = 0;
1698 md->null_mapped = hp->dxferp ? 0 : 1;
1699 if (dxfer_dir == SG_DXFER_TO_FROM_DEV)
1700 md->from_user = 1;
1701 else
1702 md->from_user = 0;
1703 }
1704
1705 if (iov_count) {
1706 int len, size = sizeof(struct sg_iovec) * iov_count;
1707 struct iovec *iov;
1708
1709 iov = memdup_user(hp->dxferp, size);
1710 if (IS_ERR(iov))
1711 return PTR_ERR(iov);
1712
1713 len = iov_length(iov, iov_count);
1714 if (hp->dxfer_len < len) {
1715 iov_count = iov_shorten(iov, iov_count, hp->dxfer_len);
1716 len = hp->dxfer_len;
1717 }
1718
1719 res = blk_rq_map_user_iov(q, rq, md, (struct sg_iovec *)iov,
1720 iov_count,
1721 len, GFP_ATOMIC);
1722 kfree(iov);
1723 } else
1724 res = blk_rq_map_user(q, rq, md, hp->dxferp,
1725 hp->dxfer_len, GFP_ATOMIC);
1726
1727 if (!res) {
1728 srp->bio = rq->bio;
1729
1730 if (!md) {
1731 req_schp->dio_in_use = 1;
1732 hp->info |= SG_INFO_DIRECT_IO;
1733 }
1734 }
1735 return res;
1736}
1737
1738static int sg_finish_rem_req(Sg_request * srp)
1739{
1740 int ret = 0;
1741
1742 Sg_fd *sfp = srp->parentfp;
1743 Sg_scatter_hold *req_schp = &srp->data;
1744
1745 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp->res_used));
1746 if (srp->rq) {
1747 if (srp->bio)
1748 ret = blk_rq_unmap_user(srp->bio);
1749
1750 blk_put_request(srp->rq);
1751 }
1752
1753 if (srp->res_used)
1754 sg_unlink_reserve(sfp, srp);
1755 else
1756 sg_remove_scat(req_schp);
1757
1758 sg_remove_request(sfp, srp);
1759
1760 return ret;
1761}
1762
1763static int
1764sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1765{
1766 int sg_bufflen = tablesize * sizeof(struct page *);
1767 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
1768
1769 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1770 if (!schp->pages)
1771 return -ENOMEM;
1772 schp->sglist_len = sg_bufflen;
1773 return tablesize; /* number of scat_gath elements allocated */
1774}
1775
1776static int
1777sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1778{
1779 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
1780 int sg_tablesize = sfp->parentdp->sg_tablesize;
1781 int blk_size = buff_size, order;
1782 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
1783
1784 if (blk_size < 0)
1785 return -EFAULT;
1786 if (0 == blk_size)
1787 ++blk_size; /* don't know why */
1788 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1789 blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
1790 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1791 buff_size, blk_size));
1792
1793 /* N.B. ret_sz carried into this block ... */
1794 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1795 if (mx_sc_elems < 0)
1796 return mx_sc_elems; /* most likely -ENOMEM */
1797
1798 num = scatter_elem_sz;
1799 if (unlikely(num != scatter_elem_sz_prev)) {
1800 if (num < PAGE_SIZE) {
1801 scatter_elem_sz = PAGE_SIZE;
1802 scatter_elem_sz_prev = PAGE_SIZE;
1803 } else
1804 scatter_elem_sz_prev = num;
1805 }
1806
1807 if (sfp->low_dma)
1808 gfp_mask |= GFP_DMA;
1809
1810 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1811 gfp_mask |= __GFP_ZERO;
1812
1813 order = get_order(num);
1814retry:
1815 ret_sz = 1 << (PAGE_SHIFT + order);
1816
1817 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1818 k++, rem_sz -= ret_sz) {
1819
1820 num = (rem_sz > scatter_elem_sz_prev) ?
1821 scatter_elem_sz_prev : rem_sz;
1822
1823 schp->pages[k] = alloc_pages(gfp_mask, order);
1824 if (!schp->pages[k])
1825 goto out;
1826
1827 if (num == scatter_elem_sz_prev) {
1828 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1829 scatter_elem_sz = ret_sz;
1830 scatter_elem_sz_prev = ret_sz;
1831 }
1832 }
1833
1834 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k=%d, num=%d, "
1835 "ret_sz=%d\n", k, num, ret_sz));
1836 } /* end of for loop */
1837
1838 schp->page_order = order;
1839 schp->k_use_sg = k;
1840 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, "
1841 "rem_sz=%d\n", k, rem_sz));
1842
1843 schp->bufflen = blk_size;
1844 if (rem_sz > 0) /* must have failed */
1845 return -ENOMEM;
1846 return 0;
1847out:
1848 for (i = 0; i < k; i++)
1849 __free_pages(schp->pages[i], order);
1850
1851 if (--order >= 0)
1852 goto retry;
1853
1854 return -ENOMEM;
1855}
1856
1857static void
1858sg_remove_scat(Sg_scatter_hold * schp)
1859{
1860 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
1861 if (schp->pages && schp->sglist_len > 0) {
1862 if (!schp->dio_in_use) {
1863 int k;
1864
1865 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1866 SCSI_LOG_TIMEOUT(5, printk(
1867 "sg_remove_scat: k=%d, pg=0x%p\n",
1868 k, schp->pages[k]));
1869 __free_pages(schp->pages[k], schp->page_order);
1870 }
1871
1872 kfree(schp->pages);
1873 }
1874 }
1875 memset(schp, 0, sizeof (*schp));
1876}
1877
1878static int
1879sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1880{
1881 Sg_scatter_hold *schp = &srp->data;
1882 int k, num;
1883
1884 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
1885 num_read_xfer));
1886 if ((!outp) || (num_read_xfer <= 0))
1887 return 0;
1888
1889 num = 1 << (PAGE_SHIFT + schp->page_order);
1890 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1891 if (num > num_read_xfer) {
1892 if (__copy_to_user(outp, page_address(schp->pages[k]),
1893 num_read_xfer))
1894 return -EFAULT;
1895 break;
1896 } else {
1897 if (__copy_to_user(outp, page_address(schp->pages[k]),
1898 num))
1899 return -EFAULT;
1900 num_read_xfer -= num;
1901 if (num_read_xfer <= 0)
1902 break;
1903 outp += num;
1904 }
1905 }
1906
1907 return 0;
1908}
1909
1910static void
1911sg_build_reserve(Sg_fd * sfp, int req_size)
1912{
1913 Sg_scatter_hold *schp = &sfp->reserve;
1914
1915 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size));
1916 do {
1917 if (req_size < PAGE_SIZE)
1918 req_size = PAGE_SIZE;
1919 if (0 == sg_build_indirect(schp, sfp, req_size))
1920 return;
1921 else
1922 sg_remove_scat(schp);
1923 req_size >>= 1; /* divide by 2 */
1924 } while (req_size > (PAGE_SIZE / 2));
1925}
1926
1927static void
1928sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
1929{
1930 Sg_scatter_hold *req_schp = &srp->data;
1931 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1932 int k, num, rem;
1933
1934 srp->res_used = 1;
1935 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size));
1936 rem = size;
1937
1938 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1939 for (k = 0; k < rsv_schp->k_use_sg; k++) {
1940 if (rem <= num) {
1941 req_schp->k_use_sg = k + 1;
1942 req_schp->sglist_len = rsv_schp->sglist_len;
1943 req_schp->pages = rsv_schp->pages;
1944
1945 req_schp->bufflen = size;
1946 req_schp->page_order = rsv_schp->page_order;
1947 break;
1948 } else
1949 rem -= num;
1950 }
1951
1952 if (k >= rsv_schp->k_use_sg)
1953 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
1954}
1955
1956static void
1957sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
1958{
1959 Sg_scatter_hold *req_schp = &srp->data;
1960
1961 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
1962 (int) req_schp->k_use_sg));
1963 req_schp->k_use_sg = 0;
1964 req_schp->bufflen = 0;
1965 req_schp->pages = NULL;
1966 req_schp->page_order = 0;
1967 req_schp->sglist_len = 0;
1968 sfp->save_scat_len = 0;
1969 srp->res_used = 0;
1970}
1971
1972static Sg_request *
1973sg_get_rq_mark(Sg_fd * sfp, int pack_id)
1974{
1975 Sg_request *resp;
1976 unsigned long iflags;
1977
1978 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1979 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
1980 /* look for requests that are ready + not SG_IO owned */
1981 if ((1 == resp->done) && (!resp->sg_io_owned) &&
1982 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
1983 resp->done = 2; /* guard against other readers */
1984 break;
1985 }
1986 }
1987 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1988 return resp;
1989}
1990
1991/* always adds to end of list */
1992static Sg_request *
1993sg_add_request(Sg_fd * sfp)
1994{
1995 int k;
1996 unsigned long iflags;
1997 Sg_request *resp;
1998 Sg_request *rp = sfp->req_arr;
1999
2000 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2001 resp = sfp->headrp;
2002 if (!resp) {
2003 memset(rp, 0, sizeof (Sg_request));
2004 rp->parentfp = sfp;
2005 resp = rp;
2006 sfp->headrp = resp;
2007 } else {
2008 if (0 == sfp->cmd_q)
2009 resp = NULL; /* command queuing disallowed */
2010 else {
2011 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2012 if (!rp->parentfp)
2013 break;
2014 }
2015 if (k < SG_MAX_QUEUE) {
2016 memset(rp, 0, sizeof (Sg_request));
2017 rp->parentfp = sfp;
2018 while (resp->nextrp)
2019 resp = resp->nextrp;
2020 resp->nextrp = rp;
2021 resp = rp;
2022 } else
2023 resp = NULL;
2024 }
2025 }
2026 if (resp) {
2027 resp->nextrp = NULL;
2028 resp->header.duration = jiffies_to_msecs(jiffies);
2029 }
2030 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2031 return resp;
2032}
2033
2034/* Return of 1 for found; 0 for not found */
2035static int
2036sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2037{
2038 Sg_request *prev_rp;
2039 Sg_request *rp;
2040 unsigned long iflags;
2041 int res = 0;
2042
2043 if ((!sfp) || (!srp) || (!sfp->headrp))
2044 return res;
2045 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2046 prev_rp = sfp->headrp;
2047 if (srp == prev_rp) {
2048 sfp->headrp = prev_rp->nextrp;
2049 prev_rp->parentfp = NULL;
2050 res = 1;
2051 } else {
2052 while ((rp = prev_rp->nextrp)) {
2053 if (srp == rp) {
2054 prev_rp->nextrp = rp->nextrp;
2055 rp->parentfp = NULL;
2056 res = 1;
2057 break;
2058 }
2059 prev_rp = rp;
2060 }
2061 }
2062 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2063 return res;
2064}
2065
2066static Sg_fd *
2067sg_add_sfp(Sg_device * sdp, int dev)
2068{
2069 Sg_fd *sfp;
2070 unsigned long iflags;
2071 int bufflen;
2072
2073 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
2074 if (!sfp)
2075 return NULL;
2076
2077 init_waitqueue_head(&sfp->read_wait);
2078 rwlock_init(&sfp->rq_list_lock);
2079
2080 kref_init(&sfp->f_ref);
2081 sfp->timeout = SG_DEFAULT_TIMEOUT;
2082 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2083 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2084 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2085 sdp->device->host->unchecked_isa_dma : 1;
2086 sfp->cmd_q = SG_DEF_COMMAND_Q;
2087 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2088 sfp->parentdp = sdp;
2089 write_lock_irqsave(&sg_index_lock, iflags);
2090 list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
2091 write_unlock_irqrestore(&sg_index_lock, iflags);
2092 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp));
2093 if (unlikely(sg_big_buff != def_reserved_size))
2094 sg_big_buff = def_reserved_size;
2095
2096 bufflen = min_t(int, sg_big_buff,
2097 queue_max_sectors(sdp->device->request_queue) * 512);
2098 sg_build_reserve(sfp, bufflen);
2099 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2100 sfp->reserve.bufflen, sfp->reserve.k_use_sg));
2101
2102 kref_get(&sdp->d_ref);
2103 __module_get(THIS_MODULE);
2104 return sfp;
2105}
2106
2107static void sg_remove_sfp_usercontext(struct work_struct *work)
2108{
2109 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2110 struct sg_device *sdp = sfp->parentdp;
2111
2112 /* Cleanup any responses which were never read(). */
2113 while (sfp->headrp)
2114 sg_finish_rem_req(sfp->headrp);
2115
2116 if (sfp->reserve.bufflen > 0) {
2117 SCSI_LOG_TIMEOUT(6,
2118 printk("sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2119 (int) sfp->reserve.bufflen,
2120 (int) sfp->reserve.k_use_sg));
2121 sg_remove_scat(&sfp->reserve);
2122 }
2123
2124 SCSI_LOG_TIMEOUT(6,
2125 printk("sg_remove_sfp: %s, sfp=0x%p\n",
2126 sdp->disk->disk_name,
2127 sfp));
2128 kfree(sfp);
2129
2130 scsi_device_put(sdp->device);
2131 sg_put_dev(sdp);
2132 module_put(THIS_MODULE);
2133}
2134
2135static void sg_remove_sfp(struct kref *kref)
2136{
2137 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
2138 struct sg_device *sdp = sfp->parentdp;
2139 unsigned long iflags;
2140
2141 write_lock_irqsave(&sg_index_lock, iflags);
2142 list_del(&sfp->sfd_siblings);
2143 write_unlock_irqrestore(&sg_index_lock, iflags);
2144 wake_up_interruptible(&sdp->o_excl_wait);
2145
2146 INIT_WORK(&sfp->ew.work, sg_remove_sfp_usercontext);
2147 schedule_work(&sfp->ew.work);
2148}
2149
2150static int
2151sg_res_in_use(Sg_fd * sfp)
2152{
2153 const Sg_request *srp;
2154 unsigned long iflags;
2155
2156 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2157 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2158 if (srp->res_used)
2159 break;
2160 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2161 return srp ? 1 : 0;
2162}
2163
2164#ifdef CONFIG_SCSI_PROC_FS
2165static int
2166sg_idr_max_id(int id, void *p, void *data)
2167{
2168 int *k = data;
2169
2170 if (*k < id)
2171 *k = id;
2172
2173 return 0;
2174}
2175
2176static int
2177sg_last_dev(void)
2178{
2179 int k = -1;
2180 unsigned long iflags;
2181
2182 read_lock_irqsave(&sg_index_lock, iflags);
2183 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2184 read_unlock_irqrestore(&sg_index_lock, iflags);
2185 return k + 1; /* origin 1 */
2186}
2187#endif
2188
2189/* must be called with sg_index_lock held */
2190static Sg_device *sg_lookup_dev(int dev)
2191{
2192 return idr_find(&sg_index_idr, dev);
2193}
2194
2195static Sg_device *sg_get_dev(int dev)
2196{
2197 struct sg_device *sdp;
2198 unsigned long flags;
2199
2200 read_lock_irqsave(&sg_index_lock, flags);
2201 sdp = sg_lookup_dev(dev);
2202 if (!sdp)
2203 sdp = ERR_PTR(-ENXIO);
2204 else if (sdp->detached) {
2205 /* If sdp->detached, then the refcount may already be 0, in
2206 * which case it would be a bug to do kref_get().
2207 */
2208 sdp = ERR_PTR(-ENODEV);
2209 } else
2210 kref_get(&sdp->d_ref);
2211 read_unlock_irqrestore(&sg_index_lock, flags);
2212
2213 return sdp;
2214}
2215
2216static void sg_put_dev(struct sg_device *sdp)
2217{
2218 kref_put(&sdp->d_ref, sg_device_destroy);
2219}
2220
2221#ifdef CONFIG_SCSI_PROC_FS
2222
2223static struct proc_dir_entry *sg_proc_sgp = NULL;
2224
2225static char sg_proc_sg_dirname[] = "scsi/sg";
2226
2227static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2228
2229static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2230static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2231 size_t count, loff_t *off);
2232static const struct file_operations adio_fops = {
2233 .owner = THIS_MODULE,
2234 .open = sg_proc_single_open_adio,
2235 .read = seq_read,
2236 .llseek = seq_lseek,
2237 .write = sg_proc_write_adio,
2238 .release = single_release,
2239};
2240
2241static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2242static ssize_t sg_proc_write_dressz(struct file *filp,
2243 const char __user *buffer, size_t count, loff_t *off);
2244static const struct file_operations dressz_fops = {
2245 .owner = THIS_MODULE,
2246 .open = sg_proc_single_open_dressz,
2247 .read = seq_read,
2248 .llseek = seq_lseek,
2249 .write = sg_proc_write_dressz,
2250 .release = single_release,
2251};
2252
2253static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2254static int sg_proc_single_open_version(struct inode *inode, struct file *file);
2255static const struct file_operations version_fops = {
2256 .owner = THIS_MODULE,
2257 .open = sg_proc_single_open_version,
2258 .read = seq_read,
2259 .llseek = seq_lseek,
2260 .release = single_release,
2261};
2262
2263static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2264static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
2265static const struct file_operations devhdr_fops = {
2266 .owner = THIS_MODULE,
2267 .open = sg_proc_single_open_devhdr,
2268 .read = seq_read,
2269 .llseek = seq_lseek,
2270 .release = single_release,
2271};
2272
2273static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2274static int sg_proc_open_dev(struct inode *inode, struct file *file);
2275static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2276static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2277static void dev_seq_stop(struct seq_file *s, void *v);
2278static const struct file_operations dev_fops = {
2279 .owner = THIS_MODULE,
2280 .open = sg_proc_open_dev,
2281 .read = seq_read,
2282 .llseek = seq_lseek,
2283 .release = seq_release,
2284};
2285static const struct seq_operations dev_seq_ops = {
2286 .start = dev_seq_start,
2287 .next = dev_seq_next,
2288 .stop = dev_seq_stop,
2289 .show = sg_proc_seq_show_dev,
2290};
2291
2292static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2293static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
2294static const struct file_operations devstrs_fops = {
2295 .owner = THIS_MODULE,
2296 .open = sg_proc_open_devstrs,
2297 .read = seq_read,
2298 .llseek = seq_lseek,
2299 .release = seq_release,
2300};
2301static const struct seq_operations devstrs_seq_ops = {
2302 .start = dev_seq_start,
2303 .next = dev_seq_next,
2304 .stop = dev_seq_stop,
2305 .show = sg_proc_seq_show_devstrs,
2306};
2307
2308static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2309static int sg_proc_open_debug(struct inode *inode, struct file *file);
2310static const struct file_operations debug_fops = {
2311 .owner = THIS_MODULE,
2312 .open = sg_proc_open_debug,
2313 .read = seq_read,
2314 .llseek = seq_lseek,
2315 .release = seq_release,
2316};
2317static const struct seq_operations debug_seq_ops = {
2318 .start = dev_seq_start,
2319 .next = dev_seq_next,
2320 .stop = dev_seq_stop,
2321 .show = sg_proc_seq_show_debug,
2322};
2323
2324
2325struct sg_proc_leaf {
2326 const char * name;
2327 const struct file_operations * fops;
2328};
2329
2330static const struct sg_proc_leaf sg_proc_leaf_arr[] = {
2331 {"allow_dio", &adio_fops},
2332 {"debug", &debug_fops},
2333 {"def_reserved_size", &dressz_fops},
2334 {"device_hdr", &devhdr_fops},
2335 {"devices", &dev_fops},
2336 {"device_strs", &devstrs_fops},
2337 {"version", &version_fops}
2338};
2339
2340static int
2341sg_proc_init(void)
2342{
2343 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2344 int k;
2345
2346 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
2347 if (!sg_proc_sgp)
2348 return 1;
2349 for (k = 0; k < num_leaves; ++k) {
2350 const struct sg_proc_leaf *leaf = &sg_proc_leaf_arr[k];
2351 umode_t mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
2352 proc_create(leaf->name, mask, sg_proc_sgp, leaf->fops);
2353 }
2354 return 0;
2355}
2356
2357static void
2358sg_proc_cleanup(void)
2359{
2360 int k;
2361 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
2362
2363 if (!sg_proc_sgp)
2364 return;
2365 for (k = 0; k < num_leaves; ++k)
2366 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2367 remove_proc_entry(sg_proc_sg_dirname, NULL);
2368}
2369
2370
2371static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2372{
2373 seq_printf(s, "%d\n", *((int *)s->private));
2374 return 0;
2375}
2376
2377static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2378{
2379 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2380}
2381
2382static ssize_t
2383sg_proc_write_adio(struct file *filp, const char __user *buffer,
2384 size_t count, loff_t *off)
2385{
2386 int err;
2387 unsigned long num;
2388
2389 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2390 return -EACCES;
2391 err = kstrtoul_from_user(buffer, count, 0, &num);
2392 if (err)
2393 return err;
2394 sg_allow_dio = num ? 1 : 0;
2395 return count;
2396}
2397
2398static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2399{
2400 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2401}
2402
2403static ssize_t
2404sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2405 size_t count, loff_t *off)
2406{
2407 int err;
2408 unsigned long k = ULONG_MAX;
2409
2410 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2411 return -EACCES;
2412
2413 err = kstrtoul_from_user(buffer, count, 0, &k);
2414 if (err)
2415 return err;
2416 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2417 sg_big_buff = k;
2418 return count;
2419 }
2420 return -ERANGE;
2421}
2422
2423static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2424{
2425 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2426 sg_version_date);
2427 return 0;
2428}
2429
2430static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2431{
2432 return single_open(file, sg_proc_seq_show_version, NULL);
2433}
2434
2435static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2436{
2437 seq_printf(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2438 "online\n");
2439 return 0;
2440}
2441
2442static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2443{
2444 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2445}
2446
2447struct sg_proc_deviter {
2448 loff_t index;
2449 size_t max;
2450};
2451
2452static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2453{
2454 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2455
2456 s->private = it;
2457 if (! it)
2458 return NULL;
2459
2460 it->index = *pos;
2461 it->max = sg_last_dev();
2462 if (it->index >= it->max)
2463 return NULL;
2464 return it;
2465}
2466
2467static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2468{
2469 struct sg_proc_deviter * it = s->private;
2470
2471 *pos = ++it->index;
2472 return (it->index < it->max) ? it : NULL;
2473}
2474
2475static void dev_seq_stop(struct seq_file *s, void *v)
2476{
2477 kfree(s->private);
2478}
2479
2480static int sg_proc_open_dev(struct inode *inode, struct file *file)
2481{
2482 return seq_open(file, &dev_seq_ops);
2483}
2484
2485static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2486{
2487 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2488 Sg_device *sdp;
2489 struct scsi_device *scsidp;
2490 unsigned long iflags;
2491
2492 read_lock_irqsave(&sg_index_lock, iflags);
2493 sdp = it ? sg_lookup_dev(it->index) : NULL;
2494 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2495 seq_printf(s, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2496 scsidp->host->host_no, scsidp->channel,
2497 scsidp->id, scsidp->lun, (int) scsidp->type,
2498 1,
2499 (int) scsidp->queue_depth,
2500 (int) scsidp->device_busy,
2501 (int) scsi_device_online(scsidp));
2502 else
2503 seq_printf(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2504 read_unlock_irqrestore(&sg_index_lock, iflags);
2505 return 0;
2506}
2507
2508static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2509{
2510 return seq_open(file, &devstrs_seq_ops);
2511}
2512
2513static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2514{
2515 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2516 Sg_device *sdp;
2517 struct scsi_device *scsidp;
2518 unsigned long iflags;
2519
2520 read_lock_irqsave(&sg_index_lock, iflags);
2521 sdp = it ? sg_lookup_dev(it->index) : NULL;
2522 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2523 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2524 scsidp->vendor, scsidp->model, scsidp->rev);
2525 else
2526 seq_printf(s, "<no active device>\n");
2527 read_unlock_irqrestore(&sg_index_lock, iflags);
2528 return 0;
2529}
2530
2531/* must be called while holding sg_index_lock */
2532static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2533{
2534 int k, m, new_interface, blen, usg;
2535 Sg_request *srp;
2536 Sg_fd *fp;
2537 const sg_io_hdr_t *hp;
2538 const char * cp;
2539 unsigned int ms;
2540
2541 k = 0;
2542 list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
2543 k++;
2544 read_lock(&fp->rq_list_lock); /* irqs already disabled */
2545 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
2546 "(res)sgat=%d low_dma=%d\n", k,
2547 jiffies_to_msecs(fp->timeout),
2548 fp->reserve.bufflen,
2549 (int) fp->reserve.k_use_sg,
2550 (int) fp->low_dma);
2551 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=0\n",
2552 (int) fp->cmd_q, (int) fp->force_packid,
2553 (int) fp->keep_orphan);
2554 for (m = 0, srp = fp->headrp;
2555 srp != NULL;
2556 ++m, srp = srp->nextrp) {
2557 hp = &srp->header;
2558 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2559 if (srp->res_used) {
2560 if (new_interface &&
2561 (SG_FLAG_MMAP_IO & hp->flags))
2562 cp = " mmap>> ";
2563 else
2564 cp = " rb>> ";
2565 } else {
2566 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2567 cp = " dio>> ";
2568 else
2569 cp = " ";
2570 }
2571 seq_printf(s, cp);
2572 blen = srp->data.bufflen;
2573 usg = srp->data.k_use_sg;
2574 seq_printf(s, srp->done ?
2575 ((1 == srp->done) ? "rcv:" : "fin:")
2576 : "act:");
2577 seq_printf(s, " id=%d blen=%d",
2578 srp->header.pack_id, blen);
2579 if (srp->done)
2580 seq_printf(s, " dur=%d", hp->duration);
2581 else {
2582 ms = jiffies_to_msecs(jiffies);
2583 seq_printf(s, " t_o/elap=%d/%d",
2584 (new_interface ? hp->timeout :
2585 jiffies_to_msecs(fp->timeout)),
2586 (ms > hp->duration ? ms - hp->duration : 0));
2587 }
2588 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2589 (int) srp->data.cmd_opcode);
2590 }
2591 if (0 == m)
2592 seq_printf(s, " No requests active\n");
2593 read_unlock(&fp->rq_list_lock);
2594 }
2595}
2596
2597static int sg_proc_open_debug(struct inode *inode, struct file *file)
2598{
2599 return seq_open(file, &debug_seq_ops);
2600}
2601
2602static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2603{
2604 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2605 Sg_device *sdp;
2606 unsigned long iflags;
2607
2608 if (it && (0 == it->index)) {
2609 seq_printf(s, "max_active_device=%d(origin 1)\n",
2610 (int)it->max);
2611 seq_printf(s, " def_reserved_size=%d\n", sg_big_buff);
2612 }
2613
2614 read_lock_irqsave(&sg_index_lock, iflags);
2615 sdp = it ? sg_lookup_dev(it->index) : NULL;
2616 if (sdp && !list_empty(&sdp->sfds)) {
2617 struct scsi_device *scsidp = sdp->device;
2618
2619 seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
2620 if (sdp->detached)
2621 seq_printf(s, "detached pending close ");
2622 else
2623 seq_printf
2624 (s, "scsi%d chan=%d id=%d lun=%d em=%d",
2625 scsidp->host->host_no,
2626 scsidp->channel, scsidp->id,
2627 scsidp->lun,
2628 scsidp->host->hostt->emulated);
2629 seq_printf(s, " sg_tablesize=%d excl=%d\n",
2630 sdp->sg_tablesize, get_exclude(sdp));
2631 sg_proc_debug_helper(s, sdp);
2632 }
2633 read_unlock_irqrestore(&sg_index_lock, iflags);
2634 return 0;
2635}
2636
2637#endif /* CONFIG_SCSI_PROC_FS */
2638
2639module_init(init_sg);
2640module_exit(exit_sg);
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * History:
4 * Started: Aug 9 by Lawrence Foard (entropy@world.std.com),
5 * to allow user process control of SCSI devices.
6 * Development Sponsored by Killy Corp. NY NY
7 *
8 * Original driver (sg.c):
9 * Copyright (C) 1992 Lawrence Foard
10 * Version 2 and 3 extensions to driver:
11 * Copyright (C) 1998 - 2014 Douglas Gilbert
12 */
13
14static int sg_version_num = 30536; /* 2 digits for each component */
15#define SG_VERSION_STR "3.5.36"
16
17/*
18 * D. P. Gilbert (dgilbert@interlog.com), notes:
19 * - scsi logging is available via SCSI_LOG_TIMEOUT macros. First
20 * the kernel/module needs to be built with CONFIG_SCSI_LOGGING
21 * (otherwise the macros compile to empty statements).
22 *
23 */
24#include <linux/module.h>
25
26#include <linux/fs.h>
27#include <linux/kernel.h>
28#include <linux/sched.h>
29#include <linux/string.h>
30#include <linux/mm.h>
31#include <linux/errno.h>
32#include <linux/mtio.h>
33#include <linux/ioctl.h>
34#include <linux/major.h>
35#include <linux/slab.h>
36#include <linux/fcntl.h>
37#include <linux/init.h>
38#include <linux/poll.h>
39#include <linux/moduleparam.h>
40#include <linux/cdev.h>
41#include <linux/idr.h>
42#include <linux/seq_file.h>
43#include <linux/blkdev.h>
44#include <linux/delay.h>
45#include <linux/blktrace_api.h>
46#include <linux/mutex.h>
47#include <linux/atomic.h>
48#include <linux/ratelimit.h>
49#include <linux/uio.h>
50#include <linux/cred.h> /* for sg_check_file_access() */
51
52#include <scsi/scsi.h>
53#include <scsi/scsi_cmnd.h>
54#include <scsi/scsi_dbg.h>
55#include <scsi/scsi_device.h>
56#include <scsi/scsi_driver.h>
57#include <scsi/scsi_eh.h>
58#include <scsi/scsi_host.h>
59#include <scsi/scsi_ioctl.h>
60#include <scsi/scsi_tcq.h>
61#include <scsi/sg.h>
62
63#include "scsi_logging.h"
64
65#ifdef CONFIG_SCSI_PROC_FS
66#include <linux/proc_fs.h>
67static char *sg_version_date = "20140603";
68
69static int sg_proc_init(void);
70#endif
71
72#define SG_ALLOW_DIO_DEF 0
73
74#define SG_MAX_DEVS (1 << MINORBITS)
75
76/* SG_MAX_CDB_SIZE should be 260 (spc4r37 section 3.1.30) however the type
77 * of sg_io_hdr::cmd_len can only represent 255. All SCSI commands greater
78 * than 16 bytes are "variable length" whose length is a multiple of 4
79 */
80#define SG_MAX_CDB_SIZE 252
81
82#define SG_DEFAULT_TIMEOUT mult_frac(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)
83
84static int sg_big_buff = SG_DEF_RESERVED_SIZE;
85/* N.B. This variable is readable and writeable via
86 /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
87 of this size (or less if there is not enough memory) will be reserved
88 for use by this file descriptor. [Deprecated usage: this variable is also
89 readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
90 the kernel (i.e. it is not a module).] */
91static int def_reserved_size = -1; /* picks up init parameter */
92static int sg_allow_dio = SG_ALLOW_DIO_DEF;
93
94static int scatter_elem_sz = SG_SCATTER_SZ;
95static int scatter_elem_sz_prev = SG_SCATTER_SZ;
96
97#define SG_SECTOR_SZ 512
98
99static int sg_add_device(struct device *);
100static void sg_remove_device(struct device *);
101
102static DEFINE_IDR(sg_index_idr);
103static DEFINE_RWLOCK(sg_index_lock); /* Also used to lock
104 file descriptor list for device */
105
106static struct class_interface sg_interface = {
107 .add_dev = sg_add_device,
108 .remove_dev = sg_remove_device,
109};
110
111typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
112 unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
113 unsigned sglist_len; /* size of malloc'd scatter-gather list ++ */
114 unsigned bufflen; /* Size of (aggregate) data buffer */
115 struct page **pages;
116 int page_order;
117 char dio_in_use; /* 0->indirect IO (or mmap), 1->dio */
118 unsigned char cmd_opcode; /* first byte of command */
119} Sg_scatter_hold;
120
121struct sg_device; /* forward declarations */
122struct sg_fd;
123
124typedef struct sg_request { /* SG_MAX_QUEUE requests outstanding per file */
125 struct list_head entry; /* list entry */
126 struct sg_fd *parentfp; /* NULL -> not in use */
127 Sg_scatter_hold data; /* hold buffer, perhaps scatter list */
128 sg_io_hdr_t header; /* scsi command+info, see <scsi/sg.h> */
129 unsigned char sense_b[SCSI_SENSE_BUFFERSIZE];
130 char res_used; /* 1 -> using reserve buffer, 0 -> not ... */
131 char orphan; /* 1 -> drop on sight, 0 -> normal */
132 char sg_io_owned; /* 1 -> packet belongs to SG_IO */
133 /* done protected by rq_list_lock */
134 char done; /* 0->before bh, 1->before read, 2->read */
135 struct request *rq;
136 struct bio *bio;
137 struct execute_work ew;
138} Sg_request;
139
140typedef struct sg_fd { /* holds the state of a file descriptor */
141 struct list_head sfd_siblings; /* protected by device's sfd_lock */
142 struct sg_device *parentdp; /* owning device */
143 wait_queue_head_t read_wait; /* queue read until command done */
144 rwlock_t rq_list_lock; /* protect access to list in req_arr */
145 struct mutex f_mutex; /* protect against changes in this fd */
146 int timeout; /* defaults to SG_DEFAULT_TIMEOUT */
147 int timeout_user; /* defaults to SG_DEFAULT_TIMEOUT_USER */
148 Sg_scatter_hold reserve; /* buffer held for this file descriptor */
149 struct list_head rq_list; /* head of request list */
150 struct fasync_struct *async_qp; /* used by asynchronous notification */
151 Sg_request req_arr[SG_MAX_QUEUE]; /* used as singly-linked list */
152 char force_packid; /* 1 -> pack_id input to read(), 0 -> ignored */
153 char cmd_q; /* 1 -> allow command queuing, 0 -> don't */
154 unsigned char next_cmd_len; /* 0: automatic, >0: use on next write() */
155 char keep_orphan; /* 0 -> drop orphan (def), 1 -> keep for read() */
156 char mmap_called; /* 0 -> mmap() never called on this fd */
157 char res_in_use; /* 1 -> 'reserve' array in use */
158 struct kref f_ref;
159 struct execute_work ew;
160} Sg_fd;
161
162typedef struct sg_device { /* holds the state of each scsi generic device */
163 struct scsi_device *device;
164 wait_queue_head_t open_wait; /* queue open() when O_EXCL present */
165 struct mutex open_rel_lock; /* held when in open() or release() */
166 int sg_tablesize; /* adapter's max scatter-gather table size */
167 u32 index; /* device index number */
168 struct list_head sfds;
169 rwlock_t sfd_lock; /* protect access to sfd list */
170 atomic_t detaching; /* 0->device usable, 1->device detaching */
171 bool exclude; /* 1->open(O_EXCL) succeeded and is active */
172 int open_cnt; /* count of opens (perhaps < num(sfds) ) */
173 char sgdebug; /* 0->off, 1->sense, 9->dump dev, 10-> all devs */
174 char name[DISK_NAME_LEN];
175 struct cdev * cdev; /* char_dev [sysfs: /sys/cdev/major/sg<n>] */
176 struct kref d_ref;
177} Sg_device;
178
179/* tasklet or soft irq callback */
180static enum rq_end_io_ret sg_rq_end_io(struct request *rq, blk_status_t status);
181static int sg_start_req(Sg_request *srp, unsigned char *cmd);
182static int sg_finish_rem_req(Sg_request * srp);
183static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
184static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
185 Sg_request * srp);
186static ssize_t sg_new_write(Sg_fd *sfp, struct file *file,
187 const char __user *buf, size_t count, int blocking,
188 int read_only, int sg_io_owned, Sg_request **o_srp);
189static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
190 unsigned char *cmnd, int timeout, int blocking);
191static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
192static void sg_remove_scat(Sg_fd * sfp, Sg_scatter_hold * schp);
193static void sg_build_reserve(Sg_fd * sfp, int req_size);
194static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
195static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
196static Sg_fd *sg_add_sfp(Sg_device * sdp);
197static void sg_remove_sfp(struct kref *);
198static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id, bool *busy);
199static Sg_request *sg_add_request(Sg_fd * sfp);
200static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
201static Sg_device *sg_get_dev(int dev);
202static void sg_device_destroy(struct kref *kref);
203
204#define SZ_SG_HEADER sizeof(struct sg_header)
205#define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
206#define SZ_SG_IOVEC sizeof(sg_iovec_t)
207#define SZ_SG_REQ_INFO sizeof(sg_req_info_t)
208
209#define sg_printk(prefix, sdp, fmt, a...) \
210 sdev_prefix_printk(prefix, (sdp)->device, (sdp)->name, fmt, ##a)
211
212/*
213 * The SCSI interfaces that use read() and write() as an asynchronous variant of
214 * ioctl(..., SG_IO, ...) are fundamentally unsafe, since there are lots of ways
215 * to trigger read() and write() calls from various contexts with elevated
216 * privileges. This can lead to kernel memory corruption (e.g. if these
217 * interfaces are called through splice()) and privilege escalation inside
218 * userspace (e.g. if a process with access to such a device passes a file
219 * descriptor to a SUID binary as stdin/stdout/stderr).
220 *
221 * This function provides protection for the legacy API by restricting the
222 * calling context.
223 */
224static int sg_check_file_access(struct file *filp, const char *caller)
225{
226 if (filp->f_cred != current_real_cred()) {
227 pr_err_once("%s: process %d (%s) changed security contexts after opening file descriptor, this is not allowed.\n",
228 caller, task_tgid_vnr(current), current->comm);
229 return -EPERM;
230 }
231 return 0;
232}
233
234static int sg_allow_access(struct file *filp, unsigned char *cmd)
235{
236 struct sg_fd *sfp = filp->private_data;
237
238 if (sfp->parentdp->device->type == TYPE_SCANNER)
239 return 0;
240 if (!scsi_cmd_allowed(cmd, filp->f_mode & FMODE_WRITE))
241 return -EPERM;
242 return 0;
243}
244
245static int
246open_wait(Sg_device *sdp, int flags)
247{
248 int retval = 0;
249
250 if (flags & O_EXCL) {
251 while (sdp->open_cnt > 0) {
252 mutex_unlock(&sdp->open_rel_lock);
253 retval = wait_event_interruptible(sdp->open_wait,
254 (atomic_read(&sdp->detaching) ||
255 !sdp->open_cnt));
256 mutex_lock(&sdp->open_rel_lock);
257
258 if (retval) /* -ERESTARTSYS */
259 return retval;
260 if (atomic_read(&sdp->detaching))
261 return -ENODEV;
262 }
263 } else {
264 while (sdp->exclude) {
265 mutex_unlock(&sdp->open_rel_lock);
266 retval = wait_event_interruptible(sdp->open_wait,
267 (atomic_read(&sdp->detaching) ||
268 !sdp->exclude));
269 mutex_lock(&sdp->open_rel_lock);
270
271 if (retval) /* -ERESTARTSYS */
272 return retval;
273 if (atomic_read(&sdp->detaching))
274 return -ENODEV;
275 }
276 }
277
278 return retval;
279}
280
281/* Returns 0 on success, else a negated errno value */
282static int
283sg_open(struct inode *inode, struct file *filp)
284{
285 int dev = iminor(inode);
286 int flags = filp->f_flags;
287 struct request_queue *q;
288 struct scsi_device *device;
289 Sg_device *sdp;
290 Sg_fd *sfp;
291 int retval;
292
293 nonseekable_open(inode, filp);
294 if ((flags & O_EXCL) && (O_RDONLY == (flags & O_ACCMODE)))
295 return -EPERM; /* Can't lock it with read only access */
296 sdp = sg_get_dev(dev);
297 if (IS_ERR(sdp))
298 return PTR_ERR(sdp);
299
300 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
301 "sg_open: flags=0x%x\n", flags));
302
303 /* This driver's module count bumped by fops_get in <linux/fs.h> */
304 /* Prevent the device driver from vanishing while we sleep */
305 device = sdp->device;
306 retval = scsi_device_get(device);
307 if (retval)
308 goto sg_put;
309
310 retval = scsi_autopm_get_device(device);
311 if (retval)
312 goto sdp_put;
313
314 /* scsi_block_when_processing_errors() may block so bypass
315 * check if O_NONBLOCK. Permits SCSI commands to be issued
316 * during error recovery. Tread carefully. */
317 if (!((flags & O_NONBLOCK) ||
318 scsi_block_when_processing_errors(device))) {
319 retval = -ENXIO;
320 /* we are in error recovery for this device */
321 goto error_out;
322 }
323
324 mutex_lock(&sdp->open_rel_lock);
325 if (flags & O_NONBLOCK) {
326 if (flags & O_EXCL) {
327 if (sdp->open_cnt > 0) {
328 retval = -EBUSY;
329 goto error_mutex_locked;
330 }
331 } else {
332 if (sdp->exclude) {
333 retval = -EBUSY;
334 goto error_mutex_locked;
335 }
336 }
337 } else {
338 retval = open_wait(sdp, flags);
339 if (retval) /* -ERESTARTSYS or -ENODEV */
340 goto error_mutex_locked;
341 }
342
343 /* N.B. at this point we are holding the open_rel_lock */
344 if (flags & O_EXCL)
345 sdp->exclude = true;
346
347 if (sdp->open_cnt < 1) { /* no existing opens */
348 sdp->sgdebug = 0;
349 q = device->request_queue;
350 sdp->sg_tablesize = queue_max_segments(q);
351 }
352 sfp = sg_add_sfp(sdp);
353 if (IS_ERR(sfp)) {
354 retval = PTR_ERR(sfp);
355 goto out_undo;
356 }
357
358 filp->private_data = sfp;
359 sdp->open_cnt++;
360 mutex_unlock(&sdp->open_rel_lock);
361
362 retval = 0;
363sg_put:
364 kref_put(&sdp->d_ref, sg_device_destroy);
365 return retval;
366
367out_undo:
368 if (flags & O_EXCL) {
369 sdp->exclude = false; /* undo if error */
370 wake_up_interruptible(&sdp->open_wait);
371 }
372error_mutex_locked:
373 mutex_unlock(&sdp->open_rel_lock);
374error_out:
375 scsi_autopm_put_device(device);
376sdp_put:
377 kref_put(&sdp->d_ref, sg_device_destroy);
378 scsi_device_put(device);
379 return retval;
380}
381
382/* Release resources associated with a successful sg_open()
383 * Returns 0 on success, else a negated errno value */
384static int
385sg_release(struct inode *inode, struct file *filp)
386{
387 Sg_device *sdp;
388 Sg_fd *sfp;
389
390 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
391 return -ENXIO;
392 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp, "sg_release\n"));
393
394 mutex_lock(&sdp->open_rel_lock);
395 scsi_autopm_put_device(sdp->device);
396 kref_put(&sfp->f_ref, sg_remove_sfp);
397 sdp->open_cnt--;
398
399 /* possibly many open()s waiting on exlude clearing, start many;
400 * only open(O_EXCL)s wait on 0==open_cnt so only start one */
401 if (sdp->exclude) {
402 sdp->exclude = false;
403 wake_up_interruptible_all(&sdp->open_wait);
404 } else if (0 == sdp->open_cnt) {
405 wake_up_interruptible(&sdp->open_wait);
406 }
407 mutex_unlock(&sdp->open_rel_lock);
408 return 0;
409}
410
411static int get_sg_io_pack_id(int *pack_id, void __user *buf, size_t count)
412{
413 struct sg_header __user *old_hdr = buf;
414 int reply_len;
415
416 if (count >= SZ_SG_HEADER) {
417 /* negative reply_len means v3 format, otherwise v1/v2 */
418 if (get_user(reply_len, &old_hdr->reply_len))
419 return -EFAULT;
420
421 if (reply_len >= 0)
422 return get_user(*pack_id, &old_hdr->pack_id);
423
424 if (in_compat_syscall() &&
425 count >= sizeof(struct compat_sg_io_hdr)) {
426 struct compat_sg_io_hdr __user *hp = buf;
427
428 return get_user(*pack_id, &hp->pack_id);
429 }
430
431 if (count >= sizeof(struct sg_io_hdr)) {
432 struct sg_io_hdr __user *hp = buf;
433
434 return get_user(*pack_id, &hp->pack_id);
435 }
436 }
437
438 /* no valid header was passed, so ignore the pack_id */
439 *pack_id = -1;
440 return 0;
441}
442
443static ssize_t
444sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
445{
446 Sg_device *sdp;
447 Sg_fd *sfp;
448 Sg_request *srp;
449 int req_pack_id = -1;
450 bool busy;
451 sg_io_hdr_t *hp;
452 struct sg_header *old_hdr;
453 int retval;
454
455 /*
456 * This could cause a response to be stranded. Close the associated
457 * file descriptor to free up any resources being held.
458 */
459 retval = sg_check_file_access(filp, __func__);
460 if (retval)
461 return retval;
462
463 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
464 return -ENXIO;
465 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
466 "sg_read: count=%d\n", (int) count));
467
468 if (sfp->force_packid)
469 retval = get_sg_io_pack_id(&req_pack_id, buf, count);
470 if (retval)
471 return retval;
472
473 srp = sg_get_rq_mark(sfp, req_pack_id, &busy);
474 if (!srp) { /* now wait on packet to arrive */
475 if (filp->f_flags & O_NONBLOCK)
476 return -EAGAIN;
477 retval = wait_event_interruptible(sfp->read_wait,
478 ((srp = sg_get_rq_mark(sfp, req_pack_id, &busy)) ||
479 (!busy && atomic_read(&sdp->detaching))));
480 if (!srp)
481 /* signal or detaching */
482 return retval ? retval : -ENODEV;
483 }
484 if (srp->header.interface_id != '\0')
485 return sg_new_read(sfp, buf, count, srp);
486
487 hp = &srp->header;
488 old_hdr = kzalloc(SZ_SG_HEADER, GFP_KERNEL);
489 if (!old_hdr)
490 return -ENOMEM;
491
492 old_hdr->reply_len = (int) hp->timeout;
493 old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
494 old_hdr->pack_id = hp->pack_id;
495 old_hdr->twelve_byte =
496 ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
497 old_hdr->target_status = hp->masked_status;
498 old_hdr->host_status = hp->host_status;
499 old_hdr->driver_status = hp->driver_status;
500 if ((CHECK_CONDITION & hp->masked_status) ||
501 (srp->sense_b[0] & 0x70) == 0x70) {
502 old_hdr->driver_status = DRIVER_SENSE;
503 memcpy(old_hdr->sense_buffer, srp->sense_b,
504 sizeof (old_hdr->sense_buffer));
505 }
506 switch (hp->host_status) {
507 /* This setup of 'result' is for backward compatibility and is best
508 ignored by the user who should use target, host + driver status */
509 case DID_OK:
510 case DID_PASSTHROUGH:
511 case DID_SOFT_ERROR:
512 old_hdr->result = 0;
513 break;
514 case DID_NO_CONNECT:
515 case DID_BUS_BUSY:
516 case DID_TIME_OUT:
517 old_hdr->result = EBUSY;
518 break;
519 case DID_BAD_TARGET:
520 case DID_ABORT:
521 case DID_PARITY:
522 case DID_RESET:
523 case DID_BAD_INTR:
524 old_hdr->result = EIO;
525 break;
526 case DID_ERROR:
527 old_hdr->result = (srp->sense_b[0] == 0 &&
528 hp->masked_status == GOOD) ? 0 : EIO;
529 break;
530 default:
531 old_hdr->result = EIO;
532 break;
533 }
534
535 /* Now copy the result back to the user buffer. */
536 if (count >= SZ_SG_HEADER) {
537 if (copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
538 retval = -EFAULT;
539 goto free_old_hdr;
540 }
541 buf += SZ_SG_HEADER;
542 if (count > old_hdr->reply_len)
543 count = old_hdr->reply_len;
544 if (count > SZ_SG_HEADER) {
545 if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
546 retval = -EFAULT;
547 goto free_old_hdr;
548 }
549 }
550 } else
551 count = (old_hdr->result == 0) ? 0 : -EIO;
552 sg_finish_rem_req(srp);
553 sg_remove_request(sfp, srp);
554 retval = count;
555free_old_hdr:
556 kfree(old_hdr);
557 return retval;
558}
559
560static ssize_t
561sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
562{
563 sg_io_hdr_t *hp = &srp->header;
564 int err = 0, err2;
565 int len;
566
567 if (in_compat_syscall()) {
568 if (count < sizeof(struct compat_sg_io_hdr)) {
569 err = -EINVAL;
570 goto err_out;
571 }
572 } else if (count < SZ_SG_IO_HDR) {
573 err = -EINVAL;
574 goto err_out;
575 }
576 hp->sb_len_wr = 0;
577 if ((hp->mx_sb_len > 0) && hp->sbp) {
578 if ((CHECK_CONDITION & hp->masked_status) ||
579 (srp->sense_b[0] & 0x70) == 0x70) {
580 int sb_len = SCSI_SENSE_BUFFERSIZE;
581 sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
582 len = 8 + (int) srp->sense_b[7]; /* Additional sense length field */
583 len = (len > sb_len) ? sb_len : len;
584 if (copy_to_user(hp->sbp, srp->sense_b, len)) {
585 err = -EFAULT;
586 goto err_out;
587 }
588 hp->driver_status = DRIVER_SENSE;
589 hp->sb_len_wr = len;
590 }
591 }
592 if (hp->masked_status || hp->host_status || hp->driver_status)
593 hp->info |= SG_INFO_CHECK;
594 err = put_sg_io_hdr(hp, buf);
595err_out:
596 err2 = sg_finish_rem_req(srp);
597 sg_remove_request(sfp, srp);
598 return err ? : err2 ? : count;
599}
600
601static ssize_t
602sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
603{
604 int mxsize, cmd_size, k;
605 int input_size, blocking;
606 unsigned char opcode;
607 Sg_device *sdp;
608 Sg_fd *sfp;
609 Sg_request *srp;
610 struct sg_header old_hdr;
611 sg_io_hdr_t *hp;
612 unsigned char cmnd[SG_MAX_CDB_SIZE];
613 int retval;
614
615 retval = sg_check_file_access(filp, __func__);
616 if (retval)
617 return retval;
618
619 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
620 return -ENXIO;
621 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
622 "sg_write: count=%d\n", (int) count));
623 if (atomic_read(&sdp->detaching))
624 return -ENODEV;
625 if (!((filp->f_flags & O_NONBLOCK) ||
626 scsi_block_when_processing_errors(sdp->device)))
627 return -ENXIO;
628
629 if (count < SZ_SG_HEADER)
630 return -EIO;
631 if (copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
632 return -EFAULT;
633 blocking = !(filp->f_flags & O_NONBLOCK);
634 if (old_hdr.reply_len < 0)
635 return sg_new_write(sfp, filp, buf, count,
636 blocking, 0, 0, NULL);
637 if (count < (SZ_SG_HEADER + 6))
638 return -EIO; /* The minimum scsi command length is 6 bytes. */
639
640 buf += SZ_SG_HEADER;
641 if (get_user(opcode, buf))
642 return -EFAULT;
643
644 if (!(srp = sg_add_request(sfp))) {
645 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sdp,
646 "sg_write: queue full\n"));
647 return -EDOM;
648 }
649 mutex_lock(&sfp->f_mutex);
650 if (sfp->next_cmd_len > 0) {
651 cmd_size = sfp->next_cmd_len;
652 sfp->next_cmd_len = 0; /* reset so only this write() effected */
653 } else {
654 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
655 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
656 cmd_size = 12;
657 }
658 mutex_unlock(&sfp->f_mutex);
659 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sdp,
660 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
661/* Determine buffer size. */
662 input_size = count - cmd_size;
663 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
664 mxsize -= SZ_SG_HEADER;
665 input_size -= SZ_SG_HEADER;
666 if (input_size < 0) {
667 sg_remove_request(sfp, srp);
668 return -EIO; /* User did not pass enough bytes for this command. */
669 }
670 hp = &srp->header;
671 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
672 hp->cmd_len = (unsigned char) cmd_size;
673 hp->iovec_count = 0;
674 hp->mx_sb_len = 0;
675 if (input_size > 0)
676 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
677 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
678 else
679 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
680 hp->dxfer_len = mxsize;
681 if ((hp->dxfer_direction == SG_DXFER_TO_DEV) ||
682 (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV))
683 hp->dxferp = (char __user *)buf + cmd_size;
684 else
685 hp->dxferp = NULL;
686 hp->sbp = NULL;
687 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
688 hp->flags = input_size; /* structure abuse ... */
689 hp->pack_id = old_hdr.pack_id;
690 hp->usr_ptr = NULL;
691 if (copy_from_user(cmnd, buf, cmd_size)) {
692 sg_remove_request(sfp, srp);
693 return -EFAULT;
694 }
695 /*
696 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
697 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
698 * is a non-zero input_size, so emit a warning.
699 */
700 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV) {
701 printk_ratelimited(KERN_WARNING
702 "sg_write: data in/out %d/%d bytes "
703 "for SCSI command 0x%x-- guessing "
704 "data in;\n program %s not setting "
705 "count and/or reply_len properly\n",
706 old_hdr.reply_len - (int)SZ_SG_HEADER,
707 input_size, (unsigned int) cmnd[0],
708 current->comm);
709 }
710 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
711 return (k < 0) ? k : count;
712}
713
714static ssize_t
715sg_new_write(Sg_fd *sfp, struct file *file, const char __user *buf,
716 size_t count, int blocking, int read_only, int sg_io_owned,
717 Sg_request **o_srp)
718{
719 int k;
720 Sg_request *srp;
721 sg_io_hdr_t *hp;
722 unsigned char cmnd[SG_MAX_CDB_SIZE];
723 int timeout;
724 unsigned long ul_timeout;
725
726 if (count < SZ_SG_IO_HDR)
727 return -EINVAL;
728
729 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
730 if (!(srp = sg_add_request(sfp))) {
731 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
732 "sg_new_write: queue full\n"));
733 return -EDOM;
734 }
735 srp->sg_io_owned = sg_io_owned;
736 hp = &srp->header;
737 if (get_sg_io_hdr(hp, buf)) {
738 sg_remove_request(sfp, srp);
739 return -EFAULT;
740 }
741 if (hp->interface_id != 'S') {
742 sg_remove_request(sfp, srp);
743 return -ENOSYS;
744 }
745 if (hp->flags & SG_FLAG_MMAP_IO) {
746 if (hp->dxfer_len > sfp->reserve.bufflen) {
747 sg_remove_request(sfp, srp);
748 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
749 }
750 if (hp->flags & SG_FLAG_DIRECT_IO) {
751 sg_remove_request(sfp, srp);
752 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
753 }
754 if (sfp->res_in_use) {
755 sg_remove_request(sfp, srp);
756 return -EBUSY; /* reserve buffer already being used */
757 }
758 }
759 ul_timeout = msecs_to_jiffies(srp->header.timeout);
760 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
761 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
762 sg_remove_request(sfp, srp);
763 return -EMSGSIZE;
764 }
765 if (copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
766 sg_remove_request(sfp, srp);
767 return -EFAULT;
768 }
769 if (read_only && sg_allow_access(file, cmnd)) {
770 sg_remove_request(sfp, srp);
771 return -EPERM;
772 }
773 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
774 if (k < 0)
775 return k;
776 if (o_srp)
777 *o_srp = srp;
778 return count;
779}
780
781static int
782sg_common_write(Sg_fd * sfp, Sg_request * srp,
783 unsigned char *cmnd, int timeout, int blocking)
784{
785 int k, at_head;
786 Sg_device *sdp = sfp->parentdp;
787 sg_io_hdr_t *hp = &srp->header;
788
789 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
790 hp->status = 0;
791 hp->masked_status = 0;
792 hp->msg_status = 0;
793 hp->info = 0;
794 hp->host_status = 0;
795 hp->driver_status = 0;
796 hp->resid = 0;
797 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
798 "sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
799 (int) cmnd[0], (int) hp->cmd_len));
800
801 if (hp->dxfer_len >= SZ_256M) {
802 sg_remove_request(sfp, srp);
803 return -EINVAL;
804 }
805
806 k = sg_start_req(srp, cmnd);
807 if (k) {
808 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
809 "sg_common_write: start_req err=%d\n", k));
810 sg_finish_rem_req(srp);
811 sg_remove_request(sfp, srp);
812 return k; /* probably out of space --> ENOMEM */
813 }
814 if (atomic_read(&sdp->detaching)) {
815 if (srp->bio) {
816 blk_mq_free_request(srp->rq);
817 srp->rq = NULL;
818 }
819
820 sg_finish_rem_req(srp);
821 sg_remove_request(sfp, srp);
822 return -ENODEV;
823 }
824
825 hp->duration = jiffies_to_msecs(jiffies);
826 if (hp->interface_id != '\0' && /* v3 (or later) interface */
827 (SG_FLAG_Q_AT_TAIL & hp->flags))
828 at_head = 0;
829 else
830 at_head = 1;
831
832 srp->rq->timeout = timeout;
833 kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
834 srp->rq->end_io = sg_rq_end_io;
835 blk_execute_rq_nowait(srp->rq, at_head);
836 return 0;
837}
838
839static int srp_done(Sg_fd *sfp, Sg_request *srp)
840{
841 unsigned long flags;
842 int ret;
843
844 read_lock_irqsave(&sfp->rq_list_lock, flags);
845 ret = srp->done;
846 read_unlock_irqrestore(&sfp->rq_list_lock, flags);
847 return ret;
848}
849
850static int max_sectors_bytes(struct request_queue *q)
851{
852 unsigned int max_sectors = queue_max_sectors(q);
853
854 max_sectors = min_t(unsigned int, max_sectors, INT_MAX >> 9);
855
856 return max_sectors << 9;
857}
858
859static void
860sg_fill_request_table(Sg_fd *sfp, sg_req_info_t *rinfo)
861{
862 Sg_request *srp;
863 int val;
864 unsigned int ms;
865
866 val = 0;
867 list_for_each_entry(srp, &sfp->rq_list, entry) {
868 if (val >= SG_MAX_QUEUE)
869 break;
870 rinfo[val].req_state = srp->done + 1;
871 rinfo[val].problem =
872 srp->header.masked_status &
873 srp->header.host_status &
874 srp->header.driver_status;
875 if (srp->done)
876 rinfo[val].duration =
877 srp->header.duration;
878 else {
879 ms = jiffies_to_msecs(jiffies);
880 rinfo[val].duration =
881 (ms > srp->header.duration) ?
882 (ms - srp->header.duration) : 0;
883 }
884 rinfo[val].orphan = srp->orphan;
885 rinfo[val].sg_io_owned = srp->sg_io_owned;
886 rinfo[val].pack_id = srp->header.pack_id;
887 rinfo[val].usr_ptr = srp->header.usr_ptr;
888 val++;
889 }
890}
891
892#ifdef CONFIG_COMPAT
893struct compat_sg_req_info { /* used by SG_GET_REQUEST_TABLE ioctl() */
894 char req_state;
895 char orphan;
896 char sg_io_owned;
897 char problem;
898 int pack_id;
899 compat_uptr_t usr_ptr;
900 unsigned int duration;
901 int unused;
902};
903
904static int put_compat_request_table(struct compat_sg_req_info __user *o,
905 struct sg_req_info *rinfo)
906{
907 int i;
908 for (i = 0; i < SG_MAX_QUEUE; i++) {
909 if (copy_to_user(o + i, rinfo + i, offsetof(sg_req_info_t, usr_ptr)) ||
910 put_user((uintptr_t)rinfo[i].usr_ptr, &o[i].usr_ptr) ||
911 put_user(rinfo[i].duration, &o[i].duration) ||
912 put_user(rinfo[i].unused, &o[i].unused))
913 return -EFAULT;
914 }
915 return 0;
916}
917#endif
918
919static long
920sg_ioctl_common(struct file *filp, Sg_device *sdp, Sg_fd *sfp,
921 unsigned int cmd_in, void __user *p)
922{
923 int __user *ip = p;
924 int result, val, read_only;
925 Sg_request *srp;
926 unsigned long iflags;
927
928 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
929 "sg_ioctl: cmd=0x%x\n", (int) cmd_in));
930 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
931
932 switch (cmd_in) {
933 case SG_IO:
934 if (atomic_read(&sdp->detaching))
935 return -ENODEV;
936 if (!scsi_block_when_processing_errors(sdp->device))
937 return -ENXIO;
938 result = sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
939 1, read_only, 1, &srp);
940 if (result < 0)
941 return result;
942 result = wait_event_interruptible(sfp->read_wait,
943 srp_done(sfp, srp));
944 write_lock_irq(&sfp->rq_list_lock);
945 if (srp->done) {
946 srp->done = 2;
947 write_unlock_irq(&sfp->rq_list_lock);
948 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
949 return (result < 0) ? result : 0;
950 }
951 srp->orphan = 1;
952 write_unlock_irq(&sfp->rq_list_lock);
953 return result; /* -ERESTARTSYS because signal hit process */
954 case SG_SET_TIMEOUT:
955 result = get_user(val, ip);
956 if (result)
957 return result;
958 if (val < 0)
959 return -EIO;
960 if (val >= mult_frac((s64)INT_MAX, USER_HZ, HZ))
961 val = min_t(s64, mult_frac((s64)INT_MAX, USER_HZ, HZ),
962 INT_MAX);
963 sfp->timeout_user = val;
964 sfp->timeout = mult_frac(val, HZ, USER_HZ);
965
966 return 0;
967 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
968 /* strange ..., for backward compatibility */
969 return sfp->timeout_user;
970 case SG_SET_FORCE_LOW_DMA:
971 /*
972 * N.B. This ioctl never worked properly, but failed to
973 * return an error value. So returning '0' to keep compability
974 * with legacy applications.
975 */
976 return 0;
977 case SG_GET_LOW_DMA:
978 return put_user(0, ip);
979 case SG_GET_SCSI_ID:
980 {
981 sg_scsi_id_t v;
982
983 if (atomic_read(&sdp->detaching))
984 return -ENODEV;
985 memset(&v, 0, sizeof(v));
986 v.host_no = sdp->device->host->host_no;
987 v.channel = sdp->device->channel;
988 v.scsi_id = sdp->device->id;
989 v.lun = sdp->device->lun;
990 v.scsi_type = sdp->device->type;
991 v.h_cmd_per_lun = sdp->device->host->cmd_per_lun;
992 v.d_queue_depth = sdp->device->queue_depth;
993 if (copy_to_user(p, &v, sizeof(sg_scsi_id_t)))
994 return -EFAULT;
995 return 0;
996 }
997 case SG_SET_FORCE_PACK_ID:
998 result = get_user(val, ip);
999 if (result)
1000 return result;
1001 sfp->force_packid = val ? 1 : 0;
1002 return 0;
1003 case SG_GET_PACK_ID:
1004 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1005 list_for_each_entry(srp, &sfp->rq_list, entry) {
1006 if ((1 == srp->done) && (!srp->sg_io_owned)) {
1007 read_unlock_irqrestore(&sfp->rq_list_lock,
1008 iflags);
1009 return put_user(srp->header.pack_id, ip);
1010 }
1011 }
1012 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1013 return put_user(-1, ip);
1014 case SG_GET_NUM_WAITING:
1015 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1016 val = 0;
1017 list_for_each_entry(srp, &sfp->rq_list, entry) {
1018 if ((1 == srp->done) && (!srp->sg_io_owned))
1019 ++val;
1020 }
1021 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1022 return put_user(val, ip);
1023 case SG_GET_SG_TABLESIZE:
1024 return put_user(sdp->sg_tablesize, ip);
1025 case SG_SET_RESERVED_SIZE:
1026 result = get_user(val, ip);
1027 if (result)
1028 return result;
1029 if (val < 0)
1030 return -EINVAL;
1031 val = min_t(int, val,
1032 max_sectors_bytes(sdp->device->request_queue));
1033 mutex_lock(&sfp->f_mutex);
1034 if (val != sfp->reserve.bufflen) {
1035 if (sfp->mmap_called ||
1036 sfp->res_in_use) {
1037 mutex_unlock(&sfp->f_mutex);
1038 return -EBUSY;
1039 }
1040
1041 sg_remove_scat(sfp, &sfp->reserve);
1042 sg_build_reserve(sfp, val);
1043 }
1044 mutex_unlock(&sfp->f_mutex);
1045 return 0;
1046 case SG_GET_RESERVED_SIZE:
1047 val = min_t(int, sfp->reserve.bufflen,
1048 max_sectors_bytes(sdp->device->request_queue));
1049 return put_user(val, ip);
1050 case SG_SET_COMMAND_Q:
1051 result = get_user(val, ip);
1052 if (result)
1053 return result;
1054 sfp->cmd_q = val ? 1 : 0;
1055 return 0;
1056 case SG_GET_COMMAND_Q:
1057 return put_user((int) sfp->cmd_q, ip);
1058 case SG_SET_KEEP_ORPHAN:
1059 result = get_user(val, ip);
1060 if (result)
1061 return result;
1062 sfp->keep_orphan = val;
1063 return 0;
1064 case SG_GET_KEEP_ORPHAN:
1065 return put_user((int) sfp->keep_orphan, ip);
1066 case SG_NEXT_CMD_LEN:
1067 result = get_user(val, ip);
1068 if (result)
1069 return result;
1070 if (val > SG_MAX_CDB_SIZE)
1071 return -ENOMEM;
1072 sfp->next_cmd_len = (val > 0) ? val : 0;
1073 return 0;
1074 case SG_GET_VERSION_NUM:
1075 return put_user(sg_version_num, ip);
1076 case SG_GET_ACCESS_COUNT:
1077 /* faked - we don't have a real access count anymore */
1078 val = (sdp->device ? 1 : 0);
1079 return put_user(val, ip);
1080 case SG_GET_REQUEST_TABLE:
1081 {
1082 sg_req_info_t *rinfo;
1083
1084 rinfo = kcalloc(SG_MAX_QUEUE, SZ_SG_REQ_INFO,
1085 GFP_KERNEL);
1086 if (!rinfo)
1087 return -ENOMEM;
1088 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1089 sg_fill_request_table(sfp, rinfo);
1090 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1091 #ifdef CONFIG_COMPAT
1092 if (in_compat_syscall())
1093 result = put_compat_request_table(p, rinfo);
1094 else
1095 #endif
1096 result = copy_to_user(p, rinfo,
1097 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1098 result = result ? -EFAULT : 0;
1099 kfree(rinfo);
1100 return result;
1101 }
1102 case SG_EMULATED_HOST:
1103 if (atomic_read(&sdp->detaching))
1104 return -ENODEV;
1105 return put_user(sdp->device->host->hostt->emulated, ip);
1106 case SCSI_IOCTL_SEND_COMMAND:
1107 if (atomic_read(&sdp->detaching))
1108 return -ENODEV;
1109 return scsi_ioctl(sdp->device, filp->f_mode & FMODE_WRITE,
1110 cmd_in, p);
1111 case SG_SET_DEBUG:
1112 result = get_user(val, ip);
1113 if (result)
1114 return result;
1115 sdp->sgdebug = (char) val;
1116 return 0;
1117 case BLKSECTGET:
1118 return put_user(max_sectors_bytes(sdp->device->request_queue),
1119 ip);
1120 case BLKTRACESETUP:
1121 return blk_trace_setup(sdp->device->request_queue, sdp->name,
1122 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
1123 NULL, p);
1124 case BLKTRACESTART:
1125 return blk_trace_startstop(sdp->device->request_queue, 1);
1126 case BLKTRACESTOP:
1127 return blk_trace_startstop(sdp->device->request_queue, 0);
1128 case BLKTRACETEARDOWN:
1129 return blk_trace_remove(sdp->device->request_queue);
1130 case SCSI_IOCTL_GET_IDLUN:
1131 case SCSI_IOCTL_GET_BUS_NUMBER:
1132 case SCSI_IOCTL_PROBE_HOST:
1133 case SG_GET_TRANSFORM:
1134 case SG_SCSI_RESET:
1135 if (atomic_read(&sdp->detaching))
1136 return -ENODEV;
1137 break;
1138 default:
1139 if (read_only)
1140 return -EPERM; /* don't know so take safe approach */
1141 break;
1142 }
1143
1144 result = scsi_ioctl_block_when_processing_errors(sdp->device,
1145 cmd_in, filp->f_flags & O_NDELAY);
1146 if (result)
1147 return result;
1148
1149 return -ENOIOCTLCMD;
1150}
1151
1152static long
1153sg_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1154{
1155 void __user *p = (void __user *)arg;
1156 Sg_device *sdp;
1157 Sg_fd *sfp;
1158 int ret;
1159
1160 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1161 return -ENXIO;
1162
1163 ret = sg_ioctl_common(filp, sdp, sfp, cmd_in, p);
1164 if (ret != -ENOIOCTLCMD)
1165 return ret;
1166 return scsi_ioctl(sdp->device, filp->f_mode & FMODE_WRITE, cmd_in, p);
1167}
1168
1169static __poll_t
1170sg_poll(struct file *filp, poll_table * wait)
1171{
1172 __poll_t res = 0;
1173 Sg_device *sdp;
1174 Sg_fd *sfp;
1175 Sg_request *srp;
1176 int count = 0;
1177 unsigned long iflags;
1178
1179 sfp = filp->private_data;
1180 if (!sfp)
1181 return EPOLLERR;
1182 sdp = sfp->parentdp;
1183 if (!sdp)
1184 return EPOLLERR;
1185 poll_wait(filp, &sfp->read_wait, wait);
1186 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1187 list_for_each_entry(srp, &sfp->rq_list, entry) {
1188 /* if any read waiting, flag it */
1189 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1190 res = EPOLLIN | EPOLLRDNORM;
1191 ++count;
1192 }
1193 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1194
1195 if (atomic_read(&sdp->detaching))
1196 res |= EPOLLHUP;
1197 else if (!sfp->cmd_q) {
1198 if (0 == count)
1199 res |= EPOLLOUT | EPOLLWRNORM;
1200 } else if (count < SG_MAX_QUEUE)
1201 res |= EPOLLOUT | EPOLLWRNORM;
1202 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1203 "sg_poll: res=0x%x\n", (__force u32) res));
1204 return res;
1205}
1206
1207static int
1208sg_fasync(int fd, struct file *filp, int mode)
1209{
1210 Sg_device *sdp;
1211 Sg_fd *sfp;
1212
1213 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1214 return -ENXIO;
1215 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1216 "sg_fasync: mode=%d\n", mode));
1217
1218 return fasync_helper(fd, filp, mode, &sfp->async_qp);
1219}
1220
1221static vm_fault_t
1222sg_vma_fault(struct vm_fault *vmf)
1223{
1224 struct vm_area_struct *vma = vmf->vma;
1225 Sg_fd *sfp;
1226 unsigned long offset, len, sa;
1227 Sg_scatter_hold *rsv_schp;
1228 int k, length;
1229
1230 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
1231 return VM_FAULT_SIGBUS;
1232 rsv_schp = &sfp->reserve;
1233 offset = vmf->pgoff << PAGE_SHIFT;
1234 if (offset >= rsv_schp->bufflen)
1235 return VM_FAULT_SIGBUS;
1236 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1237 "sg_vma_fault: offset=%lu, scatg=%d\n",
1238 offset, rsv_schp->k_use_sg));
1239 sa = vma->vm_start;
1240 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1241 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1242 len = vma->vm_end - sa;
1243 len = (len < length) ? len : length;
1244 if (offset < len) {
1245 struct page *page = nth_page(rsv_schp->pages[k],
1246 offset >> PAGE_SHIFT);
1247 get_page(page); /* increment page count */
1248 vmf->page = page;
1249 return 0; /* success */
1250 }
1251 sa += len;
1252 offset -= len;
1253 }
1254
1255 return VM_FAULT_SIGBUS;
1256}
1257
1258static const struct vm_operations_struct sg_mmap_vm_ops = {
1259 .fault = sg_vma_fault,
1260};
1261
1262static int
1263sg_mmap(struct file *filp, struct vm_area_struct *vma)
1264{
1265 Sg_fd *sfp;
1266 unsigned long req_sz, len, sa;
1267 Sg_scatter_hold *rsv_schp;
1268 int k, length;
1269 int ret = 0;
1270
1271 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1272 return -ENXIO;
1273 req_sz = vma->vm_end - vma->vm_start;
1274 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sfp->parentdp,
1275 "sg_mmap starting, vm_start=%p, len=%d\n",
1276 (void *) vma->vm_start, (int) req_sz));
1277 if (vma->vm_pgoff)
1278 return -EINVAL; /* want no offset */
1279 rsv_schp = &sfp->reserve;
1280 mutex_lock(&sfp->f_mutex);
1281 if (req_sz > rsv_schp->bufflen) {
1282 ret = -ENOMEM; /* cannot map more than reserved buffer */
1283 goto out;
1284 }
1285
1286 sa = vma->vm_start;
1287 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1288 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1289 len = vma->vm_end - sa;
1290 len = (len < length) ? len : length;
1291 sa += len;
1292 }
1293
1294 sfp->mmap_called = 1;
1295 vm_flags_set(vma, VM_IO | VM_DONTEXPAND | VM_DONTDUMP);
1296 vma->vm_private_data = sfp;
1297 vma->vm_ops = &sg_mmap_vm_ops;
1298out:
1299 mutex_unlock(&sfp->f_mutex);
1300 return ret;
1301}
1302
1303static void
1304sg_rq_end_io_usercontext(struct work_struct *work)
1305{
1306 struct sg_request *srp = container_of(work, struct sg_request, ew.work);
1307 struct sg_fd *sfp = srp->parentfp;
1308
1309 sg_finish_rem_req(srp);
1310 sg_remove_request(sfp, srp);
1311 kref_put(&sfp->f_ref, sg_remove_sfp);
1312}
1313
1314/*
1315 * This function is a "bottom half" handler that is called by the mid
1316 * level when a command is completed (or has failed).
1317 */
1318static enum rq_end_io_ret
1319sg_rq_end_io(struct request *rq, blk_status_t status)
1320{
1321 struct scsi_cmnd *scmd = blk_mq_rq_to_pdu(rq);
1322 struct sg_request *srp = rq->end_io_data;
1323 Sg_device *sdp;
1324 Sg_fd *sfp;
1325 unsigned long iflags;
1326 unsigned int ms;
1327 char *sense;
1328 int result, resid, done = 1;
1329
1330 if (WARN_ON(srp->done != 0))
1331 return RQ_END_IO_NONE;
1332
1333 sfp = srp->parentfp;
1334 if (WARN_ON(sfp == NULL))
1335 return RQ_END_IO_NONE;
1336
1337 sdp = sfp->parentdp;
1338 if (unlikely(atomic_read(&sdp->detaching)))
1339 pr_info("%s: device detaching\n", __func__);
1340
1341 sense = scmd->sense_buffer;
1342 result = scmd->result;
1343 resid = scmd->resid_len;
1344
1345 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sdp,
1346 "sg_cmd_done: pack_id=%d, res=0x%x\n",
1347 srp->header.pack_id, result));
1348 srp->header.resid = resid;
1349 ms = jiffies_to_msecs(jiffies);
1350 srp->header.duration = (ms > srp->header.duration) ?
1351 (ms - srp->header.duration) : 0;
1352 if (0 != result) {
1353 struct scsi_sense_hdr sshdr;
1354
1355 srp->header.status = 0xff & result;
1356 srp->header.masked_status = sg_status_byte(result);
1357 srp->header.msg_status = COMMAND_COMPLETE;
1358 srp->header.host_status = host_byte(result);
1359 srp->header.driver_status = driver_byte(result);
1360 if ((sdp->sgdebug > 0) &&
1361 ((CHECK_CONDITION == srp->header.masked_status) ||
1362 (COMMAND_TERMINATED == srp->header.masked_status)))
1363 __scsi_print_sense(sdp->device, __func__, sense,
1364 SCSI_SENSE_BUFFERSIZE);
1365
1366 /* Following if statement is a patch supplied by Eric Youngdale */
1367 if (driver_byte(result) != 0
1368 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
1369 && !scsi_sense_is_deferred(&sshdr)
1370 && sshdr.sense_key == UNIT_ATTENTION
1371 && sdp->device->removable) {
1372 /* Detected possible disc change. Set the bit - this */
1373 /* may be used if there are filesystems using this device */
1374 sdp->device->changed = 1;
1375 }
1376 }
1377
1378 if (scmd->sense_len)
1379 memcpy(srp->sense_b, scmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
1380
1381 /* Rely on write phase to clean out srp status values, so no "else" */
1382
1383 /*
1384 * Free the request as soon as it is complete so that its resources
1385 * can be reused without waiting for userspace to read() the
1386 * result. But keep the associated bio (if any) around until
1387 * blk_rq_unmap_user() can be called from user context.
1388 */
1389 srp->rq = NULL;
1390 blk_mq_free_request(rq);
1391
1392 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1393 if (unlikely(srp->orphan)) {
1394 if (sfp->keep_orphan)
1395 srp->sg_io_owned = 0;
1396 else
1397 done = 0;
1398 }
1399 srp->done = done;
1400 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1401
1402 if (likely(done)) {
1403 /* Now wake up any sg_read() that is waiting for this
1404 * packet.
1405 */
1406 wake_up_interruptible(&sfp->read_wait);
1407 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
1408 kref_put(&sfp->f_ref, sg_remove_sfp);
1409 } else {
1410 INIT_WORK(&srp->ew.work, sg_rq_end_io_usercontext);
1411 schedule_work(&srp->ew.work);
1412 }
1413 return RQ_END_IO_NONE;
1414}
1415
1416static const struct file_operations sg_fops = {
1417 .owner = THIS_MODULE,
1418 .read = sg_read,
1419 .write = sg_write,
1420 .poll = sg_poll,
1421 .unlocked_ioctl = sg_ioctl,
1422 .compat_ioctl = compat_ptr_ioctl,
1423 .open = sg_open,
1424 .mmap = sg_mmap,
1425 .release = sg_release,
1426 .fasync = sg_fasync,
1427 .llseek = no_llseek,
1428};
1429
1430static const struct class sg_sysfs_class = {
1431 .name = "scsi_generic"
1432};
1433
1434static int sg_sysfs_valid = 0;
1435
1436static Sg_device *
1437sg_alloc(struct scsi_device *scsidp)
1438{
1439 struct request_queue *q = scsidp->request_queue;
1440 Sg_device *sdp;
1441 unsigned long iflags;
1442 int error;
1443 u32 k;
1444
1445 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
1446 if (!sdp) {
1447 sdev_printk(KERN_WARNING, scsidp, "%s: kmalloc Sg_device "
1448 "failure\n", __func__);
1449 return ERR_PTR(-ENOMEM);
1450 }
1451
1452 idr_preload(GFP_KERNEL);
1453 write_lock_irqsave(&sg_index_lock, iflags);
1454
1455 error = idr_alloc(&sg_index_idr, sdp, 0, SG_MAX_DEVS, GFP_NOWAIT);
1456 if (error < 0) {
1457 if (error == -ENOSPC) {
1458 sdev_printk(KERN_WARNING, scsidp,
1459 "Unable to attach sg device type=%d, minor number exceeds %d\n",
1460 scsidp->type, SG_MAX_DEVS - 1);
1461 error = -ENODEV;
1462 } else {
1463 sdev_printk(KERN_WARNING, scsidp, "%s: idr "
1464 "allocation Sg_device failure: %d\n",
1465 __func__, error);
1466 }
1467 goto out_unlock;
1468 }
1469 k = error;
1470
1471 SCSI_LOG_TIMEOUT(3, sdev_printk(KERN_INFO, scsidp,
1472 "sg_alloc: dev=%d \n", k));
1473 sprintf(sdp->name, "sg%d", k);
1474 sdp->device = scsidp;
1475 mutex_init(&sdp->open_rel_lock);
1476 INIT_LIST_HEAD(&sdp->sfds);
1477 init_waitqueue_head(&sdp->open_wait);
1478 atomic_set(&sdp->detaching, 0);
1479 rwlock_init(&sdp->sfd_lock);
1480 sdp->sg_tablesize = queue_max_segments(q);
1481 sdp->index = k;
1482 kref_init(&sdp->d_ref);
1483 error = 0;
1484
1485out_unlock:
1486 write_unlock_irqrestore(&sg_index_lock, iflags);
1487 idr_preload_end();
1488
1489 if (error) {
1490 kfree(sdp);
1491 return ERR_PTR(error);
1492 }
1493 return sdp;
1494}
1495
1496static int
1497sg_add_device(struct device *cl_dev)
1498{
1499 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1500 Sg_device *sdp = NULL;
1501 struct cdev * cdev = NULL;
1502 int error;
1503 unsigned long iflags;
1504
1505 if (!blk_get_queue(scsidp->request_queue)) {
1506 pr_warn("%s: get scsi_device queue failed\n", __func__);
1507 return -ENODEV;
1508 }
1509
1510 error = -ENOMEM;
1511 cdev = cdev_alloc();
1512 if (!cdev) {
1513 pr_warn("%s: cdev_alloc failed\n", __func__);
1514 goto out;
1515 }
1516 cdev->owner = THIS_MODULE;
1517 cdev->ops = &sg_fops;
1518
1519 sdp = sg_alloc(scsidp);
1520 if (IS_ERR(sdp)) {
1521 pr_warn("%s: sg_alloc failed\n", __func__);
1522 error = PTR_ERR(sdp);
1523 goto out;
1524 }
1525
1526 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
1527 if (error)
1528 goto cdev_add_err;
1529
1530 sdp->cdev = cdev;
1531 if (sg_sysfs_valid) {
1532 struct device *sg_class_member;
1533
1534 sg_class_member = device_create(&sg_sysfs_class, cl_dev->parent,
1535 MKDEV(SCSI_GENERIC_MAJOR,
1536 sdp->index),
1537 sdp, "%s", sdp->name);
1538 if (IS_ERR(sg_class_member)) {
1539 pr_err("%s: device_create failed\n", __func__);
1540 error = PTR_ERR(sg_class_member);
1541 goto cdev_add_err;
1542 }
1543 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1544 &sg_class_member->kobj, "generic");
1545 if (error)
1546 pr_err("%s: unable to make symlink 'generic' back "
1547 "to sg%d\n", __func__, sdp->index);
1548 } else
1549 pr_warn("%s: sg_sys Invalid\n", __func__);
1550
1551 sdev_printk(KERN_NOTICE, scsidp, "Attached scsi generic sg%d "
1552 "type %d\n", sdp->index, scsidp->type);
1553
1554 dev_set_drvdata(cl_dev, sdp);
1555
1556 return 0;
1557
1558cdev_add_err:
1559 write_lock_irqsave(&sg_index_lock, iflags);
1560 idr_remove(&sg_index_idr, sdp->index);
1561 write_unlock_irqrestore(&sg_index_lock, iflags);
1562 kfree(sdp);
1563
1564out:
1565 if (cdev)
1566 cdev_del(cdev);
1567 blk_put_queue(scsidp->request_queue);
1568 return error;
1569}
1570
1571static void
1572sg_device_destroy(struct kref *kref)
1573{
1574 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1575 struct request_queue *q = sdp->device->request_queue;
1576 unsigned long flags;
1577
1578 /* CAUTION! Note that the device can still be found via idr_find()
1579 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1580 * any other cleanup.
1581 */
1582
1583 blk_trace_remove(q);
1584 blk_put_queue(q);
1585
1586 write_lock_irqsave(&sg_index_lock, flags);
1587 idr_remove(&sg_index_idr, sdp->index);
1588 write_unlock_irqrestore(&sg_index_lock, flags);
1589
1590 SCSI_LOG_TIMEOUT(3,
1591 sg_printk(KERN_INFO, sdp, "sg_device_destroy\n"));
1592
1593 kfree(sdp);
1594}
1595
1596static void
1597sg_remove_device(struct device *cl_dev)
1598{
1599 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1600 Sg_device *sdp = dev_get_drvdata(cl_dev);
1601 unsigned long iflags;
1602 Sg_fd *sfp;
1603 int val;
1604
1605 if (!sdp)
1606 return;
1607 /* want sdp->detaching non-zero as soon as possible */
1608 val = atomic_inc_return(&sdp->detaching);
1609 if (val > 1)
1610 return; /* only want to do following once per device */
1611
1612 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
1613 "%s\n", __func__));
1614
1615 read_lock_irqsave(&sdp->sfd_lock, iflags);
1616 list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
1617 wake_up_interruptible_all(&sfp->read_wait);
1618 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
1619 }
1620 wake_up_interruptible_all(&sdp->open_wait);
1621 read_unlock_irqrestore(&sdp->sfd_lock, iflags);
1622
1623 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
1624 device_destroy(&sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
1625 cdev_del(sdp->cdev);
1626 sdp->cdev = NULL;
1627
1628 kref_put(&sdp->d_ref, sg_device_destroy);
1629}
1630
1631module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1632module_param_named(def_reserved_size, def_reserved_size, int,
1633 S_IRUGO | S_IWUSR);
1634module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1635
1636MODULE_AUTHOR("Douglas Gilbert");
1637MODULE_DESCRIPTION("SCSI generic (sg) driver");
1638MODULE_LICENSE("GPL");
1639MODULE_VERSION(SG_VERSION_STR);
1640MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
1641
1642MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1643 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1644MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1645MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1646
1647#ifdef CONFIG_SYSCTL
1648#include <linux/sysctl.h>
1649
1650static struct ctl_table sg_sysctls[] = {
1651 {
1652 .procname = "sg-big-buff",
1653 .data = &sg_big_buff,
1654 .maxlen = sizeof(int),
1655 .mode = 0444,
1656 .proc_handler = proc_dointvec,
1657 },
1658};
1659
1660static struct ctl_table_header *hdr;
1661static void register_sg_sysctls(void)
1662{
1663 if (!hdr)
1664 hdr = register_sysctl("kernel", sg_sysctls);
1665}
1666
1667static void unregister_sg_sysctls(void)
1668{
1669 if (hdr)
1670 unregister_sysctl_table(hdr);
1671}
1672#else
1673#define register_sg_sysctls() do { } while (0)
1674#define unregister_sg_sysctls() do { } while (0)
1675#endif /* CONFIG_SYSCTL */
1676
1677static int __init
1678init_sg(void)
1679{
1680 int rc;
1681
1682 if (scatter_elem_sz < PAGE_SIZE) {
1683 scatter_elem_sz = PAGE_SIZE;
1684 scatter_elem_sz_prev = scatter_elem_sz;
1685 }
1686 if (def_reserved_size >= 0)
1687 sg_big_buff = def_reserved_size;
1688 else
1689 def_reserved_size = sg_big_buff;
1690
1691 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1692 SG_MAX_DEVS, "sg");
1693 if (rc)
1694 return rc;
1695 rc = class_register(&sg_sysfs_class);
1696 if (rc)
1697 goto err_out;
1698 sg_sysfs_valid = 1;
1699 rc = scsi_register_interface(&sg_interface);
1700 if (0 == rc) {
1701#ifdef CONFIG_SCSI_PROC_FS
1702 sg_proc_init();
1703#endif /* CONFIG_SCSI_PROC_FS */
1704 return 0;
1705 }
1706 class_unregister(&sg_sysfs_class);
1707 register_sg_sysctls();
1708err_out:
1709 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1710 return rc;
1711}
1712
1713static void __exit
1714exit_sg(void)
1715{
1716 unregister_sg_sysctls();
1717#ifdef CONFIG_SCSI_PROC_FS
1718 remove_proc_subtree("scsi/sg", NULL);
1719#endif /* CONFIG_SCSI_PROC_FS */
1720 scsi_unregister_interface(&sg_interface);
1721 class_unregister(&sg_sysfs_class);
1722 sg_sysfs_valid = 0;
1723 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1724 SG_MAX_DEVS);
1725 idr_destroy(&sg_index_idr);
1726}
1727
1728static int
1729sg_start_req(Sg_request *srp, unsigned char *cmd)
1730{
1731 int res;
1732 struct request *rq;
1733 Sg_fd *sfp = srp->parentfp;
1734 sg_io_hdr_t *hp = &srp->header;
1735 int dxfer_len = (int) hp->dxfer_len;
1736 int dxfer_dir = hp->dxfer_direction;
1737 unsigned int iov_count = hp->iovec_count;
1738 Sg_scatter_hold *req_schp = &srp->data;
1739 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1740 struct request_queue *q = sfp->parentdp->device->request_queue;
1741 struct rq_map_data *md, map_data;
1742 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? ITER_SOURCE : ITER_DEST;
1743 struct scsi_cmnd *scmd;
1744
1745 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1746 "sg_start_req: dxfer_len=%d\n",
1747 dxfer_len));
1748
1749 /*
1750 * NOTE
1751 *
1752 * With scsi-mq enabled, there are a fixed number of preallocated
1753 * requests equal in number to shost->can_queue. If all of the
1754 * preallocated requests are already in use, then scsi_alloc_request()
1755 * will sleep until an active command completes, freeing up a request.
1756 * Although waiting in an asynchronous interface is less than ideal, we
1757 * do not want to use BLK_MQ_REQ_NOWAIT here because userspace might
1758 * not expect an EWOULDBLOCK from this condition.
1759 */
1760 rq = scsi_alloc_request(q, hp->dxfer_direction == SG_DXFER_TO_DEV ?
1761 REQ_OP_DRV_OUT : REQ_OP_DRV_IN, 0);
1762 if (IS_ERR(rq))
1763 return PTR_ERR(rq);
1764 scmd = blk_mq_rq_to_pdu(rq);
1765
1766 if (hp->cmd_len > sizeof(scmd->cmnd)) {
1767 blk_mq_free_request(rq);
1768 return -EINVAL;
1769 }
1770
1771 memcpy(scmd->cmnd, cmd, hp->cmd_len);
1772 scmd->cmd_len = hp->cmd_len;
1773
1774 srp->rq = rq;
1775 rq->end_io_data = srp;
1776 scmd->allowed = SG_DEFAULT_RETRIES;
1777
1778 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1779 return 0;
1780
1781 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1782 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1783 blk_rq_aligned(q, (unsigned long)hp->dxferp, dxfer_len))
1784 md = NULL;
1785 else
1786 md = &map_data;
1787
1788 if (md) {
1789 mutex_lock(&sfp->f_mutex);
1790 if (dxfer_len <= rsv_schp->bufflen &&
1791 !sfp->res_in_use) {
1792 sfp->res_in_use = 1;
1793 sg_link_reserve(sfp, srp, dxfer_len);
1794 } else if (hp->flags & SG_FLAG_MMAP_IO) {
1795 res = -EBUSY; /* sfp->res_in_use == 1 */
1796 if (dxfer_len > rsv_schp->bufflen)
1797 res = -ENOMEM;
1798 mutex_unlock(&sfp->f_mutex);
1799 return res;
1800 } else {
1801 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1802 if (res) {
1803 mutex_unlock(&sfp->f_mutex);
1804 return res;
1805 }
1806 }
1807 mutex_unlock(&sfp->f_mutex);
1808
1809 md->pages = req_schp->pages;
1810 md->page_order = req_schp->page_order;
1811 md->nr_entries = req_schp->k_use_sg;
1812 md->offset = 0;
1813 md->null_mapped = hp->dxferp ? 0 : 1;
1814 if (dxfer_dir == SG_DXFER_TO_FROM_DEV)
1815 md->from_user = 1;
1816 else
1817 md->from_user = 0;
1818 }
1819
1820 res = blk_rq_map_user_io(rq, md, hp->dxferp, hp->dxfer_len,
1821 GFP_ATOMIC, iov_count, iov_count, 1, rw);
1822 if (!res) {
1823 srp->bio = rq->bio;
1824
1825 if (!md) {
1826 req_schp->dio_in_use = 1;
1827 hp->info |= SG_INFO_DIRECT_IO;
1828 }
1829 }
1830 return res;
1831}
1832
1833static int
1834sg_finish_rem_req(Sg_request *srp)
1835{
1836 int ret = 0;
1837
1838 Sg_fd *sfp = srp->parentfp;
1839 Sg_scatter_hold *req_schp = &srp->data;
1840
1841 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1842 "sg_finish_rem_req: res_used=%d\n",
1843 (int) srp->res_used));
1844 if (srp->bio)
1845 ret = blk_rq_unmap_user(srp->bio);
1846
1847 if (srp->rq)
1848 blk_mq_free_request(srp->rq);
1849
1850 if (srp->res_used)
1851 sg_unlink_reserve(sfp, srp);
1852 else
1853 sg_remove_scat(sfp, req_schp);
1854
1855 return ret;
1856}
1857
1858static int
1859sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1860{
1861 int sg_bufflen = tablesize * sizeof(struct page *);
1862 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
1863
1864 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1865 if (!schp->pages)
1866 return -ENOMEM;
1867 schp->sglist_len = sg_bufflen;
1868 return tablesize; /* number of scat_gath elements allocated */
1869}
1870
1871static int
1872sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1873{
1874 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
1875 int sg_tablesize = sfp->parentdp->sg_tablesize;
1876 int blk_size = buff_size, order;
1877 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN | __GFP_ZERO;
1878
1879 if (blk_size < 0)
1880 return -EFAULT;
1881 if (0 == blk_size)
1882 ++blk_size; /* don't know why */
1883 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1884 blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
1885 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1886 "sg_build_indirect: buff_size=%d, blk_size=%d\n",
1887 buff_size, blk_size));
1888
1889 /* N.B. ret_sz carried into this block ... */
1890 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1891 if (mx_sc_elems < 0)
1892 return mx_sc_elems; /* most likely -ENOMEM */
1893
1894 num = scatter_elem_sz;
1895 if (unlikely(num != scatter_elem_sz_prev)) {
1896 if (num < PAGE_SIZE) {
1897 scatter_elem_sz = PAGE_SIZE;
1898 scatter_elem_sz_prev = PAGE_SIZE;
1899 } else
1900 scatter_elem_sz_prev = num;
1901 }
1902
1903 order = get_order(num);
1904retry:
1905 ret_sz = 1 << (PAGE_SHIFT + order);
1906
1907 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1908 k++, rem_sz -= ret_sz) {
1909
1910 num = (rem_sz > scatter_elem_sz_prev) ?
1911 scatter_elem_sz_prev : rem_sz;
1912
1913 schp->pages[k] = alloc_pages(gfp_mask, order);
1914 if (!schp->pages[k])
1915 goto out;
1916
1917 if (num == scatter_elem_sz_prev) {
1918 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1919 scatter_elem_sz = ret_sz;
1920 scatter_elem_sz_prev = ret_sz;
1921 }
1922 }
1923
1924 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1925 "sg_build_indirect: k=%d, num=%d, ret_sz=%d\n",
1926 k, num, ret_sz));
1927 } /* end of for loop */
1928
1929 schp->page_order = order;
1930 schp->k_use_sg = k;
1931 SCSI_LOG_TIMEOUT(5, sg_printk(KERN_INFO, sfp->parentdp,
1932 "sg_build_indirect: k_use_sg=%d, rem_sz=%d\n",
1933 k, rem_sz));
1934
1935 schp->bufflen = blk_size;
1936 if (rem_sz > 0) /* must have failed */
1937 return -ENOMEM;
1938 return 0;
1939out:
1940 for (i = 0; i < k; i++)
1941 __free_pages(schp->pages[i], order);
1942
1943 if (--order >= 0)
1944 goto retry;
1945
1946 return -ENOMEM;
1947}
1948
1949static void
1950sg_remove_scat(Sg_fd * sfp, Sg_scatter_hold * schp)
1951{
1952 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
1953 "sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
1954 if (schp->pages && schp->sglist_len > 0) {
1955 if (!schp->dio_in_use) {
1956 int k;
1957
1958 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1959 SCSI_LOG_TIMEOUT(5,
1960 sg_printk(KERN_INFO, sfp->parentdp,
1961 "sg_remove_scat: k=%d, pg=0x%p\n",
1962 k, schp->pages[k]));
1963 __free_pages(schp->pages[k], schp->page_order);
1964 }
1965
1966 kfree(schp->pages);
1967 }
1968 }
1969 memset(schp, 0, sizeof (*schp));
1970}
1971
1972static int
1973sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1974{
1975 Sg_scatter_hold *schp = &srp->data;
1976 int k, num;
1977
1978 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
1979 "sg_read_oxfer: num_read_xfer=%d\n",
1980 num_read_xfer));
1981 if ((!outp) || (num_read_xfer <= 0))
1982 return 0;
1983
1984 num = 1 << (PAGE_SHIFT + schp->page_order);
1985 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1986 if (num > num_read_xfer) {
1987 if (copy_to_user(outp, page_address(schp->pages[k]),
1988 num_read_xfer))
1989 return -EFAULT;
1990 break;
1991 } else {
1992 if (copy_to_user(outp, page_address(schp->pages[k]),
1993 num))
1994 return -EFAULT;
1995 num_read_xfer -= num;
1996 if (num_read_xfer <= 0)
1997 break;
1998 outp += num;
1999 }
2000 }
2001
2002 return 0;
2003}
2004
2005static void
2006sg_build_reserve(Sg_fd * sfp, int req_size)
2007{
2008 Sg_scatter_hold *schp = &sfp->reserve;
2009
2010 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
2011 "sg_build_reserve: req_size=%d\n", req_size));
2012 do {
2013 if (req_size < PAGE_SIZE)
2014 req_size = PAGE_SIZE;
2015 if (0 == sg_build_indirect(schp, sfp, req_size))
2016 return;
2017 else
2018 sg_remove_scat(sfp, schp);
2019 req_size >>= 1; /* divide by 2 */
2020 } while (req_size > (PAGE_SIZE / 2));
2021}
2022
2023static void
2024sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
2025{
2026 Sg_scatter_hold *req_schp = &srp->data;
2027 Sg_scatter_hold *rsv_schp = &sfp->reserve;
2028 int k, num, rem;
2029
2030 srp->res_used = 1;
2031 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, sfp->parentdp,
2032 "sg_link_reserve: size=%d\n", size));
2033 rem = size;
2034
2035 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
2036 for (k = 0; k < rsv_schp->k_use_sg; k++) {
2037 if (rem <= num) {
2038 req_schp->k_use_sg = k + 1;
2039 req_schp->sglist_len = rsv_schp->sglist_len;
2040 req_schp->pages = rsv_schp->pages;
2041
2042 req_schp->bufflen = size;
2043 req_schp->page_order = rsv_schp->page_order;
2044 break;
2045 } else
2046 rem -= num;
2047 }
2048
2049 if (k >= rsv_schp->k_use_sg)
2050 SCSI_LOG_TIMEOUT(1, sg_printk(KERN_INFO, sfp->parentdp,
2051 "sg_link_reserve: BAD size\n"));
2052}
2053
2054static void
2055sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
2056{
2057 Sg_scatter_hold *req_schp = &srp->data;
2058
2059 SCSI_LOG_TIMEOUT(4, sg_printk(KERN_INFO, srp->parentfp->parentdp,
2060 "sg_unlink_reserve: req->k_use_sg=%d\n",
2061 (int) req_schp->k_use_sg));
2062 req_schp->k_use_sg = 0;
2063 req_schp->bufflen = 0;
2064 req_schp->pages = NULL;
2065 req_schp->page_order = 0;
2066 req_schp->sglist_len = 0;
2067 srp->res_used = 0;
2068 /* Called without mutex lock to avoid deadlock */
2069 sfp->res_in_use = 0;
2070}
2071
2072static Sg_request *
2073sg_get_rq_mark(Sg_fd * sfp, int pack_id, bool *busy)
2074{
2075 Sg_request *resp;
2076 unsigned long iflags;
2077
2078 *busy = false;
2079 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2080 list_for_each_entry(resp, &sfp->rq_list, entry) {
2081 /* look for requests that are not SG_IO owned */
2082 if ((!resp->sg_io_owned) &&
2083 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
2084 switch (resp->done) {
2085 case 0: /* request active */
2086 *busy = true;
2087 break;
2088 case 1: /* request done; response ready to return */
2089 resp->done = 2; /* guard against other readers */
2090 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2091 return resp;
2092 case 2: /* response already being returned */
2093 break;
2094 }
2095 }
2096 }
2097 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2098 return NULL;
2099}
2100
2101/* always adds to end of list */
2102static Sg_request *
2103sg_add_request(Sg_fd * sfp)
2104{
2105 int k;
2106 unsigned long iflags;
2107 Sg_request *rp = sfp->req_arr;
2108
2109 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2110 if (!list_empty(&sfp->rq_list)) {
2111 if (!sfp->cmd_q)
2112 goto out_unlock;
2113
2114 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2115 if (!rp->parentfp)
2116 break;
2117 }
2118 if (k >= SG_MAX_QUEUE)
2119 goto out_unlock;
2120 }
2121 memset(rp, 0, sizeof (Sg_request));
2122 rp->parentfp = sfp;
2123 rp->header.duration = jiffies_to_msecs(jiffies);
2124 list_add_tail(&rp->entry, &sfp->rq_list);
2125 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2126 return rp;
2127out_unlock:
2128 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2129 return NULL;
2130}
2131
2132/* Return of 1 for found; 0 for not found */
2133static int
2134sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2135{
2136 unsigned long iflags;
2137 int res = 0;
2138
2139 if (!sfp || !srp || list_empty(&sfp->rq_list))
2140 return res;
2141 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2142 if (!list_empty(&srp->entry)) {
2143 list_del(&srp->entry);
2144 srp->parentfp = NULL;
2145 res = 1;
2146 }
2147 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2148
2149 /*
2150 * If the device is detaching, wakeup any readers in case we just
2151 * removed the last response, which would leave nothing for them to
2152 * return other than -ENODEV.
2153 */
2154 if (unlikely(atomic_read(&sfp->parentdp->detaching)))
2155 wake_up_interruptible_all(&sfp->read_wait);
2156
2157 return res;
2158}
2159
2160static Sg_fd *
2161sg_add_sfp(Sg_device * sdp)
2162{
2163 Sg_fd *sfp;
2164 unsigned long iflags;
2165 int bufflen;
2166
2167 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
2168 if (!sfp)
2169 return ERR_PTR(-ENOMEM);
2170
2171 init_waitqueue_head(&sfp->read_wait);
2172 rwlock_init(&sfp->rq_list_lock);
2173 INIT_LIST_HEAD(&sfp->rq_list);
2174 kref_init(&sfp->f_ref);
2175 mutex_init(&sfp->f_mutex);
2176 sfp->timeout = SG_DEFAULT_TIMEOUT;
2177 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2178 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2179 sfp->cmd_q = SG_DEF_COMMAND_Q;
2180 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2181 sfp->parentdp = sdp;
2182 write_lock_irqsave(&sdp->sfd_lock, iflags);
2183 if (atomic_read(&sdp->detaching)) {
2184 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
2185 kfree(sfp);
2186 return ERR_PTR(-ENODEV);
2187 }
2188 list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
2189 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
2190 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2191 "sg_add_sfp: sfp=0x%p\n", sfp));
2192 if (unlikely(sg_big_buff != def_reserved_size))
2193 sg_big_buff = def_reserved_size;
2194
2195 bufflen = min_t(int, sg_big_buff,
2196 max_sectors_bytes(sdp->device->request_queue));
2197 sg_build_reserve(sfp, bufflen);
2198 SCSI_LOG_TIMEOUT(3, sg_printk(KERN_INFO, sdp,
2199 "sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2200 sfp->reserve.bufflen,
2201 sfp->reserve.k_use_sg));
2202
2203 kref_get(&sdp->d_ref);
2204 __module_get(THIS_MODULE);
2205 return sfp;
2206}
2207
2208static void
2209sg_remove_sfp_usercontext(struct work_struct *work)
2210{
2211 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2212 struct sg_device *sdp = sfp->parentdp;
2213 struct scsi_device *device = sdp->device;
2214 Sg_request *srp;
2215 unsigned long iflags;
2216
2217 /* Cleanup any responses which were never read(). */
2218 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2219 while (!list_empty(&sfp->rq_list)) {
2220 srp = list_first_entry(&sfp->rq_list, Sg_request, entry);
2221 sg_finish_rem_req(srp);
2222 list_del(&srp->entry);
2223 srp->parentfp = NULL;
2224 }
2225 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2226
2227 if (sfp->reserve.bufflen > 0) {
2228 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2229 "sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2230 (int) sfp->reserve.bufflen,
2231 (int) sfp->reserve.k_use_sg));
2232 sg_remove_scat(sfp, &sfp->reserve);
2233 }
2234
2235 SCSI_LOG_TIMEOUT(6, sg_printk(KERN_INFO, sdp,
2236 "sg_remove_sfp: sfp=0x%p\n", sfp));
2237 kfree(sfp);
2238
2239 kref_put(&sdp->d_ref, sg_device_destroy);
2240 scsi_device_put(device);
2241 module_put(THIS_MODULE);
2242}
2243
2244static void
2245sg_remove_sfp(struct kref *kref)
2246{
2247 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
2248 struct sg_device *sdp = sfp->parentdp;
2249 unsigned long iflags;
2250
2251 write_lock_irqsave(&sdp->sfd_lock, iflags);
2252 list_del(&sfp->sfd_siblings);
2253 write_unlock_irqrestore(&sdp->sfd_lock, iflags);
2254
2255 INIT_WORK(&sfp->ew.work, sg_remove_sfp_usercontext);
2256 schedule_work(&sfp->ew.work);
2257}
2258
2259#ifdef CONFIG_SCSI_PROC_FS
2260static int
2261sg_idr_max_id(int id, void *p, void *data)
2262{
2263 int *k = data;
2264
2265 if (*k < id)
2266 *k = id;
2267
2268 return 0;
2269}
2270
2271static int
2272sg_last_dev(void)
2273{
2274 int k = -1;
2275 unsigned long iflags;
2276
2277 read_lock_irqsave(&sg_index_lock, iflags);
2278 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2279 read_unlock_irqrestore(&sg_index_lock, iflags);
2280 return k + 1; /* origin 1 */
2281}
2282#endif
2283
2284/* must be called with sg_index_lock held */
2285static Sg_device *sg_lookup_dev(int dev)
2286{
2287 return idr_find(&sg_index_idr, dev);
2288}
2289
2290static Sg_device *
2291sg_get_dev(int dev)
2292{
2293 struct sg_device *sdp;
2294 unsigned long flags;
2295
2296 read_lock_irqsave(&sg_index_lock, flags);
2297 sdp = sg_lookup_dev(dev);
2298 if (!sdp)
2299 sdp = ERR_PTR(-ENXIO);
2300 else if (atomic_read(&sdp->detaching)) {
2301 /* If sdp->detaching, then the refcount may already be 0, in
2302 * which case it would be a bug to do kref_get().
2303 */
2304 sdp = ERR_PTR(-ENODEV);
2305 } else
2306 kref_get(&sdp->d_ref);
2307 read_unlock_irqrestore(&sg_index_lock, flags);
2308
2309 return sdp;
2310}
2311
2312#ifdef CONFIG_SCSI_PROC_FS
2313static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2314
2315static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2316static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2317 size_t count, loff_t *off);
2318static const struct proc_ops adio_proc_ops = {
2319 .proc_open = sg_proc_single_open_adio,
2320 .proc_read = seq_read,
2321 .proc_lseek = seq_lseek,
2322 .proc_write = sg_proc_write_adio,
2323 .proc_release = single_release,
2324};
2325
2326static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2327static ssize_t sg_proc_write_dressz(struct file *filp,
2328 const char __user *buffer, size_t count, loff_t *off);
2329static const struct proc_ops dressz_proc_ops = {
2330 .proc_open = sg_proc_single_open_dressz,
2331 .proc_read = seq_read,
2332 .proc_lseek = seq_lseek,
2333 .proc_write = sg_proc_write_dressz,
2334 .proc_release = single_release,
2335};
2336
2337static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2338static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2339static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2340static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2341static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2342static void dev_seq_stop(struct seq_file *s, void *v);
2343static const struct seq_operations dev_seq_ops = {
2344 .start = dev_seq_start,
2345 .next = dev_seq_next,
2346 .stop = dev_seq_stop,
2347 .show = sg_proc_seq_show_dev,
2348};
2349
2350static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2351static const struct seq_operations devstrs_seq_ops = {
2352 .start = dev_seq_start,
2353 .next = dev_seq_next,
2354 .stop = dev_seq_stop,
2355 .show = sg_proc_seq_show_devstrs,
2356};
2357
2358static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2359static const struct seq_operations debug_seq_ops = {
2360 .start = dev_seq_start,
2361 .next = dev_seq_next,
2362 .stop = dev_seq_stop,
2363 .show = sg_proc_seq_show_debug,
2364};
2365
2366static int
2367sg_proc_init(void)
2368{
2369 struct proc_dir_entry *p;
2370
2371 p = proc_mkdir("scsi/sg", NULL);
2372 if (!p)
2373 return 1;
2374
2375 proc_create("allow_dio", S_IRUGO | S_IWUSR, p, &adio_proc_ops);
2376 proc_create_seq("debug", S_IRUGO, p, &debug_seq_ops);
2377 proc_create("def_reserved_size", S_IRUGO | S_IWUSR, p, &dressz_proc_ops);
2378 proc_create_single("device_hdr", S_IRUGO, p, sg_proc_seq_show_devhdr);
2379 proc_create_seq("devices", S_IRUGO, p, &dev_seq_ops);
2380 proc_create_seq("device_strs", S_IRUGO, p, &devstrs_seq_ops);
2381 proc_create_single("version", S_IRUGO, p, sg_proc_seq_show_version);
2382 return 0;
2383}
2384
2385
2386static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2387{
2388 seq_printf(s, "%d\n", *((int *)s->private));
2389 return 0;
2390}
2391
2392static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2393{
2394 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2395}
2396
2397static ssize_t
2398sg_proc_write_adio(struct file *filp, const char __user *buffer,
2399 size_t count, loff_t *off)
2400{
2401 int err;
2402 unsigned long num;
2403
2404 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2405 return -EACCES;
2406 err = kstrtoul_from_user(buffer, count, 0, &num);
2407 if (err)
2408 return err;
2409 sg_allow_dio = num ? 1 : 0;
2410 return count;
2411}
2412
2413static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2414{
2415 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2416}
2417
2418static ssize_t
2419sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2420 size_t count, loff_t *off)
2421{
2422 int err;
2423 unsigned long k = ULONG_MAX;
2424
2425 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2426 return -EACCES;
2427
2428 err = kstrtoul_from_user(buffer, count, 0, &k);
2429 if (err)
2430 return err;
2431 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2432 sg_big_buff = k;
2433 return count;
2434 }
2435 return -ERANGE;
2436}
2437
2438static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2439{
2440 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2441 sg_version_date);
2442 return 0;
2443}
2444
2445static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2446{
2447 seq_puts(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\tonline\n");
2448 return 0;
2449}
2450
2451struct sg_proc_deviter {
2452 loff_t index;
2453 size_t max;
2454};
2455
2456static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2457{
2458 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2459
2460 s->private = it;
2461 if (! it)
2462 return NULL;
2463
2464 it->index = *pos;
2465 it->max = sg_last_dev();
2466 if (it->index >= it->max)
2467 return NULL;
2468 return it;
2469}
2470
2471static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2472{
2473 struct sg_proc_deviter * it = s->private;
2474
2475 *pos = ++it->index;
2476 return (it->index < it->max) ? it : NULL;
2477}
2478
2479static void dev_seq_stop(struct seq_file *s, void *v)
2480{
2481 kfree(s->private);
2482}
2483
2484static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2485{
2486 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2487 Sg_device *sdp;
2488 struct scsi_device *scsidp;
2489 unsigned long iflags;
2490
2491 read_lock_irqsave(&sg_index_lock, iflags);
2492 sdp = it ? sg_lookup_dev(it->index) : NULL;
2493 if ((NULL == sdp) || (NULL == sdp->device) ||
2494 (atomic_read(&sdp->detaching)))
2495 seq_puts(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2496 else {
2497 scsidp = sdp->device;
2498 seq_printf(s, "%d\t%d\t%d\t%llu\t%d\t%d\t%d\t%d\t%d\n",
2499 scsidp->host->host_no, scsidp->channel,
2500 scsidp->id, scsidp->lun, (int) scsidp->type,
2501 1,
2502 (int) scsidp->queue_depth,
2503 (int) scsi_device_busy(scsidp),
2504 (int) scsi_device_online(scsidp));
2505 }
2506 read_unlock_irqrestore(&sg_index_lock, iflags);
2507 return 0;
2508}
2509
2510static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2511{
2512 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2513 Sg_device *sdp;
2514 struct scsi_device *scsidp;
2515 unsigned long iflags;
2516
2517 read_lock_irqsave(&sg_index_lock, iflags);
2518 sdp = it ? sg_lookup_dev(it->index) : NULL;
2519 scsidp = sdp ? sdp->device : NULL;
2520 if (sdp && scsidp && (!atomic_read(&sdp->detaching)))
2521 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2522 scsidp->vendor, scsidp->model, scsidp->rev);
2523 else
2524 seq_puts(s, "<no active device>\n");
2525 read_unlock_irqrestore(&sg_index_lock, iflags);
2526 return 0;
2527}
2528
2529/* must be called while holding sg_index_lock */
2530static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2531{
2532 int k, new_interface, blen, usg;
2533 Sg_request *srp;
2534 Sg_fd *fp;
2535 const sg_io_hdr_t *hp;
2536 const char * cp;
2537 unsigned int ms;
2538
2539 k = 0;
2540 list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
2541 k++;
2542 read_lock(&fp->rq_list_lock); /* irqs already disabled */
2543 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
2544 "(res)sgat=%d low_dma=%d\n", k,
2545 jiffies_to_msecs(fp->timeout),
2546 fp->reserve.bufflen,
2547 (int) fp->reserve.k_use_sg, 0);
2548 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=0\n",
2549 (int) fp->cmd_q, (int) fp->force_packid,
2550 (int) fp->keep_orphan);
2551 list_for_each_entry(srp, &fp->rq_list, entry) {
2552 hp = &srp->header;
2553 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2554 if (srp->res_used) {
2555 if (new_interface &&
2556 (SG_FLAG_MMAP_IO & hp->flags))
2557 cp = " mmap>> ";
2558 else
2559 cp = " rb>> ";
2560 } else {
2561 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2562 cp = " dio>> ";
2563 else
2564 cp = " ";
2565 }
2566 seq_puts(s, cp);
2567 blen = srp->data.bufflen;
2568 usg = srp->data.k_use_sg;
2569 seq_puts(s, srp->done ?
2570 ((1 == srp->done) ? "rcv:" : "fin:")
2571 : "act:");
2572 seq_printf(s, " id=%d blen=%d",
2573 srp->header.pack_id, blen);
2574 if (srp->done)
2575 seq_printf(s, " dur=%d", hp->duration);
2576 else {
2577 ms = jiffies_to_msecs(jiffies);
2578 seq_printf(s, " t_o/elap=%d/%d",
2579 (new_interface ? hp->timeout :
2580 jiffies_to_msecs(fp->timeout)),
2581 (ms > hp->duration ? ms - hp->duration : 0));
2582 }
2583 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2584 (int) srp->data.cmd_opcode);
2585 }
2586 if (list_empty(&fp->rq_list))
2587 seq_puts(s, " No requests active\n");
2588 read_unlock(&fp->rq_list_lock);
2589 }
2590}
2591
2592static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2593{
2594 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2595 Sg_device *sdp;
2596 unsigned long iflags;
2597
2598 if (it && (0 == it->index))
2599 seq_printf(s, "max_active_device=%d def_reserved_size=%d\n",
2600 (int)it->max, sg_big_buff);
2601
2602 read_lock_irqsave(&sg_index_lock, iflags);
2603 sdp = it ? sg_lookup_dev(it->index) : NULL;
2604 if (NULL == sdp)
2605 goto skip;
2606 read_lock(&sdp->sfd_lock);
2607 if (!list_empty(&sdp->sfds)) {
2608 seq_printf(s, " >>> device=%s ", sdp->name);
2609 if (atomic_read(&sdp->detaching))
2610 seq_puts(s, "detaching pending close ");
2611 else if (sdp->device) {
2612 struct scsi_device *scsidp = sdp->device;
2613
2614 seq_printf(s, "%d:%d:%d:%llu em=%d",
2615 scsidp->host->host_no,
2616 scsidp->channel, scsidp->id,
2617 scsidp->lun,
2618 scsidp->host->hostt->emulated);
2619 }
2620 seq_printf(s, " sg_tablesize=%d excl=%d open_cnt=%d\n",
2621 sdp->sg_tablesize, sdp->exclude, sdp->open_cnt);
2622 sg_proc_debug_helper(s, sdp);
2623 }
2624 read_unlock(&sdp->sfd_lock);
2625skip:
2626 read_unlock_irqrestore(&sg_index_lock, iflags);
2627 return 0;
2628}
2629
2630#endif /* CONFIG_SCSI_PROC_FS */
2631
2632module_init(init_sg);
2633module_exit(exit_sg);