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