blob: 4cdaffca17fc8dddbbc8478d0af60bb186bcff87 [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,
Hannes Reinecke470613b2015-01-08 07:43:50 +0100127 "eh timeout, not aborting\n"));
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100128 } else {
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100129 SCSI_LOG_ERROR_RECOVERY(3,
130 scmd_printk(KERN_INFO, scmd,
Hannes Reinecke470613b2015-01-08 07:43:50 +0100131 "aborting command\n"));
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100132 rtn = scsi_try_to_abort_cmd(sdev->host->hostt, scmd);
133 if (rtn == SUCCESS) {
Ulrich Obergfell8922a902014-06-04 13:34:57 +0200134 set_host_byte(scmd, DID_TIME_OUT);
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100135 if (scsi_host_eh_past_deadline(sdev->host)) {
136 SCSI_LOG_ERROR_RECOVERY(3,
137 scmd_printk(KERN_INFO, scmd,
Hannes Reinecke470613b2015-01-08 07:43:50 +0100138 "eh timeout, not retrying "
139 "aborted command\n"));
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100140 } else if (!scsi_noretry_cmd(scmd) &&
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100141 (++scmd->retries <= scmd->allowed)) {
142 SCSI_LOG_ERROR_RECOVERY(3,
143 scmd_printk(KERN_WARNING, scmd,
Hannes Reinecke470613b2015-01-08 07:43:50 +0100144 "retry aborted command\n"));
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100145 scsi_queue_insert(scmd, SCSI_MLQUEUE_EH_RETRY);
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100146 return;
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100147 } else {
148 SCSI_LOG_ERROR_RECOVERY(3,
149 scmd_printk(KERN_WARNING, scmd,
Hannes Reinecke470613b2015-01-08 07:43:50 +0100150 "finish aborted command\n"));
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100151 scsi_finish_command(scmd);
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100152 return;
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100153 }
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100154 } else {
155 SCSI_LOG_ERROR_RECOVERY(3,
156 scmd_printk(KERN_INFO, scmd,
Hannes Reinecke470613b2015-01-08 07:43:50 +0100157 "cmd abort %s\n",
Hannes Reinecke883a0302014-10-24 14:27:04 +0200158 (rtn == FAST_IO_FAIL) ?
159 "not send" : "failed"));
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100160 }
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100161 }
162
163 if (!scsi_eh_scmd_add(scmd, 0)) {
164 SCSI_LOG_ERROR_RECOVERY(3,
165 scmd_printk(KERN_WARNING, scmd,
Hannes Reinecke470613b2015-01-08 07:43:50 +0100166 "terminate aborted command\n"));
Ulrich Obergfell8922a902014-06-04 13:34:57 +0200167 set_host_byte(scmd, DID_TIME_OUT);
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100168 scsi_finish_command(scmd);
169 }
170}
171
172/**
173 * scsi_abort_command - schedule a command abort
174 * @scmd: scmd to abort.
175 *
176 * We only need to abort commands after a command timeout
177 */
178static int
179scsi_abort_command(struct scsi_cmnd *scmd)
180{
181 struct scsi_device *sdev = scmd->device;
182 struct Scsi_Host *shost = sdev->host;
183 unsigned long flags;
184
185 if (scmd->eh_eflags & SCSI_EH_ABORT_SCHEDULED) {
186 /*
187 * Retry after abort failed, escalate to next level.
188 */
Hannes Reinecke7daf4802014-03-31 16:37:34 +0200189 scmd->eh_eflags &= ~SCSI_EH_ABORT_SCHEDULED;
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100190 SCSI_LOG_ERROR_RECOVERY(3,
191 scmd_printk(KERN_INFO, scmd,
Hannes Reinecke470613b2015-01-08 07:43:50 +0100192 "previous abort failed\n"));
Bart Van Asschefcc95a72014-06-02 11:50:52 +0200193 BUG_ON(delayed_work_pending(&scmd->abort_work));
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100194 return FAILED;
195 }
196
197 /*
198 * Do not try a command abort if
199 * SCSI EH has already started.
200 */
201 spin_lock_irqsave(shost->host_lock, flags);
202 if (scsi_host_in_recovery(shost)) {
203 spin_unlock_irqrestore(shost->host_lock, flags);
204 SCSI_LOG_ERROR_RECOVERY(3,
205 scmd_printk(KERN_INFO, scmd,
Hannes Reinecke470613b2015-01-08 07:43:50 +0100206 "not aborting, host in recovery\n"));
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100207 return FAILED;
208 }
209
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100210 if (shost->eh_deadline != -1 && !shost->last_reset)
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100211 shost->last_reset = jiffies;
212 spin_unlock_irqrestore(shost->host_lock, flags);
213
214 scmd->eh_eflags |= SCSI_EH_ABORT_SCHEDULED;
215 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reinecke470613b2015-01-08 07:43:50 +0100216 scmd_printk(KERN_INFO, scmd, "abort scheduled\n"));
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100217 queue_delayed_work(shost->tmf_work_q, &scmd->abort_work, HZ / 100);
218 return SUCCESS;
219}
220
221/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 * scsi_eh_scmd_add - add scsi cmd to error handling.
223 * @scmd: scmd to run eh on.
224 * @eh_flag: optional SCSI_EH flag.
225 *
226 * Return value:
227 * 0 on failure.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800228 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229int scsi_eh_scmd_add(struct scsi_cmnd *scmd, int eh_flag)
230{
231 struct Scsi_Host *shost = scmd->device->host;
232 unsigned long flags;
James Bottomley939647e2005-09-18 15:05:20 -0500233 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
James Bottomley3ed7a472005-09-19 09:50:04 -0500235 if (!shost->ehandler)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 return 0;
237
238 spin_lock_irqsave(shost->host_lock, flags);
James Bottomley939647e2005-09-18 15:05:20 -0500239 if (scsi_host_set_state(shost, SHOST_RECOVERY))
240 if (scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY))
241 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100243 if (shost->eh_deadline != -1 && !shost->last_reset)
Hannes Reineckeb4562022013-10-23 10:51:21 +0200244 shost->last_reset = jiffies;
245
James Bottomley939647e2005-09-18 15:05:20 -0500246 ret = 1;
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100247 if (scmd->eh_eflags & SCSI_EH_ABORT_SCHEDULED)
248 eh_flag &= ~SCSI_EH_CANCEL_CMD;
Christoph Hellwig3111b0d2005-06-19 13:43:26 +0200249 scmd->eh_eflags |= eh_flag;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 list_add_tail(&scmd->eh_entry, &shost->eh_cmd_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 shost->host_failed++;
252 scsi_eh_wakeup(shost);
James Bottomley939647e2005-09-18 15:05:20 -0500253 out_unlock:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 spin_unlock_irqrestore(shost->host_lock, flags);
James Bottomley939647e2005-09-18 15:05:20 -0500255 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256}
257
258/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 * scsi_times_out - Timeout function for normal scsi commands.
Jens Axboe242f9dc2008-09-14 05:55:09 -0700260 * @req: request that is timing out.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 *
262 * Notes:
263 * We do not need to lock this. There is the potential for a race
264 * only in that the normal completion handling might run, but if the
265 * normal completion function determines that the timer has already
266 * fired, then it mustn't do anything.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800267 */
Jens Axboe242f9dc2008-09-14 05:55:09 -0700268enum blk_eh_timer_return scsi_times_out(struct request *req)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269{
Jens Axboe242f9dc2008-09-14 05:55:09 -0700270 struct scsi_cmnd *scmd = req->special;
Jens Axboe242f9dc2008-09-14 05:55:09 -0700271 enum blk_eh_timer_return rtn = BLK_EH_NOT_HANDLED;
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100272 struct Scsi_Host *host = scmd->device->host;
James Bottomley6c5f8ce2007-03-16 17:44:41 -0500273
Kei Tokunagabf816232010-04-01 20:41:40 +0900274 trace_scsi_dispatch_cmd_timeout(scmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 scsi_log_completion(scmd, TIMEOUT_ERROR);
276
Ren Mingxinbb3b6212013-11-11 13:44:56 +0100277 if (host->eh_deadline != -1 && !host->last_reset)
Hannes Reineckeb4562022013-10-23 10:51:21 +0200278 host->last_reset = jiffies;
279
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100280 if (host->transportt->eh_timed_out)
281 rtn = host->transportt->eh_timed_out(scmd);
282 else if (host->hostt->eh_timed_out)
283 rtn = host->hostt->eh_timed_out(scmd);
James Bottomley6c5f8ce2007-03-16 17:44:41 -0500284
Hannes Reineckea33c0702014-06-13 14:01:45 +0200285 if (rtn == BLK_EH_NOT_HANDLED) {
286 if (!host->hostt->no_async_abort &&
287 scsi_abort_command(scmd) == SUCCESS)
Hannes Reineckee494f6a2013-11-11 13:44:54 +0100288 return BLK_EH_NOT_HANDLED;
289
Hannes Reineckea33c0702014-06-13 14:01:45 +0200290 set_host_byte(scmd, DID_TIME_OUT);
291 if (!scsi_eh_scmd_add(scmd, SCSI_EH_CANCEL_CMD))
292 rtn = BLK_EH_HANDLED;
293 }
Jens Axboe242f9dc2008-09-14 05:55:09 -0700294
Christoph Hellwigfa990782008-11-05 15:03:15 +0100295 return rtn;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296}
297
298/**
299 * scsi_block_when_processing_errors - Prevent cmds from being queued.
300 * @sdev: Device on which we are performing recovery.
301 *
302 * Description:
303 * We block until the host is out of error recovery, and then check to
304 * see whether the host or the device is offline.
305 *
306 * Return value:
307 * 0 when dev was taken offline by error recovery. 1 OK to proceed.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800308 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309int scsi_block_when_processing_errors(struct scsi_device *sdev)
310{
311 int online;
312
James Bottomley939647e2005-09-18 15:05:20 -0500313 wait_event(sdev->host->host_wait, !scsi_host_in_recovery(sdev->host));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
315 online = scsi_device_online(sdev);
316
Hannes Reinecke91921e02014-06-25 16:39:59 +0200317 SCSI_LOG_ERROR_RECOVERY(5, sdev_printk(KERN_INFO, sdev,
318 "%s: rtn: %d\n", __func__, online));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319
320 return online;
321}
322EXPORT_SYMBOL(scsi_block_when_processing_errors);
323
324#ifdef CONFIG_SCSI_LOGGING
325/**
326 * scsi_eh_prt_fail_stats - Log info on failures.
327 * @shost: scsi host being recovered.
328 * @work_q: Queue of scsi cmds to process.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800329 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330static inline void scsi_eh_prt_fail_stats(struct Scsi_Host *shost,
331 struct list_head *work_q)
332{
333 struct scsi_cmnd *scmd;
334 struct scsi_device *sdev;
335 int total_failures = 0;
336 int cmd_failed = 0;
337 int cmd_cancel = 0;
338 int devices_failed = 0;
339
340 shost_for_each_device(sdev, shost) {
341 list_for_each_entry(scmd, work_q, eh_entry) {
342 if (scmd->device == sdev) {
343 ++total_failures;
Christoph Hellwig3111b0d2005-06-19 13:43:26 +0200344 if (scmd->eh_eflags & SCSI_EH_CANCEL_CMD)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 ++cmd_cancel;
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100346 else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 ++cmd_failed;
348 }
349 }
350
351 if (cmd_cancel || cmd_failed) {
352 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea3a790d2014-10-24 14:27:03 +0200353 shost_printk(KERN_INFO, shost,
James Bottomley9ccfc752005-10-02 11:45:08 -0500354 "%s: cmds failed: %d, cancel: %d\n",
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -0700355 __func__, cmd_failed,
James Bottomley9ccfc752005-10-02 11:45:08 -0500356 cmd_cancel));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 cmd_cancel = 0;
358 cmd_failed = 0;
359 ++devices_failed;
360 }
361 }
362
Hannes Reinecke91921e02014-06-25 16:39:59 +0200363 SCSI_LOG_ERROR_RECOVERY(2, shost_printk(KERN_INFO, shost,
364 "Total of %d commands on %d"
365 " devices require eh work\n",
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100366 total_failures, devices_failed));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367}
368#endif
369
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400370 /**
371 * scsi_report_lun_change - Set flag on all *other* devices on the same target
372 * to indicate that a UNIT ATTENTION is expected.
373 * @sdev: Device reporting the UNIT ATTENTION
374 */
375static void scsi_report_lun_change(struct scsi_device *sdev)
376{
377 sdev->sdev_target->expecting_lun_change = 1;
378}
379
380/**
381 * scsi_report_sense - Examine scsi sense information and log messages for
382 * certain conditions, also issue uevents for some of them.
383 * @sdev: Device reporting the sense code
384 * @sshdr: sshdr to be examined
385 */
386static void scsi_report_sense(struct scsi_device *sdev,
387 struct scsi_sense_hdr *sshdr)
388{
389 enum scsi_device_event evt_type = SDEV_EVT_MAXBITS; /* i.e. none */
390
391 if (sshdr->sense_key == UNIT_ATTENTION) {
392 if (sshdr->asc == 0x3f && sshdr->ascq == 0x03) {
393 evt_type = SDEV_EVT_INQUIRY_CHANGE_REPORTED;
394 sdev_printk(KERN_WARNING, sdev,
395 "Inquiry data has changed");
396 } else if (sshdr->asc == 0x3f && sshdr->ascq == 0x0e) {
397 evt_type = SDEV_EVT_LUN_CHANGE_REPORTED;
398 scsi_report_lun_change(sdev);
399 sdev_printk(KERN_WARNING, sdev,
400 "Warning! Received an indication that the "
401 "LUN assignments on this target have "
402 "changed. The Linux SCSI layer does not "
403 "automatically remap LUN assignments.\n");
404 } else if (sshdr->asc == 0x3f)
405 sdev_printk(KERN_WARNING, sdev,
406 "Warning! Received an indication that the "
407 "operating parameters on this target have "
408 "changed. The Linux SCSI layer does not "
409 "automatically adjust these parameters.\n");
410
411 if (sshdr->asc == 0x38 && sshdr->ascq == 0x07) {
412 evt_type = SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED;
413 sdev_printk(KERN_WARNING, sdev,
414 "Warning! Received an indication that the "
415 "LUN reached a thin provisioning soft "
416 "threshold.\n");
417 }
418
419 if (sshdr->asc == 0x2a && sshdr->ascq == 0x01) {
420 evt_type = SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED;
421 sdev_printk(KERN_WARNING, sdev,
422 "Mode parameters changed");
423 } else if (sshdr->asc == 0x2a && sshdr->ascq == 0x09) {
424 evt_type = SDEV_EVT_CAPACITY_CHANGE_REPORTED;
425 sdev_printk(KERN_WARNING, sdev,
426 "Capacity data has changed");
427 } else if (sshdr->asc == 0x2a)
428 sdev_printk(KERN_WARNING, sdev,
429 "Parameters changed");
430 }
431
432 if (evt_type != SDEV_EVT_MAXBITS) {
433 set_bit(evt_type, sdev->pending_events);
434 schedule_work(&sdev->event_work);
435 }
436}
437
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438/**
439 * scsi_check_sense - Examine scsi cmd sense
440 * @scmd: Cmd to have sense checked.
441 *
442 * Return value:
Hannes Reinecke87f14e62013-07-01 15:16:24 +0200443 * SUCCESS or FAILED or NEEDS_RETRY or ADD_TO_MLQUEUE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 *
445 * Notes:
446 * When a deferred error is detected the current command has
447 * not been executed and needs retrying.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800448 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449static int scsi_check_sense(struct scsi_cmnd *scmd)
450{
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700451 struct scsi_device *sdev = scmd->device;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 struct scsi_sense_hdr sshdr;
453
454 if (! scsi_command_normalize_sense(scmd, &sshdr))
455 return FAILED; /* no valid sense data */
456
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400457 scsi_report_sense(sdev, &sshdr);
458
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 if (scsi_sense_is_deferred(&sshdr))
460 return NEEDS_RETRY;
461
Chandra Seetharamana6a8d9f2008-05-01 14:49:46 -0700462 if (sdev->scsi_dh_data && sdev->scsi_dh_data->scsi_dh &&
463 sdev->scsi_dh_data->scsi_dh->check_sense) {
464 int rc;
465
466 rc = sdev->scsi_dh_data->scsi_dh->check_sense(sdev, &sshdr);
467 if (rc != SCSI_RETURN_NOT_HANDLED)
468 return rc;
469 /* handler does not care. Drop down to default handling */
470 }
471
Christoph Hellwige925cc42014-11-06 15:11:22 -0600472 if (scmd->cmnd[0] == TEST_UNIT_READY && scmd->scsi_done != scsi_eh_done)
473 /*
474 * nasty: for mid-layer issued TURs, we need to return the
475 * actual sense data without any recovery attempt. For eh
476 * issued ones, we need to try to recover and interpret
477 */
478 return SUCCESS;
479
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 /*
481 * Previous logic looked for FILEMARK, EOM or ILI which are
482 * mainly associated with tapes and returned SUCCESS.
483 */
484 if (sshdr.response_code == 0x70) {
485 /* fixed format */
486 if (scmd->sense_buffer[2] & 0xe0)
487 return SUCCESS;
488 } else {
489 /*
490 * descriptor format: look for "stream commands sense data
491 * descriptor" (see SSC-3). Assume single sense data
492 * descriptor. Ignore ILI from SBC-2 READ LONG and WRITE LONG.
493 */
494 if ((sshdr.additional_length > 3) &&
495 (scmd->sense_buffer[8] == 0x4) &&
496 (scmd->sense_buffer[11] & 0xe0))
497 return SUCCESS;
498 }
499
500 switch (sshdr.sense_key) {
501 case NO_SENSE:
502 return SUCCESS;
503 case RECOVERED_ERROR:
504 return /* soft_error */ SUCCESS;
505
506 case ABORTED_COMMAND:
Martin K. Petersen511e44f2008-07-17 04:28:33 -0400507 if (sshdr.asc == 0x10) /* DIF */
508 return SUCCESS;
509
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 return NEEDS_RETRY;
511 case NOT_READY:
512 case UNIT_ATTENTION:
513 /*
514 * if we are expecting a cc/ua because of a bus reset that we
515 * performed, treat this just as a retry. otherwise this is
516 * information that we should pass up to the upper-level driver
517 * so that we can deal with it there.
518 */
519 if (scmd->device->expecting_cc_ua) {
TARUISI Hiroakidfcf7772011-08-11 20:25:20 +0900520 /*
521 * Because some device does not queue unit
522 * attentions correctly, we carefully check
523 * additional sense code and qualifier so as
524 * not to squash media change unit attention.
525 */
526 if (sshdr.asc != 0x28 || sshdr.ascq != 0x00) {
527 scmd->device->expecting_cc_ua = 0;
528 return NEEDS_RETRY;
529 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 }
531 /*
Ewan D. Milne279afdf2013-08-08 15:07:48 -0400532 * we might also expect a cc/ua if another LUN on the target
533 * reported a UA with an ASC/ASCQ of 3F 0E -
534 * REPORTED LUNS DATA HAS CHANGED.
535 */
536 if (scmd->device->sdev_target->expecting_lun_change &&
537 sshdr.asc == 0x3f && sshdr.ascq == 0x0e)
538 return NEEDS_RETRY;
539 /*
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100540 * if the device is in the process of becoming ready, we
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 * should retry.
542 */
543 if ((sshdr.asc == 0x04) && (sshdr.ascq == 0x01))
544 return NEEDS_RETRY;
545 /*
546 * if the device is not started, we need to wake
547 * the error handler to start the motor
548 */
549 if (scmd->device->allow_restart &&
550 (sshdr.asc == 0x04) && (sshdr.ascq == 0x02))
551 return FAILED;
Christoph Hellwig02e031c2010-11-10 14:54:09 +0100552 /*
553 * Pass the UA upwards for a determination in the completion
554 * functions.
555 */
556 return SUCCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100558 /* these are not supported */
Hannes Reineckea9d6ceb82013-07-01 15:16:25 +0200559 case DATA_PROTECT:
560 if (sshdr.asc == 0x27 && sshdr.ascq == 0x07) {
561 /* Thin provisioning hard threshold reached */
562 set_host_byte(scmd, DID_ALLOC_FAILURE);
563 return SUCCESS;
564 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 case COPY_ABORTED:
566 case VOLUME_OVERFLOW:
567 case MISCOMPARE:
Hannes Reinecke63583cc2011-01-18 10:13:11 +0100568 case BLANK_CHECK:
Hannes Reinecke87f14e62013-07-01 15:16:24 +0200569 set_host_byte(scmd, DID_TARGET_FAILURE);
570 return SUCCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571
572 case MEDIUM_ERROR:
Luben Tuikovfd1b4942006-11-29 19:45:23 -0800573 if (sshdr.asc == 0x11 || /* UNRECOVERED READ ERR */
574 sshdr.asc == 0x13 || /* AMNF DATA FIELD */
575 sshdr.asc == 0x14) { /* RECORD NOT FOUND */
Hannes Reinecke7e782af2013-07-01 15:16:26 +0200576 set_host_byte(scmd, DID_MEDIUM_ERROR);
Hannes Reinecke87f14e62013-07-01 15:16:24 +0200577 return SUCCESS;
Luben Tuikovfd1b4942006-11-29 19:45:23 -0800578 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 return NEEDS_RETRY;
580
581 case HARDWARE_ERROR:
582 if (scmd->device->retry_hwerror)
Mike Andersonbb0003c2008-08-12 12:11:58 -0700583 return ADD_TO_MLQUEUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 else
Hannes Reinecke87f14e62013-07-01 15:16:24 +0200585 set_host_byte(scmd, DID_TARGET_FAILURE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586
587 case ILLEGAL_REQUEST:
Mike Snitzer47ac56d2012-02-13 18:35:11 -0500588 if (sshdr.asc == 0x20 || /* Invalid command operation code */
589 sshdr.asc == 0x21 || /* Logical block address out of range */
590 sshdr.asc == 0x24 || /* Invalid field in cdb */
591 sshdr.asc == 0x26) { /* Parameter value invalid */
Hannes Reinecke87f14e62013-07-01 15:16:24 +0200592 set_host_byte(scmd, DID_TARGET_FAILURE);
Mike Snitzer47ac56d2012-02-13 18:35:11 -0500593 }
594 return SUCCESS;
595
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 default:
597 return SUCCESS;
598 }
599}
600
Vasu Dev4a840672009-10-22 15:46:33 -0700601static void scsi_handle_queue_ramp_up(struct scsi_device *sdev)
602{
603 struct scsi_host_template *sht = sdev->host->hostt;
604 struct scsi_device *tmp_sdev;
605
Christoph Hellwigc40ecc12014-11-13 14:25:11 +0100606 if (!sht->track_queue_depth ||
Vasu Dev4a840672009-10-22 15:46:33 -0700607 sdev->queue_depth >= sdev->max_queue_depth)
608 return;
609
610 if (time_before(jiffies,
611 sdev->last_queue_ramp_up + sdev->queue_ramp_up_period))
612 return;
613
614 if (time_before(jiffies,
615 sdev->last_queue_full_time + sdev->queue_ramp_up_period))
616 return;
617
618 /*
619 * Walk all devices of a target and do
620 * ramp up on them.
621 */
622 shost_for_each_device(tmp_sdev, sdev->host) {
623 if (tmp_sdev->channel != sdev->channel ||
624 tmp_sdev->id != sdev->id ||
625 tmp_sdev->queue_depth == sdev->max_queue_depth)
626 continue;
Christoph Hellwigc40ecc12014-11-13 14:25:11 +0100627
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100628 scsi_change_queue_depth(tmp_sdev, tmp_sdev->queue_depth + 1);
Vasu Dev4a840672009-10-22 15:46:33 -0700629 sdev->last_queue_ramp_up = jiffies;
630 }
631}
632
Mike Christie42a6a912009-10-15 17:46:44 -0700633static void scsi_handle_queue_full(struct scsi_device *sdev)
634{
635 struct scsi_host_template *sht = sdev->host->hostt;
636 struct scsi_device *tmp_sdev;
637
Christoph Hellwigc40ecc12014-11-13 14:25:11 +0100638 if (!sht->track_queue_depth)
Mike Christie42a6a912009-10-15 17:46:44 -0700639 return;
640
641 shost_for_each_device(tmp_sdev, sdev->host) {
642 if (tmp_sdev->channel != sdev->channel ||
643 tmp_sdev->id != sdev->id)
644 continue;
645 /*
646 * We do not know the number of commands that were at
647 * the device when we got the queue full so we start
648 * from the highest possible value and work our way down.
649 */
Christoph Hellwigc40ecc12014-11-13 14:25:11 +0100650 scsi_track_queue_full(tmp_sdev, tmp_sdev->queue_depth - 1);
Mike Christie42a6a912009-10-15 17:46:44 -0700651 }
652}
653
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654/**
655 * scsi_eh_completed_normally - Disposition a eh cmd on return from LLD.
656 * @scmd: SCSI cmd to examine.
657 *
658 * Notes:
659 * This is *only* called when we are examining the status of commands
660 * queued during error recovery. the main difference here is that we
661 * don't allow for the possibility of retries here, and we are a lot
662 * more restrictive about what we consider acceptable.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800663 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664static int scsi_eh_completed_normally(struct scsi_cmnd *scmd)
665{
666 /*
667 * first check the host byte, to see if there is anything in there
668 * that would indicate what we need to do.
669 */
670 if (host_byte(scmd->result) == DID_RESET) {
671 /*
672 * rats. we are already in the error handler, so we now
673 * get to try and figure out what to do next. if the sense
674 * is valid, we have a pretty good idea of what to do.
675 * if not, we mark it as FAILED.
676 */
677 return scsi_check_sense(scmd);
678 }
679 if (host_byte(scmd->result) != DID_OK)
680 return FAILED;
681
682 /*
683 * next, check the message byte.
684 */
685 if (msg_byte(scmd->result) != COMMAND_COMPLETE)
686 return FAILED;
687
688 /*
689 * now, check the status byte to see if this indicates
690 * anything special.
691 */
692 switch (status_byte(scmd->result)) {
693 case GOOD:
Vasu Dev4a840672009-10-22 15:46:33 -0700694 scsi_handle_queue_ramp_up(scmd->device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 case COMMAND_TERMINATED:
696 return SUCCESS;
697 case CHECK_CONDITION:
698 return scsi_check_sense(scmd);
699 case CONDITION_GOOD:
700 case INTERMEDIATE_GOOD:
701 case INTERMEDIATE_C_GOOD:
702 /*
703 * who knows? FIXME(eric)
704 */
705 return SUCCESS;
Michael Reed5f91bb02009-08-10 11:59:28 -0500706 case RESERVATION_CONFLICT:
James Bottomley67110df2010-08-06 15:17:24 -0500707 if (scmd->cmnd[0] == TEST_UNIT_READY)
708 /* it is a success, we probed the device and
709 * found it */
710 return SUCCESS;
711 /* otherwise, we failed to send the command */
712 return FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 case QUEUE_FULL:
Mike Christie42a6a912009-10-15 17:46:44 -0700714 scsi_handle_queue_full(scmd->device);
715 /* fall through */
716 case BUSY:
Hannes Reinecke3eb3a922010-07-29 10:10:16 +0200717 return NEEDS_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 default:
719 return FAILED;
720 }
721 return FAILED;
722}
723
724/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 * scsi_eh_done - Completion function for error handling.
726 * @scmd: Cmd that is done.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800727 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728static void scsi_eh_done(struct scsi_cmnd *scmd)
729{
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100730 struct completion *eh_action;
Michael Reed85631672005-12-07 21:46:27 -0600731
Hannes Reinecke91921e02014-06-25 16:39:59 +0200732 SCSI_LOG_ERROR_RECOVERY(3, scmd_printk(KERN_INFO, scmd,
Hannes Reinecke470613b2015-01-08 07:43:50 +0100733 "%s result: %x\n", __func__, scmd->result));
Michael Reed85631672005-12-07 21:46:27 -0600734
735 eh_action = scmd->device->host->eh_action;
736 if (eh_action)
737 complete(eh_action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738}
739
740/**
Brian King292148f2007-01-30 17:51:17 -0600741 * scsi_try_host_reset - ask host adapter to reset itself
Geert Uytterhoevenc2b3ebd2013-05-17 13:22:29 +0200742 * @scmd: SCSI cmd to send host reset.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800743 */
Brian King292148f2007-01-30 17:51:17 -0600744static int scsi_try_host_reset(struct scsi_cmnd *scmd)
745{
746 unsigned long flags;
747 int rtn;
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100748 struct Scsi_Host *host = scmd->device->host;
749 struct scsi_host_template *hostt = host->hostt;
Brian King292148f2007-01-30 17:51:17 -0600750
Hannes Reinecke91921e02014-06-25 16:39:59 +0200751 SCSI_LOG_ERROR_RECOVERY(3,
752 shost_printk(KERN_INFO, host, "Snd Host RST\n"));
Brian King292148f2007-01-30 17:51:17 -0600753
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100754 if (!hostt->eh_host_reset_handler)
Brian King292148f2007-01-30 17:51:17 -0600755 return FAILED;
756
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100757 rtn = hostt->eh_host_reset_handler(scmd);
Brian King292148f2007-01-30 17:51:17 -0600758
759 if (rtn == SUCCESS) {
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100760 if (!hostt->skip_settle_delay)
Brian King292148f2007-01-30 17:51:17 -0600761 ssleep(HOST_RESET_SETTLE_TIME);
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100762 spin_lock_irqsave(host->host_lock, flags);
763 scsi_report_bus_reset(host, scmd_channel(scmd));
764 spin_unlock_irqrestore(host->host_lock, flags);
Brian King292148f2007-01-30 17:51:17 -0600765 }
766
767 return rtn;
768}
769
770/**
771 * scsi_try_bus_reset - ask host to perform a bus reset
772 * @scmd: SCSI cmd to send bus reset.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800773 */
Brian King292148f2007-01-30 17:51:17 -0600774static int scsi_try_bus_reset(struct scsi_cmnd *scmd)
775{
776 unsigned long flags;
777 int rtn;
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100778 struct Scsi_Host *host = scmd->device->host;
779 struct scsi_host_template *hostt = host->hostt;
Brian King292148f2007-01-30 17:51:17 -0600780
Hannes Reinecke91921e02014-06-25 16:39:59 +0200781 SCSI_LOG_ERROR_RECOVERY(3, scmd_printk(KERN_INFO, scmd,
782 "%s: Snd Bus RST\n", __func__));
Brian King292148f2007-01-30 17:51:17 -0600783
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100784 if (!hostt->eh_bus_reset_handler)
Brian King292148f2007-01-30 17:51:17 -0600785 return FAILED;
786
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100787 rtn = hostt->eh_bus_reset_handler(scmd);
Brian King292148f2007-01-30 17:51:17 -0600788
789 if (rtn == SUCCESS) {
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100790 if (!hostt->skip_settle_delay)
Brian King292148f2007-01-30 17:51:17 -0600791 ssleep(BUS_RESET_SETTLE_TIME);
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100792 spin_lock_irqsave(host->host_lock, flags);
793 scsi_report_bus_reset(host, scmd_channel(scmd));
794 spin_unlock_irqrestore(host->host_lock, flags);
Brian King292148f2007-01-30 17:51:17 -0600795 }
796
797 return rtn;
798}
799
Mike Christie30bd7df2008-02-29 18:25:19 -0600800static void __scsi_report_device_reset(struct scsi_device *sdev, void *data)
801{
802 sdev->was_reset = 1;
803 sdev->expecting_cc_ua = 1;
804}
805
806/**
807 * scsi_try_target_reset - Ask host to perform a target reset
808 * @scmd: SCSI cmd used to send a target reset
809 *
810 * Notes:
811 * There is no timeout for this operation. if this operation is
812 * unreliable for a given host, then the host itself needs to put a
813 * timer on it, and set the host back to a consistent state prior to
814 * returning.
815 */
816static int scsi_try_target_reset(struct scsi_cmnd *scmd)
817{
818 unsigned long flags;
819 int rtn;
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100820 struct Scsi_Host *host = scmd->device->host;
821 struct scsi_host_template *hostt = host->hostt;
Mike Christie30bd7df2008-02-29 18:25:19 -0600822
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100823 if (!hostt->eh_target_reset_handler)
Mike Christie30bd7df2008-02-29 18:25:19 -0600824 return FAILED;
825
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100826 rtn = hostt->eh_target_reset_handler(scmd);
Mike Christie30bd7df2008-02-29 18:25:19 -0600827 if (rtn == SUCCESS) {
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100828 spin_lock_irqsave(host->host_lock, flags);
Mike Christie30bd7df2008-02-29 18:25:19 -0600829 __starget_for_each_device(scsi_target(scmd->device), NULL,
830 __scsi_report_device_reset);
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100831 spin_unlock_irqrestore(host->host_lock, flags);
Mike Christie30bd7df2008-02-29 18:25:19 -0600832 }
833
834 return rtn;
835}
836
Brian King292148f2007-01-30 17:51:17 -0600837/**
838 * scsi_try_bus_device_reset - Ask host to perform a BDR on a dev
839 * @scmd: SCSI cmd used to send BDR
840 *
841 * Notes:
842 * There is no timeout for this operation. if this operation is
843 * unreliable for a given host, then the host itself needs to put a
844 * timer on it, and set the host back to a consistent state prior to
845 * returning.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800846 */
Brian King292148f2007-01-30 17:51:17 -0600847static int scsi_try_bus_device_reset(struct scsi_cmnd *scmd)
848{
849 int rtn;
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100850 struct scsi_host_template *hostt = scmd->device->host->hostt;
Brian King292148f2007-01-30 17:51:17 -0600851
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100852 if (!hostt->eh_device_reset_handler)
Brian King292148f2007-01-30 17:51:17 -0600853 return FAILED;
854
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100855 rtn = hostt->eh_device_reset_handler(scmd);
Mike Christie30bd7df2008-02-29 18:25:19 -0600856 if (rtn == SUCCESS)
857 __scsi_report_device_reset(scmd->device, NULL);
Brian King292148f2007-01-30 17:51:17 -0600858 return rtn;
859}
860
Hannes Reinecke883a0302014-10-24 14:27:04 +0200861/**
862 * scsi_try_to_abort_cmd - Ask host to abort a SCSI command
Randy Dunlap6583f6f2014-12-29 09:40:56 -0800863 * @hostt: SCSI driver host template
Hannes Reinecke883a0302014-10-24 14:27:04 +0200864 * @scmd: SCSI cmd used to send a target reset
865 *
866 * Return value:
867 * SUCCESS, FAILED, or FAST_IO_FAIL
868 *
869 * Notes:
870 * SUCCESS does not necessarily indicate that the command
871 * has been aborted; it only indicates that the LLDDs
872 * has cleared all references to that command.
873 * LLDDs should return FAILED only if an abort was required
874 * but could not be executed. LLDDs should return FAST_IO_FAIL
875 * if the device is temporarily unavailable (eg due to a
876 * link down on FibreChannel)
877 */
878static int scsi_try_to_abort_cmd(struct scsi_host_template *hostt,
879 struct scsi_cmnd *scmd)
Brian King292148f2007-01-30 17:51:17 -0600880{
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100881 if (!hostt->eh_abort_handler)
Brian King292148f2007-01-30 17:51:17 -0600882 return FAILED;
883
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100884 return hostt->eh_abort_handler(scmd);
Brian King292148f2007-01-30 17:51:17 -0600885}
886
Brian King292148f2007-01-30 17:51:17 -0600887static void scsi_abort_eh_cmnd(struct scsi_cmnd *scmd)
888{
Jesper Juhl0bf8c862011-03-21 20:47:31 +0100889 if (scsi_try_to_abort_cmd(scmd->device->host->hostt, scmd) != SUCCESS)
Brian King292148f2007-01-30 17:51:17 -0600890 if (scsi_try_bus_device_reset(scmd) != SUCCESS)
Mike Christie30bd7df2008-02-29 18:25:19 -0600891 if (scsi_try_target_reset(scmd) != SUCCESS)
892 if (scsi_try_bus_reset(scmd) != SUCCESS)
893 scsi_try_host_reset(scmd);
Brian King292148f2007-01-30 17:51:17 -0600894}
895
896/**
Santosh Y3b729f72012-04-08 18:47:09 +0530897 * scsi_eh_prep_cmnd - Save a scsi command info as part of error recovery
Christoph Hellwig2dc611d2006-11-04 20:04:21 +0100898 * @scmd: SCSI command structure to hijack
Boaz Harroshe1c23462007-10-08 16:36:45 +0200899 * @ses: structure to save restore information
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200900 * @cmnd: CDB to send. Can be NULL if no new cmnd is needed
Boaz Harrosh64a87b22008-04-30 11:19:47 +0300901 * @cmnd_size: size in bytes of @cmnd (must be <= BLK_MAX_CDB)
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200902 * @sense_bytes: size of sense data to copy. or 0 (if != 0 @cmnd is ignored)
Christoph Hellwig2dc611d2006-11-04 20:04:21 +0100903 *
Boaz Harroshe1c23462007-10-08 16:36:45 +0200904 * This function is used to save a scsi command information before re-execution
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200905 * as part of the error recovery process. If @sense_bytes is 0 the command
906 * sent must be one that does not transfer any data. If @sense_bytes != 0
907 * @cmnd is ignored and this functions sets up a REQUEST_SENSE command
908 * and cmnd buffers to read @sense_bytes into @scmd->sense_buffer.
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800909 */
Boaz Harroshe1c23462007-10-08 16:36:45 +0200910void scsi_eh_prep_cmnd(struct scsi_cmnd *scmd, struct scsi_eh_save *ses,
911 unsigned char *cmnd, int cmnd_size, unsigned sense_bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912{
f59114b2005-04-17 15:00:23 -0500913 struct scsi_device *sdev = scmd->device;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914
Christoph Hellwig631c2282006-07-08 20:42:15 +0200915 /*
916 * We need saved copies of a number of fields - this is because
917 * error handling may need to overwrite these with different values
918 * to run different commands, and once error handling is complete,
919 * we will need to restore these values prior to running the actual
920 * command.
921 */
Boaz Harroshe1c23462007-10-08 16:36:45 +0200922 ses->cmd_len = scmd->cmd_len;
Boaz Harrosh64a87b22008-04-30 11:19:47 +0300923 ses->cmnd = scmd->cmnd;
Boaz Harroshe1c23462007-10-08 16:36:45 +0200924 ses->data_direction = scmd->sc_data_direction;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200925 ses->sdb = scmd->sdb;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200926 ses->next_rq = scmd->request->next_rq;
Boaz Harroshe1c23462007-10-08 16:36:45 +0200927 ses->result = scmd->result;
Alan Stern12265702008-07-21 10:25:52 -0400928 ses->underflow = scmd->underflow;
Martin K. Petersendb007fc2008-07-17 04:28:31 -0400929 ses->prot_op = scmd->prot_op;
Christoph Hellwig631c2282006-07-08 20:42:15 +0200930
Martin K. Petersendb007fc2008-07-17 04:28:31 -0400931 scmd->prot_op = SCSI_PROT_NORMAL;
James Bottomleyc69e6f82014-04-10 13:36:11 -0700932 scmd->eh_eflags = 0;
Boaz Harrosh64a87b22008-04-30 11:19:47 +0300933 scmd->cmnd = ses->eh_cmnd;
934 memset(scmd->cmnd, 0, BLK_MAX_CDB);
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200935 memset(&scmd->sdb, 0, sizeof(scmd->sdb));
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200936 scmd->request->next_rq = NULL;
Alan Stern644373a2014-03-28 10:51:15 -0700937 scmd->result = 0;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200938
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200939 if (sense_bytes) {
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200940 scmd->sdb.length = min_t(unsigned, SCSI_SENSE_BUFFERSIZE,
941 sense_bytes);
Boaz Harroshe1c23462007-10-08 16:36:45 +0200942 sg_init_one(&ses->sense_sgl, scmd->sense_buffer,
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200943 scmd->sdb.length);
944 scmd->sdb.table.sgl = &ses->sense_sgl;
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200945 scmd->sc_data_direction = DMA_FROM_DEVICE;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200946 scmd->sdb.table.nents = 1;
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200947 scmd->cmnd[0] = REQUEST_SENSE;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200948 scmd->cmnd[4] = scmd->sdb.length;
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200949 scmd->cmd_len = COMMAND_SIZE(scmd->cmnd[0]);
Christoph Hellwig631c2282006-07-08 20:42:15 +0200950 } else {
Christoph Hellwig631c2282006-07-08 20:42:15 +0200951 scmd->sc_data_direction = DMA_NONE;
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200952 if (cmnd) {
Boaz Harrosh64a87b22008-04-30 11:19:47 +0300953 BUG_ON(cmnd_size > BLK_MAX_CDB);
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200954 memcpy(scmd->cmnd, cmnd, cmnd_size);
955 scmd->cmd_len = COMMAND_SIZE(scmd->cmnd[0]);
956 }
Christoph Hellwig631c2282006-07-08 20:42:15 +0200957 }
958
959 scmd->underflow = 0;
Christoph Hellwig631c2282006-07-08 20:42:15 +0200960
Boaz Harrosh55db6c12007-10-08 16:35:19 +0200961 if (sdev->scsi_level <= SCSI_2 && sdev->scsi_level != SCSI_UNKNOWN)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 scmd->cmnd[1] = (scmd->cmnd[1] & 0x1f) |
f59114b2005-04-17 15:00:23 -0500963 (sdev->lun << 5 & 0xe0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964
Christoph Hellwig631c2282006-07-08 20:42:15 +0200965 /*
966 * Zero the sense buffer. The scsi spec mandates that any
967 * untransferred sense data should be interpreted as being zero.
968 */
FUJITA Tomonorib80ca4f2008-01-13 15:46:13 +0900969 memset(scmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
Boaz Harroshe1c23462007-10-08 16:36:45 +0200970}
971EXPORT_SYMBOL(scsi_eh_prep_cmnd);
Christoph Hellwig631c2282006-07-08 20:42:15 +0200972
Boaz Harroshe1c23462007-10-08 16:36:45 +0200973/**
Santosh Y3b729f72012-04-08 18:47:09 +0530974 * scsi_eh_restore_cmnd - Restore a scsi command info as part of error recovery
Boaz Harroshe1c23462007-10-08 16:36:45 +0200975 * @scmd: SCSI command structure to restore
Bartlomiej Zolnierkiewicz477e6082009-04-27 20:54:22 +0200976 * @ses: saved information from a coresponding call to scsi_eh_prep_cmnd
Boaz Harroshe1c23462007-10-08 16:36:45 +0200977 *
Bartlomiej Zolnierkiewicz477e6082009-04-27 20:54:22 +0200978 * Undo any damage done by above scsi_eh_prep_cmnd().
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800979 */
Boaz Harroshe1c23462007-10-08 16:36:45 +0200980void scsi_eh_restore_cmnd(struct scsi_cmnd* scmd, struct scsi_eh_save *ses)
981{
982 /*
983 * Restore original data
984 */
985 scmd->cmd_len = ses->cmd_len;
Boaz Harrosh64a87b22008-04-30 11:19:47 +0300986 scmd->cmnd = ses->cmnd;
Boaz Harroshe1c23462007-10-08 16:36:45 +0200987 scmd->sc_data_direction = ses->data_direction;
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200988 scmd->sdb = ses->sdb;
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200989 scmd->request->next_rq = ses->next_rq;
Boaz Harroshe1c23462007-10-08 16:36:45 +0200990 scmd->result = ses->result;
Alan Stern12265702008-07-21 10:25:52 -0400991 scmd->underflow = ses->underflow;
Martin K. Petersendb007fc2008-07-17 04:28:31 -0400992 scmd->prot_op = ses->prot_op;
Boaz Harroshe1c23462007-10-08 16:36:45 +0200993}
994EXPORT_SYMBOL(scsi_eh_restore_cmnd);
995
996/**
Santosh Y3b729f72012-04-08 18:47:09 +0530997 * scsi_send_eh_cmnd - submit a scsi command as part of error recovery
Boaz Harroshe1c23462007-10-08 16:36:45 +0200998 * @scmd: SCSI command structure to hijack
999 * @cmnd: CDB to send
1000 * @cmnd_size: size in bytes of @cmnd
1001 * @timeout: timeout for this request
1002 * @sense_bytes: size of sense data to copy or 0
1003 *
1004 * This function is used to send a scsi command down to a target device
1005 * as part of the error recovery process. See also scsi_eh_prep_cmnd() above.
1006 *
1007 * Return value:
1008 * SUCCESS or FAILED or NEEDS_RETRY
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001009 */
Boaz Harroshe1c23462007-10-08 16:36:45 +02001010static int scsi_send_eh_cmnd(struct scsi_cmnd *scmd, unsigned char *cmnd,
1011 int cmnd_size, int timeout, unsigned sense_bytes)
1012{
1013 struct scsi_device *sdev = scmd->device;
1014 struct Scsi_Host *shost = sdev->host;
1015 DECLARE_COMPLETION_ONSTACK(done);
Hannes Reineckefc736482013-04-25 08:10:00 +02001016 unsigned long timeleft = timeout;
Boaz Harroshe1c23462007-10-08 16:36:45 +02001017 struct scsi_eh_save ses;
Hannes Reineckefc736482013-04-25 08:10:00 +02001018 const unsigned long stall_for = msecs_to_jiffies(100);
Boaz Harroshe1c23462007-10-08 16:36:45 +02001019 int rtn;
1020
Hannes Reineckefc736482013-04-25 08:10:00 +02001021retry:
Boaz Harroshe1c23462007-10-08 16:36:45 +02001022 scsi_eh_prep_cmnd(scmd, &ses, cmnd, cmnd_size, sense_bytes);
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +01001023 shost->eh_action = &done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 scsi_log_send(scmd);
Jeff Garzikf2812332010-11-16 02:10:29 -05001026 scmd->scsi_done = scsi_eh_done;
Hannes Reineckefc736482013-04-25 08:10:00 +02001027 rtn = shost->hostt->queuecommand(shost, scmd);
1028 if (rtn) {
1029 if (timeleft > stall_for) {
1030 scsi_eh_restore_cmnd(scmd, &ses);
1031 timeleft -= stall_for;
1032 msleep(jiffies_to_msecs(stall_for));
1033 goto retry;
1034 }
1035 /* signal not to enter either branch of the if () below */
1036 timeleft = 0;
Alan Stern511833a2014-11-21 10:44:49 -05001037 rtn = FAILED;
Hannes Reineckefc736482013-04-25 08:10:00 +02001038 } else {
1039 timeleft = wait_for_completion_timeout(&done, timeout);
Hannes Reineckeac61d192014-05-08 08:09:56 +02001040 rtn = SUCCESS;
Hannes Reineckefc736482013-04-25 08:10:00 +02001041 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042
f59114b2005-04-17 15:00:23 -05001043 shost->eh_action = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044
Hannes Reineckefc736482013-04-25 08:10:00 +02001045 scsi_log_completion(scmd, rtn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046
Hannes Reinecke91921e02014-06-25 16:39:59 +02001047 SCSI_LOG_ERROR_RECOVERY(3, scmd_printk(KERN_INFO, scmd,
Hannes Reinecke470613b2015-01-08 07:43:50 +01001048 "%s timeleft: %ld\n",
1049 __func__, timeleft));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050
1051 /*
Hannes Reineckefc736482013-04-25 08:10:00 +02001052 * If there is time left scsi_eh_done got called, and we will examine
1053 * the actual status codes to see whether the command actually did
1054 * complete normally, else if we have a zero return and no time left,
1055 * the command must still be pending, so abort it and return FAILED.
1056 * If we never actually managed to issue the command, because
1057 * ->queuecommand() kept returning non zero, use the rtn = FAILED
1058 * value above (so don't execute either branch of the if)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 */
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +01001060 if (timeleft) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 rtn = scsi_eh_completed_normally(scmd);
Hannes Reinecke91921e02014-06-25 16:39:59 +02001062 SCSI_LOG_ERROR_RECOVERY(3, scmd_printk(KERN_INFO, scmd,
1063 "%s: scsi_eh_completed_normally %x\n", __func__, rtn));
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +01001064
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065 switch (rtn) {
1066 case SUCCESS:
1067 case NEEDS_RETRY:
1068 case FAILED:
1069 break;
Hannes Reinecke6e883b02009-09-17 17:00:26 +02001070 case ADD_TO_MLQUEUE:
1071 rtn = NEEDS_RETRY;
1072 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 default:
1074 rtn = FAILED;
1075 break;
1076 }
Alan Stern511833a2014-11-21 10:44:49 -05001077 } else if (rtn != FAILED) {
Brian King292148f2007-01-30 17:51:17 -06001078 scsi_abort_eh_cmnd(scmd);
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +01001079 rtn = FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 }
1081
Boaz Harroshe1c23462007-10-08 16:36:45 +02001082 scsi_eh_restore_cmnd(scmd, &ses);
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -05001083
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084 return rtn;
1085}
1086
1087/**
1088 * scsi_request_sense - Request sense data from a particular target.
1089 * @scmd: SCSI cmd for request sense.
1090 *
1091 * Notes:
1092 * Some hosts automatically obtain this information, others require
1093 * that we obtain it on our own. This function will *not* return until
1094 * the command either times out, or it completes.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001095 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096static int scsi_request_sense(struct scsi_cmnd *scmd)
1097{
Martin K. Petersen0816c922013-05-10 10:36:04 -04001098 return scsi_send_eh_cmnd(scmd, NULL, 0, scmd->device->eh_timeout, ~0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099}
1100
James Bottomley24510792013-11-11 13:44:53 +01001101static int scsi_eh_action(struct scsi_cmnd *scmd, int rtn)
1102{
1103 if (scmd->request->cmd_type != REQ_TYPE_BLOCK_PC) {
1104 struct scsi_driver *sdrv = scsi_cmd_to_driver(scmd);
1105 if (sdrv->eh_action)
1106 rtn = sdrv->eh_action(scmd, rtn);
1107 }
1108 return rtn;
1109}
1110
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111/**
1112 * scsi_eh_finish_cmd - Handle a cmd that eh is finished with.
1113 * @scmd: Original SCSI cmd that eh has finished.
1114 * @done_q: Queue for processed commands.
1115 *
1116 * Notes:
1117 * We don't want to use the normal command completion while we are are
1118 * still handling errors - it may cause other commands to be queued,
Rob Landleyeb448202007-11-03 13:30:39 -05001119 * and that would disturb what we are doing. Thus we really want to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 * keep a list of pending commands for final completion, and once we
1121 * are ready to leave error handling we handle completion for real.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001122 */
Tejun Heo041c5fc2006-01-23 13:09:36 +09001123void scsi_eh_finish_cmd(struct scsi_cmnd *scmd, struct list_head *done_q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124{
1125 scmd->device->host->host_failed--;
Christoph Hellwig3111b0d2005-06-19 13:43:26 +02001126 scmd->eh_eflags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 list_move_tail(&scmd->eh_entry, done_q);
1128}
Tejun Heo041c5fc2006-01-23 13:09:36 +09001129EXPORT_SYMBOL(scsi_eh_finish_cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130
1131/**
1132 * scsi_eh_get_sense - Get device sense data.
1133 * @work_q: Queue of commands to process.
Rob Landleyeb448202007-11-03 13:30:39 -05001134 * @done_q: Queue of processed commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 *
1136 * Description:
1137 * See if we need to request sense information. if so, then get it
Jesper Juhl0bf8c862011-03-21 20:47:31 +01001138 * now, so we have a better idea of what to do.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 *
1140 * Notes:
1141 * This has the unfortunate side effect that if a shost adapter does
Rob Landleyeb448202007-11-03 13:30:39 -05001142 * not automatically request sense information, we end up shutting
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143 * it down before we request it.
1144 *
1145 * All drivers should request sense information internally these days,
1146 * so for now all I have to say is tough noogies if you end up in here.
1147 *
1148 * XXX: Long term this code should go away, but that needs an audit of
1149 * all LLDDs first.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001150 */
Darrick J. Wongdca84e42007-01-26 14:08:49 -08001151int scsi_eh_get_sense(struct list_head *work_q,
1152 struct list_head *done_q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001154 struct scsi_cmnd *scmd, *next;
Hannes Reineckeb4562022013-10-23 10:51:21 +02001155 struct Scsi_Host *shost;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156 int rtn;
1157
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001158 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
Christoph Hellwig3111b0d2005-06-19 13:43:26 +02001159 if ((scmd->eh_eflags & SCSI_EH_CANCEL_CMD) ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160 SCSI_SENSE_VALID(scmd))
1161 continue;
1162
Hannes Reineckeb4562022013-10-23 10:51:21 +02001163 shost = scmd->device->host;
Hannes Reineckeb4562022013-10-23 10:51:21 +02001164 if (scsi_host_eh_past_deadline(shost)) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001165 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001166 scmd_printk(KERN_INFO, scmd,
1167 "%s: skip request sense, past eh deadline\n",
1168 current->comm));
Hannes Reineckeb4562022013-10-23 10:51:21 +02001169 break;
1170 }
James Bottomleyd555a2a2014-03-28 10:50:17 -07001171 if (status_byte(scmd->result) != CHECK_CONDITION)
1172 /*
1173 * don't request sense if there's no check condition
1174 * status because the error we're processing isn't one
1175 * that has a sense code (and some devices get
1176 * confused by sense requests out of the blue)
1177 */
1178 continue;
1179
Jeff Garzik3bf743e2005-10-24 18:04:06 -04001180 SCSI_LOG_ERROR_RECOVERY(2, scmd_printk(KERN_INFO, scmd,
1181 "%s: requesting sense\n",
1182 current->comm));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 rtn = scsi_request_sense(scmd);
1184 if (rtn != SUCCESS)
1185 continue;
1186
Hannes Reinecke91921e02014-06-25 16:39:59 +02001187 SCSI_LOG_ERROR_RECOVERY(3, scmd_printk(KERN_INFO, scmd,
Hannes Reinecke470613b2015-01-08 07:43:50 +01001188 "sense requested, result %x\n", scmd->result));
Hannes Reinecked811b842014-10-24 14:26:45 +02001189 SCSI_LOG_ERROR_RECOVERY(3, scsi_print_sense(scmd));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190
1191 rtn = scsi_decide_disposition(scmd);
1192
1193 /*
1194 * if the result was normal, then just pass it along to the
1195 * upper level.
1196 */
1197 if (rtn == SUCCESS)
1198 /* we don't want this command reissued, just
1199 * finished with the sense data, so set
1200 * retries to the max allowed to ensure it
1201 * won't get reissued */
1202 scmd->retries = scmd->allowed;
1203 else if (rtn != NEEDS_RETRY)
1204 continue;
1205
1206 scsi_eh_finish_cmd(scmd, done_q);
1207 }
1208
1209 return list_empty(work_q);
1210}
Darrick J. Wongdca84e42007-01-26 14:08:49 -08001211EXPORT_SYMBOL_GPL(scsi_eh_get_sense);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212
1213/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214 * scsi_eh_tur - Send TUR to device.
Rob Landleyeb448202007-11-03 13:30:39 -05001215 * @scmd: &scsi_cmnd to send TUR
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 *
1217 * Return value:
1218 * 0 - Device is ready. 1 - Device NOT ready.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001219 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220static int scsi_eh_tur(struct scsi_cmnd *scmd)
1221{
1222 static unsigned char tur_command[6] = {TEST_UNIT_READY, 0, 0, 0, 0, 0};
1223 int retry_cnt = 1, rtn;
1224
1225retry_tur:
Martin K. Petersen0816c922013-05-10 10:36:04 -04001226 rtn = scsi_send_eh_cmnd(scmd, tur_command, 6,
1227 scmd->device->eh_timeout, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228
Hannes Reinecke91921e02014-06-25 16:39:59 +02001229 SCSI_LOG_ERROR_RECOVERY(3, scmd_printk(KERN_INFO, scmd,
Hannes Reinecke470613b2015-01-08 07:43:50 +01001230 "%s return: %x\n", __func__, rtn));
Christoph Hellwig631c2282006-07-08 20:42:15 +02001231
1232 switch (rtn) {
1233 case NEEDS_RETRY:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 if (retry_cnt--)
1235 goto retry_tur;
Christoph Hellwig631c2282006-07-08 20:42:15 +02001236 /*FALLTHRU*/
1237 case SUCCESS:
Alan Sterne47373e2005-03-30 15:05:45 -05001238 return 0;
Christoph Hellwig631c2282006-07-08 20:42:15 +02001239 default:
1240 return 1;
Alan Sterne47373e2005-03-30 15:05:45 -05001241 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242}
1243
1244/**
David Jeffery3eef6252011-05-19 14:41:12 -04001245 * scsi_eh_test_devices - check if devices are responding from error recovery.
1246 * @cmd_list: scsi commands in error recovery.
Randy Dunlap74cf2982014-08-16 14:15:11 -07001247 * @work_q: queue for commands which still need more error recovery
1248 * @done_q: queue for commands which are finished
1249 * @try_stu: boolean on if a STU command should be tried in addition to TUR.
David Jeffery3eef6252011-05-19 14:41:12 -04001250 *
1251 * Decription:
1252 * Tests if devices are in a working state. Commands to devices now in
1253 * a working state are sent to the done_q while commands to devices which
1254 * are still failing to respond are returned to the work_q for more
1255 * processing.
1256 **/
1257static int scsi_eh_test_devices(struct list_head *cmd_list,
1258 struct list_head *work_q,
1259 struct list_head *done_q, int try_stu)
1260{
1261 struct scsi_cmnd *scmd, *next;
1262 struct scsi_device *sdev;
1263 int finish_cmds;
1264
1265 while (!list_empty(cmd_list)) {
1266 scmd = list_entry(cmd_list->next, struct scsi_cmnd, eh_entry);
1267 sdev = scmd->device;
1268
Hannes Reineckeb4562022013-10-23 10:51:21 +02001269 if (!try_stu) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001270 if (scsi_host_eh_past_deadline(sdev->host)) {
1271 /* Push items back onto work_q */
1272 list_splice_init(cmd_list, work_q);
Hannes Reineckeb4562022013-10-23 10:51:21 +02001273 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001274 sdev_printk(KERN_INFO, sdev,
1275 "%s: skip test device, past eh deadline",
1276 current->comm));
Hannes Reineckeb4562022013-10-23 10:51:21 +02001277 break;
1278 }
Hannes Reineckeb4562022013-10-23 10:51:21 +02001279 }
1280
David Jeffery3eef6252011-05-19 14:41:12 -04001281 finish_cmds = !scsi_device_online(scmd->device) ||
1282 (try_stu && !scsi_eh_try_stu(scmd) &&
1283 !scsi_eh_tur(scmd)) ||
1284 !scsi_eh_tur(scmd);
1285
1286 list_for_each_entry_safe(scmd, next, cmd_list, eh_entry)
1287 if (scmd->device == sdev) {
James Bottomley24510792013-11-11 13:44:53 +01001288 if (finish_cmds &&
1289 (try_stu ||
1290 scsi_eh_action(scmd, SUCCESS) == SUCCESS))
David Jeffery3eef6252011-05-19 14:41:12 -04001291 scsi_eh_finish_cmd(scmd, done_q);
1292 else
1293 list_move_tail(&scmd->eh_entry, work_q);
1294 }
1295 }
1296 return list_empty(work_q);
1297}
1298
1299
1300/**
Rob Landleyeb448202007-11-03 13:30:39 -05001301 * scsi_eh_abort_cmds - abort pending commands.
1302 * @work_q: &list_head for pending commands.
1303 * @done_q: &list_head for processed commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 *
1305 * Decription:
1306 * Try and see whether or not it makes sense to try and abort the
Rob Landleyeb448202007-11-03 13:30:39 -05001307 * running command. This only works out to be the case if we have one
1308 * command that has timed out. If the command simply failed, it makes
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 * no sense to try and abort the command, since as far as the shost
1310 * adapter is concerned, it isn't running.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001311 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312static int scsi_eh_abort_cmds(struct list_head *work_q,
1313 struct list_head *done_q)
1314{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001315 struct scsi_cmnd *scmd, *next;
David Jeffery3eef6252011-05-19 14:41:12 -04001316 LIST_HEAD(check_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 int rtn;
Hannes Reineckeb4562022013-10-23 10:51:21 +02001318 struct Scsi_Host *shost;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001320 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
Christoph Hellwig3111b0d2005-06-19 13:43:26 +02001321 if (!(scmd->eh_eflags & SCSI_EH_CANCEL_CMD))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 continue;
Hannes Reineckeb4562022013-10-23 10:51:21 +02001323 shost = scmd->device->host;
Hannes Reineckeb4562022013-10-23 10:51:21 +02001324 if (scsi_host_eh_past_deadline(shost)) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001325 list_splice_init(&check_list, work_q);
1326 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001327 scmd_printk(KERN_INFO, scmd,
1328 "%s: skip aborting cmd, past eh deadline\n",
1329 current->comm));
Hannes Reineckeb4562022013-10-23 10:51:21 +02001330 return list_empty(work_q);
1331 }
Hannes Reinecke91921e02014-06-25 16:39:59 +02001332 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001333 scmd_printk(KERN_INFO, scmd,
1334 "%s: aborting cmd\n", current->comm));
Hannes Reineckeb4562022013-10-23 10:51:21 +02001335 rtn = scsi_try_to_abort_cmd(shost->hostt, scmd);
Hannes Reinecke6fd046f2013-10-23 10:51:22 +02001336 if (rtn == FAILED) {
Hannes Reinecke91921e02014-06-25 16:39:59 +02001337 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001338 scmd_printk(KERN_INFO, scmd,
1339 "%s: aborting cmd failed\n",
1340 current->comm));
Hannes Reinecke6fd046f2013-10-23 10:51:22 +02001341 list_splice_init(&check_list, work_q);
1342 return list_empty(work_q);
1343 }
1344 scmd->eh_eflags &= ~SCSI_EH_CANCEL_CMD;
1345 if (rtn == FAST_IO_FAIL)
1346 scsi_eh_finish_cmd(scmd, done_q);
1347 else
1348 list_move_tail(&scmd->eh_entry, &check_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 }
1350
David Jeffery3eef6252011-05-19 14:41:12 -04001351 return scsi_eh_test_devices(&check_list, work_q, done_q, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352}
1353
1354/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 * scsi_eh_try_stu - Send START_UNIT to device.
Rob Landleyeb448202007-11-03 13:30:39 -05001356 * @scmd: &scsi_cmnd to send START_UNIT
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 *
1358 * Return value:
1359 * 0 - Device is ready. 1 - Device NOT ready.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001360 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361static int scsi_eh_try_stu(struct scsi_cmnd *scmd)
1362{
1363 static unsigned char stu_command[6] = {START_STOP, 0, 0, 0, 1, 0};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364
Christoph Hellwig631c2282006-07-08 20:42:15 +02001365 if (scmd->device->allow_restart) {
Brian Kinged773e62007-03-29 15:25:52 -05001366 int i, rtn = NEEDS_RETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367
Brian Kinged773e62007-03-29 15:25:52 -05001368 for (i = 0; rtn == NEEDS_RETRY && i < 2; i++)
James Bottomley9728c082008-11-30 10:32:26 -06001369 rtn = scsi_send_eh_cmnd(scmd, stu_command, 6, scmd->device->request_queue->rq_timeout, 0);
Brian Kinged773e62007-03-29 15:25:52 -05001370
Christoph Hellwig631c2282006-07-08 20:42:15 +02001371 if (rtn == SUCCESS)
1372 return 0;
1373 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375 return 1;
1376}
1377
1378 /**
1379 * scsi_eh_stu - send START_UNIT if needed
Rob Landleyeb448202007-11-03 13:30:39 -05001380 * @shost: &scsi host being recovered.
Randy Dunlap74cf2982014-08-16 14:15:11 -07001381 * @work_q: &list_head for pending commands.
Rob Landleyeb448202007-11-03 13:30:39 -05001382 * @done_q: &list_head for processed commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 *
1384 * Notes:
1385 * If commands are failing due to not ready, initializing command required,
Jesper Juhl0bf8c862011-03-21 20:47:31 +01001386 * try revalidating the device, which will end up sending a start unit.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001387 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388static int scsi_eh_stu(struct Scsi_Host *shost,
1389 struct list_head *work_q,
1390 struct list_head *done_q)
1391{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001392 struct scsi_cmnd *scmd, *stu_scmd, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 struct scsi_device *sdev;
1394
1395 shost_for_each_device(sdev, shost) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001396 if (scsi_host_eh_past_deadline(shost)) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001397 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001398 sdev_printk(KERN_INFO, sdev,
1399 "%s: skip START_UNIT, past eh deadline\n",
1400 current->comm));
Hannes Reineckeb4562022013-10-23 10:51:21 +02001401 break;
1402 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 stu_scmd = NULL;
1404 list_for_each_entry(scmd, work_q, eh_entry)
1405 if (scmd->device == sdev && SCSI_SENSE_VALID(scmd) &&
1406 scsi_check_sense(scmd) == FAILED ) {
1407 stu_scmd = scmd;
1408 break;
1409 }
1410
1411 if (!stu_scmd)
1412 continue;
1413
Hannes Reinecke91921e02014-06-25 16:39:59 +02001414 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001415 sdev_printk(KERN_INFO, sdev,
1416 "%s: Sending START_UNIT\n",
1417 current->comm));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418
1419 if (!scsi_eh_try_stu(stu_scmd)) {
1420 if (!scsi_device_online(sdev) ||
1421 !scsi_eh_tur(stu_scmd)) {
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001422 list_for_each_entry_safe(scmd, next,
1423 work_q, eh_entry) {
James Bottomley24510792013-11-11 13:44:53 +01001424 if (scmd->device == sdev &&
1425 scsi_eh_action(scmd, SUCCESS) == SUCCESS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 scsi_eh_finish_cmd(scmd, done_q);
1427 }
1428 }
1429 } else {
1430 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001431 sdev_printk(KERN_INFO, sdev,
1432 "%s: START_UNIT failed\n",
1433 current->comm));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 }
1435 }
1436
1437 return list_empty(work_q);
1438}
1439
1440
1441/**
1442 * scsi_eh_bus_device_reset - send bdr if needed
1443 * @shost: scsi host being recovered.
Randy Dunlap74cf2982014-08-16 14:15:11 -07001444 * @work_q: &list_head for pending commands.
Rob Landleyeb448202007-11-03 13:30:39 -05001445 * @done_q: &list_head for processed commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 *
1447 * Notes:
Rob Landleyeb448202007-11-03 13:30:39 -05001448 * Try a bus device reset. Still, look to see whether we have multiple
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449 * devices that are jammed or not - if we have multiple devices, it
1450 * makes no sense to try bus_device_reset - we really would need to try
Jesper Juhl0bf8c862011-03-21 20:47:31 +01001451 * a bus_reset instead.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001452 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453static int scsi_eh_bus_device_reset(struct Scsi_Host *shost,
1454 struct list_head *work_q,
1455 struct list_head *done_q)
1456{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001457 struct scsi_cmnd *scmd, *bdr_scmd, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 struct scsi_device *sdev;
1459 int rtn;
1460
1461 shost_for_each_device(sdev, shost) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001462 if (scsi_host_eh_past_deadline(shost)) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001463 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001464 sdev_printk(KERN_INFO, sdev,
1465 "%s: skip BDR, past eh deadline\n",
1466 current->comm));
Hannes Reineckeb4562022013-10-23 10:51:21 +02001467 break;
1468 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469 bdr_scmd = NULL;
1470 list_for_each_entry(scmd, work_q, eh_entry)
1471 if (scmd->device == sdev) {
1472 bdr_scmd = scmd;
1473 break;
1474 }
1475
1476 if (!bdr_scmd)
1477 continue;
1478
Hannes Reinecke91921e02014-06-25 16:39:59 +02001479 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001480 sdev_printk(KERN_INFO, sdev,
1481 "%s: Sending BDR\n", current->comm));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482 rtn = scsi_try_bus_device_reset(bdr_scmd);
Christof Schmitt2f2eb582010-03-24 16:50:30 +01001483 if (rtn == SUCCESS || rtn == FAST_IO_FAIL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 if (!scsi_device_online(sdev) ||
Christof Schmitt2f2eb582010-03-24 16:50:30 +01001485 rtn == FAST_IO_FAIL ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486 !scsi_eh_tur(bdr_scmd)) {
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001487 list_for_each_entry_safe(scmd, next,
1488 work_q, eh_entry) {
James Bottomley24510792013-11-11 13:44:53 +01001489 if (scmd->device == sdev &&
1490 scsi_eh_action(scmd, rtn) != FAILED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491 scsi_eh_finish_cmd(scmd,
1492 done_q);
1493 }
1494 }
1495 } else {
Hannes Reinecke91921e02014-06-25 16:39:59 +02001496 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001497 sdev_printk(KERN_INFO, sdev,
1498 "%s: BDR failed\n", current->comm));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499 }
1500 }
1501
1502 return list_empty(work_q);
1503}
1504
1505/**
Mike Christie30bd7df2008-02-29 18:25:19 -06001506 * scsi_eh_target_reset - send target reset if needed
1507 * @shost: scsi host being recovered.
Randy Dunlap74cf2982014-08-16 14:15:11 -07001508 * @work_q: &list_head for pending commands.
Mike Christie30bd7df2008-02-29 18:25:19 -06001509 * @done_q: &list_head for processed commands.
1510 *
1511 * Notes:
1512 * Try a target reset.
1513 */
1514static int scsi_eh_target_reset(struct Scsi_Host *shost,
1515 struct list_head *work_q,
1516 struct list_head *done_q)
1517{
James Bottomley98db5192010-10-25 15:53:41 -05001518 LIST_HEAD(tmp_list);
David Jeffery3eef6252011-05-19 14:41:12 -04001519 LIST_HEAD(check_list);
Mike Christie30bd7df2008-02-29 18:25:19 -06001520
James Bottomley98db5192010-10-25 15:53:41 -05001521 list_splice_init(work_q, &tmp_list);
1522
1523 while (!list_empty(&tmp_list)) {
1524 struct scsi_cmnd *next, *scmd;
1525 int rtn;
1526 unsigned int id;
Hannes Reineckeb4562022013-10-23 10:51:21 +02001527
Hannes Reineckeb4562022013-10-23 10:51:21 +02001528 if (scsi_host_eh_past_deadline(shost)) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001529 /* push back on work queue for further processing */
1530 list_splice_init(&check_list, work_q);
1531 list_splice_init(&tmp_list, work_q);
1532 SCSI_LOG_ERROR_RECOVERY(3,
1533 shost_printk(KERN_INFO, shost,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001534 "%s: Skip target reset, past eh deadline\n",
1535 current->comm));
Hannes Reineckeb4562022013-10-23 10:51:21 +02001536 return list_empty(work_q);
1537 }
James Bottomley98db5192010-10-25 15:53:41 -05001538
1539 scmd = list_entry(tmp_list.next, struct scsi_cmnd, eh_entry);
1540 id = scmd_id(scmd);
Mike Christie30bd7df2008-02-29 18:25:19 -06001541
Hannes Reinecke91921e02014-06-25 16:39:59 +02001542 SCSI_LOG_ERROR_RECOVERY(3,
1543 shost_printk(KERN_INFO, shost,
1544 "%s: Sending target reset to target %d\n",
1545 current->comm, id));
James Bottomley98db5192010-10-25 15:53:41 -05001546 rtn = scsi_try_target_reset(scmd);
1547 if (rtn != SUCCESS && rtn != FAST_IO_FAIL)
Hannes Reinecke91921e02014-06-25 16:39:59 +02001548 SCSI_LOG_ERROR_RECOVERY(3,
1549 shost_printk(KERN_INFO, shost,
1550 "%s: Target reset failed"
1551 " target: %d\n",
1552 current->comm, id));
James Bottomley98db5192010-10-25 15:53:41 -05001553 list_for_each_entry_safe(scmd, next, &tmp_list, eh_entry) {
1554 if (scmd_id(scmd) != id)
1555 continue;
1556
David Jeffery3eef6252011-05-19 14:41:12 -04001557 if (rtn == SUCCESS)
1558 list_move_tail(&scmd->eh_entry, &check_list);
1559 else if (rtn == FAST_IO_FAIL)
James Bottomley98db5192010-10-25 15:53:41 -05001560 scsi_eh_finish_cmd(scmd, done_q);
1561 else
1562 /* push back on work queue for further processing */
1563 list_move(&scmd->eh_entry, work_q);
1564 }
1565 }
Mike Christie30bd7df2008-02-29 18:25:19 -06001566
David Jeffery3eef6252011-05-19 14:41:12 -04001567 return scsi_eh_test_devices(&check_list, work_q, done_q, 0);
Mike Christie30bd7df2008-02-29 18:25:19 -06001568}
1569
1570/**
Jesper Juhl0bf8c862011-03-21 20:47:31 +01001571 * scsi_eh_bus_reset - send a bus reset
Rob Landleyeb448202007-11-03 13:30:39 -05001572 * @shost: &scsi host being recovered.
Randy Dunlap74cf2982014-08-16 14:15:11 -07001573 * @work_q: &list_head for pending commands.
Rob Landleyeb448202007-11-03 13:30:39 -05001574 * @done_q: &list_head for processed commands.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001575 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576static int scsi_eh_bus_reset(struct Scsi_Host *shost,
1577 struct list_head *work_q,
1578 struct list_head *done_q)
1579{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001580 struct scsi_cmnd *scmd, *chan_scmd, *next;
David Jeffery3eef6252011-05-19 14:41:12 -04001581 LIST_HEAD(check_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 unsigned int channel;
1583 int rtn;
1584
1585 /*
1586 * we really want to loop over the various channels, and do this on
1587 * a channel by channel basis. we should also check to see if any
1588 * of the failed commands are on soft_reset devices, and if so, skip
Jesper Juhl0bf8c862011-03-21 20:47:31 +01001589 * the reset.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 */
1591
1592 for (channel = 0; channel <= shost->max_channel; channel++) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001593 if (scsi_host_eh_past_deadline(shost)) {
Hannes Reineckeb4562022013-10-23 10:51:21 +02001594 list_splice_init(&check_list, work_q);
1595 SCSI_LOG_ERROR_RECOVERY(3,
1596 shost_printk(KERN_INFO, shost,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02001597 "%s: skip BRST, past eh deadline\n",
1598 current->comm));
Hannes Reineckeb4562022013-10-23 10:51:21 +02001599 return list_empty(work_q);
1600 }
Hannes Reineckeb4562022013-10-23 10:51:21 +02001601
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602 chan_scmd = NULL;
1603 list_for_each_entry(scmd, work_q, eh_entry) {
Jeff Garzik422c0d62005-10-24 18:05:09 -04001604 if (channel == scmd_channel(scmd)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 chan_scmd = scmd;
1606 break;
1607 /*
1608 * FIXME add back in some support for
1609 * soft_reset devices.
1610 */
1611 }
1612 }
1613
1614 if (!chan_scmd)
1615 continue;
Hannes Reinecke91921e02014-06-25 16:39:59 +02001616 SCSI_LOG_ERROR_RECOVERY(3,
1617 shost_printk(KERN_INFO, shost,
1618 "%s: Sending BRST chan: %d\n",
1619 current->comm, channel));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 rtn = scsi_try_bus_reset(chan_scmd);
Christof Schmitt2f2eb582010-03-24 16:50:30 +01001621 if (rtn == SUCCESS || rtn == FAST_IO_FAIL) {
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001622 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
David Jeffery3eef6252011-05-19 14:41:12 -04001623 if (channel == scmd_channel(scmd)) {
1624 if (rtn == FAST_IO_FAIL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625 scsi_eh_finish_cmd(scmd,
1626 done_q);
David Jeffery3eef6252011-05-19 14:41:12 -04001627 else
1628 list_move_tail(&scmd->eh_entry,
1629 &check_list);
1630 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631 }
1632 } else {
Hannes Reinecke91921e02014-06-25 16:39:59 +02001633 SCSI_LOG_ERROR_RECOVERY(3,
1634 shost_printk(KERN_INFO, shost,
1635 "%s: BRST failed chan: %d\n",
1636 current->comm, channel));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 }
1638 }
David Jeffery3eef6252011-05-19 14:41:12 -04001639 return scsi_eh_test_devices(&check_list, work_q, done_q, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640}
1641
1642/**
Jesper Juhl0bf8c862011-03-21 20:47:31 +01001643 * scsi_eh_host_reset - send a host reset
Randy Dunlap74cf2982014-08-16 14:15:11 -07001644 * @shost: host to be reset.
1645 * @work_q: &list_head for pending commands.
1646 * @done_q: &list_head for processed commands.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001647 */
Hannes Reinecke91921e02014-06-25 16:39:59 +02001648static int scsi_eh_host_reset(struct Scsi_Host *shost,
1649 struct list_head *work_q,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 struct list_head *done_q)
1651{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001652 struct scsi_cmnd *scmd, *next;
David Jeffery3eef6252011-05-19 14:41:12 -04001653 LIST_HEAD(check_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654 int rtn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655
1656 if (!list_empty(work_q)) {
1657 scmd = list_entry(work_q->next,
1658 struct scsi_cmnd, eh_entry);
1659
Hannes Reinecke91921e02014-06-25 16:39:59 +02001660 SCSI_LOG_ERROR_RECOVERY(3,
1661 shost_printk(KERN_INFO, shost,
1662 "%s: Sending HRST\n",
1663 current->comm));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664
1665 rtn = scsi_try_host_reset(scmd);
David Jeffery3eef6252011-05-19 14:41:12 -04001666 if (rtn == SUCCESS) {
1667 list_splice_init(work_q, &check_list);
1668 } else if (rtn == FAST_IO_FAIL) {
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001669 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 scsi_eh_finish_cmd(scmd, done_q);
1671 }
1672 } else {
Hannes Reinecke91921e02014-06-25 16:39:59 +02001673 SCSI_LOG_ERROR_RECOVERY(3,
1674 shost_printk(KERN_INFO, shost,
1675 "%s: HRST failed\n",
1676 current->comm));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 }
1678 }
David Jeffery3eef6252011-05-19 14:41:12 -04001679 return scsi_eh_test_devices(&check_list, work_q, done_q, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680}
1681
1682/**
1683 * scsi_eh_offline_sdevs - offline scsi devices that fail to recover
Randy Dunlap74cf2982014-08-16 14:15:11 -07001684 * @work_q: &list_head for pending commands.
1685 * @done_q: &list_head for processed commands.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001686 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687static void scsi_eh_offline_sdevs(struct list_head *work_q,
1688 struct list_head *done_q)
1689{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001690 struct scsi_cmnd *scmd, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02001692 list_for_each_entry_safe(scmd, next, work_q, eh_entry) {
Matthew Wilcox31765d72007-08-17 11:02:10 -06001693 sdev_printk(KERN_INFO, scmd->device, "Device offlined - "
1694 "not ready after error recovery\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695 scsi_device_set_state(scmd->device, SDEV_OFFLINE);
Christoph Hellwig3111b0d2005-06-19 13:43:26 +02001696 if (scmd->eh_eflags & SCSI_EH_CANCEL_CMD) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 /*
1698 * FIXME: Handle lost cmds.
1699 */
1700 }
1701 scsi_eh_finish_cmd(scmd, done_q);
1702 }
1703 return;
1704}
1705
1706/**
Hannes Reineckee494f6a2013-11-11 13:44:54 +01001707 * scsi_noretry_cmd - determine if command should be failed fast
Mike Christie4a274462008-08-19 18:45:31 -05001708 * @scmd: SCSI cmd to examine.
1709 */
1710int scsi_noretry_cmd(struct scsi_cmnd *scmd)
1711{
1712 switch (host_byte(scmd->result)) {
1713 case DID_OK:
1714 break;
Hannes Reineckee494f6a2013-11-11 13:44:54 +01001715 case DID_TIME_OUT:
1716 goto check_type;
Mike Christie4a274462008-08-19 18:45:31 -05001717 case DID_BUS_BUSY:
Christoph Hellwig33659eb2010-08-07 18:17:56 +02001718 return (scmd->request->cmd_flags & REQ_FAILFAST_TRANSPORT);
Mike Christie4a274462008-08-19 18:45:31 -05001719 case DID_PARITY:
Christoph Hellwig33659eb2010-08-07 18:17:56 +02001720 return (scmd->request->cmd_flags & REQ_FAILFAST_DEV);
Mike Christie4a274462008-08-19 18:45:31 -05001721 case DID_ERROR:
1722 if (msg_byte(scmd->result) == COMMAND_COMPLETE &&
1723 status_byte(scmd->result) == RESERVATION_CONFLICT)
1724 return 0;
1725 /* fall through */
1726 case DID_SOFT_ERROR:
Christoph Hellwig33659eb2010-08-07 18:17:56 +02001727 return (scmd->request->cmd_flags & REQ_FAILFAST_DRIVER);
Mike Christie4a274462008-08-19 18:45:31 -05001728 }
1729
Hannes Reineckee494f6a2013-11-11 13:44:54 +01001730 if (status_byte(scmd->result) != CHECK_CONDITION)
1731 return 0;
Mike Christie4a274462008-08-19 18:45:31 -05001732
Hannes Reineckee494f6a2013-11-11 13:44:54 +01001733check_type:
1734 /*
1735 * assume caller has checked sense and determined
1736 * the check condition was retryable.
1737 */
1738 if (scmd->request->cmd_flags & REQ_FAILFAST_DEV ||
1739 scmd->request->cmd_type == REQ_TYPE_BLOCK_PC)
1740 return 1;
1741 else
1742 return 0;
Mike Christie4a274462008-08-19 18:45:31 -05001743}
1744
1745/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746 * scsi_decide_disposition - Disposition a cmd on return from LLD.
1747 * @scmd: SCSI cmd to examine.
1748 *
1749 * Notes:
1750 * This is *only* called when we are examining the status after sending
1751 * out the actual data command. any commands that are queued for error
1752 * recovery (e.g. test_unit_ready) do *not* come through here.
1753 *
1754 * When this routine returns failed, it means the error handler thread
1755 * is woken. In cases where the error code indicates an error that
1756 * doesn't require the error handler read (i.e. we don't need to
1757 * abort/reset), this function should return SUCCESS.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001758 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759int scsi_decide_disposition(struct scsi_cmnd *scmd)
1760{
1761 int rtn;
1762
1763 /*
1764 * if the device is offline, then we clearly just pass the result back
1765 * up to the top level.
1766 */
1767 if (!scsi_device_online(scmd->device)) {
Hannes Reinecke91921e02014-06-25 16:39:59 +02001768 SCSI_LOG_ERROR_RECOVERY(5, scmd_printk(KERN_INFO, scmd,
1769 "%s: device offline - report as SUCCESS\n", __func__));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770 return SUCCESS;
1771 }
1772
1773 /*
1774 * first check the host byte, to see if there is anything in there
1775 * that would indicate what we need to do.
1776 */
1777 switch (host_byte(scmd->result)) {
1778 case DID_PASSTHROUGH:
1779 /*
1780 * no matter what, pass this through to the upper layer.
1781 * nuke this special code so that it looks like we are saying
1782 * did_ok.
1783 */
1784 scmd->result &= 0xff00ffff;
1785 return SUCCESS;
1786 case DID_OK:
1787 /*
1788 * looks good. drop through, and check the next byte.
1789 */
1790 break;
Hannes Reineckee494f6a2013-11-11 13:44:54 +01001791 case DID_ABORT:
1792 if (scmd->eh_eflags & SCSI_EH_ABORT_SCHEDULED) {
Ulrich Obergfell8922a902014-06-04 13:34:57 +02001793 set_host_byte(scmd, DID_TIME_OUT);
Hannes Reineckee494f6a2013-11-11 13:44:54 +01001794 return SUCCESS;
1795 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 case DID_NO_CONNECT:
1797 case DID_BAD_TARGET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 /*
1799 * note - this means that we just report the status back
1800 * to the top level driver, not that we actually think
1801 * that it indicates SUCCESS.
1802 */
1803 return SUCCESS;
1804 /*
1805 * when the low level driver returns did_soft_error,
Jesper Juhl0bf8c862011-03-21 20:47:31 +01001806 * it is responsible for keeping an internal retry counter
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807 * in order to avoid endless loops (db)
1808 *
1809 * actually this is a bug in this function here. we should
1810 * be mindful of the maximum number of retries specified
1811 * and not get stuck in a loop.
1812 */
1813 case DID_SOFT_ERROR:
1814 goto maybe_retry;
1815 case DID_IMM_RETRY:
1816 return NEEDS_RETRY;
1817
bf341912005-04-12 17:49:09 -05001818 case DID_REQUEUE:
1819 return ADD_TO_MLQUEUE;
Mike Christiea4dfaa62008-08-19 18:45:25 -05001820 case DID_TRANSPORT_DISRUPTED:
1821 /*
1822 * LLD/transport was disrupted during processing of the IO.
1823 * The transport class is now blocked/blocking,
1824 * and the transport will decide what to do with the IO
Mike Christie939c2282008-11-04 19:47:19 -06001825 * based on its timers and recovery capablilities if
1826 * there are enough retries.
Mike Christiea4dfaa62008-08-19 18:45:25 -05001827 */
Mike Christie939c2282008-11-04 19:47:19 -06001828 goto maybe_retry;
Mike Christiea4dfaa62008-08-19 18:45:25 -05001829 case DID_TRANSPORT_FAILFAST:
1830 /*
1831 * The transport decided to failfast the IO (most likely
1832 * the fast io fail tmo fired), so send IO directly upwards.
1833 */
1834 return SUCCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835 case DID_ERROR:
1836 if (msg_byte(scmd->result) == COMMAND_COMPLETE &&
1837 status_byte(scmd->result) == RESERVATION_CONFLICT)
1838 /*
1839 * execute reservation conflict processing code
1840 * lower down
1841 */
1842 break;
1843 /* fallthrough */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 case DID_BUS_BUSY:
1845 case DID_PARITY:
1846 goto maybe_retry;
1847 case DID_TIME_OUT:
1848 /*
1849 * when we scan the bus, we get timeout messages for
1850 * these commands if there is no device available.
1851 * other hosts report did_no_connect for the same thing.
1852 */
1853 if ((scmd->cmnd[0] == TEST_UNIT_READY ||
1854 scmd->cmnd[0] == INQUIRY)) {
1855 return SUCCESS;
1856 } else {
1857 return FAILED;
1858 }
1859 case DID_RESET:
1860 return SUCCESS;
1861 default:
1862 return FAILED;
1863 }
1864
1865 /*
1866 * next, check the message byte.
1867 */
1868 if (msg_byte(scmd->result) != COMMAND_COMPLETE)
1869 return FAILED;
1870
1871 /*
1872 * check the status byte to see if this indicates anything special.
1873 */
1874 switch (status_byte(scmd->result)) {
1875 case QUEUE_FULL:
Mike Christie42a6a912009-10-15 17:46:44 -07001876 scsi_handle_queue_full(scmd->device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 /*
1878 * the case of trying to send too many commands to a
1879 * tagged queueing device.
1880 */
1881 case BUSY:
1882 /*
1883 * device can't talk to us at the moment. Should only
1884 * occur (SAM-3) when the task queue is empty, so will cause
1885 * the empty queue handling to trigger a stall in the
1886 * device.
1887 */
1888 return ADD_TO_MLQUEUE;
1889 case GOOD:
Ewan D. Milne279afdf2013-08-08 15:07:48 -04001890 if (scmd->cmnd[0] == REPORT_LUNS)
1891 scmd->device->sdev_target->expecting_lun_change = 0;
Vasu Dev4a840672009-10-22 15:46:33 -07001892 scsi_handle_queue_ramp_up(scmd->device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 case COMMAND_TERMINATED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894 return SUCCESS;
Vladislav Bolkhovitina9b589d2008-11-06 13:57:52 +03001895 case TASK_ABORTED:
1896 goto maybe_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897 case CHECK_CONDITION:
1898 rtn = scsi_check_sense(scmd);
1899 if (rtn == NEEDS_RETRY)
1900 goto maybe_retry;
1901 /* if rtn == FAILED, we have no sense information;
1902 * returning FAILED will wake the error handler thread
1903 * to collect the sense and redo the decide
1904 * disposition */
1905 return rtn;
1906 case CONDITION_GOOD:
1907 case INTERMEDIATE_GOOD:
1908 case INTERMEDIATE_C_GOOD:
1909 case ACA_ACTIVE:
1910 /*
1911 * who knows? FIXME(eric)
1912 */
1913 return SUCCESS;
1914
1915 case RESERVATION_CONFLICT:
James Bottomley9ccfc752005-10-02 11:45:08 -05001916 sdev_printk(KERN_INFO, scmd->device,
1917 "reservation conflict\n");
Moger, Babu2082ebc2012-01-24 20:38:46 +00001918 set_host_byte(scmd, DID_NEXUS_FAILURE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 return SUCCESS; /* causes immediate i/o error */
1920 default:
1921 return FAILED;
1922 }
1923 return FAILED;
1924
1925 maybe_retry:
1926
1927 /* we requeue for retry because the error was retryable, and
1928 * the request was not marked fast fail. Note that above,
1929 * even if the request is marked fast fail, we still requeue
1930 * for queue congestion conditions (QUEUE_FULL or BUSY) */
Brian King8884efa2006-02-24 17:10:04 -06001931 if ((++scmd->retries) <= scmd->allowed
Mike Christie4a274462008-08-19 18:45:31 -05001932 && !scsi_noretry_cmd(scmd)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933 return NEEDS_RETRY;
1934 } else {
1935 /*
1936 * no more retries - report this one back to upper level.
1937 */
1938 return SUCCESS;
1939 }
1940}
1941
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001942static void eh_lock_door_done(struct request *req, int uptodate)
1943{
1944 __blk_put_request(req->q, req);
1945}
1946
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 * scsi_eh_lock_door - Prevent medium removal for the specified device
1949 * @sdev: SCSI device to prevent medium removal
1950 *
1951 * Locking:
James Bottomley91bc31f2009-05-17 09:30:48 -05001952 * We must be called from process context.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 *
1954 * Notes:
1955 * We queue up an asynchronous "ALLOW MEDIUM REMOVAL" request on the
1956 * head of the devices request queue, and continue.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001957 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958static void scsi_eh_lock_door(struct scsi_device *sdev)
1959{
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001960 struct request *req;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961
James Bottomley91bc31f2009-05-17 09:30:48 -05001962 /*
1963 * blk_get_request with GFP_KERNEL (__GFP_WAIT) sleeps until a
1964 * request becomes available
1965 */
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001966 req = blk_get_request(sdev->request_queue, READ, GFP_KERNEL);
Joe Lawrencea492f072014-08-28 08:15:21 -06001967 if (IS_ERR(req))
Joe Lawrenceeb571ee2014-07-02 15:35:16 -04001968 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969
Jens Axboef27b0872014-06-06 07:57:37 -06001970 blk_rq_set_block_pc(req);
1971
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001972 req->cmd[0] = ALLOW_MEDIUM_REMOVAL;
1973 req->cmd[1] = 0;
1974 req->cmd[2] = 0;
1975 req->cmd[3] = 0;
1976 req->cmd[4] = SCSI_REMOVAL_PREVENT;
1977 req->cmd[5] = 0;
1978
1979 req->cmd_len = COMMAND_SIZE(req->cmd[0]);
1980
FUJITA Tomonorif0787272008-12-14 01:23:45 +09001981 req->cmd_flags |= REQ_QUIET;
1982 req->timeout = 10 * HZ;
1983 req->retries = 5;
1984
1985 blk_execute_rq_nowait(req->q, NULL, req, 1, eh_lock_door_done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986}
1987
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988/**
1989 * scsi_restart_operations - restart io operations to the specified host.
1990 * @shost: Host we are restarting.
1991 *
1992 * Notes:
1993 * When we entered the error handler, we blocked all further i/o to
1994 * this device. we need to 'reverse' this process.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08001995 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996static void scsi_restart_operations(struct Scsi_Host *shost)
1997{
1998 struct scsi_device *sdev;
James Bottomley939647e2005-09-18 15:05:20 -05001999 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000
2001 /*
2002 * If the door was locked, we need to insert a door lock request
2003 * onto the head of the SCSI request queue for the device. There
2004 * is no point trying to lock the door of an off-line device.
2005 */
2006 shost_for_each_device(sdev, shost) {
Christoph Hellwig48379272014-11-03 19:36:40 +01002007 if (scsi_device_online(sdev) && sdev->was_reset && sdev->locked) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 scsi_eh_lock_door(sdev);
Christoph Hellwig48379272014-11-03 19:36:40 +01002009 sdev->was_reset = 0;
2010 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011 }
2012
2013 /*
2014 * next free up anything directly waiting upon the host. this
2015 * will be requests for character device operations, and also for
2016 * ioctls to queued block devices.
2017 */
Hannes Reineckeb4562022013-10-23 10:51:21 +02002018 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002019 shost_printk(KERN_INFO, shost, "waking up host to restart\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020
James Bottomley939647e2005-09-18 15:05:20 -05002021 spin_lock_irqsave(shost->host_lock, flags);
2022 if (scsi_host_set_state(shost, SHOST_RUNNING))
2023 if (scsi_host_set_state(shost, SHOST_CANCEL))
2024 BUG_ON(scsi_host_set_state(shost, SHOST_DEL));
2025 spin_unlock_irqrestore(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026
2027 wake_up(&shost->host_wait);
2028
2029 /*
2030 * finally we need to re-initiate requests that may be pending. we will
2031 * have had everything blocked while error handling is taking place, and
2032 * now that error recovery is done, we will need to ensure that these
2033 * requests are started.
2034 */
2035 scsi_run_host_queues(shost);
Dan Williams57fc2e32012-06-21 23:25:32 -07002036
2037 /*
2038 * if eh is active and host_eh_scheduled is pending we need to re-run
2039 * recovery. we do this check after scsi_run_host_queues() to allow
2040 * everything pent up since the last eh run a chance to make forward
2041 * progress before we sync again. Either we'll immediately re-run
2042 * recovery or scsi_device_unbusy() will wake us again when these
2043 * pending commands complete.
2044 */
2045 spin_lock_irqsave(shost->host_lock, flags);
2046 if (shost->host_eh_scheduled)
2047 if (scsi_host_set_state(shost, SHOST_RECOVERY))
2048 WARN_ON(scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY));
2049 spin_unlock_irqrestore(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050}
2051
2052/**
2053 * scsi_eh_ready_devs - check device ready state and recover if not.
Randy Dunlap74cf2982014-08-16 14:15:11 -07002054 * @shost: host to be recovered.
2055 * @work_q: &list_head for pending commands.
Rob Landleyeb448202007-11-03 13:30:39 -05002056 * @done_q: &list_head for processed commands.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08002057 */
Darrick J. Wongdca84e42007-01-26 14:08:49 -08002058void scsi_eh_ready_devs(struct Scsi_Host *shost,
2059 struct list_head *work_q,
2060 struct list_head *done_q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061{
2062 if (!scsi_eh_stu(shost, work_q, done_q))
2063 if (!scsi_eh_bus_device_reset(shost, work_q, done_q))
Mike Christie30bd7df2008-02-29 18:25:19 -06002064 if (!scsi_eh_target_reset(shost, work_q, done_q))
2065 if (!scsi_eh_bus_reset(shost, work_q, done_q))
Hannes Reinecke91921e02014-06-25 16:39:59 +02002066 if (!scsi_eh_host_reset(shost, work_q, done_q))
Mike Christie30bd7df2008-02-29 18:25:19 -06002067 scsi_eh_offline_sdevs(work_q,
2068 done_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069}
Darrick J. Wongdca84e42007-01-26 14:08:49 -08002070EXPORT_SYMBOL_GPL(scsi_eh_ready_devs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071
2072/**
2073 * scsi_eh_flush_done_q - finish processed commands or retry them.
2074 * @done_q: list_head of processed commands.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08002075 */
Tejun Heo041c5fc2006-01-23 13:09:36 +09002076void scsi_eh_flush_done_q(struct list_head *done_q)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077{
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02002078 struct scsi_cmnd *scmd, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079
Christoph Hellwig937abeaa2005-06-19 13:43:56 +02002080 list_for_each_entry_safe(scmd, next, done_q, eh_entry) {
2081 list_del_init(&scmd->eh_entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082 if (scsi_device_online(scmd->device) &&
Mike Christie4a274462008-08-19 18:45:31 -05002083 !scsi_noretry_cmd(scmd) &&
Brian King8884efa2006-02-24 17:10:04 -06002084 (++scmd->retries <= scmd->allowed)) {
Hannes Reinecke91921e02014-06-25 16:39:59 +02002085 SCSI_LOG_ERROR_RECOVERY(3,
2086 scmd_printk(KERN_INFO, scmd,
Hannes Reinecke470613b2015-01-08 07:43:50 +01002087 "%s: flush retry cmd\n",
2088 current->comm));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 scsi_queue_insert(scmd, SCSI_MLQUEUE_EH_RETRY);
2090 } else {
Patrick Mansfield 793698c2005-05-16 17:42:15 -07002091 /*
2092 * If just we got sense for the device (called
2093 * scsi_eh_get_sense), scmd->result is already
2094 * set, do not set DRIVER_TIMEOUT.
2095 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096 if (!scmd->result)
2097 scmd->result |= (DRIVER_TIMEOUT << 24);
Hannes Reinecke91921e02014-06-25 16:39:59 +02002098 SCSI_LOG_ERROR_RECOVERY(3,
2099 scmd_printk(KERN_INFO, scmd,
Hannes Reinecke470613b2015-01-08 07:43:50 +01002100 "%s: flush finish cmd\n",
2101 current->comm));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102 scsi_finish_command(scmd);
2103 }
2104 }
2105}
Tejun Heo041c5fc2006-01-23 13:09:36 +09002106EXPORT_SYMBOL(scsi_eh_flush_done_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107
2108/**
2109 * scsi_unjam_host - Attempt to fix a host which has a cmd that failed.
2110 * @shost: Host to unjam.
2111 *
2112 * Notes:
2113 * When we come in here, we *know* that all commands on the bus have
2114 * either completed, failed or timed out. we also know that no further
2115 * commands are being sent to the host, so things are relatively quiet
2116 * and we have freedom to fiddle with things as we wish.
2117 *
2118 * This is only the *default* implementation. it is possible for
2119 * individual drivers to supply their own version of this function, and
2120 * if the maintainer wishes to do this, it is strongly suggested that
2121 * this function be taken as a template and modified. this function
2122 * was designed to correctly handle problems for about 95% of the
2123 * different cases out there, and it should always provide at least a
2124 * reasonable amount of error recovery.
2125 *
2126 * Any command marked 'failed' or 'timeout' must eventually have
2127 * scsi_finish_cmd() called for it. we do all of the retry stuff
2128 * here, so when we restart the host after we return it should have an
2129 * empty queue.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08002130 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131static void scsi_unjam_host(struct Scsi_Host *shost)
2132{
2133 unsigned long flags;
2134 LIST_HEAD(eh_work_q);
2135 LIST_HEAD(eh_done_q);
2136
2137 spin_lock_irqsave(shost->host_lock, flags);
2138 list_splice_init(&shost->eh_cmd_q, &eh_work_q);
2139 spin_unlock_irqrestore(shost->host_lock, flags);
2140
2141 SCSI_LOG_ERROR_RECOVERY(1, scsi_eh_prt_fail_stats(shost, &eh_work_q));
2142
2143 if (!scsi_eh_get_sense(&eh_work_q, &eh_done_q))
2144 if (!scsi_eh_abort_cmds(&eh_work_q, &eh_done_q))
2145 scsi_eh_ready_devs(shost, &eh_work_q, &eh_done_q);
2146
Hannes Reineckeb4562022013-10-23 10:51:21 +02002147 spin_lock_irqsave(shost->host_lock, flags);
Ren Mingxinbb3b6212013-11-11 13:44:56 +01002148 if (shost->eh_deadline != -1)
Hannes Reineckeb4562022013-10-23 10:51:21 +02002149 shost->last_reset = 0;
2150 spin_unlock_irqrestore(shost->host_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 scsi_eh_flush_done_q(&eh_done_q);
2152}
2153
2154/**
Christoph Hellwigad42eb12005-10-29 01:01:55 +02002155 * scsi_error_handler - SCSI error handler thread
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 * @data: Host for which we are running.
2157 *
2158 * Notes:
Christoph Hellwigad42eb12005-10-29 01:01:55 +02002159 * This is the main error handling loop. This is run as a kernel thread
2160 * for every SCSI host and handles all error handling activity.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08002161 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162int scsi_error_handler(void *data)
2163{
Christoph Hellwigad42eb12005-10-29 01:01:55 +02002164 struct Scsi_Host *shost = data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 /*
Christoph Hellwigad42eb12005-10-29 01:01:55 +02002167 * We use TASK_INTERRUPTIBLE so that the thread is not
2168 * counted against the load average as a running process.
2169 * We never actually get interrupted because kthread_run
Frederik Schwarzerc03264a2008-12-23 00:54:00 +01002170 * disables signal delivery for the created thread.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 */
James Bottomley3ed7a472005-09-19 09:50:04 -05002172 while (!kthread_should_stop()) {
Dan Williamsb9d5c6b2012-06-21 23:25:42 -07002173 set_current_state(TASK_INTERRUPTIBLE);
Tejun Heoee7863b2006-05-15 20:57:20 +09002174 if ((shost->host_failed == 0 && shost->host_eh_scheduled == 0) ||
Christoph Hellwig74665012014-01-22 15:29:29 +01002175 shost->host_failed != atomic_read(&shost->host_busy)) {
Christoph Hellwigad42eb12005-10-29 01:01:55 +02002176 SCSI_LOG_ERROR_RECOVERY(1,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002177 shost_printk(KERN_INFO, shost,
2178 "scsi_eh_%d: sleeping\n",
2179 shost->host_no));
James Bottomley3ed7a472005-09-19 09:50:04 -05002180 schedule();
James Bottomley3ed7a472005-09-19 09:50:04 -05002181 continue;
2182 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183
James Bottomley3ed7a472005-09-19 09:50:04 -05002184 __set_current_state(TASK_RUNNING);
Christoph Hellwigad42eb12005-10-29 01:01:55 +02002185 SCSI_LOG_ERROR_RECOVERY(1,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002186 shost_printk(KERN_INFO, shost,
2187 "scsi_eh_%d: waking up %d/%d/%d\n",
2188 shost->host_no, shost->host_eh_scheduled,
Christoph Hellwig74665012014-01-22 15:29:29 +01002189 shost->host_failed,
2190 atomic_read(&shost->host_busy)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192 /*
2193 * We have a host that is failing for some reason. Figure out
2194 * what we need to do to get it up and online again (if we can).
2195 * If we fail, we end up taking the thing offline.
2196 */
Lin Mingae0751f2011-12-05 09:20:24 +08002197 if (!shost->eh_noresume && scsi_autopm_get_host(shost) != 0) {
Alan Sternbc4f2402010-06-17 10:41:42 -04002198 SCSI_LOG_ERROR_RECOVERY(1,
Hannes Reineckea222b1e2014-10-24 14:27:02 +02002199 shost_printk(KERN_ERR, shost,
2200 "scsi_eh_%d: unable to autoresume\n",
2201 shost->host_no));
Alan Sternbc4f2402010-06-17 10:41:42 -04002202 continue;
2203 }
2204
Christoph Hellwig9227c332006-04-01 19:21:04 +02002205 if (shost->transportt->eh_strategy_handler)
2206 shost->transportt->eh_strategy_handler(shost);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207 else
2208 scsi_unjam_host(shost);
2209
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210 /*
2211 * Note - if the above fails completely, the action is to take
2212 * individual devices offline and flush the queue of any
2213 * outstanding requests that may have been pending. When we
2214 * restart, we restart any I/O to any other devices on the bus
2215 * which are still online.
2216 */
2217 scsi_restart_operations(shost);
Lin Mingae0751f2011-12-05 09:20:24 +08002218 if (!shost->eh_noresume)
2219 scsi_autopm_put_host(shost);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 }
Steven Rostedt461a0ff2005-10-19 08:22:13 -04002221 __set_current_state(TASK_RUNNING);
2222
Christoph Hellwigad42eb12005-10-29 01:01:55 +02002223 SCSI_LOG_ERROR_RECOVERY(1,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002224 shost_printk(KERN_INFO, shost,
2225 "Error handler scsi_eh_%d exiting\n",
2226 shost->host_no));
James Bottomley3ed7a472005-09-19 09:50:04 -05002227 shost->ehandler = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228 return 0;
2229}
2230
2231/*
2232 * Function: scsi_report_bus_reset()
2233 *
2234 * Purpose: Utility function used by low-level drivers to report that
2235 * they have observed a bus reset on the bus being handled.
2236 *
2237 * Arguments: shost - Host in question
2238 * channel - channel on which reset was observed.
2239 *
2240 * Returns: Nothing
2241 *
2242 * Lock status: Host lock must be held.
2243 *
2244 * Notes: This only needs to be called if the reset is one which
2245 * originates from an unknown location. Resets originated
2246 * by the mid-level itself don't need to call this, but there
2247 * should be no harm.
2248 *
2249 * The main purpose of this is to make sure that a CHECK_CONDITION
2250 * is properly treated.
2251 */
2252void scsi_report_bus_reset(struct Scsi_Host *shost, int channel)
2253{
2254 struct scsi_device *sdev;
2255
2256 __shost_for_each_device(sdev, shost) {
Mike Christie30bd7df2008-02-29 18:25:19 -06002257 if (channel == sdev_channel(sdev))
2258 __scsi_report_device_reset(sdev, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259 }
2260}
2261EXPORT_SYMBOL(scsi_report_bus_reset);
2262
2263/*
2264 * Function: scsi_report_device_reset()
2265 *
2266 * Purpose: Utility function used by low-level drivers to report that
2267 * they have observed a device reset on the device being handled.
2268 *
2269 * Arguments: shost - Host in question
2270 * channel - channel on which reset was observed
2271 * target - target on which reset was observed
2272 *
2273 * Returns: Nothing
2274 *
2275 * Lock status: Host lock must be held
2276 *
2277 * Notes: This only needs to be called if the reset is one which
2278 * originates from an unknown location. Resets originated
2279 * by the mid-level itself don't need to call this, but there
2280 * should be no harm.
2281 *
2282 * The main purpose of this is to make sure that a CHECK_CONDITION
2283 * is properly treated.
2284 */
2285void scsi_report_device_reset(struct Scsi_Host *shost, int channel, int target)
2286{
2287 struct scsi_device *sdev;
2288
2289 __shost_for_each_device(sdev, shost) {
Jeff Garzik422c0d62005-10-24 18:05:09 -04002290 if (channel == sdev_channel(sdev) &&
Mike Christie30bd7df2008-02-29 18:25:19 -06002291 target == sdev_id(sdev))
2292 __scsi_report_device_reset(sdev, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293 }
2294}
2295EXPORT_SYMBOL(scsi_report_device_reset);
2296
2297static void
2298scsi_reset_provider_done_command(struct scsi_cmnd *scmd)
2299{
2300}
2301
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002302/**
2303 * scsi_ioctl_reset: explicitly reset a host/bus/target/device
2304 * @dev: scsi_device to operate on
2305 * @arg: reset type (see sg.h)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 */
2307int
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002308scsi_ioctl_reset(struct scsi_device *dev, int __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309{
Alan Sternbc4f2402010-06-17 10:41:42 -04002310 struct scsi_cmnd *scmd;
James Smartd7a1bb02006-03-08 14:50:12 -05002311 struct Scsi_Host *shost = dev->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312 struct request req;
James Smartd7a1bb02006-03-08 14:50:12 -05002313 unsigned long flags;
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002314 int error = 0, rtn, val;
2315
2316 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
2317 return -EACCES;
2318
2319 error = get_user(val, arg);
2320 if (error)
2321 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322
Alan Sternbc4f2402010-06-17 10:41:42 -04002323 if (scsi_autopm_get_host(shost) < 0)
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002324 return -EIO;
Alan Sternbc4f2402010-06-17 10:41:42 -04002325
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002326 error = -EIO;
Alan Sternbc4f2402010-06-17 10:41:42 -04002327 scmd = scsi_get_command(dev, GFP_KERNEL);
Christoph Hellwig0f121dd2014-09-05 18:00:05 -07002328 if (!scmd)
Christoph Hellwig95eeb5f2014-05-01 16:51:05 +02002329 goto out_put_autopm_host;
Christoph Hellwig95eeb5f2014-05-01 16:51:05 +02002330
FUJITA Tomonori4f54eec2008-04-29 09:54:37 +02002331 blk_rq_init(NULL, &req);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332 scmd->request = &req;
Christoph Hellwigb4edcbc2005-06-19 13:40:52 +02002333
Boaz Harrosh64a87b22008-04-30 11:19:47 +03002334 scmd->cmnd = req.cmd;
2335
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336 scmd->scsi_done = scsi_reset_provider_done_command;
Boaz Harrosh30b0c372007-12-13 13:47:40 +02002337 memset(&scmd->sdb, 0, sizeof(scmd->sdb));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338
2339 scmd->cmd_len = 0;
2340
2341 scmd->sc_data_direction = DMA_BIDIRECTIONAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342
James Smartd7a1bb02006-03-08 14:50:12 -05002343 spin_lock_irqsave(shost->host_lock, flags);
2344 shost->tmf_in_progress = 1;
2345 spin_unlock_irqrestore(shost->host_lock, flags);
2346
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002347 switch (val & ~SG_SCSI_RESET_NO_ESCALATE) {
2348 case SG_SCSI_RESET_NOTHING:
2349 rtn = SUCCESS;
2350 break;
2351 case SG_SCSI_RESET_DEVICE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352 rtn = scsi_try_bus_device_reset(scmd);
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002353 if (rtn == SUCCESS || (val & SG_SCSI_RESET_NO_ESCALATE))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354 break;
2355 /* FALLTHROUGH */
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002356 case SG_SCSI_RESET_TARGET:
Mike Christie30bd7df2008-02-29 18:25:19 -06002357 rtn = scsi_try_target_reset(scmd);
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002358 if (rtn == SUCCESS || (val & SG_SCSI_RESET_NO_ESCALATE))
Mike Christie30bd7df2008-02-29 18:25:19 -06002359 break;
2360 /* FALLTHROUGH */
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002361 case SG_SCSI_RESET_BUS:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362 rtn = scsi_try_bus_reset(scmd);
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002363 if (rtn == SUCCESS || (val & SG_SCSI_RESET_NO_ESCALATE))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364 break;
2365 /* FALLTHROUGH */
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002366 case SG_SCSI_RESET_HOST:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367 rtn = scsi_try_host_reset(scmd);
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002368 if (rtn == SUCCESS)
2369 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370 default:
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002371 /* FALLTHROUGH */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372 rtn = FAILED;
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002373 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374 }
2375
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002376 error = (rtn == SUCCESS) ? 0 : -EIO;
2377
James Smartd7a1bb02006-03-08 14:50:12 -05002378 spin_lock_irqsave(shost->host_lock, flags);
2379 shost->tmf_in_progress = 0;
2380 spin_unlock_irqrestore(shost->host_lock, flags);
2381
2382 /*
2383 * be sure to wake up anyone who was sleeping or had their queue
2384 * suspended while we performed the TMF.
2385 */
2386 SCSI_LOG_ERROR_RECOVERY(3,
Hannes Reinecke91921e02014-06-25 16:39:59 +02002387 shost_printk(KERN_INFO, shost,
2388 "waking up host to restart after TMF\n"));
James Smartd7a1bb02006-03-08 14:50:12 -05002389
2390 wake_up(&shost->host_wait);
James Smartd7a1bb02006-03-08 14:50:12 -05002391 scsi_run_host_queues(shost);
2392
Christoph Hellwig0f121dd2014-09-05 18:00:05 -07002393 scsi_put_command(scmd);
2394
Christoph Hellwig04796332014-02-20 14:20:55 -08002395out_put_autopm_host:
Alan Sternbc4f2402010-06-17 10:41:42 -04002396 scsi_autopm_put_host(shost);
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002397 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398}
Christoph Hellwig176aa9d2014-10-11 12:06:47 +02002399EXPORT_SYMBOL(scsi_ioctl_reset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400
2401/**
2402 * scsi_normalize_sense - normalize main elements from either fixed or
2403 * descriptor sense data format into a common format.
2404 *
2405 * @sense_buffer: byte array containing sense data returned by device
2406 * @sb_len: number of valid bytes in sense_buffer
2407 * @sshdr: pointer to instance of structure that common
2408 * elements are written to.
2409 *
2410 * Notes:
2411 * The "main elements" from sense data are: response_code, sense_key,
2412 * asc, ascq and additional_length (only for descriptor format).
2413 *
2414 * Typically this function can be called after a device has
2415 * responded to a SCSI command with the CHECK_CONDITION status.
2416 *
2417 * Return value:
Hannes Reinecke4753cbc2014-10-24 14:26:52 +02002418 * true if valid sense data information found, else false;
Randy Dunlapdc8875e2007-11-15 15:42:30 -08002419 */
Hannes Reinecke4753cbc2014-10-24 14:26:52 +02002420bool scsi_normalize_sense(const u8 *sense_buffer, int sb_len,
2421 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002422{
James Bottomley33aa6872005-08-28 11:31:14 -05002423 if (!sense_buffer || !sb_len)
Hannes Reinecke4753cbc2014-10-24 14:26:52 +02002424 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425
2426 memset(sshdr, 0, sizeof(struct scsi_sense_hdr));
2427
2428 sshdr->response_code = (sense_buffer[0] & 0x7f);
James Bottomley33aa6872005-08-28 11:31:14 -05002429
2430 if (!scsi_sense_valid(sshdr))
Hannes Reinecke4753cbc2014-10-24 14:26:52 +02002431 return false;
James Bottomley33aa6872005-08-28 11:31:14 -05002432
Linus Torvalds1da177e2005-04-16 15:20:36 -07002433 if (sshdr->response_code >= 0x72) {
2434 /*
2435 * descriptor format
2436 */
2437 if (sb_len > 1)
2438 sshdr->sense_key = (sense_buffer[1] & 0xf);
2439 if (sb_len > 2)
2440 sshdr->asc = sense_buffer[2];
2441 if (sb_len > 3)
2442 sshdr->ascq = sense_buffer[3];
2443 if (sb_len > 7)
2444 sshdr->additional_length = sense_buffer[7];
2445 } else {
Jesper Juhl0bf8c862011-03-21 20:47:31 +01002446 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447 * fixed format
2448 */
2449 if (sb_len > 2)
2450 sshdr->sense_key = (sense_buffer[2] & 0xf);
2451 if (sb_len > 7) {
2452 sb_len = (sb_len < (sense_buffer[7] + 8)) ?
2453 sb_len : (sense_buffer[7] + 8);
2454 if (sb_len > 12)
2455 sshdr->asc = sense_buffer[12];
2456 if (sb_len > 13)
2457 sshdr->ascq = sense_buffer[13];
2458 }
2459 }
2460
Hannes Reinecke4753cbc2014-10-24 14:26:52 +02002461 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462}
2463EXPORT_SYMBOL(scsi_normalize_sense);
2464
Hannes Reinecke4753cbc2014-10-24 14:26:52 +02002465bool scsi_command_normalize_sense(const struct scsi_cmnd *cmd,
2466 struct scsi_sense_hdr *sshdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467{
2468 return scsi_normalize_sense(cmd->sense_buffer,
FUJITA Tomonorib80ca4f2008-01-13 15:46:13 +09002469 SCSI_SENSE_BUFFERSIZE, sshdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470}
2471EXPORT_SYMBOL(scsi_command_normalize_sense);
2472
2473/**
Rob Landleyeb448202007-11-03 13:30:39 -05002474 * scsi_sense_desc_find - search for a given descriptor type in descriptor sense data format.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002475 * @sense_buffer: byte array of descriptor format sense data
2476 * @sb_len: number of valid bytes in sense_buffer
2477 * @desc_type: value of descriptor type to find
2478 * (e.g. 0 -> information)
2479 *
2480 * Notes:
2481 * only valid when sense data is in descriptor format
2482 *
2483 * Return value:
2484 * pointer to start of (first) descriptor if found else NULL
Randy Dunlapdc8875e2007-11-15 15:42:30 -08002485 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486const u8 * scsi_sense_desc_find(const u8 * sense_buffer, int sb_len,
2487 int desc_type)
2488{
2489 int add_sen_len, add_len, desc_len, k;
2490 const u8 * descp;
2491
2492 if ((sb_len < 8) || (0 == (add_sen_len = sense_buffer[7])))
2493 return NULL;
2494 if ((sense_buffer[0] < 0x72) || (sense_buffer[0] > 0x73))
2495 return NULL;
2496 add_sen_len = (add_sen_len < (sb_len - 8)) ?
2497 add_sen_len : (sb_len - 8);
2498 descp = &sense_buffer[8];
2499 for (desc_len = 0, k = 0; k < add_sen_len; k += desc_len) {
2500 descp += desc_len;
2501 add_len = (k < (add_sen_len - 1)) ? descp[1]: -1;
2502 desc_len = add_len + 2;
2503 if (descp[0] == desc_type)
2504 return descp;
2505 if (add_len < 0) // short descriptor ??
2506 break;
2507 }
2508 return NULL;
2509}
2510EXPORT_SYMBOL(scsi_sense_desc_find);
2511
2512/**
Rob Landleyeb448202007-11-03 13:30:39 -05002513 * scsi_get_sense_info_fld - get information field from sense data (either fixed or descriptor format)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514 * @sense_buffer: byte array of sense data
2515 * @sb_len: number of valid bytes in sense_buffer
2516 * @info_out: pointer to 64 integer where 8 or 4 byte information
2517 * field will be placed if found.
2518 *
2519 * Return value:
2520 * 1 if information field found, 0 if not found.
Randy Dunlapdc8875e2007-11-15 15:42:30 -08002521 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522int scsi_get_sense_info_fld(const u8 * sense_buffer, int sb_len,
2523 u64 * info_out)
2524{
2525 int j;
2526 const u8 * ucp;
2527 u64 ull;
2528
2529 if (sb_len < 7)
2530 return 0;
2531 switch (sense_buffer[0] & 0x7f) {
2532 case 0x70:
2533 case 0x71:
2534 if (sense_buffer[0] & 0x80) {
2535 *info_out = (sense_buffer[3] << 24) +
2536 (sense_buffer[4] << 16) +
2537 (sense_buffer[5] << 8) + sense_buffer[6];
2538 return 1;
2539 } else
2540 return 0;
2541 case 0x72:
2542 case 0x73:
2543 ucp = scsi_sense_desc_find(sense_buffer, sb_len,
2544 0 /* info desc */);
2545 if (ucp && (0xa == ucp[1])) {
2546 ull = 0;
2547 for (j = 0; j < 8; ++j) {
2548 if (j > 0)
2549 ull <<= 8;
2550 ull |= ucp[4 + j];
2551 }
2552 *info_out = ull;
2553 return 1;
2554 } else
2555 return 0;
2556 default:
2557 return 0;
2558 }
2559}
2560EXPORT_SYMBOL(scsi_get_sense_info_fld);
FUJITA Tomonori3bc6a262008-03-25 09:26:49 +09002561
2562/**
2563 * scsi_build_sense_buffer - build sense data in a buffer
2564 * @desc: Sense format (non zero == descriptor format,
2565 * 0 == fixed format)
2566 * @buf: Where to build sense data
2567 * @key: Sense key
2568 * @asc: Additional sense code
2569 * @ascq: Additional sense code qualifier
2570 *
2571 **/
2572void scsi_build_sense_buffer(int desc, u8 *buf, u8 key, u8 asc, u8 ascq)
2573{
2574 if (desc) {
2575 buf[0] = 0x72; /* descriptor, current */
2576 buf[1] = key;
2577 buf[2] = asc;
2578 buf[3] = ascq;
2579 buf[7] = 0;
2580 } else {
2581 buf[0] = 0x70; /* fixed, current */
2582 buf[2] = key;
2583 buf[7] = 0xa;
2584 buf[12] = asc;
2585 buf[13] = ascq;
2586 }
2587}
2588EXPORT_SYMBOL(scsi_build_sense_buffer);