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);
81 static int is_reservation_holder(
82 struct t10_pr_registration *pr_res_holder,
83 struct t10_pr_registration *pr_reg)
88 pr_res_type = pr_res_holder->pr_res_type;
90 return pr_res_holder == pr_reg ||
91 pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG ||
92 pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG;
98 target_scsi2_reservation_check(struct se_cmd *cmd)
100 struct se_device *dev = cmd->se_dev;
101 struct se_session *sess = cmd->se_sess;
103 switch (cmd->t_task_cdb[0]) {
112 if (!dev->dev_reserved_node_acl || !sess)
115 if (dev->dev_reserved_node_acl != sess->se_node_acl)
116 return TCM_RESERVATION_CONFLICT;
118 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS_WITH_ISID) {
119 if (dev->dev_res_bin_isid != sess->sess_bin_isid)
120 return TCM_RESERVATION_CONFLICT;
126 static struct t10_pr_registration *core_scsi3_locate_pr_reg(struct se_device *,
127 struct se_node_acl *, struct se_session *);
128 static void core_scsi3_put_pr_reg(struct t10_pr_registration *);
130 static int target_check_scsi2_reservation_conflict(struct se_cmd *cmd)
132 struct se_session *se_sess = cmd->se_sess;
133 struct se_device *dev = cmd->se_dev;
134 struct t10_pr_registration *pr_reg;
135 struct t10_reservation *pr_tmpl = &dev->t10_pr;
138 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
142 * From spc4r17 5.7.3 Exceptions to SPC-2 RESERVE and RELEASE
145 * A RESERVE(6) or RESERVE(10) command shall complete with GOOD
146 * status, but no reservation shall be established and the
147 * persistent reservation shall not be changed, if the command
148 * is received from a) and b) below.
150 * A RELEASE(6) or RELEASE(10) command shall complete with GOOD
151 * status, but the persistent reservation shall not be released,
152 * if the command is received from a) and b)
154 * a) An I_T nexus that is a persistent reservation holder; or
155 * b) An I_T nexus that is registered if a registrants only or
156 * all registrants type persistent reservation is present.
158 * In all other cases, a RESERVE(6) command, RESERVE(10) command,
159 * RELEASE(6) command, or RELEASE(10) command shall be processed
160 * as defined in SPC-2.
162 if (pr_reg->pr_res_holder) {
163 core_scsi3_put_pr_reg(pr_reg);
166 if ((pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_REGONLY) ||
167 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_REGONLY) ||
168 (pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
169 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
170 core_scsi3_put_pr_reg(pr_reg);
173 core_scsi3_put_pr_reg(pr_reg);
177 * Following spc2r20 5.5.1 Reservations overview:
179 * If a logical unit has executed a PERSISTENT RESERVE OUT
180 * command with the REGISTER or the REGISTER AND IGNORE
181 * EXISTING KEY service action and is still registered by any
182 * initiator, all RESERVE commands and all RELEASE commands
183 * regardless of initiator shall conflict and shall terminate
184 * with a RESERVATION CONFLICT status.
186 spin_lock(&pr_tmpl->registration_lock);
187 conflict = (list_empty(&pr_tmpl->registration_list)) ? 0 : 1;
188 spin_unlock(&pr_tmpl->registration_lock);
192 pr_err("Received legacy SPC-2 RESERVE/RELEASE"
193 " while active SPC-3 registrations exist,"
194 " returning RESERVATION_CONFLICT\n");
202 target_scsi2_reservation_release(struct se_cmd *cmd)
204 struct se_device *dev = cmd->se_dev;
205 struct se_session *sess = cmd->se_sess;
206 struct se_portal_group *tpg;
209 if (!sess || !sess->se_tpg)
211 rc = target_check_scsi2_reservation_conflict(cmd);
215 return TCM_RESERVATION_CONFLICT;
217 spin_lock(&dev->dev_reservation_lock);
218 if (!dev->dev_reserved_node_acl || !sess)
221 if (dev->dev_reserved_node_acl != sess->se_node_acl)
224 if (dev->dev_res_bin_isid != sess->sess_bin_isid)
227 dev->dev_reserved_node_acl = NULL;
228 dev->dev_reservation_flags &= ~DRF_SPC2_RESERVATIONS;
229 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS_WITH_ISID) {
230 dev->dev_res_bin_isid = 0;
231 dev->dev_reservation_flags &= ~DRF_SPC2_RESERVATIONS_WITH_ISID;
234 pr_debug("SCSI-2 Released reservation for %s LUN: %u ->"
235 " MAPPED LUN: %u for %s\n", tpg->se_tpg_tfo->get_fabric_name(),
236 cmd->se_lun->unpacked_lun, cmd->se_deve->mapped_lun,
237 sess->se_node_acl->initiatorname);
240 spin_unlock(&dev->dev_reservation_lock);
242 target_complete_cmd(cmd, GOOD);
247 target_scsi2_reservation_reserve(struct se_cmd *cmd)
249 struct se_device *dev = cmd->se_dev;
250 struct se_session *sess = cmd->se_sess;
251 struct se_portal_group *tpg;
252 sense_reason_t ret = 0;
255 if ((cmd->t_task_cdb[1] & 0x01) &&
256 (cmd->t_task_cdb[1] & 0x02)) {
257 pr_err("LongIO and Obselete Bits set, returning"
258 " ILLEGAL_REQUEST\n");
259 return TCM_UNSUPPORTED_SCSI_OPCODE;
262 * This is currently the case for target_core_mod passthrough struct se_cmd
265 if (!sess || !sess->se_tpg)
267 rc = target_check_scsi2_reservation_conflict(cmd);
272 return TCM_RESERVATION_CONFLICT;
275 spin_lock(&dev->dev_reservation_lock);
276 if (dev->dev_reserved_node_acl &&
277 (dev->dev_reserved_node_acl != sess->se_node_acl)) {
278 pr_err("SCSI-2 RESERVATION CONFLIFT for %s fabric\n",
279 tpg->se_tpg_tfo->get_fabric_name());
280 pr_err("Original reserver LUN: %u %s\n",
281 cmd->se_lun->unpacked_lun,
282 dev->dev_reserved_node_acl->initiatorname);
283 pr_err("Current attempt - LUN: %u -> MAPPED LUN: %u"
284 " from %s \n", cmd->se_lun->unpacked_lun,
285 cmd->se_deve->mapped_lun,
286 sess->se_node_acl->initiatorname);
287 ret = TCM_RESERVATION_CONFLICT;
291 dev->dev_reserved_node_acl = sess->se_node_acl;
292 dev->dev_reservation_flags |= DRF_SPC2_RESERVATIONS;
293 if (sess->sess_bin_isid != 0) {
294 dev->dev_res_bin_isid = sess->sess_bin_isid;
295 dev->dev_reservation_flags |= DRF_SPC2_RESERVATIONS_WITH_ISID;
297 pr_debug("SCSI-2 Reserved %s LUN: %u -> MAPPED LUN: %u"
298 " for %s\n", tpg->se_tpg_tfo->get_fabric_name(),
299 cmd->se_lun->unpacked_lun, cmd->se_deve->mapped_lun,
300 sess->se_node_acl->initiatorname);
303 spin_unlock(&dev->dev_reservation_lock);
306 target_complete_cmd(cmd, GOOD);
312 * Begin SPC-3/SPC-4 Persistent Reservations emulation support
314 * This function is called by those initiator ports who are *NOT*
315 * the active PR reservation holder when a reservation is present.
317 static int core_scsi3_pr_seq_non_holder(
321 unsigned char *cdb = cmd->t_task_cdb;
322 struct se_dev_entry *se_deve;
323 struct se_session *se_sess = cmd->se_sess;
324 int other_cdb = 0, ignore_reg;
325 int registered_nexus = 0, ret = 1; /* Conflict by default */
326 int all_reg = 0, reg_only = 0; /* ALL_REG, REG_ONLY */
327 int we = 0; /* Write Exclusive */
328 int legacy = 0; /* Act like a legacy device and return
329 * RESERVATION CONFLICT on some CDBs */
331 se_deve = se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
333 * Determine if the registration should be ignored due to
334 * non-matching ISIDs in target_scsi3_pr_reservation_check().
336 ignore_reg = (pr_reg_type & 0x80000000);
338 pr_reg_type &= ~0x80000000;
340 switch (pr_reg_type) {
341 case PR_TYPE_WRITE_EXCLUSIVE:
343 case PR_TYPE_EXCLUSIVE_ACCESS:
345 * Some commands are only allowed for the persistent reservation
348 if ((se_deve->def_pr_registered) && !(ignore_reg))
349 registered_nexus = 1;
351 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
353 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
355 * Some commands are only allowed for registered I_T Nexuses.
358 if ((se_deve->def_pr_registered) && !(ignore_reg))
359 registered_nexus = 1;
361 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
363 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
365 * Each registered I_T Nexus is a reservation holder.
368 if ((se_deve->def_pr_registered) && !(ignore_reg))
369 registered_nexus = 1;
375 * Referenced from spc4r17 table 45 for *NON* PR holder access
378 case SECURITY_PROTOCOL_IN:
379 if (registered_nexus)
387 case RECEIVE_DIAGNOSTIC:
392 if (registered_nexus) {
396 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
398 case PERSISTENT_RESERVE_OUT:
400 * This follows PERSISTENT_RESERVE_OUT service actions that
401 * are allowed in the presence of various reservations.
402 * See spc4r17, table 46
404 switch (cdb[1] & 0x1f) {
407 case PRO_PREEMPT_AND_ABORT:
408 ret = (registered_nexus) ? 0 : 1;
411 case PRO_REGISTER_AND_IGNORE_EXISTING_KEY:
414 case PRO_REGISTER_AND_MOVE:
419 ret = (registered_nexus) ? 0 : 1;
422 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
423 " action: 0x%02x\n", cdb[1] & 0x1f);
429 /* Handled by CRH=1 in target_scsi2_reservation_release() */
434 /* Handled by CRH=1 in target_scsi2_reservation_reserve() */
437 case TEST_UNIT_READY:
438 ret = (legacy) ? 1 : 0; /* Conflict for legacy */
441 switch (cdb[1] & 0x1f) {
442 case MI_MANAGEMENT_PROTOCOL_IN:
443 if (registered_nexus) {
447 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
449 case MI_REPORT_SUPPORTED_OPERATION_CODES:
450 case MI_REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS:
455 if (registered_nexus) {
459 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
461 case MI_REPORT_ALIASES:
462 case MI_REPORT_IDENTIFYING_INFORMATION:
463 case MI_REPORT_PRIORITY:
464 case MI_REPORT_TARGET_PGS:
465 case MI_REPORT_TIMESTAMP:
466 ret = 0; /* Allowed */
469 pr_err("Unknown MI Service Action: 0x%02x\n",
474 case ACCESS_CONTROL_IN:
475 case ACCESS_CONTROL_OUT:
478 case SERVICE_ACTION_IN_12:
481 case PERSISTENT_RESERVE_IN:
482 ret = 0; /*/ Allowed CDBs */
489 * Case where the CDB is explicitly allowed in the above switch
492 if (!ret && !other_cdb) {
493 pr_debug("Allowing explicit CDB: 0x%02x for %s"
494 " reservation holder\n", cdb[0],
495 core_scsi3_pr_dump_type(pr_reg_type));
500 * Check if write exclusive initiator ports *NOT* holding the
501 * WRITE_EXCLUSIVE_* reservation.
503 if (we && !registered_nexus) {
504 if (cmd->data_direction == DMA_TO_DEVICE) {
506 * Conflict for write exclusive
508 pr_debug("%s Conflict for unregistered nexus"
509 " %s CDB: 0x%02x to %s reservation\n",
510 transport_dump_cmd_direction(cmd),
511 se_sess->se_node_acl->initiatorname, cdb[0],
512 core_scsi3_pr_dump_type(pr_reg_type));
516 * Allow non WRITE CDBs for all Write Exclusive
517 * PR TYPEs to pass for registered and
518 * non-registered_nexuxes NOT holding the reservation.
520 * We only make noise for the unregisterd nexuses,
521 * as we expect registered non-reservation holding
522 * nexuses to issue CDBs.
525 if (!registered_nexus) {
526 pr_debug("Allowing implicit CDB: 0x%02x"
527 " for %s reservation on unregistered"
529 core_scsi3_pr_dump_type(pr_reg_type));
534 } else if ((reg_only) || (all_reg)) {
535 if (registered_nexus) {
537 * For PR_*_REG_ONLY and PR_*_ALL_REG reservations,
538 * allow commands from registered nexuses.
541 pr_debug("Allowing implicit CDB: 0x%02x for %s"
542 " reservation\n", cdb[0],
543 core_scsi3_pr_dump_type(pr_reg_type));
547 } else if (we && registered_nexus) {
549 * Reads are allowed for Write Exclusive locks
550 * from all registrants.
552 if (cmd->data_direction == DMA_FROM_DEVICE) {
553 pr_debug("Allowing READ CDB: 0x%02x for %s"
554 " reservation\n", cdb[0],
555 core_scsi3_pr_dump_type(pr_reg_type));
560 pr_debug("%s Conflict for %sregistered nexus %s CDB: 0x%2x"
561 " for %s reservation\n", transport_dump_cmd_direction(cmd),
562 (registered_nexus) ? "" : "un",
563 se_sess->se_node_acl->initiatorname, cdb[0],
564 core_scsi3_pr_dump_type(pr_reg_type));
566 return 1; /* Conflict by default */
569 static sense_reason_t
570 target_scsi3_pr_reservation_check(struct se_cmd *cmd)
572 struct se_device *dev = cmd->se_dev;
573 struct se_session *sess = cmd->se_sess;
576 if (!dev->dev_pr_res_holder)
579 pr_reg_type = dev->dev_pr_res_holder->pr_res_type;
580 cmd->pr_res_key = dev->dev_pr_res_holder->pr_res_key;
581 if (dev->dev_pr_res_holder->pr_reg_nacl != sess->se_node_acl)
582 goto check_nonholder;
584 if (dev->dev_pr_res_holder->isid_present_at_reg) {
585 if (dev->dev_pr_res_holder->pr_reg_bin_isid !=
586 sess->sess_bin_isid) {
587 pr_reg_type |= 0x80000000;
588 goto check_nonholder;
595 if (core_scsi3_pr_seq_non_holder(cmd, pr_reg_type))
596 return TCM_RESERVATION_CONFLICT;
600 static u32 core_scsi3_pr_generation(struct se_device *dev)
605 * PRGeneration field shall contain the value of a 32-bit wrapping
606 * counter mainted by the device server.
608 * Note that this is done regardless of Active Persist across
609 * Target PowerLoss (APTPL)
611 * See spc4r17 section 6.3.12 READ_KEYS service action
613 spin_lock(&dev->dev_reservation_lock);
614 prg = dev->t10_pr.pr_generation++;
615 spin_unlock(&dev->dev_reservation_lock);
620 static struct t10_pr_registration *__core_scsi3_do_alloc_registration(
621 struct se_device *dev,
622 struct se_node_acl *nacl,
623 struct se_dev_entry *deve,
629 struct t10_pr_registration *pr_reg;
631 pr_reg = kmem_cache_zalloc(t10_pr_reg_cache, GFP_ATOMIC);
633 pr_err("Unable to allocate struct t10_pr_registration\n");
637 INIT_LIST_HEAD(&pr_reg->pr_reg_list);
638 INIT_LIST_HEAD(&pr_reg->pr_reg_abort_list);
639 INIT_LIST_HEAD(&pr_reg->pr_reg_aptpl_list);
640 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_list);
641 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_mem_list);
642 atomic_set(&pr_reg->pr_res_holders, 0);
643 pr_reg->pr_reg_nacl = nacl;
644 pr_reg->pr_reg_deve = deve;
645 pr_reg->pr_res_mapped_lun = deve->mapped_lun;
646 pr_reg->pr_aptpl_target_lun = deve->se_lun->unpacked_lun;
647 pr_reg->pr_res_key = sa_res_key;
648 pr_reg->pr_reg_all_tg_pt = all_tg_pt;
649 pr_reg->pr_reg_aptpl = aptpl;
650 pr_reg->pr_reg_tg_pt_lun = deve->se_lun;
652 * If an ISID value for this SCSI Initiator Port exists,
653 * save it to the registration now.
656 pr_reg->pr_reg_bin_isid = get_unaligned_be64(isid);
657 snprintf(pr_reg->pr_reg_isid, PR_REG_ISID_LEN, "%s", isid);
658 pr_reg->isid_present_at_reg = 1;
664 static int core_scsi3_lunacl_depend_item(struct se_dev_entry *);
665 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry *);
668 * Function used for handling PR registrations for ALL_TG_PT=1 and ALL_TG_PT=0
671 static struct t10_pr_registration *__core_scsi3_alloc_registration(
672 struct se_device *dev,
673 struct se_node_acl *nacl,
674 struct se_dev_entry *deve,
680 struct se_dev_entry *deve_tmp;
681 struct se_node_acl *nacl_tmp;
682 struct se_port *port, *port_tmp;
683 const struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
684 struct t10_pr_registration *pr_reg, *pr_reg_atp, *pr_reg_tmp, *pr_reg_tmp_safe;
687 * Create a registration for the I_T Nexus upon which the
688 * PROUT REGISTER was received.
690 pr_reg = __core_scsi3_do_alloc_registration(dev, nacl, deve, isid,
691 sa_res_key, all_tg_pt, aptpl);
695 * Return pointer to pr_reg for ALL_TG_PT=0
700 * Create list of matching SCSI Initiator Port registrations
703 spin_lock(&dev->se_port_lock);
704 list_for_each_entry_safe(port, port_tmp, &dev->dev_sep_list, sep_list) {
705 atomic_inc_mb(&port->sep_tg_pt_ref_cnt);
706 spin_unlock(&dev->se_port_lock);
708 spin_lock_bh(&port->sep_alua_lock);
709 list_for_each_entry(deve_tmp, &port->sep_alua_list,
712 * This pointer will be NULL for demo mode MappedLUNs
713 * that have not been make explicit via a ConfigFS
714 * MappedLUN group for the SCSI Initiator Node ACL.
716 if (!deve_tmp->se_lun_acl)
719 nacl_tmp = deve_tmp->se_lun_acl->se_lun_nacl;
721 * Skip the matching struct se_node_acl that is allocated
724 if (nacl == nacl_tmp)
727 * Only perform PR registrations for target ports on
728 * the same fabric module as the REGISTER w/ ALL_TG_PT=1
731 if (tfo != nacl_tmp->se_tpg->se_tpg_tfo)
734 * Look for a matching Initiator Node ACL in ASCII format
736 if (strcmp(nacl->initiatorname, nacl_tmp->initiatorname))
739 atomic_inc_mb(&deve_tmp->pr_ref_count);
740 spin_unlock_bh(&port->sep_alua_lock);
742 * Grab a configfs group dependency that is released
743 * for the exception path at label out: below, or upon
744 * completion of adding ALL_TG_PT=1 registrations in
745 * __core_scsi3_add_registration()
747 ret = core_scsi3_lunacl_depend_item(deve_tmp);
749 pr_err("core_scsi3_lunacl_depend"
751 atomic_dec_mb(&port->sep_tg_pt_ref_cnt);
752 atomic_dec_mb(&deve_tmp->pr_ref_count);
756 * Located a matching SCSI Initiator Port on a different
757 * port, allocate the pr_reg_atp and attach it to the
758 * pr_reg->pr_reg_atp_list that will be processed once
759 * the original *pr_reg is processed in
760 * __core_scsi3_add_registration()
762 pr_reg_atp = __core_scsi3_do_alloc_registration(dev,
763 nacl_tmp, deve_tmp, NULL,
764 sa_res_key, all_tg_pt, aptpl);
766 atomic_dec_mb(&port->sep_tg_pt_ref_cnt);
767 atomic_dec_mb(&deve_tmp->pr_ref_count);
768 core_scsi3_lunacl_undepend_item(deve_tmp);
772 list_add_tail(&pr_reg_atp->pr_reg_atp_mem_list,
773 &pr_reg->pr_reg_atp_list);
774 spin_lock_bh(&port->sep_alua_lock);
776 spin_unlock_bh(&port->sep_alua_lock);
778 spin_lock(&dev->se_port_lock);
779 atomic_dec_mb(&port->sep_tg_pt_ref_cnt);
781 spin_unlock(&dev->se_port_lock);
785 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
786 &pr_reg->pr_reg_atp_list, pr_reg_atp_mem_list) {
787 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
788 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
789 kmem_cache_free(t10_pr_reg_cache, pr_reg_tmp);
791 kmem_cache_free(t10_pr_reg_cache, pr_reg);
795 int core_scsi3_alloc_aptpl_registration(
796 struct t10_reservation *pr_tmpl,
798 unsigned char *i_port,
801 unsigned char *t_port,
808 struct t10_pr_registration *pr_reg;
810 if (!i_port || !t_port || !sa_res_key) {
811 pr_err("Illegal parameters for APTPL registration\n");
815 pr_reg = kmem_cache_zalloc(t10_pr_reg_cache, GFP_KERNEL);
817 pr_err("Unable to allocate struct t10_pr_registration\n");
821 INIT_LIST_HEAD(&pr_reg->pr_reg_list);
822 INIT_LIST_HEAD(&pr_reg->pr_reg_abort_list);
823 INIT_LIST_HEAD(&pr_reg->pr_reg_aptpl_list);
824 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_list);
825 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_mem_list);
826 atomic_set(&pr_reg->pr_res_holders, 0);
827 pr_reg->pr_reg_nacl = NULL;
828 pr_reg->pr_reg_deve = NULL;
829 pr_reg->pr_res_mapped_lun = mapped_lun;
830 pr_reg->pr_aptpl_target_lun = target_lun;
831 pr_reg->pr_res_key = sa_res_key;
832 pr_reg->pr_reg_all_tg_pt = all_tg_pt;
833 pr_reg->pr_reg_aptpl = 1;
834 pr_reg->pr_reg_tg_pt_lun = NULL;
835 pr_reg->pr_res_scope = 0; /* Always LUN_SCOPE */
836 pr_reg->pr_res_type = type;
838 * If an ISID value had been saved in APTPL metadata for this
839 * SCSI Initiator Port, restore it now.
842 pr_reg->pr_reg_bin_isid = get_unaligned_be64(isid);
843 snprintf(pr_reg->pr_reg_isid, PR_REG_ISID_LEN, "%s", isid);
844 pr_reg->isid_present_at_reg = 1;
847 * Copy the i_port and t_port information from caller.
849 snprintf(pr_reg->pr_iport, PR_APTPL_MAX_IPORT_LEN, "%s", i_port);
850 snprintf(pr_reg->pr_tport, PR_APTPL_MAX_TPORT_LEN, "%s", t_port);
851 pr_reg->pr_reg_tpgt = tpgt;
853 * Set pr_res_holder from caller, the pr_reg who is the reservation
854 * holder will get it's pointer set in core_scsi3_aptpl_reserve() once
855 * the Initiator Node LUN ACL from the fabric module is created for
858 pr_reg->pr_res_holder = res_holder;
860 list_add_tail(&pr_reg->pr_reg_aptpl_list, &pr_tmpl->aptpl_reg_list);
861 pr_debug("SPC-3 PR APTPL Successfully added registration%s from"
862 " metadata\n", (res_holder) ? "+reservation" : "");
866 static void core_scsi3_aptpl_reserve(
867 struct se_device *dev,
868 struct se_portal_group *tpg,
869 struct se_node_acl *node_acl,
870 struct t10_pr_registration *pr_reg)
872 char i_buf[PR_REG_ISID_ID_LEN];
874 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
875 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
877 spin_lock(&dev->dev_reservation_lock);
878 dev->dev_pr_res_holder = pr_reg;
879 spin_unlock(&dev->dev_reservation_lock);
881 pr_debug("SPC-3 PR [%s] Service Action: APTPL RESERVE created"
882 " new reservation holder TYPE: %s ALL_TG_PT: %d\n",
883 tpg->se_tpg_tfo->get_fabric_name(),
884 core_scsi3_pr_dump_type(pr_reg->pr_res_type),
885 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
886 pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
887 tpg->se_tpg_tfo->get_fabric_name(), node_acl->initiatorname,
891 static void __core_scsi3_add_registration(struct se_device *, struct se_node_acl *,
892 struct t10_pr_registration *, enum register_type, int);
894 static int __core_scsi3_check_aptpl_registration(
895 struct se_device *dev,
896 struct se_portal_group *tpg,
899 struct se_node_acl *nacl,
900 struct se_dev_entry *deve)
902 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
903 struct t10_reservation *pr_tmpl = &dev->t10_pr;
904 unsigned char i_port[PR_APTPL_MAX_IPORT_LEN];
905 unsigned char t_port[PR_APTPL_MAX_TPORT_LEN];
908 memset(i_port, 0, PR_APTPL_MAX_IPORT_LEN);
909 memset(t_port, 0, PR_APTPL_MAX_TPORT_LEN);
911 * Copy Initiator Port information from struct se_node_acl
913 snprintf(i_port, PR_APTPL_MAX_IPORT_LEN, "%s", nacl->initiatorname);
914 snprintf(t_port, PR_APTPL_MAX_TPORT_LEN, "%s",
915 tpg->se_tpg_tfo->tpg_get_wwn(tpg));
916 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
918 * Look for the matching registrations+reservation from those
919 * created from APTPL metadata. Note that multiple registrations
920 * may exist for fabrics that use ISIDs in their SCSI Initiator Port
923 spin_lock(&pr_tmpl->aptpl_reg_lock);
924 list_for_each_entry_safe(pr_reg, pr_reg_tmp, &pr_tmpl->aptpl_reg_list,
927 if (!strcmp(pr_reg->pr_iport, i_port) &&
928 (pr_reg->pr_res_mapped_lun == deve->mapped_lun) &&
929 !(strcmp(pr_reg->pr_tport, t_port)) &&
930 (pr_reg->pr_reg_tpgt == tpgt) &&
931 (pr_reg->pr_aptpl_target_lun == target_lun)) {
933 pr_reg->pr_reg_nacl = nacl;
934 pr_reg->pr_reg_deve = deve;
935 pr_reg->pr_reg_tg_pt_lun = lun;
937 list_del(&pr_reg->pr_reg_aptpl_list);
938 spin_unlock(&pr_tmpl->aptpl_reg_lock);
940 * At this point all of the pointers in *pr_reg will
941 * be setup, so go ahead and add the registration.
944 __core_scsi3_add_registration(dev, nacl, pr_reg, 0, 0);
946 * If this registration is the reservation holder,
947 * make that happen now..
949 if (pr_reg->pr_res_holder)
950 core_scsi3_aptpl_reserve(dev, tpg,
953 * Reenable pr_aptpl_active to accept new metadata
954 * updates once the SCSI device is active again..
956 spin_lock(&pr_tmpl->aptpl_reg_lock);
957 pr_tmpl->pr_aptpl_active = 1;
960 spin_unlock(&pr_tmpl->aptpl_reg_lock);
965 int core_scsi3_check_aptpl_registration(
966 struct se_device *dev,
967 struct se_portal_group *tpg,
969 struct se_node_acl *nacl,
972 struct se_dev_entry *deve = nacl->device_list[mapped_lun];
974 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS)
977 return __core_scsi3_check_aptpl_registration(dev, tpg, lun,
978 lun->unpacked_lun, nacl, deve);
981 static void __core_scsi3_dump_registration(
982 const struct target_core_fabric_ops *tfo,
983 struct se_device *dev,
984 struct se_node_acl *nacl,
985 struct t10_pr_registration *pr_reg,
986 enum register_type register_type)
988 struct se_portal_group *se_tpg = nacl->se_tpg;
989 char i_buf[PR_REG_ISID_ID_LEN];
991 memset(&i_buf[0], 0, PR_REG_ISID_ID_LEN);
992 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
994 pr_debug("SPC-3 PR [%s] Service Action: REGISTER%s Initiator"
995 " Node: %s%s\n", tfo->get_fabric_name(), (register_type == REGISTER_AND_MOVE) ?
996 "_AND_MOVE" : (register_type == REGISTER_AND_IGNORE_EXISTING_KEY) ?
997 "_AND_IGNORE_EXISTING_KEY" : "", nacl->initiatorname,
999 pr_debug("SPC-3 PR [%s] registration on Target Port: %s,0x%04x\n",
1000 tfo->get_fabric_name(), tfo->tpg_get_wwn(se_tpg),
1001 tfo->tpg_get_tag(se_tpg));
1002 pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
1003 " Port(s)\n", tfo->get_fabric_name(),
1004 (pr_reg->pr_reg_all_tg_pt) ? "ALL" : "SINGLE",
1005 dev->transport->name);
1006 pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
1007 " 0x%08x APTPL: %d\n", tfo->get_fabric_name(),
1008 pr_reg->pr_res_key, pr_reg->pr_res_generation,
1009 pr_reg->pr_reg_aptpl);
1013 * this function can be called with struct se_device->dev_reservation_lock
1014 * when register_move = 1
1016 static void __core_scsi3_add_registration(
1017 struct se_device *dev,
1018 struct se_node_acl *nacl,
1019 struct t10_pr_registration *pr_reg,
1020 enum register_type register_type,
1023 const struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
1024 struct t10_pr_registration *pr_reg_tmp, *pr_reg_tmp_safe;
1025 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1028 * Increment PRgeneration counter for struct se_device upon a successful
1029 * REGISTER, see spc4r17 section 6.3.2 READ_KEYS service action
1031 * Also, when register_move = 1 for PROUT REGISTER_AND_MOVE service
1032 * action, the struct se_device->dev_reservation_lock will already be held,
1033 * so we do not call core_scsi3_pr_generation() which grabs the lock
1036 pr_reg->pr_res_generation = (register_move) ?
1037 dev->t10_pr.pr_generation++ :
1038 core_scsi3_pr_generation(dev);
1040 spin_lock(&pr_tmpl->registration_lock);
1041 list_add_tail(&pr_reg->pr_reg_list, &pr_tmpl->registration_list);
1042 pr_reg->pr_reg_deve->def_pr_registered = 1;
1044 __core_scsi3_dump_registration(tfo, dev, nacl, pr_reg, register_type);
1045 spin_unlock(&pr_tmpl->registration_lock);
1047 * Skip extra processing for ALL_TG_PT=0 or REGISTER_AND_MOVE.
1049 if (!pr_reg->pr_reg_all_tg_pt || register_move)
1052 * Walk pr_reg->pr_reg_atp_list and add registrations for ALL_TG_PT=1
1053 * allocated in __core_scsi3_alloc_registration()
1055 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
1056 &pr_reg->pr_reg_atp_list, pr_reg_atp_mem_list) {
1057 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
1059 pr_reg_tmp->pr_res_generation = core_scsi3_pr_generation(dev);
1061 spin_lock(&pr_tmpl->registration_lock);
1062 list_add_tail(&pr_reg_tmp->pr_reg_list,
1063 &pr_tmpl->registration_list);
1064 pr_reg_tmp->pr_reg_deve->def_pr_registered = 1;
1066 __core_scsi3_dump_registration(tfo, dev,
1067 pr_reg_tmp->pr_reg_nacl, pr_reg_tmp,
1069 spin_unlock(&pr_tmpl->registration_lock);
1071 * Drop configfs group dependency reference from
1072 * __core_scsi3_alloc_registration()
1074 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
1078 static int core_scsi3_alloc_registration(
1079 struct se_device *dev,
1080 struct se_node_acl *nacl,
1081 struct se_dev_entry *deve,
1082 unsigned char *isid,
1086 enum register_type register_type,
1089 struct t10_pr_registration *pr_reg;
1091 pr_reg = __core_scsi3_alloc_registration(dev, nacl, deve, isid,
1092 sa_res_key, all_tg_pt, aptpl);
1096 __core_scsi3_add_registration(dev, nacl, pr_reg,
1097 register_type, register_move);
1101 static struct t10_pr_registration *__core_scsi3_locate_pr_reg(
1102 struct se_device *dev,
1103 struct se_node_acl *nacl,
1104 unsigned char *isid)
1106 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1107 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
1108 struct se_portal_group *tpg;
1110 spin_lock(&pr_tmpl->registration_lock);
1111 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1112 &pr_tmpl->registration_list, pr_reg_list) {
1114 * First look for a matching struct se_node_acl
1116 if (pr_reg->pr_reg_nacl != nacl)
1119 tpg = pr_reg->pr_reg_nacl->se_tpg;
1121 * If this registration does NOT contain a fabric provided
1122 * ISID, then we have found a match.
1124 if (!pr_reg->isid_present_at_reg) {
1126 * Determine if this SCSI device server requires that
1127 * SCSI Intiatior TransportID w/ ISIDs is enforced
1128 * for fabric modules (iSCSI) requiring them.
1130 if (tpg->se_tpg_tfo->sess_get_initiator_sid != NULL) {
1131 if (dev->dev_attrib.enforce_pr_isids)
1134 atomic_inc_mb(&pr_reg->pr_res_holders);
1135 spin_unlock(&pr_tmpl->registration_lock);
1139 * If the *pr_reg contains a fabric defined ISID for multi-value
1140 * SCSI Initiator Port TransportIDs, then we expect a valid
1141 * matching ISID to be provided by the local SCSI Initiator Port.
1145 if (strcmp(isid, pr_reg->pr_reg_isid))
1148 atomic_inc_mb(&pr_reg->pr_res_holders);
1149 spin_unlock(&pr_tmpl->registration_lock);
1152 spin_unlock(&pr_tmpl->registration_lock);
1157 static struct t10_pr_registration *core_scsi3_locate_pr_reg(
1158 struct se_device *dev,
1159 struct se_node_acl *nacl,
1160 struct se_session *sess)
1162 struct se_portal_group *tpg = nacl->se_tpg;
1163 unsigned char buf[PR_REG_ISID_LEN], *isid_ptr = NULL;
1165 if (tpg->se_tpg_tfo->sess_get_initiator_sid != NULL) {
1166 memset(&buf[0], 0, PR_REG_ISID_LEN);
1167 tpg->se_tpg_tfo->sess_get_initiator_sid(sess, &buf[0],
1172 return __core_scsi3_locate_pr_reg(dev, nacl, isid_ptr);
1175 static void core_scsi3_put_pr_reg(struct t10_pr_registration *pr_reg)
1177 atomic_dec_mb(&pr_reg->pr_res_holders);
1180 static int core_scsi3_check_implicit_release(
1181 struct se_device *dev,
1182 struct t10_pr_registration *pr_reg)
1184 struct se_node_acl *nacl = pr_reg->pr_reg_nacl;
1185 struct t10_pr_registration *pr_res_holder;
1188 spin_lock(&dev->dev_reservation_lock);
1189 pr_res_holder = dev->dev_pr_res_holder;
1190 if (!pr_res_holder) {
1191 spin_unlock(&dev->dev_reservation_lock);
1194 if (pr_res_holder == pr_reg) {
1196 * Perform an implicit RELEASE if the registration that
1197 * is being released is holding the reservation.
1199 * From spc4r17, section 5.7.11.1:
1201 * e) If the I_T nexus is the persistent reservation holder
1202 * and the persistent reservation is not an all registrants
1203 * type, then a PERSISTENT RESERVE OUT command with REGISTER
1204 * service action or REGISTER AND IGNORE EXISTING KEY
1205 * service action with the SERVICE ACTION RESERVATION KEY
1206 * field set to zero (see 5.7.11.3).
1208 __core_scsi3_complete_pro_release(dev, nacl, pr_reg, 0, 1);
1211 * For 'All Registrants' reservation types, all existing
1212 * registrations are still processed as reservation holders
1213 * in core_scsi3_pr_seq_non_holder() after the initial
1214 * reservation holder is implicitly released here.
1216 } else if (pr_reg->pr_reg_all_tg_pt &&
1217 (!strcmp(pr_res_holder->pr_reg_nacl->initiatorname,
1218 pr_reg->pr_reg_nacl->initiatorname)) &&
1219 (pr_res_holder->pr_res_key == pr_reg->pr_res_key)) {
1220 pr_err("SPC-3 PR: Unable to perform ALL_TG_PT=1"
1221 " UNREGISTER while existing reservation with matching"
1222 " key 0x%016Lx is present from another SCSI Initiator"
1223 " Port\n", pr_reg->pr_res_key);
1226 spin_unlock(&dev->dev_reservation_lock);
1232 * Called with struct t10_reservation->registration_lock held.
1234 static void __core_scsi3_free_registration(
1235 struct se_device *dev,
1236 struct t10_pr_registration *pr_reg,
1237 struct list_head *preempt_and_abort_list,
1239 __releases(&pr_tmpl->registration_lock)
1240 __acquires(&pr_tmpl->registration_lock)
1242 const struct target_core_fabric_ops *tfo =
1243 pr_reg->pr_reg_nacl->se_tpg->se_tpg_tfo;
1244 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1245 char i_buf[PR_REG_ISID_ID_LEN];
1247 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
1248 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
1250 pr_reg->pr_reg_deve->def_pr_registered = 0;
1251 pr_reg->pr_reg_deve->pr_res_key = 0;
1252 if (!list_empty(&pr_reg->pr_reg_list))
1253 list_del(&pr_reg->pr_reg_list);
1255 * Caller accessing *pr_reg using core_scsi3_locate_pr_reg(),
1256 * so call core_scsi3_put_pr_reg() to decrement our reference.
1259 core_scsi3_put_pr_reg(pr_reg);
1261 * Wait until all reference from any other I_T nexuses for this
1262 * *pr_reg have been released. Because list_del() is called above,
1263 * the last core_scsi3_put_pr_reg(pr_reg) will release this reference
1264 * count back to zero, and we release *pr_reg.
1266 while (atomic_read(&pr_reg->pr_res_holders) != 0) {
1267 spin_unlock(&pr_tmpl->registration_lock);
1268 pr_debug("SPC-3 PR [%s] waiting for pr_res_holders\n",
1269 tfo->get_fabric_name());
1271 spin_lock(&pr_tmpl->registration_lock);
1274 pr_debug("SPC-3 PR [%s] Service Action: UNREGISTER Initiator"
1275 " Node: %s%s\n", tfo->get_fabric_name(),
1276 pr_reg->pr_reg_nacl->initiatorname,
1278 pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
1279 " Port(s)\n", tfo->get_fabric_name(),
1280 (pr_reg->pr_reg_all_tg_pt) ? "ALL" : "SINGLE",
1281 dev->transport->name);
1282 pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
1283 " 0x%08x\n", tfo->get_fabric_name(), pr_reg->pr_res_key,
1284 pr_reg->pr_res_generation);
1286 if (!preempt_and_abort_list) {
1287 pr_reg->pr_reg_deve = NULL;
1288 pr_reg->pr_reg_nacl = NULL;
1289 kmem_cache_free(t10_pr_reg_cache, pr_reg);
1293 * For PREEMPT_AND_ABORT, the list of *pr_reg in preempt_and_abort_list
1294 * are released once the ABORT_TASK_SET has completed..
1296 list_add_tail(&pr_reg->pr_reg_abort_list, preempt_and_abort_list);
1299 void core_scsi3_free_pr_reg_from_nacl(
1300 struct se_device *dev,
1301 struct se_node_acl *nacl)
1303 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1304 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_res_holder;
1305 bool free_reg = false;
1307 * If the passed se_node_acl matches the reservation holder,
1308 * release the reservation.
1310 spin_lock(&dev->dev_reservation_lock);
1311 pr_res_holder = dev->dev_pr_res_holder;
1312 if ((pr_res_holder != NULL) &&
1313 (pr_res_holder->pr_reg_nacl == nacl)) {
1314 __core_scsi3_complete_pro_release(dev, nacl, pr_res_holder, 0, 1);
1317 spin_unlock(&dev->dev_reservation_lock);
1319 * Release any registration associated with the struct se_node_acl.
1321 spin_lock(&pr_tmpl->registration_lock);
1322 if (pr_res_holder && free_reg)
1323 __core_scsi3_free_registration(dev, pr_res_holder, NULL, 0);
1325 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1326 &pr_tmpl->registration_list, pr_reg_list) {
1328 if (pr_reg->pr_reg_nacl != nacl)
1331 __core_scsi3_free_registration(dev, pr_reg, NULL, 0);
1333 spin_unlock(&pr_tmpl->registration_lock);
1336 void core_scsi3_free_all_registrations(
1337 struct se_device *dev)
1339 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1340 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_res_holder;
1342 spin_lock(&dev->dev_reservation_lock);
1343 pr_res_holder = dev->dev_pr_res_holder;
1344 if (pr_res_holder != NULL) {
1345 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
1346 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
1347 pr_res_holder, 0, 0);
1349 spin_unlock(&dev->dev_reservation_lock);
1351 spin_lock(&pr_tmpl->registration_lock);
1352 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1353 &pr_tmpl->registration_list, pr_reg_list) {
1355 __core_scsi3_free_registration(dev, pr_reg, NULL, 0);
1357 spin_unlock(&pr_tmpl->registration_lock);
1359 spin_lock(&pr_tmpl->aptpl_reg_lock);
1360 list_for_each_entry_safe(pr_reg, pr_reg_tmp, &pr_tmpl->aptpl_reg_list,
1361 pr_reg_aptpl_list) {
1362 list_del(&pr_reg->pr_reg_aptpl_list);
1363 kmem_cache_free(t10_pr_reg_cache, pr_reg);
1365 spin_unlock(&pr_tmpl->aptpl_reg_lock);
1368 static int core_scsi3_tpg_depend_item(struct se_portal_group *tpg)
1370 return target_depend_item(&tpg->tpg_group.cg_item);
1373 static void core_scsi3_tpg_undepend_item(struct se_portal_group *tpg)
1375 target_undepend_item(&tpg->tpg_group.cg_item);
1376 atomic_dec_mb(&tpg->tpg_pr_ref_count);
1379 static int core_scsi3_nodeacl_depend_item(struct se_node_acl *nacl)
1381 if (nacl->dynamic_node_acl)
1383 return target_depend_item(&nacl->acl_group.cg_item);
1386 static void core_scsi3_nodeacl_undepend_item(struct se_node_acl *nacl)
1388 if (!nacl->dynamic_node_acl)
1389 target_undepend_item(&nacl->acl_group.cg_item);
1390 atomic_dec_mb(&nacl->acl_pr_ref_count);
1393 static int core_scsi3_lunacl_depend_item(struct se_dev_entry *se_deve)
1395 struct se_lun_acl *lun_acl = se_deve->se_lun_acl;
1396 struct se_node_acl *nacl;
1397 struct se_portal_group *tpg;
1399 * For nacl->dynamic_node_acl=1
1404 nacl = lun_acl->se_lun_nacl;
1407 return target_depend_item(&lun_acl->se_lun_group.cg_item);
1410 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry *se_deve)
1412 struct se_lun_acl *lun_acl = se_deve->se_lun_acl;
1413 struct se_node_acl *nacl;
1414 struct se_portal_group *tpg;
1416 * For nacl->dynamic_node_acl=1
1419 atomic_dec_mb(&se_deve->pr_ref_count);
1422 nacl = lun_acl->se_lun_nacl;
1425 target_undepend_item(&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 const 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 APTPL metadata,"
1878 " reallocating larger buffer\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 APTPL metadata,"
1896 " reallocating larger buffer\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)
1959 int rc, len = PR_APTPL_BUF_LEN;
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;
1976 return TCM_OUT_OF_RESOURCES;
1978 rc = core_scsi3_update_aptpl_buf(dev, buf, len);
1985 rc = __core_scsi3_write_aptpl_to_file(dev, buf);
1987 pr_err("SPC-3 PR: Could not update APTPL\n");
1989 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1991 dev->t10_pr.pr_aptpl_active = 1;
1993 pr_debug("SPC-3 PR: Set APTPL Bit Activated\n");
1997 static sense_reason_t
1998 core_scsi3_emulate_pro_register(struct se_cmd *cmd, u64 res_key, u64 sa_res_key,
1999 bool aptpl, bool all_tg_pt, bool spec_i_pt, enum register_type register_type)
2001 struct se_session *se_sess = cmd->se_sess;
2002 struct se_device *dev = cmd->se_dev;
2003 struct se_dev_entry *se_deve;
2004 struct se_lun *se_lun = cmd->se_lun;
2005 struct se_portal_group *se_tpg;
2006 struct t10_pr_registration *pr_reg, *pr_reg_p, *pr_reg_tmp;
2007 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2008 unsigned char isid_buf[PR_REG_ISID_LEN], *isid_ptr = NULL;
2009 sense_reason_t ret = TCM_NO_SENSE;
2010 int pr_holder = 0, type;
2012 if (!se_sess || !se_lun) {
2013 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2014 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2016 se_tpg = se_sess->se_tpg;
2017 se_deve = se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
2019 if (se_tpg->se_tpg_tfo->sess_get_initiator_sid) {
2020 memset(&isid_buf[0], 0, PR_REG_ISID_LEN);
2021 se_tpg->se_tpg_tfo->sess_get_initiator_sid(se_sess, &isid_buf[0],
2023 isid_ptr = &isid_buf[0];
2026 * Follow logic from spc4r17 Section 5.7.7, Register Behaviors Table 47
2028 pr_reg = core_scsi3_locate_pr_reg(dev, se_sess->se_node_acl, se_sess);
2031 pr_warn("SPC-3 PR: Reservation Key non-zero"
2032 " for SA REGISTER, returning CONFLICT\n");
2033 return TCM_RESERVATION_CONFLICT;
2036 * Do nothing but return GOOD status.
2043 * Perform the Service Action REGISTER on the Initiator
2044 * Port Endpoint that the PRO was received from on the
2045 * Logical Unit of the SCSI device server.
2047 if (core_scsi3_alloc_registration(cmd->se_dev,
2048 se_sess->se_node_acl, se_deve, isid_ptr,
2049 sa_res_key, all_tg_pt, aptpl,
2050 register_type, 0)) {
2051 pr_err("Unable to allocate"
2052 " struct t10_pr_registration\n");
2053 return TCM_INVALID_PARAMETER_LIST;
2057 * Register both the Initiator port that received
2058 * PROUT SA REGISTER + SPEC_I_PT=1 and extract SCSI
2059 * TransportID from Parameter list and loop through
2060 * fabric dependent parameter list while calling
2061 * logic from of core_scsi3_alloc_registration() for
2062 * each TransportID provided SCSI Initiator Port/Device
2064 ret = core_scsi3_decode_spec_i_port(cmd, se_tpg,
2065 isid_ptr, sa_res_key, all_tg_pt, aptpl);
2070 return core_scsi3_update_and_write_aptpl(dev, aptpl);
2073 /* ok, existing registration */
2075 if ((register_type == REGISTER) && (res_key != pr_reg->pr_res_key)) {
2076 pr_err("SPC-3 PR REGISTER: Received"
2077 " res_key: 0x%016Lx does not match"
2078 " existing SA REGISTER res_key:"
2079 " 0x%016Lx\n", res_key,
2080 pr_reg->pr_res_key);
2081 ret = TCM_RESERVATION_CONFLICT;
2086 pr_err("SPC-3 PR REGISTER: SPEC_I_PT"
2087 " set on a registered nexus\n");
2088 ret = TCM_INVALID_PARAMETER_LIST;
2093 * An existing ALL_TG_PT=1 registration being released
2094 * must also set ALL_TG_PT=1 in the incoming PROUT.
2096 if (pr_reg->pr_reg_all_tg_pt && !all_tg_pt) {
2097 pr_err("SPC-3 PR REGISTER: ALL_TG_PT=1"
2098 " registration exists, but ALL_TG_PT=1 bit not"
2099 " present in received PROUT\n");
2100 ret = TCM_INVALID_CDB_FIELD;
2105 * sa_res_key=1 Change Reservation Key for registered I_T Nexus.
2109 * Increment PRgeneration counter for struct se_device"
2110 * upon a successful REGISTER, see spc4r17 section 6.3.2
2111 * READ_KEYS service action.
2113 pr_reg->pr_res_generation = core_scsi3_pr_generation(cmd->se_dev);
2114 pr_reg->pr_res_key = sa_res_key;
2115 pr_debug("SPC-3 PR [%s] REGISTER%s: Changed Reservation"
2116 " Key for %s to: 0x%016Lx PRgeneration:"
2117 " 0x%08x\n", cmd->se_tfo->get_fabric_name(),
2118 (register_type == REGISTER_AND_IGNORE_EXISTING_KEY) ? "_AND_IGNORE_EXISTING_KEY" : "",
2119 pr_reg->pr_reg_nacl->initiatorname,
2120 pr_reg->pr_res_key, pr_reg->pr_res_generation);
2124 * sa_res_key=0 Unregister Reservation Key for registered I_T Nexus.
2126 type = pr_reg->pr_res_type;
2127 pr_holder = core_scsi3_check_implicit_release(cmd->se_dev,
2129 if (pr_holder < 0) {
2130 ret = TCM_RESERVATION_CONFLICT;
2134 spin_lock(&pr_tmpl->registration_lock);
2136 * Release all ALL_TG_PT=1 for the matching SCSI Initiator Port
2137 * and matching pr_res_key.
2139 if (pr_reg->pr_reg_all_tg_pt) {
2140 list_for_each_entry_safe(pr_reg_p, pr_reg_tmp,
2141 &pr_tmpl->registration_list,
2144 if (!pr_reg_p->pr_reg_all_tg_pt)
2146 if (pr_reg_p->pr_res_key != res_key)
2148 if (pr_reg == pr_reg_p)
2150 if (strcmp(pr_reg->pr_reg_nacl->initiatorname,
2151 pr_reg_p->pr_reg_nacl->initiatorname))
2154 __core_scsi3_free_registration(dev,
2160 * Release the calling I_T Nexus registration now..
2162 __core_scsi3_free_registration(cmd->se_dev, pr_reg, NULL, 1);
2166 * From spc4r17, section 5.7.11.3 Unregistering
2168 * If the persistent reservation is a registrants only
2169 * type, the device server shall establish a unit
2170 * attention condition for the initiator port associated
2171 * with every registered I_T nexus except for the I_T
2172 * nexus on which the PERSISTENT RESERVE OUT command was
2173 * received, with the additional sense code set to
2174 * RESERVATIONS RELEASED.
2177 (type == PR_TYPE_WRITE_EXCLUSIVE_REGONLY ||
2178 type == PR_TYPE_EXCLUSIVE_ACCESS_REGONLY)) {
2179 list_for_each_entry(pr_reg_p,
2180 &pr_tmpl->registration_list,
2183 core_scsi3_ua_allocate(
2184 pr_reg_p->pr_reg_nacl,
2185 pr_reg_p->pr_res_mapped_lun,
2187 ASCQ_2AH_RESERVATIONS_RELEASED);
2191 spin_unlock(&pr_tmpl->registration_lock);
2194 ret = core_scsi3_update_and_write_aptpl(dev, aptpl);
2198 core_scsi3_put_pr_reg(pr_reg);
2202 unsigned char *core_scsi3_pr_dump_type(int type)
2205 case PR_TYPE_WRITE_EXCLUSIVE:
2206 return "Write Exclusive Access";
2207 case PR_TYPE_EXCLUSIVE_ACCESS:
2208 return "Exclusive Access";
2209 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
2210 return "Write Exclusive Access, Registrants Only";
2211 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
2212 return "Exclusive Access, Registrants Only";
2213 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
2214 return "Write Exclusive Access, All Registrants";
2215 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
2216 return "Exclusive Access, All Registrants";
2221 return "Unknown SPC-3 PR Type";
2224 static sense_reason_t
2225 core_scsi3_pro_reserve(struct se_cmd *cmd, int type, int scope, u64 res_key)
2227 struct se_device *dev = cmd->se_dev;
2228 struct se_session *se_sess = cmd->se_sess;
2229 struct se_lun *se_lun = cmd->se_lun;
2230 struct t10_pr_registration *pr_reg, *pr_res_holder;
2231 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2232 char i_buf[PR_REG_ISID_ID_LEN];
2235 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2237 if (!se_sess || !se_lun) {
2238 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2239 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2242 * Locate the existing *pr_reg via struct se_node_acl pointers
2244 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
2247 pr_err("SPC-3 PR: Unable to locate"
2248 " PR_REGISTERED *pr_reg for RESERVE\n");
2249 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2252 * From spc4r17 Section 5.7.9: Reserving:
2254 * An application client creates a persistent reservation by issuing
2255 * a PERSISTENT RESERVE OUT command with RESERVE service action through
2256 * a registered I_T nexus with the following parameters:
2257 * a) RESERVATION KEY set to the value of the reservation key that is
2258 * registered with the logical unit for the I_T nexus; and
2260 if (res_key != pr_reg->pr_res_key) {
2261 pr_err("SPC-3 PR RESERVE: Received res_key: 0x%016Lx"
2262 " does not match existing SA REGISTER res_key:"
2263 " 0x%016Lx\n", res_key, pr_reg->pr_res_key);
2264 ret = TCM_RESERVATION_CONFLICT;
2265 goto out_put_pr_reg;
2268 * From spc4r17 Section 5.7.9: Reserving:
2271 * b) TYPE field and SCOPE field set to the persistent reservation
2274 * Only one persistent reservation is allowed at a time per logical unit
2275 * and that persistent reservation has a scope of LU_SCOPE.
2277 if (scope != PR_SCOPE_LU_SCOPE) {
2278 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope);
2279 ret = TCM_INVALID_PARAMETER_LIST;
2280 goto out_put_pr_reg;
2283 * See if we have an existing PR reservation holder pointer at
2284 * struct se_device->dev_pr_res_holder in the form struct t10_pr_registration
2287 spin_lock(&dev->dev_reservation_lock);
2288 pr_res_holder = dev->dev_pr_res_holder;
2289 if (pr_res_holder) {
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 (!is_reservation_holder(pr_res_holder, pr_reg)) {
2301 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2302 pr_err("SPC-3 PR: Attempted RESERVE from"
2303 " [%s]: %s while reservation already held by"
2304 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2305 cmd->se_tfo->get_fabric_name(),
2306 se_sess->se_node_acl->initiatorname,
2307 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2308 pr_res_holder->pr_reg_nacl->initiatorname);
2310 spin_unlock(&dev->dev_reservation_lock);
2311 ret = TCM_RESERVATION_CONFLICT;
2312 goto out_put_pr_reg;
2315 * From spc4r17 Section 5.7.9: Reserving:
2317 * If a persistent reservation holder attempts to modify the
2318 * type or scope of an existing persistent reservation, the
2319 * command shall be completed with RESERVATION CONFLICT status.
2321 if ((pr_res_holder->pr_res_type != type) ||
2322 (pr_res_holder->pr_res_scope != scope)) {
2323 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2324 pr_err("SPC-3 PR: Attempted RESERVE from"
2325 " [%s]: %s trying to change TYPE and/or SCOPE,"
2326 " while reservation already held by [%s]: %s,"
2327 " returning RESERVATION_CONFLICT\n",
2328 cmd->se_tfo->get_fabric_name(),
2329 se_sess->se_node_acl->initiatorname,
2330 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2331 pr_res_holder->pr_reg_nacl->initiatorname);
2333 spin_unlock(&dev->dev_reservation_lock);
2334 ret = TCM_RESERVATION_CONFLICT;
2335 goto out_put_pr_reg;
2338 * From spc4r17 Section 5.7.9: Reserving:
2340 * If the device server receives a PERSISTENT RESERVE OUT
2341 * command with RESERVE service action where the TYPE field and
2342 * the SCOPE field contain the same values as the existing type
2343 * and scope from a persistent reservation holder, it shall not
2344 * make any change to the existing persistent reservation and
2345 * shall completethe command with GOOD status.
2347 spin_unlock(&dev->dev_reservation_lock);
2349 goto out_put_pr_reg;
2352 * Otherwise, our *pr_reg becomes the PR reservation holder for said
2353 * TYPE/SCOPE. Also set the received scope and type in *pr_reg.
2355 pr_reg->pr_res_scope = scope;
2356 pr_reg->pr_res_type = type;
2357 pr_reg->pr_res_holder = 1;
2358 dev->dev_pr_res_holder = pr_reg;
2359 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2361 pr_debug("SPC-3 PR [%s] Service Action: RESERVE created new"
2362 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2363 cmd->se_tfo->get_fabric_name(), core_scsi3_pr_dump_type(type),
2364 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2365 pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
2366 cmd->se_tfo->get_fabric_name(),
2367 se_sess->se_node_acl->initiatorname,
2369 spin_unlock(&dev->dev_reservation_lock);
2371 if (pr_tmpl->pr_aptpl_active)
2372 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
2376 core_scsi3_put_pr_reg(pr_reg);
2380 static sense_reason_t
2381 core_scsi3_emulate_pro_reserve(struct se_cmd *cmd, int type, int scope,
2385 case PR_TYPE_WRITE_EXCLUSIVE:
2386 case PR_TYPE_EXCLUSIVE_ACCESS:
2387 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
2388 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
2389 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
2390 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
2391 return core_scsi3_pro_reserve(cmd, type, scope, res_key);
2393 pr_err("SPC-3 PR: Unknown Service Action RESERVE Type:"
2395 return TCM_INVALID_CDB_FIELD;
2400 * Called with struct se_device->dev_reservation_lock held.
2402 static void __core_scsi3_complete_pro_release(
2403 struct se_device *dev,
2404 struct se_node_acl *se_nacl,
2405 struct t10_pr_registration *pr_reg,
2409 const struct target_core_fabric_ops *tfo = se_nacl->se_tpg->se_tpg_tfo;
2410 char i_buf[PR_REG_ISID_ID_LEN];
2411 int pr_res_type = 0, pr_res_scope = 0;
2413 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2414 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2416 * Go ahead and release the current PR reservation holder.
2417 * If an All Registrants reservation is currently active and
2418 * a unregister operation is requested, replace the current
2419 * dev_pr_res_holder with another active registration.
2421 if (dev->dev_pr_res_holder) {
2422 pr_res_type = dev->dev_pr_res_holder->pr_res_type;
2423 pr_res_scope = dev->dev_pr_res_holder->pr_res_scope;
2424 dev->dev_pr_res_holder->pr_res_type = 0;
2425 dev->dev_pr_res_holder->pr_res_scope = 0;
2426 dev->dev_pr_res_holder->pr_res_holder = 0;
2427 dev->dev_pr_res_holder = NULL;
2432 spin_lock(&dev->t10_pr.registration_lock);
2433 list_del_init(&pr_reg->pr_reg_list);
2435 * If the I_T nexus is a reservation holder, the persistent reservation
2436 * is of an all registrants type, and the I_T nexus is the last remaining
2437 * registered I_T nexus, then the device server shall also release the
2438 * persistent reservation.
2440 if (!list_empty(&dev->t10_pr.registration_list) &&
2441 ((pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2442 (pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))) {
2443 dev->dev_pr_res_holder =
2444 list_entry(dev->t10_pr.registration_list.next,
2445 struct t10_pr_registration, pr_reg_list);
2446 dev->dev_pr_res_holder->pr_res_type = pr_res_type;
2447 dev->dev_pr_res_holder->pr_res_scope = pr_res_scope;
2448 dev->dev_pr_res_holder->pr_res_holder = 1;
2450 spin_unlock(&dev->t10_pr.registration_lock);
2452 if (!dev->dev_pr_res_holder) {
2453 pr_debug("SPC-3 PR [%s] Service Action: %s RELEASE cleared"
2454 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2455 tfo->get_fabric_name(), (explicit) ? "explicit" :
2456 "implicit", core_scsi3_pr_dump_type(pr_res_type),
2457 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2459 pr_debug("SPC-3 PR [%s] RELEASE Node: %s%s\n",
2460 tfo->get_fabric_name(), se_nacl->initiatorname,
2463 * Clear TYPE and SCOPE for the next PROUT Service Action: RESERVE
2465 pr_reg->pr_res_holder = pr_reg->pr_res_type = pr_reg->pr_res_scope = 0;
2468 static sense_reason_t
2469 core_scsi3_emulate_pro_release(struct se_cmd *cmd, int type, int scope,
2472 struct se_device *dev = cmd->se_dev;
2473 struct se_session *se_sess = cmd->se_sess;
2474 struct se_lun *se_lun = cmd->se_lun;
2475 struct t10_pr_registration *pr_reg, *pr_reg_p, *pr_res_holder;
2476 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2477 sense_reason_t ret = 0;
2479 if (!se_sess || !se_lun) {
2480 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2481 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2484 * Locate the existing *pr_reg via struct se_node_acl pointers
2486 pr_reg = core_scsi3_locate_pr_reg(dev, se_sess->se_node_acl, se_sess);
2488 pr_err("SPC-3 PR: Unable to locate"
2489 " PR_REGISTERED *pr_reg for RELEASE\n");
2490 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2493 * From spc4r17 Section 5.7.11.2 Releasing:
2495 * If there is no persistent reservation or in response to a persistent
2496 * reservation release request from a registered I_T nexus that is not a
2497 * persistent reservation holder (see 5.7.10), the device server shall
2500 * a) Not release the persistent reservation, if any;
2501 * b) Not remove any registrations; and
2502 * c) Complete the command with GOOD status.
2504 spin_lock(&dev->dev_reservation_lock);
2505 pr_res_holder = dev->dev_pr_res_holder;
2506 if (!pr_res_holder) {
2508 * No persistent reservation, return GOOD status.
2510 spin_unlock(&dev->dev_reservation_lock);
2511 goto out_put_pr_reg;
2514 if (!is_reservation_holder(pr_res_holder, pr_reg)) {
2516 * Release request from a registered I_T nexus that is not a
2517 * persistent reservation holder. return GOOD status.
2519 spin_unlock(&dev->dev_reservation_lock);
2520 goto out_put_pr_reg;
2524 * From spc4r17 Section 5.7.11.2 Releasing:
2526 * Only the persistent reservation holder (see 5.7.10) is allowed to
2527 * release a persistent reservation.
2529 * An application client releases the persistent reservation by issuing
2530 * a PERSISTENT RESERVE OUT command with RELEASE service action through
2531 * an I_T nexus that is a persistent reservation holder with the
2532 * following parameters:
2534 * a) RESERVATION KEY field set to the value of the reservation key
2535 * that is registered with the logical unit for the I_T nexus;
2537 if (res_key != pr_reg->pr_res_key) {
2538 pr_err("SPC-3 PR RELEASE: Received res_key: 0x%016Lx"
2539 " does not match existing SA REGISTER res_key:"
2540 " 0x%016Lx\n", res_key, pr_reg->pr_res_key);
2541 spin_unlock(&dev->dev_reservation_lock);
2542 ret = TCM_RESERVATION_CONFLICT;
2543 goto out_put_pr_reg;
2546 * From spc4r17 Section 5.7.11.2 Releasing and above:
2548 * b) TYPE field and SCOPE field set to match the persistent
2549 * reservation being released.
2551 if ((pr_res_holder->pr_res_type != type) ||
2552 (pr_res_holder->pr_res_scope != scope)) {
2553 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2554 pr_err("SPC-3 PR RELEASE: Attempted to release"
2555 " reservation from [%s]: %s with different TYPE "
2556 "and/or SCOPE while reservation already held by"
2557 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2558 cmd->se_tfo->get_fabric_name(),
2559 se_sess->se_node_acl->initiatorname,
2560 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2561 pr_res_holder->pr_reg_nacl->initiatorname);
2563 spin_unlock(&dev->dev_reservation_lock);
2564 ret = TCM_RESERVATION_CONFLICT;
2565 goto out_put_pr_reg;
2568 * In response to a persistent reservation release request from the
2569 * persistent reservation holder the device server shall perform a
2570 * release by doing the following as an uninterrupted series of actions:
2571 * a) Release the persistent reservation;
2572 * b) Not remove any registration(s);
2573 * c) If the released persistent reservation is a registrants only type
2574 * or all registrants type persistent reservation,
2575 * the device server shall establish a unit attention condition for
2576 * the initiator port associated with every regis-
2577 * tered I_T nexus other than I_T nexus on which the PERSISTENT
2578 * RESERVE OUT command with RELEASE service action was received,
2579 * with the additional sense code set to RESERVATIONS RELEASED; and
2580 * d) If the persistent reservation is of any other type, the device
2581 * server shall not establish a unit attention condition.
2583 __core_scsi3_complete_pro_release(dev, se_sess->se_node_acl,
2586 spin_unlock(&dev->dev_reservation_lock);
2588 if ((type != PR_TYPE_WRITE_EXCLUSIVE_REGONLY) &&
2589 (type != PR_TYPE_EXCLUSIVE_ACCESS_REGONLY) &&
2590 (type != PR_TYPE_WRITE_EXCLUSIVE_ALLREG) &&
2591 (type != PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
2593 * If no UNIT ATTENTION conditions will be established for
2594 * PR_TYPE_WRITE_EXCLUSIVE or PR_TYPE_EXCLUSIVE_ACCESS
2595 * go ahead and check for APTPL=1 update+write below
2600 spin_lock(&pr_tmpl->registration_lock);
2601 list_for_each_entry(pr_reg_p, &pr_tmpl->registration_list,
2604 * Do not establish a UNIT ATTENTION condition
2605 * for the calling I_T Nexus
2607 if (pr_reg_p == pr_reg)
2610 core_scsi3_ua_allocate(pr_reg_p->pr_reg_nacl,
2611 pr_reg_p->pr_res_mapped_lun,
2612 0x2A, ASCQ_2AH_RESERVATIONS_RELEASED);
2614 spin_unlock(&pr_tmpl->registration_lock);
2617 if (pr_tmpl->pr_aptpl_active)
2618 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
2621 core_scsi3_put_pr_reg(pr_reg);
2625 static sense_reason_t
2626 core_scsi3_emulate_pro_clear(struct se_cmd *cmd, u64 res_key)
2628 struct se_device *dev = cmd->se_dev;
2629 struct se_node_acl *pr_reg_nacl;
2630 struct se_session *se_sess = cmd->se_sess;
2631 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2632 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_reg_n, *pr_res_holder;
2633 u32 pr_res_mapped_lun = 0;
2634 int calling_it_nexus = 0;
2636 * Locate the existing *pr_reg via struct se_node_acl pointers
2638 pr_reg_n = core_scsi3_locate_pr_reg(cmd->se_dev,
2639 se_sess->se_node_acl, se_sess);
2641 pr_err("SPC-3 PR: Unable to locate"
2642 " PR_REGISTERED *pr_reg for CLEAR\n");
2643 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2646 * From spc4r17 section 5.7.11.6, Clearing:
2648 * Any application client may release the persistent reservation and
2649 * remove all registrations from a device server by issuing a
2650 * PERSISTENT RESERVE OUT command with CLEAR service action through a
2651 * registered I_T nexus with the following parameter:
2653 * a) RESERVATION KEY field set to the value of the reservation key
2654 * that is registered with the logical unit for the I_T nexus.
2656 if (res_key != pr_reg_n->pr_res_key) {
2657 pr_err("SPC-3 PR REGISTER: Received"
2658 " res_key: 0x%016Lx does not match"
2659 " existing SA REGISTER res_key:"
2660 " 0x%016Lx\n", res_key, pr_reg_n->pr_res_key);
2661 core_scsi3_put_pr_reg(pr_reg_n);
2662 return TCM_RESERVATION_CONFLICT;
2665 * a) Release the persistent reservation, if any;
2667 spin_lock(&dev->dev_reservation_lock);
2668 pr_res_holder = dev->dev_pr_res_holder;
2669 if (pr_res_holder) {
2670 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2671 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
2672 pr_res_holder, 0, 0);
2674 spin_unlock(&dev->dev_reservation_lock);
2676 * b) Remove all registration(s) (see spc4r17 5.7.7);
2678 spin_lock(&pr_tmpl->registration_lock);
2679 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2680 &pr_tmpl->registration_list, pr_reg_list) {
2682 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2683 pr_reg_nacl = pr_reg->pr_reg_nacl;
2684 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2685 __core_scsi3_free_registration(dev, pr_reg, NULL,
2688 * e) Establish a unit attention condition for the initiator
2689 * port associated with every registered I_T nexus other
2690 * than the I_T nexus on which the PERSISTENT RESERVE OUT
2691 * command with CLEAR service action was received, with the
2692 * additional sense code set to RESERVATIONS PREEMPTED.
2694 if (!calling_it_nexus)
2695 core_scsi3_ua_allocate(pr_reg_nacl, pr_res_mapped_lun,
2696 0x2A, ASCQ_2AH_RESERVATIONS_PREEMPTED);
2698 spin_unlock(&pr_tmpl->registration_lock);
2700 pr_debug("SPC-3 PR [%s] Service Action: CLEAR complete\n",
2701 cmd->se_tfo->get_fabric_name());
2703 core_scsi3_update_and_write_aptpl(cmd->se_dev, false);
2705 core_scsi3_pr_generation(dev);
2710 * Called with struct se_device->dev_reservation_lock held.
2712 static void __core_scsi3_complete_pro_preempt(
2713 struct se_device *dev,
2714 struct t10_pr_registration *pr_reg,
2715 struct list_head *preempt_and_abort_list,
2718 enum preempt_type preempt_type)
2720 struct se_node_acl *nacl = pr_reg->pr_reg_nacl;
2721 const struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
2722 char i_buf[PR_REG_ISID_ID_LEN];
2724 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2725 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2727 * Do an implicit RELEASE of the existing reservation.
2729 if (dev->dev_pr_res_holder)
2730 __core_scsi3_complete_pro_release(dev, nacl,
2731 dev->dev_pr_res_holder, 0, 0);
2733 dev->dev_pr_res_holder = pr_reg;
2734 pr_reg->pr_res_holder = 1;
2735 pr_reg->pr_res_type = type;
2736 pr_reg->pr_res_scope = scope;
2738 pr_debug("SPC-3 PR [%s] Service Action: PREEMPT%s created new"
2739 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2740 tfo->get_fabric_name(), (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "",
2741 core_scsi3_pr_dump_type(type),
2742 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2743 pr_debug("SPC-3 PR [%s] PREEMPT%s from Node: %s%s\n",
2744 tfo->get_fabric_name(), (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "",
2745 nacl->initiatorname, i_buf);
2747 * For PREEMPT_AND_ABORT, add the preempting reservation's
2748 * struct t10_pr_registration to the list that will be compared
2749 * against received CDBs..
2751 if (preempt_and_abort_list)
2752 list_add_tail(&pr_reg->pr_reg_abort_list,
2753 preempt_and_abort_list);
2756 static void core_scsi3_release_preempt_and_abort(
2757 struct list_head *preempt_and_abort_list,
2758 struct t10_pr_registration *pr_reg_holder)
2760 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
2762 list_for_each_entry_safe(pr_reg, pr_reg_tmp, preempt_and_abort_list,
2763 pr_reg_abort_list) {
2765 list_del(&pr_reg->pr_reg_abort_list);
2766 if (pr_reg_holder == pr_reg)
2768 if (pr_reg->pr_res_holder) {
2769 pr_warn("pr_reg->pr_res_holder still set\n");
2773 pr_reg->pr_reg_deve = NULL;
2774 pr_reg->pr_reg_nacl = NULL;
2775 kmem_cache_free(t10_pr_reg_cache, pr_reg);
2779 static sense_reason_t
2780 core_scsi3_pro_preempt(struct se_cmd *cmd, int type, int scope, u64 res_key,
2781 u64 sa_res_key, enum preempt_type preempt_type)
2783 struct se_device *dev = cmd->se_dev;
2784 struct se_node_acl *pr_reg_nacl;
2785 struct se_session *se_sess = cmd->se_sess;
2786 LIST_HEAD(preempt_and_abort_list);
2787 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_reg_n, *pr_res_holder;
2788 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2789 u32 pr_res_mapped_lun = 0;
2790 int all_reg = 0, calling_it_nexus = 0;
2791 bool sa_res_key_unmatched = sa_res_key != 0;
2792 int prh_type = 0, prh_scope = 0;
2795 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2797 pr_reg_n = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
2800 pr_err("SPC-3 PR: Unable to locate"
2801 " PR_REGISTERED *pr_reg for PREEMPT%s\n",
2802 (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "");
2803 return TCM_RESERVATION_CONFLICT;
2805 if (pr_reg_n->pr_res_key != res_key) {
2806 core_scsi3_put_pr_reg(pr_reg_n);
2807 return TCM_RESERVATION_CONFLICT;
2809 if (scope != PR_SCOPE_LU_SCOPE) {
2810 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope);
2811 core_scsi3_put_pr_reg(pr_reg_n);
2812 return TCM_INVALID_PARAMETER_LIST;
2815 spin_lock(&dev->dev_reservation_lock);
2816 pr_res_holder = dev->dev_pr_res_holder;
2817 if (pr_res_holder &&
2818 ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2819 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)))
2822 if (!all_reg && !sa_res_key) {
2823 spin_unlock(&dev->dev_reservation_lock);
2824 core_scsi3_put_pr_reg(pr_reg_n);
2825 return TCM_INVALID_PARAMETER_LIST;
2828 * From spc4r17, section 5.7.11.4.4 Removing Registrations:
2830 * If the SERVICE ACTION RESERVATION KEY field does not identify a
2831 * persistent reservation holder or there is no persistent reservation
2832 * holder (i.e., there is no persistent reservation), then the device
2833 * server shall perform a preempt by doing the following in an
2834 * uninterrupted series of actions. (See below..)
2836 if (!pr_res_holder || (pr_res_holder->pr_res_key != sa_res_key)) {
2838 * No existing or SA Reservation Key matching reservations..
2840 * PROUT SA PREEMPT with All Registrant type reservations are
2841 * allowed to be processed without a matching SA Reservation Key
2843 spin_lock(&pr_tmpl->registration_lock);
2844 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2845 &pr_tmpl->registration_list, pr_reg_list) {
2847 * Removing of registrations in non all registrants
2848 * type reservations without a matching SA reservation
2851 * a) Remove the registrations for all I_T nexuses
2852 * specified by the SERVICE ACTION RESERVATION KEY
2854 * b) Ignore the contents of the SCOPE and TYPE fields;
2855 * c) Process tasks as defined in 5.7.1; and
2856 * d) Establish a unit attention condition for the
2857 * initiator port associated with every I_T nexus
2858 * that lost its registration other than the I_T
2859 * nexus on which the PERSISTENT RESERVE OUT command
2860 * was received, with the additional sense code set
2861 * to REGISTRATIONS PREEMPTED.
2864 if (pr_reg->pr_res_key != sa_res_key)
2866 sa_res_key_unmatched = false;
2868 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2869 pr_reg_nacl = pr_reg->pr_reg_nacl;
2870 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2871 __core_scsi3_free_registration(dev, pr_reg,
2872 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list :
2873 NULL, calling_it_nexus);
2876 * Case for any existing all registrants type
2877 * reservation, follow logic in spc4r17 section
2878 * 5.7.11.4 Preempting, Table 52 and Figure 7.
2880 * For a ZERO SA Reservation key, release
2881 * all other registrations and do an implicit
2882 * release of active persistent reservation.
2884 * For a non-ZERO SA Reservation key, only
2885 * release the matching reservation key from
2889 (pr_reg->pr_res_key != sa_res_key))
2891 sa_res_key_unmatched = false;
2893 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2894 if (calling_it_nexus)
2897 pr_reg_nacl = pr_reg->pr_reg_nacl;
2898 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2899 __core_scsi3_free_registration(dev, pr_reg,
2900 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list :
2903 if (!calling_it_nexus)
2904 core_scsi3_ua_allocate(pr_reg_nacl,
2905 pr_res_mapped_lun, 0x2A,
2906 ASCQ_2AH_REGISTRATIONS_PREEMPTED);
2908 spin_unlock(&pr_tmpl->registration_lock);
2910 * If a PERSISTENT RESERVE OUT with a PREEMPT service action or
2911 * a PREEMPT AND ABORT service action sets the SERVICE ACTION
2912 * RESERVATION KEY field to a value that does not match any
2913 * registered reservation key, then the device server shall
2914 * complete the command with RESERVATION CONFLICT status.
2916 if (sa_res_key_unmatched) {
2917 spin_unlock(&dev->dev_reservation_lock);
2918 core_scsi3_put_pr_reg(pr_reg_n);
2919 return TCM_RESERVATION_CONFLICT;
2922 * For an existing all registrants type reservation
2923 * with a zero SA rservation key, preempt the existing
2924 * reservation with the new PR type and scope.
2926 if (pr_res_holder && all_reg && !(sa_res_key)) {
2927 __core_scsi3_complete_pro_preempt(dev, pr_reg_n,
2928 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
2929 type, scope, preempt_type);
2931 if (preempt_type == PREEMPT_AND_ABORT)
2932 core_scsi3_release_preempt_and_abort(
2933 &preempt_and_abort_list, pr_reg_n);
2935 spin_unlock(&dev->dev_reservation_lock);
2937 if (pr_tmpl->pr_aptpl_active)
2938 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
2940 core_scsi3_put_pr_reg(pr_reg_n);
2941 core_scsi3_pr_generation(cmd->se_dev);
2945 * The PREEMPTing SA reservation key matches that of the
2946 * existing persistent reservation, first, we check if
2947 * we are preempting our own reservation.
2948 * From spc4r17, section 5.7.11.4.3 Preempting
2949 * persistent reservations and registration handling
2951 * If an all registrants persistent reservation is not
2952 * present, it is not an error for the persistent
2953 * reservation holder to preempt itself (i.e., a
2954 * PERSISTENT RESERVE OUT with a PREEMPT service action
2955 * or a PREEMPT AND ABORT service action with the
2956 * SERVICE ACTION RESERVATION KEY value equal to the
2957 * persistent reservation holder's reservation key that
2958 * is received from the persistent reservation holder).
2959 * In that case, the device server shall establish the
2960 * new persistent reservation and maintain the
2963 prh_type = pr_res_holder->pr_res_type;
2964 prh_scope = pr_res_holder->pr_res_scope;
2966 * If the SERVICE ACTION RESERVATION KEY field identifies a
2967 * persistent reservation holder (see 5.7.10), the device
2968 * server shall perform a preempt by doing the following as
2969 * an uninterrupted series of actions:
2971 * a) Release the persistent reservation for the holder
2972 * identified by the SERVICE ACTION RESERVATION KEY field;
2974 if (pr_reg_n != pr_res_holder)
2975 __core_scsi3_complete_pro_release(dev,
2976 pr_res_holder->pr_reg_nacl,
2977 dev->dev_pr_res_holder, 0, 0);
2979 * b) Remove the registrations for all I_T nexuses identified
2980 * by the SERVICE ACTION RESERVATION KEY field, except the
2981 * I_T nexus that is being used for the PERSISTENT RESERVE
2982 * OUT command. If an all registrants persistent reservation
2983 * is present and the SERVICE ACTION RESERVATION KEY field
2984 * is set to zero, then all registrations shall be removed
2985 * except for that of the I_T nexus that is being used for
2986 * the PERSISTENT RESERVE OUT command;
2988 spin_lock(&pr_tmpl->registration_lock);
2989 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2990 &pr_tmpl->registration_list, pr_reg_list) {
2992 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2993 if (calling_it_nexus)
2996 if (pr_reg->pr_res_key != sa_res_key)
2999 pr_reg_nacl = pr_reg->pr_reg_nacl;
3000 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
3001 __core_scsi3_free_registration(dev, pr_reg,
3002 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
3005 * e) Establish a unit attention condition for the initiator
3006 * port associated with every I_T nexus that lost its
3007 * persistent reservation and/or registration, with the
3008 * additional sense code set to REGISTRATIONS PREEMPTED;
3010 core_scsi3_ua_allocate(pr_reg_nacl, pr_res_mapped_lun, 0x2A,
3011 ASCQ_2AH_REGISTRATIONS_PREEMPTED);
3013 spin_unlock(&pr_tmpl->registration_lock);
3015 * c) Establish a persistent reservation for the preempting
3016 * I_T nexus using the contents of the SCOPE and TYPE fields;
3018 __core_scsi3_complete_pro_preempt(dev, pr_reg_n,
3019 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
3020 type, scope, preempt_type);
3022 * d) Process tasks as defined in 5.7.1;
3024 * f) If the type or scope has changed, then for every I_T nexus
3025 * whose reservation key was not removed, except for the I_T
3026 * nexus on which the PERSISTENT RESERVE OUT command was
3027 * received, the device server shall establish a unit
3028 * attention condition for the initiator port associated with
3029 * that I_T nexus, with the additional sense code set to
3030 * RESERVATIONS RELEASED. If the type or scope have not
3031 * changed, then no unit attention condition(s) shall be
3032 * established for this reason.
3034 if ((prh_type != type) || (prh_scope != scope)) {
3035 spin_lock(&pr_tmpl->registration_lock);
3036 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3037 &pr_tmpl->registration_list, pr_reg_list) {
3039 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
3040 if (calling_it_nexus)
3043 core_scsi3_ua_allocate(pr_reg->pr_reg_nacl,
3044 pr_reg->pr_res_mapped_lun, 0x2A,
3045 ASCQ_2AH_RESERVATIONS_RELEASED);
3047 spin_unlock(&pr_tmpl->registration_lock);
3049 spin_unlock(&dev->dev_reservation_lock);
3051 * Call LUN_RESET logic upon list of struct t10_pr_registration,
3052 * All received CDBs for the matching existing reservation and
3053 * registrations undergo ABORT_TASK logic.
3055 * From there, core_scsi3_release_preempt_and_abort() will
3056 * release every registration in the list (which have already
3057 * been removed from the primary pr_reg list), except the
3058 * new persistent reservation holder, the calling Initiator Port.
3060 if (preempt_type == PREEMPT_AND_ABORT) {
3061 core_tmr_lun_reset(dev, NULL, &preempt_and_abort_list, cmd);
3062 core_scsi3_release_preempt_and_abort(&preempt_and_abort_list,
3066 if (pr_tmpl->pr_aptpl_active)
3067 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
3069 core_scsi3_put_pr_reg(pr_reg_n);
3070 core_scsi3_pr_generation(cmd->se_dev);
3074 static sense_reason_t
3075 core_scsi3_emulate_pro_preempt(struct se_cmd *cmd, int type, int scope,
3076 u64 res_key, u64 sa_res_key, enum preempt_type preempt_type)
3079 case PR_TYPE_WRITE_EXCLUSIVE:
3080 case PR_TYPE_EXCLUSIVE_ACCESS:
3081 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
3082 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
3083 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
3084 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
3085 return core_scsi3_pro_preempt(cmd, type, scope, res_key,
3086 sa_res_key, preempt_type);
3088 pr_err("SPC-3 PR: Unknown Service Action PREEMPT%s"
3089 " Type: 0x%02x\n", (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "", type);
3090 return TCM_INVALID_CDB_FIELD;
3095 static sense_reason_t
3096 core_scsi3_emulate_pro_register_and_move(struct se_cmd *cmd, u64 res_key,
3097 u64 sa_res_key, int aptpl, int unreg)
3099 struct se_session *se_sess = cmd->se_sess;
3100 struct se_device *dev = cmd->se_dev;
3101 struct se_dev_entry *dest_se_deve = NULL;
3102 struct se_lun *se_lun = cmd->se_lun;
3103 struct se_node_acl *pr_res_nacl, *pr_reg_nacl, *dest_node_acl = NULL;
3104 struct se_port *se_port;
3105 struct se_portal_group *se_tpg, *dest_se_tpg = NULL;
3106 const struct target_core_fabric_ops *dest_tf_ops = NULL, *tf_ops;
3107 struct t10_pr_registration *pr_reg, *pr_res_holder, *dest_pr_reg;
3108 struct t10_reservation *pr_tmpl = &dev->t10_pr;
3110 unsigned char *initiator_str;
3111 char *iport_ptr = NULL, i_buf[PR_REG_ISID_ID_LEN];
3112 u32 tid_len, tmp_tid_len;
3113 int new_reg = 0, type, scope, matching_iname;
3115 unsigned short rtpi;
3116 unsigned char proto_ident;
3118 if (!se_sess || !se_lun) {
3119 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
3120 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3123 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
3124 se_tpg = se_sess->se_tpg;
3125 tf_ops = se_tpg->se_tpg_tfo;
3127 * Follow logic from spc4r17 Section 5.7.8, Table 50 --
3128 * Register behaviors for a REGISTER AND MOVE service action
3130 * Locate the existing *pr_reg via struct se_node_acl pointers
3132 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
3135 pr_err("SPC-3 PR: Unable to locate PR_REGISTERED"
3136 " *pr_reg for REGISTER_AND_MOVE\n");
3137 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3140 * The provided reservation key much match the existing reservation key
3141 * provided during this initiator's I_T nexus registration.
3143 if (res_key != pr_reg->pr_res_key) {
3144 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received"
3145 " res_key: 0x%016Lx does not match existing SA REGISTER"
3146 " res_key: 0x%016Lx\n", res_key, pr_reg->pr_res_key);
3147 ret = TCM_RESERVATION_CONFLICT;
3148 goto out_put_pr_reg;
3151 * The service active reservation key needs to be non zero
3154 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received zero"
3156 ret = TCM_INVALID_PARAMETER_LIST;
3157 goto out_put_pr_reg;
3161 * Determine the Relative Target Port Identifier where the reservation
3162 * will be moved to for the TransportID containing SCSI initiator WWN
3165 buf = transport_kmap_data_sg(cmd);
3167 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3168 goto out_put_pr_reg;
3171 rtpi = (buf[18] & 0xff) << 8;
3172 rtpi |= buf[19] & 0xff;
3173 tid_len = (buf[20] & 0xff) << 24;
3174 tid_len |= (buf[21] & 0xff) << 16;
3175 tid_len |= (buf[22] & 0xff) << 8;
3176 tid_len |= buf[23] & 0xff;
3177 transport_kunmap_data_sg(cmd);
3180 if ((tid_len + 24) != cmd->data_length) {
3181 pr_err("SPC-3 PR: Illegal tid_len: %u + 24 byte header"
3182 " does not equal CDB data_length: %u\n", tid_len,
3184 ret = TCM_INVALID_PARAMETER_LIST;
3185 goto out_put_pr_reg;
3188 spin_lock(&dev->se_port_lock);
3189 list_for_each_entry(se_port, &dev->dev_sep_list, sep_list) {
3190 if (se_port->sep_rtpi != rtpi)
3192 dest_se_tpg = se_port->sep_tpg;
3195 dest_tf_ops = dest_se_tpg->se_tpg_tfo;
3199 atomic_inc_mb(&dest_se_tpg->tpg_pr_ref_count);
3200 spin_unlock(&dev->se_port_lock);
3202 if (core_scsi3_tpg_depend_item(dest_se_tpg)) {
3203 pr_err("core_scsi3_tpg_depend_item() failed"
3204 " for dest_se_tpg\n");
3205 atomic_dec_mb(&dest_se_tpg->tpg_pr_ref_count);
3206 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3207 goto out_put_pr_reg;
3210 spin_lock(&dev->se_port_lock);
3213 spin_unlock(&dev->se_port_lock);
3215 if (!dest_se_tpg || !dest_tf_ops) {
3216 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3217 " fabric ops from Relative Target Port Identifier:"
3219 ret = TCM_INVALID_PARAMETER_LIST;
3220 goto out_put_pr_reg;
3223 buf = transport_kmap_data_sg(cmd);
3225 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3226 goto out_put_pr_reg;
3228 proto_ident = (buf[24] & 0x0f);
3230 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Extracted Protocol Identifier:"
3231 " 0x%02x\n", proto_ident);
3233 if (proto_ident != dest_tf_ops->get_fabric_proto_ident(dest_se_tpg)) {
3234 pr_err("SPC-3 PR REGISTER_AND_MOVE: Received"
3235 " proto_ident: 0x%02x does not match ident: 0x%02x"
3236 " from fabric: %s\n", proto_ident,
3237 dest_tf_ops->get_fabric_proto_ident(dest_se_tpg),
3238 dest_tf_ops->get_fabric_name());
3239 ret = TCM_INVALID_PARAMETER_LIST;
3242 if (dest_tf_ops->tpg_parse_pr_out_transport_id == NULL) {
3243 pr_err("SPC-3 PR REGISTER_AND_MOVE: Fabric does not"
3244 " containg a valid tpg_parse_pr_out_transport_id"
3245 " function pointer\n");
3246 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3249 initiator_str = dest_tf_ops->tpg_parse_pr_out_transport_id(dest_se_tpg,
3250 (const char *)&buf[24], &tmp_tid_len, &iport_ptr);
3251 if (!initiator_str) {
3252 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3253 " initiator_str from Transport ID\n");
3254 ret = TCM_INVALID_PARAMETER_LIST;
3258 transport_kunmap_data_sg(cmd);
3261 pr_debug("SPC-3 PR [%s] Extracted initiator %s identifier: %s"
3262 " %s\n", dest_tf_ops->get_fabric_name(), (iport_ptr != NULL) ?
3263 "port" : "device", initiator_str, (iport_ptr != NULL) ?
3266 * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3267 * action specifies a TransportID that is the same as the initiator port
3268 * of the I_T nexus for the command received, then the command shall
3269 * be terminated with CHECK CONDITION status, with the sense key set to
3270 * ILLEGAL REQUEST, and the additional sense code set to INVALID FIELD
3271 * IN PARAMETER LIST.
3273 pr_reg_nacl = pr_reg->pr_reg_nacl;
3274 matching_iname = (!strcmp(initiator_str,
3275 pr_reg_nacl->initiatorname)) ? 1 : 0;
3276 if (!matching_iname)
3277 goto after_iport_check;
3279 if (!iport_ptr || !pr_reg->isid_present_at_reg) {
3280 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s"
3281 " matches: %s on received I_T Nexus\n", initiator_str,
3282 pr_reg_nacl->initiatorname);
3283 ret = TCM_INVALID_PARAMETER_LIST;
3286 if (!strcmp(iport_ptr, pr_reg->pr_reg_isid)) {
3287 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s %s"
3288 " matches: %s %s on received I_T Nexus\n",
3289 initiator_str, iport_ptr, pr_reg_nacl->initiatorname,
3290 pr_reg->pr_reg_isid);
3291 ret = TCM_INVALID_PARAMETER_LIST;
3296 * Locate the destination struct se_node_acl from the received Transport ID
3298 spin_lock_irq(&dest_se_tpg->acl_node_lock);
3299 dest_node_acl = __core_tpg_get_initiator_node_acl(dest_se_tpg,
3302 atomic_inc_mb(&dest_node_acl->acl_pr_ref_count);
3303 spin_unlock_irq(&dest_se_tpg->acl_node_lock);
3305 if (!dest_node_acl) {
3306 pr_err("Unable to locate %s dest_node_acl for"
3307 " TransportID%s\n", dest_tf_ops->get_fabric_name(),
3309 ret = TCM_INVALID_PARAMETER_LIST;
3313 if (core_scsi3_nodeacl_depend_item(dest_node_acl)) {
3314 pr_err("core_scsi3_nodeacl_depend_item() for"
3315 " dest_node_acl\n");
3316 atomic_dec_mb(&dest_node_acl->acl_pr_ref_count);
3317 dest_node_acl = NULL;
3318 ret = TCM_INVALID_PARAMETER_LIST;
3322 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Found %s dest_node_acl:"
3323 " %s from TransportID\n", dest_tf_ops->get_fabric_name(),
3324 dest_node_acl->initiatorname);
3327 * Locate the struct se_dev_entry pointer for the matching RELATIVE TARGET
3330 dest_se_deve = core_get_se_deve_from_rtpi(dest_node_acl, rtpi);
3331 if (!dest_se_deve) {
3332 pr_err("Unable to locate %s dest_se_deve from RTPI:"
3333 " %hu\n", dest_tf_ops->get_fabric_name(), rtpi);
3334 ret = TCM_INVALID_PARAMETER_LIST;
3338 if (core_scsi3_lunacl_depend_item(dest_se_deve)) {
3339 pr_err("core_scsi3_lunacl_depend_item() failed\n");
3340 atomic_dec_mb(&dest_se_deve->pr_ref_count);
3341 dest_se_deve = NULL;
3342 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3346 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Located %s node %s LUN"
3347 " ACL for dest_se_deve->mapped_lun: %u\n",
3348 dest_tf_ops->get_fabric_name(), dest_node_acl->initiatorname,
3349 dest_se_deve->mapped_lun);
3352 * A persistent reservation needs to already existing in order to
3353 * successfully complete the REGISTER_AND_MOVE service action..
3355 spin_lock(&dev->dev_reservation_lock);
3356 pr_res_holder = dev->dev_pr_res_holder;
3357 if (!pr_res_holder) {
3358 pr_warn("SPC-3 PR REGISTER_AND_MOVE: No reservation"
3359 " currently held\n");
3360 spin_unlock(&dev->dev_reservation_lock);
3361 ret = TCM_INVALID_CDB_FIELD;
3365 * The received on I_T Nexus must be the reservation holder.
3367 * From spc4r17 section 5.7.8 Table 50 --
3368 * Register behaviors for a REGISTER AND MOVE service action
3370 if (!is_reservation_holder(pr_res_holder, pr_reg)) {
3371 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Calling I_T"
3372 " Nexus is not reservation holder\n");
3373 spin_unlock(&dev->dev_reservation_lock);
3374 ret = TCM_RESERVATION_CONFLICT;
3378 * From spc4r17 section 5.7.8: registering and moving reservation
3380 * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3381 * action is received and the established persistent reservation is a
3382 * Write Exclusive - All Registrants type or Exclusive Access -
3383 * All Registrants type reservation, then the command shall be completed
3384 * with RESERVATION CONFLICT status.
3386 if ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
3387 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
3388 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Unable to move"
3389 " reservation for type: %s\n",
3390 core_scsi3_pr_dump_type(pr_res_holder->pr_res_type));
3391 spin_unlock(&dev->dev_reservation_lock);
3392 ret = TCM_RESERVATION_CONFLICT;
3395 pr_res_nacl = pr_res_holder->pr_reg_nacl;
3397 * b) Ignore the contents of the (received) SCOPE and TYPE fields;
3399 type = pr_res_holder->pr_res_type;
3400 scope = pr_res_holder->pr_res_type;
3402 * c) Associate the reservation key specified in the SERVICE ACTION
3403 * RESERVATION KEY field with the I_T nexus specified as the
3404 * destination of the register and move, where:
3405 * A) The I_T nexus is specified by the TransportID and the
3406 * RELATIVE TARGET PORT IDENTIFIER field (see 6.14.4); and
3407 * B) Regardless of the TransportID format used, the association for
3408 * the initiator port is based on either the initiator port name
3409 * (see 3.1.71) on SCSI transport protocols where port names are
3410 * required or the initiator port identifier (see 3.1.70) on SCSI
3411 * transport protocols where port names are not required;
3412 * d) Register the reservation key specified in the SERVICE ACTION
3413 * RESERVATION KEY field;
3414 * e) Retain the reservation key specified in the SERVICE ACTION
3415 * RESERVATION KEY field and associated information;
3417 * Also, It is not an error for a REGISTER AND MOVE service action to
3418 * register an I_T nexus that is already registered with the same
3419 * reservation key or a different reservation key.
3421 dest_pr_reg = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
3424 if (core_scsi3_alloc_registration(cmd->se_dev,
3425 dest_node_acl, dest_se_deve, iport_ptr,
3426 sa_res_key, 0, aptpl, 2, 1)) {
3427 spin_unlock(&dev->dev_reservation_lock);
3428 ret = TCM_INVALID_PARAMETER_LIST;
3431 dest_pr_reg = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
3436 * f) Release the persistent reservation for the persistent reservation
3437 * holder (i.e., the I_T nexus on which the
3439 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
3440 dev->dev_pr_res_holder, 0, 0);
3442 * g) Move the persistent reservation to the specified I_T nexus using
3443 * the same scope and type as the persistent reservation released in
3446 dev->dev_pr_res_holder = dest_pr_reg;
3447 dest_pr_reg->pr_res_holder = 1;
3448 dest_pr_reg->pr_res_type = type;
3449 pr_reg->pr_res_scope = scope;
3450 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
3452 * Increment PRGeneration for existing registrations..
3455 dest_pr_reg->pr_res_generation = pr_tmpl->pr_generation++;
3456 spin_unlock(&dev->dev_reservation_lock);
3458 pr_debug("SPC-3 PR [%s] Service Action: REGISTER_AND_MOVE"
3459 " created new reservation holder TYPE: %s on object RTPI:"
3460 " %hu PRGeneration: 0x%08x\n", dest_tf_ops->get_fabric_name(),
3461 core_scsi3_pr_dump_type(type), rtpi,
3462 dest_pr_reg->pr_res_generation);
3463 pr_debug("SPC-3 PR Successfully moved reservation from"
3464 " %s Fabric Node: %s%s -> %s Fabric Node: %s %s\n",
3465 tf_ops->get_fabric_name(), pr_reg_nacl->initiatorname,
3466 i_buf, dest_tf_ops->get_fabric_name(),
3467 dest_node_acl->initiatorname, (iport_ptr != NULL) ?
3470 * It is now safe to release configfs group dependencies for destination
3471 * of Transport ID Initiator Device/Port Identifier
3473 core_scsi3_lunacl_undepend_item(dest_se_deve);
3474 core_scsi3_nodeacl_undepend_item(dest_node_acl);
3475 core_scsi3_tpg_undepend_item(dest_se_tpg);
3477 * h) If the UNREG bit is set to one, unregister (see 5.7.11.3) the I_T
3478 * nexus on which PERSISTENT RESERVE OUT command was received.
3481 spin_lock(&pr_tmpl->registration_lock);
3482 __core_scsi3_free_registration(dev, pr_reg, NULL, 1);
3483 spin_unlock(&pr_tmpl->registration_lock);
3485 core_scsi3_put_pr_reg(pr_reg);
3487 core_scsi3_update_and_write_aptpl(cmd->se_dev, aptpl);
3489 transport_kunmap_data_sg(cmd);
3491 core_scsi3_put_pr_reg(dest_pr_reg);
3495 transport_kunmap_data_sg(cmd);
3497 core_scsi3_lunacl_undepend_item(dest_se_deve);
3499 core_scsi3_nodeacl_undepend_item(dest_node_acl);
3500 core_scsi3_tpg_undepend_item(dest_se_tpg);
3503 core_scsi3_put_pr_reg(pr_reg);
3507 static unsigned long long core_scsi3_extract_reservation_key(unsigned char *cdb)
3509 unsigned int __v1, __v2;
3511 __v1 = (cdb[0] << 24) | (cdb[1] << 16) | (cdb[2] << 8) | cdb[3];
3512 __v2 = (cdb[4] << 24) | (cdb[5] << 16) | (cdb[6] << 8) | cdb[7];
3514 return ((unsigned long long)__v2) | (unsigned long long)__v1 << 32;
3518 * See spc4r17 section 6.14 Table 170
3521 target_scsi3_emulate_pr_out(struct se_cmd *cmd)
3523 struct se_device *dev = cmd->se_dev;
3524 unsigned char *cdb = &cmd->t_task_cdb[0];
3526 u64 res_key, sa_res_key;
3527 int sa, scope, type, aptpl;
3528 int spec_i_pt = 0, all_tg_pt = 0, unreg = 0;
3532 * Following spc2r20 5.5.1 Reservations overview:
3534 * If a logical unit has been reserved by any RESERVE command and is
3535 * still reserved by any initiator, all PERSISTENT RESERVE IN and all
3536 * PERSISTENT RESERVE OUT commands shall conflict regardless of
3537 * initiator or service action and shall terminate with a RESERVATION
3540 if (cmd->se_dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS) {
3541 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
3542 " SPC-2 reservation is held, returning"
3543 " RESERVATION_CONFLICT\n");
3544 return TCM_RESERVATION_CONFLICT;
3548 * FIXME: A NULL struct se_session pointer means an this is not coming from
3549 * a $FABRIC_MOD's nexus, but from internal passthrough ops.
3552 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3554 if (cmd->data_length < 24) {
3555 pr_warn("SPC-PR: Received PR OUT parameter list"
3556 " length too small: %u\n", cmd->data_length);
3557 return TCM_INVALID_PARAMETER_LIST;
3561 * From the PERSISTENT_RESERVE_OUT command descriptor block (CDB)
3563 sa = (cdb[1] & 0x1f);
3564 scope = (cdb[2] & 0xf0);
3565 type = (cdb[2] & 0x0f);
3567 buf = transport_kmap_data_sg(cmd);
3569 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3572 * From PERSISTENT_RESERVE_OUT parameter list (payload)
3574 res_key = core_scsi3_extract_reservation_key(&buf[0]);
3575 sa_res_key = core_scsi3_extract_reservation_key(&buf[8]);
3577 * REGISTER_AND_MOVE uses a different SA parameter list containing
3578 * SCSI TransportIDs.
3580 if (sa != PRO_REGISTER_AND_MOVE) {
3581 spec_i_pt = (buf[20] & 0x08);
3582 all_tg_pt = (buf[20] & 0x04);
3583 aptpl = (buf[20] & 0x01);
3585 aptpl = (buf[17] & 0x01);
3586 unreg = (buf[17] & 0x02);
3589 * If the backend device has been configured to force APTPL metadata
3590 * write-out, go ahead and propigate aptpl=1 down now.
3592 if (dev->dev_attrib.force_pr_aptpl)
3595 transport_kunmap_data_sg(cmd);
3599 * SPEC_I_PT=1 is only valid for Service action: REGISTER
3601 if (spec_i_pt && ((cdb[1] & 0x1f) != PRO_REGISTER))
3602 return TCM_INVALID_PARAMETER_LIST;
3605 * From spc4r17 section 6.14:
3607 * If the SPEC_I_PT bit is set to zero, the service action is not
3608 * REGISTER AND MOVE, and the parameter list length is not 24, then
3609 * the command shall be terminated with CHECK CONDITION status, with
3610 * the sense key set to ILLEGAL REQUEST, and the additional sense
3611 * code set to PARAMETER LIST LENGTH ERROR.
3613 if (!spec_i_pt && ((cdb[1] & 0x1f) != PRO_REGISTER_AND_MOVE) &&
3614 (cmd->data_length != 24)) {
3615 pr_warn("SPC-PR: Received PR OUT illegal parameter"
3616 " list length: %u\n", cmd->data_length);
3617 return TCM_INVALID_PARAMETER_LIST;
3621 * (core_scsi3_emulate_pro_* function parameters
3622 * are defined by spc4r17 Table 174:
3623 * PERSISTENT_RESERVE_OUT service actions and valid parameters.
3627 ret = core_scsi3_emulate_pro_register(cmd,
3628 res_key, sa_res_key, aptpl, all_tg_pt, spec_i_pt, REGISTER);
3631 ret = core_scsi3_emulate_pro_reserve(cmd, type, scope, res_key);
3634 ret = core_scsi3_emulate_pro_release(cmd, type, scope, res_key);
3637 ret = core_scsi3_emulate_pro_clear(cmd, res_key);
3640 ret = core_scsi3_emulate_pro_preempt(cmd, type, scope,
3641 res_key, sa_res_key, PREEMPT);
3643 case PRO_PREEMPT_AND_ABORT:
3644 ret = core_scsi3_emulate_pro_preempt(cmd, type, scope,
3645 res_key, sa_res_key, PREEMPT_AND_ABORT);
3647 case PRO_REGISTER_AND_IGNORE_EXISTING_KEY:
3648 ret = core_scsi3_emulate_pro_register(cmd,
3649 0, sa_res_key, aptpl, all_tg_pt, spec_i_pt, REGISTER_AND_IGNORE_EXISTING_KEY);
3651 case PRO_REGISTER_AND_MOVE:
3652 ret = core_scsi3_emulate_pro_register_and_move(cmd, res_key,
3653 sa_res_key, aptpl, unreg);
3656 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
3657 " action: 0x%02x\n", cdb[1] & 0x1f);
3658 return TCM_INVALID_CDB_FIELD;
3662 target_complete_cmd(cmd, GOOD);
3667 * PERSISTENT_RESERVE_IN Service Action READ_KEYS
3669 * See spc4r17 section 5.7.6.2 and section 6.13.2, Table 160
3671 static sense_reason_t
3672 core_scsi3_pri_read_keys(struct se_cmd *cmd)
3674 struct se_device *dev = cmd->se_dev;
3675 struct t10_pr_registration *pr_reg;
3677 u32 add_len = 0, off = 8;
3679 if (cmd->data_length < 8) {
3680 pr_err("PRIN SA READ_KEYS SCSI Data Length: %u"
3681 " too small\n", cmd->data_length);
3682 return TCM_INVALID_CDB_FIELD;
3685 buf = transport_kmap_data_sg(cmd);
3687 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3689 buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3690 buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3691 buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3692 buf[3] = (dev->t10_pr.pr_generation & 0xff);
3694 spin_lock(&dev->t10_pr.registration_lock);
3695 list_for_each_entry(pr_reg, &dev->t10_pr.registration_list,
3698 * Check for overflow of 8byte PRI READ_KEYS payload and
3699 * next reservation key list descriptor.
3701 if ((add_len + 8) > (cmd->data_length - 8))
3704 buf[off++] = ((pr_reg->pr_res_key >> 56) & 0xff);
3705 buf[off++] = ((pr_reg->pr_res_key >> 48) & 0xff);
3706 buf[off++] = ((pr_reg->pr_res_key >> 40) & 0xff);
3707 buf[off++] = ((pr_reg->pr_res_key >> 32) & 0xff);
3708 buf[off++] = ((pr_reg->pr_res_key >> 24) & 0xff);
3709 buf[off++] = ((pr_reg->pr_res_key >> 16) & 0xff);
3710 buf[off++] = ((pr_reg->pr_res_key >> 8) & 0xff);
3711 buf[off++] = (pr_reg->pr_res_key & 0xff);
3715 spin_unlock(&dev->t10_pr.registration_lock);
3717 buf[4] = ((add_len >> 24) & 0xff);
3718 buf[5] = ((add_len >> 16) & 0xff);
3719 buf[6] = ((add_len >> 8) & 0xff);
3720 buf[7] = (add_len & 0xff);
3722 transport_kunmap_data_sg(cmd);
3728 * PERSISTENT_RESERVE_IN Service Action READ_RESERVATION
3730 * See spc4r17 section 5.7.6.3 and section 6.13.3.2 Table 161 and 162
3732 static sense_reason_t
3733 core_scsi3_pri_read_reservation(struct se_cmd *cmd)
3735 struct se_device *dev = cmd->se_dev;
3736 struct t10_pr_registration *pr_reg;
3739 u32 add_len = 16; /* Hardcoded to 16 when a reservation is held. */
3741 if (cmd->data_length < 8) {
3742 pr_err("PRIN SA READ_RESERVATIONS SCSI Data Length: %u"
3743 " too small\n", cmd->data_length);
3744 return TCM_INVALID_CDB_FIELD;
3747 buf = transport_kmap_data_sg(cmd);
3749 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3751 buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3752 buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3753 buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3754 buf[3] = (dev->t10_pr.pr_generation & 0xff);
3756 spin_lock(&dev->dev_reservation_lock);
3757 pr_reg = dev->dev_pr_res_holder;
3760 * Set the hardcoded Additional Length
3762 buf[4] = ((add_len >> 24) & 0xff);
3763 buf[5] = ((add_len >> 16) & 0xff);
3764 buf[6] = ((add_len >> 8) & 0xff);
3765 buf[7] = (add_len & 0xff);
3767 if (cmd->data_length < 22)
3771 * Set the Reservation key.
3773 * From spc4r17, section 5.7.10:
3774 * A persistent reservation holder has its reservation key
3775 * returned in the parameter data from a PERSISTENT
3776 * RESERVE IN command with READ RESERVATION service action as
3778 * a) For a persistent reservation of the type Write Exclusive
3779 * - All Registrants or Exclusive Access  All Regitrants,
3780 * the reservation key shall be set to zero; or
3781 * b) For all other persistent reservation types, the
3782 * reservation key shall be set to the registered
3783 * reservation key for the I_T nexus that holds the
3784 * persistent reservation.
3786 if ((pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
3787 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))
3790 pr_res_key = pr_reg->pr_res_key;
3792 buf[8] = ((pr_res_key >> 56) & 0xff);
3793 buf[9] = ((pr_res_key >> 48) & 0xff);
3794 buf[10] = ((pr_res_key >> 40) & 0xff);
3795 buf[11] = ((pr_res_key >> 32) & 0xff);
3796 buf[12] = ((pr_res_key >> 24) & 0xff);
3797 buf[13] = ((pr_res_key >> 16) & 0xff);
3798 buf[14] = ((pr_res_key >> 8) & 0xff);
3799 buf[15] = (pr_res_key & 0xff);
3801 * Set the SCOPE and TYPE
3803 buf[21] = (pr_reg->pr_res_scope & 0xf0) |
3804 (pr_reg->pr_res_type & 0x0f);
3808 spin_unlock(&dev->dev_reservation_lock);
3809 transport_kunmap_data_sg(cmd);
3815 * PERSISTENT_RESERVE_IN Service Action REPORT_CAPABILITIES
3817 * See spc4r17 section 6.13.4 Table 165
3819 static sense_reason_t
3820 core_scsi3_pri_report_capabilities(struct se_cmd *cmd)
3822 struct se_device *dev = cmd->se_dev;
3823 struct t10_reservation *pr_tmpl = &dev->t10_pr;
3825 u16 add_len = 8; /* Hardcoded to 8. */
3827 if (cmd->data_length < 6) {
3828 pr_err("PRIN SA REPORT_CAPABILITIES SCSI Data Length:"
3829 " %u too small\n", cmd->data_length);
3830 return TCM_INVALID_CDB_FIELD;
3833 buf = transport_kmap_data_sg(cmd);
3835 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3837 buf[0] = ((add_len >> 8) & 0xff);
3838 buf[1] = (add_len & 0xff);
3839 buf[2] |= 0x10; /* CRH: Compatible Reservation Hanlding bit. */
3840 buf[2] |= 0x08; /* SIP_C: Specify Initiator Ports Capable bit */
3841 buf[2] |= 0x04; /* ATP_C: All Target Ports Capable bit */
3842 buf[2] |= 0x01; /* PTPL_C: Persistence across Target Power Loss bit */
3844 * We are filling in the PERSISTENT RESERVATION TYPE MASK below, so
3845 * set the TMV: Task Mask Valid bit.
3849 * Change ALLOW COMMANDs to 0x20 or 0x40 later from Table 166
3851 buf[3] |= 0x10; /* ALLOW COMMANDs field 001b */
3853 * PTPL_A: Persistence across Target Power Loss Active bit
3855 if (pr_tmpl->pr_aptpl_active)
3858 * Setup the PERSISTENT RESERVATION TYPE MASK from Table 167
3860 buf[4] |= 0x80; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3861 buf[4] |= 0x40; /* PR_TYPE_EXCLUSIVE_ACCESS_REGONLY */
3862 buf[4] |= 0x20; /* PR_TYPE_WRITE_EXCLUSIVE_REGONLY */
3863 buf[4] |= 0x08; /* PR_TYPE_EXCLUSIVE_ACCESS */
3864 buf[4] |= 0x02; /* PR_TYPE_WRITE_EXCLUSIVE */
3865 buf[5] |= 0x01; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3867 transport_kunmap_data_sg(cmd);
3873 * PERSISTENT_RESERVE_IN Service Action READ_FULL_STATUS
3875 * See spc4r17 section 6.13.5 Table 168 and 169
3877 static sense_reason_t
3878 core_scsi3_pri_read_full_status(struct se_cmd *cmd)
3880 struct se_device *dev = cmd->se_dev;
3881 struct se_node_acl *se_nacl;
3882 struct se_portal_group *se_tpg;
3883 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
3884 struct t10_reservation *pr_tmpl = &dev->t10_pr;
3886 u32 add_desc_len = 0, add_len = 0, desc_len, exp_desc_len;
3887 u32 off = 8; /* off into first Full Status descriptor */
3888 int format_code = 0, pr_res_type = 0, pr_res_scope = 0;
3889 bool all_reg = false;
3891 if (cmd->data_length < 8) {
3892 pr_err("PRIN SA READ_FULL_STATUS SCSI Data Length: %u"
3893 " too small\n", cmd->data_length);
3894 return TCM_INVALID_CDB_FIELD;
3897 buf = transport_kmap_data_sg(cmd);
3899 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3901 buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3902 buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3903 buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3904 buf[3] = (dev->t10_pr.pr_generation & 0xff);
3906 spin_lock(&dev->dev_reservation_lock);
3907 if (dev->dev_pr_res_holder) {
3908 struct t10_pr_registration *pr_holder = dev->dev_pr_res_holder;
3910 if (pr_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG ||
3911 pr_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG) {
3913 pr_res_type = pr_holder->pr_res_type;
3914 pr_res_scope = pr_holder->pr_res_scope;
3917 spin_unlock(&dev->dev_reservation_lock);
3919 spin_lock(&pr_tmpl->registration_lock);
3920 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3921 &pr_tmpl->registration_list, pr_reg_list) {
3923 se_nacl = pr_reg->pr_reg_nacl;
3924 se_tpg = pr_reg->pr_reg_nacl->se_tpg;
3927 atomic_inc_mb(&pr_reg->pr_res_holders);
3928 spin_unlock(&pr_tmpl->registration_lock);
3930 * Determine expected length of $FABRIC_MOD specific
3931 * TransportID full status descriptor..
3933 exp_desc_len = se_tpg->se_tpg_tfo->tpg_get_pr_transport_id_len(
3934 se_tpg, se_nacl, pr_reg, &format_code);
3936 if ((exp_desc_len + add_len) > cmd->data_length) {
3937 pr_warn("SPC-3 PRIN READ_FULL_STATUS ran"
3938 " out of buffer: %d\n", cmd->data_length);
3939 spin_lock(&pr_tmpl->registration_lock);
3940 atomic_dec_mb(&pr_reg->pr_res_holders);
3944 * Set RESERVATION KEY
3946 buf[off++] = ((pr_reg->pr_res_key >> 56) & 0xff);
3947 buf[off++] = ((pr_reg->pr_res_key >> 48) & 0xff);
3948 buf[off++] = ((pr_reg->pr_res_key >> 40) & 0xff);
3949 buf[off++] = ((pr_reg->pr_res_key >> 32) & 0xff);
3950 buf[off++] = ((pr_reg->pr_res_key >> 24) & 0xff);
3951 buf[off++] = ((pr_reg->pr_res_key >> 16) & 0xff);
3952 buf[off++] = ((pr_reg->pr_res_key >> 8) & 0xff);
3953 buf[off++] = (pr_reg->pr_res_key & 0xff);
3954 off += 4; /* Skip Over Reserved area */
3957 * Set ALL_TG_PT bit if PROUT SA REGISTER had this set.
3959 if (pr_reg->pr_reg_all_tg_pt)
3962 * The struct se_lun pointer will be present for the
3963 * reservation holder for PR_HOLDER bit.
3965 * Also, if this registration is the reservation
3966 * holder or there is an All Registrants reservation
3967 * active, fill in SCOPE and TYPE in the next byte.
3969 if (pr_reg->pr_res_holder) {
3971 buf[off++] = (pr_reg->pr_res_scope & 0xf0) |
3972 (pr_reg->pr_res_type & 0x0f);
3973 } else if (all_reg) {
3975 buf[off++] = (pr_res_scope & 0xf0) |
3976 (pr_res_type & 0x0f);
3981 off += 4; /* Skip over reserved area */
3983 * From spc4r17 6.3.15:
3985 * If the ALL_TG_PT bit set to zero, the RELATIVE TARGET PORT
3986 * IDENTIFIER field contains the relative port identifier (see
3987 * 3.1.120) of the target port that is part of the I_T nexus
3988 * described by this full status descriptor. If the ALL_TG_PT
3989 * bit is set to one, the contents of the RELATIVE TARGET PORT
3990 * IDENTIFIER field are not defined by this standard.
3992 if (!pr_reg->pr_reg_all_tg_pt) {
3993 struct se_port *port = pr_reg->pr_reg_tg_pt_lun->lun_sep;
3995 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
3996 buf[off++] = (port->sep_rtpi & 0xff);
3998 off += 2; /* Skip over RELATIVE TARGET PORT IDENTIFIER */
4001 * Now, have the $FABRIC_MOD fill in the protocol identifier
4003 desc_len = se_tpg->se_tpg_tfo->tpg_get_pr_transport_id(se_tpg,
4004 se_nacl, pr_reg, &format_code, &buf[off+4]);
4006 spin_lock(&pr_tmpl->registration_lock);
4007 atomic_dec_mb(&pr_reg->pr_res_holders);
4009 * Set the ADDITIONAL DESCRIPTOR LENGTH
4011 buf[off++] = ((desc_len >> 24) & 0xff);
4012 buf[off++] = ((desc_len >> 16) & 0xff);
4013 buf[off++] = ((desc_len >> 8) & 0xff);
4014 buf[off++] = (desc_len & 0xff);
4016 * Size of full desctipor header minus TransportID
4017 * containing $FABRIC_MOD specific) initiator device/port
4020 * See spc4r17 Section 6.13.5 Table 169
4022 add_desc_len = (24 + desc_len);
4025 add_len += add_desc_len;
4027 spin_unlock(&pr_tmpl->registration_lock);
4029 * Set ADDITIONAL_LENGTH
4031 buf[4] = ((add_len >> 24) & 0xff);
4032 buf[5] = ((add_len >> 16) & 0xff);
4033 buf[6] = ((add_len >> 8) & 0xff);
4034 buf[7] = (add_len & 0xff);
4036 transport_kunmap_data_sg(cmd);
4042 target_scsi3_emulate_pr_in(struct se_cmd *cmd)
4047 * Following spc2r20 5.5.1 Reservations overview:
4049 * If a logical unit has been reserved by any RESERVE command and is
4050 * still reserved by any initiator, all PERSISTENT RESERVE IN and all
4051 * PERSISTENT RESERVE OUT commands shall conflict regardless of
4052 * initiator or service action and shall terminate with a RESERVATION
4055 if (cmd->se_dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS) {
4056 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
4057 " SPC-2 reservation is held, returning"
4058 " RESERVATION_CONFLICT\n");
4059 return TCM_RESERVATION_CONFLICT;
4062 switch (cmd->t_task_cdb[1] & 0x1f) {
4064 ret = core_scsi3_pri_read_keys(cmd);
4066 case PRI_READ_RESERVATION:
4067 ret = core_scsi3_pri_read_reservation(cmd);
4069 case PRI_REPORT_CAPABILITIES:
4070 ret = core_scsi3_pri_report_capabilities(cmd);
4072 case PRI_READ_FULL_STATUS:
4073 ret = core_scsi3_pri_read_full_status(cmd);
4076 pr_err("Unknown PERSISTENT_RESERVE_IN service"
4077 " action: 0x%02x\n", cmd->t_task_cdb[1] & 0x1f);
4078 return TCM_INVALID_CDB_FIELD;
4082 target_complete_cmd(cmd, GOOD);
4087 target_check_reservation(struct se_cmd *cmd)
4089 struct se_device *dev = cmd->se_dev;
4094 if (dev->se_hba->hba_flags & HBA_FLAGS_INTERNAL_USE)
4096 if (dev->transport->transport_flags & TRANSPORT_FLAG_PASSTHROUGH)
4099 spin_lock(&dev->dev_reservation_lock);
4100 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS)
4101 ret = target_scsi2_reservation_check(cmd);
4103 ret = target_scsi3_pr_reservation_check(cmd);
4104 spin_unlock(&dev->dev_reservation_lock);