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