blob: af5acc133f72722841fc1c9d0e75cd378d5defaf [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
Hannes Reineckec49c8342016-02-19 09:17:03 +010059#define ALUA_RTPG_SIZE 128
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 */
Rob Evers3588c5a2012-05-18 14:08:54 -040074 unsigned char transition_tmo;
Chandra Seetharaman96e65862009-10-21 09:23:04 -070075 struct scsi_device *sdev;
76 activate_complete callback_fn;
77 void *callback_data;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -070078};
79
80#define ALUA_POLICY_SWITCH_CURRENT 0
81#define ALUA_POLICY_SWITCH_ALL 1
82
Chandra Seetharaman96e65862009-10-21 09:23:04 -070083static char print_alua_state(int);
Chandra Seetharaman96e65862009-10-21 09:23:04 -070084
Hannes Reinecke057ea7c2008-07-17 16:53:21 -070085/*
Hannes Reinecke057ea7c2008-07-17 16:53:21 -070086 * submit_rtpg - Issue a REPORT TARGET GROUP STATES command
87 * @sdev: sdev the command should be sent to
88 */
Hannes Reinecke40bb61a2016-02-19 09:17:02 +010089static int submit_rtpg(struct scsi_device *sdev, unsigned char *buff,
90 int bufflen, struct scsi_sense_hdr *sshdr, int flags)
Hannes Reinecke057ea7c2008-07-17 16:53:21 -070091{
Hannes Reinecke40bb61a2016-02-19 09:17:02 +010092 u8 cdb[COMMAND_SIZE(MAINTENANCE_IN)];
93 int req_flags = REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT |
94 REQ_FAILFAST_DRIVER;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -070095
96 /* Prepare the command. */
Hannes Reinecke40bb61a2016-02-19 09:17:02 +010097 memset(cdb, 0x0, COMMAND_SIZE(MAINTENANCE_IN));
98 cdb[0] = MAINTENANCE_IN;
Hannes Reinecked42ae5f2016-02-19 09:16:58 +010099 if (!(flags & ALUA_RTPG_EXT_HDR_UNSUPP))
Hannes Reinecke40bb61a2016-02-19 09:17:02 +0100100 cdb[1] = MI_REPORT_TARGET_PGS | MI_EXT_HDR_PARAM_FMT;
Rob Evers8e67ce62012-05-18 14:08:55 -0400101 else
Hannes Reinecke40bb61a2016-02-19 09:17:02 +0100102 cdb[1] = MI_REPORT_TARGET_PGS;
103 put_unaligned_be32(bufflen, &cdb[6]);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700104
Hannes Reinecke40bb61a2016-02-19 09:17:02 +0100105 return scsi_execute_req_flags(sdev, cdb, DMA_FROM_DEVICE,
106 buff, bufflen, sshdr,
107 ALUA_FAILOVER_TIMEOUT * HZ,
108 ALUA_FAILOVER_RETRIES, NULL, req_flags);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700109}
110
111/*
Hannes Reineckeb2460752016-02-19 09:17:00 +0100112 * submit_stpg - Issue a SET TARGET PORT GROUP command
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700113 *
114 * Currently we're only setting the current target port group state
115 * to 'active/optimized' and let the array firmware figure out
116 * the states of the remaining groups.
117 */
Hannes Reinecke40bb61a2016-02-19 09:17:02 +0100118static int submit_stpg(struct scsi_device *sdev, int group_id,
119 struct scsi_sense_hdr *sshdr)
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700120{
Hannes Reinecke40bb61a2016-02-19 09:17:02 +0100121 u8 cdb[COMMAND_SIZE(MAINTENANCE_OUT)];
Hannes Reineckeb2460752016-02-19 09:17:00 +0100122 unsigned char stpg_data[8];
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700123 int stpg_len = 8;
Hannes Reinecke40bb61a2016-02-19 09:17:02 +0100124 int req_flags = REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT |
125 REQ_FAILFAST_DRIVER;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700126
127 /* Prepare the data buffer */
Hannes Reineckeb2460752016-02-19 09:17:00 +0100128 memset(stpg_data, 0, stpg_len);
129 stpg_data[4] = TPGS_STATE_OPTIMIZED & 0x0f;
130 put_unaligned_be16(group_id, &stpg_data[6]);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700131
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700132 /* Prepare the command. */
Hannes Reinecke40bb61a2016-02-19 09:17:02 +0100133 memset(cdb, 0x0, COMMAND_SIZE(MAINTENANCE_OUT));
134 cdb[0] = MAINTENANCE_OUT;
135 cdb[1] = MO_SET_TARGET_PGS;
136 put_unaligned_be32(stpg_len, &cdb[6]);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700137
Hannes Reinecke40bb61a2016-02-19 09:17:02 +0100138 return scsi_execute_req_flags(sdev, cdb, DMA_TO_DEVICE,
139 stpg_data, stpg_len,
140 sshdr, ALUA_FAILOVER_TIMEOUT * HZ,
141 ALUA_FAILOVER_RETRIES, NULL, req_flags);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700142}
143
144/*
Hannes Reinecked7c48fe2011-08-24 10:51:13 +0200145 * alua_check_tpgs - Evaluate TPGS setting
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700146 * @sdev: device to be checked
147 *
Hannes Reinecked7c48fe2011-08-24 10:51:13 +0200148 * Examine the TPGS setting of the sdev to find out if ALUA
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700149 * is supported.
150 */
Hannes Reineckead0ea642015-12-01 10:16:53 +0100151static int alua_check_tpgs(struct scsi_device *sdev)
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700152{
Hannes Reineckead0ea642015-12-01 10:16:53 +0100153 int tpgs = TPGS_MODE_NONE;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700154
Hannes Reineckedb5a6a62015-12-01 10:16:43 +0100155 /*
156 * ALUA support for non-disk devices is fraught with
157 * difficulties, so disable it for now.
158 */
159 if (sdev->type != TYPE_DISK) {
Hannes Reineckedb5a6a62015-12-01 10:16:43 +0100160 sdev_printk(KERN_INFO, sdev,
161 "%s: disable for non-disk devices\n",
162 ALUA_DH_NAME);
Hannes Reineckead0ea642015-12-01 10:16:53 +0100163 return tpgs;
Hannes Reineckedb5a6a62015-12-01 10:16:43 +0100164 }
165
Hannes Reineckead0ea642015-12-01 10:16:53 +0100166 tpgs = scsi_device_tpgs(sdev);
167 switch (tpgs) {
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700168 case TPGS_MODE_EXPLICIT|TPGS_MODE_IMPLICIT:
169 sdev_printk(KERN_INFO, sdev,
170 "%s: supports implicit and explicit TPGS\n",
171 ALUA_DH_NAME);
172 break;
173 case TPGS_MODE_EXPLICIT:
174 sdev_printk(KERN_INFO, sdev, "%s: supports explicit TPGS\n",
175 ALUA_DH_NAME);
176 break;
177 case TPGS_MODE_IMPLICIT:
178 sdev_printk(KERN_INFO, sdev, "%s: supports implicit TPGS\n",
179 ALUA_DH_NAME);
180 break;
Hannes Reinecke6cc05d42015-12-01 10:16:45 +0100181 case TPGS_MODE_NONE:
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700182 sdev_printk(KERN_INFO, sdev, "%s: not supported\n",
183 ALUA_DH_NAME);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700184 break;
Hannes Reinecke6cc05d42015-12-01 10:16:45 +0100185 default:
186 sdev_printk(KERN_INFO, sdev,
187 "%s: unsupported TPGS setting %d\n",
Hannes Reineckead0ea642015-12-01 10:16:53 +0100188 ALUA_DH_NAME, tpgs);
189 tpgs = TPGS_MODE_NONE;
Hannes Reinecke6cc05d42015-12-01 10:16:45 +0100190 break;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700191 }
192
Hannes Reineckead0ea642015-12-01 10:16:53 +0100193 return tpgs;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700194}
195
196/*
Hannes Reinecke9b80dce2015-12-01 10:16:44 +0100197 * alua_check_vpd - Evaluate INQUIRY vpd page 0x83
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700198 * @sdev: device to be checked
199 *
200 * Extract the relative target port and the target port group
201 * descriptor from the list of identificators.
202 */
Hannes Reinecke9b80dce2015-12-01 10:16:44 +0100203static int alua_check_vpd(struct scsi_device *sdev, struct alua_dh_data *h)
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700204{
Hannes Reinecke83ea0e52015-12-01 10:16:58 +0100205 int rel_port = -1, group_id;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700206
Hannes Reinecke83ea0e52015-12-01 10:16:58 +0100207 group_id = scsi_vpd_tpg_id(sdev, &rel_port);
208 if (group_id < 0) {
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700209 /*
210 * Internal error; TPGS supported but required
211 * VPD identification descriptors not present.
212 * Disable ALUA support
213 */
214 sdev_printk(KERN_INFO, sdev,
215 "%s: No target port descriptors found\n",
216 ALUA_DH_NAME);
Hannes Reinecke9b80dce2015-12-01 10:16:44 +0100217 return SCSI_DH_DEV_UNSUPP;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700218 }
Hannes Reinecke83ea0e52015-12-01 10:16:58 +0100219 h->state = TPGS_STATE_OPTIMIZED;
220 h->group_id = group_id;
221
Hannes Reinecke9b80dce2015-12-01 10:16:44 +0100222 sdev_printk(KERN_INFO, sdev,
223 "%s: port group %02x rel port %02x\n",
224 ALUA_DH_NAME, h->group_id, h->rel_port);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700225
Hannes Reinecke9b80dce2015-12-01 10:16:44 +0100226 return 0;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700227}
228
229static char print_alua_state(int state)
230{
231 switch (state) {
232 case TPGS_STATE_OPTIMIZED:
233 return 'A';
234 case TPGS_STATE_NONOPTIMIZED:
235 return 'N';
236 case TPGS_STATE_STANDBY:
237 return 'S';
238 case TPGS_STATE_UNAVAILABLE:
239 return 'U';
Hannes Reinecke69723d12010-09-24 15:57:04 +0200240 case TPGS_STATE_LBA_DEPENDENT:
241 return 'L';
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700242 case TPGS_STATE_OFFLINE:
243 return 'O';
244 case TPGS_STATE_TRANSITIONING:
245 return 'T';
246 default:
247 return 'X';
248 }
249}
250
251static int alua_check_sense(struct scsi_device *sdev,
252 struct scsi_sense_hdr *sense_hdr)
253{
254 switch (sense_hdr->sense_key) {
255 case NOT_READY:
256 if (sense_hdr->asc == 0x04 && sense_hdr->ascq == 0x0a)
257 /*
258 * LUN Not Accessible - ALUA state transition
259 */
Mike Andersonc7dbb622008-08-12 12:11:57 -0700260 return ADD_TO_MLQUEUE;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700261 break;
262 case UNIT_ATTENTION:
263 if (sense_hdr->asc == 0x29 && sense_hdr->ascq == 0x00)
264 /*
265 * Power On, Reset, or Bus Device Reset, just retry.
266 */
Mike Andersonc7dbb622008-08-12 12:11:57 -0700267 return ADD_TO_MLQUEUE;
Stewart, Seanc20ee7b2013-10-15 15:52:39 +0000268 if (sense_hdr->asc == 0x29 && sense_hdr->ascq == 0x04)
269 /*
270 * Device internal reset
271 */
272 return ADD_TO_MLQUEUE;
Moger, Babu410f02d2011-12-21 18:01:37 -0500273 if (sense_hdr->asc == 0x2a && sense_hdr->ascq == 0x01)
274 /*
275 * Mode Parameters Changed
276 */
277 return ADD_TO_MLQUEUE;
Moger, Babubf819732011-10-06 13:22:07 -0400278 if (sense_hdr->asc == 0x2a && sense_hdr->ascq == 0x06)
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700279 /*
280 * ALUA state changed
281 */
Mike Andersonc7dbb622008-08-12 12:11:57 -0700282 return ADD_TO_MLQUEUE;
Moger, Babubf819732011-10-06 13:22:07 -0400283 if (sense_hdr->asc == 0x2a && sense_hdr->ascq == 0x07)
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700284 /*
285 * Implicit ALUA state transition failed
286 */
Mike Andersonc7dbb622008-08-12 12:11:57 -0700287 return ADD_TO_MLQUEUE;
Moger, Babubf819732011-10-06 13:22:07 -0400288 if (sense_hdr->asc == 0x3f && sense_hdr->ascq == 0x03)
289 /*
290 * Inquiry data has changed
291 */
292 return ADD_TO_MLQUEUE;
293 if (sense_hdr->asc == 0x3f && sense_hdr->ascq == 0x0e)
Ilgu Hong4d086f62009-01-30 17:00:11 -0600294 /*
295 * REPORTED_LUNS_DATA_HAS_CHANGED is reported
296 * when switching controllers on targets like
297 * Intel Multi-Flex. We can just retry.
298 */
299 return ADD_TO_MLQUEUE;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700300 break;
301 }
302
303 return SCSI_RETURN_NOT_HANDLED;
304}
305
306/*
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700307 * alua_rtpg - Evaluate REPORT TARGET GROUP STATES
308 * @sdev: the device to be evaluated.
Stewart, Seana8e5a2d2013-10-15 15:52:54 +0000309 * @wait_for_transition: if nonzero, wait ALUA_FAILOVER_TIMEOUT seconds for device to exit transitioning state
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700310 *
311 * Evaluate the Target Port Group State.
312 * Returns SCSI_DH_DEV_OFFLINED if the path is
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300313 * found to be unusable.
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700314 */
Stewart, Seana8e5a2d2013-10-15 15:52:54 +0000315static int alua_rtpg(struct scsi_device *sdev, struct alua_dh_data *h, int wait_for_transition)
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700316{
317 struct scsi_sense_hdr sense_hdr;
Hannes Reineckec49c8342016-02-19 09:17:03 +0100318 int len, k, off, valid_states = 0, bufflen = ALUA_RTPG_SIZE;
319 unsigned char *ucp, *buff;
Hannes Reinecke5597caf2015-12-01 10:16:48 +0100320 unsigned err, retval;
Rob Eversbc97f4b2012-05-18 14:08:56 -0400321 unsigned long expiry, interval = 0;
Rob Evers3588c5a2012-05-18 14:08:54 -0400322 unsigned int tpg_desc_tbl_off;
323 unsigned char orig_transition_tmo;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700324
Rob Evers3588c5a2012-05-18 14:08:54 -0400325 if (!h->transition_tmo)
326 expiry = round_jiffies_up(jiffies + ALUA_FAILOVER_TIMEOUT * HZ);
327 else
328 expiry = round_jiffies_up(jiffies + h->transition_tmo * HZ);
329
Hannes Reineckec49c8342016-02-19 09:17:03 +0100330 buff = kzalloc(bufflen, GFP_KERNEL);
331 if (!buff)
332 return SCSI_DH_DEV_TEMP_BUSY;
333
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700334 retry:
Hannes Reineckec49c8342016-02-19 09:17:03 +0100335 retval = submit_rtpg(sdev, buff, bufflen, &sense_hdr, h->flags);
Hannes Reinecke40bb61a2016-02-19 09:17:02 +0100336
Hannes Reinecke5597caf2015-12-01 10:16:48 +0100337 if (retval) {
Hannes Reinecke40bb61a2016-02-19 09:17:02 +0100338 if (!scsi_sense_valid(&sense_hdr)) {
Hannes Reinecke5597caf2015-12-01 10:16:48 +0100339 sdev_printk(KERN_INFO, sdev,
340 "%s: rtpg failed, result %d\n",
341 ALUA_DH_NAME, retval);
Hannes Reineckec49c8342016-02-19 09:17:03 +0100342 kfree(buff);
Hannes Reinecke40bb61a2016-02-19 09:17:02 +0100343 if (driver_byte(retval) == DRIVER_ERROR)
Hannes Reinecke5597caf2015-12-01 10:16:48 +0100344 return SCSI_DH_DEV_TEMP_BUSY;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700345 return SCSI_DH_IO;
Hannes Reinecke5597caf2015-12-01 10:16:48 +0100346 }
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700347
Rob Evers8e67ce62012-05-18 14:08:55 -0400348 /*
349 * submit_rtpg() has failed on existing arrays
350 * when requesting extended header info, and
351 * the array doesn't support extended headers,
352 * even though it shouldn't according to T10.
353 * The retry without rtpg_ext_hdr_req set
354 * handles this.
355 */
Hannes Reinecke6c4fc042015-12-01 10:16:51 +0100356 if (!(h->flags & ALUA_RTPG_EXT_HDR_UNSUPP) &&
Rob Evers8e67ce62012-05-18 14:08:55 -0400357 sense_hdr.sense_key == ILLEGAL_REQUEST &&
358 sense_hdr.asc == 0x24 && sense_hdr.ascq == 0) {
Hannes Reinecke6c4fc042015-12-01 10:16:51 +0100359 h->flags |= ALUA_RTPG_EXT_HDR_UNSUPP;
Rob Evers8e67ce62012-05-18 14:08:55 -0400360 goto retry;
361 }
Hannes Reineckee2d817d2015-12-01 10:16:54 +0100362 /*
363 * Retry on ALUA state transition or if any
364 * UNIT ATTENTION occurred.
365 */
366 if (sense_hdr.sense_key == NOT_READY &&
367 sense_hdr.asc == 0x04 && sense_hdr.ascq == 0x0a)
368 err = SCSI_DH_RETRY;
369 else if (sense_hdr.sense_key == UNIT_ATTENTION)
370 err = SCSI_DH_RETRY;
371 if (err == SCSI_DH_RETRY && time_before(jiffies, expiry)) {
Hannes Reinecke80bd68d2015-12-01 10:16:47 +0100372 sdev_printk(KERN_ERR, sdev, "%s: rtpg retry\n",
373 ALUA_DH_NAME);
374 scsi_print_sense_hdr(sdev, ALUA_DH_NAME, &sense_hdr);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700375 goto retry;
Hannes Reinecke80bd68d2015-12-01 10:16:47 +0100376 }
377 sdev_printk(KERN_ERR, sdev, "%s: rtpg failed\n",
378 ALUA_DH_NAME);
379 scsi_print_sense_hdr(sdev, ALUA_DH_NAME, &sense_hdr);
Hannes Reineckec49c8342016-02-19 09:17:03 +0100380 kfree(buff);
Hannes Reinecke80bd68d2015-12-01 10:16:47 +0100381 return SCSI_DH_IO;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700382 }
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700383
Hannes Reineckec49c8342016-02-19 09:17:03 +0100384 len = get_unaligned_be32(&buff[0]) + 4;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700385
Hannes Reineckec49c8342016-02-19 09:17:03 +0100386 if (len > bufflen) {
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700387 /* Resubmit with the correct length */
Hannes Reineckec49c8342016-02-19 09:17:03 +0100388 kfree(buff);
389 bufflen = len;
390 buff = kmalloc(bufflen, GFP_KERNEL);
391 if (!buff) {
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700392 sdev_printk(KERN_WARNING, sdev,
Harvey Harrisoncadbd4a2008-07-03 23:47:27 -0700393 "%s: kmalloc buffer failed\n",__func__);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700394 /* Temporary failure, bypass */
395 return SCSI_DH_DEV_TEMP_BUSY;
396 }
397 goto retry;
398 }
399
Rob Evers3588c5a2012-05-18 14:08:54 -0400400 orig_transition_tmo = h->transition_tmo;
Hannes Reineckec49c8342016-02-19 09:17:03 +0100401 if ((buff[4] & RTPG_FMT_MASK) == RTPG_FMT_EXT_HDR && buff[5] != 0)
402 h->transition_tmo = buff[5];
Rob Evers3588c5a2012-05-18 14:08:54 -0400403 else
404 h->transition_tmo = ALUA_FAILOVER_TIMEOUT;
405
Hannes Reineckec49c8342016-02-19 09:17:03 +0100406 if (wait_for_transition &&
407 (orig_transition_tmo != h->transition_tmo)) {
Rob Evers3588c5a2012-05-18 14:08:54 -0400408 sdev_printk(KERN_INFO, sdev,
409 "%s: transition timeout set to %d seconds\n",
410 ALUA_DH_NAME, h->transition_tmo);
411 expiry = jiffies + h->transition_tmo * HZ;
412 }
413
Hannes Reineckec49c8342016-02-19 09:17:03 +0100414 if ((buff[4] & RTPG_FMT_MASK) == RTPG_FMT_EXT_HDR)
Rob Evers3588c5a2012-05-18 14:08:54 -0400415 tpg_desc_tbl_off = 8;
416 else
417 tpg_desc_tbl_off = 4;
418
Hannes Reineckec49c8342016-02-19 09:17:03 +0100419 for (k = tpg_desc_tbl_off, ucp = buff + tpg_desc_tbl_off;
Rob Evers3588c5a2012-05-18 14:08:54 -0400420 k < len;
421 k += off, ucp += off) {
422
Hannes Reineckea7089772015-12-01 10:16:52 +0100423 if (h->group_id == get_unaligned_be16(&ucp[2])) {
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700424 h->state = ucp[0] & 0x0f;
Moger, Babudcd3a752012-03-27 20:56:08 +0000425 h->pref = ucp[0] >> 7;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700426 valid_states = ucp[1];
427 }
428 off = 8 + (ucp[7] * 4);
429 }
430
431 sdev_printk(KERN_INFO, sdev,
Moger, Babudcd3a752012-03-27 20:56:08 +0000432 "%s: port group %02x state %c %s supports %c%c%c%c%c%c%c\n",
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700433 ALUA_DH_NAME, h->group_id, print_alua_state(h->state),
Moger, Babudcd3a752012-03-27 20:56:08 +0000434 h->pref ? "preferred" : "non-preferred",
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700435 valid_states&TPGS_SUPPORT_TRANSITION?'T':'t',
436 valid_states&TPGS_SUPPORT_OFFLINE?'O':'o',
Hannes Reinecke69723d12010-09-24 15:57:04 +0200437 valid_states&TPGS_SUPPORT_LBA_DEPENDENT?'L':'l',
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700438 valid_states&TPGS_SUPPORT_UNAVAILABLE?'U':'u',
439 valid_states&TPGS_SUPPORT_STANDBY?'S':'s',
440 valid_states&TPGS_SUPPORT_NONOPTIMIZED?'N':'n',
441 valid_states&TPGS_SUPPORT_OPTIMIZED?'A':'a');
442
Hannes Reinecke69723d12010-09-24 15:57:04 +0200443 switch (h->state) {
444 case TPGS_STATE_TRANSITIONING:
Stewart, Seana8e5a2d2013-10-15 15:52:54 +0000445 if (wait_for_transition) {
446 if (time_before(jiffies, expiry)) {
447 /* State transition, retry */
448 interval += 2000;
449 msleep(interval);
450 goto retry;
451 }
452 err = SCSI_DH_RETRY;
453 } else {
454 err = SCSI_DH_OK;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700455 }
Stewart, Seana8e5a2d2013-10-15 15:52:54 +0000456
Hannes Reinecke69723d12010-09-24 15:57:04 +0200457 /* Transitioning time exceeded, set port to standby */
Hannes Reinecke69723d12010-09-24 15:57:04 +0200458 h->state = TPGS_STATE_STANDBY;
459 break;
460 case TPGS_STATE_OFFLINE:
Bart Van Asschee47f8972012-08-24 09:08:41 +0000461 /* Path unusable */
Hannes Reinecke69723d12010-09-24 15:57:04 +0200462 err = SCSI_DH_DEV_OFFLINED;
463 break;
464 default:
465 /* Useable path if active */
466 err = SCSI_DH_OK;
467 break;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700468 }
Hannes Reineckec49c8342016-02-19 09:17:03 +0100469 kfree(buff);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700470 return err;
471}
472
473/*
Hannes Reineckef2ecf132016-02-19 09:16:59 +0100474 * alua_stpg - Issue a SET TARGET PORT GROUP command
475 *
476 * Issue a SET TARGET PORT GROUP command and evaluate the
Hannes Reineckeb2460752016-02-19 09:17:00 +0100477 * response. Returns SCSI_DH_RETRY per default to trigger
478 * a re-evaluation of the target group state or SCSI_DH_OK
479 * if no further action needs to be taken.
Hannes Reineckef2ecf132016-02-19 09:16:59 +0100480 */
Hannes Reineckeb2460752016-02-19 09:17:00 +0100481static unsigned alua_stpg(struct scsi_device *sdev, struct alua_dh_data *h)
Hannes Reineckef2ecf132016-02-19 09:16:59 +0100482{
Hannes Reineckeb2460752016-02-19 09:17:00 +0100483 int retval;
484 struct scsi_sense_hdr sense_hdr;
Hannes Reineckef2ecf132016-02-19 09:16:59 +0100485
Hannes Reineckeb2460752016-02-19 09:17:00 +0100486 if (!(h->tpgs & TPGS_MODE_EXPLICIT)) {
487 /* Only implicit ALUA supported, retry */
488 return SCSI_DH_RETRY;
489 }
Hannes Reineckef2ecf132016-02-19 09:16:59 +0100490 switch (h->state) {
Hannes Reineckeb2460752016-02-19 09:17:00 +0100491 case TPGS_STATE_OPTIMIZED:
492 return SCSI_DH_OK;
Hannes Reineckef2ecf132016-02-19 09:16:59 +0100493 case TPGS_STATE_NONOPTIMIZED:
Hannes Reineckef2ecf132016-02-19 09:16:59 +0100494 if ((h->flags & ALUA_OPTIMIZE_STPG) &&
495 !h->pref &&
496 (h->tpgs & TPGS_MODE_IMPLICIT))
Hannes Reineckeb2460752016-02-19 09:17:00 +0100497 return SCSI_DH_OK;
Hannes Reineckef2ecf132016-02-19 09:16:59 +0100498 break;
499 case TPGS_STATE_STANDBY:
500 case TPGS_STATE_UNAVAILABLE:
Hannes Reineckef2ecf132016-02-19 09:16:59 +0100501 break;
502 case TPGS_STATE_OFFLINE:
Hannes Reineckeb2460752016-02-19 09:17:00 +0100503 return SCSI_DH_IO;
Hannes Reineckef2ecf132016-02-19 09:16:59 +0100504 case TPGS_STATE_TRANSITIONING:
Hannes Reineckef2ecf132016-02-19 09:16:59 +0100505 break;
506 default:
Hannes Reineckeb2460752016-02-19 09:17:00 +0100507 sdev_printk(KERN_INFO, sdev,
508 "%s: stpg failed, unhandled TPGS state %d",
509 ALUA_DH_NAME, h->state);
510 return SCSI_DH_NOSYS;
Hannes Reineckef2ecf132016-02-19 09:16:59 +0100511 }
Hannes Reinecke40bb61a2016-02-19 09:17:02 +0100512 retval = submit_stpg(sdev, h->group_id, &sense_hdr);
Hannes Reineckef2ecf132016-02-19 09:16:59 +0100513
Hannes Reineckeb2460752016-02-19 09:17:00 +0100514 if (retval) {
Hannes Reinecke40bb61a2016-02-19 09:17:02 +0100515 if (!scsi_sense_valid(&sense_hdr)) {
Hannes Reineckeb2460752016-02-19 09:17:00 +0100516 sdev_printk(KERN_INFO, sdev,
517 "%s: stpg failed, result %d",
518 ALUA_DH_NAME, retval);
Hannes Reinecke40bb61a2016-02-19 09:17:02 +0100519 if (driver_byte(retval) == DRIVER_ERROR)
Hannes Reineckeb2460752016-02-19 09:17:00 +0100520 return SCSI_DH_DEV_TEMP_BUSY;
521 } else {
522 sdev_printk(KERN_INFO, h->sdev, "%s: stpg failed\n",
523 ALUA_DH_NAME);
524 scsi_print_sense_hdr(sdev, ALUA_DH_NAME, &sense_hdr);
525 }
Hannes Reineckef2ecf132016-02-19 09:16:59 +0100526 }
Hannes Reineckeb2460752016-02-19 09:17:00 +0100527 /* Retry RTPG */
528 return SCSI_DH_RETRY;
Hannes Reineckef2ecf132016-02-19 09:16:59 +0100529}
530
531/*
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700532 * alua_initialize - Initialize ALUA state
533 * @sdev: the device to be initialized
534 *
535 * For the prep_fn to work correctly we have
536 * to initialize the ALUA state for the device.
537 */
538static int alua_initialize(struct scsi_device *sdev, struct alua_dh_data *h)
539{
Hannes Reineckead0ea642015-12-01 10:16:53 +0100540 int err = SCSI_DH_DEV_UNSUPP;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700541
Hannes Reineckead0ea642015-12-01 10:16:53 +0100542 h->tpgs = alua_check_tpgs(sdev);
543 if (h->tpgs == TPGS_MODE_NONE)
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700544 goto out;
545
Hannes Reinecke9b80dce2015-12-01 10:16:44 +0100546 err = alua_check_vpd(sdev, h);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700547 if (err != SCSI_DH_OK)
548 goto out;
549
Stewart, Seana8e5a2d2013-10-15 15:52:54 +0000550 err = alua_rtpg(sdev, h, 0);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700551 if (err != SCSI_DH_OK)
552 goto out;
553
554out:
555 return err;
556}
Moger, Babu4335d092012-03-27 20:55:49 +0000557/*
558 * alua_set_params - set/unset the optimize flag
559 * @sdev: device on the path to be activated
560 * params - parameters in the following format
561 * "no_of_params\0param1\0param2\0param3\0...\0"
562 * For example, to set the flag pass the following parameters
563 * from multipath.conf
564 * hardware_handler "2 alua 1"
565 */
566static int alua_set_params(struct scsi_device *sdev, const char *params)
567{
Christoph Hellwigee14c672015-08-27 14:16:59 +0200568 struct alua_dh_data *h = sdev->handler_data;
Moger, Babu4335d092012-03-27 20:55:49 +0000569 unsigned int optimize = 0, argc;
570 const char *p = params;
571 int result = SCSI_DH_OK;
572
573 if ((sscanf(params, "%u", &argc) != 1) || (argc != 1))
574 return -EINVAL;
575
576 while (*p++)
577 ;
578 if ((sscanf(p, "%u", &optimize) != 1) || (optimize > 1))
579 return -EINVAL;
580
581 if (optimize)
582 h->flags |= ALUA_OPTIMIZE_STPG;
583 else
584 h->flags &= ~ALUA_OPTIMIZE_STPG;
585
586 return result;
587}
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700588
Stewart, Sean7a3ad392013-04-04 14:54:47 +0000589static uint optimize_stpg;
590module_param(optimize_stpg, uint, S_IRUGO|S_IWUSR);
591MODULE_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.");
592
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700593/*
594 * alua_activate - activate a path
595 * @sdev: device on the path to be activated
596 *
597 * We're currently switching the port group to be activated only and
598 * let the array figure out the rest.
599 * There may be other arrays which require us to switch all port groups
600 * based on a certain policy. But until we actually encounter them it
601 * should be okay.
602 */
Chandra Seetharaman3ae31f62009-10-21 09:22:46 -0700603static int alua_activate(struct scsi_device *sdev,
604 activate_complete fn, void *data)
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700605{
Christoph Hellwigee14c672015-08-27 14:16:59 +0200606 struct alua_dh_data *h = sdev->handler_data;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700607 int err = SCSI_DH_OK;
608
Stewart, Seana8e5a2d2013-10-15 15:52:54 +0000609 err = alua_rtpg(sdev, h, 1);
Hannes Reinecke46ccf6b2011-08-24 10:51:16 +0200610 if (err != SCSI_DH_OK)
611 goto out;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700612
Stewart, Sean7a3ad392013-04-04 14:54:47 +0000613 if (optimize_stpg)
614 h->flags |= ALUA_OPTIMIZE_STPG;
615
Hannes Reineckeb2460752016-02-19 09:17:00 +0100616 err = alua_stpg(sdev, h);
Hannes Reineckedd5cc402016-02-19 09:17:01 +0100617 if (err == SCSI_DH_RETRY)
618 err = alua_rtpg(sdev, h, 1);
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700619out:
Hannes Reineckeb2460752016-02-19 09:17:00 +0100620 if (fn)
Chandra Seetharaman3ae31f62009-10-21 09:22:46 -0700621 fn(data, err);
622 return 0;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700623}
624
625/*
626 * alua_prep_fn - request callback
627 *
628 * Fail I/O to all paths not in state
629 * active/optimized or active/non-optimized.
630 */
631static int alua_prep_fn(struct scsi_device *sdev, struct request *req)
632{
Christoph Hellwigee14c672015-08-27 14:16:59 +0200633 struct alua_dh_data *h = sdev->handler_data;
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700634 int ret = BLKPREP_OK;
635
Hannes Reinecke69723d12010-09-24 15:57:04 +0200636 if (h->state == TPGS_STATE_TRANSITIONING)
637 ret = BLKPREP_DEFER;
638 else if (h->state != TPGS_STATE_OPTIMIZED &&
639 h->state != TPGS_STATE_NONOPTIMIZED &&
640 h->state != TPGS_STATE_LBA_DEPENDENT) {
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700641 ret = BLKPREP_KILL;
642 req->cmd_flags |= REQ_QUIET;
643 }
644 return ret;
645
646}
647
Christoph Hellwig1d520322014-09-14 11:08:21 -0700648/*
649 * alua_bus_attach - Attach device handler
650 * @sdev: device to be attached to
651 */
Christoph Hellwigee14c672015-08-27 14:16:59 +0200652static int alua_bus_attach(struct scsi_device *sdev)
Christoph Hellwig1d520322014-09-14 11:08:21 -0700653{
654 struct alua_dh_data *h;
655 int err;
656
657 h = kzalloc(sizeof(*h) , GFP_KERNEL);
658 if (!h)
Christoph Hellwigee14c672015-08-27 14:16:59 +0200659 return -ENOMEM;
Christoph Hellwig1d520322014-09-14 11:08:21 -0700660 h->tpgs = TPGS_MODE_UNINITIALIZED;
661 h->state = TPGS_STATE_OPTIMIZED;
662 h->group_id = -1;
663 h->rel_port = -1;
Christoph Hellwig1d520322014-09-14 11:08:21 -0700664 h->sdev = sdev;
665
666 err = alua_initialize(sdev, h);
667 if (err != SCSI_DH_OK && err != SCSI_DH_DEV_OFFLINED)
668 goto failed;
669
Christoph Hellwigee14c672015-08-27 14:16:59 +0200670 sdev->handler_data = h;
671 return 0;
Christoph Hellwig1d520322014-09-14 11:08:21 -0700672failed:
673 kfree(h);
Christoph Hellwigee14c672015-08-27 14:16:59 +0200674 return -EINVAL;
Christoph Hellwig1d520322014-09-14 11:08:21 -0700675}
676
677/*
678 * alua_bus_detach - Detach device handler
679 * @sdev: device to be detached from
680 */
681static void alua_bus_detach(struct scsi_device *sdev)
682{
Christoph Hellwigee14c672015-08-27 14:16:59 +0200683 struct alua_dh_data *h = sdev->handler_data;
Christoph Hellwig1d520322014-09-14 11:08:21 -0700684
Christoph Hellwigee14c672015-08-27 14:16:59 +0200685 sdev->handler_data = NULL;
Christoph Hellwig1d520322014-09-14 11:08:21 -0700686 kfree(h);
687}
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700688
689static struct scsi_device_handler alua_dh = {
690 .name = ALUA_DH_NAME,
691 .module = THIS_MODULE,
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700692 .attach = alua_bus_attach,
693 .detach = alua_bus_detach,
694 .prep_fn = alua_prep_fn,
695 .check_sense = alua_check_sense,
696 .activate = alua_activate,
Moger, Babu4335d092012-03-27 20:55:49 +0000697 .set_params = alua_set_params,
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700698};
699
Hannes Reinecke057ea7c2008-07-17 16:53:21 -0700700static int __init alua_init(void)
701{
702 int r;
703
704 r = scsi_register_device_handler(&alua_dh);
705 if (r != 0)
706 printk(KERN_ERR "%s: Failed to register scsi device handler",
707 ALUA_DH_NAME);
708 return r;
709}
710
711static void __exit alua_exit(void)
712{
713 scsi_unregister_device_handler(&alua_dh);
714}
715
716module_init(alua_init);
717module_exit(alua_exit);
718
719MODULE_DESCRIPTION("DM Multipath ALUA support");
720MODULE_AUTHOR("Hannes Reinecke <hare@suse.de>");
721MODULE_LICENSE("GPL");
722MODULE_VERSION(ALUA_DH_VER);