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/file.h>
31 #include <scsi/scsi.h>
32 #include <scsi/scsi_cmnd.h>
33 #include <asm/unaligned.h>
35 #include <target/target_core_base.h>
36 #include <target/target_core_backend.h>
37 #include <target/target_core_fabric.h>
39 #include "target_core_internal.h"
40 #include "target_core_pr.h"
41 #include "target_core_ua.h"
44 * Used for Specify Initiator Ports Capable Bit (SPEC_I_PT)
46 struct pr_transport_id_holder
{
48 struct t10_pr_registration
*dest_pr_reg
;
49 struct se_portal_group
*dest_tpg
;
50 struct se_node_acl
*dest_node_acl
;
51 struct se_dev_entry
*dest_se_deve
;
52 struct list_head dest_list
;
55 void core_pr_dump_initiator_port(
56 struct t10_pr_registration
*pr_reg
,
60 if (!pr_reg
->isid_present_at_reg
)
63 snprintf(buf
, size
, ",i,0x%s", pr_reg
->pr_reg_isid
);
68 REGISTER_AND_IGNORE_EXISTING_KEY
,
77 static void __core_scsi3_complete_pro_release(struct se_device
*, struct se_node_acl
*,
78 struct t10_pr_registration
*, int, int);
80 static int is_reservation_holder(
81 struct t10_pr_registration
*pr_res_holder
,
82 struct t10_pr_registration
*pr_reg
)
87 pr_res_type
= pr_res_holder
->pr_res_type
;
89 return pr_res_holder
== pr_reg
||
90 pr_res_type
== PR_TYPE_WRITE_EXCLUSIVE_ALLREG
||
91 pr_res_type
== PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
;
97 target_scsi2_reservation_check(struct se_cmd
*cmd
)
99 struct se_device
*dev
= cmd
->se_dev
;
100 struct se_session
*sess
= cmd
->se_sess
;
102 switch (cmd
->t_task_cdb
[0]) {
111 if (!dev
->dev_reserved_node_acl
|| !sess
)
114 if (dev
->dev_reserved_node_acl
!= sess
->se_node_acl
)
115 return TCM_RESERVATION_CONFLICT
;
117 if (dev
->dev_reservation_flags
& DRF_SPC2_RESERVATIONS_WITH_ISID
) {
118 if (dev
->dev_res_bin_isid
!= sess
->sess_bin_isid
)
119 return TCM_RESERVATION_CONFLICT
;
125 static struct t10_pr_registration
*core_scsi3_locate_pr_reg(struct se_device
*,
126 struct se_node_acl
*, struct se_session
*);
127 static void core_scsi3_put_pr_reg(struct t10_pr_registration
*);
129 static int target_check_scsi2_reservation_conflict(struct se_cmd
*cmd
)
131 struct se_session
*se_sess
= cmd
->se_sess
;
132 struct se_device
*dev
= cmd
->se_dev
;
133 struct t10_pr_registration
*pr_reg
;
134 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
137 pr_reg
= core_scsi3_locate_pr_reg(cmd
->se_dev
, se_sess
->se_node_acl
,
141 * From spc4r17 5.7.3 Exceptions to SPC-2 RESERVE and RELEASE
144 * A RESERVE(6) or RESERVE(10) command shall complete with GOOD
145 * status, but no reservation shall be established and the
146 * persistent reservation shall not be changed, if the command
147 * is received from a) and b) below.
149 * A RELEASE(6) or RELEASE(10) command shall complete with GOOD
150 * status, but the persistent reservation shall not be released,
151 * if the command is received from a) and b)
153 * a) An I_T nexus that is a persistent reservation holder; or
154 * b) An I_T nexus that is registered if a registrants only or
155 * all registrants type persistent reservation is present.
157 * In all other cases, a RESERVE(6) command, RESERVE(10) command,
158 * RELEASE(6) command, or RELEASE(10) command shall be processed
159 * as defined in SPC-2.
161 if (pr_reg
->pr_res_holder
) {
162 core_scsi3_put_pr_reg(pr_reg
);
165 if ((pr_reg
->pr_res_type
== PR_TYPE_WRITE_EXCLUSIVE_REGONLY
) ||
166 (pr_reg
->pr_res_type
== PR_TYPE_EXCLUSIVE_ACCESS_REGONLY
) ||
167 (pr_reg
->pr_res_type
== PR_TYPE_WRITE_EXCLUSIVE_ALLREG
) ||
168 (pr_reg
->pr_res_type
== PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
)) {
169 core_scsi3_put_pr_reg(pr_reg
);
172 core_scsi3_put_pr_reg(pr_reg
);
176 * Following spc2r20 5.5.1 Reservations overview:
178 * If a logical unit has executed a PERSISTENT RESERVE OUT
179 * command with the REGISTER or the REGISTER AND IGNORE
180 * EXISTING KEY service action and is still registered by any
181 * initiator, all RESERVE commands and all RELEASE commands
182 * regardless of initiator shall conflict and shall terminate
183 * with a RESERVATION CONFLICT status.
185 spin_lock(&pr_tmpl
->registration_lock
);
186 conflict
= (list_empty(&pr_tmpl
->registration_list
)) ? 0 : 1;
187 spin_unlock(&pr_tmpl
->registration_lock
);
191 pr_err("Received legacy SPC-2 RESERVE/RELEASE"
192 " while active SPC-3 registrations exist,"
193 " returning RESERVATION_CONFLICT\n");
201 target_scsi2_reservation_release(struct se_cmd
*cmd
)
203 struct se_device
*dev
= cmd
->se_dev
;
204 struct se_session
*sess
= cmd
->se_sess
;
205 struct se_portal_group
*tpg
;
208 if (!sess
|| !sess
->se_tpg
)
210 rc
= target_check_scsi2_reservation_conflict(cmd
);
214 return TCM_RESERVATION_CONFLICT
;
216 spin_lock(&dev
->dev_reservation_lock
);
217 if (!dev
->dev_reserved_node_acl
|| !sess
)
220 if (dev
->dev_reserved_node_acl
!= sess
->se_node_acl
)
223 if (dev
->dev_res_bin_isid
!= sess
->sess_bin_isid
)
226 dev
->dev_reserved_node_acl
= NULL
;
227 dev
->dev_reservation_flags
&= ~DRF_SPC2_RESERVATIONS
;
228 if (dev
->dev_reservation_flags
& DRF_SPC2_RESERVATIONS_WITH_ISID
) {
229 dev
->dev_res_bin_isid
= 0;
230 dev
->dev_reservation_flags
&= ~DRF_SPC2_RESERVATIONS_WITH_ISID
;
233 pr_debug("SCSI-2 Released reservation for %s LUN: %u ->"
234 " MAPPED LUN: %u for %s\n", tpg
->se_tpg_tfo
->get_fabric_name(),
235 cmd
->se_lun
->unpacked_lun
, cmd
->se_deve
->mapped_lun
,
236 sess
->se_node_acl
->initiatorname
);
239 spin_unlock(&dev
->dev_reservation_lock
);
241 target_complete_cmd(cmd
, GOOD
);
246 target_scsi2_reservation_reserve(struct se_cmd
*cmd
)
248 struct se_device
*dev
= cmd
->se_dev
;
249 struct se_session
*sess
= cmd
->se_sess
;
250 struct se_portal_group
*tpg
;
251 sense_reason_t ret
= 0;
254 if ((cmd
->t_task_cdb
[1] & 0x01) &&
255 (cmd
->t_task_cdb
[1] & 0x02)) {
256 pr_err("LongIO and Obselete Bits set, returning"
257 " ILLEGAL_REQUEST\n");
258 return TCM_UNSUPPORTED_SCSI_OPCODE
;
261 * This is currently the case for target_core_mod passthrough struct se_cmd
264 if (!sess
|| !sess
->se_tpg
)
266 rc
= target_check_scsi2_reservation_conflict(cmd
);
271 return TCM_RESERVATION_CONFLICT
;
274 spin_lock(&dev
->dev_reservation_lock
);
275 if (dev
->dev_reserved_node_acl
&&
276 (dev
->dev_reserved_node_acl
!= sess
->se_node_acl
)) {
277 pr_err("SCSI-2 RESERVATION CONFLIFT for %s fabric\n",
278 tpg
->se_tpg_tfo
->get_fabric_name());
279 pr_err("Original reserver LUN: %u %s\n",
280 cmd
->se_lun
->unpacked_lun
,
281 dev
->dev_reserved_node_acl
->initiatorname
);
282 pr_err("Current attempt - LUN: %u -> MAPPED LUN: %u"
283 " from %s \n", cmd
->se_lun
->unpacked_lun
,
284 cmd
->se_deve
->mapped_lun
,
285 sess
->se_node_acl
->initiatorname
);
286 ret
= TCM_RESERVATION_CONFLICT
;
290 dev
->dev_reserved_node_acl
= sess
->se_node_acl
;
291 dev
->dev_reservation_flags
|= DRF_SPC2_RESERVATIONS
;
292 if (sess
->sess_bin_isid
!= 0) {
293 dev
->dev_res_bin_isid
= sess
->sess_bin_isid
;
294 dev
->dev_reservation_flags
|= DRF_SPC2_RESERVATIONS_WITH_ISID
;
296 pr_debug("SCSI-2 Reserved %s LUN: %u -> MAPPED LUN: %u"
297 " for %s\n", tpg
->se_tpg_tfo
->get_fabric_name(),
298 cmd
->se_lun
->unpacked_lun
, cmd
->se_deve
->mapped_lun
,
299 sess
->se_node_acl
->initiatorname
);
302 spin_unlock(&dev
->dev_reservation_lock
);
305 target_complete_cmd(cmd
, GOOD
);
311 * Begin SPC-3/SPC-4 Persistent Reservations emulation support
313 * This function is called by those initiator ports who are *NOT*
314 * the active PR reservation holder when a reservation is present.
316 static int core_scsi3_pr_seq_non_holder(
320 unsigned char *cdb
= cmd
->t_task_cdb
;
321 struct se_dev_entry
*se_deve
;
322 struct se_session
*se_sess
= cmd
->se_sess
;
323 int other_cdb
= 0, ignore_reg
;
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 */
330 se_deve
= se_sess
->se_node_acl
->device_list
[cmd
->orig_fe_lun
];
332 * Determine if the registration should be ignored due to
333 * non-matching ISIDs in target_scsi3_pr_reservation_check().
335 ignore_reg
= (pr_reg_type
& 0x80000000);
337 pr_reg_type
&= ~0x80000000;
339 switch (pr_reg_type
) {
340 case PR_TYPE_WRITE_EXCLUSIVE
:
342 case PR_TYPE_EXCLUSIVE_ACCESS
:
344 * Some commands are only allowed for the persistent reservation
347 if ((se_deve
->def_pr_registered
) && !(ignore_reg
))
348 registered_nexus
= 1;
350 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY
:
352 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY
:
354 * Some commands are only allowed for registered I_T Nexuses.
357 if ((se_deve
->def_pr_registered
) && !(ignore_reg
))
358 registered_nexus
= 1;
360 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG
:
362 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
:
364 * Each registered I_T Nexus is a reservation holder.
367 if ((se_deve
->def_pr_registered
) && !(ignore_reg
))
368 registered_nexus
= 1;
374 * Referenced from spc4r17 table 45 for *NON* PR holder access
377 case SECURITY_PROTOCOL_IN
:
378 if (registered_nexus
)
386 case RECEIVE_DIAGNOSTIC
:
391 if (registered_nexus
) {
395 ret
= (we
) ? 0 : 1; /* Allowed Write Exclusive */
397 case PERSISTENT_RESERVE_OUT
:
399 * This follows PERSISTENT_RESERVE_OUT service actions that
400 * are allowed in the presence of various reservations.
401 * See spc4r17, table 46
403 switch (cdb
[1] & 0x1f) {
406 case PRO_PREEMPT_AND_ABORT
:
407 ret
= (registered_nexus
) ? 0 : 1;
410 case PRO_REGISTER_AND_IGNORE_EXISTING_KEY
:
413 case PRO_REGISTER_AND_MOVE
:
418 ret
= (registered_nexus
) ? 0 : 1;
421 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
422 " action: 0x%02x\n", cdb
[1] & 0x1f);
428 /* Handled by CRH=1 in target_scsi2_reservation_release() */
433 /* Handled by CRH=1 in target_scsi2_reservation_reserve() */
436 case TEST_UNIT_READY
:
437 ret
= (legacy
) ? 1 : 0; /* Conflict for legacy */
440 switch (cdb
[1] & 0x1f) {
441 case MI_MANAGEMENT_PROTOCOL_IN
:
442 if (registered_nexus
) {
446 ret
= (we
) ? 0 : 1; /* Allowed Write Exclusive */
448 case MI_REPORT_SUPPORTED_OPERATION_CODES
:
449 case MI_REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS
:
454 if (registered_nexus
) {
458 ret
= (we
) ? 0 : 1; /* Allowed Write Exclusive */
460 case MI_REPORT_ALIASES
:
461 case MI_REPORT_IDENTIFYING_INFORMATION
:
462 case MI_REPORT_PRIORITY
:
463 case MI_REPORT_TARGET_PGS
:
464 case MI_REPORT_TIMESTAMP
:
465 ret
= 0; /* Allowed */
468 pr_err("Unknown MI Service Action: 0x%02x\n",
473 case ACCESS_CONTROL_IN
:
474 case ACCESS_CONTROL_OUT
:
477 case SERVICE_ACTION_IN_12
:
480 case PERSISTENT_RESERVE_IN
:
481 ret
= 0; /*/ Allowed CDBs */
488 * Case where the CDB is explicitly allowed in the above switch
491 if (!ret
&& !other_cdb
) {
492 pr_debug("Allowing explicit CDB: 0x%02x for %s"
493 " reservation holder\n", cdb
[0],
494 core_scsi3_pr_dump_type(pr_reg_type
));
499 * Check if write exclusive initiator ports *NOT* holding the
500 * WRITE_EXCLUSIVE_* reservation.
502 if (we
&& !registered_nexus
) {
503 if (cmd
->data_direction
== DMA_TO_DEVICE
) {
505 * Conflict for write exclusive
507 pr_debug("%s Conflict for unregistered nexus"
508 " %s CDB: 0x%02x to %s reservation\n",
509 transport_dump_cmd_direction(cmd
),
510 se_sess
->se_node_acl
->initiatorname
, cdb
[0],
511 core_scsi3_pr_dump_type(pr_reg_type
));
515 * Allow non WRITE CDBs for all Write Exclusive
516 * PR TYPEs to pass for registered and
517 * non-registered_nexuxes NOT holding the reservation.
519 * We only make noise for the unregisterd nexuses,
520 * as we expect registered non-reservation holding
521 * nexuses to issue CDBs.
524 if (!registered_nexus
) {
525 pr_debug("Allowing implicit CDB: 0x%02x"
526 " for %s reservation on unregistered"
528 core_scsi3_pr_dump_type(pr_reg_type
));
533 } else if ((reg_only
) || (all_reg
)) {
534 if (registered_nexus
) {
536 * For PR_*_REG_ONLY and PR_*_ALL_REG reservations,
537 * allow commands from registered nexuses.
540 pr_debug("Allowing implicit CDB: 0x%02x for %s"
541 " reservation\n", cdb
[0],
542 core_scsi3_pr_dump_type(pr_reg_type
));
546 } else if (we
&& registered_nexus
) {
548 * Reads are allowed for Write Exclusive locks
549 * from all registrants.
551 if (cmd
->data_direction
== DMA_FROM_DEVICE
) {
552 pr_debug("Allowing READ CDB: 0x%02x for %s"
553 " reservation\n", cdb
[0],
554 core_scsi3_pr_dump_type(pr_reg_type
));
559 pr_debug("%s Conflict for %sregistered nexus %s CDB: 0x%2x"
560 " for %s reservation\n", transport_dump_cmd_direction(cmd
),
561 (registered_nexus
) ? "" : "un",
562 se_sess
->se_node_acl
->initiatorname
, cdb
[0],
563 core_scsi3_pr_dump_type(pr_reg_type
));
565 return 1; /* Conflict by default */
568 static sense_reason_t
569 target_scsi3_pr_reservation_check(struct se_cmd
*cmd
)
571 struct se_device
*dev
= cmd
->se_dev
;
572 struct se_session
*sess
= cmd
->se_sess
;
575 if (!dev
->dev_pr_res_holder
)
578 pr_reg_type
= dev
->dev_pr_res_holder
->pr_res_type
;
579 cmd
->pr_res_key
= dev
->dev_pr_res_holder
->pr_res_key
;
580 if (dev
->dev_pr_res_holder
->pr_reg_nacl
!= sess
->se_node_acl
)
581 goto check_nonholder
;
583 if (dev
->dev_pr_res_holder
->isid_present_at_reg
) {
584 if (dev
->dev_pr_res_holder
->pr_reg_bin_isid
!=
585 sess
->sess_bin_isid
) {
586 pr_reg_type
|= 0x80000000;
587 goto check_nonholder
;
594 if (core_scsi3_pr_seq_non_holder(cmd
, pr_reg_type
))
595 return TCM_RESERVATION_CONFLICT
;
599 static u32
core_scsi3_pr_generation(struct se_device
*dev
)
604 * PRGeneration field shall contain the value of a 32-bit wrapping
605 * counter mainted by the device server.
607 * Note that this is done regardless of Active Persist across
608 * Target PowerLoss (APTPL)
610 * See spc4r17 section 6.3.12 READ_KEYS service action
612 spin_lock(&dev
->dev_reservation_lock
);
613 prg
= dev
->t10_pr
.pr_generation
++;
614 spin_unlock(&dev
->dev_reservation_lock
);
619 static struct t10_pr_registration
*__core_scsi3_do_alloc_registration(
620 struct se_device
*dev
,
621 struct se_node_acl
*nacl
,
622 struct se_dev_entry
*deve
,
628 struct t10_pr_registration
*pr_reg
;
630 pr_reg
= kmem_cache_zalloc(t10_pr_reg_cache
, GFP_ATOMIC
);
632 pr_err("Unable to allocate struct t10_pr_registration\n");
636 INIT_LIST_HEAD(&pr_reg
->pr_reg_list
);
637 INIT_LIST_HEAD(&pr_reg
->pr_reg_abort_list
);
638 INIT_LIST_HEAD(&pr_reg
->pr_reg_aptpl_list
);
639 INIT_LIST_HEAD(&pr_reg
->pr_reg_atp_list
);
640 INIT_LIST_HEAD(&pr_reg
->pr_reg_atp_mem_list
);
641 atomic_set(&pr_reg
->pr_res_holders
, 0);
642 pr_reg
->pr_reg_nacl
= nacl
;
643 pr_reg
->pr_reg_deve
= deve
;
644 pr_reg
->pr_res_mapped_lun
= deve
->mapped_lun
;
645 pr_reg
->pr_aptpl_target_lun
= deve
->se_lun
->unpacked_lun
;
646 pr_reg
->pr_res_key
= sa_res_key
;
647 pr_reg
->pr_reg_all_tg_pt
= all_tg_pt
;
648 pr_reg
->pr_reg_aptpl
= aptpl
;
649 pr_reg
->pr_reg_tg_pt_lun
= deve
->se_lun
;
651 * If an ISID value for this SCSI Initiator Port exists,
652 * save it to the registration now.
655 pr_reg
->pr_reg_bin_isid
= get_unaligned_be64(isid
);
656 snprintf(pr_reg
->pr_reg_isid
, PR_REG_ISID_LEN
, "%s", isid
);
657 pr_reg
->isid_present_at_reg
= 1;
663 static int core_scsi3_lunacl_depend_item(struct se_dev_entry
*);
664 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry
*);
667 * Function used for handling PR registrations for ALL_TG_PT=1 and ALL_TG_PT=0
670 static struct t10_pr_registration
*__core_scsi3_alloc_registration(
671 struct se_device
*dev
,
672 struct se_node_acl
*nacl
,
673 struct se_dev_entry
*deve
,
679 struct se_dev_entry
*deve_tmp
;
680 struct se_node_acl
*nacl_tmp
;
681 struct se_port
*port
, *port_tmp
;
682 const struct target_core_fabric_ops
*tfo
= nacl
->se_tpg
->se_tpg_tfo
;
683 struct t10_pr_registration
*pr_reg
, *pr_reg_atp
, *pr_reg_tmp
, *pr_reg_tmp_safe
;
686 * Create a registration for the I_T Nexus upon which the
687 * PROUT REGISTER was received.
689 pr_reg
= __core_scsi3_do_alloc_registration(dev
, nacl
, deve
, isid
,
690 sa_res_key
, all_tg_pt
, aptpl
);
694 * Return pointer to pr_reg for ALL_TG_PT=0
699 * Create list of matching SCSI Initiator Port registrations
702 spin_lock(&dev
->se_port_lock
);
703 list_for_each_entry_safe(port
, port_tmp
, &dev
->dev_sep_list
, sep_list
) {
704 atomic_inc_mb(&port
->sep_tg_pt_ref_cnt
);
705 spin_unlock(&dev
->se_port_lock
);
707 spin_lock_bh(&port
->sep_alua_lock
);
708 list_for_each_entry(deve_tmp
, &port
->sep_alua_list
,
711 * This pointer will be NULL for demo mode MappedLUNs
712 * that have not been make explicit via a ConfigFS
713 * MappedLUN group for the SCSI Initiator Node ACL.
715 if (!deve_tmp
->se_lun_acl
)
718 nacl_tmp
= deve_tmp
->se_lun_acl
->se_lun_nacl
;
720 * Skip the matching struct se_node_acl that is allocated
723 if (nacl
== nacl_tmp
)
726 * Only perform PR registrations for target ports on
727 * the same fabric module as the REGISTER w/ ALL_TG_PT=1
730 if (tfo
!= nacl_tmp
->se_tpg
->se_tpg_tfo
)
733 * Look for a matching Initiator Node ACL in ASCII format
735 if (strcmp(nacl
->initiatorname
, nacl_tmp
->initiatorname
))
738 atomic_inc_mb(&deve_tmp
->pr_ref_count
);
739 spin_unlock_bh(&port
->sep_alua_lock
);
741 * Grab a configfs group dependency that is released
742 * for the exception path at label out: below, or upon
743 * completion of adding ALL_TG_PT=1 registrations in
744 * __core_scsi3_add_registration()
746 ret
= core_scsi3_lunacl_depend_item(deve_tmp
);
748 pr_err("core_scsi3_lunacl_depend"
750 atomic_dec_mb(&port
->sep_tg_pt_ref_cnt
);
751 atomic_dec_mb(&deve_tmp
->pr_ref_count
);
755 * Located a matching SCSI Initiator Port on a different
756 * port, allocate the pr_reg_atp and attach it to the
757 * pr_reg->pr_reg_atp_list that will be processed once
758 * the original *pr_reg is processed in
759 * __core_scsi3_add_registration()
761 pr_reg_atp
= __core_scsi3_do_alloc_registration(dev
,
762 nacl_tmp
, deve_tmp
, NULL
,
763 sa_res_key
, all_tg_pt
, aptpl
);
765 atomic_dec_mb(&port
->sep_tg_pt_ref_cnt
);
766 atomic_dec_mb(&deve_tmp
->pr_ref_count
);
767 core_scsi3_lunacl_undepend_item(deve_tmp
);
771 list_add_tail(&pr_reg_atp
->pr_reg_atp_mem_list
,
772 &pr_reg
->pr_reg_atp_list
);
773 spin_lock_bh(&port
->sep_alua_lock
);
775 spin_unlock_bh(&port
->sep_alua_lock
);
777 spin_lock(&dev
->se_port_lock
);
778 atomic_dec_mb(&port
->sep_tg_pt_ref_cnt
);
780 spin_unlock(&dev
->se_port_lock
);
784 list_for_each_entry_safe(pr_reg_tmp
, pr_reg_tmp_safe
,
785 &pr_reg
->pr_reg_atp_list
, pr_reg_atp_mem_list
) {
786 list_del(&pr_reg_tmp
->pr_reg_atp_mem_list
);
787 core_scsi3_lunacl_undepend_item(pr_reg_tmp
->pr_reg_deve
);
788 kmem_cache_free(t10_pr_reg_cache
, pr_reg_tmp
);
790 kmem_cache_free(t10_pr_reg_cache
, pr_reg
);
794 int core_scsi3_alloc_aptpl_registration(
795 struct t10_reservation
*pr_tmpl
,
797 unsigned char *i_port
,
800 unsigned char *t_port
,
807 struct t10_pr_registration
*pr_reg
;
809 if (!i_port
|| !t_port
|| !sa_res_key
) {
810 pr_err("Illegal parameters for APTPL registration\n");
814 pr_reg
= kmem_cache_zalloc(t10_pr_reg_cache
, GFP_KERNEL
);
816 pr_err("Unable to allocate struct t10_pr_registration\n");
820 INIT_LIST_HEAD(&pr_reg
->pr_reg_list
);
821 INIT_LIST_HEAD(&pr_reg
->pr_reg_abort_list
);
822 INIT_LIST_HEAD(&pr_reg
->pr_reg_aptpl_list
);
823 INIT_LIST_HEAD(&pr_reg
->pr_reg_atp_list
);
824 INIT_LIST_HEAD(&pr_reg
->pr_reg_atp_mem_list
);
825 atomic_set(&pr_reg
->pr_res_holders
, 0);
826 pr_reg
->pr_reg_nacl
= NULL
;
827 pr_reg
->pr_reg_deve
= NULL
;
828 pr_reg
->pr_res_mapped_lun
= mapped_lun
;
829 pr_reg
->pr_aptpl_target_lun
= target_lun
;
830 pr_reg
->pr_res_key
= sa_res_key
;
831 pr_reg
->pr_reg_all_tg_pt
= all_tg_pt
;
832 pr_reg
->pr_reg_aptpl
= 1;
833 pr_reg
->pr_reg_tg_pt_lun
= NULL
;
834 pr_reg
->pr_res_scope
= 0; /* Always LUN_SCOPE */
835 pr_reg
->pr_res_type
= type
;
837 * If an ISID value had been saved in APTPL metadata for this
838 * SCSI Initiator Port, restore it now.
841 pr_reg
->pr_reg_bin_isid
= get_unaligned_be64(isid
);
842 snprintf(pr_reg
->pr_reg_isid
, PR_REG_ISID_LEN
, "%s", isid
);
843 pr_reg
->isid_present_at_reg
= 1;
846 * Copy the i_port and t_port information from caller.
848 snprintf(pr_reg
->pr_iport
, PR_APTPL_MAX_IPORT_LEN
, "%s", i_port
);
849 snprintf(pr_reg
->pr_tport
, PR_APTPL_MAX_TPORT_LEN
, "%s", t_port
);
850 pr_reg
->pr_reg_tpgt
= tpgt
;
852 * Set pr_res_holder from caller, the pr_reg who is the reservation
853 * holder will get it's pointer set in core_scsi3_aptpl_reserve() once
854 * the Initiator Node LUN ACL from the fabric module is created for
857 pr_reg
->pr_res_holder
= res_holder
;
859 list_add_tail(&pr_reg
->pr_reg_aptpl_list
, &pr_tmpl
->aptpl_reg_list
);
860 pr_debug("SPC-3 PR APTPL Successfully added registration%s from"
861 " metadata\n", (res_holder
) ? "+reservation" : "");
865 static void core_scsi3_aptpl_reserve(
866 struct se_device
*dev
,
867 struct se_portal_group
*tpg
,
868 struct se_node_acl
*node_acl
,
869 struct t10_pr_registration
*pr_reg
)
871 char i_buf
[PR_REG_ISID_ID_LEN
];
873 memset(i_buf
, 0, PR_REG_ISID_ID_LEN
);
874 core_pr_dump_initiator_port(pr_reg
, i_buf
, PR_REG_ISID_ID_LEN
);
876 spin_lock(&dev
->dev_reservation_lock
);
877 dev
->dev_pr_res_holder
= pr_reg
;
878 spin_unlock(&dev
->dev_reservation_lock
);
880 pr_debug("SPC-3 PR [%s] Service Action: APTPL RESERVE created"
881 " new reservation holder TYPE: %s ALL_TG_PT: %d\n",
882 tpg
->se_tpg_tfo
->get_fabric_name(),
883 core_scsi3_pr_dump_type(pr_reg
->pr_res_type
),
884 (pr_reg
->pr_reg_all_tg_pt
) ? 1 : 0);
885 pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
886 tpg
->se_tpg_tfo
->get_fabric_name(), node_acl
->initiatorname
,
890 static void __core_scsi3_add_registration(struct se_device
*, struct se_node_acl
*,
891 struct t10_pr_registration
*, enum register_type
, int);
893 static int __core_scsi3_check_aptpl_registration(
894 struct se_device
*dev
,
895 struct se_portal_group
*tpg
,
898 struct se_node_acl
*nacl
,
899 struct se_dev_entry
*deve
)
901 struct t10_pr_registration
*pr_reg
, *pr_reg_tmp
;
902 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
903 unsigned char i_port
[PR_APTPL_MAX_IPORT_LEN
];
904 unsigned char t_port
[PR_APTPL_MAX_TPORT_LEN
];
907 memset(i_port
, 0, PR_APTPL_MAX_IPORT_LEN
);
908 memset(t_port
, 0, PR_APTPL_MAX_TPORT_LEN
);
910 * Copy Initiator Port information from struct se_node_acl
912 snprintf(i_port
, PR_APTPL_MAX_IPORT_LEN
, "%s", nacl
->initiatorname
);
913 snprintf(t_port
, PR_APTPL_MAX_TPORT_LEN
, "%s",
914 tpg
->se_tpg_tfo
->tpg_get_wwn(tpg
));
915 tpgt
= tpg
->se_tpg_tfo
->tpg_get_tag(tpg
);
917 * Look for the matching registrations+reservation from those
918 * created from APTPL metadata. Note that multiple registrations
919 * may exist for fabrics that use ISIDs in their SCSI Initiator Port
922 spin_lock(&pr_tmpl
->aptpl_reg_lock
);
923 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
, &pr_tmpl
->aptpl_reg_list
,
926 if (!strcmp(pr_reg
->pr_iport
, i_port
) &&
927 (pr_reg
->pr_res_mapped_lun
== deve
->mapped_lun
) &&
928 !(strcmp(pr_reg
->pr_tport
, t_port
)) &&
929 (pr_reg
->pr_reg_tpgt
== tpgt
) &&
930 (pr_reg
->pr_aptpl_target_lun
== target_lun
)) {
932 pr_reg
->pr_reg_nacl
= nacl
;
933 pr_reg
->pr_reg_deve
= deve
;
934 pr_reg
->pr_reg_tg_pt_lun
= lun
;
936 list_del(&pr_reg
->pr_reg_aptpl_list
);
937 spin_unlock(&pr_tmpl
->aptpl_reg_lock
);
939 * At this point all of the pointers in *pr_reg will
940 * be setup, so go ahead and add the registration.
943 __core_scsi3_add_registration(dev
, nacl
, pr_reg
, 0, 0);
945 * If this registration is the reservation holder,
946 * make that happen now..
948 if (pr_reg
->pr_res_holder
)
949 core_scsi3_aptpl_reserve(dev
, tpg
,
952 * Reenable pr_aptpl_active to accept new metadata
953 * updates once the SCSI device is active again..
955 spin_lock(&pr_tmpl
->aptpl_reg_lock
);
956 pr_tmpl
->pr_aptpl_active
= 1;
959 spin_unlock(&pr_tmpl
->aptpl_reg_lock
);
964 int core_scsi3_check_aptpl_registration(
965 struct se_device
*dev
,
966 struct se_portal_group
*tpg
,
968 struct se_node_acl
*nacl
,
971 struct se_dev_entry
*deve
= nacl
->device_list
[mapped_lun
];
973 if (dev
->dev_reservation_flags
& DRF_SPC2_RESERVATIONS
)
976 return __core_scsi3_check_aptpl_registration(dev
, tpg
, lun
,
977 lun
->unpacked_lun
, nacl
, deve
);
980 static void __core_scsi3_dump_registration(
981 const struct target_core_fabric_ops
*tfo
,
982 struct se_device
*dev
,
983 struct se_node_acl
*nacl
,
984 struct t10_pr_registration
*pr_reg
,
985 enum register_type register_type
)
987 struct se_portal_group
*se_tpg
= nacl
->se_tpg
;
988 char i_buf
[PR_REG_ISID_ID_LEN
];
990 memset(&i_buf
[0], 0, PR_REG_ISID_ID_LEN
);
991 core_pr_dump_initiator_port(pr_reg
, i_buf
, PR_REG_ISID_ID_LEN
);
993 pr_debug("SPC-3 PR [%s] Service Action: REGISTER%s Initiator"
994 " Node: %s%s\n", tfo
->get_fabric_name(), (register_type
== REGISTER_AND_MOVE
) ?
995 "_AND_MOVE" : (register_type
== REGISTER_AND_IGNORE_EXISTING_KEY
) ?
996 "_AND_IGNORE_EXISTING_KEY" : "", nacl
->initiatorname
,
998 pr_debug("SPC-3 PR [%s] registration on Target Port: %s,0x%04x\n",
999 tfo
->get_fabric_name(), tfo
->tpg_get_wwn(se_tpg
),
1000 tfo
->tpg_get_tag(se_tpg
));
1001 pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
1002 " Port(s)\n", tfo
->get_fabric_name(),
1003 (pr_reg
->pr_reg_all_tg_pt
) ? "ALL" : "SINGLE",
1004 dev
->transport
->name
);
1005 pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
1006 " 0x%08x APTPL: %d\n", tfo
->get_fabric_name(),
1007 pr_reg
->pr_res_key
, pr_reg
->pr_res_generation
,
1008 pr_reg
->pr_reg_aptpl
);
1012 * this function can be called with struct se_device->dev_reservation_lock
1013 * when register_move = 1
1015 static void __core_scsi3_add_registration(
1016 struct se_device
*dev
,
1017 struct se_node_acl
*nacl
,
1018 struct t10_pr_registration
*pr_reg
,
1019 enum register_type register_type
,
1022 const struct target_core_fabric_ops
*tfo
= nacl
->se_tpg
->se_tpg_tfo
;
1023 struct t10_pr_registration
*pr_reg_tmp
, *pr_reg_tmp_safe
;
1024 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
1027 * Increment PRgeneration counter for struct se_device upon a successful
1028 * REGISTER, see spc4r17 section 6.3.2 READ_KEYS service action
1030 * Also, when register_move = 1 for PROUT REGISTER_AND_MOVE service
1031 * action, the struct se_device->dev_reservation_lock will already be held,
1032 * so we do not call core_scsi3_pr_generation() which grabs the lock
1035 pr_reg
->pr_res_generation
= (register_move
) ?
1036 dev
->t10_pr
.pr_generation
++ :
1037 core_scsi3_pr_generation(dev
);
1039 spin_lock(&pr_tmpl
->registration_lock
);
1040 list_add_tail(&pr_reg
->pr_reg_list
, &pr_tmpl
->registration_list
);
1041 pr_reg
->pr_reg_deve
->def_pr_registered
= 1;
1043 __core_scsi3_dump_registration(tfo
, dev
, nacl
, pr_reg
, register_type
);
1044 spin_unlock(&pr_tmpl
->registration_lock
);
1046 * Skip extra processing for ALL_TG_PT=0 or REGISTER_AND_MOVE.
1048 if (!pr_reg
->pr_reg_all_tg_pt
|| register_move
)
1051 * Walk pr_reg->pr_reg_atp_list and add registrations for ALL_TG_PT=1
1052 * allocated in __core_scsi3_alloc_registration()
1054 list_for_each_entry_safe(pr_reg_tmp
, pr_reg_tmp_safe
,
1055 &pr_reg
->pr_reg_atp_list
, pr_reg_atp_mem_list
) {
1056 list_del(&pr_reg_tmp
->pr_reg_atp_mem_list
);
1058 pr_reg_tmp
->pr_res_generation
= core_scsi3_pr_generation(dev
);
1060 spin_lock(&pr_tmpl
->registration_lock
);
1061 list_add_tail(&pr_reg_tmp
->pr_reg_list
,
1062 &pr_tmpl
->registration_list
);
1063 pr_reg_tmp
->pr_reg_deve
->def_pr_registered
= 1;
1065 __core_scsi3_dump_registration(tfo
, dev
,
1066 pr_reg_tmp
->pr_reg_nacl
, pr_reg_tmp
,
1068 spin_unlock(&pr_tmpl
->registration_lock
);
1070 * Drop configfs group dependency reference from
1071 * __core_scsi3_alloc_registration()
1073 core_scsi3_lunacl_undepend_item(pr_reg_tmp
->pr_reg_deve
);
1077 static int core_scsi3_alloc_registration(
1078 struct se_device
*dev
,
1079 struct se_node_acl
*nacl
,
1080 struct se_dev_entry
*deve
,
1081 unsigned char *isid
,
1085 enum register_type register_type
,
1088 struct t10_pr_registration
*pr_reg
;
1090 pr_reg
= __core_scsi3_alloc_registration(dev
, nacl
, deve
, isid
,
1091 sa_res_key
, all_tg_pt
, aptpl
);
1095 __core_scsi3_add_registration(dev
, nacl
, pr_reg
,
1096 register_type
, register_move
);
1100 static struct t10_pr_registration
*__core_scsi3_locate_pr_reg(
1101 struct se_device
*dev
,
1102 struct se_node_acl
*nacl
,
1103 unsigned char *isid
)
1105 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
1106 struct t10_pr_registration
*pr_reg
, *pr_reg_tmp
;
1107 struct se_portal_group
*tpg
;
1109 spin_lock(&pr_tmpl
->registration_lock
);
1110 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
,
1111 &pr_tmpl
->registration_list
, pr_reg_list
) {
1113 * First look for a matching struct se_node_acl
1115 if (pr_reg
->pr_reg_nacl
!= nacl
)
1118 tpg
= pr_reg
->pr_reg_nacl
->se_tpg
;
1120 * If this registration does NOT contain a fabric provided
1121 * ISID, then we have found a match.
1123 if (!pr_reg
->isid_present_at_reg
) {
1125 * Determine if this SCSI device server requires that
1126 * SCSI Intiatior TransportID w/ ISIDs is enforced
1127 * for fabric modules (iSCSI) requiring them.
1129 if (tpg
->se_tpg_tfo
->sess_get_initiator_sid
!= NULL
) {
1130 if (dev
->dev_attrib
.enforce_pr_isids
)
1133 atomic_inc_mb(&pr_reg
->pr_res_holders
);
1134 spin_unlock(&pr_tmpl
->registration_lock
);
1138 * If the *pr_reg contains a fabric defined ISID for multi-value
1139 * SCSI Initiator Port TransportIDs, then we expect a valid
1140 * matching ISID to be provided by the local SCSI Initiator Port.
1144 if (strcmp(isid
, pr_reg
->pr_reg_isid
))
1147 atomic_inc_mb(&pr_reg
->pr_res_holders
);
1148 spin_unlock(&pr_tmpl
->registration_lock
);
1151 spin_unlock(&pr_tmpl
->registration_lock
);
1156 static struct t10_pr_registration
*core_scsi3_locate_pr_reg(
1157 struct se_device
*dev
,
1158 struct se_node_acl
*nacl
,
1159 struct se_session
*sess
)
1161 struct se_portal_group
*tpg
= nacl
->se_tpg
;
1162 unsigned char buf
[PR_REG_ISID_LEN
], *isid_ptr
= NULL
;
1164 if (tpg
->se_tpg_tfo
->sess_get_initiator_sid
!= NULL
) {
1165 memset(&buf
[0], 0, PR_REG_ISID_LEN
);
1166 tpg
->se_tpg_tfo
->sess_get_initiator_sid(sess
, &buf
[0],
1171 return __core_scsi3_locate_pr_reg(dev
, nacl
, isid_ptr
);
1174 static void core_scsi3_put_pr_reg(struct t10_pr_registration
*pr_reg
)
1176 atomic_dec_mb(&pr_reg
->pr_res_holders
);
1179 static int core_scsi3_check_implicit_release(
1180 struct se_device
*dev
,
1181 struct t10_pr_registration
*pr_reg
)
1183 struct se_node_acl
*nacl
= pr_reg
->pr_reg_nacl
;
1184 struct t10_pr_registration
*pr_res_holder
;
1187 spin_lock(&dev
->dev_reservation_lock
);
1188 pr_res_holder
= dev
->dev_pr_res_holder
;
1189 if (!pr_res_holder
) {
1190 spin_unlock(&dev
->dev_reservation_lock
);
1193 if (pr_res_holder
== pr_reg
) {
1195 * Perform an implicit RELEASE if the registration that
1196 * is being released is holding the reservation.
1198 * From spc4r17, section 5.7.11.1:
1200 * e) If the I_T nexus is the persistent reservation holder
1201 * and the persistent reservation is not an all registrants
1202 * type, then a PERSISTENT RESERVE OUT command with REGISTER
1203 * service action or REGISTER AND IGNORE EXISTING KEY
1204 * service action with the SERVICE ACTION RESERVATION KEY
1205 * field set to zero (see 5.7.11.3).
1207 __core_scsi3_complete_pro_release(dev
, nacl
, pr_reg
, 0, 1);
1210 * For 'All Registrants' reservation types, all existing
1211 * registrations are still processed as reservation holders
1212 * in core_scsi3_pr_seq_non_holder() after the initial
1213 * reservation holder is implicitly released here.
1215 } else if (pr_reg
->pr_reg_all_tg_pt
&&
1216 (!strcmp(pr_res_holder
->pr_reg_nacl
->initiatorname
,
1217 pr_reg
->pr_reg_nacl
->initiatorname
)) &&
1218 (pr_res_holder
->pr_res_key
== pr_reg
->pr_res_key
)) {
1219 pr_err("SPC-3 PR: Unable to perform ALL_TG_PT=1"
1220 " UNREGISTER while existing reservation with matching"
1221 " key 0x%016Lx is present from another SCSI Initiator"
1222 " Port\n", pr_reg
->pr_res_key
);
1225 spin_unlock(&dev
->dev_reservation_lock
);
1231 * Called with struct t10_reservation->registration_lock held.
1233 static void __core_scsi3_free_registration(
1234 struct se_device
*dev
,
1235 struct t10_pr_registration
*pr_reg
,
1236 struct list_head
*preempt_and_abort_list
,
1238 __releases(&pr_tmpl
->registration_lock
)
1239 __acquires(&pr_tmpl
->registration_lock
)
1241 const struct target_core_fabric_ops
*tfo
=
1242 pr_reg
->pr_reg_nacl
->se_tpg
->se_tpg_tfo
;
1243 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
1244 char i_buf
[PR_REG_ISID_ID_LEN
];
1246 memset(i_buf
, 0, PR_REG_ISID_ID_LEN
);
1247 core_pr_dump_initiator_port(pr_reg
, i_buf
, PR_REG_ISID_ID_LEN
);
1249 pr_reg
->pr_reg_deve
->def_pr_registered
= 0;
1250 pr_reg
->pr_reg_deve
->pr_res_key
= 0;
1251 if (!list_empty(&pr_reg
->pr_reg_list
))
1252 list_del(&pr_reg
->pr_reg_list
);
1254 * Caller accessing *pr_reg using core_scsi3_locate_pr_reg(),
1255 * so call core_scsi3_put_pr_reg() to decrement our reference.
1258 core_scsi3_put_pr_reg(pr_reg
);
1260 * Wait until all reference from any other I_T nexuses for this
1261 * *pr_reg have been released. Because list_del() is called above,
1262 * the last core_scsi3_put_pr_reg(pr_reg) will release this reference
1263 * count back to zero, and we release *pr_reg.
1265 while (atomic_read(&pr_reg
->pr_res_holders
) != 0) {
1266 spin_unlock(&pr_tmpl
->registration_lock
);
1267 pr_debug("SPC-3 PR [%s] waiting for pr_res_holders\n",
1268 tfo
->get_fabric_name());
1270 spin_lock(&pr_tmpl
->registration_lock
);
1273 pr_debug("SPC-3 PR [%s] Service Action: UNREGISTER Initiator"
1274 " Node: %s%s\n", tfo
->get_fabric_name(),
1275 pr_reg
->pr_reg_nacl
->initiatorname
,
1277 pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
1278 " Port(s)\n", tfo
->get_fabric_name(),
1279 (pr_reg
->pr_reg_all_tg_pt
) ? "ALL" : "SINGLE",
1280 dev
->transport
->name
);
1281 pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
1282 " 0x%08x\n", tfo
->get_fabric_name(), pr_reg
->pr_res_key
,
1283 pr_reg
->pr_res_generation
);
1285 if (!preempt_and_abort_list
) {
1286 pr_reg
->pr_reg_deve
= NULL
;
1287 pr_reg
->pr_reg_nacl
= NULL
;
1288 kmem_cache_free(t10_pr_reg_cache
, pr_reg
);
1292 * For PREEMPT_AND_ABORT, the list of *pr_reg in preempt_and_abort_list
1293 * are released once the ABORT_TASK_SET has completed..
1295 list_add_tail(&pr_reg
->pr_reg_abort_list
, preempt_and_abort_list
);
1298 void core_scsi3_free_pr_reg_from_nacl(
1299 struct se_device
*dev
,
1300 struct se_node_acl
*nacl
)
1302 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
1303 struct t10_pr_registration
*pr_reg
, *pr_reg_tmp
, *pr_res_holder
;
1304 bool free_reg
= false;
1306 * If the passed se_node_acl matches the reservation holder,
1307 * release the reservation.
1309 spin_lock(&dev
->dev_reservation_lock
);
1310 pr_res_holder
= dev
->dev_pr_res_holder
;
1311 if ((pr_res_holder
!= NULL
) &&
1312 (pr_res_holder
->pr_reg_nacl
== nacl
)) {
1313 __core_scsi3_complete_pro_release(dev
, nacl
, pr_res_holder
, 0, 1);
1316 spin_unlock(&dev
->dev_reservation_lock
);
1318 * Release any registration associated with the struct se_node_acl.
1320 spin_lock(&pr_tmpl
->registration_lock
);
1321 if (pr_res_holder
&& free_reg
)
1322 __core_scsi3_free_registration(dev
, pr_res_holder
, NULL
, 0);
1324 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
,
1325 &pr_tmpl
->registration_list
, pr_reg_list
) {
1327 if (pr_reg
->pr_reg_nacl
!= nacl
)
1330 __core_scsi3_free_registration(dev
, pr_reg
, NULL
, 0);
1332 spin_unlock(&pr_tmpl
->registration_lock
);
1335 void core_scsi3_free_all_registrations(
1336 struct se_device
*dev
)
1338 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
1339 struct t10_pr_registration
*pr_reg
, *pr_reg_tmp
, *pr_res_holder
;
1341 spin_lock(&dev
->dev_reservation_lock
);
1342 pr_res_holder
= dev
->dev_pr_res_holder
;
1343 if (pr_res_holder
!= NULL
) {
1344 struct se_node_acl
*pr_res_nacl
= pr_res_holder
->pr_reg_nacl
;
1345 __core_scsi3_complete_pro_release(dev
, pr_res_nacl
,
1346 pr_res_holder
, 0, 0);
1348 spin_unlock(&dev
->dev_reservation_lock
);
1350 spin_lock(&pr_tmpl
->registration_lock
);
1351 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
,
1352 &pr_tmpl
->registration_list
, pr_reg_list
) {
1354 __core_scsi3_free_registration(dev
, pr_reg
, NULL
, 0);
1356 spin_unlock(&pr_tmpl
->registration_lock
);
1358 spin_lock(&pr_tmpl
->aptpl_reg_lock
);
1359 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
, &pr_tmpl
->aptpl_reg_list
,
1360 pr_reg_aptpl_list
) {
1361 list_del(&pr_reg
->pr_reg_aptpl_list
);
1362 kmem_cache_free(t10_pr_reg_cache
, pr_reg
);
1364 spin_unlock(&pr_tmpl
->aptpl_reg_lock
);
1367 static int core_scsi3_tpg_depend_item(struct se_portal_group
*tpg
)
1369 return target_depend_item(&tpg
->tpg_group
.cg_item
);
1372 static void core_scsi3_tpg_undepend_item(struct se_portal_group
*tpg
)
1374 target_undepend_item(&tpg
->tpg_group
.cg_item
);
1375 atomic_dec_mb(&tpg
->tpg_pr_ref_count
);
1378 static int core_scsi3_nodeacl_depend_item(struct se_node_acl
*nacl
)
1380 if (nacl
->dynamic_node_acl
)
1382 return target_depend_item(&nacl
->acl_group
.cg_item
);
1385 static void core_scsi3_nodeacl_undepend_item(struct se_node_acl
*nacl
)
1387 if (!nacl
->dynamic_node_acl
)
1388 target_undepend_item(&nacl
->acl_group
.cg_item
);
1389 atomic_dec_mb(&nacl
->acl_pr_ref_count
);
1392 static int core_scsi3_lunacl_depend_item(struct se_dev_entry
*se_deve
)
1394 struct se_lun_acl
*lun_acl
= se_deve
->se_lun_acl
;
1395 struct se_node_acl
*nacl
;
1396 struct se_portal_group
*tpg
;
1398 * For nacl->dynamic_node_acl=1
1403 nacl
= lun_acl
->se_lun_nacl
;
1406 return target_depend_item(&lun_acl
->se_lun_group
.cg_item
);
1409 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry
*se_deve
)
1411 struct se_lun_acl
*lun_acl
= se_deve
->se_lun_acl
;
1412 struct se_node_acl
*nacl
;
1413 struct se_portal_group
*tpg
;
1415 * For nacl->dynamic_node_acl=1
1418 atomic_dec_mb(&se_deve
->pr_ref_count
);
1421 nacl
= lun_acl
->se_lun_nacl
;
1424 target_undepend_item(&lun_acl
->se_lun_group
.cg_item
);
1425 atomic_dec_mb(&se_deve
->pr_ref_count
);
1428 static sense_reason_t
1429 core_scsi3_decode_spec_i_port(
1431 struct se_portal_group
*tpg
,
1432 unsigned char *l_isid
,
1437 struct se_device
*dev
= cmd
->se_dev
;
1438 struct se_port
*tmp_port
;
1439 struct se_portal_group
*dest_tpg
= NULL
, *tmp_tpg
;
1440 struct se_session
*se_sess
= cmd
->se_sess
;
1441 struct se_node_acl
*dest_node_acl
= NULL
;
1442 struct se_dev_entry
*dest_se_deve
= NULL
, *local_se_deve
;
1443 struct t10_pr_registration
*dest_pr_reg
, *local_pr_reg
, *pr_reg_e
;
1444 struct t10_pr_registration
*pr_reg_tmp
, *pr_reg_tmp_safe
;
1445 LIST_HEAD(tid_dest_list
);
1446 struct pr_transport_id_holder
*tidh_new
, *tidh
, *tidh_tmp
;
1447 unsigned char *buf
, *ptr
, proto_ident
;
1448 const unsigned char *i_str
;
1449 char *iport_ptr
= NULL
, i_buf
[PR_REG_ISID_ID_LEN
];
1451 u32 tpdl
, tid_len
= 0;
1452 int dest_local_nexus
;
1455 local_se_deve
= se_sess
->se_node_acl
->device_list
[cmd
->orig_fe_lun
];
1457 * Allocate a struct pr_transport_id_holder and setup the
1458 * local_node_acl and local_se_deve pointers and add to
1459 * struct list_head tid_dest_list for add registration
1460 * processing in the loop of tid_dest_list below.
1462 tidh_new
= kzalloc(sizeof(struct pr_transport_id_holder
), GFP_KERNEL
);
1464 pr_err("Unable to allocate tidh_new\n");
1465 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1467 INIT_LIST_HEAD(&tidh_new
->dest_list
);
1468 tidh_new
->dest_tpg
= tpg
;
1469 tidh_new
->dest_node_acl
= se_sess
->se_node_acl
;
1470 tidh_new
->dest_se_deve
= local_se_deve
;
1472 local_pr_reg
= __core_scsi3_alloc_registration(cmd
->se_dev
,
1473 se_sess
->se_node_acl
, local_se_deve
, l_isid
,
1474 sa_res_key
, all_tg_pt
, aptpl
);
1475 if (!local_pr_reg
) {
1477 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1479 tidh_new
->dest_pr_reg
= local_pr_reg
;
1481 * The local I_T nexus does not hold any configfs dependances,
1482 * so we set tid_h->dest_local_nexus=1 to prevent the
1483 * configfs_undepend_item() calls in the tid_dest_list loops below.
1485 tidh_new
->dest_local_nexus
= 1;
1486 list_add_tail(&tidh_new
->dest_list
, &tid_dest_list
);
1488 if (cmd
->data_length
< 28) {
1489 pr_warn("SPC-PR: Received PR OUT parameter list"
1490 " length too small: %u\n", cmd
->data_length
);
1491 ret
= TCM_INVALID_PARAMETER_LIST
;
1495 buf
= transport_kmap_data_sg(cmd
);
1497 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1502 * For a PERSISTENT RESERVE OUT specify initiator ports payload,
1503 * first extract TransportID Parameter Data Length, and make sure
1504 * the value matches up to the SCSI expected data transfer length.
1506 tpdl
= (buf
[24] & 0xff) << 24;
1507 tpdl
|= (buf
[25] & 0xff) << 16;
1508 tpdl
|= (buf
[26] & 0xff) << 8;
1509 tpdl
|= buf
[27] & 0xff;
1511 if ((tpdl
+ 28) != cmd
->data_length
) {
1512 pr_err("SPC-3 PR: Illegal tpdl: %u + 28 byte header"
1513 " does not equal CDB data_length: %u\n", tpdl
,
1515 ret
= TCM_INVALID_PARAMETER_LIST
;
1519 * Start processing the received transport IDs using the
1520 * receiving I_T Nexus portal's fabric dependent methods to
1521 * obtain the SCSI Initiator Port/Device Identifiers.
1526 proto_ident
= (ptr
[0] & 0x0f);
1529 spin_lock(&dev
->se_port_lock
);
1530 list_for_each_entry(tmp_port
, &dev
->dev_sep_list
, sep_list
) {
1531 tmp_tpg
= tmp_port
->sep_tpg
;
1536 * Look for the matching proto_ident provided by
1537 * the received TransportID
1539 if (tmp_tpg
->proto_id
!= proto_ident
)
1541 dest_rtpi
= tmp_port
->sep_rtpi
;
1543 i_str
= target_parse_pr_out_transport_id(tmp_tpg
,
1544 (const char *)ptr
, &tid_len
, &iport_ptr
);
1548 atomic_inc_mb(&tmp_tpg
->tpg_pr_ref_count
);
1549 spin_unlock(&dev
->se_port_lock
);
1551 if (core_scsi3_tpg_depend_item(tmp_tpg
)) {
1552 pr_err(" core_scsi3_tpg_depend_item()"
1554 atomic_dec_mb(&tmp_tpg
->tpg_pr_ref_count
);
1555 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1559 * Locate the destination initiator ACL to be registered
1560 * from the decoded fabric module specific TransportID
1563 spin_lock_irq(&tmp_tpg
->acl_node_lock
);
1564 dest_node_acl
= __core_tpg_get_initiator_node_acl(
1567 atomic_inc_mb(&dest_node_acl
->acl_pr_ref_count
);
1568 spin_unlock_irq(&tmp_tpg
->acl_node_lock
);
1570 if (!dest_node_acl
) {
1571 core_scsi3_tpg_undepend_item(tmp_tpg
);
1572 spin_lock(&dev
->se_port_lock
);
1576 if (core_scsi3_nodeacl_depend_item(dest_node_acl
)) {
1577 pr_err("configfs_depend_item() failed"
1578 " for dest_node_acl->acl_group\n");
1579 atomic_dec_mb(&dest_node_acl
->acl_pr_ref_count
);
1580 core_scsi3_tpg_undepend_item(tmp_tpg
);
1581 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1586 pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node:"
1587 " %s Port RTPI: %hu\n",
1588 dest_tpg
->se_tpg_tfo
->get_fabric_name(),
1589 dest_node_acl
->initiatorname
, dest_rtpi
);
1591 spin_lock(&dev
->se_port_lock
);
1594 spin_unlock(&dev
->se_port_lock
);
1597 pr_err("SPC-3 PR SPEC_I_PT: Unable to locate"
1599 ret
= TCM_INVALID_PARAMETER_LIST
;
1603 pr_debug("SPC-3 PR SPEC_I_PT: Got %s data_length: %u tpdl: %u"
1604 " tid_len: %d for %s + %s\n",
1605 dest_tpg
->se_tpg_tfo
->get_fabric_name(), cmd
->data_length
,
1606 tpdl
, tid_len
, i_str
, iport_ptr
);
1608 if (tid_len
> tpdl
) {
1609 pr_err("SPC-3 PR SPEC_I_PT: Illegal tid_len:"
1610 " %u for Transport ID: %s\n", tid_len
, ptr
);
1611 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
1612 core_scsi3_tpg_undepend_item(dest_tpg
);
1613 ret
= TCM_INVALID_PARAMETER_LIST
;
1617 * Locate the desintation struct se_dev_entry pointer for matching
1618 * RELATIVE TARGET PORT IDENTIFIER on the receiving I_T Nexus
1621 dest_se_deve
= core_get_se_deve_from_rtpi(dest_node_acl
,
1623 if (!dest_se_deve
) {
1624 pr_err("Unable to locate %s dest_se_deve"
1625 " from destination RTPI: %hu\n",
1626 dest_tpg
->se_tpg_tfo
->get_fabric_name(),
1629 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
1630 core_scsi3_tpg_undepend_item(dest_tpg
);
1631 ret
= TCM_INVALID_PARAMETER_LIST
;
1635 if (core_scsi3_lunacl_depend_item(dest_se_deve
)) {
1636 pr_err("core_scsi3_lunacl_depend_item()"
1638 atomic_dec_mb(&dest_se_deve
->pr_ref_count
);
1639 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
1640 core_scsi3_tpg_undepend_item(dest_tpg
);
1641 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1645 pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node: %s"
1646 " dest_se_deve mapped_lun: %u\n",
1647 dest_tpg
->se_tpg_tfo
->get_fabric_name(),
1648 dest_node_acl
->initiatorname
, dest_se_deve
->mapped_lun
);
1651 * Skip any TransportIDs that already have a registration for
1654 pr_reg_e
= __core_scsi3_locate_pr_reg(dev
, dest_node_acl
,
1657 core_scsi3_put_pr_reg(pr_reg_e
);
1658 core_scsi3_lunacl_undepend_item(dest_se_deve
);
1659 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
1660 core_scsi3_tpg_undepend_item(dest_tpg
);
1667 * Allocate a struct pr_transport_id_holder and setup
1668 * the dest_node_acl and dest_se_deve pointers for the
1671 tidh_new
= kzalloc(sizeof(struct pr_transport_id_holder
),
1674 pr_err("Unable to allocate tidh_new\n");
1675 core_scsi3_lunacl_undepend_item(dest_se_deve
);
1676 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
1677 core_scsi3_tpg_undepend_item(dest_tpg
);
1678 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1681 INIT_LIST_HEAD(&tidh_new
->dest_list
);
1682 tidh_new
->dest_tpg
= dest_tpg
;
1683 tidh_new
->dest_node_acl
= dest_node_acl
;
1684 tidh_new
->dest_se_deve
= dest_se_deve
;
1687 * Allocate, but do NOT add the registration for the
1688 * TransportID referenced SCSI Initiator port. This
1689 * done because of the following from spc4r17 in section
1690 * 6.14.3 wrt SPEC_I_PT:
1692 * "If a registration fails for any initiator port (e.g., if th
1693 * logical unit does not have enough resources available to
1694 * hold the registration information), no registrations shall be
1695 * made, and the command shall be terminated with
1696 * CHECK CONDITION status."
1698 * That means we call __core_scsi3_alloc_registration() here,
1699 * and then call __core_scsi3_add_registration() in the
1700 * 2nd loop which will never fail.
1702 dest_pr_reg
= __core_scsi3_alloc_registration(cmd
->se_dev
,
1703 dest_node_acl
, dest_se_deve
, iport_ptr
,
1704 sa_res_key
, all_tg_pt
, aptpl
);
1706 core_scsi3_lunacl_undepend_item(dest_se_deve
);
1707 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
1708 core_scsi3_tpg_undepend_item(dest_tpg
);
1710 ret
= TCM_INVALID_PARAMETER_LIST
;
1713 tidh_new
->dest_pr_reg
= dest_pr_reg
;
1714 list_add_tail(&tidh_new
->dest_list
, &tid_dest_list
);
1722 transport_kunmap_data_sg(cmd
);
1725 * Go ahead and create a registrations from tid_dest_list for the
1726 * SPEC_I_PT provided TransportID for the *tidh referenced dest_node_acl
1729 * The SA Reservation Key from the PROUT is set for the
1730 * registration, and ALL_TG_PT is also passed. ALL_TG_PT=1
1731 * means that the TransportID Initiator port will be
1732 * registered on all of the target ports in the SCSI target device
1733 * ALL_TG_PT=0 means the registration will only be for the
1734 * SCSI target port the PROUT REGISTER with SPEC_I_PT=1
1737 list_for_each_entry_safe(tidh
, tidh_tmp
, &tid_dest_list
, dest_list
) {
1738 dest_tpg
= tidh
->dest_tpg
;
1739 dest_node_acl
= tidh
->dest_node_acl
;
1740 dest_se_deve
= tidh
->dest_se_deve
;
1741 dest_pr_reg
= tidh
->dest_pr_reg
;
1742 dest_local_nexus
= tidh
->dest_local_nexus
;
1744 list_del(&tidh
->dest_list
);
1747 memset(i_buf
, 0, PR_REG_ISID_ID_LEN
);
1748 core_pr_dump_initiator_port(dest_pr_reg
, i_buf
, PR_REG_ISID_ID_LEN
);
1750 __core_scsi3_add_registration(cmd
->se_dev
, dest_node_acl
,
1753 pr_debug("SPC-3 PR [%s] SPEC_I_PT: Successfully"
1754 " registered Transport ID for Node: %s%s Mapped LUN:"
1755 " %u\n", dest_tpg
->se_tpg_tfo
->get_fabric_name(),
1756 dest_node_acl
->initiatorname
, i_buf
, dest_se_deve
->mapped_lun
);
1758 if (dest_local_nexus
)
1761 core_scsi3_lunacl_undepend_item(dest_se_deve
);
1762 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
1763 core_scsi3_tpg_undepend_item(dest_tpg
);
1768 transport_kunmap_data_sg(cmd
);
1771 * For the failure case, release everything from tid_dest_list
1772 * including *dest_pr_reg and the configfs dependances..
1774 list_for_each_entry_safe(tidh
, tidh_tmp
, &tid_dest_list
, dest_list
) {
1775 dest_tpg
= tidh
->dest_tpg
;
1776 dest_node_acl
= tidh
->dest_node_acl
;
1777 dest_se_deve
= tidh
->dest_se_deve
;
1778 dest_pr_reg
= tidh
->dest_pr_reg
;
1779 dest_local_nexus
= tidh
->dest_local_nexus
;
1781 list_del(&tidh
->dest_list
);
1784 * Release any extra ALL_TG_PT=1 registrations for
1785 * the SPEC_I_PT=1 case.
1787 list_for_each_entry_safe(pr_reg_tmp
, pr_reg_tmp_safe
,
1788 &dest_pr_reg
->pr_reg_atp_list
,
1789 pr_reg_atp_mem_list
) {
1790 list_del(&pr_reg_tmp
->pr_reg_atp_mem_list
);
1791 core_scsi3_lunacl_undepend_item(pr_reg_tmp
->pr_reg_deve
);
1792 kmem_cache_free(t10_pr_reg_cache
, pr_reg_tmp
);
1795 kmem_cache_free(t10_pr_reg_cache
, dest_pr_reg
);
1797 if (dest_local_nexus
)
1800 core_scsi3_lunacl_undepend_item(dest_se_deve
);
1801 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
1802 core_scsi3_tpg_undepend_item(dest_tpg
);
1807 static int core_scsi3_update_aptpl_buf(
1808 struct se_device
*dev
,
1810 u32 pr_aptpl_buf_len
)
1813 struct se_portal_group
*tpg
;
1814 struct t10_pr_registration
*pr_reg
;
1815 unsigned char tmp
[512], isid_buf
[32];
1820 spin_lock(&dev
->dev_reservation_lock
);
1821 spin_lock(&dev
->t10_pr
.registration_lock
);
1823 * Walk the registration list..
1825 list_for_each_entry(pr_reg
, &dev
->t10_pr
.registration_list
,
1830 tpg
= pr_reg
->pr_reg_nacl
->se_tpg
;
1831 lun
= pr_reg
->pr_reg_tg_pt_lun
;
1833 * Write out any ISID value to APTPL metadata that was included
1834 * in the original registration.
1836 if (pr_reg
->isid_present_at_reg
)
1837 snprintf(isid_buf
, 32, "initiator_sid=%s\n",
1838 pr_reg
->pr_reg_isid
);
1840 * Include special metadata if the pr_reg matches the
1841 * reservation holder.
1843 if (dev
->dev_pr_res_holder
== pr_reg
) {
1844 snprintf(tmp
, 512, "PR_REG_START: %d"
1845 "\ninitiator_fabric=%s\n"
1846 "initiator_node=%s\n%s"
1848 "res_holder=1\nres_type=%02x\n"
1849 "res_scope=%02x\nres_all_tg_pt=%d\n"
1850 "mapped_lun=%u\n", reg_count
,
1851 tpg
->se_tpg_tfo
->get_fabric_name(),
1852 pr_reg
->pr_reg_nacl
->initiatorname
, isid_buf
,
1853 pr_reg
->pr_res_key
, pr_reg
->pr_res_type
,
1854 pr_reg
->pr_res_scope
, pr_reg
->pr_reg_all_tg_pt
,
1855 pr_reg
->pr_res_mapped_lun
);
1857 snprintf(tmp
, 512, "PR_REG_START: %d\n"
1858 "initiator_fabric=%s\ninitiator_node=%s\n%s"
1859 "sa_res_key=%llu\nres_holder=0\n"
1860 "res_all_tg_pt=%d\nmapped_lun=%u\n",
1861 reg_count
, tpg
->se_tpg_tfo
->get_fabric_name(),
1862 pr_reg
->pr_reg_nacl
->initiatorname
, isid_buf
,
1863 pr_reg
->pr_res_key
, pr_reg
->pr_reg_all_tg_pt
,
1864 pr_reg
->pr_res_mapped_lun
);
1867 if ((len
+ strlen(tmp
) >= pr_aptpl_buf_len
)) {
1868 pr_err("Unable to update renaming APTPL metadata,"
1869 " reallocating larger buffer\n");
1873 len
+= sprintf(buf
+len
, "%s", tmp
);
1876 * Include information about the associated SCSI target port.
1878 snprintf(tmp
, 512, "target_fabric=%s\ntarget_node=%s\n"
1879 "tpgt=%hu\nport_rtpi=%hu\ntarget_lun=%u\nPR_REG_END:"
1880 " %d\n", tpg
->se_tpg_tfo
->get_fabric_name(),
1881 tpg
->se_tpg_tfo
->tpg_get_wwn(tpg
),
1882 tpg
->se_tpg_tfo
->tpg_get_tag(tpg
),
1883 lun
->lun_sep
->sep_rtpi
, lun
->unpacked_lun
, reg_count
);
1885 if ((len
+ strlen(tmp
) >= pr_aptpl_buf_len
)) {
1886 pr_err("Unable to update renaming APTPL metadata,"
1887 " reallocating larger buffer\n");
1891 len
+= sprintf(buf
+len
, "%s", tmp
);
1896 len
+= sprintf(buf
+len
, "No Registrations or Reservations");
1899 spin_unlock(&dev
->t10_pr
.registration_lock
);
1900 spin_unlock(&dev
->dev_reservation_lock
);
1905 static int __core_scsi3_write_aptpl_to_file(
1906 struct se_device
*dev
,
1909 struct t10_wwn
*wwn
= &dev
->t10_wwn
;
1911 int flags
= O_RDWR
| O_CREAT
| O_TRUNC
;
1913 u32 pr_aptpl_buf_len
;
1916 memset(path
, 0, 512);
1918 if (strlen(&wwn
->unit_serial
[0]) >= 512) {
1919 pr_err("WWN value for struct se_device does not fit"
1920 " into path buffer\n");
1924 snprintf(path
, 512, "/var/target/pr/aptpl_%s", &wwn
->unit_serial
[0]);
1925 file
= filp_open(path
, flags
, 0600);
1927 pr_err("filp_open(%s) for APTPL metadata"
1929 return PTR_ERR(file
);
1932 pr_aptpl_buf_len
= (strlen(buf
) + 1); /* Add extra for NULL */
1934 ret
= kernel_write(file
, buf
, pr_aptpl_buf_len
, 0);
1937 pr_debug("Error writing APTPL metadata file: %s\n", path
);
1940 return (ret
< 0) ? -EIO
: 0;
1944 * Clear the APTPL metadata if APTPL has been disabled, otherwise
1945 * write out the updated metadata to struct file for this SCSI device.
1947 static sense_reason_t
core_scsi3_update_and_write_aptpl(struct se_device
*dev
, bool aptpl
)
1950 int rc
, len
= PR_APTPL_BUF_LEN
;
1953 char *null_buf
= "No Registrations or Reservations\n";
1955 rc
= __core_scsi3_write_aptpl_to_file(dev
, null_buf
);
1956 dev
->t10_pr
.pr_aptpl_active
= 0;
1957 pr_debug("SPC-3 PR: Set APTPL Bit Deactivated\n");
1960 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1967 return TCM_OUT_OF_RESOURCES
;
1969 rc
= core_scsi3_update_aptpl_buf(dev
, buf
, len
);
1976 rc
= __core_scsi3_write_aptpl_to_file(dev
, buf
);
1978 pr_err("SPC-3 PR: Could not update APTPL\n");
1980 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1982 dev
->t10_pr
.pr_aptpl_active
= 1;
1984 pr_debug("SPC-3 PR: Set APTPL Bit Activated\n");
1988 static sense_reason_t
1989 core_scsi3_emulate_pro_register(struct se_cmd
*cmd
, u64 res_key
, u64 sa_res_key
,
1990 bool aptpl
, bool all_tg_pt
, bool spec_i_pt
, enum register_type register_type
)
1992 struct se_session
*se_sess
= cmd
->se_sess
;
1993 struct se_device
*dev
= cmd
->se_dev
;
1994 struct se_dev_entry
*se_deve
;
1995 struct se_lun
*se_lun
= cmd
->se_lun
;
1996 struct se_portal_group
*se_tpg
;
1997 struct t10_pr_registration
*pr_reg
, *pr_reg_p
, *pr_reg_tmp
;
1998 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
1999 unsigned char isid_buf
[PR_REG_ISID_LEN
], *isid_ptr
= NULL
;
2000 sense_reason_t ret
= TCM_NO_SENSE
;
2001 int pr_holder
= 0, type
;
2003 if (!se_sess
|| !se_lun
) {
2004 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2005 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
2007 se_tpg
= se_sess
->se_tpg
;
2008 se_deve
= se_sess
->se_node_acl
->device_list
[cmd
->orig_fe_lun
];
2010 if (se_tpg
->se_tpg_tfo
->sess_get_initiator_sid
) {
2011 memset(&isid_buf
[0], 0, PR_REG_ISID_LEN
);
2012 se_tpg
->se_tpg_tfo
->sess_get_initiator_sid(se_sess
, &isid_buf
[0],
2014 isid_ptr
= &isid_buf
[0];
2017 * Follow logic from spc4r17 Section 5.7.7, Register Behaviors Table 47
2019 pr_reg
= core_scsi3_locate_pr_reg(dev
, se_sess
->se_node_acl
, se_sess
);
2022 pr_warn("SPC-3 PR: Reservation Key non-zero"
2023 " for SA REGISTER, returning CONFLICT\n");
2024 return TCM_RESERVATION_CONFLICT
;
2027 * Do nothing but return GOOD status.
2034 * Perform the Service Action REGISTER on the Initiator
2035 * Port Endpoint that the PRO was received from on the
2036 * Logical Unit of the SCSI device server.
2038 if (core_scsi3_alloc_registration(cmd
->se_dev
,
2039 se_sess
->se_node_acl
, se_deve
, isid_ptr
,
2040 sa_res_key
, all_tg_pt
, aptpl
,
2041 register_type
, 0)) {
2042 pr_err("Unable to allocate"
2043 " struct t10_pr_registration\n");
2044 return TCM_INVALID_PARAMETER_LIST
;
2048 * Register both the Initiator port that received
2049 * PROUT SA REGISTER + SPEC_I_PT=1 and extract SCSI
2050 * TransportID from Parameter list and loop through
2051 * fabric dependent parameter list while calling
2052 * logic from of core_scsi3_alloc_registration() for
2053 * each TransportID provided SCSI Initiator Port/Device
2055 ret
= core_scsi3_decode_spec_i_port(cmd
, se_tpg
,
2056 isid_ptr
, sa_res_key
, all_tg_pt
, aptpl
);
2061 return core_scsi3_update_and_write_aptpl(dev
, aptpl
);
2064 /* ok, existing registration */
2066 if ((register_type
== REGISTER
) && (res_key
!= pr_reg
->pr_res_key
)) {
2067 pr_err("SPC-3 PR REGISTER: Received"
2068 " res_key: 0x%016Lx does not match"
2069 " existing SA REGISTER res_key:"
2070 " 0x%016Lx\n", res_key
,
2071 pr_reg
->pr_res_key
);
2072 ret
= TCM_RESERVATION_CONFLICT
;
2077 pr_err("SPC-3 PR REGISTER: SPEC_I_PT"
2078 " set on a registered nexus\n");
2079 ret
= TCM_INVALID_PARAMETER_LIST
;
2084 * An existing ALL_TG_PT=1 registration being released
2085 * must also set ALL_TG_PT=1 in the incoming PROUT.
2087 if (pr_reg
->pr_reg_all_tg_pt
&& !all_tg_pt
) {
2088 pr_err("SPC-3 PR REGISTER: ALL_TG_PT=1"
2089 " registration exists, but ALL_TG_PT=1 bit not"
2090 " present in received PROUT\n");
2091 ret
= TCM_INVALID_CDB_FIELD
;
2096 * sa_res_key=1 Change Reservation Key for registered I_T Nexus.
2100 * Increment PRgeneration counter for struct se_device"
2101 * upon a successful REGISTER, see spc4r17 section 6.3.2
2102 * READ_KEYS service action.
2104 pr_reg
->pr_res_generation
= core_scsi3_pr_generation(cmd
->se_dev
);
2105 pr_reg
->pr_res_key
= sa_res_key
;
2106 pr_debug("SPC-3 PR [%s] REGISTER%s: Changed Reservation"
2107 " Key for %s to: 0x%016Lx PRgeneration:"
2108 " 0x%08x\n", cmd
->se_tfo
->get_fabric_name(),
2109 (register_type
== REGISTER_AND_IGNORE_EXISTING_KEY
) ? "_AND_IGNORE_EXISTING_KEY" : "",
2110 pr_reg
->pr_reg_nacl
->initiatorname
,
2111 pr_reg
->pr_res_key
, pr_reg
->pr_res_generation
);
2115 * sa_res_key=0 Unregister Reservation Key for registered I_T Nexus.
2117 type
= pr_reg
->pr_res_type
;
2118 pr_holder
= core_scsi3_check_implicit_release(cmd
->se_dev
,
2120 if (pr_holder
< 0) {
2121 ret
= TCM_RESERVATION_CONFLICT
;
2125 spin_lock(&pr_tmpl
->registration_lock
);
2127 * Release all ALL_TG_PT=1 for the matching SCSI Initiator Port
2128 * and matching pr_res_key.
2130 if (pr_reg
->pr_reg_all_tg_pt
) {
2131 list_for_each_entry_safe(pr_reg_p
, pr_reg_tmp
,
2132 &pr_tmpl
->registration_list
,
2135 if (!pr_reg_p
->pr_reg_all_tg_pt
)
2137 if (pr_reg_p
->pr_res_key
!= res_key
)
2139 if (pr_reg
== pr_reg_p
)
2141 if (strcmp(pr_reg
->pr_reg_nacl
->initiatorname
,
2142 pr_reg_p
->pr_reg_nacl
->initiatorname
))
2145 __core_scsi3_free_registration(dev
,
2151 * Release the calling I_T Nexus registration now..
2153 __core_scsi3_free_registration(cmd
->se_dev
, pr_reg
, NULL
, 1);
2157 * From spc4r17, section 5.7.11.3 Unregistering
2159 * If the persistent reservation is a registrants only
2160 * type, the device server shall establish a unit
2161 * attention condition for the initiator port associated
2162 * with every registered I_T nexus except for the I_T
2163 * nexus on which the PERSISTENT RESERVE OUT command was
2164 * received, with the additional sense code set to
2165 * RESERVATIONS RELEASED.
2168 (type
== PR_TYPE_WRITE_EXCLUSIVE_REGONLY
||
2169 type
== PR_TYPE_EXCLUSIVE_ACCESS_REGONLY
)) {
2170 list_for_each_entry(pr_reg_p
,
2171 &pr_tmpl
->registration_list
,
2174 core_scsi3_ua_allocate(
2175 pr_reg_p
->pr_reg_nacl
,
2176 pr_reg_p
->pr_res_mapped_lun
,
2178 ASCQ_2AH_RESERVATIONS_RELEASED
);
2182 spin_unlock(&pr_tmpl
->registration_lock
);
2185 ret
= core_scsi3_update_and_write_aptpl(dev
, aptpl
);
2189 core_scsi3_put_pr_reg(pr_reg
);
2193 unsigned char *core_scsi3_pr_dump_type(int type
)
2196 case PR_TYPE_WRITE_EXCLUSIVE
:
2197 return "Write Exclusive Access";
2198 case PR_TYPE_EXCLUSIVE_ACCESS
:
2199 return "Exclusive Access";
2200 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY
:
2201 return "Write Exclusive Access, Registrants Only";
2202 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY
:
2203 return "Exclusive Access, Registrants Only";
2204 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG
:
2205 return "Write Exclusive Access, All Registrants";
2206 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
:
2207 return "Exclusive Access, All Registrants";
2212 return "Unknown SPC-3 PR Type";
2215 static sense_reason_t
2216 core_scsi3_pro_reserve(struct se_cmd
*cmd
, int type
, int scope
, u64 res_key
)
2218 struct se_device
*dev
= cmd
->se_dev
;
2219 struct se_session
*se_sess
= cmd
->se_sess
;
2220 struct se_lun
*se_lun
= cmd
->se_lun
;
2221 struct t10_pr_registration
*pr_reg
, *pr_res_holder
;
2222 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
2223 char i_buf
[PR_REG_ISID_ID_LEN
];
2226 memset(i_buf
, 0, PR_REG_ISID_ID_LEN
);
2228 if (!se_sess
|| !se_lun
) {
2229 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2230 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
2233 * Locate the existing *pr_reg via struct se_node_acl pointers
2235 pr_reg
= core_scsi3_locate_pr_reg(cmd
->se_dev
, se_sess
->se_node_acl
,
2238 pr_err("SPC-3 PR: Unable to locate"
2239 " PR_REGISTERED *pr_reg for RESERVE\n");
2240 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
2243 * From spc4r17 Section 5.7.9: Reserving:
2245 * An application client creates a persistent reservation by issuing
2246 * a PERSISTENT RESERVE OUT command with RESERVE service action through
2247 * a registered I_T nexus with the following parameters:
2248 * a) RESERVATION KEY set to the value of the reservation key that is
2249 * registered with the logical unit for the I_T nexus; and
2251 if (res_key
!= pr_reg
->pr_res_key
) {
2252 pr_err("SPC-3 PR RESERVE: Received res_key: 0x%016Lx"
2253 " does not match existing SA REGISTER res_key:"
2254 " 0x%016Lx\n", res_key
, pr_reg
->pr_res_key
);
2255 ret
= TCM_RESERVATION_CONFLICT
;
2256 goto out_put_pr_reg
;
2259 * From spc4r17 Section 5.7.9: Reserving:
2262 * b) TYPE field and SCOPE field set to the persistent reservation
2265 * Only one persistent reservation is allowed at a time per logical unit
2266 * and that persistent reservation has a scope of LU_SCOPE.
2268 if (scope
!= PR_SCOPE_LU_SCOPE
) {
2269 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope
);
2270 ret
= TCM_INVALID_PARAMETER_LIST
;
2271 goto out_put_pr_reg
;
2274 * See if we have an existing PR reservation holder pointer at
2275 * struct se_device->dev_pr_res_holder in the form struct t10_pr_registration
2278 spin_lock(&dev
->dev_reservation_lock
);
2279 pr_res_holder
= dev
->dev_pr_res_holder
;
2280 if (pr_res_holder
) {
2282 * From spc4r17 Section 5.7.9: Reserving:
2284 * If the device server receives a PERSISTENT RESERVE OUT
2285 * command from an I_T nexus other than a persistent reservation
2286 * holder (see 5.7.10) that attempts to create a persistent
2287 * reservation when a persistent reservation already exists for
2288 * the logical unit, then the command shall be completed with
2289 * RESERVATION CONFLICT status.
2291 if (!is_reservation_holder(pr_res_holder
, pr_reg
)) {
2292 struct se_node_acl
*pr_res_nacl
= pr_res_holder
->pr_reg_nacl
;
2293 pr_err("SPC-3 PR: Attempted RESERVE from"
2294 " [%s]: %s while reservation already held by"
2295 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2296 cmd
->se_tfo
->get_fabric_name(),
2297 se_sess
->se_node_acl
->initiatorname
,
2298 pr_res_nacl
->se_tpg
->se_tpg_tfo
->get_fabric_name(),
2299 pr_res_holder
->pr_reg_nacl
->initiatorname
);
2301 spin_unlock(&dev
->dev_reservation_lock
);
2302 ret
= TCM_RESERVATION_CONFLICT
;
2303 goto out_put_pr_reg
;
2306 * From spc4r17 Section 5.7.9: Reserving:
2308 * If a persistent reservation holder attempts to modify the
2309 * type or scope of an existing persistent reservation, the
2310 * command shall be completed with RESERVATION CONFLICT status.
2312 if ((pr_res_holder
->pr_res_type
!= type
) ||
2313 (pr_res_holder
->pr_res_scope
!= scope
)) {
2314 struct se_node_acl
*pr_res_nacl
= pr_res_holder
->pr_reg_nacl
;
2315 pr_err("SPC-3 PR: Attempted RESERVE from"
2316 " [%s]: %s trying to change TYPE and/or SCOPE,"
2317 " while reservation already held by [%s]: %s,"
2318 " returning RESERVATION_CONFLICT\n",
2319 cmd
->se_tfo
->get_fabric_name(),
2320 se_sess
->se_node_acl
->initiatorname
,
2321 pr_res_nacl
->se_tpg
->se_tpg_tfo
->get_fabric_name(),
2322 pr_res_holder
->pr_reg_nacl
->initiatorname
);
2324 spin_unlock(&dev
->dev_reservation_lock
);
2325 ret
= TCM_RESERVATION_CONFLICT
;
2326 goto out_put_pr_reg
;
2329 * From spc4r17 Section 5.7.9: Reserving:
2331 * If the device server receives a PERSISTENT RESERVE OUT
2332 * command with RESERVE service action where the TYPE field and
2333 * the SCOPE field contain the same values as the existing type
2334 * and scope from a persistent reservation holder, it shall not
2335 * make any change to the existing persistent reservation and
2336 * shall completethe command with GOOD status.
2338 spin_unlock(&dev
->dev_reservation_lock
);
2340 goto out_put_pr_reg
;
2343 * Otherwise, our *pr_reg becomes the PR reservation holder for said
2344 * TYPE/SCOPE. Also set the received scope and type in *pr_reg.
2346 pr_reg
->pr_res_scope
= scope
;
2347 pr_reg
->pr_res_type
= type
;
2348 pr_reg
->pr_res_holder
= 1;
2349 dev
->dev_pr_res_holder
= pr_reg
;
2350 core_pr_dump_initiator_port(pr_reg
, i_buf
, PR_REG_ISID_ID_LEN
);
2352 pr_debug("SPC-3 PR [%s] Service Action: RESERVE created new"
2353 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2354 cmd
->se_tfo
->get_fabric_name(), core_scsi3_pr_dump_type(type
),
2355 (pr_reg
->pr_reg_all_tg_pt
) ? 1 : 0);
2356 pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
2357 cmd
->se_tfo
->get_fabric_name(),
2358 se_sess
->se_node_acl
->initiatorname
,
2360 spin_unlock(&dev
->dev_reservation_lock
);
2362 if (pr_tmpl
->pr_aptpl_active
)
2363 core_scsi3_update_and_write_aptpl(cmd
->se_dev
, true);
2367 core_scsi3_put_pr_reg(pr_reg
);
2371 static sense_reason_t
2372 core_scsi3_emulate_pro_reserve(struct se_cmd
*cmd
, int type
, int scope
,
2376 case PR_TYPE_WRITE_EXCLUSIVE
:
2377 case PR_TYPE_EXCLUSIVE_ACCESS
:
2378 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY
:
2379 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY
:
2380 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG
:
2381 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
:
2382 return core_scsi3_pro_reserve(cmd
, type
, scope
, res_key
);
2384 pr_err("SPC-3 PR: Unknown Service Action RESERVE Type:"
2386 return TCM_INVALID_CDB_FIELD
;
2391 * Called with struct se_device->dev_reservation_lock held.
2393 static void __core_scsi3_complete_pro_release(
2394 struct se_device
*dev
,
2395 struct se_node_acl
*se_nacl
,
2396 struct t10_pr_registration
*pr_reg
,
2400 const struct target_core_fabric_ops
*tfo
= se_nacl
->se_tpg
->se_tpg_tfo
;
2401 char i_buf
[PR_REG_ISID_ID_LEN
];
2402 int pr_res_type
= 0, pr_res_scope
= 0;
2404 memset(i_buf
, 0, PR_REG_ISID_ID_LEN
);
2405 core_pr_dump_initiator_port(pr_reg
, i_buf
, PR_REG_ISID_ID_LEN
);
2407 * Go ahead and release the current PR reservation holder.
2408 * If an All Registrants reservation is currently active and
2409 * a unregister operation is requested, replace the current
2410 * dev_pr_res_holder with another active registration.
2412 if (dev
->dev_pr_res_holder
) {
2413 pr_res_type
= dev
->dev_pr_res_holder
->pr_res_type
;
2414 pr_res_scope
= dev
->dev_pr_res_holder
->pr_res_scope
;
2415 dev
->dev_pr_res_holder
->pr_res_type
= 0;
2416 dev
->dev_pr_res_holder
->pr_res_scope
= 0;
2417 dev
->dev_pr_res_holder
->pr_res_holder
= 0;
2418 dev
->dev_pr_res_holder
= NULL
;
2423 spin_lock(&dev
->t10_pr
.registration_lock
);
2424 list_del_init(&pr_reg
->pr_reg_list
);
2426 * If the I_T nexus is a reservation holder, the persistent reservation
2427 * is of an all registrants type, and the I_T nexus is the last remaining
2428 * registered I_T nexus, then the device server shall also release the
2429 * persistent reservation.
2431 if (!list_empty(&dev
->t10_pr
.registration_list
) &&
2432 ((pr_res_type
== PR_TYPE_WRITE_EXCLUSIVE_ALLREG
) ||
2433 (pr_res_type
== PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
))) {
2434 dev
->dev_pr_res_holder
=
2435 list_entry(dev
->t10_pr
.registration_list
.next
,
2436 struct t10_pr_registration
, pr_reg_list
);
2437 dev
->dev_pr_res_holder
->pr_res_type
= pr_res_type
;
2438 dev
->dev_pr_res_holder
->pr_res_scope
= pr_res_scope
;
2439 dev
->dev_pr_res_holder
->pr_res_holder
= 1;
2441 spin_unlock(&dev
->t10_pr
.registration_lock
);
2443 if (!dev
->dev_pr_res_holder
) {
2444 pr_debug("SPC-3 PR [%s] Service Action: %s RELEASE cleared"
2445 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2446 tfo
->get_fabric_name(), (explicit) ? "explicit" :
2447 "implicit", core_scsi3_pr_dump_type(pr_res_type
),
2448 (pr_reg
->pr_reg_all_tg_pt
) ? 1 : 0);
2450 pr_debug("SPC-3 PR [%s] RELEASE Node: %s%s\n",
2451 tfo
->get_fabric_name(), se_nacl
->initiatorname
,
2454 * Clear TYPE and SCOPE for the next PROUT Service Action: RESERVE
2456 pr_reg
->pr_res_holder
= pr_reg
->pr_res_type
= pr_reg
->pr_res_scope
= 0;
2459 static sense_reason_t
2460 core_scsi3_emulate_pro_release(struct se_cmd
*cmd
, int type
, int scope
,
2463 struct se_device
*dev
= cmd
->se_dev
;
2464 struct se_session
*se_sess
= cmd
->se_sess
;
2465 struct se_lun
*se_lun
= cmd
->se_lun
;
2466 struct t10_pr_registration
*pr_reg
, *pr_reg_p
, *pr_res_holder
;
2467 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
2468 sense_reason_t ret
= 0;
2470 if (!se_sess
|| !se_lun
) {
2471 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2472 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
2475 * Locate the existing *pr_reg via struct se_node_acl pointers
2477 pr_reg
= core_scsi3_locate_pr_reg(dev
, se_sess
->se_node_acl
, se_sess
);
2479 pr_err("SPC-3 PR: Unable to locate"
2480 " PR_REGISTERED *pr_reg for RELEASE\n");
2481 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
2484 * From spc4r17 Section 5.7.11.2 Releasing:
2486 * If there is no persistent reservation or in response to a persistent
2487 * reservation release request from a registered I_T nexus that is not a
2488 * persistent reservation holder (see 5.7.10), the device server shall
2491 * a) Not release the persistent reservation, if any;
2492 * b) Not remove any registrations; and
2493 * c) Complete the command with GOOD status.
2495 spin_lock(&dev
->dev_reservation_lock
);
2496 pr_res_holder
= dev
->dev_pr_res_holder
;
2497 if (!pr_res_holder
) {
2499 * No persistent reservation, return GOOD status.
2501 spin_unlock(&dev
->dev_reservation_lock
);
2502 goto out_put_pr_reg
;
2505 if (!is_reservation_holder(pr_res_holder
, pr_reg
)) {
2507 * Release request from a registered I_T nexus that is not a
2508 * persistent reservation holder. return GOOD status.
2510 spin_unlock(&dev
->dev_reservation_lock
);
2511 goto out_put_pr_reg
;
2515 * From spc4r17 Section 5.7.11.2 Releasing:
2517 * Only the persistent reservation holder (see 5.7.10) is allowed to
2518 * release a persistent reservation.
2520 * An application client releases the persistent reservation by issuing
2521 * a PERSISTENT RESERVE OUT command with RELEASE service action through
2522 * an I_T nexus that is a persistent reservation holder with the
2523 * following parameters:
2525 * a) RESERVATION KEY field set to the value of the reservation key
2526 * that is registered with the logical unit for the I_T nexus;
2528 if (res_key
!= pr_reg
->pr_res_key
) {
2529 pr_err("SPC-3 PR RELEASE: Received res_key: 0x%016Lx"
2530 " does not match existing SA REGISTER res_key:"
2531 " 0x%016Lx\n", res_key
, pr_reg
->pr_res_key
);
2532 spin_unlock(&dev
->dev_reservation_lock
);
2533 ret
= TCM_RESERVATION_CONFLICT
;
2534 goto out_put_pr_reg
;
2537 * From spc4r17 Section 5.7.11.2 Releasing and above:
2539 * b) TYPE field and SCOPE field set to match the persistent
2540 * reservation being released.
2542 if ((pr_res_holder
->pr_res_type
!= type
) ||
2543 (pr_res_holder
->pr_res_scope
!= scope
)) {
2544 struct se_node_acl
*pr_res_nacl
= pr_res_holder
->pr_reg_nacl
;
2545 pr_err("SPC-3 PR RELEASE: Attempted to release"
2546 " reservation from [%s]: %s with different TYPE "
2547 "and/or SCOPE while reservation already held by"
2548 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2549 cmd
->se_tfo
->get_fabric_name(),
2550 se_sess
->se_node_acl
->initiatorname
,
2551 pr_res_nacl
->se_tpg
->se_tpg_tfo
->get_fabric_name(),
2552 pr_res_holder
->pr_reg_nacl
->initiatorname
);
2554 spin_unlock(&dev
->dev_reservation_lock
);
2555 ret
= TCM_RESERVATION_CONFLICT
;
2556 goto out_put_pr_reg
;
2559 * In response to a persistent reservation release request from the
2560 * persistent reservation holder the device server shall perform a
2561 * release by doing the following as an uninterrupted series of actions:
2562 * a) Release the persistent reservation;
2563 * b) Not remove any registration(s);
2564 * c) If the released persistent reservation is a registrants only type
2565 * or all registrants type persistent reservation,
2566 * the device server shall establish a unit attention condition for
2567 * the initiator port associated with every regis-
2568 * tered I_T nexus other than I_T nexus on which the PERSISTENT
2569 * RESERVE OUT command with RELEASE service action was received,
2570 * with the additional sense code set to RESERVATIONS RELEASED; and
2571 * d) If the persistent reservation is of any other type, the device
2572 * server shall not establish a unit attention condition.
2574 __core_scsi3_complete_pro_release(dev
, se_sess
->se_node_acl
,
2577 spin_unlock(&dev
->dev_reservation_lock
);
2579 if ((type
!= PR_TYPE_WRITE_EXCLUSIVE_REGONLY
) &&
2580 (type
!= PR_TYPE_EXCLUSIVE_ACCESS_REGONLY
) &&
2581 (type
!= PR_TYPE_WRITE_EXCLUSIVE_ALLREG
) &&
2582 (type
!= PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
)) {
2584 * If no UNIT ATTENTION conditions will be established for
2585 * PR_TYPE_WRITE_EXCLUSIVE or PR_TYPE_EXCLUSIVE_ACCESS
2586 * go ahead and check for APTPL=1 update+write below
2591 spin_lock(&pr_tmpl
->registration_lock
);
2592 list_for_each_entry(pr_reg_p
, &pr_tmpl
->registration_list
,
2595 * Do not establish a UNIT ATTENTION condition
2596 * for the calling I_T Nexus
2598 if (pr_reg_p
== pr_reg
)
2601 core_scsi3_ua_allocate(pr_reg_p
->pr_reg_nacl
,
2602 pr_reg_p
->pr_res_mapped_lun
,
2603 0x2A, ASCQ_2AH_RESERVATIONS_RELEASED
);
2605 spin_unlock(&pr_tmpl
->registration_lock
);
2608 if (pr_tmpl
->pr_aptpl_active
)
2609 core_scsi3_update_and_write_aptpl(cmd
->se_dev
, true);
2612 core_scsi3_put_pr_reg(pr_reg
);
2616 static sense_reason_t
2617 core_scsi3_emulate_pro_clear(struct se_cmd
*cmd
, u64 res_key
)
2619 struct se_device
*dev
= cmd
->se_dev
;
2620 struct se_node_acl
*pr_reg_nacl
;
2621 struct se_session
*se_sess
= cmd
->se_sess
;
2622 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
2623 struct t10_pr_registration
*pr_reg
, *pr_reg_tmp
, *pr_reg_n
, *pr_res_holder
;
2624 u32 pr_res_mapped_lun
= 0;
2625 int calling_it_nexus
= 0;
2627 * Locate the existing *pr_reg via struct se_node_acl pointers
2629 pr_reg_n
= core_scsi3_locate_pr_reg(cmd
->se_dev
,
2630 se_sess
->se_node_acl
, se_sess
);
2632 pr_err("SPC-3 PR: Unable to locate"
2633 " PR_REGISTERED *pr_reg for CLEAR\n");
2634 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
2637 * From spc4r17 section 5.7.11.6, Clearing:
2639 * Any application client may release the persistent reservation and
2640 * remove all registrations from a device server by issuing a
2641 * PERSISTENT RESERVE OUT command with CLEAR service action through a
2642 * registered I_T nexus with the following parameter:
2644 * a) RESERVATION KEY field set to the value of the reservation key
2645 * that is registered with the logical unit for the I_T nexus.
2647 if (res_key
!= pr_reg_n
->pr_res_key
) {
2648 pr_err("SPC-3 PR REGISTER: Received"
2649 " res_key: 0x%016Lx does not match"
2650 " existing SA REGISTER res_key:"
2651 " 0x%016Lx\n", res_key
, pr_reg_n
->pr_res_key
);
2652 core_scsi3_put_pr_reg(pr_reg_n
);
2653 return TCM_RESERVATION_CONFLICT
;
2656 * a) Release the persistent reservation, if any;
2658 spin_lock(&dev
->dev_reservation_lock
);
2659 pr_res_holder
= dev
->dev_pr_res_holder
;
2660 if (pr_res_holder
) {
2661 struct se_node_acl
*pr_res_nacl
= pr_res_holder
->pr_reg_nacl
;
2662 __core_scsi3_complete_pro_release(dev
, pr_res_nacl
,
2663 pr_res_holder
, 0, 0);
2665 spin_unlock(&dev
->dev_reservation_lock
);
2667 * b) Remove all registration(s) (see spc4r17 5.7.7);
2669 spin_lock(&pr_tmpl
->registration_lock
);
2670 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
,
2671 &pr_tmpl
->registration_list
, pr_reg_list
) {
2673 calling_it_nexus
= (pr_reg_n
== pr_reg
) ? 1 : 0;
2674 pr_reg_nacl
= pr_reg
->pr_reg_nacl
;
2675 pr_res_mapped_lun
= pr_reg
->pr_res_mapped_lun
;
2676 __core_scsi3_free_registration(dev
, pr_reg
, NULL
,
2679 * e) Establish a unit attention condition for the initiator
2680 * port associated with every registered I_T nexus other
2681 * than the I_T nexus on which the PERSISTENT RESERVE OUT
2682 * command with CLEAR service action was received, with the
2683 * additional sense code set to RESERVATIONS PREEMPTED.
2685 if (!calling_it_nexus
)
2686 core_scsi3_ua_allocate(pr_reg_nacl
, pr_res_mapped_lun
,
2687 0x2A, ASCQ_2AH_RESERVATIONS_PREEMPTED
);
2689 spin_unlock(&pr_tmpl
->registration_lock
);
2691 pr_debug("SPC-3 PR [%s] Service Action: CLEAR complete\n",
2692 cmd
->se_tfo
->get_fabric_name());
2694 core_scsi3_update_and_write_aptpl(cmd
->se_dev
, false);
2696 core_scsi3_pr_generation(dev
);
2701 * Called with struct se_device->dev_reservation_lock held.
2703 static void __core_scsi3_complete_pro_preempt(
2704 struct se_device
*dev
,
2705 struct t10_pr_registration
*pr_reg
,
2706 struct list_head
*preempt_and_abort_list
,
2709 enum preempt_type preempt_type
)
2711 struct se_node_acl
*nacl
= pr_reg
->pr_reg_nacl
;
2712 const struct target_core_fabric_ops
*tfo
= nacl
->se_tpg
->se_tpg_tfo
;
2713 char i_buf
[PR_REG_ISID_ID_LEN
];
2715 memset(i_buf
, 0, PR_REG_ISID_ID_LEN
);
2716 core_pr_dump_initiator_port(pr_reg
, i_buf
, PR_REG_ISID_ID_LEN
);
2718 * Do an implicit RELEASE of the existing reservation.
2720 if (dev
->dev_pr_res_holder
)
2721 __core_scsi3_complete_pro_release(dev
, nacl
,
2722 dev
->dev_pr_res_holder
, 0, 0);
2724 dev
->dev_pr_res_holder
= pr_reg
;
2725 pr_reg
->pr_res_holder
= 1;
2726 pr_reg
->pr_res_type
= type
;
2727 pr_reg
->pr_res_scope
= scope
;
2729 pr_debug("SPC-3 PR [%s] Service Action: PREEMPT%s created new"
2730 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2731 tfo
->get_fabric_name(), (preempt_type
== PREEMPT_AND_ABORT
) ? "_AND_ABORT" : "",
2732 core_scsi3_pr_dump_type(type
),
2733 (pr_reg
->pr_reg_all_tg_pt
) ? 1 : 0);
2734 pr_debug("SPC-3 PR [%s] PREEMPT%s from Node: %s%s\n",
2735 tfo
->get_fabric_name(), (preempt_type
== PREEMPT_AND_ABORT
) ? "_AND_ABORT" : "",
2736 nacl
->initiatorname
, i_buf
);
2738 * For PREEMPT_AND_ABORT, add the preempting reservation's
2739 * struct t10_pr_registration to the list that will be compared
2740 * against received CDBs..
2742 if (preempt_and_abort_list
)
2743 list_add_tail(&pr_reg
->pr_reg_abort_list
,
2744 preempt_and_abort_list
);
2747 static void core_scsi3_release_preempt_and_abort(
2748 struct list_head
*preempt_and_abort_list
,
2749 struct t10_pr_registration
*pr_reg_holder
)
2751 struct t10_pr_registration
*pr_reg
, *pr_reg_tmp
;
2753 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
, preempt_and_abort_list
,
2754 pr_reg_abort_list
) {
2756 list_del(&pr_reg
->pr_reg_abort_list
);
2757 if (pr_reg_holder
== pr_reg
)
2759 if (pr_reg
->pr_res_holder
) {
2760 pr_warn("pr_reg->pr_res_holder still set\n");
2764 pr_reg
->pr_reg_deve
= NULL
;
2765 pr_reg
->pr_reg_nacl
= NULL
;
2766 kmem_cache_free(t10_pr_reg_cache
, pr_reg
);
2770 static sense_reason_t
2771 core_scsi3_pro_preempt(struct se_cmd
*cmd
, int type
, int scope
, u64 res_key
,
2772 u64 sa_res_key
, enum preempt_type preempt_type
)
2774 struct se_device
*dev
= cmd
->se_dev
;
2775 struct se_node_acl
*pr_reg_nacl
;
2776 struct se_session
*se_sess
= cmd
->se_sess
;
2777 LIST_HEAD(preempt_and_abort_list
);
2778 struct t10_pr_registration
*pr_reg
, *pr_reg_tmp
, *pr_reg_n
, *pr_res_holder
;
2779 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
2780 u32 pr_res_mapped_lun
= 0;
2781 int all_reg
= 0, calling_it_nexus
= 0;
2782 bool sa_res_key_unmatched
= sa_res_key
!= 0;
2783 int prh_type
= 0, prh_scope
= 0;
2786 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
2788 pr_reg_n
= core_scsi3_locate_pr_reg(cmd
->se_dev
, se_sess
->se_node_acl
,
2791 pr_err("SPC-3 PR: Unable to locate"
2792 " PR_REGISTERED *pr_reg for PREEMPT%s\n",
2793 (preempt_type
== PREEMPT_AND_ABORT
) ? "_AND_ABORT" : "");
2794 return TCM_RESERVATION_CONFLICT
;
2796 if (pr_reg_n
->pr_res_key
!= res_key
) {
2797 core_scsi3_put_pr_reg(pr_reg_n
);
2798 return TCM_RESERVATION_CONFLICT
;
2800 if (scope
!= PR_SCOPE_LU_SCOPE
) {
2801 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope
);
2802 core_scsi3_put_pr_reg(pr_reg_n
);
2803 return TCM_INVALID_PARAMETER_LIST
;
2806 spin_lock(&dev
->dev_reservation_lock
);
2807 pr_res_holder
= dev
->dev_pr_res_holder
;
2808 if (pr_res_holder
&&
2809 ((pr_res_holder
->pr_res_type
== PR_TYPE_WRITE_EXCLUSIVE_ALLREG
) ||
2810 (pr_res_holder
->pr_res_type
== PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
)))
2813 if (!all_reg
&& !sa_res_key
) {
2814 spin_unlock(&dev
->dev_reservation_lock
);
2815 core_scsi3_put_pr_reg(pr_reg_n
);
2816 return TCM_INVALID_PARAMETER_LIST
;
2819 * From spc4r17, section 5.7.11.4.4 Removing Registrations:
2821 * If the SERVICE ACTION RESERVATION KEY field does not identify a
2822 * persistent reservation holder or there is no persistent reservation
2823 * holder (i.e., there is no persistent reservation), then the device
2824 * server shall perform a preempt by doing the following in an
2825 * uninterrupted series of actions. (See below..)
2827 if (!pr_res_holder
|| (pr_res_holder
->pr_res_key
!= sa_res_key
)) {
2829 * No existing or SA Reservation Key matching reservations..
2831 * PROUT SA PREEMPT with All Registrant type reservations are
2832 * allowed to be processed without a matching SA Reservation Key
2834 spin_lock(&pr_tmpl
->registration_lock
);
2835 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
,
2836 &pr_tmpl
->registration_list
, pr_reg_list
) {
2838 * Removing of registrations in non all registrants
2839 * type reservations without a matching SA reservation
2842 * a) Remove the registrations for all I_T nexuses
2843 * specified by the SERVICE ACTION RESERVATION KEY
2845 * b) Ignore the contents of the SCOPE and TYPE fields;
2846 * c) Process tasks as defined in 5.7.1; and
2847 * d) Establish a unit attention condition for the
2848 * initiator port associated with every I_T nexus
2849 * that lost its registration other than the I_T
2850 * nexus on which the PERSISTENT RESERVE OUT command
2851 * was received, with the additional sense code set
2852 * to REGISTRATIONS PREEMPTED.
2855 if (pr_reg
->pr_res_key
!= sa_res_key
)
2857 sa_res_key_unmatched
= false;
2859 calling_it_nexus
= (pr_reg_n
== pr_reg
) ? 1 : 0;
2860 pr_reg_nacl
= pr_reg
->pr_reg_nacl
;
2861 pr_res_mapped_lun
= pr_reg
->pr_res_mapped_lun
;
2862 __core_scsi3_free_registration(dev
, pr_reg
,
2863 (preempt_type
== PREEMPT_AND_ABORT
) ? &preempt_and_abort_list
:
2864 NULL
, calling_it_nexus
);
2867 * Case for any existing all registrants type
2868 * reservation, follow logic in spc4r17 section
2869 * 5.7.11.4 Preempting, Table 52 and Figure 7.
2871 * For a ZERO SA Reservation key, release
2872 * all other registrations and do an implicit
2873 * release of active persistent reservation.
2875 * For a non-ZERO SA Reservation key, only
2876 * release the matching reservation key from
2880 (pr_reg
->pr_res_key
!= sa_res_key
))
2882 sa_res_key_unmatched
= false;
2884 calling_it_nexus
= (pr_reg_n
== pr_reg
) ? 1 : 0;
2885 if (calling_it_nexus
)
2888 pr_reg_nacl
= pr_reg
->pr_reg_nacl
;
2889 pr_res_mapped_lun
= pr_reg
->pr_res_mapped_lun
;
2890 __core_scsi3_free_registration(dev
, pr_reg
,
2891 (preempt_type
== PREEMPT_AND_ABORT
) ? &preempt_and_abort_list
:
2894 if (!calling_it_nexus
)
2895 core_scsi3_ua_allocate(pr_reg_nacl
,
2896 pr_res_mapped_lun
, 0x2A,
2897 ASCQ_2AH_REGISTRATIONS_PREEMPTED
);
2899 spin_unlock(&pr_tmpl
->registration_lock
);
2901 * If a PERSISTENT RESERVE OUT with a PREEMPT service action or
2902 * a PREEMPT AND ABORT service action sets the SERVICE ACTION
2903 * RESERVATION KEY field to a value that does not match any
2904 * registered reservation key, then the device server shall
2905 * complete the command with RESERVATION CONFLICT status.
2907 if (sa_res_key_unmatched
) {
2908 spin_unlock(&dev
->dev_reservation_lock
);
2909 core_scsi3_put_pr_reg(pr_reg_n
);
2910 return TCM_RESERVATION_CONFLICT
;
2913 * For an existing all registrants type reservation
2914 * with a zero SA rservation key, preempt the existing
2915 * reservation with the new PR type and scope.
2917 if (pr_res_holder
&& all_reg
&& !(sa_res_key
)) {
2918 __core_scsi3_complete_pro_preempt(dev
, pr_reg_n
,
2919 (preempt_type
== PREEMPT_AND_ABORT
) ? &preempt_and_abort_list
: NULL
,
2920 type
, scope
, preempt_type
);
2922 if (preempt_type
== PREEMPT_AND_ABORT
)
2923 core_scsi3_release_preempt_and_abort(
2924 &preempt_and_abort_list
, pr_reg_n
);
2926 spin_unlock(&dev
->dev_reservation_lock
);
2928 if (pr_tmpl
->pr_aptpl_active
)
2929 core_scsi3_update_and_write_aptpl(cmd
->se_dev
, true);
2931 core_scsi3_put_pr_reg(pr_reg_n
);
2932 core_scsi3_pr_generation(cmd
->se_dev
);
2936 * The PREEMPTing SA reservation key matches that of the
2937 * existing persistent reservation, first, we check if
2938 * we are preempting our own reservation.
2939 * From spc4r17, section 5.7.11.4.3 Preempting
2940 * persistent reservations and registration handling
2942 * If an all registrants persistent reservation is not
2943 * present, it is not an error for the persistent
2944 * reservation holder to preempt itself (i.e., a
2945 * PERSISTENT RESERVE OUT with a PREEMPT service action
2946 * or a PREEMPT AND ABORT service action with the
2947 * SERVICE ACTION RESERVATION KEY value equal to the
2948 * persistent reservation holder's reservation key that
2949 * is received from the persistent reservation holder).
2950 * In that case, the device server shall establish the
2951 * new persistent reservation and maintain the
2954 prh_type
= pr_res_holder
->pr_res_type
;
2955 prh_scope
= pr_res_holder
->pr_res_scope
;
2957 * If the SERVICE ACTION RESERVATION KEY field identifies a
2958 * persistent reservation holder (see 5.7.10), the device
2959 * server shall perform a preempt by doing the following as
2960 * an uninterrupted series of actions:
2962 * a) Release the persistent reservation for the holder
2963 * identified by the SERVICE ACTION RESERVATION KEY field;
2965 if (pr_reg_n
!= pr_res_holder
)
2966 __core_scsi3_complete_pro_release(dev
,
2967 pr_res_holder
->pr_reg_nacl
,
2968 dev
->dev_pr_res_holder
, 0, 0);
2970 * b) Remove the registrations for all I_T nexuses identified
2971 * by the SERVICE ACTION RESERVATION KEY field, except the
2972 * I_T nexus that is being used for the PERSISTENT RESERVE
2973 * OUT command. If an all registrants persistent reservation
2974 * is present and the SERVICE ACTION RESERVATION KEY field
2975 * is set to zero, then all registrations shall be removed
2976 * except for that of the I_T nexus that is being used for
2977 * the PERSISTENT RESERVE OUT command;
2979 spin_lock(&pr_tmpl
->registration_lock
);
2980 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
,
2981 &pr_tmpl
->registration_list
, pr_reg_list
) {
2983 calling_it_nexus
= (pr_reg_n
== pr_reg
) ? 1 : 0;
2984 if (calling_it_nexus
)
2987 if (pr_reg
->pr_res_key
!= sa_res_key
)
2990 pr_reg_nacl
= pr_reg
->pr_reg_nacl
;
2991 pr_res_mapped_lun
= pr_reg
->pr_res_mapped_lun
;
2992 __core_scsi3_free_registration(dev
, pr_reg
,
2993 (preempt_type
== PREEMPT_AND_ABORT
) ? &preempt_and_abort_list
: NULL
,
2996 * e) Establish a unit attention condition for the initiator
2997 * port associated with every I_T nexus that lost its
2998 * persistent reservation and/or registration, with the
2999 * additional sense code set to REGISTRATIONS PREEMPTED;
3001 core_scsi3_ua_allocate(pr_reg_nacl
, pr_res_mapped_lun
, 0x2A,
3002 ASCQ_2AH_REGISTRATIONS_PREEMPTED
);
3004 spin_unlock(&pr_tmpl
->registration_lock
);
3006 * c) Establish a persistent reservation for the preempting
3007 * I_T nexus using the contents of the SCOPE and TYPE fields;
3009 __core_scsi3_complete_pro_preempt(dev
, pr_reg_n
,
3010 (preempt_type
== PREEMPT_AND_ABORT
) ? &preempt_and_abort_list
: NULL
,
3011 type
, scope
, preempt_type
);
3013 * d) Process tasks as defined in 5.7.1;
3015 * f) If the type or scope has changed, then for every I_T nexus
3016 * whose reservation key was not removed, except for the I_T
3017 * nexus on which the PERSISTENT RESERVE OUT command was
3018 * received, the device server shall establish a unit
3019 * attention condition for the initiator port associated with
3020 * that I_T nexus, with the additional sense code set to
3021 * RESERVATIONS RELEASED. If the type or scope have not
3022 * changed, then no unit attention condition(s) shall be
3023 * established for this reason.
3025 if ((prh_type
!= type
) || (prh_scope
!= scope
)) {
3026 spin_lock(&pr_tmpl
->registration_lock
);
3027 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
,
3028 &pr_tmpl
->registration_list
, pr_reg_list
) {
3030 calling_it_nexus
= (pr_reg_n
== pr_reg
) ? 1 : 0;
3031 if (calling_it_nexus
)
3034 core_scsi3_ua_allocate(pr_reg
->pr_reg_nacl
,
3035 pr_reg
->pr_res_mapped_lun
, 0x2A,
3036 ASCQ_2AH_RESERVATIONS_RELEASED
);
3038 spin_unlock(&pr_tmpl
->registration_lock
);
3040 spin_unlock(&dev
->dev_reservation_lock
);
3042 * Call LUN_RESET logic upon list of struct t10_pr_registration,
3043 * All received CDBs for the matching existing reservation and
3044 * registrations undergo ABORT_TASK logic.
3046 * From there, core_scsi3_release_preempt_and_abort() will
3047 * release every registration in the list (which have already
3048 * been removed from the primary pr_reg list), except the
3049 * new persistent reservation holder, the calling Initiator Port.
3051 if (preempt_type
== PREEMPT_AND_ABORT
) {
3052 core_tmr_lun_reset(dev
, NULL
, &preempt_and_abort_list
, cmd
);
3053 core_scsi3_release_preempt_and_abort(&preempt_and_abort_list
,
3057 if (pr_tmpl
->pr_aptpl_active
)
3058 core_scsi3_update_and_write_aptpl(cmd
->se_dev
, true);
3060 core_scsi3_put_pr_reg(pr_reg_n
);
3061 core_scsi3_pr_generation(cmd
->se_dev
);
3065 static sense_reason_t
3066 core_scsi3_emulate_pro_preempt(struct se_cmd
*cmd
, int type
, int scope
,
3067 u64 res_key
, u64 sa_res_key
, enum preempt_type preempt_type
)
3070 case PR_TYPE_WRITE_EXCLUSIVE
:
3071 case PR_TYPE_EXCLUSIVE_ACCESS
:
3072 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY
:
3073 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY
:
3074 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG
:
3075 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
:
3076 return core_scsi3_pro_preempt(cmd
, type
, scope
, res_key
,
3077 sa_res_key
, preempt_type
);
3079 pr_err("SPC-3 PR: Unknown Service Action PREEMPT%s"
3080 " Type: 0x%02x\n", (preempt_type
== PREEMPT_AND_ABORT
) ? "_AND_ABORT" : "", type
);
3081 return TCM_INVALID_CDB_FIELD
;
3086 static sense_reason_t
3087 core_scsi3_emulate_pro_register_and_move(struct se_cmd
*cmd
, u64 res_key
,
3088 u64 sa_res_key
, int aptpl
, int unreg
)
3090 struct se_session
*se_sess
= cmd
->se_sess
;
3091 struct se_device
*dev
= cmd
->se_dev
;
3092 struct se_dev_entry
*dest_se_deve
= NULL
;
3093 struct se_lun
*se_lun
= cmd
->se_lun
;
3094 struct se_node_acl
*pr_res_nacl
, *pr_reg_nacl
, *dest_node_acl
= NULL
;
3095 struct se_port
*se_port
;
3096 struct se_portal_group
*se_tpg
, *dest_se_tpg
= NULL
;
3097 const struct target_core_fabric_ops
*dest_tf_ops
= NULL
, *tf_ops
;
3098 struct t10_pr_registration
*pr_reg
, *pr_res_holder
, *dest_pr_reg
;
3099 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
3101 const unsigned char *initiator_str
;
3102 char *iport_ptr
= NULL
, i_buf
[PR_REG_ISID_ID_LEN
];
3103 u32 tid_len
, tmp_tid_len
;
3104 int new_reg
= 0, type
, scope
, matching_iname
;
3106 unsigned short rtpi
;
3107 unsigned char proto_ident
;
3109 if (!se_sess
|| !se_lun
) {
3110 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
3111 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3114 memset(i_buf
, 0, PR_REG_ISID_ID_LEN
);
3115 se_tpg
= se_sess
->se_tpg
;
3116 tf_ops
= se_tpg
->se_tpg_tfo
;
3118 * Follow logic from spc4r17 Section 5.7.8, Table 50 --
3119 * Register behaviors for a REGISTER AND MOVE service action
3121 * Locate the existing *pr_reg via struct se_node_acl pointers
3123 pr_reg
= core_scsi3_locate_pr_reg(cmd
->se_dev
, se_sess
->se_node_acl
,
3126 pr_err("SPC-3 PR: Unable to locate PR_REGISTERED"
3127 " *pr_reg for REGISTER_AND_MOVE\n");
3128 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3131 * The provided reservation key much match the existing reservation key
3132 * provided during this initiator's I_T nexus registration.
3134 if (res_key
!= pr_reg
->pr_res_key
) {
3135 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received"
3136 " res_key: 0x%016Lx does not match existing SA REGISTER"
3137 " res_key: 0x%016Lx\n", res_key
, pr_reg
->pr_res_key
);
3138 ret
= TCM_RESERVATION_CONFLICT
;
3139 goto out_put_pr_reg
;
3142 * The service active reservation key needs to be non zero
3145 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received zero"
3147 ret
= TCM_INVALID_PARAMETER_LIST
;
3148 goto out_put_pr_reg
;
3152 * Determine the Relative Target Port Identifier where the reservation
3153 * will be moved to for the TransportID containing SCSI initiator WWN
3156 buf
= transport_kmap_data_sg(cmd
);
3158 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3159 goto out_put_pr_reg
;
3162 rtpi
= (buf
[18] & 0xff) << 8;
3163 rtpi
|= buf
[19] & 0xff;
3164 tid_len
= (buf
[20] & 0xff) << 24;
3165 tid_len
|= (buf
[21] & 0xff) << 16;
3166 tid_len
|= (buf
[22] & 0xff) << 8;
3167 tid_len
|= buf
[23] & 0xff;
3168 transport_kunmap_data_sg(cmd
);
3171 if ((tid_len
+ 24) != cmd
->data_length
) {
3172 pr_err("SPC-3 PR: Illegal tid_len: %u + 24 byte header"
3173 " does not equal CDB data_length: %u\n", tid_len
,
3175 ret
= TCM_INVALID_PARAMETER_LIST
;
3176 goto out_put_pr_reg
;
3179 spin_lock(&dev
->se_port_lock
);
3180 list_for_each_entry(se_port
, &dev
->dev_sep_list
, sep_list
) {
3181 if (se_port
->sep_rtpi
!= rtpi
)
3183 dest_se_tpg
= se_port
->sep_tpg
;
3186 dest_tf_ops
= dest_se_tpg
->se_tpg_tfo
;
3190 atomic_inc_mb(&dest_se_tpg
->tpg_pr_ref_count
);
3191 spin_unlock(&dev
->se_port_lock
);
3193 if (core_scsi3_tpg_depend_item(dest_se_tpg
)) {
3194 pr_err("core_scsi3_tpg_depend_item() failed"
3195 " for dest_se_tpg\n");
3196 atomic_dec_mb(&dest_se_tpg
->tpg_pr_ref_count
);
3197 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3198 goto out_put_pr_reg
;
3201 spin_lock(&dev
->se_port_lock
);
3204 spin_unlock(&dev
->se_port_lock
);
3206 if (!dest_se_tpg
|| !dest_tf_ops
) {
3207 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3208 " fabric ops from Relative Target Port Identifier:"
3210 ret
= TCM_INVALID_PARAMETER_LIST
;
3211 goto out_put_pr_reg
;
3214 buf
= transport_kmap_data_sg(cmd
);
3216 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3217 goto out_put_pr_reg
;
3219 proto_ident
= (buf
[24] & 0x0f);
3221 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Extracted Protocol Identifier:"
3222 " 0x%02x\n", proto_ident
);
3224 if (proto_ident
!= dest_se_tpg
->proto_id
) {
3225 pr_err("SPC-3 PR REGISTER_AND_MOVE: Received"
3226 " proto_ident: 0x%02x does not match ident: 0x%02x"
3227 " from fabric: %s\n", proto_ident
,
3228 dest_se_tpg
->proto_id
,
3229 dest_tf_ops
->get_fabric_name());
3230 ret
= TCM_INVALID_PARAMETER_LIST
;
3233 initiator_str
= target_parse_pr_out_transport_id(dest_se_tpg
,
3234 (const char *)&buf
[24], &tmp_tid_len
, &iport_ptr
);
3235 if (!initiator_str
) {
3236 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3237 " initiator_str from Transport ID\n");
3238 ret
= TCM_INVALID_PARAMETER_LIST
;
3242 transport_kunmap_data_sg(cmd
);
3245 pr_debug("SPC-3 PR [%s] Extracted initiator %s identifier: %s"
3246 " %s\n", dest_tf_ops
->get_fabric_name(), (iport_ptr
!= NULL
) ?
3247 "port" : "device", initiator_str
, (iport_ptr
!= NULL
) ?
3250 * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3251 * action specifies a TransportID that is the same as the initiator port
3252 * of the I_T nexus for the command received, then the command shall
3253 * be terminated with CHECK CONDITION status, with the sense key set to
3254 * ILLEGAL REQUEST, and the additional sense code set to INVALID FIELD
3255 * IN PARAMETER LIST.
3257 pr_reg_nacl
= pr_reg
->pr_reg_nacl
;
3258 matching_iname
= (!strcmp(initiator_str
,
3259 pr_reg_nacl
->initiatorname
)) ? 1 : 0;
3260 if (!matching_iname
)
3261 goto after_iport_check
;
3263 if (!iport_ptr
|| !pr_reg
->isid_present_at_reg
) {
3264 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s"
3265 " matches: %s on received I_T Nexus\n", initiator_str
,
3266 pr_reg_nacl
->initiatorname
);
3267 ret
= TCM_INVALID_PARAMETER_LIST
;
3270 if (!strcmp(iport_ptr
, pr_reg
->pr_reg_isid
)) {
3271 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s %s"
3272 " matches: %s %s on received I_T Nexus\n",
3273 initiator_str
, iport_ptr
, pr_reg_nacl
->initiatorname
,
3274 pr_reg
->pr_reg_isid
);
3275 ret
= TCM_INVALID_PARAMETER_LIST
;
3280 * Locate the destination struct se_node_acl from the received Transport ID
3282 spin_lock_irq(&dest_se_tpg
->acl_node_lock
);
3283 dest_node_acl
= __core_tpg_get_initiator_node_acl(dest_se_tpg
,
3286 atomic_inc_mb(&dest_node_acl
->acl_pr_ref_count
);
3287 spin_unlock_irq(&dest_se_tpg
->acl_node_lock
);
3289 if (!dest_node_acl
) {
3290 pr_err("Unable to locate %s dest_node_acl for"
3291 " TransportID%s\n", dest_tf_ops
->get_fabric_name(),
3293 ret
= TCM_INVALID_PARAMETER_LIST
;
3297 if (core_scsi3_nodeacl_depend_item(dest_node_acl
)) {
3298 pr_err("core_scsi3_nodeacl_depend_item() for"
3299 " dest_node_acl\n");
3300 atomic_dec_mb(&dest_node_acl
->acl_pr_ref_count
);
3301 dest_node_acl
= NULL
;
3302 ret
= TCM_INVALID_PARAMETER_LIST
;
3306 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Found %s dest_node_acl:"
3307 " %s from TransportID\n", dest_tf_ops
->get_fabric_name(),
3308 dest_node_acl
->initiatorname
);
3311 * Locate the struct se_dev_entry pointer for the matching RELATIVE TARGET
3314 dest_se_deve
= core_get_se_deve_from_rtpi(dest_node_acl
, rtpi
);
3315 if (!dest_se_deve
) {
3316 pr_err("Unable to locate %s dest_se_deve from RTPI:"
3317 " %hu\n", dest_tf_ops
->get_fabric_name(), rtpi
);
3318 ret
= TCM_INVALID_PARAMETER_LIST
;
3322 if (core_scsi3_lunacl_depend_item(dest_se_deve
)) {
3323 pr_err("core_scsi3_lunacl_depend_item() failed\n");
3324 atomic_dec_mb(&dest_se_deve
->pr_ref_count
);
3325 dest_se_deve
= NULL
;
3326 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3330 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Located %s node %s LUN"
3331 " ACL for dest_se_deve->mapped_lun: %u\n",
3332 dest_tf_ops
->get_fabric_name(), dest_node_acl
->initiatorname
,
3333 dest_se_deve
->mapped_lun
);
3336 * A persistent reservation needs to already existing in order to
3337 * successfully complete the REGISTER_AND_MOVE service action..
3339 spin_lock(&dev
->dev_reservation_lock
);
3340 pr_res_holder
= dev
->dev_pr_res_holder
;
3341 if (!pr_res_holder
) {
3342 pr_warn("SPC-3 PR REGISTER_AND_MOVE: No reservation"
3343 " currently held\n");
3344 spin_unlock(&dev
->dev_reservation_lock
);
3345 ret
= TCM_INVALID_CDB_FIELD
;
3349 * The received on I_T Nexus must be the reservation holder.
3351 * From spc4r17 section 5.7.8 Table 50 --
3352 * Register behaviors for a REGISTER AND MOVE service action
3354 if (!is_reservation_holder(pr_res_holder
, pr_reg
)) {
3355 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Calling I_T"
3356 " Nexus is not reservation holder\n");
3357 spin_unlock(&dev
->dev_reservation_lock
);
3358 ret
= TCM_RESERVATION_CONFLICT
;
3362 * From spc4r17 section 5.7.8: registering and moving reservation
3364 * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3365 * action is received and the established persistent reservation is a
3366 * Write Exclusive - All Registrants type or Exclusive Access -
3367 * All Registrants type reservation, then the command shall be completed
3368 * with RESERVATION CONFLICT status.
3370 if ((pr_res_holder
->pr_res_type
== PR_TYPE_WRITE_EXCLUSIVE_ALLREG
) ||
3371 (pr_res_holder
->pr_res_type
== PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
)) {
3372 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Unable to move"
3373 " reservation for type: %s\n",
3374 core_scsi3_pr_dump_type(pr_res_holder
->pr_res_type
));
3375 spin_unlock(&dev
->dev_reservation_lock
);
3376 ret
= TCM_RESERVATION_CONFLICT
;
3379 pr_res_nacl
= pr_res_holder
->pr_reg_nacl
;
3381 * b) Ignore the contents of the (received) SCOPE and TYPE fields;
3383 type
= pr_res_holder
->pr_res_type
;
3384 scope
= pr_res_holder
->pr_res_type
;
3386 * c) Associate the reservation key specified in the SERVICE ACTION
3387 * RESERVATION KEY field with the I_T nexus specified as the
3388 * destination of the register and move, where:
3389 * A) The I_T nexus is specified by the TransportID and the
3390 * RELATIVE TARGET PORT IDENTIFIER field (see 6.14.4); and
3391 * B) Regardless of the TransportID format used, the association for
3392 * the initiator port is based on either the initiator port name
3393 * (see 3.1.71) on SCSI transport protocols where port names are
3394 * required or the initiator port identifier (see 3.1.70) on SCSI
3395 * transport protocols where port names are not required;
3396 * d) Register the reservation key specified in the SERVICE ACTION
3397 * RESERVATION KEY field;
3398 * e) Retain the reservation key specified in the SERVICE ACTION
3399 * RESERVATION KEY field and associated information;
3401 * Also, It is not an error for a REGISTER AND MOVE service action to
3402 * register an I_T nexus that is already registered with the same
3403 * reservation key or a different reservation key.
3405 dest_pr_reg
= __core_scsi3_locate_pr_reg(dev
, dest_node_acl
,
3408 if (core_scsi3_alloc_registration(cmd
->se_dev
,
3409 dest_node_acl
, dest_se_deve
, iport_ptr
,
3410 sa_res_key
, 0, aptpl
, 2, 1)) {
3411 spin_unlock(&dev
->dev_reservation_lock
);
3412 ret
= TCM_INVALID_PARAMETER_LIST
;
3415 dest_pr_reg
= __core_scsi3_locate_pr_reg(dev
, dest_node_acl
,
3420 * f) Release the persistent reservation for the persistent reservation
3421 * holder (i.e., the I_T nexus on which the
3423 __core_scsi3_complete_pro_release(dev
, pr_res_nacl
,
3424 dev
->dev_pr_res_holder
, 0, 0);
3426 * g) Move the persistent reservation to the specified I_T nexus using
3427 * the same scope and type as the persistent reservation released in
3430 dev
->dev_pr_res_holder
= dest_pr_reg
;
3431 dest_pr_reg
->pr_res_holder
= 1;
3432 dest_pr_reg
->pr_res_type
= type
;
3433 pr_reg
->pr_res_scope
= scope
;
3434 core_pr_dump_initiator_port(pr_reg
, i_buf
, PR_REG_ISID_ID_LEN
);
3436 * Increment PRGeneration for existing registrations..
3439 dest_pr_reg
->pr_res_generation
= pr_tmpl
->pr_generation
++;
3440 spin_unlock(&dev
->dev_reservation_lock
);
3442 pr_debug("SPC-3 PR [%s] Service Action: REGISTER_AND_MOVE"
3443 " created new reservation holder TYPE: %s on object RTPI:"
3444 " %hu PRGeneration: 0x%08x\n", dest_tf_ops
->get_fabric_name(),
3445 core_scsi3_pr_dump_type(type
), rtpi
,
3446 dest_pr_reg
->pr_res_generation
);
3447 pr_debug("SPC-3 PR Successfully moved reservation from"
3448 " %s Fabric Node: %s%s -> %s Fabric Node: %s %s\n",
3449 tf_ops
->get_fabric_name(), pr_reg_nacl
->initiatorname
,
3450 i_buf
, dest_tf_ops
->get_fabric_name(),
3451 dest_node_acl
->initiatorname
, (iport_ptr
!= NULL
) ?
3454 * It is now safe to release configfs group dependencies for destination
3455 * of Transport ID Initiator Device/Port Identifier
3457 core_scsi3_lunacl_undepend_item(dest_se_deve
);
3458 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
3459 core_scsi3_tpg_undepend_item(dest_se_tpg
);
3461 * h) If the UNREG bit is set to one, unregister (see 5.7.11.3) the I_T
3462 * nexus on which PERSISTENT RESERVE OUT command was received.
3465 spin_lock(&pr_tmpl
->registration_lock
);
3466 __core_scsi3_free_registration(dev
, pr_reg
, NULL
, 1);
3467 spin_unlock(&pr_tmpl
->registration_lock
);
3469 core_scsi3_put_pr_reg(pr_reg
);
3471 core_scsi3_update_and_write_aptpl(cmd
->se_dev
, aptpl
);
3473 transport_kunmap_data_sg(cmd
);
3475 core_scsi3_put_pr_reg(dest_pr_reg
);
3479 transport_kunmap_data_sg(cmd
);
3481 core_scsi3_lunacl_undepend_item(dest_se_deve
);
3483 core_scsi3_nodeacl_undepend_item(dest_node_acl
);
3484 core_scsi3_tpg_undepend_item(dest_se_tpg
);
3487 core_scsi3_put_pr_reg(pr_reg
);
3491 static unsigned long long core_scsi3_extract_reservation_key(unsigned char *cdb
)
3493 unsigned int __v1
, __v2
;
3495 __v1
= (cdb
[0] << 24) | (cdb
[1] << 16) | (cdb
[2] << 8) | cdb
[3];
3496 __v2
= (cdb
[4] << 24) | (cdb
[5] << 16) | (cdb
[6] << 8) | cdb
[7];
3498 return ((unsigned long long)__v2
) | (unsigned long long)__v1
<< 32;
3502 * See spc4r17 section 6.14 Table 170
3505 target_scsi3_emulate_pr_out(struct se_cmd
*cmd
)
3507 struct se_device
*dev
= cmd
->se_dev
;
3508 unsigned char *cdb
= &cmd
->t_task_cdb
[0];
3510 u64 res_key
, sa_res_key
;
3511 int sa
, scope
, type
, aptpl
;
3512 int spec_i_pt
= 0, all_tg_pt
= 0, unreg
= 0;
3516 * Following spc2r20 5.5.1 Reservations overview:
3518 * If a logical unit has been reserved by any RESERVE command and is
3519 * still reserved by any initiator, all PERSISTENT RESERVE IN and all
3520 * PERSISTENT RESERVE OUT commands shall conflict regardless of
3521 * initiator or service action and shall terminate with a RESERVATION
3524 if (cmd
->se_dev
->dev_reservation_flags
& DRF_SPC2_RESERVATIONS
) {
3525 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
3526 " SPC-2 reservation is held, returning"
3527 " RESERVATION_CONFLICT\n");
3528 return TCM_RESERVATION_CONFLICT
;
3532 * FIXME: A NULL struct se_session pointer means an this is not coming from
3533 * a $FABRIC_MOD's nexus, but from internal passthrough ops.
3536 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3538 if (cmd
->data_length
< 24) {
3539 pr_warn("SPC-PR: Received PR OUT parameter list"
3540 " length too small: %u\n", cmd
->data_length
);
3541 return TCM_INVALID_PARAMETER_LIST
;
3545 * From the PERSISTENT_RESERVE_OUT command descriptor block (CDB)
3547 sa
= (cdb
[1] & 0x1f);
3548 scope
= (cdb
[2] & 0xf0);
3549 type
= (cdb
[2] & 0x0f);
3551 buf
= transport_kmap_data_sg(cmd
);
3553 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3556 * From PERSISTENT_RESERVE_OUT parameter list (payload)
3558 res_key
= core_scsi3_extract_reservation_key(&buf
[0]);
3559 sa_res_key
= core_scsi3_extract_reservation_key(&buf
[8]);
3561 * REGISTER_AND_MOVE uses a different SA parameter list containing
3562 * SCSI TransportIDs.
3564 if (sa
!= PRO_REGISTER_AND_MOVE
) {
3565 spec_i_pt
= (buf
[20] & 0x08);
3566 all_tg_pt
= (buf
[20] & 0x04);
3567 aptpl
= (buf
[20] & 0x01);
3569 aptpl
= (buf
[17] & 0x01);
3570 unreg
= (buf
[17] & 0x02);
3573 * If the backend device has been configured to force APTPL metadata
3574 * write-out, go ahead and propigate aptpl=1 down now.
3576 if (dev
->dev_attrib
.force_pr_aptpl
)
3579 transport_kunmap_data_sg(cmd
);
3583 * SPEC_I_PT=1 is only valid for Service action: REGISTER
3585 if (spec_i_pt
&& ((cdb
[1] & 0x1f) != PRO_REGISTER
))
3586 return TCM_INVALID_PARAMETER_LIST
;
3589 * From spc4r17 section 6.14:
3591 * If the SPEC_I_PT bit is set to zero, the service action is not
3592 * REGISTER AND MOVE, and the parameter list length is not 24, then
3593 * the command shall be terminated with CHECK CONDITION status, with
3594 * the sense key set to ILLEGAL REQUEST, and the additional sense
3595 * code set to PARAMETER LIST LENGTH ERROR.
3597 if (!spec_i_pt
&& ((cdb
[1] & 0x1f) != PRO_REGISTER_AND_MOVE
) &&
3598 (cmd
->data_length
!= 24)) {
3599 pr_warn("SPC-PR: Received PR OUT illegal parameter"
3600 " list length: %u\n", cmd
->data_length
);
3601 return TCM_INVALID_PARAMETER_LIST
;
3605 * (core_scsi3_emulate_pro_* function parameters
3606 * are defined by spc4r17 Table 174:
3607 * PERSISTENT_RESERVE_OUT service actions and valid parameters.
3611 ret
= core_scsi3_emulate_pro_register(cmd
,
3612 res_key
, sa_res_key
, aptpl
, all_tg_pt
, spec_i_pt
, REGISTER
);
3615 ret
= core_scsi3_emulate_pro_reserve(cmd
, type
, scope
, res_key
);
3618 ret
= core_scsi3_emulate_pro_release(cmd
, type
, scope
, res_key
);
3621 ret
= core_scsi3_emulate_pro_clear(cmd
, res_key
);
3624 ret
= core_scsi3_emulate_pro_preempt(cmd
, type
, scope
,
3625 res_key
, sa_res_key
, PREEMPT
);
3627 case PRO_PREEMPT_AND_ABORT
:
3628 ret
= core_scsi3_emulate_pro_preempt(cmd
, type
, scope
,
3629 res_key
, sa_res_key
, PREEMPT_AND_ABORT
);
3631 case PRO_REGISTER_AND_IGNORE_EXISTING_KEY
:
3632 ret
= core_scsi3_emulate_pro_register(cmd
,
3633 0, sa_res_key
, aptpl
, all_tg_pt
, spec_i_pt
, REGISTER_AND_IGNORE_EXISTING_KEY
);
3635 case PRO_REGISTER_AND_MOVE
:
3636 ret
= core_scsi3_emulate_pro_register_and_move(cmd
, res_key
,
3637 sa_res_key
, aptpl
, unreg
);
3640 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
3641 " action: 0x%02x\n", cdb
[1] & 0x1f);
3642 return TCM_INVALID_CDB_FIELD
;
3646 target_complete_cmd(cmd
, GOOD
);
3651 * PERSISTENT_RESERVE_IN Service Action READ_KEYS
3653 * See spc4r17 section 5.7.6.2 and section 6.13.2, Table 160
3655 static sense_reason_t
3656 core_scsi3_pri_read_keys(struct se_cmd
*cmd
)
3658 struct se_device
*dev
= cmd
->se_dev
;
3659 struct t10_pr_registration
*pr_reg
;
3661 u32 add_len
= 0, off
= 8;
3663 if (cmd
->data_length
< 8) {
3664 pr_err("PRIN SA READ_KEYS SCSI Data Length: %u"
3665 " too small\n", cmd
->data_length
);
3666 return TCM_INVALID_CDB_FIELD
;
3669 buf
= transport_kmap_data_sg(cmd
);
3671 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3673 buf
[0] = ((dev
->t10_pr
.pr_generation
>> 24) & 0xff);
3674 buf
[1] = ((dev
->t10_pr
.pr_generation
>> 16) & 0xff);
3675 buf
[2] = ((dev
->t10_pr
.pr_generation
>> 8) & 0xff);
3676 buf
[3] = (dev
->t10_pr
.pr_generation
& 0xff);
3678 spin_lock(&dev
->t10_pr
.registration_lock
);
3679 list_for_each_entry(pr_reg
, &dev
->t10_pr
.registration_list
,
3682 * Check for overflow of 8byte PRI READ_KEYS payload and
3683 * next reservation key list descriptor.
3685 if ((add_len
+ 8) > (cmd
->data_length
- 8))
3688 buf
[off
++] = ((pr_reg
->pr_res_key
>> 56) & 0xff);
3689 buf
[off
++] = ((pr_reg
->pr_res_key
>> 48) & 0xff);
3690 buf
[off
++] = ((pr_reg
->pr_res_key
>> 40) & 0xff);
3691 buf
[off
++] = ((pr_reg
->pr_res_key
>> 32) & 0xff);
3692 buf
[off
++] = ((pr_reg
->pr_res_key
>> 24) & 0xff);
3693 buf
[off
++] = ((pr_reg
->pr_res_key
>> 16) & 0xff);
3694 buf
[off
++] = ((pr_reg
->pr_res_key
>> 8) & 0xff);
3695 buf
[off
++] = (pr_reg
->pr_res_key
& 0xff);
3699 spin_unlock(&dev
->t10_pr
.registration_lock
);
3701 buf
[4] = ((add_len
>> 24) & 0xff);
3702 buf
[5] = ((add_len
>> 16) & 0xff);
3703 buf
[6] = ((add_len
>> 8) & 0xff);
3704 buf
[7] = (add_len
& 0xff);
3706 transport_kunmap_data_sg(cmd
);
3712 * PERSISTENT_RESERVE_IN Service Action READ_RESERVATION
3714 * See spc4r17 section 5.7.6.3 and section 6.13.3.2 Table 161 and 162
3716 static sense_reason_t
3717 core_scsi3_pri_read_reservation(struct se_cmd
*cmd
)
3719 struct se_device
*dev
= cmd
->se_dev
;
3720 struct t10_pr_registration
*pr_reg
;
3723 u32 add_len
= 16; /* Hardcoded to 16 when a reservation is held. */
3725 if (cmd
->data_length
< 8) {
3726 pr_err("PRIN SA READ_RESERVATIONS SCSI Data Length: %u"
3727 " too small\n", cmd
->data_length
);
3728 return TCM_INVALID_CDB_FIELD
;
3731 buf
= transport_kmap_data_sg(cmd
);
3733 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3735 buf
[0] = ((dev
->t10_pr
.pr_generation
>> 24) & 0xff);
3736 buf
[1] = ((dev
->t10_pr
.pr_generation
>> 16) & 0xff);
3737 buf
[2] = ((dev
->t10_pr
.pr_generation
>> 8) & 0xff);
3738 buf
[3] = (dev
->t10_pr
.pr_generation
& 0xff);
3740 spin_lock(&dev
->dev_reservation_lock
);
3741 pr_reg
= dev
->dev_pr_res_holder
;
3744 * Set the hardcoded Additional Length
3746 buf
[4] = ((add_len
>> 24) & 0xff);
3747 buf
[5] = ((add_len
>> 16) & 0xff);
3748 buf
[6] = ((add_len
>> 8) & 0xff);
3749 buf
[7] = (add_len
& 0xff);
3751 if (cmd
->data_length
< 22)
3755 * Set the Reservation key.
3757 * From spc4r17, section 5.7.10:
3758 * A persistent reservation holder has its reservation key
3759 * returned in the parameter data from a PERSISTENT
3760 * RESERVE IN command with READ RESERVATION service action as
3762 * a) For a persistent reservation of the type Write Exclusive
3763 * - All Registrants or Exclusive Access  All Regitrants,
3764 * the reservation key shall be set to zero; or
3765 * b) For all other persistent reservation types, the
3766 * reservation key shall be set to the registered
3767 * reservation key for the I_T nexus that holds the
3768 * persistent reservation.
3770 if ((pr_reg
->pr_res_type
== PR_TYPE_WRITE_EXCLUSIVE_ALLREG
) ||
3771 (pr_reg
->pr_res_type
== PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
))
3774 pr_res_key
= pr_reg
->pr_res_key
;
3776 buf
[8] = ((pr_res_key
>> 56) & 0xff);
3777 buf
[9] = ((pr_res_key
>> 48) & 0xff);
3778 buf
[10] = ((pr_res_key
>> 40) & 0xff);
3779 buf
[11] = ((pr_res_key
>> 32) & 0xff);
3780 buf
[12] = ((pr_res_key
>> 24) & 0xff);
3781 buf
[13] = ((pr_res_key
>> 16) & 0xff);
3782 buf
[14] = ((pr_res_key
>> 8) & 0xff);
3783 buf
[15] = (pr_res_key
& 0xff);
3785 * Set the SCOPE and TYPE
3787 buf
[21] = (pr_reg
->pr_res_scope
& 0xf0) |
3788 (pr_reg
->pr_res_type
& 0x0f);
3792 spin_unlock(&dev
->dev_reservation_lock
);
3793 transport_kunmap_data_sg(cmd
);
3799 * PERSISTENT_RESERVE_IN Service Action REPORT_CAPABILITIES
3801 * See spc4r17 section 6.13.4 Table 165
3803 static sense_reason_t
3804 core_scsi3_pri_report_capabilities(struct se_cmd
*cmd
)
3806 struct se_device
*dev
= cmd
->se_dev
;
3807 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
3809 u16 add_len
= 8; /* Hardcoded to 8. */
3811 if (cmd
->data_length
< 6) {
3812 pr_err("PRIN SA REPORT_CAPABILITIES SCSI Data Length:"
3813 " %u too small\n", cmd
->data_length
);
3814 return TCM_INVALID_CDB_FIELD
;
3817 buf
= transport_kmap_data_sg(cmd
);
3819 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3821 buf
[0] = ((add_len
>> 8) & 0xff);
3822 buf
[1] = (add_len
& 0xff);
3823 buf
[2] |= 0x10; /* CRH: Compatible Reservation Hanlding bit. */
3824 buf
[2] |= 0x08; /* SIP_C: Specify Initiator Ports Capable bit */
3825 buf
[2] |= 0x04; /* ATP_C: All Target Ports Capable bit */
3826 buf
[2] |= 0x01; /* PTPL_C: Persistence across Target Power Loss bit */
3828 * We are filling in the PERSISTENT RESERVATION TYPE MASK below, so
3829 * set the TMV: Task Mask Valid bit.
3833 * Change ALLOW COMMANDs to 0x20 or 0x40 later from Table 166
3835 buf
[3] |= 0x10; /* ALLOW COMMANDs field 001b */
3837 * PTPL_A: Persistence across Target Power Loss Active bit
3839 if (pr_tmpl
->pr_aptpl_active
)
3842 * Setup the PERSISTENT RESERVATION TYPE MASK from Table 167
3844 buf
[4] |= 0x80; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3845 buf
[4] |= 0x40; /* PR_TYPE_EXCLUSIVE_ACCESS_REGONLY */
3846 buf
[4] |= 0x20; /* PR_TYPE_WRITE_EXCLUSIVE_REGONLY */
3847 buf
[4] |= 0x08; /* PR_TYPE_EXCLUSIVE_ACCESS */
3848 buf
[4] |= 0x02; /* PR_TYPE_WRITE_EXCLUSIVE */
3849 buf
[5] |= 0x01; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3851 transport_kunmap_data_sg(cmd
);
3857 * PERSISTENT_RESERVE_IN Service Action READ_FULL_STATUS
3859 * See spc4r17 section 6.13.5 Table 168 and 169
3861 static sense_reason_t
3862 core_scsi3_pri_read_full_status(struct se_cmd
*cmd
)
3864 struct se_device
*dev
= cmd
->se_dev
;
3865 struct se_node_acl
*se_nacl
;
3866 struct se_portal_group
*se_tpg
;
3867 struct t10_pr_registration
*pr_reg
, *pr_reg_tmp
;
3868 struct t10_reservation
*pr_tmpl
= &dev
->t10_pr
;
3870 u32 add_desc_len
= 0, add_len
= 0;
3871 u32 off
= 8; /* off into first Full Status descriptor */
3872 int format_code
= 0, pr_res_type
= 0, pr_res_scope
= 0;
3873 int exp_desc_len
, desc_len
;
3874 bool all_reg
= false;
3876 if (cmd
->data_length
< 8) {
3877 pr_err("PRIN SA READ_FULL_STATUS SCSI Data Length: %u"
3878 " too small\n", cmd
->data_length
);
3879 return TCM_INVALID_CDB_FIELD
;
3882 buf
= transport_kmap_data_sg(cmd
);
3884 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
3886 buf
[0] = ((dev
->t10_pr
.pr_generation
>> 24) & 0xff);
3887 buf
[1] = ((dev
->t10_pr
.pr_generation
>> 16) & 0xff);
3888 buf
[2] = ((dev
->t10_pr
.pr_generation
>> 8) & 0xff);
3889 buf
[3] = (dev
->t10_pr
.pr_generation
& 0xff);
3891 spin_lock(&dev
->dev_reservation_lock
);
3892 if (dev
->dev_pr_res_holder
) {
3893 struct t10_pr_registration
*pr_holder
= dev
->dev_pr_res_holder
;
3895 if (pr_holder
->pr_res_type
== PR_TYPE_WRITE_EXCLUSIVE_ALLREG
||
3896 pr_holder
->pr_res_type
== PR_TYPE_EXCLUSIVE_ACCESS_ALLREG
) {
3898 pr_res_type
= pr_holder
->pr_res_type
;
3899 pr_res_scope
= pr_holder
->pr_res_scope
;
3902 spin_unlock(&dev
->dev_reservation_lock
);
3904 spin_lock(&pr_tmpl
->registration_lock
);
3905 list_for_each_entry_safe(pr_reg
, pr_reg_tmp
,
3906 &pr_tmpl
->registration_list
, pr_reg_list
) {
3908 se_nacl
= pr_reg
->pr_reg_nacl
;
3909 se_tpg
= pr_reg
->pr_reg_nacl
->se_tpg
;
3912 atomic_inc_mb(&pr_reg
->pr_res_holders
);
3913 spin_unlock(&pr_tmpl
->registration_lock
);
3915 * Determine expected length of $FABRIC_MOD specific
3916 * TransportID full status descriptor..
3918 exp_desc_len
= target_get_pr_transport_id_len(se_nacl
, pr_reg
,
3920 if (exp_desc_len
< 0 ||
3921 exp_desc_len
+ add_len
> cmd
->data_length
) {
3922 pr_warn("SPC-3 PRIN READ_FULL_STATUS ran"
3923 " out of buffer: %d\n", cmd
->data_length
);
3924 spin_lock(&pr_tmpl
->registration_lock
);
3925 atomic_dec_mb(&pr_reg
->pr_res_holders
);
3929 * Set RESERVATION KEY
3931 buf
[off
++] = ((pr_reg
->pr_res_key
>> 56) & 0xff);
3932 buf
[off
++] = ((pr_reg
->pr_res_key
>> 48) & 0xff);
3933 buf
[off
++] = ((pr_reg
->pr_res_key
>> 40) & 0xff);
3934 buf
[off
++] = ((pr_reg
->pr_res_key
>> 32) & 0xff);
3935 buf
[off
++] = ((pr_reg
->pr_res_key
>> 24) & 0xff);
3936 buf
[off
++] = ((pr_reg
->pr_res_key
>> 16) & 0xff);
3937 buf
[off
++] = ((pr_reg
->pr_res_key
>> 8) & 0xff);
3938 buf
[off
++] = (pr_reg
->pr_res_key
& 0xff);
3939 off
+= 4; /* Skip Over Reserved area */
3942 * Set ALL_TG_PT bit if PROUT SA REGISTER had this set.
3944 if (pr_reg
->pr_reg_all_tg_pt
)
3947 * The struct se_lun pointer will be present for the
3948 * reservation holder for PR_HOLDER bit.
3950 * Also, if this registration is the reservation
3951 * holder or there is an All Registrants reservation
3952 * active, fill in SCOPE and TYPE in the next byte.
3954 if (pr_reg
->pr_res_holder
) {
3956 buf
[off
++] = (pr_reg
->pr_res_scope
& 0xf0) |
3957 (pr_reg
->pr_res_type
& 0x0f);
3958 } else if (all_reg
) {
3960 buf
[off
++] = (pr_res_scope
& 0xf0) |
3961 (pr_res_type
& 0x0f);
3966 off
+= 4; /* Skip over reserved area */
3968 * From spc4r17 6.3.15:
3970 * If the ALL_TG_PT bit set to zero, the RELATIVE TARGET PORT
3971 * IDENTIFIER field contains the relative port identifier (see
3972 * 3.1.120) of the target port that is part of the I_T nexus
3973 * described by this full status descriptor. If the ALL_TG_PT
3974 * bit is set to one, the contents of the RELATIVE TARGET PORT
3975 * IDENTIFIER field are not defined by this standard.
3977 if (!pr_reg
->pr_reg_all_tg_pt
) {
3978 struct se_port
*port
= pr_reg
->pr_reg_tg_pt_lun
->lun_sep
;
3980 buf
[off
++] = ((port
->sep_rtpi
>> 8) & 0xff);
3981 buf
[off
++] = (port
->sep_rtpi
& 0xff);
3983 off
+= 2; /* Skip over RELATIVE TARGET PORT IDENTIFIER */
3985 buf
[off
+4] = se_tpg
->proto_id
;
3988 * Now, have the $FABRIC_MOD fill in the transport ID.
3990 desc_len
= target_get_pr_transport_id(se_nacl
, pr_reg
,
3991 &format_code
, &buf
[off
+4]);
3993 spin_lock(&pr_tmpl
->registration_lock
);
3994 atomic_dec_mb(&pr_reg
->pr_res_holders
);
3999 * Set the ADDITIONAL DESCRIPTOR LENGTH
4001 buf
[off
++] = ((desc_len
>> 24) & 0xff);
4002 buf
[off
++] = ((desc_len
>> 16) & 0xff);
4003 buf
[off
++] = ((desc_len
>> 8) & 0xff);
4004 buf
[off
++] = (desc_len
& 0xff);
4006 * Size of full desctipor header minus TransportID
4007 * containing $FABRIC_MOD specific) initiator device/port
4010 * See spc4r17 Section 6.13.5 Table 169
4012 add_desc_len
= (24 + desc_len
);
4015 add_len
+= add_desc_len
;
4017 spin_unlock(&pr_tmpl
->registration_lock
);
4019 * Set ADDITIONAL_LENGTH
4021 buf
[4] = ((add_len
>> 24) & 0xff);
4022 buf
[5] = ((add_len
>> 16) & 0xff);
4023 buf
[6] = ((add_len
>> 8) & 0xff);
4024 buf
[7] = (add_len
& 0xff);
4026 transport_kunmap_data_sg(cmd
);
4032 target_scsi3_emulate_pr_in(struct se_cmd
*cmd
)
4037 * Following spc2r20 5.5.1 Reservations overview:
4039 * If a logical unit has been reserved by any RESERVE command and is
4040 * still reserved by any initiator, all PERSISTENT RESERVE IN and all
4041 * PERSISTENT RESERVE OUT commands shall conflict regardless of
4042 * initiator or service action and shall terminate with a RESERVATION
4045 if (cmd
->se_dev
->dev_reservation_flags
& DRF_SPC2_RESERVATIONS
) {
4046 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
4047 " SPC-2 reservation is held, returning"
4048 " RESERVATION_CONFLICT\n");
4049 return TCM_RESERVATION_CONFLICT
;
4052 switch (cmd
->t_task_cdb
[1] & 0x1f) {
4054 ret
= core_scsi3_pri_read_keys(cmd
);
4056 case PRI_READ_RESERVATION
:
4057 ret
= core_scsi3_pri_read_reservation(cmd
);
4059 case PRI_REPORT_CAPABILITIES
:
4060 ret
= core_scsi3_pri_report_capabilities(cmd
);
4062 case PRI_READ_FULL_STATUS
:
4063 ret
= core_scsi3_pri_read_full_status(cmd
);
4066 pr_err("Unknown PERSISTENT_RESERVE_IN service"
4067 " action: 0x%02x\n", cmd
->t_task_cdb
[1] & 0x1f);
4068 return TCM_INVALID_CDB_FIELD
;
4072 target_complete_cmd(cmd
, GOOD
);
4077 target_check_reservation(struct se_cmd
*cmd
)
4079 struct se_device
*dev
= cmd
->se_dev
;
4084 if (dev
->se_hba
->hba_flags
& HBA_FLAGS_INTERNAL_USE
)
4086 if (dev
->transport
->transport_flags
& TRANSPORT_FLAG_PASSTHROUGH
)
4089 spin_lock(&dev
->dev_reservation_lock
);
4090 if (dev
->dev_reservation_flags
& DRF_SPC2_RESERVATIONS
)
4091 ret
= target_scsi2_reservation_check(cmd
);
4093 ret
= target_scsi3_pr_reservation_check(cmd
);
4094 spin_unlock(&dev
->dev_reservation_lock
);