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