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