sg.c 69 KB

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