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 target_emulate_report_target_port_groups(struct se_task *task)
63 struct se_cmd *cmd = task->task_se_cmd;
64 struct se_subsystem_dev *su_dev = cmd->se_dev->se_sub_dev;
66 struct t10_alua_tg_pt_gp *tg_pt_gp;
67 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
69 u32 rd_len = 0, off = 4; /* Skip over RESERVED area to first
70 Target port group descriptor */
72 * Need at least 4 bytes of response data or else we can't
73 * even fit the return data length.
75 if (cmd->data_length < 4) {
76 pr_warn("REPORT TARGET PORT GROUPS allocation length %u"
77 " too small\n", cmd->data_length);
81 buf = transport_kmap_first_data_page(cmd);
83 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
84 list_for_each_entry(tg_pt_gp, &su_dev->t10_alua.tg_pt_gps_list,
87 * Check if the Target port group and Target port descriptor list
88 * based on tg_pt_gp_members count will fit into the response payload.
89 * Otherwise, bump rd_len to let the initiator know we have exceeded
90 * the allocation length and the response is truncated.
92 if ((off + 8 + (tg_pt_gp->tg_pt_gp_members * 4)) >
94 rd_len += 8 + (tg_pt_gp->tg_pt_gp_members * 4);
98 * PREF: Preferred target port bit, determine if this
99 * bit should be set for port group.
101 if (tg_pt_gp->tg_pt_gp_pref)
104 * Set the ASYMMETRIC ACCESS State
106 buf[off++] |= (atomic_read(
107 &tg_pt_gp->tg_pt_gp_alua_access_state) & 0xff);
109 * Set supported ASYMMETRIC ACCESS State bits
111 buf[off] = 0x80; /* T_SUP */
112 buf[off] |= 0x40; /* O_SUP */
113 buf[off] |= 0x8; /* U_SUP */
114 buf[off] |= 0x4; /* S_SUP */
115 buf[off] |= 0x2; /* AN_SUP */
116 buf[off++] |= 0x1; /* AO_SUP */
120 buf[off++] = ((tg_pt_gp->tg_pt_gp_id >> 8) & 0xff);
121 buf[off++] = (tg_pt_gp->tg_pt_gp_id & 0xff);
123 off++; /* Skip over Reserved */
127 buf[off++] = (tg_pt_gp->tg_pt_gp_alua_access_status & 0xff);
129 * Vendor Specific field
135 buf[off++] = (tg_pt_gp->tg_pt_gp_members & 0xff);
138 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
139 list_for_each_entry(tg_pt_gp_mem, &tg_pt_gp->tg_pt_gp_mem_list,
141 port = tg_pt_gp_mem->tg_pt;
143 * Start Target Port descriptor format
145 * See spc4r17 section 6.2.7 Table 247
147 off += 2; /* Skip over Obsolete */
149 * Set RELATIVE TARGET PORT IDENTIFIER
151 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
152 buf[off++] = (port->sep_rtpi & 0xff);
155 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
157 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
159 * Set the RETURN DATA LENGTH set in the header of the DataIN Payload
161 buf[0] = ((rd_len >> 24) & 0xff);
162 buf[1] = ((rd_len >> 16) & 0xff);
163 buf[2] = ((rd_len >> 8) & 0xff);
164 buf[3] = (rd_len & 0xff);
166 transport_kunmap_first_data_page(cmd);
172 * SET_TARGET_PORT_GROUPS for explict ALUA operation.
174 * See spc4r17 section 6.35
176 int target_emulate_set_target_port_groups(struct se_task *task)
178 struct se_cmd *cmd = task->task_se_cmd;
179 struct se_device *dev = cmd->se_dev;
180 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
181 struct se_port *port, *l_port = cmd->se_lun->lun_sep;
182 struct se_node_acl *nacl = cmd->se_sess->se_node_acl;
183 struct t10_alua_tg_pt_gp *tg_pt_gp = NULL, *l_tg_pt_gp;
184 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem, *l_tg_pt_gp_mem;
187 u32 len = 4; /* Skip over RESERVED area in header */
188 int alua_access_state, primary = 0, rc;
192 return PYX_TRANSPORT_LU_COMM_FAILURE;
194 buf = transport_kmap_first_data_page(cmd);
197 * Determine if explict ALUA via SET_TARGET_PORT_GROUPS is allowed
198 * for the local tg_pt_gp.
200 l_tg_pt_gp_mem = l_port->sep_alua_tg_pt_gp_mem;
201 if (!l_tg_pt_gp_mem) {
202 pr_err("Unable to access l_port->sep_alua_tg_pt_gp_mem\n");
203 rc = PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
206 spin_lock(&l_tg_pt_gp_mem->tg_pt_gp_mem_lock);
207 l_tg_pt_gp = l_tg_pt_gp_mem->tg_pt_gp;
209 spin_unlock(&l_tg_pt_gp_mem->tg_pt_gp_mem_lock);
210 pr_err("Unable to access *l_tg_pt_gp_mem->tg_pt_gp\n");
211 rc = PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
214 rc = (l_tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_EXPLICT_ALUA);
215 spin_unlock(&l_tg_pt_gp_mem->tg_pt_gp_mem_lock);
218 pr_debug("Unable to process SET_TARGET_PORT_GROUPS"
219 " while TPGS_EXPLICT_ALUA is disabled\n");
220 rc = PYX_TRANSPORT_UNKNOWN_SAM_OPCODE;
224 ptr = &buf[4]; /* Skip over RESERVED area in header */
226 while (len < cmd->data_length) {
227 alua_access_state = (ptr[0] & 0x0f);
229 * Check the received ALUA access state, and determine if
230 * the state is a primary or secondary target port asymmetric
233 rc = core_alua_check_transition(alua_access_state, &primary);
236 * If the SET TARGET PORT GROUPS attempts to establish
237 * an invalid combination of target port asymmetric
238 * access states or attempts to establish an
239 * unsupported target port asymmetric access state,
240 * then the command shall be terminated with CHECK
241 * CONDITION status, with the sense key set to ILLEGAL
242 * REQUEST, and the additional sense code set to INVALID
243 * FIELD IN PARAMETER LIST.
245 rc = PYX_TRANSPORT_INVALID_PARAMETER_LIST;
250 * If the ASYMMETRIC ACCESS STATE field (see table 267)
251 * specifies a primary target port asymmetric access state,
252 * then the TARGET PORT GROUP OR TARGET PORT field specifies
253 * a primary target port group for which the primary target
254 * port asymmetric access state shall be changed. If the
255 * ASYMMETRIC ACCESS STATE field specifies a secondary target
256 * port asymmetric access state, then the TARGET PORT GROUP OR
257 * TARGET PORT field specifies the relative target port
258 * identifier (see 3.1.120) of the target port for which the
259 * secondary target port asymmetric access state shall be
263 tg_pt_id = ((ptr[2] << 8) & 0xff);
264 tg_pt_id |= (ptr[3] & 0xff);
266 * Locate the matching target port group ID from
267 * the global tg_pt_gp list
269 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
270 list_for_each_entry(tg_pt_gp,
271 &su_dev->t10_alua.tg_pt_gps_list,
273 if (!tg_pt_gp->tg_pt_gp_valid_id)
276 if (tg_pt_id != tg_pt_gp->tg_pt_gp_id)
279 atomic_inc(&tg_pt_gp->tg_pt_gp_ref_cnt);
280 smp_mb__after_atomic_inc();
281 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
283 rc = core_alua_do_port_transition(tg_pt_gp,
285 alua_access_state, 1);
287 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
288 atomic_dec(&tg_pt_gp->tg_pt_gp_ref_cnt);
289 smp_mb__after_atomic_dec();
292 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
294 * If not matching target port group ID can be located
295 * throw an exception with ASCQ: INVALID_PARAMETER_LIST
298 rc = PYX_TRANSPORT_INVALID_PARAMETER_LIST;
303 * Extact the RELATIVE TARGET PORT IDENTIFIER to identify
304 * the Target Port in question for the the incoming
305 * SET_TARGET_PORT_GROUPS op.
307 rtpi = ((ptr[2] << 8) & 0xff);
308 rtpi |= (ptr[3] & 0xff);
310 * Locate the matching relative target port identifer
311 * for the struct se_device storage object.
313 spin_lock(&dev->se_port_lock);
314 list_for_each_entry(port, &dev->dev_sep_list,
316 if (port->sep_rtpi != rtpi)
319 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
320 spin_unlock(&dev->se_port_lock);
322 rc = core_alua_set_tg_pt_secondary_state(
323 tg_pt_gp_mem, port, 1, 1);
325 spin_lock(&dev->se_port_lock);
328 spin_unlock(&dev->se_port_lock);
330 * If not matching relative target port identifier can
331 * be located, throw an exception with ASCQ:
332 * INVALID_PARAMETER_LIST
335 rc = PYX_TRANSPORT_INVALID_PARAMETER_LIST;
345 transport_kunmap_first_data_page(cmd);
350 static inline int core_alua_state_nonoptimized(
353 int nonop_delay_msecs,
357 * Set SCF_ALUA_NON_OPTIMIZED here, this value will be checked
358 * later to determine if processing of this cmd needs to be
359 * temporarily delayed for the Active/NonOptimized primary access state.
361 cmd->se_cmd_flags |= SCF_ALUA_NON_OPTIMIZED;
362 cmd->alua_nonop_delay = nonop_delay_msecs;
366 static inline int core_alua_state_standby(
372 * Allowed CDBs for ALUA_ACCESS_STATE_STANDBY as defined by
373 * spc4r17 section 5.9.2.4.4
382 case RECEIVE_DIAGNOSTIC:
383 case SEND_DIAGNOSTIC:
386 case MI_REPORT_TARGET_PGS:
389 *alua_ascq = ASCQ_04H_ALUA_TG_PT_STANDBY;
392 case MAINTENANCE_OUT:
394 case MO_SET_TARGET_PGS:
397 *alua_ascq = ASCQ_04H_ALUA_TG_PT_STANDBY;
401 case PERSISTENT_RESERVE_IN:
402 case PERSISTENT_RESERVE_OUT:
407 *alua_ascq = ASCQ_04H_ALUA_TG_PT_STANDBY;
414 static inline int core_alua_state_unavailable(
420 * Allowed CDBs for ALUA_ACCESS_STATE_UNAVAILABLE as defined by
421 * spc4r17 section 5.9.2.4.5
428 case MI_REPORT_TARGET_PGS:
431 *alua_ascq = ASCQ_04H_ALUA_TG_PT_UNAVAILABLE;
434 case MAINTENANCE_OUT:
436 case MO_SET_TARGET_PGS:
439 *alua_ascq = ASCQ_04H_ALUA_TG_PT_UNAVAILABLE;
447 *alua_ascq = ASCQ_04H_ALUA_TG_PT_UNAVAILABLE;
454 static inline int core_alua_state_transition(
460 * Allowed CDBs for ALUA_ACCESS_STATE_TRANSITIO as defined by
461 * spc4r17 section 5.9.2.5
468 case MI_REPORT_TARGET_PGS:
471 *alua_ascq = ASCQ_04H_ALUA_STATE_TRANSITION;
479 *alua_ascq = ASCQ_04H_ALUA_STATE_TRANSITION;
487 * Used for alua_type SPC_ALUA_PASSTHROUGH and SPC2_ALUA_DISABLED
488 * in transport_cmd_sequencer(). This function is assigned to
489 * struct t10_alua *->state_check() in core_setup_alua()
491 static int core_alua_state_check_nop(
500 * Used for alua_type SPC3_ALUA_EMULATED in transport_cmd_sequencer().
501 * This function is assigned to struct t10_alua *->state_check() in
504 * Also, this function can return three different return codes to
505 * signal transport_generic_cmd_sequencer()
507 * return 1: Is used to signal LUN not accecsable, and check condition/not ready
508 * return 0: Used to signal success
509 * reutrn -1: Used to signal failure, and invalid cdb field
511 static int core_alua_state_check(
516 struct se_lun *lun = cmd->se_lun;
517 struct se_port *port = lun->lun_sep;
518 struct t10_alua_tg_pt_gp *tg_pt_gp;
519 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
520 int out_alua_state, nonop_delay_msecs;
525 * First, check for a struct se_port specific secondary ALUA target port
526 * access state: OFFLINE
528 if (atomic_read(&port->sep_tg_pt_secondary_offline)) {
529 *alua_ascq = ASCQ_04H_ALUA_OFFLINE;
530 pr_debug("ALUA: Got secondary offline status for local"
532 *alua_ascq = ASCQ_04H_ALUA_OFFLINE;
536 * Second, obtain the struct t10_alua_tg_pt_gp_member pointer to the
537 * ALUA target port group, to obtain current ALUA access state.
538 * Otherwise look for the underlying struct se_device association with
539 * a ALUA logical unit group.
541 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
542 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
543 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
544 out_alua_state = atomic_read(&tg_pt_gp->tg_pt_gp_alua_access_state);
545 nonop_delay_msecs = tg_pt_gp->tg_pt_gp_nonop_delay_msecs;
546 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
548 * Process ALUA_ACCESS_STATE_ACTIVE_OPTMIZED in a separate conditional
549 * statement so the compiler knows explicitly to check this case first.
550 * For the Optimized ALUA access state case, we want to process the
551 * incoming fabric cmd ASAP..
553 if (out_alua_state == ALUA_ACCESS_STATE_ACTIVE_OPTMIZED)
556 switch (out_alua_state) {
557 case ALUA_ACCESS_STATE_ACTIVE_NON_OPTIMIZED:
558 return core_alua_state_nonoptimized(cmd, cdb,
559 nonop_delay_msecs, alua_ascq);
560 case ALUA_ACCESS_STATE_STANDBY:
561 return core_alua_state_standby(cmd, cdb, alua_ascq);
562 case ALUA_ACCESS_STATE_UNAVAILABLE:
563 return core_alua_state_unavailable(cmd, cdb, alua_ascq);
564 case ALUA_ACCESS_STATE_TRANSITION:
565 return core_alua_state_transition(cmd, cdb, alua_ascq);
567 * OFFLINE is a secondary ALUA target port group access state, that is
568 * handled above with struct se_port->sep_tg_pt_secondary_offline=1
570 case ALUA_ACCESS_STATE_OFFLINE:
572 pr_err("Unknown ALUA access state: 0x%02x\n",
581 * Check implict and explict ALUA state change request.
583 static int core_alua_check_transition(int state, int *primary)
586 case ALUA_ACCESS_STATE_ACTIVE_OPTMIZED:
587 case ALUA_ACCESS_STATE_ACTIVE_NON_OPTIMIZED:
588 case ALUA_ACCESS_STATE_STANDBY:
589 case ALUA_ACCESS_STATE_UNAVAILABLE:
591 * OPTIMIZED, NON-OPTIMIZED, STANDBY and UNAVAILABLE are
592 * defined as primary target port asymmetric access states.
596 case ALUA_ACCESS_STATE_OFFLINE:
598 * OFFLINE state is defined as a secondary target port
599 * asymmetric access state.
604 pr_err("Unknown ALUA access state: 0x%02x\n", state);
611 static char *core_alua_dump_state(int state)
614 case ALUA_ACCESS_STATE_ACTIVE_OPTMIZED:
615 return "Active/Optimized";
616 case ALUA_ACCESS_STATE_ACTIVE_NON_OPTIMIZED:
617 return "Active/NonOptimized";
618 case ALUA_ACCESS_STATE_STANDBY:
620 case ALUA_ACCESS_STATE_UNAVAILABLE:
621 return "Unavailable";
622 case ALUA_ACCESS_STATE_OFFLINE:
631 char *core_alua_dump_status(int status)
634 case ALUA_STATUS_NONE:
636 case ALUA_STATUS_ALTERED_BY_EXPLICT_STPG:
637 return "Altered by Explict STPG";
638 case ALUA_STATUS_ALTERED_BY_IMPLICT_ALUA:
639 return "Altered by Implict ALUA";
648 * Used by fabric modules to determine when we need to delay processing
649 * for the Active/NonOptimized paths..
651 int core_alua_check_nonop_delay(
654 if (!(cmd->se_cmd_flags & SCF_ALUA_NON_OPTIMIZED))
659 * The ALUA Active/NonOptimized access state delay can be disabled
660 * in via configfs with a value of zero
662 if (!cmd->alua_nonop_delay)
665 * struct se_cmd->alua_nonop_delay gets set by a target port group
666 * defined interval in core_alua_state_nonoptimized()
668 msleep_interruptible(cmd->alua_nonop_delay);
671 EXPORT_SYMBOL(core_alua_check_nonop_delay);
674 * Called with tg_pt_gp->tg_pt_gp_md_mutex or tg_pt_gp_mem->sep_tg_pt_md_mutex
677 static int core_alua_write_tpg_metadata(
679 unsigned char *md_buf,
685 int flags = O_RDWR | O_CREAT | O_TRUNC, ret;
687 memset(iov, 0, sizeof(struct iovec));
689 file = filp_open(path, flags, 0600);
690 if (IS_ERR(file) || !file || !file->f_dentry) {
691 pr_err("filp_open(%s) for ALUA metadata failed\n",
696 iov[0].iov_base = &md_buf[0];
697 iov[0].iov_len = md_buf_len;
701 ret = vfs_writev(file, &iov[0], 1, &file->f_pos);
705 pr_err("Error writing ALUA metadata file: %s\n", path);
706 filp_close(file, NULL);
709 filp_close(file, NULL);
715 * Called with tg_pt_gp->tg_pt_gp_md_mutex held
717 static int core_alua_update_tpg_primary_metadata(
718 struct t10_alua_tg_pt_gp *tg_pt_gp,
720 unsigned char *md_buf)
722 struct se_subsystem_dev *su_dev = tg_pt_gp->tg_pt_gp_su_dev;
723 struct t10_wwn *wwn = &su_dev->t10_wwn;
724 char path[ALUA_METADATA_PATH_LEN];
727 memset(path, 0, ALUA_METADATA_PATH_LEN);
729 len = snprintf(md_buf, tg_pt_gp->tg_pt_gp_md_buf_len,
731 "alua_access_state=0x%02x\n"
732 "alua_access_status=0x%02x\n",
733 tg_pt_gp->tg_pt_gp_id, primary_state,
734 tg_pt_gp->tg_pt_gp_alua_access_status);
736 snprintf(path, ALUA_METADATA_PATH_LEN,
737 "/var/target/alua/tpgs_%s/%s", &wwn->unit_serial[0],
738 config_item_name(&tg_pt_gp->tg_pt_gp_group.cg_item));
740 return core_alua_write_tpg_metadata(path, md_buf, len);
743 static int core_alua_do_transition_tg_pt(
744 struct t10_alua_tg_pt_gp *tg_pt_gp,
745 struct se_port *l_port,
746 struct se_node_acl *nacl,
747 unsigned char *md_buf,
751 struct se_dev_entry *se_deve;
752 struct se_lun_acl *lacl;
753 struct se_port *port;
754 struct t10_alua_tg_pt_gp_member *mem;
757 * Save the old primary ALUA access state, and set the current state
758 * to ALUA_ACCESS_STATE_TRANSITION.
760 old_state = atomic_read(&tg_pt_gp->tg_pt_gp_alua_access_state);
761 atomic_set(&tg_pt_gp->tg_pt_gp_alua_access_state,
762 ALUA_ACCESS_STATE_TRANSITION);
763 tg_pt_gp->tg_pt_gp_alua_access_status = (explict) ?
764 ALUA_STATUS_ALTERED_BY_EXPLICT_STPG :
765 ALUA_STATUS_ALTERED_BY_IMPLICT_ALUA;
767 * Check for the optional ALUA primary state transition delay
769 if (tg_pt_gp->tg_pt_gp_trans_delay_msecs != 0)
770 msleep_interruptible(tg_pt_gp->tg_pt_gp_trans_delay_msecs);
772 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
773 list_for_each_entry(mem, &tg_pt_gp->tg_pt_gp_mem_list,
777 * After an implicit target port asymmetric access state
778 * change, a device server shall establish a unit attention
779 * condition for the initiator port associated with every I_T
780 * nexus with the additional sense code set to ASYMMETRIC
781 * ACCESS STATE CHAGED.
783 * After an explicit target port asymmetric access state
784 * change, a device server shall establish a unit attention
785 * condition with the additional sense code set to ASYMMETRIC
786 * ACCESS STATE CHANGED for the initiator port associated with
787 * every I_T nexus other than the I_T nexus on which the SET
788 * TARGET PORT GROUPS command
790 atomic_inc(&mem->tg_pt_gp_mem_ref_cnt);
791 smp_mb__after_atomic_inc();
792 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
794 spin_lock_bh(&port->sep_alua_lock);
795 list_for_each_entry(se_deve, &port->sep_alua_list,
797 lacl = se_deve->se_lun_acl;
799 * se_deve->se_lun_acl pointer may be NULL for a
800 * entry created without explict Node+MappedLUN ACLs
806 (nacl != NULL) && (nacl == lacl->se_lun_nacl) &&
807 (l_port != NULL) && (l_port == port))
810 core_scsi3_ua_allocate(lacl->se_lun_nacl,
811 se_deve->mapped_lun, 0x2A,
812 ASCQ_2AH_ASYMMETRIC_ACCESS_STATE_CHANGED);
814 spin_unlock_bh(&port->sep_alua_lock);
816 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
817 atomic_dec(&mem->tg_pt_gp_mem_ref_cnt);
818 smp_mb__after_atomic_dec();
820 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
822 * Update the ALUA metadata buf that has been allocated in
823 * core_alua_do_port_transition(), this metadata will be written
826 * Note that there is the case where we do not want to update the
827 * metadata when the saved metadata is being parsed in userspace
828 * when setting the existing port access state and access status.
830 * Also note that the failure to write out the ALUA metadata to
831 * struct file does NOT affect the actual ALUA transition.
833 if (tg_pt_gp->tg_pt_gp_write_metadata) {
834 mutex_lock(&tg_pt_gp->tg_pt_gp_md_mutex);
835 core_alua_update_tpg_primary_metadata(tg_pt_gp,
837 mutex_unlock(&tg_pt_gp->tg_pt_gp_md_mutex);
840 * Set the current primary ALUA access state to the requested new state
842 atomic_set(&tg_pt_gp->tg_pt_gp_alua_access_state, new_state);
844 pr_debug("Successful %s ALUA transition TG PT Group: %s ID: %hu"
845 " from primary access state %s to %s\n", (explict) ? "explict" :
846 "implict", config_item_name(&tg_pt_gp->tg_pt_gp_group.cg_item),
847 tg_pt_gp->tg_pt_gp_id, core_alua_dump_state(old_state),
848 core_alua_dump_state(new_state));
853 int core_alua_do_port_transition(
854 struct t10_alua_tg_pt_gp *l_tg_pt_gp,
855 struct se_device *l_dev,
856 struct se_port *l_port,
857 struct se_node_acl *l_nacl,
861 struct se_device *dev;
862 struct se_port *port;
863 struct se_subsystem_dev *su_dev;
864 struct se_node_acl *nacl;
865 struct t10_alua_lu_gp *lu_gp;
866 struct t10_alua_lu_gp_member *lu_gp_mem, *local_lu_gp_mem;
867 struct t10_alua_tg_pt_gp *tg_pt_gp;
868 unsigned char *md_buf;
871 if (core_alua_check_transition(new_state, &primary) != 0)
874 md_buf = kzalloc(l_tg_pt_gp->tg_pt_gp_md_buf_len, GFP_KERNEL);
876 pr_err("Unable to allocate buf for ALUA metadata\n");
880 local_lu_gp_mem = l_dev->dev_alua_lu_gp_mem;
881 spin_lock(&local_lu_gp_mem->lu_gp_mem_lock);
882 lu_gp = local_lu_gp_mem->lu_gp;
883 atomic_inc(&lu_gp->lu_gp_ref_cnt);
884 smp_mb__after_atomic_inc();
885 spin_unlock(&local_lu_gp_mem->lu_gp_mem_lock);
887 * For storage objects that are members of the 'default_lu_gp',
888 * we only do transition on the passed *l_tp_pt_gp, and not
889 * on all of the matching target port groups IDs in default_lu_gp.
891 if (!lu_gp->lu_gp_id) {
893 * core_alua_do_transition_tg_pt() will always return
896 core_alua_do_transition_tg_pt(l_tg_pt_gp, l_port, l_nacl,
897 md_buf, new_state, explict);
898 atomic_dec(&lu_gp->lu_gp_ref_cnt);
899 smp_mb__after_atomic_dec();
904 * For all other LU groups aside from 'default_lu_gp', walk all of
905 * the associated storage objects looking for a matching target port
906 * group ID from the local target port group.
908 spin_lock(&lu_gp->lu_gp_lock);
909 list_for_each_entry(lu_gp_mem, &lu_gp->lu_gp_mem_list,
912 dev = lu_gp_mem->lu_gp_mem_dev;
913 su_dev = dev->se_sub_dev;
914 atomic_inc(&lu_gp_mem->lu_gp_mem_ref_cnt);
915 smp_mb__after_atomic_inc();
916 spin_unlock(&lu_gp->lu_gp_lock);
918 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
919 list_for_each_entry(tg_pt_gp,
920 &su_dev->t10_alua.tg_pt_gps_list,
923 if (!tg_pt_gp->tg_pt_gp_valid_id)
926 * If the target behavior port asymmetric access state
927 * is changed for any target port group accessiable via
928 * a logical unit within a LU group, the target port
929 * behavior group asymmetric access states for the same
930 * target port group accessible via other logical units
931 * in that LU group will also change.
933 if (l_tg_pt_gp->tg_pt_gp_id != tg_pt_gp->tg_pt_gp_id)
936 if (l_tg_pt_gp == tg_pt_gp) {
943 atomic_inc(&tg_pt_gp->tg_pt_gp_ref_cnt);
944 smp_mb__after_atomic_inc();
945 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
947 * core_alua_do_transition_tg_pt() will always return
950 core_alua_do_transition_tg_pt(tg_pt_gp, port,
951 nacl, md_buf, new_state, explict);
953 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
954 atomic_dec(&tg_pt_gp->tg_pt_gp_ref_cnt);
955 smp_mb__after_atomic_dec();
957 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
959 spin_lock(&lu_gp->lu_gp_lock);
960 atomic_dec(&lu_gp_mem->lu_gp_mem_ref_cnt);
961 smp_mb__after_atomic_dec();
963 spin_unlock(&lu_gp->lu_gp_lock);
965 pr_debug("Successfully processed LU Group: %s all ALUA TG PT"
966 " Group IDs: %hu %s transition to primary state: %s\n",
967 config_item_name(&lu_gp->lu_gp_group.cg_item),
968 l_tg_pt_gp->tg_pt_gp_id, (explict) ? "explict" : "implict",
969 core_alua_dump_state(new_state));
971 atomic_dec(&lu_gp->lu_gp_ref_cnt);
972 smp_mb__after_atomic_dec();
978 * Called with tg_pt_gp_mem->sep_tg_pt_md_mutex held
980 static int core_alua_update_tpg_secondary_metadata(
981 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
982 struct se_port *port,
983 unsigned char *md_buf,
986 struct se_portal_group *se_tpg = port->sep_tpg;
987 char path[ALUA_METADATA_PATH_LEN], wwn[ALUA_SECONDARY_METADATA_WWN_LEN];
990 memset(path, 0, ALUA_METADATA_PATH_LEN);
991 memset(wwn, 0, ALUA_SECONDARY_METADATA_WWN_LEN);
993 len = snprintf(wwn, ALUA_SECONDARY_METADATA_WWN_LEN, "%s",
994 se_tpg->se_tpg_tfo->tpg_get_wwn(se_tpg));
996 if (se_tpg->se_tpg_tfo->tpg_get_tag != NULL)
997 snprintf(wwn+len, ALUA_SECONDARY_METADATA_WWN_LEN-len, "+%hu",
998 se_tpg->se_tpg_tfo->tpg_get_tag(se_tpg));
1000 len = snprintf(md_buf, md_buf_len, "alua_tg_pt_offline=%d\n"
1001 "alua_tg_pt_status=0x%02x\n",
1002 atomic_read(&port->sep_tg_pt_secondary_offline),
1003 port->sep_tg_pt_secondary_stat);
1005 snprintf(path, ALUA_METADATA_PATH_LEN, "/var/target/alua/%s/%s/lun_%u",
1006 se_tpg->se_tpg_tfo->get_fabric_name(), wwn,
1007 port->sep_lun->unpacked_lun);
1009 return core_alua_write_tpg_metadata(path, md_buf, len);
1012 static int core_alua_set_tg_pt_secondary_state(
1013 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
1014 struct se_port *port,
1018 struct t10_alua_tg_pt_gp *tg_pt_gp;
1019 unsigned char *md_buf;
1021 int trans_delay_msecs;
1023 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1024 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1026 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1027 pr_err("Unable to complete secondary state"
1031 trans_delay_msecs = tg_pt_gp->tg_pt_gp_trans_delay_msecs;
1033 * Set the secondary ALUA target port access state to OFFLINE
1034 * or release the previously secondary state for struct se_port
1037 atomic_set(&port->sep_tg_pt_secondary_offline, 1);
1039 atomic_set(&port->sep_tg_pt_secondary_offline, 0);
1041 md_buf_len = tg_pt_gp->tg_pt_gp_md_buf_len;
1042 port->sep_tg_pt_secondary_stat = (explict) ?
1043 ALUA_STATUS_ALTERED_BY_EXPLICT_STPG :
1044 ALUA_STATUS_ALTERED_BY_IMPLICT_ALUA;
1046 pr_debug("Successful %s ALUA transition TG PT Group: %s ID: %hu"
1047 " to secondary access state: %s\n", (explict) ? "explict" :
1048 "implict", config_item_name(&tg_pt_gp->tg_pt_gp_group.cg_item),
1049 tg_pt_gp->tg_pt_gp_id, (offline) ? "OFFLINE" : "ONLINE");
1051 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1053 * Do the optional transition delay after we set the secondary
1054 * ALUA access state.
1056 if (trans_delay_msecs != 0)
1057 msleep_interruptible(trans_delay_msecs);
1059 * See if we need to update the ALUA fabric port metadata for
1060 * secondary state and status
1062 if (port->sep_tg_pt_secondary_write_md) {
1063 md_buf = kzalloc(md_buf_len, GFP_KERNEL);
1065 pr_err("Unable to allocate md_buf for"
1066 " secondary ALUA access metadata\n");
1069 mutex_lock(&port->sep_tg_pt_md_mutex);
1070 core_alua_update_tpg_secondary_metadata(tg_pt_gp_mem, port,
1071 md_buf, md_buf_len);
1072 mutex_unlock(&port->sep_tg_pt_md_mutex);
1080 struct t10_alua_lu_gp *
1081 core_alua_allocate_lu_gp(const char *name, int def_group)
1083 struct t10_alua_lu_gp *lu_gp;
1085 lu_gp = kmem_cache_zalloc(t10_alua_lu_gp_cache, GFP_KERNEL);
1087 pr_err("Unable to allocate struct t10_alua_lu_gp\n");
1088 return ERR_PTR(-ENOMEM);
1090 INIT_LIST_HEAD(&lu_gp->lu_gp_node);
1091 INIT_LIST_HEAD(&lu_gp->lu_gp_mem_list);
1092 spin_lock_init(&lu_gp->lu_gp_lock);
1093 atomic_set(&lu_gp->lu_gp_ref_cnt, 0);
1096 lu_gp->lu_gp_id = alua_lu_gps_counter++;
1097 lu_gp->lu_gp_valid_id = 1;
1098 alua_lu_gps_count++;
1104 int core_alua_set_lu_gp_id(struct t10_alua_lu_gp *lu_gp, u16 lu_gp_id)
1106 struct t10_alua_lu_gp *lu_gp_tmp;
1109 * The lu_gp->lu_gp_id may only be set once..
1111 if (lu_gp->lu_gp_valid_id) {
1112 pr_warn("ALUA LU Group already has a valid ID,"
1113 " ignoring request\n");
1117 spin_lock(&lu_gps_lock);
1118 if (alua_lu_gps_count == 0x0000ffff) {
1119 pr_err("Maximum ALUA alua_lu_gps_count:"
1120 " 0x0000ffff reached\n");
1121 spin_unlock(&lu_gps_lock);
1122 kmem_cache_free(t10_alua_lu_gp_cache, lu_gp);
1126 lu_gp_id_tmp = (lu_gp_id != 0) ? lu_gp_id :
1127 alua_lu_gps_counter++;
1129 list_for_each_entry(lu_gp_tmp, &lu_gps_list, lu_gp_node) {
1130 if (lu_gp_tmp->lu_gp_id == lu_gp_id_tmp) {
1134 pr_warn("ALUA Logical Unit Group ID: %hu"
1135 " already exists, ignoring request\n",
1137 spin_unlock(&lu_gps_lock);
1142 lu_gp->lu_gp_id = lu_gp_id_tmp;
1143 lu_gp->lu_gp_valid_id = 1;
1144 list_add_tail(&lu_gp->lu_gp_node, &lu_gps_list);
1145 alua_lu_gps_count++;
1146 spin_unlock(&lu_gps_lock);
1151 static struct t10_alua_lu_gp_member *
1152 core_alua_allocate_lu_gp_mem(struct se_device *dev)
1154 struct t10_alua_lu_gp_member *lu_gp_mem;
1156 lu_gp_mem = kmem_cache_zalloc(t10_alua_lu_gp_mem_cache, GFP_KERNEL);
1158 pr_err("Unable to allocate struct t10_alua_lu_gp_member\n");
1159 return ERR_PTR(-ENOMEM);
1161 INIT_LIST_HEAD(&lu_gp_mem->lu_gp_mem_list);
1162 spin_lock_init(&lu_gp_mem->lu_gp_mem_lock);
1163 atomic_set(&lu_gp_mem->lu_gp_mem_ref_cnt, 0);
1165 lu_gp_mem->lu_gp_mem_dev = dev;
1166 dev->dev_alua_lu_gp_mem = lu_gp_mem;
1171 void core_alua_free_lu_gp(struct t10_alua_lu_gp *lu_gp)
1173 struct t10_alua_lu_gp_member *lu_gp_mem, *lu_gp_mem_tmp;
1175 * Once we have reached this point, config_item_put() has
1176 * already been called from target_core_alua_drop_lu_gp().
1178 * Here, we remove the *lu_gp from the global list so that
1179 * no associations can be made while we are releasing
1180 * struct t10_alua_lu_gp.
1182 spin_lock(&lu_gps_lock);
1183 atomic_set(&lu_gp->lu_gp_shutdown, 1);
1184 list_del(&lu_gp->lu_gp_node);
1185 alua_lu_gps_count--;
1186 spin_unlock(&lu_gps_lock);
1188 * Allow struct t10_alua_lu_gp * referenced by core_alua_get_lu_gp_by_name()
1189 * in target_core_configfs.c:target_core_store_alua_lu_gp() to be
1190 * released with core_alua_put_lu_gp_from_name()
1192 while (atomic_read(&lu_gp->lu_gp_ref_cnt))
1195 * Release reference to struct t10_alua_lu_gp * from all associated
1198 spin_lock(&lu_gp->lu_gp_lock);
1199 list_for_each_entry_safe(lu_gp_mem, lu_gp_mem_tmp,
1200 &lu_gp->lu_gp_mem_list, lu_gp_mem_list) {
1201 if (lu_gp_mem->lu_gp_assoc) {
1202 list_del(&lu_gp_mem->lu_gp_mem_list);
1203 lu_gp->lu_gp_members--;
1204 lu_gp_mem->lu_gp_assoc = 0;
1206 spin_unlock(&lu_gp->lu_gp_lock);
1209 * lu_gp_mem is associated with a single
1210 * struct se_device->dev_alua_lu_gp_mem, and is released when
1211 * struct se_device is released via core_alua_free_lu_gp_mem().
1213 * If the passed lu_gp does NOT match the default_lu_gp, assume
1214 * we want to re-assocate a given lu_gp_mem with default_lu_gp.
1216 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
1217 if (lu_gp != default_lu_gp)
1218 __core_alua_attach_lu_gp_mem(lu_gp_mem,
1221 lu_gp_mem->lu_gp = NULL;
1222 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
1224 spin_lock(&lu_gp->lu_gp_lock);
1226 spin_unlock(&lu_gp->lu_gp_lock);
1228 kmem_cache_free(t10_alua_lu_gp_cache, lu_gp);
1231 void core_alua_free_lu_gp_mem(struct se_device *dev)
1233 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
1234 struct t10_alua *alua = &su_dev->t10_alua;
1235 struct t10_alua_lu_gp *lu_gp;
1236 struct t10_alua_lu_gp_member *lu_gp_mem;
1238 if (alua->alua_type != SPC3_ALUA_EMULATED)
1241 lu_gp_mem = dev->dev_alua_lu_gp_mem;
1245 while (atomic_read(&lu_gp_mem->lu_gp_mem_ref_cnt))
1248 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
1249 lu_gp = lu_gp_mem->lu_gp;
1251 spin_lock(&lu_gp->lu_gp_lock);
1252 if (lu_gp_mem->lu_gp_assoc) {
1253 list_del(&lu_gp_mem->lu_gp_mem_list);
1254 lu_gp->lu_gp_members--;
1255 lu_gp_mem->lu_gp_assoc = 0;
1257 spin_unlock(&lu_gp->lu_gp_lock);
1258 lu_gp_mem->lu_gp = NULL;
1260 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
1262 kmem_cache_free(t10_alua_lu_gp_mem_cache, lu_gp_mem);
1265 struct t10_alua_lu_gp *core_alua_get_lu_gp_by_name(const char *name)
1267 struct t10_alua_lu_gp *lu_gp;
1268 struct config_item *ci;
1270 spin_lock(&lu_gps_lock);
1271 list_for_each_entry(lu_gp, &lu_gps_list, lu_gp_node) {
1272 if (!lu_gp->lu_gp_valid_id)
1274 ci = &lu_gp->lu_gp_group.cg_item;
1275 if (!strcmp(config_item_name(ci), name)) {
1276 atomic_inc(&lu_gp->lu_gp_ref_cnt);
1277 spin_unlock(&lu_gps_lock);
1281 spin_unlock(&lu_gps_lock);
1286 void core_alua_put_lu_gp_from_name(struct t10_alua_lu_gp *lu_gp)
1288 spin_lock(&lu_gps_lock);
1289 atomic_dec(&lu_gp->lu_gp_ref_cnt);
1290 spin_unlock(&lu_gps_lock);
1294 * Called with struct t10_alua_lu_gp_member->lu_gp_mem_lock
1296 void __core_alua_attach_lu_gp_mem(
1297 struct t10_alua_lu_gp_member *lu_gp_mem,
1298 struct t10_alua_lu_gp *lu_gp)
1300 spin_lock(&lu_gp->lu_gp_lock);
1301 lu_gp_mem->lu_gp = lu_gp;
1302 lu_gp_mem->lu_gp_assoc = 1;
1303 list_add_tail(&lu_gp_mem->lu_gp_mem_list, &lu_gp->lu_gp_mem_list);
1304 lu_gp->lu_gp_members++;
1305 spin_unlock(&lu_gp->lu_gp_lock);
1309 * Called with struct t10_alua_lu_gp_member->lu_gp_mem_lock
1311 void __core_alua_drop_lu_gp_mem(
1312 struct t10_alua_lu_gp_member *lu_gp_mem,
1313 struct t10_alua_lu_gp *lu_gp)
1315 spin_lock(&lu_gp->lu_gp_lock);
1316 list_del(&lu_gp_mem->lu_gp_mem_list);
1317 lu_gp_mem->lu_gp = NULL;
1318 lu_gp_mem->lu_gp_assoc = 0;
1319 lu_gp->lu_gp_members--;
1320 spin_unlock(&lu_gp->lu_gp_lock);
1323 struct t10_alua_tg_pt_gp *core_alua_allocate_tg_pt_gp(
1324 struct se_subsystem_dev *su_dev,
1328 struct t10_alua_tg_pt_gp *tg_pt_gp;
1330 tg_pt_gp = kmem_cache_zalloc(t10_alua_tg_pt_gp_cache, GFP_KERNEL);
1332 pr_err("Unable to allocate struct t10_alua_tg_pt_gp\n");
1335 INIT_LIST_HEAD(&tg_pt_gp->tg_pt_gp_list);
1336 INIT_LIST_HEAD(&tg_pt_gp->tg_pt_gp_mem_list);
1337 mutex_init(&tg_pt_gp->tg_pt_gp_md_mutex);
1338 spin_lock_init(&tg_pt_gp->tg_pt_gp_lock);
1339 atomic_set(&tg_pt_gp->tg_pt_gp_ref_cnt, 0);
1340 tg_pt_gp->tg_pt_gp_su_dev = su_dev;
1341 tg_pt_gp->tg_pt_gp_md_buf_len = ALUA_MD_BUF_LEN;
1342 atomic_set(&tg_pt_gp->tg_pt_gp_alua_access_state,
1343 ALUA_ACCESS_STATE_ACTIVE_OPTMIZED);
1345 * Enable both explict and implict ALUA support by default
1347 tg_pt_gp->tg_pt_gp_alua_access_type =
1348 TPGS_EXPLICT_ALUA | TPGS_IMPLICT_ALUA;
1350 * Set the default Active/NonOptimized Delay in milliseconds
1352 tg_pt_gp->tg_pt_gp_nonop_delay_msecs = ALUA_DEFAULT_NONOP_DELAY_MSECS;
1353 tg_pt_gp->tg_pt_gp_trans_delay_msecs = ALUA_DEFAULT_TRANS_DELAY_MSECS;
1356 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1357 tg_pt_gp->tg_pt_gp_id =
1358 su_dev->t10_alua.alua_tg_pt_gps_counter++;
1359 tg_pt_gp->tg_pt_gp_valid_id = 1;
1360 su_dev->t10_alua.alua_tg_pt_gps_count++;
1361 list_add_tail(&tg_pt_gp->tg_pt_gp_list,
1362 &su_dev->t10_alua.tg_pt_gps_list);
1363 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1369 int core_alua_set_tg_pt_gp_id(
1370 struct t10_alua_tg_pt_gp *tg_pt_gp,
1373 struct se_subsystem_dev *su_dev = tg_pt_gp->tg_pt_gp_su_dev;
1374 struct t10_alua_tg_pt_gp *tg_pt_gp_tmp;
1375 u16 tg_pt_gp_id_tmp;
1377 * The tg_pt_gp->tg_pt_gp_id may only be set once..
1379 if (tg_pt_gp->tg_pt_gp_valid_id) {
1380 pr_warn("ALUA TG PT Group already has a valid ID,"
1381 " ignoring request\n");
1385 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1386 if (su_dev->t10_alua.alua_tg_pt_gps_count == 0x0000ffff) {
1387 pr_err("Maximum ALUA alua_tg_pt_gps_count:"
1388 " 0x0000ffff reached\n");
1389 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1390 kmem_cache_free(t10_alua_tg_pt_gp_cache, tg_pt_gp);
1394 tg_pt_gp_id_tmp = (tg_pt_gp_id != 0) ? tg_pt_gp_id :
1395 su_dev->t10_alua.alua_tg_pt_gps_counter++;
1397 list_for_each_entry(tg_pt_gp_tmp, &su_dev->t10_alua.tg_pt_gps_list,
1399 if (tg_pt_gp_tmp->tg_pt_gp_id == tg_pt_gp_id_tmp) {
1403 pr_err("ALUA Target Port Group ID: %hu already"
1404 " exists, ignoring request\n", tg_pt_gp_id);
1405 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1410 tg_pt_gp->tg_pt_gp_id = tg_pt_gp_id_tmp;
1411 tg_pt_gp->tg_pt_gp_valid_id = 1;
1412 list_add_tail(&tg_pt_gp->tg_pt_gp_list,
1413 &su_dev->t10_alua.tg_pt_gps_list);
1414 su_dev->t10_alua.alua_tg_pt_gps_count++;
1415 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1420 struct t10_alua_tg_pt_gp_member *core_alua_allocate_tg_pt_gp_mem(
1421 struct se_port *port)
1423 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1425 tg_pt_gp_mem = kmem_cache_zalloc(t10_alua_tg_pt_gp_mem_cache,
1427 if (!tg_pt_gp_mem) {
1428 pr_err("Unable to allocate struct t10_alua_tg_pt_gp_member\n");
1429 return ERR_PTR(-ENOMEM);
1431 INIT_LIST_HEAD(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1432 spin_lock_init(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1433 atomic_set(&tg_pt_gp_mem->tg_pt_gp_mem_ref_cnt, 0);
1435 tg_pt_gp_mem->tg_pt = port;
1436 port->sep_alua_tg_pt_gp_mem = tg_pt_gp_mem;
1437 atomic_set(&port->sep_tg_pt_gp_active, 1);
1439 return tg_pt_gp_mem;
1442 void core_alua_free_tg_pt_gp(
1443 struct t10_alua_tg_pt_gp *tg_pt_gp)
1445 struct se_subsystem_dev *su_dev = tg_pt_gp->tg_pt_gp_su_dev;
1446 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem, *tg_pt_gp_mem_tmp;
1448 * Once we have reached this point, config_item_put() has already
1449 * been called from target_core_alua_drop_tg_pt_gp().
1451 * Here we remove *tg_pt_gp from the global list so that
1452 * no assications *OR* explict ALUA via SET_TARGET_PORT_GROUPS
1453 * can be made while we are releasing struct t10_alua_tg_pt_gp.
1455 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1456 list_del(&tg_pt_gp->tg_pt_gp_list);
1457 su_dev->t10_alua.alua_tg_pt_gps_counter--;
1458 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1460 * Allow a struct t10_alua_tg_pt_gp_member * referenced by
1461 * core_alua_get_tg_pt_gp_by_name() in
1462 * target_core_configfs.c:target_core_store_alua_tg_pt_gp()
1463 * to be released with core_alua_put_tg_pt_gp_from_name().
1465 while (atomic_read(&tg_pt_gp->tg_pt_gp_ref_cnt))
1468 * Release reference to struct t10_alua_tg_pt_gp from all associated
1471 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1472 list_for_each_entry_safe(tg_pt_gp_mem, tg_pt_gp_mem_tmp,
1473 &tg_pt_gp->tg_pt_gp_mem_list, tg_pt_gp_mem_list) {
1474 if (tg_pt_gp_mem->tg_pt_gp_assoc) {
1475 list_del(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1476 tg_pt_gp->tg_pt_gp_members--;
1477 tg_pt_gp_mem->tg_pt_gp_assoc = 0;
1479 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1481 * tg_pt_gp_mem is associated with a single
1482 * se_port->sep_alua_tg_pt_gp_mem, and is released via
1483 * core_alua_free_tg_pt_gp_mem().
1485 * If the passed tg_pt_gp does NOT match the default_tg_pt_gp,
1486 * assume we want to re-assocate a given tg_pt_gp_mem with
1489 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1490 if (tg_pt_gp != su_dev->t10_alua.default_tg_pt_gp) {
1491 __core_alua_attach_tg_pt_gp_mem(tg_pt_gp_mem,
1492 su_dev->t10_alua.default_tg_pt_gp);
1494 tg_pt_gp_mem->tg_pt_gp = NULL;
1495 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1497 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1499 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1501 kmem_cache_free(t10_alua_tg_pt_gp_cache, tg_pt_gp);
1504 void core_alua_free_tg_pt_gp_mem(struct se_port *port)
1506 struct se_subsystem_dev *su_dev = port->sep_lun->lun_se_dev->se_sub_dev;
1507 struct t10_alua *alua = &su_dev->t10_alua;
1508 struct t10_alua_tg_pt_gp *tg_pt_gp;
1509 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1511 if (alua->alua_type != SPC3_ALUA_EMULATED)
1514 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
1518 while (atomic_read(&tg_pt_gp_mem->tg_pt_gp_mem_ref_cnt))
1521 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1522 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1524 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1525 if (tg_pt_gp_mem->tg_pt_gp_assoc) {
1526 list_del(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1527 tg_pt_gp->tg_pt_gp_members--;
1528 tg_pt_gp_mem->tg_pt_gp_assoc = 0;
1530 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1531 tg_pt_gp_mem->tg_pt_gp = NULL;
1533 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1535 kmem_cache_free(t10_alua_tg_pt_gp_mem_cache, tg_pt_gp_mem);
1538 static struct t10_alua_tg_pt_gp *core_alua_get_tg_pt_gp_by_name(
1539 struct se_subsystem_dev *su_dev,
1542 struct t10_alua_tg_pt_gp *tg_pt_gp;
1543 struct config_item *ci;
1545 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1546 list_for_each_entry(tg_pt_gp, &su_dev->t10_alua.tg_pt_gps_list,
1548 if (!tg_pt_gp->tg_pt_gp_valid_id)
1550 ci = &tg_pt_gp->tg_pt_gp_group.cg_item;
1551 if (!strcmp(config_item_name(ci), name)) {
1552 atomic_inc(&tg_pt_gp->tg_pt_gp_ref_cnt);
1553 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1557 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1562 static void core_alua_put_tg_pt_gp_from_name(
1563 struct t10_alua_tg_pt_gp *tg_pt_gp)
1565 struct se_subsystem_dev *su_dev = tg_pt_gp->tg_pt_gp_su_dev;
1567 spin_lock(&su_dev->t10_alua.tg_pt_gps_lock);
1568 atomic_dec(&tg_pt_gp->tg_pt_gp_ref_cnt);
1569 spin_unlock(&su_dev->t10_alua.tg_pt_gps_lock);
1573 * Called with struct t10_alua_tg_pt_gp_member->tg_pt_gp_mem_lock held
1575 void __core_alua_attach_tg_pt_gp_mem(
1576 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
1577 struct t10_alua_tg_pt_gp *tg_pt_gp)
1579 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1580 tg_pt_gp_mem->tg_pt_gp = tg_pt_gp;
1581 tg_pt_gp_mem->tg_pt_gp_assoc = 1;
1582 list_add_tail(&tg_pt_gp_mem->tg_pt_gp_mem_list,
1583 &tg_pt_gp->tg_pt_gp_mem_list);
1584 tg_pt_gp->tg_pt_gp_members++;
1585 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1589 * Called with struct t10_alua_tg_pt_gp_member->tg_pt_gp_mem_lock held
1591 static void __core_alua_drop_tg_pt_gp_mem(
1592 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
1593 struct t10_alua_tg_pt_gp *tg_pt_gp)
1595 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1596 list_del(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1597 tg_pt_gp_mem->tg_pt_gp = NULL;
1598 tg_pt_gp_mem->tg_pt_gp_assoc = 0;
1599 tg_pt_gp->tg_pt_gp_members--;
1600 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1603 ssize_t core_alua_show_tg_pt_gp_info(struct se_port *port, char *page)
1605 struct se_subsystem_dev *su_dev = port->sep_lun->lun_se_dev->se_sub_dev;
1606 struct config_item *tg_pt_ci;
1607 struct t10_alua *alua = &su_dev->t10_alua;
1608 struct t10_alua_tg_pt_gp *tg_pt_gp;
1609 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1612 if (alua->alua_type != SPC3_ALUA_EMULATED)
1615 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
1619 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1620 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1622 tg_pt_ci = &tg_pt_gp->tg_pt_gp_group.cg_item;
1623 len += sprintf(page, "TG Port Alias: %s\nTG Port Group ID:"
1624 " %hu\nTG Port Primary Access State: %s\nTG Port "
1625 "Primary Access Status: %s\nTG Port Secondary Access"
1626 " State: %s\nTG Port Secondary Access Status: %s\n",
1627 config_item_name(tg_pt_ci), tg_pt_gp->tg_pt_gp_id,
1628 core_alua_dump_state(atomic_read(
1629 &tg_pt_gp->tg_pt_gp_alua_access_state)),
1630 core_alua_dump_status(
1631 tg_pt_gp->tg_pt_gp_alua_access_status),
1632 (atomic_read(&port->sep_tg_pt_secondary_offline)) ?
1634 core_alua_dump_status(port->sep_tg_pt_secondary_stat));
1636 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1641 ssize_t core_alua_store_tg_pt_gp_info(
1642 struct se_port *port,
1646 struct se_portal_group *tpg;
1648 struct se_subsystem_dev *su_dev = port->sep_lun->lun_se_dev->se_sub_dev;
1649 struct t10_alua_tg_pt_gp *tg_pt_gp = NULL, *tg_pt_gp_new = NULL;
1650 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1651 unsigned char buf[TG_PT_GROUP_NAME_BUF];
1654 tpg = port->sep_tpg;
1655 lun = port->sep_lun;
1657 if (su_dev->t10_alua.alua_type != SPC3_ALUA_EMULATED) {
1658 pr_warn("SPC3_ALUA_EMULATED not enabled for"
1659 " %s/tpgt_%hu/%s\n", tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1660 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1661 config_item_name(&lun->lun_group.cg_item));
1665 if (count > TG_PT_GROUP_NAME_BUF) {
1666 pr_err("ALUA Target Port Group alias too large!\n");
1669 memset(buf, 0, TG_PT_GROUP_NAME_BUF);
1670 memcpy(buf, page, count);
1672 * Any ALUA target port group alias besides "NULL" means we will be
1673 * making a new group association.
1675 if (strcmp(strstrip(buf), "NULL")) {
1677 * core_alua_get_tg_pt_gp_by_name() will increment reference to
1678 * struct t10_alua_tg_pt_gp. This reference is released with
1679 * core_alua_put_tg_pt_gp_from_name() below.
1681 tg_pt_gp_new = core_alua_get_tg_pt_gp_by_name(su_dev,
1686 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
1687 if (!tg_pt_gp_mem) {
1689 core_alua_put_tg_pt_gp_from_name(tg_pt_gp_new);
1690 pr_err("NULL struct se_port->sep_alua_tg_pt_gp_mem pointer\n");
1694 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1695 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1698 * Clearing an existing tg_pt_gp association, and replacing
1699 * with the default_tg_pt_gp.
1701 if (!tg_pt_gp_new) {
1702 pr_debug("Target_Core_ConfigFS: Moving"
1703 " %s/tpgt_%hu/%s from ALUA Target Port Group:"
1704 " alua/%s, ID: %hu back to"
1705 " default_tg_pt_gp\n",
1706 tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1707 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1708 config_item_name(&lun->lun_group.cg_item),
1710 &tg_pt_gp->tg_pt_gp_group.cg_item),
1711 tg_pt_gp->tg_pt_gp_id);
1713 __core_alua_drop_tg_pt_gp_mem(tg_pt_gp_mem, tg_pt_gp);
1714 __core_alua_attach_tg_pt_gp_mem(tg_pt_gp_mem,
1715 su_dev->t10_alua.default_tg_pt_gp);
1716 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1721 * Removing existing association of tg_pt_gp_mem with tg_pt_gp
1723 __core_alua_drop_tg_pt_gp_mem(tg_pt_gp_mem, tg_pt_gp);
1727 * Associate tg_pt_gp_mem with tg_pt_gp_new.
1729 __core_alua_attach_tg_pt_gp_mem(tg_pt_gp_mem, tg_pt_gp_new);
1730 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1731 pr_debug("Target_Core_ConfigFS: %s %s/tpgt_%hu/%s to ALUA"
1732 " Target Port Group: alua/%s, ID: %hu\n", (move) ?
1733 "Moving" : "Adding", tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1734 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1735 config_item_name(&lun->lun_group.cg_item),
1736 config_item_name(&tg_pt_gp_new->tg_pt_gp_group.cg_item),
1737 tg_pt_gp_new->tg_pt_gp_id);
1739 core_alua_put_tg_pt_gp_from_name(tg_pt_gp_new);
1743 ssize_t core_alua_show_access_type(
1744 struct t10_alua_tg_pt_gp *tg_pt_gp,
1747 if ((tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_EXPLICT_ALUA) &&
1748 (tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_IMPLICT_ALUA))
1749 return sprintf(page, "Implict and Explict\n");
1750 else if (tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_IMPLICT_ALUA)
1751 return sprintf(page, "Implict\n");
1752 else if (tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_EXPLICT_ALUA)
1753 return sprintf(page, "Explict\n");
1755 return sprintf(page, "None\n");
1758 ssize_t core_alua_store_access_type(
1759 struct t10_alua_tg_pt_gp *tg_pt_gp,
1766 ret = strict_strtoul(page, 0, &tmp);
1768 pr_err("Unable to extract alua_access_type\n");
1771 if ((tmp != 0) && (tmp != 1) && (tmp != 2) && (tmp != 3)) {
1772 pr_err("Illegal value for alua_access_type:"
1777 tg_pt_gp->tg_pt_gp_alua_access_type =
1778 TPGS_IMPLICT_ALUA | TPGS_EXPLICT_ALUA;
1780 tg_pt_gp->tg_pt_gp_alua_access_type = TPGS_EXPLICT_ALUA;
1782 tg_pt_gp->tg_pt_gp_alua_access_type = TPGS_IMPLICT_ALUA;
1784 tg_pt_gp->tg_pt_gp_alua_access_type = 0;
1789 ssize_t core_alua_show_nonop_delay_msecs(
1790 struct t10_alua_tg_pt_gp *tg_pt_gp,
1793 return sprintf(page, "%d\n", tg_pt_gp->tg_pt_gp_nonop_delay_msecs);
1796 ssize_t core_alua_store_nonop_delay_msecs(
1797 struct t10_alua_tg_pt_gp *tg_pt_gp,
1804 ret = strict_strtoul(page, 0, &tmp);
1806 pr_err("Unable to extract nonop_delay_msecs\n");
1809 if (tmp > ALUA_MAX_NONOP_DELAY_MSECS) {
1810 pr_err("Passed nonop_delay_msecs: %lu, exceeds"
1811 " ALUA_MAX_NONOP_DELAY_MSECS: %d\n", tmp,
1812 ALUA_MAX_NONOP_DELAY_MSECS);
1815 tg_pt_gp->tg_pt_gp_nonop_delay_msecs = (int)tmp;
1820 ssize_t core_alua_show_trans_delay_msecs(
1821 struct t10_alua_tg_pt_gp *tg_pt_gp,
1824 return sprintf(page, "%d\n", tg_pt_gp->tg_pt_gp_trans_delay_msecs);
1827 ssize_t core_alua_store_trans_delay_msecs(
1828 struct t10_alua_tg_pt_gp *tg_pt_gp,
1835 ret = strict_strtoul(page, 0, &tmp);
1837 pr_err("Unable to extract trans_delay_msecs\n");
1840 if (tmp > ALUA_MAX_TRANS_DELAY_MSECS) {
1841 pr_err("Passed trans_delay_msecs: %lu, exceeds"
1842 " ALUA_MAX_TRANS_DELAY_MSECS: %d\n", tmp,
1843 ALUA_MAX_TRANS_DELAY_MSECS);
1846 tg_pt_gp->tg_pt_gp_trans_delay_msecs = (int)tmp;
1851 ssize_t core_alua_show_preferred_bit(
1852 struct t10_alua_tg_pt_gp *tg_pt_gp,
1855 return sprintf(page, "%d\n", tg_pt_gp->tg_pt_gp_pref);
1858 ssize_t core_alua_store_preferred_bit(
1859 struct t10_alua_tg_pt_gp *tg_pt_gp,
1866 ret = strict_strtoul(page, 0, &tmp);
1868 pr_err("Unable to extract preferred ALUA value\n");
1871 if ((tmp != 0) && (tmp != 1)) {
1872 pr_err("Illegal value for preferred ALUA: %lu\n", tmp);
1875 tg_pt_gp->tg_pt_gp_pref = (int)tmp;
1880 ssize_t core_alua_show_offline_bit(struct se_lun *lun, char *page)
1885 return sprintf(page, "%d\n",
1886 atomic_read(&lun->lun_sep->sep_tg_pt_secondary_offline));
1889 ssize_t core_alua_store_offline_bit(
1894 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1901 ret = strict_strtoul(page, 0, &tmp);
1903 pr_err("Unable to extract alua_tg_pt_offline value\n");
1906 if ((tmp != 0) && (tmp != 1)) {
1907 pr_err("Illegal value for alua_tg_pt_offline: %lu\n",
1911 tg_pt_gp_mem = lun->lun_sep->sep_alua_tg_pt_gp_mem;
1912 if (!tg_pt_gp_mem) {
1913 pr_err("Unable to locate *tg_pt_gp_mem\n");
1917 ret = core_alua_set_tg_pt_secondary_state(tg_pt_gp_mem,
1918 lun->lun_sep, 0, (int)tmp);
1925 ssize_t core_alua_show_secondary_status(
1929 return sprintf(page, "%d\n", lun->lun_sep->sep_tg_pt_secondary_stat);
1932 ssize_t core_alua_store_secondary_status(
1940 ret = strict_strtoul(page, 0, &tmp);
1942 pr_err("Unable to extract alua_tg_pt_status\n");
1945 if ((tmp != ALUA_STATUS_NONE) &&
1946 (tmp != ALUA_STATUS_ALTERED_BY_EXPLICT_STPG) &&
1947 (tmp != ALUA_STATUS_ALTERED_BY_IMPLICT_ALUA)) {
1948 pr_err("Illegal value for alua_tg_pt_status: %lu\n",
1952 lun->lun_sep->sep_tg_pt_secondary_stat = (int)tmp;
1957 ssize_t core_alua_show_secondary_write_metadata(
1961 return sprintf(page, "%d\n",
1962 lun->lun_sep->sep_tg_pt_secondary_write_md);
1965 ssize_t core_alua_store_secondary_write_metadata(
1973 ret = strict_strtoul(page, 0, &tmp);
1975 pr_err("Unable to extract alua_tg_pt_write_md\n");
1978 if ((tmp != 0) && (tmp != 1)) {
1979 pr_err("Illegal value for alua_tg_pt_write_md:"
1983 lun->lun_sep->sep_tg_pt_secondary_write_md = (int)tmp;
1988 int core_setup_alua(struct se_device *dev, int force_pt)
1990 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
1991 struct t10_alua *alua = &su_dev->t10_alua;
1992 struct t10_alua_lu_gp_member *lu_gp_mem;
1994 * If this device is from Target_Core_Mod/pSCSI, use the ALUA logic
1995 * of the Underlying SCSI hardware. In Linux/SCSI terms, this can
1996 * cause a problem because libata and some SATA RAID HBAs appear
1997 * under Linux/SCSI, but emulate SCSI logic themselves.
1999 if (((dev->transport->transport_type == TRANSPORT_PLUGIN_PHBA_PDEV) &&
2000 !(dev->se_sub_dev->se_dev_attrib.emulate_alua)) || force_pt) {
2001 alua->alua_type = SPC_ALUA_PASSTHROUGH;
2002 alua->alua_state_check = &core_alua_state_check_nop;
2003 pr_debug("%s: Using SPC_ALUA_PASSTHROUGH, no ALUA"
2004 " emulation\n", dev->transport->name);
2008 * If SPC-3 or above is reported by real or emulated struct se_device,
2009 * use emulated ALUA.
2011 if (dev->transport->get_device_rev(dev) >= SCSI_3) {
2012 pr_debug("%s: Enabling ALUA Emulation for SPC-3"
2013 " device\n", dev->transport->name);
2015 * Associate this struct se_device with the default ALUA
2018 lu_gp_mem = core_alua_allocate_lu_gp_mem(dev);
2019 if (IS_ERR(lu_gp_mem))
2020 return PTR_ERR(lu_gp_mem);
2022 alua->alua_type = SPC3_ALUA_EMULATED;
2023 alua->alua_state_check = &core_alua_state_check;
2024 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
2025 __core_alua_attach_lu_gp_mem(lu_gp_mem,
2027 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
2029 pr_debug("%s: Adding to default ALUA LU Group:"
2030 " core/alua/lu_gps/default_lu_gp\n",
2031 dev->transport->name);
2033 alua->alua_type = SPC2_ALUA_DISABLED;
2034 alua->alua_state_check = &core_alua_state_check_nop;
2035 pr_debug("%s: Disabling ALUA Emulation for SPC-2"
2036 " device\n", dev->transport->name);