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>
38 #include <target/target_core_configfs.h>
40 #include "target_core_internal.h"
41 #include "target_core_pr.h"
42 #include "target_core_ua.h"
45 * Used for Specify Initiator Ports Capable Bit (SPEC_I_PT)
47 struct pr_transport_id_holder {
49 struct t10_pr_registration *dest_pr_reg;
50 struct se_portal_group *dest_tpg;
51 struct se_node_acl *dest_node_acl;
52 struct se_dev_entry *dest_se_deve;
53 struct list_head dest_list;
56 void core_pr_dump_initiator_port(
57 struct t10_pr_registration *pr_reg,
61 if (!pr_reg->isid_present_at_reg)
64 snprintf(buf, size, ",i,0x%s", pr_reg->pr_reg_isid);
69 REGISTER_AND_IGNORE_EXISTING_KEY,
78 static void __core_scsi3_complete_pro_release(struct se_device *, struct se_node_acl *,
79 struct t10_pr_registration *, int, int);
82 target_scsi2_reservation_check(struct se_cmd *cmd)
84 struct se_device *dev = cmd->se_dev;
85 struct se_session *sess = cmd->se_sess;
87 switch (cmd->t_task_cdb[0]) {
96 if (!dev->dev_reserved_node_acl || !sess)
99 if (dev->dev_reserved_node_acl != sess->se_node_acl)
100 return TCM_RESERVATION_CONFLICT;
102 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS_WITH_ISID) {
103 if (dev->dev_res_bin_isid != sess->sess_bin_isid)
104 return TCM_RESERVATION_CONFLICT;
110 static struct t10_pr_registration *core_scsi3_locate_pr_reg(struct se_device *,
111 struct se_node_acl *, struct se_session *);
112 static void core_scsi3_put_pr_reg(struct t10_pr_registration *);
114 static int target_check_scsi2_reservation_conflict(struct se_cmd *cmd)
116 struct se_session *se_sess = cmd->se_sess;
117 struct se_device *dev = cmd->se_dev;
118 struct t10_pr_registration *pr_reg;
119 struct t10_reservation *pr_tmpl = &dev->t10_pr;
122 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
126 * From spc4r17 5.7.3 Exceptions to SPC-2 RESERVE and RELEASE
129 * A RESERVE(6) or RESERVE(10) command shall complete with GOOD
130 * status, but no reservation shall be established and the
131 * persistent reservation shall not be changed, if the command
132 * is received from a) and b) below.
134 * A RELEASE(6) or RELEASE(10) command shall complete with GOOD
135 * status, but the persistent reservation shall not be released,
136 * if the command is received from a) and b)
138 * a) An I_T nexus that is a persistent reservation holder; or
139 * b) An I_T nexus that is registered if a registrants only or
140 * all registrants type persistent reservation is present.
142 * In all other cases, a RESERVE(6) command, RESERVE(10) command,
143 * RELEASE(6) command, or RELEASE(10) command shall be processed
144 * as defined in SPC-2.
146 if (pr_reg->pr_res_holder) {
147 core_scsi3_put_pr_reg(pr_reg);
150 if ((pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_REGONLY) ||
151 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_REGONLY) ||
152 (pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
153 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
154 core_scsi3_put_pr_reg(pr_reg);
157 core_scsi3_put_pr_reg(pr_reg);
161 * Following spc2r20 5.5.1 Reservations overview:
163 * If a logical unit has executed a PERSISTENT RESERVE OUT
164 * command with the REGISTER or the REGISTER AND IGNORE
165 * EXISTING KEY service action and is still registered by any
166 * initiator, all RESERVE commands and all RELEASE commands
167 * regardless of initiator shall conflict and shall terminate
168 * with a RESERVATION CONFLICT status.
170 spin_lock(&pr_tmpl->registration_lock);
171 conflict = (list_empty(&pr_tmpl->registration_list)) ? 0 : 1;
172 spin_unlock(&pr_tmpl->registration_lock);
176 pr_err("Received legacy SPC-2 RESERVE/RELEASE"
177 " while active SPC-3 registrations exist,"
178 " returning RESERVATION_CONFLICT\n");
186 target_scsi2_reservation_release(struct se_cmd *cmd)
188 struct se_device *dev = cmd->se_dev;
189 struct se_session *sess = cmd->se_sess;
190 struct se_portal_group *tpg;
193 if (!sess || !sess->se_tpg)
195 rc = target_check_scsi2_reservation_conflict(cmd);
199 return TCM_RESERVATION_CONFLICT;
201 spin_lock(&dev->dev_reservation_lock);
202 if (!dev->dev_reserved_node_acl || !sess)
205 if (dev->dev_reserved_node_acl != sess->se_node_acl)
208 if (dev->dev_res_bin_isid != sess->sess_bin_isid)
211 dev->dev_reserved_node_acl = NULL;
212 dev->dev_reservation_flags &= ~DRF_SPC2_RESERVATIONS;
213 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS_WITH_ISID) {
214 dev->dev_res_bin_isid = 0;
215 dev->dev_reservation_flags &= ~DRF_SPC2_RESERVATIONS_WITH_ISID;
218 pr_debug("SCSI-2 Released reservation for %s LUN: %u ->"
219 " MAPPED LUN: %u for %s\n", tpg->se_tpg_tfo->get_fabric_name(),
220 cmd->se_lun->unpacked_lun, cmd->se_deve->mapped_lun,
221 sess->se_node_acl->initiatorname);
224 spin_unlock(&dev->dev_reservation_lock);
226 target_complete_cmd(cmd, GOOD);
231 target_scsi2_reservation_reserve(struct se_cmd *cmd)
233 struct se_device *dev = cmd->se_dev;
234 struct se_session *sess = cmd->se_sess;
235 struct se_portal_group *tpg;
236 sense_reason_t ret = 0;
239 if ((cmd->t_task_cdb[1] & 0x01) &&
240 (cmd->t_task_cdb[1] & 0x02)) {
241 pr_err("LongIO and Obselete Bits set, returning"
242 " ILLEGAL_REQUEST\n");
243 return TCM_UNSUPPORTED_SCSI_OPCODE;
246 * This is currently the case for target_core_mod passthrough struct se_cmd
249 if (!sess || !sess->se_tpg)
251 rc = target_check_scsi2_reservation_conflict(cmd);
256 return TCM_RESERVATION_CONFLICT;
259 spin_lock(&dev->dev_reservation_lock);
260 if (dev->dev_reserved_node_acl &&
261 (dev->dev_reserved_node_acl != sess->se_node_acl)) {
262 pr_err("SCSI-2 RESERVATION CONFLIFT for %s fabric\n",
263 tpg->se_tpg_tfo->get_fabric_name());
264 pr_err("Original reserver LUN: %u %s\n",
265 cmd->se_lun->unpacked_lun,
266 dev->dev_reserved_node_acl->initiatorname);
267 pr_err("Current attempt - LUN: %u -> MAPPED LUN: %u"
268 " from %s \n", cmd->se_lun->unpacked_lun,
269 cmd->se_deve->mapped_lun,
270 sess->se_node_acl->initiatorname);
271 ret = TCM_RESERVATION_CONFLICT;
275 dev->dev_reserved_node_acl = sess->se_node_acl;
276 dev->dev_reservation_flags |= DRF_SPC2_RESERVATIONS;
277 if (sess->sess_bin_isid != 0) {
278 dev->dev_res_bin_isid = sess->sess_bin_isid;
279 dev->dev_reservation_flags |= DRF_SPC2_RESERVATIONS_WITH_ISID;
281 pr_debug("SCSI-2 Reserved %s LUN: %u -> MAPPED LUN: %u"
282 " for %s\n", tpg->se_tpg_tfo->get_fabric_name(),
283 cmd->se_lun->unpacked_lun, cmd->se_deve->mapped_lun,
284 sess->se_node_acl->initiatorname);
287 spin_unlock(&dev->dev_reservation_lock);
290 target_complete_cmd(cmd, GOOD);
296 * Begin SPC-3/SPC-4 Persistent Reservations emulation support
298 * This function is called by those initiator ports who are *NOT*
299 * the active PR reservation holder when a reservation is present.
301 static int core_scsi3_pr_seq_non_holder(
305 unsigned char *cdb = cmd->t_task_cdb;
306 struct se_dev_entry *se_deve;
307 struct se_session *se_sess = cmd->se_sess;
308 int other_cdb = 0, ignore_reg;
309 int registered_nexus = 0, ret = 1; /* Conflict by default */
310 int all_reg = 0, reg_only = 0; /* ALL_REG, REG_ONLY */
311 int we = 0; /* Write Exclusive */
312 int legacy = 0; /* Act like a legacy device and return
313 * RESERVATION CONFLICT on some CDBs */
315 se_deve = se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
317 * Determine if the registration should be ignored due to
318 * non-matching ISIDs in target_scsi3_pr_reservation_check().
320 ignore_reg = (pr_reg_type & 0x80000000);
322 pr_reg_type &= ~0x80000000;
324 switch (pr_reg_type) {
325 case PR_TYPE_WRITE_EXCLUSIVE:
327 case PR_TYPE_EXCLUSIVE_ACCESS:
329 * Some commands are only allowed for the persistent reservation
332 if ((se_deve->def_pr_registered) && !(ignore_reg))
333 registered_nexus = 1;
335 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
337 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
339 * Some commands are only allowed for registered I_T Nexuses.
342 if ((se_deve->def_pr_registered) && !(ignore_reg))
343 registered_nexus = 1;
345 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
347 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
349 * Each registered I_T Nexus is a reservation holder.
352 if ((se_deve->def_pr_registered) && !(ignore_reg))
353 registered_nexus = 1;
359 * Referenced from spc4r17 table 45 for *NON* PR holder access
362 case SECURITY_PROTOCOL_IN:
363 if (registered_nexus)
371 case RECEIVE_DIAGNOSTIC:
376 if (registered_nexus) {
380 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
382 case PERSISTENT_RESERVE_OUT:
384 * This follows PERSISTENT_RESERVE_OUT service actions that
385 * are allowed in the presence of various reservations.
386 * See spc4r17, table 46
388 switch (cdb[1] & 0x1f) {
391 case PRO_PREEMPT_AND_ABORT:
392 ret = (registered_nexus) ? 0 : 1;
395 case PRO_REGISTER_AND_IGNORE_EXISTING_KEY:
398 case PRO_REGISTER_AND_MOVE:
403 ret = (registered_nexus) ? 0 : 1;
406 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
407 " action: 0x%02x\n", cdb[1] & 0x1f);
413 /* Handled by CRH=1 in target_scsi2_reservation_release() */
418 /* Handled by CRH=1 in target_scsi2_reservation_reserve() */
421 case TEST_UNIT_READY:
422 ret = (legacy) ? 1 : 0; /* Conflict for legacy */
425 switch (cdb[1] & 0x1f) {
426 case MI_MANAGEMENT_PROTOCOL_IN:
427 if (registered_nexus) {
431 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
433 case MI_REPORT_SUPPORTED_OPERATION_CODES:
434 case MI_REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS:
439 if (registered_nexus) {
443 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
445 case MI_REPORT_ALIASES:
446 case MI_REPORT_IDENTIFYING_INFORMATION:
447 case MI_REPORT_PRIORITY:
448 case MI_REPORT_TARGET_PGS:
449 case MI_REPORT_TIMESTAMP:
450 ret = 0; /* Allowed */
453 pr_err("Unknown MI Service Action: 0x%02x\n",
458 case ACCESS_CONTROL_IN:
459 case ACCESS_CONTROL_OUT:
462 case SERVICE_ACTION_IN_12:
465 case PERSISTENT_RESERVE_IN:
466 ret = 0; /*/ Allowed CDBs */
473 * Case where the CDB is explicitly allowed in the above switch
476 if (!ret && !other_cdb) {
477 pr_debug("Allowing explicit CDB: 0x%02x for %s"
478 " reservation holder\n", cdb[0],
479 core_scsi3_pr_dump_type(pr_reg_type));
484 * Check if write exclusive initiator ports *NOT* holding the
485 * WRITE_EXCLUSIVE_* reservation.
487 if (we && !registered_nexus) {
488 if (cmd->data_direction == DMA_TO_DEVICE) {
490 * Conflict for write exclusive
492 pr_debug("%s Conflict for unregistered nexus"
493 " %s CDB: 0x%02x to %s reservation\n",
494 transport_dump_cmd_direction(cmd),
495 se_sess->se_node_acl->initiatorname, cdb[0],
496 core_scsi3_pr_dump_type(pr_reg_type));
500 * Allow non WRITE CDBs for all Write Exclusive
501 * PR TYPEs to pass for registered and
502 * non-registered_nexuxes NOT holding the reservation.
504 * We only make noise for the unregisterd nexuses,
505 * as we expect registered non-reservation holding
506 * nexuses to issue CDBs.
509 if (!registered_nexus) {
510 pr_debug("Allowing implicit CDB: 0x%02x"
511 " for %s reservation on unregistered"
513 core_scsi3_pr_dump_type(pr_reg_type));
518 } else if ((reg_only) || (all_reg)) {
519 if (registered_nexus) {
521 * For PR_*_REG_ONLY and PR_*_ALL_REG reservations,
522 * allow commands from registered nexuses.
525 pr_debug("Allowing implicit CDB: 0x%02x for %s"
526 " reservation\n", cdb[0],
527 core_scsi3_pr_dump_type(pr_reg_type));
531 } else if (we && registered_nexus) {
533 * Reads are allowed for Write Exclusive locks
534 * from all registrants.
536 if (cmd->data_direction == DMA_FROM_DEVICE) {
537 pr_debug("Allowing READ CDB: 0x%02x for %s"
538 " reservation\n", cdb[0],
539 core_scsi3_pr_dump_type(pr_reg_type));
544 pr_debug("%s Conflict for %sregistered nexus %s CDB: 0x%2x"
545 " for %s reservation\n", transport_dump_cmd_direction(cmd),
546 (registered_nexus) ? "" : "un",
547 se_sess->se_node_acl->initiatorname, cdb[0],
548 core_scsi3_pr_dump_type(pr_reg_type));
550 return 1; /* Conflict by default */
553 static sense_reason_t
554 target_scsi3_pr_reservation_check(struct se_cmd *cmd)
556 struct se_device *dev = cmd->se_dev;
557 struct se_session *sess = cmd->se_sess;
560 if (!dev->dev_pr_res_holder)
563 pr_reg_type = dev->dev_pr_res_holder->pr_res_type;
564 cmd->pr_res_key = dev->dev_pr_res_holder->pr_res_key;
565 if (dev->dev_pr_res_holder->pr_reg_nacl != sess->se_node_acl)
566 goto check_nonholder;
568 if (dev->dev_pr_res_holder->isid_present_at_reg) {
569 if (dev->dev_pr_res_holder->pr_reg_bin_isid !=
570 sess->sess_bin_isid) {
571 pr_reg_type |= 0x80000000;
572 goto check_nonholder;
579 if (core_scsi3_pr_seq_non_holder(cmd, pr_reg_type))
580 return TCM_RESERVATION_CONFLICT;
584 static u32 core_scsi3_pr_generation(struct se_device *dev)
589 * PRGeneration field shall contain the value of a 32-bit wrapping
590 * counter mainted by the device server.
592 * Note that this is done regardless of Active Persist across
593 * Target PowerLoss (APTPL)
595 * See spc4r17 section 6.3.12 READ_KEYS service action
597 spin_lock(&dev->dev_reservation_lock);
598 prg = dev->t10_pr.pr_generation++;
599 spin_unlock(&dev->dev_reservation_lock);
604 static struct t10_pr_registration *__core_scsi3_do_alloc_registration(
605 struct se_device *dev,
606 struct se_node_acl *nacl,
607 struct se_dev_entry *deve,
613 struct t10_pr_registration *pr_reg;
615 pr_reg = kmem_cache_zalloc(t10_pr_reg_cache, GFP_ATOMIC);
617 pr_err("Unable to allocate struct t10_pr_registration\n");
621 INIT_LIST_HEAD(&pr_reg->pr_reg_list);
622 INIT_LIST_HEAD(&pr_reg->pr_reg_abort_list);
623 INIT_LIST_HEAD(&pr_reg->pr_reg_aptpl_list);
624 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_list);
625 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_mem_list);
626 atomic_set(&pr_reg->pr_res_holders, 0);
627 pr_reg->pr_reg_nacl = nacl;
628 pr_reg->pr_reg_deve = deve;
629 pr_reg->pr_res_mapped_lun = deve->mapped_lun;
630 pr_reg->pr_aptpl_target_lun = deve->se_lun->unpacked_lun;
631 pr_reg->pr_res_key = sa_res_key;
632 pr_reg->pr_reg_all_tg_pt = all_tg_pt;
633 pr_reg->pr_reg_aptpl = aptpl;
634 pr_reg->pr_reg_tg_pt_lun = deve->se_lun;
636 * If an ISID value for this SCSI Initiator Port exists,
637 * save it to the registration now.
640 pr_reg->pr_reg_bin_isid = get_unaligned_be64(isid);
641 snprintf(pr_reg->pr_reg_isid, PR_REG_ISID_LEN, "%s", isid);
642 pr_reg->isid_present_at_reg = 1;
648 static int core_scsi3_lunacl_depend_item(struct se_dev_entry *);
649 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry *);
652 * Function used for handling PR registrations for ALL_TG_PT=1 and ALL_TG_PT=0
655 static struct t10_pr_registration *__core_scsi3_alloc_registration(
656 struct se_device *dev,
657 struct se_node_acl *nacl,
658 struct se_dev_entry *deve,
664 struct se_dev_entry *deve_tmp;
665 struct se_node_acl *nacl_tmp;
666 struct se_port *port, *port_tmp;
667 struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
668 struct t10_pr_registration *pr_reg, *pr_reg_atp, *pr_reg_tmp, *pr_reg_tmp_safe;
671 * Create a registration for the I_T Nexus upon which the
672 * PROUT REGISTER was received.
674 pr_reg = __core_scsi3_do_alloc_registration(dev, nacl, deve, isid,
675 sa_res_key, all_tg_pt, aptpl);
679 * Return pointer to pr_reg for ALL_TG_PT=0
684 * Create list of matching SCSI Initiator Port registrations
687 spin_lock(&dev->se_port_lock);
688 list_for_each_entry_safe(port, port_tmp, &dev->dev_sep_list, sep_list) {
689 atomic_inc_mb(&port->sep_tg_pt_ref_cnt);
690 spin_unlock(&dev->se_port_lock);
692 spin_lock_bh(&port->sep_alua_lock);
693 list_for_each_entry(deve_tmp, &port->sep_alua_list,
696 * This pointer will be NULL for demo mode MappedLUNs
697 * that have not been make explicit via a ConfigFS
698 * MappedLUN group for the SCSI Initiator Node ACL.
700 if (!deve_tmp->se_lun_acl)
703 nacl_tmp = deve_tmp->se_lun_acl->se_lun_nacl;
705 * Skip the matching struct se_node_acl that is allocated
708 if (nacl == nacl_tmp)
711 * Only perform PR registrations for target ports on
712 * the same fabric module as the REGISTER w/ ALL_TG_PT=1
715 if (tfo != nacl_tmp->se_tpg->se_tpg_tfo)
718 * Look for a matching Initiator Node ACL in ASCII format
720 if (strcmp(nacl->initiatorname, nacl_tmp->initiatorname))
723 atomic_inc_mb(&deve_tmp->pr_ref_count);
724 spin_unlock_bh(&port->sep_alua_lock);
726 * Grab a configfs group dependency that is released
727 * for the exception path at label out: below, or upon
728 * completion of adding ALL_TG_PT=1 registrations in
729 * __core_scsi3_add_registration()
731 ret = core_scsi3_lunacl_depend_item(deve_tmp);
733 pr_err("core_scsi3_lunacl_depend"
735 atomic_dec_mb(&port->sep_tg_pt_ref_cnt);
736 atomic_dec_mb(&deve_tmp->pr_ref_count);
740 * Located a matching SCSI Initiator Port on a different
741 * port, allocate the pr_reg_atp and attach it to the
742 * pr_reg->pr_reg_atp_list that will be processed once
743 * the original *pr_reg is processed in
744 * __core_scsi3_add_registration()
746 pr_reg_atp = __core_scsi3_do_alloc_registration(dev,
747 nacl_tmp, deve_tmp, NULL,
748 sa_res_key, all_tg_pt, aptpl);
750 atomic_dec_mb(&port->sep_tg_pt_ref_cnt);
751 atomic_dec_mb(&deve_tmp->pr_ref_count);
752 core_scsi3_lunacl_undepend_item(deve_tmp);
756 list_add_tail(&pr_reg_atp->pr_reg_atp_mem_list,
757 &pr_reg->pr_reg_atp_list);
758 spin_lock_bh(&port->sep_alua_lock);
760 spin_unlock_bh(&port->sep_alua_lock);
762 spin_lock(&dev->se_port_lock);
763 atomic_dec_mb(&port->sep_tg_pt_ref_cnt);
765 spin_unlock(&dev->se_port_lock);
769 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
770 &pr_reg->pr_reg_atp_list, pr_reg_atp_mem_list) {
771 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
772 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
773 kmem_cache_free(t10_pr_reg_cache, pr_reg_tmp);
775 kmem_cache_free(t10_pr_reg_cache, pr_reg);
779 int core_scsi3_alloc_aptpl_registration(
780 struct t10_reservation *pr_tmpl,
782 unsigned char *i_port,
785 unsigned char *t_port,
792 struct t10_pr_registration *pr_reg;
794 if (!i_port || !t_port || !sa_res_key) {
795 pr_err("Illegal parameters for APTPL registration\n");
799 pr_reg = kmem_cache_zalloc(t10_pr_reg_cache, GFP_KERNEL);
801 pr_err("Unable to allocate struct t10_pr_registration\n");
805 INIT_LIST_HEAD(&pr_reg->pr_reg_list);
806 INIT_LIST_HEAD(&pr_reg->pr_reg_abort_list);
807 INIT_LIST_HEAD(&pr_reg->pr_reg_aptpl_list);
808 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_list);
809 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_mem_list);
810 atomic_set(&pr_reg->pr_res_holders, 0);
811 pr_reg->pr_reg_nacl = NULL;
812 pr_reg->pr_reg_deve = NULL;
813 pr_reg->pr_res_mapped_lun = mapped_lun;
814 pr_reg->pr_aptpl_target_lun = target_lun;
815 pr_reg->pr_res_key = sa_res_key;
816 pr_reg->pr_reg_all_tg_pt = all_tg_pt;
817 pr_reg->pr_reg_aptpl = 1;
818 pr_reg->pr_reg_tg_pt_lun = NULL;
819 pr_reg->pr_res_scope = 0; /* Always LUN_SCOPE */
820 pr_reg->pr_res_type = type;
822 * If an ISID value had been saved in APTPL metadata for this
823 * SCSI Initiator Port, restore it now.
826 pr_reg->pr_reg_bin_isid = get_unaligned_be64(isid);
827 snprintf(pr_reg->pr_reg_isid, PR_REG_ISID_LEN, "%s", isid);
828 pr_reg->isid_present_at_reg = 1;
831 * Copy the i_port and t_port information from caller.
833 snprintf(pr_reg->pr_iport, PR_APTPL_MAX_IPORT_LEN, "%s", i_port);
834 snprintf(pr_reg->pr_tport, PR_APTPL_MAX_TPORT_LEN, "%s", t_port);
835 pr_reg->pr_reg_tpgt = tpgt;
837 * Set pr_res_holder from caller, the pr_reg who is the reservation
838 * holder will get it's pointer set in core_scsi3_aptpl_reserve() once
839 * the Initiator Node LUN ACL from the fabric module is created for
842 pr_reg->pr_res_holder = res_holder;
844 list_add_tail(&pr_reg->pr_reg_aptpl_list, &pr_tmpl->aptpl_reg_list);
845 pr_debug("SPC-3 PR APTPL Successfully added registration%s from"
846 " metadata\n", (res_holder) ? "+reservation" : "");
850 static void core_scsi3_aptpl_reserve(
851 struct se_device *dev,
852 struct se_portal_group *tpg,
853 struct se_node_acl *node_acl,
854 struct t10_pr_registration *pr_reg)
856 char i_buf[PR_REG_ISID_ID_LEN];
858 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
859 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
861 spin_lock(&dev->dev_reservation_lock);
862 dev->dev_pr_res_holder = pr_reg;
863 spin_unlock(&dev->dev_reservation_lock);
865 pr_debug("SPC-3 PR [%s] Service Action: APTPL RESERVE created"
866 " new reservation holder TYPE: %s ALL_TG_PT: %d\n",
867 tpg->se_tpg_tfo->get_fabric_name(),
868 core_scsi3_pr_dump_type(pr_reg->pr_res_type),
869 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
870 pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
871 tpg->se_tpg_tfo->get_fabric_name(), node_acl->initiatorname,
875 static void __core_scsi3_add_registration(struct se_device *, struct se_node_acl *,
876 struct t10_pr_registration *, enum register_type, int);
878 static int __core_scsi3_check_aptpl_registration(
879 struct se_device *dev,
880 struct se_portal_group *tpg,
883 struct se_node_acl *nacl,
884 struct se_dev_entry *deve)
886 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
887 struct t10_reservation *pr_tmpl = &dev->t10_pr;
888 unsigned char i_port[PR_APTPL_MAX_IPORT_LEN];
889 unsigned char t_port[PR_APTPL_MAX_TPORT_LEN];
892 memset(i_port, 0, PR_APTPL_MAX_IPORT_LEN);
893 memset(t_port, 0, PR_APTPL_MAX_TPORT_LEN);
895 * Copy Initiator Port information from struct se_node_acl
897 snprintf(i_port, PR_APTPL_MAX_IPORT_LEN, "%s", nacl->initiatorname);
898 snprintf(t_port, PR_APTPL_MAX_TPORT_LEN, "%s",
899 tpg->se_tpg_tfo->tpg_get_wwn(tpg));
900 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
902 * Look for the matching registrations+reservation from those
903 * created from APTPL metadata. Note that multiple registrations
904 * may exist for fabrics that use ISIDs in their SCSI Initiator Port
907 spin_lock(&pr_tmpl->aptpl_reg_lock);
908 list_for_each_entry_safe(pr_reg, pr_reg_tmp, &pr_tmpl->aptpl_reg_list,
911 if (!strcmp(pr_reg->pr_iport, i_port) &&
912 (pr_reg->pr_res_mapped_lun == deve->mapped_lun) &&
913 !(strcmp(pr_reg->pr_tport, t_port)) &&
914 (pr_reg->pr_reg_tpgt == tpgt) &&
915 (pr_reg->pr_aptpl_target_lun == target_lun)) {
917 pr_reg->pr_reg_nacl = nacl;
918 pr_reg->pr_reg_deve = deve;
919 pr_reg->pr_reg_tg_pt_lun = lun;
921 list_del(&pr_reg->pr_reg_aptpl_list);
922 spin_unlock(&pr_tmpl->aptpl_reg_lock);
924 * At this point all of the pointers in *pr_reg will
925 * be setup, so go ahead and add the registration.
928 __core_scsi3_add_registration(dev, nacl, pr_reg, 0, 0);
930 * If this registration is the reservation holder,
931 * make that happen now..
933 if (pr_reg->pr_res_holder)
934 core_scsi3_aptpl_reserve(dev, tpg,
937 * Reenable pr_aptpl_active to accept new metadata
938 * updates once the SCSI device is active again..
940 spin_lock(&pr_tmpl->aptpl_reg_lock);
941 pr_tmpl->pr_aptpl_active = 1;
944 spin_unlock(&pr_tmpl->aptpl_reg_lock);
949 int core_scsi3_check_aptpl_registration(
950 struct se_device *dev,
951 struct se_portal_group *tpg,
953 struct se_node_acl *nacl,
956 struct se_dev_entry *deve = nacl->device_list[mapped_lun];
958 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS)
961 return __core_scsi3_check_aptpl_registration(dev, tpg, lun,
962 lun->unpacked_lun, nacl, deve);
965 static void __core_scsi3_dump_registration(
966 struct target_core_fabric_ops *tfo,
967 struct se_device *dev,
968 struct se_node_acl *nacl,
969 struct t10_pr_registration *pr_reg,
970 enum register_type register_type)
972 struct se_portal_group *se_tpg = nacl->se_tpg;
973 char i_buf[PR_REG_ISID_ID_LEN];
975 memset(&i_buf[0], 0, PR_REG_ISID_ID_LEN);
976 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
978 pr_debug("SPC-3 PR [%s] Service Action: REGISTER%s Initiator"
979 " Node: %s%s\n", tfo->get_fabric_name(), (register_type == REGISTER_AND_MOVE) ?
980 "_AND_MOVE" : (register_type == REGISTER_AND_IGNORE_EXISTING_KEY) ?
981 "_AND_IGNORE_EXISTING_KEY" : "", nacl->initiatorname,
983 pr_debug("SPC-3 PR [%s] registration on Target Port: %s,0x%04x\n",
984 tfo->get_fabric_name(), tfo->tpg_get_wwn(se_tpg),
985 tfo->tpg_get_tag(se_tpg));
986 pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
987 " Port(s)\n", tfo->get_fabric_name(),
988 (pr_reg->pr_reg_all_tg_pt) ? "ALL" : "SINGLE",
989 dev->transport->name);
990 pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
991 " 0x%08x APTPL: %d\n", tfo->get_fabric_name(),
992 pr_reg->pr_res_key, pr_reg->pr_res_generation,
993 pr_reg->pr_reg_aptpl);
997 * this function can be called with struct se_device->dev_reservation_lock
998 * when register_move = 1
1000 static void __core_scsi3_add_registration(
1001 struct se_device *dev,
1002 struct se_node_acl *nacl,
1003 struct t10_pr_registration *pr_reg,
1004 enum register_type register_type,
1007 struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
1008 struct t10_pr_registration *pr_reg_tmp, *pr_reg_tmp_safe;
1009 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1012 * Increment PRgeneration counter for struct se_device upon a successful
1013 * REGISTER, see spc4r17 section 6.3.2 READ_KEYS service action
1015 * Also, when register_move = 1 for PROUT REGISTER_AND_MOVE service
1016 * action, the struct se_device->dev_reservation_lock will already be held,
1017 * so we do not call core_scsi3_pr_generation() which grabs the lock
1020 pr_reg->pr_res_generation = (register_move) ?
1021 dev->t10_pr.pr_generation++ :
1022 core_scsi3_pr_generation(dev);
1024 spin_lock(&pr_tmpl->registration_lock);
1025 list_add_tail(&pr_reg->pr_reg_list, &pr_tmpl->registration_list);
1026 pr_reg->pr_reg_deve->def_pr_registered = 1;
1028 __core_scsi3_dump_registration(tfo, dev, nacl, pr_reg, register_type);
1029 spin_unlock(&pr_tmpl->registration_lock);
1031 * Skip extra processing for ALL_TG_PT=0 or REGISTER_AND_MOVE.
1033 if (!pr_reg->pr_reg_all_tg_pt || register_move)
1036 * Walk pr_reg->pr_reg_atp_list and add registrations for ALL_TG_PT=1
1037 * allocated in __core_scsi3_alloc_registration()
1039 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
1040 &pr_reg->pr_reg_atp_list, pr_reg_atp_mem_list) {
1041 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
1043 pr_reg_tmp->pr_res_generation = core_scsi3_pr_generation(dev);
1045 spin_lock(&pr_tmpl->registration_lock);
1046 list_add_tail(&pr_reg_tmp->pr_reg_list,
1047 &pr_tmpl->registration_list);
1048 pr_reg_tmp->pr_reg_deve->def_pr_registered = 1;
1050 __core_scsi3_dump_registration(tfo, dev,
1051 pr_reg_tmp->pr_reg_nacl, pr_reg_tmp,
1053 spin_unlock(&pr_tmpl->registration_lock);
1055 * Drop configfs group dependency reference from
1056 * __core_scsi3_alloc_registration()
1058 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
1062 static int core_scsi3_alloc_registration(
1063 struct se_device *dev,
1064 struct se_node_acl *nacl,
1065 struct se_dev_entry *deve,
1066 unsigned char *isid,
1070 enum register_type register_type,
1073 struct t10_pr_registration *pr_reg;
1075 pr_reg = __core_scsi3_alloc_registration(dev, nacl, deve, isid,
1076 sa_res_key, all_tg_pt, aptpl);
1080 __core_scsi3_add_registration(dev, nacl, pr_reg,
1081 register_type, register_move);
1085 static struct t10_pr_registration *__core_scsi3_locate_pr_reg(
1086 struct se_device *dev,
1087 struct se_node_acl *nacl,
1088 unsigned char *isid)
1090 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1091 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
1092 struct se_portal_group *tpg;
1094 spin_lock(&pr_tmpl->registration_lock);
1095 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1096 &pr_tmpl->registration_list, pr_reg_list) {
1098 * First look for a matching struct se_node_acl
1100 if (pr_reg->pr_reg_nacl != nacl)
1103 tpg = pr_reg->pr_reg_nacl->se_tpg;
1105 * If this registration does NOT contain a fabric provided
1106 * ISID, then we have found a match.
1108 if (!pr_reg->isid_present_at_reg) {
1110 * Determine if this SCSI device server requires that
1111 * SCSI Intiatior TransportID w/ ISIDs is enforced
1112 * for fabric modules (iSCSI) requiring them.
1114 if (tpg->se_tpg_tfo->sess_get_initiator_sid != NULL) {
1115 if (dev->dev_attrib.enforce_pr_isids)
1118 atomic_inc_mb(&pr_reg->pr_res_holders);
1119 spin_unlock(&pr_tmpl->registration_lock);
1123 * If the *pr_reg contains a fabric defined ISID for multi-value
1124 * SCSI Initiator Port TransportIDs, then we expect a valid
1125 * matching ISID to be provided by the local SCSI Initiator Port.
1129 if (strcmp(isid, pr_reg->pr_reg_isid))
1132 atomic_inc_mb(&pr_reg->pr_res_holders);
1133 spin_unlock(&pr_tmpl->registration_lock);
1136 spin_unlock(&pr_tmpl->registration_lock);
1141 static struct t10_pr_registration *core_scsi3_locate_pr_reg(
1142 struct se_device *dev,
1143 struct se_node_acl *nacl,
1144 struct se_session *sess)
1146 struct se_portal_group *tpg = nacl->se_tpg;
1147 unsigned char buf[PR_REG_ISID_LEN], *isid_ptr = NULL;
1149 if (tpg->se_tpg_tfo->sess_get_initiator_sid != NULL) {
1150 memset(&buf[0], 0, PR_REG_ISID_LEN);
1151 tpg->se_tpg_tfo->sess_get_initiator_sid(sess, &buf[0],
1156 return __core_scsi3_locate_pr_reg(dev, nacl, isid_ptr);
1159 static void core_scsi3_put_pr_reg(struct t10_pr_registration *pr_reg)
1161 atomic_dec_mb(&pr_reg->pr_res_holders);
1164 static int core_scsi3_check_implicit_release(
1165 struct se_device *dev,
1166 struct t10_pr_registration *pr_reg)
1168 struct se_node_acl *nacl = pr_reg->pr_reg_nacl;
1169 struct t10_pr_registration *pr_res_holder;
1172 spin_lock(&dev->dev_reservation_lock);
1173 pr_res_holder = dev->dev_pr_res_holder;
1174 if (!pr_res_holder) {
1175 spin_unlock(&dev->dev_reservation_lock);
1178 if (pr_res_holder == pr_reg) {
1180 * Perform an implicit RELEASE if the registration that
1181 * is being released is holding the reservation.
1183 * From spc4r17, section 5.7.11.1:
1185 * e) If the I_T nexus is the persistent reservation holder
1186 * and the persistent reservation is not an all registrants
1187 * type, then a PERSISTENT RESERVE OUT command with REGISTER
1188 * service action or REGISTER AND IGNORE EXISTING KEY
1189 * service action with the SERVICE ACTION RESERVATION KEY
1190 * field set to zero (see 5.7.11.3).
1192 __core_scsi3_complete_pro_release(dev, nacl, pr_reg, 0, 1);
1195 * For 'All Registrants' reservation types, all existing
1196 * registrations are still processed as reservation holders
1197 * in core_scsi3_pr_seq_non_holder() after the initial
1198 * reservation holder is implicitly released here.
1200 } else if (pr_reg->pr_reg_all_tg_pt &&
1201 (!strcmp(pr_res_holder->pr_reg_nacl->initiatorname,
1202 pr_reg->pr_reg_nacl->initiatorname)) &&
1203 (pr_res_holder->pr_res_key == pr_reg->pr_res_key)) {
1204 pr_err("SPC-3 PR: Unable to perform ALL_TG_PT=1"
1205 " UNREGISTER while existing reservation with matching"
1206 " key 0x%016Lx is present from another SCSI Initiator"
1207 " Port\n", pr_reg->pr_res_key);
1210 spin_unlock(&dev->dev_reservation_lock);
1216 * Called with struct t10_reservation->registration_lock held.
1218 static void __core_scsi3_free_registration(
1219 struct se_device *dev,
1220 struct t10_pr_registration *pr_reg,
1221 struct list_head *preempt_and_abort_list,
1224 struct target_core_fabric_ops *tfo =
1225 pr_reg->pr_reg_nacl->se_tpg->se_tpg_tfo;
1226 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1227 char i_buf[PR_REG_ISID_ID_LEN];
1229 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
1230 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
1232 pr_reg->pr_reg_deve->def_pr_registered = 0;
1233 pr_reg->pr_reg_deve->pr_res_key = 0;
1234 if (!list_empty(&pr_reg->pr_reg_list))
1235 list_del(&pr_reg->pr_reg_list);
1237 * Caller accessing *pr_reg using core_scsi3_locate_pr_reg(),
1238 * so call core_scsi3_put_pr_reg() to decrement our reference.
1241 core_scsi3_put_pr_reg(pr_reg);
1243 * Wait until all reference from any other I_T nexuses for this
1244 * *pr_reg have been released. Because list_del() is called above,
1245 * the last core_scsi3_put_pr_reg(pr_reg) will release this reference
1246 * count back to zero, and we release *pr_reg.
1248 while (atomic_read(&pr_reg->pr_res_holders) != 0) {
1249 spin_unlock(&pr_tmpl->registration_lock);
1250 pr_debug("SPC-3 PR [%s] waiting for pr_res_holders\n",
1251 tfo->get_fabric_name());
1253 spin_lock(&pr_tmpl->registration_lock);
1256 pr_debug("SPC-3 PR [%s] Service Action: UNREGISTER Initiator"
1257 " Node: %s%s\n", tfo->get_fabric_name(),
1258 pr_reg->pr_reg_nacl->initiatorname,
1260 pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
1261 " Port(s)\n", tfo->get_fabric_name(),
1262 (pr_reg->pr_reg_all_tg_pt) ? "ALL" : "SINGLE",
1263 dev->transport->name);
1264 pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
1265 " 0x%08x\n", tfo->get_fabric_name(), pr_reg->pr_res_key,
1266 pr_reg->pr_res_generation);
1268 if (!preempt_and_abort_list) {
1269 pr_reg->pr_reg_deve = NULL;
1270 pr_reg->pr_reg_nacl = NULL;
1271 kmem_cache_free(t10_pr_reg_cache, pr_reg);
1275 * For PREEMPT_AND_ABORT, the list of *pr_reg in preempt_and_abort_list
1276 * are released once the ABORT_TASK_SET has completed..
1278 list_add_tail(&pr_reg->pr_reg_abort_list, preempt_and_abort_list);
1281 void core_scsi3_free_pr_reg_from_nacl(
1282 struct se_device *dev,
1283 struct se_node_acl *nacl)
1285 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1286 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_res_holder;
1287 bool free_reg = false;
1289 * If the passed se_node_acl matches the reservation holder,
1290 * release the reservation.
1292 spin_lock(&dev->dev_reservation_lock);
1293 pr_res_holder = dev->dev_pr_res_holder;
1294 if ((pr_res_holder != NULL) &&
1295 (pr_res_holder->pr_reg_nacl == nacl)) {
1296 __core_scsi3_complete_pro_release(dev, nacl, pr_res_holder, 0, 1);
1299 spin_unlock(&dev->dev_reservation_lock);
1301 * Release any registration associated with the struct se_node_acl.
1303 spin_lock(&pr_tmpl->registration_lock);
1304 if (pr_res_holder && free_reg)
1305 __core_scsi3_free_registration(dev, pr_res_holder, NULL, 0);
1307 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1308 &pr_tmpl->registration_list, pr_reg_list) {
1310 if (pr_reg->pr_reg_nacl != nacl)
1313 __core_scsi3_free_registration(dev, pr_reg, NULL, 0);
1315 spin_unlock(&pr_tmpl->registration_lock);
1318 void core_scsi3_free_all_registrations(
1319 struct se_device *dev)
1321 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1322 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_res_holder;
1324 spin_lock(&dev->dev_reservation_lock);
1325 pr_res_holder = dev->dev_pr_res_holder;
1326 if (pr_res_holder != NULL) {
1327 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
1328 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
1329 pr_res_holder, 0, 0);
1331 spin_unlock(&dev->dev_reservation_lock);
1333 spin_lock(&pr_tmpl->registration_lock);
1334 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1335 &pr_tmpl->registration_list, pr_reg_list) {
1337 __core_scsi3_free_registration(dev, pr_reg, NULL, 0);
1339 spin_unlock(&pr_tmpl->registration_lock);
1341 spin_lock(&pr_tmpl->aptpl_reg_lock);
1342 list_for_each_entry_safe(pr_reg, pr_reg_tmp, &pr_tmpl->aptpl_reg_list,
1343 pr_reg_aptpl_list) {
1344 list_del(&pr_reg->pr_reg_aptpl_list);
1345 kmem_cache_free(t10_pr_reg_cache, pr_reg);
1347 spin_unlock(&pr_tmpl->aptpl_reg_lock);
1350 static int core_scsi3_tpg_depend_item(struct se_portal_group *tpg)
1352 return configfs_depend_item(tpg->se_tpg_tfo->tf_subsys,
1353 &tpg->tpg_group.cg_item);
1356 static void core_scsi3_tpg_undepend_item(struct se_portal_group *tpg)
1358 configfs_undepend_item(tpg->se_tpg_tfo->tf_subsys,
1359 &tpg->tpg_group.cg_item);
1361 atomic_dec_mb(&tpg->tpg_pr_ref_count);
1364 static int core_scsi3_nodeacl_depend_item(struct se_node_acl *nacl)
1366 struct se_portal_group *tpg = nacl->se_tpg;
1368 if (nacl->dynamic_node_acl)
1371 return configfs_depend_item(tpg->se_tpg_tfo->tf_subsys,
1372 &nacl->acl_group.cg_item);
1375 static void core_scsi3_nodeacl_undepend_item(struct se_node_acl *nacl)
1377 struct se_portal_group *tpg = nacl->se_tpg;
1379 if (nacl->dynamic_node_acl) {
1380 atomic_dec_mb(&nacl->acl_pr_ref_count);
1384 configfs_undepend_item(tpg->se_tpg_tfo->tf_subsys,
1385 &nacl->acl_group.cg_item);
1387 atomic_dec_mb(&nacl->acl_pr_ref_count);
1390 static int core_scsi3_lunacl_depend_item(struct se_dev_entry *se_deve)
1392 struct se_lun_acl *lun_acl = se_deve->se_lun_acl;
1393 struct se_node_acl *nacl;
1394 struct se_portal_group *tpg;
1396 * For nacl->dynamic_node_acl=1
1401 nacl = lun_acl->se_lun_nacl;
1404 return configfs_depend_item(tpg->se_tpg_tfo->tf_subsys,
1405 &lun_acl->se_lun_group.cg_item);
1408 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry *se_deve)
1410 struct se_lun_acl *lun_acl = se_deve->se_lun_acl;
1411 struct se_node_acl *nacl;
1412 struct se_portal_group *tpg;
1414 * For nacl->dynamic_node_acl=1
1417 atomic_dec_mb(&se_deve->pr_ref_count);
1420 nacl = lun_acl->se_lun_nacl;
1423 configfs_undepend_item(tpg->se_tpg_tfo->tf_subsys,
1424 &lun_acl->se_lun_group.cg_item);
1426 atomic_dec_mb(&se_deve->pr_ref_count);
1429 static sense_reason_t
1430 core_scsi3_decode_spec_i_port(
1432 struct se_portal_group *tpg,
1433 unsigned char *l_isid,
1438 struct se_device *dev = cmd->se_dev;
1439 struct se_port *tmp_port;
1440 struct se_portal_group *dest_tpg = NULL, *tmp_tpg;
1441 struct se_session *se_sess = cmd->se_sess;
1442 struct se_node_acl *dest_node_acl = NULL;
1443 struct se_dev_entry *dest_se_deve = NULL, *local_se_deve;
1444 struct t10_pr_registration *dest_pr_reg, *local_pr_reg, *pr_reg_e;
1445 struct t10_pr_registration *pr_reg_tmp, *pr_reg_tmp_safe;
1446 LIST_HEAD(tid_dest_list);
1447 struct pr_transport_id_holder *tidh_new, *tidh, *tidh_tmp;
1448 struct target_core_fabric_ops *tmp_tf_ops;
1450 unsigned char *ptr, *i_str = NULL, proto_ident, tmp_proto_ident;
1451 char *iport_ptr = NULL, i_buf[PR_REG_ISID_ID_LEN];
1453 u32 tpdl, tid_len = 0;
1454 int dest_local_nexus;
1457 local_se_deve = se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
1459 * Allocate a struct pr_transport_id_holder and setup the
1460 * local_node_acl and local_se_deve pointers and add to
1461 * struct list_head tid_dest_list for add registration
1462 * processing in the loop of tid_dest_list below.
1464 tidh_new = kzalloc(sizeof(struct pr_transport_id_holder), GFP_KERNEL);
1466 pr_err("Unable to allocate tidh_new\n");
1467 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1469 INIT_LIST_HEAD(&tidh_new->dest_list);
1470 tidh_new->dest_tpg = tpg;
1471 tidh_new->dest_node_acl = se_sess->se_node_acl;
1472 tidh_new->dest_se_deve = local_se_deve;
1474 local_pr_reg = __core_scsi3_alloc_registration(cmd->se_dev,
1475 se_sess->se_node_acl, local_se_deve, l_isid,
1476 sa_res_key, all_tg_pt, aptpl);
1477 if (!local_pr_reg) {
1479 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1481 tidh_new->dest_pr_reg = local_pr_reg;
1483 * The local I_T nexus does not hold any configfs dependances,
1484 * so we set tid_h->dest_local_nexus=1 to prevent the
1485 * configfs_undepend_item() calls in the tid_dest_list loops below.
1487 tidh_new->dest_local_nexus = 1;
1488 list_add_tail(&tidh_new->dest_list, &tid_dest_list);
1490 if (cmd->data_length < 28) {
1491 pr_warn("SPC-PR: Received PR OUT parameter list"
1492 " length too small: %u\n", cmd->data_length);
1493 ret = TCM_INVALID_PARAMETER_LIST;
1497 buf = transport_kmap_data_sg(cmd);
1499 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1504 * For a PERSISTENT RESERVE OUT specify initiator ports payload,
1505 * first extract TransportID Parameter Data Length, and make sure
1506 * the value matches up to the SCSI expected data transfer length.
1508 tpdl = (buf[24] & 0xff) << 24;
1509 tpdl |= (buf[25] & 0xff) << 16;
1510 tpdl |= (buf[26] & 0xff) << 8;
1511 tpdl |= buf[27] & 0xff;
1513 if ((tpdl + 28) != cmd->data_length) {
1514 pr_err("SPC-3 PR: Illegal tpdl: %u + 28 byte header"
1515 " does not equal CDB data_length: %u\n", tpdl,
1517 ret = TCM_INVALID_PARAMETER_LIST;
1521 * Start processing the received transport IDs using the
1522 * receiving I_T Nexus portal's fabric dependent methods to
1523 * obtain the SCSI Initiator Port/Device Identifiers.
1528 proto_ident = (ptr[0] & 0x0f);
1531 spin_lock(&dev->se_port_lock);
1532 list_for_each_entry(tmp_port, &dev->dev_sep_list, sep_list) {
1533 tmp_tpg = tmp_port->sep_tpg;
1536 tmp_tf_ops = tmp_tpg->se_tpg_tfo;
1539 if (!tmp_tf_ops->get_fabric_proto_ident ||
1540 !tmp_tf_ops->tpg_parse_pr_out_transport_id)
1543 * Look for the matching proto_ident provided by
1544 * the received TransportID
1546 tmp_proto_ident = tmp_tf_ops->get_fabric_proto_ident(tmp_tpg);
1547 if (tmp_proto_ident != proto_ident)
1549 dest_rtpi = tmp_port->sep_rtpi;
1551 i_str = tmp_tf_ops->tpg_parse_pr_out_transport_id(
1552 tmp_tpg, (const char *)ptr, &tid_len,
1557 atomic_inc_mb(&tmp_tpg->tpg_pr_ref_count);
1558 spin_unlock(&dev->se_port_lock);
1560 if (core_scsi3_tpg_depend_item(tmp_tpg)) {
1561 pr_err(" core_scsi3_tpg_depend_item()"
1563 atomic_dec_mb(&tmp_tpg->tpg_pr_ref_count);
1564 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1568 * Locate the destination initiator ACL to be registered
1569 * from the decoded fabric module specific TransportID
1572 spin_lock_irq(&tmp_tpg->acl_node_lock);
1573 dest_node_acl = __core_tpg_get_initiator_node_acl(
1576 atomic_inc_mb(&dest_node_acl->acl_pr_ref_count);
1577 spin_unlock_irq(&tmp_tpg->acl_node_lock);
1579 if (!dest_node_acl) {
1580 core_scsi3_tpg_undepend_item(tmp_tpg);
1581 spin_lock(&dev->se_port_lock);
1585 if (core_scsi3_nodeacl_depend_item(dest_node_acl)) {
1586 pr_err("configfs_depend_item() failed"
1587 " for dest_node_acl->acl_group\n");
1588 atomic_dec_mb(&dest_node_acl->acl_pr_ref_count);
1589 core_scsi3_tpg_undepend_item(tmp_tpg);
1590 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1595 pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node:"
1596 " %s Port RTPI: %hu\n",
1597 dest_tpg->se_tpg_tfo->get_fabric_name(),
1598 dest_node_acl->initiatorname, dest_rtpi);
1600 spin_lock(&dev->se_port_lock);
1603 spin_unlock(&dev->se_port_lock);
1606 pr_err("SPC-3 PR SPEC_I_PT: Unable to locate"
1608 ret = TCM_INVALID_PARAMETER_LIST;
1612 pr_debug("SPC-3 PR SPEC_I_PT: Got %s data_length: %u tpdl: %u"
1613 " tid_len: %d for %s + %s\n",
1614 dest_tpg->se_tpg_tfo->get_fabric_name(), cmd->data_length,
1615 tpdl, tid_len, i_str, iport_ptr);
1617 if (tid_len > tpdl) {
1618 pr_err("SPC-3 PR SPEC_I_PT: Illegal tid_len:"
1619 " %u for Transport ID: %s\n", tid_len, ptr);
1620 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1621 core_scsi3_tpg_undepend_item(dest_tpg);
1622 ret = TCM_INVALID_PARAMETER_LIST;
1626 * Locate the desintation struct se_dev_entry pointer for matching
1627 * RELATIVE TARGET PORT IDENTIFIER on the receiving I_T Nexus
1630 dest_se_deve = core_get_se_deve_from_rtpi(dest_node_acl,
1632 if (!dest_se_deve) {
1633 pr_err("Unable to locate %s dest_se_deve"
1634 " from destination RTPI: %hu\n",
1635 dest_tpg->se_tpg_tfo->get_fabric_name(),
1638 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1639 core_scsi3_tpg_undepend_item(dest_tpg);
1640 ret = TCM_INVALID_PARAMETER_LIST;
1644 if (core_scsi3_lunacl_depend_item(dest_se_deve)) {
1645 pr_err("core_scsi3_lunacl_depend_item()"
1647 atomic_dec_mb(&dest_se_deve->pr_ref_count);
1648 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1649 core_scsi3_tpg_undepend_item(dest_tpg);
1650 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1654 pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node: %s"
1655 " dest_se_deve mapped_lun: %u\n",
1656 dest_tpg->se_tpg_tfo->get_fabric_name(),
1657 dest_node_acl->initiatorname, dest_se_deve->mapped_lun);
1660 * Skip any TransportIDs that already have a registration for
1663 pr_reg_e = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
1666 core_scsi3_put_pr_reg(pr_reg_e);
1667 core_scsi3_lunacl_undepend_item(dest_se_deve);
1668 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1669 core_scsi3_tpg_undepend_item(dest_tpg);
1676 * Allocate a struct pr_transport_id_holder and setup
1677 * the dest_node_acl and dest_se_deve pointers for the
1680 tidh_new = kzalloc(sizeof(struct pr_transport_id_holder),
1683 pr_err("Unable to allocate tidh_new\n");
1684 core_scsi3_lunacl_undepend_item(dest_se_deve);
1685 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1686 core_scsi3_tpg_undepend_item(dest_tpg);
1687 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1690 INIT_LIST_HEAD(&tidh_new->dest_list);
1691 tidh_new->dest_tpg = dest_tpg;
1692 tidh_new->dest_node_acl = dest_node_acl;
1693 tidh_new->dest_se_deve = dest_se_deve;
1696 * Allocate, but do NOT add the registration for the
1697 * TransportID referenced SCSI Initiator port. This
1698 * done because of the following from spc4r17 in section
1699 * 6.14.3 wrt SPEC_I_PT:
1701 * "If a registration fails for any initiator port (e.g., if th
1702 * logical unit does not have enough resources available to
1703 * hold the registration information), no registrations shall be
1704 * made, and the command shall be terminated with
1705 * CHECK CONDITION status."
1707 * That means we call __core_scsi3_alloc_registration() here,
1708 * and then call __core_scsi3_add_registration() in the
1709 * 2nd loop which will never fail.
1711 dest_pr_reg = __core_scsi3_alloc_registration(cmd->se_dev,
1712 dest_node_acl, dest_se_deve, iport_ptr,
1713 sa_res_key, all_tg_pt, aptpl);
1715 core_scsi3_lunacl_undepend_item(dest_se_deve);
1716 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1717 core_scsi3_tpg_undepend_item(dest_tpg);
1719 ret = TCM_INVALID_PARAMETER_LIST;
1722 tidh_new->dest_pr_reg = dest_pr_reg;
1723 list_add_tail(&tidh_new->dest_list, &tid_dest_list);
1731 transport_kunmap_data_sg(cmd);
1734 * Go ahead and create a registrations from tid_dest_list for the
1735 * SPEC_I_PT provided TransportID for the *tidh referenced dest_node_acl
1738 * The SA Reservation Key from the PROUT is set for the
1739 * registration, and ALL_TG_PT is also passed. ALL_TG_PT=1
1740 * means that the TransportID Initiator port will be
1741 * registered on all of the target ports in the SCSI target device
1742 * ALL_TG_PT=0 means the registration will only be for the
1743 * SCSI target port the PROUT REGISTER with SPEC_I_PT=1
1746 list_for_each_entry_safe(tidh, tidh_tmp, &tid_dest_list, dest_list) {
1747 dest_tpg = tidh->dest_tpg;
1748 dest_node_acl = tidh->dest_node_acl;
1749 dest_se_deve = tidh->dest_se_deve;
1750 dest_pr_reg = tidh->dest_pr_reg;
1751 dest_local_nexus = tidh->dest_local_nexus;
1753 list_del(&tidh->dest_list);
1756 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
1757 core_pr_dump_initiator_port(dest_pr_reg, i_buf, PR_REG_ISID_ID_LEN);
1759 __core_scsi3_add_registration(cmd->se_dev, dest_node_acl,
1762 pr_debug("SPC-3 PR [%s] SPEC_I_PT: Successfully"
1763 " registered Transport ID for Node: %s%s Mapped LUN:"
1764 " %u\n", dest_tpg->se_tpg_tfo->get_fabric_name(),
1765 dest_node_acl->initiatorname, i_buf, dest_se_deve->mapped_lun);
1767 if (dest_local_nexus)
1770 core_scsi3_lunacl_undepend_item(dest_se_deve);
1771 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1772 core_scsi3_tpg_undepend_item(dest_tpg);
1777 transport_kunmap_data_sg(cmd);
1780 * For the failure case, release everything from tid_dest_list
1781 * including *dest_pr_reg and the configfs dependances..
1783 list_for_each_entry_safe(tidh, tidh_tmp, &tid_dest_list, dest_list) {
1784 dest_tpg = tidh->dest_tpg;
1785 dest_node_acl = tidh->dest_node_acl;
1786 dest_se_deve = tidh->dest_se_deve;
1787 dest_pr_reg = tidh->dest_pr_reg;
1788 dest_local_nexus = tidh->dest_local_nexus;
1790 list_del(&tidh->dest_list);
1793 * Release any extra ALL_TG_PT=1 registrations for
1794 * the SPEC_I_PT=1 case.
1796 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
1797 &dest_pr_reg->pr_reg_atp_list,
1798 pr_reg_atp_mem_list) {
1799 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
1800 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
1801 kmem_cache_free(t10_pr_reg_cache, pr_reg_tmp);
1804 kmem_cache_free(t10_pr_reg_cache, dest_pr_reg);
1806 if (dest_local_nexus)
1809 core_scsi3_lunacl_undepend_item(dest_se_deve);
1810 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1811 core_scsi3_tpg_undepend_item(dest_tpg);
1816 static int core_scsi3_update_aptpl_buf(
1817 struct se_device *dev,
1819 u32 pr_aptpl_buf_len)
1822 struct se_portal_group *tpg;
1823 struct t10_pr_registration *pr_reg;
1824 unsigned char tmp[512], isid_buf[32];
1829 spin_lock(&dev->dev_reservation_lock);
1830 spin_lock(&dev->t10_pr.registration_lock);
1832 * Walk the registration list..
1834 list_for_each_entry(pr_reg, &dev->t10_pr.registration_list,
1839 tpg = pr_reg->pr_reg_nacl->se_tpg;
1840 lun = pr_reg->pr_reg_tg_pt_lun;
1842 * Write out any ISID value to APTPL metadata that was included
1843 * in the original registration.
1845 if (pr_reg->isid_present_at_reg)
1846 snprintf(isid_buf, 32, "initiator_sid=%s\n",
1847 pr_reg->pr_reg_isid);
1849 * Include special metadata if the pr_reg matches the
1850 * reservation holder.
1852 if (dev->dev_pr_res_holder == pr_reg) {
1853 snprintf(tmp, 512, "PR_REG_START: %d"
1854 "\ninitiator_fabric=%s\n"
1855 "initiator_node=%s\n%s"
1857 "res_holder=1\nres_type=%02x\n"
1858 "res_scope=%02x\nres_all_tg_pt=%d\n"
1859 "mapped_lun=%u\n", reg_count,
1860 tpg->se_tpg_tfo->get_fabric_name(),
1861 pr_reg->pr_reg_nacl->initiatorname, isid_buf,
1862 pr_reg->pr_res_key, pr_reg->pr_res_type,
1863 pr_reg->pr_res_scope, pr_reg->pr_reg_all_tg_pt,
1864 pr_reg->pr_res_mapped_lun);
1866 snprintf(tmp, 512, "PR_REG_START: %d\n"
1867 "initiator_fabric=%s\ninitiator_node=%s\n%s"
1868 "sa_res_key=%llu\nres_holder=0\n"
1869 "res_all_tg_pt=%d\nmapped_lun=%u\n",
1870 reg_count, tpg->se_tpg_tfo->get_fabric_name(),
1871 pr_reg->pr_reg_nacl->initiatorname, isid_buf,
1872 pr_reg->pr_res_key, pr_reg->pr_reg_all_tg_pt,
1873 pr_reg->pr_res_mapped_lun);
1876 if ((len + strlen(tmp) >= pr_aptpl_buf_len)) {
1877 pr_err("Unable to update renaming"
1878 " APTPL metadata\n");
1882 len += sprintf(buf+len, "%s", tmp);
1885 * Include information about the associated SCSI target port.
1887 snprintf(tmp, 512, "target_fabric=%s\ntarget_node=%s\n"
1888 "tpgt=%hu\nport_rtpi=%hu\ntarget_lun=%u\nPR_REG_END:"
1889 " %d\n", tpg->se_tpg_tfo->get_fabric_name(),
1890 tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1891 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1892 lun->lun_sep->sep_rtpi, lun->unpacked_lun, reg_count);
1894 if ((len + strlen(tmp) >= pr_aptpl_buf_len)) {
1895 pr_err("Unable to update renaming"
1896 " APTPL metadata\n");
1900 len += sprintf(buf+len, "%s", tmp);
1905 len += sprintf(buf+len, "No Registrations or Reservations");
1908 spin_unlock(&dev->t10_pr.registration_lock);
1909 spin_unlock(&dev->dev_reservation_lock);
1914 static int __core_scsi3_write_aptpl_to_file(
1915 struct se_device *dev,
1918 struct t10_wwn *wwn = &dev->t10_wwn;
1920 int flags = O_RDWR | O_CREAT | O_TRUNC;
1922 u32 pr_aptpl_buf_len;
1925 memset(path, 0, 512);
1927 if (strlen(&wwn->unit_serial[0]) >= 512) {
1928 pr_err("WWN value for struct se_device does not fit"
1929 " into path buffer\n");
1933 snprintf(path, 512, "/var/target/pr/aptpl_%s", &wwn->unit_serial[0]);
1934 file = filp_open(path, flags, 0600);
1936 pr_err("filp_open(%s) for APTPL metadata"
1938 return PTR_ERR(file);
1941 pr_aptpl_buf_len = (strlen(buf) + 1); /* Add extra for NULL */
1943 ret = kernel_write(file, buf, pr_aptpl_buf_len, 0);
1946 pr_debug("Error writing APTPL metadata file: %s\n", path);
1949 return (ret < 0) ? -EIO : 0;
1953 * Clear the APTPL metadata if APTPL has been disabled, otherwise
1954 * write out the updated metadata to struct file for this SCSI device.
1956 static sense_reason_t core_scsi3_update_and_write_aptpl(struct se_device *dev, bool aptpl)
1962 char *null_buf = "No Registrations or Reservations\n";
1964 rc = __core_scsi3_write_aptpl_to_file(dev, null_buf);
1965 dev->t10_pr.pr_aptpl_active = 0;
1966 pr_debug("SPC-3 PR: Set APTPL Bit Deactivated\n");
1969 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1974 buf = kzalloc(PR_APTPL_BUF_LEN, GFP_KERNEL);
1976 return TCM_OUT_OF_RESOURCES;
1978 rc = core_scsi3_update_aptpl_buf(dev, buf, PR_APTPL_BUF_LEN);
1981 return TCM_OUT_OF_RESOURCES;
1984 rc = __core_scsi3_write_aptpl_to_file(dev, buf);
1986 pr_err("SPC-3 PR: Could not update APTPL\n");
1988 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1990 dev->t10_pr.pr_aptpl_active = 1;
1992 pr_debug("SPC-3 PR: Set APTPL Bit Activated\n");
1996 static sense_reason_t
1997 core_scsi3_emulate_pro_register(struct se_cmd *cmd, u64 res_key, u64 sa_res_key,
1998 bool aptpl, bool all_tg_pt, bool spec_i_pt, enum register_type register_type)
2000 struct se_session *se_sess = cmd->se_sess;
2001 struct se_device *dev = cmd->se_dev;
2002 struct se_dev_entry *se_deve;
2003 struct se_lun *se_lun = cmd->se_lun;
2004 struct se_portal_group *se_tpg;
2005 struct t10_pr_registration *pr_reg, *pr_reg_p, *pr_reg_tmp;
2006 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2007 unsigned char isid_buf[PR_REG_ISID_LEN], *isid_ptr = NULL;
2008 sense_reason_t ret = TCM_NO_SENSE;
2009 int pr_holder = 0, type;
2011 if (!se_sess || !se_lun) {
2012 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2013 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2015 se_tpg = se_sess->se_tpg;
2016 se_deve = se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
2018 if (se_tpg->se_tpg_tfo->sess_get_initiator_sid) {
2019 memset(&isid_buf[0], 0, PR_REG_ISID_LEN);
2020 se_tpg->se_tpg_tfo->sess_get_initiator_sid(se_sess, &isid_buf[0],
2022 isid_ptr = &isid_buf[0];
2025 * Follow logic from spc4r17 Section 5.7.7, Register Behaviors Table 47
2027 pr_reg = core_scsi3_locate_pr_reg(dev, se_sess->se_node_acl, se_sess);
2030 pr_warn("SPC-3 PR: Reservation Key non-zero"
2031 " for SA REGISTER, returning CONFLICT\n");
2032 return TCM_RESERVATION_CONFLICT;
2035 * Do nothing but return GOOD status.
2042 * Perform the Service Action REGISTER on the Initiator
2043 * Port Endpoint that the PRO was received from on the
2044 * Logical Unit of the SCSI device server.
2046 if (core_scsi3_alloc_registration(cmd->se_dev,
2047 se_sess->se_node_acl, se_deve, isid_ptr,
2048 sa_res_key, all_tg_pt, aptpl,
2049 register_type, 0)) {
2050 pr_err("Unable to allocate"
2051 " struct t10_pr_registration\n");
2052 return TCM_INVALID_PARAMETER_LIST;
2056 * Register both the Initiator port that received
2057 * PROUT SA REGISTER + SPEC_I_PT=1 and extract SCSI
2058 * TransportID from Parameter list and loop through
2059 * fabric dependent parameter list while calling
2060 * logic from of core_scsi3_alloc_registration() for
2061 * each TransportID provided SCSI Initiator Port/Device
2063 ret = core_scsi3_decode_spec_i_port(cmd, se_tpg,
2064 isid_ptr, sa_res_key, all_tg_pt, aptpl);
2069 return core_scsi3_update_and_write_aptpl(dev, aptpl);
2072 /* ok, existing registration */
2074 if ((register_type == REGISTER) && (res_key != pr_reg->pr_res_key)) {
2075 pr_err("SPC-3 PR REGISTER: Received"
2076 " res_key: 0x%016Lx does not match"
2077 " existing SA REGISTER res_key:"
2078 " 0x%016Lx\n", res_key,
2079 pr_reg->pr_res_key);
2080 ret = TCM_RESERVATION_CONFLICT;
2085 pr_err("SPC-3 PR REGISTER: SPEC_I_PT"
2086 " set on a registered nexus\n");
2087 ret = TCM_INVALID_PARAMETER_LIST;
2092 * An existing ALL_TG_PT=1 registration being released
2093 * must also set ALL_TG_PT=1 in the incoming PROUT.
2095 if (pr_reg->pr_reg_all_tg_pt && !all_tg_pt) {
2096 pr_err("SPC-3 PR REGISTER: ALL_TG_PT=1"
2097 " registration exists, but ALL_TG_PT=1 bit not"
2098 " present in received PROUT\n");
2099 ret = TCM_INVALID_CDB_FIELD;
2104 * sa_res_key=1 Change Reservation Key for registered I_T Nexus.
2108 * Increment PRgeneration counter for struct se_device"
2109 * upon a successful REGISTER, see spc4r17 section 6.3.2
2110 * READ_KEYS service action.
2112 pr_reg->pr_res_generation = core_scsi3_pr_generation(cmd->se_dev);
2113 pr_reg->pr_res_key = sa_res_key;
2114 pr_debug("SPC-3 PR [%s] REGISTER%s: Changed Reservation"
2115 " Key for %s to: 0x%016Lx PRgeneration:"
2116 " 0x%08x\n", cmd->se_tfo->get_fabric_name(),
2117 (register_type == REGISTER_AND_IGNORE_EXISTING_KEY) ? "_AND_IGNORE_EXISTING_KEY" : "",
2118 pr_reg->pr_reg_nacl->initiatorname,
2119 pr_reg->pr_res_key, pr_reg->pr_res_generation);
2123 * sa_res_key=0 Unregister Reservation Key for registered I_T Nexus.
2125 type = pr_reg->pr_res_type;
2126 pr_holder = core_scsi3_check_implicit_release(cmd->se_dev,
2128 if (pr_holder < 0) {
2129 ret = TCM_RESERVATION_CONFLICT;
2133 spin_lock(&pr_tmpl->registration_lock);
2135 * Release all ALL_TG_PT=1 for the matching SCSI Initiator Port
2136 * and matching pr_res_key.
2138 if (pr_reg->pr_reg_all_tg_pt) {
2139 list_for_each_entry_safe(pr_reg_p, pr_reg_tmp,
2140 &pr_tmpl->registration_list,
2143 if (!pr_reg_p->pr_reg_all_tg_pt)
2145 if (pr_reg_p->pr_res_key != res_key)
2147 if (pr_reg == pr_reg_p)
2149 if (strcmp(pr_reg->pr_reg_nacl->initiatorname,
2150 pr_reg_p->pr_reg_nacl->initiatorname))
2153 __core_scsi3_free_registration(dev,
2159 * Release the calling I_T Nexus registration now..
2161 __core_scsi3_free_registration(cmd->se_dev, pr_reg, NULL, 1);
2165 * From spc4r17, section 5.7.11.3 Unregistering
2167 * If the persistent reservation is a registrants only
2168 * type, the device server shall establish a unit
2169 * attention condition for the initiator port associated
2170 * with every registered I_T nexus except for the I_T
2171 * nexus on which the PERSISTENT RESERVE OUT command was
2172 * received, with the additional sense code set to
2173 * RESERVATIONS RELEASED.
2176 (type == PR_TYPE_WRITE_EXCLUSIVE_REGONLY ||
2177 type == PR_TYPE_EXCLUSIVE_ACCESS_REGONLY)) {
2178 list_for_each_entry(pr_reg_p,
2179 &pr_tmpl->registration_list,
2182 core_scsi3_ua_allocate(
2183 pr_reg_p->pr_reg_nacl,
2184 pr_reg_p->pr_res_mapped_lun,
2186 ASCQ_2AH_RESERVATIONS_RELEASED);
2190 spin_unlock(&pr_tmpl->registration_lock);
2193 ret = core_scsi3_update_and_write_aptpl(dev, aptpl);
2197 core_scsi3_put_pr_reg(pr_reg);
2201 unsigned char *core_scsi3_pr_dump_type(int type)
2204 case PR_TYPE_WRITE_EXCLUSIVE:
2205 return "Write Exclusive Access";
2206 case PR_TYPE_EXCLUSIVE_ACCESS:
2207 return "Exclusive Access";
2208 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
2209 return "Write Exclusive Access, Registrants Only";
2210 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
2211 return "Exclusive Access, Registrants Only";
2212 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
2213 return "Write Exclusive Access, All Registrants";
2214 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
2215 return "Exclusive Access, All Registrants";
2220 return "Unknown SPC-3 PR Type";
2223 static sense_reason_t
2224 core_scsi3_pro_reserve(struct se_cmd *cmd, int type, int scope, u64 res_key)
2226 struct se_device *dev = cmd->se_dev;
2227 struct se_session *se_sess = cmd->se_sess;
2228 struct se_lun *se_lun = cmd->se_lun;
2229 struct t10_pr_registration *pr_reg, *pr_res_holder;
2230 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2231 char i_buf[PR_REG_ISID_ID_LEN];
2234 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2236 if (!se_sess || !se_lun) {
2237 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2238 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2241 * Locate the existing *pr_reg via struct se_node_acl pointers
2243 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
2246 pr_err("SPC-3 PR: Unable to locate"
2247 " PR_REGISTERED *pr_reg for RESERVE\n");
2248 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2251 * From spc4r17 Section 5.7.9: Reserving:
2253 * An application client creates a persistent reservation by issuing
2254 * a PERSISTENT RESERVE OUT command with RESERVE service action through
2255 * a registered I_T nexus with the following parameters:
2256 * a) RESERVATION KEY set to the value of the reservation key that is
2257 * registered with the logical unit for the I_T nexus; and
2259 if (res_key != pr_reg->pr_res_key) {
2260 pr_err("SPC-3 PR RESERVE: Received res_key: 0x%016Lx"
2261 " does not match existing SA REGISTER res_key:"
2262 " 0x%016Lx\n", res_key, pr_reg->pr_res_key);
2263 ret = TCM_RESERVATION_CONFLICT;
2264 goto out_put_pr_reg;
2267 * From spc4r17 Section 5.7.9: Reserving:
2270 * b) TYPE field and SCOPE field set to the persistent reservation
2273 * Only one persistent reservation is allowed at a time per logical unit
2274 * and that persistent reservation has a scope of LU_SCOPE.
2276 if (scope != PR_SCOPE_LU_SCOPE) {
2277 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope);
2278 ret = TCM_INVALID_PARAMETER_LIST;
2279 goto out_put_pr_reg;
2282 * See if we have an existing PR reservation holder pointer at
2283 * struct se_device->dev_pr_res_holder in the form struct t10_pr_registration
2286 spin_lock(&dev->dev_reservation_lock);
2287 pr_res_holder = dev->dev_pr_res_holder;
2288 if (pr_res_holder) {
2289 int pr_res_type = pr_res_holder->pr_res_type;
2291 * From spc4r17 Section 5.7.9: Reserving:
2293 * If the device server receives a PERSISTENT RESERVE OUT
2294 * command from an I_T nexus other than a persistent reservation
2295 * holder (see 5.7.10) that attempts to create a persistent
2296 * reservation when a persistent reservation already exists for
2297 * the logical unit, then the command shall be completed with
2298 * RESERVATION CONFLICT status.
2300 if ((pr_res_holder != pr_reg) &&
2301 (pr_res_type != PR_TYPE_WRITE_EXCLUSIVE_ALLREG) &&
2302 (pr_res_type != PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
2303 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2304 pr_err("SPC-3 PR: Attempted RESERVE from"
2305 " [%s]: %s while reservation already held by"
2306 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2307 cmd->se_tfo->get_fabric_name(),
2308 se_sess->se_node_acl->initiatorname,
2309 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2310 pr_res_holder->pr_reg_nacl->initiatorname);
2312 spin_unlock(&dev->dev_reservation_lock);
2313 ret = TCM_RESERVATION_CONFLICT;
2314 goto out_put_pr_reg;
2317 * From spc4r17 Section 5.7.9: Reserving:
2319 * If a persistent reservation holder attempts to modify the
2320 * type or scope of an existing persistent reservation, the
2321 * command shall be completed with RESERVATION CONFLICT status.
2323 if ((pr_res_holder->pr_res_type != type) ||
2324 (pr_res_holder->pr_res_scope != scope)) {
2325 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2326 pr_err("SPC-3 PR: Attempted RESERVE from"
2327 " [%s]: %s trying to change TYPE and/or SCOPE,"
2328 " while reservation already held by [%s]: %s,"
2329 " returning RESERVATION_CONFLICT\n",
2330 cmd->se_tfo->get_fabric_name(),
2331 se_sess->se_node_acl->initiatorname,
2332 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2333 pr_res_holder->pr_reg_nacl->initiatorname);
2335 spin_unlock(&dev->dev_reservation_lock);
2336 ret = TCM_RESERVATION_CONFLICT;
2337 goto out_put_pr_reg;
2340 * From spc4r17 Section 5.7.9: Reserving:
2342 * If the device server receives a PERSISTENT RESERVE OUT
2343 * command with RESERVE service action where the TYPE field and
2344 * the SCOPE field contain the same values as the existing type
2345 * and scope from a persistent reservation holder, it shall not
2346 * make any change to the existing persistent reservation and
2347 * shall completethe command with GOOD status.
2349 spin_unlock(&dev->dev_reservation_lock);
2351 goto out_put_pr_reg;
2354 * Otherwise, our *pr_reg becomes the PR reservation holder for said
2355 * TYPE/SCOPE. Also set the received scope and type in *pr_reg.
2357 pr_reg->pr_res_scope = scope;
2358 pr_reg->pr_res_type = type;
2359 pr_reg->pr_res_holder = 1;
2360 dev->dev_pr_res_holder = pr_reg;
2361 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2363 pr_debug("SPC-3 PR [%s] Service Action: RESERVE created new"
2364 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2365 cmd->se_tfo->get_fabric_name(), core_scsi3_pr_dump_type(type),
2366 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2367 pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
2368 cmd->se_tfo->get_fabric_name(),
2369 se_sess->se_node_acl->initiatorname,
2371 spin_unlock(&dev->dev_reservation_lock);
2373 if (pr_tmpl->pr_aptpl_active)
2374 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
2378 core_scsi3_put_pr_reg(pr_reg);
2382 static sense_reason_t
2383 core_scsi3_emulate_pro_reserve(struct se_cmd *cmd, int type, int scope,
2387 case PR_TYPE_WRITE_EXCLUSIVE:
2388 case PR_TYPE_EXCLUSIVE_ACCESS:
2389 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
2390 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
2391 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
2392 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
2393 return core_scsi3_pro_reserve(cmd, type, scope, res_key);
2395 pr_err("SPC-3 PR: Unknown Service Action RESERVE Type:"
2397 return TCM_INVALID_CDB_FIELD;
2402 * Called with struct se_device->dev_reservation_lock held.
2404 static void __core_scsi3_complete_pro_release(
2405 struct se_device *dev,
2406 struct se_node_acl *se_nacl,
2407 struct t10_pr_registration *pr_reg,
2411 struct target_core_fabric_ops *tfo = se_nacl->se_tpg->se_tpg_tfo;
2412 char i_buf[PR_REG_ISID_ID_LEN];
2413 int pr_res_type = 0, pr_res_scope = 0;
2415 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2416 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2418 * Go ahead and release the current PR reservation holder.
2419 * If an All Registrants reservation is currently active and
2420 * a unregister operation is requested, replace the current
2421 * dev_pr_res_holder with another active registration.
2423 if (dev->dev_pr_res_holder) {
2424 pr_res_type = dev->dev_pr_res_holder->pr_res_type;
2425 pr_res_scope = dev->dev_pr_res_holder->pr_res_scope;
2426 dev->dev_pr_res_holder->pr_res_type = 0;
2427 dev->dev_pr_res_holder->pr_res_scope = 0;
2428 dev->dev_pr_res_holder->pr_res_holder = 0;
2429 dev->dev_pr_res_holder = NULL;
2434 spin_lock(&dev->t10_pr.registration_lock);
2435 list_del_init(&pr_reg->pr_reg_list);
2437 * If the I_T nexus is a reservation holder, the persistent reservation
2438 * is of an all registrants type, and the I_T nexus is the last remaining
2439 * registered I_T nexus, then the device server shall also release the
2440 * persistent reservation.
2442 if (!list_empty(&dev->t10_pr.registration_list) &&
2443 ((pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2444 (pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))) {
2445 dev->dev_pr_res_holder =
2446 list_entry(dev->t10_pr.registration_list.next,
2447 struct t10_pr_registration, pr_reg_list);
2448 dev->dev_pr_res_holder->pr_res_type = pr_res_type;
2449 dev->dev_pr_res_holder->pr_res_scope = pr_res_scope;
2450 dev->dev_pr_res_holder->pr_res_holder = 1;
2452 spin_unlock(&dev->t10_pr.registration_lock);
2454 if (!dev->dev_pr_res_holder) {
2455 pr_debug("SPC-3 PR [%s] Service Action: %s RELEASE cleared"
2456 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2457 tfo->get_fabric_name(), (explicit) ? "explicit" :
2458 "implicit", core_scsi3_pr_dump_type(pr_res_type),
2459 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2461 pr_debug("SPC-3 PR [%s] RELEASE Node: %s%s\n",
2462 tfo->get_fabric_name(), se_nacl->initiatorname,
2465 * Clear TYPE and SCOPE for the next PROUT Service Action: RESERVE
2467 pr_reg->pr_res_holder = pr_reg->pr_res_type = pr_reg->pr_res_scope = 0;
2470 static sense_reason_t
2471 core_scsi3_emulate_pro_release(struct se_cmd *cmd, int type, int scope,
2474 struct se_device *dev = cmd->se_dev;
2475 struct se_session *se_sess = cmd->se_sess;
2476 struct se_lun *se_lun = cmd->se_lun;
2477 struct t10_pr_registration *pr_reg, *pr_reg_p, *pr_res_holder;
2478 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2480 sense_reason_t ret = 0;
2482 if (!se_sess || !se_lun) {
2483 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2484 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2487 * Locate the existing *pr_reg via struct se_node_acl pointers
2489 pr_reg = core_scsi3_locate_pr_reg(dev, se_sess->se_node_acl, se_sess);
2491 pr_err("SPC-3 PR: Unable to locate"
2492 " PR_REGISTERED *pr_reg for RELEASE\n");
2493 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2496 * From spc4r17 Section 5.7.11.2 Releasing:
2498 * If there is no persistent reservation or in response to a persistent
2499 * reservation release request from a registered I_T nexus that is not a
2500 * persistent reservation holder (see 5.7.10), the device server shall
2503 * a) Not release the persistent reservation, if any;
2504 * b) Not remove any registrations; and
2505 * c) Complete the command with GOOD status.
2507 spin_lock(&dev->dev_reservation_lock);
2508 pr_res_holder = dev->dev_pr_res_holder;
2509 if (!pr_res_holder) {
2511 * No persistent reservation, return GOOD status.
2513 spin_unlock(&dev->dev_reservation_lock);
2514 goto out_put_pr_reg;
2516 if ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2517 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))
2520 if ((all_reg == 0) && (pr_res_holder != pr_reg)) {
2522 * Non 'All Registrants' PR Type cases..
2523 * Release request from a registered I_T nexus that is not a
2524 * persistent reservation holder. return GOOD status.
2526 spin_unlock(&dev->dev_reservation_lock);
2527 goto out_put_pr_reg;
2531 * From spc4r17 Section 5.7.11.2 Releasing:
2533 * Only the persistent reservation holder (see 5.7.10) is allowed to
2534 * release a persistent reservation.
2536 * An application client releases the persistent reservation by issuing
2537 * a PERSISTENT RESERVE OUT command with RELEASE service action through
2538 * an I_T nexus that is a persistent reservation holder with the
2539 * following parameters:
2541 * a) RESERVATION KEY field set to the value of the reservation key
2542 * that is registered with the logical unit for the I_T nexus;
2544 if (res_key != pr_reg->pr_res_key) {
2545 pr_err("SPC-3 PR RELEASE: Received res_key: 0x%016Lx"
2546 " does not match existing SA REGISTER res_key:"
2547 " 0x%016Lx\n", res_key, pr_reg->pr_res_key);
2548 spin_unlock(&dev->dev_reservation_lock);
2549 ret = TCM_RESERVATION_CONFLICT;
2550 goto out_put_pr_reg;
2553 * From spc4r17 Section 5.7.11.2 Releasing and above:
2555 * b) TYPE field and SCOPE field set to match the persistent
2556 * reservation being released.
2558 if ((pr_res_holder->pr_res_type != type) ||
2559 (pr_res_holder->pr_res_scope != scope)) {
2560 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2561 pr_err("SPC-3 PR RELEASE: Attempted to release"
2562 " reservation from [%s]: %s with different TYPE "
2563 "and/or SCOPE while reservation already held by"
2564 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2565 cmd->se_tfo->get_fabric_name(),
2566 se_sess->se_node_acl->initiatorname,
2567 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2568 pr_res_holder->pr_reg_nacl->initiatorname);
2570 spin_unlock(&dev->dev_reservation_lock);
2571 ret = TCM_RESERVATION_CONFLICT;
2572 goto out_put_pr_reg;
2575 * In response to a persistent reservation release request from the
2576 * persistent reservation holder the device server shall perform a
2577 * release by doing the following as an uninterrupted series of actions:
2578 * a) Release the persistent reservation;
2579 * b) Not remove any registration(s);
2580 * c) If the released persistent reservation is a registrants only type
2581 * or all registrants type persistent reservation,
2582 * the device server shall establish a unit attention condition for
2583 * the initiator port associated with every regis-
2584 * tered I_T nexus other than I_T nexus on which the PERSISTENT
2585 * RESERVE OUT command with RELEASE service action was received,
2586 * with the additional sense code set to RESERVATIONS RELEASED; and
2587 * d) If the persistent reservation is of any other type, the device
2588 * server shall not establish a unit attention condition.
2590 __core_scsi3_complete_pro_release(dev, se_sess->se_node_acl,
2593 spin_unlock(&dev->dev_reservation_lock);
2595 if ((type != PR_TYPE_WRITE_EXCLUSIVE_REGONLY) &&
2596 (type != PR_TYPE_EXCLUSIVE_ACCESS_REGONLY) &&
2597 (type != PR_TYPE_WRITE_EXCLUSIVE_ALLREG) &&
2598 (type != PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
2600 * If no UNIT ATTENTION conditions will be established for
2601 * PR_TYPE_WRITE_EXCLUSIVE or PR_TYPE_EXCLUSIVE_ACCESS
2602 * go ahead and check for APTPL=1 update+write below
2607 spin_lock(&pr_tmpl->registration_lock);
2608 list_for_each_entry(pr_reg_p, &pr_tmpl->registration_list,
2611 * Do not establish a UNIT ATTENTION condition
2612 * for the calling I_T Nexus
2614 if (pr_reg_p == pr_reg)
2617 core_scsi3_ua_allocate(pr_reg_p->pr_reg_nacl,
2618 pr_reg_p->pr_res_mapped_lun,
2619 0x2A, ASCQ_2AH_RESERVATIONS_RELEASED);
2621 spin_unlock(&pr_tmpl->registration_lock);
2624 if (pr_tmpl->pr_aptpl_active)
2625 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
2628 core_scsi3_put_pr_reg(pr_reg);
2632 static sense_reason_t
2633 core_scsi3_emulate_pro_clear(struct se_cmd *cmd, u64 res_key)
2635 struct se_device *dev = cmd->se_dev;
2636 struct se_node_acl *pr_reg_nacl;
2637 struct se_session *se_sess = cmd->se_sess;
2638 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2639 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_reg_n, *pr_res_holder;
2640 u32 pr_res_mapped_lun = 0;
2641 int calling_it_nexus = 0;
2643 * Locate the existing *pr_reg via struct se_node_acl pointers
2645 pr_reg_n = core_scsi3_locate_pr_reg(cmd->se_dev,
2646 se_sess->se_node_acl, se_sess);
2648 pr_err("SPC-3 PR: Unable to locate"
2649 " PR_REGISTERED *pr_reg for CLEAR\n");
2650 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2653 * From spc4r17 section 5.7.11.6, Clearing:
2655 * Any application client may release the persistent reservation and
2656 * remove all registrations from a device server by issuing a
2657 * PERSISTENT RESERVE OUT command with CLEAR service action through a
2658 * registered I_T nexus with the following parameter:
2660 * a) RESERVATION KEY field set to the value of the reservation key
2661 * that is registered with the logical unit for the I_T nexus.
2663 if (res_key != pr_reg_n->pr_res_key) {
2664 pr_err("SPC-3 PR REGISTER: Received"
2665 " res_key: 0x%016Lx does not match"
2666 " existing SA REGISTER res_key:"
2667 " 0x%016Lx\n", res_key, pr_reg_n->pr_res_key);
2668 core_scsi3_put_pr_reg(pr_reg_n);
2669 return TCM_RESERVATION_CONFLICT;
2672 * a) Release the persistent reservation, if any;
2674 spin_lock(&dev->dev_reservation_lock);
2675 pr_res_holder = dev->dev_pr_res_holder;
2676 if (pr_res_holder) {
2677 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2678 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
2679 pr_res_holder, 0, 0);
2681 spin_unlock(&dev->dev_reservation_lock);
2683 * b) Remove all registration(s) (see spc4r17 5.7.7);
2685 spin_lock(&pr_tmpl->registration_lock);
2686 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2687 &pr_tmpl->registration_list, pr_reg_list) {
2689 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2690 pr_reg_nacl = pr_reg->pr_reg_nacl;
2691 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2692 __core_scsi3_free_registration(dev, pr_reg, NULL,
2695 * e) Establish a unit attention condition for the initiator
2696 * port associated with every registered I_T nexus other
2697 * than the I_T nexus on which the PERSISTENT RESERVE OUT
2698 * command with CLEAR service action was received, with the
2699 * additional sense code set to RESERVATIONS PREEMPTED.
2701 if (!calling_it_nexus)
2702 core_scsi3_ua_allocate(pr_reg_nacl, pr_res_mapped_lun,
2703 0x2A, ASCQ_2AH_RESERVATIONS_PREEMPTED);
2705 spin_unlock(&pr_tmpl->registration_lock);
2707 pr_debug("SPC-3 PR [%s] Service Action: CLEAR complete\n",
2708 cmd->se_tfo->get_fabric_name());
2710 core_scsi3_update_and_write_aptpl(cmd->se_dev, false);
2712 core_scsi3_pr_generation(dev);
2717 * Called with struct se_device->dev_reservation_lock held.
2719 static void __core_scsi3_complete_pro_preempt(
2720 struct se_device *dev,
2721 struct t10_pr_registration *pr_reg,
2722 struct list_head *preempt_and_abort_list,
2725 enum preempt_type preempt_type)
2727 struct se_node_acl *nacl = pr_reg->pr_reg_nacl;
2728 struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
2729 char i_buf[PR_REG_ISID_ID_LEN];
2731 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2732 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2734 * Do an implicit RELEASE of the existing reservation.
2736 if (dev->dev_pr_res_holder)
2737 __core_scsi3_complete_pro_release(dev, nacl,
2738 dev->dev_pr_res_holder, 0, 0);
2740 dev->dev_pr_res_holder = pr_reg;
2741 pr_reg->pr_res_holder = 1;
2742 pr_reg->pr_res_type = type;
2743 pr_reg->pr_res_scope = scope;
2745 pr_debug("SPC-3 PR [%s] Service Action: PREEMPT%s created new"
2746 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2747 tfo->get_fabric_name(), (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "",
2748 core_scsi3_pr_dump_type(type),
2749 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2750 pr_debug("SPC-3 PR [%s] PREEMPT%s from Node: %s%s\n",
2751 tfo->get_fabric_name(), (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "",
2752 nacl->initiatorname, i_buf);
2754 * For PREEMPT_AND_ABORT, add the preempting reservation's
2755 * struct t10_pr_registration to the list that will be compared
2756 * against received CDBs..
2758 if (preempt_and_abort_list)
2759 list_add_tail(&pr_reg->pr_reg_abort_list,
2760 preempt_and_abort_list);
2763 static void core_scsi3_release_preempt_and_abort(
2764 struct list_head *preempt_and_abort_list,
2765 struct t10_pr_registration *pr_reg_holder)
2767 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
2769 list_for_each_entry_safe(pr_reg, pr_reg_tmp, preempt_and_abort_list,
2770 pr_reg_abort_list) {
2772 list_del(&pr_reg->pr_reg_abort_list);
2773 if (pr_reg_holder == pr_reg)
2775 if (pr_reg->pr_res_holder) {
2776 pr_warn("pr_reg->pr_res_holder still set\n");
2780 pr_reg->pr_reg_deve = NULL;
2781 pr_reg->pr_reg_nacl = NULL;
2782 kmem_cache_free(t10_pr_reg_cache, pr_reg);
2786 static sense_reason_t
2787 core_scsi3_pro_preempt(struct se_cmd *cmd, int type, int scope, u64 res_key,
2788 u64 sa_res_key, enum preempt_type preempt_type)
2790 struct se_device *dev = cmd->se_dev;
2791 struct se_node_acl *pr_reg_nacl;
2792 struct se_session *se_sess = cmd->se_sess;
2793 LIST_HEAD(preempt_and_abort_list);
2794 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_reg_n, *pr_res_holder;
2795 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2796 u32 pr_res_mapped_lun = 0;
2797 int all_reg = 0, calling_it_nexus = 0;
2798 bool sa_res_key_unmatched = sa_res_key != 0;
2799 int prh_type = 0, prh_scope = 0;
2802 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2804 pr_reg_n = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
2807 pr_err("SPC-3 PR: Unable to locate"
2808 " PR_REGISTERED *pr_reg for PREEMPT%s\n",
2809 (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "");
2810 return TCM_RESERVATION_CONFLICT;
2812 if (pr_reg_n->pr_res_key != res_key) {
2813 core_scsi3_put_pr_reg(pr_reg_n);
2814 return TCM_RESERVATION_CONFLICT;
2816 if (scope != PR_SCOPE_LU_SCOPE) {
2817 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope);
2818 core_scsi3_put_pr_reg(pr_reg_n);
2819 return TCM_INVALID_PARAMETER_LIST;
2822 spin_lock(&dev->dev_reservation_lock);
2823 pr_res_holder = dev->dev_pr_res_holder;
2824 if (pr_res_holder &&
2825 ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2826 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)))
2829 if (!all_reg && !sa_res_key) {
2830 spin_unlock(&dev->dev_reservation_lock);
2831 core_scsi3_put_pr_reg(pr_reg_n);
2832 return TCM_INVALID_PARAMETER_LIST;
2835 * From spc4r17, section 5.7.11.4.4 Removing Registrations:
2837 * If the SERVICE ACTION RESERVATION KEY field does not identify a
2838 * persistent reservation holder or there is no persistent reservation
2839 * holder (i.e., there is no persistent reservation), then the device
2840 * server shall perform a preempt by doing the following in an
2841 * uninterrupted series of actions. (See below..)
2843 if (!pr_res_holder || (pr_res_holder->pr_res_key != sa_res_key)) {
2845 * No existing or SA Reservation Key matching reservations..
2847 * PROUT SA PREEMPT with All Registrant type reservations are
2848 * allowed to be processed without a matching SA Reservation Key
2850 spin_lock(&pr_tmpl->registration_lock);
2851 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2852 &pr_tmpl->registration_list, pr_reg_list) {
2854 * Removing of registrations in non all registrants
2855 * type reservations without a matching SA reservation
2858 * a) Remove the registrations for all I_T nexuses
2859 * specified by the SERVICE ACTION RESERVATION KEY
2861 * b) Ignore the contents of the SCOPE and TYPE fields;
2862 * c) Process tasks as defined in 5.7.1; and
2863 * d) Establish a unit attention condition for the
2864 * initiator port associated with every I_T nexus
2865 * that lost its registration other than the I_T
2866 * nexus on which the PERSISTENT RESERVE OUT command
2867 * was received, with the additional sense code set
2868 * to REGISTRATIONS PREEMPTED.
2871 if (pr_reg->pr_res_key != sa_res_key)
2873 sa_res_key_unmatched = false;
2875 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2876 pr_reg_nacl = pr_reg->pr_reg_nacl;
2877 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2878 __core_scsi3_free_registration(dev, pr_reg,
2879 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list :
2880 NULL, calling_it_nexus);
2883 * Case for any existing all registrants type
2884 * reservation, follow logic in spc4r17 section
2885 * 5.7.11.4 Preempting, Table 52 and Figure 7.
2887 * For a ZERO SA Reservation key, release
2888 * all other registrations and do an implicit
2889 * release of active persistent reservation.
2891 * For a non-ZERO SA Reservation key, only
2892 * release the matching reservation key from
2896 (pr_reg->pr_res_key != sa_res_key))
2898 sa_res_key_unmatched = false;
2900 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2901 if (calling_it_nexus)
2904 pr_reg_nacl = pr_reg->pr_reg_nacl;
2905 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2906 __core_scsi3_free_registration(dev, pr_reg,
2907 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list :
2910 if (!calling_it_nexus)
2911 core_scsi3_ua_allocate(pr_reg_nacl,
2912 pr_res_mapped_lun, 0x2A,
2913 ASCQ_2AH_REGISTRATIONS_PREEMPTED);
2915 spin_unlock(&pr_tmpl->registration_lock);
2917 * If a PERSISTENT RESERVE OUT with a PREEMPT service action or
2918 * a PREEMPT AND ABORT service action sets the SERVICE ACTION
2919 * RESERVATION KEY field to a value that does not match any
2920 * registered reservation key, then the device server shall
2921 * complete the command with RESERVATION CONFLICT status.
2923 if (sa_res_key_unmatched) {
2924 spin_unlock(&dev->dev_reservation_lock);
2925 core_scsi3_put_pr_reg(pr_reg_n);
2926 return TCM_RESERVATION_CONFLICT;
2929 * For an existing all registrants type reservation
2930 * with a zero SA rservation key, preempt the existing
2931 * reservation with the new PR type and scope.
2933 if (pr_res_holder && all_reg && !(sa_res_key)) {
2934 __core_scsi3_complete_pro_preempt(dev, pr_reg_n,
2935 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
2936 type, scope, preempt_type);
2938 if (preempt_type == PREEMPT_AND_ABORT)
2939 core_scsi3_release_preempt_and_abort(
2940 &preempt_and_abort_list, pr_reg_n);
2942 spin_unlock(&dev->dev_reservation_lock);
2944 if (pr_tmpl->pr_aptpl_active)
2945 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
2947 core_scsi3_put_pr_reg(pr_reg_n);
2948 core_scsi3_pr_generation(cmd->se_dev);
2952 * The PREEMPTing SA reservation key matches that of the
2953 * existing persistent reservation, first, we check if
2954 * we are preempting our own reservation.
2955 * From spc4r17, section 5.7.11.4.3 Preempting
2956 * persistent reservations and registration handling
2958 * If an all registrants persistent reservation is not
2959 * present, it is not an error for the persistent
2960 * reservation holder to preempt itself (i.e., a
2961 * PERSISTENT RESERVE OUT with a PREEMPT service action
2962 * or a PREEMPT AND ABORT service action with the
2963 * SERVICE ACTION RESERVATION KEY value equal to the
2964 * persistent reservation holder's reservation key that
2965 * is received from the persistent reservation holder).
2966 * In that case, the device server shall establish the
2967 * new persistent reservation and maintain the
2970 prh_type = pr_res_holder->pr_res_type;
2971 prh_scope = pr_res_holder->pr_res_scope;
2973 * If the SERVICE ACTION RESERVATION KEY field identifies a
2974 * persistent reservation holder (see 5.7.10), the device
2975 * server shall perform a preempt by doing the following as
2976 * an uninterrupted series of actions:
2978 * a) Release the persistent reservation for the holder
2979 * identified by the SERVICE ACTION RESERVATION KEY field;
2981 if (pr_reg_n != pr_res_holder)
2982 __core_scsi3_complete_pro_release(dev,
2983 pr_res_holder->pr_reg_nacl,
2984 dev->dev_pr_res_holder, 0, 0);
2986 * b) Remove the registrations for all I_T nexuses identified
2987 * by the SERVICE ACTION RESERVATION KEY field, except the
2988 * I_T nexus that is being used for the PERSISTENT RESERVE
2989 * OUT command. If an all registrants persistent reservation
2990 * is present and the SERVICE ACTION RESERVATION KEY field
2991 * is set to zero, then all registrations shall be removed
2992 * except for that of the I_T nexus that is being used for
2993 * the PERSISTENT RESERVE OUT command;
2995 spin_lock(&pr_tmpl->registration_lock);
2996 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2997 &pr_tmpl->registration_list, pr_reg_list) {
2999 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
3000 if (calling_it_nexus)
3003 if (pr_reg->pr_res_key != sa_res_key)
3006 pr_reg_nacl = pr_reg->pr_reg_nacl;
3007 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
3008 __core_scsi3_free_registration(dev, pr_reg,
3009 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
3012 * e) Establish a unit attention condition for the initiator
3013 * port associated with every I_T nexus that lost its
3014 * persistent reservation and/or registration, with the
3015 * additional sense code set to REGISTRATIONS PREEMPTED;
3017 core_scsi3_ua_allocate(pr_reg_nacl, pr_res_mapped_lun, 0x2A,
3018 ASCQ_2AH_REGISTRATIONS_PREEMPTED);
3020 spin_unlock(&pr_tmpl->registration_lock);
3022 * c) Establish a persistent reservation for the preempting
3023 * I_T nexus using the contents of the SCOPE and TYPE fields;
3025 __core_scsi3_complete_pro_preempt(dev, pr_reg_n,
3026 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
3027 type, scope, preempt_type);
3029 * d) Process tasks as defined in 5.7.1;
3031 * f) If the type or scope has changed, then for every I_T nexus
3032 * whose reservation key was not removed, except for the I_T
3033 * nexus on which the PERSISTENT RESERVE OUT command was
3034 * received, the device server shall establish a unit
3035 * attention condition for the initiator port associated with
3036 * that I_T nexus, with the additional sense code set to
3037 * RESERVATIONS RELEASED. If the type or scope have not
3038 * changed, then no unit attention condition(s) shall be
3039 * established for this reason.
3041 if ((prh_type != type) || (prh_scope != scope)) {
3042 spin_lock(&pr_tmpl->registration_lock);
3043 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3044 &pr_tmpl->registration_list, pr_reg_list) {
3046 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
3047 if (calling_it_nexus)
3050 core_scsi3_ua_allocate(pr_reg->pr_reg_nacl,
3051 pr_reg->pr_res_mapped_lun, 0x2A,
3052 ASCQ_2AH_RESERVATIONS_RELEASED);
3054 spin_unlock(&pr_tmpl->registration_lock);
3056 spin_unlock(&dev->dev_reservation_lock);
3058 * Call LUN_RESET logic upon list of struct t10_pr_registration,
3059 * All received CDBs for the matching existing reservation and
3060 * registrations undergo ABORT_TASK logic.
3062 * From there, core_scsi3_release_preempt_and_abort() will
3063 * release every registration in the list (which have already
3064 * been removed from the primary pr_reg list), except the
3065 * new persistent reservation holder, the calling Initiator Port.
3067 if (preempt_type == PREEMPT_AND_ABORT) {
3068 core_tmr_lun_reset(dev, NULL, &preempt_and_abort_list, cmd);
3069 core_scsi3_release_preempt_and_abort(&preempt_and_abort_list,
3073 if (pr_tmpl->pr_aptpl_active)
3074 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
3076 core_scsi3_put_pr_reg(pr_reg_n);
3077 core_scsi3_pr_generation(cmd->se_dev);
3081 static sense_reason_t
3082 core_scsi3_emulate_pro_preempt(struct se_cmd *cmd, int type, int scope,
3083 u64 res_key, u64 sa_res_key, enum preempt_type preempt_type)
3086 case PR_TYPE_WRITE_EXCLUSIVE:
3087 case PR_TYPE_EXCLUSIVE_ACCESS:
3088 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
3089 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
3090 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
3091 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
3092 return core_scsi3_pro_preempt(cmd, type, scope, res_key,
3093 sa_res_key, preempt_type);
3095 pr_err("SPC-3 PR: Unknown Service Action PREEMPT%s"
3096 " Type: 0x%02x\n", (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "", type);
3097 return TCM_INVALID_CDB_FIELD;
3102 static sense_reason_t
3103 core_scsi3_emulate_pro_register_and_move(struct se_cmd *cmd, u64 res_key,
3104 u64 sa_res_key, int aptpl, int unreg)
3106 struct se_session *se_sess = cmd->se_sess;
3107 struct se_device *dev = cmd->se_dev;
3108 struct se_dev_entry *dest_se_deve = NULL;
3109 struct se_lun *se_lun = cmd->se_lun;
3110 struct se_node_acl *pr_res_nacl, *pr_reg_nacl, *dest_node_acl = NULL;
3111 struct se_port *se_port;
3112 struct se_portal_group *se_tpg, *dest_se_tpg = NULL;
3113 struct target_core_fabric_ops *dest_tf_ops = NULL, *tf_ops;
3114 struct t10_pr_registration *pr_reg, *pr_res_holder, *dest_pr_reg;
3115 struct t10_reservation *pr_tmpl = &dev->t10_pr;
3117 unsigned char *initiator_str;
3118 char *iport_ptr = NULL, i_buf[PR_REG_ISID_ID_LEN];
3119 u32 tid_len, tmp_tid_len;
3120 int new_reg = 0, type, scope, matching_iname;
3122 unsigned short rtpi;
3123 unsigned char proto_ident;
3125 if (!se_sess || !se_lun) {
3126 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
3127 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3130 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
3131 se_tpg = se_sess->se_tpg;
3132 tf_ops = se_tpg->se_tpg_tfo;
3134 * Follow logic from spc4r17 Section 5.7.8, Table 50 --
3135 * Register behaviors for a REGISTER AND MOVE service action
3137 * Locate the existing *pr_reg via struct se_node_acl pointers
3139 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
3142 pr_err("SPC-3 PR: Unable to locate PR_REGISTERED"
3143 " *pr_reg for REGISTER_AND_MOVE\n");
3144 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3147 * The provided reservation key much match the existing reservation key
3148 * provided during this initiator's I_T nexus registration.
3150 if (res_key != pr_reg->pr_res_key) {
3151 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received"
3152 " res_key: 0x%016Lx does not match existing SA REGISTER"
3153 " res_key: 0x%016Lx\n", res_key, pr_reg->pr_res_key);
3154 ret = TCM_RESERVATION_CONFLICT;
3155 goto out_put_pr_reg;
3158 * The service active reservation key needs to be non zero
3161 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received zero"
3163 ret = TCM_INVALID_PARAMETER_LIST;
3164 goto out_put_pr_reg;
3168 * Determine the Relative Target Port Identifier where the reservation
3169 * will be moved to for the TransportID containing SCSI initiator WWN
3172 buf = transport_kmap_data_sg(cmd);
3174 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3175 goto out_put_pr_reg;
3178 rtpi = (buf[18] & 0xff) << 8;
3179 rtpi |= buf[19] & 0xff;
3180 tid_len = (buf[20] & 0xff) << 24;
3181 tid_len |= (buf[21] & 0xff) << 16;
3182 tid_len |= (buf[22] & 0xff) << 8;
3183 tid_len |= buf[23] & 0xff;
3184 transport_kunmap_data_sg(cmd);
3187 if ((tid_len + 24) != cmd->data_length) {
3188 pr_err("SPC-3 PR: Illegal tid_len: %u + 24 byte header"
3189 " does not equal CDB data_length: %u\n", tid_len,
3191 ret = TCM_INVALID_PARAMETER_LIST;
3192 goto out_put_pr_reg;
3195 spin_lock(&dev->se_port_lock);
3196 list_for_each_entry(se_port, &dev->dev_sep_list, sep_list) {
3197 if (se_port->sep_rtpi != rtpi)
3199 dest_se_tpg = se_port->sep_tpg;
3202 dest_tf_ops = dest_se_tpg->se_tpg_tfo;
3206 atomic_inc_mb(&dest_se_tpg->tpg_pr_ref_count);
3207 spin_unlock(&dev->se_port_lock);
3209 if (core_scsi3_tpg_depend_item(dest_se_tpg)) {
3210 pr_err("core_scsi3_tpg_depend_item() failed"
3211 " for dest_se_tpg\n");
3212 atomic_dec_mb(&dest_se_tpg->tpg_pr_ref_count);
3213 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3214 goto out_put_pr_reg;
3217 spin_lock(&dev->se_port_lock);
3220 spin_unlock(&dev->se_port_lock);
3222 if (!dest_se_tpg || !dest_tf_ops) {
3223 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3224 " fabric ops from Relative Target Port Identifier:"
3226 ret = TCM_INVALID_PARAMETER_LIST;
3227 goto out_put_pr_reg;
3230 buf = transport_kmap_data_sg(cmd);
3232 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3233 goto out_put_pr_reg;
3235 proto_ident = (buf[24] & 0x0f);
3237 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Extracted Protocol Identifier:"
3238 " 0x%02x\n", proto_ident);
3240 if (proto_ident != dest_tf_ops->get_fabric_proto_ident(dest_se_tpg)) {
3241 pr_err("SPC-3 PR REGISTER_AND_MOVE: Received"
3242 " proto_ident: 0x%02x does not match ident: 0x%02x"
3243 " from fabric: %s\n", proto_ident,
3244 dest_tf_ops->get_fabric_proto_ident(dest_se_tpg),
3245 dest_tf_ops->get_fabric_name());
3246 ret = TCM_INVALID_PARAMETER_LIST;
3249 if (dest_tf_ops->tpg_parse_pr_out_transport_id == NULL) {
3250 pr_err("SPC-3 PR REGISTER_AND_MOVE: Fabric does not"
3251 " containg a valid tpg_parse_pr_out_transport_id"
3252 " function pointer\n");
3253 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3256 initiator_str = dest_tf_ops->tpg_parse_pr_out_transport_id(dest_se_tpg,
3257 (const char *)&buf[24], &tmp_tid_len, &iport_ptr);
3258 if (!initiator_str) {
3259 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3260 " initiator_str from Transport ID\n");
3261 ret = TCM_INVALID_PARAMETER_LIST;
3265 transport_kunmap_data_sg(cmd);
3268 pr_debug("SPC-3 PR [%s] Extracted initiator %s identifier: %s"
3269 " %s\n", dest_tf_ops->get_fabric_name(), (iport_ptr != NULL) ?
3270 "port" : "device", initiator_str, (iport_ptr != NULL) ?
3273 * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3274 * action specifies a TransportID that is the same as the initiator port
3275 * of the I_T nexus for the command received, then the command shall
3276 * be terminated with CHECK CONDITION status, with the sense key set to
3277 * ILLEGAL REQUEST, and the additional sense code set to INVALID FIELD
3278 * IN PARAMETER LIST.
3280 pr_reg_nacl = pr_reg->pr_reg_nacl;
3281 matching_iname = (!strcmp(initiator_str,
3282 pr_reg_nacl->initiatorname)) ? 1 : 0;
3283 if (!matching_iname)
3284 goto after_iport_check;
3286 if (!iport_ptr || !pr_reg->isid_present_at_reg) {
3287 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s"
3288 " matches: %s on received I_T Nexus\n", initiator_str,
3289 pr_reg_nacl->initiatorname);
3290 ret = TCM_INVALID_PARAMETER_LIST;
3293 if (!strcmp(iport_ptr, pr_reg->pr_reg_isid)) {
3294 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s %s"
3295 " matches: %s %s on received I_T Nexus\n",
3296 initiator_str, iport_ptr, pr_reg_nacl->initiatorname,
3297 pr_reg->pr_reg_isid);
3298 ret = TCM_INVALID_PARAMETER_LIST;
3303 * Locate the destination struct se_node_acl from the received Transport ID
3305 spin_lock_irq(&dest_se_tpg->acl_node_lock);
3306 dest_node_acl = __core_tpg_get_initiator_node_acl(dest_se_tpg,
3309 atomic_inc_mb(&dest_node_acl->acl_pr_ref_count);
3310 spin_unlock_irq(&dest_se_tpg->acl_node_lock);
3312 if (!dest_node_acl) {
3313 pr_err("Unable to locate %s dest_node_acl for"
3314 " TransportID%s\n", dest_tf_ops->get_fabric_name(),
3316 ret = TCM_INVALID_PARAMETER_LIST;
3320 if (core_scsi3_nodeacl_depend_item(dest_node_acl)) {
3321 pr_err("core_scsi3_nodeacl_depend_item() for"
3322 " dest_node_acl\n");
3323 atomic_dec_mb(&dest_node_acl->acl_pr_ref_count);
3324 dest_node_acl = NULL;
3325 ret = TCM_INVALID_PARAMETER_LIST;
3329 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Found %s dest_node_acl:"
3330 " %s from TransportID\n", dest_tf_ops->get_fabric_name(),
3331 dest_node_acl->initiatorname);
3334 * Locate the struct se_dev_entry pointer for the matching RELATIVE TARGET
3337 dest_se_deve = core_get_se_deve_from_rtpi(dest_node_acl, rtpi);
3338 if (!dest_se_deve) {
3339 pr_err("Unable to locate %s dest_se_deve from RTPI:"
3340 " %hu\n", dest_tf_ops->get_fabric_name(), rtpi);
3341 ret = TCM_INVALID_PARAMETER_LIST;
3345 if (core_scsi3_lunacl_depend_item(dest_se_deve)) {
3346 pr_err("core_scsi3_lunacl_depend_item() failed\n");
3347 atomic_dec_mb(&dest_se_deve->pr_ref_count);
3348 dest_se_deve = NULL;
3349 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3353 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Located %s node %s LUN"
3354 " ACL for dest_se_deve->mapped_lun: %u\n",
3355 dest_tf_ops->get_fabric_name(), dest_node_acl->initiatorname,
3356 dest_se_deve->mapped_lun);
3359 * A persistent reservation needs to already existing in order to
3360 * successfully complete the REGISTER_AND_MOVE service action..
3362 spin_lock(&dev->dev_reservation_lock);
3363 pr_res_holder = dev->dev_pr_res_holder;
3364 if (!pr_res_holder) {
3365 pr_warn("SPC-3 PR REGISTER_AND_MOVE: No reservation"
3366 " currently held\n");
3367 spin_unlock(&dev->dev_reservation_lock);
3368 ret = TCM_INVALID_CDB_FIELD;
3372 * The received on I_T Nexus must be the reservation holder.
3374 * From spc4r17 section 5.7.8 Table 50 --
3375 * Register behaviors for a REGISTER AND MOVE service action
3377 if (pr_res_holder != pr_reg) {
3378 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Calling I_T"
3379 " Nexus is not reservation holder\n");
3380 spin_unlock(&dev->dev_reservation_lock);
3381 ret = TCM_RESERVATION_CONFLICT;
3385 * From spc4r17 section 5.7.8: registering and moving reservation
3387 * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3388 * action is received and the established persistent reservation is a
3389 * Write Exclusive - All Registrants type or Exclusive Access -
3390 * All Registrants type reservation, then the command shall be completed
3391 * with RESERVATION CONFLICT status.
3393 if ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
3394 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
3395 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Unable to move"
3396 " reservation for type: %s\n",
3397 core_scsi3_pr_dump_type(pr_res_holder->pr_res_type));
3398 spin_unlock(&dev->dev_reservation_lock);
3399 ret = TCM_RESERVATION_CONFLICT;
3402 pr_res_nacl = pr_res_holder->pr_reg_nacl;
3404 * b) Ignore the contents of the (received) SCOPE and TYPE fields;
3406 type = pr_res_holder->pr_res_type;
3407 scope = pr_res_holder->pr_res_type;
3409 * c) Associate the reservation key specified in the SERVICE ACTION
3410 * RESERVATION KEY field with the I_T nexus specified as the
3411 * destination of the register and move, where:
3412 * A) The I_T nexus is specified by the TransportID and the
3413 * RELATIVE TARGET PORT IDENTIFIER field (see 6.14.4); and
3414 * B) Regardless of the TransportID format used, the association for
3415 * the initiator port is based on either the initiator port name
3416 * (see 3.1.71) on SCSI transport protocols where port names are
3417 * required or the initiator port identifier (see 3.1.70) on SCSI
3418 * transport protocols where port names are not required;
3419 * d) Register the reservation key specified in the SERVICE ACTION
3420 * RESERVATION KEY field;
3421 * e) Retain the reservation key specified in the SERVICE ACTION
3422 * RESERVATION KEY field and associated information;
3424 * Also, It is not an error for a REGISTER AND MOVE service action to
3425 * register an I_T nexus that is already registered with the same
3426 * reservation key or a different reservation key.
3428 dest_pr_reg = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
3431 if (core_scsi3_alloc_registration(cmd->se_dev,
3432 dest_node_acl, dest_se_deve, iport_ptr,
3433 sa_res_key, 0, aptpl, 2, 1)) {
3434 spin_unlock(&dev->dev_reservation_lock);
3435 ret = TCM_INVALID_PARAMETER_LIST;
3438 dest_pr_reg = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
3443 * f) Release the persistent reservation for the persistent reservation
3444 * holder (i.e., the I_T nexus on which the
3446 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
3447 dev->dev_pr_res_holder, 0, 0);
3449 * g) Move the persistent reservation to the specified I_T nexus using
3450 * the same scope and type as the persistent reservation released in
3453 dev->dev_pr_res_holder = dest_pr_reg;
3454 dest_pr_reg->pr_res_holder = 1;
3455 dest_pr_reg->pr_res_type = type;
3456 pr_reg->pr_res_scope = scope;
3457 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
3459 * Increment PRGeneration for existing registrations..
3462 dest_pr_reg->pr_res_generation = pr_tmpl->pr_generation++;
3463 spin_unlock(&dev->dev_reservation_lock);
3465 pr_debug("SPC-3 PR [%s] Service Action: REGISTER_AND_MOVE"
3466 " created new reservation holder TYPE: %s on object RTPI:"
3467 " %hu PRGeneration: 0x%08x\n", dest_tf_ops->get_fabric_name(),
3468 core_scsi3_pr_dump_type(type), rtpi,
3469 dest_pr_reg->pr_res_generation);
3470 pr_debug("SPC-3 PR Successfully moved reservation from"
3471 " %s Fabric Node: %s%s -> %s Fabric Node: %s %s\n",
3472 tf_ops->get_fabric_name(), pr_reg_nacl->initiatorname,
3473 i_buf, dest_tf_ops->get_fabric_name(),
3474 dest_node_acl->initiatorname, (iport_ptr != NULL) ?
3477 * It is now safe to release configfs group dependencies for destination
3478 * of Transport ID Initiator Device/Port Identifier
3480 core_scsi3_lunacl_undepend_item(dest_se_deve);
3481 core_scsi3_nodeacl_undepend_item(dest_node_acl);
3482 core_scsi3_tpg_undepend_item(dest_se_tpg);
3484 * h) If the UNREG bit is set to one, unregister (see 5.7.11.3) the I_T
3485 * nexus on which PERSISTENT RESERVE OUT command was received.
3488 spin_lock(&pr_tmpl->registration_lock);
3489 __core_scsi3_free_registration(dev, pr_reg, NULL, 1);
3490 spin_unlock(&pr_tmpl->registration_lock);
3492 core_scsi3_put_pr_reg(pr_reg);
3494 core_scsi3_update_and_write_aptpl(cmd->se_dev, aptpl);
3496 transport_kunmap_data_sg(cmd);
3498 core_scsi3_put_pr_reg(dest_pr_reg);
3502 transport_kunmap_data_sg(cmd);
3504 core_scsi3_lunacl_undepend_item(dest_se_deve);
3506 core_scsi3_nodeacl_undepend_item(dest_node_acl);
3507 core_scsi3_tpg_undepend_item(dest_se_tpg);
3510 core_scsi3_put_pr_reg(pr_reg);
3514 static unsigned long long core_scsi3_extract_reservation_key(unsigned char *cdb)
3516 unsigned int __v1, __v2;
3518 __v1 = (cdb[0] << 24) | (cdb[1] << 16) | (cdb[2] << 8) | cdb[3];
3519 __v2 = (cdb[4] << 24) | (cdb[5] << 16) | (cdb[6] << 8) | cdb[7];
3521 return ((unsigned long long)__v2) | (unsigned long long)__v1 << 32;
3525 * See spc4r17 section 6.14 Table 170
3528 target_scsi3_emulate_pr_out(struct se_cmd *cmd)
3530 struct se_device *dev = cmd->se_dev;
3531 unsigned char *cdb = &cmd->t_task_cdb[0];
3533 u64 res_key, sa_res_key;
3534 int sa, scope, type, aptpl;
3535 int spec_i_pt = 0, all_tg_pt = 0, unreg = 0;
3539 * Following spc2r20 5.5.1 Reservations overview:
3541 * If a logical unit has been reserved by any RESERVE command and is
3542 * still reserved by any initiator, all PERSISTENT RESERVE IN and all
3543 * PERSISTENT RESERVE OUT commands shall conflict regardless of
3544 * initiator or service action and shall terminate with a RESERVATION
3547 if (cmd->se_dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS) {
3548 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
3549 " SPC-2 reservation is held, returning"
3550 " RESERVATION_CONFLICT\n");
3551 return TCM_RESERVATION_CONFLICT;
3555 * FIXME: A NULL struct se_session pointer means an this is not coming from
3556 * a $FABRIC_MOD's nexus, but from internal passthrough ops.
3559 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3561 if (cmd->data_length < 24) {
3562 pr_warn("SPC-PR: Received PR OUT parameter list"
3563 " length too small: %u\n", cmd->data_length);
3564 return TCM_INVALID_PARAMETER_LIST;
3568 * From the PERSISTENT_RESERVE_OUT command descriptor block (CDB)
3570 sa = (cdb[1] & 0x1f);
3571 scope = (cdb[2] & 0xf0);
3572 type = (cdb[2] & 0x0f);
3574 buf = transport_kmap_data_sg(cmd);
3576 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3579 * From PERSISTENT_RESERVE_OUT parameter list (payload)
3581 res_key = core_scsi3_extract_reservation_key(&buf[0]);
3582 sa_res_key = core_scsi3_extract_reservation_key(&buf[8]);
3584 * REGISTER_AND_MOVE uses a different SA parameter list containing
3585 * SCSI TransportIDs.
3587 if (sa != PRO_REGISTER_AND_MOVE) {
3588 spec_i_pt = (buf[20] & 0x08);
3589 all_tg_pt = (buf[20] & 0x04);
3590 aptpl = (buf[20] & 0x01);
3592 aptpl = (buf[17] & 0x01);
3593 unreg = (buf[17] & 0x02);
3596 * If the backend device has been configured to force APTPL metadata
3597 * write-out, go ahead and propigate aptpl=1 down now.
3599 if (dev->dev_attrib.force_pr_aptpl)
3602 transport_kunmap_data_sg(cmd);
3606 * SPEC_I_PT=1 is only valid for Service action: REGISTER
3608 if (spec_i_pt && ((cdb[1] & 0x1f) != PRO_REGISTER))
3609 return TCM_INVALID_PARAMETER_LIST;
3612 * From spc4r17 section 6.14:
3614 * If the SPEC_I_PT bit is set to zero, the service action is not
3615 * REGISTER AND MOVE, and the parameter list length is not 24, then
3616 * the command shall be terminated with CHECK CONDITION status, with
3617 * the sense key set to ILLEGAL REQUEST, and the additional sense
3618 * code set to PARAMETER LIST LENGTH ERROR.
3620 if (!spec_i_pt && ((cdb[1] & 0x1f) != PRO_REGISTER_AND_MOVE) &&
3621 (cmd->data_length != 24)) {
3622 pr_warn("SPC-PR: Received PR OUT illegal parameter"
3623 " list length: %u\n", cmd->data_length);
3624 return TCM_INVALID_PARAMETER_LIST;
3628 * (core_scsi3_emulate_pro_* function parameters
3629 * are defined by spc4r17 Table 174:
3630 * PERSISTENT_RESERVE_OUT service actions and valid parameters.
3634 ret = core_scsi3_emulate_pro_register(cmd,
3635 res_key, sa_res_key, aptpl, all_tg_pt, spec_i_pt, REGISTER);
3638 ret = core_scsi3_emulate_pro_reserve(cmd, type, scope, res_key);
3641 ret = core_scsi3_emulate_pro_release(cmd, type, scope, res_key);
3644 ret = core_scsi3_emulate_pro_clear(cmd, res_key);
3647 ret = core_scsi3_emulate_pro_preempt(cmd, type, scope,
3648 res_key, sa_res_key, PREEMPT);
3650 case PRO_PREEMPT_AND_ABORT:
3651 ret = core_scsi3_emulate_pro_preempt(cmd, type, scope,
3652 res_key, sa_res_key, PREEMPT_AND_ABORT);
3654 case PRO_REGISTER_AND_IGNORE_EXISTING_KEY:
3655 ret = core_scsi3_emulate_pro_register(cmd,
3656 0, sa_res_key, aptpl, all_tg_pt, spec_i_pt, REGISTER_AND_IGNORE_EXISTING_KEY);
3658 case PRO_REGISTER_AND_MOVE:
3659 ret = core_scsi3_emulate_pro_register_and_move(cmd, res_key,
3660 sa_res_key, aptpl, unreg);
3663 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
3664 " action: 0x%02x\n", cdb[1] & 0x1f);
3665 return TCM_INVALID_CDB_FIELD;
3669 target_complete_cmd(cmd, GOOD);
3674 * PERSISTENT_RESERVE_IN Service Action READ_KEYS
3676 * See spc4r17 section 5.7.6.2 and section 6.13.2, Table 160
3678 static sense_reason_t
3679 core_scsi3_pri_read_keys(struct se_cmd *cmd)
3681 struct se_device *dev = cmd->se_dev;
3682 struct t10_pr_registration *pr_reg;
3684 u32 add_len = 0, off = 8;
3686 if (cmd->data_length < 8) {
3687 pr_err("PRIN SA READ_KEYS SCSI Data Length: %u"
3688 " too small\n", cmd->data_length);
3689 return TCM_INVALID_CDB_FIELD;
3692 buf = transport_kmap_data_sg(cmd);
3694 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3696 buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3697 buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3698 buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3699 buf[3] = (dev->t10_pr.pr_generation & 0xff);
3701 spin_lock(&dev->t10_pr.registration_lock);
3702 list_for_each_entry(pr_reg, &dev->t10_pr.registration_list,
3705 * Check for overflow of 8byte PRI READ_KEYS payload and
3706 * next reservation key list descriptor.
3708 if ((add_len + 8) > (cmd->data_length - 8))
3711 buf[off++] = ((pr_reg->pr_res_key >> 56) & 0xff);
3712 buf[off++] = ((pr_reg->pr_res_key >> 48) & 0xff);
3713 buf[off++] = ((pr_reg->pr_res_key >> 40) & 0xff);
3714 buf[off++] = ((pr_reg->pr_res_key >> 32) & 0xff);
3715 buf[off++] = ((pr_reg->pr_res_key >> 24) & 0xff);
3716 buf[off++] = ((pr_reg->pr_res_key >> 16) & 0xff);
3717 buf[off++] = ((pr_reg->pr_res_key >> 8) & 0xff);
3718 buf[off++] = (pr_reg->pr_res_key & 0xff);
3722 spin_unlock(&dev->t10_pr.registration_lock);
3724 buf[4] = ((add_len >> 24) & 0xff);
3725 buf[5] = ((add_len >> 16) & 0xff);
3726 buf[6] = ((add_len >> 8) & 0xff);
3727 buf[7] = (add_len & 0xff);
3729 transport_kunmap_data_sg(cmd);
3735 * PERSISTENT_RESERVE_IN Service Action READ_RESERVATION
3737 * See spc4r17 section 5.7.6.3 and section 6.13.3.2 Table 161 and 162
3739 static sense_reason_t
3740 core_scsi3_pri_read_reservation(struct se_cmd *cmd)
3742 struct se_device *dev = cmd->se_dev;
3743 struct t10_pr_registration *pr_reg;
3746 u32 add_len = 16; /* Hardcoded to 16 when a reservation is held. */
3748 if (cmd->data_length < 8) {
3749 pr_err("PRIN SA READ_RESERVATIONS SCSI Data Length: %u"
3750 " too small\n", cmd->data_length);
3751 return TCM_INVALID_CDB_FIELD;
3754 buf = transport_kmap_data_sg(cmd);
3756 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3758 buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3759 buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3760 buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3761 buf[3] = (dev->t10_pr.pr_generation & 0xff);
3763 spin_lock(&dev->dev_reservation_lock);
3764 pr_reg = dev->dev_pr_res_holder;
3767 * Set the hardcoded Additional Length
3769 buf[4] = ((add_len >> 24) & 0xff);
3770 buf[5] = ((add_len >> 16) & 0xff);
3771 buf[6] = ((add_len >> 8) & 0xff);
3772 buf[7] = (add_len & 0xff);
3774 if (cmd->data_length < 22)
3778 * Set the Reservation key.
3780 * From spc4r17, section 5.7.10:
3781 * A persistent reservation holder has its reservation key
3782 * returned in the parameter data from a PERSISTENT
3783 * RESERVE IN command with READ RESERVATION service action as
3785 * a) For a persistent reservation of the type Write Exclusive
3786 * - All Registrants or Exclusive Access  All Regitrants,
3787 * the reservation key shall be set to zero; or
3788 * b) For all other persistent reservation types, the
3789 * reservation key shall be set to the registered
3790 * reservation key for the I_T nexus that holds the
3791 * persistent reservation.
3793 if ((pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
3794 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))
3797 pr_res_key = pr_reg->pr_res_key;
3799 buf[8] = ((pr_res_key >> 56) & 0xff);
3800 buf[9] = ((pr_res_key >> 48) & 0xff);
3801 buf[10] = ((pr_res_key >> 40) & 0xff);
3802 buf[11] = ((pr_res_key >> 32) & 0xff);
3803 buf[12] = ((pr_res_key >> 24) & 0xff);
3804 buf[13] = ((pr_res_key >> 16) & 0xff);
3805 buf[14] = ((pr_res_key >> 8) & 0xff);
3806 buf[15] = (pr_res_key & 0xff);
3808 * Set the SCOPE and TYPE
3810 buf[21] = (pr_reg->pr_res_scope & 0xf0) |
3811 (pr_reg->pr_res_type & 0x0f);
3815 spin_unlock(&dev->dev_reservation_lock);
3816 transport_kunmap_data_sg(cmd);
3822 * PERSISTENT_RESERVE_IN Service Action REPORT_CAPABILITIES
3824 * See spc4r17 section 6.13.4 Table 165
3826 static sense_reason_t
3827 core_scsi3_pri_report_capabilities(struct se_cmd *cmd)
3829 struct se_device *dev = cmd->se_dev;
3830 struct t10_reservation *pr_tmpl = &dev->t10_pr;
3832 u16 add_len = 8; /* Hardcoded to 8. */
3834 if (cmd->data_length < 6) {
3835 pr_err("PRIN SA REPORT_CAPABILITIES SCSI Data Length:"
3836 " %u too small\n", cmd->data_length);
3837 return TCM_INVALID_CDB_FIELD;
3840 buf = transport_kmap_data_sg(cmd);
3842 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3844 buf[0] = ((add_len >> 8) & 0xff);
3845 buf[1] = (add_len & 0xff);
3846 buf[2] |= 0x10; /* CRH: Compatible Reservation Hanlding bit. */
3847 buf[2] |= 0x08; /* SIP_C: Specify Initiator Ports Capable bit */
3848 buf[2] |= 0x04; /* ATP_C: All Target Ports Capable bit */
3849 buf[2] |= 0x01; /* PTPL_C: Persistence across Target Power Loss bit */
3851 * We are filling in the PERSISTENT RESERVATION TYPE MASK below, so
3852 * set the TMV: Task Mask Valid bit.
3856 * Change ALLOW COMMANDs to 0x20 or 0x40 later from Table 166
3858 buf[3] |= 0x10; /* ALLOW COMMANDs field 001b */
3860 * PTPL_A: Persistence across Target Power Loss Active bit
3862 if (pr_tmpl->pr_aptpl_active)
3865 * Setup the PERSISTENT RESERVATION TYPE MASK from Table 167
3867 buf[4] |= 0x80; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3868 buf[4] |= 0x40; /* PR_TYPE_EXCLUSIVE_ACCESS_REGONLY */
3869 buf[4] |= 0x20; /* PR_TYPE_WRITE_EXCLUSIVE_REGONLY */
3870 buf[4] |= 0x08; /* PR_TYPE_EXCLUSIVE_ACCESS */
3871 buf[4] |= 0x02; /* PR_TYPE_WRITE_EXCLUSIVE */
3872 buf[5] |= 0x01; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3874 transport_kunmap_data_sg(cmd);
3880 * PERSISTENT_RESERVE_IN Service Action READ_FULL_STATUS
3882 * See spc4r17 section 6.13.5 Table 168 and 169
3884 static sense_reason_t
3885 core_scsi3_pri_read_full_status(struct se_cmd *cmd)
3887 struct se_device *dev = cmd->se_dev;
3888 struct se_node_acl *se_nacl;
3889 struct se_portal_group *se_tpg;
3890 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
3891 struct t10_reservation *pr_tmpl = &dev->t10_pr;
3893 u32 add_desc_len = 0, add_len = 0, desc_len, exp_desc_len;
3894 u32 off = 8; /* off into first Full Status descriptor */
3895 int format_code = 0, pr_res_type = 0, pr_res_scope = 0;
3896 bool all_reg = false;
3898 if (cmd->data_length < 8) {
3899 pr_err("PRIN SA READ_FULL_STATUS SCSI Data Length: %u"
3900 " too small\n", cmd->data_length);
3901 return TCM_INVALID_CDB_FIELD;
3904 buf = transport_kmap_data_sg(cmd);
3906 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3908 buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3909 buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3910 buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3911 buf[3] = (dev->t10_pr.pr_generation & 0xff);
3913 spin_lock(&dev->dev_reservation_lock);
3914 if (dev->dev_pr_res_holder) {
3915 struct t10_pr_registration *pr_holder = dev->dev_pr_res_holder;
3917 if (pr_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG ||
3918 pr_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG) {
3920 pr_res_type = pr_holder->pr_res_type;
3921 pr_res_scope = pr_holder->pr_res_scope;
3924 spin_unlock(&dev->dev_reservation_lock);
3926 spin_lock(&pr_tmpl->registration_lock);
3927 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3928 &pr_tmpl->registration_list, pr_reg_list) {
3930 se_nacl = pr_reg->pr_reg_nacl;
3931 se_tpg = pr_reg->pr_reg_nacl->se_tpg;
3934 atomic_inc_mb(&pr_reg->pr_res_holders);
3935 spin_unlock(&pr_tmpl->registration_lock);
3937 * Determine expected length of $FABRIC_MOD specific
3938 * TransportID full status descriptor..
3940 exp_desc_len = se_tpg->se_tpg_tfo->tpg_get_pr_transport_id_len(
3941 se_tpg, se_nacl, pr_reg, &format_code);
3943 if ((exp_desc_len + add_len) > cmd->data_length) {
3944 pr_warn("SPC-3 PRIN READ_FULL_STATUS ran"
3945 " out of buffer: %d\n", cmd->data_length);
3946 spin_lock(&pr_tmpl->registration_lock);
3947 atomic_dec_mb(&pr_reg->pr_res_holders);
3951 * Set RESERVATION KEY
3953 buf[off++] = ((pr_reg->pr_res_key >> 56) & 0xff);
3954 buf[off++] = ((pr_reg->pr_res_key >> 48) & 0xff);
3955 buf[off++] = ((pr_reg->pr_res_key >> 40) & 0xff);
3956 buf[off++] = ((pr_reg->pr_res_key >> 32) & 0xff);
3957 buf[off++] = ((pr_reg->pr_res_key >> 24) & 0xff);
3958 buf[off++] = ((pr_reg->pr_res_key >> 16) & 0xff);
3959 buf[off++] = ((pr_reg->pr_res_key >> 8) & 0xff);
3960 buf[off++] = (pr_reg->pr_res_key & 0xff);
3961 off += 4; /* Skip Over Reserved area */
3964 * Set ALL_TG_PT bit if PROUT SA REGISTER had this set.
3966 if (pr_reg->pr_reg_all_tg_pt)
3969 * The struct se_lun pointer will be present for the
3970 * reservation holder for PR_HOLDER bit.
3972 * Also, if this registration is the reservation
3973 * holder or there is an All Registrants reservation
3974 * active, fill in SCOPE and TYPE in the next byte.
3976 if (pr_reg->pr_res_holder) {
3978 buf[off++] = (pr_reg->pr_res_scope & 0xf0) |
3979 (pr_reg->pr_res_type & 0x0f);
3980 } else if (all_reg) {
3982 buf[off++] = (pr_res_scope & 0xf0) |
3983 (pr_res_type & 0x0f);
3988 off += 4; /* Skip over reserved area */
3990 * From spc4r17 6.3.15:
3992 * If the ALL_TG_PT bit set to zero, the RELATIVE TARGET PORT
3993 * IDENTIFIER field contains the relative port identifier (see
3994 * 3.1.120) of the target port that is part of the I_T nexus
3995 * described by this full status descriptor. If the ALL_TG_PT
3996 * bit is set to one, the contents of the RELATIVE TARGET PORT
3997 * IDENTIFIER field are not defined by this standard.
3999 if (!pr_reg->pr_reg_all_tg_pt) {
4000 struct se_port *port = pr_reg->pr_reg_tg_pt_lun->lun_sep;
4002 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
4003 buf[off++] = (port->sep_rtpi & 0xff);
4005 off += 2; /* Skip over RELATIVE TARGET PORT IDENTIFIER */
4008 * Now, have the $FABRIC_MOD fill in the protocol identifier
4010 desc_len = se_tpg->se_tpg_tfo->tpg_get_pr_transport_id(se_tpg,
4011 se_nacl, pr_reg, &format_code, &buf[off+4]);
4013 spin_lock(&pr_tmpl->registration_lock);
4014 atomic_dec_mb(&pr_reg->pr_res_holders);
4016 * Set the ADDITIONAL DESCRIPTOR LENGTH
4018 buf[off++] = ((desc_len >> 24) & 0xff);
4019 buf[off++] = ((desc_len >> 16) & 0xff);
4020 buf[off++] = ((desc_len >> 8) & 0xff);
4021 buf[off++] = (desc_len & 0xff);
4023 * Size of full desctipor header minus TransportID
4024 * containing $FABRIC_MOD specific) initiator device/port
4027 * See spc4r17 Section 6.13.5 Table 169
4029 add_desc_len = (24 + desc_len);
4032 add_len += add_desc_len;
4034 spin_unlock(&pr_tmpl->registration_lock);
4036 * Set ADDITIONAL_LENGTH
4038 buf[4] = ((add_len >> 24) & 0xff);
4039 buf[5] = ((add_len >> 16) & 0xff);
4040 buf[6] = ((add_len >> 8) & 0xff);
4041 buf[7] = (add_len & 0xff);
4043 transport_kunmap_data_sg(cmd);
4049 target_scsi3_emulate_pr_in(struct se_cmd *cmd)
4054 * Following spc2r20 5.5.1 Reservations overview:
4056 * If a logical unit has been reserved by any RESERVE command and is
4057 * still reserved by any initiator, all PERSISTENT RESERVE IN and all
4058 * PERSISTENT RESERVE OUT commands shall conflict regardless of
4059 * initiator or service action and shall terminate with a RESERVATION
4062 if (cmd->se_dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS) {
4063 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
4064 " SPC-2 reservation is held, returning"
4065 " RESERVATION_CONFLICT\n");
4066 return TCM_RESERVATION_CONFLICT;
4069 switch (cmd->t_task_cdb[1] & 0x1f) {
4071 ret = core_scsi3_pri_read_keys(cmd);
4073 case PRI_READ_RESERVATION:
4074 ret = core_scsi3_pri_read_reservation(cmd);
4076 case PRI_REPORT_CAPABILITIES:
4077 ret = core_scsi3_pri_report_capabilities(cmd);
4079 case PRI_READ_FULL_STATUS:
4080 ret = core_scsi3_pri_read_full_status(cmd);
4083 pr_err("Unknown PERSISTENT_RESERVE_IN service"
4084 " action: 0x%02x\n", cmd->t_task_cdb[1] & 0x1f);
4085 return TCM_INVALID_CDB_FIELD;
4089 target_complete_cmd(cmd, GOOD);
4094 target_check_reservation(struct se_cmd *cmd)
4096 struct se_device *dev = cmd->se_dev;
4101 if (dev->se_hba->hba_flags & HBA_FLAGS_INTERNAL_USE)
4103 if (dev->transport->transport_type == TRANSPORT_PLUGIN_PHBA_PDEV)
4106 spin_lock(&dev->dev_reservation_lock);
4107 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS)
4108 ret = target_scsi2_reservation_check(cmd);
4110 ret = target_scsi3_pr_reservation_check(cmd);
4111 spin_unlock(&dev->dev_reservation_lock);