1 /*******************************************************************************
2 * Filename: target_core_alua.c
4 * This file contains SPC-3 compliant asymmetric logical unit assigntment (ALUA)
6 * Copyright (c) 2009-2010 Rising Tide Systems
7 * Copyright (c) 2009-2010 Linux-iSCSI.org
9 * Nicholas A. Bellinger <nab@kernel.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25 ******************************************************************************/
27 #include <linux/slab.h>
28 #include <linux/spinlock.h>
29 #include <linux/configfs.h>
30 #include <linux/export.h>
31 #include <scsi/scsi.h>
32 #include <scsi/scsi_cmnd.h>
33 #include <asm/unaligned.h>
35 #include <target/target_core_base.h>
36 #include <target/target_core_backend.h>
37 #include <target/target_core_fabric.h>
38 #include <target/target_core_configfs.h>
40 #include "target_core_internal.h"
41 #include "target_core_alua.h"
42 #include "target_core_ua.h"
44 static int core_alua_check_transition(int state, int *primary);
45 static int core_alua_set_tg_pt_secondary_state(
46 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
47 struct se_port *port, int explict, int offline);
49 static u16 alua_lu_gps_counter;
50 static u32 alua_lu_gps_count;
52 static DEFINE_SPINLOCK(lu_gps_lock);
53 static LIST_HEAD(lu_gps_list);
55 struct t10_alua_lu_gp *default_lu_gp;
58 * REPORT_TARGET_PORT_GROUPS
60 * See spc4r17 section 6.27
62 int target_emulate_report_target_port_groups(struct se_cmd *cmd)
64 struct se_subsystem_dev *su_dev = cmd->se_dev->se_sub_dev;
66 struct t10_alua_tg_pt_gp *tg_pt_gp;
67 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
69 u32 rd_len = 0, off = 4; /* Skip over RESERVED area to first
70 Target port group descriptor */
72 * Need at least 4 bytes of response data or else we can't
73 * even fit the return data length.
75 if (cmd->data_length < 4) {
76 pr_warn("REPORT TARGET PORT GROUPS allocation length %u"
77 " too small\n", cmd->data_length);
81 buf = transport_kmap_data_sg(cmd);
83 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
84 list_for_each_entry(tg_pt_gp, &su_dev->t10_alua.tg_pt_gps_list,
87 * Check if the Target port group and Target port descriptor list
88 * based on tg_pt_gp_members count will fit into the response payload.
89 * Otherwise, bump rd_len to let the initiator know we have exceeded
90 * the allocation length and the response is truncated.
92 if ((off + 8 + (tg_pt_gp->tg_pt_gp_members * 4)) >
94 rd_len += 8 + (tg_pt_gp->tg_pt_gp_members * 4);
98 * PREF: Preferred target port bit, determine if this
99 * bit should be set for port group.
101 if (tg_pt_gp->tg_pt_gp_pref)
104 * Set the ASYMMETRIC ACCESS State
106 buf[off++] |= (atomic_read(
107 &tg_pt_gp->tg_pt_gp_alua_access_state) & 0xff);
109 * Set supported ASYMMETRIC ACCESS State bits
111 buf[off] = 0x80; /* T_SUP */
112 buf[off] |= 0x40; /* O_SUP */
113 buf[off] |= 0x8; /* U_SUP */
114 buf[off] |= 0x4; /* S_SUP */
115 buf[off] |= 0x2; /* AN_SUP */
116 buf[off++] |= 0x1; /* AO_SUP */
120 buf[off++] = ((tg_pt_gp->tg_pt_gp_id >> 8) & 0xff);
121 buf[off++] = (tg_pt_gp->tg_pt_gp_id & 0xff);
123 off++; /* Skip over Reserved */
127 buf[off++] = (tg_pt_gp->tg_pt_gp_alua_access_status & 0xff);
129 * Vendor Specific field
135 buf[off++] = (tg_pt_gp->tg_pt_gp_members & 0xff);
138 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
139 list_for_each_entry(tg_pt_gp_mem, &tg_pt_gp->tg_pt_gp_mem_list,
141 port = tg_pt_gp_mem->tg_pt;
143 * Start Target Port descriptor format
145 * See spc4r17 section 6.2.7 Table 247
147 off += 2; /* Skip over Obsolete */
149 * Set RELATIVE TARGET PORT IDENTIFIER
151 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
152 buf[off++] = (port->sep_rtpi & 0xff);
155 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
157 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
159 * Set the RETURN DATA LENGTH set in the header of the DataIN Payload
161 buf[0] = ((rd_len >> 24) & 0xff);
162 buf[1] = ((rd_len >> 16) & 0xff);
163 buf[2] = ((rd_len >> 8) & 0xff);
164 buf[3] = (rd_len & 0xff);
166 transport_kunmap_data_sg(cmd);
168 target_complete_cmd(cmd, GOOD);
173 * SET_TARGET_PORT_GROUPS for explict ALUA operation.
175 * See spc4r17 section 6.35
177 int target_emulate_set_target_port_groups(struct se_cmd *cmd)
179 struct se_device *dev = cmd->se_dev;
180 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
181 struct se_port *port, *l_port = cmd->se_lun->lun_sep;
182 struct se_node_acl *nacl = cmd->se_sess->se_node_acl;
183 struct t10_alua_tg_pt_gp *tg_pt_gp = NULL, *l_tg_pt_gp;
184 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem, *l_tg_pt_gp_mem;
187 u32 len = 4; /* Skip over RESERVED area in header */
188 int alua_access_state, primary = 0, rc;
192 cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
195 buf = transport_kmap_data_sg(cmd);
198 * Determine if explict ALUA via SET_TARGET_PORT_GROUPS is allowed
199 * for the local tg_pt_gp.
201 l_tg_pt_gp_mem = l_port->sep_alua_tg_pt_gp_mem;
202 if (!l_tg_pt_gp_mem) {
203 pr_err("Unable to access l_port->sep_alua_tg_pt_gp_mem\n");
204 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
208 spin_lock(&l_tg_pt_gp_mem->tg_pt_gp_mem_lock);
209 l_tg_pt_gp = l_tg_pt_gp_mem->tg_pt_gp;
211 spin_unlock(&l_tg_pt_gp_mem->tg_pt_gp_mem_lock);
212 pr_err("Unable to access *l_tg_pt_gp_mem->tg_pt_gp\n");
213 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
217 rc = (l_tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_EXPLICT_ALUA);
218 spin_unlock(&l_tg_pt_gp_mem->tg_pt_gp_mem_lock);
221 pr_debug("Unable to process SET_TARGET_PORT_GROUPS"
222 " while TPGS_EXPLICT_ALUA is disabled\n");
223 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
228 ptr = &buf[4]; /* Skip over RESERVED area in header */
230 while (len < cmd->data_length) {
231 alua_access_state = (ptr[0] & 0x0f);
233 * Check the received ALUA access state, and determine if
234 * the state is a primary or secondary target port asymmetric
237 rc = core_alua_check_transition(alua_access_state, &primary);
240 * If the SET TARGET PORT GROUPS attempts to establish
241 * an invalid combination of target port asymmetric
242 * access states or attempts to establish an
243 * unsupported target port asymmetric access state,
244 * then the command shall be terminated with CHECK
245 * CONDITION status, with the sense key set to ILLEGAL
246 * REQUEST, and the additional sense code set to INVALID
247 * FIELD IN PARAMETER LIST.
249 cmd->scsi_sense_reason = TCM_INVALID_PARAMETER_LIST;
255 * If the ASYMMETRIC ACCESS STATE field (see table 267)
256 * specifies a primary target port asymmetric access state,
257 * then the TARGET PORT GROUP OR TARGET PORT field specifies
258 * a primary target port group for which the primary target
259 * port asymmetric access state shall be changed. If the
260 * ASYMMETRIC ACCESS STATE field specifies a secondary target
261 * port asymmetric access state, then the TARGET PORT GROUP OR
262 * TARGET PORT field specifies the relative target port
263 * identifier (see 3.1.120) of the target port for which the
264 * secondary target port asymmetric access state shall be
268 tg_pt_id = get_unaligned_be16(ptr + 2);
270 * Locate the matching target port group ID from
271 * the global tg_pt_gp list
273 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
274 list_for_each_entry(tg_pt_gp,
275 &su_dev->t10_alua.tg_pt_gps_list,
277 if (!tg_pt_gp->tg_pt_gp_valid_id)
280 if (tg_pt_id != tg_pt_gp->tg_pt_gp_id)
283 atomic_inc(&tg_pt_gp->tg_pt_gp_ref_cnt);
284 smp_mb__after_atomic_inc();
285 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
287 rc = core_alua_do_port_transition(tg_pt_gp,
289 alua_access_state, 1);
291 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
292 atomic_dec(&tg_pt_gp->tg_pt_gp_ref_cnt);
293 smp_mb__after_atomic_dec();
296 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
298 * If not matching target port group ID can be located
299 * throw an exception with ASCQ: INVALID_PARAMETER_LIST
302 cmd->scsi_sense_reason = TCM_INVALID_PARAMETER_LIST;
308 * Extact the RELATIVE TARGET PORT IDENTIFIER to identify
309 * the Target Port in question for the the incoming
310 * SET_TARGET_PORT_GROUPS op.
312 rtpi = get_unaligned_be16(ptr + 2);
314 * Locate the matching relative target port identifer
315 * for the struct se_device storage object.
317 spin_lock(&dev->se_port_lock);
318 list_for_each_entry(port, &dev->dev_sep_list,
320 if (port->sep_rtpi != rtpi)
323 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
324 spin_unlock(&dev->se_port_lock);
326 rc = core_alua_set_tg_pt_secondary_state(
327 tg_pt_gp_mem, port, 1, 1);
329 spin_lock(&dev->se_port_lock);
332 spin_unlock(&dev->se_port_lock);
334 * If not matching relative target port identifier can
335 * be located, throw an exception with ASCQ:
336 * INVALID_PARAMETER_LIST
339 cmd->scsi_sense_reason = TCM_INVALID_PARAMETER_LIST;
350 transport_kunmap_data_sg(cmd);
351 target_complete_cmd(cmd, GOOD);
355 static inline int core_alua_state_nonoptimized(
358 int nonop_delay_msecs,
362 * Set SCF_ALUA_NON_OPTIMIZED here, this value will be checked
363 * later to determine if processing of this cmd needs to be
364 * temporarily delayed for the Active/NonOptimized primary access state.
366 cmd->se_cmd_flags |= SCF_ALUA_NON_OPTIMIZED;
367 cmd->alua_nonop_delay = nonop_delay_msecs;
371 static inline int core_alua_state_standby(
377 * Allowed CDBs for ALUA_ACCESS_STATE_STANDBY as defined by
378 * spc4r17 section 5.9.2.4.4
387 case RECEIVE_DIAGNOSTIC:
388 case SEND_DIAGNOSTIC:
391 case MI_REPORT_TARGET_PGS:
394 *alua_ascq = ASCQ_04H_ALUA_TG_PT_STANDBY;
397 case MAINTENANCE_OUT:
399 case MO_SET_TARGET_PGS:
402 *alua_ascq = ASCQ_04H_ALUA_TG_PT_STANDBY;
406 case PERSISTENT_RESERVE_IN:
407 case PERSISTENT_RESERVE_OUT:
412 *alua_ascq = ASCQ_04H_ALUA_TG_PT_STANDBY;
419 static inline int core_alua_state_unavailable(
425 * Allowed CDBs for ALUA_ACCESS_STATE_UNAVAILABLE as defined by
426 * spc4r17 section 5.9.2.4.5
433 case MI_REPORT_TARGET_PGS:
436 *alua_ascq = ASCQ_04H_ALUA_TG_PT_UNAVAILABLE;
439 case MAINTENANCE_OUT:
441 case MO_SET_TARGET_PGS:
444 *alua_ascq = ASCQ_04H_ALUA_TG_PT_UNAVAILABLE;
452 *alua_ascq = ASCQ_04H_ALUA_TG_PT_UNAVAILABLE;
459 static inline int core_alua_state_transition(
465 * Allowed CDBs for ALUA_ACCESS_STATE_TRANSITIO as defined by
466 * spc4r17 section 5.9.2.5
473 case MI_REPORT_TARGET_PGS:
476 *alua_ascq = ASCQ_04H_ALUA_STATE_TRANSITION;
484 *alua_ascq = ASCQ_04H_ALUA_STATE_TRANSITION;
492 * Used for alua_type SPC_ALUA_PASSTHROUGH and SPC2_ALUA_DISABLED
493 * in transport_cmd_sequencer(). This function is assigned to
494 * struct t10_alua *->state_check() in core_setup_alua()
496 static int core_alua_state_check_nop(
505 * Used for alua_type SPC3_ALUA_EMULATED in transport_cmd_sequencer().
506 * This function is assigned to struct t10_alua *->state_check() in
509 * Also, this function can return three different return codes to
510 * signal transport_generic_cmd_sequencer()
512 * return 1: Is used to signal LUN not accecsable, and check condition/not ready
513 * return 0: Used to signal success
514 * reutrn -1: Used to signal failure, and invalid cdb field
516 static int core_alua_state_check(
521 struct se_lun *lun = cmd->se_lun;
522 struct se_port *port = lun->lun_sep;
523 struct t10_alua_tg_pt_gp *tg_pt_gp;
524 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
525 int out_alua_state, nonop_delay_msecs;
530 * First, check for a struct se_port specific secondary ALUA target port
531 * access state: OFFLINE
533 if (atomic_read(&port->sep_tg_pt_secondary_offline)) {
534 *alua_ascq = ASCQ_04H_ALUA_OFFLINE;
535 pr_debug("ALUA: Got secondary offline status for local"
537 *alua_ascq = ASCQ_04H_ALUA_OFFLINE;
541 * Second, obtain the struct t10_alua_tg_pt_gp_member pointer to the
542 * ALUA target port group, to obtain current ALUA access state.
543 * Otherwise look for the underlying struct se_device association with
544 * a ALUA logical unit group.
546 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
547 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
548 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
549 out_alua_state = atomic_read(&tg_pt_gp->tg_pt_gp_alua_access_state);
550 nonop_delay_msecs = tg_pt_gp->tg_pt_gp_nonop_delay_msecs;
551 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
553 * Process ALUA_ACCESS_STATE_ACTIVE_OPTMIZED in a separate conditional
554 * statement so the compiler knows explicitly to check this case first.
555 * For the Optimized ALUA access state case, we want to process the
556 * incoming fabric cmd ASAP..
558 if (out_alua_state == ALUA_ACCESS_STATE_ACTIVE_OPTMIZED)
561 switch (out_alua_state) {
562 case ALUA_ACCESS_STATE_ACTIVE_NON_OPTIMIZED:
563 return core_alua_state_nonoptimized(cmd, cdb,
564 nonop_delay_msecs, alua_ascq);
565 case ALUA_ACCESS_STATE_STANDBY:
566 return core_alua_state_standby(cmd, cdb, alua_ascq);
567 case ALUA_ACCESS_STATE_UNAVAILABLE:
568 return core_alua_state_unavailable(cmd, cdb, alua_ascq);
569 case ALUA_ACCESS_STATE_TRANSITION:
570 return core_alua_state_transition(cmd, cdb, alua_ascq);
572 * OFFLINE is a secondary ALUA target port group access state, that is
573 * handled above with struct se_port->sep_tg_pt_secondary_offline=1
575 case ALUA_ACCESS_STATE_OFFLINE:
577 pr_err("Unknown ALUA access state: 0x%02x\n",
586 * Check implict and explict ALUA state change request.
588 static int core_alua_check_transition(int state, int *primary)
591 case ALUA_ACCESS_STATE_ACTIVE_OPTMIZED:
592 case ALUA_ACCESS_STATE_ACTIVE_NON_OPTIMIZED:
593 case ALUA_ACCESS_STATE_STANDBY:
594 case ALUA_ACCESS_STATE_UNAVAILABLE:
596 * OPTIMIZED, NON-OPTIMIZED, STANDBY and UNAVAILABLE are
597 * defined as primary target port asymmetric access states.
601 case ALUA_ACCESS_STATE_OFFLINE:
603 * OFFLINE state is defined as a secondary target port
604 * asymmetric access state.
609 pr_err("Unknown ALUA access state: 0x%02x\n", state);
616 static char *core_alua_dump_state(int state)
619 case ALUA_ACCESS_STATE_ACTIVE_OPTMIZED:
620 return "Active/Optimized";
621 case ALUA_ACCESS_STATE_ACTIVE_NON_OPTIMIZED:
622 return "Active/NonOptimized";
623 case ALUA_ACCESS_STATE_STANDBY:
625 case ALUA_ACCESS_STATE_UNAVAILABLE:
626 return "Unavailable";
627 case ALUA_ACCESS_STATE_OFFLINE:
636 char *core_alua_dump_status(int status)
639 case ALUA_STATUS_NONE:
641 case ALUA_STATUS_ALTERED_BY_EXPLICT_STPG:
642 return "Altered by Explict STPG";
643 case ALUA_STATUS_ALTERED_BY_IMPLICT_ALUA:
644 return "Altered by Implict ALUA";
653 * Used by fabric modules to determine when we need to delay processing
654 * for the Active/NonOptimized paths..
656 int core_alua_check_nonop_delay(
659 if (!(cmd->se_cmd_flags & SCF_ALUA_NON_OPTIMIZED))
664 * The ALUA Active/NonOptimized access state delay can be disabled
665 * in via configfs with a value of zero
667 if (!cmd->alua_nonop_delay)
670 * struct se_cmd->alua_nonop_delay gets set by a target port group
671 * defined interval in core_alua_state_nonoptimized()
673 msleep_interruptible(cmd->alua_nonop_delay);
676 EXPORT_SYMBOL(core_alua_check_nonop_delay);
679 * Called with tg_pt_gp->tg_pt_gp_md_mutex or tg_pt_gp_mem->sep_tg_pt_md_mutex
682 static int core_alua_write_tpg_metadata(
684 unsigned char *md_buf,
690 int flags = O_RDWR | O_CREAT | O_TRUNC, ret;
692 memset(iov, 0, sizeof(struct iovec));
694 file = filp_open(path, flags, 0600);
695 if (IS_ERR(file) || !file || !file->f_dentry) {
696 pr_err("filp_open(%s) for ALUA metadata failed\n",
701 iov[0].iov_base = &md_buf[0];
702 iov[0].iov_len = md_buf_len;
706 ret = vfs_writev(file, &iov[0], 1, &file->f_pos);
710 pr_err("Error writing ALUA metadata file: %s\n", path);
711 filp_close(file, NULL);
714 filp_close(file, NULL);
720 * Called with tg_pt_gp->tg_pt_gp_md_mutex held
722 static int core_alua_update_tpg_primary_metadata(
723 struct t10_alua_tg_pt_gp *tg_pt_gp,
725 unsigned char *md_buf)
727 struct se_subsystem_dev *su_dev = tg_pt_gp->tg_pt_gp_su_dev;
728 struct t10_wwn *wwn = &su_dev->t10_wwn;
729 char path[ALUA_METADATA_PATH_LEN];
732 memset(path, 0, ALUA_METADATA_PATH_LEN);
734 len = snprintf(md_buf, tg_pt_gp->tg_pt_gp_md_buf_len,
736 "alua_access_state=0x%02x\n"
737 "alua_access_status=0x%02x\n",
738 tg_pt_gp->tg_pt_gp_id, primary_state,
739 tg_pt_gp->tg_pt_gp_alua_access_status);
741 snprintf(path, ALUA_METADATA_PATH_LEN,
742 "/var/target/alua/tpgs_%s/%s", &wwn->unit_serial[0],
743 config_item_name(&tg_pt_gp->tg_pt_gp_group.cg_item));
745 return core_alua_write_tpg_metadata(path, md_buf, len);
748 static int core_alua_do_transition_tg_pt(
749 struct t10_alua_tg_pt_gp *tg_pt_gp,
750 struct se_port *l_port,
751 struct se_node_acl *nacl,
752 unsigned char *md_buf,
756 struct se_dev_entry *se_deve;
757 struct se_lun_acl *lacl;
758 struct se_port *port;
759 struct t10_alua_tg_pt_gp_member *mem;
762 * Save the old primary ALUA access state, and set the current state
763 * to ALUA_ACCESS_STATE_TRANSITION.
765 old_state = atomic_read(&tg_pt_gp->tg_pt_gp_alua_access_state);
766 atomic_set(&tg_pt_gp->tg_pt_gp_alua_access_state,
767 ALUA_ACCESS_STATE_TRANSITION);
768 tg_pt_gp->tg_pt_gp_alua_access_status = (explict) ?
769 ALUA_STATUS_ALTERED_BY_EXPLICT_STPG :
770 ALUA_STATUS_ALTERED_BY_IMPLICT_ALUA;
772 * Check for the optional ALUA primary state transition delay
774 if (tg_pt_gp->tg_pt_gp_trans_delay_msecs != 0)
775 msleep_interruptible(tg_pt_gp->tg_pt_gp_trans_delay_msecs);
777 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
778 list_for_each_entry(mem, &tg_pt_gp->tg_pt_gp_mem_list,
782 * After an implicit target port asymmetric access state
783 * change, a device server shall establish a unit attention
784 * condition for the initiator port associated with every I_T
785 * nexus with the additional sense code set to ASYMMETRIC
786 * ACCESS STATE CHAGED.
788 * After an explicit target port asymmetric access state
789 * change, a device server shall establish a unit attention
790 * condition with the additional sense code set to ASYMMETRIC
791 * ACCESS STATE CHANGED for the initiator port associated with
792 * every I_T nexus other than the I_T nexus on which the SET
793 * TARGET PORT GROUPS command
795 atomic_inc(&mem->tg_pt_gp_mem_ref_cnt);
796 smp_mb__after_atomic_inc();
797 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
799 spin_lock_bh(&port->sep_alua_lock);
800 list_for_each_entry(se_deve, &port->sep_alua_list,
802 lacl = se_deve->se_lun_acl;
804 * se_deve->se_lun_acl pointer may be NULL for a
805 * entry created without explict Node+MappedLUN ACLs
811 (nacl != NULL) && (nacl == lacl->se_lun_nacl) &&
812 (l_port != NULL) && (l_port == port))
815 core_scsi3_ua_allocate(lacl->se_lun_nacl,
816 se_deve->mapped_lun, 0x2A,
817 ASCQ_2AH_ASYMMETRIC_ACCESS_STATE_CHANGED);
819 spin_unlock_bh(&port->sep_alua_lock);
821 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
822 atomic_dec(&mem->tg_pt_gp_mem_ref_cnt);
823 smp_mb__after_atomic_dec();
825 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
827 * Update the ALUA metadata buf that has been allocated in
828 * core_alua_do_port_transition(), this metadata will be written
831 * Note that there is the case where we do not want to update the
832 * metadata when the saved metadata is being parsed in userspace
833 * when setting the existing port access state and access status.
835 * Also note that the failure to write out the ALUA metadata to
836 * struct file does NOT affect the actual ALUA transition.
838 if (tg_pt_gp->tg_pt_gp_write_metadata) {
839 mutex_lock(&tg_pt_gp->tg_pt_gp_md_mutex);
840 core_alua_update_tpg_primary_metadata(tg_pt_gp,
842 mutex_unlock(&tg_pt_gp->tg_pt_gp_md_mutex);
845 * Set the current primary ALUA access state to the requested new state
847 atomic_set(&tg_pt_gp->tg_pt_gp_alua_access_state, new_state);
849 pr_debug("Successful %s ALUA transition TG PT Group: %s ID: %hu"
850 " from primary access state %s to %s\n", (explict) ? "explict" :
851 "implict", config_item_name(&tg_pt_gp->tg_pt_gp_group.cg_item),
852 tg_pt_gp->tg_pt_gp_id, core_alua_dump_state(old_state),
853 core_alua_dump_state(new_state));
858 int core_alua_do_port_transition(
859 struct t10_alua_tg_pt_gp *l_tg_pt_gp,
860 struct se_device *l_dev,
861 struct se_port *l_port,
862 struct se_node_acl *l_nacl,
866 struct se_device *dev;
867 struct se_port *port;
868 struct se_subsystem_dev *su_dev;
869 struct se_node_acl *nacl;
870 struct t10_alua_lu_gp *lu_gp;
871 struct t10_alua_lu_gp_member *lu_gp_mem, *local_lu_gp_mem;
872 struct t10_alua_tg_pt_gp *tg_pt_gp;
873 unsigned char *md_buf;
876 if (core_alua_check_transition(new_state, &primary) != 0)
879 md_buf = kzalloc(l_tg_pt_gp->tg_pt_gp_md_buf_len, GFP_KERNEL);
881 pr_err("Unable to allocate buf for ALUA metadata\n");
885 local_lu_gp_mem = l_dev->dev_alua_lu_gp_mem;
886 spin_lock(&local_lu_gp_mem->lu_gp_mem_lock);
887 lu_gp = local_lu_gp_mem->lu_gp;
888 atomic_inc(&lu_gp->lu_gp_ref_cnt);
889 smp_mb__after_atomic_inc();
890 spin_unlock(&local_lu_gp_mem->lu_gp_mem_lock);
892 * For storage objects that are members of the 'default_lu_gp',
893 * we only do transition on the passed *l_tp_pt_gp, and not
894 * on all of the matching target port groups IDs in default_lu_gp.
896 if (!lu_gp->lu_gp_id) {
898 * core_alua_do_transition_tg_pt() will always return
901 core_alua_do_transition_tg_pt(l_tg_pt_gp, l_port, l_nacl,
902 md_buf, new_state, explict);
903 atomic_dec(&lu_gp->lu_gp_ref_cnt);
904 smp_mb__after_atomic_dec();
909 * For all other LU groups aside from 'default_lu_gp', walk all of
910 * the associated storage objects looking for a matching target port
911 * group ID from the local target port group.
913 spin_lock(&lu_gp->lu_gp_lock);
914 list_for_each_entry(lu_gp_mem, &lu_gp->lu_gp_mem_list,
917 dev = lu_gp_mem->lu_gp_mem_dev;
918 su_dev = dev->se_sub_dev;
919 atomic_inc(&lu_gp_mem->lu_gp_mem_ref_cnt);
920 smp_mb__after_atomic_inc();
921 spin_unlock(&lu_gp->lu_gp_lock);
923 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
924 list_for_each_entry(tg_pt_gp,
925 &su_dev->t10_alua.tg_pt_gps_list,
928 if (!tg_pt_gp->tg_pt_gp_valid_id)
931 * If the target behavior port asymmetric access state
932 * is changed for any target port group accessiable via
933 * a logical unit within a LU group, the target port
934 * behavior group asymmetric access states for the same
935 * target port group accessible via other logical units
936 * in that LU group will also change.
938 if (l_tg_pt_gp->tg_pt_gp_id != tg_pt_gp->tg_pt_gp_id)
941 if (l_tg_pt_gp == tg_pt_gp) {
948 atomic_inc(&tg_pt_gp->tg_pt_gp_ref_cnt);
949 smp_mb__after_atomic_inc();
950 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
952 * core_alua_do_transition_tg_pt() will always return
955 core_alua_do_transition_tg_pt(tg_pt_gp, port,
956 nacl, md_buf, new_state, explict);
958 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
959 atomic_dec(&tg_pt_gp->tg_pt_gp_ref_cnt);
960 smp_mb__after_atomic_dec();
962 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
964 spin_lock(&lu_gp->lu_gp_lock);
965 atomic_dec(&lu_gp_mem->lu_gp_mem_ref_cnt);
966 smp_mb__after_atomic_dec();
968 spin_unlock(&lu_gp->lu_gp_lock);
970 pr_debug("Successfully processed LU Group: %s all ALUA TG PT"
971 " Group IDs: %hu %s transition to primary state: %s\n",
972 config_item_name(&lu_gp->lu_gp_group.cg_item),
973 l_tg_pt_gp->tg_pt_gp_id, (explict) ? "explict" : "implict",
974 core_alua_dump_state(new_state));
976 atomic_dec(&lu_gp->lu_gp_ref_cnt);
977 smp_mb__after_atomic_dec();
983 * Called with tg_pt_gp_mem->sep_tg_pt_md_mutex held
985 static int core_alua_update_tpg_secondary_metadata(
986 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
987 struct se_port *port,
988 unsigned char *md_buf,
991 struct se_portal_group *se_tpg = port->sep_tpg;
992 char path[ALUA_METADATA_PATH_LEN], wwn[ALUA_SECONDARY_METADATA_WWN_LEN];
995 memset(path, 0, ALUA_METADATA_PATH_LEN);
996 memset(wwn, 0, ALUA_SECONDARY_METADATA_WWN_LEN);
998 len = snprintf(wwn, ALUA_SECONDARY_METADATA_WWN_LEN, "%s",
999 se_tpg->se_tpg_tfo->tpg_get_wwn(se_tpg));
1001 if (se_tpg->se_tpg_tfo->tpg_get_tag != NULL)
1002 snprintf(wwn+len, ALUA_SECONDARY_METADATA_WWN_LEN-len, "+%hu",
1003 se_tpg->se_tpg_tfo->tpg_get_tag(se_tpg));
1005 len = snprintf(md_buf, md_buf_len, "alua_tg_pt_offline=%d\n"
1006 "alua_tg_pt_status=0x%02x\n",
1007 atomic_read(&port->sep_tg_pt_secondary_offline),
1008 port->sep_tg_pt_secondary_stat);
1010 snprintf(path, ALUA_METADATA_PATH_LEN, "/var/target/alua/%s/%s/lun_%u",
1011 se_tpg->se_tpg_tfo->get_fabric_name(), wwn,
1012 port->sep_lun->unpacked_lun);
1014 return core_alua_write_tpg_metadata(path, md_buf, len);
1017 static int core_alua_set_tg_pt_secondary_state(
1018 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
1019 struct se_port *port,
1023 struct t10_alua_tg_pt_gp *tg_pt_gp;
1024 unsigned char *md_buf;
1026 int trans_delay_msecs;
1028 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1029 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1031 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1032 pr_err("Unable to complete secondary state"
1036 trans_delay_msecs = tg_pt_gp->tg_pt_gp_trans_delay_msecs;
1038 * Set the secondary ALUA target port access state to OFFLINE
1039 * or release the previously secondary state for struct se_port
1042 atomic_set(&port->sep_tg_pt_secondary_offline, 1);
1044 atomic_set(&port->sep_tg_pt_secondary_offline, 0);
1046 md_buf_len = tg_pt_gp->tg_pt_gp_md_buf_len;
1047 port->sep_tg_pt_secondary_stat = (explict) ?
1048 ALUA_STATUS_ALTERED_BY_EXPLICT_STPG :
1049 ALUA_STATUS_ALTERED_BY_IMPLICT_ALUA;
1051 pr_debug("Successful %s ALUA transition TG PT Group: %s ID: %hu"
1052 " to secondary access state: %s\n", (explict) ? "explict" :
1053 "implict", config_item_name(&tg_pt_gp->tg_pt_gp_group.cg_item),
1054 tg_pt_gp->tg_pt_gp_id, (offline) ? "OFFLINE" : "ONLINE");
1056 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1058 * Do the optional transition delay after we set the secondary
1059 * ALUA access state.
1061 if (trans_delay_msecs != 0)
1062 msleep_interruptible(trans_delay_msecs);
1064 * See if we need to update the ALUA fabric port metadata for
1065 * secondary state and status
1067 if (port->sep_tg_pt_secondary_write_md) {
1068 md_buf = kzalloc(md_buf_len, GFP_KERNEL);
1070 pr_err("Unable to allocate md_buf for"
1071 " secondary ALUA access metadata\n");
1074 mutex_lock(&port->sep_tg_pt_md_mutex);
1075 core_alua_update_tpg_secondary_metadata(tg_pt_gp_mem, port,
1076 md_buf, md_buf_len);
1077 mutex_unlock(&port->sep_tg_pt_md_mutex);
1085 struct t10_alua_lu_gp *
1086 core_alua_allocate_lu_gp(const char *name, int def_group)
1088 struct t10_alua_lu_gp *lu_gp;
1090 lu_gp = kmem_cache_zalloc(t10_alua_lu_gp_cache, GFP_KERNEL);
1092 pr_err("Unable to allocate struct t10_alua_lu_gp\n");
1093 return ERR_PTR(-ENOMEM);
1095 INIT_LIST_HEAD(&lu_gp->lu_gp_node);
1096 INIT_LIST_HEAD(&lu_gp->lu_gp_mem_list);
1097 spin_lock_init(&lu_gp->lu_gp_lock);
1098 atomic_set(&lu_gp->lu_gp_ref_cnt, 0);
1101 lu_gp->lu_gp_id = alua_lu_gps_counter++;
1102 lu_gp->lu_gp_valid_id = 1;
1103 alua_lu_gps_count++;
1109 int core_alua_set_lu_gp_id(struct t10_alua_lu_gp *lu_gp, u16 lu_gp_id)
1111 struct t10_alua_lu_gp *lu_gp_tmp;
1114 * The lu_gp->lu_gp_id may only be set once..
1116 if (lu_gp->lu_gp_valid_id) {
1117 pr_warn("ALUA LU Group already has a valid ID,"
1118 " ignoring request\n");
1122 spin_lock(&lu_gps_lock);
1123 if (alua_lu_gps_count == 0x0000ffff) {
1124 pr_err("Maximum ALUA alua_lu_gps_count:"
1125 " 0x0000ffff reached\n");
1126 spin_unlock(&lu_gps_lock);
1127 kmem_cache_free(t10_alua_lu_gp_cache, lu_gp);
1131 lu_gp_id_tmp = (lu_gp_id != 0) ? lu_gp_id :
1132 alua_lu_gps_counter++;
1134 list_for_each_entry(lu_gp_tmp, &lu_gps_list, lu_gp_node) {
1135 if (lu_gp_tmp->lu_gp_id == lu_gp_id_tmp) {
1139 pr_warn("ALUA Logical Unit Group ID: %hu"
1140 " already exists, ignoring request\n",
1142 spin_unlock(&lu_gps_lock);
1147 lu_gp->lu_gp_id = lu_gp_id_tmp;
1148 lu_gp->lu_gp_valid_id = 1;
1149 list_add_tail(&lu_gp->lu_gp_node, &lu_gps_list);
1150 alua_lu_gps_count++;
1151 spin_unlock(&lu_gps_lock);
1156 static struct t10_alua_lu_gp_member *
1157 core_alua_allocate_lu_gp_mem(struct se_device *dev)
1159 struct t10_alua_lu_gp_member *lu_gp_mem;
1161 lu_gp_mem = kmem_cache_zalloc(t10_alua_lu_gp_mem_cache, GFP_KERNEL);
1163 pr_err("Unable to allocate struct t10_alua_lu_gp_member\n");
1164 return ERR_PTR(-ENOMEM);
1166 INIT_LIST_HEAD(&lu_gp_mem->lu_gp_mem_list);
1167 spin_lock_init(&lu_gp_mem->lu_gp_mem_lock);
1168 atomic_set(&lu_gp_mem->lu_gp_mem_ref_cnt, 0);
1170 lu_gp_mem->lu_gp_mem_dev = dev;
1171 dev->dev_alua_lu_gp_mem = lu_gp_mem;
1176 void core_alua_free_lu_gp(struct t10_alua_lu_gp *lu_gp)
1178 struct t10_alua_lu_gp_member *lu_gp_mem, *lu_gp_mem_tmp;
1180 * Once we have reached this point, config_item_put() has
1181 * already been called from target_core_alua_drop_lu_gp().
1183 * Here, we remove the *lu_gp from the global list so that
1184 * no associations can be made while we are releasing
1185 * struct t10_alua_lu_gp.
1187 spin_lock(&lu_gps_lock);
1188 list_del(&lu_gp->lu_gp_node);
1189 alua_lu_gps_count--;
1190 spin_unlock(&lu_gps_lock);
1192 * Allow struct t10_alua_lu_gp * referenced by core_alua_get_lu_gp_by_name()
1193 * in target_core_configfs.c:target_core_store_alua_lu_gp() to be
1194 * released with core_alua_put_lu_gp_from_name()
1196 while (atomic_read(&lu_gp->lu_gp_ref_cnt))
1199 * Release reference to struct t10_alua_lu_gp * from all associated
1202 spin_lock(&lu_gp->lu_gp_lock);
1203 list_for_each_entry_safe(lu_gp_mem, lu_gp_mem_tmp,
1204 &lu_gp->lu_gp_mem_list, lu_gp_mem_list) {
1205 if (lu_gp_mem->lu_gp_assoc) {
1206 list_del(&lu_gp_mem->lu_gp_mem_list);
1207 lu_gp->lu_gp_members--;
1208 lu_gp_mem->lu_gp_assoc = 0;
1210 spin_unlock(&lu_gp->lu_gp_lock);
1213 * lu_gp_mem is associated with a single
1214 * struct se_device->dev_alua_lu_gp_mem, and is released when
1215 * struct se_device is released via core_alua_free_lu_gp_mem().
1217 * If the passed lu_gp does NOT match the default_lu_gp, assume
1218 * we want to re-assocate a given lu_gp_mem with default_lu_gp.
1220 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
1221 if (lu_gp != default_lu_gp)
1222 __core_alua_attach_lu_gp_mem(lu_gp_mem,
1225 lu_gp_mem->lu_gp = NULL;
1226 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
1228 spin_lock(&lu_gp->lu_gp_lock);
1230 spin_unlock(&lu_gp->lu_gp_lock);
1232 kmem_cache_free(t10_alua_lu_gp_cache, lu_gp);
1235 void core_alua_free_lu_gp_mem(struct se_device *dev)
1237 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
1238 struct t10_alua *alua = &su_dev->t10_alua;
1239 struct t10_alua_lu_gp *lu_gp;
1240 struct t10_alua_lu_gp_member *lu_gp_mem;
1242 if (alua->alua_type != SPC3_ALUA_EMULATED)
1245 lu_gp_mem = dev->dev_alua_lu_gp_mem;
1249 while (atomic_read(&lu_gp_mem->lu_gp_mem_ref_cnt))
1252 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
1253 lu_gp = lu_gp_mem->lu_gp;
1255 spin_lock(&lu_gp->lu_gp_lock);
1256 if (lu_gp_mem->lu_gp_assoc) {
1257 list_del(&lu_gp_mem->lu_gp_mem_list);
1258 lu_gp->lu_gp_members--;
1259 lu_gp_mem->lu_gp_assoc = 0;
1261 spin_unlock(&lu_gp->lu_gp_lock);
1262 lu_gp_mem->lu_gp = NULL;
1264 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
1266 kmem_cache_free(t10_alua_lu_gp_mem_cache, lu_gp_mem);
1269 struct t10_alua_lu_gp *core_alua_get_lu_gp_by_name(const char *name)
1271 struct t10_alua_lu_gp *lu_gp;
1272 struct config_item *ci;
1274 spin_lock(&lu_gps_lock);
1275 list_for_each_entry(lu_gp, &lu_gps_list, lu_gp_node) {
1276 if (!lu_gp->lu_gp_valid_id)
1278 ci = &lu_gp->lu_gp_group.cg_item;
1279 if (!strcmp(config_item_name(ci), name)) {
1280 atomic_inc(&lu_gp->lu_gp_ref_cnt);
1281 spin_unlock(&lu_gps_lock);
1285 spin_unlock(&lu_gps_lock);
1290 void core_alua_put_lu_gp_from_name(struct t10_alua_lu_gp *lu_gp)
1292 spin_lock(&lu_gps_lock);
1293 atomic_dec(&lu_gp->lu_gp_ref_cnt);
1294 spin_unlock(&lu_gps_lock);
1298 * Called with struct t10_alua_lu_gp_member->lu_gp_mem_lock
1300 void __core_alua_attach_lu_gp_mem(
1301 struct t10_alua_lu_gp_member *lu_gp_mem,
1302 struct t10_alua_lu_gp *lu_gp)
1304 spin_lock(&lu_gp->lu_gp_lock);
1305 lu_gp_mem->lu_gp = lu_gp;
1306 lu_gp_mem->lu_gp_assoc = 1;
1307 list_add_tail(&lu_gp_mem->lu_gp_mem_list, &lu_gp->lu_gp_mem_list);
1308 lu_gp->lu_gp_members++;
1309 spin_unlock(&lu_gp->lu_gp_lock);
1313 * Called with struct t10_alua_lu_gp_member->lu_gp_mem_lock
1315 void __core_alua_drop_lu_gp_mem(
1316 struct t10_alua_lu_gp_member *lu_gp_mem,
1317 struct t10_alua_lu_gp *lu_gp)
1319 spin_lock(&lu_gp->lu_gp_lock);
1320 list_del(&lu_gp_mem->lu_gp_mem_list);
1321 lu_gp_mem->lu_gp = NULL;
1322 lu_gp_mem->lu_gp_assoc = 0;
1323 lu_gp->lu_gp_members--;
1324 spin_unlock(&lu_gp->lu_gp_lock);
1327 struct t10_alua_tg_pt_gp *core_alua_allocate_tg_pt_gp(
1328 struct se_subsystem_dev *su_dev,
1332 struct t10_alua_tg_pt_gp *tg_pt_gp;
1334 tg_pt_gp = kmem_cache_zalloc(t10_alua_tg_pt_gp_cache, GFP_KERNEL);
1336 pr_err("Unable to allocate struct t10_alua_tg_pt_gp\n");
1339 INIT_LIST_HEAD(&tg_pt_gp->tg_pt_gp_list);
1340 INIT_LIST_HEAD(&tg_pt_gp->tg_pt_gp_mem_list);
1341 mutex_init(&tg_pt_gp->tg_pt_gp_md_mutex);
1342 spin_lock_init(&tg_pt_gp->tg_pt_gp_lock);
1343 atomic_set(&tg_pt_gp->tg_pt_gp_ref_cnt, 0);
1344 tg_pt_gp->tg_pt_gp_su_dev = su_dev;
1345 tg_pt_gp->tg_pt_gp_md_buf_len = ALUA_MD_BUF_LEN;
1346 atomic_set(&tg_pt_gp->tg_pt_gp_alua_access_state,
1347 ALUA_ACCESS_STATE_ACTIVE_OPTMIZED);
1349 * Enable both explict and implict ALUA support by default
1351 tg_pt_gp->tg_pt_gp_alua_access_type =
1352 TPGS_EXPLICT_ALUA | TPGS_IMPLICT_ALUA;
1354 * Set the default Active/NonOptimized Delay in milliseconds
1356 tg_pt_gp->tg_pt_gp_nonop_delay_msecs = ALUA_DEFAULT_NONOP_DELAY_MSECS;
1357 tg_pt_gp->tg_pt_gp_trans_delay_msecs = ALUA_DEFAULT_TRANS_DELAY_MSECS;
1360 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1361 tg_pt_gp->tg_pt_gp_id =
1362 su_dev->t10_alua.alua_tg_pt_gps_counter++;
1363 tg_pt_gp->tg_pt_gp_valid_id = 1;
1364 su_dev->t10_alua.alua_tg_pt_gps_count++;
1365 list_add_tail(&tg_pt_gp->tg_pt_gp_list,
1366 &su_dev->t10_alua.tg_pt_gps_list);
1367 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1373 int core_alua_set_tg_pt_gp_id(
1374 struct t10_alua_tg_pt_gp *tg_pt_gp,
1377 struct se_subsystem_dev *su_dev = tg_pt_gp->tg_pt_gp_su_dev;
1378 struct t10_alua_tg_pt_gp *tg_pt_gp_tmp;
1379 u16 tg_pt_gp_id_tmp;
1381 * The tg_pt_gp->tg_pt_gp_id may only be set once..
1383 if (tg_pt_gp->tg_pt_gp_valid_id) {
1384 pr_warn("ALUA TG PT Group already has a valid ID,"
1385 " ignoring request\n");
1389 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1390 if (su_dev->t10_alua.alua_tg_pt_gps_count == 0x0000ffff) {
1391 pr_err("Maximum ALUA alua_tg_pt_gps_count:"
1392 " 0x0000ffff reached\n");
1393 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1394 kmem_cache_free(t10_alua_tg_pt_gp_cache, tg_pt_gp);
1398 tg_pt_gp_id_tmp = (tg_pt_gp_id != 0) ? tg_pt_gp_id :
1399 su_dev->t10_alua.alua_tg_pt_gps_counter++;
1401 list_for_each_entry(tg_pt_gp_tmp, &su_dev->t10_alua.tg_pt_gps_list,
1403 if (tg_pt_gp_tmp->tg_pt_gp_id == tg_pt_gp_id_tmp) {
1407 pr_err("ALUA Target Port Group ID: %hu already"
1408 " exists, ignoring request\n", tg_pt_gp_id);
1409 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1414 tg_pt_gp->tg_pt_gp_id = tg_pt_gp_id_tmp;
1415 tg_pt_gp->tg_pt_gp_valid_id = 1;
1416 list_add_tail(&tg_pt_gp->tg_pt_gp_list,
1417 &su_dev->t10_alua.tg_pt_gps_list);
1418 su_dev->t10_alua.alua_tg_pt_gps_count++;
1419 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1424 struct t10_alua_tg_pt_gp_member *core_alua_allocate_tg_pt_gp_mem(
1425 struct se_port *port)
1427 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1429 tg_pt_gp_mem = kmem_cache_zalloc(t10_alua_tg_pt_gp_mem_cache,
1431 if (!tg_pt_gp_mem) {
1432 pr_err("Unable to allocate struct t10_alua_tg_pt_gp_member\n");
1433 return ERR_PTR(-ENOMEM);
1435 INIT_LIST_HEAD(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1436 spin_lock_init(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1437 atomic_set(&tg_pt_gp_mem->tg_pt_gp_mem_ref_cnt, 0);
1439 tg_pt_gp_mem->tg_pt = port;
1440 port->sep_alua_tg_pt_gp_mem = tg_pt_gp_mem;
1442 return tg_pt_gp_mem;
1445 void core_alua_free_tg_pt_gp(
1446 struct t10_alua_tg_pt_gp *tg_pt_gp)
1448 struct se_subsystem_dev *su_dev = tg_pt_gp->tg_pt_gp_su_dev;
1449 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem, *tg_pt_gp_mem_tmp;
1451 * Once we have reached this point, config_item_put() has already
1452 * been called from target_core_alua_drop_tg_pt_gp().
1454 * Here we remove *tg_pt_gp from the global list so that
1455 * no assications *OR* explict ALUA via SET_TARGET_PORT_GROUPS
1456 * can be made while we are releasing struct t10_alua_tg_pt_gp.
1458 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1459 list_del(&tg_pt_gp->tg_pt_gp_list);
1460 su_dev->t10_alua.alua_tg_pt_gps_counter--;
1461 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1463 * Allow a struct t10_alua_tg_pt_gp_member * referenced by
1464 * core_alua_get_tg_pt_gp_by_name() in
1465 * target_core_configfs.c:target_core_store_alua_tg_pt_gp()
1466 * to be released with core_alua_put_tg_pt_gp_from_name().
1468 while (atomic_read(&tg_pt_gp->tg_pt_gp_ref_cnt))
1471 * Release reference to struct t10_alua_tg_pt_gp from all associated
1474 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1475 list_for_each_entry_safe(tg_pt_gp_mem, tg_pt_gp_mem_tmp,
1476 &tg_pt_gp->tg_pt_gp_mem_list, tg_pt_gp_mem_list) {
1477 if (tg_pt_gp_mem->tg_pt_gp_assoc) {
1478 list_del(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1479 tg_pt_gp->tg_pt_gp_members--;
1480 tg_pt_gp_mem->tg_pt_gp_assoc = 0;
1482 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1484 * tg_pt_gp_mem is associated with a single
1485 * se_port->sep_alua_tg_pt_gp_mem, and is released via
1486 * core_alua_free_tg_pt_gp_mem().
1488 * If the passed tg_pt_gp does NOT match the default_tg_pt_gp,
1489 * assume we want to re-assocate a given tg_pt_gp_mem with
1492 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1493 if (tg_pt_gp != su_dev->t10_alua.default_tg_pt_gp) {
1494 __core_alua_attach_tg_pt_gp_mem(tg_pt_gp_mem,
1495 su_dev->t10_alua.default_tg_pt_gp);
1497 tg_pt_gp_mem->tg_pt_gp = NULL;
1498 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1500 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1502 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1504 kmem_cache_free(t10_alua_tg_pt_gp_cache, tg_pt_gp);
1507 void core_alua_free_tg_pt_gp_mem(struct se_port *port)
1509 struct se_subsystem_dev *su_dev = port->sep_lun->lun_se_dev->se_sub_dev;
1510 struct t10_alua *alua = &su_dev->t10_alua;
1511 struct t10_alua_tg_pt_gp *tg_pt_gp;
1512 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1514 if (alua->alua_type != SPC3_ALUA_EMULATED)
1517 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
1521 while (atomic_read(&tg_pt_gp_mem->tg_pt_gp_mem_ref_cnt))
1524 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1525 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1527 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1528 if (tg_pt_gp_mem->tg_pt_gp_assoc) {
1529 list_del(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1530 tg_pt_gp->tg_pt_gp_members--;
1531 tg_pt_gp_mem->tg_pt_gp_assoc = 0;
1533 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1534 tg_pt_gp_mem->tg_pt_gp = NULL;
1536 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1538 kmem_cache_free(t10_alua_tg_pt_gp_mem_cache, tg_pt_gp_mem);
1541 static struct t10_alua_tg_pt_gp *core_alua_get_tg_pt_gp_by_name(
1542 struct se_subsystem_dev *su_dev,
1545 struct t10_alua_tg_pt_gp *tg_pt_gp;
1546 struct config_item *ci;
1548 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1549 list_for_each_entry(tg_pt_gp, &su_dev->t10_alua.tg_pt_gps_list,
1551 if (!tg_pt_gp->tg_pt_gp_valid_id)
1553 ci = &tg_pt_gp->tg_pt_gp_group.cg_item;
1554 if (!strcmp(config_item_name(ci), name)) {
1555 atomic_inc(&tg_pt_gp->tg_pt_gp_ref_cnt);
1556 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1560 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1565 static void core_alua_put_tg_pt_gp_from_name(
1566 struct t10_alua_tg_pt_gp *tg_pt_gp)
1568 struct se_subsystem_dev *su_dev = tg_pt_gp->tg_pt_gp_su_dev;
1570 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1571 atomic_dec(&tg_pt_gp->tg_pt_gp_ref_cnt);
1572 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1576 * Called with struct t10_alua_tg_pt_gp_member->tg_pt_gp_mem_lock held
1578 void __core_alua_attach_tg_pt_gp_mem(
1579 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
1580 struct t10_alua_tg_pt_gp *tg_pt_gp)
1582 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1583 tg_pt_gp_mem->tg_pt_gp = tg_pt_gp;
1584 tg_pt_gp_mem->tg_pt_gp_assoc = 1;
1585 list_add_tail(&tg_pt_gp_mem->tg_pt_gp_mem_list,
1586 &tg_pt_gp->tg_pt_gp_mem_list);
1587 tg_pt_gp->tg_pt_gp_members++;
1588 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1592 * Called with struct t10_alua_tg_pt_gp_member->tg_pt_gp_mem_lock held
1594 static void __core_alua_drop_tg_pt_gp_mem(
1595 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
1596 struct t10_alua_tg_pt_gp *tg_pt_gp)
1598 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1599 list_del(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1600 tg_pt_gp_mem->tg_pt_gp = NULL;
1601 tg_pt_gp_mem->tg_pt_gp_assoc = 0;
1602 tg_pt_gp->tg_pt_gp_members--;
1603 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1606 ssize_t core_alua_show_tg_pt_gp_info(struct se_port *port, char *page)
1608 struct se_subsystem_dev *su_dev = port->sep_lun->lun_se_dev->se_sub_dev;
1609 struct config_item *tg_pt_ci;
1610 struct t10_alua *alua = &su_dev->t10_alua;
1611 struct t10_alua_tg_pt_gp *tg_pt_gp;
1612 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1615 if (alua->alua_type != SPC3_ALUA_EMULATED)
1618 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
1622 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1623 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1625 tg_pt_ci = &tg_pt_gp->tg_pt_gp_group.cg_item;
1626 len += sprintf(page, "TG Port Alias: %s\nTG Port Group ID:"
1627 " %hu\nTG Port Primary Access State: %s\nTG Port "
1628 "Primary Access Status: %s\nTG Port Secondary Access"
1629 " State: %s\nTG Port Secondary Access Status: %s\n",
1630 config_item_name(tg_pt_ci), tg_pt_gp->tg_pt_gp_id,
1631 core_alua_dump_state(atomic_read(
1632 &tg_pt_gp->tg_pt_gp_alua_access_state)),
1633 core_alua_dump_status(
1634 tg_pt_gp->tg_pt_gp_alua_access_status),
1635 (atomic_read(&port->sep_tg_pt_secondary_offline)) ?
1637 core_alua_dump_status(port->sep_tg_pt_secondary_stat));
1639 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1644 ssize_t core_alua_store_tg_pt_gp_info(
1645 struct se_port *port,
1649 struct se_portal_group *tpg;
1651 struct se_subsystem_dev *su_dev = port->sep_lun->lun_se_dev->se_sub_dev;
1652 struct t10_alua_tg_pt_gp *tg_pt_gp = NULL, *tg_pt_gp_new = NULL;
1653 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1654 unsigned char buf[TG_PT_GROUP_NAME_BUF];
1657 tpg = port->sep_tpg;
1658 lun = port->sep_lun;
1660 if (su_dev->t10_alua.alua_type != SPC3_ALUA_EMULATED) {
1661 pr_warn("SPC3_ALUA_EMULATED not enabled for"
1662 " %s/tpgt_%hu/%s\n", tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1663 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1664 config_item_name(&lun->lun_group.cg_item));
1668 if (count > TG_PT_GROUP_NAME_BUF) {
1669 pr_err("ALUA Target Port Group alias too large!\n");
1672 memset(buf, 0, TG_PT_GROUP_NAME_BUF);
1673 memcpy(buf, page, count);
1675 * Any ALUA target port group alias besides "NULL" means we will be
1676 * making a new group association.
1678 if (strcmp(strstrip(buf), "NULL")) {
1680 * core_alua_get_tg_pt_gp_by_name() will increment reference to
1681 * struct t10_alua_tg_pt_gp. This reference is released with
1682 * core_alua_put_tg_pt_gp_from_name() below.
1684 tg_pt_gp_new = core_alua_get_tg_pt_gp_by_name(su_dev,
1689 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
1690 if (!tg_pt_gp_mem) {
1692 core_alua_put_tg_pt_gp_from_name(tg_pt_gp_new);
1693 pr_err("NULL struct se_port->sep_alua_tg_pt_gp_mem pointer\n");
1697 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1698 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1701 * Clearing an existing tg_pt_gp association, and replacing
1702 * with the default_tg_pt_gp.
1704 if (!tg_pt_gp_new) {
1705 pr_debug("Target_Core_ConfigFS: Moving"
1706 " %s/tpgt_%hu/%s from ALUA Target Port Group:"
1707 " alua/%s, ID: %hu back to"
1708 " default_tg_pt_gp\n",
1709 tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1710 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1711 config_item_name(&lun->lun_group.cg_item),
1713 &tg_pt_gp->tg_pt_gp_group.cg_item),
1714 tg_pt_gp->tg_pt_gp_id);
1716 __core_alua_drop_tg_pt_gp_mem(tg_pt_gp_mem, tg_pt_gp);
1717 __core_alua_attach_tg_pt_gp_mem(tg_pt_gp_mem,
1718 su_dev->t10_alua.default_tg_pt_gp);
1719 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1724 * Removing existing association of tg_pt_gp_mem with tg_pt_gp
1726 __core_alua_drop_tg_pt_gp_mem(tg_pt_gp_mem, tg_pt_gp);
1730 * Associate tg_pt_gp_mem with tg_pt_gp_new.
1732 __core_alua_attach_tg_pt_gp_mem(tg_pt_gp_mem, tg_pt_gp_new);
1733 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1734 pr_debug("Target_Core_ConfigFS: %s %s/tpgt_%hu/%s to ALUA"
1735 " Target Port Group: alua/%s, ID: %hu\n", (move) ?
1736 "Moving" : "Adding", tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1737 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1738 config_item_name(&lun->lun_group.cg_item),
1739 config_item_name(&tg_pt_gp_new->tg_pt_gp_group.cg_item),
1740 tg_pt_gp_new->tg_pt_gp_id);
1742 core_alua_put_tg_pt_gp_from_name(tg_pt_gp_new);
1746 ssize_t core_alua_show_access_type(
1747 struct t10_alua_tg_pt_gp *tg_pt_gp,
1750 if ((tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_EXPLICT_ALUA) &&
1751 (tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_IMPLICT_ALUA))
1752 return sprintf(page, "Implict and Explict\n");
1753 else if (tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_IMPLICT_ALUA)
1754 return sprintf(page, "Implict\n");
1755 else if (tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_EXPLICT_ALUA)
1756 return sprintf(page, "Explict\n");
1758 return sprintf(page, "None\n");
1761 ssize_t core_alua_store_access_type(
1762 struct t10_alua_tg_pt_gp *tg_pt_gp,
1769 ret = strict_strtoul(page, 0, &tmp);
1771 pr_err("Unable to extract alua_access_type\n");
1774 if ((tmp != 0) && (tmp != 1) && (tmp != 2) && (tmp != 3)) {
1775 pr_err("Illegal value for alua_access_type:"
1780 tg_pt_gp->tg_pt_gp_alua_access_type =
1781 TPGS_IMPLICT_ALUA | TPGS_EXPLICT_ALUA;
1783 tg_pt_gp->tg_pt_gp_alua_access_type = TPGS_EXPLICT_ALUA;
1785 tg_pt_gp->tg_pt_gp_alua_access_type = TPGS_IMPLICT_ALUA;
1787 tg_pt_gp->tg_pt_gp_alua_access_type = 0;
1792 ssize_t core_alua_show_nonop_delay_msecs(
1793 struct t10_alua_tg_pt_gp *tg_pt_gp,
1796 return sprintf(page, "%d\n", tg_pt_gp->tg_pt_gp_nonop_delay_msecs);
1799 ssize_t core_alua_store_nonop_delay_msecs(
1800 struct t10_alua_tg_pt_gp *tg_pt_gp,
1807 ret = strict_strtoul(page, 0, &tmp);
1809 pr_err("Unable to extract nonop_delay_msecs\n");
1812 if (tmp > ALUA_MAX_NONOP_DELAY_MSECS) {
1813 pr_err("Passed nonop_delay_msecs: %lu, exceeds"
1814 " ALUA_MAX_NONOP_DELAY_MSECS: %d\n", tmp,
1815 ALUA_MAX_NONOP_DELAY_MSECS);
1818 tg_pt_gp->tg_pt_gp_nonop_delay_msecs = (int)tmp;
1823 ssize_t core_alua_show_trans_delay_msecs(
1824 struct t10_alua_tg_pt_gp *tg_pt_gp,
1827 return sprintf(page, "%d\n", tg_pt_gp->tg_pt_gp_trans_delay_msecs);
1830 ssize_t core_alua_store_trans_delay_msecs(
1831 struct t10_alua_tg_pt_gp *tg_pt_gp,
1838 ret = strict_strtoul(page, 0, &tmp);
1840 pr_err("Unable to extract trans_delay_msecs\n");
1843 if (tmp > ALUA_MAX_TRANS_DELAY_MSECS) {
1844 pr_err("Passed trans_delay_msecs: %lu, exceeds"
1845 " ALUA_MAX_TRANS_DELAY_MSECS: %d\n", tmp,
1846 ALUA_MAX_TRANS_DELAY_MSECS);
1849 tg_pt_gp->tg_pt_gp_trans_delay_msecs = (int)tmp;
1854 ssize_t core_alua_show_preferred_bit(
1855 struct t10_alua_tg_pt_gp *tg_pt_gp,
1858 return sprintf(page, "%d\n", tg_pt_gp->tg_pt_gp_pref);
1861 ssize_t core_alua_store_preferred_bit(
1862 struct t10_alua_tg_pt_gp *tg_pt_gp,
1869 ret = strict_strtoul(page, 0, &tmp);
1871 pr_err("Unable to extract preferred ALUA value\n");
1874 if ((tmp != 0) && (tmp != 1)) {
1875 pr_err("Illegal value for preferred ALUA: %lu\n", tmp);
1878 tg_pt_gp->tg_pt_gp_pref = (int)tmp;
1883 ssize_t core_alua_show_offline_bit(struct se_lun *lun, char *page)
1888 return sprintf(page, "%d\n",
1889 atomic_read(&lun->lun_sep->sep_tg_pt_secondary_offline));
1892 ssize_t core_alua_store_offline_bit(
1897 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1904 ret = strict_strtoul(page, 0, &tmp);
1906 pr_err("Unable to extract alua_tg_pt_offline value\n");
1909 if ((tmp != 0) && (tmp != 1)) {
1910 pr_err("Illegal value for alua_tg_pt_offline: %lu\n",
1914 tg_pt_gp_mem = lun->lun_sep->sep_alua_tg_pt_gp_mem;
1915 if (!tg_pt_gp_mem) {
1916 pr_err("Unable to locate *tg_pt_gp_mem\n");
1920 ret = core_alua_set_tg_pt_secondary_state(tg_pt_gp_mem,
1921 lun->lun_sep, 0, (int)tmp);
1928 ssize_t core_alua_show_secondary_status(
1932 return sprintf(page, "%d\n", lun->lun_sep->sep_tg_pt_secondary_stat);
1935 ssize_t core_alua_store_secondary_status(
1943 ret = strict_strtoul(page, 0, &tmp);
1945 pr_err("Unable to extract alua_tg_pt_status\n");
1948 if ((tmp != ALUA_STATUS_NONE) &&
1949 (tmp != ALUA_STATUS_ALTERED_BY_EXPLICT_STPG) &&
1950 (tmp != ALUA_STATUS_ALTERED_BY_IMPLICT_ALUA)) {
1951 pr_err("Illegal value for alua_tg_pt_status: %lu\n",
1955 lun->lun_sep->sep_tg_pt_secondary_stat = (int)tmp;
1960 ssize_t core_alua_show_secondary_write_metadata(
1964 return sprintf(page, "%d\n",
1965 lun->lun_sep->sep_tg_pt_secondary_write_md);
1968 ssize_t core_alua_store_secondary_write_metadata(
1976 ret = strict_strtoul(page, 0, &tmp);
1978 pr_err("Unable to extract alua_tg_pt_write_md\n");
1981 if ((tmp != 0) && (tmp != 1)) {
1982 pr_err("Illegal value for alua_tg_pt_write_md:"
1986 lun->lun_sep->sep_tg_pt_secondary_write_md = (int)tmp;
1991 int core_setup_alua(struct se_device *dev, int force_pt)
1993 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
1994 struct t10_alua *alua = &su_dev->t10_alua;
1995 struct t10_alua_lu_gp_member *lu_gp_mem;
1997 * If this device is from Target_Core_Mod/pSCSI, use the ALUA logic
1998 * of the Underlying SCSI hardware. In Linux/SCSI terms, this can
1999 * cause a problem because libata and some SATA RAID HBAs appear
2000 * under Linux/SCSI, but emulate SCSI logic themselves.
2002 if (((dev->transport->transport_type == TRANSPORT_PLUGIN_PHBA_PDEV) &&
2003 !(dev->se_sub_dev->se_dev_attrib.emulate_alua)) || force_pt) {
2004 alua->alua_type = SPC_ALUA_PASSTHROUGH;
2005 alua->alua_state_check = &core_alua_state_check_nop;
2006 pr_debug("%s: Using SPC_ALUA_PASSTHROUGH, no ALUA"
2007 " emulation\n", dev->transport->name);
2011 * If SPC-3 or above is reported by real or emulated struct se_device,
2012 * use emulated ALUA.
2014 if (dev->transport->get_device_rev(dev) >= SCSI_3) {
2015 pr_debug("%s: Enabling ALUA Emulation for SPC-3"
2016 " device\n", dev->transport->name);
2018 * Associate this struct se_device with the default ALUA
2021 lu_gp_mem = core_alua_allocate_lu_gp_mem(dev);
2022 if (IS_ERR(lu_gp_mem))
2023 return PTR_ERR(lu_gp_mem);
2025 alua->alua_type = SPC3_ALUA_EMULATED;
2026 alua->alua_state_check = &core_alua_state_check;
2027 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
2028 __core_alua_attach_lu_gp_mem(lu_gp_mem,
2030 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
2032 pr_debug("%s: Adding to default ALUA LU Group:"
2033 " core/alua/lu_gps/default_lu_gp\n",
2034 dev->transport->name);
2036 alua->alua_type = SPC2_ALUA_DISABLED;
2037 alua->alua_state_check = &core_alua_state_check_nop;
2038 pr_debug("%s: Disabling ALUA Emulation for SPC-2"
2039 " device\n", dev->transport->name);