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