Loading...
1/*
2 * Generic SCSI-3 ALUA SCSI Device Handler
3 *
4 * Copyright (C) 2007-2010 Hannes Reinecke, SUSE Linux Products GmbH.
5 * 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 */
22#include <linux/slab.h>
23#include <linux/delay.h>
24#include <scsi/scsi.h>
25#include <scsi/scsi_eh.h>
26#include <scsi/scsi_dh.h>
27
28#define ALUA_DH_NAME "alua"
29#define ALUA_DH_VER "1.3"
30
31#define TPGS_STATE_OPTIMIZED 0x0
32#define TPGS_STATE_NONOPTIMIZED 0x1
33#define TPGS_STATE_STANDBY 0x2
34#define TPGS_STATE_UNAVAILABLE 0x3
35#define TPGS_STATE_LBA_DEPENDENT 0x4
36#define TPGS_STATE_OFFLINE 0xe
37#define TPGS_STATE_TRANSITIONING 0xf
38
39#define TPGS_SUPPORT_NONE 0x00
40#define TPGS_SUPPORT_OPTIMIZED 0x01
41#define TPGS_SUPPORT_NONOPTIMIZED 0x02
42#define TPGS_SUPPORT_STANDBY 0x04
43#define TPGS_SUPPORT_UNAVAILABLE 0x08
44#define TPGS_SUPPORT_LBA_DEPENDENT 0x10
45#define TPGS_SUPPORT_OFFLINE 0x40
46#define TPGS_SUPPORT_TRANSITION 0x80
47
48#define TPGS_MODE_UNINITIALIZED -1
49#define TPGS_MODE_NONE 0x0
50#define TPGS_MODE_IMPLICIT 0x1
51#define TPGS_MODE_EXPLICIT 0x2
52
53#define ALUA_INQUIRY_SIZE 36
54#define ALUA_FAILOVER_TIMEOUT (60 * HZ)
55#define ALUA_FAILOVER_RETRIES 5
56
57struct alua_dh_data {
58 int group_id;
59 int rel_port;
60 int tpgs;
61 int state;
62 unsigned char inq[ALUA_INQUIRY_SIZE];
63 unsigned char *buff;
64 int bufflen;
65 unsigned char sense[SCSI_SENSE_BUFFERSIZE];
66 int senselen;
67 struct scsi_device *sdev;
68 activate_complete callback_fn;
69 void *callback_data;
70};
71
72#define ALUA_POLICY_SWITCH_CURRENT 0
73#define ALUA_POLICY_SWITCH_ALL 1
74
75static char print_alua_state(int);
76static int alua_check_sense(struct scsi_device *, struct scsi_sense_hdr *);
77
78static inline struct alua_dh_data *get_alua_data(struct scsi_device *sdev)
79{
80 struct scsi_dh_data *scsi_dh_data = sdev->scsi_dh_data;
81 BUG_ON(scsi_dh_data == NULL);
82 return ((struct alua_dh_data *) scsi_dh_data->buf);
83}
84
85static int realloc_buffer(struct alua_dh_data *h, unsigned len)
86{
87 if (h->buff && h->buff != h->inq)
88 kfree(h->buff);
89
90 h->buff = kmalloc(len, GFP_NOIO);
91 if (!h->buff) {
92 h->buff = h->inq;
93 h->bufflen = ALUA_INQUIRY_SIZE;
94 return 1;
95 }
96 h->bufflen = len;
97 return 0;
98}
99
100static struct request *get_alua_req(struct scsi_device *sdev,
101 void *buffer, unsigned buflen, int rw)
102{
103 struct request *rq;
104 struct request_queue *q = sdev->request_queue;
105
106 rq = blk_get_request(q, rw, GFP_NOIO);
107
108 if (!rq) {
109 sdev_printk(KERN_INFO, sdev,
110 "%s: blk_get_request failed\n", __func__);
111 return NULL;
112 }
113
114 if (buflen && blk_rq_map_kern(q, rq, buffer, buflen, GFP_NOIO)) {
115 blk_put_request(rq);
116 sdev_printk(KERN_INFO, sdev,
117 "%s: blk_rq_map_kern failed\n", __func__);
118 return NULL;
119 }
120
121 rq->cmd_type = REQ_TYPE_BLOCK_PC;
122 rq->cmd_flags |= REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT |
123 REQ_FAILFAST_DRIVER;
124 rq->retries = ALUA_FAILOVER_RETRIES;
125 rq->timeout = ALUA_FAILOVER_TIMEOUT;
126
127 return rq;
128}
129
130/*
131 * submit_std_inquiry - Issue a standard INQUIRY command
132 * @sdev: sdev the command should be send to
133 */
134static int submit_std_inquiry(struct scsi_device *sdev, struct alua_dh_data *h)
135{
136 struct request *rq;
137 int err = SCSI_DH_RES_TEMP_UNAVAIL;
138
139 rq = get_alua_req(sdev, h->inq, ALUA_INQUIRY_SIZE, READ);
140 if (!rq)
141 goto done;
142
143 /* Prepare the command. */
144 rq->cmd[0] = INQUIRY;
145 rq->cmd[1] = 0;
146 rq->cmd[2] = 0;
147 rq->cmd[4] = ALUA_INQUIRY_SIZE;
148 rq->cmd_len = COMMAND_SIZE(INQUIRY);
149
150 rq->sense = h->sense;
151 memset(rq->sense, 0, SCSI_SENSE_BUFFERSIZE);
152 rq->sense_len = h->senselen = 0;
153
154 err = blk_execute_rq(rq->q, NULL, rq, 1);
155 if (err == -EIO) {
156 sdev_printk(KERN_INFO, sdev,
157 "%s: std inquiry failed with %x\n",
158 ALUA_DH_NAME, rq->errors);
159 h->senselen = rq->sense_len;
160 err = SCSI_DH_IO;
161 }
162 blk_put_request(rq);
163done:
164 return err;
165}
166
167/*
168 * submit_vpd_inquiry - Issue an INQUIRY VPD page 0x83 command
169 * @sdev: sdev the command should be sent to
170 */
171static int submit_vpd_inquiry(struct scsi_device *sdev, struct alua_dh_data *h)
172{
173 struct request *rq;
174 int err = SCSI_DH_RES_TEMP_UNAVAIL;
175
176 rq = get_alua_req(sdev, h->buff, h->bufflen, READ);
177 if (!rq)
178 goto done;
179
180 /* Prepare the command. */
181 rq->cmd[0] = INQUIRY;
182 rq->cmd[1] = 1;
183 rq->cmd[2] = 0x83;
184 rq->cmd[4] = h->bufflen;
185 rq->cmd_len = COMMAND_SIZE(INQUIRY);
186
187 rq->sense = h->sense;
188 memset(rq->sense, 0, SCSI_SENSE_BUFFERSIZE);
189 rq->sense_len = h->senselen = 0;
190
191 err = blk_execute_rq(rq->q, NULL, rq, 1);
192 if (err == -EIO) {
193 sdev_printk(KERN_INFO, sdev,
194 "%s: evpd inquiry failed with %x\n",
195 ALUA_DH_NAME, rq->errors);
196 h->senselen = rq->sense_len;
197 err = SCSI_DH_IO;
198 }
199 blk_put_request(rq);
200done:
201 return err;
202}
203
204/*
205 * submit_rtpg - Issue a REPORT TARGET GROUP STATES command
206 * @sdev: sdev the command should be sent to
207 */
208static unsigned submit_rtpg(struct scsi_device *sdev, struct alua_dh_data *h)
209{
210 struct request *rq;
211 int err = SCSI_DH_RES_TEMP_UNAVAIL;
212
213 rq = get_alua_req(sdev, h->buff, h->bufflen, READ);
214 if (!rq)
215 goto done;
216
217 /* Prepare the command. */
218 rq->cmd[0] = MAINTENANCE_IN;
219 rq->cmd[1] = MI_REPORT_TARGET_PGS;
220 rq->cmd[6] = (h->bufflen >> 24) & 0xff;
221 rq->cmd[7] = (h->bufflen >> 16) & 0xff;
222 rq->cmd[8] = (h->bufflen >> 8) & 0xff;
223 rq->cmd[9] = h->bufflen & 0xff;
224 rq->cmd_len = COMMAND_SIZE(MAINTENANCE_IN);
225
226 rq->sense = h->sense;
227 memset(rq->sense, 0, SCSI_SENSE_BUFFERSIZE);
228 rq->sense_len = h->senselen = 0;
229
230 err = blk_execute_rq(rq->q, NULL, rq, 1);
231 if (err == -EIO) {
232 sdev_printk(KERN_INFO, sdev,
233 "%s: rtpg failed with %x\n",
234 ALUA_DH_NAME, rq->errors);
235 h->senselen = rq->sense_len;
236 err = SCSI_DH_IO;
237 }
238 blk_put_request(rq);
239done:
240 return err;
241}
242
243/*
244 * alua_stpg - Evaluate SET TARGET GROUP STATES
245 * @sdev: the device to be evaluated
246 * @state: the new target group state
247 *
248 * Send a SET TARGET GROUP STATES command to the device.
249 * We only have to test here if we should resubmit the command;
250 * any other error is assumed as a failure.
251 */
252static void stpg_endio(struct request *req, int error)
253{
254 struct alua_dh_data *h = req->end_io_data;
255 struct scsi_sense_hdr sense_hdr;
256 unsigned err = SCSI_DH_OK;
257
258 if (error || host_byte(req->errors) != DID_OK ||
259 msg_byte(req->errors) != COMMAND_COMPLETE) {
260 err = SCSI_DH_IO;
261 goto done;
262 }
263
264 if (h->senselen > 0) {
265 err = scsi_normalize_sense(h->sense, SCSI_SENSE_BUFFERSIZE,
266 &sense_hdr);
267 if (!err) {
268 err = SCSI_DH_IO;
269 goto done;
270 }
271 err = alua_check_sense(h->sdev, &sense_hdr);
272 if (err == ADD_TO_MLQUEUE) {
273 err = SCSI_DH_RETRY;
274 goto done;
275 }
276 sdev_printk(KERN_INFO, h->sdev,
277 "%s: stpg sense code: %02x/%02x/%02x\n",
278 ALUA_DH_NAME, sense_hdr.sense_key,
279 sense_hdr.asc, sense_hdr.ascq);
280 err = SCSI_DH_IO;
281 }
282 if (err == SCSI_DH_OK) {
283 h->state = TPGS_STATE_OPTIMIZED;
284 sdev_printk(KERN_INFO, h->sdev,
285 "%s: port group %02x switched to state %c\n",
286 ALUA_DH_NAME, h->group_id,
287 print_alua_state(h->state));
288 }
289done:
290 req->end_io_data = NULL;
291 __blk_put_request(req->q, req);
292 if (h->callback_fn) {
293 h->callback_fn(h->callback_data, err);
294 h->callback_fn = h->callback_data = NULL;
295 }
296 return;
297}
298
299/*
300 * submit_stpg - Issue a SET TARGET GROUP STATES command
301 *
302 * Currently we're only setting the current target port group state
303 * to 'active/optimized' and let the array firmware figure out
304 * the states of the remaining groups.
305 */
306static unsigned submit_stpg(struct alua_dh_data *h)
307{
308 struct request *rq;
309 int stpg_len = 8;
310 struct scsi_device *sdev = h->sdev;
311
312 /* Prepare the data buffer */
313 memset(h->buff, 0, stpg_len);
314 h->buff[4] = TPGS_STATE_OPTIMIZED & 0x0f;
315 h->buff[6] = (h->group_id >> 8) & 0xff;
316 h->buff[7] = h->group_id & 0xff;
317
318 rq = get_alua_req(sdev, h->buff, stpg_len, WRITE);
319 if (!rq)
320 return SCSI_DH_RES_TEMP_UNAVAIL;
321
322 /* Prepare the command. */
323 rq->cmd[0] = MAINTENANCE_OUT;
324 rq->cmd[1] = MO_SET_TARGET_PGS;
325 rq->cmd[6] = (stpg_len >> 24) & 0xff;
326 rq->cmd[7] = (stpg_len >> 16) & 0xff;
327 rq->cmd[8] = (stpg_len >> 8) & 0xff;
328 rq->cmd[9] = stpg_len & 0xff;
329 rq->cmd_len = COMMAND_SIZE(MAINTENANCE_OUT);
330
331 rq->sense = h->sense;
332 memset(rq->sense, 0, SCSI_SENSE_BUFFERSIZE);
333 rq->sense_len = h->senselen = 0;
334 rq->end_io_data = h;
335
336 blk_execute_rq_nowait(rq->q, NULL, rq, 1, stpg_endio);
337 return SCSI_DH_OK;
338}
339
340/*
341 * alua_std_inquiry - Evaluate standard INQUIRY command
342 * @sdev: device to be checked
343 *
344 * Just extract the TPGS setting to find out if ALUA
345 * is supported.
346 */
347static int alua_std_inquiry(struct scsi_device *sdev, struct alua_dh_data *h)
348{
349 int err;
350
351 err = submit_std_inquiry(sdev, h);
352
353 if (err != SCSI_DH_OK)
354 return err;
355
356 /* Check TPGS setting */
357 h->tpgs = (h->inq[5] >> 4) & 0x3;
358 switch (h->tpgs) {
359 case TPGS_MODE_EXPLICIT|TPGS_MODE_IMPLICIT:
360 sdev_printk(KERN_INFO, sdev,
361 "%s: supports implicit and explicit TPGS\n",
362 ALUA_DH_NAME);
363 break;
364 case TPGS_MODE_EXPLICIT:
365 sdev_printk(KERN_INFO, sdev, "%s: supports explicit TPGS\n",
366 ALUA_DH_NAME);
367 break;
368 case TPGS_MODE_IMPLICIT:
369 sdev_printk(KERN_INFO, sdev, "%s: supports implicit TPGS\n",
370 ALUA_DH_NAME);
371 break;
372 default:
373 h->tpgs = TPGS_MODE_NONE;
374 sdev_printk(KERN_INFO, sdev, "%s: not supported\n",
375 ALUA_DH_NAME);
376 err = SCSI_DH_DEV_UNSUPP;
377 break;
378 }
379
380 return err;
381}
382
383/*
384 * alua_vpd_inquiry - Evaluate INQUIRY vpd page 0x83
385 * @sdev: device to be checked
386 *
387 * Extract the relative target port and the target port group
388 * descriptor from the list of identificators.
389 */
390static int alua_vpd_inquiry(struct scsi_device *sdev, struct alua_dh_data *h)
391{
392 int len;
393 unsigned err;
394 unsigned char *d;
395
396 retry:
397 err = submit_vpd_inquiry(sdev, h);
398
399 if (err != SCSI_DH_OK)
400 return err;
401
402 /* Check if vpd page exceeds initial buffer */
403 len = (h->buff[2] << 8) + h->buff[3] + 4;
404 if (len > h->bufflen) {
405 /* Resubmit with the correct length */
406 if (realloc_buffer(h, len)) {
407 sdev_printk(KERN_WARNING, sdev,
408 "%s: kmalloc buffer failed\n",
409 ALUA_DH_NAME);
410 /* Temporary failure, bypass */
411 return SCSI_DH_DEV_TEMP_BUSY;
412 }
413 goto retry;
414 }
415
416 /*
417 * Now look for the correct descriptor.
418 */
419 d = h->buff + 4;
420 while (d < h->buff + len) {
421 switch (d[1] & 0xf) {
422 case 0x4:
423 /* Relative target port */
424 h->rel_port = (d[6] << 8) + d[7];
425 break;
426 case 0x5:
427 /* Target port group */
428 h->group_id = (d[6] << 8) + d[7];
429 break;
430 default:
431 break;
432 }
433 d += d[3] + 4;
434 }
435
436 if (h->group_id == -1) {
437 /*
438 * Internal error; TPGS supported but required
439 * VPD identification descriptors not present.
440 * Disable ALUA support
441 */
442 sdev_printk(KERN_INFO, sdev,
443 "%s: No target port descriptors found\n",
444 ALUA_DH_NAME);
445 h->state = TPGS_STATE_OPTIMIZED;
446 h->tpgs = TPGS_MODE_NONE;
447 err = SCSI_DH_DEV_UNSUPP;
448 } else {
449 sdev_printk(KERN_INFO, sdev,
450 "%s: port group %02x rel port %02x\n",
451 ALUA_DH_NAME, h->group_id, h->rel_port);
452 }
453
454 return err;
455}
456
457static char print_alua_state(int state)
458{
459 switch (state) {
460 case TPGS_STATE_OPTIMIZED:
461 return 'A';
462 case TPGS_STATE_NONOPTIMIZED:
463 return 'N';
464 case TPGS_STATE_STANDBY:
465 return 'S';
466 case TPGS_STATE_UNAVAILABLE:
467 return 'U';
468 case TPGS_STATE_LBA_DEPENDENT:
469 return 'L';
470 case TPGS_STATE_OFFLINE:
471 return 'O';
472 case TPGS_STATE_TRANSITIONING:
473 return 'T';
474 default:
475 return 'X';
476 }
477}
478
479static int alua_check_sense(struct scsi_device *sdev,
480 struct scsi_sense_hdr *sense_hdr)
481{
482 switch (sense_hdr->sense_key) {
483 case NOT_READY:
484 if (sense_hdr->asc == 0x04 && sense_hdr->ascq == 0x0a)
485 /*
486 * LUN Not Accessible - ALUA state transition
487 */
488 return ADD_TO_MLQUEUE;
489 if (sense_hdr->asc == 0x04 && sense_hdr->ascq == 0x0b)
490 /*
491 * LUN Not Accessible -- Target port in standby state
492 */
493 return SUCCESS;
494 if (sense_hdr->asc == 0x04 && sense_hdr->ascq == 0x0c)
495 /*
496 * LUN Not Accessible -- Target port in unavailable state
497 */
498 return SUCCESS;
499 if (sense_hdr->asc == 0x04 && sense_hdr->ascq == 0x12)
500 /*
501 * LUN Not Ready -- Offline
502 */
503 return SUCCESS;
504 break;
505 case UNIT_ATTENTION:
506 if (sense_hdr->asc == 0x29 && sense_hdr->ascq == 0x00)
507 /*
508 * Power On, Reset, or Bus Device Reset, just retry.
509 */
510 return ADD_TO_MLQUEUE;
511 if (sense_hdr->asc == 0x2a && sense_hdr->ascq == 0x06) {
512 /*
513 * ALUA state changed
514 */
515 return ADD_TO_MLQUEUE;
516 }
517 if (sense_hdr->asc == 0x2a && sense_hdr->ascq == 0x07) {
518 /*
519 * Implicit ALUA state transition failed
520 */
521 return ADD_TO_MLQUEUE;
522 }
523 if (sense_hdr->asc == 0x3f && sense_hdr->ascq == 0x0e) {
524 /*
525 * REPORTED_LUNS_DATA_HAS_CHANGED is reported
526 * when switching controllers on targets like
527 * Intel Multi-Flex. We can just retry.
528 */
529 return ADD_TO_MLQUEUE;
530 }
531
532 break;
533 }
534
535 return SCSI_RETURN_NOT_HANDLED;
536}
537
538/*
539 * alua_rtpg - Evaluate REPORT TARGET GROUP STATES
540 * @sdev: the device to be evaluated.
541 *
542 * Evaluate the Target Port Group State.
543 * Returns SCSI_DH_DEV_OFFLINED if the path is
544 * found to be unusable.
545 */
546static int alua_rtpg(struct scsi_device *sdev, struct alua_dh_data *h)
547{
548 struct scsi_sense_hdr sense_hdr;
549 int len, k, off, valid_states = 0;
550 char *ucp;
551 unsigned err;
552 unsigned long expiry, interval = 10;
553
554 expiry = round_jiffies_up(jiffies + ALUA_FAILOVER_TIMEOUT);
555 retry:
556 err = submit_rtpg(sdev, h);
557
558 if (err == SCSI_DH_IO && h->senselen > 0) {
559 err = scsi_normalize_sense(h->sense, SCSI_SENSE_BUFFERSIZE,
560 &sense_hdr);
561 if (!err)
562 return SCSI_DH_IO;
563
564 err = alua_check_sense(sdev, &sense_hdr);
565 if (err == ADD_TO_MLQUEUE && time_before(jiffies, expiry))
566 goto retry;
567 sdev_printk(KERN_INFO, sdev,
568 "%s: rtpg sense code %02x/%02x/%02x\n",
569 ALUA_DH_NAME, sense_hdr.sense_key,
570 sense_hdr.asc, sense_hdr.ascq);
571 err = SCSI_DH_IO;
572 }
573 if (err != SCSI_DH_OK)
574 return err;
575
576 len = (h->buff[0] << 24) + (h->buff[1] << 16) +
577 (h->buff[2] << 8) + h->buff[3] + 4;
578
579 if (len > h->bufflen) {
580 /* Resubmit with the correct length */
581 if (realloc_buffer(h, len)) {
582 sdev_printk(KERN_WARNING, sdev,
583 "%s: kmalloc buffer failed\n",__func__);
584 /* Temporary failure, bypass */
585 return SCSI_DH_DEV_TEMP_BUSY;
586 }
587 goto retry;
588 }
589
590 for (k = 4, ucp = h->buff + 4; k < len; k += off, ucp += off) {
591 if (h->group_id == (ucp[2] << 8) + ucp[3]) {
592 h->state = ucp[0] & 0x0f;
593 valid_states = ucp[1];
594 }
595 off = 8 + (ucp[7] * 4);
596 }
597
598 sdev_printk(KERN_INFO, sdev,
599 "%s: port group %02x state %c supports %c%c%c%c%c%c%c\n",
600 ALUA_DH_NAME, h->group_id, print_alua_state(h->state),
601 valid_states&TPGS_SUPPORT_TRANSITION?'T':'t',
602 valid_states&TPGS_SUPPORT_OFFLINE?'O':'o',
603 valid_states&TPGS_SUPPORT_LBA_DEPENDENT?'L':'l',
604 valid_states&TPGS_SUPPORT_UNAVAILABLE?'U':'u',
605 valid_states&TPGS_SUPPORT_STANDBY?'S':'s',
606 valid_states&TPGS_SUPPORT_NONOPTIMIZED?'N':'n',
607 valid_states&TPGS_SUPPORT_OPTIMIZED?'A':'a');
608
609 switch (h->state) {
610 case TPGS_STATE_TRANSITIONING:
611 if (time_before(jiffies, expiry)) {
612 /* State transition, retry */
613 interval *= 10;
614 msleep(interval);
615 goto retry;
616 }
617 /* Transitioning time exceeded, set port to standby */
618 err = SCSI_DH_RETRY;
619 h->state = TPGS_STATE_STANDBY;
620 break;
621 case TPGS_STATE_OFFLINE:
622 case TPGS_STATE_UNAVAILABLE:
623 /* Path unusable for unavailable/offline */
624 err = SCSI_DH_DEV_OFFLINED;
625 break;
626 default:
627 /* Useable path if active */
628 err = SCSI_DH_OK;
629 break;
630 }
631 return err;
632}
633
634/*
635 * alua_initialize - Initialize ALUA state
636 * @sdev: the device to be initialized
637 *
638 * For the prep_fn to work correctly we have
639 * to initialize the ALUA state for the device.
640 */
641static int alua_initialize(struct scsi_device *sdev, struct alua_dh_data *h)
642{
643 int err;
644
645 err = alua_std_inquiry(sdev, h);
646 if (err != SCSI_DH_OK)
647 goto out;
648
649 err = alua_vpd_inquiry(sdev, h);
650 if (err != SCSI_DH_OK)
651 goto out;
652
653 err = alua_rtpg(sdev, h);
654 if (err != SCSI_DH_OK)
655 goto out;
656
657out:
658 return err;
659}
660
661/*
662 * alua_activate - activate a path
663 * @sdev: device on the path to be activated
664 *
665 * We're currently switching the port group to be activated only and
666 * let the array figure out the rest.
667 * There may be other arrays which require us to switch all port groups
668 * based on a certain policy. But until we actually encounter them it
669 * should be okay.
670 */
671static int alua_activate(struct scsi_device *sdev,
672 activate_complete fn, void *data)
673{
674 struct alua_dh_data *h = get_alua_data(sdev);
675 int err = SCSI_DH_OK;
676
677 if (h->group_id != -1) {
678 err = alua_rtpg(sdev, h);
679 if (err != SCSI_DH_OK)
680 goto out;
681 }
682
683 if (h->tpgs & TPGS_MODE_EXPLICIT &&
684 h->state != TPGS_STATE_OPTIMIZED &&
685 h->state != TPGS_STATE_LBA_DEPENDENT) {
686 h->callback_fn = fn;
687 h->callback_data = data;
688 err = submit_stpg(h);
689 if (err == SCSI_DH_OK)
690 return 0;
691 h->callback_fn = h->callback_data = NULL;
692 }
693
694out:
695 if (fn)
696 fn(data, err);
697 return 0;
698}
699
700/*
701 * alua_prep_fn - request callback
702 *
703 * Fail I/O to all paths not in state
704 * active/optimized or active/non-optimized.
705 */
706static int alua_prep_fn(struct scsi_device *sdev, struct request *req)
707{
708 struct alua_dh_data *h = get_alua_data(sdev);
709 int ret = BLKPREP_OK;
710
711 if (h->state == TPGS_STATE_TRANSITIONING)
712 ret = BLKPREP_DEFER;
713 else if (h->state != TPGS_STATE_OPTIMIZED &&
714 h->state != TPGS_STATE_NONOPTIMIZED &&
715 h->state != TPGS_STATE_LBA_DEPENDENT) {
716 ret = BLKPREP_KILL;
717 req->cmd_flags |= REQ_QUIET;
718 }
719 return ret;
720
721}
722
723static const struct scsi_dh_devlist alua_dev_list[] = {
724 {"HP", "MSA VOLUME" },
725 {"HP", "HSV101" },
726 {"HP", "HSV111" },
727 {"HP", "HSV200" },
728 {"HP", "HSV210" },
729 {"HP", "HSV300" },
730 {"IBM", "2107900" },
731 {"IBM", "2145" },
732 {"Pillar", "Axiom" },
733 {"Intel", "Multi-Flex"},
734 {"NETAPP", "LUN"},
735 {"NETAPP", "LUN C-Mode"},
736 {"AIX", "NVDISK"},
737 {"Promise", "VTrak"},
738 {NULL, NULL}
739};
740
741static int alua_bus_attach(struct scsi_device *sdev);
742static void alua_bus_detach(struct scsi_device *sdev);
743
744static struct scsi_device_handler alua_dh = {
745 .name = ALUA_DH_NAME,
746 .module = THIS_MODULE,
747 .devlist = alua_dev_list,
748 .attach = alua_bus_attach,
749 .detach = alua_bus_detach,
750 .prep_fn = alua_prep_fn,
751 .check_sense = alua_check_sense,
752 .activate = alua_activate,
753};
754
755/*
756 * alua_bus_attach - Attach device handler
757 * @sdev: device to be attached to
758 */
759static int alua_bus_attach(struct scsi_device *sdev)
760{
761 struct scsi_dh_data *scsi_dh_data;
762 struct alua_dh_data *h;
763 unsigned long flags;
764 int err = SCSI_DH_OK;
765
766 scsi_dh_data = kzalloc(sizeof(*scsi_dh_data)
767 + sizeof(*h) , GFP_KERNEL);
768 if (!scsi_dh_data) {
769 sdev_printk(KERN_ERR, sdev, "%s: Attach failed\n",
770 ALUA_DH_NAME);
771 return -ENOMEM;
772 }
773
774 scsi_dh_data->scsi_dh = &alua_dh;
775 h = (struct alua_dh_data *) scsi_dh_data->buf;
776 h->tpgs = TPGS_MODE_UNINITIALIZED;
777 h->state = TPGS_STATE_OPTIMIZED;
778 h->group_id = -1;
779 h->rel_port = -1;
780 h->buff = h->inq;
781 h->bufflen = ALUA_INQUIRY_SIZE;
782 h->sdev = sdev;
783
784 err = alua_initialize(sdev, h);
785 if ((err != SCSI_DH_OK) && (err != SCSI_DH_DEV_OFFLINED))
786 goto failed;
787
788 if (!try_module_get(THIS_MODULE))
789 goto failed;
790
791 spin_lock_irqsave(sdev->request_queue->queue_lock, flags);
792 sdev->scsi_dh_data = scsi_dh_data;
793 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
794
795 return 0;
796
797failed:
798 kfree(scsi_dh_data);
799 sdev_printk(KERN_ERR, sdev, "%s: not attached\n", ALUA_DH_NAME);
800 return -EINVAL;
801}
802
803/*
804 * alua_bus_detach - Detach device handler
805 * @sdev: device to be detached from
806 */
807static void alua_bus_detach(struct scsi_device *sdev)
808{
809 struct scsi_dh_data *scsi_dh_data;
810 struct alua_dh_data *h;
811 unsigned long flags;
812
813 spin_lock_irqsave(sdev->request_queue->queue_lock, flags);
814 scsi_dh_data = sdev->scsi_dh_data;
815 sdev->scsi_dh_data = NULL;
816 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
817
818 h = (struct alua_dh_data *) scsi_dh_data->buf;
819 if (h->buff && h->inq != h->buff)
820 kfree(h->buff);
821 kfree(scsi_dh_data);
822 module_put(THIS_MODULE);
823 sdev_printk(KERN_NOTICE, sdev, "%s: Detached\n", ALUA_DH_NAME);
824}
825
826static int __init alua_init(void)
827{
828 int r;
829
830 r = scsi_register_device_handler(&alua_dh);
831 if (r != 0)
832 printk(KERN_ERR "%s: Failed to register scsi device handler",
833 ALUA_DH_NAME);
834 return r;
835}
836
837static void __exit alua_exit(void)
838{
839 scsi_unregister_device_handler(&alua_dh);
840}
841
842module_init(alua_init);
843module_exit(alua_exit);
844
845MODULE_DESCRIPTION("DM Multipath ALUA support");
846MODULE_AUTHOR("Hannes Reinecke <hare@suse.de>");
847MODULE_LICENSE("GPL");
848MODULE_VERSION(ALUA_DH_VER);
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Generic SCSI-3 ALUA SCSI Device Handler
4 *
5 * Copyright (C) 2007-2010 Hannes Reinecke, SUSE Linux Products GmbH.
6 * All rights reserved.
7 */
8#include <linux/slab.h>
9#include <linux/delay.h>
10#include <linux/module.h>
11#include <asm/unaligned.h>
12#include <scsi/scsi.h>
13#include <scsi/scsi_proto.h>
14#include <scsi/scsi_dbg.h>
15#include <scsi/scsi_eh.h>
16#include <scsi/scsi_dh.h>
17
18#define ALUA_DH_NAME "alua"
19#define ALUA_DH_VER "2.0"
20
21#define TPGS_SUPPORT_NONE 0x00
22#define TPGS_SUPPORT_OPTIMIZED 0x01
23#define TPGS_SUPPORT_NONOPTIMIZED 0x02
24#define TPGS_SUPPORT_STANDBY 0x04
25#define TPGS_SUPPORT_UNAVAILABLE 0x08
26#define TPGS_SUPPORT_LBA_DEPENDENT 0x10
27#define TPGS_SUPPORT_OFFLINE 0x40
28#define TPGS_SUPPORT_TRANSITION 0x80
29#define TPGS_SUPPORT_ALL 0xdf
30
31#define RTPG_FMT_MASK 0x70
32#define RTPG_FMT_EXT_HDR 0x10
33
34#define TPGS_MODE_UNINITIALIZED -1
35#define TPGS_MODE_NONE 0x0
36#define TPGS_MODE_IMPLICIT 0x1
37#define TPGS_MODE_EXPLICIT 0x2
38
39#define ALUA_RTPG_SIZE 128
40#define ALUA_FAILOVER_TIMEOUT 60
41#define ALUA_FAILOVER_RETRIES 5
42#define ALUA_RTPG_DELAY_MSECS 5
43#define ALUA_RTPG_RETRY_DELAY 2
44
45/* device handler flags */
46#define ALUA_OPTIMIZE_STPG 0x01
47#define ALUA_RTPG_EXT_HDR_UNSUPP 0x02
48/* State machine flags */
49#define ALUA_PG_RUN_RTPG 0x10
50#define ALUA_PG_RUN_STPG 0x20
51#define ALUA_PG_RUNNING 0x40
52
53static uint optimize_stpg;
54module_param(optimize_stpg, uint, S_IRUGO|S_IWUSR);
55MODULE_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.");
56
57static LIST_HEAD(port_group_list);
58static DEFINE_SPINLOCK(port_group_lock);
59static struct workqueue_struct *kaluad_wq;
60
61struct alua_port_group {
62 struct kref kref;
63 struct rcu_head rcu;
64 struct list_head node;
65 struct list_head dh_list;
66 unsigned char device_id_str[256];
67 int device_id_len;
68 int group_id;
69 int tpgs;
70 int state;
71 int pref;
72 int valid_states;
73 unsigned flags; /* used for optimizing STPG */
74 unsigned char transition_tmo;
75 unsigned long expiry;
76 unsigned long interval;
77 struct delayed_work rtpg_work;
78 spinlock_t lock;
79 struct list_head rtpg_list;
80 struct scsi_device *rtpg_sdev;
81};
82
83struct alua_dh_data {
84 struct list_head node;
85 struct alua_port_group __rcu *pg;
86 int group_id;
87 spinlock_t pg_lock;
88 struct scsi_device *sdev;
89 int init_error;
90 struct mutex init_mutex;
91 bool disabled;
92};
93
94struct alua_queue_data {
95 struct list_head entry;
96 activate_complete callback_fn;
97 void *callback_data;
98};
99
100#define ALUA_POLICY_SWITCH_CURRENT 0
101#define ALUA_POLICY_SWITCH_ALL 1
102
103static void alua_rtpg_work(struct work_struct *work);
104static bool alua_rtpg_queue(struct alua_port_group *pg,
105 struct scsi_device *sdev,
106 struct alua_queue_data *qdata, bool force);
107static void alua_check(struct scsi_device *sdev, bool force);
108
109static void release_port_group(struct kref *kref)
110{
111 struct alua_port_group *pg;
112
113 pg = container_of(kref, struct alua_port_group, kref);
114 if (pg->rtpg_sdev)
115 flush_delayed_work(&pg->rtpg_work);
116 spin_lock(&port_group_lock);
117 list_del(&pg->node);
118 spin_unlock(&port_group_lock);
119 kfree_rcu(pg, rcu);
120}
121
122/*
123 * submit_rtpg - Issue a REPORT TARGET GROUP STATES command
124 * @sdev: sdev the command should be sent to
125 */
126static int submit_rtpg(struct scsi_device *sdev, unsigned char *buff,
127 int bufflen, struct scsi_sense_hdr *sshdr, int flags)
128{
129 u8 cdb[MAX_COMMAND_SIZE];
130 blk_opf_t opf = REQ_OP_DRV_IN | REQ_FAILFAST_DEV |
131 REQ_FAILFAST_TRANSPORT | REQ_FAILFAST_DRIVER;
132 const struct scsi_exec_args exec_args = {
133 .sshdr = sshdr,
134 };
135
136 /* Prepare the command. */
137 memset(cdb, 0x0, MAX_COMMAND_SIZE);
138 cdb[0] = MAINTENANCE_IN;
139 if (!(flags & ALUA_RTPG_EXT_HDR_UNSUPP))
140 cdb[1] = MI_REPORT_TARGET_PGS | MI_EXT_HDR_PARAM_FMT;
141 else
142 cdb[1] = MI_REPORT_TARGET_PGS;
143 put_unaligned_be32(bufflen, &cdb[6]);
144
145 return scsi_execute_cmd(sdev, cdb, opf, buff, bufflen,
146 ALUA_FAILOVER_TIMEOUT * HZ,
147 ALUA_FAILOVER_RETRIES, &exec_args);
148}
149
150/*
151 * submit_stpg - Issue a SET TARGET PORT GROUP command
152 *
153 * Currently we're only setting the current target port group state
154 * to 'active/optimized' and let the array firmware figure out
155 * the states of the remaining groups.
156 */
157static int submit_stpg(struct scsi_device *sdev, int group_id,
158 struct scsi_sense_hdr *sshdr)
159{
160 u8 cdb[MAX_COMMAND_SIZE];
161 unsigned char stpg_data[8];
162 int stpg_len = 8;
163 blk_opf_t opf = REQ_OP_DRV_OUT | REQ_FAILFAST_DEV |
164 REQ_FAILFAST_TRANSPORT | REQ_FAILFAST_DRIVER;
165 const struct scsi_exec_args exec_args = {
166 .sshdr = sshdr,
167 };
168
169 /* Prepare the data buffer */
170 memset(stpg_data, 0, stpg_len);
171 stpg_data[4] = SCSI_ACCESS_STATE_OPTIMAL;
172 put_unaligned_be16(group_id, &stpg_data[6]);
173
174 /* Prepare the command. */
175 memset(cdb, 0x0, MAX_COMMAND_SIZE);
176 cdb[0] = MAINTENANCE_OUT;
177 cdb[1] = MO_SET_TARGET_PGS;
178 put_unaligned_be32(stpg_len, &cdb[6]);
179
180 return scsi_execute_cmd(sdev, cdb, opf, stpg_data,
181 stpg_len, ALUA_FAILOVER_TIMEOUT * HZ,
182 ALUA_FAILOVER_RETRIES, &exec_args);
183}
184
185static struct alua_port_group *alua_find_get_pg(char *id_str, size_t id_size,
186 int group_id)
187{
188 struct alua_port_group *pg;
189
190 if (!id_str || !id_size || !strlen(id_str))
191 return NULL;
192
193 list_for_each_entry(pg, &port_group_list, node) {
194 if (pg->group_id != group_id)
195 continue;
196 if (!pg->device_id_len || pg->device_id_len != id_size)
197 continue;
198 if (strncmp(pg->device_id_str, id_str, id_size))
199 continue;
200 if (!kref_get_unless_zero(&pg->kref))
201 continue;
202 return pg;
203 }
204
205 return NULL;
206}
207
208/*
209 * alua_alloc_pg - Allocate a new port_group structure
210 * @sdev: scsi device
211 * @group_id: port group id
212 * @tpgs: target port group settings
213 *
214 * Allocate a new port_group structure for a given
215 * device.
216 */
217static struct alua_port_group *alua_alloc_pg(struct scsi_device *sdev,
218 int group_id, int tpgs)
219{
220 struct alua_port_group *pg, *tmp_pg;
221
222 pg = kzalloc(sizeof(struct alua_port_group), GFP_KERNEL);
223 if (!pg)
224 return ERR_PTR(-ENOMEM);
225
226 pg->device_id_len = scsi_vpd_lun_id(sdev, pg->device_id_str,
227 sizeof(pg->device_id_str));
228 if (pg->device_id_len <= 0) {
229 /*
230 * TPGS supported but no device identification found.
231 * Generate private device identification.
232 */
233 sdev_printk(KERN_INFO, sdev,
234 "%s: No device descriptors found\n",
235 ALUA_DH_NAME);
236 pg->device_id_str[0] = '\0';
237 pg->device_id_len = 0;
238 }
239 pg->group_id = group_id;
240 pg->tpgs = tpgs;
241 pg->state = SCSI_ACCESS_STATE_OPTIMAL;
242 pg->valid_states = TPGS_SUPPORT_ALL;
243 if (optimize_stpg)
244 pg->flags |= ALUA_OPTIMIZE_STPG;
245 kref_init(&pg->kref);
246 INIT_DELAYED_WORK(&pg->rtpg_work, alua_rtpg_work);
247 INIT_LIST_HEAD(&pg->rtpg_list);
248 INIT_LIST_HEAD(&pg->node);
249 INIT_LIST_HEAD(&pg->dh_list);
250 spin_lock_init(&pg->lock);
251
252 spin_lock(&port_group_lock);
253 tmp_pg = alua_find_get_pg(pg->device_id_str, pg->device_id_len,
254 group_id);
255 if (tmp_pg) {
256 spin_unlock(&port_group_lock);
257 kfree(pg);
258 return tmp_pg;
259 }
260
261 list_add(&pg->node, &port_group_list);
262 spin_unlock(&port_group_lock);
263
264 return pg;
265}
266
267/*
268 * alua_check_tpgs - Evaluate TPGS setting
269 * @sdev: device to be checked
270 *
271 * Examine the TPGS setting of the sdev to find out if ALUA
272 * is supported.
273 */
274static int alua_check_tpgs(struct scsi_device *sdev)
275{
276 int tpgs = TPGS_MODE_NONE;
277
278 /*
279 * ALUA support for non-disk devices is fraught with
280 * difficulties, so disable it for now.
281 */
282 if (sdev->type != TYPE_DISK) {
283 sdev_printk(KERN_INFO, sdev,
284 "%s: disable for non-disk devices\n",
285 ALUA_DH_NAME);
286 return tpgs;
287 }
288
289 tpgs = scsi_device_tpgs(sdev);
290 switch (tpgs) {
291 case TPGS_MODE_EXPLICIT|TPGS_MODE_IMPLICIT:
292 sdev_printk(KERN_INFO, sdev,
293 "%s: supports implicit and explicit TPGS\n",
294 ALUA_DH_NAME);
295 break;
296 case TPGS_MODE_EXPLICIT:
297 sdev_printk(KERN_INFO, sdev, "%s: supports explicit TPGS\n",
298 ALUA_DH_NAME);
299 break;
300 case TPGS_MODE_IMPLICIT:
301 sdev_printk(KERN_INFO, sdev, "%s: supports implicit TPGS\n",
302 ALUA_DH_NAME);
303 break;
304 case TPGS_MODE_NONE:
305 sdev_printk(KERN_INFO, sdev, "%s: not supported\n",
306 ALUA_DH_NAME);
307 break;
308 default:
309 sdev_printk(KERN_INFO, sdev,
310 "%s: unsupported TPGS setting %d\n",
311 ALUA_DH_NAME, tpgs);
312 tpgs = TPGS_MODE_NONE;
313 break;
314 }
315
316 return tpgs;
317}
318
319/*
320 * alua_check_vpd - Evaluate INQUIRY vpd page 0x83
321 * @sdev: device to be checked
322 *
323 * Extract the relative target port and the target port group
324 * descriptor from the list of identificators.
325 */
326static int alua_check_vpd(struct scsi_device *sdev, struct alua_dh_data *h,
327 int tpgs)
328{
329 int rel_port = -1, group_id;
330 struct alua_port_group *pg, *old_pg = NULL;
331 bool pg_updated = false;
332 unsigned long flags;
333
334 group_id = scsi_vpd_tpg_id(sdev, &rel_port);
335 if (group_id < 0) {
336 /*
337 * Internal error; TPGS supported but required
338 * VPD identification descriptors not present.
339 * Disable ALUA support
340 */
341 sdev_printk(KERN_INFO, sdev,
342 "%s: No target port descriptors found\n",
343 ALUA_DH_NAME);
344 return SCSI_DH_DEV_UNSUPP;
345 }
346
347 pg = alua_alloc_pg(sdev, group_id, tpgs);
348 if (IS_ERR(pg)) {
349 if (PTR_ERR(pg) == -ENOMEM)
350 return SCSI_DH_NOMEM;
351 return SCSI_DH_DEV_UNSUPP;
352 }
353 if (pg->device_id_len)
354 sdev_printk(KERN_INFO, sdev,
355 "%s: device %s port group %x rel port %x\n",
356 ALUA_DH_NAME, pg->device_id_str,
357 group_id, rel_port);
358 else
359 sdev_printk(KERN_INFO, sdev,
360 "%s: port group %x rel port %x\n",
361 ALUA_DH_NAME, group_id, rel_port);
362
363 kref_get(&pg->kref);
364
365 /* Check for existing port group references */
366 spin_lock(&h->pg_lock);
367 old_pg = rcu_dereference_protected(h->pg, lockdep_is_held(&h->pg_lock));
368 if (old_pg != pg) {
369 /* port group has changed. Update to new port group */
370 if (h->pg) {
371 spin_lock_irqsave(&old_pg->lock, flags);
372 list_del_rcu(&h->node);
373 spin_unlock_irqrestore(&old_pg->lock, flags);
374 }
375 rcu_assign_pointer(h->pg, pg);
376 pg_updated = true;
377 }
378
379 spin_lock_irqsave(&pg->lock, flags);
380 if (pg_updated)
381 list_add_rcu(&h->node, &pg->dh_list);
382 spin_unlock_irqrestore(&pg->lock, flags);
383
384 spin_unlock(&h->pg_lock);
385
386 alua_rtpg_queue(pg, sdev, NULL, true);
387 kref_put(&pg->kref, release_port_group);
388
389 if (old_pg)
390 kref_put(&old_pg->kref, release_port_group);
391
392 return SCSI_DH_OK;
393}
394
395static char print_alua_state(unsigned char state)
396{
397 switch (state) {
398 case SCSI_ACCESS_STATE_OPTIMAL:
399 return 'A';
400 case SCSI_ACCESS_STATE_ACTIVE:
401 return 'N';
402 case SCSI_ACCESS_STATE_STANDBY:
403 return 'S';
404 case SCSI_ACCESS_STATE_UNAVAILABLE:
405 return 'U';
406 case SCSI_ACCESS_STATE_LBA:
407 return 'L';
408 case SCSI_ACCESS_STATE_OFFLINE:
409 return 'O';
410 case SCSI_ACCESS_STATE_TRANSITIONING:
411 return 'T';
412 default:
413 return 'X';
414 }
415}
416
417static enum scsi_disposition alua_check_sense(struct scsi_device *sdev,
418 struct scsi_sense_hdr *sense_hdr)
419{
420 struct alua_dh_data *h = sdev->handler_data;
421 struct alua_port_group *pg;
422
423 switch (sense_hdr->sense_key) {
424 case NOT_READY:
425 if (sense_hdr->asc == 0x04 && sense_hdr->ascq == 0x0a) {
426 /*
427 * LUN Not Accessible - ALUA state transition
428 */
429 rcu_read_lock();
430 pg = rcu_dereference(h->pg);
431 if (pg)
432 pg->state = SCSI_ACCESS_STATE_TRANSITIONING;
433 rcu_read_unlock();
434 alua_check(sdev, false);
435 return NEEDS_RETRY;
436 }
437 break;
438 case UNIT_ATTENTION:
439 if (sense_hdr->asc == 0x29 && sense_hdr->ascq == 0x00) {
440 /*
441 * Power On, Reset, or Bus Device Reset.
442 * Might have obscured a state transition,
443 * so schedule a recheck.
444 */
445 alua_check(sdev, true);
446 return ADD_TO_MLQUEUE;
447 }
448 if (sense_hdr->asc == 0x29 && sense_hdr->ascq == 0x04)
449 /*
450 * Device internal reset
451 */
452 return ADD_TO_MLQUEUE;
453 if (sense_hdr->asc == 0x2a && sense_hdr->ascq == 0x01)
454 /*
455 * Mode Parameters Changed
456 */
457 return ADD_TO_MLQUEUE;
458 if (sense_hdr->asc == 0x2a && sense_hdr->ascq == 0x06) {
459 /*
460 * ALUA state changed
461 */
462 alua_check(sdev, true);
463 return ADD_TO_MLQUEUE;
464 }
465 if (sense_hdr->asc == 0x2a && sense_hdr->ascq == 0x07) {
466 /*
467 * Implicit ALUA state transition failed
468 */
469 alua_check(sdev, true);
470 return ADD_TO_MLQUEUE;
471 }
472 if (sense_hdr->asc == 0x3f && sense_hdr->ascq == 0x03)
473 /*
474 * Inquiry data has changed
475 */
476 return ADD_TO_MLQUEUE;
477 if (sense_hdr->asc == 0x3f && sense_hdr->ascq == 0x0e)
478 /*
479 * REPORTED_LUNS_DATA_HAS_CHANGED is reported
480 * when switching controllers on targets like
481 * Intel Multi-Flex. We can just retry.
482 */
483 return ADD_TO_MLQUEUE;
484 break;
485 }
486
487 return SCSI_RETURN_NOT_HANDLED;
488}
489
490/*
491 * alua_tur - Send a TEST UNIT READY
492 * @sdev: device to which the TEST UNIT READY command should be send
493 *
494 * Send a TEST UNIT READY to @sdev to figure out the device state
495 * Returns SCSI_DH_RETRY if the sense code is NOT READY/ALUA TRANSITIONING,
496 * SCSI_DH_OK if no error occurred, and SCSI_DH_IO otherwise.
497 */
498static int alua_tur(struct scsi_device *sdev)
499{
500 struct scsi_sense_hdr sense_hdr;
501 int retval;
502
503 retval = scsi_test_unit_ready(sdev, ALUA_FAILOVER_TIMEOUT * HZ,
504 ALUA_FAILOVER_RETRIES, &sense_hdr);
505 if (sense_hdr.sense_key == NOT_READY &&
506 sense_hdr.asc == 0x04 && sense_hdr.ascq == 0x0a)
507 return SCSI_DH_RETRY;
508 else if (retval)
509 return SCSI_DH_IO;
510 else
511 return SCSI_DH_OK;
512}
513
514/*
515 * alua_rtpg - Evaluate REPORT TARGET GROUP STATES
516 * @sdev: the device to be evaluated.
517 *
518 * Evaluate the Target Port Group State.
519 * Returns SCSI_DH_DEV_OFFLINED if the path is
520 * found to be unusable.
521 */
522static int alua_rtpg(struct scsi_device *sdev, struct alua_port_group *pg)
523{
524 struct scsi_sense_hdr sense_hdr;
525 struct alua_port_group *tmp_pg;
526 int len, k, off, bufflen = ALUA_RTPG_SIZE;
527 int group_id_old, state_old, pref_old, valid_states_old;
528 unsigned char *desc, *buff;
529 unsigned err;
530 int retval;
531 unsigned int tpg_desc_tbl_off;
532 unsigned char orig_transition_tmo;
533 unsigned long flags;
534 bool transitioning_sense = false;
535
536 group_id_old = pg->group_id;
537 state_old = pg->state;
538 pref_old = pg->pref;
539 valid_states_old = pg->valid_states;
540
541 if (!pg->expiry) {
542 unsigned long transition_tmo = ALUA_FAILOVER_TIMEOUT * HZ;
543
544 if (pg->transition_tmo)
545 transition_tmo = pg->transition_tmo * HZ;
546
547 pg->expiry = round_jiffies_up(jiffies + transition_tmo);
548 }
549
550 buff = kzalloc(bufflen, GFP_KERNEL);
551 if (!buff)
552 return SCSI_DH_DEV_TEMP_BUSY;
553
554 retry:
555 err = 0;
556 retval = submit_rtpg(sdev, buff, bufflen, &sense_hdr, pg->flags);
557
558 if (retval) {
559 /*
560 * Some (broken) implementations have a habit of returning
561 * an error during things like firmware update etc.
562 * But if the target only supports active/optimized there's
563 * not much we can do; it's not that we can switch paths
564 * or anything.
565 * So ignore any errors to avoid spurious failures during
566 * path failover.
567 */
568 if ((pg->valid_states & ~TPGS_SUPPORT_OPTIMIZED) == 0) {
569 sdev_printk(KERN_INFO, sdev,
570 "%s: ignoring rtpg result %d\n",
571 ALUA_DH_NAME, retval);
572 kfree(buff);
573 return SCSI_DH_OK;
574 }
575 if (retval < 0 || !scsi_sense_valid(&sense_hdr)) {
576 sdev_printk(KERN_INFO, sdev,
577 "%s: rtpg failed, result %d\n",
578 ALUA_DH_NAME, retval);
579 kfree(buff);
580 if (retval < 0)
581 return SCSI_DH_DEV_TEMP_BUSY;
582 if (host_byte(retval) == DID_NO_CONNECT)
583 return SCSI_DH_RES_TEMP_UNAVAIL;
584 return SCSI_DH_IO;
585 }
586
587 /*
588 * submit_rtpg() has failed on existing arrays
589 * when requesting extended header info, and
590 * the array doesn't support extended headers,
591 * even though it shouldn't according to T10.
592 * The retry without rtpg_ext_hdr_req set
593 * handles this.
594 * Note: some arrays return a sense key of ILLEGAL_REQUEST
595 * with ASC 00h if they don't support the extended header.
596 */
597 if (!(pg->flags & ALUA_RTPG_EXT_HDR_UNSUPP) &&
598 sense_hdr.sense_key == ILLEGAL_REQUEST) {
599 pg->flags |= ALUA_RTPG_EXT_HDR_UNSUPP;
600 goto retry;
601 }
602 /*
603 * If the array returns with 'ALUA state transition'
604 * sense code here it cannot return RTPG data during
605 * transition. So set the state to 'transitioning' directly.
606 */
607 if (sense_hdr.sense_key == NOT_READY &&
608 sense_hdr.asc == 0x04 && sense_hdr.ascq == 0x0a) {
609 transitioning_sense = true;
610 goto skip_rtpg;
611 }
612 /*
613 * Retry on any other UNIT ATTENTION occurred.
614 */
615 if (sense_hdr.sense_key == UNIT_ATTENTION)
616 err = SCSI_DH_RETRY;
617 if (err == SCSI_DH_RETRY &&
618 pg->expiry != 0 && time_before(jiffies, pg->expiry)) {
619 sdev_printk(KERN_ERR, sdev, "%s: rtpg retry\n",
620 ALUA_DH_NAME);
621 scsi_print_sense_hdr(sdev, ALUA_DH_NAME, &sense_hdr);
622 kfree(buff);
623 return err;
624 }
625 sdev_printk(KERN_ERR, sdev, "%s: rtpg failed\n",
626 ALUA_DH_NAME);
627 scsi_print_sense_hdr(sdev, ALUA_DH_NAME, &sense_hdr);
628 kfree(buff);
629 pg->expiry = 0;
630 return SCSI_DH_IO;
631 }
632
633 len = get_unaligned_be32(&buff[0]) + 4;
634
635 if (len > bufflen) {
636 /* Resubmit with the correct length */
637 kfree(buff);
638 bufflen = len;
639 buff = kmalloc(bufflen, GFP_KERNEL);
640 if (!buff) {
641 sdev_printk(KERN_WARNING, sdev,
642 "%s: kmalloc buffer failed\n",__func__);
643 /* Temporary failure, bypass */
644 pg->expiry = 0;
645 return SCSI_DH_DEV_TEMP_BUSY;
646 }
647 goto retry;
648 }
649
650 orig_transition_tmo = pg->transition_tmo;
651 if ((buff[4] & RTPG_FMT_MASK) == RTPG_FMT_EXT_HDR && buff[5] != 0)
652 pg->transition_tmo = buff[5];
653 else
654 pg->transition_tmo = ALUA_FAILOVER_TIMEOUT;
655
656 if (orig_transition_tmo != pg->transition_tmo) {
657 sdev_printk(KERN_INFO, sdev,
658 "%s: transition timeout set to %d seconds\n",
659 ALUA_DH_NAME, pg->transition_tmo);
660 pg->expiry = jiffies + pg->transition_tmo * HZ;
661 }
662
663 if ((buff[4] & RTPG_FMT_MASK) == RTPG_FMT_EXT_HDR)
664 tpg_desc_tbl_off = 8;
665 else
666 tpg_desc_tbl_off = 4;
667
668 for (k = tpg_desc_tbl_off, desc = buff + tpg_desc_tbl_off;
669 k < len;
670 k += off, desc += off) {
671 u16 group_id = get_unaligned_be16(&desc[2]);
672
673 spin_lock_irqsave(&port_group_lock, flags);
674 tmp_pg = alua_find_get_pg(pg->device_id_str, pg->device_id_len,
675 group_id);
676 spin_unlock_irqrestore(&port_group_lock, flags);
677 if (tmp_pg) {
678 if (spin_trylock_irqsave(&tmp_pg->lock, flags)) {
679 if ((tmp_pg == pg) ||
680 !(tmp_pg->flags & ALUA_PG_RUNNING)) {
681 struct alua_dh_data *h;
682
683 tmp_pg->state = desc[0] & 0x0f;
684 tmp_pg->pref = desc[0] >> 7;
685 rcu_read_lock();
686 list_for_each_entry_rcu(h,
687 &tmp_pg->dh_list, node) {
688 if (!h->sdev)
689 continue;
690 h->sdev->access_state = desc[0];
691 }
692 rcu_read_unlock();
693 }
694 if (tmp_pg == pg)
695 tmp_pg->valid_states = desc[1];
696 spin_unlock_irqrestore(&tmp_pg->lock, flags);
697 }
698 kref_put(&tmp_pg->kref, release_port_group);
699 }
700 off = 8 + (desc[7] * 4);
701 }
702
703 skip_rtpg:
704 spin_lock_irqsave(&pg->lock, flags);
705 if (transitioning_sense)
706 pg->state = SCSI_ACCESS_STATE_TRANSITIONING;
707
708 if (group_id_old != pg->group_id || state_old != pg->state ||
709 pref_old != pg->pref || valid_states_old != pg->valid_states)
710 sdev_printk(KERN_INFO, sdev,
711 "%s: port group %02x state %c %s supports %c%c%c%c%c%c%c\n",
712 ALUA_DH_NAME, pg->group_id, print_alua_state(pg->state),
713 pg->pref ? "preferred" : "non-preferred",
714 pg->valid_states&TPGS_SUPPORT_TRANSITION?'T':'t',
715 pg->valid_states&TPGS_SUPPORT_OFFLINE?'O':'o',
716 pg->valid_states&TPGS_SUPPORT_LBA_DEPENDENT?'L':'l',
717 pg->valid_states&TPGS_SUPPORT_UNAVAILABLE?'U':'u',
718 pg->valid_states&TPGS_SUPPORT_STANDBY?'S':'s',
719 pg->valid_states&TPGS_SUPPORT_NONOPTIMIZED?'N':'n',
720 pg->valid_states&TPGS_SUPPORT_OPTIMIZED?'A':'a');
721
722 switch (pg->state) {
723 case SCSI_ACCESS_STATE_TRANSITIONING:
724 if (time_before(jiffies, pg->expiry)) {
725 /* State transition, retry */
726 pg->interval = ALUA_RTPG_RETRY_DELAY;
727 err = SCSI_DH_RETRY;
728 } else {
729 struct alua_dh_data *h;
730
731 /* Transitioning time exceeded, set port to standby */
732 err = SCSI_DH_IO;
733 pg->state = SCSI_ACCESS_STATE_STANDBY;
734 pg->expiry = 0;
735 rcu_read_lock();
736 list_for_each_entry_rcu(h, &pg->dh_list, node) {
737 if (!h->sdev)
738 continue;
739 h->sdev->access_state =
740 (pg->state & SCSI_ACCESS_STATE_MASK);
741 if (pg->pref)
742 h->sdev->access_state |=
743 SCSI_ACCESS_STATE_PREFERRED;
744 }
745 rcu_read_unlock();
746 }
747 break;
748 case SCSI_ACCESS_STATE_OFFLINE:
749 /* Path unusable */
750 err = SCSI_DH_DEV_OFFLINED;
751 pg->expiry = 0;
752 break;
753 default:
754 /* Useable path if active */
755 err = SCSI_DH_OK;
756 pg->expiry = 0;
757 break;
758 }
759 spin_unlock_irqrestore(&pg->lock, flags);
760 kfree(buff);
761 return err;
762}
763
764/*
765 * alua_stpg - Issue a SET TARGET PORT GROUP command
766 *
767 * Issue a SET TARGET PORT GROUP command and evaluate the
768 * response. Returns SCSI_DH_RETRY per default to trigger
769 * a re-evaluation of the target group state or SCSI_DH_OK
770 * if no further action needs to be taken.
771 */
772static unsigned alua_stpg(struct scsi_device *sdev, struct alua_port_group *pg)
773{
774 int retval;
775 struct scsi_sense_hdr sense_hdr;
776
777 if (!(pg->tpgs & TPGS_MODE_EXPLICIT)) {
778 /* Only implicit ALUA supported, retry */
779 return SCSI_DH_RETRY;
780 }
781 switch (pg->state) {
782 case SCSI_ACCESS_STATE_OPTIMAL:
783 return SCSI_DH_OK;
784 case SCSI_ACCESS_STATE_ACTIVE:
785 if ((pg->flags & ALUA_OPTIMIZE_STPG) &&
786 !pg->pref &&
787 (pg->tpgs & TPGS_MODE_IMPLICIT))
788 return SCSI_DH_OK;
789 break;
790 case SCSI_ACCESS_STATE_STANDBY:
791 case SCSI_ACCESS_STATE_UNAVAILABLE:
792 break;
793 case SCSI_ACCESS_STATE_OFFLINE:
794 return SCSI_DH_IO;
795 case SCSI_ACCESS_STATE_TRANSITIONING:
796 break;
797 default:
798 sdev_printk(KERN_INFO, sdev,
799 "%s: stpg failed, unhandled TPGS state %d",
800 ALUA_DH_NAME, pg->state);
801 return SCSI_DH_NOSYS;
802 }
803 retval = submit_stpg(sdev, pg->group_id, &sense_hdr);
804
805 if (retval) {
806 if (retval < 0 || !scsi_sense_valid(&sense_hdr)) {
807 sdev_printk(KERN_INFO, sdev,
808 "%s: stpg failed, result %d",
809 ALUA_DH_NAME, retval);
810 if (retval < 0)
811 return SCSI_DH_DEV_TEMP_BUSY;
812 } else {
813 sdev_printk(KERN_INFO, sdev, "%s: stpg failed\n",
814 ALUA_DH_NAME);
815 scsi_print_sense_hdr(sdev, ALUA_DH_NAME, &sense_hdr);
816 }
817 }
818 /* Retry RTPG */
819 return SCSI_DH_RETRY;
820}
821
822/*
823 * The caller must call scsi_device_put() on the returned pointer if it is not
824 * NULL.
825 */
826static struct scsi_device * __must_check
827alua_rtpg_select_sdev(struct alua_port_group *pg)
828{
829 struct alua_dh_data *h;
830 struct scsi_device *sdev = NULL, *prev_sdev;
831
832 lockdep_assert_held(&pg->lock);
833 if (WARN_ON(!pg->rtpg_sdev))
834 return NULL;
835
836 /*
837 * RCU protection isn't necessary for dh_list here
838 * as we hold pg->lock, but for access to h->pg.
839 */
840 rcu_read_lock();
841 list_for_each_entry_rcu(h, &pg->dh_list, node) {
842 if (!h->sdev)
843 continue;
844 if (h->sdev == pg->rtpg_sdev) {
845 h->disabled = true;
846 continue;
847 }
848 if (rcu_dereference(h->pg) == pg &&
849 !h->disabled &&
850 !scsi_device_get(h->sdev)) {
851 sdev = h->sdev;
852 break;
853 }
854 }
855 rcu_read_unlock();
856
857 if (!sdev) {
858 pr_warn("%s: no device found for rtpg\n",
859 (pg->device_id_len ?
860 (char *)pg->device_id_str : "(nameless PG)"));
861 return NULL;
862 }
863
864 sdev_printk(KERN_INFO, sdev, "rtpg retry on different device\n");
865
866 prev_sdev = pg->rtpg_sdev;
867 pg->rtpg_sdev = sdev;
868
869 return prev_sdev;
870}
871
872static void alua_rtpg_work(struct work_struct *work)
873{
874 struct alua_port_group *pg =
875 container_of(work, struct alua_port_group, rtpg_work.work);
876 struct scsi_device *sdev, *prev_sdev = NULL;
877 LIST_HEAD(qdata_list);
878 int err = SCSI_DH_OK;
879 struct alua_queue_data *qdata, *tmp;
880 struct alua_dh_data *h;
881 unsigned long flags;
882
883 spin_lock_irqsave(&pg->lock, flags);
884 sdev = pg->rtpg_sdev;
885 if (!sdev) {
886 WARN_ON(pg->flags & ALUA_PG_RUN_RTPG);
887 WARN_ON(pg->flags & ALUA_PG_RUN_STPG);
888 spin_unlock_irqrestore(&pg->lock, flags);
889 kref_put(&pg->kref, release_port_group);
890 return;
891 }
892 pg->flags |= ALUA_PG_RUNNING;
893 if (pg->flags & ALUA_PG_RUN_RTPG) {
894 int state = pg->state;
895
896 pg->flags &= ~ALUA_PG_RUN_RTPG;
897 spin_unlock_irqrestore(&pg->lock, flags);
898 if (state == SCSI_ACCESS_STATE_TRANSITIONING) {
899 if (alua_tur(sdev) == SCSI_DH_RETRY) {
900 spin_lock_irqsave(&pg->lock, flags);
901 pg->flags &= ~ALUA_PG_RUNNING;
902 pg->flags |= ALUA_PG_RUN_RTPG;
903 if (!pg->interval)
904 pg->interval = ALUA_RTPG_RETRY_DELAY;
905 spin_unlock_irqrestore(&pg->lock, flags);
906 queue_delayed_work(kaluad_wq, &pg->rtpg_work,
907 pg->interval * HZ);
908 return;
909 }
910 /* Send RTPG on failure or if TUR indicates SUCCESS */
911 }
912 err = alua_rtpg(sdev, pg);
913 spin_lock_irqsave(&pg->lock, flags);
914
915 /* If RTPG failed on the current device, try using another */
916 if (err == SCSI_DH_RES_TEMP_UNAVAIL &&
917 (prev_sdev = alua_rtpg_select_sdev(pg)))
918 err = SCSI_DH_IMM_RETRY;
919
920 if (err == SCSI_DH_RETRY || err == SCSI_DH_IMM_RETRY ||
921 pg->flags & ALUA_PG_RUN_RTPG) {
922 pg->flags &= ~ALUA_PG_RUNNING;
923 if (err == SCSI_DH_IMM_RETRY)
924 pg->interval = 0;
925 else if (!pg->interval && !(pg->flags & ALUA_PG_RUN_RTPG))
926 pg->interval = ALUA_RTPG_RETRY_DELAY;
927 pg->flags |= ALUA_PG_RUN_RTPG;
928 spin_unlock_irqrestore(&pg->lock, flags);
929 goto queue_rtpg;
930 }
931 if (err != SCSI_DH_OK)
932 pg->flags &= ~ALUA_PG_RUN_STPG;
933 }
934 if (pg->flags & ALUA_PG_RUN_STPG) {
935 pg->flags &= ~ALUA_PG_RUN_STPG;
936 spin_unlock_irqrestore(&pg->lock, flags);
937 err = alua_stpg(sdev, pg);
938 spin_lock_irqsave(&pg->lock, flags);
939 if (err == SCSI_DH_RETRY || pg->flags & ALUA_PG_RUN_RTPG) {
940 pg->flags |= ALUA_PG_RUN_RTPG;
941 pg->interval = 0;
942 pg->flags &= ~ALUA_PG_RUNNING;
943 spin_unlock_irqrestore(&pg->lock, flags);
944 goto queue_rtpg;
945 }
946 }
947
948 list_splice_init(&pg->rtpg_list, &qdata_list);
949 /*
950 * We went through an RTPG, for good or bad.
951 * Re-enable all devices for the next attempt.
952 */
953 list_for_each_entry(h, &pg->dh_list, node)
954 h->disabled = false;
955 pg->rtpg_sdev = NULL;
956 spin_unlock_irqrestore(&pg->lock, flags);
957
958 if (prev_sdev)
959 scsi_device_put(prev_sdev);
960
961 list_for_each_entry_safe(qdata, tmp, &qdata_list, entry) {
962 list_del(&qdata->entry);
963 if (qdata->callback_fn)
964 qdata->callback_fn(qdata->callback_data, err);
965 kfree(qdata);
966 }
967 spin_lock_irqsave(&pg->lock, flags);
968 pg->flags &= ~ALUA_PG_RUNNING;
969 spin_unlock_irqrestore(&pg->lock, flags);
970 scsi_device_put(sdev);
971 kref_put(&pg->kref, release_port_group);
972 return;
973
974queue_rtpg:
975 if (prev_sdev)
976 scsi_device_put(prev_sdev);
977 queue_delayed_work(kaluad_wq, &pg->rtpg_work, pg->interval * HZ);
978}
979
980/**
981 * alua_rtpg_queue() - cause RTPG to be submitted asynchronously
982 * @pg: ALUA port group associated with @sdev.
983 * @sdev: SCSI device for which to submit an RTPG.
984 * @qdata: Information about the callback to invoke after the RTPG.
985 * @force: Whether or not to submit an RTPG if a work item that will submit an
986 * RTPG already has been scheduled.
987 *
988 * Returns true if and only if alua_rtpg_work() will be called asynchronously.
989 * That function is responsible for calling @qdata->fn().
990 *
991 * Context: may be called from atomic context (alua_check()) only if the caller
992 * holds an sdev reference.
993 */
994static bool alua_rtpg_queue(struct alua_port_group *pg,
995 struct scsi_device *sdev,
996 struct alua_queue_data *qdata, bool force)
997{
998 int start_queue = 0;
999 unsigned long flags;
1000
1001 if (WARN_ON_ONCE(!pg) || scsi_device_get(sdev))
1002 return false;
1003
1004 spin_lock_irqsave(&pg->lock, flags);
1005 if (qdata) {
1006 list_add_tail(&qdata->entry, &pg->rtpg_list);
1007 pg->flags |= ALUA_PG_RUN_STPG;
1008 force = true;
1009 }
1010 if (pg->rtpg_sdev == NULL) {
1011 struct alua_dh_data *h = sdev->handler_data;
1012
1013 rcu_read_lock();
1014 if (h && rcu_dereference(h->pg) == pg) {
1015 pg->interval = 0;
1016 pg->flags |= ALUA_PG_RUN_RTPG;
1017 kref_get(&pg->kref);
1018 pg->rtpg_sdev = sdev;
1019 start_queue = 1;
1020 }
1021 rcu_read_unlock();
1022 } else if (!(pg->flags & ALUA_PG_RUN_RTPG) && force) {
1023 pg->flags |= ALUA_PG_RUN_RTPG;
1024 /* Do not queue if the worker is already running */
1025 if (!(pg->flags & ALUA_PG_RUNNING)) {
1026 kref_get(&pg->kref);
1027 start_queue = 1;
1028 }
1029 }
1030
1031 spin_unlock_irqrestore(&pg->lock, flags);
1032
1033 if (start_queue) {
1034 if (queue_delayed_work(kaluad_wq, &pg->rtpg_work,
1035 msecs_to_jiffies(ALUA_RTPG_DELAY_MSECS)))
1036 sdev = NULL;
1037 else
1038 kref_put(&pg->kref, release_port_group);
1039 }
1040 if (sdev)
1041 scsi_device_put(sdev);
1042
1043 return true;
1044}
1045
1046/*
1047 * alua_initialize - Initialize ALUA state
1048 * @sdev: the device to be initialized
1049 *
1050 * For the prep_fn to work correctly we have
1051 * to initialize the ALUA state for the device.
1052 */
1053static int alua_initialize(struct scsi_device *sdev, struct alua_dh_data *h)
1054{
1055 int err = SCSI_DH_DEV_UNSUPP, tpgs;
1056
1057 mutex_lock(&h->init_mutex);
1058 h->disabled = false;
1059 tpgs = alua_check_tpgs(sdev);
1060 if (tpgs != TPGS_MODE_NONE)
1061 err = alua_check_vpd(sdev, h, tpgs);
1062 h->init_error = err;
1063 mutex_unlock(&h->init_mutex);
1064 return err;
1065}
1066/*
1067 * alua_set_params - set/unset the optimize flag
1068 * @sdev: device on the path to be activated
1069 * params - parameters in the following format
1070 * "no_of_params\0param1\0param2\0param3\0...\0"
1071 * For example, to set the flag pass the following parameters
1072 * from multipath.conf
1073 * hardware_handler "2 alua 1"
1074 */
1075static int alua_set_params(struct scsi_device *sdev, const char *params)
1076{
1077 struct alua_dh_data *h = sdev->handler_data;
1078 struct alua_port_group *pg = NULL;
1079 unsigned int optimize = 0, argc;
1080 const char *p = params;
1081 int result = SCSI_DH_OK;
1082 unsigned long flags;
1083
1084 if ((sscanf(params, "%u", &argc) != 1) || (argc != 1))
1085 return -EINVAL;
1086
1087 while (*p++)
1088 ;
1089 if ((sscanf(p, "%u", &optimize) != 1) || (optimize > 1))
1090 return -EINVAL;
1091
1092 rcu_read_lock();
1093 pg = rcu_dereference(h->pg);
1094 if (!pg) {
1095 rcu_read_unlock();
1096 return -ENXIO;
1097 }
1098 spin_lock_irqsave(&pg->lock, flags);
1099 if (optimize)
1100 pg->flags |= ALUA_OPTIMIZE_STPG;
1101 else
1102 pg->flags &= ~ALUA_OPTIMIZE_STPG;
1103 spin_unlock_irqrestore(&pg->lock, flags);
1104 rcu_read_unlock();
1105
1106 return result;
1107}
1108
1109/*
1110 * alua_activate - activate a path
1111 * @sdev: device on the path to be activated
1112 *
1113 * We're currently switching the port group to be activated only and
1114 * let the array figure out the rest.
1115 * There may be other arrays which require us to switch all port groups
1116 * based on a certain policy. But until we actually encounter them it
1117 * should be okay.
1118 */
1119static int alua_activate(struct scsi_device *sdev,
1120 activate_complete fn, void *data)
1121{
1122 struct alua_dh_data *h = sdev->handler_data;
1123 int err = SCSI_DH_OK;
1124 struct alua_queue_data *qdata;
1125 struct alua_port_group *pg;
1126
1127 qdata = kzalloc(sizeof(*qdata), GFP_KERNEL);
1128 if (!qdata) {
1129 err = SCSI_DH_RES_TEMP_UNAVAIL;
1130 goto out;
1131 }
1132 qdata->callback_fn = fn;
1133 qdata->callback_data = data;
1134
1135 mutex_lock(&h->init_mutex);
1136 rcu_read_lock();
1137 pg = rcu_dereference(h->pg);
1138 if (!pg || !kref_get_unless_zero(&pg->kref)) {
1139 rcu_read_unlock();
1140 kfree(qdata);
1141 err = h->init_error;
1142 mutex_unlock(&h->init_mutex);
1143 goto out;
1144 }
1145 rcu_read_unlock();
1146 mutex_unlock(&h->init_mutex);
1147
1148 if (alua_rtpg_queue(pg, sdev, qdata, true)) {
1149 fn = NULL;
1150 } else {
1151 kfree(qdata);
1152 err = SCSI_DH_DEV_OFFLINED;
1153 }
1154 kref_put(&pg->kref, release_port_group);
1155out:
1156 if (fn)
1157 fn(data, err);
1158 return 0;
1159}
1160
1161/*
1162 * alua_check - check path status
1163 * @sdev: device on the path to be checked
1164 *
1165 * Check the device status
1166 */
1167static void alua_check(struct scsi_device *sdev, bool force)
1168{
1169 struct alua_dh_data *h = sdev->handler_data;
1170 struct alua_port_group *pg;
1171
1172 rcu_read_lock();
1173 pg = rcu_dereference(h->pg);
1174 if (!pg || !kref_get_unless_zero(&pg->kref)) {
1175 rcu_read_unlock();
1176 return;
1177 }
1178 rcu_read_unlock();
1179 alua_rtpg_queue(pg, sdev, NULL, force);
1180 kref_put(&pg->kref, release_port_group);
1181}
1182
1183/*
1184 * alua_prep_fn - request callback
1185 *
1186 * Fail I/O to all paths not in state
1187 * active/optimized or active/non-optimized.
1188 */
1189static blk_status_t alua_prep_fn(struct scsi_device *sdev, struct request *req)
1190{
1191 struct alua_dh_data *h = sdev->handler_data;
1192 struct alua_port_group *pg;
1193 unsigned char state = SCSI_ACCESS_STATE_OPTIMAL;
1194
1195 rcu_read_lock();
1196 pg = rcu_dereference(h->pg);
1197 if (pg)
1198 state = pg->state;
1199 rcu_read_unlock();
1200
1201 switch (state) {
1202 case SCSI_ACCESS_STATE_OPTIMAL:
1203 case SCSI_ACCESS_STATE_ACTIVE:
1204 case SCSI_ACCESS_STATE_LBA:
1205 case SCSI_ACCESS_STATE_TRANSITIONING:
1206 return BLK_STS_OK;
1207 default:
1208 req->rq_flags |= RQF_QUIET;
1209 return BLK_STS_IOERR;
1210 }
1211}
1212
1213static void alua_rescan(struct scsi_device *sdev)
1214{
1215 struct alua_dh_data *h = sdev->handler_data;
1216
1217 alua_initialize(sdev, h);
1218}
1219
1220/*
1221 * alua_bus_attach - Attach device handler
1222 * @sdev: device to be attached to
1223 */
1224static int alua_bus_attach(struct scsi_device *sdev)
1225{
1226 struct alua_dh_data *h;
1227 int err;
1228
1229 h = kzalloc(sizeof(*h) , GFP_KERNEL);
1230 if (!h)
1231 return SCSI_DH_NOMEM;
1232 spin_lock_init(&h->pg_lock);
1233 rcu_assign_pointer(h->pg, NULL);
1234 h->init_error = SCSI_DH_OK;
1235 h->sdev = sdev;
1236 INIT_LIST_HEAD(&h->node);
1237
1238 mutex_init(&h->init_mutex);
1239 err = alua_initialize(sdev, h);
1240 if (err != SCSI_DH_OK && err != SCSI_DH_DEV_OFFLINED)
1241 goto failed;
1242
1243 sdev->handler_data = h;
1244 return SCSI_DH_OK;
1245failed:
1246 kfree(h);
1247 return err;
1248}
1249
1250/*
1251 * alua_bus_detach - Detach device handler
1252 * @sdev: device to be detached from
1253 */
1254static void alua_bus_detach(struct scsi_device *sdev)
1255{
1256 struct alua_dh_data *h = sdev->handler_data;
1257 struct alua_port_group *pg;
1258
1259 spin_lock(&h->pg_lock);
1260 pg = rcu_dereference_protected(h->pg, lockdep_is_held(&h->pg_lock));
1261 rcu_assign_pointer(h->pg, NULL);
1262 spin_unlock(&h->pg_lock);
1263 if (pg) {
1264 spin_lock_irq(&pg->lock);
1265 list_del_rcu(&h->node);
1266 spin_unlock_irq(&pg->lock);
1267 kref_put(&pg->kref, release_port_group);
1268 }
1269 sdev->handler_data = NULL;
1270 synchronize_rcu();
1271 kfree(h);
1272}
1273
1274static struct scsi_device_handler alua_dh = {
1275 .name = ALUA_DH_NAME,
1276 .module = THIS_MODULE,
1277 .attach = alua_bus_attach,
1278 .detach = alua_bus_detach,
1279 .prep_fn = alua_prep_fn,
1280 .check_sense = alua_check_sense,
1281 .activate = alua_activate,
1282 .rescan = alua_rescan,
1283 .set_params = alua_set_params,
1284};
1285
1286static int __init alua_init(void)
1287{
1288 int r;
1289
1290 kaluad_wq = alloc_workqueue("kaluad", WQ_MEM_RECLAIM, 0);
1291 if (!kaluad_wq)
1292 return -ENOMEM;
1293
1294 r = scsi_register_device_handler(&alua_dh);
1295 if (r != 0) {
1296 printk(KERN_ERR "%s: Failed to register scsi device handler",
1297 ALUA_DH_NAME);
1298 destroy_workqueue(kaluad_wq);
1299 }
1300 return r;
1301}
1302
1303static void __exit alua_exit(void)
1304{
1305 scsi_unregister_device_handler(&alua_dh);
1306 destroy_workqueue(kaluad_wq);
1307}
1308
1309module_init(alua_init);
1310module_exit(alua_exit);
1311
1312MODULE_DESCRIPTION("DM Multipath ALUA support");
1313MODULE_AUTHOR("Hannes Reinecke <hare@suse.de>");
1314MODULE_LICENSE("GPL");
1315MODULE_VERSION(ALUA_DH_VER);