sg.c 72 KB

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