Merge tag 'v3.10.107' 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 570
823a2a03
AV
571 if (unlikely(segment_eq(get_fs(), KERNEL_DS)))
572 return -EINVAL;
573
1da177e4
LT
574 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
575 return -ENXIO;
576 SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
577 sdp->disk->disk_name, (int) count));
578 if (sdp->detached)
579 return -ENODEV;
580 if (!((filp->f_flags & O_NONBLOCK) ||
581 scsi_block_when_processing_errors(sdp->device)))
582 return -ENXIO;
583
584 if (!access_ok(VERIFY_READ, buf, count))
585 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
586 if (count < SZ_SG_HEADER)
587 return -EIO;
588 if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
589 return -EFAULT;
590 blocking = !(filp->f_flags & O_NONBLOCK);
591 if (old_hdr.reply_len < 0)
a2dd3b4c
TB
592 return sg_new_write(sfp, filp, buf, count,
593 blocking, 0, 0, NULL);
1da177e4
LT
594 if (count < (SZ_SG_HEADER + 6))
595 return -EIO; /* The minimum scsi command length is 6 bytes. */
596
597 if (!(srp = sg_add_request(sfp))) {
598 SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
599 return -EDOM;
600 }
601 buf += SZ_SG_HEADER;
602 __get_user(opcode, buf);
603 if (sfp->next_cmd_len > 0) {
604 if (sfp->next_cmd_len > MAX_COMMAND_SIZE) {
605 SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
606 sfp->next_cmd_len = 0;
607 sg_remove_request(sfp, srp);
608 return -EIO;
609 }
610 cmd_size = sfp->next_cmd_len;
611 sfp->next_cmd_len = 0; /* reset so only this write() effected */
612 } else {
613 cmd_size = COMMAND_SIZE(opcode); /* based on SCSI command group */
614 if ((opcode >= 0xc0) && old_hdr.twelve_byte)
615 cmd_size = 12;
616 }
617 SCSI_LOG_TIMEOUT(4, printk(
618 "sg_write: scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
619/* Determine buffer size. */
620 input_size = count - cmd_size;
621 mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
622 mxsize -= SZ_SG_HEADER;
623 input_size -= SZ_SG_HEADER;
624 if (input_size < 0) {
625 sg_remove_request(sfp, srp);
626 return -EIO; /* User did not pass enough bytes for this command. */
627 }
628 hp = &srp->header;
629 hp->interface_id = '\0'; /* indicator of old interface tunnelled */
630 hp->cmd_len = (unsigned char) cmd_size;
631 hp->iovec_count = 0;
632 hp->mx_sb_len = 0;
633 if (input_size > 0)
634 hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
635 SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
636 else
637 hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
638 hp->dxfer_len = mxsize;
64adb59f
DG
639 if ((hp->dxfer_direction == SG_DXFER_TO_DEV) ||
640 (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV))
fad7f01e
FT
641 hp->dxferp = (char __user *)buf + cmd_size;
642 else
643 hp->dxferp = NULL;
1da177e4
LT
644 hp->sbp = NULL;
645 hp->timeout = old_hdr.reply_len; /* structure abuse ... */
646 hp->flags = input_size; /* structure abuse ... */
647 hp->pack_id = old_hdr.pack_id;
648 hp->usr_ptr = NULL;
649 if (__copy_from_user(cmnd, buf, cmd_size))
650 return -EFAULT;
651 /*
652 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
653 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
654 * is a non-zero input_size, so emit a warning.
655 */
eaa3e22e
AK
656 if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV) {
657 static char cmd[TASK_COMM_LEN];
2fe038e3
CD
658 if (strcmp(current->comm, cmd)) {
659 printk_ratelimited(KERN_WARNING
660 "sg_write: data in/out %d/%d bytes "
661 "for SCSI command 0x%x-- guessing "
662 "data in;\n program %s not setting "
663 "count and/or reply_len properly\n",
664 old_hdr.reply_len - (int)SZ_SG_HEADER,
665 input_size, (unsigned int) cmnd[0],
666 current->comm);
eaa3e22e
AK
667 strcpy(cmd, current->comm);
668 }
669 }
1da177e4
LT
670 k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
671 return (k < 0) ? k : count;
672}
673
674static ssize_t
0b07de85 675sg_new_write(Sg_fd *sfp, struct file *file, const char __user *buf,
a2dd3b4c 676 size_t count, int blocking, int read_only, int sg_io_owned,
0b07de85 677 Sg_request **o_srp)
1da177e4
LT
678{
679 int k;
680 Sg_request *srp;
681 sg_io_hdr_t *hp;
d6b10348 682 unsigned char cmnd[MAX_COMMAND_SIZE];
1da177e4
LT
683 int timeout;
684 unsigned long ul_timeout;
685
686 if (count < SZ_SG_IO_HDR)
687 return -EINVAL;
688 if (!access_ok(VERIFY_READ, buf, count))
689 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
690
691 sfp->cmd_q = 1; /* when sg_io_hdr seen, set command queuing on */
692 if (!(srp = sg_add_request(sfp))) {
693 SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
694 return -EDOM;
695 }
a2dd3b4c 696 srp->sg_io_owned = sg_io_owned;
1da177e4
LT
697 hp = &srp->header;
698 if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
699 sg_remove_request(sfp, srp);
700 return -EFAULT;
701 }
702 if (hp->interface_id != 'S') {
703 sg_remove_request(sfp, srp);
704 return -ENOSYS;
705 }
706 if (hp->flags & SG_FLAG_MMAP_IO) {
707 if (hp->dxfer_len > sfp->reserve.bufflen) {
708 sg_remove_request(sfp, srp);
709 return -ENOMEM; /* MMAP_IO size must fit in reserve buffer */
710 }
711 if (hp->flags & SG_FLAG_DIRECT_IO) {
712 sg_remove_request(sfp, srp);
713 return -EINVAL; /* either MMAP_IO or DIRECT_IO (not both) */
714 }
715 if (sg_res_in_use(sfp)) {
716 sg_remove_request(sfp, srp);
717 return -EBUSY; /* reserve buffer already being used */
718 }
719 }
720 ul_timeout = msecs_to_jiffies(srp->header.timeout);
721 timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
722 if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
723 sg_remove_request(sfp, srp);
724 return -EMSGSIZE;
725 }
726 if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
727 sg_remove_request(sfp, srp);
728 return -EFAULT; /* protects following copy_from_user()s + get_user()s */
729 }
730 if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
731 sg_remove_request(sfp, srp);
732 return -EFAULT;
733 }
14e507b8 734 if (read_only && sg_allow_access(file, cmnd)) {
1da177e4
LT
735 sg_remove_request(sfp, srp);
736 return -EPERM;
737 }
738 k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
739 if (k < 0)
740 return k;
741 if (o_srp)
742 *o_srp = srp;
743 return count;
744}
745
746static int
747sg_common_write(Sg_fd * sfp, Sg_request * srp,
748 unsigned char *cmnd, int timeout, int blocking)
749{
d6b10348 750 int k, data_dir;
1da177e4
LT
751 Sg_device *sdp = sfp->parentdp;
752 sg_io_hdr_t *hp = &srp->header;
1da177e4
LT
753
754 srp->data.cmd_opcode = cmnd[0]; /* hold opcode of command */
755 hp->status = 0;
756 hp->masked_status = 0;
757 hp->msg_status = 0;
758 hp->info = 0;
759 hp->host_status = 0;
760 hp->driver_status = 0;
761 hp->resid = 0;
762 SCSI_LOG_TIMEOUT(4, printk("sg_common_write: scsi opcode=0x%02x, cmd_size=%d\n",
763 (int) cmnd[0], (int) hp->cmd_len));
764
10865dfa
FT
765 k = sg_start_req(srp, cmnd);
766 if (k) {
7ca63cb4 767 SCSI_LOG_TIMEOUT(1, printk("sg_common_write: start_req err=%d\n", k));
1da177e4
LT
768 sg_finish_rem_req(srp);
769 return k; /* probably out of space --> ENOMEM */
770 }
1da177e4 771 if (sdp->detached) {
dda50d92
CO
772 if (srp->bio) {
773 if (srp->rq->cmd != srp->rq->__cmd)
774 kfree(srp->rq->cmd);
775
caf19d38 776 blk_end_request_all(srp->rq, -EIO);
dda50d92
CO
777 srp->rq = NULL;
778 }
779
1da177e4
LT
780 sg_finish_rem_req(srp);
781 return -ENODEV;
782 }
1da177e4 783
1da177e4
LT
784 switch (hp->dxfer_direction) {
785 case SG_DXFER_TO_FROM_DEV:
786 case SG_DXFER_FROM_DEV:
d6b10348 787 data_dir = DMA_FROM_DEVICE;
1da177e4
LT
788 break;
789 case SG_DXFER_TO_DEV:
d6b10348 790 data_dir = DMA_TO_DEVICE;
1da177e4
LT
791 break;
792 case SG_DXFER_UNKNOWN:
d6b10348 793 data_dir = DMA_BIDIRECTIONAL;
1da177e4
LT
794 break;
795 default:
d6b10348 796 data_dir = DMA_NONE;
1da177e4
LT
797 break;
798 }
cb59e840 799 hp->duration = jiffies_to_msecs(jiffies);
10db10d1
FT
800
801 srp->rq->timeout = timeout;
c6517b79 802 kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
10db10d1
FT
803 blk_execute_rq_nowait(sdp->device->request_queue, sdp->disk,
804 srp->rq, 1, sg_rq_end_io);
805 return 0;
1da177e4
LT
806}
807
6acddc5e
JE
808static int srp_done(Sg_fd *sfp, Sg_request *srp)
809{
810 unsigned long flags;
811 int ret;
812
813 read_lock_irqsave(&sfp->rq_list_lock, flags);
814 ret = srp->done;
815 read_unlock_irqrestore(&sfp->rq_list_lock, flags);
816 return ret;
817}
818
37b9d1e0 819static long
f4927c45 820sg_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1da177e4
LT
821{
822 void __user *p = (void __user *)arg;
823 int __user *ip = p;
824 int result, val, read_only;
825 Sg_device *sdp;
826 Sg_fd *sfp;
827 Sg_request *srp;
828 unsigned long iflags;
829
830 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
831 return -ENXIO;
abf54393 832
1da177e4
LT
833 SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
834 sdp->disk->disk_name, (int) cmd_in));
835 read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));
836
837 switch (cmd_in) {
838 case SG_IO:
dddbf8d9
JE
839 if (sdp->detached)
840 return -ENODEV;
841 if (!scsi_block_when_processing_errors(sdp->device))
842 return -ENXIO;
843 if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
844 return -EFAULT;
845 result = sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
846 1, read_only, 1, &srp);
847 if (result < 0)
848 return result;
3f0c6aba 849 result = wait_event_interruptible(sfp->read_wait,
6acddc5e 850 (srp_done(sfp, srp) || sdp->detached));
794c10fa
JE
851 if (sdp->detached)
852 return -ENODEV;
853 write_lock_irq(&sfp->rq_list_lock);
854 if (srp->done) {
855 srp->done = 2;
dddbf8d9 856 write_unlock_irq(&sfp->rq_list_lock);
794c10fa
JE
857 result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
858 return (result < 0) ? result : 0;
1da177e4 859 }
794c10fa
JE
860 srp->orphan = 1;
861 write_unlock_irq(&sfp->rq_list_lock);
862 return result; /* -ERESTARTSYS because signal hit process */
1da177e4
LT
863 case SG_SET_TIMEOUT:
864 result = get_user(val, ip);
865 if (result)
866 return result;
867 if (val < 0)
868 return -EIO;
869 if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
870 val = MULDIV (INT_MAX, USER_HZ, HZ);
871 sfp->timeout_user = val;
872 sfp->timeout = MULDIV (val, HZ, USER_HZ);
873
874 return 0;
875 case SG_GET_TIMEOUT: /* N.B. User receives timeout as return value */
876 /* strange ..., for backward compatibility */
877 return sfp->timeout_user;
878 case SG_SET_FORCE_LOW_DMA:
879 result = get_user(val, ip);
880 if (result)
881 return result;
882 if (val) {
883 sfp->low_dma = 1;
884 if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
885 val = (int) sfp->reserve.bufflen;
886 sg_remove_scat(&sfp->reserve);
887 sg_build_reserve(sfp, val);
888 }
889 } else {
890 if (sdp->detached)
891 return -ENODEV;
892 sfp->low_dma = sdp->device->host->unchecked_isa_dma;
893 }
894 return 0;
895 case SG_GET_LOW_DMA:
896 return put_user((int) sfp->low_dma, ip);
897 case SG_GET_SCSI_ID:
898 if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
899 return -EFAULT;
900 else {
901 sg_scsi_id_t __user *sg_idp = p;
902
903 if (sdp->detached)
904 return -ENODEV;
905 __put_user((int) sdp->device->host->host_no,
906 &sg_idp->host_no);
907 __put_user((int) sdp->device->channel,
908 &sg_idp->channel);
909 __put_user((int) sdp->device->id, &sg_idp->scsi_id);
910 __put_user((int) sdp->device->lun, &sg_idp->lun);
911 __put_user((int) sdp->device->type, &sg_idp->scsi_type);
912 __put_user((short) sdp->device->host->cmd_per_lun,
913 &sg_idp->h_cmd_per_lun);
914 __put_user((short) sdp->device->queue_depth,
915 &sg_idp->d_queue_depth);
916 __put_user(0, &sg_idp->unused[0]);
917 __put_user(0, &sg_idp->unused[1]);
918 return 0;
919 }
920 case SG_SET_FORCE_PACK_ID:
921 result = get_user(val, ip);
922 if (result)
923 return result;
924 sfp->force_packid = val ? 1 : 0;
925 return 0;
926 case SG_GET_PACK_ID:
927 if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
928 return -EFAULT;
929 read_lock_irqsave(&sfp->rq_list_lock, iflags);
930 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
931 if ((1 == srp->done) && (!srp->sg_io_owned)) {
932 read_unlock_irqrestore(&sfp->rq_list_lock,
933 iflags);
934 __put_user(srp->header.pack_id, ip);
935 return 0;
936 }
937 }
938 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
939 __put_user(-1, ip);
940 return 0;
941 case SG_GET_NUM_WAITING:
942 read_lock_irqsave(&sfp->rq_list_lock, iflags);
943 for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
944 if ((1 == srp->done) && (!srp->sg_io_owned))
945 ++val;
946 }
947 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
948 return put_user(val, ip);
949 case SG_GET_SG_TABLESIZE:
950 return put_user(sdp->sg_tablesize, ip);
951 case SG_SET_RESERVED_SIZE:
952 result = get_user(val, ip);
953 if (result)
954 return result;
955 if (val < 0)
956 return -EINVAL;
44ec9542 957 val = min_t(int, val,
ae03bf63 958 queue_max_sectors(sdp->device->request_queue) * 512);
1da177e4
LT
959 if (val != sfp->reserve.bufflen) {
960 if (sg_res_in_use(sfp) || sfp->mmap_called)
961 return -EBUSY;
962 sg_remove_scat(&sfp->reserve);
963 sg_build_reserve(sfp, val);
964 }
965 return 0;
966 case SG_GET_RESERVED_SIZE:
44ec9542 967 val = min_t(int, sfp->reserve.bufflen,
ae03bf63 968 queue_max_sectors(sdp->device->request_queue) * 512);
1da177e4
LT
969 return put_user(val, ip);
970 case SG_SET_COMMAND_Q:
971 result = get_user(val, ip);
972 if (result)
973 return result;
974 sfp->cmd_q = val ? 1 : 0;
975 return 0;
976 case SG_GET_COMMAND_Q:
977 return put_user((int) sfp->cmd_q, ip);
978 case SG_SET_KEEP_ORPHAN:
979 result = get_user(val, ip);
980 if (result)
981 return result;
982 sfp->keep_orphan = val;
983 return 0;
984 case SG_GET_KEEP_ORPHAN:
985 return put_user((int) sfp->keep_orphan, ip);
986 case SG_NEXT_CMD_LEN:
987 result = get_user(val, ip);
988 if (result)
989 return result;
990 sfp->next_cmd_len = (val > 0) ? val : 0;
991 return 0;
992 case SG_GET_VERSION_NUM:
993 return put_user(sg_version_num, ip);
994 case SG_GET_ACCESS_COUNT:
995 /* faked - we don't have a real access count anymore */
996 val = (sdp->device ? 1 : 0);
997 return put_user(val, ip);
998 case SG_GET_REQUEST_TABLE:
999 if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
1000 return -EFAULT;
1001 else {
cb59e840
DG
1002 sg_req_info_t *rinfo;
1003 unsigned int ms;
1004
1005 rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
1006 GFP_KERNEL);
1007 if (!rinfo)
1008 return -ENOMEM;
1da177e4
LT
1009 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1010 for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
1011 ++val, srp = srp ? srp->nextrp : srp) {
1012 memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
1013 if (srp) {
1014 rinfo[val].req_state = srp->done + 1;
1015 rinfo[val].problem =
1016 srp->header.masked_status &
1017 srp->header.host_status &
1018 srp->header.driver_status;
cb59e840
DG
1019 if (srp->done)
1020 rinfo[val].duration =
1021 srp->header.duration;
1022 else {
1023 ms = jiffies_to_msecs(jiffies);
1024 rinfo[val].duration =
1025 (ms > srp->header.duration) ?
1026 (ms - srp->header.duration) : 0;
1027 }
1da177e4 1028 rinfo[val].orphan = srp->orphan;
cb59e840
DG
1029 rinfo[val].sg_io_owned =
1030 srp->sg_io_owned;
1031 rinfo[val].pack_id =
1032 srp->header.pack_id;
1033 rinfo[val].usr_ptr =
1034 srp->header.usr_ptr;
1da177e4
LT
1035 }
1036 }
1037 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
cb59e840
DG
1038 result = __copy_to_user(p, rinfo,
1039 SZ_SG_REQ_INFO * SG_MAX_QUEUE);
1040 result = result ? -EFAULT : 0;
1041 kfree(rinfo);
1042 return result;
1da177e4
LT
1043 }
1044 case SG_EMULATED_HOST:
1045 if (sdp->detached)
1046 return -ENODEV;
1047 return put_user(sdp->device->host->hostt->emulated, ip);
1048 case SG_SCSI_RESET:
1049 if (sdp->detached)
1050 return -ENODEV;
1051 if (filp->f_flags & O_NONBLOCK) {
939647ee 1052 if (scsi_host_in_recovery(sdp->device->host))
1da177e4
LT
1053 return -EBUSY;
1054 } else if (!scsi_block_when_processing_errors(sdp->device))
1055 return -EBUSY;
1056 result = get_user(val, ip);
1057 if (result)
1058 return result;
1059 if (SG_SCSI_RESET_NOTHING == val)
1060 return 0;
1061 switch (val) {
1062 case SG_SCSI_RESET_DEVICE:
1063 val = SCSI_TRY_RESET_DEVICE;
1064 break;
39120e11
BK
1065 case SG_SCSI_RESET_TARGET:
1066 val = SCSI_TRY_RESET_TARGET;
1067 break;
1da177e4
LT
1068 case SG_SCSI_RESET_BUS:
1069 val = SCSI_TRY_RESET_BUS;
1070 break;
1071 case SG_SCSI_RESET_HOST:
1072 val = SCSI_TRY_RESET_HOST;
1073 break;
1074 default:
1075 return -EINVAL;
1076 }
1077 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1078 return -EACCES;
1079 return (scsi_reset_provider(sdp->device, val) ==
1080 SUCCESS) ? 0 : -EIO;
1081 case SCSI_IOCTL_SEND_COMMAND:
1082 if (sdp->detached)
1083 return -ENODEV;
1084 if (read_only) {
1085 unsigned char opcode = WRITE_6;
1086 Scsi_Ioctl_Command __user *siocp = p;
1087
1088 if (copy_from_user(&opcode, siocp->data, 1))
1089 return -EFAULT;
14e507b8 1090 if (sg_allow_access(filp, &opcode))
1da177e4
LT
1091 return -EPERM;
1092 }
e915e872 1093 return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
1da177e4
LT
1094 case SG_SET_DEBUG:
1095 result = get_user(val, ip);
1096 if (result)
1097 return result;
1098 sdp->sgdebug = (char) val;
1099 return 0;
1100 case SCSI_IOCTL_GET_IDLUN:
1101 case SCSI_IOCTL_GET_BUS_NUMBER:
1102 case SCSI_IOCTL_PROBE_HOST:
1103 case SG_GET_TRANSFORM:
1104 if (sdp->detached)
1105 return -ENODEV;
1106 return scsi_ioctl(sdp->device, cmd_in, p);
44ec9542 1107 case BLKSECTGET:
ae03bf63 1108 return put_user(queue_max_sectors(sdp->device->request_queue) * 512,
44ec9542 1109 ip);
6da127ad
CS
1110 case BLKTRACESETUP:
1111 return blk_trace_setup(sdp->device->request_queue,
1112 sdp->disk->disk_name,
76e3a19d 1113 MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
d0deef5b 1114 NULL,
6da127ad
CS
1115 (char *)arg);
1116 case BLKTRACESTART:
1117 return blk_trace_startstop(sdp->device->request_queue, 1);
1118 case BLKTRACESTOP:
1119 return blk_trace_startstop(sdp->device->request_queue, 0);
1120 case BLKTRACETEARDOWN:
1121 return blk_trace_remove(sdp->device->request_queue);
1da177e4
LT
1122 default:
1123 if (read_only)
1124 return -EPERM; /* don't know so take safe approach */
1125 return scsi_ioctl(sdp->device, cmd_in, p);
1126 }
1127}
1128
1129#ifdef CONFIG_COMPAT
1130static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
1131{
1132 Sg_device *sdp;
1133 Sg_fd *sfp;
1134 struct scsi_device *sdev;
1135
1136 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1137 return -ENXIO;
1138
1139 sdev = sdp->device;
1140 if (sdev->host->hostt->compat_ioctl) {
1141 int ret;
1142
1143 ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);
1144
1145 return ret;
1146 }
1147
1148 return -ENOIOCTLCMD;
1149}
1150#endif
1151
1152static unsigned int
1153sg_poll(struct file *filp, poll_table * wait)
1154{
1155 unsigned int res = 0;
1156 Sg_device *sdp;
1157 Sg_fd *sfp;
1158 Sg_request *srp;
1159 int count = 0;
1160 unsigned long iflags;
1161
ebaf466b
JE
1162 sfp = filp->private_data;
1163 if (!sfp)
1164 return POLLERR;
1165 sdp = sfp->parentdp;
1166 if (!sdp)
1da177e4
LT
1167 return POLLERR;
1168 poll_wait(filp, &sfp->read_wait, wait);
1169 read_lock_irqsave(&sfp->rq_list_lock, iflags);
1170 for (srp = sfp->headrp; srp; srp = srp->nextrp) {
1171 /* if any read waiting, flag it */
1172 if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
1173 res = POLLIN | POLLRDNORM;
1174 ++count;
1175 }
1176 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1177
1178 if (sdp->detached)
1179 res |= POLLHUP;
1180 else if (!sfp->cmd_q) {
1181 if (0 == count)
1182 res |= POLLOUT | POLLWRNORM;
1183 } else if (count < SG_MAX_QUEUE)
1184 res |= POLLOUT | POLLWRNORM;
1185 SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
1186 sdp->disk->disk_name, (int) res));
1187 return res;
1188}
1189
1190static int
1191sg_fasync(int fd, struct file *filp, int mode)
1192{
1da177e4
LT
1193 Sg_device *sdp;
1194 Sg_fd *sfp;
1195
1196 if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
1197 return -ENXIO;
1198 SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
1199 sdp->disk->disk_name, mode));
1200
60aa4924 1201 return fasync_helper(fd, filp, mode, &sfp->async_qp);
1da177e4
LT
1202}
1203
a13ff0bb
NP
1204static int
1205sg_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
1da177e4
LT
1206{
1207 Sg_fd *sfp;
d6b10348 1208 unsigned long offset, len, sa;
1da177e4 1209 Sg_scatter_hold *rsv_schp;
10db10d1 1210 int k, length;
1da177e4
LT
1211
1212 if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
a13ff0bb 1213 return VM_FAULT_SIGBUS;
1da177e4 1214 rsv_schp = &sfp->reserve;
a13ff0bb 1215 offset = vmf->pgoff << PAGE_SHIFT;
1da177e4 1216 if (offset >= rsv_schp->bufflen)
a13ff0bb
NP
1217 return VM_FAULT_SIGBUS;
1218 SCSI_LOG_TIMEOUT(3, printk("sg_vma_fault: offset=%lu, scatg=%d\n",
1da177e4 1219 offset, rsv_schp->k_use_sg));
d6b10348 1220 sa = vma->vm_start;
10db10d1
FT
1221 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1222 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
d6b10348 1223 len = vma->vm_end - sa;
10db10d1 1224 len = (len < length) ? len : length;
d6b10348 1225 if (offset < len) {
10db10d1
FT
1226 struct page *page = nth_page(rsv_schp->pages[k],
1227 offset >> PAGE_SHIFT);
d6b10348 1228 get_page(page); /* increment page count */
a13ff0bb
NP
1229 vmf->page = page;
1230 return 0; /* success */
1da177e4 1231 }
d6b10348
MC
1232 sa += len;
1233 offset -= len;
1da177e4 1234 }
d6b10348 1235
a13ff0bb 1236 return VM_FAULT_SIGBUS;
1da177e4
LT
1237}
1238
f0f37e2f 1239static const struct vm_operations_struct sg_mmap_vm_ops = {
a13ff0bb 1240 .fault = sg_vma_fault,
1da177e4
LT
1241};
1242
1243static int
1244sg_mmap(struct file *filp, struct vm_area_struct *vma)
1245{
1246 Sg_fd *sfp;
d6b10348 1247 unsigned long req_sz, len, sa;
1da177e4 1248 Sg_scatter_hold *rsv_schp;
10db10d1 1249 int k, length;
1da177e4
LT
1250
1251 if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
1252 return -ENXIO;
cb59e840 1253 req_sz = vma->vm_end - vma->vm_start;
1da177e4
LT
1254 SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
1255 (void *) vma->vm_start, (int) req_sz));
1256 if (vma->vm_pgoff)
1257 return -EINVAL; /* want no offset */
1258 rsv_schp = &sfp->reserve;
1259 if (req_sz > rsv_schp->bufflen)
1260 return -ENOMEM; /* cannot map more than reserved buffer */
1261
d6b10348 1262 sa = vma->vm_start;
10db10d1
FT
1263 length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1264 for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
d6b10348 1265 len = vma->vm_end - sa;
10db10d1 1266 len = (len < length) ? len : length;
d6b10348 1267 sa += len;
1da177e4 1268 }
d6b10348 1269
f9aed0e2 1270 sfp->mmap_called = 1;
014212bf 1271 vma->vm_flags |= VM_IO | VM_DONTEXPAND | VM_DONTDUMP;
1da177e4
LT
1272 vma->vm_private_data = sfp;
1273 vma->vm_ops = &sg_mmap_vm_ops;
1274 return 0;
1275}
1276
c96952ed
FT
1277static void sg_rq_end_io_usercontext(struct work_struct *work)
1278{
1279 struct sg_request *srp = container_of(work, struct sg_request, ew.work);
1280 struct sg_fd *sfp = srp->parentfp;
1281
1282 sg_finish_rem_req(srp);
1283 kref_put(&sfp->f_ref, sg_remove_sfp);
1284}
1285
a91a3a20
FT
1286/*
1287 * This function is a "bottom half" handler that is called by the mid
1288 * level when a command is completed (or has failed).
1289 */
1290static void sg_rq_end_io(struct request *rq, int uptodate)
1da177e4 1291{
a91a3a20 1292 struct sg_request *srp = rq->end_io_data;
c6517b79 1293 Sg_device *sdp;
1da177e4 1294 Sg_fd *sfp;
1da177e4 1295 unsigned long iflags;
cb59e840 1296 unsigned int ms;
a91a3a20 1297 char *sense;
c6517b79 1298 int result, resid, done = 1;
1da177e4 1299
c6517b79 1300 if (WARN_ON(srp->done != 0))
1da177e4 1301 return;
c6517b79 1302
1da177e4 1303 sfp = srp->parentfp;
c6517b79 1304 if (WARN_ON(sfp == NULL))
1da177e4 1305 return;
c6517b79
TB
1306
1307 sdp = sfp->parentdp;
1308 if (unlikely(sdp->detached))
1309 printk(KERN_INFO "sg_rq_end_io: device detached\n");
1da177e4 1310
a91a3a20
FT
1311 sense = rq->sense;
1312 result = rq->errors;
c3a4d78c 1313 resid = rq->resid_len;
1da177e4
LT
1314
1315 SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
d6b10348
MC
1316 sdp->disk->disk_name, srp->header.pack_id, result));
1317 srp->header.resid = resid;
cb59e840
DG
1318 ms = jiffies_to_msecs(jiffies);
1319 srp->header.duration = (ms > srp->header.duration) ?
1320 (ms - srp->header.duration) : 0;
d6b10348 1321 if (0 != result) {
1da177e4
LT
1322 struct scsi_sense_hdr sshdr;
1323
d6b10348
MC
1324 srp->header.status = 0xff & result;
1325 srp->header.masked_status = status_byte(result);
1326 srp->header.msg_status = msg_byte(result);
1327 srp->header.host_status = host_byte(result);
1328 srp->header.driver_status = driver_byte(result);
1da177e4
LT
1329 if ((sdp->sgdebug > 0) &&
1330 ((CHECK_CONDITION == srp->header.masked_status) ||
1331 (COMMAND_TERMINATED == srp->header.masked_status)))
d6b10348
MC
1332 __scsi_print_sense("sg_cmd_done", sense,
1333 SCSI_SENSE_BUFFERSIZE);
1da177e4
LT
1334
1335 /* Following if statement is a patch supplied by Eric Youngdale */
d6b10348
MC
1336 if (driver_byte(result) != 0
1337 && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
1da177e4
LT
1338 && !scsi_sense_is_deferred(&sshdr)
1339 && sshdr.sense_key == UNIT_ATTENTION
1340 && sdp->device->removable) {
1341 /* Detected possible disc change. Set the bit - this */
1342 /* may be used if there are filesystems using this device */
1343 sdp->device->changed = 1;
1344 }
1345 }
1346 /* Rely on write phase to clean out srp status values, so no "else" */
1347
c6517b79
TB
1348 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1349 if (unlikely(srp->orphan)) {
1da177e4
LT
1350 if (sfp->keep_orphan)
1351 srp->sg_io_owned = 0;
c6517b79
TB
1352 else
1353 done = 0;
1da177e4 1354 }
c6517b79
TB
1355 srp->done = done;
1356 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1357
1358 if (likely(done)) {
1359 /* Now wake up any sg_read() that is waiting for this
1360 * packet.
1361 */
1da177e4 1362 wake_up_interruptible(&sfp->read_wait);
c6517b79 1363 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
c96952ed 1364 kref_put(&sfp->f_ref, sg_remove_sfp);
015640ed
FT
1365 } else {
1366 INIT_WORK(&srp->ew.work, sg_rq_end_io_usercontext);
1367 schedule_work(&srp->ew.work);
1368 }
1da177e4
LT
1369}
1370
828c0950 1371static const struct file_operations sg_fops = {
1da177e4
LT
1372 .owner = THIS_MODULE,
1373 .read = sg_read,
1374 .write = sg_write,
1375 .poll = sg_poll,
37b9d1e0 1376 .unlocked_ioctl = sg_ioctl,
1da177e4
LT
1377#ifdef CONFIG_COMPAT
1378 .compat_ioctl = sg_compat_ioctl,
1379#endif
1380 .open = sg_open,
1381 .mmap = sg_mmap,
1382 .release = sg_release,
1383 .fasync = sg_fasync,
6038f373 1384 .llseek = no_llseek,
1da177e4
LT
1385};
1386
d253878b 1387static struct class *sg_sysfs_class;
1da177e4
LT
1388
1389static int sg_sysfs_valid = 0;
1390
7c07d613 1391static Sg_device *sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
1da177e4 1392{
d6b10348 1393 struct request_queue *q = scsidp->request_queue;
1da177e4
LT
1394 Sg_device *sdp;
1395 unsigned long iflags;
7c07d613
JB
1396 int error;
1397 u32 k;
1da177e4 1398
24669f75 1399 sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
1da177e4
LT
1400 if (!sdp) {
1401 printk(KERN_WARNING "kmalloc Sg_device failure\n");
7c07d613
JB
1402 return ERR_PTR(-ENOMEM);
1403 }
c6517b79 1404
b98c52b5 1405 idr_preload(GFP_KERNEL);
7c07d613 1406 write_lock_irqsave(&sg_index_lock, iflags);
1da177e4 1407
b98c52b5
TH
1408 error = idr_alloc(&sg_index_idr, sdp, 0, SG_MAX_DEVS, GFP_NOWAIT);
1409 if (error < 0) {
1410 if (error == -ENOSPC) {
1411 sdev_printk(KERN_WARNING, scsidp,
1412 "Unable to attach sg device type=%d, minor number exceeds %d\n",
1413 scsidp->type, SG_MAX_DEVS - 1);
1414 error = -ENODEV;
1415 } else {
1416 printk(KERN_WARNING
1417 "idr allocation Sg_device failure: %d\n", error);
1418 }
1419 goto out_unlock;
1da177e4 1420 }
b98c52b5 1421 k = error;
1da177e4 1422
1da177e4
LT
1423 SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k));
1424 sprintf(disk->disk_name, "sg%d", k);
1425 disk->first_minor = k;
1426 sdp->disk = disk;
1427 sdp->device = scsidp;
3442f802 1428 INIT_LIST_HEAD(&sdp->sfds);
1da177e4 1429 init_waitqueue_head(&sdp->o_excl_wait);
8a78362c 1430 sdp->sg_tablesize = queue_max_segments(q);
7c07d613 1431 sdp->index = k;
c6517b79 1432 kref_init(&sdp->d_ref);
b98c52b5 1433 error = 0;
c6517b79 1434
b98c52b5 1435out_unlock:
c6517b79 1436 write_unlock_irqrestore(&sg_index_lock, iflags);
b98c52b5 1437 idr_preload_end();
1da177e4 1438
7c07d613 1439 if (error) {
1da177e4 1440 kfree(sdp);
7c07d613
JB
1441 return ERR_PTR(error);
1442 }
1443 return sdp;
1da177e4
LT
1444}
1445
1446static int
ee959b00 1447sg_add(struct device *cl_dev, struct class_interface *cl_intf)
1da177e4 1448{
ee959b00 1449 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1da177e4
LT
1450 struct gendisk *disk;
1451 Sg_device *sdp = NULL;
1452 struct cdev * cdev = NULL;
7c07d613 1453 int error;
454e8957 1454 unsigned long iflags;
1da177e4
LT
1455
1456 disk = alloc_disk(1);
1457 if (!disk) {
1458 printk(KERN_WARNING "alloc_disk failed\n");
1459 return -ENOMEM;
1460 }
1461 disk->major = SCSI_GENERIC_MAJOR;
1462
1463 error = -ENOMEM;
1464 cdev = cdev_alloc();
1465 if (!cdev) {
1466 printk(KERN_WARNING "cdev_alloc failed\n");
1467 goto out;
1468 }
1469 cdev->owner = THIS_MODULE;
1470 cdev->ops = &sg_fops;
1471
7c07d613
JB
1472 sdp = sg_alloc(disk, scsidp);
1473 if (IS_ERR(sdp)) {
1da177e4 1474 printk(KERN_WARNING "sg_alloc failed\n");
7c07d613 1475 error = PTR_ERR(sdp);
1da177e4
LT
1476 goto out;
1477 }
1da177e4 1478
7c07d613 1479 error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
5e3c34c1 1480 if (error)
454e8957 1481 goto cdev_add_err;
5e3c34c1 1482
1da177e4
LT
1483 sdp->cdev = cdev;
1484 if (sg_sysfs_valid) {
ee959b00 1485 struct device *sg_class_member;
1da177e4 1486
d73a1a67
GKH
1487 sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
1488 MKDEV(SCSI_GENERIC_MAJOR,
1489 sdp->index),
1490 sdp, "%s", disk->disk_name);
d07e0361
FT
1491 if (IS_ERR(sg_class_member)) {
1492 printk(KERN_ERR "sg_add: "
ee959b00 1493 "device_create failed\n");
d07e0361
FT
1494 error = PTR_ERR(sg_class_member);
1495 goto cdev_add_err;
1496 }
d07e0361 1497 error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
1da177e4
LT
1498 &sg_class_member->kobj, "generic");
1499 if (error)
1500 printk(KERN_ERR "sg_add: unable to make symlink "
7c07d613 1501 "'generic' back to sg%d\n", sdp->index);
1da177e4 1502 } else
7c07d613 1503 printk(KERN_WARNING "sg_add: sg_sys Invalid\n");
1da177e4 1504
9ccfc756 1505 sdev_printk(KERN_NOTICE, scsidp,
7c07d613
JB
1506 "Attached scsi generic sg%d type %d\n", sdp->index,
1507 scsidp->type);
1da177e4 1508
ee959b00 1509 dev_set_drvdata(cl_dev, sdp);
a24484f2 1510
1da177e4
LT
1511 return 0;
1512
454e8957 1513cdev_add_err:
7c07d613
JB
1514 write_lock_irqsave(&sg_index_lock, iflags);
1515 idr_remove(&sg_index_idr, sdp->index);
1516 write_unlock_irqrestore(&sg_index_lock, iflags);
1517 kfree(sdp);
454e8957 1518
1da177e4
LT
1519out:
1520 put_disk(disk);
1521 if (cdev)
1522 cdev_del(cdev);
1523 return error;
1524}
1525
c6517b79
TB
1526static void sg_device_destroy(struct kref *kref)
1527{
1528 struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
1529 unsigned long flags;
1530
1531 /* CAUTION! Note that the device can still be found via idr_find()
1532 * even though the refcount is 0. Therefore, do idr_remove() BEFORE
1533 * any other cleanup.
1534 */
1535
1536 write_lock_irqsave(&sg_index_lock, flags);
1537 idr_remove(&sg_index_idr, sdp->index);
1538 write_unlock_irqrestore(&sg_index_lock, flags);
1539
1540 SCSI_LOG_TIMEOUT(3,
1541 printk("sg_device_destroy: %s\n",
1542 sdp->disk->disk_name));
1543
1544 put_disk(sdp->disk);
1545 kfree(sdp);
1546}
1547
1548static void sg_remove(struct device *cl_dev, struct class_interface *cl_intf)
1da177e4 1549{
ee959b00
TJ
1550 struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
1551 Sg_device *sdp = dev_get_drvdata(cl_dev);
1da177e4
LT
1552 unsigned long iflags;
1553 Sg_fd *sfp;
1da177e4 1554
c6517b79 1555 if (!sdp || sdp->detached)
1da177e4 1556 return;
7c07d613 1557
c6517b79
TB
1558 SCSI_LOG_TIMEOUT(3, printk("sg_remove: %s\n", sdp->disk->disk_name));
1559
1560 /* Need a write lock to set sdp->detached. */
7c07d613 1561 write_lock_irqsave(&sg_index_lock, iflags);
c6517b79 1562 sdp->detached = 1;
3442f802 1563 list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
c6517b79
TB
1564 wake_up_interruptible(&sfp->read_wait);
1565 kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
7c07d613
JB
1566 }
1567 write_unlock_irqrestore(&sg_index_lock, iflags);
1568
1569 sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
ee959b00 1570 device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
7c07d613
JB
1571 cdev_del(sdp->cdev);
1572 sdp->cdev = NULL;
1da177e4 1573
c6517b79 1574 sg_put_dev(sdp);
1da177e4
LT
1575}
1576
6460e75a
DG
1577module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
1578module_param_named(def_reserved_size, def_reserved_size, int,
1579 S_IRUGO | S_IWUSR);
1da177e4
LT
1580module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);
1581
1582MODULE_AUTHOR("Douglas Gilbert");
1583MODULE_DESCRIPTION("SCSI generic (sg) driver");
1584MODULE_LICENSE("GPL");
1585MODULE_VERSION(SG_VERSION_STR);
f018fa55 1586MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
1da177e4 1587
6460e75a
DG
1588MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
1589 "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
1da177e4
LT
1590MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
1591MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");
1592
1593static int __init
1594init_sg(void)
1595{
1596 int rc;
1597
6460e75a
DG
1598 if (scatter_elem_sz < PAGE_SIZE) {
1599 scatter_elem_sz = PAGE_SIZE;
1600 scatter_elem_sz_prev = scatter_elem_sz;
1601 }
1da177e4
LT
1602 if (def_reserved_size >= 0)
1603 sg_big_buff = def_reserved_size;
6460e75a
DG
1604 else
1605 def_reserved_size = sg_big_buff;
1da177e4
LT
1606
1607 rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1608 SG_MAX_DEVS, "sg");
1609 if (rc)
1610 return rc;
d253878b 1611 sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
1da177e4
LT
1612 if ( IS_ERR(sg_sysfs_class) ) {
1613 rc = PTR_ERR(sg_sysfs_class);
1614 goto err_out;
1615 }
1616 sg_sysfs_valid = 1;
1617 rc = scsi_register_interface(&sg_interface);
1618 if (0 == rc) {
1619#ifdef CONFIG_SCSI_PROC_FS
1620 sg_proc_init();
1621#endif /* CONFIG_SCSI_PROC_FS */
1622 return 0;
1623 }
d253878b 1624 class_destroy(sg_sysfs_class);
1da177e4
LT
1625err_out:
1626 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
1627 return rc;
1628}
1629
1630static void __exit
1631exit_sg(void)
1632{
1633#ifdef CONFIG_SCSI_PROC_FS
1634 sg_proc_cleanup();
1635#endif /* CONFIG_SCSI_PROC_FS */
1636 scsi_unregister_interface(&sg_interface);
d253878b 1637 class_destroy(sg_sysfs_class);
1da177e4
LT
1638 sg_sysfs_valid = 0;
1639 unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
1640 SG_MAX_DEVS);
7c07d613 1641 idr_destroy(&sg_index_idr);
1da177e4
LT
1642}
1643
44c7b0ea 1644static int sg_start_req(Sg_request *srp, unsigned char *cmd)
10865dfa 1645{
626710c9 1646 int res;
10865dfa 1647 struct request *rq;
44c7b0ea
FT
1648 Sg_fd *sfp = srp->parentfp;
1649 sg_io_hdr_t *hp = &srp->header;
1650 int dxfer_len = (int) hp->dxfer_len;
1651 int dxfer_dir = hp->dxfer_direction;
626710c9 1652 unsigned int iov_count = hp->iovec_count;
44c7b0ea
FT
1653 Sg_scatter_hold *req_schp = &srp->data;
1654 Sg_scatter_hold *rsv_schp = &sfp->reserve;
1655 struct request_queue *q = sfp->parentdp->device->request_queue;
626710c9 1656 struct rq_map_data *md, map_data;
10865dfa
FT
1657 int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;
1658
44c7b0ea
FT
1659 SCSI_LOG_TIMEOUT(4, printk(KERN_INFO "sg_start_req: dxfer_len=%d\n",
1660 dxfer_len));
1661
10865dfa
FT
1662 rq = blk_get_request(q, rw, GFP_ATOMIC);
1663 if (!rq)
1664 return -ENOMEM;
1665
1666 memcpy(rq->cmd, cmd, hp->cmd_len);
1667
1668 rq->cmd_len = hp->cmd_len;
1669 rq->cmd_type = REQ_TYPE_BLOCK_PC;
1670
1671 srp->rq = rq;
1672 rq->end_io_data = srp;
1673 rq->sense = srp->sense_b;
1674 rq->retries = SG_DEFAULT_RETRIES;
1675
1da177e4 1676 if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
10db10d1 1677 return 0;
10865dfa 1678
626710c9
FT
1679 if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
1680 dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
1681 !sfp->parentdp->device->host->unchecked_isa_dma &&
2610a254 1682 blk_rq_aligned(q, (unsigned long)hp->dxferp, dxfer_len))
626710c9
FT
1683 md = NULL;
1684 else
1685 md = &map_data;
1686
1687 if (md) {
1688 if (!sg_res_in_use(sfp) && dxfer_len <= rsv_schp->bufflen)
1689 sg_link_reserve(sfp, srp, dxfer_len);
1690 else {
1691 res = sg_build_indirect(req_schp, sfp, dxfer_len);
1692 if (res)
1693 return res;
1694 }
7e56cb0f 1695
626710c9
FT
1696 md->pages = req_schp->pages;
1697 md->page_order = req_schp->page_order;
1698 md->nr_entries = req_schp->k_use_sg;
56c451f4 1699 md->offset = 0;
97ae77a1 1700 md->null_mapped = hp->dxferp ? 0 : 1;
ecb554a8
FT
1701 if (dxfer_dir == SG_DXFER_TO_FROM_DEV)
1702 md->from_user = 1;
1703 else
1704 md->from_user = 0;
626710c9
FT
1705 }
1706
4d0dd435
AV
1707 if (unlikely(iov_count > UIO_MAXIOV))
1708 return -EINVAL;
1709
0fdf96b6
FT
1710 if (iov_count) {
1711 int len, size = sizeof(struct sg_iovec) * iov_count;
1712 struct iovec *iov;
1713
3094141c
JL
1714 iov = memdup_user(hp->dxferp, size);
1715 if (IS_ERR(iov))
1716 return PTR_ERR(iov);
0fdf96b6
FT
1717
1718 len = iov_length(iov, iov_count);
1719 if (hp->dxfer_len < len) {
1720 iov_count = iov_shorten(iov, iov_count, hp->dxfer_len);
1721 len = hp->dxfer_len;
1722 }
1723
1724 res = blk_rq_map_user_iov(q, rq, md, (struct sg_iovec *)iov,
1725 iov_count,
1726 len, GFP_ATOMIC);
1727 kfree(iov);
1728 } else
626710c9
FT
1729 res = blk_rq_map_user(q, rq, md, hp->dxferp,
1730 hp->dxfer_len, GFP_ATOMIC);
10db10d1
FT
1731
1732 if (!res) {
626710c9 1733 srp->bio = rq->bio;
10db10d1 1734
626710c9
FT
1735 if (!md) {
1736 req_schp->dio_in_use = 1;
1737 hp->info |= SG_INFO_DIRECT_IO;
1738 }
1739 }
10db10d1 1740 return res;
1da177e4
LT
1741}
1742
e7ee4cc0 1743static int sg_finish_rem_req(Sg_request * srp)
1da177e4 1744{
e7ee4cc0
FT
1745 int ret = 0;
1746
1da177e4
LT
1747 Sg_fd *sfp = srp->parentfp;
1748 Sg_scatter_hold *req_schp = &srp->data;
1749
1750 SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp->res_used));
6e5a30cb
FT
1751 if (srp->rq) {
1752 if (srp->bio)
e7ee4cc0 1753 ret = blk_rq_unmap_user(srp->bio);
10db10d1 1754
10865dfa 1755 blk_put_request(srp->rq);
6e5a30cb 1756 }
10865dfa 1757
e27168f8
CS
1758 if (srp->res_used)
1759 sg_unlink_reserve(sfp, srp);
1760 else
1761 sg_remove_scat(req_schp);
1762
1da177e4 1763 sg_remove_request(sfp, srp);
e7ee4cc0
FT
1764
1765 return ret;
1da177e4
LT
1766}
1767
1768static int
1769sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
1770{
10db10d1 1771 int sg_bufflen = tablesize * sizeof(struct page *);
2d20eaf9 1772 gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
1da177e4 1773
10db10d1
FT
1774 schp->pages = kzalloc(sg_bufflen, gfp_flags);
1775 if (!schp->pages)
1da177e4 1776 return -ENOMEM;
1da177e4 1777 schp->sglist_len = sg_bufflen;
d6b10348 1778 return tablesize; /* number of scat_gath elements allocated */
1da177e4
LT
1779}
1780
1da177e4
LT
1781static int
1782sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
1783{
10db10d1 1784 int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
d6b10348 1785 int sg_tablesize = sfp->parentdp->sg_tablesize;
10db10d1
FT
1786 int blk_size = buff_size, order;
1787 gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
1da177e4 1788
fb119935 1789 if (blk_size < 0)
1da177e4
LT
1790 return -EFAULT;
1791 if (0 == blk_size)
1792 ++blk_size; /* don't know why */
b2ed6c69
FT
1793 /* round request up to next highest SG_SECTOR_SZ byte boundary */
1794 blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
1da177e4
LT
1795 SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
1796 buff_size, blk_size));
d6b10348
MC
1797
1798 /* N.B. ret_sz carried into this block ... */
1799 mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
1800 if (mx_sc_elems < 0)
1801 return mx_sc_elems; /* most likely -ENOMEM */
1802
6460e75a
DG
1803 num = scatter_elem_sz;
1804 if (unlikely(num != scatter_elem_sz_prev)) {
1805 if (num < PAGE_SIZE) {
1806 scatter_elem_sz = PAGE_SIZE;
1807 scatter_elem_sz_prev = PAGE_SIZE;
1808 } else
1809 scatter_elem_sz_prev = num;
1810 }
10db10d1
FT
1811
1812 if (sfp->low_dma)
1813 gfp_mask |= GFP_DMA;
1814
1815 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
1816 gfp_mask |= __GFP_ZERO;
1817
1818 order = get_order(num);
1819retry:
1820 ret_sz = 1 << (PAGE_SHIFT + order);
1821
1822 for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
1823 k++, rem_sz -= ret_sz) {
1824
6460e75a 1825 num = (rem_sz > scatter_elem_sz_prev) ?
10db10d1
FT
1826 scatter_elem_sz_prev : rem_sz;
1827
1828 schp->pages[k] = alloc_pages(gfp_mask, order);
1829 if (!schp->pages[k])
1830 goto out;
d6b10348 1831
6460e75a
DG
1832 if (num == scatter_elem_sz_prev) {
1833 if (unlikely(ret_sz > scatter_elem_sz_prev)) {
1834 scatter_elem_sz = ret_sz;
1835 scatter_elem_sz_prev = ret_sz;
1836 }
1837 }
d6b10348 1838
7ca63cb4
DG
1839 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k=%d, num=%d, "
1840 "ret_sz=%d\n", k, num, ret_sz));
d6b10348
MC
1841 } /* end of for loop */
1842
10db10d1 1843 schp->page_order = order;
d6b10348 1844 schp->k_use_sg = k;
7ca63cb4
DG
1845 SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, "
1846 "rem_sz=%d\n", k, rem_sz));
d6b10348
MC
1847
1848 schp->bufflen = blk_size;
1849 if (rem_sz > 0) /* must have failed */
1850 return -ENOMEM;
1da177e4 1851 return 0;
10db10d1
FT
1852out:
1853 for (i = 0; i < k; i++)
e71044ee 1854 __free_pages(schp->pages[i], order);
10db10d1
FT
1855
1856 if (--order >= 0)
1857 goto retry;
1858
1859 return -ENOMEM;
1da177e4
LT
1860}
1861
1da177e4
LT
1862static void
1863sg_remove_scat(Sg_scatter_hold * schp)
1864{
1865 SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
10db10d1 1866 if (schp->pages && schp->sglist_len > 0) {
6e5a30cb 1867 if (!schp->dio_in_use) {
1da177e4
LT
1868 int k;
1869
10db10d1 1870 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1da177e4 1871 SCSI_LOG_TIMEOUT(5, printk(
10db10d1
FT
1872 "sg_remove_scat: k=%d, pg=0x%p\n",
1873 k, schp->pages[k]));
1874 __free_pages(schp->pages[k], schp->page_order);
1da177e4 1875 }
6e5a30cb 1876
10db10d1 1877 kfree(schp->pages);
1da177e4 1878 }
d6b10348 1879 }
1da177e4
LT
1880 memset(schp, 0, sizeof (*schp));
1881}
1882
1da177e4
LT
1883static int
1884sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
1885{
1886 Sg_scatter_hold *schp = &srp->data;
d6b10348 1887 int k, num;
1da177e4
LT
1888
1889 SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
1890 num_read_xfer));
1891 if ((!outp) || (num_read_xfer <= 0))
1892 return 0;
d6b10348 1893
10db10d1
FT
1894 num = 1 << (PAGE_SHIFT + schp->page_order);
1895 for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
d6b10348 1896 if (num > num_read_xfer) {
10db10d1 1897 if (__copy_to_user(outp, page_address(schp->pages[k]),
d6b10348
MC
1898 num_read_xfer))
1899 return -EFAULT;
1900 break;
1901 } else {
10db10d1 1902 if (__copy_to_user(outp, page_address(schp->pages[k]),
d6b10348
MC
1903 num))
1904 return -EFAULT;
1905 num_read_xfer -= num;
1906 if (num_read_xfer <= 0)
1da177e4 1907 break;
d6b10348 1908 outp += num;
1da177e4 1909 }
1da177e4 1910 }
d6b10348 1911
1da177e4
LT
1912 return 0;
1913}
1914
1915static void
1916sg_build_reserve(Sg_fd * sfp, int req_size)
1917{
1918 Sg_scatter_hold *schp = &sfp->reserve;
1919
1920 SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size));
1921 do {
1922 if (req_size < PAGE_SIZE)
1923 req_size = PAGE_SIZE;
1924 if (0 == sg_build_indirect(schp, sfp, req_size))
1925 return;
1926 else
1927 sg_remove_scat(schp);
1928 req_size >>= 1; /* divide by 2 */
1929 } while (req_size > (PAGE_SIZE / 2));
1930}
1931
1932static void
1933sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
1934{
1935 Sg_scatter_hold *req_schp = &srp->data;
1936 Sg_scatter_hold *rsv_schp = &sfp->reserve;
d6b10348 1937 int k, num, rem;
1da177e4
LT
1938
1939 srp->res_used = 1;
1940 SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size));
eca7be5e 1941 rem = size;
d6b10348 1942
10db10d1
FT
1943 num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
1944 for (k = 0; k < rsv_schp->k_use_sg; k++) {
d6b10348 1945 if (rem <= num) {
d6b10348
MC
1946 req_schp->k_use_sg = k + 1;
1947 req_schp->sglist_len = rsv_schp->sglist_len;
10db10d1 1948 req_schp->pages = rsv_schp->pages;
d6b10348
MC
1949
1950 req_schp->bufflen = size;
10db10d1 1951 req_schp->page_order = rsv_schp->page_order;
d6b10348
MC
1952 break;
1953 } else
1954 rem -= num;
1da177e4 1955 }
d6b10348
MC
1956
1957 if (k >= rsv_schp->k_use_sg)
1958 SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
1da177e4
LT
1959}
1960
1961static void
1962sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
1963{
1964 Sg_scatter_hold *req_schp = &srp->data;
1da177e4
LT
1965
1966 SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
1967 (int) req_schp->k_use_sg));
1da177e4
LT
1968 req_schp->k_use_sg = 0;
1969 req_schp->bufflen = 0;
10db10d1
FT
1970 req_schp->pages = NULL;
1971 req_schp->page_order = 0;
1da177e4
LT
1972 req_schp->sglist_len = 0;
1973 sfp->save_scat_len = 0;
1974 srp->res_used = 0;
1975}
1976
1977static Sg_request *
1978sg_get_rq_mark(Sg_fd * sfp, int pack_id)
1979{
1980 Sg_request *resp;
1981 unsigned long iflags;
1982
1983 write_lock_irqsave(&sfp->rq_list_lock, iflags);
1984 for (resp = sfp->headrp; resp; resp = resp->nextrp) {
1985 /* look for requests that are ready + not SG_IO owned */
1986 if ((1 == resp->done) && (!resp->sg_io_owned) &&
1987 ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
1988 resp->done = 2; /* guard against other readers */
1989 break;
1990 }
1991 }
1992 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
1993 return resp;
1994}
1995
1da177e4
LT
1996/* always adds to end of list */
1997static Sg_request *
1998sg_add_request(Sg_fd * sfp)
1999{
2000 int k;
2001 unsigned long iflags;
2002 Sg_request *resp;
2003 Sg_request *rp = sfp->req_arr;
2004
2005 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2006 resp = sfp->headrp;
2007 if (!resp) {
2008 memset(rp, 0, sizeof (Sg_request));
2009 rp->parentfp = sfp;
2010 resp = rp;
2011 sfp->headrp = resp;
2012 } else {
2013 if (0 == sfp->cmd_q)
2014 resp = NULL; /* command queuing disallowed */
2015 else {
2016 for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
2017 if (!rp->parentfp)
2018 break;
2019 }
2020 if (k < SG_MAX_QUEUE) {
2021 memset(rp, 0, sizeof (Sg_request));
2022 rp->parentfp = sfp;
2023 while (resp->nextrp)
2024 resp = resp->nextrp;
2025 resp->nextrp = rp;
2026 resp = rp;
2027 } else
2028 resp = NULL;
2029 }
2030 }
2031 if (resp) {
2032 resp->nextrp = NULL;
cb59e840 2033 resp->header.duration = jiffies_to_msecs(jiffies);
1da177e4
LT
2034 }
2035 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2036 return resp;
2037}
2038
2039/* Return of 1 for found; 0 for not found */
2040static int
2041sg_remove_request(Sg_fd * sfp, Sg_request * srp)
2042{
2043 Sg_request *prev_rp;
2044 Sg_request *rp;
2045 unsigned long iflags;
2046 int res = 0;
2047
2048 if ((!sfp) || (!srp) || (!sfp->headrp))
2049 return res;
2050 write_lock_irqsave(&sfp->rq_list_lock, iflags);
2051 prev_rp = sfp->headrp;
2052 if (srp == prev_rp) {
2053 sfp->headrp = prev_rp->nextrp;
2054 prev_rp->parentfp = NULL;
2055 res = 1;
2056 } else {
2057 while ((rp = prev_rp->nextrp)) {
2058 if (srp == rp) {
2059 prev_rp->nextrp = rp->nextrp;
2060 rp->parentfp = NULL;
2061 res = 1;
2062 break;
2063 }
2064 prev_rp = rp;
2065 }
2066 }
2067 write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2068 return res;
2069}
2070
1da177e4
LT
2071static Sg_fd *
2072sg_add_sfp(Sg_device * sdp, int dev)
2073{
2074 Sg_fd *sfp;
2075 unsigned long iflags;
44ec9542 2076 int bufflen;
1da177e4 2077
d6b10348 2078 sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
1da177e4
LT
2079 if (!sfp)
2080 return NULL;
d6b10348 2081
1da177e4
LT
2082 init_waitqueue_head(&sfp->read_wait);
2083 rwlock_init(&sfp->rq_list_lock);
2084
c6517b79 2085 kref_init(&sfp->f_ref);
1da177e4
LT
2086 sfp->timeout = SG_DEFAULT_TIMEOUT;
2087 sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
2088 sfp->force_packid = SG_DEF_FORCE_PACK_ID;
2089 sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
2090 sdp->device->host->unchecked_isa_dma : 1;
2091 sfp->cmd_q = SG_DEF_COMMAND_Q;
2092 sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
2093 sfp->parentdp = sdp;
7c07d613 2094 write_lock_irqsave(&sg_index_lock, iflags);
3442f802 2095 list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
7c07d613 2096 write_unlock_irqrestore(&sg_index_lock, iflags);
1da177e4 2097 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp));
6460e75a
DG
2098 if (unlikely(sg_big_buff != def_reserved_size))
2099 sg_big_buff = def_reserved_size;
2100
44ec9542 2101 bufflen = min_t(int, sg_big_buff,
ae03bf63 2102 queue_max_sectors(sdp->device->request_queue) * 512);
44ec9542 2103 sg_build_reserve(sfp, bufflen);
1da177e4
LT
2104 SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: bufflen=%d, k_use_sg=%d\n",
2105 sfp->reserve.bufflen, sfp->reserve.k_use_sg));
c6517b79
TB
2106
2107 kref_get(&sdp->d_ref);
2108 __module_get(THIS_MODULE);
1da177e4
LT
2109 return sfp;
2110}
2111
c6517b79 2112static void sg_remove_sfp_usercontext(struct work_struct *work)
1da177e4 2113{
c6517b79
TB
2114 struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
2115 struct sg_device *sdp = sfp->parentdp;
2116
2117 /* Cleanup any responses which were never read(). */
2118 while (sfp->headrp)
2119 sg_finish_rem_req(sfp->headrp);
1da177e4 2120
1da177e4 2121 if (sfp->reserve.bufflen > 0) {
c6517b79
TB
2122 SCSI_LOG_TIMEOUT(6,
2123 printk("sg_remove_sfp: bufflen=%d, k_use_sg=%d\n",
2124 (int) sfp->reserve.bufflen,
2125 (int) sfp->reserve.k_use_sg));
1da177e4
LT
2126 sg_remove_scat(&sfp->reserve);
2127 }
c6517b79
TB
2128
2129 SCSI_LOG_TIMEOUT(6,
2130 printk("sg_remove_sfp: %s, sfp=0x%p\n",
2131 sdp->disk->disk_name,
2132 sfp));
d6b10348 2133 kfree(sfp);
c6517b79
TB
2134
2135 scsi_device_put(sdp->device);
2136 sg_put_dev(sdp);
2137 module_put(THIS_MODULE);
1da177e4
LT
2138}
2139
c6517b79 2140static void sg_remove_sfp(struct kref *kref)
1da177e4 2141{
c6517b79
TB
2142 struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
2143 struct sg_device *sdp = sfp->parentdp;
c6517b79 2144 unsigned long iflags;
1da177e4 2145
c6517b79 2146 write_lock_irqsave(&sg_index_lock, iflags);
3442f802 2147 list_del(&sfp->sfd_siblings);
c6517b79
TB
2148 write_unlock_irqrestore(&sg_index_lock, iflags);
2149 wake_up_interruptible(&sdp->o_excl_wait);
1da177e4 2150
015640ed
FT
2151 INIT_WORK(&sfp->ew.work, sg_remove_sfp_usercontext);
2152 schedule_work(&sfp->ew.work);
1da177e4
LT
2153}
2154
2155static int
2156sg_res_in_use(Sg_fd * sfp)
2157{
2158 const Sg_request *srp;
2159 unsigned long iflags;
2160
2161 read_lock_irqsave(&sfp->rq_list_lock, iflags);
2162 for (srp = sfp->headrp; srp; srp = srp->nextrp)
2163 if (srp->res_used)
2164 break;
2165 read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
2166 return srp ? 1 : 0;
2167}
2168
1da177e4 2169#ifdef CONFIG_SCSI_PROC_FS
7c07d613
JB
2170static int
2171sg_idr_max_id(int id, void *p, void *data)
2172{
2173 int *k = data;
2174
2175 if (*k < id)
2176 *k = id;
2177
2178 return 0;
2179}
2180
1da177e4
LT
2181static int
2182sg_last_dev(void)
2183{
53474c04 2184 int k = -1;
1da177e4
LT
2185 unsigned long iflags;
2186
7c07d613
JB
2187 read_lock_irqsave(&sg_index_lock, iflags);
2188 idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
2189 read_unlock_irqrestore(&sg_index_lock, iflags);
1da177e4
LT
2190 return k + 1; /* origin 1 */
2191}
2192#endif
2193
c6517b79
TB
2194/* must be called with sg_index_lock held */
2195static Sg_device *sg_lookup_dev(int dev)
1da177e4 2196{
c6517b79
TB
2197 return idr_find(&sg_index_idr, dev);
2198}
1da177e4 2199
c6517b79
TB
2200static Sg_device *sg_get_dev(int dev)
2201{
2202 struct sg_device *sdp;
2203 unsigned long flags;
2204
2205 read_lock_irqsave(&sg_index_lock, flags);
2206 sdp = sg_lookup_dev(dev);
2207 if (!sdp)
2208 sdp = ERR_PTR(-ENXIO);
2209 else if (sdp->detached) {
2210 /* If sdp->detached, then the refcount may already be 0, in
2211 * which case it would be a bug to do kref_get().
2212 */
2213 sdp = ERR_PTR(-ENODEV);
2214 } else
2215 kref_get(&sdp->d_ref);
2216 read_unlock_irqrestore(&sg_index_lock, flags);
7c07d613 2217
1da177e4
LT
2218 return sdp;
2219}
2220
c6517b79
TB
2221static void sg_put_dev(struct sg_device *sdp)
2222{
2223 kref_put(&sdp->d_ref, sg_device_destroy);
2224}
2225
1da177e4
LT
2226#ifdef CONFIG_SCSI_PROC_FS
2227
2228static struct proc_dir_entry *sg_proc_sgp = NULL;
2229
2230static char sg_proc_sg_dirname[] = "scsi/sg";
2231
2232static int sg_proc_seq_show_int(struct seq_file *s, void *v);
2233
2234static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
2235static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
2236 size_t count, loff_t *off);
828c0950
AD
2237static const struct file_operations adio_fops = {
2238 .owner = THIS_MODULE,
1da177e4 2239 .open = sg_proc_single_open_adio,
828c0950
AD
2240 .read = seq_read,
2241 .llseek = seq_lseek,
1da177e4
LT
2242 .write = sg_proc_write_adio,
2243 .release = single_release,
2244};
2245
2246static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
2247static ssize_t sg_proc_write_dressz(struct file *filp,
2248 const char __user *buffer, size_t count, loff_t *off);
828c0950
AD
2249static const struct file_operations dressz_fops = {
2250 .owner = THIS_MODULE,
1da177e4 2251 .open = sg_proc_single_open_dressz,
828c0950
AD
2252 .read = seq_read,
2253 .llseek = seq_lseek,
1da177e4
LT
2254 .write = sg_proc_write_dressz,
2255 .release = single_release,
2256};
2257
2258static int sg_proc_seq_show_version(struct seq_file *s, void *v);
2259static int sg_proc_single_open_version(struct inode *inode, struct file *file);
828c0950
AD
2260static const struct file_operations version_fops = {
2261 .owner = THIS_MODULE,
1da177e4 2262 .open = sg_proc_single_open_version,
828c0950
AD
2263 .read = seq_read,
2264 .llseek = seq_lseek,
1da177e4
LT
2265 .release = single_release,
2266};
2267
2268static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
2269static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
828c0950
AD
2270static const struct file_operations devhdr_fops = {
2271 .owner = THIS_MODULE,
1da177e4 2272 .open = sg_proc_single_open_devhdr,
828c0950
AD
2273 .read = seq_read,
2274 .llseek = seq_lseek,
1da177e4
LT
2275 .release = single_release,
2276};
2277
2278static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
2279static int sg_proc_open_dev(struct inode *inode, struct file *file);
2280static void * dev_seq_start(struct seq_file *s, loff_t *pos);
2281static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
2282static void dev_seq_stop(struct seq_file *s, void *v);
828c0950
AD
2283static const struct file_operations dev_fops = {
2284 .owner = THIS_MODULE,
1da177e4 2285 .open = sg_proc_open_dev,
828c0950
AD
2286 .read = seq_read,
2287 .llseek = seq_lseek,
1da177e4
LT
2288 .release = seq_release,
2289};
88e9d34c 2290static const struct seq_operations dev_seq_ops = {
1da177e4
LT
2291 .start = dev_seq_start,
2292 .next = dev_seq_next,
2293 .stop = dev_seq_stop,
2294 .show = sg_proc_seq_show_dev,
2295};
2296
2297static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
2298static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
828c0950
AD
2299static const struct file_operations devstrs_fops = {
2300 .owner = THIS_MODULE,
1da177e4 2301 .open = sg_proc_open_devstrs,
828c0950
AD
2302 .read = seq_read,
2303 .llseek = seq_lseek,
1da177e4
LT
2304 .release = seq_release,
2305};
88e9d34c 2306static const struct seq_operations devstrs_seq_ops = {
1da177e4
LT
2307 .start = dev_seq_start,
2308 .next = dev_seq_next,
2309 .stop = dev_seq_stop,
2310 .show = sg_proc_seq_show_devstrs,
2311};
2312
2313static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
2314static int sg_proc_open_debug(struct inode *inode, struct file *file);
828c0950
AD
2315static const struct file_operations debug_fops = {
2316 .owner = THIS_MODULE,
1da177e4 2317 .open = sg_proc_open_debug,
828c0950
AD
2318 .read = seq_read,
2319 .llseek = seq_lseek,
1da177e4
LT
2320 .release = seq_release,
2321};
88e9d34c 2322static const struct seq_operations debug_seq_ops = {
1da177e4
LT
2323 .start = dev_seq_start,
2324 .next = dev_seq_next,
2325 .stop = dev_seq_stop,
2326 .show = sg_proc_seq_show_debug,
2327};
2328
2329
2330struct sg_proc_leaf {
2331 const char * name;
828c0950 2332 const struct file_operations * fops;
1da177e4
LT
2333};
2334
18b8ba6c 2335static const struct sg_proc_leaf sg_proc_leaf_arr[] = {
1da177e4
LT
2336 {"allow_dio", &adio_fops},
2337 {"debug", &debug_fops},
2338 {"def_reserved_size", &dressz_fops},
2339 {"device_hdr", &devhdr_fops},
2340 {"devices", &dev_fops},
2341 {"device_strs", &devstrs_fops},
2342 {"version", &version_fops}
2343};
2344
2345static int
2346sg_proc_init(void)
2347{
6391a113 2348 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
d161a13f 2349 int k;
1da177e4 2350
66600221 2351 sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
1da177e4
LT
2352 if (!sg_proc_sgp)
2353 return 1;
2354 for (k = 0; k < num_leaves; ++k) {
18b8ba6c 2355 const struct sg_proc_leaf *leaf = &sg_proc_leaf_arr[k];
d161a13f 2356 umode_t mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
a973909f 2357 proc_create(leaf->name, mask, sg_proc_sgp, leaf->fops);
1da177e4
LT
2358 }
2359 return 0;
2360}
2361
2362static void
2363sg_proc_cleanup(void)
2364{
2365 int k;
6391a113 2366 int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
1da177e4
LT
2367
2368 if (!sg_proc_sgp)
2369 return;
2370 for (k = 0; k < num_leaves; ++k)
2371 remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
2372 remove_proc_entry(sg_proc_sg_dirname, NULL);
2373}
2374
2375
2376static int sg_proc_seq_show_int(struct seq_file *s, void *v)
2377{
2378 seq_printf(s, "%d\n", *((int *)s->private));
2379 return 0;
2380}
2381
2382static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
2383{
2384 return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
2385}
2386
2387static ssize_t
2388sg_proc_write_adio(struct file *filp, const char __user *buffer,
2389 size_t count, loff_t *off)
2390{
7e95fffe
SB
2391 int err;
2392 unsigned long num;
1da177e4
LT
2393
2394 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2395 return -EACCES;
7e95fffe
SB
2396 err = kstrtoul_from_user(buffer, count, 0, &num);
2397 if (err)
2398 return err;
2399 sg_allow_dio = num ? 1 : 0;
1da177e4
LT
2400 return count;
2401}
2402
2403static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
2404{
2405 return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
2406}
2407
2408static ssize_t
2409sg_proc_write_dressz(struct file *filp, const char __user *buffer,
2410 size_t count, loff_t *off)
2411{
7e95fffe 2412 int err;
1da177e4 2413 unsigned long k = ULONG_MAX;
1da177e4
LT
2414
2415 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2416 return -EACCES;
7e95fffe
SB
2417
2418 err = kstrtoul_from_user(buffer, count, 0, &k);
2419 if (err)
2420 return err;
1da177e4
LT
2421 if (k <= 1048576) { /* limit "big buff" to 1 MB */
2422 sg_big_buff = k;
2423 return count;
2424 }
2425 return -ERANGE;
2426}
2427
2428static int sg_proc_seq_show_version(struct seq_file *s, void *v)
2429{
2430 seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
2431 sg_version_date);
2432 return 0;
2433}
2434
2435static int sg_proc_single_open_version(struct inode *inode, struct file *file)
2436{
2437 return single_open(file, sg_proc_seq_show_version, NULL);
2438}
2439
2440static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
2441{
2442 seq_printf(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
2443 "online\n");
2444 return 0;
2445}
2446
2447static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
2448{
2449 return single_open(file, sg_proc_seq_show_devhdr, NULL);
2450}
2451
2452struct sg_proc_deviter {
2453 loff_t index;
2454 size_t max;
2455};
2456
2457static void * dev_seq_start(struct seq_file *s, loff_t *pos)
2458{
2459 struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);
2460
729d70f5 2461 s->private = it;
1da177e4
LT
2462 if (! it)
2463 return NULL;
729d70f5 2464
1da177e4
LT
2465 it->index = *pos;
2466 it->max = sg_last_dev();
2467 if (it->index >= it->max)
729d70f5 2468 return NULL;
1da177e4 2469 return it;
1da177e4
LT
2470}
2471
2472static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
2473{
729d70f5 2474 struct sg_proc_deviter * it = s->private;
1da177e4
LT
2475
2476 *pos = ++it->index;
2477 return (it->index < it->max) ? it : NULL;
2478}
2479
2480static void dev_seq_stop(struct seq_file *s, void *v)
2481{
729d70f5 2482 kfree(s->private);
1da177e4
LT
2483}
2484
2485static int sg_proc_open_dev(struct inode *inode, struct file *file)
2486{
2487 return seq_open(file, &dev_seq_ops);
2488}
2489
2490static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
2491{
2492 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2493 Sg_device *sdp;
2494 struct scsi_device *scsidp;
c6517b79 2495 unsigned long iflags;
1da177e4 2496
c6517b79
TB
2497 read_lock_irqsave(&sg_index_lock, iflags);
2498 sdp = it ? sg_lookup_dev(it->index) : NULL;
1da177e4
LT
2499 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2500 seq_printf(s, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
2501 scsidp->host->host_no, scsidp->channel,
2502 scsidp->id, scsidp->lun, (int) scsidp->type,
2503 1,
2504 (int) scsidp->queue_depth,
2505 (int) scsidp->device_busy,
2506 (int) scsi_device_online(scsidp));
2507 else
2508 seq_printf(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
c6517b79 2509 read_unlock_irqrestore(&sg_index_lock, iflags);
1da177e4
LT
2510 return 0;
2511}
2512
2513static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
2514{
2515 return seq_open(file, &devstrs_seq_ops);
2516}
2517
2518static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
2519{
2520 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2521 Sg_device *sdp;
2522 struct scsi_device *scsidp;
c6517b79 2523 unsigned long iflags;
1da177e4 2524
c6517b79
TB
2525 read_lock_irqsave(&sg_index_lock, iflags);
2526 sdp = it ? sg_lookup_dev(it->index) : NULL;
1da177e4
LT
2527 if (sdp && (scsidp = sdp->device) && (!sdp->detached))
2528 seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
2529 scsidp->vendor, scsidp->model, scsidp->rev);
2530 else
2531 seq_printf(s, "<no active device>\n");
c6517b79 2532 read_unlock_irqrestore(&sg_index_lock, iflags);
1da177e4
LT
2533 return 0;
2534}
2535
c6517b79 2536/* must be called while holding sg_index_lock */
1da177e4
LT
2537static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
2538{
2539 int k, m, new_interface, blen, usg;
2540 Sg_request *srp;
2541 Sg_fd *fp;
2542 const sg_io_hdr_t *hp;
2543 const char * cp;
cb59e840 2544 unsigned int ms;
1da177e4 2545
3442f802
FT
2546 k = 0;
2547 list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
2548 k++;
c6517b79 2549 read_lock(&fp->rq_list_lock); /* irqs already disabled */
1da177e4 2550 seq_printf(s, " FD(%d): timeout=%dms bufflen=%d "
3442f802 2551 "(res)sgat=%d low_dma=%d\n", k,
1da177e4
LT
2552 jiffies_to_msecs(fp->timeout),
2553 fp->reserve.bufflen,
2554 (int) fp->reserve.k_use_sg,
2555 (int) fp->low_dma);
ebaf466b 2556 seq_printf(s, " cmd_q=%d f_packid=%d k_orphan=%d closed=0\n",
1da177e4 2557 (int) fp->cmd_q, (int) fp->force_packid,
ebaf466b 2558 (int) fp->keep_orphan);
c6517b79
TB
2559 for (m = 0, srp = fp->headrp;
2560 srp != NULL;
2561 ++m, srp = srp->nextrp) {
1da177e4
LT
2562 hp = &srp->header;
2563 new_interface = (hp->interface_id == '\0') ? 0 : 1;
2564 if (srp->res_used) {
2565 if (new_interface &&
2566 (SG_FLAG_MMAP_IO & hp->flags))
2567 cp = " mmap>> ";
2568 else
2569 cp = " rb>> ";
2570 } else {
2571 if (SG_INFO_DIRECT_IO_MASK & hp->info)
2572 cp = " dio>> ";
2573 else
2574 cp = " ";
2575 }
2576 seq_printf(s, cp);
d6b10348
MC
2577 blen = srp->data.bufflen;
2578 usg = srp->data.k_use_sg;
1da177e4
LT
2579 seq_printf(s, srp->done ?
2580 ((1 == srp->done) ? "rcv:" : "fin:")
d6b10348 2581 : "act:");
1da177e4
LT
2582 seq_printf(s, " id=%d blen=%d",
2583 srp->header.pack_id, blen);
2584 if (srp->done)
2585 seq_printf(s, " dur=%d", hp->duration);
cb59e840
DG
2586 else {
2587 ms = jiffies_to_msecs(jiffies);
1da177e4 2588 seq_printf(s, " t_o/elap=%d/%d",
cb59e840
DG
2589 (new_interface ? hp->timeout :
2590 jiffies_to_msecs(fp->timeout)),
2591 (ms > hp->duration ? ms - hp->duration : 0));
2592 }
1da177e4
LT
2593 seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
2594 (int) srp->data.cmd_opcode);
2595 }
2596 if (0 == m)
2597 seq_printf(s, " No requests active\n");
c6517b79 2598 read_unlock(&fp->rq_list_lock);
1da177e4
LT
2599 }
2600}
2601
2602static int sg_proc_open_debug(struct inode *inode, struct file *file)
2603{
2604 return seq_open(file, &debug_seq_ops);
2605}
2606
2607static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
2608{
2609 struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
2610 Sg_device *sdp;
c6517b79 2611 unsigned long iflags;
1da177e4
LT
2612
2613 if (it && (0 == it->index)) {
7c07d613
JB
2614 seq_printf(s, "max_active_device=%d(origin 1)\n",
2615 (int)it->max);
1da177e4
LT
2616 seq_printf(s, " def_reserved_size=%d\n", sg_big_buff);
2617 }
1da177e4 2618
c6517b79
TB
2619 read_lock_irqsave(&sg_index_lock, iflags);
2620 sdp = it ? sg_lookup_dev(it->index) : NULL;
3442f802 2621 if (sdp && !list_empty(&sdp->sfds)) {
c6517b79 2622 struct scsi_device *scsidp = sdp->device;
1da177e4 2623
c6517b79
TB
2624 seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
2625 if (sdp->detached)
2626 seq_printf(s, "detached pending close ");
2627 else
2628 seq_printf
2629 (s, "scsi%d chan=%d id=%d lun=%d em=%d",
2630 scsidp->host->host_no,
2631 scsidp->channel, scsidp->id,
2632 scsidp->lun,
2633 scsidp->host->hostt->emulated);
2634 seq_printf(s, " sg_tablesize=%d excl=%d\n",
b499e524 2635 sdp->sg_tablesize, get_exclude(sdp));
1da177e4
LT
2636 sg_proc_debug_helper(s, sdp);
2637 }
c6517b79 2638 read_unlock_irqrestore(&sg_index_lock, iflags);
1da177e4
LT
2639 return 0;
2640}
2641
2642#endif /* CONFIG_SCSI_PROC_FS */
2643
2644module_init(init_sg);
2645module_exit(exit_sg);