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/version.h>
28 #include <linux/slab.h>
29 #include <linux/spinlock.h>
30 #include <linux/configfs.h>
31 #include <scsi/scsi.h>
32 #include <scsi/scsi_cmnd.h>
34 #include <target/target_core_base.h>
35 #include <target/target_core_device.h>
36 #include <target/target_core_transport.h>
37 #include <target/target_core_fabric_ops.h>
38 #include <target/target_core_configfs.h>
40 #include "target_core_alua.h"
41 #include "target_core_hba.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 core_emulate_report_target_port_groups(struct se_cmd *cmd)
64 struct se_subsystem_dev *su_dev = cmd->se_lun->lun_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;
68 unsigned char *buf = (unsigned char *)cmd->t_task->t_task_buf;
69 u32 rd_len = 0, off = 4; /* Skip over RESERVED area to first
70 Target port group descriptor */
72 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
73 list_for_each_entry(tg_pt_gp, &su_dev->t10_alua.tg_pt_gps_list,
76 * PREF: Preferred target port bit, determine if this
77 * bit should be set for port group.
79 if (tg_pt_gp->tg_pt_gp_pref)
82 * Set the ASYMMETRIC ACCESS State
84 buf[off++] |= (atomic_read(
85 &tg_pt_gp->tg_pt_gp_alua_access_state) & 0xff);
87 * Set supported ASYMMETRIC ACCESS State bits
89 buf[off] = 0x80; /* T_SUP */
90 buf[off] |= 0x40; /* O_SUP */
91 buf[off] |= 0x8; /* U_SUP */
92 buf[off] |= 0x4; /* S_SUP */
93 buf[off] |= 0x2; /* AN_SUP */
94 buf[off++] |= 0x1; /* AO_SUP */
98 buf[off++] = ((tg_pt_gp->tg_pt_gp_id >> 8) & 0xff);
99 buf[off++] = (tg_pt_gp->tg_pt_gp_id & 0xff);
101 off++; /* Skip over Reserved */
105 buf[off++] = (tg_pt_gp->tg_pt_gp_alua_access_status & 0xff);
107 * Vendor Specific field
113 buf[off++] = (tg_pt_gp->tg_pt_gp_members & 0xff);
116 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
117 list_for_each_entry(tg_pt_gp_mem, &tg_pt_gp->tg_pt_gp_mem_list,
119 port = tg_pt_gp_mem->tg_pt;
121 * Start Target Port descriptor format
123 * See spc4r17 section 6.2.7 Table 247
125 off += 2; /* Skip over Obsolete */
127 * Set RELATIVE TARGET PORT IDENTIFIER
129 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
130 buf[off++] = (port->sep_rtpi & 0xff);
133 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
135 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
137 * Set the RETURN DATA LENGTH set in the header of the DataIN Payload
139 buf[0] = ((rd_len >> 24) & 0xff);
140 buf[1] = ((rd_len >> 16) & 0xff);
141 buf[2] = ((rd_len >> 8) & 0xff);
142 buf[3] = (rd_len & 0xff);
148 * SET_TARGET_PORT_GROUPS for explict ALUA operation.
150 * See spc4r17 section 6.35
152 int core_emulate_set_target_port_groups(struct se_cmd *cmd)
154 struct se_device *dev = cmd->se_lun->lun_se_dev;
155 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
156 struct se_port *port, *l_port = cmd->se_lun->lun_sep;
157 struct se_node_acl *nacl = cmd->se_sess->se_node_acl;
158 struct t10_alua_tg_pt_gp *tg_pt_gp = NULL, *l_tg_pt_gp;
159 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem, *l_tg_pt_gp_mem;
160 unsigned char *buf = (unsigned char *)cmd->t_task->t_task_buf;
161 unsigned char *ptr = &buf[4]; /* Skip over RESERVED area in header */
162 u32 len = 4; /* Skip over RESERVED area in header */
163 int alua_access_state, primary = 0, rc;
167 return PYX_TRANSPORT_LU_COMM_FAILURE;
169 * Determine if explict ALUA via SET_TARGET_PORT_GROUPS is allowed
170 * for the local tg_pt_gp.
172 l_tg_pt_gp_mem = l_port->sep_alua_tg_pt_gp_mem;
173 if (!(l_tg_pt_gp_mem)) {
174 printk(KERN_ERR "Unable to access l_port->sep_alua_tg_pt_gp_mem\n");
175 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
177 spin_lock(&l_tg_pt_gp_mem->tg_pt_gp_mem_lock);
178 l_tg_pt_gp = l_tg_pt_gp_mem->tg_pt_gp;
180 spin_unlock(&l_tg_pt_gp_mem->tg_pt_gp_mem_lock);
181 printk(KERN_ERR "Unable to access *l_tg_pt_gp_mem->tg_pt_gp\n");
182 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
184 rc = (l_tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_EXPLICT_ALUA);
185 spin_unlock(&l_tg_pt_gp_mem->tg_pt_gp_mem_lock);
188 printk(KERN_INFO "Unable to process SET_TARGET_PORT_GROUPS"
189 " while TPGS_EXPLICT_ALUA is disabled\n");
190 return PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
193 while (len < cmd->data_length) {
194 alua_access_state = (ptr[0] & 0x0f);
196 * Check the received ALUA access state, and determine if
197 * the state is a primary or secondary target port asymmetric
200 rc = core_alua_check_transition(alua_access_state, &primary);
203 * If the SET TARGET PORT GROUPS attempts to establish
204 * an invalid combination of target port asymmetric
205 * access states or attempts to establish an
206 * unsupported target port asymmetric access state,
207 * then the command shall be terminated with CHECK
208 * CONDITION status, with the sense key set to ILLEGAL
209 * REQUEST, and the additional sense code set to INVALID
210 * FIELD IN PARAMETER LIST.
212 return PYX_TRANSPORT_INVALID_PARAMETER_LIST;
216 * If the ASYMMETRIC ACCESS STATE field (see table 267)
217 * specifies a primary target port asymmetric access state,
218 * then the TARGET PORT GROUP OR TARGET PORT field specifies
219 * a primary target port group for which the primary target
220 * port asymmetric access state shall be changed. If the
221 * ASYMMETRIC ACCESS STATE field specifies a secondary target
222 * port asymmetric access state, then the TARGET PORT GROUP OR
223 * TARGET PORT field specifies the relative target port
224 * identifier (see 3.1.120) of the target port for which the
225 * secondary target port asymmetric access state shall be
229 tg_pt_id = ((ptr[2] << 8) & 0xff);
230 tg_pt_id |= (ptr[3] & 0xff);
232 * Locate the matching target port group ID from
233 * the global tg_pt_gp list
235 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
236 list_for_each_entry(tg_pt_gp,
237 &su_dev->t10_alua.tg_pt_gps_list,
239 if (!(tg_pt_gp->tg_pt_gp_valid_id))
242 if (tg_pt_id != tg_pt_gp->tg_pt_gp_id)
245 atomic_inc(&tg_pt_gp->tg_pt_gp_ref_cnt);
246 smp_mb__after_atomic_inc();
247 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
249 rc = core_alua_do_port_transition(tg_pt_gp,
251 alua_access_state, 1);
253 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
254 atomic_dec(&tg_pt_gp->tg_pt_gp_ref_cnt);
255 smp_mb__after_atomic_dec();
258 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
260 * If not matching target port group ID can be located
261 * throw an exception with ASCQ: INVALID_PARAMETER_LIST
264 return PYX_TRANSPORT_INVALID_PARAMETER_LIST;
267 * Extact the RELATIVE TARGET PORT IDENTIFIER to identify
268 * the Target Port in question for the the incoming
269 * SET_TARGET_PORT_GROUPS op.
271 rtpi = ((ptr[2] << 8) & 0xff);
272 rtpi |= (ptr[3] & 0xff);
274 * Locate the matching relative target port identifer
275 * for the struct se_device storage object.
277 spin_lock(&dev->se_port_lock);
278 list_for_each_entry(port, &dev->dev_sep_list,
280 if (port->sep_rtpi != rtpi)
283 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
284 spin_unlock(&dev->se_port_lock);
286 rc = core_alua_set_tg_pt_secondary_state(
287 tg_pt_gp_mem, port, 1, 1);
289 spin_lock(&dev->se_port_lock);
292 spin_unlock(&dev->se_port_lock);
294 * If not matching relative target port identifier can
295 * be located, throw an exception with ASCQ:
296 * INVALID_PARAMETER_LIST
299 return PYX_TRANSPORT_INVALID_PARAMETER_LIST;
309 static inline int core_alua_state_nonoptimized(
312 int nonop_delay_msecs,
316 * Set SCF_ALUA_NON_OPTIMIZED here, this value will be checked
317 * later to determine if processing of this cmd needs to be
318 * temporarily delayed for the Active/NonOptimized primary access state.
320 cmd->se_cmd_flags |= SCF_ALUA_NON_OPTIMIZED;
321 cmd->alua_nonop_delay = nonop_delay_msecs;
325 static inline int core_alua_state_standby(
331 * Allowed CDBs for ALUA_ACCESS_STATE_STANDBY as defined by
332 * spc4r17 section 5.9.2.4.4
341 case RECEIVE_DIAGNOSTIC:
342 case SEND_DIAGNOSTIC:
345 case MI_REPORT_TARGET_PGS:
348 *alua_ascq = ASCQ_04H_ALUA_TG_PT_STANDBY;
351 case MAINTENANCE_OUT:
353 case MO_SET_TARGET_PGS:
356 *alua_ascq = ASCQ_04H_ALUA_TG_PT_STANDBY;
360 case PERSISTENT_RESERVE_IN:
361 case PERSISTENT_RESERVE_OUT:
366 *alua_ascq = ASCQ_04H_ALUA_TG_PT_STANDBY;
373 static inline int core_alua_state_unavailable(
379 * Allowed CDBs for ALUA_ACCESS_STATE_UNAVAILABLE as defined by
380 * spc4r17 section 5.9.2.4.5
387 case MI_REPORT_TARGET_PGS:
390 *alua_ascq = ASCQ_04H_ALUA_TG_PT_UNAVAILABLE;
393 case MAINTENANCE_OUT:
395 case MO_SET_TARGET_PGS:
398 *alua_ascq = ASCQ_04H_ALUA_TG_PT_UNAVAILABLE;
406 *alua_ascq = ASCQ_04H_ALUA_TG_PT_UNAVAILABLE;
413 static inline int core_alua_state_transition(
419 * Allowed CDBs for ALUA_ACCESS_STATE_TRANSITIO as defined by
420 * spc4r17 section 5.9.2.5
427 case MI_REPORT_TARGET_PGS:
430 *alua_ascq = ASCQ_04H_ALUA_STATE_TRANSITION;
438 *alua_ascq = ASCQ_04H_ALUA_STATE_TRANSITION;
446 * Used for alua_type SPC_ALUA_PASSTHROUGH and SPC2_ALUA_DISABLED
447 * in transport_cmd_sequencer(). This function is assigned to
448 * struct t10_alua *->state_check() in core_setup_alua()
450 static int core_alua_state_check_nop(
459 * Used for alua_type SPC3_ALUA_EMULATED in transport_cmd_sequencer().
460 * This function is assigned to struct t10_alua *->state_check() in
463 * Also, this function can return three different return codes to
464 * signal transport_generic_cmd_sequencer()
466 * return 1: Is used to signal LUN not accecsable, and check condition/not ready
467 * return 0: Used to signal success
468 * reutrn -1: Used to signal failure, and invalid cdb field
470 static int core_alua_state_check(
475 struct se_lun *lun = cmd->se_lun;
476 struct se_port *port = lun->lun_sep;
477 struct t10_alua_tg_pt_gp *tg_pt_gp;
478 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
479 int out_alua_state, nonop_delay_msecs;
484 * First, check for a struct se_port specific secondary ALUA target port
485 * access state: OFFLINE
487 if (atomic_read(&port->sep_tg_pt_secondary_offline)) {
488 *alua_ascq = ASCQ_04H_ALUA_OFFLINE;
489 printk(KERN_INFO "ALUA: Got secondary offline status for local"
491 *alua_ascq = ASCQ_04H_ALUA_OFFLINE;
495 * Second, obtain the struct t10_alua_tg_pt_gp_member pointer to the
496 * ALUA target port group, to obtain current ALUA access state.
497 * Otherwise look for the underlying struct se_device association with
498 * a ALUA logical unit group.
500 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
501 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
502 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
503 out_alua_state = atomic_read(&tg_pt_gp->tg_pt_gp_alua_access_state);
504 nonop_delay_msecs = tg_pt_gp->tg_pt_gp_nonop_delay_msecs;
505 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
507 * Process ALUA_ACCESS_STATE_ACTIVE_OPTMIZED in a separate conditional
508 * statement so the compiler knows explicitly to check this case first.
509 * For the Optimized ALUA access state case, we want to process the
510 * incoming fabric cmd ASAP..
512 if (out_alua_state == ALUA_ACCESS_STATE_ACTIVE_OPTMIZED)
515 switch (out_alua_state) {
516 case ALUA_ACCESS_STATE_ACTIVE_NON_OPTIMIZED:
517 return core_alua_state_nonoptimized(cmd, cdb,
518 nonop_delay_msecs, alua_ascq);
519 case ALUA_ACCESS_STATE_STANDBY:
520 return core_alua_state_standby(cmd, cdb, alua_ascq);
521 case ALUA_ACCESS_STATE_UNAVAILABLE:
522 return core_alua_state_unavailable(cmd, cdb, alua_ascq);
523 case ALUA_ACCESS_STATE_TRANSITION:
524 return core_alua_state_transition(cmd, cdb, alua_ascq);
526 * OFFLINE is a secondary ALUA target port group access state, that is
527 * handled above with struct se_port->sep_tg_pt_secondary_offline=1
529 case ALUA_ACCESS_STATE_OFFLINE:
531 printk(KERN_ERR "Unknown ALUA access state: 0x%02x\n",
540 * Check implict and explict ALUA state change request.
542 static int core_alua_check_transition(int state, int *primary)
545 case ALUA_ACCESS_STATE_ACTIVE_OPTMIZED:
546 case ALUA_ACCESS_STATE_ACTIVE_NON_OPTIMIZED:
547 case ALUA_ACCESS_STATE_STANDBY:
548 case ALUA_ACCESS_STATE_UNAVAILABLE:
550 * OPTIMIZED, NON-OPTIMIZED, STANDBY and UNAVAILABLE are
551 * defined as primary target port asymmetric access states.
555 case ALUA_ACCESS_STATE_OFFLINE:
557 * OFFLINE state is defined as a secondary target port
558 * asymmetric access state.
563 printk(KERN_ERR "Unknown ALUA access state: 0x%02x\n", state);
570 static char *core_alua_dump_state(int state)
573 case ALUA_ACCESS_STATE_ACTIVE_OPTMIZED:
574 return "Active/Optimized";
575 case ALUA_ACCESS_STATE_ACTIVE_NON_OPTIMIZED:
576 return "Active/NonOptimized";
577 case ALUA_ACCESS_STATE_STANDBY:
579 case ALUA_ACCESS_STATE_UNAVAILABLE:
580 return "Unavailable";
581 case ALUA_ACCESS_STATE_OFFLINE:
590 char *core_alua_dump_status(int status)
593 case ALUA_STATUS_NONE:
595 case ALUA_STATUS_ALTERED_BY_EXPLICT_STPG:
596 return "Altered by Explict STPG";
597 case ALUA_STATUS_ALTERED_BY_IMPLICT_ALUA:
598 return "Altered by Implict ALUA";
607 * Used by fabric modules to determine when we need to delay processing
608 * for the Active/NonOptimized paths..
610 int core_alua_check_nonop_delay(
613 if (!(cmd->se_cmd_flags & SCF_ALUA_NON_OPTIMIZED))
618 * The ALUA Active/NonOptimized access state delay can be disabled
619 * in via configfs with a value of zero
621 if (!(cmd->alua_nonop_delay))
624 * struct se_cmd->alua_nonop_delay gets set by a target port group
625 * defined interval in core_alua_state_nonoptimized()
627 msleep_interruptible(cmd->alua_nonop_delay);
630 EXPORT_SYMBOL(core_alua_check_nonop_delay);
633 * Called with tg_pt_gp->tg_pt_gp_md_mutex or tg_pt_gp_mem->sep_tg_pt_md_mutex
636 static int core_alua_write_tpg_metadata(
638 unsigned char *md_buf,
644 int flags = O_RDWR | O_CREAT | O_TRUNC, ret;
646 memset(iov, 0, sizeof(struct iovec));
648 file = filp_open(path, flags, 0600);
649 if (IS_ERR(file) || !file || !file->f_dentry) {
650 printk(KERN_ERR "filp_open(%s) for ALUA metadata failed\n",
655 iov[0].iov_base = &md_buf[0];
656 iov[0].iov_len = md_buf_len;
660 ret = vfs_writev(file, &iov[0], 1, &file->f_pos);
664 printk(KERN_ERR "Error writing ALUA metadata file: %s\n", path);
665 filp_close(file, NULL);
668 filp_close(file, NULL);
674 * Called with tg_pt_gp->tg_pt_gp_md_mutex held
676 static int core_alua_update_tpg_primary_metadata(
677 struct t10_alua_tg_pt_gp *tg_pt_gp,
679 unsigned char *md_buf)
681 struct se_subsystem_dev *su_dev = tg_pt_gp->tg_pt_gp_su_dev;
682 struct t10_wwn *wwn = &su_dev->t10_wwn;
683 char path[ALUA_METADATA_PATH_LEN];
686 memset(path, 0, ALUA_METADATA_PATH_LEN);
688 len = snprintf(md_buf, tg_pt_gp->tg_pt_gp_md_buf_len,
690 "alua_access_state=0x%02x\n"
691 "alua_access_status=0x%02x\n",
692 tg_pt_gp->tg_pt_gp_id, primary_state,
693 tg_pt_gp->tg_pt_gp_alua_access_status);
695 snprintf(path, ALUA_METADATA_PATH_LEN,
696 "/var/target/alua/tpgs_%s/%s", &wwn->unit_serial[0],
697 config_item_name(&tg_pt_gp->tg_pt_gp_group.cg_item));
699 return core_alua_write_tpg_metadata(path, md_buf, len);
702 static int core_alua_do_transition_tg_pt(
703 struct t10_alua_tg_pt_gp *tg_pt_gp,
704 struct se_port *l_port,
705 struct se_node_acl *nacl,
706 unsigned char *md_buf,
710 struct se_dev_entry *se_deve;
711 struct se_lun_acl *lacl;
712 struct se_port *port;
713 struct t10_alua_tg_pt_gp_member *mem;
716 * Save the old primary ALUA access state, and set the current state
717 * to ALUA_ACCESS_STATE_TRANSITION.
719 old_state = atomic_read(&tg_pt_gp->tg_pt_gp_alua_access_state);
720 atomic_set(&tg_pt_gp->tg_pt_gp_alua_access_state,
721 ALUA_ACCESS_STATE_TRANSITION);
722 tg_pt_gp->tg_pt_gp_alua_access_status = (explict) ?
723 ALUA_STATUS_ALTERED_BY_EXPLICT_STPG :
724 ALUA_STATUS_ALTERED_BY_IMPLICT_ALUA;
726 * Check for the optional ALUA primary state transition delay
728 if (tg_pt_gp->tg_pt_gp_trans_delay_msecs != 0)
729 msleep_interruptible(tg_pt_gp->tg_pt_gp_trans_delay_msecs);
731 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
732 list_for_each_entry(mem, &tg_pt_gp->tg_pt_gp_mem_list,
736 * After an implicit target port asymmetric access state
737 * change, a device server shall establish a unit attention
738 * condition for the initiator port associated with every I_T
739 * nexus with the additional sense code set to ASYMMETRIC
740 * ACCESS STATE CHAGED.
742 * After an explicit target port asymmetric access state
743 * change, a device server shall establish a unit attention
744 * condition with the additional sense code set to ASYMMETRIC
745 * ACCESS STATE CHANGED for the initiator port associated with
746 * every I_T nexus other than the I_T nexus on which the SET
747 * TARGET PORT GROUPS command
749 atomic_inc(&mem->tg_pt_gp_mem_ref_cnt);
750 smp_mb__after_atomic_inc();
751 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
753 spin_lock_bh(&port->sep_alua_lock);
754 list_for_each_entry(se_deve, &port->sep_alua_list,
756 lacl = se_deve->se_lun_acl;
758 * se_deve->se_lun_acl pointer may be NULL for a
759 * entry created without explict Node+MappedLUN ACLs
765 (nacl != NULL) && (nacl == lacl->se_lun_nacl) &&
766 (l_port != NULL) && (l_port == port))
769 core_scsi3_ua_allocate(lacl->se_lun_nacl,
770 se_deve->mapped_lun, 0x2A,
771 ASCQ_2AH_ASYMMETRIC_ACCESS_STATE_CHANGED);
773 spin_unlock_bh(&port->sep_alua_lock);
775 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
776 atomic_dec(&mem->tg_pt_gp_mem_ref_cnt);
777 smp_mb__after_atomic_dec();
779 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
781 * Update the ALUA metadata buf that has been allocated in
782 * core_alua_do_port_transition(), this metadata will be written
785 * Note that there is the case where we do not want to update the
786 * metadata when the saved metadata is being parsed in userspace
787 * when setting the existing port access state and access status.
789 * Also note that the failure to write out the ALUA metadata to
790 * struct file does NOT affect the actual ALUA transition.
792 if (tg_pt_gp->tg_pt_gp_write_metadata) {
793 mutex_lock(&tg_pt_gp->tg_pt_gp_md_mutex);
794 core_alua_update_tpg_primary_metadata(tg_pt_gp,
796 mutex_unlock(&tg_pt_gp->tg_pt_gp_md_mutex);
799 * Set the current primary ALUA access state to the requested new state
801 atomic_set(&tg_pt_gp->tg_pt_gp_alua_access_state, new_state);
803 printk(KERN_INFO "Successful %s ALUA transition TG PT Group: %s ID: %hu"
804 " from primary access state %s to %s\n", (explict) ? "explict" :
805 "implict", config_item_name(&tg_pt_gp->tg_pt_gp_group.cg_item),
806 tg_pt_gp->tg_pt_gp_id, core_alua_dump_state(old_state),
807 core_alua_dump_state(new_state));
812 int core_alua_do_port_transition(
813 struct t10_alua_tg_pt_gp *l_tg_pt_gp,
814 struct se_device *l_dev,
815 struct se_port *l_port,
816 struct se_node_acl *l_nacl,
820 struct se_device *dev;
821 struct se_port *port;
822 struct se_subsystem_dev *su_dev;
823 struct se_node_acl *nacl;
824 struct t10_alua_lu_gp *lu_gp;
825 struct t10_alua_lu_gp_member *lu_gp_mem, *local_lu_gp_mem;
826 struct t10_alua_tg_pt_gp *tg_pt_gp;
827 unsigned char *md_buf;
830 if (core_alua_check_transition(new_state, &primary) != 0)
833 md_buf = kzalloc(l_tg_pt_gp->tg_pt_gp_md_buf_len, GFP_KERNEL);
835 printk("Unable to allocate buf for ALUA metadata\n");
839 local_lu_gp_mem = l_dev->dev_alua_lu_gp_mem;
840 spin_lock(&local_lu_gp_mem->lu_gp_mem_lock);
841 lu_gp = local_lu_gp_mem->lu_gp;
842 atomic_inc(&lu_gp->lu_gp_ref_cnt);
843 smp_mb__after_atomic_inc();
844 spin_unlock(&local_lu_gp_mem->lu_gp_mem_lock);
846 * For storage objects that are members of the 'default_lu_gp',
847 * we only do transition on the passed *l_tp_pt_gp, and not
848 * on all of the matching target port groups IDs in default_lu_gp.
850 if (!(lu_gp->lu_gp_id)) {
852 * core_alua_do_transition_tg_pt() will always return
855 core_alua_do_transition_tg_pt(l_tg_pt_gp, l_port, l_nacl,
856 md_buf, new_state, explict);
857 atomic_dec(&lu_gp->lu_gp_ref_cnt);
858 smp_mb__after_atomic_dec();
863 * For all other LU groups aside from 'default_lu_gp', walk all of
864 * the associated storage objects looking for a matching target port
865 * group ID from the local target port group.
867 spin_lock(&lu_gp->lu_gp_lock);
868 list_for_each_entry(lu_gp_mem, &lu_gp->lu_gp_mem_list,
871 dev = lu_gp_mem->lu_gp_mem_dev;
872 su_dev = dev->se_sub_dev;
873 atomic_inc(&lu_gp_mem->lu_gp_mem_ref_cnt);
874 smp_mb__after_atomic_inc();
875 spin_unlock(&lu_gp->lu_gp_lock);
877 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
878 list_for_each_entry(tg_pt_gp,
879 &su_dev->t10_alua.tg_pt_gps_list,
882 if (!(tg_pt_gp->tg_pt_gp_valid_id))
885 * If the target behavior port asymmetric access state
886 * is changed for any target port group accessiable via
887 * a logical unit within a LU group, the target port
888 * behavior group asymmetric access states for the same
889 * target port group accessible via other logical units
890 * in that LU group will also change.
892 if (l_tg_pt_gp->tg_pt_gp_id != tg_pt_gp->tg_pt_gp_id)
895 if (l_tg_pt_gp == tg_pt_gp) {
902 atomic_inc(&tg_pt_gp->tg_pt_gp_ref_cnt);
903 smp_mb__after_atomic_inc();
904 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
906 * core_alua_do_transition_tg_pt() will always return
909 core_alua_do_transition_tg_pt(tg_pt_gp, port,
910 nacl, md_buf, new_state, explict);
912 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
913 atomic_dec(&tg_pt_gp->tg_pt_gp_ref_cnt);
914 smp_mb__after_atomic_dec();
916 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
918 spin_lock(&lu_gp->lu_gp_lock);
919 atomic_dec(&lu_gp_mem->lu_gp_mem_ref_cnt);
920 smp_mb__after_atomic_dec();
922 spin_unlock(&lu_gp->lu_gp_lock);
924 printk(KERN_INFO "Successfully processed LU Group: %s all ALUA TG PT"
925 " Group IDs: %hu %s transition to primary state: %s\n",
926 config_item_name(&lu_gp->lu_gp_group.cg_item),
927 l_tg_pt_gp->tg_pt_gp_id, (explict) ? "explict" : "implict",
928 core_alua_dump_state(new_state));
930 atomic_dec(&lu_gp->lu_gp_ref_cnt);
931 smp_mb__after_atomic_dec();
937 * Called with tg_pt_gp_mem->sep_tg_pt_md_mutex held
939 static int core_alua_update_tpg_secondary_metadata(
940 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
941 struct se_port *port,
942 unsigned char *md_buf,
945 struct se_portal_group *se_tpg = port->sep_tpg;
946 char path[ALUA_METADATA_PATH_LEN], wwn[ALUA_SECONDARY_METADATA_WWN_LEN];
949 memset(path, 0, ALUA_METADATA_PATH_LEN);
950 memset(wwn, 0, ALUA_SECONDARY_METADATA_WWN_LEN);
952 len = snprintf(wwn, ALUA_SECONDARY_METADATA_WWN_LEN, "%s",
953 se_tpg->se_tpg_tfo->tpg_get_wwn(se_tpg));
955 if (se_tpg->se_tpg_tfo->tpg_get_tag != NULL)
956 snprintf(wwn+len, ALUA_SECONDARY_METADATA_WWN_LEN-len, "+%hu",
957 se_tpg->se_tpg_tfo->tpg_get_tag(se_tpg));
959 len = snprintf(md_buf, md_buf_len, "alua_tg_pt_offline=%d\n"
960 "alua_tg_pt_status=0x%02x\n",
961 atomic_read(&port->sep_tg_pt_secondary_offline),
962 port->sep_tg_pt_secondary_stat);
964 snprintf(path, ALUA_METADATA_PATH_LEN, "/var/target/alua/%s/%s/lun_%u",
965 se_tpg->se_tpg_tfo->get_fabric_name(), wwn,
966 port->sep_lun->unpacked_lun);
968 return core_alua_write_tpg_metadata(path, md_buf, len);
971 static int core_alua_set_tg_pt_secondary_state(
972 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
973 struct se_port *port,
977 struct t10_alua_tg_pt_gp *tg_pt_gp;
978 unsigned char *md_buf;
980 int trans_delay_msecs;
982 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
983 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
985 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
986 printk(KERN_ERR "Unable to complete secondary state"
990 trans_delay_msecs = tg_pt_gp->tg_pt_gp_trans_delay_msecs;
992 * Set the secondary ALUA target port access state to OFFLINE
993 * or release the previously secondary state for struct se_port
996 atomic_set(&port->sep_tg_pt_secondary_offline, 1);
998 atomic_set(&port->sep_tg_pt_secondary_offline, 0);
1000 md_buf_len = tg_pt_gp->tg_pt_gp_md_buf_len;
1001 port->sep_tg_pt_secondary_stat = (explict) ?
1002 ALUA_STATUS_ALTERED_BY_EXPLICT_STPG :
1003 ALUA_STATUS_ALTERED_BY_IMPLICT_ALUA;
1005 printk(KERN_INFO "Successful %s ALUA transition TG PT Group: %s ID: %hu"
1006 " to secondary access state: %s\n", (explict) ? "explict" :
1007 "implict", config_item_name(&tg_pt_gp->tg_pt_gp_group.cg_item),
1008 tg_pt_gp->tg_pt_gp_id, (offline) ? "OFFLINE" : "ONLINE");
1010 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1012 * Do the optional transition delay after we set the secondary
1013 * ALUA access state.
1015 if (trans_delay_msecs != 0)
1016 msleep_interruptible(trans_delay_msecs);
1018 * See if we need to update the ALUA fabric port metadata for
1019 * secondary state and status
1021 if (port->sep_tg_pt_secondary_write_md) {
1022 md_buf = kzalloc(md_buf_len, GFP_KERNEL);
1024 printk(KERN_ERR "Unable to allocate md_buf for"
1025 " secondary ALUA access metadata\n");
1028 mutex_lock(&port->sep_tg_pt_md_mutex);
1029 core_alua_update_tpg_secondary_metadata(tg_pt_gp_mem, port,
1030 md_buf, md_buf_len);
1031 mutex_unlock(&port->sep_tg_pt_md_mutex);
1039 struct t10_alua_lu_gp *
1040 core_alua_allocate_lu_gp(const char *name, int def_group)
1042 struct t10_alua_lu_gp *lu_gp;
1044 lu_gp = kmem_cache_zalloc(t10_alua_lu_gp_cache, GFP_KERNEL);
1046 printk(KERN_ERR "Unable to allocate struct t10_alua_lu_gp\n");
1047 return ERR_PTR(-ENOMEM);
1049 INIT_LIST_HEAD(&lu_gp->lu_gp_node);
1050 INIT_LIST_HEAD(&lu_gp->lu_gp_mem_list);
1051 spin_lock_init(&lu_gp->lu_gp_lock);
1052 atomic_set(&lu_gp->lu_gp_ref_cnt, 0);
1055 lu_gp->lu_gp_id = alua_lu_gps_counter++;
1056 lu_gp->lu_gp_valid_id = 1;
1057 alua_lu_gps_count++;
1063 int core_alua_set_lu_gp_id(struct t10_alua_lu_gp *lu_gp, u16 lu_gp_id)
1065 struct t10_alua_lu_gp *lu_gp_tmp;
1068 * The lu_gp->lu_gp_id may only be set once..
1070 if (lu_gp->lu_gp_valid_id) {
1071 printk(KERN_WARNING "ALUA LU Group already has a valid ID,"
1072 " ignoring request\n");
1076 spin_lock(&lu_gps_lock);
1077 if (alua_lu_gps_count == 0x0000ffff) {
1078 printk(KERN_ERR "Maximum ALUA alua_lu_gps_count:"
1079 " 0x0000ffff reached\n");
1080 spin_unlock(&lu_gps_lock);
1081 kmem_cache_free(t10_alua_lu_gp_cache, lu_gp);
1085 lu_gp_id_tmp = (lu_gp_id != 0) ? lu_gp_id :
1086 alua_lu_gps_counter++;
1088 list_for_each_entry(lu_gp_tmp, &lu_gps_list, lu_gp_node) {
1089 if (lu_gp_tmp->lu_gp_id == lu_gp_id_tmp) {
1093 printk(KERN_WARNING "ALUA Logical Unit Group ID: %hu"
1094 " already exists, ignoring request\n",
1096 spin_unlock(&lu_gps_lock);
1101 lu_gp->lu_gp_id = lu_gp_id_tmp;
1102 lu_gp->lu_gp_valid_id = 1;
1103 list_add_tail(&lu_gp->lu_gp_node, &lu_gps_list);
1104 alua_lu_gps_count++;
1105 spin_unlock(&lu_gps_lock);
1110 static struct t10_alua_lu_gp_member *
1111 core_alua_allocate_lu_gp_mem(struct se_device *dev)
1113 struct t10_alua_lu_gp_member *lu_gp_mem;
1115 lu_gp_mem = kmem_cache_zalloc(t10_alua_lu_gp_mem_cache, GFP_KERNEL);
1117 printk(KERN_ERR "Unable to allocate struct t10_alua_lu_gp_member\n");
1118 return ERR_PTR(-ENOMEM);
1120 INIT_LIST_HEAD(&lu_gp_mem->lu_gp_mem_list);
1121 spin_lock_init(&lu_gp_mem->lu_gp_mem_lock);
1122 atomic_set(&lu_gp_mem->lu_gp_mem_ref_cnt, 0);
1124 lu_gp_mem->lu_gp_mem_dev = dev;
1125 dev->dev_alua_lu_gp_mem = lu_gp_mem;
1130 void core_alua_free_lu_gp(struct t10_alua_lu_gp *lu_gp)
1132 struct t10_alua_lu_gp_member *lu_gp_mem, *lu_gp_mem_tmp;
1134 * Once we have reached this point, config_item_put() has
1135 * already been called from target_core_alua_drop_lu_gp().
1137 * Here, we remove the *lu_gp from the global list so that
1138 * no associations can be made while we are releasing
1139 * struct t10_alua_lu_gp.
1141 spin_lock(&lu_gps_lock);
1142 atomic_set(&lu_gp->lu_gp_shutdown, 1);
1143 list_del(&lu_gp->lu_gp_node);
1144 alua_lu_gps_count--;
1145 spin_unlock(&lu_gps_lock);
1147 * Allow struct t10_alua_lu_gp * referenced by core_alua_get_lu_gp_by_name()
1148 * in target_core_configfs.c:target_core_store_alua_lu_gp() to be
1149 * released with core_alua_put_lu_gp_from_name()
1151 while (atomic_read(&lu_gp->lu_gp_ref_cnt))
1154 * Release reference to struct t10_alua_lu_gp * from all associated
1157 spin_lock(&lu_gp->lu_gp_lock);
1158 list_for_each_entry_safe(lu_gp_mem, lu_gp_mem_tmp,
1159 &lu_gp->lu_gp_mem_list, lu_gp_mem_list) {
1160 if (lu_gp_mem->lu_gp_assoc) {
1161 list_del(&lu_gp_mem->lu_gp_mem_list);
1162 lu_gp->lu_gp_members--;
1163 lu_gp_mem->lu_gp_assoc = 0;
1165 spin_unlock(&lu_gp->lu_gp_lock);
1168 * lu_gp_mem is associated with a single
1169 * struct se_device->dev_alua_lu_gp_mem, and is released when
1170 * struct se_device is released via core_alua_free_lu_gp_mem().
1172 * If the passed lu_gp does NOT match the default_lu_gp, assume
1173 * we want to re-assocate a given lu_gp_mem with default_lu_gp.
1175 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
1176 if (lu_gp != default_lu_gp)
1177 __core_alua_attach_lu_gp_mem(lu_gp_mem,
1180 lu_gp_mem->lu_gp = NULL;
1181 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
1183 spin_lock(&lu_gp->lu_gp_lock);
1185 spin_unlock(&lu_gp->lu_gp_lock);
1187 kmem_cache_free(t10_alua_lu_gp_cache, lu_gp);
1190 void core_alua_free_lu_gp_mem(struct se_device *dev)
1192 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
1193 struct t10_alua *alua = &su_dev->t10_alua;
1194 struct t10_alua_lu_gp *lu_gp;
1195 struct t10_alua_lu_gp_member *lu_gp_mem;
1197 if (alua->alua_type != SPC3_ALUA_EMULATED)
1200 lu_gp_mem = dev->dev_alua_lu_gp_mem;
1204 while (atomic_read(&lu_gp_mem->lu_gp_mem_ref_cnt))
1207 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
1208 lu_gp = lu_gp_mem->lu_gp;
1210 spin_lock(&lu_gp->lu_gp_lock);
1211 if (lu_gp_mem->lu_gp_assoc) {
1212 list_del(&lu_gp_mem->lu_gp_mem_list);
1213 lu_gp->lu_gp_members--;
1214 lu_gp_mem->lu_gp_assoc = 0;
1216 spin_unlock(&lu_gp->lu_gp_lock);
1217 lu_gp_mem->lu_gp = NULL;
1219 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
1221 kmem_cache_free(t10_alua_lu_gp_mem_cache, lu_gp_mem);
1224 struct t10_alua_lu_gp *core_alua_get_lu_gp_by_name(const char *name)
1226 struct t10_alua_lu_gp *lu_gp;
1227 struct config_item *ci;
1229 spin_lock(&lu_gps_lock);
1230 list_for_each_entry(lu_gp, &lu_gps_list, lu_gp_node) {
1231 if (!(lu_gp->lu_gp_valid_id))
1233 ci = &lu_gp->lu_gp_group.cg_item;
1234 if (!(strcmp(config_item_name(ci), name))) {
1235 atomic_inc(&lu_gp->lu_gp_ref_cnt);
1236 spin_unlock(&lu_gps_lock);
1240 spin_unlock(&lu_gps_lock);
1245 void core_alua_put_lu_gp_from_name(struct t10_alua_lu_gp *lu_gp)
1247 spin_lock(&lu_gps_lock);
1248 atomic_dec(&lu_gp->lu_gp_ref_cnt);
1249 spin_unlock(&lu_gps_lock);
1253 * Called with struct t10_alua_lu_gp_member->lu_gp_mem_lock
1255 void __core_alua_attach_lu_gp_mem(
1256 struct t10_alua_lu_gp_member *lu_gp_mem,
1257 struct t10_alua_lu_gp *lu_gp)
1259 spin_lock(&lu_gp->lu_gp_lock);
1260 lu_gp_mem->lu_gp = lu_gp;
1261 lu_gp_mem->lu_gp_assoc = 1;
1262 list_add_tail(&lu_gp_mem->lu_gp_mem_list, &lu_gp->lu_gp_mem_list);
1263 lu_gp->lu_gp_members++;
1264 spin_unlock(&lu_gp->lu_gp_lock);
1268 * Called with struct t10_alua_lu_gp_member->lu_gp_mem_lock
1270 void __core_alua_drop_lu_gp_mem(
1271 struct t10_alua_lu_gp_member *lu_gp_mem,
1272 struct t10_alua_lu_gp *lu_gp)
1274 spin_lock(&lu_gp->lu_gp_lock);
1275 list_del(&lu_gp_mem->lu_gp_mem_list);
1276 lu_gp_mem->lu_gp = NULL;
1277 lu_gp_mem->lu_gp_assoc = 0;
1278 lu_gp->lu_gp_members--;
1279 spin_unlock(&lu_gp->lu_gp_lock);
1282 struct t10_alua_tg_pt_gp *core_alua_allocate_tg_pt_gp(
1283 struct se_subsystem_dev *su_dev,
1287 struct t10_alua_tg_pt_gp *tg_pt_gp;
1289 tg_pt_gp = kmem_cache_zalloc(t10_alua_tg_pt_gp_cache, GFP_KERNEL);
1291 printk(KERN_ERR "Unable to allocate struct t10_alua_tg_pt_gp\n");
1294 INIT_LIST_HEAD(&tg_pt_gp->tg_pt_gp_list);
1295 INIT_LIST_HEAD(&tg_pt_gp->tg_pt_gp_mem_list);
1296 mutex_init(&tg_pt_gp->tg_pt_gp_md_mutex);
1297 spin_lock_init(&tg_pt_gp->tg_pt_gp_lock);
1298 atomic_set(&tg_pt_gp->tg_pt_gp_ref_cnt, 0);
1299 tg_pt_gp->tg_pt_gp_su_dev = su_dev;
1300 tg_pt_gp->tg_pt_gp_md_buf_len = ALUA_MD_BUF_LEN;
1301 atomic_set(&tg_pt_gp->tg_pt_gp_alua_access_state,
1302 ALUA_ACCESS_STATE_ACTIVE_OPTMIZED);
1304 * Enable both explict and implict ALUA support by default
1306 tg_pt_gp->tg_pt_gp_alua_access_type =
1307 TPGS_EXPLICT_ALUA | TPGS_IMPLICT_ALUA;
1309 * Set the default Active/NonOptimized Delay in milliseconds
1311 tg_pt_gp->tg_pt_gp_nonop_delay_msecs = ALUA_DEFAULT_NONOP_DELAY_MSECS;
1312 tg_pt_gp->tg_pt_gp_trans_delay_msecs = ALUA_DEFAULT_TRANS_DELAY_MSECS;
1315 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1316 tg_pt_gp->tg_pt_gp_id =
1317 su_dev->t10_alua.alua_tg_pt_gps_counter++;
1318 tg_pt_gp->tg_pt_gp_valid_id = 1;
1319 su_dev->t10_alua.alua_tg_pt_gps_count++;
1320 list_add_tail(&tg_pt_gp->tg_pt_gp_list,
1321 &su_dev->t10_alua.tg_pt_gps_list);
1322 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1328 int core_alua_set_tg_pt_gp_id(
1329 struct t10_alua_tg_pt_gp *tg_pt_gp,
1332 struct se_subsystem_dev *su_dev = tg_pt_gp->tg_pt_gp_su_dev;
1333 struct t10_alua_tg_pt_gp *tg_pt_gp_tmp;
1334 u16 tg_pt_gp_id_tmp;
1336 * The tg_pt_gp->tg_pt_gp_id may only be set once..
1338 if (tg_pt_gp->tg_pt_gp_valid_id) {
1339 printk(KERN_WARNING "ALUA TG PT Group already has a valid ID,"
1340 " ignoring request\n");
1344 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1345 if (su_dev->t10_alua.alua_tg_pt_gps_count == 0x0000ffff) {
1346 printk(KERN_ERR "Maximum ALUA alua_tg_pt_gps_count:"
1347 " 0x0000ffff reached\n");
1348 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1349 kmem_cache_free(t10_alua_tg_pt_gp_cache, tg_pt_gp);
1353 tg_pt_gp_id_tmp = (tg_pt_gp_id != 0) ? tg_pt_gp_id :
1354 su_dev->t10_alua.alua_tg_pt_gps_counter++;
1356 list_for_each_entry(tg_pt_gp_tmp, &su_dev->t10_alua.tg_pt_gps_list,
1358 if (tg_pt_gp_tmp->tg_pt_gp_id == tg_pt_gp_id_tmp) {
1362 printk(KERN_ERR "ALUA Target Port Group ID: %hu already"
1363 " exists, ignoring request\n", tg_pt_gp_id);
1364 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1369 tg_pt_gp->tg_pt_gp_id = tg_pt_gp_id_tmp;
1370 tg_pt_gp->tg_pt_gp_valid_id = 1;
1371 list_add_tail(&tg_pt_gp->tg_pt_gp_list,
1372 &su_dev->t10_alua.tg_pt_gps_list);
1373 su_dev->t10_alua.alua_tg_pt_gps_count++;
1374 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1379 struct t10_alua_tg_pt_gp_member *core_alua_allocate_tg_pt_gp_mem(
1380 struct se_port *port)
1382 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1384 tg_pt_gp_mem = kmem_cache_zalloc(t10_alua_tg_pt_gp_mem_cache,
1386 if (!(tg_pt_gp_mem)) {
1387 printk(KERN_ERR "Unable to allocate struct t10_alua_tg_pt_gp_member\n");
1388 return ERR_PTR(-ENOMEM);
1390 INIT_LIST_HEAD(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1391 spin_lock_init(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1392 atomic_set(&tg_pt_gp_mem->tg_pt_gp_mem_ref_cnt, 0);
1394 tg_pt_gp_mem->tg_pt = port;
1395 port->sep_alua_tg_pt_gp_mem = tg_pt_gp_mem;
1396 atomic_set(&port->sep_tg_pt_gp_active, 1);
1398 return tg_pt_gp_mem;
1401 void core_alua_free_tg_pt_gp(
1402 struct t10_alua_tg_pt_gp *tg_pt_gp)
1404 struct se_subsystem_dev *su_dev = tg_pt_gp->tg_pt_gp_su_dev;
1405 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem, *tg_pt_gp_mem_tmp;
1407 * Once we have reached this point, config_item_put() has already
1408 * been called from target_core_alua_drop_tg_pt_gp().
1410 * Here we remove *tg_pt_gp from the global list so that
1411 * no assications *OR* explict ALUA via SET_TARGET_PORT_GROUPS
1412 * can be made while we are releasing struct t10_alua_tg_pt_gp.
1414 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1415 list_del(&tg_pt_gp->tg_pt_gp_list);
1416 su_dev->t10_alua.alua_tg_pt_gps_counter--;
1417 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1419 * Allow a struct t10_alua_tg_pt_gp_member * referenced by
1420 * core_alua_get_tg_pt_gp_by_name() in
1421 * target_core_configfs.c:target_core_store_alua_tg_pt_gp()
1422 * to be released with core_alua_put_tg_pt_gp_from_name().
1424 while (atomic_read(&tg_pt_gp->tg_pt_gp_ref_cnt))
1427 * Release reference to struct t10_alua_tg_pt_gp from all associated
1430 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1431 list_for_each_entry_safe(tg_pt_gp_mem, tg_pt_gp_mem_tmp,
1432 &tg_pt_gp->tg_pt_gp_mem_list, tg_pt_gp_mem_list) {
1433 if (tg_pt_gp_mem->tg_pt_gp_assoc) {
1434 list_del(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1435 tg_pt_gp->tg_pt_gp_members--;
1436 tg_pt_gp_mem->tg_pt_gp_assoc = 0;
1438 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1440 * tg_pt_gp_mem is associated with a single
1441 * se_port->sep_alua_tg_pt_gp_mem, and is released via
1442 * core_alua_free_tg_pt_gp_mem().
1444 * If the passed tg_pt_gp does NOT match the default_tg_pt_gp,
1445 * assume we want to re-assocate a given tg_pt_gp_mem with
1448 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1449 if (tg_pt_gp != su_dev->t10_alua.default_tg_pt_gp) {
1450 __core_alua_attach_tg_pt_gp_mem(tg_pt_gp_mem,
1451 su_dev->t10_alua.default_tg_pt_gp);
1453 tg_pt_gp_mem->tg_pt_gp = NULL;
1454 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1456 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1458 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1460 kmem_cache_free(t10_alua_tg_pt_gp_cache, tg_pt_gp);
1463 void core_alua_free_tg_pt_gp_mem(struct se_port *port)
1465 struct se_subsystem_dev *su_dev = port->sep_lun->lun_se_dev->se_sub_dev;
1466 struct t10_alua *alua = &su_dev->t10_alua;
1467 struct t10_alua_tg_pt_gp *tg_pt_gp;
1468 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1470 if (alua->alua_type != SPC3_ALUA_EMULATED)
1473 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
1474 if (!(tg_pt_gp_mem))
1477 while (atomic_read(&tg_pt_gp_mem->tg_pt_gp_mem_ref_cnt))
1480 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1481 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1483 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1484 if (tg_pt_gp_mem->tg_pt_gp_assoc) {
1485 list_del(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1486 tg_pt_gp->tg_pt_gp_members--;
1487 tg_pt_gp_mem->tg_pt_gp_assoc = 0;
1489 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1490 tg_pt_gp_mem->tg_pt_gp = NULL;
1492 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1494 kmem_cache_free(t10_alua_tg_pt_gp_mem_cache, tg_pt_gp_mem);
1497 static struct t10_alua_tg_pt_gp *core_alua_get_tg_pt_gp_by_name(
1498 struct se_subsystem_dev *su_dev,
1501 struct t10_alua_tg_pt_gp *tg_pt_gp;
1502 struct config_item *ci;
1504 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1505 list_for_each_entry(tg_pt_gp, &su_dev->t10_alua.tg_pt_gps_list,
1507 if (!(tg_pt_gp->tg_pt_gp_valid_id))
1509 ci = &tg_pt_gp->tg_pt_gp_group.cg_item;
1510 if (!(strcmp(config_item_name(ci), name))) {
1511 atomic_inc(&tg_pt_gp->tg_pt_gp_ref_cnt);
1512 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1516 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1521 static void core_alua_put_tg_pt_gp_from_name(
1522 struct t10_alua_tg_pt_gp *tg_pt_gp)
1524 struct se_subsystem_dev *su_dev = tg_pt_gp->tg_pt_gp_su_dev;
1526 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1527 atomic_dec(&tg_pt_gp->tg_pt_gp_ref_cnt);
1528 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1532 * Called with struct t10_alua_tg_pt_gp_member->tg_pt_gp_mem_lock held
1534 void __core_alua_attach_tg_pt_gp_mem(
1535 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
1536 struct t10_alua_tg_pt_gp *tg_pt_gp)
1538 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1539 tg_pt_gp_mem->tg_pt_gp = tg_pt_gp;
1540 tg_pt_gp_mem->tg_pt_gp_assoc = 1;
1541 list_add_tail(&tg_pt_gp_mem->tg_pt_gp_mem_list,
1542 &tg_pt_gp->tg_pt_gp_mem_list);
1543 tg_pt_gp->tg_pt_gp_members++;
1544 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1548 * Called with struct t10_alua_tg_pt_gp_member->tg_pt_gp_mem_lock held
1550 static void __core_alua_drop_tg_pt_gp_mem(
1551 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
1552 struct t10_alua_tg_pt_gp *tg_pt_gp)
1554 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1555 list_del(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1556 tg_pt_gp_mem->tg_pt_gp = NULL;
1557 tg_pt_gp_mem->tg_pt_gp_assoc = 0;
1558 tg_pt_gp->tg_pt_gp_members--;
1559 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1562 ssize_t core_alua_show_tg_pt_gp_info(struct se_port *port, char *page)
1564 struct se_subsystem_dev *su_dev = port->sep_lun->lun_se_dev->se_sub_dev;
1565 struct config_item *tg_pt_ci;
1566 struct t10_alua *alua = &su_dev->t10_alua;
1567 struct t10_alua_tg_pt_gp *tg_pt_gp;
1568 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1571 if (alua->alua_type != SPC3_ALUA_EMULATED)
1574 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
1575 if (!(tg_pt_gp_mem))
1578 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1579 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1581 tg_pt_ci = &tg_pt_gp->tg_pt_gp_group.cg_item;
1582 len += sprintf(page, "TG Port Alias: %s\nTG Port Group ID:"
1583 " %hu\nTG Port Primary Access State: %s\nTG Port "
1584 "Primary Access Status: %s\nTG Port Secondary Access"
1585 " State: %s\nTG Port Secondary Access Status: %s\n",
1586 config_item_name(tg_pt_ci), tg_pt_gp->tg_pt_gp_id,
1587 core_alua_dump_state(atomic_read(
1588 &tg_pt_gp->tg_pt_gp_alua_access_state)),
1589 core_alua_dump_status(
1590 tg_pt_gp->tg_pt_gp_alua_access_status),
1591 (atomic_read(&port->sep_tg_pt_secondary_offline)) ?
1593 core_alua_dump_status(port->sep_tg_pt_secondary_stat));
1595 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1600 ssize_t core_alua_store_tg_pt_gp_info(
1601 struct se_port *port,
1605 struct se_portal_group *tpg;
1607 struct se_subsystem_dev *su_dev = port->sep_lun->lun_se_dev->se_sub_dev;
1608 struct t10_alua_tg_pt_gp *tg_pt_gp = NULL, *tg_pt_gp_new = NULL;
1609 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1610 unsigned char buf[TG_PT_GROUP_NAME_BUF];
1613 tpg = port->sep_tpg;
1614 lun = port->sep_lun;
1616 if (su_dev->t10_alua.alua_type != SPC3_ALUA_EMULATED) {
1617 printk(KERN_WARNING "SPC3_ALUA_EMULATED not enabled for"
1618 " %s/tpgt_%hu/%s\n", tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1619 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1620 config_item_name(&lun->lun_group.cg_item));
1624 if (count > TG_PT_GROUP_NAME_BUF) {
1625 printk(KERN_ERR "ALUA Target Port Group alias too large!\n");
1628 memset(buf, 0, TG_PT_GROUP_NAME_BUF);
1629 memcpy(buf, page, count);
1631 * Any ALUA target port group alias besides "NULL" means we will be
1632 * making a new group association.
1634 if (strcmp(strstrip(buf), "NULL")) {
1636 * core_alua_get_tg_pt_gp_by_name() will increment reference to
1637 * struct t10_alua_tg_pt_gp. This reference is released with
1638 * core_alua_put_tg_pt_gp_from_name() below.
1640 tg_pt_gp_new = core_alua_get_tg_pt_gp_by_name(su_dev,
1642 if (!(tg_pt_gp_new))
1645 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
1646 if (!(tg_pt_gp_mem)) {
1648 core_alua_put_tg_pt_gp_from_name(tg_pt_gp_new);
1649 printk(KERN_ERR "NULL struct se_port->sep_alua_tg_pt_gp_mem pointer\n");
1653 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1654 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1657 * Clearing an existing tg_pt_gp association, and replacing
1658 * with the default_tg_pt_gp.
1660 if (!(tg_pt_gp_new)) {
1661 printk(KERN_INFO "Target_Core_ConfigFS: Moving"
1662 " %s/tpgt_%hu/%s from ALUA Target Port Group:"
1663 " alua/%s, ID: %hu back to"
1664 " default_tg_pt_gp\n",
1665 tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1666 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1667 config_item_name(&lun->lun_group.cg_item),
1669 &tg_pt_gp->tg_pt_gp_group.cg_item),
1670 tg_pt_gp->tg_pt_gp_id);
1672 __core_alua_drop_tg_pt_gp_mem(tg_pt_gp_mem, tg_pt_gp);
1673 __core_alua_attach_tg_pt_gp_mem(tg_pt_gp_mem,
1674 su_dev->t10_alua.default_tg_pt_gp);
1675 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1680 * Removing existing association of tg_pt_gp_mem with tg_pt_gp
1682 __core_alua_drop_tg_pt_gp_mem(tg_pt_gp_mem, tg_pt_gp);
1686 * Associate tg_pt_gp_mem with tg_pt_gp_new.
1688 __core_alua_attach_tg_pt_gp_mem(tg_pt_gp_mem, tg_pt_gp_new);
1689 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1690 printk(KERN_INFO "Target_Core_ConfigFS: %s %s/tpgt_%hu/%s to ALUA"
1691 " Target Port Group: alua/%s, ID: %hu\n", (move) ?
1692 "Moving" : "Adding", tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1693 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1694 config_item_name(&lun->lun_group.cg_item),
1695 config_item_name(&tg_pt_gp_new->tg_pt_gp_group.cg_item),
1696 tg_pt_gp_new->tg_pt_gp_id);
1698 core_alua_put_tg_pt_gp_from_name(tg_pt_gp_new);
1702 ssize_t core_alua_show_access_type(
1703 struct t10_alua_tg_pt_gp *tg_pt_gp,
1706 if ((tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_EXPLICT_ALUA) &&
1707 (tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_IMPLICT_ALUA))
1708 return sprintf(page, "Implict and Explict\n");
1709 else if (tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_IMPLICT_ALUA)
1710 return sprintf(page, "Implict\n");
1711 else if (tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_EXPLICT_ALUA)
1712 return sprintf(page, "Explict\n");
1714 return sprintf(page, "None\n");
1717 ssize_t core_alua_store_access_type(
1718 struct t10_alua_tg_pt_gp *tg_pt_gp,
1725 ret = strict_strtoul(page, 0, &tmp);
1727 printk(KERN_ERR "Unable to extract alua_access_type\n");
1730 if ((tmp != 0) && (tmp != 1) && (tmp != 2) && (tmp != 3)) {
1731 printk(KERN_ERR "Illegal value for alua_access_type:"
1736 tg_pt_gp->tg_pt_gp_alua_access_type =
1737 TPGS_IMPLICT_ALUA | TPGS_EXPLICT_ALUA;
1739 tg_pt_gp->tg_pt_gp_alua_access_type = TPGS_EXPLICT_ALUA;
1741 tg_pt_gp->tg_pt_gp_alua_access_type = TPGS_IMPLICT_ALUA;
1743 tg_pt_gp->tg_pt_gp_alua_access_type = 0;
1748 ssize_t core_alua_show_nonop_delay_msecs(
1749 struct t10_alua_tg_pt_gp *tg_pt_gp,
1752 return sprintf(page, "%d\n", tg_pt_gp->tg_pt_gp_nonop_delay_msecs);
1755 ssize_t core_alua_store_nonop_delay_msecs(
1756 struct t10_alua_tg_pt_gp *tg_pt_gp,
1763 ret = strict_strtoul(page, 0, &tmp);
1765 printk(KERN_ERR "Unable to extract nonop_delay_msecs\n");
1768 if (tmp > ALUA_MAX_NONOP_DELAY_MSECS) {
1769 printk(KERN_ERR "Passed nonop_delay_msecs: %lu, exceeds"
1770 " ALUA_MAX_NONOP_DELAY_MSECS: %d\n", tmp,
1771 ALUA_MAX_NONOP_DELAY_MSECS);
1774 tg_pt_gp->tg_pt_gp_nonop_delay_msecs = (int)tmp;
1779 ssize_t core_alua_show_trans_delay_msecs(
1780 struct t10_alua_tg_pt_gp *tg_pt_gp,
1783 return sprintf(page, "%d\n", tg_pt_gp->tg_pt_gp_trans_delay_msecs);
1786 ssize_t core_alua_store_trans_delay_msecs(
1787 struct t10_alua_tg_pt_gp *tg_pt_gp,
1794 ret = strict_strtoul(page, 0, &tmp);
1796 printk(KERN_ERR "Unable to extract trans_delay_msecs\n");
1799 if (tmp > ALUA_MAX_TRANS_DELAY_MSECS) {
1800 printk(KERN_ERR "Passed trans_delay_msecs: %lu, exceeds"
1801 " ALUA_MAX_TRANS_DELAY_MSECS: %d\n", tmp,
1802 ALUA_MAX_TRANS_DELAY_MSECS);
1805 tg_pt_gp->tg_pt_gp_trans_delay_msecs = (int)tmp;
1810 ssize_t core_alua_show_preferred_bit(
1811 struct t10_alua_tg_pt_gp *tg_pt_gp,
1814 return sprintf(page, "%d\n", tg_pt_gp->tg_pt_gp_pref);
1817 ssize_t core_alua_store_preferred_bit(
1818 struct t10_alua_tg_pt_gp *tg_pt_gp,
1825 ret = strict_strtoul(page, 0, &tmp);
1827 printk(KERN_ERR "Unable to extract preferred ALUA value\n");
1830 if ((tmp != 0) && (tmp != 1)) {
1831 printk(KERN_ERR "Illegal value for preferred ALUA: %lu\n", tmp);
1834 tg_pt_gp->tg_pt_gp_pref = (int)tmp;
1839 ssize_t core_alua_show_offline_bit(struct se_lun *lun, char *page)
1841 if (!(lun->lun_sep))
1844 return sprintf(page, "%d\n",
1845 atomic_read(&lun->lun_sep->sep_tg_pt_secondary_offline));
1848 ssize_t core_alua_store_offline_bit(
1853 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1857 if (!(lun->lun_sep))
1860 ret = strict_strtoul(page, 0, &tmp);
1862 printk(KERN_ERR "Unable to extract alua_tg_pt_offline value\n");
1865 if ((tmp != 0) && (tmp != 1)) {
1866 printk(KERN_ERR "Illegal value for alua_tg_pt_offline: %lu\n",
1870 tg_pt_gp_mem = lun->lun_sep->sep_alua_tg_pt_gp_mem;
1871 if (!(tg_pt_gp_mem)) {
1872 printk(KERN_ERR "Unable to locate *tg_pt_gp_mem\n");
1876 ret = core_alua_set_tg_pt_secondary_state(tg_pt_gp_mem,
1877 lun->lun_sep, 0, (int)tmp);
1884 ssize_t core_alua_show_secondary_status(
1888 return sprintf(page, "%d\n", lun->lun_sep->sep_tg_pt_secondary_stat);
1891 ssize_t core_alua_store_secondary_status(
1899 ret = strict_strtoul(page, 0, &tmp);
1901 printk(KERN_ERR "Unable to extract alua_tg_pt_status\n");
1904 if ((tmp != ALUA_STATUS_NONE) &&
1905 (tmp != ALUA_STATUS_ALTERED_BY_EXPLICT_STPG) &&
1906 (tmp != ALUA_STATUS_ALTERED_BY_IMPLICT_ALUA)) {
1907 printk(KERN_ERR "Illegal value for alua_tg_pt_status: %lu\n",
1911 lun->lun_sep->sep_tg_pt_secondary_stat = (int)tmp;
1916 ssize_t core_alua_show_secondary_write_metadata(
1920 return sprintf(page, "%d\n",
1921 lun->lun_sep->sep_tg_pt_secondary_write_md);
1924 ssize_t core_alua_store_secondary_write_metadata(
1932 ret = strict_strtoul(page, 0, &tmp);
1934 printk(KERN_ERR "Unable to extract alua_tg_pt_write_md\n");
1937 if ((tmp != 0) && (tmp != 1)) {
1938 printk(KERN_ERR "Illegal value for alua_tg_pt_write_md:"
1942 lun->lun_sep->sep_tg_pt_secondary_write_md = (int)tmp;
1947 int core_setup_alua(struct se_device *dev, int force_pt)
1949 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
1950 struct t10_alua *alua = &su_dev->t10_alua;
1951 struct t10_alua_lu_gp_member *lu_gp_mem;
1953 * If this device is from Target_Core_Mod/pSCSI, use the ALUA logic
1954 * of the Underlying SCSI hardware. In Linux/SCSI terms, this can
1955 * cause a problem because libata and some SATA RAID HBAs appear
1956 * under Linux/SCSI, but emulate SCSI logic themselves.
1958 if (((dev->transport->transport_type == TRANSPORT_PLUGIN_PHBA_PDEV) &&
1959 !(dev->se_sub_dev->se_dev_attrib.emulate_alua)) || force_pt) {
1960 alua->alua_type = SPC_ALUA_PASSTHROUGH;
1961 alua->alua_state_check = &core_alua_state_check_nop;
1962 printk(KERN_INFO "%s: Using SPC_ALUA_PASSTHROUGH, no ALUA"
1963 " emulation\n", dev->transport->name);
1967 * If SPC-3 or above is reported by real or emulated struct se_device,
1968 * use emulated ALUA.
1970 if (dev->transport->get_device_rev(dev) >= SCSI_3) {
1971 printk(KERN_INFO "%s: Enabling ALUA Emulation for SPC-3"
1972 " device\n", dev->transport->name);
1974 * Associate this struct se_device with the default ALUA
1977 lu_gp_mem = core_alua_allocate_lu_gp_mem(dev);
1978 if (IS_ERR(lu_gp_mem))
1979 return PTR_ERR(lu_gp_mem);
1981 alua->alua_type = SPC3_ALUA_EMULATED;
1982 alua->alua_state_check = &core_alua_state_check;
1983 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
1984 __core_alua_attach_lu_gp_mem(lu_gp_mem,
1986 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
1988 printk(KERN_INFO "%s: Adding to default ALUA LU Group:"
1989 " core/alua/lu_gps/default_lu_gp\n",
1990 dev->transport->name);
1992 alua->alua_type = SPC2_ALUA_DISABLED;
1993 alua->alua_state_check = &core_alua_state_check_nop;
1994 printk(KERN_INFO "%s: Disabling ALUA Emulation for SPC-2"
1995 " device\n", dev->transport->name);