drivers/scsi/sg.c

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