1 /*******************************************************************************
2 * Filename: target_core_pr.c
4 * This file contains SPC-3 compliant persistent reservations and
5 * legacy SPC-2 reservations with compatible reservation handling (CRH=1)
7 * (c) Copyright 2009-2013 Datera, Inc.
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/list.h>
30 #include <linux/vmalloc.h>
31 #include <linux/file.h>
32 #include <linux/fcntl.h>
34 #include <scsi/scsi_proto.h>
35 #include <asm/unaligned.h>
37 #include <target/target_core_base.h>
38 #include <target/target_core_backend.h>
39 #include <target/target_core_fabric.h>
41 #include "target_core_internal.h"
42 #include "target_core_pr.h"
43 #include "target_core_ua.h"
46 * Used for Specify Initiator Ports Capable Bit (SPEC_I_PT)
48 struct pr_transport_id_holder
{
49 struct t10_pr_registration
*dest_pr_reg
;
50 struct se_portal_group
*dest_tpg
;
51 struct se_node_acl
*dest_node_acl
;
52 struct se_dev_entry
*dest_se_deve
;
53 struct list_head dest_list
;
56 void core_pr_dump_initiator_port(
57 struct t10_pr_registration
*pr_reg
,
61 if (!pr_reg
->isid_present_at_reg
)
64 snprintf(buf
, size
, ",i,0x%s", pr_reg
->pr_reg_isid
);
69 REGISTER_AND_IGNORE_EXISTING_KEY
,
78 static void __core_scsi3_complete_pro_release(struct se_device
*, struct se_node_acl
*,
79 struct t10_pr_registration
*, int, int);
81 static int is_reservation_holder(
82 struct t10_pr_registration
*pr_res_holder
,
83 struct t10_pr_registration
*pr_reg
)
88 pr_res_type
= pr_res_holder
->pr_res_type
;
90 return pr_res_holder
== pr_reg
||
91 pr_res_type
== PR_TYPE_WRITE_EXCLUSIVE_ALLREG
||
92 pr_res_type
== PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
;
98 target_scsi2_reservation_check(struct se_cmd
*cmd
)
100 struct se_device
*dev
= cmd
->se_dev
;
101 struct se_session
*sess
= cmd
->se_sess
;
103 switch (cmd
->t_task_cdb
[0]) {
112 if (!dev
->dev_reserved_node_acl
|| !sess
)
115 if (dev
->dev_reserved_node_acl
!= sess
->se_node_acl
)
116 return TCM_RESERVATION_CONFLICT
;
118 if (dev
->dev_reservation_flags
& DRF_SPC2_RESERVATIONS_WITH_ISID
) {
119 if (dev
->dev_res_bin_isid
!= sess
->sess_bin_isid
)
120 return TCM_RESERVATION_CONFLICT
;
126 static struct t10_pr_registration
*core_scsi3_locate_pr_reg(struct se_device
*,
127 struct se_node_acl
*, struct se_session
*);
128 static void core_scsi3_put_pr_reg(struct t10_pr_registration
*);
130 static int target_check_scsi2_reservation_conflict(struct se_cmd
*cmd
)
132 struct se_session
*se_sess
= cmd
->se_sess
;
133 struct se_device
*dev
= cmd
->se_dev
;
134 struct t10_pr_registration
*pr_reg
;
135 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
138 pr_reg
= core_scsi3_locate_pr_reg(cmd
->se_dev
, se_sess
->se_node_acl
,
142 * From spc4r17 5.7.3 Exceptions to SPC-2 RESERVE and RELEASE
145 * A RESERVE(6) or RESERVE(10) command shall complete with GOOD
146 * status, but no reservation shall be established and the
147 * persistent reservation shall not be changed, if the command
148 * is received from a) and b) below.
150 * A RELEASE(6) or RELEASE(10) command shall complete with GOOD
151 * status, but the persistent reservation shall not be released,
152 * if the command is received from a) and b)
154 * a) An I_T nexus that is a persistent reservation holder; or
155 * b) An I_T nexus that is registered if a registrants only or
156 * all registrants type persistent reservation is present.
158 * In all other cases, a RESERVE(6) command, RESERVE(10) command,
159 * RELEASE(6) command, or RELEASE(10) command shall be processed
160 * as defined in SPC-2.
162 if (pr_reg
->pr_res_holder
) {
163 core_scsi3_put_pr_reg(pr_reg
);
166 if ((pr_reg
->pr_res_type
== PR_TYPE_WRITE_EXCLUSIVE_REGONLY
) ||
167 (pr_reg
->pr_res_type
== PR_TYPE_EXCLUSIVE_ACCESS_REGONLY
) ||
168 (pr_reg
->pr_res_type
== PR_TYPE_WRITE_EXCLUSIVE_ALLREG
) ||
169 (pr_reg
->pr_res_type
== PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
)) {
170 core_scsi3_put_pr_reg(pr_reg
);
173 core_scsi3_put_pr_reg(pr_reg
);
177 * Following spc2r20 5.5.1 Reservations overview:
179 * If a logical unit has executed a PERSISTENT RESERVE OUT
180 * command with the REGISTER or the REGISTER AND IGNORE
181 * EXISTING KEY service action and is still registered by any
182 * initiator, all RESERVE commands and all RELEASE commands
183 * regardless of initiator shall conflict and shall terminate
184 * with a RESERVATION CONFLICT status.
186 spin_lock(&pr_tmpl
->registration_lock
);
187 conflict
= (list_empty(&pr_tmpl
->registration_list
)) ? 0 : 1;
188 spin_unlock(&pr_tmpl
->registration_lock
);
192 pr_err("Received legacy SPC-2 RESERVE/RELEASE"
193 " while active SPC-3 registrations exist,"
194 " returning RESERVATION_CONFLICT\n");
202 target_scsi2_reservation_release(struct se_cmd
*cmd
)
204 struct se_device
*dev
= cmd
->se_dev
;
205 struct se_session
*sess
= cmd
->se_sess
;
206 struct se_portal_group
*tpg
;
209 if (!sess
|| !sess
->se_tpg
)
211 rc
= target_check_scsi2_reservation_conflict(cmd
);
215 return TCM_RESERVATION_CONFLICT
;
217 spin_lock(&dev
->dev_reservation_lock
);
218 if (!dev
->dev_reserved_node_acl
|| !sess
)
221 if (dev
->dev_reserved_node_acl
!= sess
->se_node_acl
)
224 if (dev
->dev_res_bin_isid
!= sess
->sess_bin_isid
)
227 dev
->dev_reserved_node_acl
= NULL
;
228 dev
->dev_reservation_flags
&= ~DRF_SPC2_RESERVATIONS
;
229 if (dev
->dev_reservation_flags
& DRF_SPC2_RESERVATIONS_WITH_ISID
) {
230 dev
->dev_res_bin_isid
= 0;
231 dev
->dev_reservation_flags
&= ~DRF_SPC2_RESERVATIONS_WITH_ISID
;
234 pr_debug("SCSI-2 Released reservation for %s LUN: %llu ->"
235 " MAPPED LUN: %llu for %s\n",
236 tpg
->se_tpg_tfo
->get_fabric_name(),
237 cmd
->se_lun
->unpacked_lun
, cmd
->orig_fe_lun
,
238 sess
->se_node_acl
->initiatorname
);
241 spin_unlock(&dev
->dev_reservation_lock
);
243 target_complete_cmd(cmd
, GOOD
);
248 target_scsi2_reservation_reserve(struct se_cmd
*cmd
)
250 struct se_device
*dev
= cmd
->se_dev
;
251 struct se_session
*sess
= cmd
->se_sess
;
252 struct se_portal_group
*tpg
;
253 sense_reason_t ret
= 0;
256 if ((cmd
->t_task_cdb
[1] & 0x01) &&
257 (cmd
->t_task_cdb
[1] & 0x02)) {
258 pr_err("LongIO and Obsolete Bits set, returning ILLEGAL_REQUEST\n");
259 return TCM_UNSUPPORTED_SCSI_OPCODE
;
262 * This is currently the case for target_core_mod passthrough struct se_cmd
265 if (!sess
|| !sess
->se_tpg
)
267 rc
= target_check_scsi2_reservation_conflict(cmd
);
272 return TCM_RESERVATION_CONFLICT
;
275 spin_lock(&dev
->dev_reservation_lock
);
276 if (dev
->dev_reserved_node_acl
&&
277 (dev
->dev_reserved_node_acl
!= sess
->se_node_acl
)) {
278 pr_err("SCSI-2 RESERVATION CONFLIFT for %s fabric\n",
279 tpg
->se_tpg_tfo
->get_fabric_name());
280 pr_err("Original reserver LUN: %llu %s\n",
281 cmd
->se_lun
->unpacked_lun
,
282 dev
->dev_reserved_node_acl
->initiatorname
);
283 pr_err("Current attempt - LUN: %llu -> MAPPED LUN: %llu"
284 " from %s \n", cmd
->se_lun
->unpacked_lun
,
286 sess
->se_node_acl
->initiatorname
);
287 ret
= TCM_RESERVATION_CONFLICT
;
291 dev
->dev_reserved_node_acl
= sess
->se_node_acl
;
292 dev
->dev_reservation_flags
|= DRF_SPC2_RESERVATIONS
;
293 if (sess
->sess_bin_isid
!= 0) {
294 dev
->dev_res_bin_isid
= sess
->sess_bin_isid
;
295 dev
->dev_reservation_flags
|= DRF_SPC2_RESERVATIONS_WITH_ISID
;
297 pr_debug("SCSI-2 Reserved %s LUN: %llu -> MAPPED LUN: %llu"
298 " for %s\n", tpg
->se_tpg_tfo
->get_fabric_name(),
299 cmd
->se_lun
->unpacked_lun
, cmd
->orig_fe_lun
,
300 sess
->se_node_acl
->initiatorname
);
303 spin_unlock(&dev
->dev_reservation_lock
);
306 target_complete_cmd(cmd
, GOOD
);
312 * Begin SPC-3/SPC-4 Persistent Reservations emulation support
314 * This function is called by those initiator ports who are *NOT*
315 * the active PR reservation holder when a reservation is present.
317 static int core_scsi3_pr_seq_non_holder(struct se_cmd
*cmd
, u32 pr_reg_type
,
320 unsigned char *cdb
= cmd
->t_task_cdb
;
321 struct se_session
*se_sess
= cmd
->se_sess
;
322 struct se_node_acl
*nacl
= se_sess
->se_node_acl
;
324 int registered_nexus
= 0, ret
= 1; /* Conflict by default */
325 int all_reg
= 0, reg_only
= 0; /* ALL_REG, REG_ONLY */
326 int we
= 0; /* Write Exclusive */
327 int legacy
= 0; /* Act like a legacy device and return
328 * RESERVATION CONFLICT on some CDBs */
331 registered_nexus
= 0;
333 struct se_dev_entry
*se_deve
;
336 se_deve
= target_nacl_find_deve(nacl
, cmd
->orig_fe_lun
);
338 registered_nexus
= test_bit(DEF_PR_REG_ACTIVE
,
339 &se_deve
->deve_flags
);
343 switch (pr_reg_type
) {
344 case PR_TYPE_WRITE_EXCLUSIVE
:
346 case PR_TYPE_EXCLUSIVE_ACCESS
:
348 * Some commands are only allowed for the persistent reservation
352 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY
:
354 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY
:
356 * Some commands are only allowed for registered I_T Nexuses.
360 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG
:
362 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
:
364 * Each registered I_T Nexus is a reservation holder.
372 * Referenced from spc4r17 table 45 for *NON* PR holder access
375 case SECURITY_PROTOCOL_IN
:
376 if (registered_nexus
)
384 case RECEIVE_DIAGNOSTIC
:
389 if (registered_nexus
) {
393 ret
= (we
) ? 0 : 1; /* Allowed Write Exclusive */
395 case PERSISTENT_RESERVE_OUT
:
397 * This follows PERSISTENT_RESERVE_OUT service actions that
398 * are allowed in the presence of various reservations.
399 * See spc4r17, table 46
401 switch (cdb
[1] & 0x1f) {
404 case PRO_PREEMPT_AND_ABORT
:
405 ret
= (registered_nexus
) ? 0 : 1;
408 case PRO_REGISTER_AND_IGNORE_EXISTING_KEY
:
411 case PRO_REGISTER_AND_MOVE
:
416 ret
= (registered_nexus
) ? 0 : 1;
419 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
420 " action: 0x%02x\n", cdb
[1] & 0x1f);
426 /* Handled by CRH=1 in target_scsi2_reservation_release() */
431 /* Handled by CRH=1 in target_scsi2_reservation_reserve() */
434 case TEST_UNIT_READY
:
435 ret
= (legacy
) ? 1 : 0; /* Conflict for legacy */
438 switch (cdb
[1] & 0x1f) {
439 case MI_MANAGEMENT_PROTOCOL_IN
:
440 if (registered_nexus
) {
444 ret
= (we
) ? 0 : 1; /* Allowed Write Exclusive */
446 case MI_REPORT_SUPPORTED_OPERATION_CODES
:
447 case MI_REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS
:
452 if (registered_nexus
) {
456 ret
= (we
) ? 0 : 1; /* Allowed Write Exclusive */
458 case MI_REPORT_ALIASES
:
459 case MI_REPORT_IDENTIFYING_INFORMATION
:
460 case MI_REPORT_PRIORITY
:
461 case MI_REPORT_TARGET_PGS
:
462 case MI_REPORT_TIMESTAMP
:
463 ret
= 0; /* Allowed */
466 pr_err("Unknown MI Service Action: 0x%02x\n",
471 case ACCESS_CONTROL_IN
:
472 case ACCESS_CONTROL_OUT
:
475 case SERVICE_ACTION_IN_12
:
478 case PERSISTENT_RESERVE_IN
:
479 ret
= 0; /*/ Allowed CDBs */
486 * Case where the CDB is explicitly allowed in the above switch
489 if (!ret
&& !other_cdb
) {
490 pr_debug("Allowing explicit CDB: 0x%02x for %s"
491 " reservation holder\n", cdb
[0],
492 core_scsi3_pr_dump_type(pr_reg_type
));
497 * Check if write exclusive initiator ports *NOT* holding the
498 * WRITE_EXCLUSIVE_* reservation.
500 if (we
&& !registered_nexus
) {
501 if (cmd
->data_direction
== DMA_TO_DEVICE
) {
503 * Conflict for write exclusive
505 pr_debug("%s Conflict for unregistered nexus"
506 " %s CDB: 0x%02x to %s reservation\n",
507 transport_dump_cmd_direction(cmd
),
508 se_sess
->se_node_acl
->initiatorname
, cdb
[0],
509 core_scsi3_pr_dump_type(pr_reg_type
));
513 * Allow non WRITE CDBs for all Write Exclusive
514 * PR TYPEs to pass for registered and
515 * non-registered_nexuxes NOT holding the reservation.
517 * We only make noise for the unregisterd nexuses,
518 * as we expect registered non-reservation holding
519 * nexuses to issue CDBs.
522 if (!registered_nexus
) {
523 pr_debug("Allowing implicit CDB: 0x%02x"
524 " for %s reservation on unregistered"
526 core_scsi3_pr_dump_type(pr_reg_type
));
531 } else if ((reg_only
) || (all_reg
)) {
532 if (registered_nexus
) {
534 * For PR_*_REG_ONLY and PR_*_ALL_REG reservations,
535 * allow commands from registered nexuses.
538 pr_debug("Allowing implicit CDB: 0x%02x for %s"
539 " reservation\n", cdb
[0],
540 core_scsi3_pr_dump_type(pr_reg_type
));
544 } else if (we
&& registered_nexus
) {
546 * Reads are allowed for Write Exclusive locks
547 * from all registrants.
549 if (cmd
->data_direction
== DMA_FROM_DEVICE
) {
550 pr_debug("Allowing READ CDB: 0x%02x for %s"
551 " reservation\n", cdb
[0],
552 core_scsi3_pr_dump_type(pr_reg_type
));
557 pr_debug("%s Conflict for %sregistered nexus %s CDB: 0x%2x"
558 " for %s reservation\n", transport_dump_cmd_direction(cmd
),
559 (registered_nexus
) ? "" : "un",
560 se_sess
->se_node_acl
->initiatorname
, cdb
[0],
561 core_scsi3_pr_dump_type(pr_reg_type
));
563 return 1; /* Conflict by default */
566 static sense_reason_t
567 target_scsi3_pr_reservation_check(struct se_cmd
*cmd
)
569 struct se_device
*dev
= cmd
->se_dev
;
570 struct se_session
*sess
= cmd
->se_sess
;
572 bool isid_mismatch
= false;
574 if (!dev
->dev_pr_res_holder
)
577 pr_reg_type
= dev
->dev_pr_res_holder
->pr_res_type
;
578 cmd
->pr_res_key
= dev
->dev_pr_res_holder
->pr_res_key
;
579 if (dev
->dev_pr_res_holder
->pr_reg_nacl
!= sess
->se_node_acl
)
580 goto check_nonholder
;
582 if (dev
->dev_pr_res_holder
->isid_present_at_reg
) {
583 if (dev
->dev_pr_res_holder
->pr_reg_bin_isid
!=
584 sess
->sess_bin_isid
) {
585 isid_mismatch
= true;
586 goto check_nonholder
;
593 if (core_scsi3_pr_seq_non_holder(cmd
, pr_reg_type
, isid_mismatch
))
594 return TCM_RESERVATION_CONFLICT
;
598 static u32
core_scsi3_pr_generation(struct se_device
*dev
)
603 * PRGeneration field shall contain the value of a 32-bit wrapping
604 * counter mainted by the device server.
606 * Note that this is done regardless of Active Persist across
607 * Target PowerLoss (APTPL)
609 * See spc4r17 section 6.3.12 READ_KEYS service action
611 spin_lock(&dev
->dev_reservation_lock
);
612 prg
= dev
->t10_pr
.pr_generation
++;
613 spin_unlock(&dev
->dev_reservation_lock
);
618 static struct t10_pr_registration
*__core_scsi3_do_alloc_registration(
619 struct se_device
*dev
,
620 struct se_node_acl
*nacl
,
622 struct se_dev_entry
*dest_deve
,
629 struct t10_pr_registration
*pr_reg
;
631 pr_reg
= kmem_cache_zalloc(t10_pr_reg_cache
, GFP_ATOMIC
);
633 pr_err("Unable to allocate struct t10_pr_registration\n");
637 INIT_LIST_HEAD(&pr_reg
->pr_reg_list
);
638 INIT_LIST_HEAD(&pr_reg
->pr_reg_abort_list
);
639 INIT_LIST_HEAD(&pr_reg
->pr_reg_aptpl_list
);
640 INIT_LIST_HEAD(&pr_reg
->pr_reg_atp_list
);
641 INIT_LIST_HEAD(&pr_reg
->pr_reg_atp_mem_list
);
642 atomic_set(&pr_reg
->pr_res_holders
, 0);
643 pr_reg
->pr_reg_nacl
= nacl
;
645 * For destination registrations for ALL_TG_PT=1 and SPEC_I_PT=1,
646 * the se_dev_entry->pr_ref will have been already obtained by
647 * core_get_se_deve_from_rtpi() or __core_scsi3_alloc_registration().
649 * Otherwise, locate se_dev_entry now and obtain a reference until
650 * registration completes in __core_scsi3_add_registration().
653 pr_reg
->pr_reg_deve
= dest_deve
;
656 pr_reg
->pr_reg_deve
= target_nacl_find_deve(nacl
, mapped_lun
);
657 if (!pr_reg
->pr_reg_deve
) {
659 pr_err("Unable to locate PR deve %s mapped_lun: %llu\n",
660 nacl
->initiatorname
, mapped_lun
);
661 kmem_cache_free(t10_pr_reg_cache
, pr_reg
);
664 kref_get(&pr_reg
->pr_reg_deve
->pr_kref
);
667 pr_reg
->pr_res_mapped_lun
= mapped_lun
;
668 pr_reg
->pr_aptpl_target_lun
= lun
->unpacked_lun
;
669 pr_reg
->tg_pt_sep_rtpi
= lun
->lun_rtpi
;
670 pr_reg
->pr_res_key
= sa_res_key
;
671 pr_reg
->pr_reg_all_tg_pt
= all_tg_pt
;
672 pr_reg
->pr_reg_aptpl
= aptpl
;
674 * If an ISID value for this SCSI Initiator Port exists,
675 * save it to the registration now.
678 pr_reg
->pr_reg_bin_isid
= get_unaligned_be64(isid
);
679 snprintf(pr_reg
->pr_reg_isid
, PR_REG_ISID_LEN
, "%s", isid
);
680 pr_reg
->isid_present_at_reg
= 1;
686 static int core_scsi3_lunacl_depend_item(struct se_dev_entry
*);
687 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry
*);
690 * Function used for handling PR registrations for ALL_TG_PT=1 and ALL_TG_PT=0
693 static struct t10_pr_registration
*__core_scsi3_alloc_registration(
694 struct se_device
*dev
,
695 struct se_node_acl
*nacl
,
697 struct se_dev_entry
*deve
,
704 struct se_dev_entry
*deve_tmp
;
705 struct se_node_acl
*nacl_tmp
;
706 struct se_lun_acl
*lacl_tmp
;
707 struct se_lun
*lun_tmp
, *next
, *dest_lun
;
708 const struct target_core_fabric_ops
*tfo
= nacl
->se_tpg
->se_tpg_tfo
;
709 struct t10_pr_registration
*pr_reg
, *pr_reg_atp
, *pr_reg_tmp
, *pr_reg_tmp_safe
;
712 * Create a registration for the I_T Nexus upon which the
713 * PROUT REGISTER was received.
715 pr_reg
= __core_scsi3_do_alloc_registration(dev
, nacl
, lun
, deve
, mapped_lun
,
716 isid
, sa_res_key
, all_tg_pt
,
721 * Return pointer to pr_reg for ALL_TG_PT=0
726 * Create list of matching SCSI Initiator Port registrations
729 spin_lock(&dev
->se_port_lock
);
730 list_for_each_entry_safe(lun_tmp
, next
, &dev
->dev_sep_list
, lun_dev_link
) {
731 if (!percpu_ref_tryget_live(&lun_tmp
->lun_ref
))
733 spin_unlock(&dev
->se_port_lock
);
735 spin_lock(&lun_tmp
->lun_deve_lock
);
736 list_for_each_entry(deve_tmp
, &lun_tmp
->lun_deve_list
, lun_link
) {
738 * This pointer will be NULL for demo mode MappedLUNs
739 * that have not been make explicit via a ConfigFS
740 * MappedLUN group for the SCSI Initiator Node ACL.
742 if (!deve_tmp
->se_lun_acl
)
745 lacl_tmp
= rcu_dereference_check(deve_tmp
->se_lun_acl
,
746 lockdep_is_held(&lun_tmp
->lun_deve_lock
));
747 nacl_tmp
= lacl_tmp
->se_lun_nacl
;
749 * Skip the matching struct se_node_acl that is allocated
752 if (nacl
== nacl_tmp
)
755 * Only perform PR registrations for target ports on
756 * the same fabric module as the REGISTER w/ ALL_TG_PT=1
759 if (tfo
!= nacl_tmp
->se_tpg
->se_tpg_tfo
)
762 * Look for a matching Initiator Node ACL in ASCII format
764 if (strcmp(nacl
->initiatorname
, nacl_tmp
->initiatorname
))
767 kref_get(&deve_tmp
->pr_kref
);
768 spin_unlock(&lun_tmp
->lun_deve_lock
);
770 * Grab a configfs group dependency that is released
771 * for the exception path at label out: below, or upon
772 * completion of adding ALL_TG_PT=1 registrations in
773 * __core_scsi3_add_registration()
775 ret
= core_scsi3_lunacl_depend_item(deve_tmp
);
777 pr_err("core_scsi3_lunacl_depend"
779 percpu_ref_put(&lun_tmp
->lun_ref
);
780 kref_put(&deve_tmp
->pr_kref
, target_pr_kref_release
);
784 * Located a matching SCSI Initiator Port on a different
785 * port, allocate the pr_reg_atp and attach it to the
786 * pr_reg->pr_reg_atp_list that will be processed once
787 * the original *pr_reg is processed in
788 * __core_scsi3_add_registration()
790 dest_lun
= rcu_dereference_check(deve_tmp
->se_lun
,
791 kref_read(&deve_tmp
->pr_kref
) != 0);
793 pr_reg_atp
= __core_scsi3_do_alloc_registration(dev
,
794 nacl_tmp
, dest_lun
, deve_tmp
,
795 deve_tmp
->mapped_lun
, NULL
,
796 sa_res_key
, all_tg_pt
, aptpl
);
798 percpu_ref_put(&lun_tmp
->lun_ref
);
799 core_scsi3_lunacl_undepend_item(deve_tmp
);
803 list_add_tail(&pr_reg_atp
->pr_reg_atp_mem_list
,
804 &pr_reg
->pr_reg_atp_list
);
805 spin_lock(&lun_tmp
->lun_deve_lock
);
807 spin_unlock(&lun_tmp
->lun_deve_lock
);
809 spin_lock(&dev
->se_port_lock
);
810 percpu_ref_put(&lun_tmp
->lun_ref
);
812 spin_unlock(&dev
->se_port_lock
);
816 list_for_each_entry_safe(pr_reg_tmp
, pr_reg_tmp_safe
,
817 &pr_reg
->pr_reg_atp_list
, pr_reg_atp_mem_list
) {
818 list_del(&pr_reg_tmp
->pr_reg_atp_mem_list
);
819 core_scsi3_lunacl_undepend_item(pr_reg_tmp
->pr_reg_deve
);
820 kmem_cache_free(t10_pr_reg_cache
, pr_reg_tmp
);
822 kmem_cache_free(t10_pr_reg_cache
, pr_reg
);
826 int core_scsi3_alloc_aptpl_registration(
827 struct t10_reservation
*pr_tmpl
,
829 unsigned char *i_port
,
832 unsigned char *t_port
,
839 struct t10_pr_registration
*pr_reg
;
841 if (!i_port
|| !t_port
|| !sa_res_key
) {
842 pr_err("Illegal parameters for APTPL registration\n");
846 pr_reg
= kmem_cache_zalloc(t10_pr_reg_cache
, GFP_KERNEL
);
848 pr_err("Unable to allocate struct t10_pr_registration\n");
852 INIT_LIST_HEAD(&pr_reg
->pr_reg_list
);
853 INIT_LIST_HEAD(&pr_reg
->pr_reg_abort_list
);
854 INIT_LIST_HEAD(&pr_reg
->pr_reg_aptpl_list
);
855 INIT_LIST_HEAD(&pr_reg
->pr_reg_atp_list
);
856 INIT_LIST_HEAD(&pr_reg
->pr_reg_atp_mem_list
);
857 atomic_set(&pr_reg
->pr_res_holders
, 0);
858 pr_reg
->pr_reg_nacl
= NULL
;
859 pr_reg
->pr_reg_deve
= NULL
;
860 pr_reg
->pr_res_mapped_lun
= mapped_lun
;
861 pr_reg
->pr_aptpl_target_lun
= target_lun
;
862 pr_reg
->pr_res_key
= sa_res_key
;
863 pr_reg
->pr_reg_all_tg_pt
= all_tg_pt
;
864 pr_reg
->pr_reg_aptpl
= 1;
865 pr_reg
->pr_res_scope
= 0; /* Always LUN_SCOPE */
866 pr_reg
->pr_res_type
= type
;
868 * If an ISID value had been saved in APTPL metadata for this
869 * SCSI Initiator Port, restore it now.
872 pr_reg
->pr_reg_bin_isid
= get_unaligned_be64(isid
);
873 snprintf(pr_reg
->pr_reg_isid
, PR_REG_ISID_LEN
, "%s", isid
);
874 pr_reg
->isid_present_at_reg
= 1;
877 * Copy the i_port and t_port information from caller.
879 snprintf(pr_reg
->pr_iport
, PR_APTPL_MAX_IPORT_LEN
, "%s", i_port
);
880 snprintf(pr_reg
->pr_tport
, PR_APTPL_MAX_TPORT_LEN
, "%s", t_port
);
881 pr_reg
->pr_reg_tpgt
= tpgt
;
883 * Set pr_res_holder from caller, the pr_reg who is the reservation
884 * holder will get it's pointer set in core_scsi3_aptpl_reserve() once
885 * the Initiator Node LUN ACL from the fabric module is created for
888 pr_reg
->pr_res_holder
= res_holder
;
890 list_add_tail(&pr_reg
->pr_reg_aptpl_list
, &pr_tmpl
->aptpl_reg_list
);
891 pr_debug("SPC-3 PR APTPL Successfully added registration%s from"
892 " metadata\n", (res_holder
) ? "+reservation" : "");
896 static void core_scsi3_aptpl_reserve(
897 struct se_device
*dev
,
898 struct se_portal_group
*tpg
,
899 struct se_node_acl
*node_acl
,
900 struct t10_pr_registration
*pr_reg
)
902 char i_buf
[PR_REG_ISID_ID_LEN
];
904 memset(i_buf
, 0, PR_REG_ISID_ID_LEN
);
905 core_pr_dump_initiator_port(pr_reg
, i_buf
, PR_REG_ISID_ID_LEN
);
907 spin_lock(&dev
->dev_reservation_lock
);
908 dev
->dev_pr_res_holder
= pr_reg
;
909 spin_unlock(&dev
->dev_reservation_lock
);
911 pr_debug("SPC-3 PR [%s] Service Action: APTPL RESERVE created"
912 " new reservation holder TYPE: %s ALL_TG_PT: %d\n",
913 tpg
->se_tpg_tfo
->get_fabric_name(),
914 core_scsi3_pr_dump_type(pr_reg
->pr_res_type
),
915 (pr_reg
->pr_reg_all_tg_pt
) ? 1 : 0);
916 pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
917 tpg
->se_tpg_tfo
->get_fabric_name(), node_acl
->initiatorname
,
921 static void __core_scsi3_add_registration(struct se_device
*, struct se_node_acl
*,
922 struct t10_pr_registration
*, enum register_type
, int);
924 static int __core_scsi3_check_aptpl_registration(
925 struct se_device
*dev
,
926 struct se_portal_group
*tpg
,
929 struct se_node_acl
*nacl
,
932 struct t10_pr_registration
*pr_reg
, *pr_reg_tmp
;
933 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
934 unsigned char i_port
[PR_APTPL_MAX_IPORT_LEN
];
935 unsigned char t_port
[PR_APTPL_MAX_TPORT_LEN
];
938 memset(i_port
, 0, PR_APTPL_MAX_IPORT_LEN
);
939 memset(t_port
, 0, PR_APTPL_MAX_TPORT_LEN
);
941 * Copy Initiator Port information from struct se_node_acl
943 snprintf(i_port
, PR_APTPL_MAX_IPORT_LEN
, "%s", nacl
->initiatorname
);
944 snprintf(t_port
, PR_APTPL_MAX_TPORT_LEN
, "%s",
945 tpg
->se_tpg_tfo
->tpg_get_wwn(tpg
));
946 tpgt
= tpg
->se_tpg_tfo
->tpg_get_tag(tpg
);
948 * Look for the matching registrations+reservation from those
949 * created from APTPL metadata. Note that multiple registrations
950 * may exist for fabrics that use ISIDs in their SCSI Initiator Port
953 spin_lock(&pr_tmpl
->aptpl_reg_lock
);
954 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
, &pr_tmpl
->aptpl_reg_list
,
957 if (!strcmp(pr_reg
->pr_iport
, i_port
) &&
958 (pr_reg
->pr_res_mapped_lun
== mapped_lun
) &&
959 !(strcmp(pr_reg
->pr_tport
, t_port
)) &&
960 (pr_reg
->pr_reg_tpgt
== tpgt
) &&
961 (pr_reg
->pr_aptpl_target_lun
== target_lun
)) {
963 * Obtain the ->pr_reg_deve pointer + reference, that
964 * is released by __core_scsi3_add_registration() below.
967 pr_reg
->pr_reg_deve
= target_nacl_find_deve(nacl
, mapped_lun
);
968 if (!pr_reg
->pr_reg_deve
) {
969 pr_err("Unable to locate PR APTPL %s mapped_lun:"
970 " %llu\n", nacl
->initiatorname
, mapped_lun
);
974 kref_get(&pr_reg
->pr_reg_deve
->pr_kref
);
977 pr_reg
->pr_reg_nacl
= nacl
;
978 pr_reg
->tg_pt_sep_rtpi
= lun
->lun_rtpi
;
979 list_del(&pr_reg
->pr_reg_aptpl_list
);
980 spin_unlock(&pr_tmpl
->aptpl_reg_lock
);
982 * At this point all of the pointers in *pr_reg will
983 * be setup, so go ahead and add the registration.
985 __core_scsi3_add_registration(dev
, nacl
, pr_reg
, 0, 0);
987 * If this registration is the reservation holder,
988 * make that happen now..
990 if (pr_reg
->pr_res_holder
)
991 core_scsi3_aptpl_reserve(dev
, tpg
,
994 * Reenable pr_aptpl_active to accept new metadata
995 * updates once the SCSI device is active again..
997 spin_lock(&pr_tmpl
->aptpl_reg_lock
);
998 pr_tmpl
->pr_aptpl_active
= 1;
1001 spin_unlock(&pr_tmpl
->aptpl_reg_lock
);
1006 int core_scsi3_check_aptpl_registration(
1007 struct se_device
*dev
,
1008 struct se_portal_group
*tpg
,
1010 struct se_node_acl
*nacl
,
1013 if (dev
->dev_reservation_flags
& DRF_SPC2_RESERVATIONS
)
1016 return __core_scsi3_check_aptpl_registration(dev
, tpg
, lun
,
1017 lun
->unpacked_lun
, nacl
,
1021 static void __core_scsi3_dump_registration(
1022 const struct target_core_fabric_ops
*tfo
,
1023 struct se_device
*dev
,
1024 struct se_node_acl
*nacl
,
1025 struct t10_pr_registration
*pr_reg
,
1026 enum register_type register_type
)
1028 struct se_portal_group
*se_tpg
= nacl
->se_tpg
;
1029 char i_buf
[PR_REG_ISID_ID_LEN
];
1031 memset(&i_buf
[0], 0, PR_REG_ISID_ID_LEN
);
1032 core_pr_dump_initiator_port(pr_reg
, i_buf
, PR_REG_ISID_ID_LEN
);
1034 pr_debug("SPC-3 PR [%s] Service Action: REGISTER%s Initiator"
1035 " Node: %s%s\n", tfo
->get_fabric_name(), (register_type
== REGISTER_AND_MOVE
) ?
1036 "_AND_MOVE" : (register_type
== REGISTER_AND_IGNORE_EXISTING_KEY
) ?
1037 "_AND_IGNORE_EXISTING_KEY" : "", nacl
->initiatorname
,
1039 pr_debug("SPC-3 PR [%s] registration on Target Port: %s,0x%04x\n",
1040 tfo
->get_fabric_name(), tfo
->tpg_get_wwn(se_tpg
),
1041 tfo
->tpg_get_tag(se_tpg
));
1042 pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
1043 " Port(s)\n", tfo
->get_fabric_name(),
1044 (pr_reg
->pr_reg_all_tg_pt
) ? "ALL" : "SINGLE",
1045 dev
->transport
->name
);
1046 pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
1047 " 0x%08x APTPL: %d\n", tfo
->get_fabric_name(),
1048 pr_reg
->pr_res_key
, pr_reg
->pr_res_generation
,
1049 pr_reg
->pr_reg_aptpl
);
1052 static void __core_scsi3_add_registration(
1053 struct se_device
*dev
,
1054 struct se_node_acl
*nacl
,
1055 struct t10_pr_registration
*pr_reg
,
1056 enum register_type register_type
,
1059 const struct target_core_fabric_ops
*tfo
= nacl
->se_tpg
->se_tpg_tfo
;
1060 struct t10_pr_registration
*pr_reg_tmp
, *pr_reg_tmp_safe
;
1061 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
1062 struct se_dev_entry
*deve
;
1065 * Increment PRgeneration counter for struct se_device upon a successful
1066 * REGISTER, see spc4r17 section 6.3.2 READ_KEYS service action
1068 * Also, when register_move = 1 for PROUT REGISTER_AND_MOVE service
1069 * action, the struct se_device->dev_reservation_lock will already be held,
1070 * so we do not call core_scsi3_pr_generation() which grabs the lock
1073 pr_reg
->pr_res_generation
= (register_move
) ?
1074 dev
->t10_pr
.pr_generation
++ :
1075 core_scsi3_pr_generation(dev
);
1077 spin_lock(&pr_tmpl
->registration_lock
);
1078 list_add_tail(&pr_reg
->pr_reg_list
, &pr_tmpl
->registration_list
);
1080 __core_scsi3_dump_registration(tfo
, dev
, nacl
, pr_reg
, register_type
);
1081 spin_unlock(&pr_tmpl
->registration_lock
);
1083 * Skip extra processing for ALL_TG_PT=0 or REGISTER_AND_MOVE.
1085 if (!pr_reg
->pr_reg_all_tg_pt
|| register_move
)
1088 * Walk pr_reg->pr_reg_atp_list and add registrations for ALL_TG_PT=1
1089 * allocated in __core_scsi3_alloc_registration()
1091 list_for_each_entry_safe(pr_reg_tmp
, pr_reg_tmp_safe
,
1092 &pr_reg
->pr_reg_atp_list
, pr_reg_atp_mem_list
) {
1093 struct se_node_acl
*nacl_tmp
= pr_reg_tmp
->pr_reg_nacl
;
1095 list_del(&pr_reg_tmp
->pr_reg_atp_mem_list
);
1097 pr_reg_tmp
->pr_res_generation
= core_scsi3_pr_generation(dev
);
1099 spin_lock(&pr_tmpl
->registration_lock
);
1100 list_add_tail(&pr_reg_tmp
->pr_reg_list
,
1101 &pr_tmpl
->registration_list
);
1103 __core_scsi3_dump_registration(tfo
, dev
, nacl_tmp
, pr_reg_tmp
,
1105 spin_unlock(&pr_tmpl
->registration_lock
);
1107 * Drop configfs group dependency reference and deve->pr_kref
1108 * obtained from __core_scsi3_alloc_registration() code.
1111 deve
= pr_reg_tmp
->pr_reg_deve
;
1113 set_bit(DEF_PR_REG_ACTIVE
, &deve
->deve_flags
);
1114 core_scsi3_lunacl_undepend_item(deve
);
1115 pr_reg_tmp
->pr_reg_deve
= NULL
;
1121 * Drop deve->pr_kref obtained in __core_scsi3_do_alloc_registration()
1124 deve
= pr_reg
->pr_reg_deve
;
1126 set_bit(DEF_PR_REG_ACTIVE
, &deve
->deve_flags
);
1127 kref_put(&deve
->pr_kref
, target_pr_kref_release
);
1128 pr_reg
->pr_reg_deve
= NULL
;
1133 static int core_scsi3_alloc_registration(
1134 struct se_device
*dev
,
1135 struct se_node_acl
*nacl
,
1137 struct se_dev_entry
*deve
,
1139 unsigned char *isid
,
1143 enum register_type register_type
,
1146 struct t10_pr_registration
*pr_reg
;
1148 pr_reg
= __core_scsi3_alloc_registration(dev
, nacl
, lun
, deve
, mapped_lun
,
1149 isid
, sa_res_key
, all_tg_pt
,
1154 __core_scsi3_add_registration(dev
, nacl
, pr_reg
,
1155 register_type
, register_move
);
1159 static struct t10_pr_registration
*__core_scsi3_locate_pr_reg(
1160 struct se_device
*dev
,
1161 struct se_node_acl
*nacl
,
1162 unsigned char *isid
)
1164 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
1165 struct t10_pr_registration
*pr_reg
, *pr_reg_tmp
;
1166 struct se_portal_group
*tpg
;
1168 spin_lock(&pr_tmpl
->registration_lock
);
1169 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
,
1170 &pr_tmpl
->registration_list
, pr_reg_list
) {
1172 * First look for a matching struct se_node_acl
1174 if (pr_reg
->pr_reg_nacl
!= nacl
)
1177 tpg
= pr_reg
->pr_reg_nacl
->se_tpg
;
1179 * If this registration does NOT contain a fabric provided
1180 * ISID, then we have found a match.
1182 if (!pr_reg
->isid_present_at_reg
) {
1184 * Determine if this SCSI device server requires that
1185 * SCSI Intiatior TransportID w/ ISIDs is enforced
1186 * for fabric modules (iSCSI) requiring them.
1188 if (tpg
->se_tpg_tfo
->sess_get_initiator_sid
!= NULL
) {
1189 if (dev
->dev_attrib
.enforce_pr_isids
)
1192 atomic_inc_mb(&pr_reg
->pr_res_holders
);
1193 spin_unlock(&pr_tmpl
->registration_lock
);
1197 * If the *pr_reg contains a fabric defined ISID for multi-value
1198 * SCSI Initiator Port TransportIDs, then we expect a valid
1199 * matching ISID to be provided by the local SCSI Initiator Port.
1203 if (strcmp(isid
, pr_reg
->pr_reg_isid
))
1206 atomic_inc_mb(&pr_reg
->pr_res_holders
);
1207 spin_unlock(&pr_tmpl
->registration_lock
);
1210 spin_unlock(&pr_tmpl
->registration_lock
);
1215 static struct t10_pr_registration
*core_scsi3_locate_pr_reg(
1216 struct se_device
*dev
,
1217 struct se_node_acl
*nacl
,
1218 struct se_session
*sess
)
1220 struct se_portal_group
*tpg
= nacl
->se_tpg
;
1221 unsigned char buf
[PR_REG_ISID_LEN
], *isid_ptr
= NULL
;
1223 if (tpg
->se_tpg_tfo
->sess_get_initiator_sid
!= NULL
) {
1224 memset(&buf
[0], 0, PR_REG_ISID_LEN
);
1225 tpg
->se_tpg_tfo
->sess_get_initiator_sid(sess
, &buf
[0],
1230 return __core_scsi3_locate_pr_reg(dev
, nacl
, isid_ptr
);
1233 static void core_scsi3_put_pr_reg(struct t10_pr_registration
*pr_reg
)
1235 atomic_dec_mb(&pr_reg
->pr_res_holders
);
1238 static int core_scsi3_check_implicit_release(
1239 struct se_device
*dev
,
1240 struct t10_pr_registration
*pr_reg
)
1242 struct se_node_acl
*nacl
= pr_reg
->pr_reg_nacl
;
1243 struct t10_pr_registration
*pr_res_holder
;
1246 spin_lock(&dev
->dev_reservation_lock
);
1247 pr_res_holder
= dev
->dev_pr_res_holder
;
1248 if (!pr_res_holder
) {
1249 spin_unlock(&dev
->dev_reservation_lock
);
1252 if (pr_res_holder
== pr_reg
) {
1254 * Perform an implicit RELEASE if the registration that
1255 * is being released is holding the reservation.
1257 * From spc4r17, section 5.7.11.1:
1259 * e) If the I_T nexus is the persistent reservation holder
1260 * and the persistent reservation is not an all registrants
1261 * type, then a PERSISTENT RESERVE OUT command with REGISTER
1262 * service action or REGISTER AND IGNORE EXISTING KEY
1263 * service action with the SERVICE ACTION RESERVATION KEY
1264 * field set to zero (see 5.7.11.3).
1266 __core_scsi3_complete_pro_release(dev
, nacl
, pr_reg
, 0, 1);
1269 * For 'All Registrants' reservation types, all existing
1270 * registrations are still processed as reservation holders
1271 * in core_scsi3_pr_seq_non_holder() after the initial
1272 * reservation holder is implicitly released here.
1274 } else if (pr_reg
->pr_reg_all_tg_pt
&&
1275 (!strcmp(pr_res_holder
->pr_reg_nacl
->initiatorname
,
1276 pr_reg
->pr_reg_nacl
->initiatorname
)) &&
1277 (pr_res_holder
->pr_res_key
== pr_reg
->pr_res_key
)) {
1278 pr_err("SPC-3 PR: Unable to perform ALL_TG_PT=1"
1279 " UNREGISTER while existing reservation with matching"
1280 " key 0x%016Lx is present from another SCSI Initiator"
1281 " Port\n", pr_reg
->pr_res_key
);
1284 spin_unlock(&dev
->dev_reservation_lock
);
1290 * Called with struct t10_reservation->registration_lock held.
1292 static void __core_scsi3_free_registration(
1293 struct se_device
*dev
,
1294 struct t10_pr_registration
*pr_reg
,
1295 struct list_head
*preempt_and_abort_list
,
1297 __releases(&pr_tmpl
->registration_lock
)
1298 __acquires(&pr_tmpl
->registration_lock
)
1300 const struct target_core_fabric_ops
*tfo
=
1301 pr_reg
->pr_reg_nacl
->se_tpg
->se_tpg_tfo
;
1302 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
1303 struct se_node_acl
*nacl
= pr_reg
->pr_reg_nacl
;
1304 struct se_dev_entry
*deve
;
1305 char i_buf
[PR_REG_ISID_ID_LEN
];
1307 memset(i_buf
, 0, PR_REG_ISID_ID_LEN
);
1308 core_pr_dump_initiator_port(pr_reg
, i_buf
, PR_REG_ISID_ID_LEN
);
1310 if (!list_empty(&pr_reg
->pr_reg_list
))
1311 list_del(&pr_reg
->pr_reg_list
);
1313 * Caller accessing *pr_reg using core_scsi3_locate_pr_reg(),
1314 * so call core_scsi3_put_pr_reg() to decrement our reference.
1317 core_scsi3_put_pr_reg(pr_reg
);
1319 spin_unlock(&pr_tmpl
->registration_lock
);
1321 * Wait until all reference from any other I_T nexuses for this
1322 * *pr_reg have been released. Because list_del() is called above,
1323 * the last core_scsi3_put_pr_reg(pr_reg) will release this reference
1324 * count back to zero, and we release *pr_reg.
1326 while (atomic_read(&pr_reg
->pr_res_holders
) != 0) {
1327 pr_debug("SPC-3 PR [%s] waiting for pr_res_holders\n",
1328 tfo
->get_fabric_name());
1333 deve
= target_nacl_find_deve(nacl
, pr_reg
->pr_res_mapped_lun
);
1335 clear_bit(DEF_PR_REG_ACTIVE
, &deve
->deve_flags
);
1338 spin_lock(&pr_tmpl
->registration_lock
);
1339 pr_debug("SPC-3 PR [%s] Service Action: UNREGISTER Initiator"
1340 " Node: %s%s\n", tfo
->get_fabric_name(),
1341 pr_reg
->pr_reg_nacl
->initiatorname
,
1343 pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
1344 " Port(s)\n", tfo
->get_fabric_name(),
1345 (pr_reg
->pr_reg_all_tg_pt
) ? "ALL" : "SINGLE",
1346 dev
->transport
->name
);
1347 pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
1348 " 0x%08x\n", tfo
->get_fabric_name(), pr_reg
->pr_res_key
,
1349 pr_reg
->pr_res_generation
);
1351 if (!preempt_and_abort_list
) {
1352 pr_reg
->pr_reg_deve
= NULL
;
1353 pr_reg
->pr_reg_nacl
= NULL
;
1354 kmem_cache_free(t10_pr_reg_cache
, pr_reg
);
1358 * For PREEMPT_AND_ABORT, the list of *pr_reg in preempt_and_abort_list
1359 * are released once the ABORT_TASK_SET has completed..
1361 list_add_tail(&pr_reg
->pr_reg_abort_list
, preempt_and_abort_list
);
1364 void core_scsi3_free_pr_reg_from_nacl(
1365 struct se_device
*dev
,
1366 struct se_node_acl
*nacl
)
1368 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
1369 struct t10_pr_registration
*pr_reg
, *pr_reg_tmp
, *pr_res_holder
;
1370 bool free_reg
= false;
1372 * If the passed se_node_acl matches the reservation holder,
1373 * release the reservation.
1375 spin_lock(&dev
->dev_reservation_lock
);
1376 pr_res_holder
= dev
->dev_pr_res_holder
;
1377 if ((pr_res_holder
!= NULL
) &&
1378 (pr_res_holder
->pr_reg_nacl
== nacl
)) {
1379 __core_scsi3_complete_pro_release(dev
, nacl
, pr_res_holder
, 0, 1);
1382 spin_unlock(&dev
->dev_reservation_lock
);
1384 * Release any registration associated with the struct se_node_acl.
1386 spin_lock(&pr_tmpl
->registration_lock
);
1387 if (pr_res_holder
&& free_reg
)
1388 __core_scsi3_free_registration(dev
, pr_res_holder
, NULL
, 0);
1390 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
,
1391 &pr_tmpl
->registration_list
, pr_reg_list
) {
1393 if (pr_reg
->pr_reg_nacl
!= nacl
)
1396 __core_scsi3_free_registration(dev
, pr_reg
, NULL
, 0);
1398 spin_unlock(&pr_tmpl
->registration_lock
);
1401 void core_scsi3_free_all_registrations(
1402 struct se_device
*dev
)
1404 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
1405 struct t10_pr_registration
*pr_reg
, *pr_reg_tmp
, *pr_res_holder
;
1407 spin_lock(&dev
->dev_reservation_lock
);
1408 pr_res_holder
= dev
->dev_pr_res_holder
;
1409 if (pr_res_holder
!= NULL
) {
1410 struct se_node_acl
*pr_res_nacl
= pr_res_holder
->pr_reg_nacl
;
1411 __core_scsi3_complete_pro_release(dev
, pr_res_nacl
,
1412 pr_res_holder
, 0, 0);
1414 spin_unlock(&dev
->dev_reservation_lock
);
1416 spin_lock(&pr_tmpl
->registration_lock
);
1417 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
,
1418 &pr_tmpl
->registration_list
, pr_reg_list
) {
1420 __core_scsi3_free_registration(dev
, pr_reg
, NULL
, 0);
1422 spin_unlock(&pr_tmpl
->registration_lock
);
1424 spin_lock(&pr_tmpl
->aptpl_reg_lock
);
1425 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
, &pr_tmpl
->aptpl_reg_list
,
1426 pr_reg_aptpl_list
) {
1427 list_del(&pr_reg
->pr_reg_aptpl_list
);
1428 kmem_cache_free(t10_pr_reg_cache
, pr_reg
);
1430 spin_unlock(&pr_tmpl
->aptpl_reg_lock
);
1433 static int core_scsi3_tpg_depend_item(struct se_portal_group
*tpg
)
1435 return target_depend_item(&tpg
->tpg_group
.cg_item
);
1438 static void core_scsi3_tpg_undepend_item(struct se_portal_group
*tpg
)
1440 target_undepend_item(&tpg
->tpg_group
.cg_item
);
1441 atomic_dec_mb(&tpg
->tpg_pr_ref_count
);
1444 static int core_scsi3_nodeacl_depend_item(struct se_node_acl
*nacl
)
1446 if (nacl
->dynamic_node_acl
)
1448 return target_depend_item(&nacl
->acl_group
.cg_item
);
1451 static void core_scsi3_nodeacl_undepend_item(struct se_node_acl
*nacl
)
1453 if (!nacl
->dynamic_node_acl
)
1454 target_undepend_item(&nacl
->acl_group
.cg_item
);
1455 atomic_dec_mb(&nacl
->acl_pr_ref_count
);
1458 static int core_scsi3_lunacl_depend_item(struct se_dev_entry
*se_deve
)
1460 struct se_lun_acl
*lun_acl
;
1463 * For nacl->dynamic_node_acl=1
1465 lun_acl
= rcu_dereference_check(se_deve
->se_lun_acl
,
1466 kref_read(&se_deve
->pr_kref
) != 0);
1470 return target_depend_item(&lun_acl
->se_lun_group
.cg_item
);
1473 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry
*se_deve
)
1475 struct se_lun_acl
*lun_acl
;
1478 * For nacl->dynamic_node_acl=1
1480 lun_acl
= rcu_dereference_check(se_deve
->se_lun_acl
,
1481 kref_read(&se_deve
->pr_kref
) != 0);
1483 kref_put(&se_deve
->pr_kref
, target_pr_kref_release
);
1487 target_undepend_item(&lun_acl
->se_lun_group
.cg_item
);
1488 kref_put(&se_deve
->pr_kref
, target_pr_kref_release
);
1491 static sense_reason_t
1492 core_scsi3_decode_spec_i_port(
1494 struct se_portal_group
*tpg
,
1495 unsigned char *l_isid
,
1500 struct se_device
*dev
= cmd
->se_dev
;
1501 struct se_portal_group
*dest_tpg
= NULL
, *tmp_tpg
;
1502 struct se_session
*se_sess
= cmd
->se_sess
;
1503 struct se_node_acl
*dest_node_acl
= NULL
;
1504 struct se_dev_entry
*dest_se_deve
= NULL
;
1505 struct t10_pr_registration
*dest_pr_reg
, *local_pr_reg
, *pr_reg_e
;
1506 struct t10_pr_registration
*pr_reg_tmp
, *pr_reg_tmp_safe
;
1507 LIST_HEAD(tid_dest_list
);
1508 struct pr_transport_id_holder
*tidh_new
, *tidh
, *tidh_tmp
;
1509 unsigned char *buf
, *ptr
, proto_ident
;
1510 const unsigned char *i_str
= NULL
;
1511 char *iport_ptr
= NULL
, i_buf
[PR_REG_ISID_ID_LEN
];
1513 u32 tpdl
, tid_len
= 0;
1517 * Allocate a struct pr_transport_id_holder and setup the
1518 * local_node_acl pointer and add to struct list_head tid_dest_list
1519 * for add registration processing in the loop of tid_dest_list below.
1521 tidh_new
= kzalloc(sizeof(struct pr_transport_id_holder
), GFP_KERNEL
);
1523 pr_err("Unable to allocate tidh_new\n");
1524 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1526 INIT_LIST_HEAD(&tidh_new
->dest_list
);
1527 tidh_new
->dest_tpg
= tpg
;
1528 tidh_new
->dest_node_acl
= se_sess
->se_node_acl
;
1530 local_pr_reg
= __core_scsi3_alloc_registration(cmd
->se_dev
,
1531 se_sess
->se_node_acl
, cmd
->se_lun
,
1532 NULL
, cmd
->orig_fe_lun
, l_isid
,
1533 sa_res_key
, all_tg_pt
, aptpl
);
1534 if (!local_pr_reg
) {
1536 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1538 tidh_new
->dest_pr_reg
= local_pr_reg
;
1540 * The local I_T nexus does not hold any configfs dependances,
1541 * so we set tidh_new->dest_se_deve to NULL to prevent the
1542 * configfs_undepend_item() calls in the tid_dest_list loops below.
1544 tidh_new
->dest_se_deve
= NULL
;
1545 list_add_tail(&tidh_new
->dest_list
, &tid_dest_list
);
1547 if (cmd
->data_length
< 28) {
1548 pr_warn("SPC-PR: Received PR OUT parameter list"
1549 " length too small: %u\n", cmd
->data_length
);
1550 ret
= TCM_INVALID_PARAMETER_LIST
;
1554 buf
= transport_kmap_data_sg(cmd
);
1556 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1561 * For a PERSISTENT RESERVE OUT specify initiator ports payload,
1562 * first extract TransportID Parameter Data Length, and make sure
1563 * the value matches up to the SCSI expected data transfer length.
1565 tpdl
= get_unaligned_be32(&buf
[24]);
1567 if ((tpdl
+ 28) != cmd
->data_length
) {
1568 pr_err("SPC-3 PR: Illegal tpdl: %u + 28 byte header"
1569 " does not equal CDB data_length: %u\n", tpdl
,
1571 ret
= TCM_INVALID_PARAMETER_LIST
;
1575 * Start processing the received transport IDs using the
1576 * receiving I_T Nexus portal's fabric dependent methods to
1577 * obtain the SCSI Initiator Port/Device Identifiers.
1582 struct se_lun
*dest_lun
, *tmp_lun
;
1584 proto_ident
= (ptr
[0] & 0x0f);
1587 spin_lock(&dev
->se_port_lock
);
1588 list_for_each_entry(tmp_lun
, &dev
->dev_sep_list
, lun_dev_link
) {
1589 tmp_tpg
= tmp_lun
->lun_tpg
;
1592 * Look for the matching proto_ident provided by
1593 * the received TransportID
1595 if (tmp_tpg
->proto_id
!= proto_ident
)
1597 dest_rtpi
= tmp_lun
->lun_rtpi
;
1599 i_str
= target_parse_pr_out_transport_id(tmp_tpg
,
1600 (const char *)ptr
, &tid_len
, &iport_ptr
);
1604 atomic_inc_mb(&tmp_tpg
->tpg_pr_ref_count
);
1605 spin_unlock(&dev
->se_port_lock
);
1607 if (core_scsi3_tpg_depend_item(tmp_tpg
)) {
1608 pr_err(" core_scsi3_tpg_depend_item()"
1610 atomic_dec_mb(&tmp_tpg
->tpg_pr_ref_count
);
1611 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1615 * Locate the destination initiator ACL to be registered
1616 * from the decoded fabric module specific TransportID
1619 mutex_lock(&tmp_tpg
->acl_node_mutex
);
1620 dest_node_acl
= __core_tpg_get_initiator_node_acl(
1623 atomic_inc_mb(&dest_node_acl
->acl_pr_ref_count
);
1624 mutex_unlock(&tmp_tpg
->acl_node_mutex
);
1626 if (!dest_node_acl
) {
1627 core_scsi3_tpg_undepend_item(tmp_tpg
);
1628 spin_lock(&dev
->se_port_lock
);
1632 if (core_scsi3_nodeacl_depend_item(dest_node_acl
)) {
1633 pr_err("configfs_depend_item() failed"
1634 " for dest_node_acl->acl_group\n");
1635 atomic_dec_mb(&dest_node_acl
->acl_pr_ref_count
);
1636 core_scsi3_tpg_undepend_item(tmp_tpg
);
1637 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1642 pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node:"
1643 " %s Port RTPI: %hu\n",
1644 dest_tpg
->se_tpg_tfo
->get_fabric_name(),
1645 dest_node_acl
->initiatorname
, dest_rtpi
);
1647 spin_lock(&dev
->se_port_lock
);
1650 spin_unlock(&dev
->se_port_lock
);
1653 pr_err("SPC-3 PR SPEC_I_PT: Unable to locate"
1655 ret
= TCM_INVALID_PARAMETER_LIST
;
1659 pr_debug("SPC-3 PR SPEC_I_PT: Got %s data_length: %u tpdl: %u"
1660 " tid_len: %d for %s + %s\n",
1661 dest_tpg
->se_tpg_tfo
->get_fabric_name(), cmd
->data_length
,
1662 tpdl
, tid_len
, i_str
, iport_ptr
);
1664 if (tid_len
> tpdl
) {
1665 pr_err("SPC-3 PR SPEC_I_PT: Illegal tid_len:"
1666 " %u for Transport ID: %s\n", tid_len
, ptr
);
1667 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
1668 core_scsi3_tpg_undepend_item(dest_tpg
);
1669 ret
= TCM_INVALID_PARAMETER_LIST
;
1673 * Locate the desintation struct se_dev_entry pointer for matching
1674 * RELATIVE TARGET PORT IDENTIFIER on the receiving I_T Nexus
1677 dest_se_deve
= core_get_se_deve_from_rtpi(dest_node_acl
,
1679 if (!dest_se_deve
) {
1680 pr_err("Unable to locate %s dest_se_deve"
1681 " from destination RTPI: %hu\n",
1682 dest_tpg
->se_tpg_tfo
->get_fabric_name(),
1685 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
1686 core_scsi3_tpg_undepend_item(dest_tpg
);
1687 ret
= TCM_INVALID_PARAMETER_LIST
;
1691 if (core_scsi3_lunacl_depend_item(dest_se_deve
)) {
1692 pr_err("core_scsi3_lunacl_depend_item()"
1694 kref_put(&dest_se_deve
->pr_kref
, target_pr_kref_release
);
1695 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
1696 core_scsi3_tpg_undepend_item(dest_tpg
);
1697 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1701 pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node: %s"
1702 " dest_se_deve mapped_lun: %llu\n",
1703 dest_tpg
->se_tpg_tfo
->get_fabric_name(),
1704 dest_node_acl
->initiatorname
, dest_se_deve
->mapped_lun
);
1707 * Skip any TransportIDs that already have a registration for
1710 pr_reg_e
= __core_scsi3_locate_pr_reg(dev
, dest_node_acl
,
1713 core_scsi3_put_pr_reg(pr_reg_e
);
1714 core_scsi3_lunacl_undepend_item(dest_se_deve
);
1715 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
1716 core_scsi3_tpg_undepend_item(dest_tpg
);
1723 * Allocate a struct pr_transport_id_holder and setup
1724 * the dest_node_acl and dest_se_deve pointers for the
1727 tidh_new
= kzalloc(sizeof(struct pr_transport_id_holder
),
1730 pr_err("Unable to allocate tidh_new\n");
1731 core_scsi3_lunacl_undepend_item(dest_se_deve
);
1732 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
1733 core_scsi3_tpg_undepend_item(dest_tpg
);
1734 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1737 INIT_LIST_HEAD(&tidh_new
->dest_list
);
1738 tidh_new
->dest_tpg
= dest_tpg
;
1739 tidh_new
->dest_node_acl
= dest_node_acl
;
1740 tidh_new
->dest_se_deve
= dest_se_deve
;
1743 * Allocate, but do NOT add the registration for the
1744 * TransportID referenced SCSI Initiator port. This
1745 * done because of the following from spc4r17 in section
1746 * 6.14.3 wrt SPEC_I_PT:
1748 * "If a registration fails for any initiator port (e.g., if th
1749 * logical unit does not have enough resources available to
1750 * hold the registration information), no registrations shall be
1751 * made, and the command shall be terminated with
1752 * CHECK CONDITION status."
1754 * That means we call __core_scsi3_alloc_registration() here,
1755 * and then call __core_scsi3_add_registration() in the
1756 * 2nd loop which will never fail.
1758 dest_lun
= rcu_dereference_check(dest_se_deve
->se_lun
,
1759 kref_read(&dest_se_deve
->pr_kref
) != 0);
1761 dest_pr_reg
= __core_scsi3_alloc_registration(cmd
->se_dev
,
1762 dest_node_acl
, dest_lun
, dest_se_deve
,
1763 dest_se_deve
->mapped_lun
, iport_ptr
,
1764 sa_res_key
, all_tg_pt
, aptpl
);
1766 core_scsi3_lunacl_undepend_item(dest_se_deve
);
1767 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
1768 core_scsi3_tpg_undepend_item(dest_tpg
);
1770 ret
= TCM_INVALID_PARAMETER_LIST
;
1773 tidh_new
->dest_pr_reg
= dest_pr_reg
;
1774 list_add_tail(&tidh_new
->dest_list
, &tid_dest_list
);
1782 transport_kunmap_data_sg(cmd
);
1785 * Go ahead and create a registrations from tid_dest_list for the
1786 * SPEC_I_PT provided TransportID for the *tidh referenced dest_node_acl
1789 * The SA Reservation Key from the PROUT is set for the
1790 * registration, and ALL_TG_PT is also passed. ALL_TG_PT=1
1791 * means that the TransportID Initiator port will be
1792 * registered on all of the target ports in the SCSI target device
1793 * ALL_TG_PT=0 means the registration will only be for the
1794 * SCSI target port the PROUT REGISTER with SPEC_I_PT=1
1797 list_for_each_entry_safe(tidh
, tidh_tmp
, &tid_dest_list
, dest_list
) {
1798 dest_tpg
= tidh
->dest_tpg
;
1799 dest_node_acl
= tidh
->dest_node_acl
;
1800 dest_se_deve
= tidh
->dest_se_deve
;
1801 dest_pr_reg
= tidh
->dest_pr_reg
;
1803 list_del(&tidh
->dest_list
);
1806 memset(i_buf
, 0, PR_REG_ISID_ID_LEN
);
1807 core_pr_dump_initiator_port(dest_pr_reg
, i_buf
, PR_REG_ISID_ID_LEN
);
1809 __core_scsi3_add_registration(cmd
->se_dev
, dest_node_acl
,
1812 pr_debug("SPC-3 PR [%s] SPEC_I_PT: Successfully"
1813 " registered Transport ID for Node: %s%s Mapped LUN:"
1814 " %llu\n", dest_tpg
->se_tpg_tfo
->get_fabric_name(),
1815 dest_node_acl
->initiatorname
, i_buf
, (dest_se_deve
) ?
1816 dest_se_deve
->mapped_lun
: 0);
1818 if (!dest_se_deve
) {
1819 kref_put(&local_pr_reg
->pr_reg_deve
->pr_kref
,
1820 target_pr_kref_release
);
1823 core_scsi3_lunacl_undepend_item(dest_se_deve
);
1824 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
1825 core_scsi3_tpg_undepend_item(dest_tpg
);
1830 transport_kunmap_data_sg(cmd
);
1833 * For the failure case, release everything from tid_dest_list
1834 * including *dest_pr_reg and the configfs dependances..
1836 list_for_each_entry_safe(tidh
, tidh_tmp
, &tid_dest_list
, dest_list
) {
1837 dest_tpg
= tidh
->dest_tpg
;
1838 dest_node_acl
= tidh
->dest_node_acl
;
1839 dest_se_deve
= tidh
->dest_se_deve
;
1840 dest_pr_reg
= tidh
->dest_pr_reg
;
1842 list_del(&tidh
->dest_list
);
1845 * Release any extra ALL_TG_PT=1 registrations for
1846 * the SPEC_I_PT=1 case.
1848 list_for_each_entry_safe(pr_reg_tmp
, pr_reg_tmp_safe
,
1849 &dest_pr_reg
->pr_reg_atp_list
,
1850 pr_reg_atp_mem_list
) {
1851 list_del(&pr_reg_tmp
->pr_reg_atp_mem_list
);
1852 core_scsi3_lunacl_undepend_item(pr_reg_tmp
->pr_reg_deve
);
1853 kmem_cache_free(t10_pr_reg_cache
, pr_reg_tmp
);
1856 kmem_cache_free(t10_pr_reg_cache
, dest_pr_reg
);
1858 if (!dest_se_deve
) {
1859 kref_put(&local_pr_reg
->pr_reg_deve
->pr_kref
,
1860 target_pr_kref_release
);
1863 core_scsi3_lunacl_undepend_item(dest_se_deve
);
1864 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
1865 core_scsi3_tpg_undepend_item(dest_tpg
);
1870 static int core_scsi3_update_aptpl_buf(
1871 struct se_device
*dev
,
1873 u32 pr_aptpl_buf_len
)
1875 struct se_portal_group
*tpg
;
1876 struct t10_pr_registration
*pr_reg
;
1877 unsigned char tmp
[512], isid_buf
[32];
1882 spin_lock(&dev
->dev_reservation_lock
);
1883 spin_lock(&dev
->t10_pr
.registration_lock
);
1885 * Walk the registration list..
1887 list_for_each_entry(pr_reg
, &dev
->t10_pr
.registration_list
,
1892 tpg
= pr_reg
->pr_reg_nacl
->se_tpg
;
1894 * Write out any ISID value to APTPL metadata that was included
1895 * in the original registration.
1897 if (pr_reg
->isid_present_at_reg
)
1898 snprintf(isid_buf
, 32, "initiator_sid=%s\n",
1899 pr_reg
->pr_reg_isid
);
1901 * Include special metadata if the pr_reg matches the
1902 * reservation holder.
1904 if (dev
->dev_pr_res_holder
== pr_reg
) {
1905 snprintf(tmp
, 512, "PR_REG_START: %d"
1906 "\ninitiator_fabric=%s\n"
1907 "initiator_node=%s\n%s"
1909 "res_holder=1\nres_type=%02x\n"
1910 "res_scope=%02x\nres_all_tg_pt=%d\n"
1911 "mapped_lun=%llu\n", reg_count
,
1912 tpg
->se_tpg_tfo
->get_fabric_name(),
1913 pr_reg
->pr_reg_nacl
->initiatorname
, isid_buf
,
1914 pr_reg
->pr_res_key
, pr_reg
->pr_res_type
,
1915 pr_reg
->pr_res_scope
, pr_reg
->pr_reg_all_tg_pt
,
1916 pr_reg
->pr_res_mapped_lun
);
1918 snprintf(tmp
, 512, "PR_REG_START: %d\n"
1919 "initiator_fabric=%s\ninitiator_node=%s\n%s"
1920 "sa_res_key=%llu\nres_holder=0\n"
1921 "res_all_tg_pt=%d\nmapped_lun=%llu\n",
1922 reg_count
, tpg
->se_tpg_tfo
->get_fabric_name(),
1923 pr_reg
->pr_reg_nacl
->initiatorname
, isid_buf
,
1924 pr_reg
->pr_res_key
, pr_reg
->pr_reg_all_tg_pt
,
1925 pr_reg
->pr_res_mapped_lun
);
1928 if ((len
+ strlen(tmp
) >= pr_aptpl_buf_len
)) {
1929 pr_err("Unable to update renaming APTPL metadata,"
1930 " reallocating larger buffer\n");
1934 len
+= sprintf(buf
+len
, "%s", tmp
);
1937 * Include information about the associated SCSI target port.
1939 snprintf(tmp
, 512, "target_fabric=%s\ntarget_node=%s\n"
1940 "tpgt=%hu\nport_rtpi=%hu\ntarget_lun=%llu\nPR_REG_END:"
1941 " %d\n", tpg
->se_tpg_tfo
->get_fabric_name(),
1942 tpg
->se_tpg_tfo
->tpg_get_wwn(tpg
),
1943 tpg
->se_tpg_tfo
->tpg_get_tag(tpg
),
1944 pr_reg
->tg_pt_sep_rtpi
, pr_reg
->pr_aptpl_target_lun
,
1947 if ((len
+ strlen(tmp
) >= pr_aptpl_buf_len
)) {
1948 pr_err("Unable to update renaming APTPL metadata,"
1949 " reallocating larger buffer\n");
1953 len
+= sprintf(buf
+len
, "%s", tmp
);
1958 len
+= sprintf(buf
+len
, "No Registrations or Reservations");
1961 spin_unlock(&dev
->t10_pr
.registration_lock
);
1962 spin_unlock(&dev
->dev_reservation_lock
);
1967 static int __core_scsi3_write_aptpl_to_file(
1968 struct se_device
*dev
,
1971 struct t10_wwn
*wwn
= &dev
->t10_wwn
;
1973 int flags
= O_RDWR
| O_CREAT
| O_TRUNC
;
1975 u32 pr_aptpl_buf_len
;
1979 memset(path
, 0, 512);
1981 if (strlen(&wwn
->unit_serial
[0]) >= 512) {
1982 pr_err("WWN value for struct se_device does not fit"
1983 " into path buffer\n");
1987 snprintf(path
, 512, "%s/pr/aptpl_%s", db_root
, &wwn
->unit_serial
[0]);
1988 file
= filp_open(path
, flags
, 0600);
1990 pr_err("filp_open(%s) for APTPL metadata"
1992 return PTR_ERR(file
);
1995 pr_aptpl_buf_len
= (strlen(buf
) + 1); /* Add extra for NULL */
1997 ret
= kernel_write(file
, buf
, pr_aptpl_buf_len
, &pos
);
2000 pr_debug("Error writing APTPL metadata file: %s\n", path
);
2003 return (ret
< 0) ? -EIO
: 0;
2007 * Clear the APTPL metadata if APTPL has been disabled, otherwise
2008 * write out the updated metadata to struct file for this SCSI device.
2010 static sense_reason_t
core_scsi3_update_and_write_aptpl(struct se_device
*dev
, bool aptpl
)
2013 int rc
, len
= PR_APTPL_BUF_LEN
;
2016 char *null_buf
= "No Registrations or Reservations\n";
2018 rc
= __core_scsi3_write_aptpl_to_file(dev
, null_buf
);
2019 dev
->t10_pr
.pr_aptpl_active
= 0;
2020 pr_debug("SPC-3 PR: Set APTPL Bit Deactivated\n");
2023 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
2030 return TCM_OUT_OF_RESOURCES
;
2032 rc
= core_scsi3_update_aptpl_buf(dev
, buf
, len
);
2039 rc
= __core_scsi3_write_aptpl_to_file(dev
, buf
);
2041 pr_err("SPC-3 PR: Could not update APTPL\n");
2043 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
2045 dev
->t10_pr
.pr_aptpl_active
= 1;
2047 pr_debug("SPC-3 PR: Set APTPL Bit Activated\n");
2051 static sense_reason_t
2052 core_scsi3_emulate_pro_register(struct se_cmd
*cmd
, u64 res_key
, u64 sa_res_key
,
2053 bool aptpl
, bool all_tg_pt
, bool spec_i_pt
, enum register_type register_type
)
2055 struct se_session
*se_sess
= cmd
->se_sess
;
2056 struct se_device
*dev
= cmd
->se_dev
;
2057 struct se_lun
*se_lun
= cmd
->se_lun
;
2058 struct se_portal_group
*se_tpg
;
2059 struct t10_pr_registration
*pr_reg
, *pr_reg_p
, *pr_reg_tmp
;
2060 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
2061 unsigned char isid_buf
[PR_REG_ISID_LEN
], *isid_ptr
= NULL
;
2062 sense_reason_t ret
= TCM_NO_SENSE
;
2063 int pr_holder
= 0, type
;
2065 if (!se_sess
|| !se_lun
) {
2066 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2067 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
2069 se_tpg
= se_sess
->se_tpg
;
2071 if (se_tpg
->se_tpg_tfo
->sess_get_initiator_sid
) {
2072 memset(&isid_buf
[0], 0, PR_REG_ISID_LEN
);
2073 se_tpg
->se_tpg_tfo
->sess_get_initiator_sid(se_sess
, &isid_buf
[0],
2075 isid_ptr
= &isid_buf
[0];
2078 * Follow logic from spc4r17 Section 5.7.7, Register Behaviors Table 47
2080 pr_reg
= core_scsi3_locate_pr_reg(dev
, se_sess
->se_node_acl
, se_sess
);
2083 pr_warn("SPC-3 PR: Reservation Key non-zero"
2084 " for SA REGISTER, returning CONFLICT\n");
2085 return TCM_RESERVATION_CONFLICT
;
2088 * Do nothing but return GOOD status.
2095 * Perform the Service Action REGISTER on the Initiator
2096 * Port Endpoint that the PRO was received from on the
2097 * Logical Unit of the SCSI device server.
2099 if (core_scsi3_alloc_registration(cmd
->se_dev
,
2100 se_sess
->se_node_acl
, cmd
->se_lun
,
2101 NULL
, cmd
->orig_fe_lun
, isid_ptr
,
2102 sa_res_key
, all_tg_pt
, aptpl
,
2103 register_type
, 0)) {
2104 pr_err("Unable to allocate"
2105 " struct t10_pr_registration\n");
2106 return TCM_INVALID_PARAMETER_LIST
;
2110 * Register both the Initiator port that received
2111 * PROUT SA REGISTER + SPEC_I_PT=1 and extract SCSI
2112 * TransportID from Parameter list and loop through
2113 * fabric dependent parameter list while calling
2114 * logic from of core_scsi3_alloc_registration() for
2115 * each TransportID provided SCSI Initiator Port/Device
2117 ret
= core_scsi3_decode_spec_i_port(cmd
, se_tpg
,
2118 isid_ptr
, sa_res_key
, all_tg_pt
, aptpl
);
2122 return core_scsi3_update_and_write_aptpl(dev
, aptpl
);
2125 /* ok, existing registration */
2127 if ((register_type
== REGISTER
) && (res_key
!= pr_reg
->pr_res_key
)) {
2128 pr_err("SPC-3 PR REGISTER: Received"
2129 " res_key: 0x%016Lx does not match"
2130 " existing SA REGISTER res_key:"
2131 " 0x%016Lx\n", res_key
,
2132 pr_reg
->pr_res_key
);
2133 ret
= TCM_RESERVATION_CONFLICT
;
2138 pr_err("SPC-3 PR REGISTER: SPEC_I_PT"
2139 " set on a registered nexus\n");
2140 ret
= TCM_INVALID_PARAMETER_LIST
;
2145 * An existing ALL_TG_PT=1 registration being released
2146 * must also set ALL_TG_PT=1 in the incoming PROUT.
2148 if (pr_reg
->pr_reg_all_tg_pt
&& !all_tg_pt
) {
2149 pr_err("SPC-3 PR REGISTER: ALL_TG_PT=1"
2150 " registration exists, but ALL_TG_PT=1 bit not"
2151 " present in received PROUT\n");
2152 ret
= TCM_INVALID_CDB_FIELD
;
2157 * sa_res_key=1 Change Reservation Key for registered I_T Nexus.
2161 * Increment PRgeneration counter for struct se_device"
2162 * upon a successful REGISTER, see spc4r17 section 6.3.2
2163 * READ_KEYS service action.
2165 pr_reg
->pr_res_generation
= core_scsi3_pr_generation(cmd
->se_dev
);
2166 pr_reg
->pr_res_key
= sa_res_key
;
2167 pr_debug("SPC-3 PR [%s] REGISTER%s: Changed Reservation"
2168 " Key for %s to: 0x%016Lx PRgeneration:"
2169 " 0x%08x\n", cmd
->se_tfo
->get_fabric_name(),
2170 (register_type
== REGISTER_AND_IGNORE_EXISTING_KEY
) ? "_AND_IGNORE_EXISTING_KEY" : "",
2171 pr_reg
->pr_reg_nacl
->initiatorname
,
2172 pr_reg
->pr_res_key
, pr_reg
->pr_res_generation
);
2176 * sa_res_key=0 Unregister Reservation Key for registered I_T Nexus.
2178 type
= pr_reg
->pr_res_type
;
2179 pr_holder
= core_scsi3_check_implicit_release(cmd
->se_dev
,
2181 if (pr_holder
< 0) {
2182 ret
= TCM_RESERVATION_CONFLICT
;
2186 spin_lock(&pr_tmpl
->registration_lock
);
2188 * Release all ALL_TG_PT=1 for the matching SCSI Initiator Port
2189 * and matching pr_res_key.
2191 if (pr_reg
->pr_reg_all_tg_pt
) {
2192 list_for_each_entry_safe(pr_reg_p
, pr_reg_tmp
,
2193 &pr_tmpl
->registration_list
,
2196 if (!pr_reg_p
->pr_reg_all_tg_pt
)
2198 if (pr_reg_p
->pr_res_key
!= res_key
)
2200 if (pr_reg
== pr_reg_p
)
2202 if (strcmp(pr_reg
->pr_reg_nacl
->initiatorname
,
2203 pr_reg_p
->pr_reg_nacl
->initiatorname
))
2206 __core_scsi3_free_registration(dev
,
2212 * Release the calling I_T Nexus registration now..
2214 __core_scsi3_free_registration(cmd
->se_dev
, pr_reg
, NULL
, 1);
2218 * From spc4r17, section 5.7.11.3 Unregistering
2220 * If the persistent reservation is a registrants only
2221 * type, the device server shall establish a unit
2222 * attention condition for the initiator port associated
2223 * with every registered I_T nexus except for the I_T
2224 * nexus on which the PERSISTENT RESERVE OUT command was
2225 * received, with the additional sense code set to
2226 * RESERVATIONS RELEASED.
2229 (type
== PR_TYPE_WRITE_EXCLUSIVE_REGONLY
||
2230 type
== PR_TYPE_EXCLUSIVE_ACCESS_REGONLY
)) {
2231 list_for_each_entry(pr_reg_p
,
2232 &pr_tmpl
->registration_list
,
2235 target_ua_allocate_lun(
2236 pr_reg_p
->pr_reg_nacl
,
2237 pr_reg_p
->pr_res_mapped_lun
,
2239 ASCQ_2AH_RESERVATIONS_RELEASED
);
2243 spin_unlock(&pr_tmpl
->registration_lock
);
2246 ret
= core_scsi3_update_and_write_aptpl(dev
, aptpl
);
2250 core_scsi3_put_pr_reg(pr_reg
);
2254 unsigned char *core_scsi3_pr_dump_type(int type
)
2257 case PR_TYPE_WRITE_EXCLUSIVE
:
2258 return "Write Exclusive Access";
2259 case PR_TYPE_EXCLUSIVE_ACCESS
:
2260 return "Exclusive Access";
2261 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY
:
2262 return "Write Exclusive Access, Registrants Only";
2263 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY
:
2264 return "Exclusive Access, Registrants Only";
2265 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG
:
2266 return "Write Exclusive Access, All Registrants";
2267 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
:
2268 return "Exclusive Access, All Registrants";
2273 return "Unknown SPC-3 PR Type";
2276 static sense_reason_t
2277 core_scsi3_pro_reserve(struct se_cmd
*cmd
, int type
, int scope
, u64 res_key
)
2279 struct se_device
*dev
= cmd
->se_dev
;
2280 struct se_session
*se_sess
= cmd
->se_sess
;
2281 struct se_lun
*se_lun
= cmd
->se_lun
;
2282 struct t10_pr_registration
*pr_reg
, *pr_res_holder
;
2283 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
2284 char i_buf
[PR_REG_ISID_ID_LEN
];
2287 memset(i_buf
, 0, PR_REG_ISID_ID_LEN
);
2289 if (!se_sess
|| !se_lun
) {
2290 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2291 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
2294 * Locate the existing *pr_reg via struct se_node_acl pointers
2296 pr_reg
= core_scsi3_locate_pr_reg(cmd
->se_dev
, se_sess
->se_node_acl
,
2299 pr_err("SPC-3 PR: Unable to locate"
2300 " PR_REGISTERED *pr_reg for RESERVE\n");
2301 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
2304 * From spc4r17 Section 5.7.9: Reserving:
2306 * An application client creates a persistent reservation by issuing
2307 * a PERSISTENT RESERVE OUT command with RESERVE service action through
2308 * a registered I_T nexus with the following parameters:
2309 * a) RESERVATION KEY set to the value of the reservation key that is
2310 * registered with the logical unit for the I_T nexus; and
2312 if (res_key
!= pr_reg
->pr_res_key
) {
2313 pr_err("SPC-3 PR RESERVE: Received res_key: 0x%016Lx"
2314 " does not match existing SA REGISTER res_key:"
2315 " 0x%016Lx\n", res_key
, pr_reg
->pr_res_key
);
2316 ret
= TCM_RESERVATION_CONFLICT
;
2317 goto out_put_pr_reg
;
2320 * From spc4r17 Section 5.7.9: Reserving:
2323 * b) TYPE field and SCOPE field set to the persistent reservation
2326 * Only one persistent reservation is allowed at a time per logical unit
2327 * and that persistent reservation has a scope of LU_SCOPE.
2329 if (scope
!= PR_SCOPE_LU_SCOPE
) {
2330 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope
);
2331 ret
= TCM_INVALID_PARAMETER_LIST
;
2332 goto out_put_pr_reg
;
2335 * See if we have an existing PR reservation holder pointer at
2336 * struct se_device->dev_pr_res_holder in the form struct t10_pr_registration
2339 spin_lock(&dev
->dev_reservation_lock
);
2340 pr_res_holder
= dev
->dev_pr_res_holder
;
2341 if (pr_res_holder
) {
2343 * From spc4r17 Section 5.7.9: Reserving:
2345 * If the device server receives a PERSISTENT RESERVE OUT
2346 * command from an I_T nexus other than a persistent reservation
2347 * holder (see 5.7.10) that attempts to create a persistent
2348 * reservation when a persistent reservation already exists for
2349 * the logical unit, then the command shall be completed with
2350 * RESERVATION CONFLICT status.
2352 if (!is_reservation_holder(pr_res_holder
, pr_reg
)) {
2353 struct se_node_acl
*pr_res_nacl
= pr_res_holder
->pr_reg_nacl
;
2354 pr_err("SPC-3 PR: Attempted RESERVE from"
2355 " [%s]: %s while reservation already held by"
2356 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2357 cmd
->se_tfo
->get_fabric_name(),
2358 se_sess
->se_node_acl
->initiatorname
,
2359 pr_res_nacl
->se_tpg
->se_tpg_tfo
->get_fabric_name(),
2360 pr_res_holder
->pr_reg_nacl
->initiatorname
);
2362 spin_unlock(&dev
->dev_reservation_lock
);
2363 ret
= TCM_RESERVATION_CONFLICT
;
2364 goto out_put_pr_reg
;
2367 * From spc4r17 Section 5.7.9: Reserving:
2369 * If a persistent reservation holder attempts to modify the
2370 * type or scope of an existing persistent reservation, the
2371 * command shall be completed with RESERVATION CONFLICT status.
2373 if ((pr_res_holder
->pr_res_type
!= type
) ||
2374 (pr_res_holder
->pr_res_scope
!= scope
)) {
2375 struct se_node_acl
*pr_res_nacl
= pr_res_holder
->pr_reg_nacl
;
2376 pr_err("SPC-3 PR: Attempted RESERVE from"
2377 " [%s]: %s trying to change TYPE and/or SCOPE,"
2378 " while reservation already held by [%s]: %s,"
2379 " returning RESERVATION_CONFLICT\n",
2380 cmd
->se_tfo
->get_fabric_name(),
2381 se_sess
->se_node_acl
->initiatorname
,
2382 pr_res_nacl
->se_tpg
->se_tpg_tfo
->get_fabric_name(),
2383 pr_res_holder
->pr_reg_nacl
->initiatorname
);
2385 spin_unlock(&dev
->dev_reservation_lock
);
2386 ret
= TCM_RESERVATION_CONFLICT
;
2387 goto out_put_pr_reg
;
2390 * From spc4r17 Section 5.7.9: Reserving:
2392 * If the device server receives a PERSISTENT RESERVE OUT
2393 * command with RESERVE service action where the TYPE field and
2394 * the SCOPE field contain the same values as the existing type
2395 * and scope from a persistent reservation holder, it shall not
2396 * make any change to the existing persistent reservation and
2397 * shall completethe command with GOOD status.
2399 spin_unlock(&dev
->dev_reservation_lock
);
2401 goto out_put_pr_reg
;
2404 * Otherwise, our *pr_reg becomes the PR reservation holder for said
2405 * TYPE/SCOPE. Also set the received scope and type in *pr_reg.
2407 pr_reg
->pr_res_scope
= scope
;
2408 pr_reg
->pr_res_type
= type
;
2409 pr_reg
->pr_res_holder
= 1;
2410 dev
->dev_pr_res_holder
= pr_reg
;
2411 core_pr_dump_initiator_port(pr_reg
, i_buf
, PR_REG_ISID_ID_LEN
);
2413 pr_debug("SPC-3 PR [%s] Service Action: RESERVE created new"
2414 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2415 cmd
->se_tfo
->get_fabric_name(), core_scsi3_pr_dump_type(type
),
2416 (pr_reg
->pr_reg_all_tg_pt
) ? 1 : 0);
2417 pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
2418 cmd
->se_tfo
->get_fabric_name(),
2419 se_sess
->se_node_acl
->initiatorname
,
2421 spin_unlock(&dev
->dev_reservation_lock
);
2423 if (pr_tmpl
->pr_aptpl_active
)
2424 core_scsi3_update_and_write_aptpl(cmd
->se_dev
, true);
2428 core_scsi3_put_pr_reg(pr_reg
);
2432 static sense_reason_t
2433 core_scsi3_emulate_pro_reserve(struct se_cmd
*cmd
, int type
, int scope
,
2437 case PR_TYPE_WRITE_EXCLUSIVE
:
2438 case PR_TYPE_EXCLUSIVE_ACCESS
:
2439 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY
:
2440 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY
:
2441 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG
:
2442 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
:
2443 return core_scsi3_pro_reserve(cmd
, type
, scope
, res_key
);
2445 pr_err("SPC-3 PR: Unknown Service Action RESERVE Type:"
2447 return TCM_INVALID_CDB_FIELD
;
2452 * Called with struct se_device->dev_reservation_lock held.
2454 static void __core_scsi3_complete_pro_release(
2455 struct se_device
*dev
,
2456 struct se_node_acl
*se_nacl
,
2457 struct t10_pr_registration
*pr_reg
,
2461 const struct target_core_fabric_ops
*tfo
= se_nacl
->se_tpg
->se_tpg_tfo
;
2462 char i_buf
[PR_REG_ISID_ID_LEN
];
2463 int pr_res_type
= 0, pr_res_scope
= 0;
2465 memset(i_buf
, 0, PR_REG_ISID_ID_LEN
);
2466 core_pr_dump_initiator_port(pr_reg
, i_buf
, PR_REG_ISID_ID_LEN
);
2468 * Go ahead and release the current PR reservation holder.
2469 * If an All Registrants reservation is currently active and
2470 * a unregister operation is requested, replace the current
2471 * dev_pr_res_holder with another active registration.
2473 if (dev
->dev_pr_res_holder
) {
2474 pr_res_type
= dev
->dev_pr_res_holder
->pr_res_type
;
2475 pr_res_scope
= dev
->dev_pr_res_holder
->pr_res_scope
;
2476 dev
->dev_pr_res_holder
->pr_res_type
= 0;
2477 dev
->dev_pr_res_holder
->pr_res_scope
= 0;
2478 dev
->dev_pr_res_holder
->pr_res_holder
= 0;
2479 dev
->dev_pr_res_holder
= NULL
;
2484 spin_lock(&dev
->t10_pr
.registration_lock
);
2485 list_del_init(&pr_reg
->pr_reg_list
);
2487 * If the I_T nexus is a reservation holder, the persistent reservation
2488 * is of an all registrants type, and the I_T nexus is the last remaining
2489 * registered I_T nexus, then the device server shall also release the
2490 * persistent reservation.
2492 if (!list_empty(&dev
->t10_pr
.registration_list
) &&
2493 ((pr_res_type
== PR_TYPE_WRITE_EXCLUSIVE_ALLREG
) ||
2494 (pr_res_type
== PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
))) {
2495 dev
->dev_pr_res_holder
=
2496 list_entry(dev
->t10_pr
.registration_list
.next
,
2497 struct t10_pr_registration
, pr_reg_list
);
2498 dev
->dev_pr_res_holder
->pr_res_type
= pr_res_type
;
2499 dev
->dev_pr_res_holder
->pr_res_scope
= pr_res_scope
;
2500 dev
->dev_pr_res_holder
->pr_res_holder
= 1;
2502 spin_unlock(&dev
->t10_pr
.registration_lock
);
2504 if (!dev
->dev_pr_res_holder
) {
2505 pr_debug("SPC-3 PR [%s] Service Action: %s RELEASE cleared"
2506 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2507 tfo
->get_fabric_name(), (explicit) ? "explicit" :
2508 "implicit", core_scsi3_pr_dump_type(pr_res_type
),
2509 (pr_reg
->pr_reg_all_tg_pt
) ? 1 : 0);
2511 pr_debug("SPC-3 PR [%s] RELEASE Node: %s%s\n",
2512 tfo
->get_fabric_name(), se_nacl
->initiatorname
,
2515 * Clear TYPE and SCOPE for the next PROUT Service Action: RESERVE
2517 pr_reg
->pr_res_holder
= pr_reg
->pr_res_type
= pr_reg
->pr_res_scope
= 0;
2520 static sense_reason_t
2521 core_scsi3_emulate_pro_release(struct se_cmd
*cmd
, int type
, int scope
,
2524 struct se_device
*dev
= cmd
->se_dev
;
2525 struct se_session
*se_sess
= cmd
->se_sess
;
2526 struct se_lun
*se_lun
= cmd
->se_lun
;
2527 struct t10_pr_registration
*pr_reg
, *pr_reg_p
, *pr_res_holder
;
2528 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
2529 sense_reason_t ret
= 0;
2531 if (!se_sess
|| !se_lun
) {
2532 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2533 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
2536 * Locate the existing *pr_reg via struct se_node_acl pointers
2538 pr_reg
= core_scsi3_locate_pr_reg(dev
, se_sess
->se_node_acl
, se_sess
);
2540 pr_err("SPC-3 PR: Unable to locate"
2541 " PR_REGISTERED *pr_reg for RELEASE\n");
2542 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
2545 * From spc4r17 Section 5.7.11.2 Releasing:
2547 * If there is no persistent reservation or in response to a persistent
2548 * reservation release request from a registered I_T nexus that is not a
2549 * persistent reservation holder (see 5.7.10), the device server shall
2552 * a) Not release the persistent reservation, if any;
2553 * b) Not remove any registrations; and
2554 * c) Complete the command with GOOD status.
2556 spin_lock(&dev
->dev_reservation_lock
);
2557 pr_res_holder
= dev
->dev_pr_res_holder
;
2558 if (!pr_res_holder
) {
2560 * No persistent reservation, return GOOD status.
2562 spin_unlock(&dev
->dev_reservation_lock
);
2563 goto out_put_pr_reg
;
2566 if (!is_reservation_holder(pr_res_holder
, pr_reg
)) {
2568 * Release request from a registered I_T nexus that is not a
2569 * persistent reservation holder. return GOOD status.
2571 spin_unlock(&dev
->dev_reservation_lock
);
2572 goto out_put_pr_reg
;
2576 * From spc4r17 Section 5.7.11.2 Releasing:
2578 * Only the persistent reservation holder (see 5.7.10) is allowed to
2579 * release a persistent reservation.
2581 * An application client releases the persistent reservation by issuing
2582 * a PERSISTENT RESERVE OUT command with RELEASE service action through
2583 * an I_T nexus that is a persistent reservation holder with the
2584 * following parameters:
2586 * a) RESERVATION KEY field set to the value of the reservation key
2587 * that is registered with the logical unit for the I_T nexus;
2589 if (res_key
!= pr_reg
->pr_res_key
) {
2590 pr_err("SPC-3 PR RELEASE: Received res_key: 0x%016Lx"
2591 " does not match existing SA REGISTER res_key:"
2592 " 0x%016Lx\n", res_key
, pr_reg
->pr_res_key
);
2593 spin_unlock(&dev
->dev_reservation_lock
);
2594 ret
= TCM_RESERVATION_CONFLICT
;
2595 goto out_put_pr_reg
;
2598 * From spc4r17 Section 5.7.11.2 Releasing and above:
2600 * b) TYPE field and SCOPE field set to match the persistent
2601 * reservation being released.
2603 if ((pr_res_holder
->pr_res_type
!= type
) ||
2604 (pr_res_holder
->pr_res_scope
!= scope
)) {
2605 struct se_node_acl
*pr_res_nacl
= pr_res_holder
->pr_reg_nacl
;
2606 pr_err("SPC-3 PR RELEASE: Attempted to release"
2607 " reservation from [%s]: %s with different TYPE "
2608 "and/or SCOPE while reservation already held by"
2609 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2610 cmd
->se_tfo
->get_fabric_name(),
2611 se_sess
->se_node_acl
->initiatorname
,
2612 pr_res_nacl
->se_tpg
->se_tpg_tfo
->get_fabric_name(),
2613 pr_res_holder
->pr_reg_nacl
->initiatorname
);
2615 spin_unlock(&dev
->dev_reservation_lock
);
2616 ret
= TCM_RESERVATION_CONFLICT
;
2617 goto out_put_pr_reg
;
2620 * In response to a persistent reservation release request from the
2621 * persistent reservation holder the device server shall perform a
2622 * release by doing the following as an uninterrupted series of actions:
2623 * a) Release the persistent reservation;
2624 * b) Not remove any registration(s);
2625 * c) If the released persistent reservation is a registrants only type
2626 * or all registrants type persistent reservation,
2627 * the device server shall establish a unit attention condition for
2628 * the initiator port associated with every regis-
2629 * tered I_T nexus other than I_T nexus on which the PERSISTENT
2630 * RESERVE OUT command with RELEASE service action was received,
2631 * with the additional sense code set to RESERVATIONS RELEASED; and
2632 * d) If the persistent reservation is of any other type, the device
2633 * server shall not establish a unit attention condition.
2635 __core_scsi3_complete_pro_release(dev
, se_sess
->se_node_acl
,
2638 spin_unlock(&dev
->dev_reservation_lock
);
2640 if ((type
!= PR_TYPE_WRITE_EXCLUSIVE_REGONLY
) &&
2641 (type
!= PR_TYPE_EXCLUSIVE_ACCESS_REGONLY
) &&
2642 (type
!= PR_TYPE_WRITE_EXCLUSIVE_ALLREG
) &&
2643 (type
!= PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
)) {
2645 * If no UNIT ATTENTION conditions will be established for
2646 * PR_TYPE_WRITE_EXCLUSIVE or PR_TYPE_EXCLUSIVE_ACCESS
2647 * go ahead and check for APTPL=1 update+write below
2652 spin_lock(&pr_tmpl
->registration_lock
);
2653 list_for_each_entry(pr_reg_p
, &pr_tmpl
->registration_list
,
2656 * Do not establish a UNIT ATTENTION condition
2657 * for the calling I_T Nexus
2659 if (pr_reg_p
== pr_reg
)
2662 target_ua_allocate_lun(pr_reg_p
->pr_reg_nacl
,
2663 pr_reg_p
->pr_res_mapped_lun
,
2664 0x2A, ASCQ_2AH_RESERVATIONS_RELEASED
);
2666 spin_unlock(&pr_tmpl
->registration_lock
);
2669 if (pr_tmpl
->pr_aptpl_active
)
2670 core_scsi3_update_and_write_aptpl(cmd
->se_dev
, true);
2673 core_scsi3_put_pr_reg(pr_reg
);
2677 static sense_reason_t
2678 core_scsi3_emulate_pro_clear(struct se_cmd
*cmd
, u64 res_key
)
2680 struct se_device
*dev
= cmd
->se_dev
;
2681 struct se_node_acl
*pr_reg_nacl
;
2682 struct se_session
*se_sess
= cmd
->se_sess
;
2683 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
2684 struct t10_pr_registration
*pr_reg
, *pr_reg_tmp
, *pr_reg_n
, *pr_res_holder
;
2685 u64 pr_res_mapped_lun
= 0;
2686 int calling_it_nexus
= 0;
2688 * Locate the existing *pr_reg via struct se_node_acl pointers
2690 pr_reg_n
= core_scsi3_locate_pr_reg(cmd
->se_dev
,
2691 se_sess
->se_node_acl
, se_sess
);
2693 pr_err("SPC-3 PR: Unable to locate"
2694 " PR_REGISTERED *pr_reg for CLEAR\n");
2695 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
2698 * From spc4r17 section 5.7.11.6, Clearing:
2700 * Any application client may release the persistent reservation and
2701 * remove all registrations from a device server by issuing a
2702 * PERSISTENT RESERVE OUT command with CLEAR service action through a
2703 * registered I_T nexus with the following parameter:
2705 * a) RESERVATION KEY field set to the value of the reservation key
2706 * that is registered with the logical unit for the I_T nexus.
2708 if (res_key
!= pr_reg_n
->pr_res_key
) {
2709 pr_err("SPC-3 PR REGISTER: Received"
2710 " res_key: 0x%016Lx does not match"
2711 " existing SA REGISTER res_key:"
2712 " 0x%016Lx\n", res_key
, pr_reg_n
->pr_res_key
);
2713 core_scsi3_put_pr_reg(pr_reg_n
);
2714 return TCM_RESERVATION_CONFLICT
;
2717 * a) Release the persistent reservation, if any;
2719 spin_lock(&dev
->dev_reservation_lock
);
2720 pr_res_holder
= dev
->dev_pr_res_holder
;
2721 if (pr_res_holder
) {
2722 struct se_node_acl
*pr_res_nacl
= pr_res_holder
->pr_reg_nacl
;
2723 __core_scsi3_complete_pro_release(dev
, pr_res_nacl
,
2724 pr_res_holder
, 0, 0);
2726 spin_unlock(&dev
->dev_reservation_lock
);
2728 * b) Remove all registration(s) (see spc4r17 5.7.7);
2730 spin_lock(&pr_tmpl
->registration_lock
);
2731 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
,
2732 &pr_tmpl
->registration_list
, pr_reg_list
) {
2734 calling_it_nexus
= (pr_reg_n
== pr_reg
) ? 1 : 0;
2735 pr_reg_nacl
= pr_reg
->pr_reg_nacl
;
2736 pr_res_mapped_lun
= pr_reg
->pr_res_mapped_lun
;
2737 __core_scsi3_free_registration(dev
, pr_reg
, NULL
,
2740 * e) Establish a unit attention condition for the initiator
2741 * port associated with every registered I_T nexus other
2742 * than the I_T nexus on which the PERSISTENT RESERVE OUT
2743 * command with CLEAR service action was received, with the
2744 * additional sense code set to RESERVATIONS PREEMPTED.
2746 if (!calling_it_nexus
)
2747 target_ua_allocate_lun(pr_reg_nacl
, pr_res_mapped_lun
,
2748 0x2A, ASCQ_2AH_RESERVATIONS_PREEMPTED
);
2750 spin_unlock(&pr_tmpl
->registration_lock
);
2752 pr_debug("SPC-3 PR [%s] Service Action: CLEAR complete\n",
2753 cmd
->se_tfo
->get_fabric_name());
2755 core_scsi3_update_and_write_aptpl(cmd
->se_dev
, false);
2757 core_scsi3_pr_generation(dev
);
2762 * Called with struct se_device->dev_reservation_lock held.
2764 static void __core_scsi3_complete_pro_preempt(
2765 struct se_device
*dev
,
2766 struct t10_pr_registration
*pr_reg
,
2767 struct list_head
*preempt_and_abort_list
,
2770 enum preempt_type preempt_type
)
2772 struct se_node_acl
*nacl
= pr_reg
->pr_reg_nacl
;
2773 const struct target_core_fabric_ops
*tfo
= nacl
->se_tpg
->se_tpg_tfo
;
2774 char i_buf
[PR_REG_ISID_ID_LEN
];
2776 memset(i_buf
, 0, PR_REG_ISID_ID_LEN
);
2777 core_pr_dump_initiator_port(pr_reg
, i_buf
, PR_REG_ISID_ID_LEN
);
2779 * Do an implicit RELEASE of the existing reservation.
2781 if (dev
->dev_pr_res_holder
)
2782 __core_scsi3_complete_pro_release(dev
, nacl
,
2783 dev
->dev_pr_res_holder
, 0, 0);
2785 dev
->dev_pr_res_holder
= pr_reg
;
2786 pr_reg
->pr_res_holder
= 1;
2787 pr_reg
->pr_res_type
= type
;
2788 pr_reg
->pr_res_scope
= scope
;
2790 pr_debug("SPC-3 PR [%s] Service Action: PREEMPT%s created new"
2791 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2792 tfo
->get_fabric_name(), (preempt_type
== PREEMPT_AND_ABORT
) ? "_AND_ABORT" : "",
2793 core_scsi3_pr_dump_type(type
),
2794 (pr_reg
->pr_reg_all_tg_pt
) ? 1 : 0);
2795 pr_debug("SPC-3 PR [%s] PREEMPT%s from Node: %s%s\n",
2796 tfo
->get_fabric_name(), (preempt_type
== PREEMPT_AND_ABORT
) ? "_AND_ABORT" : "",
2797 nacl
->initiatorname
, i_buf
);
2799 * For PREEMPT_AND_ABORT, add the preempting reservation's
2800 * struct t10_pr_registration to the list that will be compared
2801 * against received CDBs..
2803 if (preempt_and_abort_list
)
2804 list_add_tail(&pr_reg
->pr_reg_abort_list
,
2805 preempt_and_abort_list
);
2808 static void core_scsi3_release_preempt_and_abort(
2809 struct list_head
*preempt_and_abort_list
,
2810 struct t10_pr_registration
*pr_reg_holder
)
2812 struct t10_pr_registration
*pr_reg
, *pr_reg_tmp
;
2814 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
, preempt_and_abort_list
,
2815 pr_reg_abort_list
) {
2817 list_del(&pr_reg
->pr_reg_abort_list
);
2818 if (pr_reg_holder
== pr_reg
)
2820 if (pr_reg
->pr_res_holder
) {
2821 pr_warn("pr_reg->pr_res_holder still set\n");
2825 pr_reg
->pr_reg_deve
= NULL
;
2826 pr_reg
->pr_reg_nacl
= NULL
;
2827 kmem_cache_free(t10_pr_reg_cache
, pr_reg
);
2831 static sense_reason_t
2832 core_scsi3_pro_preempt(struct se_cmd
*cmd
, int type
, int scope
, u64 res_key
,
2833 u64 sa_res_key
, enum preempt_type preempt_type
)
2835 struct se_device
*dev
= cmd
->se_dev
;
2836 struct se_node_acl
*pr_reg_nacl
;
2837 struct se_session
*se_sess
= cmd
->se_sess
;
2838 LIST_HEAD(preempt_and_abort_list
);
2839 struct t10_pr_registration
*pr_reg
, *pr_reg_tmp
, *pr_reg_n
, *pr_res_holder
;
2840 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
2841 u64 pr_res_mapped_lun
= 0;
2842 int all_reg
= 0, calling_it_nexus
= 0;
2843 bool sa_res_key_unmatched
= sa_res_key
!= 0;
2844 int prh_type
= 0, prh_scope
= 0;
2847 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
2849 pr_reg_n
= core_scsi3_locate_pr_reg(cmd
->se_dev
, se_sess
->se_node_acl
,
2852 pr_err("SPC-3 PR: Unable to locate"
2853 " PR_REGISTERED *pr_reg for PREEMPT%s\n",
2854 (preempt_type
== PREEMPT_AND_ABORT
) ? "_AND_ABORT" : "");
2855 return TCM_RESERVATION_CONFLICT
;
2857 if (pr_reg_n
->pr_res_key
!= res_key
) {
2858 core_scsi3_put_pr_reg(pr_reg_n
);
2859 return TCM_RESERVATION_CONFLICT
;
2861 if (scope
!= PR_SCOPE_LU_SCOPE
) {
2862 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope
);
2863 core_scsi3_put_pr_reg(pr_reg_n
);
2864 return TCM_INVALID_PARAMETER_LIST
;
2867 spin_lock(&dev
->dev_reservation_lock
);
2868 pr_res_holder
= dev
->dev_pr_res_holder
;
2869 if (pr_res_holder
&&
2870 ((pr_res_holder
->pr_res_type
== PR_TYPE_WRITE_EXCLUSIVE_ALLREG
) ||
2871 (pr_res_holder
->pr_res_type
== PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
)))
2874 if (!all_reg
&& !sa_res_key
) {
2875 spin_unlock(&dev
->dev_reservation_lock
);
2876 core_scsi3_put_pr_reg(pr_reg_n
);
2877 return TCM_INVALID_PARAMETER_LIST
;
2880 * From spc4r17, section 5.7.11.4.4 Removing Registrations:
2882 * If the SERVICE ACTION RESERVATION KEY field does not identify a
2883 * persistent reservation holder or there is no persistent reservation
2884 * holder (i.e., there is no persistent reservation), then the device
2885 * server shall perform a preempt by doing the following in an
2886 * uninterrupted series of actions. (See below..)
2888 if (!pr_res_holder
|| (pr_res_holder
->pr_res_key
!= sa_res_key
)) {
2890 * No existing or SA Reservation Key matching reservations..
2892 * PROUT SA PREEMPT with All Registrant type reservations are
2893 * allowed to be processed without a matching SA Reservation Key
2895 spin_lock(&pr_tmpl
->registration_lock
);
2896 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
,
2897 &pr_tmpl
->registration_list
, pr_reg_list
) {
2899 * Removing of registrations in non all registrants
2900 * type reservations without a matching SA reservation
2903 * a) Remove the registrations for all I_T nexuses
2904 * specified by the SERVICE ACTION RESERVATION KEY
2906 * b) Ignore the contents of the SCOPE and TYPE fields;
2907 * c) Process tasks as defined in 5.7.1; and
2908 * d) Establish a unit attention condition for the
2909 * initiator port associated with every I_T nexus
2910 * that lost its registration other than the I_T
2911 * nexus on which the PERSISTENT RESERVE OUT command
2912 * was received, with the additional sense code set
2913 * to REGISTRATIONS PREEMPTED.
2916 if (pr_reg
->pr_res_key
!= sa_res_key
)
2918 sa_res_key_unmatched
= false;
2920 calling_it_nexus
= (pr_reg_n
== pr_reg
) ? 1 : 0;
2921 pr_reg_nacl
= pr_reg
->pr_reg_nacl
;
2922 pr_res_mapped_lun
= pr_reg
->pr_res_mapped_lun
;
2923 __core_scsi3_free_registration(dev
, pr_reg
,
2924 (preempt_type
== PREEMPT_AND_ABORT
) ? &preempt_and_abort_list
:
2925 NULL
, calling_it_nexus
);
2928 * Case for any existing all registrants type
2929 * reservation, follow logic in spc4r17 section
2930 * 5.7.11.4 Preempting, Table 52 and Figure 7.
2932 * For a ZERO SA Reservation key, release
2933 * all other registrations and do an implicit
2934 * release of active persistent reservation.
2936 * For a non-ZERO SA Reservation key, only
2937 * release the matching reservation key from
2941 (pr_reg
->pr_res_key
!= sa_res_key
))
2943 sa_res_key_unmatched
= false;
2945 calling_it_nexus
= (pr_reg_n
== pr_reg
) ? 1 : 0;
2946 if (calling_it_nexus
)
2949 pr_reg_nacl
= pr_reg
->pr_reg_nacl
;
2950 pr_res_mapped_lun
= pr_reg
->pr_res_mapped_lun
;
2951 __core_scsi3_free_registration(dev
, pr_reg
,
2952 (preempt_type
== PREEMPT_AND_ABORT
) ? &preempt_and_abort_list
:
2955 if (!calling_it_nexus
)
2956 target_ua_allocate_lun(pr_reg_nacl
,
2957 pr_res_mapped_lun
, 0x2A,
2958 ASCQ_2AH_REGISTRATIONS_PREEMPTED
);
2960 spin_unlock(&pr_tmpl
->registration_lock
);
2962 * If a PERSISTENT RESERVE OUT with a PREEMPT service action or
2963 * a PREEMPT AND ABORT service action sets the SERVICE ACTION
2964 * RESERVATION KEY field to a value that does not match any
2965 * registered reservation key, then the device server shall
2966 * complete the command with RESERVATION CONFLICT status.
2968 if (sa_res_key_unmatched
) {
2969 spin_unlock(&dev
->dev_reservation_lock
);
2970 core_scsi3_put_pr_reg(pr_reg_n
);
2971 return TCM_RESERVATION_CONFLICT
;
2974 * For an existing all registrants type reservation
2975 * with a zero SA rservation key, preempt the existing
2976 * reservation with the new PR type and scope.
2978 if (pr_res_holder
&& all_reg
&& !(sa_res_key
)) {
2979 __core_scsi3_complete_pro_preempt(dev
, pr_reg_n
,
2980 (preempt_type
== PREEMPT_AND_ABORT
) ? &preempt_and_abort_list
: NULL
,
2981 type
, scope
, preempt_type
);
2983 if (preempt_type
== PREEMPT_AND_ABORT
)
2984 core_scsi3_release_preempt_and_abort(
2985 &preempt_and_abort_list
, pr_reg_n
);
2987 spin_unlock(&dev
->dev_reservation_lock
);
2989 if (pr_tmpl
->pr_aptpl_active
)
2990 core_scsi3_update_and_write_aptpl(cmd
->se_dev
, true);
2992 core_scsi3_put_pr_reg(pr_reg_n
);
2993 core_scsi3_pr_generation(cmd
->se_dev
);
2997 * The PREEMPTing SA reservation key matches that of the
2998 * existing persistent reservation, first, we check if
2999 * we are preempting our own reservation.
3000 * From spc4r17, section 5.7.11.4.3 Preempting
3001 * persistent reservations and registration handling
3003 * If an all registrants persistent reservation is not
3004 * present, it is not an error for the persistent
3005 * reservation holder to preempt itself (i.e., a
3006 * PERSISTENT RESERVE OUT with a PREEMPT service action
3007 * or a PREEMPT AND ABORT service action with the
3008 * SERVICE ACTION RESERVATION KEY value equal to the
3009 * persistent reservation holder's reservation key that
3010 * is received from the persistent reservation holder).
3011 * In that case, the device server shall establish the
3012 * new persistent reservation and maintain the
3015 prh_type
= pr_res_holder
->pr_res_type
;
3016 prh_scope
= pr_res_holder
->pr_res_scope
;
3018 * If the SERVICE ACTION RESERVATION KEY field identifies a
3019 * persistent reservation holder (see 5.7.10), the device
3020 * server shall perform a preempt by doing the following as
3021 * an uninterrupted series of actions:
3023 * a) Release the persistent reservation for the holder
3024 * identified by the SERVICE ACTION RESERVATION KEY field;
3026 if (pr_reg_n
!= pr_res_holder
)
3027 __core_scsi3_complete_pro_release(dev
,
3028 pr_res_holder
->pr_reg_nacl
,
3029 dev
->dev_pr_res_holder
, 0, 0);
3031 * b) Remove the registrations for all I_T nexuses identified
3032 * by the SERVICE ACTION RESERVATION KEY field, except the
3033 * I_T nexus that is being used for the PERSISTENT RESERVE
3034 * OUT command. If an all registrants persistent reservation
3035 * is present and the SERVICE ACTION RESERVATION KEY field
3036 * is set to zero, then all registrations shall be removed
3037 * except for that of the I_T nexus that is being used for
3038 * the PERSISTENT RESERVE OUT command;
3040 spin_lock(&pr_tmpl
->registration_lock
);
3041 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
,
3042 &pr_tmpl
->registration_list
, pr_reg_list
) {
3044 calling_it_nexus
= (pr_reg_n
== pr_reg
) ? 1 : 0;
3045 if (calling_it_nexus
)
3048 if (pr_reg
->pr_res_key
!= sa_res_key
)
3051 pr_reg_nacl
= pr_reg
->pr_reg_nacl
;
3052 pr_res_mapped_lun
= pr_reg
->pr_res_mapped_lun
;
3053 __core_scsi3_free_registration(dev
, pr_reg
,
3054 (preempt_type
== PREEMPT_AND_ABORT
) ? &preempt_and_abort_list
: NULL
,
3057 * e) Establish a unit attention condition for the initiator
3058 * port associated with every I_T nexus that lost its
3059 * persistent reservation and/or registration, with the
3060 * additional sense code set to REGISTRATIONS PREEMPTED;
3062 target_ua_allocate_lun(pr_reg_nacl
, pr_res_mapped_lun
, 0x2A,
3063 ASCQ_2AH_REGISTRATIONS_PREEMPTED
);
3065 spin_unlock(&pr_tmpl
->registration_lock
);
3067 * c) Establish a persistent reservation for the preempting
3068 * I_T nexus using the contents of the SCOPE and TYPE fields;
3070 __core_scsi3_complete_pro_preempt(dev
, pr_reg_n
,
3071 (preempt_type
== PREEMPT_AND_ABORT
) ? &preempt_and_abort_list
: NULL
,
3072 type
, scope
, preempt_type
);
3074 * d) Process tasks as defined in 5.7.1;
3076 * f) If the type or scope has changed, then for every I_T nexus
3077 * whose reservation key was not removed, except for the I_T
3078 * nexus on which the PERSISTENT RESERVE OUT command was
3079 * received, the device server shall establish a unit
3080 * attention condition for the initiator port associated with
3081 * that I_T nexus, with the additional sense code set to
3082 * RESERVATIONS RELEASED. If the type or scope have not
3083 * changed, then no unit attention condition(s) shall be
3084 * established for this reason.
3086 if ((prh_type
!= type
) || (prh_scope
!= scope
)) {
3087 spin_lock(&pr_tmpl
->registration_lock
);
3088 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
,
3089 &pr_tmpl
->registration_list
, pr_reg_list
) {
3091 calling_it_nexus
= (pr_reg_n
== pr_reg
) ? 1 : 0;
3092 if (calling_it_nexus
)
3095 target_ua_allocate_lun(pr_reg
->pr_reg_nacl
,
3096 pr_reg
->pr_res_mapped_lun
, 0x2A,
3097 ASCQ_2AH_RESERVATIONS_RELEASED
);
3099 spin_unlock(&pr_tmpl
->registration_lock
);
3101 spin_unlock(&dev
->dev_reservation_lock
);
3103 * Call LUN_RESET logic upon list of struct t10_pr_registration,
3104 * All received CDBs for the matching existing reservation and
3105 * registrations undergo ABORT_TASK logic.
3107 * From there, core_scsi3_release_preempt_and_abort() will
3108 * release every registration in the list (which have already
3109 * been removed from the primary pr_reg list), except the
3110 * new persistent reservation holder, the calling Initiator Port.
3112 if (preempt_type
== PREEMPT_AND_ABORT
) {
3113 core_tmr_lun_reset(dev
, NULL
, &preempt_and_abort_list
, cmd
);
3114 core_scsi3_release_preempt_and_abort(&preempt_and_abort_list
,
3118 if (pr_tmpl
->pr_aptpl_active
)
3119 core_scsi3_update_and_write_aptpl(cmd
->se_dev
, true);
3121 core_scsi3_put_pr_reg(pr_reg_n
);
3122 core_scsi3_pr_generation(cmd
->se_dev
);
3126 static sense_reason_t
3127 core_scsi3_emulate_pro_preempt(struct se_cmd
*cmd
, int type
, int scope
,
3128 u64 res_key
, u64 sa_res_key
, enum preempt_type preempt_type
)
3131 case PR_TYPE_WRITE_EXCLUSIVE
:
3132 case PR_TYPE_EXCLUSIVE_ACCESS
:
3133 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY
:
3134 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY
:
3135 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG
:
3136 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
:
3137 return core_scsi3_pro_preempt(cmd
, type
, scope
, res_key
,
3138 sa_res_key
, preempt_type
);
3140 pr_err("SPC-3 PR: Unknown Service Action PREEMPT%s"
3141 " Type: 0x%02x\n", (preempt_type
== PREEMPT_AND_ABORT
) ? "_AND_ABORT" : "", type
);
3142 return TCM_INVALID_CDB_FIELD
;
3147 static sense_reason_t
3148 core_scsi3_emulate_pro_register_and_move(struct se_cmd
*cmd
, u64 res_key
,
3149 u64 sa_res_key
, int aptpl
, int unreg
)
3151 struct se_session
*se_sess
= cmd
->se_sess
;
3152 struct se_device
*dev
= cmd
->se_dev
;
3153 struct se_dev_entry
*dest_se_deve
= NULL
;
3154 struct se_lun
*se_lun
= cmd
->se_lun
, *tmp_lun
;
3155 struct se_node_acl
*pr_res_nacl
, *pr_reg_nacl
, *dest_node_acl
= NULL
;
3156 struct se_portal_group
*se_tpg
, *dest_se_tpg
= NULL
;
3157 const struct target_core_fabric_ops
*dest_tf_ops
= NULL
, *tf_ops
;
3158 struct t10_pr_registration
*pr_reg
, *pr_res_holder
, *dest_pr_reg
;
3159 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
3161 const unsigned char *initiator_str
;
3162 char *iport_ptr
= NULL
, i_buf
[PR_REG_ISID_ID_LEN
];
3163 u32 tid_len
, tmp_tid_len
;
3164 int new_reg
= 0, type
, scope
, matching_iname
;
3166 unsigned short rtpi
;
3167 unsigned char proto_ident
;
3169 if (!se_sess
|| !se_lun
) {
3170 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
3171 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3174 memset(i_buf
, 0, PR_REG_ISID_ID_LEN
);
3175 se_tpg
= se_sess
->se_tpg
;
3176 tf_ops
= se_tpg
->se_tpg_tfo
;
3178 * Follow logic from spc4r17 Section 5.7.8, Table 50 --
3179 * Register behaviors for a REGISTER AND MOVE service action
3181 * Locate the existing *pr_reg via struct se_node_acl pointers
3183 pr_reg
= core_scsi3_locate_pr_reg(cmd
->se_dev
, se_sess
->se_node_acl
,
3186 pr_err("SPC-3 PR: Unable to locate PR_REGISTERED"
3187 " *pr_reg for REGISTER_AND_MOVE\n");
3188 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3191 * The provided reservation key much match the existing reservation key
3192 * provided during this initiator's I_T nexus registration.
3194 if (res_key
!= pr_reg
->pr_res_key
) {
3195 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received"
3196 " res_key: 0x%016Lx does not match existing SA REGISTER"
3197 " res_key: 0x%016Lx\n", res_key
, pr_reg
->pr_res_key
);
3198 ret
= TCM_RESERVATION_CONFLICT
;
3199 goto out_put_pr_reg
;
3202 * The service active reservation key needs to be non zero
3205 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received zero"
3207 ret
= TCM_INVALID_PARAMETER_LIST
;
3208 goto out_put_pr_reg
;
3212 * Determine the Relative Target Port Identifier where the reservation
3213 * will be moved to for the TransportID containing SCSI initiator WWN
3216 buf
= transport_kmap_data_sg(cmd
);
3218 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3219 goto out_put_pr_reg
;
3222 rtpi
= get_unaligned_be16(&buf
[18]);
3223 tid_len
= get_unaligned_be32(&buf
[20]);
3224 transport_kunmap_data_sg(cmd
);
3227 if ((tid_len
+ 24) != cmd
->data_length
) {
3228 pr_err("SPC-3 PR: Illegal tid_len: %u + 24 byte header"
3229 " does not equal CDB data_length: %u\n", tid_len
,
3231 ret
= TCM_INVALID_PARAMETER_LIST
;
3232 goto out_put_pr_reg
;
3235 spin_lock(&dev
->se_port_lock
);
3236 list_for_each_entry(tmp_lun
, &dev
->dev_sep_list
, lun_dev_link
) {
3237 if (tmp_lun
->lun_rtpi
!= rtpi
)
3239 dest_se_tpg
= tmp_lun
->lun_tpg
;
3240 dest_tf_ops
= dest_se_tpg
->se_tpg_tfo
;
3244 atomic_inc_mb(&dest_se_tpg
->tpg_pr_ref_count
);
3245 spin_unlock(&dev
->se_port_lock
);
3247 if (core_scsi3_tpg_depend_item(dest_se_tpg
)) {
3248 pr_err("core_scsi3_tpg_depend_item() failed"
3249 " for dest_se_tpg\n");
3250 atomic_dec_mb(&dest_se_tpg
->tpg_pr_ref_count
);
3251 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3252 goto out_put_pr_reg
;
3255 spin_lock(&dev
->se_port_lock
);
3258 spin_unlock(&dev
->se_port_lock
);
3260 if (!dest_se_tpg
|| !dest_tf_ops
) {
3261 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3262 " fabric ops from Relative Target Port Identifier:"
3264 ret
= TCM_INVALID_PARAMETER_LIST
;
3265 goto out_put_pr_reg
;
3268 buf
= transport_kmap_data_sg(cmd
);
3270 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3271 goto out_put_pr_reg
;
3273 proto_ident
= (buf
[24] & 0x0f);
3275 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Extracted Protocol Identifier:"
3276 " 0x%02x\n", proto_ident
);
3278 if (proto_ident
!= dest_se_tpg
->proto_id
) {
3279 pr_err("SPC-3 PR REGISTER_AND_MOVE: Received"
3280 " proto_ident: 0x%02x does not match ident: 0x%02x"
3281 " from fabric: %s\n", proto_ident
,
3282 dest_se_tpg
->proto_id
,
3283 dest_tf_ops
->get_fabric_name());
3284 ret
= TCM_INVALID_PARAMETER_LIST
;
3287 initiator_str
= target_parse_pr_out_transport_id(dest_se_tpg
,
3288 (const char *)&buf
[24], &tmp_tid_len
, &iport_ptr
);
3289 if (!initiator_str
) {
3290 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3291 " initiator_str from Transport ID\n");
3292 ret
= TCM_INVALID_PARAMETER_LIST
;
3296 transport_kunmap_data_sg(cmd
);
3299 pr_debug("SPC-3 PR [%s] Extracted initiator %s identifier: %s"
3300 " %s\n", dest_tf_ops
->get_fabric_name(), (iport_ptr
!= NULL
) ?
3301 "port" : "device", initiator_str
, (iport_ptr
!= NULL
) ?
3304 * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3305 * action specifies a TransportID that is the same as the initiator port
3306 * of the I_T nexus for the command received, then the command shall
3307 * be terminated with CHECK CONDITION status, with the sense key set to
3308 * ILLEGAL REQUEST, and the additional sense code set to INVALID FIELD
3309 * IN PARAMETER LIST.
3311 pr_reg_nacl
= pr_reg
->pr_reg_nacl
;
3312 matching_iname
= (!strcmp(initiator_str
,
3313 pr_reg_nacl
->initiatorname
)) ? 1 : 0;
3314 if (!matching_iname
)
3315 goto after_iport_check
;
3317 if (!iport_ptr
|| !pr_reg
->isid_present_at_reg
) {
3318 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s"
3319 " matches: %s on received I_T Nexus\n", initiator_str
,
3320 pr_reg_nacl
->initiatorname
);
3321 ret
= TCM_INVALID_PARAMETER_LIST
;
3324 if (!strcmp(iport_ptr
, pr_reg
->pr_reg_isid
)) {
3325 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s %s"
3326 " matches: %s %s on received I_T Nexus\n",
3327 initiator_str
, iport_ptr
, pr_reg_nacl
->initiatorname
,
3328 pr_reg
->pr_reg_isid
);
3329 ret
= TCM_INVALID_PARAMETER_LIST
;
3334 * Locate the destination struct se_node_acl from the received Transport ID
3336 mutex_lock(&dest_se_tpg
->acl_node_mutex
);
3337 dest_node_acl
= __core_tpg_get_initiator_node_acl(dest_se_tpg
,
3340 atomic_inc_mb(&dest_node_acl
->acl_pr_ref_count
);
3341 mutex_unlock(&dest_se_tpg
->acl_node_mutex
);
3343 if (!dest_node_acl
) {
3344 pr_err("Unable to locate %s dest_node_acl for"
3345 " TransportID%s\n", dest_tf_ops
->get_fabric_name(),
3347 ret
= TCM_INVALID_PARAMETER_LIST
;
3351 if (core_scsi3_nodeacl_depend_item(dest_node_acl
)) {
3352 pr_err("core_scsi3_nodeacl_depend_item() for"
3353 " dest_node_acl\n");
3354 atomic_dec_mb(&dest_node_acl
->acl_pr_ref_count
);
3355 dest_node_acl
= NULL
;
3356 ret
= TCM_INVALID_PARAMETER_LIST
;
3360 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Found %s dest_node_acl:"
3361 " %s from TransportID\n", dest_tf_ops
->get_fabric_name(),
3362 dest_node_acl
->initiatorname
);
3365 * Locate the struct se_dev_entry pointer for the matching RELATIVE TARGET
3368 dest_se_deve
= core_get_se_deve_from_rtpi(dest_node_acl
, rtpi
);
3369 if (!dest_se_deve
) {
3370 pr_err("Unable to locate %s dest_se_deve from RTPI:"
3371 " %hu\n", dest_tf_ops
->get_fabric_name(), rtpi
);
3372 ret
= TCM_INVALID_PARAMETER_LIST
;
3376 if (core_scsi3_lunacl_depend_item(dest_se_deve
)) {
3377 pr_err("core_scsi3_lunacl_depend_item() failed\n");
3378 kref_put(&dest_se_deve
->pr_kref
, target_pr_kref_release
);
3379 dest_se_deve
= NULL
;
3380 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3384 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Located %s node %s LUN"
3385 " ACL for dest_se_deve->mapped_lun: %llu\n",
3386 dest_tf_ops
->get_fabric_name(), dest_node_acl
->initiatorname
,
3387 dest_se_deve
->mapped_lun
);
3390 * A persistent reservation needs to already existing in order to
3391 * successfully complete the REGISTER_AND_MOVE service action..
3393 spin_lock(&dev
->dev_reservation_lock
);
3394 pr_res_holder
= dev
->dev_pr_res_holder
;
3395 if (!pr_res_holder
) {
3396 pr_warn("SPC-3 PR REGISTER_AND_MOVE: No reservation"
3397 " currently held\n");
3398 spin_unlock(&dev
->dev_reservation_lock
);
3399 ret
= TCM_INVALID_CDB_FIELD
;
3403 * The received on I_T Nexus must be the reservation holder.
3405 * From spc4r17 section 5.7.8 Table 50 --
3406 * Register behaviors for a REGISTER AND MOVE service action
3408 if (!is_reservation_holder(pr_res_holder
, pr_reg
)) {
3409 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Calling I_T"
3410 " Nexus is not reservation holder\n");
3411 spin_unlock(&dev
->dev_reservation_lock
);
3412 ret
= TCM_RESERVATION_CONFLICT
;
3416 * From spc4r17 section 5.7.8: registering and moving reservation
3418 * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3419 * action is received and the established persistent reservation is a
3420 * Write Exclusive - All Registrants type or Exclusive Access -
3421 * All Registrants type reservation, then the command shall be completed
3422 * with RESERVATION CONFLICT status.
3424 if ((pr_res_holder
->pr_res_type
== PR_TYPE_WRITE_EXCLUSIVE_ALLREG
) ||
3425 (pr_res_holder
->pr_res_type
== PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
)) {
3426 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Unable to move"
3427 " reservation for type: %s\n",
3428 core_scsi3_pr_dump_type(pr_res_holder
->pr_res_type
));
3429 spin_unlock(&dev
->dev_reservation_lock
);
3430 ret
= TCM_RESERVATION_CONFLICT
;
3433 pr_res_nacl
= pr_res_holder
->pr_reg_nacl
;
3435 * b) Ignore the contents of the (received) SCOPE and TYPE fields;
3437 type
= pr_res_holder
->pr_res_type
;
3438 scope
= pr_res_holder
->pr_res_type
;
3440 * c) Associate the reservation key specified in the SERVICE ACTION
3441 * RESERVATION KEY field with the I_T nexus specified as the
3442 * destination of the register and move, where:
3443 * A) The I_T nexus is specified by the TransportID and the
3444 * RELATIVE TARGET PORT IDENTIFIER field (see 6.14.4); and
3445 * B) Regardless of the TransportID format used, the association for
3446 * the initiator port is based on either the initiator port name
3447 * (see 3.1.71) on SCSI transport protocols where port names are
3448 * required or the initiator port identifier (see 3.1.70) on SCSI
3449 * transport protocols where port names are not required;
3450 * d) Register the reservation key specified in the SERVICE ACTION
3451 * RESERVATION KEY field;
3452 * e) Retain the reservation key specified in the SERVICE ACTION
3453 * RESERVATION KEY field and associated information;
3455 * Also, It is not an error for a REGISTER AND MOVE service action to
3456 * register an I_T nexus that is already registered with the same
3457 * reservation key or a different reservation key.
3459 dest_pr_reg
= __core_scsi3_locate_pr_reg(dev
, dest_node_acl
,
3462 struct se_lun
*dest_lun
= rcu_dereference_check(dest_se_deve
->se_lun
,
3463 kref_read(&dest_se_deve
->pr_kref
) != 0);
3465 spin_unlock(&dev
->dev_reservation_lock
);
3466 if (core_scsi3_alloc_registration(cmd
->se_dev
, dest_node_acl
,
3467 dest_lun
, dest_se_deve
, dest_se_deve
->mapped_lun
,
3468 iport_ptr
, sa_res_key
, 0, aptpl
, 2, 1)) {
3469 ret
= TCM_INVALID_PARAMETER_LIST
;
3472 spin_lock(&dev
->dev_reservation_lock
);
3473 dest_pr_reg
= __core_scsi3_locate_pr_reg(dev
, dest_node_acl
,
3478 * f) Release the persistent reservation for the persistent reservation
3479 * holder (i.e., the I_T nexus on which the
3481 __core_scsi3_complete_pro_release(dev
, pr_res_nacl
,
3482 dev
->dev_pr_res_holder
, 0, 0);
3484 * g) Move the persistent reservation to the specified I_T nexus using
3485 * the same scope and type as the persistent reservation released in
3488 dev
->dev_pr_res_holder
= dest_pr_reg
;
3489 dest_pr_reg
->pr_res_holder
= 1;
3490 dest_pr_reg
->pr_res_type
= type
;
3491 pr_reg
->pr_res_scope
= scope
;
3492 core_pr_dump_initiator_port(pr_reg
, i_buf
, PR_REG_ISID_ID_LEN
);
3494 * Increment PRGeneration for existing registrations..
3497 dest_pr_reg
->pr_res_generation
= pr_tmpl
->pr_generation
++;
3498 spin_unlock(&dev
->dev_reservation_lock
);
3500 pr_debug("SPC-3 PR [%s] Service Action: REGISTER_AND_MOVE"
3501 " created new reservation holder TYPE: %s on object RTPI:"
3502 " %hu PRGeneration: 0x%08x\n", dest_tf_ops
->get_fabric_name(),
3503 core_scsi3_pr_dump_type(type
), rtpi
,
3504 dest_pr_reg
->pr_res_generation
);
3505 pr_debug("SPC-3 PR Successfully moved reservation from"
3506 " %s Fabric Node: %s%s -> %s Fabric Node: %s %s\n",
3507 tf_ops
->get_fabric_name(), pr_reg_nacl
->initiatorname
,
3508 i_buf
, dest_tf_ops
->get_fabric_name(),
3509 dest_node_acl
->initiatorname
, (iport_ptr
!= NULL
) ?
3512 * It is now safe to release configfs group dependencies for destination
3513 * of Transport ID Initiator Device/Port Identifier
3515 core_scsi3_lunacl_undepend_item(dest_se_deve
);
3516 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
3517 core_scsi3_tpg_undepend_item(dest_se_tpg
);
3519 * h) If the UNREG bit is set to one, unregister (see 5.7.11.3) the I_T
3520 * nexus on which PERSISTENT RESERVE OUT command was received.
3523 spin_lock(&pr_tmpl
->registration_lock
);
3524 __core_scsi3_free_registration(dev
, pr_reg
, NULL
, 1);
3525 spin_unlock(&pr_tmpl
->registration_lock
);
3527 core_scsi3_put_pr_reg(pr_reg
);
3529 core_scsi3_update_and_write_aptpl(cmd
->se_dev
, aptpl
);
3531 transport_kunmap_data_sg(cmd
);
3533 core_scsi3_put_pr_reg(dest_pr_reg
);
3537 transport_kunmap_data_sg(cmd
);
3539 core_scsi3_lunacl_undepend_item(dest_se_deve
);
3541 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
3542 core_scsi3_tpg_undepend_item(dest_se_tpg
);
3545 core_scsi3_put_pr_reg(pr_reg
);
3550 * See spc4r17 section 6.14 Table 170
3553 target_scsi3_emulate_pr_out(struct se_cmd
*cmd
)
3555 struct se_device
*dev
= cmd
->se_dev
;
3556 unsigned char *cdb
= &cmd
->t_task_cdb
[0];
3558 u64 res_key
, sa_res_key
;
3559 int sa
, scope
, type
, aptpl
;
3560 int spec_i_pt
= 0, all_tg_pt
= 0, unreg
= 0;
3564 * Following spc2r20 5.5.1 Reservations overview:
3566 * If a logical unit has been reserved by any RESERVE command and is
3567 * still reserved by any initiator, all PERSISTENT RESERVE IN and all
3568 * PERSISTENT RESERVE OUT commands shall conflict regardless of
3569 * initiator or service action and shall terminate with a RESERVATION
3572 if (cmd
->se_dev
->dev_reservation_flags
& DRF_SPC2_RESERVATIONS
) {
3573 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
3574 " SPC-2 reservation is held, returning"
3575 " RESERVATION_CONFLICT\n");
3576 return TCM_RESERVATION_CONFLICT
;
3580 * FIXME: A NULL struct se_session pointer means an this is not coming from
3581 * a $FABRIC_MOD's nexus, but from internal passthrough ops.
3584 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3586 if (cmd
->data_length
< 24) {
3587 pr_warn("SPC-PR: Received PR OUT parameter list"
3588 " length too small: %u\n", cmd
->data_length
);
3589 return TCM_PARAMETER_LIST_LENGTH_ERROR
;
3593 * From the PERSISTENT_RESERVE_OUT command descriptor block (CDB)
3595 sa
= (cdb
[1] & 0x1f);
3596 scope
= (cdb
[2] & 0xf0);
3597 type
= (cdb
[2] & 0x0f);
3599 buf
= transport_kmap_data_sg(cmd
);
3601 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3604 * From PERSISTENT_RESERVE_OUT parameter list (payload)
3606 res_key
= get_unaligned_be64(&buf
[0]);
3607 sa_res_key
= get_unaligned_be64(&buf
[8]);
3609 * REGISTER_AND_MOVE uses a different SA parameter list containing
3610 * SCSI TransportIDs.
3612 if (sa
!= PRO_REGISTER_AND_MOVE
) {
3613 spec_i_pt
= (buf
[20] & 0x08);
3614 all_tg_pt
= (buf
[20] & 0x04);
3615 aptpl
= (buf
[20] & 0x01);
3617 aptpl
= (buf
[17] & 0x01);
3618 unreg
= (buf
[17] & 0x02);
3621 * If the backend device has been configured to force APTPL metadata
3622 * write-out, go ahead and propigate aptpl=1 down now.
3624 if (dev
->dev_attrib
.force_pr_aptpl
)
3627 transport_kunmap_data_sg(cmd
);
3631 * SPEC_I_PT=1 is only valid for Service action: REGISTER
3633 if (spec_i_pt
&& (sa
!= PRO_REGISTER
))
3634 return TCM_INVALID_PARAMETER_LIST
;
3637 * From spc4r17 section 6.14:
3639 * If the SPEC_I_PT bit is set to zero, the service action is not
3640 * REGISTER AND MOVE, and the parameter list length is not 24, then
3641 * the command shall be terminated with CHECK CONDITION status, with
3642 * the sense key set to ILLEGAL REQUEST, and the additional sense
3643 * code set to PARAMETER LIST LENGTH ERROR.
3645 if (!spec_i_pt
&& (sa
!= PRO_REGISTER_AND_MOVE
) &&
3646 (cmd
->data_length
!= 24)) {
3647 pr_warn("SPC-PR: Received PR OUT illegal parameter"
3648 " list length: %u\n", cmd
->data_length
);
3649 return TCM_PARAMETER_LIST_LENGTH_ERROR
;
3653 * (core_scsi3_emulate_pro_* function parameters
3654 * are defined by spc4r17 Table 174:
3655 * PERSISTENT_RESERVE_OUT service actions and valid parameters.
3659 ret
= core_scsi3_emulate_pro_register(cmd
,
3660 res_key
, sa_res_key
, aptpl
, all_tg_pt
, spec_i_pt
, REGISTER
);
3663 ret
= core_scsi3_emulate_pro_reserve(cmd
, type
, scope
, res_key
);
3666 ret
= core_scsi3_emulate_pro_release(cmd
, type
, scope
, res_key
);
3669 ret
= core_scsi3_emulate_pro_clear(cmd
, res_key
);
3672 ret
= core_scsi3_emulate_pro_preempt(cmd
, type
, scope
,
3673 res_key
, sa_res_key
, PREEMPT
);
3675 case PRO_PREEMPT_AND_ABORT
:
3676 ret
= core_scsi3_emulate_pro_preempt(cmd
, type
, scope
,
3677 res_key
, sa_res_key
, PREEMPT_AND_ABORT
);
3679 case PRO_REGISTER_AND_IGNORE_EXISTING_KEY
:
3680 ret
= core_scsi3_emulate_pro_register(cmd
,
3681 0, sa_res_key
, aptpl
, all_tg_pt
, spec_i_pt
, REGISTER_AND_IGNORE_EXISTING_KEY
);
3683 case PRO_REGISTER_AND_MOVE
:
3684 ret
= core_scsi3_emulate_pro_register_and_move(cmd
, res_key
,
3685 sa_res_key
, aptpl
, unreg
);
3688 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
3689 " action: 0x%02x\n", sa
);
3690 return TCM_INVALID_CDB_FIELD
;
3694 target_complete_cmd(cmd
, GOOD
);
3699 * PERSISTENT_RESERVE_IN Service Action READ_KEYS
3701 * See spc4r17 section 5.7.6.2 and section 6.13.2, Table 160
3703 static sense_reason_t
3704 core_scsi3_pri_read_keys(struct se_cmd
*cmd
)
3706 struct se_device
*dev
= cmd
->se_dev
;
3707 struct t10_pr_registration
*pr_reg
;
3709 u32 add_len
= 0, off
= 8;
3711 if (cmd
->data_length
< 8) {
3712 pr_err("PRIN SA READ_KEYS SCSI Data Length: %u"
3713 " too small\n", cmd
->data_length
);
3714 return TCM_INVALID_CDB_FIELD
;
3717 buf
= transport_kmap_data_sg(cmd
);
3719 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3721 put_unaligned_be32(dev
->t10_pr
.pr_generation
, buf
);
3723 spin_lock(&dev
->t10_pr
.registration_lock
);
3724 list_for_each_entry(pr_reg
, &dev
->t10_pr
.registration_list
,
3727 * Check for overflow of 8byte PRI READ_KEYS payload and
3728 * next reservation key list descriptor.
3730 if ((add_len
+ 8) > (cmd
->data_length
- 8))
3733 put_unaligned_be64(pr_reg
->pr_res_key
, &buf
[off
]);
3737 spin_unlock(&dev
->t10_pr
.registration_lock
);
3739 put_unaligned_be32(add_len
, &buf
[4]);
3741 transport_kunmap_data_sg(cmd
);
3747 * PERSISTENT_RESERVE_IN Service Action READ_RESERVATION
3749 * See spc4r17 section 5.7.6.3 and section 6.13.3.2 Table 161 and 162
3751 static sense_reason_t
3752 core_scsi3_pri_read_reservation(struct se_cmd
*cmd
)
3754 struct se_device
*dev
= cmd
->se_dev
;
3755 struct t10_pr_registration
*pr_reg
;
3758 u32 add_len
= 16; /* Hardcoded to 16 when a reservation is held. */
3760 if (cmd
->data_length
< 8) {
3761 pr_err("PRIN SA READ_RESERVATIONS SCSI Data Length: %u"
3762 " too small\n", cmd
->data_length
);
3763 return TCM_INVALID_CDB_FIELD
;
3766 buf
= transport_kmap_data_sg(cmd
);
3768 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3770 put_unaligned_be32(dev
->t10_pr
.pr_generation
, &buf
[0]);
3772 spin_lock(&dev
->dev_reservation_lock
);
3773 pr_reg
= dev
->dev_pr_res_holder
;
3776 * Set the hardcoded Additional Length
3778 put_unaligned_be32(add_len
, &buf
[4]);
3780 if (cmd
->data_length
< 22)
3784 * Set the Reservation key.
3786 * From spc4r17, section 5.7.10:
3787 * A persistent reservation holder has its reservation key
3788 * returned in the parameter data from a PERSISTENT
3789 * RESERVE IN command with READ RESERVATION service action as
3791 * a) For a persistent reservation of the type Write Exclusive
3792 * - All Registrants or Exclusive Access  All Regitrants,
3793 * the reservation key shall be set to zero; or
3794 * b) For all other persistent reservation types, the
3795 * reservation key shall be set to the registered
3796 * reservation key for the I_T nexus that holds the
3797 * persistent reservation.
3799 if ((pr_reg
->pr_res_type
== PR_TYPE_WRITE_EXCLUSIVE_ALLREG
) ||
3800 (pr_reg
->pr_res_type
== PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
))
3803 pr_res_key
= pr_reg
->pr_res_key
;
3805 put_unaligned_be64(pr_res_key
, &buf
[8]);
3807 * Set the SCOPE and TYPE
3809 buf
[21] = (pr_reg
->pr_res_scope
& 0xf0) |
3810 (pr_reg
->pr_res_type
& 0x0f);
3814 spin_unlock(&dev
->dev_reservation_lock
);
3815 transport_kunmap_data_sg(cmd
);
3821 * PERSISTENT_RESERVE_IN Service Action REPORT_CAPABILITIES
3823 * See spc4r17 section 6.13.4 Table 165
3825 static sense_reason_t
3826 core_scsi3_pri_report_capabilities(struct se_cmd
*cmd
)
3828 struct se_device
*dev
= cmd
->se_dev
;
3829 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
3831 u16 add_len
= 8; /* Hardcoded to 8. */
3833 if (cmd
->data_length
< 6) {
3834 pr_err("PRIN SA REPORT_CAPABILITIES SCSI Data Length:"
3835 " %u too small\n", cmd
->data_length
);
3836 return TCM_INVALID_CDB_FIELD
;
3839 buf
= transport_kmap_data_sg(cmd
);
3841 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3843 put_unaligned_be16(add_len
, &buf
[0]);
3844 buf
[2] |= 0x10; /* CRH: Compatible Reservation Hanlding bit. */
3845 buf
[2] |= 0x08; /* SIP_C: Specify Initiator Ports Capable bit */
3846 buf
[2] |= 0x04; /* ATP_C: All Target Ports Capable bit */
3847 buf
[2] |= 0x01; /* PTPL_C: Persistence across Target Power Loss bit */
3849 * We are filling in the PERSISTENT RESERVATION TYPE MASK below, so
3850 * set the TMV: Task Mask Valid bit.
3854 * Change ALLOW COMMANDs to 0x20 or 0x40 later from Table 166
3856 buf
[3] |= 0x10; /* ALLOW COMMANDs field 001b */
3858 * PTPL_A: Persistence across Target Power Loss Active bit
3860 if (pr_tmpl
->pr_aptpl_active
)
3863 * Setup the PERSISTENT RESERVATION TYPE MASK from Table 167
3865 buf
[4] |= 0x80; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3866 buf
[4] |= 0x40; /* PR_TYPE_EXCLUSIVE_ACCESS_REGONLY */
3867 buf
[4] |= 0x20; /* PR_TYPE_WRITE_EXCLUSIVE_REGONLY */
3868 buf
[4] |= 0x08; /* PR_TYPE_EXCLUSIVE_ACCESS */
3869 buf
[4] |= 0x02; /* PR_TYPE_WRITE_EXCLUSIVE */
3870 buf
[5] |= 0x01; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3872 transport_kunmap_data_sg(cmd
);
3878 * PERSISTENT_RESERVE_IN Service Action READ_FULL_STATUS
3880 * See spc4r17 section 6.13.5 Table 168 and 169
3882 static sense_reason_t
3883 core_scsi3_pri_read_full_status(struct se_cmd
*cmd
)
3885 struct se_device
*dev
= cmd
->se_dev
;
3886 struct se_node_acl
*se_nacl
;
3887 struct se_portal_group
*se_tpg
;
3888 struct t10_pr_registration
*pr_reg
, *pr_reg_tmp
;
3889 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
3891 u32 add_desc_len
= 0, add_len
= 0;
3892 u32 off
= 8; /* off into first Full Status descriptor */
3893 int format_code
= 0, pr_res_type
= 0, pr_res_scope
= 0;
3894 int exp_desc_len
, desc_len
;
3895 bool all_reg
= false;
3897 if (cmd
->data_length
< 8) {
3898 pr_err("PRIN SA READ_FULL_STATUS SCSI Data Length: %u"
3899 " too small\n", cmd
->data_length
);
3900 return TCM_INVALID_CDB_FIELD
;
3903 buf
= transport_kmap_data_sg(cmd
);
3905 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3907 put_unaligned_be32(dev
->t10_pr
.pr_generation
, &buf
[0]);
3909 spin_lock(&dev
->dev_reservation_lock
);
3910 if (dev
->dev_pr_res_holder
) {
3911 struct t10_pr_registration
*pr_holder
= dev
->dev_pr_res_holder
;
3913 if (pr_holder
->pr_res_type
== PR_TYPE_WRITE_EXCLUSIVE_ALLREG
||
3914 pr_holder
->pr_res_type
== PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
) {
3916 pr_res_type
= pr_holder
->pr_res_type
;
3917 pr_res_scope
= pr_holder
->pr_res_scope
;
3920 spin_unlock(&dev
->dev_reservation_lock
);
3922 spin_lock(&pr_tmpl
->registration_lock
);
3923 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
,
3924 &pr_tmpl
->registration_list
, pr_reg_list
) {
3926 se_nacl
= pr_reg
->pr_reg_nacl
;
3927 se_tpg
= pr_reg
->pr_reg_nacl
->se_tpg
;
3930 atomic_inc_mb(&pr_reg
->pr_res_holders
);
3931 spin_unlock(&pr_tmpl
->registration_lock
);
3933 * Determine expected length of $FABRIC_MOD specific
3934 * TransportID full status descriptor..
3936 exp_desc_len
= target_get_pr_transport_id_len(se_nacl
, pr_reg
,
3938 if (exp_desc_len
< 0 ||
3939 exp_desc_len
+ add_len
> cmd
->data_length
) {
3940 pr_warn("SPC-3 PRIN READ_FULL_STATUS ran"
3941 " out of buffer: %d\n", cmd
->data_length
);
3942 spin_lock(&pr_tmpl
->registration_lock
);
3943 atomic_dec_mb(&pr_reg
->pr_res_holders
);
3947 * Set RESERVATION KEY
3949 put_unaligned_be64(pr_reg
->pr_res_key
, &buf
[off
]);
3951 off
+= 4; /* Skip Over Reserved area */
3954 * Set ALL_TG_PT bit if PROUT SA REGISTER had this set.
3956 if (pr_reg
->pr_reg_all_tg_pt
)
3959 * The struct se_lun pointer will be present for the
3960 * reservation holder for PR_HOLDER bit.
3962 * Also, if this registration is the reservation
3963 * holder or there is an All Registrants reservation
3964 * active, fill in SCOPE and TYPE in the next byte.
3966 if (pr_reg
->pr_res_holder
) {
3968 buf
[off
++] = (pr_reg
->pr_res_scope
& 0xf0) |
3969 (pr_reg
->pr_res_type
& 0x0f);
3970 } else if (all_reg
) {
3972 buf
[off
++] = (pr_res_scope
& 0xf0) |
3973 (pr_res_type
& 0x0f);
3978 off
+= 4; /* Skip over reserved area */
3980 * From spc4r17 6.3.15:
3982 * If the ALL_TG_PT bit set to zero, the RELATIVE TARGET PORT
3983 * IDENTIFIER field contains the relative port identifier (see
3984 * 3.1.120) of the target port that is part of the I_T nexus
3985 * described by this full status descriptor. If the ALL_TG_PT
3986 * bit is set to one, the contents of the RELATIVE TARGET PORT
3987 * IDENTIFIER field are not defined by this standard.
3989 if (!pr_reg
->pr_reg_all_tg_pt
) {
3990 u16 sep_rtpi
= pr_reg
->tg_pt_sep_rtpi
;
3992 put_unaligned_be16(sep_rtpi
, &buf
[off
]);
3995 off
+= 2; /* Skip over RELATIVE TARGET PORT IDENTIFIER */
3997 buf
[off
+4] = se_tpg
->proto_id
;
4000 * Now, have the $FABRIC_MOD fill in the transport ID.
4002 desc_len
= target_get_pr_transport_id(se_nacl
, pr_reg
,
4003 &format_code
, &buf
[off
+4]);
4005 spin_lock(&pr_tmpl
->registration_lock
);
4006 atomic_dec_mb(&pr_reg
->pr_res_holders
);
4011 * Set the ADDITIONAL DESCRIPTOR LENGTH
4013 put_unaligned_be32(desc_len
, &buf
[off
]);
4015 * Size of full desctipor header minus TransportID
4016 * containing $FABRIC_MOD specific) initiator device/port
4019 * See spc4r17 Section 6.13.5 Table 169
4021 add_desc_len
= (24 + desc_len
);
4024 add_len
+= add_desc_len
;
4026 spin_unlock(&pr_tmpl
->registration_lock
);
4028 * Set ADDITIONAL_LENGTH
4030 put_unaligned_be32(add_len
, &buf
[4]);
4032 transport_kunmap_data_sg(cmd
);
4038 target_scsi3_emulate_pr_in(struct se_cmd
*cmd
)
4043 * Following spc2r20 5.5.1 Reservations overview:
4045 * If a logical unit has been reserved by any RESERVE command and is
4046 * still reserved by any initiator, all PERSISTENT RESERVE IN and all
4047 * PERSISTENT RESERVE OUT commands shall conflict regardless of
4048 * initiator or service action and shall terminate with a RESERVATION
4051 if (cmd
->se_dev
->dev_reservation_flags
& DRF_SPC2_RESERVATIONS
) {
4052 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
4053 " SPC-2 reservation is held, returning"
4054 " RESERVATION_CONFLICT\n");
4055 return TCM_RESERVATION_CONFLICT
;
4058 switch (cmd
->t_task_cdb
[1] & 0x1f) {
4060 ret
= core_scsi3_pri_read_keys(cmd
);
4062 case PRI_READ_RESERVATION
:
4063 ret
= core_scsi3_pri_read_reservation(cmd
);
4065 case PRI_REPORT_CAPABILITIES
:
4066 ret
= core_scsi3_pri_report_capabilities(cmd
);
4068 case PRI_READ_FULL_STATUS
:
4069 ret
= core_scsi3_pri_read_full_status(cmd
);
4072 pr_err("Unknown PERSISTENT_RESERVE_IN service"
4073 " action: 0x%02x\n", cmd
->t_task_cdb
[1] & 0x1f);
4074 return TCM_INVALID_CDB_FIELD
;
4078 target_complete_cmd(cmd
, GOOD
);
4083 target_check_reservation(struct se_cmd
*cmd
)
4085 struct se_device
*dev
= cmd
->se_dev
;
4090 if (dev
->se_hba
->hba_flags
& HBA_FLAGS_INTERNAL_USE
)
4092 if (dev
->transport
->transport_flags
& TRANSPORT_FLAG_PASSTHROUGH_PGR
)
4095 spin_lock(&dev
->dev_reservation_lock
);
4096 if (dev
->dev_reservation_flags
& DRF_SPC2_RESERVATIONS
)
4097 ret
= target_scsi2_reservation_check(cmd
);
4099 ret
= target_scsi3_pr_reservation_check(cmd
);
4100 spin_unlock(&dev
->dev_reservation_lock
);