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