blob: 8afb01604d515baff0ed4b10e2d526326935a913 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * scsi_error.c Copyright (C) 1997 Eric Youngdale
3 *
4 * SCSI error/timeout handling
5 * Initial versions: Eric Youngdale. Based upon conversations with
Jesper Juhl0bf8c862011-03-21 20:47:31 +01006 * Leonard Zubkoff and David Miller at Linux Expo,
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * ideas originating from all over the place.
8 *
9 * Restructured scsi_unjam_host and associated functions.
10 * September 04, 2002 Mike Anderson (andmike@us.ibm.com)
11 *
12 * Forward port of Russell King's (rmk@arm.linux.org.uk) changes and
Jesper Juhl0bf8c862011-03-21 20:47:31 +010013 * minor cleanups.
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 * September 30, 2002 Mike Anderson (andmike@us.ibm.com)
15 */
16
17#include <linux/module.h>
18#include <linux/sched.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090019#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/timer.h>
21#include <linux/string.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/kernel.h>
Rafael J. Wysocki83144182007-07-17 04:03:35 -070023#include <linux/freezer.h>
Christoph Hellwigc5478de2005-09-06 14:04:26 +020024#include <linux/kthread.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/interrupt.h>
26#include <linux/blkdev.h>
27#include <linux/delay.h>
Hannes Reineckefc736482013-04-25 08:10:00 +020028#include <linux/jiffies.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
30#include <scsi/scsi.h>
Christoph Hellwigbeb40482006-06-10 18:01:03 +020031#include <scsi/scsi_cmnd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <scsi/scsi_dbg.h>
33#include <scsi/scsi_device.h>
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -050034#include <scsi/scsi_driver.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <scsi/scsi_eh.h>
James Smartc829c392006-03-13 08:28:57 -050036#include <scsi/scsi_transport.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <scsi/scsi_host.h>
38#include <scsi/scsi_ioctl.h>
Christoph Hellwig176aa9d2014-10-11 12:06:47 +020039#include <scsi/sg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
41#include "scsi_priv.h"
42#include "scsi_logging.h"
Adrian Bunk79ee8302007-08-10 14:50:42 -070043#include "scsi_transport_api.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Kei Tokunagabf816232010-04-01 20:41:40 +090045#include <trace/events/scsi.h>
46
James Bottomley14216562012-07-25 23:55:55 +040047static void scsi_eh_done(struct scsi_cmnd *scmd);
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049/*
50 * These should *probably* be handled by the host itself.
51 * Since it is allowed to sleep, it probably should.
52 */
53#define BUS_RESET_SETTLE_TIME (10)
54#define HOST_RESET_SETTLE_TIME (10)
55
David Jeffery3eef6252011-05-19 14:41:12 -040056static int scsi_eh_try_stu(struct scsi_cmnd *scmd);
Hannes Reineckee494f6a2013-11-11 13:44:54 +010057static int scsi_try_to_abort_cmd(struct scsi_host_template *,
58 struct scsi_cmnd *);
David Jeffery3eef6252011-05-19 14:41:12 -040059
Linus Torvalds1da177e2005-04-16 15:20:36 -070060/* called with shost->host_lock held */
61void scsi_eh_wakeup(struct Scsi_Host *shost)
62{
Christoph Hellwig74665012014-01-22 15:29:29 +010063 if (atomic_read(&shost->host_busy) == shost->host_failed) {
Kei Tokunagabf816232010-04-01 20:41:40 +090064 trace_scsi_eh_wakeup(shost);
James Bottomley3ed7a472005-09-19 09:50:04 -050065 wake_up_process(shost->ehandler);
Hannes Reinecke91921e02014-06-25 16:39:59 +020066 SCSI_LOG_ERROR_RECOVERY(5, shost_printk(KERN_INFO, shost,
67 "Waking error handler thread\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 }
69}
Tejun Heof8bbfc22006-05-19 21:07:05 +090070
71/**
72 * scsi_schedule_eh - schedule EH for SCSI host
73 * @shost: SCSI host to invoke error handling on.
74 *
75 * Schedule SCSI EH without scmd.
Randy Dunlapdc8875e2007-11-15 15:42:30 -080076 */
Tejun Heof8bbfc22006-05-19 21:07:05 +090077void scsi_schedule_eh(struct Scsi_Host *shost)
78{
79 unsigned long flags;
80
81 spin_lock_irqsave(shost->host_lock, flags);
82
83 if (scsi_host_set_state(shost, SHOST_RECOVERY) == 0 ||
84 scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY) == 0) {
85 shost->host_eh_scheduled++;
86 scsi_eh_wakeup(shost);
87 }
88
89 spin_unlock_irqrestore(shost->host_lock, flags);
90}
91EXPORT_SYMBOL_GPL(scsi_schedule_eh);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Hannes Reineckeb4562022013-10-23 10:51:21 +020093static int scsi_host_eh_past_deadline(struct Scsi_Host *shost)
94{
Ren Mingxinbb3b6212013-11-11 13:44:56 +010095 if (!shost->last_reset || shost->eh_deadline == -1)
Hannes Reineckeb4562022013-10-23 10:51:21 +020096 return 0;
97
Hannes Reinecke76ad3e52013-11-11 13:44:55 +010098 /*
99 * 32bit accesses are guaranteed to be atomic
100 * (on all supported architectures), so instead
101 * of using a spinlock we can as well double check
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100102 * if eh_deadline has been set to 'off' during the
Hannes Reinecke76ad3e52013-11-11 13:44:55 +0100103 * time_before call.
104 */
105 if (time_before(jiffies, shost->last_reset + shost->eh_deadline) &&
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100106 shost->eh_deadline > -1)
Hannes Reineckeb4562022013-10-23 10:51:21 +0200107 return 0;
108
109 return 1;
110}
111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112/**
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100113 * scmd_eh_abort_handler - Handle command aborts
114 * @work: command to be aborted.
115 */
116void
117scmd_eh_abort_handler(struct work_struct *work)
118{
119 struct scsi_cmnd *scmd =
120 container_of(work, struct scsi_cmnd, abort_work.work);
121 struct scsi_device *sdev = scmd->device;
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100122 int rtn;
123
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100124 if (scsi_host_eh_past_deadline(sdev->host)) {
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100125 SCSI_LOG_ERROR_RECOVERY(3,
126 scmd_printk(KERN_INFO, scmd,
127 "scmd %p eh timeout, not aborting\n",
128 scmd));
129 } else {
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100130 SCSI_LOG_ERROR_RECOVERY(3,
131 scmd_printk(KERN_INFO, scmd,
132 "aborting command %p\n", scmd));
133 rtn = scsi_try_to_abort_cmd(sdev->host->hostt, scmd);
134 if (rtn == SUCCESS) {
Ulrich Obergfell8922a902014-06-04 13:34:57 +0200135 set_host_byte(scmd, DID_TIME_OUT);
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100136 if (scsi_host_eh_past_deadline(sdev->host)) {
137 SCSI_LOG_ERROR_RECOVERY(3,
138 scmd_printk(KERN_INFO, scmd,
139 "scmd %p eh timeout, "
140 "not retrying aborted "
141 "command\n", scmd));
142 } else if (!scsi_noretry_cmd(scmd) &&
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100143 (++scmd->retries <= scmd->allowed)) {
144 SCSI_LOG_ERROR_RECOVERY(3,
145 scmd_printk(KERN_WARNING, scmd,
146 "scmd %p retry "
147 "aborted command\n", scmd));
148 scsi_queue_insert(scmd, SCSI_MLQUEUE_EH_RETRY);
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100149 return;
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100150 } else {
151 SCSI_LOG_ERROR_RECOVERY(3,
152 scmd_printk(KERN_WARNING, scmd,
153 "scmd %p finish "
154 "aborted command\n", scmd));
155 scsi_finish_command(scmd);
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100156 return;
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100157 }
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100158 } else {
159 SCSI_LOG_ERROR_RECOVERY(3,
160 scmd_printk(KERN_INFO, scmd,
Hannes Reinecke883a0302014-10-24 14:27:04 +0200161 "scmd %p abort %s\n", scmd,
162 (rtn == FAST_IO_FAIL) ?
163 "not send" : "failed"));
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100164 }
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100165 }
166
167 if (!scsi_eh_scmd_add(scmd, 0)) {
168 SCSI_LOG_ERROR_RECOVERY(3,
169 scmd_printk(KERN_WARNING, scmd,
170 "scmd %p terminate "
171 "aborted command\n", scmd));
Ulrich Obergfell8922a902014-06-04 13:34:57 +0200172 set_host_byte(scmd, DID_TIME_OUT);
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100173 scsi_finish_command(scmd);
174 }
175}
176
177/**
178 * scsi_abort_command - schedule a command abort
179 * @scmd: scmd to abort.
180 *
181 * We only need to abort commands after a command timeout
182 */
183static int
184scsi_abort_command(struct scsi_cmnd *scmd)
185{
186 struct scsi_device *sdev = scmd->device;
187 struct Scsi_Host *shost = sdev->host;
188 unsigned long flags;
189
190 if (scmd->eh_eflags & SCSI_EH_ABORT_SCHEDULED) {
191 /*
192 * Retry after abort failed, escalate to next level.
193 */
Hannes Reinecke7daf4802014-03-31 16:37:34 +0200194 scmd->eh_eflags &= ~SCSI_EH_ABORT_SCHEDULED;
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100195 SCSI_LOG_ERROR_RECOVERY(3,
196 scmd_printk(KERN_INFO, scmd,
197 "scmd %p previous abort failed\n", scmd));
Bart Van Asschefcc95a72014-06-02 11:50:52 +0200198 BUG_ON(delayed_work_pending(&scmd->abort_work));
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100199 return FAILED;
200 }
201
202 /*
203 * Do not try a command abort if
204 * SCSI EH has already started.
205 */
206 spin_lock_irqsave(shost->host_lock, flags);
207 if (scsi_host_in_recovery(shost)) {
208 spin_unlock_irqrestore(shost->host_lock, flags);
209 SCSI_LOG_ERROR_RECOVERY(3,
210 scmd_printk(KERN_INFO, scmd,
211 "scmd %p not aborting, host in recovery\n",
212 scmd));
213 return FAILED;
214 }
215
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100216 if (shost->eh_deadline != -1 && !shost->last_reset)
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100217 shost->last_reset = jiffies;
218 spin_unlock_irqrestore(shost->host_lock, flags);
219
220 scmd->eh_eflags |= SCSI_EH_ABORT_SCHEDULED;
221 SCSI_LOG_ERROR_RECOVERY(3,
222 scmd_printk(KERN_INFO, scmd,
223 "scmd %p abort scheduled\n", scmd));
224 queue_delayed_work(shost->tmf_work_q, &scmd->abort_work, HZ / 100);
225 return SUCCESS;
226}
227
228/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 * scsi_eh_scmd_add - add scsi cmd to error handling.
230 * @scmd: scmd to run eh on.
231 * @eh_flag: optional SCSI_EH flag.
232 *
233 * Return value:
234 * 0 on failure.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800235 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236int scsi_eh_scmd_add(struct scsi_cmnd *scmd, int eh_flag)
237{
238 struct Scsi_Host *shost = scmd->device->host;
239 unsigned long flags;
James Bottomley939647e2005-09-18 15:05:20 -0500240 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
James Bottomley3ed7a472005-09-19 09:50:04 -0500242 if (!shost->ehandler)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 return 0;
244
245 spin_lock_irqsave(shost->host_lock, flags);
James Bottomley939647e2005-09-18 15:05:20 -0500246 if (scsi_host_set_state(shost, SHOST_RECOVERY))
247 if (scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY))
248 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100250 if (shost->eh_deadline != -1 && !shost->last_reset)
Hannes Reineckeb4562022013-10-23 10:51:21 +0200251 shost->last_reset = jiffies;
252
James Bottomley939647e2005-09-18 15:05:20 -0500253 ret = 1;
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100254 if (scmd->eh_eflags & SCSI_EH_ABORT_SCHEDULED)
255 eh_flag &= ~SCSI_EH_CANCEL_CMD;
Christoph Hellwig3111b0d2005-06-19 13:43:26 +0200256 scmd->eh_eflags |= eh_flag;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 list_add_tail(&scmd->eh_entry, &shost->eh_cmd_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 shost->host_failed++;
259 scsi_eh_wakeup(shost);
James Bottomley939647e2005-09-18 15:05:20 -0500260 out_unlock:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 spin_unlock_irqrestore(shost->host_lock, flags);
James Bottomley939647e2005-09-18 15:05:20 -0500262 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263}
264
265/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 * scsi_times_out - Timeout function for normal scsi commands.
Jens Axboe242f9dc2008-09-14 05:55:09 -0700267 * @req: request that is timing out.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 *
269 * Notes:
270 * We do not need to lock this. There is the potential for a race
271 * only in that the normal completion handling might run, but if the
272 * normal completion function determines that the timer has already
273 * fired, then it mustn't do anything.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800274 */
Jens Axboe242f9dc2008-09-14 05:55:09 -0700275enum blk_eh_timer_return scsi_times_out(struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276{
Jens Axboe242f9dc2008-09-14 05:55:09 -0700277 struct scsi_cmnd *scmd = req->special;
Jens Axboe242f9dc2008-09-14 05:55:09 -0700278 enum blk_eh_timer_return rtn = BLK_EH_NOT_HANDLED;
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100279 struct Scsi_Host *host = scmd->device->host;
James Bottomley6c5f8ce2007-03-16 17:44:41 -0500280
Kei Tokunagabf816232010-04-01 20:41:40 +0900281 trace_scsi_dispatch_cmd_timeout(scmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 scsi_log_completion(scmd, TIMEOUT_ERROR);
283
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100284 if (host->eh_deadline != -1 && !host->last_reset)
Hannes Reineckeb4562022013-10-23 10:51:21 +0200285 host->last_reset = jiffies;
286
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100287 if (host->transportt->eh_timed_out)
288 rtn = host->transportt->eh_timed_out(scmd);
289 else if (host->hostt->eh_timed_out)
290 rtn = host->hostt->eh_timed_out(scmd);
James Bottomley6c5f8ce2007-03-16 17:44:41 -0500291
Hannes Reineckea33c0702014-06-13 14:01:45 +0200292 if (rtn == BLK_EH_NOT_HANDLED) {
293 if (!host->hostt->no_async_abort &&
294 scsi_abort_command(scmd) == SUCCESS)
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100295 return BLK_EH_NOT_HANDLED;
296
Hannes Reineckea33c0702014-06-13 14:01:45 +0200297 set_host_byte(scmd, DID_TIME_OUT);
298 if (!scsi_eh_scmd_add(scmd, SCSI_EH_CANCEL_CMD))
299 rtn = BLK_EH_HANDLED;
300 }
Jens Axboe242f9dc2008-09-14 05:55:09 -0700301
Christoph Hellwigfa990782008-11-05 15:03:15 +0100302 return rtn;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303}
304
305/**
306 * scsi_block_when_processing_errors - Prevent cmds from being queued.
307 * @sdev: Device on which we are performing recovery.
308 *
309 * Description:
310 * We block until the host is out of error recovery, and then check to
311 * see whether the host or the device is offline.
312 *
313 * Return value:
314 * 0 when dev was taken offline by error recovery. 1 OK to proceed.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800315 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316int scsi_block_when_processing_errors(struct scsi_device *sdev)
317{
318 int online;
319
James Bottomley939647e2005-09-18 15:05:20 -0500320 wait_event(sdev->host->host_wait, !scsi_host_in_recovery(sdev->host));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
322 online = scsi_device_online(sdev);
323
Hannes Reinecke91921e02014-06-25 16:39:59 +0200324 SCSI_LOG_ERROR_RECOVERY(5, sdev_printk(KERN_INFO, sdev,
325 "%s: rtn: %d\n", __func__, online));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326
327 return online;
328}
329EXPORT_SYMBOL(scsi_block_when_processing_errors);
330
331#ifdef CONFIG_SCSI_LOGGING
332/**
333 * scsi_eh_prt_fail_stats - Log info on failures.
334 * @shost: scsi host being recovered.
335 * @work_q: Queue of scsi cmds to process.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800336 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337static inline void scsi_eh_prt_fail_stats(struct Scsi_Host *shost,
338 struct list_head *work_q)
339{
340 struct scsi_cmnd *scmd;
341 struct scsi_device *sdev;
342 int total_failures = 0;
343 int cmd_failed = 0;
344 int cmd_cancel = 0;
345 int devices_failed = 0;
346
347 shost_for_each_device(sdev, shost) {
348 list_for_each_entry(scmd, work_q, eh_entry) {
349 if (scmd->device == sdev) {
350 ++total_failures;
Christoph Hellwig3111b0d2005-06-19 13:43:26 +0200351 if (scmd->eh_eflags & SCSI_EH_CANCEL_CMD)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 ++cmd_cancel;
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100353 else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 ++cmd_failed;
355 }
356 }
357
358 if (cmd_cancel || cmd_failed) {
359 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea3a790d2014-10-24 14:27:03 +0200360 shost_printk(KERN_INFO, shost,
James Bottomley9ccfc752005-10-02 11:45:08 -0500361 "%s: cmds failed: %d, cancel: %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -0700362 __func__, cmd_failed,
James Bottomley9ccfc752005-10-02 11:45:08 -0500363 cmd_cancel));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 cmd_cancel = 0;
365 cmd_failed = 0;
366 ++devices_failed;
367 }
368 }
369
Hannes Reinecke91921e02014-06-25 16:39:59 +0200370 SCSI_LOG_ERROR_RECOVERY(2, shost_printk(KERN_INFO, shost,
371 "Total of %d commands on %d"
372 " devices require eh work\n",
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100373 total_failures, devices_failed));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374}
375#endif
376
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400377 /**
378 * scsi_report_lun_change - Set flag on all *other* devices on the same target
379 * to indicate that a UNIT ATTENTION is expected.
380 * @sdev: Device reporting the UNIT ATTENTION
381 */
382static void scsi_report_lun_change(struct scsi_device *sdev)
383{
384 sdev->sdev_target->expecting_lun_change = 1;
385}
386
387/**
388 * scsi_report_sense - Examine scsi sense information and log messages for
389 * certain conditions, also issue uevents for some of them.
390 * @sdev: Device reporting the sense code
391 * @sshdr: sshdr to be examined
392 */
393static void scsi_report_sense(struct scsi_device *sdev,
394 struct scsi_sense_hdr *sshdr)
395{
396 enum scsi_device_event evt_type = SDEV_EVT_MAXBITS; /* i.e. none */
397
398 if (sshdr->sense_key == UNIT_ATTENTION) {
399 if (sshdr->asc == 0x3f && sshdr->ascq == 0x03) {
400 evt_type = SDEV_EVT_INQUIRY_CHANGE_REPORTED;
401 sdev_printk(KERN_WARNING, sdev,
402 "Inquiry data has changed");
403 } else if (sshdr->asc == 0x3f && sshdr->ascq == 0x0e) {
404 evt_type = SDEV_EVT_LUN_CHANGE_REPORTED;
405 scsi_report_lun_change(sdev);
406 sdev_printk(KERN_WARNING, sdev,
407 "Warning! Received an indication that the "
408 "LUN assignments on this target have "
409 "changed. The Linux SCSI layer does not "
410 "automatically remap LUN assignments.\n");
411 } else if (sshdr->asc == 0x3f)
412 sdev_printk(KERN_WARNING, sdev,
413 "Warning! Received an indication that the "
414 "operating parameters on this target have "
415 "changed. The Linux SCSI layer does not "
416 "automatically adjust these parameters.\n");
417
418 if (sshdr->asc == 0x38 && sshdr->ascq == 0x07) {
419 evt_type = SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED;
420 sdev_printk(KERN_WARNING, sdev,
421 "Warning! Received an indication that the "
422 "LUN reached a thin provisioning soft "
423 "threshold.\n");
424 }
425
426 if (sshdr->asc == 0x2a && sshdr->ascq == 0x01) {
427 evt_type = SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED;
428 sdev_printk(KERN_WARNING, sdev,
429 "Mode parameters changed");
430 } else if (sshdr->asc == 0x2a && sshdr->ascq == 0x09) {
431 evt_type = SDEV_EVT_CAPACITY_CHANGE_REPORTED;
432 sdev_printk(KERN_WARNING, sdev,
433 "Capacity data has changed");
434 } else if (sshdr->asc == 0x2a)
435 sdev_printk(KERN_WARNING, sdev,
436 "Parameters changed");
437 }
438
439 if (evt_type != SDEV_EVT_MAXBITS) {
440 set_bit(evt_type, sdev->pending_events);
441 schedule_work(&sdev->event_work);
442 }
443}
444
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445/**
446 * scsi_check_sense - Examine scsi cmd sense
447 * @scmd: Cmd to have sense checked.
448 *
449 * Return value:
Hannes Reinecke87f14e62013-07-01 15:16:24 +0200450 * SUCCESS or FAILED or NEEDS_RETRY or ADD_TO_MLQUEUE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 *
452 * Notes:
453 * When a deferred error is detected the current command has
454 * not been executed and needs retrying.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800455 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456static int scsi_check_sense(struct scsi_cmnd *scmd)
457{
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700458 struct scsi_device *sdev = scmd->device;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 struct scsi_sense_hdr sshdr;
460
461 if (! scsi_command_normalize_sense(scmd, &sshdr))
462 return FAILED; /* no valid sense data */
463
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400464 scsi_report_sense(sdev, &sshdr);
465
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 if (scsi_sense_is_deferred(&sshdr))
467 return NEEDS_RETRY;
468
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700469 if (sdev->scsi_dh_data && sdev->scsi_dh_data->scsi_dh &&
470 sdev->scsi_dh_data->scsi_dh->check_sense) {
471 int rc;
472
473 rc = sdev->scsi_dh_data->scsi_dh->check_sense(sdev, &sshdr);
474 if (rc != SCSI_RETURN_NOT_HANDLED)
475 return rc;
476 /* handler does not care. Drop down to default handling */
477 }
478
Christoph Hellwige925cc42014-11-06 15:11:22 -0600479 if (scmd->cmnd[0] == TEST_UNIT_READY && scmd->scsi_done != scsi_eh_done)
480 /*
481 * nasty: for mid-layer issued TURs, we need to return the
482 * actual sense data without any recovery attempt. For eh
483 * issued ones, we need to try to recover and interpret
484 */
485 return SUCCESS;
486
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 /*
488 * Previous logic looked for FILEMARK, EOM or ILI which are
489 * mainly associated with tapes and returned SUCCESS.
490 */
491 if (sshdr.response_code == 0x70) {
492 /* fixed format */
493 if (scmd->sense_buffer[2] & 0xe0)
494 return SUCCESS;
495 } else {
496 /*
497 * descriptor format: look for "stream commands sense data
498 * descriptor" (see SSC-3). Assume single sense data
499 * descriptor. Ignore ILI from SBC-2 READ LONG and WRITE LONG.
500 */
501 if ((sshdr.additional_length > 3) &&
502 (scmd->sense_buffer[8] == 0x4) &&
503 (scmd->sense_buffer[11] & 0xe0))
504 return SUCCESS;
505 }
506
507 switch (sshdr.sense_key) {
508 case NO_SENSE:
509 return SUCCESS;
510 case RECOVERED_ERROR:
511 return /* soft_error */ SUCCESS;
512
513 case ABORTED_COMMAND:
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400514 if (sshdr.asc == 0x10) /* DIF */
515 return SUCCESS;
516
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 return NEEDS_RETRY;
518 case NOT_READY:
519 case UNIT_ATTENTION:
520 /*
521 * if we are expecting a cc/ua because of a bus reset that we
522 * performed, treat this just as a retry. otherwise this is
523 * information that we should pass up to the upper-level driver
524 * so that we can deal with it there.
525 */
526 if (scmd->device->expecting_cc_ua) {
TARUISI Hiroakidfcf7772011-08-11 20:25:20 +0900527 /*
528 * Because some device does not queue unit
529 * attentions correctly, we carefully check
530 * additional sense code and qualifier so as
531 * not to squash media change unit attention.
532 */
533 if (sshdr.asc != 0x28 || sshdr.ascq != 0x00) {
534 scmd->device->expecting_cc_ua = 0;
535 return NEEDS_RETRY;
536 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 }
538 /*
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400539 * we might also expect a cc/ua if another LUN on the target
540 * reported a UA with an ASC/ASCQ of 3F 0E -
541 * REPORTED LUNS DATA HAS CHANGED.
542 */
543 if (scmd->device->sdev_target->expecting_lun_change &&
544 sshdr.asc == 0x3f && sshdr.ascq == 0x0e)
545 return NEEDS_RETRY;
546 /*
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100547 * if the device is in the process of becoming ready, we
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 * should retry.
549 */
550 if ((sshdr.asc == 0x04) && (sshdr.ascq == 0x01))
551 return NEEDS_RETRY;
552 /*
553 * if the device is not started, we need to wake
554 * the error handler to start the motor
555 */
556 if (scmd->device->allow_restart &&
557 (sshdr.asc == 0x04) && (sshdr.ascq == 0x02))
558 return FAILED;
Christoph Hellwig02e031c2010-11-10 14:54:09 +0100559 /*
560 * Pass the UA upwards for a determination in the completion
561 * functions.
562 */
563 return SUCCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100565 /* these are not supported */
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200566 case DATA_PROTECT:
567 if (sshdr.asc == 0x27 && sshdr.ascq == 0x07) {
568 /* Thin provisioning hard threshold reached */
569 set_host_byte(scmd, DID_ALLOC_FAILURE);
570 return SUCCESS;
571 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 case COPY_ABORTED:
573 case VOLUME_OVERFLOW:
574 case MISCOMPARE:
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100575 case BLANK_CHECK:
Hannes Reinecke87f14e62013-07-01 15:16:24 +0200576 set_host_byte(scmd, DID_TARGET_FAILURE);
577 return SUCCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578
579 case MEDIUM_ERROR:
Luben Tuikovfd1b4942006-11-29 19:45:23 -0800580 if (sshdr.asc == 0x11 || /* UNRECOVERED READ ERR */
581 sshdr.asc == 0x13 || /* AMNF DATA FIELD */
582 sshdr.asc == 0x14) { /* RECORD NOT FOUND */
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200583 set_host_byte(scmd, DID_MEDIUM_ERROR);
Hannes Reinecke87f14e62013-07-01 15:16:24 +0200584 return SUCCESS;
Luben Tuikovfd1b4942006-11-29 19:45:23 -0800585 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 return NEEDS_RETRY;
587
588 case HARDWARE_ERROR:
589 if (scmd->device->retry_hwerror)
Mike Andersonbb0003c2008-08-12 12:11:58 -0700590 return ADD_TO_MLQUEUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 else
Hannes Reinecke87f14e62013-07-01 15:16:24 +0200592 set_host_byte(scmd, DID_TARGET_FAILURE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593
594 case ILLEGAL_REQUEST:
Mike Snitzer47ac56d2012-02-13 18:35:11 -0500595 if (sshdr.asc == 0x20 || /* Invalid command operation code */
596 sshdr.asc == 0x21 || /* Logical block address out of range */
597 sshdr.asc == 0x24 || /* Invalid field in cdb */
598 sshdr.asc == 0x26) { /* Parameter value invalid */
Hannes Reinecke87f14e62013-07-01 15:16:24 +0200599 set_host_byte(scmd, DID_TARGET_FAILURE);
Mike Snitzer47ac56d2012-02-13 18:35:11 -0500600 }
601 return SUCCESS;
602
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 default:
604 return SUCCESS;
605 }
606}
607
Vasu Dev4a840672009-10-22 15:46:33 -0700608static void scsi_handle_queue_ramp_up(struct scsi_device *sdev)
609{
610 struct scsi_host_template *sht = sdev->host->hostt;
611 struct scsi_device *tmp_sdev;
612
Christoph Hellwigc40ecc12014-11-13 14:25:11 +0100613 if (!sht->track_queue_depth ||
Vasu Dev4a840672009-10-22 15:46:33 -0700614 sdev->queue_depth >= sdev->max_queue_depth)
615 return;
616
617 if (time_before(jiffies,
618 sdev->last_queue_ramp_up + sdev->queue_ramp_up_period))
619 return;
620
621 if (time_before(jiffies,
622 sdev->last_queue_full_time + sdev->queue_ramp_up_period))
623 return;
624
625 /*
626 * Walk all devices of a target and do
627 * ramp up on them.
628 */
629 shost_for_each_device(tmp_sdev, sdev->host) {
630 if (tmp_sdev->channel != sdev->channel ||
631 tmp_sdev->id != sdev->id ||
632 tmp_sdev->queue_depth == sdev->max_queue_depth)
633 continue;
Christoph Hellwigc40ecc12014-11-13 14:25:11 +0100634
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100635 scsi_change_queue_depth(tmp_sdev, tmp_sdev->queue_depth + 1);
Vasu Dev4a840672009-10-22 15:46:33 -0700636 sdev->last_queue_ramp_up = jiffies;
637 }
638}
639
Mike Christie42a6a912009-10-15 17:46:44 -0700640static void scsi_handle_queue_full(struct scsi_device *sdev)
641{
642 struct scsi_host_template *sht = sdev->host->hostt;
643 struct scsi_device *tmp_sdev;
644
Christoph Hellwigc40ecc12014-11-13 14:25:11 +0100645 if (!sht->track_queue_depth)
Mike Christie42a6a912009-10-15 17:46:44 -0700646 return;
647
648 shost_for_each_device(tmp_sdev, sdev->host) {
649 if (tmp_sdev->channel != sdev->channel ||
650 tmp_sdev->id != sdev->id)
651 continue;
652 /*
653 * We do not know the number of commands that were at
654 * the device when we got the queue full so we start
655 * from the highest possible value and work our way down.
656 */
Christoph Hellwigc40ecc12014-11-13 14:25:11 +0100657 scsi_track_queue_full(tmp_sdev, tmp_sdev->queue_depth - 1);
Mike Christie42a6a912009-10-15 17:46:44 -0700658 }
659}
660
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661/**
662 * scsi_eh_completed_normally - Disposition a eh cmd on return from LLD.
663 * @scmd: SCSI cmd to examine.
664 *
665 * Notes:
666 * This is *only* called when we are examining the status of commands
667 * queued during error recovery. the main difference here is that we
668 * don't allow for the possibility of retries here, and we are a lot
669 * more restrictive about what we consider acceptable.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800670 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671static int scsi_eh_completed_normally(struct scsi_cmnd *scmd)
672{
673 /*
674 * first check the host byte, to see if there is anything in there
675 * that would indicate what we need to do.
676 */
677 if (host_byte(scmd->result) == DID_RESET) {
678 /*
679 * rats. we are already in the error handler, so we now
680 * get to try and figure out what to do next. if the sense
681 * is valid, we have a pretty good idea of what to do.
682 * if not, we mark it as FAILED.
683 */
684 return scsi_check_sense(scmd);
685 }
686 if (host_byte(scmd->result) != DID_OK)
687 return FAILED;
688
689 /*
690 * next, check the message byte.
691 */
692 if (msg_byte(scmd->result) != COMMAND_COMPLETE)
693 return FAILED;
694
695 /*
696 * now, check the status byte to see if this indicates
697 * anything special.
698 */
699 switch (status_byte(scmd->result)) {
700 case GOOD:
Vasu Dev4a840672009-10-22 15:46:33 -0700701 scsi_handle_queue_ramp_up(scmd->device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 case COMMAND_TERMINATED:
703 return SUCCESS;
704 case CHECK_CONDITION:
705 return scsi_check_sense(scmd);
706 case CONDITION_GOOD:
707 case INTERMEDIATE_GOOD:
708 case INTERMEDIATE_C_GOOD:
709 /*
710 * who knows? FIXME(eric)
711 */
712 return SUCCESS;
Michael Reed5f91bb02009-08-10 11:59:28 -0500713 case RESERVATION_CONFLICT:
James Bottomley67110df2010-08-06 15:17:24 -0500714 if (scmd->cmnd[0] == TEST_UNIT_READY)
715 /* it is a success, we probed the device and
716 * found it */
717 return SUCCESS;
718 /* otherwise, we failed to send the command */
719 return FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 case QUEUE_FULL:
Mike Christie42a6a912009-10-15 17:46:44 -0700721 scsi_handle_queue_full(scmd->device);
722 /* fall through */
723 case BUSY:
Hannes Reinecke3eb3a922010-07-29 10:10:16 +0200724 return NEEDS_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 default:
726 return FAILED;
727 }
728 return FAILED;
729}
730
731/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 * scsi_eh_done - Completion function for error handling.
733 * @scmd: Cmd that is done.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800734 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735static void scsi_eh_done(struct scsi_cmnd *scmd)
736{
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100737 struct completion *eh_action;
Michael Reed85631672005-12-07 21:46:27 -0600738
Hannes Reinecke91921e02014-06-25 16:39:59 +0200739 SCSI_LOG_ERROR_RECOVERY(3, scmd_printk(KERN_INFO, scmd,
740 "%s scmd: %p result: %x\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -0700741 __func__, scmd, scmd->result));
Michael Reed85631672005-12-07 21:46:27 -0600742
743 eh_action = scmd->device->host->eh_action;
744 if (eh_action)
745 complete(eh_action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746}
747
748/**
Brian King292148f2007-01-30 17:51:17 -0600749 * scsi_try_host_reset - ask host adapter to reset itself
Geert Uytterhoevenc2b3ebd2013-05-17 13:22:29 +0200750 * @scmd: SCSI cmd to send host reset.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800751 */
Brian King292148f2007-01-30 17:51:17 -0600752static int scsi_try_host_reset(struct scsi_cmnd *scmd)
753{
754 unsigned long flags;
755 int rtn;
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100756 struct Scsi_Host *host = scmd->device->host;
757 struct scsi_host_template *hostt = host->hostt;
Brian King292148f2007-01-30 17:51:17 -0600758
Hannes Reinecke91921e02014-06-25 16:39:59 +0200759 SCSI_LOG_ERROR_RECOVERY(3,
760 shost_printk(KERN_INFO, host, "Snd Host RST\n"));
Brian King292148f2007-01-30 17:51:17 -0600761
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100762 if (!hostt->eh_host_reset_handler)
Brian King292148f2007-01-30 17:51:17 -0600763 return FAILED;
764
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100765 rtn = hostt->eh_host_reset_handler(scmd);
Brian King292148f2007-01-30 17:51:17 -0600766
767 if (rtn == SUCCESS) {
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100768 if (!hostt->skip_settle_delay)
Brian King292148f2007-01-30 17:51:17 -0600769 ssleep(HOST_RESET_SETTLE_TIME);
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100770 spin_lock_irqsave(host->host_lock, flags);
771 scsi_report_bus_reset(host, scmd_channel(scmd));
772 spin_unlock_irqrestore(host->host_lock, flags);
Brian King292148f2007-01-30 17:51:17 -0600773 }
774
775 return rtn;
776}
777
778/**
779 * scsi_try_bus_reset - ask host to perform a bus reset
780 * @scmd: SCSI cmd to send bus reset.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800781 */
Brian King292148f2007-01-30 17:51:17 -0600782static int scsi_try_bus_reset(struct scsi_cmnd *scmd)
783{
784 unsigned long flags;
785 int rtn;
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100786 struct Scsi_Host *host = scmd->device->host;
787 struct scsi_host_template *hostt = host->hostt;
Brian King292148f2007-01-30 17:51:17 -0600788
Hannes Reinecke91921e02014-06-25 16:39:59 +0200789 SCSI_LOG_ERROR_RECOVERY(3, scmd_printk(KERN_INFO, scmd,
790 "%s: Snd Bus RST\n", __func__));
Brian King292148f2007-01-30 17:51:17 -0600791
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100792 if (!hostt->eh_bus_reset_handler)
Brian King292148f2007-01-30 17:51:17 -0600793 return FAILED;
794
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100795 rtn = hostt->eh_bus_reset_handler(scmd);
Brian King292148f2007-01-30 17:51:17 -0600796
797 if (rtn == SUCCESS) {
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100798 if (!hostt->skip_settle_delay)
Brian King292148f2007-01-30 17:51:17 -0600799 ssleep(BUS_RESET_SETTLE_TIME);
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100800 spin_lock_irqsave(host->host_lock, flags);
801 scsi_report_bus_reset(host, scmd_channel(scmd));
802 spin_unlock_irqrestore(host->host_lock, flags);
Brian King292148f2007-01-30 17:51:17 -0600803 }
804
805 return rtn;
806}
807
Mike Christie30bd7df2008-02-29 18:25:19 -0600808static void __scsi_report_device_reset(struct scsi_device *sdev, void *data)
809{
810 sdev->was_reset = 1;
811 sdev->expecting_cc_ua = 1;
812}
813
814/**
815 * scsi_try_target_reset - Ask host to perform a target reset
816 * @scmd: SCSI cmd used to send a target reset
817 *
818 * Notes:
819 * There is no timeout for this operation. if this operation is
820 * unreliable for a given host, then the host itself needs to put a
821 * timer on it, and set the host back to a consistent state prior to
822 * returning.
823 */
824static int scsi_try_target_reset(struct scsi_cmnd *scmd)
825{
826 unsigned long flags;
827 int rtn;
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100828 struct Scsi_Host *host = scmd->device->host;
829 struct scsi_host_template *hostt = host->hostt;
Mike Christie30bd7df2008-02-29 18:25:19 -0600830
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100831 if (!hostt->eh_target_reset_handler)
Mike Christie30bd7df2008-02-29 18:25:19 -0600832 return FAILED;
833
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100834 rtn = hostt->eh_target_reset_handler(scmd);
Mike Christie30bd7df2008-02-29 18:25:19 -0600835 if (rtn == SUCCESS) {
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100836 spin_lock_irqsave(host->host_lock, flags);
Mike Christie30bd7df2008-02-29 18:25:19 -0600837 __starget_for_each_device(scsi_target(scmd->device), NULL,
838 __scsi_report_device_reset);
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100839 spin_unlock_irqrestore(host->host_lock, flags);
Mike Christie30bd7df2008-02-29 18:25:19 -0600840 }
841
842 return rtn;
843}
844
Brian King292148f2007-01-30 17:51:17 -0600845/**
846 * scsi_try_bus_device_reset - Ask host to perform a BDR on a dev
847 * @scmd: SCSI cmd used to send BDR
848 *
849 * Notes:
850 * There is no timeout for this operation. if this operation is
851 * unreliable for a given host, then the host itself needs to put a
852 * timer on it, and set the host back to a consistent state prior to
853 * returning.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800854 */
Brian King292148f2007-01-30 17:51:17 -0600855static int scsi_try_bus_device_reset(struct scsi_cmnd *scmd)
856{
857 int rtn;
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100858 struct scsi_host_template *hostt = scmd->device->host->hostt;
Brian King292148f2007-01-30 17:51:17 -0600859
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100860 if (!hostt->eh_device_reset_handler)
Brian King292148f2007-01-30 17:51:17 -0600861 return FAILED;
862
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100863 rtn = hostt->eh_device_reset_handler(scmd);
Mike Christie30bd7df2008-02-29 18:25:19 -0600864 if (rtn == SUCCESS)
865 __scsi_report_device_reset(scmd->device, NULL);
Brian King292148f2007-01-30 17:51:17 -0600866 return rtn;
867}
868
Hannes Reinecke883a0302014-10-24 14:27:04 +0200869/**
870 * scsi_try_to_abort_cmd - Ask host to abort a SCSI command
871 * @scmd: SCSI cmd used to send a target reset
872 *
873 * Return value:
874 * SUCCESS, FAILED, or FAST_IO_FAIL
875 *
876 * Notes:
877 * SUCCESS does not necessarily indicate that the command
878 * has been aborted; it only indicates that the LLDDs
879 * has cleared all references to that command.
880 * LLDDs should return FAILED only if an abort was required
881 * but could not be executed. LLDDs should return FAST_IO_FAIL
882 * if the device is temporarily unavailable (eg due to a
883 * link down on FibreChannel)
884 */
885static int scsi_try_to_abort_cmd(struct scsi_host_template *hostt,
886 struct scsi_cmnd *scmd)
Brian King292148f2007-01-30 17:51:17 -0600887{
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100888 if (!hostt->eh_abort_handler)
Brian King292148f2007-01-30 17:51:17 -0600889 return FAILED;
890
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100891 return hostt->eh_abort_handler(scmd);
Brian King292148f2007-01-30 17:51:17 -0600892}
893
Brian King292148f2007-01-30 17:51:17 -0600894static void scsi_abort_eh_cmnd(struct scsi_cmnd *scmd)
895{
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100896 if (scsi_try_to_abort_cmd(scmd->device->host->hostt, scmd) != SUCCESS)
Brian King292148f2007-01-30 17:51:17 -0600897 if (scsi_try_bus_device_reset(scmd) != SUCCESS)
Mike Christie30bd7df2008-02-29 18:25:19 -0600898 if (scsi_try_target_reset(scmd) != SUCCESS)
899 if (scsi_try_bus_reset(scmd) != SUCCESS)
900 scsi_try_host_reset(scmd);
Brian King292148f2007-01-30 17:51:17 -0600901}
902
903/**
Santosh Y3b729f72012-04-08 18:47:09 +0530904 * scsi_eh_prep_cmnd - Save a scsi command info as part of error recovery
Christoph Hellwig2dc611d2006-11-04 20:04:21 +0100905 * @scmd: SCSI command structure to hijack
Boaz Harroshe1c23462007-10-08 16:36:45 +0200906 * @ses: structure to save restore information
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200907 * @cmnd: CDB to send. Can be NULL if no new cmnd is needed
Boaz Harrosh64a87b22008-04-30 11:19:47 +0300908 * @cmnd_size: size in bytes of @cmnd (must be <= BLK_MAX_CDB)
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200909 * @sense_bytes: size of sense data to copy. or 0 (if != 0 @cmnd is ignored)
Christoph Hellwig2dc611d2006-11-04 20:04:21 +0100910 *
Boaz Harroshe1c23462007-10-08 16:36:45 +0200911 * This function is used to save a scsi command information before re-execution
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200912 * as part of the error recovery process. If @sense_bytes is 0 the command
913 * sent must be one that does not transfer any data. If @sense_bytes != 0
914 * @cmnd is ignored and this functions sets up a REQUEST_SENSE command
915 * and cmnd buffers to read @sense_bytes into @scmd->sense_buffer.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800916 */
Boaz Harroshe1c23462007-10-08 16:36:45 +0200917void scsi_eh_prep_cmnd(struct scsi_cmnd *scmd, struct scsi_eh_save *ses,
918 unsigned char *cmnd, int cmnd_size, unsigned sense_bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919{
f59114b2005-04-17 15:00:23 -0500920 struct scsi_device *sdev = scmd->device;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
Christoph Hellwig631c2282006-07-08 20:42:15 +0200922 /*
923 * We need saved copies of a number of fields - this is because
924 * error handling may need to overwrite these with different values
925 * to run different commands, and once error handling is complete,
926 * we will need to restore these values prior to running the actual
927 * command.
928 */
Boaz Harroshe1c23462007-10-08 16:36:45 +0200929 ses->cmd_len = scmd->cmd_len;
Boaz Harrosh64a87b22008-04-30 11:19:47 +0300930 ses->cmnd = scmd->cmnd;
Boaz Harroshe1c23462007-10-08 16:36:45 +0200931 ses->data_direction = scmd->sc_data_direction;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200932 ses->sdb = scmd->sdb;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200933 ses->next_rq = scmd->request->next_rq;
Boaz Harroshe1c23462007-10-08 16:36:45 +0200934 ses->result = scmd->result;
Alan Stern12265702008-07-21 10:25:52 -0400935 ses->underflow = scmd->underflow;
Martin K. Petersendb007fc2008-07-17 04:28:31 -0400936 ses->prot_op = scmd->prot_op;
Christoph Hellwig631c2282006-07-08 20:42:15 +0200937
Martin K. Petersendb007fc2008-07-17 04:28:31 -0400938 scmd->prot_op = SCSI_PROT_NORMAL;
James Bottomleyc69e6f82014-04-10 13:36:11 -0700939 scmd->eh_eflags = 0;
Boaz Harrosh64a87b22008-04-30 11:19:47 +0300940 scmd->cmnd = ses->eh_cmnd;
941 memset(scmd->cmnd, 0, BLK_MAX_CDB);
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200942 memset(&scmd->sdb, 0, sizeof(scmd->sdb));
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200943 scmd->request->next_rq = NULL;
Alan Stern644373a2014-03-28 10:51:15 -0700944 scmd->result = 0;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200945
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200946 if (sense_bytes) {
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200947 scmd->sdb.length = min_t(unsigned, SCSI_SENSE_BUFFERSIZE,
948 sense_bytes);
Boaz Harroshe1c23462007-10-08 16:36:45 +0200949 sg_init_one(&ses->sense_sgl, scmd->sense_buffer,
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200950 scmd->sdb.length);
951 scmd->sdb.table.sgl = &ses->sense_sgl;
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200952 scmd->sc_data_direction = DMA_FROM_DEVICE;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200953 scmd->sdb.table.nents = 1;
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200954 scmd->cmnd[0] = REQUEST_SENSE;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200955 scmd->cmnd[4] = scmd->sdb.length;
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200956 scmd->cmd_len = COMMAND_SIZE(scmd->cmnd[0]);
Christoph Hellwig631c2282006-07-08 20:42:15 +0200957 } else {
Christoph Hellwig631c2282006-07-08 20:42:15 +0200958 scmd->sc_data_direction = DMA_NONE;
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200959 if (cmnd) {
Boaz Harrosh64a87b22008-04-30 11:19:47 +0300960 BUG_ON(cmnd_size > BLK_MAX_CDB);
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200961 memcpy(scmd->cmnd, cmnd, cmnd_size);
962 scmd->cmd_len = COMMAND_SIZE(scmd->cmnd[0]);
963 }
Christoph Hellwig631c2282006-07-08 20:42:15 +0200964 }
965
966 scmd->underflow = 0;
Christoph Hellwig631c2282006-07-08 20:42:15 +0200967
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200968 if (sdev->scsi_level <= SCSI_2 && sdev->scsi_level != SCSI_UNKNOWN)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 scmd->cmnd[1] = (scmd->cmnd[1] & 0x1f) |
f59114b2005-04-17 15:00:23 -0500970 (sdev->lun << 5 & 0xe0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971
Christoph Hellwig631c2282006-07-08 20:42:15 +0200972 /*
973 * Zero the sense buffer. The scsi spec mandates that any
974 * untransferred sense data should be interpreted as being zero.
975 */
FUJITA Tomonorib80ca4f2008-01-13 15:46:13 +0900976 memset(scmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Boaz Harroshe1c23462007-10-08 16:36:45 +0200977}
978EXPORT_SYMBOL(scsi_eh_prep_cmnd);
Christoph Hellwig631c2282006-07-08 20:42:15 +0200979
Boaz Harroshe1c23462007-10-08 16:36:45 +0200980/**
Santosh Y3b729f72012-04-08 18:47:09 +0530981 * scsi_eh_restore_cmnd - Restore a scsi command info as part of error recovery
Boaz Harroshe1c23462007-10-08 16:36:45 +0200982 * @scmd: SCSI command structure to restore
Bartlomiej Zolnierkiewicz477e6082009-04-27 20:54:22 +0200983 * @ses: saved information from a coresponding call to scsi_eh_prep_cmnd
Boaz Harroshe1c23462007-10-08 16:36:45 +0200984 *
Bartlomiej Zolnierkiewicz477e6082009-04-27 20:54:22 +0200985 * Undo any damage done by above scsi_eh_prep_cmnd().
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800986 */
Boaz Harroshe1c23462007-10-08 16:36:45 +0200987void scsi_eh_restore_cmnd(struct scsi_cmnd* scmd, struct scsi_eh_save *ses)
988{
989 /*
990 * Restore original data
991 */
992 scmd->cmd_len = ses->cmd_len;
Boaz Harrosh64a87b22008-04-30 11:19:47 +0300993 scmd->cmnd = ses->cmnd;
Boaz Harroshe1c23462007-10-08 16:36:45 +0200994 scmd->sc_data_direction = ses->data_direction;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200995 scmd->sdb = ses->sdb;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200996 scmd->request->next_rq = ses->next_rq;
Boaz Harroshe1c23462007-10-08 16:36:45 +0200997 scmd->result = ses->result;
Alan Stern12265702008-07-21 10:25:52 -0400998 scmd->underflow = ses->underflow;
Martin K. Petersendb007fc2008-07-17 04:28:31 -0400999 scmd->prot_op = ses->prot_op;
Boaz Harroshe1c23462007-10-08 16:36:45 +02001000}
1001EXPORT_SYMBOL(scsi_eh_restore_cmnd);
1002
1003/**
Santosh Y3b729f72012-04-08 18:47:09 +05301004 * scsi_send_eh_cmnd - submit a scsi command as part of error recovery
Boaz Harroshe1c23462007-10-08 16:36:45 +02001005 * @scmd: SCSI command structure to hijack
1006 * @cmnd: CDB to send
1007 * @cmnd_size: size in bytes of @cmnd
1008 * @timeout: timeout for this request
1009 * @sense_bytes: size of sense data to copy or 0
1010 *
1011 * This function is used to send a scsi command down to a target device
1012 * as part of the error recovery process. See also scsi_eh_prep_cmnd() above.
1013 *
1014 * Return value:
1015 * SUCCESS or FAILED or NEEDS_RETRY
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001016 */
Boaz Harroshe1c23462007-10-08 16:36:45 +02001017static int scsi_send_eh_cmnd(struct scsi_cmnd *scmd, unsigned char *cmnd,
1018 int cmnd_size, int timeout, unsigned sense_bytes)
1019{
1020 struct scsi_device *sdev = scmd->device;
1021 struct Scsi_Host *shost = sdev->host;
1022 DECLARE_COMPLETION_ONSTACK(done);
Hannes Reineckefc736482013-04-25 08:10:00 +02001023 unsigned long timeleft = timeout;
Boaz Harroshe1c23462007-10-08 16:36:45 +02001024 struct scsi_eh_save ses;
Hannes Reineckefc736482013-04-25 08:10:00 +02001025 const unsigned long stall_for = msecs_to_jiffies(100);
Boaz Harroshe1c23462007-10-08 16:36:45 +02001026 int rtn;
1027
Hannes Reineckefc736482013-04-25 08:10:00 +02001028retry:
Boaz Harroshe1c23462007-10-08 16:36:45 +02001029 scsi_eh_prep_cmnd(scmd, &ses, cmnd, cmnd_size, sense_bytes);
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +01001030 shost->eh_action = &done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 scsi_log_send(scmd);
Jeff Garzikf2812332010-11-16 02:10:29 -05001033 scmd->scsi_done = scsi_eh_done;
Hannes Reineckefc736482013-04-25 08:10:00 +02001034 rtn = shost->hostt->queuecommand(shost, scmd);
1035 if (rtn) {
1036 if (timeleft > stall_for) {
1037 scsi_eh_restore_cmnd(scmd, &ses);
1038 timeleft -= stall_for;
1039 msleep(jiffies_to_msecs(stall_for));
1040 goto retry;
1041 }
1042 /* signal not to enter either branch of the if () below */
1043 timeleft = 0;
Alan Stern511833a2014-11-21 10:44:49 -05001044 rtn = FAILED;
Hannes Reineckefc736482013-04-25 08:10:00 +02001045 } else {
1046 timeleft = wait_for_completion_timeout(&done, timeout);
Hannes Reineckeac61d192014-05-08 08:09:56 +02001047 rtn = SUCCESS;
Hannes Reineckefc736482013-04-25 08:10:00 +02001048 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049
f59114b2005-04-17 15:00:23 -05001050 shost->eh_action = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051
Hannes Reineckefc736482013-04-25 08:10:00 +02001052 scsi_log_completion(scmd, rtn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053
Hannes Reinecke91921e02014-06-25 16:39:59 +02001054 SCSI_LOG_ERROR_RECOVERY(3, scmd_printk(KERN_INFO, scmd,
1055 "%s: scmd: %p, timeleft: %ld\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -07001056 __func__, scmd, timeleft));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057
1058 /*
Hannes Reineckefc736482013-04-25 08:10:00 +02001059 * If there is time left scsi_eh_done got called, and we will examine
1060 * the actual status codes to see whether the command actually did
1061 * complete normally, else if we have a zero return and no time left,
1062 * the command must still be pending, so abort it and return FAILED.
1063 * If we never actually managed to issue the command, because
1064 * ->queuecommand() kept returning non zero, use the rtn = FAILED
1065 * value above (so don't execute either branch of the if)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 */
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +01001067 if (timeleft) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 rtn = scsi_eh_completed_normally(scmd);
Hannes Reinecke91921e02014-06-25 16:39:59 +02001069 SCSI_LOG_ERROR_RECOVERY(3, scmd_printk(KERN_INFO, scmd,
1070 "%s: scsi_eh_completed_normally %x\n", __func__, rtn));
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +01001071
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 switch (rtn) {
1073 case SUCCESS:
1074 case NEEDS_RETRY:
1075 case FAILED:
1076 break;
Hannes Reinecke6e883b02009-09-17 17:00:26 +02001077 case ADD_TO_MLQUEUE:
1078 rtn = NEEDS_RETRY;
1079 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 default:
1081 rtn = FAILED;
1082 break;
1083 }
Alan Stern511833a2014-11-21 10:44:49 -05001084 } else if (rtn != FAILED) {
Brian King292148f2007-01-30 17:51:17 -06001085 scsi_abort_eh_cmnd(scmd);
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +01001086 rtn = FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 }
1088
Boaz Harroshe1c23462007-10-08 16:36:45 +02001089 scsi_eh_restore_cmnd(scmd, &ses);
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001090
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 return rtn;
1092}
1093
1094/**
1095 * scsi_request_sense - Request sense data from a particular target.
1096 * @scmd: SCSI cmd for request sense.
1097 *
1098 * Notes:
1099 * Some hosts automatically obtain this information, others require
1100 * that we obtain it on our own. This function will *not* return until
1101 * the command either times out, or it completes.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001102 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103static int scsi_request_sense(struct scsi_cmnd *scmd)
1104{
Martin K. Petersen0816c922013-05-10 10:36:04 -04001105 return scsi_send_eh_cmnd(scmd, NULL, 0, scmd->device->eh_timeout, ~0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106}
1107
James Bottomley24510792013-11-11 13:44:53 +01001108static int scsi_eh_action(struct scsi_cmnd *scmd, int rtn)
1109{
1110 if (scmd->request->cmd_type != REQ_TYPE_BLOCK_PC) {
1111 struct scsi_driver *sdrv = scsi_cmd_to_driver(scmd);
1112 if (sdrv->eh_action)
1113 rtn = sdrv->eh_action(scmd, rtn);
1114 }
1115 return rtn;
1116}
1117
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118/**
1119 * scsi_eh_finish_cmd - Handle a cmd that eh is finished with.
1120 * @scmd: Original SCSI cmd that eh has finished.
1121 * @done_q: Queue for processed commands.
1122 *
1123 * Notes:
1124 * We don't want to use the normal command completion while we are are
1125 * still handling errors - it may cause other commands to be queued,
Rob Landleyeb448202007-11-03 13:30:39 -05001126 * and that would disturb what we are doing. Thus we really want to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 * keep a list of pending commands for final completion, and once we
1128 * are ready to leave error handling we handle completion for real.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001129 */
Tejun Heo041c5fc2006-01-23 13:09:36 +09001130void scsi_eh_finish_cmd(struct scsi_cmnd *scmd, struct list_head *done_q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131{
1132 scmd->device->host->host_failed--;
Christoph Hellwig3111b0d2005-06-19 13:43:26 +02001133 scmd->eh_eflags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 list_move_tail(&scmd->eh_entry, done_q);
1135}
Tejun Heo041c5fc2006-01-23 13:09:36 +09001136EXPORT_SYMBOL(scsi_eh_finish_cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137
1138/**
1139 * scsi_eh_get_sense - Get device sense data.
1140 * @work_q: Queue of commands to process.
Rob Landleyeb448202007-11-03 13:30:39 -05001141 * @done_q: Queue of processed commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 *
1143 * Description:
1144 * See if we need to request sense information. if so, then get it
Jesper Juhl0bf8c862011-03-21 20:47:31 +01001145 * now, so we have a better idea of what to do.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 *
1147 * Notes:
1148 * This has the unfortunate side effect that if a shost adapter does
Rob Landleyeb448202007-11-03 13:30:39 -05001149 * not automatically request sense information, we end up shutting
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 * it down before we request it.
1151 *
1152 * All drivers should request sense information internally these days,
1153 * so for now all I have to say is tough noogies if you end up in here.
1154 *
1155 * XXX: Long term this code should go away, but that needs an audit of
1156 * all LLDDs first.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001157 */
Darrick J. Wongdca84e42007-01-26 14:08:49 -08001158int scsi_eh_get_sense(struct list_head *work_q,
1159 struct list_head *done_q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001161 struct scsi_cmnd *scmd, *next;
Hannes Reineckeb4562022013-10-23 10:51:21 +02001162 struct Scsi_Host *shost;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 int rtn;
1164
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001165 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
Christoph Hellwig3111b0d2005-06-19 13:43:26 +02001166 if ((scmd->eh_eflags & SCSI_EH_CANCEL_CMD) ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 SCSI_SENSE_VALID(scmd))
1168 continue;
1169
Hannes Reineckeb4562022013-10-23 10:51:21 +02001170 shost = scmd->device->host;
Hannes Reineckeb4562022013-10-23 10:51:21 +02001171 if (scsi_host_eh_past_deadline(shost)) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001172 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001173 scmd_printk(KERN_INFO, scmd,
1174 "%s: skip request sense, past eh deadline\n",
1175 current->comm));
Hannes Reineckeb4562022013-10-23 10:51:21 +02001176 break;
1177 }
James Bottomleyd555a2a2014-03-28 10:50:17 -07001178 if (status_byte(scmd->result) != CHECK_CONDITION)
1179 /*
1180 * don't request sense if there's no check condition
1181 * status because the error we're processing isn't one
1182 * that has a sense code (and some devices get
1183 * confused by sense requests out of the blue)
1184 */
1185 continue;
1186
Jeff Garzik3bf743e2005-10-24 18:04:06 -04001187 SCSI_LOG_ERROR_RECOVERY(2, scmd_printk(KERN_INFO, scmd,
1188 "%s: requesting sense\n",
1189 current->comm));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190 rtn = scsi_request_sense(scmd);
1191 if (rtn != SUCCESS)
1192 continue;
1193
Hannes Reinecke91921e02014-06-25 16:39:59 +02001194 SCSI_LOG_ERROR_RECOVERY(3, scmd_printk(KERN_INFO, scmd,
1195 "sense requested for %p result %x\n",
1196 scmd, scmd->result));
Hannes Reinecked811b842014-10-24 14:26:45 +02001197 SCSI_LOG_ERROR_RECOVERY(3, scsi_print_sense(scmd));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198
1199 rtn = scsi_decide_disposition(scmd);
1200
1201 /*
1202 * if the result was normal, then just pass it along to the
1203 * upper level.
1204 */
1205 if (rtn == SUCCESS)
1206 /* we don't want this command reissued, just
1207 * finished with the sense data, so set
1208 * retries to the max allowed to ensure it
1209 * won't get reissued */
1210 scmd->retries = scmd->allowed;
1211 else if (rtn != NEEDS_RETRY)
1212 continue;
1213
1214 scsi_eh_finish_cmd(scmd, done_q);
1215 }
1216
1217 return list_empty(work_q);
1218}
Darrick J. Wongdca84e42007-01-26 14:08:49 -08001219EXPORT_SYMBOL_GPL(scsi_eh_get_sense);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220
1221/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 * scsi_eh_tur - Send TUR to device.
Rob Landleyeb448202007-11-03 13:30:39 -05001223 * @scmd: &scsi_cmnd to send TUR
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 *
1225 * Return value:
1226 * 0 - Device is ready. 1 - Device NOT ready.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001227 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228static int scsi_eh_tur(struct scsi_cmnd *scmd)
1229{
1230 static unsigned char tur_command[6] = {TEST_UNIT_READY, 0, 0, 0, 0, 0};
1231 int retry_cnt = 1, rtn;
1232
1233retry_tur:
Martin K. Petersen0816c922013-05-10 10:36:04 -04001234 rtn = scsi_send_eh_cmnd(scmd, tur_command, 6,
1235 scmd->device->eh_timeout, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236
Hannes Reinecke91921e02014-06-25 16:39:59 +02001237 SCSI_LOG_ERROR_RECOVERY(3, scmd_printk(KERN_INFO, scmd,
1238 "%s: scmd %p rtn %x\n", __func__, scmd, rtn));
Christoph Hellwig631c2282006-07-08 20:42:15 +02001239
1240 switch (rtn) {
1241 case NEEDS_RETRY:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 if (retry_cnt--)
1243 goto retry_tur;
Christoph Hellwig631c2282006-07-08 20:42:15 +02001244 /*FALLTHRU*/
1245 case SUCCESS:
Alan Sterne47373e2005-03-30 15:05:45 -05001246 return 0;
Christoph Hellwig631c2282006-07-08 20:42:15 +02001247 default:
1248 return 1;
Alan Sterne47373e2005-03-30 15:05:45 -05001249 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250}
1251
1252/**
David Jeffery3eef6252011-05-19 14:41:12 -04001253 * scsi_eh_test_devices - check if devices are responding from error recovery.
1254 * @cmd_list: scsi commands in error recovery.
Randy Dunlap74cf2982014-08-16 14:15:11 -07001255 * @work_q: queue for commands which still need more error recovery
1256 * @done_q: queue for commands which are finished
1257 * @try_stu: boolean on if a STU command should be tried in addition to TUR.
David Jeffery3eef6252011-05-19 14:41:12 -04001258 *
1259 * Decription:
1260 * Tests if devices are in a working state. Commands to devices now in
1261 * a working state are sent to the done_q while commands to devices which
1262 * are still failing to respond are returned to the work_q for more
1263 * processing.
1264 **/
1265static int scsi_eh_test_devices(struct list_head *cmd_list,
1266 struct list_head *work_q,
1267 struct list_head *done_q, int try_stu)
1268{
1269 struct scsi_cmnd *scmd, *next;
1270 struct scsi_device *sdev;
1271 int finish_cmds;
1272
1273 while (!list_empty(cmd_list)) {
1274 scmd = list_entry(cmd_list->next, struct scsi_cmnd, eh_entry);
1275 sdev = scmd->device;
1276
Hannes Reineckeb4562022013-10-23 10:51:21 +02001277 if (!try_stu) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001278 if (scsi_host_eh_past_deadline(sdev->host)) {
1279 /* Push items back onto work_q */
1280 list_splice_init(cmd_list, work_q);
Hannes Reineckeb4562022013-10-23 10:51:21 +02001281 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001282 sdev_printk(KERN_INFO, sdev,
1283 "%s: skip test device, past eh deadline",
1284 current->comm));
Hannes Reineckeb4562022013-10-23 10:51:21 +02001285 break;
1286 }
Hannes Reineckeb4562022013-10-23 10:51:21 +02001287 }
1288
David Jeffery3eef6252011-05-19 14:41:12 -04001289 finish_cmds = !scsi_device_online(scmd->device) ||
1290 (try_stu && !scsi_eh_try_stu(scmd) &&
1291 !scsi_eh_tur(scmd)) ||
1292 !scsi_eh_tur(scmd);
1293
1294 list_for_each_entry_safe(scmd, next, cmd_list, eh_entry)
1295 if (scmd->device == sdev) {
James Bottomley24510792013-11-11 13:44:53 +01001296 if (finish_cmds &&
1297 (try_stu ||
1298 scsi_eh_action(scmd, SUCCESS) == SUCCESS))
David Jeffery3eef6252011-05-19 14:41:12 -04001299 scsi_eh_finish_cmd(scmd, done_q);
1300 else
1301 list_move_tail(&scmd->eh_entry, work_q);
1302 }
1303 }
1304 return list_empty(work_q);
1305}
1306
1307
1308/**
Rob Landleyeb448202007-11-03 13:30:39 -05001309 * scsi_eh_abort_cmds - abort pending commands.
1310 * @work_q: &list_head for pending commands.
1311 * @done_q: &list_head for processed commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 *
1313 * Decription:
1314 * Try and see whether or not it makes sense to try and abort the
Rob Landleyeb448202007-11-03 13:30:39 -05001315 * running command. This only works out to be the case if we have one
1316 * command that has timed out. If the command simply failed, it makes
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 * no sense to try and abort the command, since as far as the shost
1318 * adapter is concerned, it isn't running.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001319 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320static int scsi_eh_abort_cmds(struct list_head *work_q,
1321 struct list_head *done_q)
1322{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001323 struct scsi_cmnd *scmd, *next;
David Jeffery3eef6252011-05-19 14:41:12 -04001324 LIST_HEAD(check_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 int rtn;
Hannes Reineckeb4562022013-10-23 10:51:21 +02001326 struct Scsi_Host *shost;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001328 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
Christoph Hellwig3111b0d2005-06-19 13:43:26 +02001329 if (!(scmd->eh_eflags & SCSI_EH_CANCEL_CMD))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 continue;
Hannes Reineckeb4562022013-10-23 10:51:21 +02001331 shost = scmd->device->host;
Hannes Reineckeb4562022013-10-23 10:51:21 +02001332 if (scsi_host_eh_past_deadline(shost)) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001333 list_splice_init(&check_list, work_q);
1334 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001335 scmd_printk(KERN_INFO, scmd,
1336 "%s: skip aborting cmd, past eh deadline\n",
1337 current->comm));
Hannes Reineckeb4562022013-10-23 10:51:21 +02001338 return list_empty(work_q);
1339 }
Hannes Reinecke91921e02014-06-25 16:39:59 +02001340 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001341 scmd_printk(KERN_INFO, scmd,
1342 "%s: aborting cmd\n", current->comm));
Hannes Reineckeb4562022013-10-23 10:51:21 +02001343 rtn = scsi_try_to_abort_cmd(shost->hostt, scmd);
Hannes Reinecke6fd046f2013-10-23 10:51:22 +02001344 if (rtn == FAILED) {
Hannes Reinecke91921e02014-06-25 16:39:59 +02001345 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001346 scmd_printk(KERN_INFO, scmd,
1347 "%s: aborting cmd failed\n",
1348 current->comm));
Hannes Reinecke6fd046f2013-10-23 10:51:22 +02001349 list_splice_init(&check_list, work_q);
1350 return list_empty(work_q);
1351 }
1352 scmd->eh_eflags &= ~SCSI_EH_CANCEL_CMD;
1353 if (rtn == FAST_IO_FAIL)
1354 scsi_eh_finish_cmd(scmd, done_q);
1355 else
1356 list_move_tail(&scmd->eh_entry, &check_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 }
1358
David Jeffery3eef6252011-05-19 14:41:12 -04001359 return scsi_eh_test_devices(&check_list, work_q, done_q, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360}
1361
1362/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 * scsi_eh_try_stu - Send START_UNIT to device.
Rob Landleyeb448202007-11-03 13:30:39 -05001364 * @scmd: &scsi_cmnd to send START_UNIT
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 *
1366 * Return value:
1367 * 0 - Device is ready. 1 - Device NOT ready.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001368 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369static int scsi_eh_try_stu(struct scsi_cmnd *scmd)
1370{
1371 static unsigned char stu_command[6] = {START_STOP, 0, 0, 0, 1, 0};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372
Christoph Hellwig631c2282006-07-08 20:42:15 +02001373 if (scmd->device->allow_restart) {
Brian Kinged773e62007-03-29 15:25:52 -05001374 int i, rtn = NEEDS_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375
Brian Kinged773e62007-03-29 15:25:52 -05001376 for (i = 0; rtn == NEEDS_RETRY && i < 2; i++)
James Bottomley9728c082008-11-30 10:32:26 -06001377 rtn = scsi_send_eh_cmnd(scmd, stu_command, 6, scmd->device->request_queue->rq_timeout, 0);
Brian Kinged773e62007-03-29 15:25:52 -05001378
Christoph Hellwig631c2282006-07-08 20:42:15 +02001379 if (rtn == SUCCESS)
1380 return 0;
1381 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 return 1;
1384}
1385
1386 /**
1387 * scsi_eh_stu - send START_UNIT if needed
Rob Landleyeb448202007-11-03 13:30:39 -05001388 * @shost: &scsi host being recovered.
Randy Dunlap74cf2982014-08-16 14:15:11 -07001389 * @work_q: &list_head for pending commands.
Rob Landleyeb448202007-11-03 13:30:39 -05001390 * @done_q: &list_head for processed commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 *
1392 * Notes:
1393 * If commands are failing due to not ready, initializing command required,
Jesper Juhl0bf8c862011-03-21 20:47:31 +01001394 * try revalidating the device, which will end up sending a start unit.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001395 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396static int scsi_eh_stu(struct Scsi_Host *shost,
1397 struct list_head *work_q,
1398 struct list_head *done_q)
1399{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001400 struct scsi_cmnd *scmd, *stu_scmd, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 struct scsi_device *sdev;
1402
1403 shost_for_each_device(sdev, shost) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001404 if (scsi_host_eh_past_deadline(shost)) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001405 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001406 sdev_printk(KERN_INFO, sdev,
1407 "%s: skip START_UNIT, past eh deadline\n",
1408 current->comm));
Hannes Reineckeb4562022013-10-23 10:51:21 +02001409 break;
1410 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411 stu_scmd = NULL;
1412 list_for_each_entry(scmd, work_q, eh_entry)
1413 if (scmd->device == sdev && SCSI_SENSE_VALID(scmd) &&
1414 scsi_check_sense(scmd) == FAILED ) {
1415 stu_scmd = scmd;
1416 break;
1417 }
1418
1419 if (!stu_scmd)
1420 continue;
1421
Hannes Reinecke91921e02014-06-25 16:39:59 +02001422 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001423 sdev_printk(KERN_INFO, sdev,
1424 "%s: Sending START_UNIT\n",
1425 current->comm));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426
1427 if (!scsi_eh_try_stu(stu_scmd)) {
1428 if (!scsi_device_online(sdev) ||
1429 !scsi_eh_tur(stu_scmd)) {
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001430 list_for_each_entry_safe(scmd, next,
1431 work_q, eh_entry) {
James Bottomley24510792013-11-11 13:44:53 +01001432 if (scmd->device == sdev &&
1433 scsi_eh_action(scmd, SUCCESS) == SUCCESS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 scsi_eh_finish_cmd(scmd, done_q);
1435 }
1436 }
1437 } else {
1438 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001439 sdev_printk(KERN_INFO, sdev,
1440 "%s: START_UNIT failed\n",
1441 current->comm));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 }
1443 }
1444
1445 return list_empty(work_q);
1446}
1447
1448
1449/**
1450 * scsi_eh_bus_device_reset - send bdr if needed
1451 * @shost: scsi host being recovered.
Randy Dunlap74cf2982014-08-16 14:15:11 -07001452 * @work_q: &list_head for pending commands.
Rob Landleyeb448202007-11-03 13:30:39 -05001453 * @done_q: &list_head for processed commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 *
1455 * Notes:
Rob Landleyeb448202007-11-03 13:30:39 -05001456 * Try a bus device reset. Still, look to see whether we have multiple
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 * devices that are jammed or not - if we have multiple devices, it
1458 * makes no sense to try bus_device_reset - we really would need to try
Jesper Juhl0bf8c862011-03-21 20:47:31 +01001459 * a bus_reset instead.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001460 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461static int scsi_eh_bus_device_reset(struct Scsi_Host *shost,
1462 struct list_head *work_q,
1463 struct list_head *done_q)
1464{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001465 struct scsi_cmnd *scmd, *bdr_scmd, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466 struct scsi_device *sdev;
1467 int rtn;
1468
1469 shost_for_each_device(sdev, shost) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001470 if (scsi_host_eh_past_deadline(shost)) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001471 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001472 sdev_printk(KERN_INFO, sdev,
1473 "%s: skip BDR, past eh deadline\n",
1474 current->comm));
Hannes Reineckeb4562022013-10-23 10:51:21 +02001475 break;
1476 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 bdr_scmd = NULL;
1478 list_for_each_entry(scmd, work_q, eh_entry)
1479 if (scmd->device == sdev) {
1480 bdr_scmd = scmd;
1481 break;
1482 }
1483
1484 if (!bdr_scmd)
1485 continue;
1486
Hannes Reinecke91921e02014-06-25 16:39:59 +02001487 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001488 sdev_printk(KERN_INFO, sdev,
1489 "%s: Sending BDR\n", current->comm));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490 rtn = scsi_try_bus_device_reset(bdr_scmd);
Christof Schmitt2f2eb582010-03-24 16:50:30 +01001491 if (rtn == SUCCESS || rtn == FAST_IO_FAIL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492 if (!scsi_device_online(sdev) ||
Christof Schmitt2f2eb582010-03-24 16:50:30 +01001493 rtn == FAST_IO_FAIL ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494 !scsi_eh_tur(bdr_scmd)) {
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001495 list_for_each_entry_safe(scmd, next,
1496 work_q, eh_entry) {
James Bottomley24510792013-11-11 13:44:53 +01001497 if (scmd->device == sdev &&
1498 scsi_eh_action(scmd, rtn) != FAILED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499 scsi_eh_finish_cmd(scmd,
1500 done_q);
1501 }
1502 }
1503 } else {
Hannes Reinecke91921e02014-06-25 16:39:59 +02001504 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001505 sdev_printk(KERN_INFO, sdev,
1506 "%s: BDR failed\n", current->comm));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 }
1508 }
1509
1510 return list_empty(work_q);
1511}
1512
1513/**
Mike Christie30bd7df2008-02-29 18:25:19 -06001514 * scsi_eh_target_reset - send target reset if needed
1515 * @shost: scsi host being recovered.
Randy Dunlap74cf2982014-08-16 14:15:11 -07001516 * @work_q: &list_head for pending commands.
Mike Christie30bd7df2008-02-29 18:25:19 -06001517 * @done_q: &list_head for processed commands.
1518 *
1519 * Notes:
1520 * Try a target reset.
1521 */
1522static int scsi_eh_target_reset(struct Scsi_Host *shost,
1523 struct list_head *work_q,
1524 struct list_head *done_q)
1525{
James Bottomley98db5192010-10-25 15:53:41 -05001526 LIST_HEAD(tmp_list);
David Jeffery3eef6252011-05-19 14:41:12 -04001527 LIST_HEAD(check_list);
Mike Christie30bd7df2008-02-29 18:25:19 -06001528
James Bottomley98db5192010-10-25 15:53:41 -05001529 list_splice_init(work_q, &tmp_list);
1530
1531 while (!list_empty(&tmp_list)) {
1532 struct scsi_cmnd *next, *scmd;
1533 int rtn;
1534 unsigned int id;
Hannes Reineckeb4562022013-10-23 10:51:21 +02001535
Hannes Reineckeb4562022013-10-23 10:51:21 +02001536 if (scsi_host_eh_past_deadline(shost)) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001537 /* push back on work queue for further processing */
1538 list_splice_init(&check_list, work_q);
1539 list_splice_init(&tmp_list, work_q);
1540 SCSI_LOG_ERROR_RECOVERY(3,
1541 shost_printk(KERN_INFO, shost,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001542 "%s: Skip target reset, past eh deadline\n",
1543 current->comm));
Hannes Reineckeb4562022013-10-23 10:51:21 +02001544 return list_empty(work_q);
1545 }
James Bottomley98db5192010-10-25 15:53:41 -05001546
1547 scmd = list_entry(tmp_list.next, struct scsi_cmnd, eh_entry);
1548 id = scmd_id(scmd);
Mike Christie30bd7df2008-02-29 18:25:19 -06001549
Hannes Reinecke91921e02014-06-25 16:39:59 +02001550 SCSI_LOG_ERROR_RECOVERY(3,
1551 shost_printk(KERN_INFO, shost,
1552 "%s: Sending target reset to target %d\n",
1553 current->comm, id));
James Bottomley98db5192010-10-25 15:53:41 -05001554 rtn = scsi_try_target_reset(scmd);
1555 if (rtn != SUCCESS && rtn != FAST_IO_FAIL)
Hannes Reinecke91921e02014-06-25 16:39:59 +02001556 SCSI_LOG_ERROR_RECOVERY(3,
1557 shost_printk(KERN_INFO, shost,
1558 "%s: Target reset failed"
1559 " target: %d\n",
1560 current->comm, id));
James Bottomley98db5192010-10-25 15:53:41 -05001561 list_for_each_entry_safe(scmd, next, &tmp_list, eh_entry) {
1562 if (scmd_id(scmd) != id)
1563 continue;
1564
David Jeffery3eef6252011-05-19 14:41:12 -04001565 if (rtn == SUCCESS)
1566 list_move_tail(&scmd->eh_entry, &check_list);
1567 else if (rtn == FAST_IO_FAIL)
James Bottomley98db5192010-10-25 15:53:41 -05001568 scsi_eh_finish_cmd(scmd, done_q);
1569 else
1570 /* push back on work queue for further processing */
1571 list_move(&scmd->eh_entry, work_q);
1572 }
1573 }
Mike Christie30bd7df2008-02-29 18:25:19 -06001574
David Jeffery3eef6252011-05-19 14:41:12 -04001575 return scsi_eh_test_devices(&check_list, work_q, done_q, 0);
Mike Christie30bd7df2008-02-29 18:25:19 -06001576}
1577
1578/**
Jesper Juhl0bf8c862011-03-21 20:47:31 +01001579 * scsi_eh_bus_reset - send a bus reset
Rob Landleyeb448202007-11-03 13:30:39 -05001580 * @shost: &scsi host being recovered.
Randy Dunlap74cf2982014-08-16 14:15:11 -07001581 * @work_q: &list_head for pending commands.
Rob Landleyeb448202007-11-03 13:30:39 -05001582 * @done_q: &list_head for processed commands.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001583 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584static int scsi_eh_bus_reset(struct Scsi_Host *shost,
1585 struct list_head *work_q,
1586 struct list_head *done_q)
1587{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001588 struct scsi_cmnd *scmd, *chan_scmd, *next;
David Jeffery3eef6252011-05-19 14:41:12 -04001589 LIST_HEAD(check_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 unsigned int channel;
1591 int rtn;
1592
1593 /*
1594 * we really want to loop over the various channels, and do this on
1595 * a channel by channel basis. we should also check to see if any
1596 * of the failed commands are on soft_reset devices, and if so, skip
Jesper Juhl0bf8c862011-03-21 20:47:31 +01001597 * the reset.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 */
1599
1600 for (channel = 0; channel <= shost->max_channel; channel++) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001601 if (scsi_host_eh_past_deadline(shost)) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001602 list_splice_init(&check_list, work_q);
1603 SCSI_LOG_ERROR_RECOVERY(3,
1604 shost_printk(KERN_INFO, shost,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001605 "%s: skip BRST, past eh deadline\n",
1606 current->comm));
Hannes Reineckeb4562022013-10-23 10:51:21 +02001607 return list_empty(work_q);
1608 }
Hannes Reineckeb4562022013-10-23 10:51:21 +02001609
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 chan_scmd = NULL;
1611 list_for_each_entry(scmd, work_q, eh_entry) {
Jeff Garzik422c0d62005-10-24 18:05:09 -04001612 if (channel == scmd_channel(scmd)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 chan_scmd = scmd;
1614 break;
1615 /*
1616 * FIXME add back in some support for
1617 * soft_reset devices.
1618 */
1619 }
1620 }
1621
1622 if (!chan_scmd)
1623 continue;
Hannes Reinecke91921e02014-06-25 16:39:59 +02001624 SCSI_LOG_ERROR_RECOVERY(3,
1625 shost_printk(KERN_INFO, shost,
1626 "%s: Sending BRST chan: %d\n",
1627 current->comm, channel));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 rtn = scsi_try_bus_reset(chan_scmd);
Christof Schmitt2f2eb582010-03-24 16:50:30 +01001629 if (rtn == SUCCESS || rtn == FAST_IO_FAIL) {
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001630 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
David Jeffery3eef6252011-05-19 14:41:12 -04001631 if (channel == scmd_channel(scmd)) {
1632 if (rtn == FAST_IO_FAIL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 scsi_eh_finish_cmd(scmd,
1634 done_q);
David Jeffery3eef6252011-05-19 14:41:12 -04001635 else
1636 list_move_tail(&scmd->eh_entry,
1637 &check_list);
1638 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639 }
1640 } else {
Hannes Reinecke91921e02014-06-25 16:39:59 +02001641 SCSI_LOG_ERROR_RECOVERY(3,
1642 shost_printk(KERN_INFO, shost,
1643 "%s: BRST failed chan: %d\n",
1644 current->comm, channel));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 }
1646 }
David Jeffery3eef6252011-05-19 14:41:12 -04001647 return scsi_eh_test_devices(&check_list, work_q, done_q, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648}
1649
1650/**
Jesper Juhl0bf8c862011-03-21 20:47:31 +01001651 * scsi_eh_host_reset - send a host reset
Randy Dunlap74cf2982014-08-16 14:15:11 -07001652 * @shost: host to be reset.
1653 * @work_q: &list_head for pending commands.
1654 * @done_q: &list_head for processed commands.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001655 */
Hannes Reinecke91921e02014-06-25 16:39:59 +02001656static int scsi_eh_host_reset(struct Scsi_Host *shost,
1657 struct list_head *work_q,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 struct list_head *done_q)
1659{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001660 struct scsi_cmnd *scmd, *next;
David Jeffery3eef6252011-05-19 14:41:12 -04001661 LIST_HEAD(check_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 int rtn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663
1664 if (!list_empty(work_q)) {
1665 scmd = list_entry(work_q->next,
1666 struct scsi_cmnd, eh_entry);
1667
Hannes Reinecke91921e02014-06-25 16:39:59 +02001668 SCSI_LOG_ERROR_RECOVERY(3,
1669 shost_printk(KERN_INFO, shost,
1670 "%s: Sending HRST\n",
1671 current->comm));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672
1673 rtn = scsi_try_host_reset(scmd);
David Jeffery3eef6252011-05-19 14:41:12 -04001674 if (rtn == SUCCESS) {
1675 list_splice_init(work_q, &check_list);
1676 } else if (rtn == FAST_IO_FAIL) {
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001677 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 scsi_eh_finish_cmd(scmd, done_q);
1679 }
1680 } else {
Hannes Reinecke91921e02014-06-25 16:39:59 +02001681 SCSI_LOG_ERROR_RECOVERY(3,
1682 shost_printk(KERN_INFO, shost,
1683 "%s: HRST failed\n",
1684 current->comm));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 }
1686 }
David Jeffery3eef6252011-05-19 14:41:12 -04001687 return scsi_eh_test_devices(&check_list, work_q, done_q, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688}
1689
1690/**
1691 * scsi_eh_offline_sdevs - offline scsi devices that fail to recover
Randy Dunlap74cf2982014-08-16 14:15:11 -07001692 * @work_q: &list_head for pending commands.
1693 * @done_q: &list_head for processed commands.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001694 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695static void scsi_eh_offline_sdevs(struct list_head *work_q,
1696 struct list_head *done_q)
1697{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001698 struct scsi_cmnd *scmd, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001700 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
Matthew Wilcox31765d72007-08-17 11:02:10 -06001701 sdev_printk(KERN_INFO, scmd->device, "Device offlined - "
1702 "not ready after error recovery\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 scsi_device_set_state(scmd->device, SDEV_OFFLINE);
Christoph Hellwig3111b0d2005-06-19 13:43:26 +02001704 if (scmd->eh_eflags & SCSI_EH_CANCEL_CMD) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705 /*
1706 * FIXME: Handle lost cmds.
1707 */
1708 }
1709 scsi_eh_finish_cmd(scmd, done_q);
1710 }
1711 return;
1712}
1713
1714/**
Hannes Reineckee494f6a2013-11-11 13:44:54 +01001715 * scsi_noretry_cmd - determine if command should be failed fast
Mike Christie4a274462008-08-19 18:45:31 -05001716 * @scmd: SCSI cmd to examine.
1717 */
1718int scsi_noretry_cmd(struct scsi_cmnd *scmd)
1719{
1720 switch (host_byte(scmd->result)) {
1721 case DID_OK:
1722 break;
Hannes Reineckee494f6a2013-11-11 13:44:54 +01001723 case DID_TIME_OUT:
1724 goto check_type;
Mike Christie4a274462008-08-19 18:45:31 -05001725 case DID_BUS_BUSY:
Christoph Hellwig33659eb2010-08-07 18:17:56 +02001726 return (scmd->request->cmd_flags & REQ_FAILFAST_TRANSPORT);
Mike Christie4a274462008-08-19 18:45:31 -05001727 case DID_PARITY:
Christoph Hellwig33659eb2010-08-07 18:17:56 +02001728 return (scmd->request->cmd_flags & REQ_FAILFAST_DEV);
Mike Christie4a274462008-08-19 18:45:31 -05001729 case DID_ERROR:
1730 if (msg_byte(scmd->result) == COMMAND_COMPLETE &&
1731 status_byte(scmd->result) == RESERVATION_CONFLICT)
1732 return 0;
1733 /* fall through */
1734 case DID_SOFT_ERROR:
Christoph Hellwig33659eb2010-08-07 18:17:56 +02001735 return (scmd->request->cmd_flags & REQ_FAILFAST_DRIVER);
Mike Christie4a274462008-08-19 18:45:31 -05001736 }
1737
Hannes Reineckee494f6a2013-11-11 13:44:54 +01001738 if (status_byte(scmd->result) != CHECK_CONDITION)
1739 return 0;
Mike Christie4a274462008-08-19 18:45:31 -05001740
Hannes Reineckee494f6a2013-11-11 13:44:54 +01001741check_type:
1742 /*
1743 * assume caller has checked sense and determined
1744 * the check condition was retryable.
1745 */
1746 if (scmd->request->cmd_flags & REQ_FAILFAST_DEV ||
1747 scmd->request->cmd_type == REQ_TYPE_BLOCK_PC)
1748 return 1;
1749 else
1750 return 0;
Mike Christie4a274462008-08-19 18:45:31 -05001751}
1752
1753/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754 * scsi_decide_disposition - Disposition a cmd on return from LLD.
1755 * @scmd: SCSI cmd to examine.
1756 *
1757 * Notes:
1758 * This is *only* called when we are examining the status after sending
1759 * out the actual data command. any commands that are queued for error
1760 * recovery (e.g. test_unit_ready) do *not* come through here.
1761 *
1762 * When this routine returns failed, it means the error handler thread
1763 * is woken. In cases where the error code indicates an error that
1764 * doesn't require the error handler read (i.e. we don't need to
1765 * abort/reset), this function should return SUCCESS.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001766 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767int scsi_decide_disposition(struct scsi_cmnd *scmd)
1768{
1769 int rtn;
1770
1771 /*
1772 * if the device is offline, then we clearly just pass the result back
1773 * up to the top level.
1774 */
1775 if (!scsi_device_online(scmd->device)) {
Hannes Reinecke91921e02014-06-25 16:39:59 +02001776 SCSI_LOG_ERROR_RECOVERY(5, scmd_printk(KERN_INFO, scmd,
1777 "%s: device offline - report as SUCCESS\n", __func__));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778 return SUCCESS;
1779 }
1780
1781 /*
1782 * first check the host byte, to see if there is anything in there
1783 * that would indicate what we need to do.
1784 */
1785 switch (host_byte(scmd->result)) {
1786 case DID_PASSTHROUGH:
1787 /*
1788 * no matter what, pass this through to the upper layer.
1789 * nuke this special code so that it looks like we are saying
1790 * did_ok.
1791 */
1792 scmd->result &= 0xff00ffff;
1793 return SUCCESS;
1794 case DID_OK:
1795 /*
1796 * looks good. drop through, and check the next byte.
1797 */
1798 break;
Hannes Reineckee494f6a2013-11-11 13:44:54 +01001799 case DID_ABORT:
1800 if (scmd->eh_eflags & SCSI_EH_ABORT_SCHEDULED) {
Ulrich Obergfell8922a902014-06-04 13:34:57 +02001801 set_host_byte(scmd, DID_TIME_OUT);
Hannes Reineckee494f6a2013-11-11 13:44:54 +01001802 return SUCCESS;
1803 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804 case DID_NO_CONNECT:
1805 case DID_BAD_TARGET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 /*
1807 * note - this means that we just report the status back
1808 * to the top level driver, not that we actually think
1809 * that it indicates SUCCESS.
1810 */
1811 return SUCCESS;
1812 /*
1813 * when the low level driver returns did_soft_error,
Jesper Juhl0bf8c862011-03-21 20:47:31 +01001814 * it is responsible for keeping an internal retry counter
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815 * in order to avoid endless loops (db)
1816 *
1817 * actually this is a bug in this function here. we should
1818 * be mindful of the maximum number of retries specified
1819 * and not get stuck in a loop.
1820 */
1821 case DID_SOFT_ERROR:
1822 goto maybe_retry;
1823 case DID_IMM_RETRY:
1824 return NEEDS_RETRY;
1825
bf341912005-04-12 17:49:09 -05001826 case DID_REQUEUE:
1827 return ADD_TO_MLQUEUE;
Mike Christiea4dfaa62008-08-19 18:45:25 -05001828 case DID_TRANSPORT_DISRUPTED:
1829 /*
1830 * LLD/transport was disrupted during processing of the IO.
1831 * The transport class is now blocked/blocking,
1832 * and the transport will decide what to do with the IO
Mike Christie939c2282008-11-04 19:47:19 -06001833 * based on its timers and recovery capablilities if
1834 * there are enough retries.
Mike Christiea4dfaa62008-08-19 18:45:25 -05001835 */
Mike Christie939c2282008-11-04 19:47:19 -06001836 goto maybe_retry;
Mike Christiea4dfaa62008-08-19 18:45:25 -05001837 case DID_TRANSPORT_FAILFAST:
1838 /*
1839 * The transport decided to failfast the IO (most likely
1840 * the fast io fail tmo fired), so send IO directly upwards.
1841 */
1842 return SUCCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 case DID_ERROR:
1844 if (msg_byte(scmd->result) == COMMAND_COMPLETE &&
1845 status_byte(scmd->result) == RESERVATION_CONFLICT)
1846 /*
1847 * execute reservation conflict processing code
1848 * lower down
1849 */
1850 break;
1851 /* fallthrough */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852 case DID_BUS_BUSY:
1853 case DID_PARITY:
1854 goto maybe_retry;
1855 case DID_TIME_OUT:
1856 /*
1857 * when we scan the bus, we get timeout messages for
1858 * these commands if there is no device available.
1859 * other hosts report did_no_connect for the same thing.
1860 */
1861 if ((scmd->cmnd[0] == TEST_UNIT_READY ||
1862 scmd->cmnd[0] == INQUIRY)) {
1863 return SUCCESS;
1864 } else {
1865 return FAILED;
1866 }
1867 case DID_RESET:
1868 return SUCCESS;
1869 default:
1870 return FAILED;
1871 }
1872
1873 /*
1874 * next, check the message byte.
1875 */
1876 if (msg_byte(scmd->result) != COMMAND_COMPLETE)
1877 return FAILED;
1878
1879 /*
1880 * check the status byte to see if this indicates anything special.
1881 */
1882 switch (status_byte(scmd->result)) {
1883 case QUEUE_FULL:
Mike Christie42a6a912009-10-15 17:46:44 -07001884 scsi_handle_queue_full(scmd->device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 /*
1886 * the case of trying to send too many commands to a
1887 * tagged queueing device.
1888 */
1889 case BUSY:
1890 /*
1891 * device can't talk to us at the moment. Should only
1892 * occur (SAM-3) when the task queue is empty, so will cause
1893 * the empty queue handling to trigger a stall in the
1894 * device.
1895 */
1896 return ADD_TO_MLQUEUE;
1897 case GOOD:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04001898 if (scmd->cmnd[0] == REPORT_LUNS)
1899 scmd->device->sdev_target->expecting_lun_change = 0;
Vasu Dev4a840672009-10-22 15:46:33 -07001900 scsi_handle_queue_ramp_up(scmd->device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901 case COMMAND_TERMINATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902 return SUCCESS;
Vladislav Bolkhovitina9b589d2008-11-06 13:57:52 +03001903 case TASK_ABORTED:
1904 goto maybe_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905 case CHECK_CONDITION:
1906 rtn = scsi_check_sense(scmd);
1907 if (rtn == NEEDS_RETRY)
1908 goto maybe_retry;
1909 /* if rtn == FAILED, we have no sense information;
1910 * returning FAILED will wake the error handler thread
1911 * to collect the sense and redo the decide
1912 * disposition */
1913 return rtn;
1914 case CONDITION_GOOD:
1915 case INTERMEDIATE_GOOD:
1916 case INTERMEDIATE_C_GOOD:
1917 case ACA_ACTIVE:
1918 /*
1919 * who knows? FIXME(eric)
1920 */
1921 return SUCCESS;
1922
1923 case RESERVATION_CONFLICT:
James Bottomley9ccfc752005-10-02 11:45:08 -05001924 sdev_printk(KERN_INFO, scmd->device,
1925 "reservation conflict\n");
Moger, Babu2082ebc2012-01-24 20:38:46 +00001926 set_host_byte(scmd, DID_NEXUS_FAILURE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001927 return SUCCESS; /* causes immediate i/o error */
1928 default:
1929 return FAILED;
1930 }
1931 return FAILED;
1932
1933 maybe_retry:
1934
1935 /* we requeue for retry because the error was retryable, and
1936 * the request was not marked fast fail. Note that above,
1937 * even if the request is marked fast fail, we still requeue
1938 * for queue congestion conditions (QUEUE_FULL or BUSY) */
Brian King8884efa2006-02-24 17:10:04 -06001939 if ((++scmd->retries) <= scmd->allowed
Mike Christie4a274462008-08-19 18:45:31 -05001940 && !scsi_noretry_cmd(scmd)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 return NEEDS_RETRY;
1942 } else {
1943 /*
1944 * no more retries - report this one back to upper level.
1945 */
1946 return SUCCESS;
1947 }
1948}
1949
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001950static void eh_lock_door_done(struct request *req, int uptodate)
1951{
1952 __blk_put_request(req->q, req);
1953}
1954
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 * scsi_eh_lock_door - Prevent medium removal for the specified device
1957 * @sdev: SCSI device to prevent medium removal
1958 *
1959 * Locking:
James Bottomley91bc31f2009-05-17 09:30:48 -05001960 * We must be called from process context.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 *
1962 * Notes:
1963 * We queue up an asynchronous "ALLOW MEDIUM REMOVAL" request on the
1964 * head of the devices request queue, and continue.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001965 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966static void scsi_eh_lock_door(struct scsi_device *sdev)
1967{
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001968 struct request *req;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969
James Bottomley91bc31f2009-05-17 09:30:48 -05001970 /*
1971 * blk_get_request with GFP_KERNEL (__GFP_WAIT) sleeps until a
1972 * request becomes available
1973 */
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001974 req = blk_get_request(sdev->request_queue, READ, GFP_KERNEL);
Joe Lawrencea492f072014-08-28 08:15:21 -06001975 if (IS_ERR(req))
Joe Lawrenceeb571ee2014-07-02 15:35:16 -04001976 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977
Jens Axboef27b0872014-06-06 07:57:37 -06001978 blk_rq_set_block_pc(req);
1979
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001980 req->cmd[0] = ALLOW_MEDIUM_REMOVAL;
1981 req->cmd[1] = 0;
1982 req->cmd[2] = 0;
1983 req->cmd[3] = 0;
1984 req->cmd[4] = SCSI_REMOVAL_PREVENT;
1985 req->cmd[5] = 0;
1986
1987 req->cmd_len = COMMAND_SIZE(req->cmd[0]);
1988
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001989 req->cmd_flags |= REQ_QUIET;
1990 req->timeout = 10 * HZ;
1991 req->retries = 5;
1992
1993 blk_execute_rq_nowait(req->q, NULL, req, 1, eh_lock_door_done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994}
1995
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996/**
1997 * scsi_restart_operations - restart io operations to the specified host.
1998 * @shost: Host we are restarting.
1999 *
2000 * Notes:
2001 * When we entered the error handler, we blocked all further i/o to
2002 * this device. we need to 'reverse' this process.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08002003 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004static void scsi_restart_operations(struct Scsi_Host *shost)
2005{
2006 struct scsi_device *sdev;
James Bottomley939647e2005-09-18 15:05:20 -05002007 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008
2009 /*
2010 * If the door was locked, we need to insert a door lock request
2011 * onto the head of the SCSI request queue for the device. There
2012 * is no point trying to lock the door of an off-line device.
2013 */
2014 shost_for_each_device(sdev, shost) {
Christoph Hellwig48379272014-11-03 19:36:40 +01002015 if (scsi_device_online(sdev) && sdev->was_reset && sdev->locked) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016 scsi_eh_lock_door(sdev);
Christoph Hellwig48379272014-11-03 19:36:40 +01002017 sdev->was_reset = 0;
2018 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019 }
2020
2021 /*
2022 * next free up anything directly waiting upon the host. this
2023 * will be requests for character device operations, and also for
2024 * ioctls to queued block devices.
2025 */
Hannes Reineckeb4562022013-10-23 10:51:21 +02002026 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002027 shost_printk(KERN_INFO, shost, "waking up host to restart\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028
James Bottomley939647e2005-09-18 15:05:20 -05002029 spin_lock_irqsave(shost->host_lock, flags);
2030 if (scsi_host_set_state(shost, SHOST_RUNNING))
2031 if (scsi_host_set_state(shost, SHOST_CANCEL))
2032 BUG_ON(scsi_host_set_state(shost, SHOST_DEL));
2033 spin_unlock_irqrestore(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034
2035 wake_up(&shost->host_wait);
2036
2037 /*
2038 * finally we need to re-initiate requests that may be pending. we will
2039 * have had everything blocked while error handling is taking place, and
2040 * now that error recovery is done, we will need to ensure that these
2041 * requests are started.
2042 */
2043 scsi_run_host_queues(shost);
Dan Williams57fc2e32012-06-21 23:25:32 -07002044
2045 /*
2046 * if eh is active and host_eh_scheduled is pending we need to re-run
2047 * recovery. we do this check after scsi_run_host_queues() to allow
2048 * everything pent up since the last eh run a chance to make forward
2049 * progress before we sync again. Either we'll immediately re-run
2050 * recovery or scsi_device_unbusy() will wake us again when these
2051 * pending commands complete.
2052 */
2053 spin_lock_irqsave(shost->host_lock, flags);
2054 if (shost->host_eh_scheduled)
2055 if (scsi_host_set_state(shost, SHOST_RECOVERY))
2056 WARN_ON(scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY));
2057 spin_unlock_irqrestore(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058}
2059
2060/**
2061 * scsi_eh_ready_devs - check device ready state and recover if not.
Randy Dunlap74cf2982014-08-16 14:15:11 -07002062 * @shost: host to be recovered.
2063 * @work_q: &list_head for pending commands.
Rob Landleyeb448202007-11-03 13:30:39 -05002064 * @done_q: &list_head for processed commands.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08002065 */
Darrick J. Wongdca84e42007-01-26 14:08:49 -08002066void scsi_eh_ready_devs(struct Scsi_Host *shost,
2067 struct list_head *work_q,
2068 struct list_head *done_q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069{
2070 if (!scsi_eh_stu(shost, work_q, done_q))
2071 if (!scsi_eh_bus_device_reset(shost, work_q, done_q))
Mike Christie30bd7df2008-02-29 18:25:19 -06002072 if (!scsi_eh_target_reset(shost, work_q, done_q))
2073 if (!scsi_eh_bus_reset(shost, work_q, done_q))
Hannes Reinecke91921e02014-06-25 16:39:59 +02002074 if (!scsi_eh_host_reset(shost, work_q, done_q))
Mike Christie30bd7df2008-02-29 18:25:19 -06002075 scsi_eh_offline_sdevs(work_q,
2076 done_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077}
Darrick J. Wongdca84e42007-01-26 14:08:49 -08002078EXPORT_SYMBOL_GPL(scsi_eh_ready_devs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079
2080/**
2081 * scsi_eh_flush_done_q - finish processed commands or retry them.
2082 * @done_q: list_head of processed commands.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08002083 */
Tejun Heo041c5fc2006-01-23 13:09:36 +09002084void scsi_eh_flush_done_q(struct list_head *done_q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02002086 struct scsi_cmnd *scmd, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02002088 list_for_each_entry_safe(scmd, next, done_q, eh_entry) {
2089 list_del_init(&scmd->eh_entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090 if (scsi_device_online(scmd->device) &&
Mike Christie4a274462008-08-19 18:45:31 -05002091 !scsi_noretry_cmd(scmd) &&
Brian King8884efa2006-02-24 17:10:04 -06002092 (++scmd->retries <= scmd->allowed)) {
Hannes Reinecke91921e02014-06-25 16:39:59 +02002093 SCSI_LOG_ERROR_RECOVERY(3,
2094 scmd_printk(KERN_INFO, scmd,
2095 "%s: flush retry cmd: %p\n",
2096 current->comm, scmd));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097 scsi_queue_insert(scmd, SCSI_MLQUEUE_EH_RETRY);
2098 } else {
Patrick Mansfield 793698c2005-05-16 17:42:15 -07002099 /*
2100 * If just we got sense for the device (called
2101 * scsi_eh_get_sense), scmd->result is already
2102 * set, do not set DRIVER_TIMEOUT.
2103 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 if (!scmd->result)
2105 scmd->result |= (DRIVER_TIMEOUT << 24);
Hannes Reinecke91921e02014-06-25 16:39:59 +02002106 SCSI_LOG_ERROR_RECOVERY(3,
2107 scmd_printk(KERN_INFO, scmd,
2108 "%s: flush finish cmd: %p\n",
2109 current->comm, scmd));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110 scsi_finish_command(scmd);
2111 }
2112 }
2113}
Tejun Heo041c5fc2006-01-23 13:09:36 +09002114EXPORT_SYMBOL(scsi_eh_flush_done_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115
2116/**
2117 * scsi_unjam_host - Attempt to fix a host which has a cmd that failed.
2118 * @shost: Host to unjam.
2119 *
2120 * Notes:
2121 * When we come in here, we *know* that all commands on the bus have
2122 * either completed, failed or timed out. we also know that no further
2123 * commands are being sent to the host, so things are relatively quiet
2124 * and we have freedom to fiddle with things as we wish.
2125 *
2126 * This is only the *default* implementation. it is possible for
2127 * individual drivers to supply their own version of this function, and
2128 * if the maintainer wishes to do this, it is strongly suggested that
2129 * this function be taken as a template and modified. this function
2130 * was designed to correctly handle problems for about 95% of the
2131 * different cases out there, and it should always provide at least a
2132 * reasonable amount of error recovery.
2133 *
2134 * Any command marked 'failed' or 'timeout' must eventually have
2135 * scsi_finish_cmd() called for it. we do all of the retry stuff
2136 * here, so when we restart the host after we return it should have an
2137 * empty queue.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08002138 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139static void scsi_unjam_host(struct Scsi_Host *shost)
2140{
2141 unsigned long flags;
2142 LIST_HEAD(eh_work_q);
2143 LIST_HEAD(eh_done_q);
2144
2145 spin_lock_irqsave(shost->host_lock, flags);
2146 list_splice_init(&shost->eh_cmd_q, &eh_work_q);
2147 spin_unlock_irqrestore(shost->host_lock, flags);
2148
2149 SCSI_LOG_ERROR_RECOVERY(1, scsi_eh_prt_fail_stats(shost, &eh_work_q));
2150
2151 if (!scsi_eh_get_sense(&eh_work_q, &eh_done_q))
2152 if (!scsi_eh_abort_cmds(&eh_work_q, &eh_done_q))
2153 scsi_eh_ready_devs(shost, &eh_work_q, &eh_done_q);
2154
Hannes Reineckeb4562022013-10-23 10:51:21 +02002155 spin_lock_irqsave(shost->host_lock, flags);
Ren Mingxinbb3b6212013-11-11 13:44:56 +01002156 if (shost->eh_deadline != -1)
Hannes Reineckeb4562022013-10-23 10:51:21 +02002157 shost->last_reset = 0;
2158 spin_unlock_irqrestore(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159 scsi_eh_flush_done_q(&eh_done_q);
2160}
2161
2162/**
Christoph Hellwigad42eb12005-10-29 01:01:55 +02002163 * scsi_error_handler - SCSI error handler thread
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 * @data: Host for which we are running.
2165 *
2166 * Notes:
Christoph Hellwigad42eb12005-10-29 01:01:55 +02002167 * This is the main error handling loop. This is run as a kernel thread
2168 * for every SCSI host and handles all error handling activity.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08002169 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170int scsi_error_handler(void *data)
2171{
Christoph Hellwigad42eb12005-10-29 01:01:55 +02002172 struct Scsi_Host *shost = data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174 /*
Christoph Hellwigad42eb12005-10-29 01:01:55 +02002175 * We use TASK_INTERRUPTIBLE so that the thread is not
2176 * counted against the load average as a running process.
2177 * We never actually get interrupted because kthread_run
Frederik Schwarzerc03264a2008-12-23 00:54:00 +01002178 * disables signal delivery for the created thread.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 */
James Bottomley3ed7a472005-09-19 09:50:04 -05002180 while (!kthread_should_stop()) {
Dan Williamsb9d5c6b2012-06-21 23:25:42 -07002181 set_current_state(TASK_INTERRUPTIBLE);
Tejun Heoee7863b2006-05-15 20:57:20 +09002182 if ((shost->host_failed == 0 && shost->host_eh_scheduled == 0) ||
Christoph Hellwig74665012014-01-22 15:29:29 +01002183 shost->host_failed != atomic_read(&shost->host_busy)) {
Christoph Hellwigad42eb12005-10-29 01:01:55 +02002184 SCSI_LOG_ERROR_RECOVERY(1,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002185 shost_printk(KERN_INFO, shost,
2186 "scsi_eh_%d: sleeping\n",
2187 shost->host_no));
James Bottomley3ed7a472005-09-19 09:50:04 -05002188 schedule();
James Bottomley3ed7a472005-09-19 09:50:04 -05002189 continue;
2190 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191
James Bottomley3ed7a472005-09-19 09:50:04 -05002192 __set_current_state(TASK_RUNNING);
Christoph Hellwigad42eb12005-10-29 01:01:55 +02002193 SCSI_LOG_ERROR_RECOVERY(1,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002194 shost_printk(KERN_INFO, shost,
2195 "scsi_eh_%d: waking up %d/%d/%d\n",
2196 shost->host_no, shost->host_eh_scheduled,
Christoph Hellwig74665012014-01-22 15:29:29 +01002197 shost->host_failed,
2198 atomic_read(&shost->host_busy)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 /*
2201 * We have a host that is failing for some reason. Figure out
2202 * what we need to do to get it up and online again (if we can).
2203 * If we fail, we end up taking the thing offline.
2204 */
Lin Mingae0751f2011-12-05 09:20:24 +08002205 if (!shost->eh_noresume && scsi_autopm_get_host(shost) != 0) {
Alan Sternbc4f2402010-06-17 10:41:42 -04002206 SCSI_LOG_ERROR_RECOVERY(1,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02002207 shost_printk(KERN_ERR, shost,
2208 "scsi_eh_%d: unable to autoresume\n",
2209 shost->host_no));
Alan Sternbc4f2402010-06-17 10:41:42 -04002210 continue;
2211 }
2212
Christoph Hellwig9227c332006-04-01 19:21:04 +02002213 if (shost->transportt->eh_strategy_handler)
2214 shost->transportt->eh_strategy_handler(shost);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215 else
2216 scsi_unjam_host(shost);
2217
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218 /*
2219 * Note - if the above fails completely, the action is to take
2220 * individual devices offline and flush the queue of any
2221 * outstanding requests that may have been pending. When we
2222 * restart, we restart any I/O to any other devices on the bus
2223 * which are still online.
2224 */
2225 scsi_restart_operations(shost);
Lin Mingae0751f2011-12-05 09:20:24 +08002226 if (!shost->eh_noresume)
2227 scsi_autopm_put_host(shost);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228 }
Steven Rostedt461a0ff2005-10-19 08:22:13 -04002229 __set_current_state(TASK_RUNNING);
2230
Christoph Hellwigad42eb12005-10-29 01:01:55 +02002231 SCSI_LOG_ERROR_RECOVERY(1,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002232 shost_printk(KERN_INFO, shost,
2233 "Error handler scsi_eh_%d exiting\n",
2234 shost->host_no));
James Bottomley3ed7a472005-09-19 09:50:04 -05002235 shost->ehandler = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236 return 0;
2237}
2238
2239/*
2240 * Function: scsi_report_bus_reset()
2241 *
2242 * Purpose: Utility function used by low-level drivers to report that
2243 * they have observed a bus reset on the bus being handled.
2244 *
2245 * Arguments: shost - Host in question
2246 * channel - channel on which reset was observed.
2247 *
2248 * Returns: Nothing
2249 *
2250 * Lock status: Host lock must be held.
2251 *
2252 * Notes: This only needs to be called if the reset is one which
2253 * originates from an unknown location. Resets originated
2254 * by the mid-level itself don't need to call this, but there
2255 * should be no harm.
2256 *
2257 * The main purpose of this is to make sure that a CHECK_CONDITION
2258 * is properly treated.
2259 */
2260void scsi_report_bus_reset(struct Scsi_Host *shost, int channel)
2261{
2262 struct scsi_device *sdev;
2263
2264 __shost_for_each_device(sdev, shost) {
Mike Christie30bd7df2008-02-29 18:25:19 -06002265 if (channel == sdev_channel(sdev))
2266 __scsi_report_device_reset(sdev, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267 }
2268}
2269EXPORT_SYMBOL(scsi_report_bus_reset);
2270
2271/*
2272 * Function: scsi_report_device_reset()
2273 *
2274 * Purpose: Utility function used by low-level drivers to report that
2275 * they have observed a device reset on the device being handled.
2276 *
2277 * Arguments: shost - Host in question
2278 * channel - channel on which reset was observed
2279 * target - target on which reset was observed
2280 *
2281 * Returns: Nothing
2282 *
2283 * Lock status: Host lock must be held
2284 *
2285 * Notes: This only needs to be called if the reset is one which
2286 * originates from an unknown location. Resets originated
2287 * by the mid-level itself don't need to call this, but there
2288 * should be no harm.
2289 *
2290 * The main purpose of this is to make sure that a CHECK_CONDITION
2291 * is properly treated.
2292 */
2293void scsi_report_device_reset(struct Scsi_Host *shost, int channel, int target)
2294{
2295 struct scsi_device *sdev;
2296
2297 __shost_for_each_device(sdev, shost) {
Jeff Garzik422c0d62005-10-24 18:05:09 -04002298 if (channel == sdev_channel(sdev) &&
Mike Christie30bd7df2008-02-29 18:25:19 -06002299 target == sdev_id(sdev))
2300 __scsi_report_device_reset(sdev, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 }
2302}
2303EXPORT_SYMBOL(scsi_report_device_reset);
2304
2305static void
2306scsi_reset_provider_done_command(struct scsi_cmnd *scmd)
2307{
2308}
2309
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002310/**
2311 * scsi_ioctl_reset: explicitly reset a host/bus/target/device
2312 * @dev: scsi_device to operate on
2313 * @arg: reset type (see sg.h)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 */
2315int
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002316scsi_ioctl_reset(struct scsi_device *dev, int __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317{
Alan Sternbc4f2402010-06-17 10:41:42 -04002318 struct scsi_cmnd *scmd;
James Smartd7a1bb02006-03-08 14:50:12 -05002319 struct Scsi_Host *shost = dev->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 struct request req;
James Smartd7a1bb02006-03-08 14:50:12 -05002321 unsigned long flags;
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002322 int error = 0, rtn, val;
2323
2324 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2325 return -EACCES;
2326
2327 error = get_user(val, arg);
2328 if (error)
2329 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330
Alan Sternbc4f2402010-06-17 10:41:42 -04002331 if (scsi_autopm_get_host(shost) < 0)
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002332 return -EIO;
Alan Sternbc4f2402010-06-17 10:41:42 -04002333
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002334 error = -EIO;
Alan Sternbc4f2402010-06-17 10:41:42 -04002335 scmd = scsi_get_command(dev, GFP_KERNEL);
Christoph Hellwig0f121dd2014-09-05 18:00:05 -07002336 if (!scmd)
Christoph Hellwig95eeb5f2014-05-01 16:51:05 +02002337 goto out_put_autopm_host;
Christoph Hellwig95eeb5f2014-05-01 16:51:05 +02002338
FUJITA Tomonori4f54eec2008-04-29 09:54:37 +02002339 blk_rq_init(NULL, &req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002340 scmd->request = &req;
Christoph Hellwigb4edcbc2005-06-19 13:40:52 +02002341
Boaz Harrosh64a87b22008-04-30 11:19:47 +03002342 scmd->cmnd = req.cmd;
2343
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344 scmd->scsi_done = scsi_reset_provider_done_command;
Boaz Harrosh30b0c372007-12-13 13:47:40 +02002345 memset(&scmd->sdb, 0, sizeof(scmd->sdb));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346
2347 scmd->cmd_len = 0;
2348
2349 scmd->sc_data_direction = DMA_BIDIRECTIONAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350
James Smartd7a1bb02006-03-08 14:50:12 -05002351 spin_lock_irqsave(shost->host_lock, flags);
2352 shost->tmf_in_progress = 1;
2353 spin_unlock_irqrestore(shost->host_lock, flags);
2354
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002355 switch (val & ~SG_SCSI_RESET_NO_ESCALATE) {
2356 case SG_SCSI_RESET_NOTHING:
2357 rtn = SUCCESS;
2358 break;
2359 case SG_SCSI_RESET_DEVICE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360 rtn = scsi_try_bus_device_reset(scmd);
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002361 if (rtn == SUCCESS || (val & SG_SCSI_RESET_NO_ESCALATE))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362 break;
2363 /* FALLTHROUGH */
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002364 case SG_SCSI_RESET_TARGET:
Mike Christie30bd7df2008-02-29 18:25:19 -06002365 rtn = scsi_try_target_reset(scmd);
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002366 if (rtn == SUCCESS || (val & SG_SCSI_RESET_NO_ESCALATE))
Mike Christie30bd7df2008-02-29 18:25:19 -06002367 break;
2368 /* FALLTHROUGH */
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002369 case SG_SCSI_RESET_BUS:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370 rtn = scsi_try_bus_reset(scmd);
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002371 if (rtn == SUCCESS || (val & SG_SCSI_RESET_NO_ESCALATE))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372 break;
2373 /* FALLTHROUGH */
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002374 case SG_SCSI_RESET_HOST:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375 rtn = scsi_try_host_reset(scmd);
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002376 if (rtn == SUCCESS)
2377 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378 default:
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002379 /* FALLTHROUGH */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002380 rtn = FAILED;
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002381 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002382 }
2383
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002384 error = (rtn == SUCCESS) ? 0 : -EIO;
2385
James Smartd7a1bb02006-03-08 14:50:12 -05002386 spin_lock_irqsave(shost->host_lock, flags);
2387 shost->tmf_in_progress = 0;
2388 spin_unlock_irqrestore(shost->host_lock, flags);
2389
2390 /*
2391 * be sure to wake up anyone who was sleeping or had their queue
2392 * suspended while we performed the TMF.
2393 */
2394 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002395 shost_printk(KERN_INFO, shost,
2396 "waking up host to restart after TMF\n"));
James Smartd7a1bb02006-03-08 14:50:12 -05002397
2398 wake_up(&shost->host_wait);
James Smartd7a1bb02006-03-08 14:50:12 -05002399 scsi_run_host_queues(shost);
2400
Christoph Hellwig0f121dd2014-09-05 18:00:05 -07002401 scsi_put_command(scmd);
2402
Christoph Hellwig04796332014-02-20 14:20:55 -08002403out_put_autopm_host:
Alan Sternbc4f2402010-06-17 10:41:42 -04002404 scsi_autopm_put_host(shost);
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002405 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002406}
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002407EXPORT_SYMBOL(scsi_ioctl_reset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002408
2409/**
2410 * scsi_normalize_sense - normalize main elements from either fixed or
2411 * descriptor sense data format into a common format.
2412 *
2413 * @sense_buffer: byte array containing sense data returned by device
2414 * @sb_len: number of valid bytes in sense_buffer
2415 * @sshdr: pointer to instance of structure that common
2416 * elements are written to.
2417 *
2418 * Notes:
2419 * The "main elements" from sense data are: response_code, sense_key,
2420 * asc, ascq and additional_length (only for descriptor format).
2421 *
2422 * Typically this function can be called after a device has
2423 * responded to a SCSI command with the CHECK_CONDITION status.
2424 *
2425 * Return value:
Hannes Reinecke4753cbc2014-10-24 14:26:52 +02002426 * true if valid sense data information found, else false;
Randy Dunlapdc8875e2007-11-15 15:42:30 -08002427 */
Hannes Reinecke4753cbc2014-10-24 14:26:52 +02002428bool scsi_normalize_sense(const u8 *sense_buffer, int sb_len,
2429 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002430{
James Bottomley33aa6872005-08-28 11:31:14 -05002431 if (!sense_buffer || !sb_len)
Hannes Reinecke4753cbc2014-10-24 14:26:52 +02002432 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002433
2434 memset(sshdr, 0, sizeof(struct scsi_sense_hdr));
2435
2436 sshdr->response_code = (sense_buffer[0] & 0x7f);
James Bottomley33aa6872005-08-28 11:31:14 -05002437
2438 if (!scsi_sense_valid(sshdr))
Hannes Reinecke4753cbc2014-10-24 14:26:52 +02002439 return false;
James Bottomley33aa6872005-08-28 11:31:14 -05002440
Linus Torvalds1da177e2005-04-16 15:20:36 -07002441 if (sshdr->response_code >= 0x72) {
2442 /*
2443 * descriptor format
2444 */
2445 if (sb_len > 1)
2446 sshdr->sense_key = (sense_buffer[1] & 0xf);
2447 if (sb_len > 2)
2448 sshdr->asc = sense_buffer[2];
2449 if (sb_len > 3)
2450 sshdr->ascq = sense_buffer[3];
2451 if (sb_len > 7)
2452 sshdr->additional_length = sense_buffer[7];
2453 } else {
Jesper Juhl0bf8c862011-03-21 20:47:31 +01002454 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 * fixed format
2456 */
2457 if (sb_len > 2)
2458 sshdr->sense_key = (sense_buffer[2] & 0xf);
2459 if (sb_len > 7) {
2460 sb_len = (sb_len < (sense_buffer[7] + 8)) ?
2461 sb_len : (sense_buffer[7] + 8);
2462 if (sb_len > 12)
2463 sshdr->asc = sense_buffer[12];
2464 if (sb_len > 13)
2465 sshdr->ascq = sense_buffer[13];
2466 }
2467 }
2468
Hannes Reinecke4753cbc2014-10-24 14:26:52 +02002469 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470}
2471EXPORT_SYMBOL(scsi_normalize_sense);
2472
Hannes Reinecke4753cbc2014-10-24 14:26:52 +02002473bool scsi_command_normalize_sense(const struct scsi_cmnd *cmd,
2474 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002475{
2476 return scsi_normalize_sense(cmd->sense_buffer,
FUJITA Tomonorib80ca4f2008-01-13 15:46:13 +09002477 SCSI_SENSE_BUFFERSIZE, sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478}
2479EXPORT_SYMBOL(scsi_command_normalize_sense);
2480
2481/**
Rob Landleyeb448202007-11-03 13:30:39 -05002482 * scsi_sense_desc_find - search for a given descriptor type in descriptor sense data format.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483 * @sense_buffer: byte array of descriptor format sense data
2484 * @sb_len: number of valid bytes in sense_buffer
2485 * @desc_type: value of descriptor type to find
2486 * (e.g. 0 -> information)
2487 *
2488 * Notes:
2489 * only valid when sense data is in descriptor format
2490 *
2491 * Return value:
2492 * pointer to start of (first) descriptor if found else NULL
Randy Dunlapdc8875e2007-11-15 15:42:30 -08002493 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494const u8 * scsi_sense_desc_find(const u8 * sense_buffer, int sb_len,
2495 int desc_type)
2496{
2497 int add_sen_len, add_len, desc_len, k;
2498 const u8 * descp;
2499
2500 if ((sb_len < 8) || (0 == (add_sen_len = sense_buffer[7])))
2501 return NULL;
2502 if ((sense_buffer[0] < 0x72) || (sense_buffer[0] > 0x73))
2503 return NULL;
2504 add_sen_len = (add_sen_len < (sb_len - 8)) ?
2505 add_sen_len : (sb_len - 8);
2506 descp = &sense_buffer[8];
2507 for (desc_len = 0, k = 0; k < add_sen_len; k += desc_len) {
2508 descp += desc_len;
2509 add_len = (k < (add_sen_len - 1)) ? descp[1]: -1;
2510 desc_len = add_len + 2;
2511 if (descp[0] == desc_type)
2512 return descp;
2513 if (add_len < 0) // short descriptor ??
2514 break;
2515 }
2516 return NULL;
2517}
2518EXPORT_SYMBOL(scsi_sense_desc_find);
2519
2520/**
Rob Landleyeb448202007-11-03 13:30:39 -05002521 * scsi_get_sense_info_fld - get information field from sense data (either fixed or descriptor format)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522 * @sense_buffer: byte array of sense data
2523 * @sb_len: number of valid bytes in sense_buffer
2524 * @info_out: pointer to 64 integer where 8 or 4 byte information
2525 * field will be placed if found.
2526 *
2527 * Return value:
2528 * 1 if information field found, 0 if not found.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08002529 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530int scsi_get_sense_info_fld(const u8 * sense_buffer, int sb_len,
2531 u64 * info_out)
2532{
2533 int j;
2534 const u8 * ucp;
2535 u64 ull;
2536
2537 if (sb_len < 7)
2538 return 0;
2539 switch (sense_buffer[0] & 0x7f) {
2540 case 0x70:
2541 case 0x71:
2542 if (sense_buffer[0] & 0x80) {
2543 *info_out = (sense_buffer[3] << 24) +
2544 (sense_buffer[4] << 16) +
2545 (sense_buffer[5] << 8) + sense_buffer[6];
2546 return 1;
2547 } else
2548 return 0;
2549 case 0x72:
2550 case 0x73:
2551 ucp = scsi_sense_desc_find(sense_buffer, sb_len,
2552 0 /* info desc */);
2553 if (ucp && (0xa == ucp[1])) {
2554 ull = 0;
2555 for (j = 0; j < 8; ++j) {
2556 if (j > 0)
2557 ull <<= 8;
2558 ull |= ucp[4 + j];
2559 }
2560 *info_out = ull;
2561 return 1;
2562 } else
2563 return 0;
2564 default:
2565 return 0;
2566 }
2567}
2568EXPORT_SYMBOL(scsi_get_sense_info_fld);
FUJITA Tomonori3bc6a262008-03-25 09:26:49 +09002569
2570/**
2571 * scsi_build_sense_buffer - build sense data in a buffer
2572 * @desc: Sense format (non zero == descriptor format,
2573 * 0 == fixed format)
2574 * @buf: Where to build sense data
2575 * @key: Sense key
2576 * @asc: Additional sense code
2577 * @ascq: Additional sense code qualifier
2578 *
2579 **/
2580void scsi_build_sense_buffer(int desc, u8 *buf, u8 key, u8 asc, u8 ascq)
2581{
2582 if (desc) {
2583 buf[0] = 0x72; /* descriptor, current */
2584 buf[1] = key;
2585 buf[2] = asc;
2586 buf[3] = ascq;
2587 buf[7] = 0;
2588 } else {
2589 buf[0] = 0x70; /* fixed, current */
2590 buf[2] = key;
2591 buf[7] = 0xa;
2592 buf[12] = asc;
2593 buf[13] = ascq;
2594 }
2595}
2596EXPORT_SYMBOL(scsi_build_sense_buffer);