1 /*******************************************************************************
2 * Filename: target_core_alua.c
4 * This file contains SPC-3 compliant asymmetric logical unit assigntment (ALUA)
6 * (c) Copyright 2009-2013 Datera, Inc.
8 * Nicholas A. Bellinger <nab@kernel.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 ******************************************************************************/
26 #include <linux/slab.h>
27 #include <linux/spinlock.h>
28 #include <linux/configfs.h>
29 #include <linux/export.h>
30 #include <linux/file.h>
31 #include <scsi/scsi.h>
32 #include <scsi/scsi_cmnd.h>
33 #include <asm/unaligned.h>
35 #include <target/target_core_base.h>
36 #include <target/target_core_backend.h>
37 #include <target/target_core_fabric.h>
38 #include <target/target_core_configfs.h>
40 #include "target_core_internal.h"
41 #include "target_core_alua.h"
42 #include "target_core_ua.h"
44 static sense_reason_t core_alua_check_transition(int state, int valid,
46 static int core_alua_set_tg_pt_secondary_state(
47 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
48 struct se_port *port, int explicit, int offline);
50 static char *core_alua_dump_state(int state);
52 static u16 alua_lu_gps_counter;
53 static u32 alua_lu_gps_count;
55 static DEFINE_SPINLOCK(lu_gps_lock);
56 static LIST_HEAD(lu_gps_list);
58 struct t10_alua_lu_gp *default_lu_gp;
61 * REPORT_TARGET_PORT_GROUPS
63 * See spc4r17 section 6.27
66 target_emulate_report_target_port_groups(struct se_cmd *cmd)
68 struct se_device *dev = cmd->se_dev;
70 struct t10_alua_tg_pt_gp *tg_pt_gp;
71 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
74 int ext_hdr = (cmd->t_task_cdb[1] & 0x20);
77 * Skip over RESERVED area to first Target port group descriptor
78 * depending on the PARAMETER DATA FORMAT type..
85 if (cmd->data_length < off) {
86 pr_warn("REPORT TARGET PORT GROUPS allocation length %u too"
87 " small for %s header\n", cmd->data_length,
88 (ext_hdr) ? "extended" : "normal");
89 return TCM_INVALID_CDB_FIELD;
91 buf = transport_kmap_data_sg(cmd);
93 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
95 spin_lock(&dev->t10_alua.tg_pt_gps_lock);
96 list_for_each_entry(tg_pt_gp, &dev->t10_alua.tg_pt_gps_list,
99 * Check if the Target port group and Target port descriptor list
100 * based on tg_pt_gp_members count will fit into the response payload.
101 * Otherwise, bump rd_len to let the initiator know we have exceeded
102 * the allocation length and the response is truncated.
104 if ((off + 8 + (tg_pt_gp->tg_pt_gp_members * 4)) >
106 rd_len += 8 + (tg_pt_gp->tg_pt_gp_members * 4);
110 * PREF: Preferred target port bit, determine if this
111 * bit should be set for port group.
113 if (tg_pt_gp->tg_pt_gp_pref)
116 * Set the ASYMMETRIC ACCESS State
118 buf[off++] |= (atomic_read(
119 &tg_pt_gp->tg_pt_gp_alua_access_state) & 0xff);
121 * Set supported ASYMMETRIC ACCESS State bits
123 buf[off++] |= tg_pt_gp->tg_pt_gp_alua_supported_states;
127 buf[off++] = ((tg_pt_gp->tg_pt_gp_id >> 8) & 0xff);
128 buf[off++] = (tg_pt_gp->tg_pt_gp_id & 0xff);
130 off++; /* Skip over Reserved */
134 buf[off++] = (tg_pt_gp->tg_pt_gp_alua_access_status & 0xff);
136 * Vendor Specific field
142 buf[off++] = (tg_pt_gp->tg_pt_gp_members & 0xff);
145 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
146 list_for_each_entry(tg_pt_gp_mem, &tg_pt_gp->tg_pt_gp_mem_list,
148 port = tg_pt_gp_mem->tg_pt;
150 * Start Target Port descriptor format
152 * See spc4r17 section 6.2.7 Table 247
154 off += 2; /* Skip over Obsolete */
156 * Set RELATIVE TARGET PORT IDENTIFIER
158 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
159 buf[off++] = (port->sep_rtpi & 0xff);
162 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
164 spin_unlock(&dev->t10_alua.tg_pt_gps_lock);
166 * Set the RETURN DATA LENGTH set in the header of the DataIN Payload
168 put_unaligned_be32(rd_len, &buf[0]);
171 * Fill in the Extended header parameter data format if requested
176 * Set the implicit transition time (in seconds) for the application
177 * client to use as a base for it's transition timeout value.
179 * Use the current tg_pt_gp_mem -> tg_pt_gp membership from the LUN
180 * this CDB was received upon to determine this value individually
181 * for ALUA target port group.
183 port = cmd->se_lun->lun_sep;
184 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
186 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
187 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
189 buf[5] = tg_pt_gp->tg_pt_gp_implicit_trans_secs;
190 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
193 transport_kunmap_data_sg(cmd);
195 target_complete_cmd(cmd, GOOD);
200 * SET_TARGET_PORT_GROUPS for explicit ALUA operation.
202 * See spc4r17 section 6.35
205 target_emulate_set_target_port_groups(struct se_cmd *cmd)
207 struct se_device *dev = cmd->se_dev;
208 struct se_port *port, *l_port = cmd->se_lun->lun_sep;
209 struct se_node_acl *nacl = cmd->se_sess->se_node_acl;
210 struct t10_alua_tg_pt_gp *tg_pt_gp = NULL, *l_tg_pt_gp;
211 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem, *l_tg_pt_gp_mem;
214 sense_reason_t rc = TCM_NO_SENSE;
215 u32 len = 4; /* Skip over RESERVED area in header */
216 int alua_access_state, primary = 0, valid_states;
220 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
222 if (cmd->data_length < 4) {
223 pr_warn("SET TARGET PORT GROUPS parameter list length %u too"
224 " small\n", cmd->data_length);
225 return TCM_INVALID_PARAMETER_LIST;
228 buf = transport_kmap_data_sg(cmd);
230 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
233 * Determine if explicit ALUA via SET_TARGET_PORT_GROUPS is allowed
234 * for the local tg_pt_gp.
236 l_tg_pt_gp_mem = l_port->sep_alua_tg_pt_gp_mem;
237 if (!l_tg_pt_gp_mem) {
238 pr_err("Unable to access l_port->sep_alua_tg_pt_gp_mem\n");
239 rc = TCM_UNSUPPORTED_SCSI_OPCODE;
242 spin_lock(&l_tg_pt_gp_mem->tg_pt_gp_mem_lock);
243 l_tg_pt_gp = l_tg_pt_gp_mem->tg_pt_gp;
245 spin_unlock(&l_tg_pt_gp_mem->tg_pt_gp_mem_lock);
246 pr_err("Unable to access *l_tg_pt_gp_mem->tg_pt_gp\n");
247 rc = TCM_UNSUPPORTED_SCSI_OPCODE;
250 spin_unlock(&l_tg_pt_gp_mem->tg_pt_gp_mem_lock);
252 if (!(l_tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_EXPLICIT_ALUA)) {
253 pr_debug("Unable to process SET_TARGET_PORT_GROUPS"
254 " while TPGS_EXPLICIT_ALUA is disabled\n");
255 rc = TCM_UNSUPPORTED_SCSI_OPCODE;
258 valid_states = l_tg_pt_gp->tg_pt_gp_alua_supported_states;
260 ptr = &buf[4]; /* Skip over RESERVED area in header */
262 while (len < cmd->data_length) {
264 alua_access_state = (ptr[0] & 0x0f);
266 * Check the received ALUA access state, and determine if
267 * the state is a primary or secondary target port asymmetric
270 rc = core_alua_check_transition(alua_access_state,
271 valid_states, &primary);
274 * If the SET TARGET PORT GROUPS attempts to establish
275 * an invalid combination of target port asymmetric
276 * access states or attempts to establish an
277 * unsupported target port asymmetric access state,
278 * then the command shall be terminated with CHECK
279 * CONDITION status, with the sense key set to ILLEGAL
280 * REQUEST, and the additional sense code set to INVALID
281 * FIELD IN PARAMETER LIST.
287 * If the ASYMMETRIC ACCESS STATE field (see table 267)
288 * specifies a primary target port asymmetric access state,
289 * then the TARGET PORT GROUP OR TARGET PORT field specifies
290 * a primary target port group for which the primary target
291 * port asymmetric access state shall be changed. If the
292 * ASYMMETRIC ACCESS STATE field specifies a secondary target
293 * port asymmetric access state, then the TARGET PORT GROUP OR
294 * TARGET PORT field specifies the relative target port
295 * identifier (see 3.1.120) of the target port for which the
296 * secondary target port asymmetric access state shall be
300 tg_pt_id = get_unaligned_be16(ptr + 2);
302 * Locate the matching target port group ID from
303 * the global tg_pt_gp list
305 spin_lock(&dev->t10_alua.tg_pt_gps_lock);
306 list_for_each_entry(tg_pt_gp,
307 &dev->t10_alua.tg_pt_gps_list,
309 if (!tg_pt_gp->tg_pt_gp_valid_id)
312 if (tg_pt_id != tg_pt_gp->tg_pt_gp_id)
315 atomic_inc(&tg_pt_gp->tg_pt_gp_ref_cnt);
316 smp_mb__after_atomic_inc();
318 spin_unlock(&dev->t10_alua.tg_pt_gps_lock);
320 if (!core_alua_do_port_transition(tg_pt_gp,
322 alua_access_state, 1))
325 spin_lock(&dev->t10_alua.tg_pt_gps_lock);
326 atomic_dec(&tg_pt_gp->tg_pt_gp_ref_cnt);
327 smp_mb__after_atomic_dec();
330 spin_unlock(&dev->t10_alua.tg_pt_gps_lock);
333 * Extract the RELATIVE TARGET PORT IDENTIFIER to identify
334 * the Target Port in question for the the incoming
335 * SET_TARGET_PORT_GROUPS op.
337 rtpi = get_unaligned_be16(ptr + 2);
339 * Locate the matching relative target port identifier
340 * for the struct se_device storage object.
342 spin_lock(&dev->se_port_lock);
343 list_for_each_entry(port, &dev->dev_sep_list,
345 if (port->sep_rtpi != rtpi)
348 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
350 spin_unlock(&dev->se_port_lock);
352 if (!core_alua_set_tg_pt_secondary_state(
353 tg_pt_gp_mem, port, 1, 1))
356 spin_lock(&dev->se_port_lock);
359 spin_unlock(&dev->se_port_lock);
363 rc = TCM_INVALID_PARAMETER_LIST;
372 transport_kunmap_data_sg(cmd);
374 target_complete_cmd(cmd, GOOD);
378 static inline int core_alua_state_nonoptimized(
381 int nonop_delay_msecs,
385 * Set SCF_ALUA_NON_OPTIMIZED here, this value will be checked
386 * later to determine if processing of this cmd needs to be
387 * temporarily delayed for the Active/NonOptimized primary access state.
389 cmd->se_cmd_flags |= SCF_ALUA_NON_OPTIMIZED;
390 cmd->alua_nonop_delay = nonop_delay_msecs;
394 static inline int core_alua_state_standby(
400 * Allowed CDBs for ALUA_ACCESS_STATE_STANDBY as defined by
401 * spc4r17 section 5.9.2.4.4
410 case RECEIVE_DIAGNOSTIC:
411 case SEND_DIAGNOSTIC:
414 switch (cdb[1] & 0x1f) {
415 case MI_REPORT_TARGET_PGS:
418 *alua_ascq = ASCQ_04H_ALUA_TG_PT_STANDBY;
421 case MAINTENANCE_OUT:
423 case MO_SET_TARGET_PGS:
426 *alua_ascq = ASCQ_04H_ALUA_TG_PT_STANDBY;
430 case PERSISTENT_RESERVE_IN:
431 case PERSISTENT_RESERVE_OUT:
436 *alua_ascq = ASCQ_04H_ALUA_TG_PT_STANDBY;
443 static inline int core_alua_state_unavailable(
449 * Allowed CDBs for ALUA_ACCESS_STATE_UNAVAILABLE as defined by
450 * spc4r17 section 5.9.2.4.5
457 switch (cdb[1] & 0x1f) {
458 case MI_REPORT_TARGET_PGS:
461 *alua_ascq = ASCQ_04H_ALUA_TG_PT_UNAVAILABLE;
464 case MAINTENANCE_OUT:
466 case MO_SET_TARGET_PGS:
469 *alua_ascq = ASCQ_04H_ALUA_TG_PT_UNAVAILABLE;
477 *alua_ascq = ASCQ_04H_ALUA_TG_PT_UNAVAILABLE;
484 static inline int core_alua_state_transition(
490 * Allowed CDBs for ALUA_ACCESS_STATE_TRANSITION as defined by
491 * spc4r17 section 5.9.2.5
498 switch (cdb[1] & 0x1f) {
499 case MI_REPORT_TARGET_PGS:
502 *alua_ascq = ASCQ_04H_ALUA_STATE_TRANSITION;
510 *alua_ascq = ASCQ_04H_ALUA_STATE_TRANSITION;
518 * return 1: Is used to signal LUN not accessible, and check condition/not ready
519 * return 0: Used to signal success
520 * return -1: Used to signal failure, and invalid cdb field
523 target_alua_state_check(struct se_cmd *cmd)
525 struct se_device *dev = cmd->se_dev;
526 unsigned char *cdb = cmd->t_task_cdb;
527 struct se_lun *lun = cmd->se_lun;
528 struct se_port *port = lun->lun_sep;
529 struct t10_alua_tg_pt_gp *tg_pt_gp;
530 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
531 int out_alua_state, nonop_delay_msecs;
535 if (dev->se_hba->hba_flags & HBA_FLAGS_INTERNAL_USE)
537 if (dev->transport->transport_type == TRANSPORT_PLUGIN_PHBA_PDEV)
543 * First, check for a struct se_port specific secondary ALUA target port
544 * access state: OFFLINE
546 if (atomic_read(&port->sep_tg_pt_secondary_offline)) {
547 pr_debug("ALUA: Got secondary offline status for local"
549 alua_ascq = ASCQ_04H_ALUA_OFFLINE;
554 * Second, obtain the struct t10_alua_tg_pt_gp_member pointer to the
555 * ALUA target port group, to obtain current ALUA access state.
556 * Otherwise look for the underlying struct se_device association with
557 * a ALUA logical unit group.
559 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
563 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
564 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
565 out_alua_state = atomic_read(&tg_pt_gp->tg_pt_gp_alua_access_state);
566 nonop_delay_msecs = tg_pt_gp->tg_pt_gp_nonop_delay_msecs;
567 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
569 * Process ALUA_ACCESS_STATE_ACTIVE_OPTIMIZED in a separate conditional
570 * statement so the compiler knows explicitly to check this case first.
571 * For the Optimized ALUA access state case, we want to process the
572 * incoming fabric cmd ASAP..
574 if (out_alua_state == ALUA_ACCESS_STATE_ACTIVE_OPTIMIZED)
577 switch (out_alua_state) {
578 case ALUA_ACCESS_STATE_ACTIVE_NON_OPTIMIZED:
579 ret = core_alua_state_nonoptimized(cmd, cdb,
580 nonop_delay_msecs, &alua_ascq);
582 case ALUA_ACCESS_STATE_STANDBY:
583 ret = core_alua_state_standby(cmd, cdb, &alua_ascq);
585 case ALUA_ACCESS_STATE_UNAVAILABLE:
586 ret = core_alua_state_unavailable(cmd, cdb, &alua_ascq);
588 case ALUA_ACCESS_STATE_TRANSITION:
589 ret = core_alua_state_transition(cmd, cdb, &alua_ascq);
592 * OFFLINE is a secondary ALUA target port group access state, that is
593 * handled above with struct se_port->sep_tg_pt_secondary_offline=1
595 case ALUA_ACCESS_STATE_OFFLINE:
597 pr_err("Unknown ALUA access state: 0x%02x\n",
599 return TCM_INVALID_CDB_FIELD;
605 * Set SCSI additional sense code (ASC) to 'LUN Not Accessible';
606 * The ALUA additional sense code qualifier (ASCQ) is determined
607 * by the ALUA primary or secondary access state..
609 pr_debug("[%s]: ALUA TG Port not available, "
610 "SenseKey: NOT_READY, ASC/ASCQ: "
612 cmd->se_tfo->get_fabric_name(), alua_ascq);
614 cmd->scsi_asc = 0x04;
615 cmd->scsi_ascq = alua_ascq;
616 return TCM_CHECK_CONDITION_NOT_READY;
623 * Check implicit and explicit ALUA state change request.
625 static sense_reason_t
626 core_alua_check_transition(int state, int valid, int *primary)
629 * OPTIMIZED, NON-OPTIMIZED, STANDBY and UNAVAILABLE are
630 * defined as primary target port asymmetric access states.
633 case ALUA_ACCESS_STATE_ACTIVE_OPTIMIZED:
634 if (!(valid & ALUA_AO_SUP))
638 case ALUA_ACCESS_STATE_ACTIVE_NON_OPTIMIZED:
639 if (!(valid & ALUA_AN_SUP))
643 case ALUA_ACCESS_STATE_STANDBY:
644 if (!(valid & ALUA_S_SUP))
648 case ALUA_ACCESS_STATE_UNAVAILABLE:
649 if (!(valid & ALUA_U_SUP))
653 case ALUA_ACCESS_STATE_OFFLINE:
655 * OFFLINE state is defined as a secondary target port
656 * asymmetric access state.
658 if (!(valid & ALUA_O_SUP))
662 case ALUA_ACCESS_STATE_TRANSITION:
664 * Transitioning is set internally, and
665 * cannot be selected manually.
669 pr_err("Unknown ALUA access state: 0x%02x\n", state);
670 return TCM_INVALID_PARAMETER_LIST;
676 pr_err("ALUA access state %s not supported",
677 core_alua_dump_state(state));
678 return TCM_INVALID_PARAMETER_LIST;
681 static char *core_alua_dump_state(int state)
684 case ALUA_ACCESS_STATE_ACTIVE_OPTIMIZED:
685 return "Active/Optimized";
686 case ALUA_ACCESS_STATE_ACTIVE_NON_OPTIMIZED:
687 return "Active/NonOptimized";
688 case ALUA_ACCESS_STATE_STANDBY:
690 case ALUA_ACCESS_STATE_UNAVAILABLE:
691 return "Unavailable";
692 case ALUA_ACCESS_STATE_OFFLINE:
694 case ALUA_ACCESS_STATE_TRANSITION:
695 return "Transitioning";
703 char *core_alua_dump_status(int status)
706 case ALUA_STATUS_NONE:
708 case ALUA_STATUS_ALTERED_BY_EXPLICIT_STPG:
709 return "Altered by Explicit STPG";
710 case ALUA_STATUS_ALTERED_BY_IMPLICIT_ALUA:
711 return "Altered by Implicit ALUA";
720 * Used by fabric modules to determine when we need to delay processing
721 * for the Active/NonOptimized paths..
723 int core_alua_check_nonop_delay(
726 if (!(cmd->se_cmd_flags & SCF_ALUA_NON_OPTIMIZED))
731 * The ALUA Active/NonOptimized access state delay can be disabled
732 * in via configfs with a value of zero
734 if (!cmd->alua_nonop_delay)
737 * struct se_cmd->alua_nonop_delay gets set by a target port group
738 * defined interval in core_alua_state_nonoptimized()
740 msleep_interruptible(cmd->alua_nonop_delay);
743 EXPORT_SYMBOL(core_alua_check_nonop_delay);
746 * Called with tg_pt_gp->tg_pt_gp_md_mutex or tg_pt_gp_mem->sep_tg_pt_md_mutex
749 static int core_alua_write_tpg_metadata(
751 unsigned char *md_buf,
754 struct file *file = filp_open(path, O_RDWR | O_CREAT | O_TRUNC, 0600);
758 pr_err("filp_open(%s) for ALUA metadata failed\n", path);
761 ret = kernel_write(file, md_buf, md_buf_len, 0);
763 pr_err("Error writing ALUA metadata file: %s\n", path);
765 return (ret < 0) ? -EIO : 0;
769 * Called with tg_pt_gp->tg_pt_gp_md_mutex held
771 static int core_alua_update_tpg_primary_metadata(
772 struct t10_alua_tg_pt_gp *tg_pt_gp,
775 unsigned char *md_buf;
776 struct t10_wwn *wwn = &tg_pt_gp->tg_pt_gp_dev->t10_wwn;
777 char path[ALUA_METADATA_PATH_LEN];
780 md_buf = kzalloc(ALUA_MD_BUF_LEN, GFP_KERNEL);
782 pr_err("Unable to allocate buf for ALUA metadata\n");
786 memset(path, 0, ALUA_METADATA_PATH_LEN);
788 len = snprintf(md_buf, ALUA_MD_BUF_LEN,
790 "alua_access_state=0x%02x\n"
791 "alua_access_status=0x%02x\n",
792 tg_pt_gp->tg_pt_gp_id, primary_state,
793 tg_pt_gp->tg_pt_gp_alua_access_status);
795 snprintf(path, ALUA_METADATA_PATH_LEN,
796 "/var/target/alua/tpgs_%s/%s", &wwn->unit_serial[0],
797 config_item_name(&tg_pt_gp->tg_pt_gp_group.cg_item));
799 rc = core_alua_write_tpg_metadata(path, md_buf, len);
804 static int core_alua_do_transition_tg_pt(
805 struct t10_alua_tg_pt_gp *tg_pt_gp,
806 struct se_port *l_port,
807 struct se_node_acl *nacl,
811 struct se_dev_entry *se_deve;
812 struct se_lun_acl *lacl;
813 struct se_port *port;
814 struct t10_alua_tg_pt_gp_member *mem;
817 * Save the old primary ALUA access state, and set the current state
818 * to ALUA_ACCESS_STATE_TRANSITION.
820 old_state = atomic_read(&tg_pt_gp->tg_pt_gp_alua_access_state);
821 atomic_set(&tg_pt_gp->tg_pt_gp_alua_access_state,
822 ALUA_ACCESS_STATE_TRANSITION);
823 tg_pt_gp->tg_pt_gp_alua_access_status = (explicit) ?
824 ALUA_STATUS_ALTERED_BY_EXPLICIT_STPG :
825 ALUA_STATUS_ALTERED_BY_IMPLICIT_ALUA;
827 * Check for the optional ALUA primary state transition delay
829 if (tg_pt_gp->tg_pt_gp_trans_delay_msecs != 0)
830 msleep_interruptible(tg_pt_gp->tg_pt_gp_trans_delay_msecs);
832 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
833 list_for_each_entry(mem, &tg_pt_gp->tg_pt_gp_mem_list,
837 * After an implicit target port asymmetric access state
838 * change, a device server shall establish a unit attention
839 * condition for the initiator port associated with every I_T
840 * nexus with the additional sense code set to ASYMMETRIC
841 * ACCESS STATE CHANGED.
843 * After an explicit target port asymmetric access state
844 * change, a device server shall establish a unit attention
845 * condition with the additional sense code set to ASYMMETRIC
846 * ACCESS STATE CHANGED for the initiator port associated with
847 * every I_T nexus other than the I_T nexus on which the SET
848 * TARGET PORT GROUPS command
850 atomic_inc(&mem->tg_pt_gp_mem_ref_cnt);
851 smp_mb__after_atomic_inc();
852 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
854 spin_lock_bh(&port->sep_alua_lock);
855 list_for_each_entry(se_deve, &port->sep_alua_list,
857 lacl = se_deve->se_lun_acl;
859 * se_deve->se_lun_acl pointer may be NULL for a
860 * entry created without explicit Node+MappedLUN ACLs
866 (nacl != NULL) && (nacl == lacl->se_lun_nacl) &&
867 (l_port != NULL) && (l_port == port))
870 core_scsi3_ua_allocate(lacl->se_lun_nacl,
871 se_deve->mapped_lun, 0x2A,
872 ASCQ_2AH_ASYMMETRIC_ACCESS_STATE_CHANGED);
874 spin_unlock_bh(&port->sep_alua_lock);
876 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
877 atomic_dec(&mem->tg_pt_gp_mem_ref_cnt);
878 smp_mb__after_atomic_dec();
880 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
882 * Update the ALUA metadata buf that has been allocated in
883 * core_alua_do_port_transition(), this metadata will be written
886 * Note that there is the case where we do not want to update the
887 * metadata when the saved metadata is being parsed in userspace
888 * when setting the existing port access state and access status.
890 * Also note that the failure to write out the ALUA metadata to
891 * struct file does NOT affect the actual ALUA transition.
893 if (tg_pt_gp->tg_pt_gp_write_metadata) {
894 mutex_lock(&tg_pt_gp->tg_pt_gp_md_mutex);
895 core_alua_update_tpg_primary_metadata(tg_pt_gp, new_state);
896 mutex_unlock(&tg_pt_gp->tg_pt_gp_md_mutex);
899 * Set the current primary ALUA access state to the requested new state
901 atomic_set(&tg_pt_gp->tg_pt_gp_alua_access_state, new_state);
903 pr_debug("Successful %s ALUA transition TG PT Group: %s ID: %hu"
904 " from primary access state %s to %s\n", (explicit) ? "explicit" :
905 "implicit", config_item_name(&tg_pt_gp->tg_pt_gp_group.cg_item),
906 tg_pt_gp->tg_pt_gp_id, core_alua_dump_state(old_state),
907 core_alua_dump_state(new_state));
912 int core_alua_do_port_transition(
913 struct t10_alua_tg_pt_gp *l_tg_pt_gp,
914 struct se_device *l_dev,
915 struct se_port *l_port,
916 struct se_node_acl *l_nacl,
920 struct se_device *dev;
921 struct se_port *port;
922 struct se_node_acl *nacl;
923 struct t10_alua_lu_gp *lu_gp;
924 struct t10_alua_lu_gp_member *lu_gp_mem, *local_lu_gp_mem;
925 struct t10_alua_tg_pt_gp *tg_pt_gp;
926 int primary, valid_states;
928 valid_states = l_tg_pt_gp->tg_pt_gp_alua_supported_states;
929 if (core_alua_check_transition(new_state, valid_states, &primary) != 0)
932 local_lu_gp_mem = l_dev->dev_alua_lu_gp_mem;
933 spin_lock(&local_lu_gp_mem->lu_gp_mem_lock);
934 lu_gp = local_lu_gp_mem->lu_gp;
935 atomic_inc(&lu_gp->lu_gp_ref_cnt);
936 smp_mb__after_atomic_inc();
937 spin_unlock(&local_lu_gp_mem->lu_gp_mem_lock);
939 * For storage objects that are members of the 'default_lu_gp',
940 * we only do transition on the passed *l_tp_pt_gp, and not
941 * on all of the matching target port groups IDs in default_lu_gp.
943 if (!lu_gp->lu_gp_id) {
945 * core_alua_do_transition_tg_pt() will always return
948 core_alua_do_transition_tg_pt(l_tg_pt_gp, l_port, l_nacl,
949 new_state, explicit);
950 atomic_dec(&lu_gp->lu_gp_ref_cnt);
951 smp_mb__after_atomic_dec();
955 * For all other LU groups aside from 'default_lu_gp', walk all of
956 * the associated storage objects looking for a matching target port
957 * group ID from the local target port group.
959 spin_lock(&lu_gp->lu_gp_lock);
960 list_for_each_entry(lu_gp_mem, &lu_gp->lu_gp_mem_list,
963 dev = lu_gp_mem->lu_gp_mem_dev;
964 atomic_inc(&lu_gp_mem->lu_gp_mem_ref_cnt);
965 smp_mb__after_atomic_inc();
966 spin_unlock(&lu_gp->lu_gp_lock);
968 spin_lock(&dev->t10_alua.tg_pt_gps_lock);
969 list_for_each_entry(tg_pt_gp,
970 &dev->t10_alua.tg_pt_gps_list,
973 if (!tg_pt_gp->tg_pt_gp_valid_id)
976 * If the target behavior port asymmetric access state
977 * is changed for any target port group accessible via
978 * a logical unit within a LU group, the target port
979 * behavior group asymmetric access states for the same
980 * target port group accessible via other logical units
981 * in that LU group will also change.
983 if (l_tg_pt_gp->tg_pt_gp_id != tg_pt_gp->tg_pt_gp_id)
986 if (l_tg_pt_gp == tg_pt_gp) {
993 atomic_inc(&tg_pt_gp->tg_pt_gp_ref_cnt);
994 smp_mb__after_atomic_inc();
995 spin_unlock(&dev->t10_alua.tg_pt_gps_lock);
997 * core_alua_do_transition_tg_pt() will always return
1000 core_alua_do_transition_tg_pt(tg_pt_gp, port,
1001 nacl, new_state, explicit);
1003 spin_lock(&dev->t10_alua.tg_pt_gps_lock);
1004 atomic_dec(&tg_pt_gp->tg_pt_gp_ref_cnt);
1005 smp_mb__after_atomic_dec();
1007 spin_unlock(&dev->t10_alua.tg_pt_gps_lock);
1009 spin_lock(&lu_gp->lu_gp_lock);
1010 atomic_dec(&lu_gp_mem->lu_gp_mem_ref_cnt);
1011 smp_mb__after_atomic_dec();
1013 spin_unlock(&lu_gp->lu_gp_lock);
1015 pr_debug("Successfully processed LU Group: %s all ALUA TG PT"
1016 " Group IDs: %hu %s transition to primary state: %s\n",
1017 config_item_name(&lu_gp->lu_gp_group.cg_item),
1018 l_tg_pt_gp->tg_pt_gp_id, (explicit) ? "explicit" : "implicit",
1019 core_alua_dump_state(new_state));
1021 atomic_dec(&lu_gp->lu_gp_ref_cnt);
1022 smp_mb__after_atomic_dec();
1027 * Called with tg_pt_gp_mem->sep_tg_pt_md_mutex held
1029 static int core_alua_update_tpg_secondary_metadata(
1030 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
1031 struct se_port *port)
1033 unsigned char *md_buf;
1034 struct se_portal_group *se_tpg = port->sep_tpg;
1035 char path[ALUA_METADATA_PATH_LEN], wwn[ALUA_SECONDARY_METADATA_WWN_LEN];
1038 md_buf = kzalloc(ALUA_MD_BUF_LEN, GFP_KERNEL);
1040 pr_err("Unable to allocate buf for ALUA metadata\n");
1044 memset(path, 0, ALUA_METADATA_PATH_LEN);
1045 memset(wwn, 0, ALUA_SECONDARY_METADATA_WWN_LEN);
1047 len = snprintf(wwn, ALUA_SECONDARY_METADATA_WWN_LEN, "%s",
1048 se_tpg->se_tpg_tfo->tpg_get_wwn(se_tpg));
1050 if (se_tpg->se_tpg_tfo->tpg_get_tag != NULL)
1051 snprintf(wwn+len, ALUA_SECONDARY_METADATA_WWN_LEN-len, "+%hu",
1052 se_tpg->se_tpg_tfo->tpg_get_tag(se_tpg));
1054 len = snprintf(md_buf, ALUA_MD_BUF_LEN, "alua_tg_pt_offline=%d\n"
1055 "alua_tg_pt_status=0x%02x\n",
1056 atomic_read(&port->sep_tg_pt_secondary_offline),
1057 port->sep_tg_pt_secondary_stat);
1059 snprintf(path, ALUA_METADATA_PATH_LEN, "/var/target/alua/%s/%s/lun_%u",
1060 se_tpg->se_tpg_tfo->get_fabric_name(), wwn,
1061 port->sep_lun->unpacked_lun);
1063 rc = core_alua_write_tpg_metadata(path, md_buf, len);
1069 static int core_alua_set_tg_pt_secondary_state(
1070 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
1071 struct se_port *port,
1075 struct t10_alua_tg_pt_gp *tg_pt_gp;
1076 int trans_delay_msecs;
1078 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1079 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1081 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1082 pr_err("Unable to complete secondary state"
1086 trans_delay_msecs = tg_pt_gp->tg_pt_gp_trans_delay_msecs;
1088 * Set the secondary ALUA target port access state to OFFLINE
1089 * or release the previously secondary state for struct se_port
1092 atomic_set(&port->sep_tg_pt_secondary_offline, 1);
1094 atomic_set(&port->sep_tg_pt_secondary_offline, 0);
1096 port->sep_tg_pt_secondary_stat = (explicit) ?
1097 ALUA_STATUS_ALTERED_BY_EXPLICIT_STPG :
1098 ALUA_STATUS_ALTERED_BY_IMPLICIT_ALUA;
1100 pr_debug("Successful %s ALUA transition TG PT Group: %s ID: %hu"
1101 " to secondary access state: %s\n", (explicit) ? "explicit" :
1102 "implicit", config_item_name(&tg_pt_gp->tg_pt_gp_group.cg_item),
1103 tg_pt_gp->tg_pt_gp_id, (offline) ? "OFFLINE" : "ONLINE");
1105 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1107 * Do the optional transition delay after we set the secondary
1108 * ALUA access state.
1110 if (trans_delay_msecs != 0)
1111 msleep_interruptible(trans_delay_msecs);
1113 * See if we need to update the ALUA fabric port metadata for
1114 * secondary state and status
1116 if (port->sep_tg_pt_secondary_write_md) {
1117 mutex_lock(&port->sep_tg_pt_md_mutex);
1118 core_alua_update_tpg_secondary_metadata(tg_pt_gp_mem, port);
1119 mutex_unlock(&port->sep_tg_pt_md_mutex);
1125 struct t10_alua_lu_gp *
1126 core_alua_allocate_lu_gp(const char *name, int def_group)
1128 struct t10_alua_lu_gp *lu_gp;
1130 lu_gp = kmem_cache_zalloc(t10_alua_lu_gp_cache, GFP_KERNEL);
1132 pr_err("Unable to allocate struct t10_alua_lu_gp\n");
1133 return ERR_PTR(-ENOMEM);
1135 INIT_LIST_HEAD(&lu_gp->lu_gp_node);
1136 INIT_LIST_HEAD(&lu_gp->lu_gp_mem_list);
1137 spin_lock_init(&lu_gp->lu_gp_lock);
1138 atomic_set(&lu_gp->lu_gp_ref_cnt, 0);
1141 lu_gp->lu_gp_id = alua_lu_gps_counter++;
1142 lu_gp->lu_gp_valid_id = 1;
1143 alua_lu_gps_count++;
1149 int core_alua_set_lu_gp_id(struct t10_alua_lu_gp *lu_gp, u16 lu_gp_id)
1151 struct t10_alua_lu_gp *lu_gp_tmp;
1154 * The lu_gp->lu_gp_id may only be set once..
1156 if (lu_gp->lu_gp_valid_id) {
1157 pr_warn("ALUA LU Group already has a valid ID,"
1158 " ignoring request\n");
1162 spin_lock(&lu_gps_lock);
1163 if (alua_lu_gps_count == 0x0000ffff) {
1164 pr_err("Maximum ALUA alua_lu_gps_count:"
1165 " 0x0000ffff reached\n");
1166 spin_unlock(&lu_gps_lock);
1167 kmem_cache_free(t10_alua_lu_gp_cache, lu_gp);
1171 lu_gp_id_tmp = (lu_gp_id != 0) ? lu_gp_id :
1172 alua_lu_gps_counter++;
1174 list_for_each_entry(lu_gp_tmp, &lu_gps_list, lu_gp_node) {
1175 if (lu_gp_tmp->lu_gp_id == lu_gp_id_tmp) {
1179 pr_warn("ALUA Logical Unit Group ID: %hu"
1180 " already exists, ignoring request\n",
1182 spin_unlock(&lu_gps_lock);
1187 lu_gp->lu_gp_id = lu_gp_id_tmp;
1188 lu_gp->lu_gp_valid_id = 1;
1189 list_add_tail(&lu_gp->lu_gp_node, &lu_gps_list);
1190 alua_lu_gps_count++;
1191 spin_unlock(&lu_gps_lock);
1196 static struct t10_alua_lu_gp_member *
1197 core_alua_allocate_lu_gp_mem(struct se_device *dev)
1199 struct t10_alua_lu_gp_member *lu_gp_mem;
1201 lu_gp_mem = kmem_cache_zalloc(t10_alua_lu_gp_mem_cache, GFP_KERNEL);
1203 pr_err("Unable to allocate struct t10_alua_lu_gp_member\n");
1204 return ERR_PTR(-ENOMEM);
1206 INIT_LIST_HEAD(&lu_gp_mem->lu_gp_mem_list);
1207 spin_lock_init(&lu_gp_mem->lu_gp_mem_lock);
1208 atomic_set(&lu_gp_mem->lu_gp_mem_ref_cnt, 0);
1210 lu_gp_mem->lu_gp_mem_dev = dev;
1211 dev->dev_alua_lu_gp_mem = lu_gp_mem;
1216 void core_alua_free_lu_gp(struct t10_alua_lu_gp *lu_gp)
1218 struct t10_alua_lu_gp_member *lu_gp_mem, *lu_gp_mem_tmp;
1220 * Once we have reached this point, config_item_put() has
1221 * already been called from target_core_alua_drop_lu_gp().
1223 * Here, we remove the *lu_gp from the global list so that
1224 * no associations can be made while we are releasing
1225 * struct t10_alua_lu_gp.
1227 spin_lock(&lu_gps_lock);
1228 list_del(&lu_gp->lu_gp_node);
1229 alua_lu_gps_count--;
1230 spin_unlock(&lu_gps_lock);
1232 * Allow struct t10_alua_lu_gp * referenced by core_alua_get_lu_gp_by_name()
1233 * in target_core_configfs.c:target_core_store_alua_lu_gp() to be
1234 * released with core_alua_put_lu_gp_from_name()
1236 while (atomic_read(&lu_gp->lu_gp_ref_cnt))
1239 * Release reference to struct t10_alua_lu_gp * from all associated
1242 spin_lock(&lu_gp->lu_gp_lock);
1243 list_for_each_entry_safe(lu_gp_mem, lu_gp_mem_tmp,
1244 &lu_gp->lu_gp_mem_list, lu_gp_mem_list) {
1245 if (lu_gp_mem->lu_gp_assoc) {
1246 list_del(&lu_gp_mem->lu_gp_mem_list);
1247 lu_gp->lu_gp_members--;
1248 lu_gp_mem->lu_gp_assoc = 0;
1250 spin_unlock(&lu_gp->lu_gp_lock);
1253 * lu_gp_mem is associated with a single
1254 * struct se_device->dev_alua_lu_gp_mem, and is released when
1255 * struct se_device is released via core_alua_free_lu_gp_mem().
1257 * If the passed lu_gp does NOT match the default_lu_gp, assume
1258 * we want to re-associate a given lu_gp_mem with default_lu_gp.
1260 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
1261 if (lu_gp != default_lu_gp)
1262 __core_alua_attach_lu_gp_mem(lu_gp_mem,
1265 lu_gp_mem->lu_gp = NULL;
1266 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
1268 spin_lock(&lu_gp->lu_gp_lock);
1270 spin_unlock(&lu_gp->lu_gp_lock);
1272 kmem_cache_free(t10_alua_lu_gp_cache, lu_gp);
1275 void core_alua_free_lu_gp_mem(struct se_device *dev)
1277 struct t10_alua_lu_gp *lu_gp;
1278 struct t10_alua_lu_gp_member *lu_gp_mem;
1280 lu_gp_mem = dev->dev_alua_lu_gp_mem;
1284 while (atomic_read(&lu_gp_mem->lu_gp_mem_ref_cnt))
1287 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
1288 lu_gp = lu_gp_mem->lu_gp;
1290 spin_lock(&lu_gp->lu_gp_lock);
1291 if (lu_gp_mem->lu_gp_assoc) {
1292 list_del(&lu_gp_mem->lu_gp_mem_list);
1293 lu_gp->lu_gp_members--;
1294 lu_gp_mem->lu_gp_assoc = 0;
1296 spin_unlock(&lu_gp->lu_gp_lock);
1297 lu_gp_mem->lu_gp = NULL;
1299 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
1301 kmem_cache_free(t10_alua_lu_gp_mem_cache, lu_gp_mem);
1304 struct t10_alua_lu_gp *core_alua_get_lu_gp_by_name(const char *name)
1306 struct t10_alua_lu_gp *lu_gp;
1307 struct config_item *ci;
1309 spin_lock(&lu_gps_lock);
1310 list_for_each_entry(lu_gp, &lu_gps_list, lu_gp_node) {
1311 if (!lu_gp->lu_gp_valid_id)
1313 ci = &lu_gp->lu_gp_group.cg_item;
1314 if (!strcmp(config_item_name(ci), name)) {
1315 atomic_inc(&lu_gp->lu_gp_ref_cnt);
1316 spin_unlock(&lu_gps_lock);
1320 spin_unlock(&lu_gps_lock);
1325 void core_alua_put_lu_gp_from_name(struct t10_alua_lu_gp *lu_gp)
1327 spin_lock(&lu_gps_lock);
1328 atomic_dec(&lu_gp->lu_gp_ref_cnt);
1329 spin_unlock(&lu_gps_lock);
1333 * Called with struct t10_alua_lu_gp_member->lu_gp_mem_lock
1335 void __core_alua_attach_lu_gp_mem(
1336 struct t10_alua_lu_gp_member *lu_gp_mem,
1337 struct t10_alua_lu_gp *lu_gp)
1339 spin_lock(&lu_gp->lu_gp_lock);
1340 lu_gp_mem->lu_gp = lu_gp;
1341 lu_gp_mem->lu_gp_assoc = 1;
1342 list_add_tail(&lu_gp_mem->lu_gp_mem_list, &lu_gp->lu_gp_mem_list);
1343 lu_gp->lu_gp_members++;
1344 spin_unlock(&lu_gp->lu_gp_lock);
1348 * Called with struct t10_alua_lu_gp_member->lu_gp_mem_lock
1350 void __core_alua_drop_lu_gp_mem(
1351 struct t10_alua_lu_gp_member *lu_gp_mem,
1352 struct t10_alua_lu_gp *lu_gp)
1354 spin_lock(&lu_gp->lu_gp_lock);
1355 list_del(&lu_gp_mem->lu_gp_mem_list);
1356 lu_gp_mem->lu_gp = NULL;
1357 lu_gp_mem->lu_gp_assoc = 0;
1358 lu_gp->lu_gp_members--;
1359 spin_unlock(&lu_gp->lu_gp_lock);
1362 struct t10_alua_tg_pt_gp *core_alua_allocate_tg_pt_gp(struct se_device *dev,
1363 const char *name, int def_group)
1365 struct t10_alua_tg_pt_gp *tg_pt_gp;
1367 tg_pt_gp = kmem_cache_zalloc(t10_alua_tg_pt_gp_cache, GFP_KERNEL);
1369 pr_err("Unable to allocate struct t10_alua_tg_pt_gp\n");
1372 INIT_LIST_HEAD(&tg_pt_gp->tg_pt_gp_list);
1373 INIT_LIST_HEAD(&tg_pt_gp->tg_pt_gp_mem_list);
1374 mutex_init(&tg_pt_gp->tg_pt_gp_md_mutex);
1375 spin_lock_init(&tg_pt_gp->tg_pt_gp_lock);
1376 atomic_set(&tg_pt_gp->tg_pt_gp_ref_cnt, 0);
1377 tg_pt_gp->tg_pt_gp_dev = dev;
1378 atomic_set(&tg_pt_gp->tg_pt_gp_alua_access_state,
1379 ALUA_ACCESS_STATE_ACTIVE_OPTIMIZED);
1381 * Enable both explicit and implicit ALUA support by default
1383 tg_pt_gp->tg_pt_gp_alua_access_type =
1384 TPGS_EXPLICIT_ALUA | TPGS_IMPLICIT_ALUA;
1386 * Set the default Active/NonOptimized Delay in milliseconds
1388 tg_pt_gp->tg_pt_gp_nonop_delay_msecs = ALUA_DEFAULT_NONOP_DELAY_MSECS;
1389 tg_pt_gp->tg_pt_gp_trans_delay_msecs = ALUA_DEFAULT_TRANS_DELAY_MSECS;
1390 tg_pt_gp->tg_pt_gp_implicit_trans_secs = ALUA_DEFAULT_IMPLICIT_TRANS_SECS;
1393 * Enable all supported states
1395 tg_pt_gp->tg_pt_gp_alua_supported_states =
1396 ALUA_T_SUP | ALUA_O_SUP |
1397 ALUA_U_SUP | ALUA_S_SUP | ALUA_AN_SUP | ALUA_AO_SUP;
1400 spin_lock(&dev->t10_alua.tg_pt_gps_lock);
1401 tg_pt_gp->tg_pt_gp_id =
1402 dev->t10_alua.alua_tg_pt_gps_counter++;
1403 tg_pt_gp->tg_pt_gp_valid_id = 1;
1404 dev->t10_alua.alua_tg_pt_gps_count++;
1405 list_add_tail(&tg_pt_gp->tg_pt_gp_list,
1406 &dev->t10_alua.tg_pt_gps_list);
1407 spin_unlock(&dev->t10_alua.tg_pt_gps_lock);
1413 int core_alua_set_tg_pt_gp_id(
1414 struct t10_alua_tg_pt_gp *tg_pt_gp,
1417 struct se_device *dev = tg_pt_gp->tg_pt_gp_dev;
1418 struct t10_alua_tg_pt_gp *tg_pt_gp_tmp;
1419 u16 tg_pt_gp_id_tmp;
1422 * The tg_pt_gp->tg_pt_gp_id may only be set once..
1424 if (tg_pt_gp->tg_pt_gp_valid_id) {
1425 pr_warn("ALUA TG PT Group already has a valid ID,"
1426 " ignoring request\n");
1430 spin_lock(&dev->t10_alua.tg_pt_gps_lock);
1431 if (dev->t10_alua.alua_tg_pt_gps_count == 0x0000ffff) {
1432 pr_err("Maximum ALUA alua_tg_pt_gps_count:"
1433 " 0x0000ffff reached\n");
1434 spin_unlock(&dev->t10_alua.tg_pt_gps_lock);
1435 kmem_cache_free(t10_alua_tg_pt_gp_cache, tg_pt_gp);
1439 tg_pt_gp_id_tmp = (tg_pt_gp_id != 0) ? tg_pt_gp_id :
1440 dev->t10_alua.alua_tg_pt_gps_counter++;
1442 list_for_each_entry(tg_pt_gp_tmp, &dev->t10_alua.tg_pt_gps_list,
1444 if (tg_pt_gp_tmp->tg_pt_gp_id == tg_pt_gp_id_tmp) {
1448 pr_err("ALUA Target Port Group ID: %hu already"
1449 " exists, ignoring request\n", tg_pt_gp_id);
1450 spin_unlock(&dev->t10_alua.tg_pt_gps_lock);
1455 tg_pt_gp->tg_pt_gp_id = tg_pt_gp_id_tmp;
1456 tg_pt_gp->tg_pt_gp_valid_id = 1;
1457 list_add_tail(&tg_pt_gp->tg_pt_gp_list,
1458 &dev->t10_alua.tg_pt_gps_list);
1459 dev->t10_alua.alua_tg_pt_gps_count++;
1460 spin_unlock(&dev->t10_alua.tg_pt_gps_lock);
1465 struct t10_alua_tg_pt_gp_member *core_alua_allocate_tg_pt_gp_mem(
1466 struct se_port *port)
1468 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1470 tg_pt_gp_mem = kmem_cache_zalloc(t10_alua_tg_pt_gp_mem_cache,
1472 if (!tg_pt_gp_mem) {
1473 pr_err("Unable to allocate struct t10_alua_tg_pt_gp_member\n");
1474 return ERR_PTR(-ENOMEM);
1476 INIT_LIST_HEAD(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1477 spin_lock_init(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1478 atomic_set(&tg_pt_gp_mem->tg_pt_gp_mem_ref_cnt, 0);
1480 tg_pt_gp_mem->tg_pt = port;
1481 port->sep_alua_tg_pt_gp_mem = tg_pt_gp_mem;
1483 return tg_pt_gp_mem;
1486 void core_alua_free_tg_pt_gp(
1487 struct t10_alua_tg_pt_gp *tg_pt_gp)
1489 struct se_device *dev = tg_pt_gp->tg_pt_gp_dev;
1490 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem, *tg_pt_gp_mem_tmp;
1493 * Once we have reached this point, config_item_put() has already
1494 * been called from target_core_alua_drop_tg_pt_gp().
1496 * Here we remove *tg_pt_gp from the global list so that
1497 * no associations *OR* explicit ALUA via SET_TARGET_PORT_GROUPS
1498 * can be made while we are releasing struct t10_alua_tg_pt_gp.
1500 spin_lock(&dev->t10_alua.tg_pt_gps_lock);
1501 list_del(&tg_pt_gp->tg_pt_gp_list);
1502 dev->t10_alua.alua_tg_pt_gps_counter--;
1503 spin_unlock(&dev->t10_alua.tg_pt_gps_lock);
1506 * Allow a struct t10_alua_tg_pt_gp_member * referenced by
1507 * core_alua_get_tg_pt_gp_by_name() in
1508 * target_core_configfs.c:target_core_store_alua_tg_pt_gp()
1509 * to be released with core_alua_put_tg_pt_gp_from_name().
1511 while (atomic_read(&tg_pt_gp->tg_pt_gp_ref_cnt))
1515 * Release reference to struct t10_alua_tg_pt_gp from all associated
1518 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1519 list_for_each_entry_safe(tg_pt_gp_mem, tg_pt_gp_mem_tmp,
1520 &tg_pt_gp->tg_pt_gp_mem_list, tg_pt_gp_mem_list) {
1521 if (tg_pt_gp_mem->tg_pt_gp_assoc) {
1522 list_del(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1523 tg_pt_gp->tg_pt_gp_members--;
1524 tg_pt_gp_mem->tg_pt_gp_assoc = 0;
1526 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1528 * tg_pt_gp_mem is associated with a single
1529 * se_port->sep_alua_tg_pt_gp_mem, and is released via
1530 * core_alua_free_tg_pt_gp_mem().
1532 * If the passed tg_pt_gp does NOT match the default_tg_pt_gp,
1533 * assume we want to re-associate a given tg_pt_gp_mem with
1536 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1537 if (tg_pt_gp != dev->t10_alua.default_tg_pt_gp) {
1538 __core_alua_attach_tg_pt_gp_mem(tg_pt_gp_mem,
1539 dev->t10_alua.default_tg_pt_gp);
1541 tg_pt_gp_mem->tg_pt_gp = NULL;
1542 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1544 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1546 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1548 kmem_cache_free(t10_alua_tg_pt_gp_cache, tg_pt_gp);
1551 void core_alua_free_tg_pt_gp_mem(struct se_port *port)
1553 struct t10_alua_tg_pt_gp *tg_pt_gp;
1554 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1556 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
1560 while (atomic_read(&tg_pt_gp_mem->tg_pt_gp_mem_ref_cnt))
1563 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1564 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1566 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1567 if (tg_pt_gp_mem->tg_pt_gp_assoc) {
1568 list_del(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1569 tg_pt_gp->tg_pt_gp_members--;
1570 tg_pt_gp_mem->tg_pt_gp_assoc = 0;
1572 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1573 tg_pt_gp_mem->tg_pt_gp = NULL;
1575 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1577 kmem_cache_free(t10_alua_tg_pt_gp_mem_cache, tg_pt_gp_mem);
1580 static struct t10_alua_tg_pt_gp *core_alua_get_tg_pt_gp_by_name(
1581 struct se_device *dev, const char *name)
1583 struct t10_alua_tg_pt_gp *tg_pt_gp;
1584 struct config_item *ci;
1586 spin_lock(&dev->t10_alua.tg_pt_gps_lock);
1587 list_for_each_entry(tg_pt_gp, &dev->t10_alua.tg_pt_gps_list,
1589 if (!tg_pt_gp->tg_pt_gp_valid_id)
1591 ci = &tg_pt_gp->tg_pt_gp_group.cg_item;
1592 if (!strcmp(config_item_name(ci), name)) {
1593 atomic_inc(&tg_pt_gp->tg_pt_gp_ref_cnt);
1594 spin_unlock(&dev->t10_alua.tg_pt_gps_lock);
1598 spin_unlock(&dev->t10_alua.tg_pt_gps_lock);
1603 static void core_alua_put_tg_pt_gp_from_name(
1604 struct t10_alua_tg_pt_gp *tg_pt_gp)
1606 struct se_device *dev = tg_pt_gp->tg_pt_gp_dev;
1608 spin_lock(&dev->t10_alua.tg_pt_gps_lock);
1609 atomic_dec(&tg_pt_gp->tg_pt_gp_ref_cnt);
1610 spin_unlock(&dev->t10_alua.tg_pt_gps_lock);
1614 * Called with struct t10_alua_tg_pt_gp_member->tg_pt_gp_mem_lock held
1616 void __core_alua_attach_tg_pt_gp_mem(
1617 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
1618 struct t10_alua_tg_pt_gp *tg_pt_gp)
1620 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1621 tg_pt_gp_mem->tg_pt_gp = tg_pt_gp;
1622 tg_pt_gp_mem->tg_pt_gp_assoc = 1;
1623 list_add_tail(&tg_pt_gp_mem->tg_pt_gp_mem_list,
1624 &tg_pt_gp->tg_pt_gp_mem_list);
1625 tg_pt_gp->tg_pt_gp_members++;
1626 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1630 * Called with struct t10_alua_tg_pt_gp_member->tg_pt_gp_mem_lock held
1632 static void __core_alua_drop_tg_pt_gp_mem(
1633 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem,
1634 struct t10_alua_tg_pt_gp *tg_pt_gp)
1636 spin_lock(&tg_pt_gp->tg_pt_gp_lock);
1637 list_del(&tg_pt_gp_mem->tg_pt_gp_mem_list);
1638 tg_pt_gp_mem->tg_pt_gp = NULL;
1639 tg_pt_gp_mem->tg_pt_gp_assoc = 0;
1640 tg_pt_gp->tg_pt_gp_members--;
1641 spin_unlock(&tg_pt_gp->tg_pt_gp_lock);
1644 ssize_t core_alua_show_tg_pt_gp_info(struct se_port *port, char *page)
1646 struct config_item *tg_pt_ci;
1647 struct t10_alua_tg_pt_gp *tg_pt_gp;
1648 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1651 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
1655 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1656 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1658 tg_pt_ci = &tg_pt_gp->tg_pt_gp_group.cg_item;
1659 len += sprintf(page, "TG Port Alias: %s\nTG Port Group ID:"
1660 " %hu\nTG Port Primary Access State: %s\nTG Port "
1661 "Primary Access Status: %s\nTG Port Secondary Access"
1662 " State: %s\nTG Port Secondary Access Status: %s\n",
1663 config_item_name(tg_pt_ci), tg_pt_gp->tg_pt_gp_id,
1664 core_alua_dump_state(atomic_read(
1665 &tg_pt_gp->tg_pt_gp_alua_access_state)),
1666 core_alua_dump_status(
1667 tg_pt_gp->tg_pt_gp_alua_access_status),
1668 (atomic_read(&port->sep_tg_pt_secondary_offline)) ?
1670 core_alua_dump_status(port->sep_tg_pt_secondary_stat));
1672 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1677 ssize_t core_alua_store_tg_pt_gp_info(
1678 struct se_port *port,
1682 struct se_portal_group *tpg;
1684 struct se_device *dev = port->sep_lun->lun_se_dev;
1685 struct t10_alua_tg_pt_gp *tg_pt_gp = NULL, *tg_pt_gp_new = NULL;
1686 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1687 unsigned char buf[TG_PT_GROUP_NAME_BUF];
1690 tpg = port->sep_tpg;
1691 lun = port->sep_lun;
1693 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
1697 if (count > TG_PT_GROUP_NAME_BUF) {
1698 pr_err("ALUA Target Port Group alias too large!\n");
1701 memset(buf, 0, TG_PT_GROUP_NAME_BUF);
1702 memcpy(buf, page, count);
1704 * Any ALUA target port group alias besides "NULL" means we will be
1705 * making a new group association.
1707 if (strcmp(strstrip(buf), "NULL")) {
1709 * core_alua_get_tg_pt_gp_by_name() will increment reference to
1710 * struct t10_alua_tg_pt_gp. This reference is released with
1711 * core_alua_put_tg_pt_gp_from_name() below.
1713 tg_pt_gp_new = core_alua_get_tg_pt_gp_by_name(dev,
1719 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1720 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
1723 * Clearing an existing tg_pt_gp association, and replacing
1724 * with the default_tg_pt_gp.
1726 if (!tg_pt_gp_new) {
1727 pr_debug("Target_Core_ConfigFS: Moving"
1728 " %s/tpgt_%hu/%s from ALUA Target Port Group:"
1729 " alua/%s, ID: %hu back to"
1730 " default_tg_pt_gp\n",
1731 tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1732 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1733 config_item_name(&lun->lun_group.cg_item),
1735 &tg_pt_gp->tg_pt_gp_group.cg_item),
1736 tg_pt_gp->tg_pt_gp_id);
1738 __core_alua_drop_tg_pt_gp_mem(tg_pt_gp_mem, tg_pt_gp);
1739 __core_alua_attach_tg_pt_gp_mem(tg_pt_gp_mem,
1740 dev->t10_alua.default_tg_pt_gp);
1741 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1746 * Removing existing association of tg_pt_gp_mem with tg_pt_gp
1748 __core_alua_drop_tg_pt_gp_mem(tg_pt_gp_mem, tg_pt_gp);
1752 * Associate tg_pt_gp_mem with tg_pt_gp_new.
1754 __core_alua_attach_tg_pt_gp_mem(tg_pt_gp_mem, tg_pt_gp_new);
1755 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
1756 pr_debug("Target_Core_ConfigFS: %s %s/tpgt_%hu/%s to ALUA"
1757 " Target Port Group: alua/%s, ID: %hu\n", (move) ?
1758 "Moving" : "Adding", tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1759 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1760 config_item_name(&lun->lun_group.cg_item),
1761 config_item_name(&tg_pt_gp_new->tg_pt_gp_group.cg_item),
1762 tg_pt_gp_new->tg_pt_gp_id);
1764 core_alua_put_tg_pt_gp_from_name(tg_pt_gp_new);
1768 ssize_t core_alua_show_access_type(
1769 struct t10_alua_tg_pt_gp *tg_pt_gp,
1772 if ((tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_EXPLICIT_ALUA) &&
1773 (tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_IMPLICIT_ALUA))
1774 return sprintf(page, "Implicit and Explicit\n");
1775 else if (tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_IMPLICIT_ALUA)
1776 return sprintf(page, "Implicit\n");
1777 else if (tg_pt_gp->tg_pt_gp_alua_access_type & TPGS_EXPLICIT_ALUA)
1778 return sprintf(page, "Explicit\n");
1780 return sprintf(page, "None\n");
1783 ssize_t core_alua_store_access_type(
1784 struct t10_alua_tg_pt_gp *tg_pt_gp,
1791 ret = kstrtoul(page, 0, &tmp);
1793 pr_err("Unable to extract alua_access_type\n");
1796 if ((tmp != 0) && (tmp != 1) && (tmp != 2) && (tmp != 3)) {
1797 pr_err("Illegal value for alua_access_type:"
1802 tg_pt_gp->tg_pt_gp_alua_access_type =
1803 TPGS_IMPLICIT_ALUA | TPGS_EXPLICIT_ALUA;
1805 tg_pt_gp->tg_pt_gp_alua_access_type = TPGS_EXPLICIT_ALUA;
1807 tg_pt_gp->tg_pt_gp_alua_access_type = TPGS_IMPLICIT_ALUA;
1809 tg_pt_gp->tg_pt_gp_alua_access_type = 0;
1814 ssize_t core_alua_show_nonop_delay_msecs(
1815 struct t10_alua_tg_pt_gp *tg_pt_gp,
1818 return sprintf(page, "%d\n", tg_pt_gp->tg_pt_gp_nonop_delay_msecs);
1821 ssize_t core_alua_store_nonop_delay_msecs(
1822 struct t10_alua_tg_pt_gp *tg_pt_gp,
1829 ret = kstrtoul(page, 0, &tmp);
1831 pr_err("Unable to extract nonop_delay_msecs\n");
1834 if (tmp > ALUA_MAX_NONOP_DELAY_MSECS) {
1835 pr_err("Passed nonop_delay_msecs: %lu, exceeds"
1836 " ALUA_MAX_NONOP_DELAY_MSECS: %d\n", tmp,
1837 ALUA_MAX_NONOP_DELAY_MSECS);
1840 tg_pt_gp->tg_pt_gp_nonop_delay_msecs = (int)tmp;
1845 ssize_t core_alua_show_trans_delay_msecs(
1846 struct t10_alua_tg_pt_gp *tg_pt_gp,
1849 return sprintf(page, "%d\n", tg_pt_gp->tg_pt_gp_trans_delay_msecs);
1852 ssize_t core_alua_store_trans_delay_msecs(
1853 struct t10_alua_tg_pt_gp *tg_pt_gp,
1860 ret = kstrtoul(page, 0, &tmp);
1862 pr_err("Unable to extract trans_delay_msecs\n");
1865 if (tmp > ALUA_MAX_TRANS_DELAY_MSECS) {
1866 pr_err("Passed trans_delay_msecs: %lu, exceeds"
1867 " ALUA_MAX_TRANS_DELAY_MSECS: %d\n", tmp,
1868 ALUA_MAX_TRANS_DELAY_MSECS);
1871 tg_pt_gp->tg_pt_gp_trans_delay_msecs = (int)tmp;
1876 ssize_t core_alua_show_implicit_trans_secs(
1877 struct t10_alua_tg_pt_gp *tg_pt_gp,
1880 return sprintf(page, "%d\n", tg_pt_gp->tg_pt_gp_implicit_trans_secs);
1883 ssize_t core_alua_store_implicit_trans_secs(
1884 struct t10_alua_tg_pt_gp *tg_pt_gp,
1891 ret = kstrtoul(page, 0, &tmp);
1893 pr_err("Unable to extract implicit_trans_secs\n");
1896 if (tmp > ALUA_MAX_IMPLICIT_TRANS_SECS) {
1897 pr_err("Passed implicit_trans_secs: %lu, exceeds"
1898 " ALUA_MAX_IMPLICIT_TRANS_SECS: %d\n", tmp,
1899 ALUA_MAX_IMPLICIT_TRANS_SECS);
1902 tg_pt_gp->tg_pt_gp_implicit_trans_secs = (int)tmp;
1907 ssize_t core_alua_show_preferred_bit(
1908 struct t10_alua_tg_pt_gp *tg_pt_gp,
1911 return sprintf(page, "%d\n", tg_pt_gp->tg_pt_gp_pref);
1914 ssize_t core_alua_store_preferred_bit(
1915 struct t10_alua_tg_pt_gp *tg_pt_gp,
1922 ret = kstrtoul(page, 0, &tmp);
1924 pr_err("Unable to extract preferred ALUA value\n");
1927 if ((tmp != 0) && (tmp != 1)) {
1928 pr_err("Illegal value for preferred ALUA: %lu\n", tmp);
1931 tg_pt_gp->tg_pt_gp_pref = (int)tmp;
1936 ssize_t core_alua_show_offline_bit(struct se_lun *lun, char *page)
1941 return sprintf(page, "%d\n",
1942 atomic_read(&lun->lun_sep->sep_tg_pt_secondary_offline));
1945 ssize_t core_alua_store_offline_bit(
1950 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
1957 ret = kstrtoul(page, 0, &tmp);
1959 pr_err("Unable to extract alua_tg_pt_offline value\n");
1962 if ((tmp != 0) && (tmp != 1)) {
1963 pr_err("Illegal value for alua_tg_pt_offline: %lu\n",
1967 tg_pt_gp_mem = lun->lun_sep->sep_alua_tg_pt_gp_mem;
1968 if (!tg_pt_gp_mem) {
1969 pr_err("Unable to locate *tg_pt_gp_mem\n");
1973 ret = core_alua_set_tg_pt_secondary_state(tg_pt_gp_mem,
1974 lun->lun_sep, 0, (int)tmp);
1981 ssize_t core_alua_show_secondary_status(
1985 return sprintf(page, "%d\n", lun->lun_sep->sep_tg_pt_secondary_stat);
1988 ssize_t core_alua_store_secondary_status(
1996 ret = kstrtoul(page, 0, &tmp);
1998 pr_err("Unable to extract alua_tg_pt_status\n");
2001 if ((tmp != ALUA_STATUS_NONE) &&
2002 (tmp != ALUA_STATUS_ALTERED_BY_EXPLICIT_STPG) &&
2003 (tmp != ALUA_STATUS_ALTERED_BY_IMPLICIT_ALUA)) {
2004 pr_err("Illegal value for alua_tg_pt_status: %lu\n",
2008 lun->lun_sep->sep_tg_pt_secondary_stat = (int)tmp;
2013 ssize_t core_alua_show_secondary_write_metadata(
2017 return sprintf(page, "%d\n",
2018 lun->lun_sep->sep_tg_pt_secondary_write_md);
2021 ssize_t core_alua_store_secondary_write_metadata(
2029 ret = kstrtoul(page, 0, &tmp);
2031 pr_err("Unable to extract alua_tg_pt_write_md\n");
2034 if ((tmp != 0) && (tmp != 1)) {
2035 pr_err("Illegal value for alua_tg_pt_write_md:"
2039 lun->lun_sep->sep_tg_pt_secondary_write_md = (int)tmp;
2044 int core_setup_alua(struct se_device *dev)
2046 if (dev->transport->transport_type != TRANSPORT_PLUGIN_PHBA_PDEV &&
2047 !(dev->se_hba->hba_flags & HBA_FLAGS_INTERNAL_USE)) {
2048 struct t10_alua_lu_gp_member *lu_gp_mem;
2051 * Associate this struct se_device with the default ALUA
2054 lu_gp_mem = core_alua_allocate_lu_gp_mem(dev);
2055 if (IS_ERR(lu_gp_mem))
2056 return PTR_ERR(lu_gp_mem);
2058 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
2059 __core_alua_attach_lu_gp_mem(lu_gp_mem,
2061 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
2063 pr_debug("%s: Adding to default ALUA LU Group:"
2064 " core/alua/lu_gps/default_lu_gp\n",
2065 dev->transport->name);