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