scsi_dh_alua.c 19.5 KB
Newer Older
1 2 3
/*
 * Generic SCSI-3 ALUA SCSI Device Handler
 *
4
 * Copyright (C) 2007-2010 Hannes Reinecke, SUSE Linux Products GmbH.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 */
22
#include <linux/slab.h>
23
#include <linux/delay.h>
24
#include <linux/module.h>
25
#include <asm/unaligned.h>
26
#include <scsi/scsi.h>
27
#include <scsi/scsi_dbg.h>
28 29 30 31
#include <scsi/scsi_eh.h>
#include <scsi/scsi_dh.h>

#define ALUA_DH_NAME "alua"
32
#define ALUA_DH_VER "1.3"
33 34 35 36 37

#define TPGS_STATE_OPTIMIZED		0x0
#define TPGS_STATE_NONOPTIMIZED		0x1
#define TPGS_STATE_STANDBY		0x2
#define TPGS_STATE_UNAVAILABLE		0x3
38
#define TPGS_STATE_LBA_DEPENDENT	0x4
39 40 41 42 43 44 45 46
#define TPGS_STATE_OFFLINE		0xe
#define TPGS_STATE_TRANSITIONING	0xf

#define TPGS_SUPPORT_NONE		0x00
#define TPGS_SUPPORT_OPTIMIZED		0x01
#define TPGS_SUPPORT_NONOPTIMIZED	0x02
#define TPGS_SUPPORT_STANDBY		0x04
#define TPGS_SUPPORT_UNAVAILABLE	0x08
47
#define TPGS_SUPPORT_LBA_DEPENDENT	0x10
48 49 50
#define TPGS_SUPPORT_OFFLINE		0x40
#define TPGS_SUPPORT_TRANSITION		0x80

51 52 53
#define RTPG_FMT_MASK			0x70
#define RTPG_FMT_EXT_HDR		0x10

54 55 56 57 58 59
#define TPGS_MODE_UNINITIALIZED		 -1
#define TPGS_MODE_NONE			0x0
#define TPGS_MODE_IMPLICIT		0x1
#define TPGS_MODE_EXPLICIT		0x2

#define ALUA_INQUIRY_SIZE		36
60
#define ALUA_FAILOVER_TIMEOUT		60
61 62
#define ALUA_FAILOVER_RETRIES		5

63
/* device handler flags */
64
#define ALUA_OPTIMIZE_STPG		1
65
#define ALUA_RTPG_EXT_HDR_UNSUPP	2
66

67 68 69 70 71
struct alua_dh_data {
	int			group_id;
	int			rel_port;
	int			tpgs;
	int			state;
72
	int			pref;
73
	unsigned		flags; /* used for optimizing STPG */
74 75 76
	unsigned char		inq[ALUA_INQUIRY_SIZE];
	unsigned char		*buff;
	int			bufflen;
77
	unsigned char		transition_tmo;
78
	unsigned char		sense[SCSI_SENSE_BUFFERSIZE];
79 80 81
	struct scsi_device	*sdev;
	activate_complete	callback_fn;
	void			*callback_data;
82 83 84 85 86
};

#define ALUA_POLICY_SWITCH_CURRENT	0
#define ALUA_POLICY_SWITCH_ALL		1

87 88
static char print_alua_state(int);

89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
static int realloc_buffer(struct alua_dh_data *h, unsigned len)
{
	if (h->buff && h->buff != h->inq)
		kfree(h->buff);

	h->buff = kmalloc(len, GFP_NOIO);
	if (!h->buff) {
		h->buff = h->inq;
		h->bufflen = ALUA_INQUIRY_SIZE;
		return 1;
	}
	h->bufflen = len;
	return 0;
}

static struct request *get_alua_req(struct scsi_device *sdev,
				    void *buffer, unsigned buflen, int rw)
{
	struct request *rq;
	struct request_queue *q = sdev->request_queue;

	rq = blk_get_request(q, rw, GFP_NOIO);

112
	if (IS_ERR(rq)) {
113
		sdev_printk(KERN_INFO, sdev,
114
			    "%s: blk_get_request failed\n", __func__);
115 116
		return NULL;
	}
J
Jens Axboe 已提交
117
	blk_rq_set_block_pc(rq);
118 119 120 121

	if (buflen && blk_rq_map_kern(q, rq, buffer, buflen, GFP_NOIO)) {
		blk_put_request(rq);
		sdev_printk(KERN_INFO, sdev,
122
			    "%s: blk_rq_map_kern failed\n", __func__);
123 124 125
		return NULL;
	}

126
	rq->cmd_flags |= REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT |
127
			 REQ_FAILFAST_DRIVER;
128
	rq->retries = ALUA_FAILOVER_RETRIES;
129
	rq->timeout = ALUA_FAILOVER_TIMEOUT * HZ;
130 131 132 133 134 135 136 137

	return rq;
}

/*
 * submit_rtpg - Issue a REPORT TARGET GROUP STATES command
 * @sdev: sdev the command should be sent to
 */
138 139
static unsigned submit_rtpg(struct scsi_device *sdev, unsigned char *buff,
			    int bufflen, unsigned char *sense, int flags)
140 141
{
	struct request *rq;
142
	int err = 0;
143

144
	rq = get_alua_req(sdev, buff, bufflen, READ);
145 146
	if (!rq) {
		err = DRIVER_BUSY << 24;
147
		goto done;
148
	}
149 150 151

	/* Prepare the command. */
	rq->cmd[0] = MAINTENANCE_IN;
152
	if (!(flags & ALUA_RTPG_EXT_HDR_UNSUPP))
153 154 155
		rq->cmd[1] = MI_REPORT_TARGET_PGS | MI_EXT_HDR_PARAM_FMT;
	else
		rq->cmd[1] = MI_REPORT_TARGET_PGS;
156
	put_unaligned_be32(bufflen, &rq->cmd[6]);
157 158
	rq->cmd_len = COMMAND_SIZE(MAINTENANCE_IN);

159
	rq->sense = sense;
160
	memset(rq->sense, 0, SCSI_SENSE_BUFFERSIZE);
161
	rq->sense_len = 0;
162

163 164 165
	blk_execute_rq(rq->q, NULL, rq, 1);
	if (rq->errors)
		err = rq->errors;
166 167 168 169 170
	blk_put_request(rq);
done:
	return err;
}

171
/*
172
 * submit_stpg - Issue a SET TARGET PORT GROUP command
173 174 175 176 177
 *
 * Currently we're only setting the current target port group state
 * to 'active/optimized' and let the array firmware figure out
 * the states of the remaining groups.
 */
178 179
static unsigned submit_stpg(struct scsi_device *sdev, int group_id,
			    unsigned char *sense)
180 181
{
	struct request *rq;
182
	unsigned char stpg_data[8];
183
	int stpg_len = 8;
184
	int err = 0;
185 186

	/* Prepare the data buffer */
187 188 189
	memset(stpg_data, 0, stpg_len);
	stpg_data[4] = TPGS_STATE_OPTIMIZED & 0x0f;
	put_unaligned_be16(group_id, &stpg_data[6]);
190

191
	rq = get_alua_req(sdev, stpg_data, stpg_len, WRITE);
192
	if (!rq)
193
		return DRIVER_BUSY << 24;
194 195 196 197

	/* Prepare the command. */
	rq->cmd[0] = MAINTENANCE_OUT;
	rq->cmd[1] = MO_SET_TARGET_PGS;
198
	put_unaligned_be32(stpg_len, &rq->cmd[6]);
199 200
	rq->cmd_len = COMMAND_SIZE(MAINTENANCE_OUT);

201
	rq->sense = sense;
202
	memset(rq->sense, 0, SCSI_SENSE_BUFFERSIZE);
203
	rq->sense_len = 0;
204

205 206 207 208 209 210 211
	blk_execute_rq(rq->q, NULL, rq, 1);
	if (rq->errors)
		err = rq->errors;

	blk_put_request(rq);

	return err;
212 213 214
}

/*
215
 * alua_check_tpgs - Evaluate TPGS setting
216 217
 * @sdev: device to be checked
 *
218
 * Examine the TPGS setting of the sdev to find out if ALUA
219 220
 * is supported.
 */
221
static int alua_check_tpgs(struct scsi_device *sdev)
222
{
223
	int tpgs = TPGS_MODE_NONE;
224

225 226 227 228 229 230 231 232
	/*
	 * ALUA support for non-disk devices is fraught with
	 * difficulties, so disable it for now.
	 */
	if (sdev->type != TYPE_DISK) {
		sdev_printk(KERN_INFO, sdev,
			    "%s: disable for non-disk devices\n",
			    ALUA_DH_NAME);
233
		return tpgs;
234 235
	}

236 237
	tpgs = scsi_device_tpgs(sdev);
	switch (tpgs) {
238 239 240 241 242 243 244 245 246 247 248 249 250
	case TPGS_MODE_EXPLICIT|TPGS_MODE_IMPLICIT:
		sdev_printk(KERN_INFO, sdev,
			    "%s: supports implicit and explicit TPGS\n",
			    ALUA_DH_NAME);
		break;
	case TPGS_MODE_EXPLICIT:
		sdev_printk(KERN_INFO, sdev, "%s: supports explicit TPGS\n",
			    ALUA_DH_NAME);
		break;
	case TPGS_MODE_IMPLICIT:
		sdev_printk(KERN_INFO, sdev, "%s: supports implicit TPGS\n",
			    ALUA_DH_NAME);
		break;
H
Hannes Reinecke 已提交
251
	case TPGS_MODE_NONE:
252 253 254
		sdev_printk(KERN_INFO, sdev, "%s: not supported\n",
			    ALUA_DH_NAME);
		break;
H
Hannes Reinecke 已提交
255 256 257
	default:
		sdev_printk(KERN_INFO, sdev,
			    "%s: unsupported TPGS setting %d\n",
258 259
			    ALUA_DH_NAME, tpgs);
		tpgs = TPGS_MODE_NONE;
H
Hannes Reinecke 已提交
260
		break;
261 262
	}

263
	return tpgs;
264 265 266
}

/*
267
 * alua_check_vpd - Evaluate INQUIRY vpd page 0x83
268 269 270 271 272
 * @sdev: device to be checked
 *
 * Extract the relative target port and the target port group
 * descriptor from the list of identificators.
 */
273
static int alua_check_vpd(struct scsi_device *sdev, struct alua_dh_data *h)
274
{
275
	int rel_port = -1, group_id;
276

277 278
	group_id = scsi_vpd_tpg_id(sdev, &rel_port);
	if (group_id < 0) {
279 280 281 282 283 284 285 286
		/*
		 * Internal error; TPGS supported but required
		 * VPD identification descriptors not present.
		 * Disable ALUA support
		 */
		sdev_printk(KERN_INFO, sdev,
			    "%s: No target port descriptors found\n",
			    ALUA_DH_NAME);
287
		return SCSI_DH_DEV_UNSUPP;
288
	}
289 290 291
	h->state = TPGS_STATE_OPTIMIZED;
	h->group_id = group_id;

292 293 294
	sdev_printk(KERN_INFO, sdev,
		    "%s: port group %02x rel port %02x\n",
		    ALUA_DH_NAME, h->group_id, h->rel_port);
295

296
	return 0;
297 298 299 300 301 302 303 304 305 306 307 308 309
}

static char print_alua_state(int state)
{
	switch (state) {
	case TPGS_STATE_OPTIMIZED:
		return 'A';
	case TPGS_STATE_NONOPTIMIZED:
		return 'N';
	case TPGS_STATE_STANDBY:
		return 'S';
	case TPGS_STATE_UNAVAILABLE:
		return 'U';
310 311
	case TPGS_STATE_LBA_DEPENDENT:
		return 'L';
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
	case TPGS_STATE_OFFLINE:
		return 'O';
	case TPGS_STATE_TRANSITIONING:
		return 'T';
	default:
		return 'X';
	}
}

static int alua_check_sense(struct scsi_device *sdev,
			    struct scsi_sense_hdr *sense_hdr)
{
	switch (sense_hdr->sense_key) {
	case NOT_READY:
		if (sense_hdr->asc == 0x04 && sense_hdr->ascq == 0x0a)
			/*
			 * LUN Not Accessible - ALUA state transition
			 */
330
			return ADD_TO_MLQUEUE;
331 332 333 334 335 336
		break;
	case UNIT_ATTENTION:
		if (sense_hdr->asc == 0x29 && sense_hdr->ascq == 0x00)
			/*
			 * Power On, Reset, or Bus Device Reset, just retry.
			 */
337
			return ADD_TO_MLQUEUE;
338 339 340 341 342
		if (sense_hdr->asc == 0x29 && sense_hdr->ascq == 0x04)
			/*
			 * Device internal reset
			 */
			return ADD_TO_MLQUEUE;
343 344 345 346 347
		if (sense_hdr->asc == 0x2a && sense_hdr->ascq == 0x01)
			/*
			 * Mode Parameters Changed
			 */
			return ADD_TO_MLQUEUE;
348
		if (sense_hdr->asc == 0x2a && sense_hdr->ascq == 0x06)
349 350 351
			/*
			 * ALUA state changed
			 */
352
			return ADD_TO_MLQUEUE;
353
		if (sense_hdr->asc == 0x2a && sense_hdr->ascq == 0x07)
354 355 356
			/*
			 * Implicit ALUA state transition failed
			 */
357
			return ADD_TO_MLQUEUE;
358 359 360 361 362 363
		if (sense_hdr->asc == 0x3f && sense_hdr->ascq == 0x03)
			/*
			 * Inquiry data has changed
			 */
			return ADD_TO_MLQUEUE;
		if (sense_hdr->asc == 0x3f && sense_hdr->ascq == 0x0e)
364 365 366 367 368 369
			/*
			 * REPORTED_LUNS_DATA_HAS_CHANGED is reported
			 * when switching controllers on targets like
			 * Intel Multi-Flex. We can just retry.
			 */
			return ADD_TO_MLQUEUE;
370 371 372 373 374 375 376 377 378
		break;
	}

	return SCSI_RETURN_NOT_HANDLED;
}

/*
 * alua_rtpg - Evaluate REPORT TARGET GROUP STATES
 * @sdev: the device to be evaluated.
379
 * @wait_for_transition: if nonzero, wait ALUA_FAILOVER_TIMEOUT seconds for device to exit transitioning state
380 381 382
 *
 * Evaluate the Target Port Group State.
 * Returns SCSI_DH_DEV_OFFLINED if the path is
L
Lucas De Marchi 已提交
383
 * found to be unusable.
384
 */
385
static int alua_rtpg(struct scsi_device *sdev, struct alua_dh_data *h, int wait_for_transition)
386 387 388
{
	struct scsi_sense_hdr sense_hdr;
	int len, k, off, valid_states = 0;
389
	unsigned char *ucp;
390
	unsigned err, retval;
391
	unsigned long expiry, interval = 0;
392 393 394 395 396 397 398
	unsigned int tpg_desc_tbl_off;
	unsigned char orig_transition_tmo;

	if (!h->transition_tmo)
		expiry = round_jiffies_up(jiffies + ALUA_FAILOVER_TIMEOUT * HZ);
	else
		expiry = round_jiffies_up(jiffies + h->transition_tmo * HZ);
399 400

 retry:
401
	retval = submit_rtpg(sdev, h->buff, h->bufflen, h->sense, h->flags);
402
	if (retval) {
403
		if (!scsi_normalize_sense(h->sense, SCSI_SENSE_BUFFERSIZE,
404 405 406 407 408 409
					  &sense_hdr)) {
			sdev_printk(KERN_INFO, sdev,
				    "%s: rtpg failed, result %d\n",
				    ALUA_DH_NAME, retval);
			if (driver_byte(retval) == DRIVER_BUSY)
				return SCSI_DH_DEV_TEMP_BUSY;
410
			return SCSI_DH_IO;
411
		}
412

413 414 415 416 417 418 419 420
		/*
		 * submit_rtpg() has failed on existing arrays
		 * when requesting extended header info, and
		 * the array doesn't support extended headers,
		 * even though it shouldn't according to T10.
		 * The retry without rtpg_ext_hdr_req set
		 * handles this.
		 */
421
		if (!(h->flags & ALUA_RTPG_EXT_HDR_UNSUPP) &&
422 423
		    sense_hdr.sense_key == ILLEGAL_REQUEST &&
		    sense_hdr.asc == 0x24 && sense_hdr.ascq == 0) {
424
			h->flags |= ALUA_RTPG_EXT_HDR_UNSUPP;
425 426
			goto retry;
		}
427 428 429 430 431 432 433 434 435 436
		/*
		 * Retry on ALUA state transition or if any
		 * UNIT ATTENTION occurred.
		 */
		if (sense_hdr.sense_key == NOT_READY &&
		    sense_hdr.asc == 0x04 && sense_hdr.ascq == 0x0a)
			err = SCSI_DH_RETRY;
		else if (sense_hdr.sense_key == UNIT_ATTENTION)
			err = SCSI_DH_RETRY;
		if (err == SCSI_DH_RETRY && time_before(jiffies, expiry)) {
437 438 439
			sdev_printk(KERN_ERR, sdev, "%s: rtpg retry\n",
				    ALUA_DH_NAME);
			scsi_print_sense_hdr(sdev, ALUA_DH_NAME, &sense_hdr);
440
			goto retry;
441 442 443 444 445
		}
		sdev_printk(KERN_ERR, sdev, "%s: rtpg failed\n",
			    ALUA_DH_NAME);
		scsi_print_sense_hdr(sdev, ALUA_DH_NAME, &sense_hdr);
		return SCSI_DH_IO;
446 447
	}

448
	len = get_unaligned_be32(&h->buff[0]) + 4;
449 450 451 452 453

	if (len > h->bufflen) {
		/* Resubmit with the correct length */
		if (realloc_buffer(h, len)) {
			sdev_printk(KERN_WARNING, sdev,
454
				    "%s: kmalloc buffer failed\n",__func__);
455 456 457 458 459 460
			/* Temporary failure, bypass */
			return SCSI_DH_DEV_TEMP_BUSY;
		}
		goto retry;
	}

461 462 463 464 465 466
	orig_transition_tmo = h->transition_tmo;
	if ((h->buff[4] & RTPG_FMT_MASK) == RTPG_FMT_EXT_HDR && h->buff[5] != 0)
		h->transition_tmo = h->buff[5];
	else
		h->transition_tmo = ALUA_FAILOVER_TIMEOUT;

467
	if (wait_for_transition && (orig_transition_tmo != h->transition_tmo)) {
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
		sdev_printk(KERN_INFO, sdev,
			    "%s: transition timeout set to %d seconds\n",
			    ALUA_DH_NAME, h->transition_tmo);
		expiry = jiffies + h->transition_tmo * HZ;
	}

	if ((h->buff[4] & RTPG_FMT_MASK) == RTPG_FMT_EXT_HDR)
		tpg_desc_tbl_off = 8;
	else
		tpg_desc_tbl_off = 4;

	for (k = tpg_desc_tbl_off, ucp = h->buff + tpg_desc_tbl_off;
	     k < len;
	     k += off, ucp += off) {

483
		if (h->group_id == get_unaligned_be16(&ucp[2])) {
484
			h->state = ucp[0] & 0x0f;
485
			h->pref = ucp[0] >> 7;
486 487 488 489 490 491
			valid_states = ucp[1];
		}
		off = 8 + (ucp[7] * 4);
	}

	sdev_printk(KERN_INFO, sdev,
492
		    "%s: port group %02x state %c %s supports %c%c%c%c%c%c%c\n",
493
		    ALUA_DH_NAME, h->group_id, print_alua_state(h->state),
494
		    h->pref ? "preferred" : "non-preferred",
495 496
		    valid_states&TPGS_SUPPORT_TRANSITION?'T':'t',
		    valid_states&TPGS_SUPPORT_OFFLINE?'O':'o',
497
		    valid_states&TPGS_SUPPORT_LBA_DEPENDENT?'L':'l',
498 499 500 501 502
		    valid_states&TPGS_SUPPORT_UNAVAILABLE?'U':'u',
		    valid_states&TPGS_SUPPORT_STANDBY?'S':'s',
		    valid_states&TPGS_SUPPORT_NONOPTIMIZED?'N':'n',
		    valid_states&TPGS_SUPPORT_OPTIMIZED?'A':'a');

503 504
	switch (h->state) {
	case TPGS_STATE_TRANSITIONING:
505 506 507 508 509 510 511 512 513 514
		if (wait_for_transition) {
			if (time_before(jiffies, expiry)) {
				/* State transition, retry */
				interval += 2000;
				msleep(interval);
				goto retry;
			}
			err = SCSI_DH_RETRY;
		} else {
			err = SCSI_DH_OK;
515
		}
516

517 518 519 520
		/* Transitioning time exceeded, set port to standby */
		h->state = TPGS_STATE_STANDBY;
		break;
	case TPGS_STATE_OFFLINE:
521
		/* Path unusable */
522 523 524 525 526 527
		err = SCSI_DH_DEV_OFFLINED;
		break;
	default:
		/* Useable path if active */
		err = SCSI_DH_OK;
		break;
528 529 530 531
	}
	return err;
}

532 533 534 535
/*
 * alua_stpg - Issue a SET TARGET PORT GROUP command
 *
 * Issue a SET TARGET PORT GROUP command and evaluate the
536 537 538
 * response. Returns SCSI_DH_RETRY per default to trigger
 * a re-evaluation of the target group state or SCSI_DH_OK
 * if no further action needs to be taken.
539
 */
540
static unsigned alua_stpg(struct scsi_device *sdev, struct alua_dh_data *h)
541
{
542 543
	int retval;
	struct scsi_sense_hdr sense_hdr;
544

545 546 547 548
	if (!(h->tpgs & TPGS_MODE_EXPLICIT)) {
		/* Only implicit ALUA supported, retry */
		return SCSI_DH_RETRY;
	}
549
	switch (h->state) {
550 551
	case TPGS_STATE_OPTIMIZED:
		return SCSI_DH_OK;
552 553 554 555
	case TPGS_STATE_NONOPTIMIZED:
		if ((h->flags & ALUA_OPTIMIZE_STPG) &&
		    !h->pref &&
		    (h->tpgs & TPGS_MODE_IMPLICIT))
556
			return SCSI_DH_OK;
557 558 559 560 561
		break;
	case TPGS_STATE_STANDBY:
	case TPGS_STATE_UNAVAILABLE:
		break;
	case TPGS_STATE_OFFLINE:
562
		return SCSI_DH_IO;
563 564 565
	case TPGS_STATE_TRANSITIONING:
		break;
	default:
566 567 568 569
		sdev_printk(KERN_INFO, sdev,
			    "%s: stpg failed, unhandled TPGS state %d",
			    ALUA_DH_NAME, h->state);
		return SCSI_DH_NOSYS;
570
	}
571
	retval = submit_stpg(sdev, h->group_id, h->sense);
572

573 574 575 576 577 578 579 580 581 582 583 584 585
	if (retval) {
		if (!scsi_normalize_sense(h->sense, SCSI_SENSE_BUFFERSIZE,
					  &sense_hdr)) {
			sdev_printk(KERN_INFO, sdev,
				    "%s: stpg failed, result %d",
				    ALUA_DH_NAME, retval);
			if (driver_byte(retval) == DRIVER_BUSY)
				return SCSI_DH_DEV_TEMP_BUSY;
		} else {
			sdev_printk(KERN_INFO, h->sdev, "%s: stpg failed\n",
				    ALUA_DH_NAME);
			scsi_print_sense_hdr(sdev, ALUA_DH_NAME, &sense_hdr);
		}
586
	}
587 588
	/* Retry RTPG */
	return SCSI_DH_RETRY;
589 590
}

591 592 593 594 595 596 597 598 599
/*
 * alua_initialize - Initialize ALUA state
 * @sdev: the device to be initialized
 *
 * For the prep_fn to work correctly we have
 * to initialize the ALUA state for the device.
 */
static int alua_initialize(struct scsi_device *sdev, struct alua_dh_data *h)
{
600
	int err = SCSI_DH_DEV_UNSUPP;
601

602 603
	h->tpgs = alua_check_tpgs(sdev);
	if (h->tpgs == TPGS_MODE_NONE)
604 605
		goto out;

606
	err = alua_check_vpd(sdev, h);
607 608 609
	if (err != SCSI_DH_OK)
		goto out;

610
	err = alua_rtpg(sdev, h, 0);
611 612 613 614 615 616
	if (err != SCSI_DH_OK)
		goto out;

out:
	return err;
}
617 618 619 620 621 622 623 624 625 626 627
/*
 * alua_set_params - set/unset the optimize flag
 * @sdev: device on the path to be activated
 * params - parameters in the following format
 *      "no_of_params\0param1\0param2\0param3\0...\0"
 * For example, to set the flag pass the following parameters
 * from multipath.conf
 *     hardware_handler        "2 alua 1"
 */
static int alua_set_params(struct scsi_device *sdev, const char *params)
{
628
	struct alua_dh_data *h = sdev->handler_data;
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
	unsigned int optimize = 0, argc;
	const char *p = params;
	int result = SCSI_DH_OK;

	if ((sscanf(params, "%u", &argc) != 1) || (argc != 1))
		return -EINVAL;

	while (*p++)
		;
	if ((sscanf(p, "%u", &optimize) != 1) || (optimize > 1))
		return -EINVAL;

	if (optimize)
		h->flags |= ALUA_OPTIMIZE_STPG;
	else
		h->flags &= ~ALUA_OPTIMIZE_STPG;

	return result;
}
648

649 650 651 652
static uint optimize_stpg;
module_param(optimize_stpg, uint, S_IRUGO|S_IWUSR);
MODULE_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.");

653 654 655 656 657 658 659 660 661 662
/*
 * alua_activate - activate a path
 * @sdev: device on the path to be activated
 *
 * We're currently switching the port group to be activated only and
 * let the array figure out the rest.
 * There may be other arrays which require us to switch all port groups
 * based on a certain policy. But until we actually encounter them it
 * should be okay.
 */
663 664
static int alua_activate(struct scsi_device *sdev,
			activate_complete fn, void *data)
665
{
666
	struct alua_dh_data *h = sdev->handler_data;
667 668
	int err = SCSI_DH_OK;

669
	err = alua_rtpg(sdev, h, 1);
670 671
	if (err != SCSI_DH_OK)
		goto out;
672

673 674 675
	if (optimize_stpg)
		h->flags |= ALUA_OPTIMIZE_STPG;

676
	err = alua_stpg(sdev, h);
677
out:
678
	if (fn)
679 680
		fn(data, err);
	return 0;
681 682 683 684 685 686 687 688 689 690
}

/*
 * alua_prep_fn - request callback
 *
 * Fail I/O to all paths not in state
 * active/optimized or active/non-optimized.
 */
static int alua_prep_fn(struct scsi_device *sdev, struct request *req)
{
691
	struct alua_dh_data *h = sdev->handler_data;
692 693
	int ret = BLKPREP_OK;

694 695 696 697 698
	if (h->state == TPGS_STATE_TRANSITIONING)
		ret = BLKPREP_DEFER;
	else if (h->state != TPGS_STATE_OPTIMIZED &&
		 h->state != TPGS_STATE_NONOPTIMIZED &&
		 h->state != TPGS_STATE_LBA_DEPENDENT) {
699 700 701 702 703 704 705 706 707 708 709
		ret = BLKPREP_KILL;
		req->cmd_flags |= REQ_QUIET;
	}
	return ret;

}

/*
 * alua_bus_attach - Attach device handler
 * @sdev: device to be attached to
 */
710
static int alua_bus_attach(struct scsi_device *sdev)
711 712
{
	struct alua_dh_data *h;
713
	int err;
714

715
	h = kzalloc(sizeof(*h) , GFP_KERNEL);
716
	if (!h)
717
		return -ENOMEM;
718 719 720 721 722 723
	h->tpgs = TPGS_MODE_UNINITIALIZED;
	h->state = TPGS_STATE_OPTIMIZED;
	h->group_id = -1;
	h->rel_port = -1;
	h->buff = h->inq;
	h->bufflen = ALUA_INQUIRY_SIZE;
724
	h->sdev = sdev;
725 726

	err = alua_initialize(sdev, h);
727
	if (err != SCSI_DH_OK && err != SCSI_DH_DEV_OFFLINED)
728 729
		goto failed;

730 731
	sdev->handler_data = h;
	return 0;
732
failed:
733
	kfree(h);
734
	return -EINVAL;
735 736 737 738 739 740 741 742
}

/*
 * alua_bus_detach - Detach device handler
 * @sdev: device to be detached from
 */
static void alua_bus_detach(struct scsi_device *sdev)
{
743
	struct alua_dh_data *h = sdev->handler_data;
744 745 746

	if (h->buff && h->inq != h->buff)
		kfree(h->buff);
747
	sdev->handler_data = NULL;
748
	kfree(h);
749 750
}

751 752 753 754 755 756 757 758 759 760 761
static struct scsi_device_handler alua_dh = {
	.name = ALUA_DH_NAME,
	.module = THIS_MODULE,
	.attach = alua_bus_attach,
	.detach = alua_bus_detach,
	.prep_fn = alua_prep_fn,
	.check_sense = alua_check_sense,
	.activate = alua_activate,
	.set_params = alua_set_params,
};

762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
static int __init alua_init(void)
{
	int r;

	r = scsi_register_device_handler(&alua_dh);
	if (r != 0)
		printk(KERN_ERR "%s: Failed to register scsi device handler",
			ALUA_DH_NAME);
	return r;
}

static void __exit alua_exit(void)
{
	scsi_unregister_device_handler(&alua_dh);
}

module_init(alua_init);
module_exit(alua_exit);

MODULE_DESCRIPTION("DM Multipath ALUA support");
MODULE_AUTHOR("Hannes Reinecke <hare@suse.de>");
MODULE_LICENSE("GPL");
MODULE_VERSION(ALUA_DH_VER);