sg.c 69.7 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/*
 *  History:
 *  Started: Aug 9 by Lawrence Foard (entropy@world.std.com),
 *           to allow user process control of SCSI devices.
 *  Development Sponsored by Killy Corp. NY NY
 *
 * Original driver (sg.c):
 *        Copyright (C) 1992 Lawrence Foard
 * Version 2 and 3 extensions to driver:
 *        Copyright (C) 1998 - 2005 Douglas Gilbert
 *
 *  Modified  19-JAN-1998  Richard Gooch <rgooch@atnf.csiro.au>  Devfs support
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 */

21 22
static int sg_version_num = 30534;	/* 2 digits for each component */
#define SG_VERSION_STR "3.5.34"
L
Linus Torvalds 已提交
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40

/*
 *  D. P. Gilbert (dgilbert@interlog.com, dougg@triode.net.au), notes:
 *      - scsi logging is available via SCSI_LOG_TIMEOUT macros. First
 *        the kernel/module needs to be built with CONFIG_SCSI_LOGGING
 *        (otherwise the macros compile to empty statements).
 *
 */
#include <linux/module.h>

#include <linux/fs.h>
#include <linux/kernel.h>
#include <linux/sched.h>
#include <linux/string.h>
#include <linux/mm.h>
#include <linux/errno.h>
#include <linux/mtio.h>
#include <linux/ioctl.h>
41
#include <linux/slab.h>
L
Linus Torvalds 已提交
42 43 44 45 46
#include <linux/fcntl.h>
#include <linux/init.h>
#include <linux/poll.h>
#include <linux/moduleparam.h>
#include <linux/cdev.h>
47
#include <linux/idr.h>
L
Linus Torvalds 已提交
48 49 50
#include <linux/seq_file.h>
#include <linux/blkdev.h>
#include <linux/delay.h>
51
#include <linux/blktrace_api.h>
52
#include <linux/mutex.h>
L
Linus Torvalds 已提交
53 54

#include "scsi.h"
已提交
55
#include <scsi/scsi_dbg.h>
L
Linus Torvalds 已提交
56 57 58 59 60 61 62 63 64
#include <scsi/scsi_host.h>
#include <scsi/scsi_driver.h>
#include <scsi/scsi_ioctl.h>
#include <scsi/sg.h>

#include "scsi_logging.h"

#ifdef CONFIG_SCSI_PROC_FS
#include <linux/proc_fs.h>
65
static char *sg_version_date = "20061027";
L
Linus Torvalds 已提交
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97

static int sg_proc_init(void);
static void sg_proc_cleanup(void);
#endif

#define SG_ALLOW_DIO_DEF 0

#define SG_MAX_DEVS 32768

/*
 * Suppose you want to calculate the formula muldiv(x,m,d)=int(x * m / d)
 * Then when using 32 bit integers x * m may overflow during the calculation.
 * Replacing muldiv(x) by muldiv(x)=((x % d) * m) / d + int(x / d) * m
 * calculates the same, but prevents the overflow when both m and d
 * are "small" numbers (like HZ and USER_HZ).
 * Of course an overflow is inavoidable if the result of muldiv doesn't fit
 * in 32 bits.
 */
#define MULDIV(X,MUL,DIV) ((((X % DIV) * MUL) / DIV) + ((X / DIV) * MUL))

#define SG_DEFAULT_TIMEOUT MULDIV(SG_DEFAULT_TIMEOUT_USER, HZ, USER_HZ)

int sg_big_buff = SG_DEF_RESERVED_SIZE;
/* N.B. This variable is readable and writeable via
   /proc/scsi/sg/def_reserved_size . Each time sg_open() is called a buffer
   of this size (or less if there is not enough memory) will be reserved
   for use by this file descriptor. [Deprecated usage: this variable is also
   readable via /proc/sys/kernel/sg-big-buff if the sg driver is built into
   the kernel (i.e. it is not a module).] */
static int def_reserved_size = -1;	/* picks up init parameter */
static int sg_allow_dio = SG_ALLOW_DIO_DEF;

98 99 100
static int scatter_elem_sz = SG_SCATTER_SZ;
static int scatter_elem_sz_prev = SG_SCATTER_SZ;

L
Linus Torvalds 已提交
101 102
#define SG_SECTOR_SZ 512

103 104
static int sg_add(struct device *, struct class_interface *);
static void sg_remove(struct device *, struct class_interface *);
L
Linus Torvalds 已提交
105

106 107
static DEFINE_MUTEX(sg_mutex);

108 109
static DEFINE_IDR(sg_index_idr);
static DEFINE_RWLOCK(sg_index_lock);	/* Also used to lock
L
Linus Torvalds 已提交
110 111 112
							   file descriptor list for device */

static struct class_interface sg_interface = {
113 114
	.add_dev	= sg_add,
	.remove_dev	= sg_remove,
L
Linus Torvalds 已提交
115 116 117 118
};

typedef struct sg_scatter_hold { /* holding area for scsi scatter gather info */
	unsigned short k_use_sg; /* Count of kernel scatter-gather pieces */
119
	unsigned sglist_len; /* size of malloc'd scatter-gather list ++ */
L
Linus Torvalds 已提交
120
	unsigned bufflen;	/* Size of (aggregate) data buffer */
121 122
	struct page **pages;
	int page_order;
L
Linus Torvalds 已提交
123 124 125 126 127 128 129 130 131 132 133 134
	char dio_in_use;	/* 0->indirect IO (or mmap), 1->dio */
	unsigned char cmd_opcode; /* first byte of command */
} Sg_scatter_hold;

struct sg_device;		/* forward declarations */
struct sg_fd;

typedef struct sg_request {	/* SG_MAX_QUEUE requests outstanding per file */
	struct sg_request *nextrp;	/* NULL -> tail request (slist) */
	struct sg_fd *parentfp;	/* NULL -> not in use */
	Sg_scatter_hold data;	/* hold buffer, perhaps scatter list */
	sg_io_hdr_t header;	/* scsi command+info, see <scsi/sg.h> */
135
	unsigned char sense_b[SCSI_SENSE_BUFFERSIZE];
L
Linus Torvalds 已提交
136 137 138 139
	char res_used;		/* 1 -> using reserve buffer, 0 -> not ... */
	char orphan;		/* 1 -> drop on sight, 0 -> normal */
	char sg_io_owned;	/* 1 -> packet belongs to SG_IO */
	volatile char done;	/* 0->before bh, 1->before read, 2->read */
140
	struct request *rq;
141
	struct bio *bio;
142
	struct execute_work ew;
L
Linus Torvalds 已提交
143 144 145
} Sg_request;

typedef struct sg_fd {		/* holds the state of a file descriptor */
146
	struct list_head sfd_siblings;
L
Linus Torvalds 已提交
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
	struct sg_device *parentdp;	/* owning device */
	wait_queue_head_t read_wait;	/* queue read until command done */
	rwlock_t rq_list_lock;	/* protect access to list in req_arr */
	int timeout;		/* defaults to SG_DEFAULT_TIMEOUT      */
	int timeout_user;	/* defaults to SG_DEFAULT_TIMEOUT_USER */
	Sg_scatter_hold reserve;	/* buffer held for this file descriptor */
	unsigned save_scat_len;	/* original length of trunc. scat. element */
	Sg_request *headrp;	/* head of request slist, NULL->empty */
	struct fasync_struct *async_qp;	/* used by asynchronous notification */
	Sg_request req_arr[SG_MAX_QUEUE];	/* used as singly-linked list */
	char low_dma;		/* as in parent but possibly overridden to 1 */
	char force_packid;	/* 1 -> pack_id input to read(), 0 -> ignored */
	volatile char closed;	/* 1 -> fd closed but request(s) outstanding */
	char cmd_q;		/* 1 -> allow command queuing, 0 -> don't */
	char next_cmd_len;	/* 0 -> automatic (def), >0 -> use on next write() */
	char keep_orphan;	/* 0 -> drop orphan (def), 1 -> keep for read() */
	char mmap_called;	/* 0 -> mmap() never called on this fd */
164 165
	struct kref f_ref;
	struct execute_work ew;
L
Linus Torvalds 已提交
166 167 168 169 170 171
} Sg_fd;

typedef struct sg_device { /* holds the state of each scsi generic device */
	struct scsi_device *device;
	wait_queue_head_t o_excl_wait;	/* queue open() when O_EXCL in use */
	int sg_tablesize;	/* adapter's max scatter-gather table size */
172
	u32 index;		/* device index number */
173
	struct list_head sfds;
L
Linus Torvalds 已提交
174 175 176 177 178
	volatile char detached;	/* 0->attached, 1->detached pending removal */
	volatile char exclude;	/* opened for exclusive access */
	char sgdebug;		/* 0->off, 1->sense, 9->dump dev, 10-> all devs */
	struct gendisk *disk;
	struct cdev * cdev;	/* char_dev [sysfs: /sys/cdev/major/sg<n>] */
179
	struct kref d_ref;
L
Linus Torvalds 已提交
180 181
} Sg_device;

182
/* tasklet or soft irq callback */
183
static void sg_rq_end_io(struct request *rq, int uptodate);
184
static int sg_start_req(Sg_request *srp, unsigned char *cmd);
185
static int sg_finish_rem_req(Sg_request * srp);
L
Linus Torvalds 已提交
186 187 188
static int sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size);
static ssize_t sg_new_read(Sg_fd * sfp, char __user *buf, size_t count,
			   Sg_request * srp);
189 190
static ssize_t sg_new_write(Sg_fd *sfp, struct file *file,
			const char __user *buf, size_t count, int blocking,
191
			int read_only, int sg_io_owned, Sg_request **o_srp);
L
Linus Torvalds 已提交
192 193 194 195 196 197 198 199
static int sg_common_write(Sg_fd * sfp, Sg_request * srp,
			   unsigned char *cmnd, int timeout, int blocking);
static int sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer);
static void sg_remove_scat(Sg_scatter_hold * schp);
static void sg_build_reserve(Sg_fd * sfp, int req_size);
static void sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size);
static void sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp);
static Sg_fd *sg_add_sfp(Sg_device * sdp, int dev);
200
static void sg_remove_sfp(struct kref *);
L
Linus Torvalds 已提交
201 202 203 204 205
static Sg_request *sg_get_rq_mark(Sg_fd * sfp, int pack_id);
static Sg_request *sg_add_request(Sg_fd * sfp);
static int sg_remove_request(Sg_fd * sfp, Sg_request * srp);
static int sg_res_in_use(Sg_fd * sfp);
static Sg_device *sg_get_dev(int dev);
206
static void sg_put_dev(Sg_device *sdp);
L
Linus Torvalds 已提交
207 208 209 210 211 212

#define SZ_SG_HEADER sizeof(struct sg_header)
#define SZ_SG_IO_HDR sizeof(sg_io_hdr_t)
#define SZ_SG_IOVEC sizeof(sg_iovec_t)
#define SZ_SG_REQ_INFO sizeof(sg_req_info_t)

213 214 215 216 217 218 219
static int sg_allow_access(struct file *filp, unsigned char *cmd)
{
	struct sg_fd *sfp = (struct sg_fd *)filp->private_data;

	if (sfp->parentdp->device->type == TYPE_SCANNER)
		return 0;

220
	return blk_verify_command(cmd, filp->f_mode & FMODE_WRITE);
221 222
}

L
Linus Torvalds 已提交
223 224 225 226 227
static int
sg_open(struct inode *inode, struct file *filp)
{
	int dev = iminor(inode);
	int flags = filp->f_flags;
228
	struct request_queue *q;
L
Linus Torvalds 已提交
229 230 231 232 233
	Sg_device *sdp;
	Sg_fd *sfp;
	int res;
	int retval;

234
	mutex_lock(&sg_mutex);
L
Linus Torvalds 已提交
235 236 237
	nonseekable_open(inode, filp);
	SCSI_LOG_TIMEOUT(3, printk("sg_open: dev=%d, flags=0x%x\n", dev, flags));
	sdp = sg_get_dev(dev);
238 239 240 241
	if (IS_ERR(sdp)) {
		retval = PTR_ERR(sdp);
		sdp = NULL;
		goto sg_put;
242
	}
L
Linus Torvalds 已提交
243 244 245 246

	/* This driver's module count bumped by fops_get in <linux/fs.h> */
	/* Prevent the device driver from vanishing while we sleep */
	retval = scsi_device_get(sdp->device);
247 248
	if (retval)
		goto sg_put;
L
Linus Torvalds 已提交
249

250 251 252 253
	retval = scsi_autopm_get_device(sdp->device);
	if (retval)
		goto sdp_put;

L
Linus Torvalds 已提交
254 255 256 257 258 259 260 261 262 263 264 265
	if (!((flags & O_NONBLOCK) ||
	      scsi_block_when_processing_errors(sdp->device))) {
		retval = -ENXIO;
		/* we are in error recovery for this device */
		goto error_out;
	}

	if (flags & O_EXCL) {
		if (O_RDONLY == (flags & O_ACCMODE)) {
			retval = -EPERM; /* Can't lock it with read only access */
			goto error_out;
		}
266
		if (!list_empty(&sdp->sfds) && (flags & O_NONBLOCK)) {
L
Linus Torvalds 已提交
267 268 269 270 271
			retval = -EBUSY;
			goto error_out;
		}
		res = 0;
		__wait_event_interruptible(sdp->o_excl_wait,
272
					   ((!list_empty(&sdp->sfds) || sdp->exclude) ? 0 : (sdp->exclude = 1)), res);
L
Linus Torvalds 已提交
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
		if (res) {
			retval = res;	/* -ERESTARTSYS because signal hit process */
			goto error_out;
		}
	} else if (sdp->exclude) {	/* some other fd has an exclusive lock on dev */
		if (flags & O_NONBLOCK) {
			retval = -EBUSY;
			goto error_out;
		}
		res = 0;
		__wait_event_interruptible(sdp->o_excl_wait, (!sdp->exclude),
					   res);
		if (res) {
			retval = res;	/* -ERESTARTSYS because signal hit process */
			goto error_out;
		}
	}
	if (sdp->detached) {
		retval = -ENODEV;
		goto error_out;
	}
294
	if (list_empty(&sdp->sfds)) {	/* no existing opens on this device */
L
Linus Torvalds 已提交
295
		sdp->sgdebug = 0;
296
		q = sdp->device->request_queue;
297
		sdp->sg_tablesize = queue_max_segments(q);
L
Linus Torvalds 已提交
298 299 300 301
	}
	if ((sfp = sg_add_sfp(sdp, dev)))
		filp->private_data = sfp;
	else {
302
		if (flags & O_EXCL) {
L
Linus Torvalds 已提交
303
			sdp->exclude = 0;	/* undo if error */
304 305
			wake_up_interruptible(&sdp->o_excl_wait);
		}
L
Linus Torvalds 已提交
306 307 308
		retval = -ENOMEM;
		goto error_out;
	}
309 310
	retval = 0;
error_out:
311 312 313
	if (retval) {
		scsi_autopm_put_device(sdp->device);
sdp_put:
314
		scsi_device_put(sdp->device);
315
	}
316 317 318
sg_put:
	if (sdp)
		sg_put_dev(sdp);
319
	mutex_unlock(&sg_mutex);
L
Linus Torvalds 已提交
320 321 322 323 324 325 326 327 328 329 330 331 332
	return retval;
}

/* Following function was formerly called 'sg_close' */
static int
sg_release(struct inode *inode, struct file *filp)
{
	Sg_device *sdp;
	Sg_fd *sfp;

	if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
		return -ENXIO;
	SCSI_LOG_TIMEOUT(3, printk("sg_release: %s\n", sdp->disk->disk_name));
333 334 335 336 337 338

	sfp->closed = 1;

	sdp->exclude = 0;
	wake_up_interruptible(&sdp->o_excl_wait);

339
	scsi_autopm_put_device(sdp->device);
340
	kref_put(&sfp->f_ref, sg_remove_sfp);
L
Linus Torvalds 已提交
341 342 343 344 345 346 347 348 349 350 351
	return 0;
}

static ssize_t
sg_read(struct file *filp, char __user *buf, size_t count, loff_t * ppos)
{
	Sg_device *sdp;
	Sg_fd *sfp;
	Sg_request *srp;
	int req_pack_id = -1;
	sg_io_hdr_t *hp;
已提交
352 353
	struct sg_header *old_hdr = NULL;
	int retval = 0;
L
Linus Torvalds 已提交
354 355 356 357 358

	if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
		return -ENXIO;
	SCSI_LOG_TIMEOUT(3, printk("sg_read: %s, count=%d\n",
				   sdp->disk->disk_name, (int) count));
359

L
Linus Torvalds 已提交
360 361 362
	if (!access_ok(VERIFY_WRITE, buf, count))
		return -EFAULT;
	if (sfp->force_packid && (count >= SZ_SG_HEADER)) {
已提交
363 364 365 366 367 368 369 370
		old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
		if (!old_hdr)
			return -ENOMEM;
		if (__copy_from_user(old_hdr, buf, SZ_SG_HEADER)) {
			retval = -EFAULT;
			goto free_old_hdr;
		}
		if (old_hdr->reply_len < 0) {
L
Linus Torvalds 已提交
371
			if (count >= SZ_SG_IO_HDR) {
已提交
372 373 374 375 376 377 378 379 380 381 382 383 384 385
				sg_io_hdr_t *new_hdr;
				new_hdr = kmalloc(SZ_SG_IO_HDR, GFP_KERNEL);
				if (!new_hdr) {
					retval = -ENOMEM;
					goto free_old_hdr;
				}
				retval =__copy_from_user
				    (new_hdr, buf, SZ_SG_IO_HDR);
				req_pack_id = new_hdr->pack_id;
				kfree(new_hdr);
				if (retval) {
					retval = -EFAULT;
					goto free_old_hdr;
				}
L
Linus Torvalds 已提交
386 387
			}
		} else
已提交
388
			req_pack_id = old_hdr->pack_id;
L
Linus Torvalds 已提交
389 390 391
	}
	srp = sg_get_rq_mark(sfp, req_pack_id);
	if (!srp) {		/* now wait on packet to arrive */
已提交
392 393 394 395 396 397 398 399
		if (sdp->detached) {
			retval = -ENODEV;
			goto free_old_hdr;
		}
		if (filp->f_flags & O_NONBLOCK) {
			retval = -EAGAIN;
			goto free_old_hdr;
		}
L
Linus Torvalds 已提交
400
		while (1) {
已提交
401
			retval = 0; /* following macro beats race condition */
L
Linus Torvalds 已提交
402
			__wait_event_interruptible(sfp->read_wait,
已提交
403 404 405 406 407 408 409 410
				(sdp->detached ||
				(srp = sg_get_rq_mark(sfp, req_pack_id))), 
				retval);
			if (sdp->detached) {
				retval = -ENODEV;
				goto free_old_hdr;
			}
			if (0 == retval)
L
Linus Torvalds 已提交
411
				break;
已提交
412 413 414

			/* -ERESTARTSYS as signal hit process */
			goto free_old_hdr;
L
Linus Torvalds 已提交
415 416
		}
	}
已提交
417 418 419 420
	if (srp->header.interface_id != '\0') {
		retval = sg_new_read(sfp, buf, count, srp);
		goto free_old_hdr;
	}
L
Linus Torvalds 已提交
421 422

	hp = &srp->header;
已提交
423 424 425 426 427 428 429 430 431 432 433 434
	if (old_hdr == NULL) {
		old_hdr = kmalloc(SZ_SG_HEADER, GFP_KERNEL);
		if (! old_hdr) {
			retval = -ENOMEM;
			goto free_old_hdr;
		}
	}
	memset(old_hdr, 0, SZ_SG_HEADER);
	old_hdr->reply_len = (int) hp->timeout;
	old_hdr->pack_len = old_hdr->reply_len; /* old, strange behaviour */
	old_hdr->pack_id = hp->pack_id;
	old_hdr->twelve_byte =
L
Linus Torvalds 已提交
435
	    ((srp->data.cmd_opcode >= 0xc0) && (12 == hp->cmd_len)) ? 1 : 0;
已提交
436 437 438
	old_hdr->target_status = hp->masked_status;
	old_hdr->host_status = hp->host_status;
	old_hdr->driver_status = hp->driver_status;
L
Linus Torvalds 已提交
439 440
	if ((CHECK_CONDITION & hp->masked_status) ||
	    (DRIVER_SENSE & hp->driver_status))
已提交
441 442
		memcpy(old_hdr->sense_buffer, srp->sense_b,
		       sizeof (old_hdr->sense_buffer));
L
Linus Torvalds 已提交
443 444 445 446 447 448
	switch (hp->host_status) {
	/* This setup of 'result' is for backward compatibility and is best
	   ignored by the user who should use target, host + driver status */
	case DID_OK:
	case DID_PASSTHROUGH:
	case DID_SOFT_ERROR:
已提交
449
		old_hdr->result = 0;
L
Linus Torvalds 已提交
450 451 452 453
		break;
	case DID_NO_CONNECT:
	case DID_BUS_BUSY:
	case DID_TIME_OUT:
已提交
454
		old_hdr->result = EBUSY;
L
Linus Torvalds 已提交
455 456 457 458 459 460
		break;
	case DID_BAD_TARGET:
	case DID_ABORT:
	case DID_PARITY:
	case DID_RESET:
	case DID_BAD_INTR:
已提交
461
		old_hdr->result = EIO;
L
Linus Torvalds 已提交
462 463
		break;
	case DID_ERROR:
已提交
464
		old_hdr->result = (srp->sense_b[0] == 0 && 
L
Linus Torvalds 已提交
465 466 467
				  hp->masked_status == GOOD) ? 0 : EIO;
		break;
	default:
已提交
468
		old_hdr->result = EIO;
L
Linus Torvalds 已提交
469 470 471 472 473
		break;
	}

	/* Now copy the result back to the user buffer.  */
	if (count >= SZ_SG_HEADER) {
已提交
474 475 476 477
		if (__copy_to_user(buf, old_hdr, SZ_SG_HEADER)) {
			retval = -EFAULT;
			goto free_old_hdr;
		}
L
Linus Torvalds 已提交
478
		buf += SZ_SG_HEADER;
已提交
479 480
		if (count > old_hdr->reply_len)
			count = old_hdr->reply_len;
L
Linus Torvalds 已提交
481
		if (count > SZ_SG_HEADER) {
已提交
482 483 484 485
			if (sg_read_oxfer(srp, buf, count - SZ_SG_HEADER)) {
				retval = -EFAULT;
				goto free_old_hdr;
			}
L
Linus Torvalds 已提交
486 487
		}
	} else
已提交
488
		count = (old_hdr->result == 0) ? 0 : -EIO;
L
Linus Torvalds 已提交
489
	sg_finish_rem_req(srp);
已提交
490 491
	retval = count;
free_old_hdr:
J
Jesper Juhl 已提交
492
	kfree(old_hdr);
已提交
493
	return retval;
L
Linus Torvalds 已提交
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
}

static ssize_t
sg_new_read(Sg_fd * sfp, char __user *buf, size_t count, Sg_request * srp)
{
	sg_io_hdr_t *hp = &srp->header;
	int err = 0;
	int len;

	if (count < SZ_SG_IO_HDR) {
		err = -EINVAL;
		goto err_out;
	}
	hp->sb_len_wr = 0;
	if ((hp->mx_sb_len > 0) && hp->sbp) {
		if ((CHECK_CONDITION & hp->masked_status) ||
		    (DRIVER_SENSE & hp->driver_status)) {
511
			int sb_len = SCSI_SENSE_BUFFERSIZE;
L
Linus Torvalds 已提交
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
			sb_len = (hp->mx_sb_len > sb_len) ? sb_len : hp->mx_sb_len;
			len = 8 + (int) srp->sense_b[7];	/* Additional sense length field */
			len = (len > sb_len) ? sb_len : len;
			if (copy_to_user(hp->sbp, srp->sense_b, len)) {
				err = -EFAULT;
				goto err_out;
			}
			hp->sb_len_wr = len;
		}
	}
	if (hp->masked_status || hp->host_status || hp->driver_status)
		hp->info |= SG_INFO_CHECK;
	if (copy_to_user(buf, hp, SZ_SG_IO_HDR)) {
		err = -EFAULT;
		goto err_out;
	}
F
FUJITA Tomonori 已提交
528
err_out:
529
	err = sg_finish_rem_req(srp);
L
Linus Torvalds 已提交
530 531 532 533 534 535 536 537 538 539 540 541 542 543
	return (0 == err) ? count : err;
}

static ssize_t
sg_write(struct file *filp, const char __user *buf, size_t count, loff_t * ppos)
{
	int mxsize, cmd_size, k;
	int input_size, blocking;
	unsigned char opcode;
	Sg_device *sdp;
	Sg_fd *sfp;
	Sg_request *srp;
	struct sg_header old_hdr;
	sg_io_hdr_t *hp;
544
	unsigned char cmnd[MAX_COMMAND_SIZE];
L
Linus Torvalds 已提交
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563

	if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
		return -ENXIO;
	SCSI_LOG_TIMEOUT(3, printk("sg_write: %s, count=%d\n",
				   sdp->disk->disk_name, (int) count));
	if (sdp->detached)
		return -ENODEV;
	if (!((filp->f_flags & O_NONBLOCK) ||
	      scsi_block_when_processing_errors(sdp->device)))
		return -ENXIO;

	if (!access_ok(VERIFY_READ, buf, count))
		return -EFAULT;	/* protects following copy_from_user()s + get_user()s */
	if (count < SZ_SG_HEADER)
		return -EIO;
	if (__copy_from_user(&old_hdr, buf, SZ_SG_HEADER))
		return -EFAULT;
	blocking = !(filp->f_flags & O_NONBLOCK);
	if (old_hdr.reply_len < 0)
564 565
		return sg_new_write(sfp, filp, buf, count,
				    blocking, 0, 0, NULL);
L
Linus Torvalds 已提交
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
	if (count < (SZ_SG_HEADER + 6))
		return -EIO;	/* The minimum scsi command length is 6 bytes. */

	if (!(srp = sg_add_request(sfp))) {
		SCSI_LOG_TIMEOUT(1, printk("sg_write: queue full\n"));
		return -EDOM;
	}
	buf += SZ_SG_HEADER;
	__get_user(opcode, buf);
	if (sfp->next_cmd_len > 0) {
		if (sfp->next_cmd_len > MAX_COMMAND_SIZE) {
			SCSI_LOG_TIMEOUT(1, printk("sg_write: command length too long\n"));
			sfp->next_cmd_len = 0;
			sg_remove_request(sfp, srp);
			return -EIO;
		}
		cmd_size = sfp->next_cmd_len;
		sfp->next_cmd_len = 0;	/* reset so only this write() effected */
	} else {
		cmd_size = COMMAND_SIZE(opcode);	/* based on SCSI command group */
		if ((opcode >= 0xc0) && old_hdr.twelve_byte)
			cmd_size = 12;
	}
	SCSI_LOG_TIMEOUT(4, printk(
		"sg_write:   scsi opcode=0x%02x, cmd_size=%d\n", (int) opcode, cmd_size));
/* Determine buffer size.  */
	input_size = count - cmd_size;
	mxsize = (input_size > old_hdr.reply_len) ? input_size : old_hdr.reply_len;
	mxsize -= SZ_SG_HEADER;
	input_size -= SZ_SG_HEADER;
	if (input_size < 0) {
		sg_remove_request(sfp, srp);
		return -EIO;	/* User did not pass enough bytes for this command. */
	}
	hp = &srp->header;
	hp->interface_id = '\0';	/* indicator of old interface tunnelled */
	hp->cmd_len = (unsigned char) cmd_size;
	hp->iovec_count = 0;
	hp->mx_sb_len = 0;
	if (input_size > 0)
		hp->dxfer_direction = (old_hdr.reply_len > SZ_SG_HEADER) ?
		    SG_DXFER_TO_FROM_DEV : SG_DXFER_TO_DEV;
	else
		hp->dxfer_direction = (mxsize > 0) ? SG_DXFER_FROM_DEV : SG_DXFER_NONE;
	hp->dxfer_len = mxsize;
611 612 613 614
	if (hp->dxfer_direction == SG_DXFER_TO_DEV)
		hp->dxferp = (char __user *)buf + cmd_size;
	else
		hp->dxferp = NULL;
L
Linus Torvalds 已提交
615 616 617 618 619 620 621 622 623 624 625 626
	hp->sbp = NULL;
	hp->timeout = old_hdr.reply_len;	/* structure abuse ... */
	hp->flags = input_size;	/* structure abuse ... */
	hp->pack_id = old_hdr.pack_id;
	hp->usr_ptr = NULL;
	if (__copy_from_user(cmnd, buf, cmd_size))
		return -EFAULT;
	/*
	 * SG_DXFER_TO_FROM_DEV is functionally equivalent to SG_DXFER_FROM_DEV,
	 * but is is possible that the app intended SG_DXFER_TO_DEV, because there
	 * is a non-zero input_size, so emit a warning.
	 */
627 628 629
	if (hp->dxfer_direction == SG_DXFER_TO_FROM_DEV) {
		static char cmd[TASK_COMM_LEN];
		if (strcmp(current->comm, cmd) && printk_ratelimit()) {
L
Linus Torvalds 已提交
630 631
			printk(KERN_WARNING
			       "sg_write: data in/out %d/%d bytes for SCSI command 0x%x--"
632
			       "guessing data in;\n   "
L
Linus Torvalds 已提交
633 634 635 636
			       "program %s not setting count and/or reply_len properly\n",
			       old_hdr.reply_len - (int)SZ_SG_HEADER,
			       input_size, (unsigned int) cmnd[0],
			       current->comm);
637 638 639
			strcpy(cmd, current->comm);
		}
	}
L
Linus Torvalds 已提交
640 641 642 643 644
	k = sg_common_write(sfp, srp, cmnd, sfp->timeout, blocking);
	return (k < 0) ? k : count;
}

static ssize_t
645
sg_new_write(Sg_fd *sfp, struct file *file, const char __user *buf,
646
		 size_t count, int blocking, int read_only, int sg_io_owned,
647
		 Sg_request **o_srp)
L
Linus Torvalds 已提交
648 649 650 651
{
	int k;
	Sg_request *srp;
	sg_io_hdr_t *hp;
652
	unsigned char cmnd[MAX_COMMAND_SIZE];
L
Linus Torvalds 已提交
653 654 655 656 657 658 659 660 661 662 663 664 665
	int timeout;
	unsigned long ul_timeout;

	if (count < SZ_SG_IO_HDR)
		return -EINVAL;
	if (!access_ok(VERIFY_READ, buf, count))
		return -EFAULT; /* protects following copy_from_user()s + get_user()s */

	sfp->cmd_q = 1;	/* when sg_io_hdr seen, set command queuing on */
	if (!(srp = sg_add_request(sfp))) {
		SCSI_LOG_TIMEOUT(1, printk("sg_new_write: queue full\n"));
		return -EDOM;
	}
666
	srp->sg_io_owned = sg_io_owned;
L
Linus Torvalds 已提交
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
	hp = &srp->header;
	if (__copy_from_user(hp, buf, SZ_SG_IO_HDR)) {
		sg_remove_request(sfp, srp);
		return -EFAULT;
	}
	if (hp->interface_id != 'S') {
		sg_remove_request(sfp, srp);
		return -ENOSYS;
	}
	if (hp->flags & SG_FLAG_MMAP_IO) {
		if (hp->dxfer_len > sfp->reserve.bufflen) {
			sg_remove_request(sfp, srp);
			return -ENOMEM;	/* MMAP_IO size must fit in reserve buffer */
		}
		if (hp->flags & SG_FLAG_DIRECT_IO) {
			sg_remove_request(sfp, srp);
			return -EINVAL;	/* either MMAP_IO or DIRECT_IO (not both) */
		}
		if (sg_res_in_use(sfp)) {
			sg_remove_request(sfp, srp);
			return -EBUSY;	/* reserve buffer already being used */
		}
	}
	ul_timeout = msecs_to_jiffies(srp->header.timeout);
	timeout = (ul_timeout < INT_MAX) ? ul_timeout : INT_MAX;
	if ((!hp->cmdp) || (hp->cmd_len < 6) || (hp->cmd_len > sizeof (cmnd))) {
		sg_remove_request(sfp, srp);
		return -EMSGSIZE;
	}
	if (!access_ok(VERIFY_READ, hp->cmdp, hp->cmd_len)) {
		sg_remove_request(sfp, srp);
		return -EFAULT;	/* protects following copy_from_user()s + get_user()s */
	}
	if (__copy_from_user(cmnd, hp->cmdp, hp->cmd_len)) {
		sg_remove_request(sfp, srp);
		return -EFAULT;
	}
704
	if (read_only && sg_allow_access(file, cmnd)) {
L
Linus Torvalds 已提交
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
		sg_remove_request(sfp, srp);
		return -EPERM;
	}
	k = sg_common_write(sfp, srp, cmnd, timeout, blocking);
	if (k < 0)
		return k;
	if (o_srp)
		*o_srp = srp;
	return count;
}

static int
sg_common_write(Sg_fd * sfp, Sg_request * srp,
		unsigned char *cmnd, int timeout, int blocking)
{
720
	int k, data_dir;
L
Linus Torvalds 已提交
721 722 723 724 725 726 727 728 729 730 731 732 733 734
	Sg_device *sdp = sfp->parentdp;
	sg_io_hdr_t *hp = &srp->header;

	srp->data.cmd_opcode = cmnd[0];	/* hold opcode of command */
	hp->status = 0;
	hp->masked_status = 0;
	hp->msg_status = 0;
	hp->info = 0;
	hp->host_status = 0;
	hp->driver_status = 0;
	hp->resid = 0;
	SCSI_LOG_TIMEOUT(4, printk("sg_common_write:  scsi opcode=0x%02x, cmd_size=%d\n",
			  (int) cmnd[0], (int) hp->cmd_len));

735 736
	k = sg_start_req(srp, cmnd);
	if (k) {
737
		SCSI_LOG_TIMEOUT(1, printk("sg_common_write: start_req err=%d\n", k));
L
Linus Torvalds 已提交
738 739 740 741
		sg_finish_rem_req(srp);
		return k;	/* probably out of space --> ENOMEM */
	}
	if (sdp->detached) {
742 743
		if (srp->bio)
			blk_end_request_all(srp->rq, -EIO);
L
Linus Torvalds 已提交
744 745 746 747 748 749 750
		sg_finish_rem_req(srp);
		return -ENODEV;
	}

	switch (hp->dxfer_direction) {
	case SG_DXFER_TO_FROM_DEV:
	case SG_DXFER_FROM_DEV:
751
		data_dir = DMA_FROM_DEVICE;
L
Linus Torvalds 已提交
752 753
		break;
	case SG_DXFER_TO_DEV:
754
		data_dir = DMA_TO_DEVICE;
L
Linus Torvalds 已提交
755 756
		break;
	case SG_DXFER_UNKNOWN:
757
		data_dir = DMA_BIDIRECTIONAL;
L
Linus Torvalds 已提交
758 759
		break;
	default:
760
		data_dir = DMA_NONE;
L
Linus Torvalds 已提交
761 762
		break;
	}
已提交
763
	hp->duration = jiffies_to_msecs(jiffies);
764 765

	srp->rq->timeout = timeout;
766
	kref_get(&sfp->f_ref); /* sg_rq_end_io() does kref_put(). */
767 768 769
	blk_execute_rq_nowait(sdp->device->request_queue, sdp->disk,
			      srp->rq, 1, sg_rq_end_io);
	return 0;
L
Linus Torvalds 已提交
770 771 772
}

static int
773
sg_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
L
Linus Torvalds 已提交
774 775 776 777 778 779 780 781 782 783 784
{
	void __user *p = (void __user *)arg;
	int __user *ip = p;
	int result, val, read_only;
	Sg_device *sdp;
	Sg_fd *sfp;
	Sg_request *srp;
	unsigned long iflags;

	if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
		return -ENXIO;
785

L
Linus Torvalds 已提交
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
	SCSI_LOG_TIMEOUT(3, printk("sg_ioctl: %s, cmd=0x%x\n",
				   sdp->disk->disk_name, (int) cmd_in));
	read_only = (O_RDWR != (filp->f_flags & O_ACCMODE));

	switch (cmd_in) {
	case SG_IO:
		{
			int blocking = 1;	/* ignore O_NONBLOCK flag */

			if (sdp->detached)
				return -ENODEV;
			if (!scsi_block_when_processing_errors(sdp->device))
				return -ENXIO;
			if (!access_ok(VERIFY_WRITE, p, SZ_SG_IO_HDR))
				return -EFAULT;
			result =
802
			    sg_new_write(sfp, filp, p, SZ_SG_IO_HDR,
803
					 blocking, read_only, 1, &srp);
L
Linus Torvalds 已提交
804 805 806 807 808
			if (result < 0)
				return result;
			while (1) {
				result = 0;	/* following macro to beat race condition */
				__wait_event_interruptible(sfp->read_wait,
809 810
					(srp->done || sdp->detached),
					result);
L
Linus Torvalds 已提交
811 812
				if (sdp->detached)
					return -ENODEV;
813 814 815 816
				write_lock_irq(&sfp->rq_list_lock);
				if (srp->done) {
					srp->done = 2;
					write_unlock_irq(&sfp->rq_list_lock);
L
Linus Torvalds 已提交
817
					break;
818
				}
L
Linus Torvalds 已提交
819
				srp->orphan = 1;
820
				write_unlock_irq(&sfp->rq_list_lock);
L
Linus Torvalds 已提交
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
				return result;	/* -ERESTARTSYS because signal hit process */
			}
			result = sg_new_read(sfp, p, SZ_SG_IO_HDR, srp);
			return (result < 0) ? result : 0;
		}
	case SG_SET_TIMEOUT:
		result = get_user(val, ip);
		if (result)
			return result;
		if (val < 0)
			return -EIO;
		if (val >= MULDIV (INT_MAX, USER_HZ, HZ))
		    val = MULDIV (INT_MAX, USER_HZ, HZ);
		sfp->timeout_user = val;
		sfp->timeout = MULDIV (val, HZ, USER_HZ);

		return 0;
	case SG_GET_TIMEOUT:	/* N.B. User receives timeout as return value */
				/* strange ..., for backward compatibility */
		return sfp->timeout_user;
	case SG_SET_FORCE_LOW_DMA:
		result = get_user(val, ip);
		if (result)
			return result;
		if (val) {
			sfp->low_dma = 1;
			if ((0 == sfp->low_dma) && (0 == sg_res_in_use(sfp))) {
				val = (int) sfp->reserve.bufflen;
				sg_remove_scat(&sfp->reserve);
				sg_build_reserve(sfp, val);
			}
		} else {
			if (sdp->detached)
				return -ENODEV;
			sfp->low_dma = sdp->device->host->unchecked_isa_dma;
		}
		return 0;
	case SG_GET_LOW_DMA:
		return put_user((int) sfp->low_dma, ip);
	case SG_GET_SCSI_ID:
		if (!access_ok(VERIFY_WRITE, p, sizeof (sg_scsi_id_t)))
			return -EFAULT;
		else {
			sg_scsi_id_t __user *sg_idp = p;

			if (sdp->detached)
				return -ENODEV;
			__put_user((int) sdp->device->host->host_no,
				   &sg_idp->host_no);
			__put_user((int) sdp->device->channel,
				   &sg_idp->channel);
			__put_user((int) sdp->device->id, &sg_idp->scsi_id);
			__put_user((int) sdp->device->lun, &sg_idp->lun);
			__put_user((int) sdp->device->type, &sg_idp->scsi_type);
			__put_user((short) sdp->device->host->cmd_per_lun,
				   &sg_idp->h_cmd_per_lun);
			__put_user((short) sdp->device->queue_depth,
				   &sg_idp->d_queue_depth);
			__put_user(0, &sg_idp->unused[0]);
			__put_user(0, &sg_idp->unused[1]);
			return 0;
		}
	case SG_SET_FORCE_PACK_ID:
		result = get_user(val, ip);
		if (result)
			return result;
		sfp->force_packid = val ? 1 : 0;
		return 0;
	case SG_GET_PACK_ID:
		if (!access_ok(VERIFY_WRITE, ip, sizeof (int)))
			return -EFAULT;
		read_lock_irqsave(&sfp->rq_list_lock, iflags);
		for (srp = sfp->headrp; srp; srp = srp->nextrp) {
			if ((1 == srp->done) && (!srp->sg_io_owned)) {
				read_unlock_irqrestore(&sfp->rq_list_lock,
						       iflags);
				__put_user(srp->header.pack_id, ip);
				return 0;
			}
		}
		read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
		__put_user(-1, ip);
		return 0;
	case SG_GET_NUM_WAITING:
		read_lock_irqsave(&sfp->rq_list_lock, iflags);
		for (val = 0, srp = sfp->headrp; srp; srp = srp->nextrp) {
			if ((1 == srp->done) && (!srp->sg_io_owned))
				++val;
		}
		read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
		return put_user(val, ip);
	case SG_GET_SG_TABLESIZE:
		return put_user(sdp->sg_tablesize, ip);
	case SG_SET_RESERVED_SIZE:
		result = get_user(val, ip);
		if (result)
			return result;
                if (val < 0)
                        return -EINVAL;
920
		val = min_t(int, val,
921
			    queue_max_sectors(sdp->device->request_queue) * 512);
L
Linus Torvalds 已提交
922 923 924 925 926 927 928 929
		if (val != sfp->reserve.bufflen) {
			if (sg_res_in_use(sfp) || sfp->mmap_called)
				return -EBUSY;
			sg_remove_scat(&sfp->reserve);
			sg_build_reserve(sfp, val);
		}
		return 0;
	case SG_GET_RESERVED_SIZE:
930
		val = min_t(int, sfp->reserve.bufflen,
931
			    queue_max_sectors(sdp->device->request_queue) * 512);
L
Linus Torvalds 已提交
932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
		return put_user(val, ip);
	case SG_SET_COMMAND_Q:
		result = get_user(val, ip);
		if (result)
			return result;
		sfp->cmd_q = val ? 1 : 0;
		return 0;
	case SG_GET_COMMAND_Q:
		return put_user((int) sfp->cmd_q, ip);
	case SG_SET_KEEP_ORPHAN:
		result = get_user(val, ip);
		if (result)
			return result;
		sfp->keep_orphan = val;
		return 0;
	case SG_GET_KEEP_ORPHAN:
		return put_user((int) sfp->keep_orphan, ip);
	case SG_NEXT_CMD_LEN:
		result = get_user(val, ip);
		if (result)
			return result;
		sfp->next_cmd_len = (val > 0) ? val : 0;
		return 0;
	case SG_GET_VERSION_NUM:
		return put_user(sg_version_num, ip);
	case SG_GET_ACCESS_COUNT:
		/* faked - we don't have a real access count anymore */
		val = (sdp->device ? 1 : 0);
		return put_user(val, ip);
	case SG_GET_REQUEST_TABLE:
		if (!access_ok(VERIFY_WRITE, p, SZ_SG_REQ_INFO * SG_MAX_QUEUE))
			return -EFAULT;
		else {
已提交
965 966 967 968 969 970 971
			sg_req_info_t *rinfo;
			unsigned int ms;

			rinfo = kmalloc(SZ_SG_REQ_INFO * SG_MAX_QUEUE,
								GFP_KERNEL);
			if (!rinfo)
				return -ENOMEM;
L
Linus Torvalds 已提交
972 973 974 975 976 977 978 979 980 981
			read_lock_irqsave(&sfp->rq_list_lock, iflags);
			for (srp = sfp->headrp, val = 0; val < SG_MAX_QUEUE;
			     ++val, srp = srp ? srp->nextrp : srp) {
				memset(&rinfo[val], 0, SZ_SG_REQ_INFO);
				if (srp) {
					rinfo[val].req_state = srp->done + 1;
					rinfo[val].problem =
					    srp->header.masked_status & 
					    srp->header.host_status & 
					    srp->header.driver_status;
已提交
982 983 984 985 986 987 988 989 990
					if (srp->done)
						rinfo[val].duration =
							srp->header.duration;
					else {
						ms = jiffies_to_msecs(jiffies);
						rinfo[val].duration =
						    (ms > srp->header.duration) ?
						    (ms - srp->header.duration) : 0;
					}
L
Linus Torvalds 已提交
991
					rinfo[val].orphan = srp->orphan;
已提交
992 993 994 995 996 997
					rinfo[val].sg_io_owned =
							srp->sg_io_owned;
					rinfo[val].pack_id =
							srp->header.pack_id;
					rinfo[val].usr_ptr =
							srp->header.usr_ptr;
L
Linus Torvalds 已提交
998 999 1000
				}
			}
			read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
已提交
1001 1002 1003 1004 1005
			result = __copy_to_user(p, rinfo, 
						SZ_SG_REQ_INFO * SG_MAX_QUEUE);
			result = result ? -EFAULT : 0;
			kfree(rinfo);
			return result;
L
Linus Torvalds 已提交
1006 1007 1008 1009 1010 1011 1012 1013 1014
		}
	case SG_EMULATED_HOST:
		if (sdp->detached)
			return -ENODEV;
		return put_user(sdp->device->host->hostt->emulated, ip);
	case SG_SCSI_RESET:
		if (sdp->detached)
			return -ENODEV;
		if (filp->f_flags & O_NONBLOCK) {
1015
			if (scsi_host_in_recovery(sdp->device->host))
L
Linus Torvalds 已提交
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
				return -EBUSY;
		} else if (!scsi_block_when_processing_errors(sdp->device))
			return -EBUSY;
		result = get_user(val, ip);
		if (result)
			return result;
		if (SG_SCSI_RESET_NOTHING == val)
			return 0;
		switch (val) {
		case SG_SCSI_RESET_DEVICE:
			val = SCSI_TRY_RESET_DEVICE;
			break;
B
Brian King 已提交
1028 1029 1030
		case SG_SCSI_RESET_TARGET:
			val = SCSI_TRY_RESET_TARGET;
			break;
L
Linus Torvalds 已提交
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
		case SG_SCSI_RESET_BUS:
			val = SCSI_TRY_RESET_BUS;
			break;
		case SG_SCSI_RESET_HOST:
			val = SCSI_TRY_RESET_HOST;
			break;
		default:
			return -EINVAL;
		}
		if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
			return -EACCES;
		return (scsi_reset_provider(sdp->device, val) ==
			SUCCESS) ? 0 : -EIO;
	case SCSI_IOCTL_SEND_COMMAND:
		if (sdp->detached)
			return -ENODEV;
		if (read_only) {
			unsigned char opcode = WRITE_6;
			Scsi_Ioctl_Command __user *siocp = p;

			if (copy_from_user(&opcode, siocp->data, 1))
				return -EFAULT;
1053
			if (sg_allow_access(filp, &opcode))
L
Linus Torvalds 已提交
1054 1055
				return -EPERM;
		}
1056
		return sg_scsi_ioctl(sdp->device->request_queue, NULL, filp->f_mode, p);
L
Linus Torvalds 已提交
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
	case SG_SET_DEBUG:
		result = get_user(val, ip);
		if (result)
			return result;
		sdp->sgdebug = (char) val;
		return 0;
	case SCSI_IOCTL_GET_IDLUN:
	case SCSI_IOCTL_GET_BUS_NUMBER:
	case SCSI_IOCTL_PROBE_HOST:
	case SG_GET_TRANSFORM:
		if (sdp->detached)
			return -ENODEV;
		return scsi_ioctl(sdp->device, cmd_in, p);
1070
	case BLKSECTGET:
1071
		return put_user(queue_max_sectors(sdp->device->request_queue) * 512,
1072
				ip);
1073 1074 1075
	case BLKTRACESETUP:
		return blk_trace_setup(sdp->device->request_queue,
				       sdp->disk->disk_name,
1076
				       MKDEV(SCSI_GENERIC_MAJOR, sdp->index),
1077
				       NULL,
1078 1079 1080 1081 1082 1083 1084
				       (char *)arg);
	case BLKTRACESTART:
		return blk_trace_startstop(sdp->device->request_queue, 1);
	case BLKTRACESTOP:
		return blk_trace_startstop(sdp->device->request_queue, 0);
	case BLKTRACETEARDOWN:
		return blk_trace_remove(sdp->device->request_queue);
L
Linus Torvalds 已提交
1085 1086 1087 1088 1089 1090 1091
	default:
		if (read_only)
			return -EPERM;	/* don't know so take safe approach */
		return scsi_ioctl(sdp->device, cmd_in, p);
	}
}

1092 1093 1094 1095 1096
static long
sg_unlocked_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
{
	int ret;

1097
	mutex_lock(&sg_mutex);
1098
	ret = sg_ioctl(filp, cmd_in, arg);
1099
	mutex_unlock(&sg_mutex);
1100 1101 1102 1103

	return ret;
}

L
Linus Torvalds 已提交
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
#ifdef CONFIG_COMPAT
static long sg_compat_ioctl(struct file *filp, unsigned int cmd_in, unsigned long arg)
{
	Sg_device *sdp;
	Sg_fd *sfp;
	struct scsi_device *sdev;

	if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
		return -ENXIO;

	sdev = sdp->device;
	if (sdev->host->hostt->compat_ioctl) { 
		int ret;

		ret = sdev->host->hostt->compat_ioctl(sdev, cmd_in, (void __user *)arg);

		return ret;
	}
	
	return -ENOIOCTLCMD;
}
#endif

static unsigned int
sg_poll(struct file *filp, poll_table * wait)
{
	unsigned int res = 0;
	Sg_device *sdp;
	Sg_fd *sfp;
	Sg_request *srp;
	int count = 0;
	unsigned long iflags;

	if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp))
	    || sfp->closed)
		return POLLERR;
	poll_wait(filp, &sfp->read_wait, wait);
	read_lock_irqsave(&sfp->rq_list_lock, iflags);
	for (srp = sfp->headrp; srp; srp = srp->nextrp) {
		/* if any read waiting, flag it */
		if ((0 == res) && (1 == srp->done) && (!srp->sg_io_owned))
			res = POLLIN | POLLRDNORM;
		++count;
	}
	read_unlock_irqrestore(&sfp->rq_list_lock, iflags);

	if (sdp->detached)
		res |= POLLHUP;
	else if (!sfp->cmd_q) {
		if (0 == count)
			res |= POLLOUT | POLLWRNORM;
	} else if (count < SG_MAX_QUEUE)
		res |= POLLOUT | POLLWRNORM;
	SCSI_LOG_TIMEOUT(3, printk("sg_poll: %s, res=0x%x\n",
				   sdp->disk->disk_name, (int) res));
	return res;
}

static int
sg_fasync(int fd, struct file *filp, int mode)
{
	Sg_device *sdp;
	Sg_fd *sfp;

	if ((!(sfp = (Sg_fd *) filp->private_data)) || (!(sdp = sfp->parentdp)))
		return -ENXIO;
	SCSI_LOG_TIMEOUT(3, printk("sg_fasync: %s, mode=%d\n",
				   sdp->disk->disk_name, mode));

1173
	return fasync_helper(fd, filp, mode, &sfp->async_qp);
L
Linus Torvalds 已提交
1174 1175
}

N
Nick Piggin 已提交
1176 1177
static int
sg_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
L
Linus Torvalds 已提交
1178 1179
{
	Sg_fd *sfp;
1180
	unsigned long offset, len, sa;
L
Linus Torvalds 已提交
1181
	Sg_scatter_hold *rsv_schp;
1182
	int k, length;
L
Linus Torvalds 已提交
1183 1184

	if ((NULL == vma) || (!(sfp = (Sg_fd *) vma->vm_private_data)))
N
Nick Piggin 已提交
1185
		return VM_FAULT_SIGBUS;
L
Linus Torvalds 已提交
1186
	rsv_schp = &sfp->reserve;
N
Nick Piggin 已提交
1187
	offset = vmf->pgoff << PAGE_SHIFT;
L
Linus Torvalds 已提交
1188
	if (offset >= rsv_schp->bufflen)
N
Nick Piggin 已提交
1189 1190
		return VM_FAULT_SIGBUS;
	SCSI_LOG_TIMEOUT(3, printk("sg_vma_fault: offset=%lu, scatg=%d\n",
L
Linus Torvalds 已提交
1191
				   offset, rsv_schp->k_use_sg));
1192
	sa = vma->vm_start;
1193 1194
	length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
	for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1195
		len = vma->vm_end - sa;
1196
		len = (len < length) ? len : length;
1197
		if (offset < len) {
1198 1199
			struct page *page = nth_page(rsv_schp->pages[k],
						     offset >> PAGE_SHIFT);
1200
			get_page(page);	/* increment page count */
N
Nick Piggin 已提交
1201 1202
			vmf->page = page;
			return 0; /* success */
L
Linus Torvalds 已提交
1203
		}
1204 1205
		sa += len;
		offset -= len;
L
Linus Torvalds 已提交
1206
	}
1207

N
Nick Piggin 已提交
1208
	return VM_FAULT_SIGBUS;
L
Linus Torvalds 已提交
1209 1210
}

1211
static const struct vm_operations_struct sg_mmap_vm_ops = {
N
Nick Piggin 已提交
1212
	.fault = sg_vma_fault,
L
Linus Torvalds 已提交
1213 1214 1215 1216 1217 1218
};

static int
sg_mmap(struct file *filp, struct vm_area_struct *vma)
{
	Sg_fd *sfp;
1219
	unsigned long req_sz, len, sa;
L
Linus Torvalds 已提交
1220
	Sg_scatter_hold *rsv_schp;
1221
	int k, length;
L
Linus Torvalds 已提交
1222 1223 1224

	if ((!filp) || (!vma) || (!(sfp = (Sg_fd *) filp->private_data)))
		return -ENXIO;
已提交
1225
	req_sz = vma->vm_end - vma->vm_start;
L
Linus Torvalds 已提交
1226 1227 1228 1229 1230 1231 1232 1233
	SCSI_LOG_TIMEOUT(3, printk("sg_mmap starting, vm_start=%p, len=%d\n",
				   (void *) vma->vm_start, (int) req_sz));
	if (vma->vm_pgoff)
		return -EINVAL;	/* want no offset */
	rsv_schp = &sfp->reserve;
	if (req_sz > rsv_schp->bufflen)
		return -ENOMEM;	/* cannot map more than reserved buffer */

1234
	sa = vma->vm_start;
1235 1236
	length = 1 << (PAGE_SHIFT + rsv_schp->page_order);
	for (k = 0; k < rsv_schp->k_use_sg && sa < vma->vm_end; k++) {
1237
		len = vma->vm_end - sa;
1238
		len = (len < length) ? len : length;
1239
		sa += len;
L
Linus Torvalds 已提交
1240
	}
1241

N
Nick Piggin 已提交
1242
	sfp->mmap_called = 1;
1243
	vma->vm_flags |= VM_RESERVED;
L
Linus Torvalds 已提交
1244 1245 1246 1247 1248
	vma->vm_private_data = sfp;
	vma->vm_ops = &sg_mmap_vm_ops;
	return 0;
}

1249 1250 1251 1252 1253 1254 1255 1256 1257
static void sg_rq_end_io_usercontext(struct work_struct *work)
{
	struct sg_request *srp = container_of(work, struct sg_request, ew.work);
	struct sg_fd *sfp = srp->parentfp;

	sg_finish_rem_req(srp);
	kref_put(&sfp->f_ref, sg_remove_sfp);
}

1258 1259 1260 1261 1262
/*
 * This function is a "bottom half" handler that is called by the mid
 * level when a command is completed (or has failed).
 */
static void sg_rq_end_io(struct request *rq, int uptodate)
L
Linus Torvalds 已提交
1263
{
1264
	struct sg_request *srp = rq->end_io_data;
1265
	Sg_device *sdp;
L
Linus Torvalds 已提交
1266 1267
	Sg_fd *sfp;
	unsigned long iflags;
已提交
1268
	unsigned int ms;
1269
	char *sense;
1270
	int result, resid, done = 1;
L
Linus Torvalds 已提交
1271

1272
	if (WARN_ON(srp->done != 0))
L
Linus Torvalds 已提交
1273
		return;
1274

L
Linus Torvalds 已提交
1275
	sfp = srp->parentfp;
1276
	if (WARN_ON(sfp == NULL))
L
Linus Torvalds 已提交
1277
		return;
1278 1279 1280 1281

	sdp = sfp->parentdp;
	if (unlikely(sdp->detached))
		printk(KERN_INFO "sg_rq_end_io: device detached\n");
L
Linus Torvalds 已提交
1282

1283 1284
	sense = rq->sense;
	result = rq->errors;
T
Tejun Heo 已提交
1285
	resid = rq->resid_len;
L
Linus Torvalds 已提交
1286 1287

	SCSI_LOG_TIMEOUT(4, printk("sg_cmd_done: %s, pack_id=%d, res=0x%x\n",
1288 1289
		sdp->disk->disk_name, srp->header.pack_id, result));
	srp->header.resid = resid;
已提交
1290 1291 1292
	ms = jiffies_to_msecs(jiffies);
	srp->header.duration = (ms > srp->header.duration) ?
				(ms - srp->header.duration) : 0;
1293
	if (0 != result) {
L
Linus Torvalds 已提交
1294 1295
		struct scsi_sense_hdr sshdr;

1296 1297 1298 1299 1300
		srp->header.status = 0xff & result;
		srp->header.masked_status = status_byte(result);
		srp->header.msg_status = msg_byte(result);
		srp->header.host_status = host_byte(result);
		srp->header.driver_status = driver_byte(result);
L
Linus Torvalds 已提交
1301 1302 1303
		if ((sdp->sgdebug > 0) &&
		    ((CHECK_CONDITION == srp->header.masked_status) ||
		     (COMMAND_TERMINATED == srp->header.masked_status)))
1304 1305
			__scsi_print_sense("sg_cmd_done", sense,
					   SCSI_SENSE_BUFFERSIZE);
L
Linus Torvalds 已提交
1306 1307

		/* Following if statement is a patch supplied by Eric Youngdale */
1308 1309
		if (driver_byte(result) != 0
		    && scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, &sshdr)
L
Linus Torvalds 已提交
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319
		    && !scsi_sense_is_deferred(&sshdr)
		    && sshdr.sense_key == UNIT_ATTENTION
		    && sdp->device->removable) {
			/* Detected possible disc change. Set the bit - this */
			/* may be used if there are filesystems using this device */
			sdp->device->changed = 1;
		}
	}
	/* Rely on write phase to clean out srp status values, so no "else" */

1320 1321
	write_lock_irqsave(&sfp->rq_list_lock, iflags);
	if (unlikely(srp->orphan)) {
L
Linus Torvalds 已提交
1322 1323
		if (sfp->keep_orphan)
			srp->sg_io_owned = 0;
1324 1325
		else
			done = 0;
L
Linus Torvalds 已提交
1326
	}
1327 1328 1329 1330 1331 1332 1333
	srp->done = done;
	write_unlock_irqrestore(&sfp->rq_list_lock, iflags);

	if (likely(done)) {
		/* Now wake up any sg_read() that is waiting for this
		 * packet.
		 */
L
Linus Torvalds 已提交
1334
		wake_up_interruptible(&sfp->read_wait);
1335
		kill_fasync(&sfp->async_qp, SIGPOLL, POLL_IN);
1336
		kref_put(&sfp->f_ref, sg_remove_sfp);
1337 1338 1339 1340
	} else {
		INIT_WORK(&srp->ew.work, sg_rq_end_io_usercontext);
		schedule_work(&srp->ew.work);
	}
L
Linus Torvalds 已提交
1341 1342
}

1343
static const struct file_operations sg_fops = {
L
Linus Torvalds 已提交
1344 1345 1346 1347
	.owner = THIS_MODULE,
	.read = sg_read,
	.write = sg_write,
	.poll = sg_poll,
1348
	.unlocked_ioctl = sg_unlocked_ioctl,
L
Linus Torvalds 已提交
1349 1350 1351 1352 1353 1354 1355 1356 1357
#ifdef CONFIG_COMPAT
	.compat_ioctl = sg_compat_ioctl,
#endif
	.open = sg_open,
	.mmap = sg_mmap,
	.release = sg_release,
	.fasync = sg_fasync,
};

1358
static struct class *sg_sysfs_class;
L
Linus Torvalds 已提交
1359 1360 1361

static int sg_sysfs_valid = 0;

1362
static Sg_device *sg_alloc(struct gendisk *disk, struct scsi_device *scsidp)
L
Linus Torvalds 已提交
1363
{
1364
	struct request_queue *q = scsidp->request_queue;
L
Linus Torvalds 已提交
1365 1366
	Sg_device *sdp;
	unsigned long iflags;
1367 1368
	int error;
	u32 k;
L
Linus Torvalds 已提交
1369

J
Jes Sorensen 已提交
1370
	sdp = kzalloc(sizeof(Sg_device), GFP_KERNEL);
L
Linus Torvalds 已提交
1371 1372
	if (!sdp) {
		printk(KERN_WARNING "kmalloc Sg_device failure\n");
1373 1374
		return ERR_PTR(-ENOMEM);
	}
1375

1376 1377
	if (!idr_pre_get(&sg_index_idr, GFP_KERNEL)) {
		printk(KERN_WARNING "idr expansion Sg_device failure\n");
1378
		error = -ENOMEM;
1379
		goto out;
L
Linus Torvalds 已提交
1380 1381
	}

1382
	write_lock_irqsave(&sg_index_lock, iflags);
L
Linus Torvalds 已提交
1383

1384
	error = idr_get_new(&sg_index_idr, sdp, &k);
1385
	if (error) {
1386
		write_unlock_irqrestore(&sg_index_lock, iflags);
1387 1388 1389
		printk(KERN_WARNING "idr allocation Sg_device failure: %d\n",
		       error);
		goto out;
L
Linus Torvalds 已提交
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399
	}

	if (unlikely(k >= SG_MAX_DEVS))
		goto overflow;

	SCSI_LOG_TIMEOUT(3, printk("sg_alloc: dev=%d \n", k));
	sprintf(disk->disk_name, "sg%d", k);
	disk->first_minor = k;
	sdp->disk = disk;
	sdp->device = scsidp;
1400
	INIT_LIST_HEAD(&sdp->sfds);
L
Linus Torvalds 已提交
1401
	init_waitqueue_head(&sdp->o_excl_wait);
1402
	sdp->sg_tablesize = queue_max_segments(q);
1403
	sdp->index = k;
1404 1405 1406
	kref_init(&sdp->d_ref);

	write_unlock_irqrestore(&sg_index_lock, iflags);
L
Linus Torvalds 已提交
1407

1408
	error = 0;
L
Linus Torvalds 已提交
1409
 out:
1410
	if (error) {
L
Linus Torvalds 已提交
1411
		kfree(sdp);
1412 1413 1414
		return ERR_PTR(error);
	}
	return sdp;
L
Linus Torvalds 已提交
1415 1416

 overflow:
1417 1418
	idr_remove(&sg_index_idr, k);
	write_unlock_irqrestore(&sg_index_lock, iflags);
1419 1420 1421
	sdev_printk(KERN_WARNING, scsidp,
		    "Unable to attach sg device type=%d, minor "
		    "number exceeds %d\n", scsidp->type, SG_MAX_DEVS - 1);
L
Linus Torvalds 已提交
1422 1423 1424 1425 1426
	error = -ENODEV;
	goto out;
}

static int
1427
sg_add(struct device *cl_dev, struct class_interface *cl_intf)
L
Linus Torvalds 已提交
1428
{
1429
	struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
L
Linus Torvalds 已提交
1430 1431 1432
	struct gendisk *disk;
	Sg_device *sdp = NULL;
	struct cdev * cdev = NULL;
1433
	int error;
1434
	unsigned long iflags;
L
Linus Torvalds 已提交
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451

	disk = alloc_disk(1);
	if (!disk) {
		printk(KERN_WARNING "alloc_disk failed\n");
		return -ENOMEM;
	}
	disk->major = SCSI_GENERIC_MAJOR;

	error = -ENOMEM;
	cdev = cdev_alloc();
	if (!cdev) {
		printk(KERN_WARNING "cdev_alloc failed\n");
		goto out;
	}
	cdev->owner = THIS_MODULE;
	cdev->ops = &sg_fops;

1452 1453
	sdp = sg_alloc(disk, scsidp);
	if (IS_ERR(sdp)) {
L
Linus Torvalds 已提交
1454
		printk(KERN_WARNING "sg_alloc failed\n");
1455
		error = PTR_ERR(sdp);
L
Linus Torvalds 已提交
1456 1457 1458
		goto out;
	}

1459
	error = cdev_add(cdev, MKDEV(SCSI_GENERIC_MAJOR, sdp->index), 1);
1460
	if (error)
1461
		goto cdev_add_err;
1462

L
Linus Torvalds 已提交
1463 1464
	sdp->cdev = cdev;
	if (sg_sysfs_valid) {
1465
		struct device *sg_class_member;
L
Linus Torvalds 已提交
1466

1467 1468 1469 1470
		sg_class_member = device_create(sg_sysfs_class, cl_dev->parent,
						MKDEV(SCSI_GENERIC_MAJOR,
						      sdp->index),
						sdp, "%s", disk->disk_name);
1471 1472
		if (IS_ERR(sg_class_member)) {
			printk(KERN_ERR "sg_add: "
1473
			       "device_create failed\n");
1474 1475 1476 1477
			error = PTR_ERR(sg_class_member);
			goto cdev_add_err;
		}
		error = sysfs_create_link(&scsidp->sdev_gendev.kobj,
L
Linus Torvalds 已提交
1478 1479 1480
					  &sg_class_member->kobj, "generic");
		if (error)
			printk(KERN_ERR "sg_add: unable to make symlink "
1481
					"'generic' back to sg%d\n", sdp->index);
L
Linus Torvalds 已提交
1482
	} else
1483
		printk(KERN_WARNING "sg_add: sg_sys Invalid\n");
L
Linus Torvalds 已提交
1484

1485
	sdev_printk(KERN_NOTICE, scsidp,
1486 1487
		    "Attached scsi generic sg%d type %d\n", sdp->index,
		    scsidp->type);
L
Linus Torvalds 已提交
1488

1489
	dev_set_drvdata(cl_dev, sdp);
1490

L
Linus Torvalds 已提交
1491 1492
	return 0;

1493
cdev_add_err:
1494 1495 1496 1497
	write_lock_irqsave(&sg_index_lock, iflags);
	idr_remove(&sg_index_idr, sdp->index);
	write_unlock_irqrestore(&sg_index_lock, iflags);
	kfree(sdp);
1498

L
Linus Torvalds 已提交
1499 1500 1501 1502 1503 1504 1505
out:
	put_disk(disk);
	if (cdev)
		cdev_del(cdev);
	return error;
}

1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528
static void sg_device_destroy(struct kref *kref)
{
	struct sg_device *sdp = container_of(kref, struct sg_device, d_ref);
	unsigned long flags;

	/* CAUTION!  Note that the device can still be found via idr_find()
	 * even though the refcount is 0.  Therefore, do idr_remove() BEFORE
	 * any other cleanup.
	 */

	write_lock_irqsave(&sg_index_lock, flags);
	idr_remove(&sg_index_idr, sdp->index);
	write_unlock_irqrestore(&sg_index_lock, flags);

	SCSI_LOG_TIMEOUT(3,
		printk("sg_device_destroy: %s\n",
			sdp->disk->disk_name));

	put_disk(sdp->disk);
	kfree(sdp);
}

static void sg_remove(struct device *cl_dev, struct class_interface *cl_intf)
L
Linus Torvalds 已提交
1529
{
1530 1531
	struct scsi_device *scsidp = to_scsi_device(cl_dev->parent);
	Sg_device *sdp = dev_get_drvdata(cl_dev);
L
Linus Torvalds 已提交
1532 1533 1534
	unsigned long iflags;
	Sg_fd *sfp;

1535
	if (!sdp || sdp->detached)
L
Linus Torvalds 已提交
1536
		return;
1537

1538 1539 1540
	SCSI_LOG_TIMEOUT(3, printk("sg_remove: %s\n", sdp->disk->disk_name));

	/* Need a write lock to set sdp->detached. */
1541
	write_lock_irqsave(&sg_index_lock, iflags);
1542
	sdp->detached = 1;
1543
	list_for_each_entry(sfp, &sdp->sfds, sfd_siblings) {
1544 1545
		wake_up_interruptible(&sfp->read_wait);
		kill_fasync(&sfp->async_qp, SIGPOLL, POLL_HUP);
1546 1547 1548 1549
	}
	write_unlock_irqrestore(&sg_index_lock, iflags);

	sysfs_remove_link(&scsidp->sdev_gendev.kobj, "generic");
1550
	device_destroy(sg_sysfs_class, MKDEV(SCSI_GENERIC_MAJOR, sdp->index));
1551 1552
	cdev_del(sdp->cdev);
	sdp->cdev = NULL;
L
Linus Torvalds 已提交
1553

1554
	sg_put_dev(sdp);
L
Linus Torvalds 已提交
1555 1556
}

1557 1558 1559
module_param_named(scatter_elem_sz, scatter_elem_sz, int, S_IRUGO | S_IWUSR);
module_param_named(def_reserved_size, def_reserved_size, int,
		   S_IRUGO | S_IWUSR);
L
Linus Torvalds 已提交
1560 1561 1562 1563 1564 1565
module_param_named(allow_dio, sg_allow_dio, int, S_IRUGO | S_IWUSR);

MODULE_AUTHOR("Douglas Gilbert");
MODULE_DESCRIPTION("SCSI generic (sg) driver");
MODULE_LICENSE("GPL");
MODULE_VERSION(SG_VERSION_STR);
1566
MODULE_ALIAS_CHARDEV_MAJOR(SCSI_GENERIC_MAJOR);
L
Linus Torvalds 已提交
1567

1568 1569
MODULE_PARM_DESC(scatter_elem_sz, "scatter gather element "
                "size (default: max(SG_SCATTER_SZ, PAGE_SIZE))");
L
Linus Torvalds 已提交
1570 1571 1572 1573 1574 1575 1576 1577
MODULE_PARM_DESC(def_reserved_size, "size of buffer reserved for each fd");
MODULE_PARM_DESC(allow_dio, "allow direct I/O (default: 0 (disallow))");

static int __init
init_sg(void)
{
	int rc;

1578 1579 1580 1581
	if (scatter_elem_sz < PAGE_SIZE) {
		scatter_elem_sz = PAGE_SIZE;
		scatter_elem_sz_prev = scatter_elem_sz;
	}
L
Linus Torvalds 已提交
1582 1583
	if (def_reserved_size >= 0)
		sg_big_buff = def_reserved_size;
1584 1585
	else
		def_reserved_size = sg_big_buff;
L
Linus Torvalds 已提交
1586 1587 1588 1589 1590

	rc = register_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), 
				    SG_MAX_DEVS, "sg");
	if (rc)
		return rc;
1591
        sg_sysfs_class = class_create(THIS_MODULE, "scsi_generic");
L
Linus Torvalds 已提交
1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
        if ( IS_ERR(sg_sysfs_class) ) {
		rc = PTR_ERR(sg_sysfs_class);
		goto err_out;
        }
	sg_sysfs_valid = 1;
	rc = scsi_register_interface(&sg_interface);
	if (0 == rc) {
#ifdef CONFIG_SCSI_PROC_FS
		sg_proc_init();
#endif				/* CONFIG_SCSI_PROC_FS */
		return 0;
	}
1604
	class_destroy(sg_sysfs_class);
L
Linus Torvalds 已提交
1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616
err_out:
	unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0), SG_MAX_DEVS);
	return rc;
}

static void __exit
exit_sg(void)
{
#ifdef CONFIG_SCSI_PROC_FS
	sg_proc_cleanup();
#endif				/* CONFIG_SCSI_PROC_FS */
	scsi_unregister_interface(&sg_interface);
1617
	class_destroy(sg_sysfs_class);
L
Linus Torvalds 已提交
1618 1619 1620
	sg_sysfs_valid = 0;
	unregister_chrdev_region(MKDEV(SCSI_GENERIC_MAJOR, 0),
				 SG_MAX_DEVS);
1621
	idr_destroy(&sg_index_idr);
L
Linus Torvalds 已提交
1622 1623
}

F
FUJITA Tomonori 已提交
1624
static int sg_start_req(Sg_request *srp, unsigned char *cmd)
1625
{
1626
	int res;
1627
	struct request *rq;
F
FUJITA Tomonori 已提交
1628 1629 1630 1631
	Sg_fd *sfp = srp->parentfp;
	sg_io_hdr_t *hp = &srp->header;
	int dxfer_len = (int) hp->dxfer_len;
	int dxfer_dir = hp->dxfer_direction;
1632
	unsigned int iov_count = hp->iovec_count;
F
FUJITA Tomonori 已提交
1633 1634 1635
	Sg_scatter_hold *req_schp = &srp->data;
	Sg_scatter_hold *rsv_schp = &sfp->reserve;
	struct request_queue *q = sfp->parentdp->device->request_queue;
1636
	struct rq_map_data *md, map_data;
1637 1638
	int rw = hp->dxfer_direction == SG_DXFER_TO_DEV ? WRITE : READ;

F
FUJITA Tomonori 已提交
1639 1640 1641
	SCSI_LOG_TIMEOUT(4, printk(KERN_INFO "sg_start_req: dxfer_len=%d\n",
				   dxfer_len));

1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655
	rq = blk_get_request(q, rw, GFP_ATOMIC);
	if (!rq)
		return -ENOMEM;

	memcpy(rq->cmd, cmd, hp->cmd_len);

	rq->cmd_len = hp->cmd_len;
	rq->cmd_type = REQ_TYPE_BLOCK_PC;

	srp->rq = rq;
	rq->end_io_data = srp;
	rq->sense = srp->sense_b;
	rq->retries = SG_DEFAULT_RETRIES;

L
Linus Torvalds 已提交
1656
	if ((dxfer_len <= 0) || (dxfer_dir == SG_DXFER_NONE))
1657
		return 0;
1658

1659 1660 1661
	if (sg_allow_dio && hp->flags & SG_FLAG_DIRECT_IO &&
	    dxfer_dir != SG_DXFER_UNKNOWN && !iov_count &&
	    !sfp->parentdp->device->host->unchecked_isa_dma &&
1662
	    blk_rq_aligned(q, hp->dxferp, dxfer_len))
1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674
		md = NULL;
	else
		md = &map_data;

	if (md) {
		if (!sg_res_in_use(sfp) && dxfer_len <= rsv_schp->bufflen)
			sg_link_reserve(sfp, srp, dxfer_len);
		else {
			res = sg_build_indirect(req_schp, sfp, dxfer_len);
			if (res)
				return res;
		}
1675

1676 1677 1678
		md->pages = req_schp->pages;
		md->page_order = req_schp->page_order;
		md->nr_entries = req_schp->k_use_sg;
1679
		md->offset = 0;
1680
		md->null_mapped = hp->dxferp ? 0 : 1;
1681 1682 1683 1684
		if (dxfer_dir == SG_DXFER_TO_FROM_DEV)
			md->from_user = 1;
		else
			md->from_user = 0;
1685 1686
	}

1687 1688 1689 1690
	if (iov_count) {
		int len, size = sizeof(struct sg_iovec) * iov_count;
		struct iovec *iov;

J
Julia Lawall 已提交
1691 1692 1693
		iov = memdup_user(hp->dxferp, size);
		if (IS_ERR(iov))
			return PTR_ERR(iov);
1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705

		len = iov_length(iov, iov_count);
		if (hp->dxfer_len < len) {
			iov_count = iov_shorten(iov, iov_count, hp->dxfer_len);
			len = hp->dxfer_len;
		}

		res = blk_rq_map_user_iov(q, rq, md, (struct sg_iovec *)iov,
					  iov_count,
					  len, GFP_ATOMIC);
		kfree(iov);
	} else
1706 1707
		res = blk_rq_map_user(q, rq, md, hp->dxferp,
				      hp->dxfer_len, GFP_ATOMIC);
1708 1709

	if (!res) {
1710
		srp->bio = rq->bio;
1711

1712 1713 1714 1715 1716
		if (!md) {
			req_schp->dio_in_use = 1;
			hp->info |= SG_INFO_DIRECT_IO;
		}
	}
1717
	return res;
L
Linus Torvalds 已提交
1718 1719
}

1720
static int sg_finish_rem_req(Sg_request * srp)
L
Linus Torvalds 已提交
1721
{
1722 1723
	int ret = 0;

L
Linus Torvalds 已提交
1724 1725 1726 1727
	Sg_fd *sfp = srp->parentfp;
	Sg_scatter_hold *req_schp = &srp->data;

	SCSI_LOG_TIMEOUT(4, printk("sg_finish_rem_req: res_used=%d\n", (int) srp->res_used));
1728 1729
	if (srp->rq) {
		if (srp->bio)
1730
			ret = blk_rq_unmap_user(srp->bio);
1731

1732
		blk_put_request(srp->rq);
1733
	}
1734

1735 1736 1737 1738 1739
	if (srp->res_used)
		sg_unlink_reserve(sfp, srp);
	else
		sg_remove_scat(req_schp);

L
Linus Torvalds 已提交
1740
	sg_remove_request(sfp, srp);
1741 1742

	return ret;
L
Linus Torvalds 已提交
1743 1744 1745 1746 1747
}

static int
sg_build_sgat(Sg_scatter_hold * schp, const Sg_fd * sfp, int tablesize)
{
1748
	int sg_bufflen = tablesize * sizeof(struct page *);
A
Al Viro 已提交
1749
	gfp_t gfp_flags = GFP_ATOMIC | __GFP_NOWARN;
L
Linus Torvalds 已提交
1750

1751 1752
	schp->pages = kzalloc(sg_bufflen, gfp_flags);
	if (!schp->pages)
L
Linus Torvalds 已提交
1753 1754
		return -ENOMEM;
	schp->sglist_len = sg_bufflen;
1755
	return tablesize;	/* number of scat_gath elements allocated */
L
Linus Torvalds 已提交
1756 1757 1758 1759 1760
}

static int
sg_build_indirect(Sg_scatter_hold * schp, Sg_fd * sfp, int buff_size)
{
1761
	int ret_sz = 0, i, k, rem_sz, num, mx_sc_elems;
1762
	int sg_tablesize = sfp->parentdp->sg_tablesize;
1763 1764
	int blk_size = buff_size, order;
	gfp_t gfp_mask = GFP_ATOMIC | __GFP_COMP | __GFP_NOWARN;
L
Linus Torvalds 已提交
1765

1766
	if (blk_size < 0)
L
Linus Torvalds 已提交
1767 1768 1769
		return -EFAULT;
	if (0 == blk_size)
		++blk_size;	/* don't know why */
F
FUJITA Tomonori 已提交
1770 1771
	/* round request up to next highest SG_SECTOR_SZ byte boundary */
	blk_size = ALIGN(blk_size, SG_SECTOR_SZ);
L
Linus Torvalds 已提交
1772 1773
	SCSI_LOG_TIMEOUT(4, printk("sg_build_indirect: buff_size=%d, blk_size=%d\n",
				   buff_size, blk_size));
1774 1775 1776 1777 1778 1779

	/* N.B. ret_sz carried into this block ... */
	mx_sc_elems = sg_build_sgat(schp, sfp, sg_tablesize);
	if (mx_sc_elems < 0)
		return mx_sc_elems;	/* most likely -ENOMEM */

1780 1781 1782 1783 1784 1785 1786 1787
	num = scatter_elem_sz;
	if (unlikely(num != scatter_elem_sz_prev)) {
		if (num < PAGE_SIZE) {
			scatter_elem_sz = PAGE_SIZE;
			scatter_elem_sz_prev = PAGE_SIZE;
		} else
			scatter_elem_sz_prev = num;
	}
1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801

	if (sfp->low_dma)
		gfp_mask |= GFP_DMA;

	if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
		gfp_mask |= __GFP_ZERO;

	order = get_order(num);
retry:
	ret_sz = 1 << (PAGE_SHIFT + order);

	for (k = 0, rem_sz = blk_size; rem_sz > 0 && k < mx_sc_elems;
	     k++, rem_sz -= ret_sz) {

1802
		num = (rem_sz > scatter_elem_sz_prev) ?
1803 1804 1805 1806 1807
			scatter_elem_sz_prev : rem_sz;

		schp->pages[k] = alloc_pages(gfp_mask, order);
		if (!schp->pages[k])
			goto out;
1808

1809 1810 1811 1812 1813 1814
		if (num == scatter_elem_sz_prev) {
			if (unlikely(ret_sz > scatter_elem_sz_prev)) {
				scatter_elem_sz = ret_sz;
				scatter_elem_sz_prev = ret_sz;
			}
		}
1815

1816 1817
		SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k=%d, num=%d, "
				 "ret_sz=%d\n", k, num, ret_sz));
1818 1819
	}		/* end of for loop */

1820
	schp->page_order = order;
1821
	schp->k_use_sg = k;
1822 1823
	SCSI_LOG_TIMEOUT(5, printk("sg_build_indirect: k_use_sg=%d, "
			 "rem_sz=%d\n", k, rem_sz));
1824 1825 1826 1827

	schp->bufflen = blk_size;
	if (rem_sz > 0)	/* must have failed */
		return -ENOMEM;
L
Linus Torvalds 已提交
1828
	return 0;
1829 1830
out:
	for (i = 0; i < k; i++)
1831
		__free_pages(schp->pages[i], order);
1832 1833 1834 1835 1836

	if (--order >= 0)
		goto retry;

	return -ENOMEM;
L
Linus Torvalds 已提交
1837 1838 1839 1840 1841 1842
}

static void
sg_remove_scat(Sg_scatter_hold * schp)
{
	SCSI_LOG_TIMEOUT(4, printk("sg_remove_scat: k_use_sg=%d\n", schp->k_use_sg));
1843
	if (schp->pages && schp->sglist_len > 0) {
1844
		if (!schp->dio_in_use) {
L
Linus Torvalds 已提交
1845 1846
			int k;

1847
			for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
L
Linus Torvalds 已提交
1848
				SCSI_LOG_TIMEOUT(5, printk(
1849 1850 1851
				    "sg_remove_scat: k=%d, pg=0x%p\n",
				    k, schp->pages[k]));
				__free_pages(schp->pages[k], schp->page_order);
L
Linus Torvalds 已提交
1852
			}
1853

1854
			kfree(schp->pages);
L
Linus Torvalds 已提交
1855
		}
1856
	}
L
Linus Torvalds 已提交
1857 1858 1859 1860 1861 1862 1863
	memset(schp, 0, sizeof (*schp));
}

static int
sg_read_oxfer(Sg_request * srp, char __user *outp, int num_read_xfer)
{
	Sg_scatter_hold *schp = &srp->data;
1864
	int k, num;
L
Linus Torvalds 已提交
1865 1866 1867 1868 1869

	SCSI_LOG_TIMEOUT(4, printk("sg_read_oxfer: num_read_xfer=%d\n",
				   num_read_xfer));
	if ((!outp) || (num_read_xfer <= 0))
		return 0;
1870

1871 1872
	num = 1 << (PAGE_SHIFT + schp->page_order);
	for (k = 0; k < schp->k_use_sg && schp->pages[k]; k++) {
1873
		if (num > num_read_xfer) {
1874
			if (__copy_to_user(outp, page_address(schp->pages[k]),
1875 1876 1877 1878
					   num_read_xfer))
				return -EFAULT;
			break;
		} else {
1879
			if (__copy_to_user(outp, page_address(schp->pages[k]),
1880 1881 1882 1883
					   num))
				return -EFAULT;
			num_read_xfer -= num;
			if (num_read_xfer <= 0)
L
Linus Torvalds 已提交
1884
				break;
1885
			outp += num;
L
Linus Torvalds 已提交
1886 1887
		}
	}
1888

L
Linus Torvalds 已提交
1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913
	return 0;
}

static void
sg_build_reserve(Sg_fd * sfp, int req_size)
{
	Sg_scatter_hold *schp = &sfp->reserve;

	SCSI_LOG_TIMEOUT(4, printk("sg_build_reserve: req_size=%d\n", req_size));
	do {
		if (req_size < PAGE_SIZE)
			req_size = PAGE_SIZE;
		if (0 == sg_build_indirect(schp, sfp, req_size))
			return;
		else
			sg_remove_scat(schp);
		req_size >>= 1;	/* divide by 2 */
	} while (req_size > (PAGE_SIZE / 2));
}

static void
sg_link_reserve(Sg_fd * sfp, Sg_request * srp, int size)
{
	Sg_scatter_hold *req_schp = &srp->data;
	Sg_scatter_hold *rsv_schp = &sfp->reserve;
1914
	int k, num, rem;
L
Linus Torvalds 已提交
1915 1916 1917

	srp->res_used = 1;
	SCSI_LOG_TIMEOUT(4, printk("sg_link_reserve: size=%d\n", size));
B
Brian King 已提交
1918
	rem = size;
1919

1920 1921
	num = 1 << (PAGE_SHIFT + rsv_schp->page_order);
	for (k = 0; k < rsv_schp->k_use_sg; k++) {
1922 1923 1924
		if (rem <= num) {
			req_schp->k_use_sg = k + 1;
			req_schp->sglist_len = rsv_schp->sglist_len;
1925
			req_schp->pages = rsv_schp->pages;
1926 1927

			req_schp->bufflen = size;
1928
			req_schp->page_order = rsv_schp->page_order;
1929 1930 1931
			break;
		} else
			rem -= num;
L
Linus Torvalds 已提交
1932
	}
1933 1934 1935

	if (k >= rsv_schp->k_use_sg)
		SCSI_LOG_TIMEOUT(1, printk("sg_link_reserve: BAD size\n"));
L
Linus Torvalds 已提交
1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946
}

static void
sg_unlink_reserve(Sg_fd * sfp, Sg_request * srp)
{
	Sg_scatter_hold *req_schp = &srp->data;

	SCSI_LOG_TIMEOUT(4, printk("sg_unlink_reserve: req->k_use_sg=%d\n",
				   (int) req_schp->k_use_sg));
	req_schp->k_use_sg = 0;
	req_schp->bufflen = 0;
1947 1948
	req_schp->pages = NULL;
	req_schp->page_order = 0;
L
Linus Torvalds 已提交
1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009
	req_schp->sglist_len = 0;
	sfp->save_scat_len = 0;
	srp->res_used = 0;
}

static Sg_request *
sg_get_rq_mark(Sg_fd * sfp, int pack_id)
{
	Sg_request *resp;
	unsigned long iflags;

	write_lock_irqsave(&sfp->rq_list_lock, iflags);
	for (resp = sfp->headrp; resp; resp = resp->nextrp) {
		/* look for requests that are ready + not SG_IO owned */
		if ((1 == resp->done) && (!resp->sg_io_owned) &&
		    ((-1 == pack_id) || (resp->header.pack_id == pack_id))) {
			resp->done = 2;	/* guard against other readers */
			break;
		}
	}
	write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
	return resp;
}

/* always adds to end of list */
static Sg_request *
sg_add_request(Sg_fd * sfp)
{
	int k;
	unsigned long iflags;
	Sg_request *resp;
	Sg_request *rp = sfp->req_arr;

	write_lock_irqsave(&sfp->rq_list_lock, iflags);
	resp = sfp->headrp;
	if (!resp) {
		memset(rp, 0, sizeof (Sg_request));
		rp->parentfp = sfp;
		resp = rp;
		sfp->headrp = resp;
	} else {
		if (0 == sfp->cmd_q)
			resp = NULL;	/* command queuing disallowed */
		else {
			for (k = 0; k < SG_MAX_QUEUE; ++k, ++rp) {
				if (!rp->parentfp)
					break;
			}
			if (k < SG_MAX_QUEUE) {
				memset(rp, 0, sizeof (Sg_request));
				rp->parentfp = sfp;
				while (resp->nextrp)
					resp = resp->nextrp;
				resp->nextrp = rp;
				resp = rp;
			} else
				resp = NULL;
		}
	}
	if (resp) {
		resp->nextrp = NULL;
已提交
2010
		resp->header.duration = jiffies_to_msecs(jiffies);
L
Linus Torvalds 已提交
2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052
	}
	write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
	return resp;
}

/* Return of 1 for found; 0 for not found */
static int
sg_remove_request(Sg_fd * sfp, Sg_request * srp)
{
	Sg_request *prev_rp;
	Sg_request *rp;
	unsigned long iflags;
	int res = 0;

	if ((!sfp) || (!srp) || (!sfp->headrp))
		return res;
	write_lock_irqsave(&sfp->rq_list_lock, iflags);
	prev_rp = sfp->headrp;
	if (srp == prev_rp) {
		sfp->headrp = prev_rp->nextrp;
		prev_rp->parentfp = NULL;
		res = 1;
	} else {
		while ((rp = prev_rp->nextrp)) {
			if (srp == rp) {
				prev_rp->nextrp = rp->nextrp;
				rp->parentfp = NULL;
				res = 1;
				break;
			}
			prev_rp = rp;
		}
	}
	write_unlock_irqrestore(&sfp->rq_list_lock, iflags);
	return res;
}

static Sg_fd *
sg_add_sfp(Sg_device * sdp, int dev)
{
	Sg_fd *sfp;
	unsigned long iflags;
2053
	int bufflen;
L
Linus Torvalds 已提交
2054

2055
	sfp = kzalloc(sizeof(*sfp), GFP_ATOMIC | __GFP_NOWARN);
L
Linus Torvalds 已提交
2056 2057
	if (!sfp)
		return NULL;
2058

L
Linus Torvalds 已提交
2059 2060 2061
	init_waitqueue_head(&sfp->read_wait);
	rwlock_init(&sfp->rq_list_lock);

2062
	kref_init(&sfp->f_ref);
L
Linus Torvalds 已提交
2063 2064 2065 2066 2067 2068 2069 2070
	sfp->timeout = SG_DEFAULT_TIMEOUT;
	sfp->timeout_user = SG_DEFAULT_TIMEOUT_USER;
	sfp->force_packid = SG_DEF_FORCE_PACK_ID;
	sfp->low_dma = (SG_DEF_FORCE_LOW_DMA == 0) ?
	    sdp->device->host->unchecked_isa_dma : 1;
	sfp->cmd_q = SG_DEF_COMMAND_Q;
	sfp->keep_orphan = SG_DEF_KEEP_ORPHAN;
	sfp->parentdp = sdp;
2071
	write_lock_irqsave(&sg_index_lock, iflags);
2072
	list_add_tail(&sfp->sfd_siblings, &sdp->sfds);
2073
	write_unlock_irqrestore(&sg_index_lock, iflags);
L
Linus Torvalds 已提交
2074
	SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp: sfp=0x%p\n", sfp));
2075 2076 2077
	if (unlikely(sg_big_buff != def_reserved_size))
		sg_big_buff = def_reserved_size;

2078
	bufflen = min_t(int, sg_big_buff,
2079
			queue_max_sectors(sdp->device->request_queue) * 512);
2080
	sg_build_reserve(sfp, bufflen);
L
Linus Torvalds 已提交
2081 2082
	SCSI_LOG_TIMEOUT(3, printk("sg_add_sfp:   bufflen=%d, k_use_sg=%d\n",
			   sfp->reserve.bufflen, sfp->reserve.k_use_sg));
2083 2084 2085

	kref_get(&sdp->d_ref);
	__module_get(THIS_MODULE);
L
Linus Torvalds 已提交
2086 2087 2088
	return sfp;
}

2089
static void sg_remove_sfp_usercontext(struct work_struct *work)
L
Linus Torvalds 已提交
2090
{
2091 2092 2093 2094 2095 2096
	struct sg_fd *sfp = container_of(work, struct sg_fd, ew.work);
	struct sg_device *sdp = sfp->parentdp;

	/* Cleanup any responses which were never read(). */
	while (sfp->headrp)
		sg_finish_rem_req(sfp->headrp);
L
Linus Torvalds 已提交
2097 2098

	if (sfp->reserve.bufflen > 0) {
2099 2100 2101 2102
		SCSI_LOG_TIMEOUT(6,
			printk("sg_remove_sfp:    bufflen=%d, k_use_sg=%d\n",
				(int) sfp->reserve.bufflen,
				(int) sfp->reserve.k_use_sg));
L
Linus Torvalds 已提交
2103 2104
		sg_remove_scat(&sfp->reserve);
	}
2105 2106 2107 2108 2109

	SCSI_LOG_TIMEOUT(6,
		printk("sg_remove_sfp: %s, sfp=0x%p\n",
			sdp->disk->disk_name,
			sfp));
2110
	kfree(sfp);
2111 2112 2113 2114

	scsi_device_put(sdp->device);
	sg_put_dev(sdp);
	module_put(THIS_MODULE);
L
Linus Torvalds 已提交
2115 2116
}

2117
static void sg_remove_sfp(struct kref *kref)
L
Linus Torvalds 已提交
2118
{
2119 2120 2121
	struct sg_fd *sfp = container_of(kref, struct sg_fd, f_ref);
	struct sg_device *sdp = sfp->parentdp;
	unsigned long iflags;
L
Linus Torvalds 已提交
2122

2123
	write_lock_irqsave(&sg_index_lock, iflags);
2124
	list_del(&sfp->sfd_siblings);
2125 2126
	write_unlock_irqrestore(&sg_index_lock, iflags);
	wake_up_interruptible(&sdp->o_excl_wait);
L
Linus Torvalds 已提交
2127

2128 2129
	INIT_WORK(&sfp->ew.work, sg_remove_sfp_usercontext);
	schedule_work(&sfp->ew.work);
L
Linus Torvalds 已提交
2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146
}

static int
sg_res_in_use(Sg_fd * sfp)
{
	const Sg_request *srp;
	unsigned long iflags;

	read_lock_irqsave(&sfp->rq_list_lock, iflags);
	for (srp = sfp->headrp; srp; srp = srp->nextrp)
		if (srp->res_used)
			break;
	read_unlock_irqrestore(&sfp->rq_list_lock, iflags);
	return srp ? 1 : 0;
}

#ifdef CONFIG_SCSI_PROC_FS
2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157
static int
sg_idr_max_id(int id, void *p, void *data)
{
	int *k = data;

	if (*k < id)
		*k = id;

	return 0;
}

L
Linus Torvalds 已提交
2158 2159 2160
static int
sg_last_dev(void)
{
2161
	int k = -1;
L
Linus Torvalds 已提交
2162 2163
	unsigned long iflags;

2164 2165 2166
	read_lock_irqsave(&sg_index_lock, iflags);
	idr_for_each(&sg_index_idr, sg_idr_max_id, &k);
	read_unlock_irqrestore(&sg_index_lock, iflags);
L
Linus Torvalds 已提交
2167 2168 2169 2170
	return k + 1;		/* origin 1 */
}
#endif

2171 2172
/* must be called with sg_index_lock held */
static Sg_device *sg_lookup_dev(int dev)
L
Linus Torvalds 已提交
2173
{
2174 2175
	return idr_find(&sg_index_idr, dev);
}
L
Linus Torvalds 已提交
2176

2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193
static Sg_device *sg_get_dev(int dev)
{
	struct sg_device *sdp;
	unsigned long flags;

	read_lock_irqsave(&sg_index_lock, flags);
	sdp = sg_lookup_dev(dev);
	if (!sdp)
		sdp = ERR_PTR(-ENXIO);
	else if (sdp->detached) {
		/* If sdp->detached, then the refcount may already be 0, in
		 * which case it would be a bug to do kref_get().
		 */
		sdp = ERR_PTR(-ENODEV);
	} else
		kref_get(&sdp->d_ref);
	read_unlock_irqrestore(&sg_index_lock, flags);
2194

L
Linus Torvalds 已提交
2195 2196 2197
	return sdp;
}

2198 2199 2200 2201 2202
static void sg_put_dev(struct sg_device *sdp)
{
	kref_put(&sdp->d_ref, sg_device_destroy);
}

L
Linus Torvalds 已提交
2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213
#ifdef CONFIG_SCSI_PROC_FS

static struct proc_dir_entry *sg_proc_sgp = NULL;

static char sg_proc_sg_dirname[] = "scsi/sg";

static int sg_proc_seq_show_int(struct seq_file *s, void *v);

static int sg_proc_single_open_adio(struct inode *inode, struct file *file);
static ssize_t sg_proc_write_adio(struct file *filp, const char __user *buffer,
			          size_t count, loff_t *off);
2214 2215
static const struct file_operations adio_fops = {
	.owner = THIS_MODULE,
L
Linus Torvalds 已提交
2216
	.open = sg_proc_single_open_adio,
2217 2218
	.read = seq_read,
	.llseek = seq_lseek,
L
Linus Torvalds 已提交
2219 2220 2221 2222 2223 2224 2225
	.write = sg_proc_write_adio,
	.release = single_release,
};

static int sg_proc_single_open_dressz(struct inode *inode, struct file *file);
static ssize_t sg_proc_write_dressz(struct file *filp, 
		const char __user *buffer, size_t count, loff_t *off);
2226 2227
static const struct file_operations dressz_fops = {
	.owner = THIS_MODULE,
L
Linus Torvalds 已提交
2228
	.open = sg_proc_single_open_dressz,
2229 2230
	.read = seq_read,
	.llseek = seq_lseek,
L
Linus Torvalds 已提交
2231 2232 2233 2234 2235 2236
	.write = sg_proc_write_dressz,
	.release = single_release,
};

static int sg_proc_seq_show_version(struct seq_file *s, void *v);
static int sg_proc_single_open_version(struct inode *inode, struct file *file);
2237 2238
static const struct file_operations version_fops = {
	.owner = THIS_MODULE,
L
Linus Torvalds 已提交
2239
	.open = sg_proc_single_open_version,
2240 2241
	.read = seq_read,
	.llseek = seq_lseek,
L
Linus Torvalds 已提交
2242 2243 2244 2245 2246
	.release = single_release,
};

static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v);
static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file);
2247 2248
static const struct file_operations devhdr_fops = {
	.owner = THIS_MODULE,
L
Linus Torvalds 已提交
2249
	.open = sg_proc_single_open_devhdr,
2250 2251
	.read = seq_read,
	.llseek = seq_lseek,
L
Linus Torvalds 已提交
2252 2253 2254 2255 2256 2257 2258 2259
	.release = single_release,
};

static int sg_proc_seq_show_dev(struct seq_file *s, void *v);
static int sg_proc_open_dev(struct inode *inode, struct file *file);
static void * dev_seq_start(struct seq_file *s, loff_t *pos);
static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos);
static void dev_seq_stop(struct seq_file *s, void *v);
2260 2261
static const struct file_operations dev_fops = {
	.owner = THIS_MODULE,
L
Linus Torvalds 已提交
2262
	.open = sg_proc_open_dev,
2263 2264
	.read = seq_read,
	.llseek = seq_lseek,
L
Linus Torvalds 已提交
2265 2266
	.release = seq_release,
};
J
James Morris 已提交
2267
static const struct seq_operations dev_seq_ops = {
L
Linus Torvalds 已提交
2268 2269 2270 2271 2272 2273 2274 2275
	.start = dev_seq_start,
	.next  = dev_seq_next,
	.stop  = dev_seq_stop,
	.show  = sg_proc_seq_show_dev,
};

static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v);
static int sg_proc_open_devstrs(struct inode *inode, struct file *file);
2276 2277
static const struct file_operations devstrs_fops = {
	.owner = THIS_MODULE,
L
Linus Torvalds 已提交
2278
	.open = sg_proc_open_devstrs,
2279 2280
	.read = seq_read,
	.llseek = seq_lseek,
L
Linus Torvalds 已提交
2281 2282
	.release = seq_release,
};
J
James Morris 已提交
2283
static const struct seq_operations devstrs_seq_ops = {
L
Linus Torvalds 已提交
2284 2285 2286 2287 2288 2289 2290 2291
	.start = dev_seq_start,
	.next  = dev_seq_next,
	.stop  = dev_seq_stop,
	.show  = sg_proc_seq_show_devstrs,
};

static int sg_proc_seq_show_debug(struct seq_file *s, void *v);
static int sg_proc_open_debug(struct inode *inode, struct file *file);
2292 2293
static const struct file_operations debug_fops = {
	.owner = THIS_MODULE,
L
Linus Torvalds 已提交
2294
	.open = sg_proc_open_debug,
2295 2296
	.read = seq_read,
	.llseek = seq_lseek,
L
Linus Torvalds 已提交
2297 2298
	.release = seq_release,
};
J
James Morris 已提交
2299
static const struct seq_operations debug_seq_ops = {
L
Linus Torvalds 已提交
2300 2301 2302 2303 2304 2305 2306 2307 2308
	.start = dev_seq_start,
	.next  = dev_seq_next,
	.stop  = dev_seq_stop,
	.show  = sg_proc_seq_show_debug,
};


struct sg_proc_leaf {
	const char * name;
2309
	const struct file_operations * fops;
L
Linus Torvalds 已提交
2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325
};

static struct sg_proc_leaf sg_proc_leaf_arr[] = {
	{"allow_dio", &adio_fops},
	{"debug", &debug_fops},
	{"def_reserved_size", &dressz_fops},
	{"device_hdr", &devhdr_fops},
	{"devices", &dev_fops},
	{"device_strs", &devstrs_fops},
	{"version", &version_fops}
};

static int
sg_proc_init(void)
{
	int k, mask;
2326
	int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
L
Linus Torvalds 已提交
2327 2328
	struct sg_proc_leaf * leaf;

2329
	sg_proc_sgp = proc_mkdir(sg_proc_sg_dirname, NULL);
L
Linus Torvalds 已提交
2330 2331 2332 2333 2334
	if (!sg_proc_sgp)
		return 1;
	for (k = 0; k < num_leaves; ++k) {
		leaf = &sg_proc_leaf_arr[k];
		mask = leaf->fops->write ? S_IRUGO | S_IWUSR : S_IRUGO;
2335
		proc_create(leaf->name, mask, sg_proc_sgp, leaf->fops);
L
Linus Torvalds 已提交
2336 2337 2338 2339 2340 2341 2342 2343
	}
	return 0;
}

static void
sg_proc_cleanup(void)
{
	int k;
2344
	int num_leaves = ARRAY_SIZE(sg_proc_leaf_arr);
L
Linus Torvalds 已提交
2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441

	if (!sg_proc_sgp)
		return;
	for (k = 0; k < num_leaves; ++k)
		remove_proc_entry(sg_proc_leaf_arr[k].name, sg_proc_sgp);
	remove_proc_entry(sg_proc_sg_dirname, NULL);
}


static int sg_proc_seq_show_int(struct seq_file *s, void *v)
{
	seq_printf(s, "%d\n", *((int *)s->private));
	return 0;
}

static int sg_proc_single_open_adio(struct inode *inode, struct file *file)
{
	return single_open(file, sg_proc_seq_show_int, &sg_allow_dio);
}

static ssize_t 
sg_proc_write_adio(struct file *filp, const char __user *buffer,
		   size_t count, loff_t *off)
{
	int num;
	char buff[11];

	if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
		return -EACCES;
	num = (count < 10) ? count : 10;
	if (copy_from_user(buff, buffer, num))
		return -EFAULT;
	buff[num] = '\0';
	sg_allow_dio = simple_strtoul(buff, NULL, 10) ? 1 : 0;
	return count;
}

static int sg_proc_single_open_dressz(struct inode *inode, struct file *file)
{
	return single_open(file, sg_proc_seq_show_int, &sg_big_buff);
}

static ssize_t 
sg_proc_write_dressz(struct file *filp, const char __user *buffer,
		     size_t count, loff_t *off)
{
	int num;
	unsigned long k = ULONG_MAX;
	char buff[11];

	if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
		return -EACCES;
	num = (count < 10) ? count : 10;
	if (copy_from_user(buff, buffer, num))
		return -EFAULT;
	buff[num] = '\0';
	k = simple_strtoul(buff, NULL, 10);
	if (k <= 1048576) {	/* limit "big buff" to 1 MB */
		sg_big_buff = k;
		return count;
	}
	return -ERANGE;
}

static int sg_proc_seq_show_version(struct seq_file *s, void *v)
{
	seq_printf(s, "%d\t%s [%s]\n", sg_version_num, SG_VERSION_STR,
		   sg_version_date);
	return 0;
}

static int sg_proc_single_open_version(struct inode *inode, struct file *file)
{
	return single_open(file, sg_proc_seq_show_version, NULL);
}

static int sg_proc_seq_show_devhdr(struct seq_file *s, void *v)
{
	seq_printf(s, "host\tchan\tid\tlun\ttype\topens\tqdepth\tbusy\t"
		   "online\n");
	return 0;
}

static int sg_proc_single_open_devhdr(struct inode *inode, struct file *file)
{
	return single_open(file, sg_proc_seq_show_devhdr, NULL);
}

struct sg_proc_deviter {
	loff_t	index;
	size_t	max;
};

static void * dev_seq_start(struct seq_file *s, loff_t *pos)
{
	struct sg_proc_deviter * it = kmalloc(sizeof(*it), GFP_KERNEL);

2442
	s->private = it;
L
Linus Torvalds 已提交
2443 2444
	if (! it)
		return NULL;
2445

L
Linus Torvalds 已提交
2446 2447 2448
	it->index = *pos;
	it->max = sg_last_dev();
	if (it->index >= it->max)
2449
		return NULL;
L
Linus Torvalds 已提交
2450 2451 2452 2453 2454
	return it;
}

static void * dev_seq_next(struct seq_file *s, void *v, loff_t *pos)
{
2455
	struct sg_proc_deviter * it = s->private;
L
Linus Torvalds 已提交
2456 2457 2458 2459 2460 2461 2462

	*pos = ++it->index;
	return (it->index < it->max) ? it : NULL;
}

static void dev_seq_stop(struct seq_file *s, void *v)
{
2463
	kfree(s->private);
L
Linus Torvalds 已提交
2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475
}

static int sg_proc_open_dev(struct inode *inode, struct file *file)
{
        return seq_open(file, &dev_seq_ops);
}

static int sg_proc_seq_show_dev(struct seq_file *s, void *v)
{
	struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
	Sg_device *sdp;
	struct scsi_device *scsidp;
2476
	unsigned long iflags;
L
Linus Torvalds 已提交
2477

2478 2479
	read_lock_irqsave(&sg_index_lock, iflags);
	sdp = it ? sg_lookup_dev(it->index) : NULL;
L
Linus Torvalds 已提交
2480 2481 2482 2483 2484 2485 2486 2487 2488 2489
	if (sdp && (scsidp = sdp->device) && (!sdp->detached))
		seq_printf(s, "%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\t%d\n",
			      scsidp->host->host_no, scsidp->channel,
			      scsidp->id, scsidp->lun, (int) scsidp->type,
			      1,
			      (int) scsidp->queue_depth,
			      (int) scsidp->device_busy,
			      (int) scsi_device_online(scsidp));
	else
		seq_printf(s, "-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\t-1\n");
2490
	read_unlock_irqrestore(&sg_index_lock, iflags);
L
Linus Torvalds 已提交
2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503
	return 0;
}

static int sg_proc_open_devstrs(struct inode *inode, struct file *file)
{
        return seq_open(file, &devstrs_seq_ops);
}

static int sg_proc_seq_show_devstrs(struct seq_file *s, void *v)
{
	struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
	Sg_device *sdp;
	struct scsi_device *scsidp;
2504
	unsigned long iflags;
L
Linus Torvalds 已提交
2505

2506 2507
	read_lock_irqsave(&sg_index_lock, iflags);
	sdp = it ? sg_lookup_dev(it->index) : NULL;
L
Linus Torvalds 已提交
2508 2509 2510 2511 2512
	if (sdp && (scsidp = sdp->device) && (!sdp->detached))
		seq_printf(s, "%8.8s\t%16.16s\t%4.4s\n",
			   scsidp->vendor, scsidp->model, scsidp->rev);
	else
		seq_printf(s, "<no active device>\n");
2513
	read_unlock_irqrestore(&sg_index_lock, iflags);
L
Linus Torvalds 已提交
2514 2515 2516
	return 0;
}

2517
/* must be called while holding sg_index_lock */
L
Linus Torvalds 已提交
2518 2519 2520 2521 2522 2523 2524
static void sg_proc_debug_helper(struct seq_file *s, Sg_device * sdp)
{
	int k, m, new_interface, blen, usg;
	Sg_request *srp;
	Sg_fd *fp;
	const sg_io_hdr_t *hp;
	const char * cp;
已提交
2525
	unsigned int ms;
L
Linus Torvalds 已提交
2526

2527 2528 2529
	k = 0;
	list_for_each_entry(fp, &sdp->sfds, sfd_siblings) {
		k++;
2530
		read_lock(&fp->rq_list_lock); /* irqs already disabled */
L
Linus Torvalds 已提交
2531
		seq_printf(s, "   FD(%d): timeout=%dms bufflen=%d "
2532
			   "(res)sgat=%d low_dma=%d\n", k,
L
Linus Torvalds 已提交
2533 2534 2535 2536 2537 2538 2539
			   jiffies_to_msecs(fp->timeout),
			   fp->reserve.bufflen,
			   (int) fp->reserve.k_use_sg,
			   (int) fp->low_dma);
		seq_printf(s, "   cmd_q=%d f_packid=%d k_orphan=%d closed=%d\n",
			   (int) fp->cmd_q, (int) fp->force_packid,
			   (int) fp->keep_orphan, (int) fp->closed);
2540 2541 2542
		for (m = 0, srp = fp->headrp;
				srp != NULL;
				++m, srp = srp->nextrp) {
L
Linus Torvalds 已提交
2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557
			hp = &srp->header;
			new_interface = (hp->interface_id == '\0') ? 0 : 1;
			if (srp->res_used) {
				if (new_interface && 
				    (SG_FLAG_MMAP_IO & hp->flags))
					cp = "     mmap>> ";
				else
					cp = "     rb>> ";
			} else {
				if (SG_INFO_DIRECT_IO_MASK & hp->info)
					cp = "     dio>> ";
				else
					cp = "     ";
			}
			seq_printf(s, cp);
2558 2559
			blen = srp->data.bufflen;
			usg = srp->data.k_use_sg;
L
Linus Torvalds 已提交
2560 2561
			seq_printf(s, srp->done ? 
				   ((1 == srp->done) ?  "rcv:" : "fin:")
2562
				   : "act:");
L
Linus Torvalds 已提交
2563 2564 2565 2566
			seq_printf(s, " id=%d blen=%d",
				   srp->header.pack_id, blen);
			if (srp->done)
				seq_printf(s, " dur=%d", hp->duration);
已提交
2567 2568
			else {
				ms = jiffies_to_msecs(jiffies);
L
Linus Torvalds 已提交
2569
				seq_printf(s, " t_o/elap=%d/%d",
已提交
2570 2571 2572 2573
					(new_interface ? hp->timeout :
						  jiffies_to_msecs(fp->timeout)),
					(ms > hp->duration ? ms - hp->duration : 0));
			}
L
Linus Torvalds 已提交
2574 2575 2576 2577 2578
			seq_printf(s, "ms sgat=%d op=0x%02x\n", usg,
				   (int) srp->data.cmd_opcode);
		}
		if (0 == m)
			seq_printf(s, "     No requests active\n");
2579
		read_unlock(&fp->rq_list_lock);
L
Linus Torvalds 已提交
2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591
	}
}

static int sg_proc_open_debug(struct inode *inode, struct file *file)
{
        return seq_open(file, &debug_seq_ops);
}

static int sg_proc_seq_show_debug(struct seq_file *s, void *v)
{
	struct sg_proc_deviter * it = (struct sg_proc_deviter *) v;
	Sg_device *sdp;
2592
	unsigned long iflags;
L
Linus Torvalds 已提交
2593 2594

	if (it && (0 == it->index)) {
2595 2596
		seq_printf(s, "max_active_device=%d(origin 1)\n",
			   (int)it->max);
L
Linus Torvalds 已提交
2597 2598 2599
		seq_printf(s, " def_reserved_size=%d\n", sg_big_buff);
	}

2600 2601
	read_lock_irqsave(&sg_index_lock, iflags);
	sdp = it ? sg_lookup_dev(it->index) : NULL;
2602
	if (sdp && !list_empty(&sdp->sfds)) {
2603
		struct scsi_device *scsidp = sdp->device;
L
Linus Torvalds 已提交
2604

2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616
		seq_printf(s, " >>> device=%s ", sdp->disk->disk_name);
		if (sdp->detached)
			seq_printf(s, "detached pending close ");
		else
			seq_printf
			    (s, "scsi%d chan=%d id=%d lun=%d   em=%d",
			     scsidp->host->host_no,
			     scsidp->channel, scsidp->id,
			     scsidp->lun,
			     scsidp->host->hostt->emulated);
		seq_printf(s, " sg_tablesize=%d excl=%d\n",
			   sdp->sg_tablesize, sdp->exclude);
L
Linus Torvalds 已提交
2617 2618
		sg_proc_debug_helper(s, sdp);
	}
2619
	read_unlock_irqrestore(&sg_index_lock, iflags);
L
Linus Torvalds 已提交
2620 2621 2622 2623 2624 2625 2626
	return 0;
}

#endif				/* CONFIG_SCSI_PROC_FS */

module_init(init_sg);
module_exit(exit_sg);