blob: f100cbb7d2e19303bf025108e22eaac39b13dd32 [file] [log] [blame]
Hannes Reinecke057ea7c2008-07-17 16:53:21 -07001/*
2 * Generic SCSI-3 ALUA SCSI Device Handler
3 *
Hannes Reinecke69723d12010-09-24 15:57:04 +02004 * Copyright (C) 2007-2010 Hannes Reinecke, SUSE Linux Products GmbH.
Hannes Reinecke057ea7c2008-07-17 16:53:21 -07005 * All rights reserved.
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 *
21 */
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090022#include <linux/slab.h>
Hannes Reinecke69723d12010-09-24 15:57:04 +020023#include <linux/delay.h>
Paul Gortmakeracf3368f2011-05-27 09:47:43 -040024#include <linux/module.h>
Hannes Reineckea7089772015-12-01 10:16:52 +010025#include <asm/unaligned.h>
Hannes Reinecke057ea7c2008-07-17 16:53:21 -070026#include <scsi/scsi.h>
Hannes Reinecke80bd68d2015-12-01 10:16:47 +010027#include <scsi/scsi_dbg.h>
Hannes Reinecke057ea7c2008-07-17 16:53:21 -070028#include <scsi/scsi_eh.h>
29#include <scsi/scsi_dh.h>
30
31#define ALUA_DH_NAME "alua"
Hannes Reinecke69723d12010-09-24 15:57:04 +020032#define ALUA_DH_VER "1.3"
Hannes Reinecke057ea7c2008-07-17 16:53:21 -070033
34#define TPGS_STATE_OPTIMIZED 0x0
35#define TPGS_STATE_NONOPTIMIZED 0x1
36#define TPGS_STATE_STANDBY 0x2
37#define TPGS_STATE_UNAVAILABLE 0x3
Hannes Reinecke69723d12010-09-24 15:57:04 +020038#define TPGS_STATE_LBA_DEPENDENT 0x4
Hannes Reinecke057ea7c2008-07-17 16:53:21 -070039#define TPGS_STATE_OFFLINE 0xe
40#define TPGS_STATE_TRANSITIONING 0xf
41
42#define TPGS_SUPPORT_NONE 0x00
43#define TPGS_SUPPORT_OPTIMIZED 0x01
44#define TPGS_SUPPORT_NONOPTIMIZED 0x02
45#define TPGS_SUPPORT_STANDBY 0x04
46#define TPGS_SUPPORT_UNAVAILABLE 0x08
Hannes Reinecke69723d12010-09-24 15:57:04 +020047#define TPGS_SUPPORT_LBA_DEPENDENT 0x10
Hannes Reinecke057ea7c2008-07-17 16:53:21 -070048#define TPGS_SUPPORT_OFFLINE 0x40
49#define TPGS_SUPPORT_TRANSITION 0x80
50
Rob Evers3588c5a2012-05-18 14:08:54 -040051#define RTPG_FMT_MASK 0x70
52#define RTPG_FMT_EXT_HDR 0x10
53
Hannes Reinecke057ea7c2008-07-17 16:53:21 -070054#define TPGS_MODE_UNINITIALIZED -1
55#define TPGS_MODE_NONE 0x0
56#define TPGS_MODE_IMPLICIT 0x1
57#define TPGS_MODE_EXPLICIT 0x2
58
59#define ALUA_INQUIRY_SIZE 36
Rob Evers3588c5a2012-05-18 14:08:54 -040060#define ALUA_FAILOVER_TIMEOUT 60
Hannes Reinecke057ea7c2008-07-17 16:53:21 -070061#define ALUA_FAILOVER_RETRIES 5
62
Hannes Reinecke6c4fc042015-12-01 10:16:51 +010063/* device handler flags */
Moger, Babu4335d092012-03-27 20:55:49 +000064#define ALUA_OPTIMIZE_STPG 1
Hannes Reinecke6c4fc042015-12-01 10:16:51 +010065#define ALUA_RTPG_EXT_HDR_UNSUPP 2
Moger, Babu4335d092012-03-27 20:55:49 +000066
Hannes Reinecke057ea7c2008-07-17 16:53:21 -070067struct alua_dh_data {
68 int group_id;
69 int rel_port;
70 int tpgs;
71 int state;
Moger, Babudcd3a752012-03-27 20:56:08 +000072 int pref;
Moger, Babu4335d092012-03-27 20:55:49 +000073 unsigned flags; /* used for optimizing STPG */
Hannes Reinecke057ea7c2008-07-17 16:53:21 -070074 unsigned char inq[ALUA_INQUIRY_SIZE];
75 unsigned char *buff;
76 int bufflen;
Rob Evers3588c5a2012-05-18 14:08:54 -040077 unsigned char transition_tmo;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -070078 unsigned char sense[SCSI_SENSE_BUFFERSIZE];
Chandra Seetharaman96e65862009-10-21 09:23:04 -070079 struct scsi_device *sdev;
80 activate_complete callback_fn;
81 void *callback_data;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -070082};
83
84#define ALUA_POLICY_SWITCH_CURRENT 0
85#define ALUA_POLICY_SWITCH_ALL 1
86
Chandra Seetharaman96e65862009-10-21 09:23:04 -070087static char print_alua_state(int);
Chandra Seetharaman96e65862009-10-21 09:23:04 -070088
Hannes Reinecke057ea7c2008-07-17 16:53:21 -070089static int realloc_buffer(struct alua_dh_data *h, unsigned len)
90{
91 if (h->buff && h->buff != h->inq)
92 kfree(h->buff);
93
94 h->buff = kmalloc(len, GFP_NOIO);
95 if (!h->buff) {
96 h->buff = h->inq;
97 h->bufflen = ALUA_INQUIRY_SIZE;
98 return 1;
99 }
100 h->bufflen = len;
101 return 0;
102}
103
104static struct request *get_alua_req(struct scsi_device *sdev,
105 void *buffer, unsigned buflen, int rw)
106{
107 struct request *rq;
108 struct request_queue *q = sdev->request_queue;
109
110 rq = blk_get_request(q, rw, GFP_NOIO);
111
Joe Lawrencea492f072014-08-28 08:15:21 -0600112 if (IS_ERR(rq)) {
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700113 sdev_printk(KERN_INFO, sdev,
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -0700114 "%s: blk_get_request failed\n", __func__);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700115 return NULL;
116 }
Jens Axboef27b0872014-06-06 07:57:37 -0600117 blk_rq_set_block_pc(rq);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700118
119 if (buflen && blk_rq_map_kern(q, rq, buffer, buflen, GFP_NOIO)) {
120 blk_put_request(rq);
121 sdev_printk(KERN_INFO, sdev,
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -0700122 "%s: blk_rq_map_kern failed\n", __func__);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700123 return NULL;
124 }
125
Mike Christie6000a362008-08-19 18:45:30 -0500126 rq->cmd_flags |= REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT |
Mike Christie64f84bc2008-09-06 08:39:16 -0500127 REQ_FAILFAST_DRIVER;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700128 rq->retries = ALUA_FAILOVER_RETRIES;
Rob Evers3588c5a2012-05-18 14:08:54 -0400129 rq->timeout = ALUA_FAILOVER_TIMEOUT * HZ;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700130
131 return rq;
132}
133
134/*
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700135 * submit_rtpg - Issue a REPORT TARGET GROUP STATES command
136 * @sdev: sdev the command should be sent to
137 */
Hannes Reinecke6c4fc042015-12-01 10:16:51 +0100138static unsigned submit_rtpg(struct scsi_device *sdev, struct alua_dh_data *h)
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700139{
140 struct request *rq;
Hannes Reinecke5597caf2015-12-01 10:16:48 +0100141 int err = 0;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700142
143 rq = get_alua_req(sdev, h->buff, h->bufflen, READ);
Hannes Reinecke5597caf2015-12-01 10:16:48 +0100144 if (!rq) {
145 err = DRIVER_BUSY << 24;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700146 goto done;
Hannes Reinecke5597caf2015-12-01 10:16:48 +0100147 }
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700148
149 /* Prepare the command. */
150 rq->cmd[0] = MAINTENANCE_IN;
Hannes Reinecke6c4fc042015-12-01 10:16:51 +0100151 if (!(h->flags & ALUA_RTPG_EXT_HDR_UNSUPP))
Rob Evers8e67ce62012-05-18 14:08:55 -0400152 rq->cmd[1] = MI_REPORT_TARGET_PGS | MI_EXT_HDR_PARAM_FMT;
153 else
154 rq->cmd[1] = MI_REPORT_TARGET_PGS;
Hannes Reineckea7089772015-12-01 10:16:52 +0100155 put_unaligned_be32(h->bufflen, &rq->cmd[6]);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700156 rq->cmd_len = COMMAND_SIZE(MAINTENANCE_IN);
157
158 rq->sense = h->sense;
159 memset(rq->sense, 0, SCSI_SENSE_BUFFERSIZE);
Hannes Reinecked3692a32015-12-01 10:16:46 +0100160 rq->sense_len = 0;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700161
Hannes Reinecke5597caf2015-12-01 10:16:48 +0100162 blk_execute_rq(rq->q, NULL, rq, 1);
163 if (rq->errors)
164 err = rq->errors;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700165 blk_put_request(rq);
166done:
167 return err;
168}
169
170/*
Hannes Reineckedac173e2015-12-01 10:16:49 +0100171 * stpg_endio - Evaluate SET TARGET GROUP STATES
Chandra Seetharaman96e65862009-10-21 09:23:04 -0700172 * @sdev: the device to be evaluated
173 * @state: the new target group state
174 *
Hannes Reineckedac173e2015-12-01 10:16:49 +0100175 * Evaluate a SET TARGET GROUP STATES command response.
Chandra Seetharaman96e65862009-10-21 09:23:04 -0700176 */
177static void stpg_endio(struct request *req, int error)
178{
179 struct alua_dh_data *h = req->end_io_data;
180 struct scsi_sense_hdr sense_hdr;
Joseph Gruher93499232011-01-05 16:00:22 -0500181 unsigned err = SCSI_DH_OK;
Chandra Seetharaman96e65862009-10-21 09:23:04 -0700182
Mike Christie27db6822013-03-05 22:40:24 -0600183 if (host_byte(req->errors) != DID_OK ||
184 msg_byte(req->errors) != COMMAND_COMPLETE) {
Joseph Gruher93499232011-01-05 16:00:22 -0500185 err = SCSI_DH_IO;
Chandra Seetharaman96e65862009-10-21 09:23:04 -0700186 goto done;
Joseph Gruher93499232011-01-05 16:00:22 -0500187 }
Chandra Seetharaman96e65862009-10-21 09:23:04 -0700188
Hannes Reinecked3692a32015-12-01 10:16:46 +0100189 if (scsi_normalize_sense(h->sense, SCSI_SENSE_BUFFERSIZE,
190 &sense_hdr)) {
Hannes Reineckee2d817d2015-12-01 10:16:54 +0100191 if (sense_hdr.sense_key == NOT_READY &&
192 sense_hdr.asc == 0x04 && sense_hdr.ascq == 0x0a) {
193 /* ALUA state transition already in progress */
194 err = SCSI_DH_OK;
195 goto done;
196 }
197 if (sense_hdr.sense_key == UNIT_ATTENTION) {
Chandra Seetharaman96e65862009-10-21 09:23:04 -0700198 err = SCSI_DH_RETRY;
199 goto done;
200 }
Hannes Reinecke80bd68d2015-12-01 10:16:47 +0100201 sdev_printk(KERN_INFO, h->sdev, "%s: stpg failed\n",
202 ALUA_DH_NAME);
203 scsi_print_sense_hdr(h->sdev, ALUA_DH_NAME, &sense_hdr);
Chandra Seetharaman96e65862009-10-21 09:23:04 -0700204 err = SCSI_DH_IO;
Mike Christie27db6822013-03-05 22:40:24 -0600205 } else if (error)
206 err = SCSI_DH_IO;
207
Chandra Seetharaman96e65862009-10-21 09:23:04 -0700208 if (err == SCSI_DH_OK) {
209 h->state = TPGS_STATE_OPTIMIZED;
210 sdev_printk(KERN_INFO, h->sdev,
211 "%s: port group %02x switched to state %c\n",
212 ALUA_DH_NAME, h->group_id,
213 print_alua_state(h->state));
214 }
215done:
Joseph Gruhered0f36b2011-01-05 16:00:21 -0500216 req->end_io_data = NULL;
217 __blk_put_request(req->q, req);
Chandra Seetharaman96e65862009-10-21 09:23:04 -0700218 if (h->callback_fn) {
219 h->callback_fn(h->callback_data, err);
220 h->callback_fn = h->callback_data = NULL;
221 }
222 return;
223}
224
225/*
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700226 * submit_stpg - Issue a SET TARGET GROUP STATES command
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700227 *
228 * Currently we're only setting the current target port group state
229 * to 'active/optimized' and let the array firmware figure out
230 * the states of the remaining groups.
231 */
Chandra Seetharaman96e65862009-10-21 09:23:04 -0700232static unsigned submit_stpg(struct alua_dh_data *h)
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700233{
234 struct request *rq;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700235 int stpg_len = 8;
Chandra Seetharaman96e65862009-10-21 09:23:04 -0700236 struct scsi_device *sdev = h->sdev;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700237
238 /* Prepare the data buffer */
239 memset(h->buff, 0, stpg_len);
240 h->buff[4] = TPGS_STATE_OPTIMIZED & 0x0f;
Hannes Reineckea7089772015-12-01 10:16:52 +0100241 put_unaligned_be16(h->group_id, &h->buff[6]);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700242
243 rq = get_alua_req(sdev, h->buff, stpg_len, WRITE);
244 if (!rq)
Chandra Seetharaman96e65862009-10-21 09:23:04 -0700245 return SCSI_DH_RES_TEMP_UNAVAIL;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700246
247 /* Prepare the command. */
248 rq->cmd[0] = MAINTENANCE_OUT;
249 rq->cmd[1] = MO_SET_TARGET_PGS;
Hannes Reineckea7089772015-12-01 10:16:52 +0100250 put_unaligned_be32(stpg_len, &rq->cmd[6]);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700251 rq->cmd_len = COMMAND_SIZE(MAINTENANCE_OUT);
252
253 rq->sense = h->sense;
254 memset(rq->sense, 0, SCSI_SENSE_BUFFERSIZE);
Hannes Reinecked3692a32015-12-01 10:16:46 +0100255 rq->sense_len = 0;
Chandra Seetharaman96e65862009-10-21 09:23:04 -0700256 rq->end_io_data = h;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700257
Chandra Seetharaman96e65862009-10-21 09:23:04 -0700258 blk_execute_rq_nowait(rq->q, NULL, rq, 1, stpg_endio);
Joseph Gruher7c66e9a2011-01-05 16:00:20 -0500259 return SCSI_DH_OK;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700260}
261
262/*
Hannes Reinecked7c48fe2011-08-24 10:51:13 +0200263 * alua_check_tpgs - Evaluate TPGS setting
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700264 * @sdev: device to be checked
265 *
Hannes Reinecked7c48fe2011-08-24 10:51:13 +0200266 * Examine the TPGS setting of the sdev to find out if ALUA
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700267 * is supported.
268 */
Hannes Reineckead0ea642015-12-01 10:16:53 +0100269static int alua_check_tpgs(struct scsi_device *sdev)
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700270{
Hannes Reineckead0ea642015-12-01 10:16:53 +0100271 int tpgs = TPGS_MODE_NONE;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700272
Hannes Reineckedb5a6a62015-12-01 10:16:43 +0100273 /*
274 * ALUA support for non-disk devices is fraught with
275 * difficulties, so disable it for now.
276 */
277 if (sdev->type != TYPE_DISK) {
Hannes Reineckedb5a6a62015-12-01 10:16:43 +0100278 sdev_printk(KERN_INFO, sdev,
279 "%s: disable for non-disk devices\n",
280 ALUA_DH_NAME);
Hannes Reineckead0ea642015-12-01 10:16:53 +0100281 return tpgs;
Hannes Reineckedb5a6a62015-12-01 10:16:43 +0100282 }
283
Hannes Reineckead0ea642015-12-01 10:16:53 +0100284 tpgs = scsi_device_tpgs(sdev);
285 switch (tpgs) {
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700286 case TPGS_MODE_EXPLICIT|TPGS_MODE_IMPLICIT:
287 sdev_printk(KERN_INFO, sdev,
288 "%s: supports implicit and explicit TPGS\n",
289 ALUA_DH_NAME);
290 break;
291 case TPGS_MODE_EXPLICIT:
292 sdev_printk(KERN_INFO, sdev, "%s: supports explicit TPGS\n",
293 ALUA_DH_NAME);
294 break;
295 case TPGS_MODE_IMPLICIT:
296 sdev_printk(KERN_INFO, sdev, "%s: supports implicit TPGS\n",
297 ALUA_DH_NAME);
298 break;
Hannes Reinecke6cc05d42015-12-01 10:16:45 +0100299 case TPGS_MODE_NONE:
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700300 sdev_printk(KERN_INFO, sdev, "%s: not supported\n",
301 ALUA_DH_NAME);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700302 break;
Hannes Reinecke6cc05d42015-12-01 10:16:45 +0100303 default:
304 sdev_printk(KERN_INFO, sdev,
305 "%s: unsupported TPGS setting %d\n",
Hannes Reineckead0ea642015-12-01 10:16:53 +0100306 ALUA_DH_NAME, tpgs);
307 tpgs = TPGS_MODE_NONE;
Hannes Reinecke6cc05d42015-12-01 10:16:45 +0100308 break;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700309 }
310
Hannes Reineckead0ea642015-12-01 10:16:53 +0100311 return tpgs;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700312}
313
314/*
Hannes Reinecke9b80dce2015-12-01 10:16:44 +0100315 * alua_check_vpd - Evaluate INQUIRY vpd page 0x83
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700316 * @sdev: device to be checked
317 *
318 * Extract the relative target port and the target port group
319 * descriptor from the list of identificators.
320 */
Hannes Reinecke9b80dce2015-12-01 10:16:44 +0100321static int alua_check_vpd(struct scsi_device *sdev, struct alua_dh_data *h)
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700322{
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700323 unsigned char *d;
Hannes Reinecke9b80dce2015-12-01 10:16:44 +0100324 unsigned char __rcu *vpd_pg83;
Hannes Reinecke83ea0e52015-12-01 10:16:58 +0100325 int rel_port = -1, group_id;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700326
Hannes Reinecke83ea0e52015-12-01 10:16:58 +0100327 group_id = scsi_vpd_tpg_id(sdev, &rel_port);
328 if (group_id < 0) {
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700329 /*
330 * Internal error; TPGS supported but required
331 * VPD identification descriptors not present.
332 * Disable ALUA support
333 */
334 sdev_printk(KERN_INFO, sdev,
335 "%s: No target port descriptors found\n",
336 ALUA_DH_NAME);
Hannes Reinecke9b80dce2015-12-01 10:16:44 +0100337 return SCSI_DH_DEV_UNSUPP;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700338 }
Hannes Reinecke83ea0e52015-12-01 10:16:58 +0100339 h->state = TPGS_STATE_OPTIMIZED;
340 h->group_id = group_id;
341
Hannes Reinecke9b80dce2015-12-01 10:16:44 +0100342 sdev_printk(KERN_INFO, sdev,
343 "%s: port group %02x rel port %02x\n",
344 ALUA_DH_NAME, h->group_id, h->rel_port);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700345
Hannes Reinecke9b80dce2015-12-01 10:16:44 +0100346 return 0;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700347}
348
349static char print_alua_state(int state)
350{
351 switch (state) {
352 case TPGS_STATE_OPTIMIZED:
353 return 'A';
354 case TPGS_STATE_NONOPTIMIZED:
355 return 'N';
356 case TPGS_STATE_STANDBY:
357 return 'S';
358 case TPGS_STATE_UNAVAILABLE:
359 return 'U';
Hannes Reinecke69723d12010-09-24 15:57:04 +0200360 case TPGS_STATE_LBA_DEPENDENT:
361 return 'L';
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700362 case TPGS_STATE_OFFLINE:
363 return 'O';
364 case TPGS_STATE_TRANSITIONING:
365 return 'T';
366 default:
367 return 'X';
368 }
369}
370
371static int alua_check_sense(struct scsi_device *sdev,
372 struct scsi_sense_hdr *sense_hdr)
373{
374 switch (sense_hdr->sense_key) {
375 case NOT_READY:
376 if (sense_hdr->asc == 0x04 && sense_hdr->ascq == 0x0a)
377 /*
378 * LUN Not Accessible - ALUA state transition
379 */
Mike Andersonc7dbb622008-08-12 12:11:57 -0700380 return ADD_TO_MLQUEUE;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700381 break;
382 case UNIT_ATTENTION:
383 if (sense_hdr->asc == 0x29 && sense_hdr->ascq == 0x00)
384 /*
385 * Power On, Reset, or Bus Device Reset, just retry.
386 */
Mike Andersonc7dbb622008-08-12 12:11:57 -0700387 return ADD_TO_MLQUEUE;
Stewart, Seanc20ee7b2013-10-15 15:52:39 +0000388 if (sense_hdr->asc == 0x29 && sense_hdr->ascq == 0x04)
389 /*
390 * Device internal reset
391 */
392 return ADD_TO_MLQUEUE;
Moger, Babu410f02d2011-12-21 18:01:37 -0500393 if (sense_hdr->asc == 0x2a && sense_hdr->ascq == 0x01)
394 /*
395 * Mode Parameters Changed
396 */
397 return ADD_TO_MLQUEUE;
Moger, Babubf819732011-10-06 13:22:07 -0400398 if (sense_hdr->asc == 0x2a && sense_hdr->ascq == 0x06)
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700399 /*
400 * ALUA state changed
401 */
Mike Andersonc7dbb622008-08-12 12:11:57 -0700402 return ADD_TO_MLQUEUE;
Moger, Babubf819732011-10-06 13:22:07 -0400403 if (sense_hdr->asc == 0x2a && sense_hdr->ascq == 0x07)
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700404 /*
405 * Implicit ALUA state transition failed
406 */
Mike Andersonc7dbb622008-08-12 12:11:57 -0700407 return ADD_TO_MLQUEUE;
Moger, Babubf819732011-10-06 13:22:07 -0400408 if (sense_hdr->asc == 0x3f && sense_hdr->ascq == 0x03)
409 /*
410 * Inquiry data has changed
411 */
412 return ADD_TO_MLQUEUE;
413 if (sense_hdr->asc == 0x3f && sense_hdr->ascq == 0x0e)
Ilgu Hong4d086f62009-01-30 17:00:11 -0600414 /*
415 * REPORTED_LUNS_DATA_HAS_CHANGED is reported
416 * when switching controllers on targets like
417 * Intel Multi-Flex. We can just retry.
418 */
419 return ADD_TO_MLQUEUE;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700420 break;
421 }
422
423 return SCSI_RETURN_NOT_HANDLED;
424}
425
426/*
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700427 * alua_rtpg - Evaluate REPORT TARGET GROUP STATES
428 * @sdev: the device to be evaluated.
Stewart, Seana8e5a2d2013-10-15 15:52:54 +0000429 * @wait_for_transition: if nonzero, wait ALUA_FAILOVER_TIMEOUT seconds for device to exit transitioning state
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700430 *
431 * Evaluate the Target Port Group State.
432 * Returns SCSI_DH_DEV_OFFLINED if the path is
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300433 * found to be unusable.
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700434 */
Stewart, Seana8e5a2d2013-10-15 15:52:54 +0000435static int alua_rtpg(struct scsi_device *sdev, struct alua_dh_data *h, int wait_for_transition)
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700436{
437 struct scsi_sense_hdr sense_hdr;
438 int len, k, off, valid_states = 0;
Hannes Reineckecfde3fa2011-08-24 10:51:18 +0200439 unsigned char *ucp;
Hannes Reinecke5597caf2015-12-01 10:16:48 +0100440 unsigned err, retval;
Rob Eversbc97f4b2012-05-18 14:08:56 -0400441 unsigned long expiry, interval = 0;
Rob Evers3588c5a2012-05-18 14:08:54 -0400442 unsigned int tpg_desc_tbl_off;
443 unsigned char orig_transition_tmo;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700444
Rob Evers3588c5a2012-05-18 14:08:54 -0400445 if (!h->transition_tmo)
446 expiry = round_jiffies_up(jiffies + ALUA_FAILOVER_TIMEOUT * HZ);
447 else
448 expiry = round_jiffies_up(jiffies + h->transition_tmo * HZ);
449
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700450 retry:
Hannes Reinecke6c4fc042015-12-01 10:16:51 +0100451 retval = submit_rtpg(sdev, h);
Hannes Reinecke5597caf2015-12-01 10:16:48 +0100452 if (retval) {
Hannes Reinecked3692a32015-12-01 10:16:46 +0100453 if (!scsi_normalize_sense(h->sense, SCSI_SENSE_BUFFERSIZE,
Hannes Reinecke5597caf2015-12-01 10:16:48 +0100454 &sense_hdr)) {
455 sdev_printk(KERN_INFO, sdev,
456 "%s: rtpg failed, result %d\n",
457 ALUA_DH_NAME, retval);
458 if (driver_byte(retval) == DRIVER_BUSY)
459 return SCSI_DH_DEV_TEMP_BUSY;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700460 return SCSI_DH_IO;
Hannes Reinecke5597caf2015-12-01 10:16:48 +0100461 }
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700462
Rob Evers8e67ce62012-05-18 14:08:55 -0400463 /*
464 * submit_rtpg() has failed on existing arrays
465 * when requesting extended header info, and
466 * the array doesn't support extended headers,
467 * even though it shouldn't according to T10.
468 * The retry without rtpg_ext_hdr_req set
469 * handles this.
470 */
Hannes Reinecke6c4fc042015-12-01 10:16:51 +0100471 if (!(h->flags & ALUA_RTPG_EXT_HDR_UNSUPP) &&
Rob Evers8e67ce62012-05-18 14:08:55 -0400472 sense_hdr.sense_key == ILLEGAL_REQUEST &&
473 sense_hdr.asc == 0x24 && sense_hdr.ascq == 0) {
Hannes Reinecke6c4fc042015-12-01 10:16:51 +0100474 h->flags |= ALUA_RTPG_EXT_HDR_UNSUPP;
Rob Evers8e67ce62012-05-18 14:08:55 -0400475 goto retry;
476 }
Hannes Reineckee2d817d2015-12-01 10:16:54 +0100477 /*
478 * Retry on ALUA state transition or if any
479 * UNIT ATTENTION occurred.
480 */
481 if (sense_hdr.sense_key == NOT_READY &&
482 sense_hdr.asc == 0x04 && sense_hdr.ascq == 0x0a)
483 err = SCSI_DH_RETRY;
484 else if (sense_hdr.sense_key == UNIT_ATTENTION)
485 err = SCSI_DH_RETRY;
486 if (err == SCSI_DH_RETRY && time_before(jiffies, expiry)) {
Hannes Reinecke80bd68d2015-12-01 10:16:47 +0100487 sdev_printk(KERN_ERR, sdev, "%s: rtpg retry\n",
488 ALUA_DH_NAME);
489 scsi_print_sense_hdr(sdev, ALUA_DH_NAME, &sense_hdr);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700490 goto retry;
Hannes Reinecke80bd68d2015-12-01 10:16:47 +0100491 }
492 sdev_printk(KERN_ERR, sdev, "%s: rtpg failed\n",
493 ALUA_DH_NAME);
494 scsi_print_sense_hdr(sdev, ALUA_DH_NAME, &sense_hdr);
495 return SCSI_DH_IO;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700496 }
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700497
Hannes Reineckea7089772015-12-01 10:16:52 +0100498 len = get_unaligned_be32(&h->buff[0]) + 4;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700499
500 if (len > h->bufflen) {
501 /* Resubmit with the correct length */
502 if (realloc_buffer(h, len)) {
503 sdev_printk(KERN_WARNING, sdev,
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -0700504 "%s: kmalloc buffer failed\n",__func__);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700505 /* Temporary failure, bypass */
506 return SCSI_DH_DEV_TEMP_BUSY;
507 }
508 goto retry;
509 }
510
Rob Evers3588c5a2012-05-18 14:08:54 -0400511 orig_transition_tmo = h->transition_tmo;
512 if ((h->buff[4] & RTPG_FMT_MASK) == RTPG_FMT_EXT_HDR && h->buff[5] != 0)
513 h->transition_tmo = h->buff[5];
514 else
515 h->transition_tmo = ALUA_FAILOVER_TIMEOUT;
516
Stewart, Seana8e5a2d2013-10-15 15:52:54 +0000517 if (wait_for_transition && (orig_transition_tmo != h->transition_tmo)) {
Rob Evers3588c5a2012-05-18 14:08:54 -0400518 sdev_printk(KERN_INFO, sdev,
519 "%s: transition timeout set to %d seconds\n",
520 ALUA_DH_NAME, h->transition_tmo);
521 expiry = jiffies + h->transition_tmo * HZ;
522 }
523
524 if ((h->buff[4] & RTPG_FMT_MASK) == RTPG_FMT_EXT_HDR)
525 tpg_desc_tbl_off = 8;
526 else
527 tpg_desc_tbl_off = 4;
528
529 for (k = tpg_desc_tbl_off, ucp = h->buff + tpg_desc_tbl_off;
530 k < len;
531 k += off, ucp += off) {
532
Hannes Reineckea7089772015-12-01 10:16:52 +0100533 if (h->group_id == get_unaligned_be16(&ucp[2])) {
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700534 h->state = ucp[0] & 0x0f;
Moger, Babudcd3a752012-03-27 20:56:08 +0000535 h->pref = ucp[0] >> 7;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700536 valid_states = ucp[1];
537 }
538 off = 8 + (ucp[7] * 4);
539 }
540
541 sdev_printk(KERN_INFO, sdev,
Moger, Babudcd3a752012-03-27 20:56:08 +0000542 "%s: port group %02x state %c %s supports %c%c%c%c%c%c%c\n",
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700543 ALUA_DH_NAME, h->group_id, print_alua_state(h->state),
Moger, Babudcd3a752012-03-27 20:56:08 +0000544 h->pref ? "preferred" : "non-preferred",
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700545 valid_states&TPGS_SUPPORT_TRANSITION?'T':'t',
546 valid_states&TPGS_SUPPORT_OFFLINE?'O':'o',
Hannes Reinecke69723d12010-09-24 15:57:04 +0200547 valid_states&TPGS_SUPPORT_LBA_DEPENDENT?'L':'l',
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700548 valid_states&TPGS_SUPPORT_UNAVAILABLE?'U':'u',
549 valid_states&TPGS_SUPPORT_STANDBY?'S':'s',
550 valid_states&TPGS_SUPPORT_NONOPTIMIZED?'N':'n',
551 valid_states&TPGS_SUPPORT_OPTIMIZED?'A':'a');
552
Hannes Reinecke69723d12010-09-24 15:57:04 +0200553 switch (h->state) {
554 case TPGS_STATE_TRANSITIONING:
Stewart, Seana8e5a2d2013-10-15 15:52:54 +0000555 if (wait_for_transition) {
556 if (time_before(jiffies, expiry)) {
557 /* State transition, retry */
558 interval += 2000;
559 msleep(interval);
560 goto retry;
561 }
562 err = SCSI_DH_RETRY;
563 } else {
564 err = SCSI_DH_OK;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700565 }
Stewart, Seana8e5a2d2013-10-15 15:52:54 +0000566
Hannes Reinecke69723d12010-09-24 15:57:04 +0200567 /* Transitioning time exceeded, set port to standby */
Hannes Reinecke69723d12010-09-24 15:57:04 +0200568 h->state = TPGS_STATE_STANDBY;
569 break;
570 case TPGS_STATE_OFFLINE:
Bart Van Asschee47f8972012-08-24 09:08:41 +0000571 /* Path unusable */
Hannes Reinecke69723d12010-09-24 15:57:04 +0200572 err = SCSI_DH_DEV_OFFLINED;
573 break;
574 default:
575 /* Useable path if active */
576 err = SCSI_DH_OK;
577 break;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700578 }
579 return err;
580}
581
582/*
583 * alua_initialize - Initialize ALUA state
584 * @sdev: the device to be initialized
585 *
586 * For the prep_fn to work correctly we have
587 * to initialize the ALUA state for the device.
588 */
589static int alua_initialize(struct scsi_device *sdev, struct alua_dh_data *h)
590{
Hannes Reineckead0ea642015-12-01 10:16:53 +0100591 int err = SCSI_DH_DEV_UNSUPP;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700592
Hannes Reineckead0ea642015-12-01 10:16:53 +0100593 h->tpgs = alua_check_tpgs(sdev);
594 if (h->tpgs == TPGS_MODE_NONE)
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700595 goto out;
596
Hannes Reinecke9b80dce2015-12-01 10:16:44 +0100597 err = alua_check_vpd(sdev, h);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700598 if (err != SCSI_DH_OK)
599 goto out;
600
Stewart, Seana8e5a2d2013-10-15 15:52:54 +0000601 err = alua_rtpg(sdev, h, 0);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700602 if (err != SCSI_DH_OK)
603 goto out;
604
605out:
606 return err;
607}
Moger, Babu4335d092012-03-27 20:55:49 +0000608/*
609 * alua_set_params - set/unset the optimize flag
610 * @sdev: device on the path to be activated
611 * params - parameters in the following format
612 * "no_of_params\0param1\0param2\0param3\0...\0"
613 * For example, to set the flag pass the following parameters
614 * from multipath.conf
615 * hardware_handler "2 alua 1"
616 */
617static int alua_set_params(struct scsi_device *sdev, const char *params)
618{
Christoph Hellwigee14c672015-08-27 14:16:59 +0200619 struct alua_dh_data *h = sdev->handler_data;
Moger, Babu4335d092012-03-27 20:55:49 +0000620 unsigned int optimize = 0, argc;
621 const char *p = params;
622 int result = SCSI_DH_OK;
623
624 if ((sscanf(params, "%u", &argc) != 1) || (argc != 1))
625 return -EINVAL;
626
627 while (*p++)
628 ;
629 if ((sscanf(p, "%u", &optimize) != 1) || (optimize > 1))
630 return -EINVAL;
631
632 if (optimize)
633 h->flags |= ALUA_OPTIMIZE_STPG;
634 else
635 h->flags &= ~ALUA_OPTIMIZE_STPG;
636
637 return result;
638}
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700639
Stewart, Sean7a3ad392013-04-04 14:54:47 +0000640static uint optimize_stpg;
641module_param(optimize_stpg, uint, S_IRUGO|S_IWUSR);
642MODULE_PARM_DESC(optimize_stpg, "Allow use of a non-optimized path, rather than sending a STPG, when implicit TPGS is supported (0=No,1=Yes). Default is 0.");
643
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700644/*
645 * alua_activate - activate a path
646 * @sdev: device on the path to be activated
647 *
648 * We're currently switching the port group to be activated only and
649 * let the array figure out the rest.
650 * There may be other arrays which require us to switch all port groups
651 * based on a certain policy. But until we actually encounter them it
652 * should be okay.
653 */
Chandra Seetharaman3ae31f62009-10-21 09:22:46 -0700654static int alua_activate(struct scsi_device *sdev,
655 activate_complete fn, void *data)
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700656{
Christoph Hellwigee14c672015-08-27 14:16:59 +0200657 struct alua_dh_data *h = sdev->handler_data;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700658 int err = SCSI_DH_OK;
Moger, Babu72d9e0f2012-03-27 20:56:20 +0000659 int stpg = 0;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700660
Stewart, Seana8e5a2d2013-10-15 15:52:54 +0000661 err = alua_rtpg(sdev, h, 1);
Hannes Reinecke46ccf6b2011-08-24 10:51:16 +0200662 if (err != SCSI_DH_OK)
663 goto out;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700664
Stewart, Sean7a3ad392013-04-04 14:54:47 +0000665 if (optimize_stpg)
666 h->flags |= ALUA_OPTIMIZE_STPG;
667
Moger, Babu72d9e0f2012-03-27 20:56:20 +0000668 if (h->tpgs & TPGS_MODE_EXPLICIT) {
669 switch (h->state) {
670 case TPGS_STATE_NONOPTIMIZED:
671 stpg = 1;
672 if ((h->flags & ALUA_OPTIMIZE_STPG) &&
673 (!h->pref) &&
674 (h->tpgs & TPGS_MODE_IMPLICIT))
675 stpg = 0;
676 break;
677 case TPGS_STATE_STANDBY:
Bart Van Asschebb2c94a2012-06-22 08:49:38 +0000678 case TPGS_STATE_UNAVAILABLE:
Moger, Babu72d9e0f2012-03-27 20:56:20 +0000679 stpg = 1;
680 break;
Moger, Babu72d9e0f2012-03-27 20:56:20 +0000681 case TPGS_STATE_OFFLINE:
682 err = SCSI_DH_IO;
683 break;
684 case TPGS_STATE_TRANSITIONING:
685 err = SCSI_DH_RETRY;
686 break;
687 default:
688 break;
689 }
690 }
691
692 if (stpg) {
Chandra Seetharaman96e65862009-10-21 09:23:04 -0700693 h->callback_fn = fn;
694 h->callback_data = data;
695 err = submit_stpg(h);
696 if (err == SCSI_DH_OK)
697 return 0;
698 h->callback_fn = h->callback_data = NULL;
699 }
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700700
701out:
Chandra Seetharaman3ae31f62009-10-21 09:22:46 -0700702 if (fn)
703 fn(data, err);
704 return 0;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700705}
706
707/*
708 * alua_prep_fn - request callback
709 *
710 * Fail I/O to all paths not in state
711 * active/optimized or active/non-optimized.
712 */
713static int alua_prep_fn(struct scsi_device *sdev, struct request *req)
714{
Christoph Hellwigee14c672015-08-27 14:16:59 +0200715 struct alua_dh_data *h = sdev->handler_data;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700716 int ret = BLKPREP_OK;
717
Hannes Reinecke69723d12010-09-24 15:57:04 +0200718 if (h->state == TPGS_STATE_TRANSITIONING)
719 ret = BLKPREP_DEFER;
720 else if (h->state != TPGS_STATE_OPTIMIZED &&
721 h->state != TPGS_STATE_NONOPTIMIZED &&
722 h->state != TPGS_STATE_LBA_DEPENDENT) {
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700723 ret = BLKPREP_KILL;
724 req->cmd_flags |= REQ_QUIET;
725 }
726 return ret;
727
728}
729
Christoph Hellwig1d520322014-09-14 11:08:21 -0700730/*
731 * alua_bus_attach - Attach device handler
732 * @sdev: device to be attached to
733 */
Christoph Hellwigee14c672015-08-27 14:16:59 +0200734static int alua_bus_attach(struct scsi_device *sdev)
Christoph Hellwig1d520322014-09-14 11:08:21 -0700735{
736 struct alua_dh_data *h;
737 int err;
738
739 h = kzalloc(sizeof(*h) , GFP_KERNEL);
740 if (!h)
Christoph Hellwigee14c672015-08-27 14:16:59 +0200741 return -ENOMEM;
Christoph Hellwig1d520322014-09-14 11:08:21 -0700742 h->tpgs = TPGS_MODE_UNINITIALIZED;
743 h->state = TPGS_STATE_OPTIMIZED;
744 h->group_id = -1;
745 h->rel_port = -1;
746 h->buff = h->inq;
747 h->bufflen = ALUA_INQUIRY_SIZE;
748 h->sdev = sdev;
749
750 err = alua_initialize(sdev, h);
751 if (err != SCSI_DH_OK && err != SCSI_DH_DEV_OFFLINED)
752 goto failed;
753
Christoph Hellwigee14c672015-08-27 14:16:59 +0200754 sdev->handler_data = h;
755 return 0;
Christoph Hellwig1d520322014-09-14 11:08:21 -0700756failed:
757 kfree(h);
Christoph Hellwigee14c672015-08-27 14:16:59 +0200758 return -EINVAL;
Christoph Hellwig1d520322014-09-14 11:08:21 -0700759}
760
761/*
762 * alua_bus_detach - Detach device handler
763 * @sdev: device to be detached from
764 */
765static void alua_bus_detach(struct scsi_device *sdev)
766{
Christoph Hellwigee14c672015-08-27 14:16:59 +0200767 struct alua_dh_data *h = sdev->handler_data;
Christoph Hellwig1d520322014-09-14 11:08:21 -0700768
769 if (h->buff && h->inq != h->buff)
770 kfree(h->buff);
Christoph Hellwigee14c672015-08-27 14:16:59 +0200771 sdev->handler_data = NULL;
Christoph Hellwig1d520322014-09-14 11:08:21 -0700772 kfree(h);
773}
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700774
775static struct scsi_device_handler alua_dh = {
776 .name = ALUA_DH_NAME,
777 .module = THIS_MODULE,
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700778 .attach = alua_bus_attach,
779 .detach = alua_bus_detach,
780 .prep_fn = alua_prep_fn,
781 .check_sense = alua_check_sense,
782 .activate = alua_activate,
Moger, Babu4335d092012-03-27 20:55:49 +0000783 .set_params = alua_set_params,
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700784};
785
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700786static int __init alua_init(void)
787{
788 int r;
789
790 r = scsi_register_device_handler(&alua_dh);
791 if (r != 0)
792 printk(KERN_ERR "%s: Failed to register scsi device handler",
793 ALUA_DH_NAME);
794 return r;
795}
796
797static void __exit alua_exit(void)
798{
799 scsi_unregister_device_handler(&alua_dh);
800}
801
802module_init(alua_init);
803module_exit(alua_exit);
804
805MODULE_DESCRIPTION("DM Multipath ALUA support");
806MODULE_AUTHOR("Hannes Reinecke <hare@suse.de>");
807MODULE_LICENSE("GPL");
808MODULE_VERSION(ALUA_DH_VER);