scsi_lib.c 64 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554
  1. /*
  2. * scsi_lib.c Copyright (C) 1999 Eric Youngdale
  3. *
  4. * SCSI queueing library.
  5. * Initial versions: Eric Youngdale (eric@andante.org).
  6. * Based upon conversations with large numbers
  7. * of people at Linux Expo.
  8. */
  9. #include <linux/bio.h>
  10. #include <linux/bitops.h>
  11. #include <linux/blkdev.h>
  12. #include <linux/completion.h>
  13. #include <linux/kernel.h>
  14. #include <linux/mempool.h>
  15. #include <linux/slab.h>
  16. #include <linux/init.h>
  17. #include <linux/pci.h>
  18. #include <linux/delay.h>
  19. #include <linux/hardirq.h>
  20. #include <linux/scatterlist.h>
  21. #include <scsi/scsi.h>
  22. #include <scsi/scsi_cmnd.h>
  23. #include <scsi/scsi_dbg.h>
  24. #include <scsi/scsi_device.h>
  25. #include <scsi/scsi_driver.h>
  26. #include <scsi/scsi_eh.h>
  27. #include <scsi/scsi_host.h>
  28. #include "scsi_priv.h"
  29. #include "scsi_logging.h"
  30. #define SG_MEMPOOL_NR ARRAY_SIZE(scsi_sg_pools)
  31. #define SG_MEMPOOL_SIZE 2
  32. struct scsi_host_sg_pool {
  33. size_t size;
  34. char *name;
  35. struct kmem_cache *slab;
  36. mempool_t *pool;
  37. };
  38. #define SP(x) { x, "sgpool-" __stringify(x) }
  39. #if (SCSI_MAX_SG_SEGMENTS < 32)
  40. #error SCSI_MAX_SG_SEGMENTS is too small (must be 32 or greater)
  41. #endif
  42. static struct scsi_host_sg_pool scsi_sg_pools[] = {
  43. SP(8),
  44. SP(16),
  45. #if (SCSI_MAX_SG_SEGMENTS > 32)
  46. SP(32),
  47. #if (SCSI_MAX_SG_SEGMENTS > 64)
  48. SP(64),
  49. #if (SCSI_MAX_SG_SEGMENTS > 128)
  50. SP(128),
  51. #if (SCSI_MAX_SG_SEGMENTS > 256)
  52. #error SCSI_MAX_SG_SEGMENTS is too large (256 MAX)
  53. #endif
  54. #endif
  55. #endif
  56. #endif
  57. SP(SCSI_MAX_SG_SEGMENTS)
  58. };
  59. #undef SP
  60. struct kmem_cache *scsi_sdb_cache;
  61. static void scsi_run_queue(struct request_queue *q);
  62. /*
  63. * Function: scsi_unprep_request()
  64. *
  65. * Purpose: Remove all preparation done for a request, including its
  66. * associated scsi_cmnd, so that it can be requeued.
  67. *
  68. * Arguments: req - request to unprepare
  69. *
  70. * Lock status: Assumed that no locks are held upon entry.
  71. *
  72. * Returns: Nothing.
  73. */
  74. static void scsi_unprep_request(struct request *req)
  75. {
  76. struct scsi_cmnd *cmd = req->special;
  77. req->cmd_flags &= ~REQ_DONTPREP;
  78. req->special = NULL;
  79. scsi_put_command(cmd);
  80. }
  81. /**
  82. * __scsi_queue_insert - private queue insertion
  83. * @cmd: The SCSI command being requeued
  84. * @reason: The reason for the requeue
  85. * @unbusy: Whether the queue should be unbusied
  86. *
  87. * This is a private queue insertion. The public interface
  88. * scsi_queue_insert() always assumes the queue should be unbusied
  89. * because it's always called before the completion. This function is
  90. * for a requeue after completion, which should only occur in this
  91. * file.
  92. */
  93. static int __scsi_queue_insert(struct scsi_cmnd *cmd, int reason, int unbusy)
  94. {
  95. struct Scsi_Host *host = cmd->device->host;
  96. struct scsi_device *device = cmd->device;
  97. struct scsi_target *starget = scsi_target(device);
  98. struct request_queue *q = device->request_queue;
  99. unsigned long flags;
  100. SCSI_LOG_MLQUEUE(1,
  101. printk("Inserting command %p into mlqueue\n", cmd));
  102. /*
  103. * Set the appropriate busy bit for the device/host.
  104. *
  105. * If the host/device isn't busy, assume that something actually
  106. * completed, and that we should be able to queue a command now.
  107. *
  108. * Note that the prior mid-layer assumption that any host could
  109. * always queue at least one command is now broken. The mid-layer
  110. * will implement a user specifiable stall (see
  111. * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
  112. * if a command is requeued with no other commands outstanding
  113. * either for the device or for the host.
  114. */
  115. switch (reason) {
  116. case SCSI_MLQUEUE_HOST_BUSY:
  117. host->host_blocked = host->max_host_blocked;
  118. break;
  119. case SCSI_MLQUEUE_DEVICE_BUSY:
  120. device->device_blocked = device->max_device_blocked;
  121. break;
  122. case SCSI_MLQUEUE_TARGET_BUSY:
  123. starget->target_blocked = starget->max_target_blocked;
  124. break;
  125. }
  126. /*
  127. * Decrement the counters, since these commands are no longer
  128. * active on the host/device.
  129. */
  130. if (unbusy)
  131. scsi_device_unbusy(device);
  132. /*
  133. * Requeue this command. It will go before all other commands
  134. * that are already in the queue.
  135. *
  136. * NOTE: there is magic here about the way the queue is plugged if
  137. * we have no outstanding commands.
  138. *
  139. * Although we *don't* plug the queue, we call the request
  140. * function. The SCSI request function detects the blocked condition
  141. * and plugs the queue appropriately.
  142. */
  143. spin_lock_irqsave(q->queue_lock, flags);
  144. blk_requeue_request(q, cmd->request);
  145. spin_unlock_irqrestore(q->queue_lock, flags);
  146. scsi_run_queue(q);
  147. return 0;
  148. }
  149. /*
  150. * Function: scsi_queue_insert()
  151. *
  152. * Purpose: Insert a command in the midlevel queue.
  153. *
  154. * Arguments: cmd - command that we are adding to queue.
  155. * reason - why we are inserting command to queue.
  156. *
  157. * Lock status: Assumed that lock is not held upon entry.
  158. *
  159. * Returns: Nothing.
  160. *
  161. * Notes: We do this for one of two cases. Either the host is busy
  162. * and it cannot accept any more commands for the time being,
  163. * or the device returned QUEUE_FULL and can accept no more
  164. * commands.
  165. * Notes: This could be called either from an interrupt context or a
  166. * normal process context.
  167. */
  168. int scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
  169. {
  170. return __scsi_queue_insert(cmd, reason, 1);
  171. }
  172. /**
  173. * scsi_execute - insert request and wait for the result
  174. * @sdev: scsi device
  175. * @cmd: scsi command
  176. * @data_direction: data direction
  177. * @buffer: data buffer
  178. * @bufflen: len of buffer
  179. * @sense: optional sense buffer
  180. * @timeout: request timeout in seconds
  181. * @retries: number of times to retry request
  182. * @flags: or into request flags;
  183. * @resid: optional residual length
  184. *
  185. * returns the req->errors value which is the scsi_cmnd result
  186. * field.
  187. */
  188. int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
  189. int data_direction, void *buffer, unsigned bufflen,
  190. unsigned char *sense, int timeout, int retries, int flags,
  191. int *resid)
  192. {
  193. struct request *req;
  194. int write = (data_direction == DMA_TO_DEVICE);
  195. int ret = DRIVER_ERROR << 24;
  196. req = blk_get_request(sdev->request_queue, write, __GFP_WAIT);
  197. if (bufflen && blk_rq_map_kern(sdev->request_queue, req,
  198. buffer, bufflen, __GFP_WAIT))
  199. goto out;
  200. req->cmd_len = COMMAND_SIZE(cmd[0]);
  201. memcpy(req->cmd, cmd, req->cmd_len);
  202. req->sense = sense;
  203. req->sense_len = 0;
  204. req->retries = retries;
  205. req->timeout = timeout;
  206. req->cmd_type = REQ_TYPE_BLOCK_PC;
  207. req->cmd_flags |= flags | REQ_QUIET | REQ_PREEMPT;
  208. /*
  209. * head injection *required* here otherwise quiesce won't work
  210. */
  211. blk_execute_rq(req->q, NULL, req, 1);
  212. /*
  213. * Some devices (USB mass-storage in particular) may transfer
  214. * garbage data together with a residue indicating that the data
  215. * is invalid. Prevent the garbage from being misinterpreted
  216. * and prevent security leaks by zeroing out the excess data.
  217. */
  218. if (unlikely(req->resid_len > 0 && req->resid_len <= bufflen))
  219. memset(buffer + (bufflen - req->resid_len), 0, req->resid_len);
  220. if (resid)
  221. *resid = req->resid_len;
  222. ret = req->errors;
  223. out:
  224. blk_put_request(req);
  225. return ret;
  226. }
  227. EXPORT_SYMBOL(scsi_execute);
  228. int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
  229. int data_direction, void *buffer, unsigned bufflen,
  230. struct scsi_sense_hdr *sshdr, int timeout, int retries,
  231. int *resid)
  232. {
  233. char *sense = NULL;
  234. int result;
  235. if (sshdr) {
  236. sense = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
  237. if (!sense)
  238. return DRIVER_ERROR << 24;
  239. }
  240. result = scsi_execute(sdev, cmd, data_direction, buffer, bufflen,
  241. sense, timeout, retries, 0, resid);
  242. if (sshdr)
  243. scsi_normalize_sense(sense, SCSI_SENSE_BUFFERSIZE, sshdr);
  244. kfree(sense);
  245. return result;
  246. }
  247. EXPORT_SYMBOL(scsi_execute_req);
  248. /*
  249. * Function: scsi_init_cmd_errh()
  250. *
  251. * Purpose: Initialize cmd fields related to error handling.
  252. *
  253. * Arguments: cmd - command that is ready to be queued.
  254. *
  255. * Notes: This function has the job of initializing a number of
  256. * fields related to error handling. Typically this will
  257. * be called once for each command, as required.
  258. */
  259. static void scsi_init_cmd_errh(struct scsi_cmnd *cmd)
  260. {
  261. cmd->serial_number = 0;
  262. scsi_set_resid(cmd, 0);
  263. memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
  264. if (cmd->cmd_len == 0)
  265. cmd->cmd_len = scsi_command_size(cmd->cmnd);
  266. }
  267. void scsi_device_unbusy(struct scsi_device *sdev)
  268. {
  269. struct Scsi_Host *shost = sdev->host;
  270. struct scsi_target *starget = scsi_target(sdev);
  271. unsigned long flags;
  272. spin_lock_irqsave(shost->host_lock, flags);
  273. shost->host_busy--;
  274. starget->target_busy--;
  275. if (unlikely(scsi_host_in_recovery(shost) &&
  276. (shost->host_failed || shost->host_eh_scheduled)))
  277. scsi_eh_wakeup(shost);
  278. spin_unlock(shost->host_lock);
  279. spin_lock(sdev->request_queue->queue_lock);
  280. sdev->device_busy--;
  281. spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
  282. }
  283. /*
  284. * Called for single_lun devices on IO completion. Clear starget_sdev_user,
  285. * and call blk_run_queue for all the scsi_devices on the target -
  286. * including current_sdev first.
  287. *
  288. * Called with *no* scsi locks held.
  289. */
  290. static void scsi_single_lun_run(struct scsi_device *current_sdev)
  291. {
  292. struct Scsi_Host *shost = current_sdev->host;
  293. struct scsi_device *sdev, *tmp;
  294. struct scsi_target *starget = scsi_target(current_sdev);
  295. unsigned long flags;
  296. spin_lock_irqsave(shost->host_lock, flags);
  297. starget->starget_sdev_user = NULL;
  298. spin_unlock_irqrestore(shost->host_lock, flags);
  299. /*
  300. * Call blk_run_queue for all LUNs on the target, starting with
  301. * current_sdev. We race with others (to set starget_sdev_user),
  302. * but in most cases, we will be first. Ideally, each LU on the
  303. * target would get some limited time or requests on the target.
  304. */
  305. blk_run_queue(current_sdev->request_queue);
  306. spin_lock_irqsave(shost->host_lock, flags);
  307. if (starget->starget_sdev_user)
  308. goto out;
  309. list_for_each_entry_safe(sdev, tmp, &starget->devices,
  310. same_target_siblings) {
  311. if (sdev == current_sdev)
  312. continue;
  313. if (scsi_device_get(sdev))
  314. continue;
  315. spin_unlock_irqrestore(shost->host_lock, flags);
  316. blk_run_queue(sdev->request_queue);
  317. spin_lock_irqsave(shost->host_lock, flags);
  318. scsi_device_put(sdev);
  319. }
  320. out:
  321. spin_unlock_irqrestore(shost->host_lock, flags);
  322. }
  323. static inline int scsi_device_is_busy(struct scsi_device *sdev)
  324. {
  325. if (sdev->device_busy >= sdev->queue_depth || sdev->device_blocked)
  326. return 1;
  327. return 0;
  328. }
  329. static inline int scsi_target_is_busy(struct scsi_target *starget)
  330. {
  331. return ((starget->can_queue > 0 &&
  332. starget->target_busy >= starget->can_queue) ||
  333. starget->target_blocked);
  334. }
  335. static inline int scsi_host_is_busy(struct Scsi_Host *shost)
  336. {
  337. if ((shost->can_queue > 0 && shost->host_busy >= shost->can_queue) ||
  338. shost->host_blocked || shost->host_self_blocked)
  339. return 1;
  340. return 0;
  341. }
  342. /*
  343. * Function: scsi_run_queue()
  344. *
  345. * Purpose: Select a proper request queue to serve next
  346. *
  347. * Arguments: q - last request's queue
  348. *
  349. * Returns: Nothing
  350. *
  351. * Notes: The previous command was completely finished, start
  352. * a new one if possible.
  353. */
  354. static void scsi_run_queue(struct request_queue *q)
  355. {
  356. struct scsi_device *sdev = q->queuedata;
  357. struct Scsi_Host *shost = sdev->host;
  358. LIST_HEAD(starved_list);
  359. unsigned long flags;
  360. if (scsi_target(sdev)->single_lun)
  361. scsi_single_lun_run(sdev);
  362. spin_lock_irqsave(shost->host_lock, flags);
  363. list_splice_init(&shost->starved_list, &starved_list);
  364. while (!list_empty(&starved_list)) {
  365. int flagset;
  366. /*
  367. * As long as shost is accepting commands and we have
  368. * starved queues, call blk_run_queue. scsi_request_fn
  369. * drops the queue_lock and can add us back to the
  370. * starved_list.
  371. *
  372. * host_lock protects the starved_list and starved_entry.
  373. * scsi_request_fn must get the host_lock before checking
  374. * or modifying starved_list or starved_entry.
  375. */
  376. if (scsi_host_is_busy(shost))
  377. break;
  378. sdev = list_entry(starved_list.next,
  379. struct scsi_device, starved_entry);
  380. list_del_init(&sdev->starved_entry);
  381. if (scsi_target_is_busy(scsi_target(sdev))) {
  382. list_move_tail(&sdev->starved_entry,
  383. &shost->starved_list);
  384. continue;
  385. }
  386. spin_unlock(shost->host_lock);
  387. spin_lock(sdev->request_queue->queue_lock);
  388. flagset = test_bit(QUEUE_FLAG_REENTER, &q->queue_flags) &&
  389. !test_bit(QUEUE_FLAG_REENTER,
  390. &sdev->request_queue->queue_flags);
  391. if (flagset)
  392. queue_flag_set(QUEUE_FLAG_REENTER, sdev->request_queue);
  393. __blk_run_queue(sdev->request_queue);
  394. if (flagset)
  395. queue_flag_clear(QUEUE_FLAG_REENTER, sdev->request_queue);
  396. spin_unlock(sdev->request_queue->queue_lock);
  397. spin_lock(shost->host_lock);
  398. }
  399. /* put any unprocessed entries back */
  400. list_splice(&starved_list, &shost->starved_list);
  401. spin_unlock_irqrestore(shost->host_lock, flags);
  402. blk_run_queue(q);
  403. }
  404. /*
  405. * Function: scsi_requeue_command()
  406. *
  407. * Purpose: Handle post-processing of completed commands.
  408. *
  409. * Arguments: q - queue to operate on
  410. * cmd - command that may need to be requeued.
  411. *
  412. * Returns: Nothing
  413. *
  414. * Notes: After command completion, there may be blocks left
  415. * over which weren't finished by the previous command
  416. * this can be for a number of reasons - the main one is
  417. * I/O errors in the middle of the request, in which case
  418. * we need to request the blocks that come after the bad
  419. * sector.
  420. * Notes: Upon return, cmd is a stale pointer.
  421. */
  422. static void scsi_requeue_command(struct request_queue *q, struct scsi_cmnd *cmd)
  423. {
  424. struct request *req = cmd->request;
  425. unsigned long flags;
  426. spin_lock_irqsave(q->queue_lock, flags);
  427. scsi_unprep_request(req);
  428. blk_requeue_request(q, req);
  429. spin_unlock_irqrestore(q->queue_lock, flags);
  430. scsi_run_queue(q);
  431. }
  432. void scsi_next_command(struct scsi_cmnd *cmd)
  433. {
  434. struct scsi_device *sdev = cmd->device;
  435. struct request_queue *q = sdev->request_queue;
  436. /* need to hold a reference on the device before we let go of the cmd */
  437. get_device(&sdev->sdev_gendev);
  438. scsi_put_command(cmd);
  439. scsi_run_queue(q);
  440. /* ok to remove device now */
  441. put_device(&sdev->sdev_gendev);
  442. }
  443. void scsi_run_host_queues(struct Scsi_Host *shost)
  444. {
  445. struct scsi_device *sdev;
  446. shost_for_each_device(sdev, shost)
  447. scsi_run_queue(sdev->request_queue);
  448. }
  449. static void __scsi_release_buffers(struct scsi_cmnd *, int);
  450. /*
  451. * Function: scsi_end_request()
  452. *
  453. * Purpose: Post-processing of completed commands (usually invoked at end
  454. * of upper level post-processing and scsi_io_completion).
  455. *
  456. * Arguments: cmd - command that is complete.
  457. * error - 0 if I/O indicates success, < 0 for I/O error.
  458. * bytes - number of bytes of completed I/O
  459. * requeue - indicates whether we should requeue leftovers.
  460. *
  461. * Lock status: Assumed that lock is not held upon entry.
  462. *
  463. * Returns: cmd if requeue required, NULL otherwise.
  464. *
  465. * Notes: This is called for block device requests in order to
  466. * mark some number of sectors as complete.
  467. *
  468. * We are guaranteeing that the request queue will be goosed
  469. * at some point during this call.
  470. * Notes: If cmd was requeued, upon return it will be a stale pointer.
  471. */
  472. static struct scsi_cmnd *scsi_end_request(struct scsi_cmnd *cmd, int error,
  473. int bytes, int requeue)
  474. {
  475. struct request_queue *q = cmd->device->request_queue;
  476. struct request *req = cmd->request;
  477. /*
  478. * If there are blocks left over at the end, set up the command
  479. * to queue the remainder of them.
  480. */
  481. if (blk_end_request(req, error, bytes)) {
  482. /* kill remainder if no retrys */
  483. if (error && scsi_noretry_cmd(cmd))
  484. blk_end_request_all(req, error);
  485. else {
  486. if (requeue) {
  487. /*
  488. * Bleah. Leftovers again. Stick the
  489. * leftovers in the front of the
  490. * queue, and goose the queue again.
  491. */
  492. scsi_release_buffers(cmd);
  493. scsi_requeue_command(q, cmd);
  494. cmd = NULL;
  495. }
  496. return cmd;
  497. }
  498. }
  499. /*
  500. * This will goose the queue request function at the end, so we don't
  501. * need to worry about launching another command.
  502. */
  503. __scsi_release_buffers(cmd, 0);
  504. scsi_next_command(cmd);
  505. return NULL;
  506. }
  507. static inline unsigned int scsi_sgtable_index(unsigned short nents)
  508. {
  509. unsigned int index;
  510. BUG_ON(nents > SCSI_MAX_SG_SEGMENTS);
  511. if (nents <= 8)
  512. index = 0;
  513. else
  514. index = get_count_order(nents) - 3;
  515. return index;
  516. }
  517. static void scsi_sg_free(struct scatterlist *sgl, unsigned int nents)
  518. {
  519. struct scsi_host_sg_pool *sgp;
  520. sgp = scsi_sg_pools + scsi_sgtable_index(nents);
  521. mempool_free(sgl, sgp->pool);
  522. }
  523. static struct scatterlist *scsi_sg_alloc(unsigned int nents, gfp_t gfp_mask)
  524. {
  525. struct scsi_host_sg_pool *sgp;
  526. sgp = scsi_sg_pools + scsi_sgtable_index(nents);
  527. return mempool_alloc(sgp->pool, gfp_mask);
  528. }
  529. static int scsi_alloc_sgtable(struct scsi_data_buffer *sdb, int nents,
  530. gfp_t gfp_mask)
  531. {
  532. int ret;
  533. BUG_ON(!nents);
  534. ret = __sg_alloc_table(&sdb->table, nents, SCSI_MAX_SG_SEGMENTS,
  535. gfp_mask, scsi_sg_alloc);
  536. if (unlikely(ret))
  537. __sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS,
  538. scsi_sg_free);
  539. return ret;
  540. }
  541. static void scsi_free_sgtable(struct scsi_data_buffer *sdb)
  542. {
  543. __sg_free_table(&sdb->table, SCSI_MAX_SG_SEGMENTS, scsi_sg_free);
  544. }
  545. static void __scsi_release_buffers(struct scsi_cmnd *cmd, int do_bidi_check)
  546. {
  547. if (cmd->sdb.table.nents)
  548. scsi_free_sgtable(&cmd->sdb);
  549. memset(&cmd->sdb, 0, sizeof(cmd->sdb));
  550. if (do_bidi_check && scsi_bidi_cmnd(cmd)) {
  551. struct scsi_data_buffer *bidi_sdb =
  552. cmd->request->next_rq->special;
  553. scsi_free_sgtable(bidi_sdb);
  554. kmem_cache_free(scsi_sdb_cache, bidi_sdb);
  555. cmd->request->next_rq->special = NULL;
  556. }
  557. if (scsi_prot_sg_count(cmd))
  558. scsi_free_sgtable(cmd->prot_sdb);
  559. }
  560. /*
  561. * Function: scsi_release_buffers()
  562. *
  563. * Purpose: Completion processing for block device I/O requests.
  564. *
  565. * Arguments: cmd - command that we are bailing.
  566. *
  567. * Lock status: Assumed that no lock is held upon entry.
  568. *
  569. * Returns: Nothing
  570. *
  571. * Notes: In the event that an upper level driver rejects a
  572. * command, we must release resources allocated during
  573. * the __init_io() function. Primarily this would involve
  574. * the scatter-gather table, and potentially any bounce
  575. * buffers.
  576. */
  577. void scsi_release_buffers(struct scsi_cmnd *cmd)
  578. {
  579. __scsi_release_buffers(cmd, 1);
  580. }
  581. EXPORT_SYMBOL(scsi_release_buffers);
  582. /*
  583. * Function: scsi_io_completion()
  584. *
  585. * Purpose: Completion processing for block device I/O requests.
  586. *
  587. * Arguments: cmd - command that is finished.
  588. *
  589. * Lock status: Assumed that no lock is held upon entry.
  590. *
  591. * Returns: Nothing
  592. *
  593. * Notes: This function is matched in terms of capabilities to
  594. * the function that created the scatter-gather list.
  595. * In other words, if there are no bounce buffers
  596. * (the normal case for most drivers), we don't need
  597. * the logic to deal with cleaning up afterwards.
  598. *
  599. * We must call scsi_end_request(). This will finish off
  600. * the specified number of sectors. If we are done, the
  601. * command block will be released and the queue function
  602. * will be goosed. If we are not done then we have to
  603. * figure out what to do next:
  604. *
  605. * a) We can call scsi_requeue_command(). The request
  606. * will be unprepared and put back on the queue. Then
  607. * a new command will be created for it. This should
  608. * be used if we made forward progress, or if we want
  609. * to switch from READ(10) to READ(6) for example.
  610. *
  611. * b) We can call scsi_queue_insert(). The request will
  612. * be put back on the queue and retried using the same
  613. * command as before, possibly after a delay.
  614. *
  615. * c) We can call blk_end_request() with -EIO to fail
  616. * the remainder of the request.
  617. */
  618. void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes)
  619. {
  620. int result = cmd->result;
  621. struct request_queue *q = cmd->device->request_queue;
  622. struct request *req = cmd->request;
  623. int error = 0;
  624. struct scsi_sense_hdr sshdr;
  625. int sense_valid = 0;
  626. int sense_deferred = 0;
  627. enum {ACTION_FAIL, ACTION_REPREP, ACTION_RETRY,
  628. ACTION_DELAYED_RETRY} action;
  629. char *description = NULL;
  630. if (result) {
  631. sense_valid = scsi_command_normalize_sense(cmd, &sshdr);
  632. if (sense_valid)
  633. sense_deferred = scsi_sense_is_deferred(&sshdr);
  634. }
  635. if (blk_pc_request(req)) { /* SG_IO ioctl from block level */
  636. req->errors = result;
  637. if (result) {
  638. if (sense_valid && req->sense) {
  639. /*
  640. * SG_IO wants current and deferred errors
  641. */
  642. int len = 8 + cmd->sense_buffer[7];
  643. if (len > SCSI_SENSE_BUFFERSIZE)
  644. len = SCSI_SENSE_BUFFERSIZE;
  645. memcpy(req->sense, cmd->sense_buffer, len);
  646. req->sense_len = len;
  647. }
  648. if (!sense_deferred)
  649. error = -EIO;
  650. }
  651. req->resid_len = scsi_get_resid(cmd);
  652. if (scsi_bidi_cmnd(cmd)) {
  653. /*
  654. * Bidi commands Must be complete as a whole,
  655. * both sides at once.
  656. */
  657. req->next_rq->resid_len = scsi_in(cmd)->resid;
  658. blk_end_request_all(req, 0);
  659. scsi_release_buffers(cmd);
  660. scsi_next_command(cmd);
  661. return;
  662. }
  663. }
  664. BUG_ON(blk_bidi_rq(req)); /* bidi not support for !blk_pc_request yet */
  665. /*
  666. * Next deal with any sectors which we were able to correctly
  667. * handle.
  668. */
  669. SCSI_LOG_HLCOMPLETE(1, printk("%u sectors total, "
  670. "%d bytes done.\n",
  671. blk_rq_sectors(req), good_bytes));
  672. /*
  673. * Recovered errors need reporting, but they're always treated
  674. * as success, so fiddle the result code here. For BLOCK_PC
  675. * we already took a copy of the original into rq->errors which
  676. * is what gets returned to the user
  677. */
  678. if (sense_valid && sshdr.sense_key == RECOVERED_ERROR) {
  679. if (!(req->cmd_flags & REQ_QUIET))
  680. scsi_print_sense("", cmd);
  681. result = 0;
  682. /* BLOCK_PC may have set error */
  683. error = 0;
  684. }
  685. /*
  686. * A number of bytes were successfully read. If there
  687. * are leftovers and there is some kind of error
  688. * (result != 0), retry the rest.
  689. */
  690. if (scsi_end_request(cmd, error, good_bytes, result == 0) == NULL)
  691. return;
  692. error = -EIO;
  693. if (host_byte(result) == DID_RESET) {
  694. /* Third party bus reset or reset for error recovery
  695. * reasons. Just retry the command and see what
  696. * happens.
  697. */
  698. action = ACTION_RETRY;
  699. } else if (sense_valid && !sense_deferred) {
  700. switch (sshdr.sense_key) {
  701. case UNIT_ATTENTION:
  702. if (cmd->device->removable) {
  703. /* Detected disc change. Set a bit
  704. * and quietly refuse further access.
  705. */
  706. cmd->device->changed = 1;
  707. description = "Media Changed";
  708. action = ACTION_FAIL;
  709. } else {
  710. /* Must have been a power glitch, or a
  711. * bus reset. Could not have been a
  712. * media change, so we just retry the
  713. * command and see what happens.
  714. */
  715. action = ACTION_RETRY;
  716. }
  717. break;
  718. case ILLEGAL_REQUEST:
  719. /* If we had an ILLEGAL REQUEST returned, then
  720. * we may have performed an unsupported
  721. * command. The only thing this should be
  722. * would be a ten byte read where only a six
  723. * byte read was supported. Also, on a system
  724. * where READ CAPACITY failed, we may have
  725. * read past the end of the disk.
  726. */
  727. if ((cmd->device->use_10_for_rw &&
  728. sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
  729. (cmd->cmnd[0] == READ_10 ||
  730. cmd->cmnd[0] == WRITE_10)) {
  731. /* This will issue a new 6-byte command. */
  732. cmd->device->use_10_for_rw = 0;
  733. action = ACTION_REPREP;
  734. } else if (sshdr.asc == 0x10) /* DIX */ {
  735. description = "Host Data Integrity Failure";
  736. action = ACTION_FAIL;
  737. error = -EILSEQ;
  738. } else
  739. action = ACTION_FAIL;
  740. break;
  741. case ABORTED_COMMAND:
  742. action = ACTION_FAIL;
  743. if (sshdr.asc == 0x10) { /* DIF */
  744. description = "Target Data Integrity Failure";
  745. error = -EILSEQ;
  746. }
  747. break;
  748. case NOT_READY:
  749. /* If the device is in the process of becoming
  750. * ready, or has a temporary blockage, retry.
  751. */
  752. if (sshdr.asc == 0x04) {
  753. switch (sshdr.ascq) {
  754. case 0x01: /* becoming ready */
  755. case 0x04: /* format in progress */
  756. case 0x05: /* rebuild in progress */
  757. case 0x06: /* recalculation in progress */
  758. case 0x07: /* operation in progress */
  759. case 0x08: /* Long write in progress */
  760. case 0x09: /* self test in progress */
  761. case 0x14: /* space allocation in progress */
  762. action = ACTION_DELAYED_RETRY;
  763. break;
  764. default:
  765. description = "Device not ready";
  766. action = ACTION_FAIL;
  767. break;
  768. }
  769. } else {
  770. description = "Device not ready";
  771. action = ACTION_FAIL;
  772. }
  773. break;
  774. case VOLUME_OVERFLOW:
  775. /* See SSC3rXX or current. */
  776. action = ACTION_FAIL;
  777. break;
  778. default:
  779. description = "Unhandled sense code";
  780. action = ACTION_FAIL;
  781. break;
  782. }
  783. } else {
  784. description = "Unhandled error code";
  785. action = ACTION_FAIL;
  786. }
  787. switch (action) {
  788. case ACTION_FAIL:
  789. /* Give up and fail the remainder of the request */
  790. scsi_release_buffers(cmd);
  791. if (!(req->cmd_flags & REQ_QUIET)) {
  792. if (description)
  793. scmd_printk(KERN_INFO, cmd, "%s\n",
  794. description);
  795. scsi_print_result(cmd);
  796. if (driver_byte(result) & DRIVER_SENSE)
  797. scsi_print_sense("", cmd);
  798. scsi_print_command(cmd);
  799. }
  800. if (blk_end_request_err(req, error))
  801. scsi_requeue_command(q, cmd);
  802. else
  803. scsi_next_command(cmd);
  804. break;
  805. case ACTION_REPREP:
  806. /* Unprep the request and put it back at the head of the queue.
  807. * A new command will be prepared and issued.
  808. */
  809. scsi_release_buffers(cmd);
  810. scsi_requeue_command(q, cmd);
  811. break;
  812. case ACTION_RETRY:
  813. /* Retry the same command immediately */
  814. __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, 0);
  815. break;
  816. case ACTION_DELAYED_RETRY:
  817. /* Retry the same command after a delay */
  818. __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, 0);
  819. break;
  820. }
  821. }
  822. static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb,
  823. gfp_t gfp_mask)
  824. {
  825. int count;
  826. /*
  827. * If sg table allocation fails, requeue request later.
  828. */
  829. if (unlikely(scsi_alloc_sgtable(sdb, req->nr_phys_segments,
  830. gfp_mask))) {
  831. return BLKPREP_DEFER;
  832. }
  833. req->buffer = NULL;
  834. /*
  835. * Next, walk the list, and fill in the addresses and sizes of
  836. * each segment.
  837. */
  838. count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
  839. BUG_ON(count > sdb->table.nents);
  840. sdb->table.nents = count;
  841. sdb->length = blk_rq_bytes(req);
  842. return BLKPREP_OK;
  843. }
  844. /*
  845. * Function: scsi_init_io()
  846. *
  847. * Purpose: SCSI I/O initialize function.
  848. *
  849. * Arguments: cmd - Command descriptor we wish to initialize
  850. *
  851. * Returns: 0 on success
  852. * BLKPREP_DEFER if the failure is retryable
  853. * BLKPREP_KILL if the failure is fatal
  854. */
  855. int scsi_init_io(struct scsi_cmnd *cmd, gfp_t gfp_mask)
  856. {
  857. int error = scsi_init_sgtable(cmd->request, &cmd->sdb, gfp_mask);
  858. if (error)
  859. goto err_exit;
  860. if (blk_bidi_rq(cmd->request)) {
  861. struct scsi_data_buffer *bidi_sdb = kmem_cache_zalloc(
  862. scsi_sdb_cache, GFP_ATOMIC);
  863. if (!bidi_sdb) {
  864. error = BLKPREP_DEFER;
  865. goto err_exit;
  866. }
  867. cmd->request->next_rq->special = bidi_sdb;
  868. error = scsi_init_sgtable(cmd->request->next_rq, bidi_sdb,
  869. GFP_ATOMIC);
  870. if (error)
  871. goto err_exit;
  872. }
  873. if (blk_integrity_rq(cmd->request)) {
  874. struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
  875. int ivecs, count;
  876. BUG_ON(prot_sdb == NULL);
  877. ivecs = blk_rq_count_integrity_sg(cmd->request);
  878. if (scsi_alloc_sgtable(prot_sdb, ivecs, gfp_mask)) {
  879. error = BLKPREP_DEFER;
  880. goto err_exit;
  881. }
  882. count = blk_rq_map_integrity_sg(cmd->request,
  883. prot_sdb->table.sgl);
  884. BUG_ON(unlikely(count > ivecs));
  885. cmd->prot_sdb = prot_sdb;
  886. cmd->prot_sdb->table.nents = count;
  887. }
  888. return BLKPREP_OK ;
  889. err_exit:
  890. scsi_release_buffers(cmd);
  891. if (error == BLKPREP_KILL)
  892. scsi_put_command(cmd);
  893. else /* BLKPREP_DEFER */
  894. scsi_unprep_request(cmd->request);
  895. return error;
  896. }
  897. EXPORT_SYMBOL(scsi_init_io);
  898. static struct scsi_cmnd *scsi_get_cmd_from_req(struct scsi_device *sdev,
  899. struct request *req)
  900. {
  901. struct scsi_cmnd *cmd;
  902. if (!req->special) {
  903. cmd = scsi_get_command(sdev, GFP_ATOMIC);
  904. if (unlikely(!cmd))
  905. return NULL;
  906. req->special = cmd;
  907. } else {
  908. cmd = req->special;
  909. }
  910. /* pull a tag out of the request if we have one */
  911. cmd->tag = req->tag;
  912. cmd->request = req;
  913. cmd->cmnd = req->cmd;
  914. return cmd;
  915. }
  916. int scsi_setup_blk_pc_cmnd(struct scsi_device *sdev, struct request *req)
  917. {
  918. struct scsi_cmnd *cmd;
  919. int ret = scsi_prep_state_check(sdev, req);
  920. if (ret != BLKPREP_OK)
  921. return ret;
  922. cmd = scsi_get_cmd_from_req(sdev, req);
  923. if (unlikely(!cmd))
  924. return BLKPREP_DEFER;
  925. /*
  926. * BLOCK_PC requests may transfer data, in which case they must
  927. * a bio attached to them. Or they might contain a SCSI command
  928. * that does not transfer data, in which case they may optionally
  929. * submit a request without an attached bio.
  930. */
  931. if (req->bio) {
  932. int ret;
  933. BUG_ON(!req->nr_phys_segments);
  934. ret = scsi_init_io(cmd, GFP_ATOMIC);
  935. if (unlikely(ret))
  936. return ret;
  937. } else {
  938. BUG_ON(blk_rq_bytes(req));
  939. memset(&cmd->sdb, 0, sizeof(cmd->sdb));
  940. req->buffer = NULL;
  941. }
  942. cmd->cmd_len = req->cmd_len;
  943. if (!blk_rq_bytes(req))
  944. cmd->sc_data_direction = DMA_NONE;
  945. else if (rq_data_dir(req) == WRITE)
  946. cmd->sc_data_direction = DMA_TO_DEVICE;
  947. else
  948. cmd->sc_data_direction = DMA_FROM_DEVICE;
  949. cmd->transfersize = blk_rq_bytes(req);
  950. cmd->allowed = req->retries;
  951. return BLKPREP_OK;
  952. }
  953. EXPORT_SYMBOL(scsi_setup_blk_pc_cmnd);
  954. /*
  955. * Setup a REQ_TYPE_FS command. These are simple read/write request
  956. * from filesystems that still need to be translated to SCSI CDBs from
  957. * the ULD.
  958. */
  959. int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
  960. {
  961. struct scsi_cmnd *cmd;
  962. int ret = scsi_prep_state_check(sdev, req);
  963. if (ret != BLKPREP_OK)
  964. return ret;
  965. if (unlikely(sdev->scsi_dh_data && sdev->scsi_dh_data->scsi_dh
  966. && sdev->scsi_dh_data->scsi_dh->prep_fn)) {
  967. ret = sdev->scsi_dh_data->scsi_dh->prep_fn(sdev, req);
  968. if (ret != BLKPREP_OK)
  969. return ret;
  970. }
  971. /*
  972. * Filesystem requests must transfer data.
  973. */
  974. BUG_ON(!req->nr_phys_segments);
  975. cmd = scsi_get_cmd_from_req(sdev, req);
  976. if (unlikely(!cmd))
  977. return BLKPREP_DEFER;
  978. memset(cmd->cmnd, 0, BLK_MAX_CDB);
  979. return scsi_init_io(cmd, GFP_ATOMIC);
  980. }
  981. EXPORT_SYMBOL(scsi_setup_fs_cmnd);
  982. int scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
  983. {
  984. int ret = BLKPREP_OK;
  985. /*
  986. * If the device is not in running state we will reject some
  987. * or all commands.
  988. */
  989. if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
  990. switch (sdev->sdev_state) {
  991. case SDEV_OFFLINE:
  992. /*
  993. * If the device is offline we refuse to process any
  994. * commands. The device must be brought online
  995. * before trying any recovery commands.
  996. */
  997. sdev_printk(KERN_ERR, sdev,
  998. "rejecting I/O to offline device\n");
  999. ret = BLKPREP_KILL;
  1000. break;
  1001. case SDEV_DEL:
  1002. /*
  1003. * If the device is fully deleted, we refuse to
  1004. * process any commands as well.
  1005. */
  1006. sdev_printk(KERN_ERR, sdev,
  1007. "rejecting I/O to dead device\n");
  1008. ret = BLKPREP_KILL;
  1009. break;
  1010. case SDEV_QUIESCE:
  1011. case SDEV_BLOCK:
  1012. case SDEV_CREATED_BLOCK:
  1013. /*
  1014. * If the devices is blocked we defer normal commands.
  1015. */
  1016. if (!(req->cmd_flags & REQ_PREEMPT))
  1017. ret = BLKPREP_DEFER;
  1018. break;
  1019. default:
  1020. /*
  1021. * For any other not fully online state we only allow
  1022. * special commands. In particular any user initiated
  1023. * command is not allowed.
  1024. */
  1025. if (!(req->cmd_flags & REQ_PREEMPT))
  1026. ret = BLKPREP_KILL;
  1027. break;
  1028. }
  1029. }
  1030. return ret;
  1031. }
  1032. EXPORT_SYMBOL(scsi_prep_state_check);
  1033. int scsi_prep_return(struct request_queue *q, struct request *req, int ret)
  1034. {
  1035. struct scsi_device *sdev = q->queuedata;
  1036. switch (ret) {
  1037. case BLKPREP_KILL:
  1038. req->errors = DID_NO_CONNECT << 16;
  1039. /* release the command and kill it */
  1040. if (req->special) {
  1041. struct scsi_cmnd *cmd = req->special;
  1042. scsi_release_buffers(cmd);
  1043. scsi_put_command(cmd);
  1044. req->special = NULL;
  1045. }
  1046. break;
  1047. case BLKPREP_DEFER:
  1048. /*
  1049. * If we defer, the blk_peek_request() returns NULL, but the
  1050. * queue must be restarted, so we plug here if no returning
  1051. * command will automatically do that.
  1052. */
  1053. if (sdev->device_busy == 0)
  1054. blk_plug_device(q);
  1055. break;
  1056. default:
  1057. req->cmd_flags |= REQ_DONTPREP;
  1058. }
  1059. return ret;
  1060. }
  1061. EXPORT_SYMBOL(scsi_prep_return);
  1062. int scsi_prep_fn(struct request_queue *q, struct request *req)
  1063. {
  1064. struct scsi_device *sdev = q->queuedata;
  1065. int ret = BLKPREP_KILL;
  1066. if (req->cmd_type == REQ_TYPE_BLOCK_PC)
  1067. ret = scsi_setup_blk_pc_cmnd(sdev, req);
  1068. return scsi_prep_return(q, req, ret);
  1069. }
  1070. EXPORT_SYMBOL(scsi_prep_fn);
  1071. /*
  1072. * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
  1073. * return 0.
  1074. *
  1075. * Called with the queue_lock held.
  1076. */
  1077. static inline int scsi_dev_queue_ready(struct request_queue *q,
  1078. struct scsi_device *sdev)
  1079. {
  1080. if (sdev->device_busy == 0 && sdev->device_blocked) {
  1081. /*
  1082. * unblock after device_blocked iterates to zero
  1083. */
  1084. if (--sdev->device_blocked == 0) {
  1085. SCSI_LOG_MLQUEUE(3,
  1086. sdev_printk(KERN_INFO, sdev,
  1087. "unblocking device at zero depth\n"));
  1088. } else {
  1089. blk_plug_device(q);
  1090. return 0;
  1091. }
  1092. }
  1093. if (scsi_device_is_busy(sdev))
  1094. return 0;
  1095. return 1;
  1096. }
  1097. /*
  1098. * scsi_target_queue_ready: checks if there we can send commands to target
  1099. * @sdev: scsi device on starget to check.
  1100. *
  1101. * Called with the host lock held.
  1102. */
  1103. static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
  1104. struct scsi_device *sdev)
  1105. {
  1106. struct scsi_target *starget = scsi_target(sdev);
  1107. if (starget->single_lun) {
  1108. if (starget->starget_sdev_user &&
  1109. starget->starget_sdev_user != sdev)
  1110. return 0;
  1111. starget->starget_sdev_user = sdev;
  1112. }
  1113. if (starget->target_busy == 0 && starget->target_blocked) {
  1114. /*
  1115. * unblock after target_blocked iterates to zero
  1116. */
  1117. if (--starget->target_blocked == 0) {
  1118. SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
  1119. "unblocking target at zero depth\n"));
  1120. } else
  1121. return 0;
  1122. }
  1123. if (scsi_target_is_busy(starget)) {
  1124. if (list_empty(&sdev->starved_entry)) {
  1125. list_add_tail(&sdev->starved_entry,
  1126. &shost->starved_list);
  1127. return 0;
  1128. }
  1129. }
  1130. /* We're OK to process the command, so we can't be starved */
  1131. if (!list_empty(&sdev->starved_entry))
  1132. list_del_init(&sdev->starved_entry);
  1133. return 1;
  1134. }
  1135. /*
  1136. * scsi_host_queue_ready: if we can send requests to shost, return 1 else
  1137. * return 0. We must end up running the queue again whenever 0 is
  1138. * returned, else IO can hang.
  1139. *
  1140. * Called with host_lock held.
  1141. */
  1142. static inline int scsi_host_queue_ready(struct request_queue *q,
  1143. struct Scsi_Host *shost,
  1144. struct scsi_device *sdev)
  1145. {
  1146. if (scsi_host_in_recovery(shost))
  1147. return 0;
  1148. if (shost->host_busy == 0 && shost->host_blocked) {
  1149. /*
  1150. * unblock after host_blocked iterates to zero
  1151. */
  1152. if (--shost->host_blocked == 0) {
  1153. SCSI_LOG_MLQUEUE(3,
  1154. printk("scsi%d unblocking host at zero depth\n",
  1155. shost->host_no));
  1156. } else {
  1157. return 0;
  1158. }
  1159. }
  1160. if (scsi_host_is_busy(shost)) {
  1161. if (list_empty(&sdev->starved_entry))
  1162. list_add_tail(&sdev->starved_entry, &shost->starved_list);
  1163. return 0;
  1164. }
  1165. /* We're OK to process the command, so we can't be starved */
  1166. if (!list_empty(&sdev->starved_entry))
  1167. list_del_init(&sdev->starved_entry);
  1168. return 1;
  1169. }
  1170. /*
  1171. * Busy state exporting function for request stacking drivers.
  1172. *
  1173. * For efficiency, no lock is taken to check the busy state of
  1174. * shost/starget/sdev, since the returned value is not guaranteed and
  1175. * may be changed after request stacking drivers call the function,
  1176. * regardless of taking lock or not.
  1177. *
  1178. * When scsi can't dispatch I/Os anymore and needs to kill I/Os
  1179. * (e.g. !sdev), scsi needs to return 'not busy'.
  1180. * Otherwise, request stacking drivers may hold requests forever.
  1181. */
  1182. static int scsi_lld_busy(struct request_queue *q)
  1183. {
  1184. struct scsi_device *sdev = q->queuedata;
  1185. struct Scsi_Host *shost;
  1186. struct scsi_target *starget;
  1187. if (!sdev)
  1188. return 0;
  1189. shost = sdev->host;
  1190. starget = scsi_target(sdev);
  1191. if (scsi_host_in_recovery(shost) || scsi_host_is_busy(shost) ||
  1192. scsi_target_is_busy(starget) || scsi_device_is_busy(sdev))
  1193. return 1;
  1194. return 0;
  1195. }
  1196. /*
  1197. * Kill a request for a dead device
  1198. */
  1199. static void scsi_kill_request(struct request *req, struct request_queue *q)
  1200. {
  1201. struct scsi_cmnd *cmd = req->special;
  1202. struct scsi_device *sdev;
  1203. struct scsi_target *starget;
  1204. struct Scsi_Host *shost;
  1205. blk_start_request(req);
  1206. if (unlikely(cmd == NULL)) {
  1207. printk(KERN_CRIT "impossible request in %s.\n",
  1208. __func__);
  1209. BUG();
  1210. }
  1211. sdev = cmd->device;
  1212. starget = scsi_target(sdev);
  1213. shost = sdev->host;
  1214. scsi_init_cmd_errh(cmd);
  1215. cmd->result = DID_NO_CONNECT << 16;
  1216. atomic_inc(&cmd->device->iorequest_cnt);
  1217. /*
  1218. * SCSI request completion path will do scsi_device_unbusy(),
  1219. * bump busy counts. To bump the counters, we need to dance
  1220. * with the locks as normal issue path does.
  1221. */
  1222. sdev->device_busy++;
  1223. spin_unlock(sdev->request_queue->queue_lock);
  1224. spin_lock(shost->host_lock);
  1225. shost->host_busy++;
  1226. starget->target_busy++;
  1227. spin_unlock(shost->host_lock);
  1228. spin_lock(sdev->request_queue->queue_lock);
  1229. blk_complete_request(req);
  1230. }
  1231. static void scsi_softirq_done(struct request *rq)
  1232. {
  1233. struct scsi_cmnd *cmd = rq->special;
  1234. unsigned long wait_for = (cmd->allowed + 1) * rq->timeout;
  1235. int disposition;
  1236. INIT_LIST_HEAD(&cmd->eh_entry);
  1237. /*
  1238. * Set the serial numbers back to zero
  1239. */
  1240. cmd->serial_number = 0;
  1241. atomic_inc(&cmd->device->iodone_cnt);
  1242. if (cmd->result)
  1243. atomic_inc(&cmd->device->ioerr_cnt);
  1244. disposition = scsi_decide_disposition(cmd);
  1245. if (disposition != SUCCESS &&
  1246. time_before(cmd->jiffies_at_alloc + wait_for, jiffies)) {
  1247. sdev_printk(KERN_ERR, cmd->device,
  1248. "timing out command, waited %lus\n",
  1249. wait_for/HZ);
  1250. disposition = SUCCESS;
  1251. }
  1252. scsi_log_completion(cmd, disposition);
  1253. switch (disposition) {
  1254. case SUCCESS:
  1255. scsi_finish_command(cmd);
  1256. break;
  1257. case NEEDS_RETRY:
  1258. scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY);
  1259. break;
  1260. case ADD_TO_MLQUEUE:
  1261. scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
  1262. break;
  1263. default:
  1264. if (!scsi_eh_scmd_add(cmd, 0))
  1265. scsi_finish_command(cmd);
  1266. }
  1267. }
  1268. /*
  1269. * Function: scsi_request_fn()
  1270. *
  1271. * Purpose: Main strategy routine for SCSI.
  1272. *
  1273. * Arguments: q - Pointer to actual queue.
  1274. *
  1275. * Returns: Nothing
  1276. *
  1277. * Lock status: IO request lock assumed to be held when called.
  1278. */
  1279. static void scsi_request_fn(struct request_queue *q)
  1280. {
  1281. struct scsi_device *sdev = q->queuedata;
  1282. struct Scsi_Host *shost;
  1283. struct scsi_cmnd *cmd;
  1284. struct request *req;
  1285. if (!sdev) {
  1286. printk("scsi: killing requests for dead queue\n");
  1287. while ((req = blk_peek_request(q)) != NULL)
  1288. scsi_kill_request(req, q);
  1289. return;
  1290. }
  1291. if(!get_device(&sdev->sdev_gendev))
  1292. /* We must be tearing the block queue down already */
  1293. return;
  1294. /*
  1295. * To start with, we keep looping until the queue is empty, or until
  1296. * the host is no longer able to accept any more requests.
  1297. */
  1298. shost = sdev->host;
  1299. while (!blk_queue_plugged(q)) {
  1300. int rtn;
  1301. /*
  1302. * get next queueable request. We do this early to make sure
  1303. * that the request is fully prepared even if we cannot
  1304. * accept it.
  1305. */
  1306. req = blk_peek_request(q);
  1307. if (!req || !scsi_dev_queue_ready(q, sdev))
  1308. break;
  1309. if (unlikely(!scsi_device_online(sdev))) {
  1310. sdev_printk(KERN_ERR, sdev,
  1311. "rejecting I/O to offline device\n");
  1312. scsi_kill_request(req, q);
  1313. continue;
  1314. }
  1315. /*
  1316. * Remove the request from the request list.
  1317. */
  1318. if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
  1319. blk_start_request(req);
  1320. sdev->device_busy++;
  1321. spin_unlock(q->queue_lock);
  1322. cmd = req->special;
  1323. if (unlikely(cmd == NULL)) {
  1324. printk(KERN_CRIT "impossible request in %s.\n"
  1325. "please mail a stack trace to "
  1326. "linux-scsi@vger.kernel.org\n",
  1327. __func__);
  1328. blk_dump_rq_flags(req, "foo");
  1329. BUG();
  1330. }
  1331. spin_lock(shost->host_lock);
  1332. /*
  1333. * We hit this when the driver is using a host wide
  1334. * tag map. For device level tag maps the queue_depth check
  1335. * in the device ready fn would prevent us from trying
  1336. * to allocate a tag. Since the map is a shared host resource
  1337. * we add the dev to the starved list so it eventually gets
  1338. * a run when a tag is freed.
  1339. */
  1340. if (blk_queue_tagged(q) && !blk_rq_tagged(req)) {
  1341. if (list_empty(&sdev->starved_entry))
  1342. list_add_tail(&sdev->starved_entry,
  1343. &shost->starved_list);
  1344. goto not_ready;
  1345. }
  1346. if (!scsi_target_queue_ready(shost, sdev))
  1347. goto not_ready;
  1348. if (!scsi_host_queue_ready(q, shost, sdev))
  1349. goto not_ready;
  1350. scsi_target(sdev)->target_busy++;
  1351. shost->host_busy++;
  1352. /*
  1353. * XXX(hch): This is rather suboptimal, scsi_dispatch_cmd will
  1354. * take the lock again.
  1355. */
  1356. spin_unlock_irq(shost->host_lock);
  1357. /*
  1358. * Finally, initialize any error handling parameters, and set up
  1359. * the timers for timeouts.
  1360. */
  1361. scsi_init_cmd_errh(cmd);
  1362. /*
  1363. * Dispatch the command to the low-level driver.
  1364. */
  1365. rtn = scsi_dispatch_cmd(cmd);
  1366. spin_lock_irq(q->queue_lock);
  1367. if(rtn) {
  1368. /* we're refusing the command; because of
  1369. * the way locks get dropped, we need to
  1370. * check here if plugging is required */
  1371. if(sdev->device_busy == 0)
  1372. blk_plug_device(q);
  1373. break;
  1374. }
  1375. }
  1376. goto out;
  1377. not_ready:
  1378. spin_unlock_irq(shost->host_lock);
  1379. /*
  1380. * lock q, handle tag, requeue req, and decrement device_busy. We
  1381. * must return with queue_lock held.
  1382. *
  1383. * Decrementing device_busy without checking it is OK, as all such
  1384. * cases (host limits or settings) should run the queue at some
  1385. * later time.
  1386. */
  1387. spin_lock_irq(q->queue_lock);
  1388. blk_requeue_request(q, req);
  1389. sdev->device_busy--;
  1390. if(sdev->device_busy == 0)
  1391. blk_plug_device(q);
  1392. out:
  1393. /* must be careful here...if we trigger the ->remove() function
  1394. * we cannot be holding the q lock */
  1395. spin_unlock_irq(q->queue_lock);
  1396. put_device(&sdev->sdev_gendev);
  1397. spin_lock_irq(q->queue_lock);
  1398. }
  1399. u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
  1400. {
  1401. struct device *host_dev;
  1402. u64 bounce_limit = 0xffffffff;
  1403. if (shost->unchecked_isa_dma)
  1404. return BLK_BOUNCE_ISA;
  1405. /*
  1406. * Platforms with virtual-DMA translation
  1407. * hardware have no practical limit.
  1408. */
  1409. if (!PCI_DMA_BUS_IS_PHYS)
  1410. return BLK_BOUNCE_ANY;
  1411. host_dev = scsi_get_device(shost);
  1412. if (host_dev && host_dev->dma_mask)
  1413. bounce_limit = *host_dev->dma_mask;
  1414. return bounce_limit;
  1415. }
  1416. EXPORT_SYMBOL(scsi_calculate_bounce_limit);
  1417. struct request_queue *__scsi_alloc_queue(struct Scsi_Host *shost,
  1418. request_fn_proc *request_fn)
  1419. {
  1420. struct request_queue *q;
  1421. struct device *dev = shost->shost_gendev.parent;
  1422. q = blk_init_queue(request_fn, NULL);
  1423. if (!q)
  1424. return NULL;
  1425. /*
  1426. * this limit is imposed by hardware restrictions
  1427. */
  1428. blk_queue_max_hw_segments(q, shost->sg_tablesize);
  1429. blk_queue_max_phys_segments(q, SCSI_MAX_SG_CHAIN_SEGMENTS);
  1430. blk_queue_max_sectors(q, shost->max_sectors);
  1431. blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
  1432. blk_queue_segment_boundary(q, shost->dma_boundary);
  1433. dma_set_seg_boundary(dev, shost->dma_boundary);
  1434. blk_queue_max_segment_size(q, dma_get_max_seg_size(dev));
  1435. /* New queue, no concurrency on queue_flags */
  1436. if (!shost->use_clustering)
  1437. queue_flag_clear_unlocked(QUEUE_FLAG_CLUSTER, q);
  1438. /*
  1439. * set a reasonable default alignment on word boundaries: the
  1440. * host and device may alter it using
  1441. * blk_queue_update_dma_alignment() later.
  1442. */
  1443. blk_queue_dma_alignment(q, 0x03);
  1444. return q;
  1445. }
  1446. EXPORT_SYMBOL(__scsi_alloc_queue);
  1447. struct request_queue *scsi_alloc_queue(struct scsi_device *sdev)
  1448. {
  1449. struct request_queue *q;
  1450. q = __scsi_alloc_queue(sdev->host, scsi_request_fn);
  1451. if (!q)
  1452. return NULL;
  1453. blk_queue_prep_rq(q, scsi_prep_fn);
  1454. blk_queue_softirq_done(q, scsi_softirq_done);
  1455. blk_queue_rq_timed_out(q, scsi_times_out);
  1456. blk_queue_lld_busy(q, scsi_lld_busy);
  1457. return q;
  1458. }
  1459. void scsi_free_queue(struct request_queue *q)
  1460. {
  1461. blk_cleanup_queue(q);
  1462. }
  1463. /*
  1464. * Function: scsi_block_requests()
  1465. *
  1466. * Purpose: Utility function used by low-level drivers to prevent further
  1467. * commands from being queued to the device.
  1468. *
  1469. * Arguments: shost - Host in question
  1470. *
  1471. * Returns: Nothing
  1472. *
  1473. * Lock status: No locks are assumed held.
  1474. *
  1475. * Notes: There is no timer nor any other means by which the requests
  1476. * get unblocked other than the low-level driver calling
  1477. * scsi_unblock_requests().
  1478. */
  1479. void scsi_block_requests(struct Scsi_Host *shost)
  1480. {
  1481. shost->host_self_blocked = 1;
  1482. }
  1483. EXPORT_SYMBOL(scsi_block_requests);
  1484. /*
  1485. * Function: scsi_unblock_requests()
  1486. *
  1487. * Purpose: Utility function used by low-level drivers to allow further
  1488. * commands from being queued to the device.
  1489. *
  1490. * Arguments: shost - Host in question
  1491. *
  1492. * Returns: Nothing
  1493. *
  1494. * Lock status: No locks are assumed held.
  1495. *
  1496. * Notes: There is no timer nor any other means by which the requests
  1497. * get unblocked other than the low-level driver calling
  1498. * scsi_unblock_requests().
  1499. *
  1500. * This is done as an API function so that changes to the
  1501. * internals of the scsi mid-layer won't require wholesale
  1502. * changes to drivers that use this feature.
  1503. */
  1504. void scsi_unblock_requests(struct Scsi_Host *shost)
  1505. {
  1506. shost->host_self_blocked = 0;
  1507. scsi_run_host_queues(shost);
  1508. }
  1509. EXPORT_SYMBOL(scsi_unblock_requests);
  1510. int __init scsi_init_queue(void)
  1511. {
  1512. int i;
  1513. scsi_sdb_cache = kmem_cache_create("scsi_data_buffer",
  1514. sizeof(struct scsi_data_buffer),
  1515. 0, 0, NULL);
  1516. if (!scsi_sdb_cache) {
  1517. printk(KERN_ERR "SCSI: can't init scsi sdb cache\n");
  1518. return -ENOMEM;
  1519. }
  1520. for (i = 0; i < SG_MEMPOOL_NR; i++) {
  1521. struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
  1522. int size = sgp->size * sizeof(struct scatterlist);
  1523. sgp->slab = kmem_cache_create(sgp->name, size, 0,
  1524. SLAB_HWCACHE_ALIGN, NULL);
  1525. if (!sgp->slab) {
  1526. printk(KERN_ERR "SCSI: can't init sg slab %s\n",
  1527. sgp->name);
  1528. goto cleanup_sdb;
  1529. }
  1530. sgp->pool = mempool_create_slab_pool(SG_MEMPOOL_SIZE,
  1531. sgp->slab);
  1532. if (!sgp->pool) {
  1533. printk(KERN_ERR "SCSI: can't init sg mempool %s\n",
  1534. sgp->name);
  1535. goto cleanup_sdb;
  1536. }
  1537. }
  1538. return 0;
  1539. cleanup_sdb:
  1540. for (i = 0; i < SG_MEMPOOL_NR; i++) {
  1541. struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
  1542. if (sgp->pool)
  1543. mempool_destroy(sgp->pool);
  1544. if (sgp->slab)
  1545. kmem_cache_destroy(sgp->slab);
  1546. }
  1547. kmem_cache_destroy(scsi_sdb_cache);
  1548. return -ENOMEM;
  1549. }
  1550. void scsi_exit_queue(void)
  1551. {
  1552. int i;
  1553. kmem_cache_destroy(scsi_sdb_cache);
  1554. for (i = 0; i < SG_MEMPOOL_NR; i++) {
  1555. struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
  1556. mempool_destroy(sgp->pool);
  1557. kmem_cache_destroy(sgp->slab);
  1558. }
  1559. }
  1560. /**
  1561. * scsi_mode_select - issue a mode select
  1562. * @sdev: SCSI device to be queried
  1563. * @pf: Page format bit (1 == standard, 0 == vendor specific)
  1564. * @sp: Save page bit (0 == don't save, 1 == save)
  1565. * @modepage: mode page being requested
  1566. * @buffer: request buffer (may not be smaller than eight bytes)
  1567. * @len: length of request buffer.
  1568. * @timeout: command timeout
  1569. * @retries: number of retries before failing
  1570. * @data: returns a structure abstracting the mode header data
  1571. * @sshdr: place to put sense data (or NULL if no sense to be collected).
  1572. * must be SCSI_SENSE_BUFFERSIZE big.
  1573. *
  1574. * Returns zero if successful; negative error number or scsi
  1575. * status on error
  1576. *
  1577. */
  1578. int
  1579. scsi_mode_select(struct scsi_device *sdev, int pf, int sp, int modepage,
  1580. unsigned char *buffer, int len, int timeout, int retries,
  1581. struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
  1582. {
  1583. unsigned char cmd[10];
  1584. unsigned char *real_buffer;
  1585. int ret;
  1586. memset(cmd, 0, sizeof(cmd));
  1587. cmd[1] = (pf ? 0x10 : 0) | (sp ? 0x01 : 0);
  1588. if (sdev->use_10_for_ms) {
  1589. if (len > 65535)
  1590. return -EINVAL;
  1591. real_buffer = kmalloc(8 + len, GFP_KERNEL);
  1592. if (!real_buffer)
  1593. return -ENOMEM;
  1594. memcpy(real_buffer + 8, buffer, len);
  1595. len += 8;
  1596. real_buffer[0] = 0;
  1597. real_buffer[1] = 0;
  1598. real_buffer[2] = data->medium_type;
  1599. real_buffer[3] = data->device_specific;
  1600. real_buffer[4] = data->longlba ? 0x01 : 0;
  1601. real_buffer[5] = 0;
  1602. real_buffer[6] = data->block_descriptor_length >> 8;
  1603. real_buffer[7] = data->block_descriptor_length;
  1604. cmd[0] = MODE_SELECT_10;
  1605. cmd[7] = len >> 8;
  1606. cmd[8] = len;
  1607. } else {
  1608. if (len > 255 || data->block_descriptor_length > 255 ||
  1609. data->longlba)
  1610. return -EINVAL;
  1611. real_buffer = kmalloc(4 + len, GFP_KERNEL);
  1612. if (!real_buffer)
  1613. return -ENOMEM;
  1614. memcpy(real_buffer + 4, buffer, len);
  1615. len += 4;
  1616. real_buffer[0] = 0;
  1617. real_buffer[1] = data->medium_type;
  1618. real_buffer[2] = data->device_specific;
  1619. real_buffer[3] = data->block_descriptor_length;
  1620. cmd[0] = MODE_SELECT;
  1621. cmd[4] = len;
  1622. }
  1623. ret = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, real_buffer, len,
  1624. sshdr, timeout, retries, NULL);
  1625. kfree(real_buffer);
  1626. return ret;
  1627. }
  1628. EXPORT_SYMBOL_GPL(scsi_mode_select);
  1629. /**
  1630. * scsi_mode_sense - issue a mode sense, falling back from 10 to six bytes if necessary.
  1631. * @sdev: SCSI device to be queried
  1632. * @dbd: set if mode sense will allow block descriptors to be returned
  1633. * @modepage: mode page being requested
  1634. * @buffer: request buffer (may not be smaller than eight bytes)
  1635. * @len: length of request buffer.
  1636. * @timeout: command timeout
  1637. * @retries: number of retries before failing
  1638. * @data: returns a structure abstracting the mode header data
  1639. * @sshdr: place to put sense data (or NULL if no sense to be collected).
  1640. * must be SCSI_SENSE_BUFFERSIZE big.
  1641. *
  1642. * Returns zero if unsuccessful, or the header offset (either 4
  1643. * or 8 depending on whether a six or ten byte command was
  1644. * issued) if successful.
  1645. */
  1646. int
  1647. scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
  1648. unsigned char *buffer, int len, int timeout, int retries,
  1649. struct scsi_mode_data *data, struct scsi_sense_hdr *sshdr)
  1650. {
  1651. unsigned char cmd[12];
  1652. int use_10_for_ms;
  1653. int header_length;
  1654. int result;
  1655. struct scsi_sense_hdr my_sshdr;
  1656. memset(data, 0, sizeof(*data));
  1657. memset(&cmd[0], 0, 12);
  1658. cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
  1659. cmd[2] = modepage;
  1660. /* caller might not be interested in sense, but we need it */
  1661. if (!sshdr)
  1662. sshdr = &my_sshdr;
  1663. retry:
  1664. use_10_for_ms = sdev->use_10_for_ms;
  1665. if (use_10_for_ms) {
  1666. if (len < 8)
  1667. len = 8;
  1668. cmd[0] = MODE_SENSE_10;
  1669. cmd[8] = len;
  1670. header_length = 8;
  1671. } else {
  1672. if (len < 4)
  1673. len = 4;
  1674. cmd[0] = MODE_SENSE;
  1675. cmd[4] = len;
  1676. header_length = 4;
  1677. }
  1678. memset(buffer, 0, len);
  1679. result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
  1680. sshdr, timeout, retries, NULL);
  1681. /* This code looks awful: what it's doing is making sure an
  1682. * ILLEGAL REQUEST sense return identifies the actual command
  1683. * byte as the problem. MODE_SENSE commands can return
  1684. * ILLEGAL REQUEST if the code page isn't supported */
  1685. if (use_10_for_ms && !scsi_status_is_good(result) &&
  1686. (driver_byte(result) & DRIVER_SENSE)) {
  1687. if (scsi_sense_valid(sshdr)) {
  1688. if ((sshdr->sense_key == ILLEGAL_REQUEST) &&
  1689. (sshdr->asc == 0x20) && (sshdr->ascq == 0)) {
  1690. /*
  1691. * Invalid command operation code
  1692. */
  1693. sdev->use_10_for_ms = 0;
  1694. goto retry;
  1695. }
  1696. }
  1697. }
  1698. if(scsi_status_is_good(result)) {
  1699. if (unlikely(buffer[0] == 0x86 && buffer[1] == 0x0b &&
  1700. (modepage == 6 || modepage == 8))) {
  1701. /* Initio breakage? */
  1702. header_length = 0;
  1703. data->length = 13;
  1704. data->medium_type = 0;
  1705. data->device_specific = 0;
  1706. data->longlba = 0;
  1707. data->block_descriptor_length = 0;
  1708. } else if(use_10_for_ms) {
  1709. data->length = buffer[0]*256 + buffer[1] + 2;
  1710. data->medium_type = buffer[2];
  1711. data->device_specific = buffer[3];
  1712. data->longlba = buffer[4] & 0x01;
  1713. data->block_descriptor_length = buffer[6]*256
  1714. + buffer[7];
  1715. } else {
  1716. data->length = buffer[0] + 1;
  1717. data->medium_type = buffer[1];
  1718. data->device_specific = buffer[2];
  1719. data->block_descriptor_length = buffer[3];
  1720. }
  1721. data->header_length = header_length;
  1722. }
  1723. return result;
  1724. }
  1725. EXPORT_SYMBOL(scsi_mode_sense);
  1726. /**
  1727. * scsi_test_unit_ready - test if unit is ready
  1728. * @sdev: scsi device to change the state of.
  1729. * @timeout: command timeout
  1730. * @retries: number of retries before failing
  1731. * @sshdr_external: Optional pointer to struct scsi_sense_hdr for
  1732. * returning sense. Make sure that this is cleared before passing
  1733. * in.
  1734. *
  1735. * Returns zero if unsuccessful or an error if TUR failed. For
  1736. * removable media, a return of NOT_READY or UNIT_ATTENTION is
  1737. * translated to success, with the ->changed flag updated.
  1738. **/
  1739. int
  1740. scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries,
  1741. struct scsi_sense_hdr *sshdr_external)
  1742. {
  1743. char cmd[] = {
  1744. TEST_UNIT_READY, 0, 0, 0, 0, 0,
  1745. };
  1746. struct scsi_sense_hdr *sshdr;
  1747. int result;
  1748. if (!sshdr_external)
  1749. sshdr = kzalloc(sizeof(*sshdr), GFP_KERNEL);
  1750. else
  1751. sshdr = sshdr_external;
  1752. /* try to eat the UNIT_ATTENTION if there are enough retries */
  1753. do {
  1754. result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0, sshdr,
  1755. timeout, retries, NULL);
  1756. if (sdev->removable && scsi_sense_valid(sshdr) &&
  1757. sshdr->sense_key == UNIT_ATTENTION)
  1758. sdev->changed = 1;
  1759. } while (scsi_sense_valid(sshdr) &&
  1760. sshdr->sense_key == UNIT_ATTENTION && --retries);
  1761. if (!sshdr)
  1762. /* could not allocate sense buffer, so can't process it */
  1763. return result;
  1764. if (sdev->removable && scsi_sense_valid(sshdr) &&
  1765. (sshdr->sense_key == UNIT_ATTENTION ||
  1766. sshdr->sense_key == NOT_READY)) {
  1767. sdev->changed = 1;
  1768. result = 0;
  1769. }
  1770. if (!sshdr_external)
  1771. kfree(sshdr);
  1772. return result;
  1773. }
  1774. EXPORT_SYMBOL(scsi_test_unit_ready);
  1775. /**
  1776. * scsi_device_set_state - Take the given device through the device state model.
  1777. * @sdev: scsi device to change the state of.
  1778. * @state: state to change to.
  1779. *
  1780. * Returns zero if unsuccessful or an error if the requested
  1781. * transition is illegal.
  1782. */
  1783. int
  1784. scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
  1785. {
  1786. enum scsi_device_state oldstate = sdev->sdev_state;
  1787. if (state == oldstate)
  1788. return 0;
  1789. switch (state) {
  1790. case SDEV_CREATED:
  1791. switch (oldstate) {
  1792. case SDEV_CREATED_BLOCK:
  1793. break;
  1794. default:
  1795. goto illegal;
  1796. }
  1797. break;
  1798. case SDEV_RUNNING:
  1799. switch (oldstate) {
  1800. case SDEV_CREATED:
  1801. case SDEV_OFFLINE:
  1802. case SDEV_QUIESCE:
  1803. case SDEV_BLOCK:
  1804. break;
  1805. default:
  1806. goto illegal;
  1807. }
  1808. break;
  1809. case SDEV_QUIESCE:
  1810. switch (oldstate) {
  1811. case SDEV_RUNNING:
  1812. case SDEV_OFFLINE:
  1813. break;
  1814. default:
  1815. goto illegal;
  1816. }
  1817. break;
  1818. case SDEV_OFFLINE:
  1819. switch (oldstate) {
  1820. case SDEV_CREATED:
  1821. case SDEV_RUNNING:
  1822. case SDEV_QUIESCE:
  1823. case SDEV_BLOCK:
  1824. break;
  1825. default:
  1826. goto illegal;
  1827. }
  1828. break;
  1829. case SDEV_BLOCK:
  1830. switch (oldstate) {
  1831. case SDEV_RUNNING:
  1832. case SDEV_CREATED_BLOCK:
  1833. break;
  1834. default:
  1835. goto illegal;
  1836. }
  1837. break;
  1838. case SDEV_CREATED_BLOCK:
  1839. switch (oldstate) {
  1840. case SDEV_CREATED:
  1841. break;
  1842. default:
  1843. goto illegal;
  1844. }
  1845. break;
  1846. case SDEV_CANCEL:
  1847. switch (oldstate) {
  1848. case SDEV_CREATED:
  1849. case SDEV_RUNNING:
  1850. case SDEV_QUIESCE:
  1851. case SDEV_OFFLINE:
  1852. case SDEV_BLOCK:
  1853. break;
  1854. default:
  1855. goto illegal;
  1856. }
  1857. break;
  1858. case SDEV_DEL:
  1859. switch (oldstate) {
  1860. case SDEV_CREATED:
  1861. case SDEV_RUNNING:
  1862. case SDEV_OFFLINE:
  1863. case SDEV_CANCEL:
  1864. break;
  1865. default:
  1866. goto illegal;
  1867. }
  1868. break;
  1869. }
  1870. sdev->sdev_state = state;
  1871. return 0;
  1872. illegal:
  1873. SCSI_LOG_ERROR_RECOVERY(1,
  1874. sdev_printk(KERN_ERR, sdev,
  1875. "Illegal state transition %s->%s\n",
  1876. scsi_device_state_name(oldstate),
  1877. scsi_device_state_name(state))
  1878. );
  1879. return -EINVAL;
  1880. }
  1881. EXPORT_SYMBOL(scsi_device_set_state);
  1882. /**
  1883. * sdev_evt_emit - emit a single SCSI device uevent
  1884. * @sdev: associated SCSI device
  1885. * @evt: event to emit
  1886. *
  1887. * Send a single uevent (scsi_event) to the associated scsi_device.
  1888. */
  1889. static void scsi_evt_emit(struct scsi_device *sdev, struct scsi_event *evt)
  1890. {
  1891. int idx = 0;
  1892. char *envp[3];
  1893. switch (evt->evt_type) {
  1894. case SDEV_EVT_MEDIA_CHANGE:
  1895. envp[idx++] = "SDEV_MEDIA_CHANGE=1";
  1896. break;
  1897. default:
  1898. /* do nothing */
  1899. break;
  1900. }
  1901. envp[idx++] = NULL;
  1902. kobject_uevent_env(&sdev->sdev_gendev.kobj, KOBJ_CHANGE, envp);
  1903. }
  1904. /**
  1905. * sdev_evt_thread - send a uevent for each scsi event
  1906. * @work: work struct for scsi_device
  1907. *
  1908. * Dispatch queued events to their associated scsi_device kobjects
  1909. * as uevents.
  1910. */
  1911. void scsi_evt_thread(struct work_struct *work)
  1912. {
  1913. struct scsi_device *sdev;
  1914. LIST_HEAD(event_list);
  1915. sdev = container_of(work, struct scsi_device, event_work);
  1916. while (1) {
  1917. struct scsi_event *evt;
  1918. struct list_head *this, *tmp;
  1919. unsigned long flags;
  1920. spin_lock_irqsave(&sdev->list_lock, flags);
  1921. list_splice_init(&sdev->event_list, &event_list);
  1922. spin_unlock_irqrestore(&sdev->list_lock, flags);
  1923. if (list_empty(&event_list))
  1924. break;
  1925. list_for_each_safe(this, tmp, &event_list) {
  1926. evt = list_entry(this, struct scsi_event, node);
  1927. list_del(&evt->node);
  1928. scsi_evt_emit(sdev, evt);
  1929. kfree(evt);
  1930. }
  1931. }
  1932. }
  1933. /**
  1934. * sdev_evt_send - send asserted event to uevent thread
  1935. * @sdev: scsi_device event occurred on
  1936. * @evt: event to send
  1937. *
  1938. * Assert scsi device event asynchronously.
  1939. */
  1940. void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt)
  1941. {
  1942. unsigned long flags;
  1943. #if 0
  1944. /* FIXME: currently this check eliminates all media change events
  1945. * for polled devices. Need to update to discriminate between AN
  1946. * and polled events */
  1947. if (!test_bit(evt->evt_type, sdev->supported_events)) {
  1948. kfree(evt);
  1949. return;
  1950. }
  1951. #endif
  1952. spin_lock_irqsave(&sdev->list_lock, flags);
  1953. list_add_tail(&evt->node, &sdev->event_list);
  1954. schedule_work(&sdev->event_work);
  1955. spin_unlock_irqrestore(&sdev->list_lock, flags);
  1956. }
  1957. EXPORT_SYMBOL_GPL(sdev_evt_send);
  1958. /**
  1959. * sdev_evt_alloc - allocate a new scsi event
  1960. * @evt_type: type of event to allocate
  1961. * @gfpflags: GFP flags for allocation
  1962. *
  1963. * Allocates and returns a new scsi_event.
  1964. */
  1965. struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
  1966. gfp_t gfpflags)
  1967. {
  1968. struct scsi_event *evt = kzalloc(sizeof(struct scsi_event), gfpflags);
  1969. if (!evt)
  1970. return NULL;
  1971. evt->evt_type = evt_type;
  1972. INIT_LIST_HEAD(&evt->node);
  1973. /* evt_type-specific initialization, if any */
  1974. switch (evt_type) {
  1975. case SDEV_EVT_MEDIA_CHANGE:
  1976. default:
  1977. /* do nothing */
  1978. break;
  1979. }
  1980. return evt;
  1981. }
  1982. EXPORT_SYMBOL_GPL(sdev_evt_alloc);
  1983. /**
  1984. * sdev_evt_send_simple - send asserted event to uevent thread
  1985. * @sdev: scsi_device event occurred on
  1986. * @evt_type: type of event to send
  1987. * @gfpflags: GFP flags for allocation
  1988. *
  1989. * Assert scsi device event asynchronously, given an event type.
  1990. */
  1991. void sdev_evt_send_simple(struct scsi_device *sdev,
  1992. enum scsi_device_event evt_type, gfp_t gfpflags)
  1993. {
  1994. struct scsi_event *evt = sdev_evt_alloc(evt_type, gfpflags);
  1995. if (!evt) {
  1996. sdev_printk(KERN_ERR, sdev, "event %d eaten due to OOM\n",
  1997. evt_type);
  1998. return;
  1999. }
  2000. sdev_evt_send(sdev, evt);
  2001. }
  2002. EXPORT_SYMBOL_GPL(sdev_evt_send_simple);
  2003. /**
  2004. * scsi_device_quiesce - Block user issued commands.
  2005. * @sdev: scsi device to quiesce.
  2006. *
  2007. * This works by trying to transition to the SDEV_QUIESCE state
  2008. * (which must be a legal transition). When the device is in this
  2009. * state, only special requests will be accepted, all others will
  2010. * be deferred. Since special requests may also be requeued requests,
  2011. * a successful return doesn't guarantee the device will be
  2012. * totally quiescent.
  2013. *
  2014. * Must be called with user context, may sleep.
  2015. *
  2016. * Returns zero if unsuccessful or an error if not.
  2017. */
  2018. int
  2019. scsi_device_quiesce(struct scsi_device *sdev)
  2020. {
  2021. int err = scsi_device_set_state(sdev, SDEV_QUIESCE);
  2022. if (err)
  2023. return err;
  2024. scsi_run_queue(sdev->request_queue);
  2025. while (sdev->device_busy) {
  2026. msleep_interruptible(200);
  2027. scsi_run_queue(sdev->request_queue);
  2028. }
  2029. return 0;
  2030. }
  2031. EXPORT_SYMBOL(scsi_device_quiesce);
  2032. /**
  2033. * scsi_device_resume - Restart user issued commands to a quiesced device.
  2034. * @sdev: scsi device to resume.
  2035. *
  2036. * Moves the device from quiesced back to running and restarts the
  2037. * queues.
  2038. *
  2039. * Must be called with user context, may sleep.
  2040. */
  2041. void
  2042. scsi_device_resume(struct scsi_device *sdev)
  2043. {
  2044. if(scsi_device_set_state(sdev, SDEV_RUNNING))
  2045. return;
  2046. scsi_run_queue(sdev->request_queue);
  2047. }
  2048. EXPORT_SYMBOL(scsi_device_resume);
  2049. static void
  2050. device_quiesce_fn(struct scsi_device *sdev, void *data)
  2051. {
  2052. scsi_device_quiesce(sdev);
  2053. }
  2054. void
  2055. scsi_target_quiesce(struct scsi_target *starget)
  2056. {
  2057. starget_for_each_device(starget, NULL, device_quiesce_fn);
  2058. }
  2059. EXPORT_SYMBOL(scsi_target_quiesce);
  2060. static void
  2061. device_resume_fn(struct scsi_device *sdev, void *data)
  2062. {
  2063. scsi_device_resume(sdev);
  2064. }
  2065. void
  2066. scsi_target_resume(struct scsi_target *starget)
  2067. {
  2068. starget_for_each_device(starget, NULL, device_resume_fn);
  2069. }
  2070. EXPORT_SYMBOL(scsi_target_resume);
  2071. /**
  2072. * scsi_internal_device_block - internal function to put a device temporarily into the SDEV_BLOCK state
  2073. * @sdev: device to block
  2074. *
  2075. * Block request made by scsi lld's to temporarily stop all
  2076. * scsi commands on the specified device. Called from interrupt
  2077. * or normal process context.
  2078. *
  2079. * Returns zero if successful or error if not
  2080. *
  2081. * Notes:
  2082. * This routine transitions the device to the SDEV_BLOCK state
  2083. * (which must be a legal transition). When the device is in this
  2084. * state, all commands are deferred until the scsi lld reenables
  2085. * the device with scsi_device_unblock or device_block_tmo fires.
  2086. * This routine assumes the host_lock is held on entry.
  2087. */
  2088. int
  2089. scsi_internal_device_block(struct scsi_device *sdev)
  2090. {
  2091. struct request_queue *q = sdev->request_queue;
  2092. unsigned long flags;
  2093. int err = 0;
  2094. err = scsi_device_set_state(sdev, SDEV_BLOCK);
  2095. if (err) {
  2096. err = scsi_device_set_state(sdev, SDEV_CREATED_BLOCK);
  2097. if (err)
  2098. return err;
  2099. }
  2100. /*
  2101. * The device has transitioned to SDEV_BLOCK. Stop the
  2102. * block layer from calling the midlayer with this device's
  2103. * request queue.
  2104. */
  2105. spin_lock_irqsave(q->queue_lock, flags);
  2106. blk_stop_queue(q);
  2107. spin_unlock_irqrestore(q->queue_lock, flags);
  2108. return 0;
  2109. }
  2110. EXPORT_SYMBOL_GPL(scsi_internal_device_block);
  2111. /**
  2112. * scsi_internal_device_unblock - resume a device after a block request
  2113. * @sdev: device to resume
  2114. *
  2115. * Called by scsi lld's or the midlayer to restart the device queue
  2116. * for the previously suspended scsi device. Called from interrupt or
  2117. * normal process context.
  2118. *
  2119. * Returns zero if successful or error if not.
  2120. *
  2121. * Notes:
  2122. * This routine transitions the device to the SDEV_RUNNING state
  2123. * (which must be a legal transition) allowing the midlayer to
  2124. * goose the queue for this device. This routine assumes the
  2125. * host_lock is held upon entry.
  2126. */
  2127. int
  2128. scsi_internal_device_unblock(struct scsi_device *sdev)
  2129. {
  2130. struct request_queue *q = sdev->request_queue;
  2131. unsigned long flags;
  2132. /*
  2133. * Try to transition the scsi device to SDEV_RUNNING
  2134. * and goose the device queue if successful.
  2135. */
  2136. if (sdev->sdev_state == SDEV_BLOCK)
  2137. sdev->sdev_state = SDEV_RUNNING;
  2138. else if (sdev->sdev_state == SDEV_CREATED_BLOCK)
  2139. sdev->sdev_state = SDEV_CREATED;
  2140. else
  2141. return -EINVAL;
  2142. spin_lock_irqsave(q->queue_lock, flags);
  2143. blk_start_queue(q);
  2144. spin_unlock_irqrestore(q->queue_lock, flags);
  2145. return 0;
  2146. }
  2147. EXPORT_SYMBOL_GPL(scsi_internal_device_unblock);
  2148. static void
  2149. device_block(struct scsi_device *sdev, void *data)
  2150. {
  2151. scsi_internal_device_block(sdev);
  2152. }
  2153. static int
  2154. target_block(struct device *dev, void *data)
  2155. {
  2156. if (scsi_is_target_device(dev))
  2157. starget_for_each_device(to_scsi_target(dev), NULL,
  2158. device_block);
  2159. return 0;
  2160. }
  2161. void
  2162. scsi_target_block(struct device *dev)
  2163. {
  2164. if (scsi_is_target_device(dev))
  2165. starget_for_each_device(to_scsi_target(dev), NULL,
  2166. device_block);
  2167. else
  2168. device_for_each_child(dev, NULL, target_block);
  2169. }
  2170. EXPORT_SYMBOL_GPL(scsi_target_block);
  2171. static void
  2172. device_unblock(struct scsi_device *sdev, void *data)
  2173. {
  2174. scsi_internal_device_unblock(sdev);
  2175. }
  2176. static int
  2177. target_unblock(struct device *dev, void *data)
  2178. {
  2179. if (scsi_is_target_device(dev))
  2180. starget_for_each_device(to_scsi_target(dev), NULL,
  2181. device_unblock);
  2182. return 0;
  2183. }
  2184. void
  2185. scsi_target_unblock(struct device *dev)
  2186. {
  2187. if (scsi_is_target_device(dev))
  2188. starget_for_each_device(to_scsi_target(dev), NULL,
  2189. device_unblock);
  2190. else
  2191. device_for_each_child(dev, NULL, target_unblock);
  2192. }
  2193. EXPORT_SYMBOL_GPL(scsi_target_unblock);
  2194. /**
  2195. * scsi_kmap_atomic_sg - find and atomically map an sg-elemnt
  2196. * @sgl: scatter-gather list
  2197. * @sg_count: number of segments in sg
  2198. * @offset: offset in bytes into sg, on return offset into the mapped area
  2199. * @len: bytes to map, on return number of bytes mapped
  2200. *
  2201. * Returns virtual address of the start of the mapped page
  2202. */
  2203. void *scsi_kmap_atomic_sg(struct scatterlist *sgl, int sg_count,
  2204. size_t *offset, size_t *len)
  2205. {
  2206. int i;
  2207. size_t sg_len = 0, len_complete = 0;
  2208. struct scatterlist *sg;
  2209. struct page *page;
  2210. WARN_ON(!irqs_disabled());
  2211. for_each_sg(sgl, sg, sg_count, i) {
  2212. len_complete = sg_len; /* Complete sg-entries */
  2213. sg_len += sg->length;
  2214. if (sg_len > *offset)
  2215. break;
  2216. }
  2217. if (unlikely(i == sg_count)) {
  2218. printk(KERN_ERR "%s: Bytes in sg: %zu, requested offset %zu, "
  2219. "elements %d\n",
  2220. __func__, sg_len, *offset, sg_count);
  2221. WARN_ON(1);
  2222. return NULL;
  2223. }
  2224. /* Offset starting from the beginning of first page in this sg-entry */
  2225. *offset = *offset - len_complete + sg->offset;
  2226. /* Assumption: contiguous pages can be accessed as "page + i" */
  2227. page = nth_page(sg_page(sg), (*offset >> PAGE_SHIFT));
  2228. *offset &= ~PAGE_MASK;
  2229. /* Bytes in this sg-entry from *offset to the end of the page */
  2230. sg_len = PAGE_SIZE - *offset;
  2231. if (*len > sg_len)
  2232. *len = sg_len;
  2233. return kmap_atomic(page, KM_BIO_SRC_IRQ);
  2234. }
  2235. EXPORT_SYMBOL(scsi_kmap_atomic_sg);
  2236. /**
  2237. * scsi_kunmap_atomic_sg - atomically unmap a virtual address, previously mapped with scsi_kmap_atomic_sg
  2238. * @virt: virtual address to be unmapped
  2239. */
  2240. void scsi_kunmap_atomic_sg(void *virt)
  2241. {
  2242. kunmap_atomic(virt, KM_BIO_SRC_IRQ);
  2243. }
  2244. EXPORT_SYMBOL(scsi_kunmap_atomic_sg);