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 <scsi/scsi.h>
31 #include <scsi/scsi_cmnd.h>
33 #include <target/target_core_base.h>
34 #include <target/target_core_device.h>
35 #include <target/target_core_transport.h>
36 #include <target/target_core_fabric_ops.h>
37 #include <target/target_core_configfs.h>
39 #include "target_core_alua.h"
40 #include "target_core_hba.h"
41 #include "target_core_ua.h"
43 static int core_alua_check_transition(int state, int *primary);
44 static int core_alua_set_tg_pt_secondary_state(
45 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
46 struct se_port *port, int explict, int offline);
48 static u16 alua_lu_gps_counter;
49 static u32 alua_lu_gps_count;
51 static DEFINE_SPINLOCK(lu_gps_lock);
52 static LIST_HEAD(lu_gps_list);
54 struct t10_alua_lu_gp *default_lu_gp;
57 * REPORT_TARGET_PORT_GROUPS
59 * See spc4r17 section 6.27
61 int core_emulate_report_target_port_groups(struct se_cmd *cmd)
63 struct se_subsystem_dev *su_dev = cmd->se_dev->se_sub_dev;
65 struct t10_alua_tg_pt_gp *tg_pt_gp;
66 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
68 u32 rd_len = 0, off = 4; /* Skip over RESERVED area to first
69 Target port group descriptor */
71 buf = transport_kmap_first_data_page(cmd);
73 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
74 list_for_each_entry(tg_pt_gp, &su_dev->t10_alua.tg_pt_gps_list,
77 * PREF: Preferred target port bit, determine if this
78 * bit should be set for port group.
80 if (tg_pt_gp->tg_pt_gp_pref)
83 * Set the ASYMMETRIC ACCESS State
85 buf[off++] |= (atomic_read(
86 &tg_pt_gp->tg_pt_gp_alua_access_state) & 0xff);
88 * Set supported ASYMMETRIC ACCESS State bits
90 buf[off] = 0x80; /* T_SUP */
91 buf[off] |= 0x40; /* O_SUP */
92 buf[off] |= 0x8; /* U_SUP */
93 buf[off] |= 0x4; /* S_SUP */
94 buf[off] |= 0x2; /* AN_SUP */
95 buf[off++] |= 0x1; /* AO_SUP */
99 buf[off++] = ((tg_pt_gp->tg_pt_gp_id >> 8) & 0xff);
100 buf[off++] = (tg_pt_gp->tg_pt_gp_id & 0xff);
102 off++; /* Skip over Reserved */
106 buf[off++] = (tg_pt_gp->tg_pt_gp_alua_access_status & 0xff);
108 * Vendor Specific field
114 buf[off++] = (tg_pt_gp->tg_pt_gp_members & 0xff);
117 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
118 list_for_each_entry(tg_pt_gp_mem, &tg_pt_gp->tg_pt_gp_mem_list,
120 port = tg_pt_gp_mem->tg_pt;
122 * Start Target Port descriptor format
124 * See spc4r17 section 6.2.7 Table 247
126 off += 2; /* Skip over Obsolete */
128 * Set RELATIVE TARGET PORT IDENTIFIER
130 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
131 buf[off++] = (port->sep_rtpi & 0xff);
134 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
136 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
138 * Set the RETURN DATA LENGTH set in the header of the DataIN Payload
140 buf[0] = ((rd_len >> 24) & 0xff);
141 buf[1] = ((rd_len >> 16) & 0xff);
142 buf[2] = ((rd_len >> 8) & 0xff);
143 buf[3] = (rd_len & 0xff);
145 transport_kunmap_first_data_page(cmd);
151 * SET_TARGET_PORT_GROUPS for explict ALUA operation.
153 * See spc4r17 section 6.35
155 int core_emulate_set_target_port_groups(struct se_cmd *cmd)
157 struct se_device *dev = cmd->se_dev;
158 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
159 struct se_port *port, *l_port = cmd->se_lun->lun_sep;
160 struct se_node_acl *nacl = cmd->se_sess->se_node_acl;
161 struct t10_alua_tg_pt_gp *tg_pt_gp = NULL, *l_tg_pt_gp;
162 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem, *l_tg_pt_gp_mem;
165 u32 len = 4; /* Skip over RESERVED area in header */
166 int alua_access_state, primary = 0, rc;
170 return PYX_TRANSPORT_LU_COMM_FAILURE;
172 buf = transport_kmap_first_data_page(cmd);
175 * Determine if explict ALUA via SET_TARGET_PORT_GROUPS is allowed
176 * for the local tg_pt_gp.
178 l_tg_pt_gp_mem = l_port->sep_alua_tg_pt_gp_mem;
179 if (!l_tg_pt_gp_mem) {
180 pr_err("Unable to access l_port->sep_alua_tg_pt_gp_mem\n");
181 rc = PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
184 spin_lock(&l_tg_pt_gp_mem->tg_pt_gp_mem_lock);
185 l_tg_pt_gp = l_tg_pt_gp_mem->tg_pt_gp;
187 spin_unlock(&l_tg_pt_gp_mem->tg_pt_gp_mem_lock);
188 pr_err("Unable to access *l_tg_pt_gp_mem->tg_pt_gp\n");
189 rc = PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
192 rc = (l_tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_EXPLICT_ALUA);
193 spin_unlock(&l_tg_pt_gp_mem->tg_pt_gp_mem_lock);
196 pr_debug("Unable to process SET_TARGET_PORT_GROUPS"
197 " while TPGS_EXPLICT_ALUA is disabled\n");
198 rc = PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
202 ptr = &buf[4]; /* Skip over RESERVED area in header */
204 while (len < cmd->data_length) {
205 alua_access_state = (ptr[0] & 0x0f);
207 * Check the received ALUA access state, and determine if
208 * the state is a primary or secondary target port asymmetric
211 rc = core_alua_check_transition(alua_access_state, &primary);
214 * If the SET TARGET PORT GROUPS attempts to establish
215 * an invalid combination of target port asymmetric
216 * access states or attempts to establish an
217 * unsupported target port asymmetric access state,
218 * then the command shall be terminated with CHECK
219 * CONDITION status, with the sense key set to ILLEGAL
220 * REQUEST, and the additional sense code set to INVALID
221 * FIELD IN PARAMETER LIST.
223 rc = PYX_TRANSPORT_INVALID_PARAMETER_LIST;
228 * If the ASYMMETRIC ACCESS STATE field (see table 267)
229 * specifies a primary target port asymmetric access state,
230 * then the TARGET PORT GROUP OR TARGET PORT field specifies
231 * a primary target port group for which the primary target
232 * port asymmetric access state shall be changed. If the
233 * ASYMMETRIC ACCESS STATE field specifies a secondary target
234 * port asymmetric access state, then the TARGET PORT GROUP OR
235 * TARGET PORT field specifies the relative target port
236 * identifier (see 3.1.120) of the target port for which the
237 * secondary target port asymmetric access state shall be
241 tg_pt_id = ((ptr[2] << 8) & 0xff);
242 tg_pt_id |= (ptr[3] & 0xff);
244 * Locate the matching target port group ID from
245 * the global tg_pt_gp list
247 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
248 list_for_each_entry(tg_pt_gp,
249 &su_dev->t10_alua.tg_pt_gps_list,
251 if (!tg_pt_gp->tg_pt_gp_valid_id)
254 if (tg_pt_id != tg_pt_gp->tg_pt_gp_id)
257 atomic_inc(&tg_pt_gp->tg_pt_gp_ref_cnt);
258 smp_mb__after_atomic_inc();
259 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
261 rc = core_alua_do_port_transition(tg_pt_gp,
263 alua_access_state, 1);
265 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
266 atomic_dec(&tg_pt_gp->tg_pt_gp_ref_cnt);
267 smp_mb__after_atomic_dec();
270 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
272 * If not matching target port group ID can be located
273 * throw an exception with ASCQ: INVALID_PARAMETER_LIST
276 rc = PYX_TRANSPORT_INVALID_PARAMETER_LIST;
281 * Extact the RELATIVE TARGET PORT IDENTIFIER to identify
282 * the Target Port in question for the the incoming
283 * SET_TARGET_PORT_GROUPS op.
285 rtpi = ((ptr[2] << 8) & 0xff);
286 rtpi |= (ptr[3] & 0xff);
288 * Locate the matching relative target port identifer
289 * for the struct se_device storage object.
291 spin_lock(&dev->se_port_lock);
292 list_for_each_entry(port, &dev->dev_sep_list,
294 if (port->sep_rtpi != rtpi)
297 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
298 spin_unlock(&dev->se_port_lock);
300 rc = core_alua_set_tg_pt_secondary_state(
301 tg_pt_gp_mem, port, 1, 1);
303 spin_lock(&dev->se_port_lock);
306 spin_unlock(&dev->se_port_lock);
308 * If not matching relative target port identifier can
309 * be located, throw an exception with ASCQ:
310 * INVALID_PARAMETER_LIST
313 rc = PYX_TRANSPORT_INVALID_PARAMETER_LIST;
323 transport_kunmap_first_data_page(cmd);
328 static inline int core_alua_state_nonoptimized(
331 int nonop_delay_msecs,
335 * Set SCF_ALUA_NON_OPTIMIZED here, this value will be checked
336 * later to determine if processing of this cmd needs to be
337 * temporarily delayed for the Active/NonOptimized primary access state.
339 cmd->se_cmd_flags |= SCF_ALUA_NON_OPTIMIZED;
340 cmd->alua_nonop_delay = nonop_delay_msecs;
344 static inline int core_alua_state_standby(
350 * Allowed CDBs for ALUA_ACCESS_STATE_STANDBY as defined by
351 * spc4r17 section 5.9.2.4.4
360 case RECEIVE_DIAGNOSTIC:
361 case SEND_DIAGNOSTIC:
364 case MI_REPORT_TARGET_PGS:
367 *alua_ascq = ASCQ_04H_ALUA_TG_PT_STANDBY;
370 case MAINTENANCE_OUT:
372 case MO_SET_TARGET_PGS:
375 *alua_ascq = ASCQ_04H_ALUA_TG_PT_STANDBY;
379 case PERSISTENT_RESERVE_IN:
380 case PERSISTENT_RESERVE_OUT:
385 *alua_ascq = ASCQ_04H_ALUA_TG_PT_STANDBY;
392 static inline int core_alua_state_unavailable(
398 * Allowed CDBs for ALUA_ACCESS_STATE_UNAVAILABLE as defined by
399 * spc4r17 section 5.9.2.4.5
406 case MI_REPORT_TARGET_PGS:
409 *alua_ascq = ASCQ_04H_ALUA_TG_PT_UNAVAILABLE;
412 case MAINTENANCE_OUT:
414 case MO_SET_TARGET_PGS:
417 *alua_ascq = ASCQ_04H_ALUA_TG_PT_UNAVAILABLE;
425 *alua_ascq = ASCQ_04H_ALUA_TG_PT_UNAVAILABLE;
432 static inline int core_alua_state_transition(
438 * Allowed CDBs for ALUA_ACCESS_STATE_TRANSITIO as defined by
439 * spc4r17 section 5.9.2.5
446 case MI_REPORT_TARGET_PGS:
449 *alua_ascq = ASCQ_04H_ALUA_STATE_TRANSITION;
457 *alua_ascq = ASCQ_04H_ALUA_STATE_TRANSITION;
465 * Used for alua_type SPC_ALUA_PASSTHROUGH and SPC2_ALUA_DISABLED
466 * in transport_cmd_sequencer(). This function is assigned to
467 * struct t10_alua *->state_check() in core_setup_alua()
469 static int core_alua_state_check_nop(
478 * Used for alua_type SPC3_ALUA_EMULATED in transport_cmd_sequencer().
479 * This function is assigned to struct t10_alua *->state_check() in
482 * Also, this function can return three different return codes to
483 * signal transport_generic_cmd_sequencer()
485 * return 1: Is used to signal LUN not accecsable, and check condition/not ready
486 * return 0: Used to signal success
487 * reutrn -1: Used to signal failure, and invalid cdb field
489 static int core_alua_state_check(
494 struct se_lun *lun = cmd->se_lun;
495 struct se_port *port = lun->lun_sep;
496 struct t10_alua_tg_pt_gp *tg_pt_gp;
497 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
498 int out_alua_state, nonop_delay_msecs;
503 * First, check for a struct se_port specific secondary ALUA target port
504 * access state: OFFLINE
506 if (atomic_read(&port->sep_tg_pt_secondary_offline)) {
507 *alua_ascq = ASCQ_04H_ALUA_OFFLINE;
508 pr_debug("ALUA: Got secondary offline status for local"
510 *alua_ascq = ASCQ_04H_ALUA_OFFLINE;
514 * Second, obtain the struct t10_alua_tg_pt_gp_member pointer to the
515 * ALUA target port group, to obtain current ALUA access state.
516 * Otherwise look for the underlying struct se_device association with
517 * a ALUA logical unit group.
519 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
520 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
521 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
522 out_alua_state = atomic_read(&tg_pt_gp->tg_pt_gp_alua_access_state);
523 nonop_delay_msecs = tg_pt_gp->tg_pt_gp_nonop_delay_msecs;
524 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
526 * Process ALUA_ACCESS_STATE_ACTIVE_OPTMIZED in a separate conditional
527 * statement so the compiler knows explicitly to check this case first.
528 * For the Optimized ALUA access state case, we want to process the
529 * incoming fabric cmd ASAP..
531 if (out_alua_state == ALUA_ACCESS_STATE_ACTIVE_OPTMIZED)
534 switch (out_alua_state) {
535 case ALUA_ACCESS_STATE_ACTIVE_NON_OPTIMIZED:
536 return core_alua_state_nonoptimized(cmd, cdb,
537 nonop_delay_msecs, alua_ascq);
538 case ALUA_ACCESS_STATE_STANDBY:
539 return core_alua_state_standby(cmd, cdb, alua_ascq);
540 case ALUA_ACCESS_STATE_UNAVAILABLE:
541 return core_alua_state_unavailable(cmd, cdb, alua_ascq);
542 case ALUA_ACCESS_STATE_TRANSITION:
543 return core_alua_state_transition(cmd, cdb, alua_ascq);
545 * OFFLINE is a secondary ALUA target port group access state, that is
546 * handled above with struct se_port->sep_tg_pt_secondary_offline=1
548 case ALUA_ACCESS_STATE_OFFLINE:
550 pr_err("Unknown ALUA access state: 0x%02x\n",
559 * Check implict and explict ALUA state change request.
561 static int core_alua_check_transition(int state, int *primary)
564 case ALUA_ACCESS_STATE_ACTIVE_OPTMIZED:
565 case ALUA_ACCESS_STATE_ACTIVE_NON_OPTIMIZED:
566 case ALUA_ACCESS_STATE_STANDBY:
567 case ALUA_ACCESS_STATE_UNAVAILABLE:
569 * OPTIMIZED, NON-OPTIMIZED, STANDBY and UNAVAILABLE are
570 * defined as primary target port asymmetric access states.
574 case ALUA_ACCESS_STATE_OFFLINE:
576 * OFFLINE state is defined as a secondary target port
577 * asymmetric access state.
582 pr_err("Unknown ALUA access state: 0x%02x\n", state);
589 static char *core_alua_dump_state(int state)
592 case ALUA_ACCESS_STATE_ACTIVE_OPTMIZED:
593 return "Active/Optimized";
594 case ALUA_ACCESS_STATE_ACTIVE_NON_OPTIMIZED:
595 return "Active/NonOptimized";
596 case ALUA_ACCESS_STATE_STANDBY:
598 case ALUA_ACCESS_STATE_UNAVAILABLE:
599 return "Unavailable";
600 case ALUA_ACCESS_STATE_OFFLINE:
609 char *core_alua_dump_status(int status)
612 case ALUA_STATUS_NONE:
614 case ALUA_STATUS_ALTERED_BY_EXPLICT_STPG:
615 return "Altered by Explict STPG";
616 case ALUA_STATUS_ALTERED_BY_IMPLICT_ALUA:
617 return "Altered by Implict ALUA";
626 * Used by fabric modules to determine when we need to delay processing
627 * for the Active/NonOptimized paths..
629 int core_alua_check_nonop_delay(
632 if (!(cmd->se_cmd_flags & SCF_ALUA_NON_OPTIMIZED))
637 * The ALUA Active/NonOptimized access state delay can be disabled
638 * in via configfs with a value of zero
640 if (!cmd->alua_nonop_delay)
643 * struct se_cmd->alua_nonop_delay gets set by a target port group
644 * defined interval in core_alua_state_nonoptimized()
646 msleep_interruptible(cmd->alua_nonop_delay);
649 EXPORT_SYMBOL(core_alua_check_nonop_delay);
652 * Called with tg_pt_gp->tg_pt_gp_md_mutex or tg_pt_gp_mem->sep_tg_pt_md_mutex
655 static int core_alua_write_tpg_metadata(
657 unsigned char *md_buf,
663 int flags = O_RDWR | O_CREAT | O_TRUNC, ret;
665 memset(iov, 0, sizeof(struct iovec));
667 file = filp_open(path, flags, 0600);
668 if (IS_ERR(file) || !file || !file->f_dentry) {
669 pr_err("filp_open(%s) for ALUA metadata failed\n",
674 iov[0].iov_base = &md_buf[0];
675 iov[0].iov_len = md_buf_len;
679 ret = vfs_writev(file, &iov[0], 1, &file->f_pos);
683 pr_err("Error writing ALUA metadata file: %s\n", path);
684 filp_close(file, NULL);
687 filp_close(file, NULL);
693 * Called with tg_pt_gp->tg_pt_gp_md_mutex held
695 static int core_alua_update_tpg_primary_metadata(
696 struct t10_alua_tg_pt_gp *tg_pt_gp,
698 unsigned char *md_buf)
700 struct se_subsystem_dev *su_dev = tg_pt_gp->tg_pt_gp_su_dev;
701 struct t10_wwn *wwn = &su_dev->t10_wwn;
702 char path[ALUA_METADATA_PATH_LEN];
705 memset(path, 0, ALUA_METADATA_PATH_LEN);
707 len = snprintf(md_buf, tg_pt_gp->tg_pt_gp_md_buf_len,
709 "alua_access_state=0x%02x\n"
710 "alua_access_status=0x%02x\n",
711 tg_pt_gp->tg_pt_gp_id, primary_state,
712 tg_pt_gp->tg_pt_gp_alua_access_status);
714 snprintf(path, ALUA_METADATA_PATH_LEN,
715 "/var/target/alua/tpgs_%s/%s", &wwn->unit_serial[0],
716 config_item_name(&tg_pt_gp->tg_pt_gp_group.cg_item));
718 return core_alua_write_tpg_metadata(path, md_buf, len);
721 static int core_alua_do_transition_tg_pt(
722 struct t10_alua_tg_pt_gp *tg_pt_gp,
723 struct se_port *l_port,
724 struct se_node_acl *nacl,
725 unsigned char *md_buf,
729 struct se_dev_entry *se_deve;
730 struct se_lun_acl *lacl;
731 struct se_port *port;
732 struct t10_alua_tg_pt_gp_member *mem;
735 * Save the old primary ALUA access state, and set the current state
736 * to ALUA_ACCESS_STATE_TRANSITION.
738 old_state = atomic_read(&tg_pt_gp->tg_pt_gp_alua_access_state);
739 atomic_set(&tg_pt_gp->tg_pt_gp_alua_access_state,
740 ALUA_ACCESS_STATE_TRANSITION);
741 tg_pt_gp->tg_pt_gp_alua_access_status = (explict) ?
742 ALUA_STATUS_ALTERED_BY_EXPLICT_STPG :
743 ALUA_STATUS_ALTERED_BY_IMPLICT_ALUA;
745 * Check for the optional ALUA primary state transition delay
747 if (tg_pt_gp->tg_pt_gp_trans_delay_msecs != 0)
748 msleep_interruptible(tg_pt_gp->tg_pt_gp_trans_delay_msecs);
750 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
751 list_for_each_entry(mem, &tg_pt_gp->tg_pt_gp_mem_list,
755 * After an implicit target port asymmetric access state
756 * change, a device server shall establish a unit attention
757 * condition for the initiator port associated with every I_T
758 * nexus with the additional sense code set to ASYMMETRIC
759 * ACCESS STATE CHAGED.
761 * After an explicit target port asymmetric access state
762 * change, a device server shall establish a unit attention
763 * condition with the additional sense code set to ASYMMETRIC
764 * ACCESS STATE CHANGED for the initiator port associated with
765 * every I_T nexus other than the I_T nexus on which the SET
766 * TARGET PORT GROUPS command
768 atomic_inc(&mem->tg_pt_gp_mem_ref_cnt);
769 smp_mb__after_atomic_inc();
770 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
772 spin_lock_bh(&port->sep_alua_lock);
773 list_for_each_entry(se_deve, &port->sep_alua_list,
775 lacl = se_deve->se_lun_acl;
777 * se_deve->se_lun_acl pointer may be NULL for a
778 * entry created without explict Node+MappedLUN ACLs
784 (nacl != NULL) && (nacl == lacl->se_lun_nacl) &&
785 (l_port != NULL) && (l_port == port))
788 core_scsi3_ua_allocate(lacl->se_lun_nacl,
789 se_deve->mapped_lun, 0x2A,
790 ASCQ_2AH_ASYMMETRIC_ACCESS_STATE_CHANGED);
792 spin_unlock_bh(&port->sep_alua_lock);
794 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
795 atomic_dec(&mem->tg_pt_gp_mem_ref_cnt);
796 smp_mb__after_atomic_dec();
798 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
800 * Update the ALUA metadata buf that has been allocated in
801 * core_alua_do_port_transition(), this metadata will be written
804 * Note that there is the case where we do not want to update the
805 * metadata when the saved metadata is being parsed in userspace
806 * when setting the existing port access state and access status.
808 * Also note that the failure to write out the ALUA metadata to
809 * struct file does NOT affect the actual ALUA transition.
811 if (tg_pt_gp->tg_pt_gp_write_metadata) {
812 mutex_lock(&tg_pt_gp->tg_pt_gp_md_mutex);
813 core_alua_update_tpg_primary_metadata(tg_pt_gp,
815 mutex_unlock(&tg_pt_gp->tg_pt_gp_md_mutex);
818 * Set the current primary ALUA access state to the requested new state
820 atomic_set(&tg_pt_gp->tg_pt_gp_alua_access_state, new_state);
822 pr_debug("Successful %s ALUA transition TG PT Group: %s ID: %hu"
823 " from primary access state %s to %s\n", (explict) ? "explict" :
824 "implict", config_item_name(&tg_pt_gp->tg_pt_gp_group.cg_item),
825 tg_pt_gp->tg_pt_gp_id, core_alua_dump_state(old_state),
826 core_alua_dump_state(new_state));
831 int core_alua_do_port_transition(
832 struct t10_alua_tg_pt_gp *l_tg_pt_gp,
833 struct se_device *l_dev,
834 struct se_port *l_port,
835 struct se_node_acl *l_nacl,
839 struct se_device *dev;
840 struct se_port *port;
841 struct se_subsystem_dev *su_dev;
842 struct se_node_acl *nacl;
843 struct t10_alua_lu_gp *lu_gp;
844 struct t10_alua_lu_gp_member *lu_gp_mem, *local_lu_gp_mem;
845 struct t10_alua_tg_pt_gp *tg_pt_gp;
846 unsigned char *md_buf;
849 if (core_alua_check_transition(new_state, &primary) != 0)
852 md_buf = kzalloc(l_tg_pt_gp->tg_pt_gp_md_buf_len, GFP_KERNEL);
854 pr_err("Unable to allocate buf for ALUA metadata\n");
858 local_lu_gp_mem = l_dev->dev_alua_lu_gp_mem;
859 spin_lock(&local_lu_gp_mem->lu_gp_mem_lock);
860 lu_gp = local_lu_gp_mem->lu_gp;
861 atomic_inc(&lu_gp->lu_gp_ref_cnt);
862 smp_mb__after_atomic_inc();
863 spin_unlock(&local_lu_gp_mem->lu_gp_mem_lock);
865 * For storage objects that are members of the 'default_lu_gp',
866 * we only do transition on the passed *l_tp_pt_gp, and not
867 * on all of the matching target port groups IDs in default_lu_gp.
869 if (!lu_gp->lu_gp_id) {
871 * core_alua_do_transition_tg_pt() will always return
874 core_alua_do_transition_tg_pt(l_tg_pt_gp, l_port, l_nacl,
875 md_buf, new_state, explict);
876 atomic_dec(&lu_gp->lu_gp_ref_cnt);
877 smp_mb__after_atomic_dec();
882 * For all other LU groups aside from 'default_lu_gp', walk all of
883 * the associated storage objects looking for a matching target port
884 * group ID from the local target port group.
886 spin_lock(&lu_gp->lu_gp_lock);
887 list_for_each_entry(lu_gp_mem, &lu_gp->lu_gp_mem_list,
890 dev = lu_gp_mem->lu_gp_mem_dev;
891 su_dev = dev->se_sub_dev;
892 atomic_inc(&lu_gp_mem->lu_gp_mem_ref_cnt);
893 smp_mb__after_atomic_inc();
894 spin_unlock(&lu_gp->lu_gp_lock);
896 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
897 list_for_each_entry(tg_pt_gp,
898 &su_dev->t10_alua.tg_pt_gps_list,
901 if (!tg_pt_gp->tg_pt_gp_valid_id)
904 * If the target behavior port asymmetric access state
905 * is changed for any target port group accessiable via
906 * a logical unit within a LU group, the target port
907 * behavior group asymmetric access states for the same
908 * target port group accessible via other logical units
909 * in that LU group will also change.
911 if (l_tg_pt_gp->tg_pt_gp_id != tg_pt_gp->tg_pt_gp_id)
914 if (l_tg_pt_gp == tg_pt_gp) {
921 atomic_inc(&tg_pt_gp->tg_pt_gp_ref_cnt);
922 smp_mb__after_atomic_inc();
923 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
925 * core_alua_do_transition_tg_pt() will always return
928 core_alua_do_transition_tg_pt(tg_pt_gp, port,
929 nacl, md_buf, new_state, explict);
931 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
932 atomic_dec(&tg_pt_gp->tg_pt_gp_ref_cnt);
933 smp_mb__after_atomic_dec();
935 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
937 spin_lock(&lu_gp->lu_gp_lock);
938 atomic_dec(&lu_gp_mem->lu_gp_mem_ref_cnt);
939 smp_mb__after_atomic_dec();
941 spin_unlock(&lu_gp->lu_gp_lock);
943 pr_debug("Successfully processed LU Group: %s all ALUA TG PT"
944 " Group IDs: %hu %s transition to primary state: %s\n",
945 config_item_name(&lu_gp->lu_gp_group.cg_item),
946 l_tg_pt_gp->tg_pt_gp_id, (explict) ? "explict" : "implict",
947 core_alua_dump_state(new_state));
949 atomic_dec(&lu_gp->lu_gp_ref_cnt);
950 smp_mb__after_atomic_dec();
956 * Called with tg_pt_gp_mem->sep_tg_pt_md_mutex held
958 static int core_alua_update_tpg_secondary_metadata(
959 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
960 struct se_port *port,
961 unsigned char *md_buf,
964 struct se_portal_group *se_tpg = port->sep_tpg;
965 char path[ALUA_METADATA_PATH_LEN], wwn[ALUA_SECONDARY_METADATA_WWN_LEN];
968 memset(path, 0, ALUA_METADATA_PATH_LEN);
969 memset(wwn, 0, ALUA_SECONDARY_METADATA_WWN_LEN);
971 len = snprintf(wwn, ALUA_SECONDARY_METADATA_WWN_LEN, "%s",
972 se_tpg->se_tpg_tfo->tpg_get_wwn(se_tpg));
974 if (se_tpg->se_tpg_tfo->tpg_get_tag != NULL)
975 snprintf(wwn+len, ALUA_SECONDARY_METADATA_WWN_LEN-len, "+%hu",
976 se_tpg->se_tpg_tfo->tpg_get_tag(se_tpg));
978 len = snprintf(md_buf, md_buf_len, "alua_tg_pt_offline=%d\n"
979 "alua_tg_pt_status=0x%02x\n",
980 atomic_read(&port->sep_tg_pt_secondary_offline),
981 port->sep_tg_pt_secondary_stat);
983 snprintf(path, ALUA_METADATA_PATH_LEN, "/var/target/alua/%s/%s/lun_%u",
984 se_tpg->se_tpg_tfo->get_fabric_name(), wwn,
985 port->sep_lun->unpacked_lun);
987 return core_alua_write_tpg_metadata(path, md_buf, len);
990 static int core_alua_set_tg_pt_secondary_state(
991 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
992 struct se_port *port,
996 struct t10_alua_tg_pt_gp *tg_pt_gp;
997 unsigned char *md_buf;
999 int trans_delay_msecs;
1001 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1002 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1004 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1005 pr_err("Unable to complete secondary state"
1009 trans_delay_msecs = tg_pt_gp->tg_pt_gp_trans_delay_msecs;
1011 * Set the secondary ALUA target port access state to OFFLINE
1012 * or release the previously secondary state for struct se_port
1015 atomic_set(&port->sep_tg_pt_secondary_offline, 1);
1017 atomic_set(&port->sep_tg_pt_secondary_offline, 0);
1019 md_buf_len = tg_pt_gp->tg_pt_gp_md_buf_len;
1020 port->sep_tg_pt_secondary_stat = (explict) ?
1021 ALUA_STATUS_ALTERED_BY_EXPLICT_STPG :
1022 ALUA_STATUS_ALTERED_BY_IMPLICT_ALUA;
1024 pr_debug("Successful %s ALUA transition TG PT Group: %s ID: %hu"
1025 " to secondary access state: %s\n", (explict) ? "explict" :
1026 "implict", config_item_name(&tg_pt_gp->tg_pt_gp_group.cg_item),
1027 tg_pt_gp->tg_pt_gp_id, (offline) ? "OFFLINE" : "ONLINE");
1029 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1031 * Do the optional transition delay after we set the secondary
1032 * ALUA access state.
1034 if (trans_delay_msecs != 0)
1035 msleep_interruptible(trans_delay_msecs);
1037 * See if we need to update the ALUA fabric port metadata for
1038 * secondary state and status
1040 if (port->sep_tg_pt_secondary_write_md) {
1041 md_buf = kzalloc(md_buf_len, GFP_KERNEL);
1043 pr_err("Unable to allocate md_buf for"
1044 " secondary ALUA access metadata\n");
1047 mutex_lock(&port->sep_tg_pt_md_mutex);
1048 core_alua_update_tpg_secondary_metadata(tg_pt_gp_mem, port,
1049 md_buf, md_buf_len);
1050 mutex_unlock(&port->sep_tg_pt_md_mutex);
1058 struct t10_alua_lu_gp *
1059 core_alua_allocate_lu_gp(const char *name, int def_group)
1061 struct t10_alua_lu_gp *lu_gp;
1063 lu_gp = kmem_cache_zalloc(t10_alua_lu_gp_cache, GFP_KERNEL);
1065 pr_err("Unable to allocate struct t10_alua_lu_gp\n");
1066 return ERR_PTR(-ENOMEM);
1068 INIT_LIST_HEAD(&lu_gp->lu_gp_node);
1069 INIT_LIST_HEAD(&lu_gp->lu_gp_mem_list);
1070 spin_lock_init(&lu_gp->lu_gp_lock);
1071 atomic_set(&lu_gp->lu_gp_ref_cnt, 0);
1074 lu_gp->lu_gp_id = alua_lu_gps_counter++;
1075 lu_gp->lu_gp_valid_id = 1;
1076 alua_lu_gps_count++;
1082 int core_alua_set_lu_gp_id(struct t10_alua_lu_gp *lu_gp, u16 lu_gp_id)
1084 struct t10_alua_lu_gp *lu_gp_tmp;
1087 * The lu_gp->lu_gp_id may only be set once..
1089 if (lu_gp->lu_gp_valid_id) {
1090 pr_warn("ALUA LU Group already has a valid ID,"
1091 " ignoring request\n");
1095 spin_lock(&lu_gps_lock);
1096 if (alua_lu_gps_count == 0x0000ffff) {
1097 pr_err("Maximum ALUA alua_lu_gps_count:"
1098 " 0x0000ffff reached\n");
1099 spin_unlock(&lu_gps_lock);
1100 kmem_cache_free(t10_alua_lu_gp_cache, lu_gp);
1104 lu_gp_id_tmp = (lu_gp_id != 0) ? lu_gp_id :
1105 alua_lu_gps_counter++;
1107 list_for_each_entry(lu_gp_tmp, &lu_gps_list, lu_gp_node) {
1108 if (lu_gp_tmp->lu_gp_id == lu_gp_id_tmp) {
1112 pr_warn("ALUA Logical Unit Group ID: %hu"
1113 " already exists, ignoring request\n",
1115 spin_unlock(&lu_gps_lock);
1120 lu_gp->lu_gp_id = lu_gp_id_tmp;
1121 lu_gp->lu_gp_valid_id = 1;
1122 list_add_tail(&lu_gp->lu_gp_node, &lu_gps_list);
1123 alua_lu_gps_count++;
1124 spin_unlock(&lu_gps_lock);
1129 static struct t10_alua_lu_gp_member *
1130 core_alua_allocate_lu_gp_mem(struct se_device *dev)
1132 struct t10_alua_lu_gp_member *lu_gp_mem;
1134 lu_gp_mem = kmem_cache_zalloc(t10_alua_lu_gp_mem_cache, GFP_KERNEL);
1136 pr_err("Unable to allocate struct t10_alua_lu_gp_member\n");
1137 return ERR_PTR(-ENOMEM);
1139 INIT_LIST_HEAD(&lu_gp_mem->lu_gp_mem_list);
1140 spin_lock_init(&lu_gp_mem->lu_gp_mem_lock);
1141 atomic_set(&lu_gp_mem->lu_gp_mem_ref_cnt, 0);
1143 lu_gp_mem->lu_gp_mem_dev = dev;
1144 dev->dev_alua_lu_gp_mem = lu_gp_mem;
1149 void core_alua_free_lu_gp(struct t10_alua_lu_gp *lu_gp)
1151 struct t10_alua_lu_gp_member *lu_gp_mem, *lu_gp_mem_tmp;
1153 * Once we have reached this point, config_item_put() has
1154 * already been called from target_core_alua_drop_lu_gp().
1156 * Here, we remove the *lu_gp from the global list so that
1157 * no associations can be made while we are releasing
1158 * struct t10_alua_lu_gp.
1160 spin_lock(&lu_gps_lock);
1161 atomic_set(&lu_gp->lu_gp_shutdown, 1);
1162 list_del(&lu_gp->lu_gp_node);
1163 alua_lu_gps_count--;
1164 spin_unlock(&lu_gps_lock);
1166 * Allow struct t10_alua_lu_gp * referenced by core_alua_get_lu_gp_by_name()
1167 * in target_core_configfs.c:target_core_store_alua_lu_gp() to be
1168 * released with core_alua_put_lu_gp_from_name()
1170 while (atomic_read(&lu_gp->lu_gp_ref_cnt))
1173 * Release reference to struct t10_alua_lu_gp * from all associated
1176 spin_lock(&lu_gp->lu_gp_lock);
1177 list_for_each_entry_safe(lu_gp_mem, lu_gp_mem_tmp,
1178 &lu_gp->lu_gp_mem_list, lu_gp_mem_list) {
1179 if (lu_gp_mem->lu_gp_assoc) {
1180 list_del(&lu_gp_mem->lu_gp_mem_list);
1181 lu_gp->lu_gp_members--;
1182 lu_gp_mem->lu_gp_assoc = 0;
1184 spin_unlock(&lu_gp->lu_gp_lock);
1187 * lu_gp_mem is associated with a single
1188 * struct se_device->dev_alua_lu_gp_mem, and is released when
1189 * struct se_device is released via core_alua_free_lu_gp_mem().
1191 * If the passed lu_gp does NOT match the default_lu_gp, assume
1192 * we want to re-assocate a given lu_gp_mem with default_lu_gp.
1194 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
1195 if (lu_gp != default_lu_gp)
1196 __core_alua_attach_lu_gp_mem(lu_gp_mem,
1199 lu_gp_mem->lu_gp = NULL;
1200 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
1202 spin_lock(&lu_gp->lu_gp_lock);
1204 spin_unlock(&lu_gp->lu_gp_lock);
1206 kmem_cache_free(t10_alua_lu_gp_cache, lu_gp);
1209 void core_alua_free_lu_gp_mem(struct se_device *dev)
1211 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
1212 struct t10_alua *alua = &su_dev->t10_alua;
1213 struct t10_alua_lu_gp *lu_gp;
1214 struct t10_alua_lu_gp_member *lu_gp_mem;
1216 if (alua->alua_type != SPC3_ALUA_EMULATED)
1219 lu_gp_mem = dev->dev_alua_lu_gp_mem;
1223 while (atomic_read(&lu_gp_mem->lu_gp_mem_ref_cnt))
1226 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
1227 lu_gp = lu_gp_mem->lu_gp;
1229 spin_lock(&lu_gp->lu_gp_lock);
1230 if (lu_gp_mem->lu_gp_assoc) {
1231 list_del(&lu_gp_mem->lu_gp_mem_list);
1232 lu_gp->lu_gp_members--;
1233 lu_gp_mem->lu_gp_assoc = 0;
1235 spin_unlock(&lu_gp->lu_gp_lock);
1236 lu_gp_mem->lu_gp = NULL;
1238 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
1240 kmem_cache_free(t10_alua_lu_gp_mem_cache, lu_gp_mem);
1243 struct t10_alua_lu_gp *core_alua_get_lu_gp_by_name(const char *name)
1245 struct t10_alua_lu_gp *lu_gp;
1246 struct config_item *ci;
1248 spin_lock(&lu_gps_lock);
1249 list_for_each_entry(lu_gp, &lu_gps_list, lu_gp_node) {
1250 if (!lu_gp->lu_gp_valid_id)
1252 ci = &lu_gp->lu_gp_group.cg_item;
1253 if (!strcmp(config_item_name(ci), name)) {
1254 atomic_inc(&lu_gp->lu_gp_ref_cnt);
1255 spin_unlock(&lu_gps_lock);
1259 spin_unlock(&lu_gps_lock);
1264 void core_alua_put_lu_gp_from_name(struct t10_alua_lu_gp *lu_gp)
1266 spin_lock(&lu_gps_lock);
1267 atomic_dec(&lu_gp->lu_gp_ref_cnt);
1268 spin_unlock(&lu_gps_lock);
1272 * Called with struct t10_alua_lu_gp_member->lu_gp_mem_lock
1274 void __core_alua_attach_lu_gp_mem(
1275 struct t10_alua_lu_gp_member *lu_gp_mem,
1276 struct t10_alua_lu_gp *lu_gp)
1278 spin_lock(&lu_gp->lu_gp_lock);
1279 lu_gp_mem->lu_gp = lu_gp;
1280 lu_gp_mem->lu_gp_assoc = 1;
1281 list_add_tail(&lu_gp_mem->lu_gp_mem_list, &lu_gp->lu_gp_mem_list);
1282 lu_gp->lu_gp_members++;
1283 spin_unlock(&lu_gp->lu_gp_lock);
1287 * Called with struct t10_alua_lu_gp_member->lu_gp_mem_lock
1289 void __core_alua_drop_lu_gp_mem(
1290 struct t10_alua_lu_gp_member *lu_gp_mem,
1291 struct t10_alua_lu_gp *lu_gp)
1293 spin_lock(&lu_gp->lu_gp_lock);
1294 list_del(&lu_gp_mem->lu_gp_mem_list);
1295 lu_gp_mem->lu_gp = NULL;
1296 lu_gp_mem->lu_gp_assoc = 0;
1297 lu_gp->lu_gp_members--;
1298 spin_unlock(&lu_gp->lu_gp_lock);
1301 struct t10_alua_tg_pt_gp *core_alua_allocate_tg_pt_gp(
1302 struct se_subsystem_dev *su_dev,
1306 struct t10_alua_tg_pt_gp *tg_pt_gp;
1308 tg_pt_gp = kmem_cache_zalloc(t10_alua_tg_pt_gp_cache, GFP_KERNEL);
1310 pr_err("Unable to allocate struct t10_alua_tg_pt_gp\n");
1313 INIT_LIST_HEAD(&tg_pt_gp->tg_pt_gp_list);
1314 INIT_LIST_HEAD(&tg_pt_gp->tg_pt_gp_mem_list);
1315 mutex_init(&tg_pt_gp->tg_pt_gp_md_mutex);
1316 spin_lock_init(&tg_pt_gp->tg_pt_gp_lock);
1317 atomic_set(&tg_pt_gp->tg_pt_gp_ref_cnt, 0);
1318 tg_pt_gp->tg_pt_gp_su_dev = su_dev;
1319 tg_pt_gp->tg_pt_gp_md_buf_len = ALUA_MD_BUF_LEN;
1320 atomic_set(&tg_pt_gp->tg_pt_gp_alua_access_state,
1321 ALUA_ACCESS_STATE_ACTIVE_OPTMIZED);
1323 * Enable both explict and implict ALUA support by default
1325 tg_pt_gp->tg_pt_gp_alua_access_type =
1326 TPGS_EXPLICT_ALUA | TPGS_IMPLICT_ALUA;
1328 * Set the default Active/NonOptimized Delay in milliseconds
1330 tg_pt_gp->tg_pt_gp_nonop_delay_msecs = ALUA_DEFAULT_NONOP_DELAY_MSECS;
1331 tg_pt_gp->tg_pt_gp_trans_delay_msecs = ALUA_DEFAULT_TRANS_DELAY_MSECS;
1334 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1335 tg_pt_gp->tg_pt_gp_id =
1336 su_dev->t10_alua.alua_tg_pt_gps_counter++;
1337 tg_pt_gp->tg_pt_gp_valid_id = 1;
1338 su_dev->t10_alua.alua_tg_pt_gps_count++;
1339 list_add_tail(&tg_pt_gp->tg_pt_gp_list,
1340 &su_dev->t10_alua.tg_pt_gps_list);
1341 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1347 int core_alua_set_tg_pt_gp_id(
1348 struct t10_alua_tg_pt_gp *tg_pt_gp,
1351 struct se_subsystem_dev *su_dev = tg_pt_gp->tg_pt_gp_su_dev;
1352 struct t10_alua_tg_pt_gp *tg_pt_gp_tmp;
1353 u16 tg_pt_gp_id_tmp;
1355 * The tg_pt_gp->tg_pt_gp_id may only be set once..
1357 if (tg_pt_gp->tg_pt_gp_valid_id) {
1358 pr_warn("ALUA TG PT Group already has a valid ID,"
1359 " ignoring request\n");
1363 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1364 if (su_dev->t10_alua.alua_tg_pt_gps_count == 0x0000ffff) {
1365 pr_err("Maximum ALUA alua_tg_pt_gps_count:"
1366 " 0x0000ffff reached\n");
1367 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1368 kmem_cache_free(t10_alua_tg_pt_gp_cache, tg_pt_gp);
1372 tg_pt_gp_id_tmp = (tg_pt_gp_id != 0) ? tg_pt_gp_id :
1373 su_dev->t10_alua.alua_tg_pt_gps_counter++;
1375 list_for_each_entry(tg_pt_gp_tmp, &su_dev->t10_alua.tg_pt_gps_list,
1377 if (tg_pt_gp_tmp->tg_pt_gp_id == tg_pt_gp_id_tmp) {
1381 pr_err("ALUA Target Port Group ID: %hu already"
1382 " exists, ignoring request\n", tg_pt_gp_id);
1383 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1388 tg_pt_gp->tg_pt_gp_id = tg_pt_gp_id_tmp;
1389 tg_pt_gp->tg_pt_gp_valid_id = 1;
1390 list_add_tail(&tg_pt_gp->tg_pt_gp_list,
1391 &su_dev->t10_alua.tg_pt_gps_list);
1392 su_dev->t10_alua.alua_tg_pt_gps_count++;
1393 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1398 struct t10_alua_tg_pt_gp_member *core_alua_allocate_tg_pt_gp_mem(
1399 struct se_port *port)
1401 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1403 tg_pt_gp_mem = kmem_cache_zalloc(t10_alua_tg_pt_gp_mem_cache,
1405 if (!tg_pt_gp_mem) {
1406 pr_err("Unable to allocate struct t10_alua_tg_pt_gp_member\n");
1407 return ERR_PTR(-ENOMEM);
1409 INIT_LIST_HEAD(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1410 spin_lock_init(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1411 atomic_set(&tg_pt_gp_mem->tg_pt_gp_mem_ref_cnt, 0);
1413 tg_pt_gp_mem->tg_pt = port;
1414 port->sep_alua_tg_pt_gp_mem = tg_pt_gp_mem;
1415 atomic_set(&port->sep_tg_pt_gp_active, 1);
1417 return tg_pt_gp_mem;
1420 void core_alua_free_tg_pt_gp(
1421 struct t10_alua_tg_pt_gp *tg_pt_gp)
1423 struct se_subsystem_dev *su_dev = tg_pt_gp->tg_pt_gp_su_dev;
1424 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem, *tg_pt_gp_mem_tmp;
1426 * Once we have reached this point, config_item_put() has already
1427 * been called from target_core_alua_drop_tg_pt_gp().
1429 * Here we remove *tg_pt_gp from the global list so that
1430 * no assications *OR* explict ALUA via SET_TARGET_PORT_GROUPS
1431 * can be made while we are releasing struct t10_alua_tg_pt_gp.
1433 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1434 list_del(&tg_pt_gp->tg_pt_gp_list);
1435 su_dev->t10_alua.alua_tg_pt_gps_counter--;
1436 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1438 * Allow a struct t10_alua_tg_pt_gp_member * referenced by
1439 * core_alua_get_tg_pt_gp_by_name() in
1440 * target_core_configfs.c:target_core_store_alua_tg_pt_gp()
1441 * to be released with core_alua_put_tg_pt_gp_from_name().
1443 while (atomic_read(&tg_pt_gp->tg_pt_gp_ref_cnt))
1446 * Release reference to struct t10_alua_tg_pt_gp from all associated
1449 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1450 list_for_each_entry_safe(tg_pt_gp_mem, tg_pt_gp_mem_tmp,
1451 &tg_pt_gp->tg_pt_gp_mem_list, tg_pt_gp_mem_list) {
1452 if (tg_pt_gp_mem->tg_pt_gp_assoc) {
1453 list_del(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1454 tg_pt_gp->tg_pt_gp_members--;
1455 tg_pt_gp_mem->tg_pt_gp_assoc = 0;
1457 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1459 * tg_pt_gp_mem is associated with a single
1460 * se_port->sep_alua_tg_pt_gp_mem, and is released via
1461 * core_alua_free_tg_pt_gp_mem().
1463 * If the passed tg_pt_gp does NOT match the default_tg_pt_gp,
1464 * assume we want to re-assocate a given tg_pt_gp_mem with
1467 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1468 if (tg_pt_gp != su_dev->t10_alua.default_tg_pt_gp) {
1469 __core_alua_attach_tg_pt_gp_mem(tg_pt_gp_mem,
1470 su_dev->t10_alua.default_tg_pt_gp);
1472 tg_pt_gp_mem->tg_pt_gp = NULL;
1473 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1475 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1477 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1479 kmem_cache_free(t10_alua_tg_pt_gp_cache, tg_pt_gp);
1482 void core_alua_free_tg_pt_gp_mem(struct se_port *port)
1484 struct se_subsystem_dev *su_dev = port->sep_lun->lun_se_dev->se_sub_dev;
1485 struct t10_alua *alua = &su_dev->t10_alua;
1486 struct t10_alua_tg_pt_gp *tg_pt_gp;
1487 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1489 if (alua->alua_type != SPC3_ALUA_EMULATED)
1492 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
1496 while (atomic_read(&tg_pt_gp_mem->tg_pt_gp_mem_ref_cnt))
1499 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1500 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1502 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1503 if (tg_pt_gp_mem->tg_pt_gp_assoc) {
1504 list_del(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1505 tg_pt_gp->tg_pt_gp_members--;
1506 tg_pt_gp_mem->tg_pt_gp_assoc = 0;
1508 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1509 tg_pt_gp_mem->tg_pt_gp = NULL;
1511 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1513 kmem_cache_free(t10_alua_tg_pt_gp_mem_cache, tg_pt_gp_mem);
1516 static struct t10_alua_tg_pt_gp *core_alua_get_tg_pt_gp_by_name(
1517 struct se_subsystem_dev *su_dev,
1520 struct t10_alua_tg_pt_gp *tg_pt_gp;
1521 struct config_item *ci;
1523 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1524 list_for_each_entry(tg_pt_gp, &su_dev->t10_alua.tg_pt_gps_list,
1526 if (!tg_pt_gp->tg_pt_gp_valid_id)
1528 ci = &tg_pt_gp->tg_pt_gp_group.cg_item;
1529 if (!strcmp(config_item_name(ci), name)) {
1530 atomic_inc(&tg_pt_gp->tg_pt_gp_ref_cnt);
1531 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1535 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1540 static void core_alua_put_tg_pt_gp_from_name(
1541 struct t10_alua_tg_pt_gp *tg_pt_gp)
1543 struct se_subsystem_dev *su_dev = tg_pt_gp->tg_pt_gp_su_dev;
1545 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1546 atomic_dec(&tg_pt_gp->tg_pt_gp_ref_cnt);
1547 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1551 * Called with struct t10_alua_tg_pt_gp_member->tg_pt_gp_mem_lock held
1553 void __core_alua_attach_tg_pt_gp_mem(
1554 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
1555 struct t10_alua_tg_pt_gp *tg_pt_gp)
1557 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1558 tg_pt_gp_mem->tg_pt_gp = tg_pt_gp;
1559 tg_pt_gp_mem->tg_pt_gp_assoc = 1;
1560 list_add_tail(&tg_pt_gp_mem->tg_pt_gp_mem_list,
1561 &tg_pt_gp->tg_pt_gp_mem_list);
1562 tg_pt_gp->tg_pt_gp_members++;
1563 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1567 * Called with struct t10_alua_tg_pt_gp_member->tg_pt_gp_mem_lock held
1569 static void __core_alua_drop_tg_pt_gp_mem(
1570 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
1571 struct t10_alua_tg_pt_gp *tg_pt_gp)
1573 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1574 list_del(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1575 tg_pt_gp_mem->tg_pt_gp = NULL;
1576 tg_pt_gp_mem->tg_pt_gp_assoc = 0;
1577 tg_pt_gp->tg_pt_gp_members--;
1578 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1581 ssize_t core_alua_show_tg_pt_gp_info(struct se_port *port, char *page)
1583 struct se_subsystem_dev *su_dev = port->sep_lun->lun_se_dev->se_sub_dev;
1584 struct config_item *tg_pt_ci;
1585 struct t10_alua *alua = &su_dev->t10_alua;
1586 struct t10_alua_tg_pt_gp *tg_pt_gp;
1587 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1590 if (alua->alua_type != SPC3_ALUA_EMULATED)
1593 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
1597 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1598 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1600 tg_pt_ci = &tg_pt_gp->tg_pt_gp_group.cg_item;
1601 len += sprintf(page, "TG Port Alias: %s\nTG Port Group ID:"
1602 " %hu\nTG Port Primary Access State: %s\nTG Port "
1603 "Primary Access Status: %s\nTG Port Secondary Access"
1604 " State: %s\nTG Port Secondary Access Status: %s\n",
1605 config_item_name(tg_pt_ci), tg_pt_gp->tg_pt_gp_id,
1606 core_alua_dump_state(atomic_read(
1607 &tg_pt_gp->tg_pt_gp_alua_access_state)),
1608 core_alua_dump_status(
1609 tg_pt_gp->tg_pt_gp_alua_access_status),
1610 (atomic_read(&port->sep_tg_pt_secondary_offline)) ?
1612 core_alua_dump_status(port->sep_tg_pt_secondary_stat));
1614 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1619 ssize_t core_alua_store_tg_pt_gp_info(
1620 struct se_port *port,
1624 struct se_portal_group *tpg;
1626 struct se_subsystem_dev *su_dev = port->sep_lun->lun_se_dev->se_sub_dev;
1627 struct t10_alua_tg_pt_gp *tg_pt_gp = NULL, *tg_pt_gp_new = NULL;
1628 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1629 unsigned char buf[TG_PT_GROUP_NAME_BUF];
1632 tpg = port->sep_tpg;
1633 lun = port->sep_lun;
1635 if (su_dev->t10_alua.alua_type != SPC3_ALUA_EMULATED) {
1636 pr_warn("SPC3_ALUA_EMULATED not enabled for"
1637 " %s/tpgt_%hu/%s\n", tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1638 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1639 config_item_name(&lun->lun_group.cg_item));
1643 if (count > TG_PT_GROUP_NAME_BUF) {
1644 pr_err("ALUA Target Port Group alias too large!\n");
1647 memset(buf, 0, TG_PT_GROUP_NAME_BUF);
1648 memcpy(buf, page, count);
1650 * Any ALUA target port group alias besides "NULL" means we will be
1651 * making a new group association.
1653 if (strcmp(strstrip(buf), "NULL")) {
1655 * core_alua_get_tg_pt_gp_by_name() will increment reference to
1656 * struct t10_alua_tg_pt_gp. This reference is released with
1657 * core_alua_put_tg_pt_gp_from_name() below.
1659 tg_pt_gp_new = core_alua_get_tg_pt_gp_by_name(su_dev,
1664 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
1665 if (!tg_pt_gp_mem) {
1667 core_alua_put_tg_pt_gp_from_name(tg_pt_gp_new);
1668 pr_err("NULL struct se_port->sep_alua_tg_pt_gp_mem pointer\n");
1672 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1673 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1676 * Clearing an existing tg_pt_gp association, and replacing
1677 * with the default_tg_pt_gp.
1679 if (!tg_pt_gp_new) {
1680 pr_debug("Target_Core_ConfigFS: Moving"
1681 " %s/tpgt_%hu/%s from ALUA Target Port Group:"
1682 " alua/%s, ID: %hu back to"
1683 " default_tg_pt_gp\n",
1684 tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1685 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1686 config_item_name(&lun->lun_group.cg_item),
1688 &tg_pt_gp->tg_pt_gp_group.cg_item),
1689 tg_pt_gp->tg_pt_gp_id);
1691 __core_alua_drop_tg_pt_gp_mem(tg_pt_gp_mem, tg_pt_gp);
1692 __core_alua_attach_tg_pt_gp_mem(tg_pt_gp_mem,
1693 su_dev->t10_alua.default_tg_pt_gp);
1694 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1699 * Removing existing association of tg_pt_gp_mem with tg_pt_gp
1701 __core_alua_drop_tg_pt_gp_mem(tg_pt_gp_mem, tg_pt_gp);
1705 * Associate tg_pt_gp_mem with tg_pt_gp_new.
1707 __core_alua_attach_tg_pt_gp_mem(tg_pt_gp_mem, tg_pt_gp_new);
1708 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1709 pr_debug("Target_Core_ConfigFS: %s %s/tpgt_%hu/%s to ALUA"
1710 " Target Port Group: alua/%s, ID: %hu\n", (move) ?
1711 "Moving" : "Adding", tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1712 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1713 config_item_name(&lun->lun_group.cg_item),
1714 config_item_name(&tg_pt_gp_new->tg_pt_gp_group.cg_item),
1715 tg_pt_gp_new->tg_pt_gp_id);
1717 core_alua_put_tg_pt_gp_from_name(tg_pt_gp_new);
1721 ssize_t core_alua_show_access_type(
1722 struct t10_alua_tg_pt_gp *tg_pt_gp,
1725 if ((tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_EXPLICT_ALUA) &&
1726 (tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_IMPLICT_ALUA))
1727 return sprintf(page, "Implict and Explict\n");
1728 else if (tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_IMPLICT_ALUA)
1729 return sprintf(page, "Implict\n");
1730 else if (tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_EXPLICT_ALUA)
1731 return sprintf(page, "Explict\n");
1733 return sprintf(page, "None\n");
1736 ssize_t core_alua_store_access_type(
1737 struct t10_alua_tg_pt_gp *tg_pt_gp,
1744 ret = strict_strtoul(page, 0, &tmp);
1746 pr_err("Unable to extract alua_access_type\n");
1749 if ((tmp != 0) && (tmp != 1) && (tmp != 2) && (tmp != 3)) {
1750 pr_err("Illegal value for alua_access_type:"
1755 tg_pt_gp->tg_pt_gp_alua_access_type =
1756 TPGS_IMPLICT_ALUA | TPGS_EXPLICT_ALUA;
1758 tg_pt_gp->tg_pt_gp_alua_access_type = TPGS_EXPLICT_ALUA;
1760 tg_pt_gp->tg_pt_gp_alua_access_type = TPGS_IMPLICT_ALUA;
1762 tg_pt_gp->tg_pt_gp_alua_access_type = 0;
1767 ssize_t core_alua_show_nonop_delay_msecs(
1768 struct t10_alua_tg_pt_gp *tg_pt_gp,
1771 return sprintf(page, "%d\n", tg_pt_gp->tg_pt_gp_nonop_delay_msecs);
1774 ssize_t core_alua_store_nonop_delay_msecs(
1775 struct t10_alua_tg_pt_gp *tg_pt_gp,
1782 ret = strict_strtoul(page, 0, &tmp);
1784 pr_err("Unable to extract nonop_delay_msecs\n");
1787 if (tmp > ALUA_MAX_NONOP_DELAY_MSECS) {
1788 pr_err("Passed nonop_delay_msecs: %lu, exceeds"
1789 " ALUA_MAX_NONOP_DELAY_MSECS: %d\n", tmp,
1790 ALUA_MAX_NONOP_DELAY_MSECS);
1793 tg_pt_gp->tg_pt_gp_nonop_delay_msecs = (int)tmp;
1798 ssize_t core_alua_show_trans_delay_msecs(
1799 struct t10_alua_tg_pt_gp *tg_pt_gp,
1802 return sprintf(page, "%d\n", tg_pt_gp->tg_pt_gp_trans_delay_msecs);
1805 ssize_t core_alua_store_trans_delay_msecs(
1806 struct t10_alua_tg_pt_gp *tg_pt_gp,
1813 ret = strict_strtoul(page, 0, &tmp);
1815 pr_err("Unable to extract trans_delay_msecs\n");
1818 if (tmp > ALUA_MAX_TRANS_DELAY_MSECS) {
1819 pr_err("Passed trans_delay_msecs: %lu, exceeds"
1820 " ALUA_MAX_TRANS_DELAY_MSECS: %d\n", tmp,
1821 ALUA_MAX_TRANS_DELAY_MSECS);
1824 tg_pt_gp->tg_pt_gp_trans_delay_msecs = (int)tmp;
1829 ssize_t core_alua_show_preferred_bit(
1830 struct t10_alua_tg_pt_gp *tg_pt_gp,
1833 return sprintf(page, "%d\n", tg_pt_gp->tg_pt_gp_pref);
1836 ssize_t core_alua_store_preferred_bit(
1837 struct t10_alua_tg_pt_gp *tg_pt_gp,
1844 ret = strict_strtoul(page, 0, &tmp);
1846 pr_err("Unable to extract preferred ALUA value\n");
1849 if ((tmp != 0) && (tmp != 1)) {
1850 pr_err("Illegal value for preferred ALUA: %lu\n", tmp);
1853 tg_pt_gp->tg_pt_gp_pref = (int)tmp;
1858 ssize_t core_alua_show_offline_bit(struct se_lun *lun, char *page)
1863 return sprintf(page, "%d\n",
1864 atomic_read(&lun->lun_sep->sep_tg_pt_secondary_offline));
1867 ssize_t core_alua_store_offline_bit(
1872 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1879 ret = strict_strtoul(page, 0, &tmp);
1881 pr_err("Unable to extract alua_tg_pt_offline value\n");
1884 if ((tmp != 0) && (tmp != 1)) {
1885 pr_err("Illegal value for alua_tg_pt_offline: %lu\n",
1889 tg_pt_gp_mem = lun->lun_sep->sep_alua_tg_pt_gp_mem;
1890 if (!tg_pt_gp_mem) {
1891 pr_err("Unable to locate *tg_pt_gp_mem\n");
1895 ret = core_alua_set_tg_pt_secondary_state(tg_pt_gp_mem,
1896 lun->lun_sep, 0, (int)tmp);
1903 ssize_t core_alua_show_secondary_status(
1907 return sprintf(page, "%d\n", lun->lun_sep->sep_tg_pt_secondary_stat);
1910 ssize_t core_alua_store_secondary_status(
1918 ret = strict_strtoul(page, 0, &tmp);
1920 pr_err("Unable to extract alua_tg_pt_status\n");
1923 if ((tmp != ALUA_STATUS_NONE) &&
1924 (tmp != ALUA_STATUS_ALTERED_BY_EXPLICT_STPG) &&
1925 (tmp != ALUA_STATUS_ALTERED_BY_IMPLICT_ALUA)) {
1926 pr_err("Illegal value for alua_tg_pt_status: %lu\n",
1930 lun->lun_sep->sep_tg_pt_secondary_stat = (int)tmp;
1935 ssize_t core_alua_show_secondary_write_metadata(
1939 return sprintf(page, "%d\n",
1940 lun->lun_sep->sep_tg_pt_secondary_write_md);
1943 ssize_t core_alua_store_secondary_write_metadata(
1951 ret = strict_strtoul(page, 0, &tmp);
1953 pr_err("Unable to extract alua_tg_pt_write_md\n");
1956 if ((tmp != 0) && (tmp != 1)) {
1957 pr_err("Illegal value for alua_tg_pt_write_md:"
1961 lun->lun_sep->sep_tg_pt_secondary_write_md = (int)tmp;
1966 int core_setup_alua(struct se_device *dev, int force_pt)
1968 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
1969 struct t10_alua *alua = &su_dev->t10_alua;
1970 struct t10_alua_lu_gp_member *lu_gp_mem;
1972 * If this device is from Target_Core_Mod/pSCSI, use the ALUA logic
1973 * of the Underlying SCSI hardware. In Linux/SCSI terms, this can
1974 * cause a problem because libata and some SATA RAID HBAs appear
1975 * under Linux/SCSI, but emulate SCSI logic themselves.
1977 if (((dev->transport->transport_type == TRANSPORT_PLUGIN_PHBA_PDEV) &&
1978 !(dev->se_sub_dev->se_dev_attrib.emulate_alua)) || force_pt) {
1979 alua->alua_type = SPC_ALUA_PASSTHROUGH;
1980 alua->alua_state_check = &core_alua_state_check_nop;
1981 pr_debug("%s: Using SPC_ALUA_PASSTHROUGH, no ALUA"
1982 " emulation\n", dev->transport->name);
1986 * If SPC-3 or above is reported by real or emulated struct se_device,
1987 * use emulated ALUA.
1989 if (dev->transport->get_device_rev(dev) >= SCSI_3) {
1990 pr_debug("%s: Enabling ALUA Emulation for SPC-3"
1991 " device\n", dev->transport->name);
1993 * Associate this struct se_device with the default ALUA
1996 lu_gp_mem = core_alua_allocate_lu_gp_mem(dev);
1997 if (IS_ERR(lu_gp_mem))
1998 return PTR_ERR(lu_gp_mem);
2000 alua->alua_type = SPC3_ALUA_EMULATED;
2001 alua->alua_state_check = &core_alua_state_check;
2002 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
2003 __core_alua_attach_lu_gp_mem(lu_gp_mem,
2005 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
2007 pr_debug("%s: Adding to default ALUA LU Group:"
2008 " core/alua/lu_gps/default_lu_gp\n",
2009 dev->transport->name);
2011 alua->alua_type = SPC2_ALUA_DISABLED;
2012 alua->alua_state_check = &core_alua_state_check_nop;
2013 pr_debug("%s: Disabling ALUA Emulation for SPC-2"
2014 " device\n", dev->transport->name);