scsi_lib.c 64 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552
  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. blk_unprep_request(req);
  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 (req->cmd_type == REQ_TYPE_BLOCK_PC) { /* 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. scsi_release_buffers(cmd);
  659. blk_end_request_all(req, 0);
  660. scsi_next_command(cmd);
  661. return;
  662. }
  663. }
  664. /* no bidi support for !REQ_TYPE_BLOCK_PC yet */
  665. BUG_ON(blk_bidi_rq(req));
  666. /*
  667. * Next deal with any sectors which we were able to correctly
  668. * handle.
  669. */
  670. SCSI_LOG_HLCOMPLETE(1, printk("%u sectors total, "
  671. "%d bytes done.\n",
  672. blk_rq_sectors(req), good_bytes));
  673. /*
  674. * Recovered errors need reporting, but they're always treated
  675. * as success, so fiddle the result code here. For BLOCK_PC
  676. * we already took a copy of the original into rq->errors which
  677. * is what gets returned to the user
  678. */
  679. if (sense_valid && (sshdr.sense_key == RECOVERED_ERROR)) {
  680. /* if ATA PASS-THROUGH INFORMATION AVAILABLE skip
  681. * print since caller wants ATA registers. Only occurs on
  682. * SCSI ATA PASS_THROUGH commands when CK_COND=1
  683. */
  684. if ((sshdr.asc == 0x0) && (sshdr.ascq == 0x1d))
  685. ;
  686. else if (!(req->cmd_flags & REQ_QUIET))
  687. scsi_print_sense("", cmd);
  688. result = 0;
  689. /* BLOCK_PC may have set error */
  690. error = 0;
  691. }
  692. /*
  693. * A number of bytes were successfully read. If there
  694. * are leftovers and there is some kind of error
  695. * (result != 0), retry the rest.
  696. */
  697. if (scsi_end_request(cmd, error, good_bytes, result == 0) == NULL)
  698. return;
  699. error = -EIO;
  700. if (host_byte(result) == DID_RESET) {
  701. /* Third party bus reset or reset for error recovery
  702. * reasons. Just retry the command and see what
  703. * happens.
  704. */
  705. action = ACTION_RETRY;
  706. } else if (sense_valid && !sense_deferred) {
  707. switch (sshdr.sense_key) {
  708. case UNIT_ATTENTION:
  709. if (cmd->device->removable) {
  710. /* Detected disc change. Set a bit
  711. * and quietly refuse further access.
  712. */
  713. cmd->device->changed = 1;
  714. description = "Media Changed";
  715. action = ACTION_FAIL;
  716. } else {
  717. /* Must have been a power glitch, or a
  718. * bus reset. Could not have been a
  719. * media change, so we just retry the
  720. * command and see what happens.
  721. */
  722. action = ACTION_RETRY;
  723. }
  724. break;
  725. case ILLEGAL_REQUEST:
  726. /* If we had an ILLEGAL REQUEST returned, then
  727. * we may have performed an unsupported
  728. * command. The only thing this should be
  729. * would be a ten byte read where only a six
  730. * byte read was supported. Also, on a system
  731. * where READ CAPACITY failed, we may have
  732. * read past the end of the disk.
  733. */
  734. if ((cmd->device->use_10_for_rw &&
  735. sshdr.asc == 0x20 && sshdr.ascq == 0x00) &&
  736. (cmd->cmnd[0] == READ_10 ||
  737. cmd->cmnd[0] == WRITE_10)) {
  738. /* This will issue a new 6-byte command. */
  739. cmd->device->use_10_for_rw = 0;
  740. action = ACTION_REPREP;
  741. } else if (sshdr.asc == 0x10) /* DIX */ {
  742. description = "Host Data Integrity Failure";
  743. action = ACTION_FAIL;
  744. error = -EILSEQ;
  745. } else
  746. action = ACTION_FAIL;
  747. break;
  748. case ABORTED_COMMAND:
  749. action = ACTION_FAIL;
  750. if (sshdr.asc == 0x10) { /* DIF */
  751. description = "Target Data Integrity Failure";
  752. error = -EILSEQ;
  753. }
  754. break;
  755. case NOT_READY:
  756. /* If the device is in the process of becoming
  757. * ready, or has a temporary blockage, retry.
  758. */
  759. if (sshdr.asc == 0x04) {
  760. switch (sshdr.ascq) {
  761. case 0x01: /* becoming ready */
  762. case 0x04: /* format in progress */
  763. case 0x05: /* rebuild in progress */
  764. case 0x06: /* recalculation in progress */
  765. case 0x07: /* operation in progress */
  766. case 0x08: /* Long write in progress */
  767. case 0x09: /* self test in progress */
  768. case 0x14: /* space allocation in progress */
  769. action = ACTION_DELAYED_RETRY;
  770. break;
  771. default:
  772. description = "Device not ready";
  773. action = ACTION_FAIL;
  774. break;
  775. }
  776. } else {
  777. description = "Device not ready";
  778. action = ACTION_FAIL;
  779. }
  780. break;
  781. case VOLUME_OVERFLOW:
  782. /* See SSC3rXX or current. */
  783. action = ACTION_FAIL;
  784. break;
  785. default:
  786. description = "Unhandled sense code";
  787. action = ACTION_FAIL;
  788. break;
  789. }
  790. } else {
  791. description = "Unhandled error code";
  792. action = ACTION_FAIL;
  793. }
  794. switch (action) {
  795. case ACTION_FAIL:
  796. /* Give up and fail the remainder of the request */
  797. scsi_release_buffers(cmd);
  798. if (!(req->cmd_flags & REQ_QUIET)) {
  799. if (description)
  800. scmd_printk(KERN_INFO, cmd, "%s\n",
  801. description);
  802. scsi_print_result(cmd);
  803. if (driver_byte(result) & DRIVER_SENSE)
  804. scsi_print_sense("", cmd);
  805. scsi_print_command(cmd);
  806. }
  807. if (blk_end_request_err(req, error))
  808. scsi_requeue_command(q, cmd);
  809. else
  810. scsi_next_command(cmd);
  811. break;
  812. case ACTION_REPREP:
  813. /* Unprep the request and put it back at the head of the queue.
  814. * A new command will be prepared and issued.
  815. */
  816. scsi_release_buffers(cmd);
  817. scsi_requeue_command(q, cmd);
  818. break;
  819. case ACTION_RETRY:
  820. /* Retry the same command immediately */
  821. __scsi_queue_insert(cmd, SCSI_MLQUEUE_EH_RETRY, 0);
  822. break;
  823. case ACTION_DELAYED_RETRY:
  824. /* Retry the same command after a delay */
  825. __scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY, 0);
  826. break;
  827. }
  828. }
  829. static int scsi_init_sgtable(struct request *req, struct scsi_data_buffer *sdb,
  830. gfp_t gfp_mask)
  831. {
  832. int count;
  833. /*
  834. * If sg table allocation fails, requeue request later.
  835. */
  836. if (unlikely(scsi_alloc_sgtable(sdb, req->nr_phys_segments,
  837. gfp_mask))) {
  838. return BLKPREP_DEFER;
  839. }
  840. req->buffer = NULL;
  841. /*
  842. * Next, walk the list, and fill in the addresses and sizes of
  843. * each segment.
  844. */
  845. count = blk_rq_map_sg(req->q, req, sdb->table.sgl);
  846. BUG_ON(count > sdb->table.nents);
  847. sdb->table.nents = count;
  848. sdb->length = blk_rq_bytes(req);
  849. return BLKPREP_OK;
  850. }
  851. /*
  852. * Function: scsi_init_io()
  853. *
  854. * Purpose: SCSI I/O initialize function.
  855. *
  856. * Arguments: cmd - Command descriptor we wish to initialize
  857. *
  858. * Returns: 0 on success
  859. * BLKPREP_DEFER if the failure is retryable
  860. * BLKPREP_KILL if the failure is fatal
  861. */
  862. int scsi_init_io(struct scsi_cmnd *cmd, gfp_t gfp_mask)
  863. {
  864. int error = scsi_init_sgtable(cmd->request, &cmd->sdb, gfp_mask);
  865. if (error)
  866. goto err_exit;
  867. if (blk_bidi_rq(cmd->request)) {
  868. struct scsi_data_buffer *bidi_sdb = kmem_cache_zalloc(
  869. scsi_sdb_cache, GFP_ATOMIC);
  870. if (!bidi_sdb) {
  871. error = BLKPREP_DEFER;
  872. goto err_exit;
  873. }
  874. cmd->request->next_rq->special = bidi_sdb;
  875. error = scsi_init_sgtable(cmd->request->next_rq, bidi_sdb,
  876. GFP_ATOMIC);
  877. if (error)
  878. goto err_exit;
  879. }
  880. if (blk_integrity_rq(cmd->request)) {
  881. struct scsi_data_buffer *prot_sdb = cmd->prot_sdb;
  882. int ivecs, count;
  883. BUG_ON(prot_sdb == NULL);
  884. ivecs = blk_rq_count_integrity_sg(cmd->request);
  885. if (scsi_alloc_sgtable(prot_sdb, ivecs, gfp_mask)) {
  886. error = BLKPREP_DEFER;
  887. goto err_exit;
  888. }
  889. count = blk_rq_map_integrity_sg(cmd->request,
  890. prot_sdb->table.sgl);
  891. BUG_ON(unlikely(count > ivecs));
  892. cmd->prot_sdb = prot_sdb;
  893. cmd->prot_sdb->table.nents = count;
  894. }
  895. return BLKPREP_OK ;
  896. err_exit:
  897. scsi_release_buffers(cmd);
  898. cmd->request->special = NULL;
  899. scsi_put_command(cmd);
  900. return error;
  901. }
  902. EXPORT_SYMBOL(scsi_init_io);
  903. static struct scsi_cmnd *scsi_get_cmd_from_req(struct scsi_device *sdev,
  904. struct request *req)
  905. {
  906. struct scsi_cmnd *cmd;
  907. if (!req->special) {
  908. cmd = scsi_get_command(sdev, GFP_ATOMIC);
  909. if (unlikely(!cmd))
  910. return NULL;
  911. req->special = cmd;
  912. } else {
  913. cmd = req->special;
  914. }
  915. /* pull a tag out of the request if we have one */
  916. cmd->tag = req->tag;
  917. cmd->request = req;
  918. cmd->cmnd = req->cmd;
  919. return cmd;
  920. }
  921. int scsi_setup_blk_pc_cmnd(struct scsi_device *sdev, struct request *req)
  922. {
  923. struct scsi_cmnd *cmd;
  924. int ret = scsi_prep_state_check(sdev, req);
  925. if (ret != BLKPREP_OK)
  926. return ret;
  927. cmd = scsi_get_cmd_from_req(sdev, req);
  928. if (unlikely(!cmd))
  929. return BLKPREP_DEFER;
  930. /*
  931. * BLOCK_PC requests may transfer data, in which case they must
  932. * a bio attached to them. Or they might contain a SCSI command
  933. * that does not transfer data, in which case they may optionally
  934. * submit a request without an attached bio.
  935. */
  936. if (req->bio) {
  937. int ret;
  938. BUG_ON(!req->nr_phys_segments);
  939. ret = scsi_init_io(cmd, GFP_ATOMIC);
  940. if (unlikely(ret))
  941. return ret;
  942. } else {
  943. BUG_ON(blk_rq_bytes(req));
  944. memset(&cmd->sdb, 0, sizeof(cmd->sdb));
  945. req->buffer = NULL;
  946. }
  947. cmd->cmd_len = req->cmd_len;
  948. if (!blk_rq_bytes(req))
  949. cmd->sc_data_direction = DMA_NONE;
  950. else if (rq_data_dir(req) == WRITE)
  951. cmd->sc_data_direction = DMA_TO_DEVICE;
  952. else
  953. cmd->sc_data_direction = DMA_FROM_DEVICE;
  954. cmd->transfersize = blk_rq_bytes(req);
  955. cmd->allowed = req->retries;
  956. return BLKPREP_OK;
  957. }
  958. EXPORT_SYMBOL(scsi_setup_blk_pc_cmnd);
  959. /*
  960. * Setup a REQ_TYPE_FS command. These are simple read/write request
  961. * from filesystems that still need to be translated to SCSI CDBs from
  962. * the ULD.
  963. */
  964. int scsi_setup_fs_cmnd(struct scsi_device *sdev, struct request *req)
  965. {
  966. struct scsi_cmnd *cmd;
  967. int ret = scsi_prep_state_check(sdev, req);
  968. if (ret != BLKPREP_OK)
  969. return ret;
  970. if (unlikely(sdev->scsi_dh_data && sdev->scsi_dh_data->scsi_dh
  971. && sdev->scsi_dh_data->scsi_dh->prep_fn)) {
  972. ret = sdev->scsi_dh_data->scsi_dh->prep_fn(sdev, req);
  973. if (ret != BLKPREP_OK)
  974. return ret;
  975. }
  976. /*
  977. * Filesystem requests must transfer data.
  978. */
  979. BUG_ON(!req->nr_phys_segments);
  980. cmd = scsi_get_cmd_from_req(sdev, req);
  981. if (unlikely(!cmd))
  982. return BLKPREP_DEFER;
  983. memset(cmd->cmnd, 0, BLK_MAX_CDB);
  984. return scsi_init_io(cmd, GFP_ATOMIC);
  985. }
  986. EXPORT_SYMBOL(scsi_setup_fs_cmnd);
  987. int scsi_prep_state_check(struct scsi_device *sdev, struct request *req)
  988. {
  989. int ret = BLKPREP_OK;
  990. /*
  991. * If the device is not in running state we will reject some
  992. * or all commands.
  993. */
  994. if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
  995. switch (sdev->sdev_state) {
  996. case SDEV_OFFLINE:
  997. /*
  998. * If the device is offline we refuse to process any
  999. * commands. The device must be brought online
  1000. * before trying any recovery commands.
  1001. */
  1002. sdev_printk(KERN_ERR, sdev,
  1003. "rejecting I/O to offline device\n");
  1004. ret = BLKPREP_KILL;
  1005. break;
  1006. case SDEV_DEL:
  1007. /*
  1008. * If the device is fully deleted, we refuse to
  1009. * process any commands as well.
  1010. */
  1011. sdev_printk(KERN_ERR, sdev,
  1012. "rejecting I/O to dead device\n");
  1013. ret = BLKPREP_KILL;
  1014. break;
  1015. case SDEV_QUIESCE:
  1016. case SDEV_BLOCK:
  1017. case SDEV_CREATED_BLOCK:
  1018. /*
  1019. * If the devices is blocked we defer normal commands.
  1020. */
  1021. if (!(req->cmd_flags & REQ_PREEMPT))
  1022. ret = BLKPREP_DEFER;
  1023. break;
  1024. default:
  1025. /*
  1026. * For any other not fully online state we only allow
  1027. * special commands. In particular any user initiated
  1028. * command is not allowed.
  1029. */
  1030. if (!(req->cmd_flags & REQ_PREEMPT))
  1031. ret = BLKPREP_KILL;
  1032. break;
  1033. }
  1034. }
  1035. return ret;
  1036. }
  1037. EXPORT_SYMBOL(scsi_prep_state_check);
  1038. int scsi_prep_return(struct request_queue *q, struct request *req, int ret)
  1039. {
  1040. struct scsi_device *sdev = q->queuedata;
  1041. switch (ret) {
  1042. case BLKPREP_KILL:
  1043. req->errors = DID_NO_CONNECT << 16;
  1044. /* release the command and kill it */
  1045. if (req->special) {
  1046. struct scsi_cmnd *cmd = req->special;
  1047. scsi_release_buffers(cmd);
  1048. scsi_put_command(cmd);
  1049. req->special = NULL;
  1050. }
  1051. break;
  1052. case BLKPREP_DEFER:
  1053. /*
  1054. * If we defer, the blk_peek_request() returns NULL, but the
  1055. * queue must be restarted, so we plug here if no returning
  1056. * command will automatically do that.
  1057. */
  1058. if (sdev->device_busy == 0)
  1059. blk_plug_device(q);
  1060. break;
  1061. default:
  1062. req->cmd_flags |= REQ_DONTPREP;
  1063. }
  1064. return ret;
  1065. }
  1066. EXPORT_SYMBOL(scsi_prep_return);
  1067. int scsi_prep_fn(struct request_queue *q, struct request *req)
  1068. {
  1069. struct scsi_device *sdev = q->queuedata;
  1070. int ret = BLKPREP_KILL;
  1071. if (req->cmd_type == REQ_TYPE_BLOCK_PC)
  1072. ret = scsi_setup_blk_pc_cmnd(sdev, req);
  1073. return scsi_prep_return(q, req, ret);
  1074. }
  1075. EXPORT_SYMBOL(scsi_prep_fn);
  1076. /*
  1077. * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
  1078. * return 0.
  1079. *
  1080. * Called with the queue_lock held.
  1081. */
  1082. static inline int scsi_dev_queue_ready(struct request_queue *q,
  1083. struct scsi_device *sdev)
  1084. {
  1085. if (sdev->device_busy == 0 && sdev->device_blocked) {
  1086. /*
  1087. * unblock after device_blocked iterates to zero
  1088. */
  1089. if (--sdev->device_blocked == 0) {
  1090. SCSI_LOG_MLQUEUE(3,
  1091. sdev_printk(KERN_INFO, sdev,
  1092. "unblocking device at zero depth\n"));
  1093. } else {
  1094. blk_plug_device(q);
  1095. return 0;
  1096. }
  1097. }
  1098. if (scsi_device_is_busy(sdev))
  1099. return 0;
  1100. return 1;
  1101. }
  1102. /*
  1103. * scsi_target_queue_ready: checks if there we can send commands to target
  1104. * @sdev: scsi device on starget to check.
  1105. *
  1106. * Called with the host lock held.
  1107. */
  1108. static inline int scsi_target_queue_ready(struct Scsi_Host *shost,
  1109. struct scsi_device *sdev)
  1110. {
  1111. struct scsi_target *starget = scsi_target(sdev);
  1112. if (starget->single_lun) {
  1113. if (starget->starget_sdev_user &&
  1114. starget->starget_sdev_user != sdev)
  1115. return 0;
  1116. starget->starget_sdev_user = sdev;
  1117. }
  1118. if (starget->target_busy == 0 && starget->target_blocked) {
  1119. /*
  1120. * unblock after target_blocked iterates to zero
  1121. */
  1122. if (--starget->target_blocked == 0) {
  1123. SCSI_LOG_MLQUEUE(3, starget_printk(KERN_INFO, starget,
  1124. "unblocking target at zero depth\n"));
  1125. } else
  1126. return 0;
  1127. }
  1128. if (scsi_target_is_busy(starget)) {
  1129. if (list_empty(&sdev->starved_entry)) {
  1130. list_add_tail(&sdev->starved_entry,
  1131. &shost->starved_list);
  1132. return 0;
  1133. }
  1134. }
  1135. /* We're OK to process the command, so we can't be starved */
  1136. if (!list_empty(&sdev->starved_entry))
  1137. list_del_init(&sdev->starved_entry);
  1138. return 1;
  1139. }
  1140. /*
  1141. * scsi_host_queue_ready: if we can send requests to shost, return 1 else
  1142. * return 0. We must end up running the queue again whenever 0 is
  1143. * returned, else IO can hang.
  1144. *
  1145. * Called with host_lock held.
  1146. */
  1147. static inline int scsi_host_queue_ready(struct request_queue *q,
  1148. struct Scsi_Host *shost,
  1149. struct scsi_device *sdev)
  1150. {
  1151. if (scsi_host_in_recovery(shost))
  1152. return 0;
  1153. if (shost->host_busy == 0 && shost->host_blocked) {
  1154. /*
  1155. * unblock after host_blocked iterates to zero
  1156. */
  1157. if (--shost->host_blocked == 0) {
  1158. SCSI_LOG_MLQUEUE(3,
  1159. printk("scsi%d unblocking host at zero depth\n",
  1160. shost->host_no));
  1161. } else {
  1162. return 0;
  1163. }
  1164. }
  1165. if (scsi_host_is_busy(shost)) {
  1166. if (list_empty(&sdev->starved_entry))
  1167. list_add_tail(&sdev->starved_entry, &shost->starved_list);
  1168. return 0;
  1169. }
  1170. /* We're OK to process the command, so we can't be starved */
  1171. if (!list_empty(&sdev->starved_entry))
  1172. list_del_init(&sdev->starved_entry);
  1173. return 1;
  1174. }
  1175. /*
  1176. * Busy state exporting function for request stacking drivers.
  1177. *
  1178. * For efficiency, no lock is taken to check the busy state of
  1179. * shost/starget/sdev, since the returned value is not guaranteed and
  1180. * may be changed after request stacking drivers call the function,
  1181. * regardless of taking lock or not.
  1182. *
  1183. * When scsi can't dispatch I/Os anymore and needs to kill I/Os
  1184. * (e.g. !sdev), scsi needs to return 'not busy'.
  1185. * Otherwise, request stacking drivers may hold requests forever.
  1186. */
  1187. static int scsi_lld_busy(struct request_queue *q)
  1188. {
  1189. struct scsi_device *sdev = q->queuedata;
  1190. struct Scsi_Host *shost;
  1191. struct scsi_target *starget;
  1192. if (!sdev)
  1193. return 0;
  1194. shost = sdev->host;
  1195. starget = scsi_target(sdev);
  1196. if (scsi_host_in_recovery(shost) || scsi_host_is_busy(shost) ||
  1197. scsi_target_is_busy(starget) || scsi_device_is_busy(sdev))
  1198. return 1;
  1199. return 0;
  1200. }
  1201. /*
  1202. * Kill a request for a dead device
  1203. */
  1204. static void scsi_kill_request(struct request *req, struct request_queue *q)
  1205. {
  1206. struct scsi_cmnd *cmd = req->special;
  1207. struct scsi_device *sdev;
  1208. struct scsi_target *starget;
  1209. struct Scsi_Host *shost;
  1210. blk_start_request(req);
  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_segments(q, min_t(unsigned short, shost->sg_tablesize,
  1429. SCSI_MAX_SG_CHAIN_SEGMENTS));
  1430. blk_queue_max_hw_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);