sg.c 70 KB

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