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-2012 RisingTide Systems LLC.
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);
82 target_scsi2_reservation_check(struct se_cmd *cmd)
84 struct se_device *dev = cmd->se_dev;
85 struct se_session *sess = cmd->se_sess;
87 switch (cmd->t_task_cdb[0]) {
96 if (!dev->dev_reserved_node_acl || !sess)
99 if (dev->dev_reserved_node_acl != sess->se_node_acl)
100 return TCM_RESERVATION_CONFLICT;
102 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS_WITH_ISID) {
103 if (dev->dev_res_bin_isid != sess->sess_bin_isid)
104 return TCM_RESERVATION_CONFLICT;
110 static struct t10_pr_registration *core_scsi3_locate_pr_reg(struct se_device *,
111 struct se_node_acl *, struct se_session *);
112 static void core_scsi3_put_pr_reg(struct t10_pr_registration *);
114 static int target_check_scsi2_reservation_conflict(struct se_cmd *cmd)
116 struct se_session *se_sess = cmd->se_sess;
117 struct se_device *dev = cmd->se_dev;
118 struct t10_pr_registration *pr_reg;
119 struct t10_reservation *pr_tmpl = &dev->t10_pr;
122 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
126 * From spc4r17 5.7.3 Exceptions to SPC-2 RESERVE and RELEASE
129 * A RESERVE(6) or RESERVE(10) command shall complete with GOOD
130 * status, but no reservation shall be established and the
131 * persistent reservation shall not be changed, if the command
132 * is received from a) and b) below.
134 * A RELEASE(6) or RELEASE(10) command shall complete with GOOD
135 * status, but the persistent reservation shall not be released,
136 * if the command is received from a) and b)
138 * a) An I_T nexus that is a persistent reservation holder; or
139 * b) An I_T nexus that is registered if a registrants only or
140 * all registrants type persistent reservation is present.
142 * In all other cases, a RESERVE(6) command, RESERVE(10) command,
143 * RELEASE(6) command, or RELEASE(10) command shall be processed
144 * as defined in SPC-2.
146 if (pr_reg->pr_res_holder) {
147 core_scsi3_put_pr_reg(pr_reg);
150 if ((pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_REGONLY) ||
151 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_REGONLY) ||
152 (pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
153 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
154 core_scsi3_put_pr_reg(pr_reg);
157 core_scsi3_put_pr_reg(pr_reg);
161 * Following spc2r20 5.5.1 Reservations overview:
163 * If a logical unit has executed a PERSISTENT RESERVE OUT
164 * command with the REGISTER or the REGISTER AND IGNORE
165 * EXISTING KEY service action and is still registered by any
166 * initiator, all RESERVE commands and all RELEASE commands
167 * regardless of initiator shall conflict and shall terminate
168 * with a RESERVATION CONFLICT status.
170 spin_lock(&pr_tmpl->registration_lock);
171 conflict = (list_empty(&pr_tmpl->registration_list)) ? 0 : 1;
172 spin_unlock(&pr_tmpl->registration_lock);
176 pr_err("Received legacy SPC-2 RESERVE/RELEASE"
177 " while active SPC-3 registrations exist,"
178 " returning RESERVATION_CONFLICT\n");
186 target_scsi2_reservation_release(struct se_cmd *cmd)
188 struct se_device *dev = cmd->se_dev;
189 struct se_session *sess = cmd->se_sess;
190 struct se_portal_group *tpg;
193 if (!sess || !sess->se_tpg)
195 rc = target_check_scsi2_reservation_conflict(cmd);
199 return TCM_RESERVATION_CONFLICT;
201 spin_lock(&dev->dev_reservation_lock);
202 if (!dev->dev_reserved_node_acl || !sess)
205 if (dev->dev_reserved_node_acl != sess->se_node_acl)
208 if (dev->dev_res_bin_isid != sess->sess_bin_isid)
211 dev->dev_reserved_node_acl = NULL;
212 dev->dev_reservation_flags &= ~DRF_SPC2_RESERVATIONS;
213 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS_WITH_ISID) {
214 dev->dev_res_bin_isid = 0;
215 dev->dev_reservation_flags &= ~DRF_SPC2_RESERVATIONS_WITH_ISID;
218 pr_debug("SCSI-2 Released reservation for %s LUN: %u ->"
219 " MAPPED LUN: %u for %s\n", tpg->se_tpg_tfo->get_fabric_name(),
220 cmd->se_lun->unpacked_lun, cmd->se_deve->mapped_lun,
221 sess->se_node_acl->initiatorname);
224 spin_unlock(&dev->dev_reservation_lock);
226 target_complete_cmd(cmd, GOOD);
231 target_scsi2_reservation_reserve(struct se_cmd *cmd)
233 struct se_device *dev = cmd->se_dev;
234 struct se_session *sess = cmd->se_sess;
235 struct se_portal_group *tpg;
236 sense_reason_t ret = 0;
239 if ((cmd->t_task_cdb[1] & 0x01) &&
240 (cmd->t_task_cdb[1] & 0x02)) {
241 pr_err("LongIO and Obselete Bits set, returning"
242 " ILLEGAL_REQUEST\n");
243 return TCM_UNSUPPORTED_SCSI_OPCODE;
246 * This is currently the case for target_core_mod passthrough struct se_cmd
249 if (!sess || !sess->se_tpg)
251 rc = target_check_scsi2_reservation_conflict(cmd);
256 return TCM_RESERVATION_CONFLICT;
259 spin_lock(&dev->dev_reservation_lock);
260 if (dev->dev_reserved_node_acl &&
261 (dev->dev_reserved_node_acl != sess->se_node_acl)) {
262 pr_err("SCSI-2 RESERVATION CONFLIFT for %s fabric\n",
263 tpg->se_tpg_tfo->get_fabric_name());
264 pr_err("Original reserver LUN: %u %s\n",
265 cmd->se_lun->unpacked_lun,
266 dev->dev_reserved_node_acl->initiatorname);
267 pr_err("Current attempt - LUN: %u -> MAPPED LUN: %u"
268 " from %s \n", cmd->se_lun->unpacked_lun,
269 cmd->se_deve->mapped_lun,
270 sess->se_node_acl->initiatorname);
271 ret = TCM_RESERVATION_CONFLICT;
275 dev->dev_reserved_node_acl = sess->se_node_acl;
276 dev->dev_reservation_flags |= DRF_SPC2_RESERVATIONS;
277 if (sess->sess_bin_isid != 0) {
278 dev->dev_res_bin_isid = sess->sess_bin_isid;
279 dev->dev_reservation_flags |= DRF_SPC2_RESERVATIONS_WITH_ISID;
281 pr_debug("SCSI-2 Reserved %s LUN: %u -> MAPPED LUN: %u"
282 " for %s\n", tpg->se_tpg_tfo->get_fabric_name(),
283 cmd->se_lun->unpacked_lun, cmd->se_deve->mapped_lun,
284 sess->se_node_acl->initiatorname);
287 spin_unlock(&dev->dev_reservation_lock);
290 target_complete_cmd(cmd, GOOD);
296 * Begin SPC-3/SPC-4 Persistent Reservations emulation support
298 * This function is called by those initiator ports who are *NOT*
299 * the active PR reservation holder when a reservation is present.
301 static int core_scsi3_pr_seq_non_holder(
305 unsigned char *cdb = cmd->t_task_cdb;
306 struct se_dev_entry *se_deve;
307 struct se_session *se_sess = cmd->se_sess;
308 int other_cdb = 0, ignore_reg;
309 int registered_nexus = 0, ret = 1; /* Conflict by default */
310 int all_reg = 0, reg_only = 0; /* ALL_REG, REG_ONLY */
311 int we = 0; /* Write Exclusive */
312 int legacy = 0; /* Act like a legacy device and return
313 * RESERVATION CONFLICT on some CDBs */
315 se_deve = se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
317 * Determine if the registration should be ignored due to
318 * non-matching ISIDs in target_scsi3_pr_reservation_check().
320 ignore_reg = (pr_reg_type & 0x80000000);
322 pr_reg_type &= ~0x80000000;
324 switch (pr_reg_type) {
325 case PR_TYPE_WRITE_EXCLUSIVE:
327 case PR_TYPE_EXCLUSIVE_ACCESS:
329 * Some commands are only allowed for the persistent reservation
332 if ((se_deve->def_pr_registered) && !(ignore_reg))
333 registered_nexus = 1;
335 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
337 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
339 * Some commands are only allowed for registered I_T Nexuses.
342 if ((se_deve->def_pr_registered) && !(ignore_reg))
343 registered_nexus = 1;
345 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
347 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
349 * Each registered I_T Nexus is a reservation holder.
352 if ((se_deve->def_pr_registered) && !(ignore_reg))
353 registered_nexus = 1;
359 * Referenced from spc4r17 table 45 for *NON* PR holder access
362 case SECURITY_PROTOCOL_IN:
363 if (registered_nexus)
371 case RECEIVE_DIAGNOSTIC:
376 if (registered_nexus) {
380 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
382 case PERSISTENT_RESERVE_OUT:
384 * This follows PERSISTENT_RESERVE_OUT service actions that
385 * are allowed in the presence of various reservations.
386 * See spc4r17, table 46
388 switch (cdb[1] & 0x1f) {
391 case PRO_PREEMPT_AND_ABORT:
392 ret = (registered_nexus) ? 0 : 1;
395 case PRO_REGISTER_AND_IGNORE_EXISTING_KEY:
398 case PRO_REGISTER_AND_MOVE:
403 ret = (registered_nexus) ? 0 : 1;
406 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
407 " action: 0x%02x\n", cdb[1] & 0x1f);
413 /* Handled by CRH=1 in target_scsi2_reservation_release() */
418 /* Handled by CRH=1 in target_scsi2_reservation_reserve() */
421 case TEST_UNIT_READY:
422 ret = (legacy) ? 1 : 0; /* Conflict for legacy */
425 switch (cdb[1] & 0x1f) {
426 case MI_MANAGEMENT_PROTOCOL_IN:
427 if (registered_nexus) {
431 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
433 case MI_REPORT_SUPPORTED_OPERATION_CODES:
434 case MI_REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS:
439 if (registered_nexus) {
443 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
445 case MI_REPORT_ALIASES:
446 case MI_REPORT_IDENTIFYING_INFORMATION:
447 case MI_REPORT_PRIORITY:
448 case MI_REPORT_TARGET_PGS:
449 case MI_REPORT_TIMESTAMP:
450 ret = 0; /* Allowed */
453 pr_err("Unknown MI Service Action: 0x%02x\n",
458 case ACCESS_CONTROL_IN:
459 case ACCESS_CONTROL_OUT:
462 case READ_MEDIA_SERIAL_NUMBER:
465 case PERSISTENT_RESERVE_IN:
466 ret = 0; /*/ Allowed CDBs */
473 * Case where the CDB is explicitly allowed in the above switch
476 if (!ret && !other_cdb) {
477 pr_debug("Allowing explict CDB: 0x%02x for %s"
478 " reservation holder\n", cdb[0],
479 core_scsi3_pr_dump_type(pr_reg_type));
484 * Check if write exclusive initiator ports *NOT* holding the
485 * WRITE_EXCLUSIVE_* reservation.
487 if (we && !registered_nexus) {
488 if (cmd->data_direction == DMA_TO_DEVICE) {
490 * Conflict for write exclusive
492 pr_debug("%s Conflict for unregistered nexus"
493 " %s CDB: 0x%02x to %s reservation\n",
494 transport_dump_cmd_direction(cmd),
495 se_sess->se_node_acl->initiatorname, cdb[0],
496 core_scsi3_pr_dump_type(pr_reg_type));
500 * Allow non WRITE CDBs for all Write Exclusive
501 * PR TYPEs to pass for registered and
502 * non-registered_nexuxes NOT holding the reservation.
504 * We only make noise for the unregisterd nexuses,
505 * as we expect registered non-reservation holding
506 * nexuses to issue CDBs.
509 if (!registered_nexus) {
510 pr_debug("Allowing implict CDB: 0x%02x"
511 " for %s reservation on unregistered"
513 core_scsi3_pr_dump_type(pr_reg_type));
518 } else if ((reg_only) || (all_reg)) {
519 if (registered_nexus) {
521 * For PR_*_REG_ONLY and PR_*_ALL_REG reservations,
522 * allow commands from registered nexuses.
525 pr_debug("Allowing implict CDB: 0x%02x for %s"
526 " reservation\n", cdb[0],
527 core_scsi3_pr_dump_type(pr_reg_type));
532 pr_debug("%s Conflict for %sregistered nexus %s CDB: 0x%2x"
533 " for %s reservation\n", transport_dump_cmd_direction(cmd),
534 (registered_nexus) ? "" : "un",
535 se_sess->se_node_acl->initiatorname, cdb[0],
536 core_scsi3_pr_dump_type(pr_reg_type));
538 return 1; /* Conflict by default */
541 static sense_reason_t
542 target_scsi3_pr_reservation_check(struct se_cmd *cmd)
544 struct se_device *dev = cmd->se_dev;
545 struct se_session *sess = cmd->se_sess;
548 if (!dev->dev_pr_res_holder)
551 pr_reg_type = dev->dev_pr_res_holder->pr_res_type;
552 cmd->pr_res_key = dev->dev_pr_res_holder->pr_res_key;
553 if (dev->dev_pr_res_holder->pr_reg_nacl != sess->se_node_acl)
554 goto check_nonholder;
556 if (dev->dev_pr_res_holder->isid_present_at_reg) {
557 if (dev->dev_pr_res_holder->pr_reg_bin_isid !=
558 sess->sess_bin_isid) {
559 pr_reg_type |= 0x80000000;
560 goto check_nonholder;
567 if (core_scsi3_pr_seq_non_holder(cmd, pr_reg_type))
568 return TCM_RESERVATION_CONFLICT;
572 static u32 core_scsi3_pr_generation(struct se_device *dev)
577 * PRGeneration field shall contain the value of a 32-bit wrapping
578 * counter mainted by the device server.
580 * Note that this is done regardless of Active Persist across
581 * Target PowerLoss (APTPL)
583 * See spc4r17 section 6.3.12 READ_KEYS service action
585 spin_lock(&dev->dev_reservation_lock);
586 prg = dev->t10_pr.pr_generation++;
587 spin_unlock(&dev->dev_reservation_lock);
592 static struct t10_pr_registration *__core_scsi3_do_alloc_registration(
593 struct se_device *dev,
594 struct se_node_acl *nacl,
595 struct se_dev_entry *deve,
601 struct t10_pr_registration *pr_reg;
603 pr_reg = kmem_cache_zalloc(t10_pr_reg_cache, GFP_ATOMIC);
605 pr_err("Unable to allocate struct t10_pr_registration\n");
609 pr_reg->pr_aptpl_buf = kzalloc(dev->t10_pr.pr_aptpl_buf_len,
611 if (!pr_reg->pr_aptpl_buf) {
612 pr_err("Unable to allocate pr_reg->pr_aptpl_buf\n");
613 kmem_cache_free(t10_pr_reg_cache, pr_reg);
617 INIT_LIST_HEAD(&pr_reg->pr_reg_list);
618 INIT_LIST_HEAD(&pr_reg->pr_reg_abort_list);
619 INIT_LIST_HEAD(&pr_reg->pr_reg_aptpl_list);
620 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_list);
621 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_mem_list);
622 atomic_set(&pr_reg->pr_res_holders, 0);
623 pr_reg->pr_reg_nacl = nacl;
624 pr_reg->pr_reg_deve = deve;
625 pr_reg->pr_res_mapped_lun = deve->mapped_lun;
626 pr_reg->pr_aptpl_target_lun = deve->se_lun->unpacked_lun;
627 pr_reg->pr_res_key = sa_res_key;
628 pr_reg->pr_reg_all_tg_pt = all_tg_pt;
629 pr_reg->pr_reg_aptpl = aptpl;
630 pr_reg->pr_reg_tg_pt_lun = deve->se_lun;
632 * If an ISID value for this SCSI Initiator Port exists,
633 * save it to the registration now.
636 pr_reg->pr_reg_bin_isid = get_unaligned_be64(isid);
637 snprintf(pr_reg->pr_reg_isid, PR_REG_ISID_LEN, "%s", isid);
638 pr_reg->isid_present_at_reg = 1;
644 static int core_scsi3_lunacl_depend_item(struct se_dev_entry *);
645 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry *);
648 * Function used for handling PR registrations for ALL_TG_PT=1 and ALL_TG_PT=0
651 static struct t10_pr_registration *__core_scsi3_alloc_registration(
652 struct se_device *dev,
653 struct se_node_acl *nacl,
654 struct se_dev_entry *deve,
660 struct se_dev_entry *deve_tmp;
661 struct se_node_acl *nacl_tmp;
662 struct se_port *port, *port_tmp;
663 struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
664 struct t10_pr_registration *pr_reg, *pr_reg_atp, *pr_reg_tmp, *pr_reg_tmp_safe;
667 * Create a registration for the I_T Nexus upon which the
668 * PROUT REGISTER was received.
670 pr_reg = __core_scsi3_do_alloc_registration(dev, nacl, deve, isid,
671 sa_res_key, all_tg_pt, aptpl);
675 * Return pointer to pr_reg for ALL_TG_PT=0
680 * Create list of matching SCSI Initiator Port registrations
683 spin_lock(&dev->se_port_lock);
684 list_for_each_entry_safe(port, port_tmp, &dev->dev_sep_list, sep_list) {
685 atomic_inc(&port->sep_tg_pt_ref_cnt);
686 smp_mb__after_atomic_inc();
687 spin_unlock(&dev->se_port_lock);
689 spin_lock_bh(&port->sep_alua_lock);
690 list_for_each_entry(deve_tmp, &port->sep_alua_list,
693 * This pointer will be NULL for demo mode MappedLUNs
694 * that have not been make explict via a ConfigFS
695 * MappedLUN group for the SCSI Initiator Node ACL.
697 if (!deve_tmp->se_lun_acl)
700 nacl_tmp = deve_tmp->se_lun_acl->se_lun_nacl;
702 * Skip the matching struct se_node_acl that is allocated
705 if (nacl == nacl_tmp)
708 * Only perform PR registrations for target ports on
709 * the same fabric module as the REGISTER w/ ALL_TG_PT=1
712 if (tfo != nacl_tmp->se_tpg->se_tpg_tfo)
715 * Look for a matching Initiator Node ACL in ASCII format
717 if (strcmp(nacl->initiatorname, nacl_tmp->initiatorname))
720 atomic_inc(&deve_tmp->pr_ref_count);
721 smp_mb__after_atomic_inc();
722 spin_unlock_bh(&port->sep_alua_lock);
724 * Grab a configfs group dependency that is released
725 * for the exception path at label out: below, or upon
726 * completion of adding ALL_TG_PT=1 registrations in
727 * __core_scsi3_add_registration()
729 ret = core_scsi3_lunacl_depend_item(deve_tmp);
731 pr_err("core_scsi3_lunacl_depend"
733 atomic_dec(&port->sep_tg_pt_ref_cnt);
734 smp_mb__after_atomic_dec();
735 atomic_dec(&deve_tmp->pr_ref_count);
736 smp_mb__after_atomic_dec();
740 * Located a matching SCSI Initiator Port on a different
741 * port, allocate the pr_reg_atp and attach it to the
742 * pr_reg->pr_reg_atp_list that will be processed once
743 * the original *pr_reg is processed in
744 * __core_scsi3_add_registration()
746 pr_reg_atp = __core_scsi3_do_alloc_registration(dev,
747 nacl_tmp, deve_tmp, NULL,
748 sa_res_key, all_tg_pt, aptpl);
750 atomic_dec(&port->sep_tg_pt_ref_cnt);
751 smp_mb__after_atomic_dec();
752 atomic_dec(&deve_tmp->pr_ref_count);
753 smp_mb__after_atomic_dec();
754 core_scsi3_lunacl_undepend_item(deve_tmp);
758 list_add_tail(&pr_reg_atp->pr_reg_atp_mem_list,
759 &pr_reg->pr_reg_atp_list);
760 spin_lock_bh(&port->sep_alua_lock);
762 spin_unlock_bh(&port->sep_alua_lock);
764 spin_lock(&dev->se_port_lock);
765 atomic_dec(&port->sep_tg_pt_ref_cnt);
766 smp_mb__after_atomic_dec();
768 spin_unlock(&dev->se_port_lock);
772 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
773 &pr_reg->pr_reg_atp_list, pr_reg_atp_mem_list) {
774 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
775 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
776 kmem_cache_free(t10_pr_reg_cache, pr_reg_tmp);
778 kmem_cache_free(t10_pr_reg_cache, pr_reg);
782 int core_scsi3_alloc_aptpl_registration(
783 struct t10_reservation *pr_tmpl,
785 unsigned char *i_port,
788 unsigned char *t_port,
795 struct t10_pr_registration *pr_reg;
797 if (!i_port || !t_port || !sa_res_key) {
798 pr_err("Illegal parameters for APTPL registration\n");
802 pr_reg = kmem_cache_zalloc(t10_pr_reg_cache, GFP_KERNEL);
804 pr_err("Unable to allocate struct t10_pr_registration\n");
807 pr_reg->pr_aptpl_buf = kzalloc(pr_tmpl->pr_aptpl_buf_len, GFP_KERNEL);
809 INIT_LIST_HEAD(&pr_reg->pr_reg_list);
810 INIT_LIST_HEAD(&pr_reg->pr_reg_abort_list);
811 INIT_LIST_HEAD(&pr_reg->pr_reg_aptpl_list);
812 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_list);
813 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_mem_list);
814 atomic_set(&pr_reg->pr_res_holders, 0);
815 pr_reg->pr_reg_nacl = NULL;
816 pr_reg->pr_reg_deve = NULL;
817 pr_reg->pr_res_mapped_lun = mapped_lun;
818 pr_reg->pr_aptpl_target_lun = target_lun;
819 pr_reg->pr_res_key = sa_res_key;
820 pr_reg->pr_reg_all_tg_pt = all_tg_pt;
821 pr_reg->pr_reg_aptpl = 1;
822 pr_reg->pr_reg_tg_pt_lun = NULL;
823 pr_reg->pr_res_scope = 0; /* Always LUN_SCOPE */
824 pr_reg->pr_res_type = type;
826 * If an ISID value had been saved in APTPL metadata for this
827 * SCSI Initiator Port, restore it now.
830 pr_reg->pr_reg_bin_isid = get_unaligned_be64(isid);
831 snprintf(pr_reg->pr_reg_isid, PR_REG_ISID_LEN, "%s", isid);
832 pr_reg->isid_present_at_reg = 1;
835 * Copy the i_port and t_port information from caller.
837 snprintf(pr_reg->pr_iport, PR_APTPL_MAX_IPORT_LEN, "%s", i_port);
838 snprintf(pr_reg->pr_tport, PR_APTPL_MAX_TPORT_LEN, "%s", t_port);
839 pr_reg->pr_reg_tpgt = tpgt;
841 * Set pr_res_holder from caller, the pr_reg who is the reservation
842 * holder will get it's pointer set in core_scsi3_aptpl_reserve() once
843 * the Initiator Node LUN ACL from the fabric module is created for
846 pr_reg->pr_res_holder = res_holder;
848 list_add_tail(&pr_reg->pr_reg_aptpl_list, &pr_tmpl->aptpl_reg_list);
849 pr_debug("SPC-3 PR APTPL Successfully added registration%s from"
850 " metadata\n", (res_holder) ? "+reservation" : "");
854 static void core_scsi3_aptpl_reserve(
855 struct se_device *dev,
856 struct se_portal_group *tpg,
857 struct se_node_acl *node_acl,
858 struct t10_pr_registration *pr_reg)
860 char i_buf[PR_REG_ISID_ID_LEN];
862 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
863 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
865 spin_lock(&dev->dev_reservation_lock);
866 dev->dev_pr_res_holder = pr_reg;
867 spin_unlock(&dev->dev_reservation_lock);
869 pr_debug("SPC-3 PR [%s] Service Action: APTPL RESERVE created"
870 " new reservation holder TYPE: %s ALL_TG_PT: %d\n",
871 tpg->se_tpg_tfo->get_fabric_name(),
872 core_scsi3_pr_dump_type(pr_reg->pr_res_type),
873 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
874 pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
875 tpg->se_tpg_tfo->get_fabric_name(), node_acl->initiatorname,
879 static void __core_scsi3_add_registration(struct se_device *, struct se_node_acl *,
880 struct t10_pr_registration *, enum register_type, int);
882 static int __core_scsi3_check_aptpl_registration(
883 struct se_device *dev,
884 struct se_portal_group *tpg,
887 struct se_node_acl *nacl,
888 struct se_dev_entry *deve)
890 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
891 struct t10_reservation *pr_tmpl = &dev->t10_pr;
892 unsigned char i_port[PR_APTPL_MAX_IPORT_LEN];
893 unsigned char t_port[PR_APTPL_MAX_TPORT_LEN];
896 memset(i_port, 0, PR_APTPL_MAX_IPORT_LEN);
897 memset(t_port, 0, PR_APTPL_MAX_TPORT_LEN);
899 * Copy Initiator Port information from struct se_node_acl
901 snprintf(i_port, PR_APTPL_MAX_IPORT_LEN, "%s", nacl->initiatorname);
902 snprintf(t_port, PR_APTPL_MAX_TPORT_LEN, "%s",
903 tpg->se_tpg_tfo->tpg_get_wwn(tpg));
904 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
906 * Look for the matching registrations+reservation from those
907 * created from APTPL metadata. Note that multiple registrations
908 * may exist for fabrics that use ISIDs in their SCSI Initiator Port
911 spin_lock(&pr_tmpl->aptpl_reg_lock);
912 list_for_each_entry_safe(pr_reg, pr_reg_tmp, &pr_tmpl->aptpl_reg_list,
914 if (!strcmp(pr_reg->pr_iport, i_port) &&
915 (pr_reg->pr_res_mapped_lun == deve->mapped_lun) &&
916 !(strcmp(pr_reg->pr_tport, t_port)) &&
917 (pr_reg->pr_reg_tpgt == tpgt) &&
918 (pr_reg->pr_aptpl_target_lun == target_lun)) {
920 pr_reg->pr_reg_nacl = nacl;
921 pr_reg->pr_reg_deve = deve;
922 pr_reg->pr_reg_tg_pt_lun = lun;
924 list_del(&pr_reg->pr_reg_aptpl_list);
925 spin_unlock(&pr_tmpl->aptpl_reg_lock);
927 * At this point all of the pointers in *pr_reg will
928 * be setup, so go ahead and add the registration.
931 __core_scsi3_add_registration(dev, nacl, pr_reg, 0, 0);
933 * If this registration is the reservation holder,
934 * make that happen now..
936 if (pr_reg->pr_res_holder)
937 core_scsi3_aptpl_reserve(dev, tpg,
940 * Reenable pr_aptpl_active to accept new metadata
941 * updates once the SCSI device is active again..
943 spin_lock(&pr_tmpl->aptpl_reg_lock);
944 pr_tmpl->pr_aptpl_active = 1;
947 spin_unlock(&pr_tmpl->aptpl_reg_lock);
952 int core_scsi3_check_aptpl_registration(
953 struct se_device *dev,
954 struct se_portal_group *tpg,
956 struct se_lun_acl *lun_acl)
958 struct se_node_acl *nacl = lun_acl->se_lun_nacl;
959 struct se_dev_entry *deve = nacl->device_list[lun_acl->mapped_lun];
961 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS)
964 return __core_scsi3_check_aptpl_registration(dev, tpg, lun,
965 lun->unpacked_lun, nacl, deve);
968 static void __core_scsi3_dump_registration(
969 struct target_core_fabric_ops *tfo,
970 struct se_device *dev,
971 struct se_node_acl *nacl,
972 struct t10_pr_registration *pr_reg,
973 enum register_type register_type)
975 struct se_portal_group *se_tpg = nacl->se_tpg;
976 char i_buf[PR_REG_ISID_ID_LEN];
978 memset(&i_buf[0], 0, PR_REG_ISID_ID_LEN);
979 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
981 pr_debug("SPC-3 PR [%s] Service Action: REGISTER%s Initiator"
982 " Node: %s%s\n", tfo->get_fabric_name(), (register_type == REGISTER_AND_MOVE) ?
983 "_AND_MOVE" : (register_type == REGISTER_AND_IGNORE_EXISTING_KEY) ?
984 "_AND_IGNORE_EXISTING_KEY" : "", nacl->initiatorname,
986 pr_debug("SPC-3 PR [%s] registration on Target Port: %s,0x%04x\n",
987 tfo->get_fabric_name(), tfo->tpg_get_wwn(se_tpg),
988 tfo->tpg_get_tag(se_tpg));
989 pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
990 " Port(s)\n", tfo->get_fabric_name(),
991 (pr_reg->pr_reg_all_tg_pt) ? "ALL" : "SINGLE",
992 dev->transport->name);
993 pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
994 " 0x%08x APTPL: %d\n", tfo->get_fabric_name(),
995 pr_reg->pr_res_key, pr_reg->pr_res_generation,
996 pr_reg->pr_reg_aptpl);
1000 * this function can be called with struct se_device->dev_reservation_lock
1001 * when register_move = 1
1003 static void __core_scsi3_add_registration(
1004 struct se_device *dev,
1005 struct se_node_acl *nacl,
1006 struct t10_pr_registration *pr_reg,
1007 enum register_type register_type,
1010 struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
1011 struct t10_pr_registration *pr_reg_tmp, *pr_reg_tmp_safe;
1012 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1015 * Increment PRgeneration counter for struct se_device upon a successful
1016 * REGISTER, see spc4r17 section 6.3.2 READ_KEYS service action
1018 * Also, when register_move = 1 for PROUT REGISTER_AND_MOVE service
1019 * action, the struct se_device->dev_reservation_lock will already be held,
1020 * so we do not call core_scsi3_pr_generation() which grabs the lock
1023 pr_reg->pr_res_generation = (register_move) ?
1024 dev->t10_pr.pr_generation++ :
1025 core_scsi3_pr_generation(dev);
1027 spin_lock(&pr_tmpl->registration_lock);
1028 list_add_tail(&pr_reg->pr_reg_list, &pr_tmpl->registration_list);
1029 pr_reg->pr_reg_deve->def_pr_registered = 1;
1031 __core_scsi3_dump_registration(tfo, dev, nacl, pr_reg, register_type);
1032 spin_unlock(&pr_tmpl->registration_lock);
1034 * Skip extra processing for ALL_TG_PT=0 or REGISTER_AND_MOVE.
1036 if (!pr_reg->pr_reg_all_tg_pt || register_move)
1039 * Walk pr_reg->pr_reg_atp_list and add registrations for ALL_TG_PT=1
1040 * allocated in __core_scsi3_alloc_registration()
1042 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
1043 &pr_reg->pr_reg_atp_list, pr_reg_atp_mem_list) {
1044 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
1046 pr_reg_tmp->pr_res_generation = core_scsi3_pr_generation(dev);
1048 spin_lock(&pr_tmpl->registration_lock);
1049 list_add_tail(&pr_reg_tmp->pr_reg_list,
1050 &pr_tmpl->registration_list);
1051 pr_reg_tmp->pr_reg_deve->def_pr_registered = 1;
1053 __core_scsi3_dump_registration(tfo, dev,
1054 pr_reg_tmp->pr_reg_nacl, pr_reg_tmp,
1056 spin_unlock(&pr_tmpl->registration_lock);
1058 * Drop configfs group dependency reference from
1059 * __core_scsi3_alloc_registration()
1061 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
1065 static int core_scsi3_alloc_registration(
1066 struct se_device *dev,
1067 struct se_node_acl *nacl,
1068 struct se_dev_entry *deve,
1069 unsigned char *isid,
1073 enum register_type register_type,
1076 struct t10_pr_registration *pr_reg;
1078 pr_reg = __core_scsi3_alloc_registration(dev, nacl, deve, isid,
1079 sa_res_key, all_tg_pt, aptpl);
1083 __core_scsi3_add_registration(dev, nacl, pr_reg,
1084 register_type, register_move);
1088 static struct t10_pr_registration *__core_scsi3_locate_pr_reg(
1089 struct se_device *dev,
1090 struct se_node_acl *nacl,
1091 unsigned char *isid)
1093 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1094 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
1095 struct se_portal_group *tpg;
1097 spin_lock(&pr_tmpl->registration_lock);
1098 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1099 &pr_tmpl->registration_list, pr_reg_list) {
1101 * First look for a matching struct se_node_acl
1103 if (pr_reg->pr_reg_nacl != nacl)
1106 tpg = pr_reg->pr_reg_nacl->se_tpg;
1108 * If this registration does NOT contain a fabric provided
1109 * ISID, then we have found a match.
1111 if (!pr_reg->isid_present_at_reg) {
1113 * Determine if this SCSI device server requires that
1114 * SCSI Intiatior TransportID w/ ISIDs is enforced
1115 * for fabric modules (iSCSI) requiring them.
1117 if (tpg->se_tpg_tfo->sess_get_initiator_sid != NULL) {
1118 if (dev->dev_attrib.enforce_pr_isids)
1121 atomic_inc(&pr_reg->pr_res_holders);
1122 smp_mb__after_atomic_inc();
1123 spin_unlock(&pr_tmpl->registration_lock);
1127 * If the *pr_reg contains a fabric defined ISID for multi-value
1128 * SCSI Initiator Port TransportIDs, then we expect a valid
1129 * matching ISID to be provided by the local SCSI Initiator Port.
1133 if (strcmp(isid, pr_reg->pr_reg_isid))
1136 atomic_inc(&pr_reg->pr_res_holders);
1137 smp_mb__after_atomic_inc();
1138 spin_unlock(&pr_tmpl->registration_lock);
1141 spin_unlock(&pr_tmpl->registration_lock);
1146 static struct t10_pr_registration *core_scsi3_locate_pr_reg(
1147 struct se_device *dev,
1148 struct se_node_acl *nacl,
1149 struct se_session *sess)
1151 struct se_portal_group *tpg = nacl->se_tpg;
1152 unsigned char buf[PR_REG_ISID_LEN], *isid_ptr = NULL;
1154 if (tpg->se_tpg_tfo->sess_get_initiator_sid != NULL) {
1155 memset(&buf[0], 0, PR_REG_ISID_LEN);
1156 tpg->se_tpg_tfo->sess_get_initiator_sid(sess, &buf[0],
1161 return __core_scsi3_locate_pr_reg(dev, nacl, isid_ptr);
1164 static void core_scsi3_put_pr_reg(struct t10_pr_registration *pr_reg)
1166 atomic_dec(&pr_reg->pr_res_holders);
1167 smp_mb__after_atomic_dec();
1170 static int core_scsi3_check_implict_release(
1171 struct se_device *dev,
1172 struct t10_pr_registration *pr_reg)
1174 struct se_node_acl *nacl = pr_reg->pr_reg_nacl;
1175 struct t10_pr_registration *pr_res_holder;
1178 spin_lock(&dev->dev_reservation_lock);
1179 pr_res_holder = dev->dev_pr_res_holder;
1180 if (!pr_res_holder) {
1181 spin_unlock(&dev->dev_reservation_lock);
1184 if (pr_res_holder == pr_reg) {
1186 * Perform an implict RELEASE if the registration that
1187 * is being released is holding the reservation.
1189 * From spc4r17, section 5.7.11.1:
1191 * e) If the I_T nexus is the persistent reservation holder
1192 * and the persistent reservation is not an all registrants
1193 * type, then a PERSISTENT RESERVE OUT command with REGISTER
1194 * service action or REGISTER AND IGNORE EXISTING KEY
1195 * service action with the SERVICE ACTION RESERVATION KEY
1196 * field set to zero (see 5.7.11.3).
1198 __core_scsi3_complete_pro_release(dev, nacl, pr_reg, 0);
1201 * For 'All Registrants' reservation types, all existing
1202 * registrations are still processed as reservation holders
1203 * in core_scsi3_pr_seq_non_holder() after the initial
1204 * reservation holder is implictly released here.
1206 } else if (pr_reg->pr_reg_all_tg_pt &&
1207 (!strcmp(pr_res_holder->pr_reg_nacl->initiatorname,
1208 pr_reg->pr_reg_nacl->initiatorname)) &&
1209 (pr_res_holder->pr_res_key == pr_reg->pr_res_key)) {
1210 pr_err("SPC-3 PR: Unable to perform ALL_TG_PT=1"
1211 " UNREGISTER while existing reservation with matching"
1212 " key 0x%016Lx is present from another SCSI Initiator"
1213 " Port\n", pr_reg->pr_res_key);
1216 spin_unlock(&dev->dev_reservation_lock);
1222 * Called with struct t10_reservation->registration_lock held.
1224 static void __core_scsi3_free_registration(
1225 struct se_device *dev,
1226 struct t10_pr_registration *pr_reg,
1227 struct list_head *preempt_and_abort_list,
1230 struct target_core_fabric_ops *tfo =
1231 pr_reg->pr_reg_nacl->se_tpg->se_tpg_tfo;
1232 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1233 char i_buf[PR_REG_ISID_ID_LEN];
1235 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
1236 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
1238 pr_reg->pr_reg_deve->def_pr_registered = 0;
1239 pr_reg->pr_reg_deve->pr_res_key = 0;
1240 list_del(&pr_reg->pr_reg_list);
1242 * Caller accessing *pr_reg using core_scsi3_locate_pr_reg(),
1243 * so call core_scsi3_put_pr_reg() to decrement our reference.
1246 core_scsi3_put_pr_reg(pr_reg);
1248 * Wait until all reference from any other I_T nexuses for this
1249 * *pr_reg have been released. Because list_del() is called above,
1250 * the last core_scsi3_put_pr_reg(pr_reg) will release this reference
1251 * count back to zero, and we release *pr_reg.
1253 while (atomic_read(&pr_reg->pr_res_holders) != 0) {
1254 spin_unlock(&pr_tmpl->registration_lock);
1255 pr_debug("SPC-3 PR [%s] waiting for pr_res_holders\n",
1256 tfo->get_fabric_name());
1258 spin_lock(&pr_tmpl->registration_lock);
1261 pr_debug("SPC-3 PR [%s] Service Action: UNREGISTER Initiator"
1262 " Node: %s%s\n", tfo->get_fabric_name(),
1263 pr_reg->pr_reg_nacl->initiatorname,
1265 pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
1266 " Port(s)\n", tfo->get_fabric_name(),
1267 (pr_reg->pr_reg_all_tg_pt) ? "ALL" : "SINGLE",
1268 dev->transport->name);
1269 pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
1270 " 0x%08x\n", tfo->get_fabric_name(), pr_reg->pr_res_key,
1271 pr_reg->pr_res_generation);
1273 if (!preempt_and_abort_list) {
1274 pr_reg->pr_reg_deve = NULL;
1275 pr_reg->pr_reg_nacl = NULL;
1276 kfree(pr_reg->pr_aptpl_buf);
1277 kmem_cache_free(t10_pr_reg_cache, pr_reg);
1281 * For PREEMPT_AND_ABORT, the list of *pr_reg in preempt_and_abort_list
1282 * are released once the ABORT_TASK_SET has completed..
1284 list_add_tail(&pr_reg->pr_reg_abort_list, preempt_and_abort_list);
1287 void core_scsi3_free_pr_reg_from_nacl(
1288 struct se_device *dev,
1289 struct se_node_acl *nacl)
1291 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1292 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_res_holder;
1294 * If the passed se_node_acl matches the reservation holder,
1295 * release the reservation.
1297 spin_lock(&dev->dev_reservation_lock);
1298 pr_res_holder = dev->dev_pr_res_holder;
1299 if ((pr_res_holder != NULL) &&
1300 (pr_res_holder->pr_reg_nacl == nacl))
1301 __core_scsi3_complete_pro_release(dev, nacl, pr_res_holder, 0);
1302 spin_unlock(&dev->dev_reservation_lock);
1304 * Release any registration associated with the struct se_node_acl.
1306 spin_lock(&pr_tmpl->registration_lock);
1307 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1308 &pr_tmpl->registration_list, pr_reg_list) {
1310 if (pr_reg->pr_reg_nacl != nacl)
1313 __core_scsi3_free_registration(dev, pr_reg, NULL, 0);
1315 spin_unlock(&pr_tmpl->registration_lock);
1318 void core_scsi3_free_all_registrations(
1319 struct se_device *dev)
1321 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1322 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_res_holder;
1324 spin_lock(&dev->dev_reservation_lock);
1325 pr_res_holder = dev->dev_pr_res_holder;
1326 if (pr_res_holder != NULL) {
1327 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
1328 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
1331 spin_unlock(&dev->dev_reservation_lock);
1333 spin_lock(&pr_tmpl->registration_lock);
1334 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1335 &pr_tmpl->registration_list, pr_reg_list) {
1337 __core_scsi3_free_registration(dev, pr_reg, NULL, 0);
1339 spin_unlock(&pr_tmpl->registration_lock);
1341 spin_lock(&pr_tmpl->aptpl_reg_lock);
1342 list_for_each_entry_safe(pr_reg, pr_reg_tmp, &pr_tmpl->aptpl_reg_list,
1343 pr_reg_aptpl_list) {
1344 list_del(&pr_reg->pr_reg_aptpl_list);
1345 kfree(pr_reg->pr_aptpl_buf);
1346 kmem_cache_free(t10_pr_reg_cache, pr_reg);
1348 spin_unlock(&pr_tmpl->aptpl_reg_lock);
1351 static int core_scsi3_tpg_depend_item(struct se_portal_group *tpg)
1353 return configfs_depend_item(tpg->se_tpg_tfo->tf_subsys,
1354 &tpg->tpg_group.cg_item);
1357 static void core_scsi3_tpg_undepend_item(struct se_portal_group *tpg)
1359 configfs_undepend_item(tpg->se_tpg_tfo->tf_subsys,
1360 &tpg->tpg_group.cg_item);
1362 atomic_dec(&tpg->tpg_pr_ref_count);
1363 smp_mb__after_atomic_dec();
1366 static int core_scsi3_nodeacl_depend_item(struct se_node_acl *nacl)
1368 struct se_portal_group *tpg = nacl->se_tpg;
1370 if (nacl->dynamic_node_acl)
1373 return configfs_depend_item(tpg->se_tpg_tfo->tf_subsys,
1374 &nacl->acl_group.cg_item);
1377 static void core_scsi3_nodeacl_undepend_item(struct se_node_acl *nacl)
1379 struct se_portal_group *tpg = nacl->se_tpg;
1381 if (nacl->dynamic_node_acl) {
1382 atomic_dec(&nacl->acl_pr_ref_count);
1383 smp_mb__after_atomic_dec();
1387 configfs_undepend_item(tpg->se_tpg_tfo->tf_subsys,
1388 &nacl->acl_group.cg_item);
1390 atomic_dec(&nacl->acl_pr_ref_count);
1391 smp_mb__after_atomic_dec();
1394 static int core_scsi3_lunacl_depend_item(struct se_dev_entry *se_deve)
1396 struct se_lun_acl *lun_acl = se_deve->se_lun_acl;
1397 struct se_node_acl *nacl;
1398 struct se_portal_group *tpg;
1400 * For nacl->dynamic_node_acl=1
1405 nacl = lun_acl->se_lun_nacl;
1408 return configfs_depend_item(tpg->se_tpg_tfo->tf_subsys,
1409 &lun_acl->se_lun_group.cg_item);
1412 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry *se_deve)
1414 struct se_lun_acl *lun_acl = se_deve->se_lun_acl;
1415 struct se_node_acl *nacl;
1416 struct se_portal_group *tpg;
1418 * For nacl->dynamic_node_acl=1
1421 atomic_dec(&se_deve->pr_ref_count);
1422 smp_mb__after_atomic_dec();
1425 nacl = lun_acl->se_lun_nacl;
1428 configfs_undepend_item(tpg->se_tpg_tfo->tf_subsys,
1429 &lun_acl->se_lun_group.cg_item);
1431 atomic_dec(&se_deve->pr_ref_count);
1432 smp_mb__after_atomic_dec();
1435 static sense_reason_t
1436 core_scsi3_decode_spec_i_port(
1438 struct se_portal_group *tpg,
1439 unsigned char *l_isid,
1444 struct se_device *dev = cmd->se_dev;
1445 struct se_port *tmp_port;
1446 struct se_portal_group *dest_tpg = NULL, *tmp_tpg;
1447 struct se_session *se_sess = cmd->se_sess;
1448 struct se_node_acl *dest_node_acl = NULL;
1449 struct se_dev_entry *dest_se_deve = NULL, *local_se_deve;
1450 struct t10_pr_registration *dest_pr_reg, *local_pr_reg, *pr_reg_e;
1451 struct t10_pr_registration *pr_reg_tmp, *pr_reg_tmp_safe;
1452 LIST_HEAD(tid_dest_list);
1453 struct pr_transport_id_holder *tidh_new, *tidh, *tidh_tmp;
1454 struct target_core_fabric_ops *tmp_tf_ops;
1456 unsigned char *ptr, *i_str = NULL, proto_ident, tmp_proto_ident;
1457 char *iport_ptr = NULL, dest_iport[64], i_buf[PR_REG_ISID_ID_LEN];
1459 u32 tpdl, tid_len = 0;
1460 int dest_local_nexus;
1463 memset(dest_iport, 0, 64);
1465 local_se_deve = se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
1467 * Allocate a struct pr_transport_id_holder and setup the
1468 * local_node_acl and local_se_deve pointers and add to
1469 * struct list_head tid_dest_list for add registration
1470 * processing in the loop of tid_dest_list below.
1472 tidh_new = kzalloc(sizeof(struct pr_transport_id_holder), GFP_KERNEL);
1474 pr_err("Unable to allocate tidh_new\n");
1475 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1477 INIT_LIST_HEAD(&tidh_new->dest_list);
1478 tidh_new->dest_tpg = tpg;
1479 tidh_new->dest_node_acl = se_sess->se_node_acl;
1480 tidh_new->dest_se_deve = local_se_deve;
1482 local_pr_reg = __core_scsi3_alloc_registration(cmd->se_dev,
1483 se_sess->se_node_acl, local_se_deve, l_isid,
1484 sa_res_key, all_tg_pt, aptpl);
1485 if (!local_pr_reg) {
1487 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1489 tidh_new->dest_pr_reg = local_pr_reg;
1491 * The local I_T nexus does not hold any configfs dependances,
1492 * so we set tid_h->dest_local_nexus=1 to prevent the
1493 * configfs_undepend_item() calls in the tid_dest_list loops below.
1495 tidh_new->dest_local_nexus = 1;
1496 list_add_tail(&tidh_new->dest_list, &tid_dest_list);
1498 if (cmd->data_length < 28) {
1499 pr_warn("SPC-PR: Received PR OUT parameter list"
1500 " length too small: %u\n", cmd->data_length);
1501 ret = TCM_INVALID_PARAMETER_LIST;
1505 buf = transport_kmap_data_sg(cmd);
1507 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1512 * For a PERSISTENT RESERVE OUT specify initiator ports payload,
1513 * first extract TransportID Parameter Data Length, and make sure
1514 * the value matches up to the SCSI expected data transfer length.
1516 tpdl = (buf[24] & 0xff) << 24;
1517 tpdl |= (buf[25] & 0xff) << 16;
1518 tpdl |= (buf[26] & 0xff) << 8;
1519 tpdl |= buf[27] & 0xff;
1521 if ((tpdl + 28) != cmd->data_length) {
1522 pr_err("SPC-3 PR: Illegal tpdl: %u + 28 byte header"
1523 " does not equal CDB data_length: %u\n", tpdl,
1525 ret = TCM_INVALID_PARAMETER_LIST;
1529 * Start processing the received transport IDs using the
1530 * receiving I_T Nexus portal's fabric dependent methods to
1531 * obtain the SCSI Initiator Port/Device Identifiers.
1536 proto_ident = (ptr[0] & 0x0f);
1539 spin_lock(&dev->se_port_lock);
1540 list_for_each_entry(tmp_port, &dev->dev_sep_list, sep_list) {
1541 tmp_tpg = tmp_port->sep_tpg;
1544 tmp_tf_ops = tmp_tpg->se_tpg_tfo;
1547 if (!tmp_tf_ops->get_fabric_proto_ident ||
1548 !tmp_tf_ops->tpg_parse_pr_out_transport_id)
1551 * Look for the matching proto_ident provided by
1552 * the received TransportID
1554 tmp_proto_ident = tmp_tf_ops->get_fabric_proto_ident(tmp_tpg);
1555 if (tmp_proto_ident != proto_ident)
1557 dest_rtpi = tmp_port->sep_rtpi;
1559 i_str = tmp_tf_ops->tpg_parse_pr_out_transport_id(
1560 tmp_tpg, (const char *)ptr, &tid_len,
1565 atomic_inc(&tmp_tpg->tpg_pr_ref_count);
1566 smp_mb__after_atomic_inc();
1567 spin_unlock(&dev->se_port_lock);
1569 if (core_scsi3_tpg_depend_item(tmp_tpg)) {
1570 pr_err(" core_scsi3_tpg_depend_item()"
1572 atomic_dec(&tmp_tpg->tpg_pr_ref_count);
1573 smp_mb__after_atomic_dec();
1574 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1578 * Locate the destination initiator ACL to be registered
1579 * from the decoded fabric module specific TransportID
1582 spin_lock_irq(&tmp_tpg->acl_node_lock);
1583 dest_node_acl = __core_tpg_get_initiator_node_acl(
1585 if (dest_node_acl) {
1586 atomic_inc(&dest_node_acl->acl_pr_ref_count);
1587 smp_mb__after_atomic_inc();
1589 spin_unlock_irq(&tmp_tpg->acl_node_lock);
1591 if (!dest_node_acl) {
1592 core_scsi3_tpg_undepend_item(tmp_tpg);
1593 spin_lock(&dev->se_port_lock);
1597 if (core_scsi3_nodeacl_depend_item(dest_node_acl)) {
1598 pr_err("configfs_depend_item() failed"
1599 " for dest_node_acl->acl_group\n");
1600 atomic_dec(&dest_node_acl->acl_pr_ref_count);
1601 smp_mb__after_atomic_dec();
1602 core_scsi3_tpg_undepend_item(tmp_tpg);
1603 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1608 pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node:"
1609 " %s Port RTPI: %hu\n",
1610 dest_tpg->se_tpg_tfo->get_fabric_name(),
1611 dest_node_acl->initiatorname, dest_rtpi);
1613 spin_lock(&dev->se_port_lock);
1616 spin_unlock(&dev->se_port_lock);
1619 pr_err("SPC-3 PR SPEC_I_PT: Unable to locate"
1621 ret = TCM_INVALID_PARAMETER_LIST;
1625 pr_debug("SPC-3 PR SPEC_I_PT: Got %s data_length: %u tpdl: %u"
1626 " tid_len: %d for %s + %s\n",
1627 dest_tpg->se_tpg_tfo->get_fabric_name(), cmd->data_length,
1628 tpdl, tid_len, i_str, iport_ptr);
1630 if (tid_len > tpdl) {
1631 pr_err("SPC-3 PR SPEC_I_PT: Illegal tid_len:"
1632 " %u for Transport ID: %s\n", tid_len, ptr);
1633 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1634 core_scsi3_tpg_undepend_item(dest_tpg);
1635 ret = TCM_INVALID_PARAMETER_LIST;
1639 * Locate the desintation struct se_dev_entry pointer for matching
1640 * RELATIVE TARGET PORT IDENTIFIER on the receiving I_T Nexus
1643 dest_se_deve = core_get_se_deve_from_rtpi(dest_node_acl,
1645 if (!dest_se_deve) {
1646 pr_err("Unable to locate %s dest_se_deve"
1647 " from destination RTPI: %hu\n",
1648 dest_tpg->se_tpg_tfo->get_fabric_name(),
1651 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1652 core_scsi3_tpg_undepend_item(dest_tpg);
1653 ret = TCM_INVALID_PARAMETER_LIST;
1657 if (core_scsi3_lunacl_depend_item(dest_se_deve)) {
1658 pr_err("core_scsi3_lunacl_depend_item()"
1660 atomic_dec(&dest_se_deve->pr_ref_count);
1661 smp_mb__after_atomic_dec();
1662 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1663 core_scsi3_tpg_undepend_item(dest_tpg);
1664 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1668 pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node: %s"
1669 " dest_se_deve mapped_lun: %u\n",
1670 dest_tpg->se_tpg_tfo->get_fabric_name(),
1671 dest_node_acl->initiatorname, dest_se_deve->mapped_lun);
1674 * Skip any TransportIDs that already have a registration for
1677 pr_reg_e = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
1680 core_scsi3_put_pr_reg(pr_reg_e);
1681 core_scsi3_lunacl_undepend_item(dest_se_deve);
1682 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1683 core_scsi3_tpg_undepend_item(dest_tpg);
1690 * Allocate a struct pr_transport_id_holder and setup
1691 * the dest_node_acl and dest_se_deve pointers for the
1694 tidh_new = kzalloc(sizeof(struct pr_transport_id_holder),
1697 pr_err("Unable to allocate tidh_new\n");
1698 core_scsi3_lunacl_undepend_item(dest_se_deve);
1699 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1700 core_scsi3_tpg_undepend_item(dest_tpg);
1701 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1704 INIT_LIST_HEAD(&tidh_new->dest_list);
1705 tidh_new->dest_tpg = dest_tpg;
1706 tidh_new->dest_node_acl = dest_node_acl;
1707 tidh_new->dest_se_deve = dest_se_deve;
1710 * Allocate, but do NOT add the registration for the
1711 * TransportID referenced SCSI Initiator port. This
1712 * done because of the following from spc4r17 in section
1713 * 6.14.3 wrt SPEC_I_PT:
1715 * "If a registration fails for any initiator port (e.g., if th
1716 * logical unit does not have enough resources available to
1717 * hold the registration information), no registrations shall be
1718 * made, and the command shall be terminated with
1719 * CHECK CONDITION status."
1721 * That means we call __core_scsi3_alloc_registration() here,
1722 * and then call __core_scsi3_add_registration() in the
1723 * 2nd loop which will never fail.
1725 dest_pr_reg = __core_scsi3_alloc_registration(cmd->se_dev,
1726 dest_node_acl, dest_se_deve, iport_ptr,
1727 sa_res_key, all_tg_pt, aptpl);
1729 core_scsi3_lunacl_undepend_item(dest_se_deve);
1730 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1731 core_scsi3_tpg_undepend_item(dest_tpg);
1733 ret = TCM_INVALID_PARAMETER_LIST;
1736 tidh_new->dest_pr_reg = dest_pr_reg;
1737 list_add_tail(&tidh_new->dest_list, &tid_dest_list);
1745 transport_kunmap_data_sg(cmd);
1748 * Go ahead and create a registrations from tid_dest_list for the
1749 * SPEC_I_PT provided TransportID for the *tidh referenced dest_node_acl
1752 * The SA Reservation Key from the PROUT is set for the
1753 * registration, and ALL_TG_PT is also passed. ALL_TG_PT=1
1754 * means that the TransportID Initiator port will be
1755 * registered on all of the target ports in the SCSI target device
1756 * ALL_TG_PT=0 means the registration will only be for the
1757 * SCSI target port the PROUT REGISTER with SPEC_I_PT=1
1760 list_for_each_entry_safe(tidh, tidh_tmp, &tid_dest_list, dest_list) {
1761 dest_tpg = tidh->dest_tpg;
1762 dest_node_acl = tidh->dest_node_acl;
1763 dest_se_deve = tidh->dest_se_deve;
1764 dest_pr_reg = tidh->dest_pr_reg;
1765 dest_local_nexus = tidh->dest_local_nexus;
1767 list_del(&tidh->dest_list);
1770 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
1771 core_pr_dump_initiator_port(dest_pr_reg, i_buf, PR_REG_ISID_ID_LEN);
1773 __core_scsi3_add_registration(cmd->se_dev, dest_node_acl,
1776 pr_debug("SPC-3 PR [%s] SPEC_I_PT: Successfully"
1777 " registered Transport ID for Node: %s%s Mapped LUN:"
1778 " %u\n", dest_tpg->se_tpg_tfo->get_fabric_name(),
1779 dest_node_acl->initiatorname, i_buf, dest_se_deve->mapped_lun);
1781 if (dest_local_nexus)
1784 core_scsi3_lunacl_undepend_item(dest_se_deve);
1785 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1786 core_scsi3_tpg_undepend_item(dest_tpg);
1791 transport_kunmap_data_sg(cmd);
1794 * For the failure case, release everything from tid_dest_list
1795 * including *dest_pr_reg and the configfs dependances..
1797 list_for_each_entry_safe(tidh, tidh_tmp, &tid_dest_list, dest_list) {
1798 dest_tpg = tidh->dest_tpg;
1799 dest_node_acl = tidh->dest_node_acl;
1800 dest_se_deve = tidh->dest_se_deve;
1801 dest_pr_reg = tidh->dest_pr_reg;
1802 dest_local_nexus = tidh->dest_local_nexus;
1804 list_del(&tidh->dest_list);
1807 * Release any extra ALL_TG_PT=1 registrations for
1808 * the SPEC_I_PT=1 case.
1810 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
1811 &dest_pr_reg->pr_reg_atp_list,
1812 pr_reg_atp_mem_list) {
1813 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
1814 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
1815 kmem_cache_free(t10_pr_reg_cache, pr_reg_tmp);
1818 kfree(dest_pr_reg->pr_aptpl_buf);
1819 kmem_cache_free(t10_pr_reg_cache, dest_pr_reg);
1821 if (dest_local_nexus)
1824 core_scsi3_lunacl_undepend_item(dest_se_deve);
1825 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1826 core_scsi3_tpg_undepend_item(dest_tpg);
1832 * Called with struct se_device->dev_reservation_lock held
1834 static int __core_scsi3_update_aptpl_buf(
1835 struct se_device *dev,
1837 u32 pr_aptpl_buf_len,
1838 int clear_aptpl_metadata)
1841 struct se_portal_group *tpg;
1842 struct t10_pr_registration *pr_reg;
1843 unsigned char tmp[512], isid_buf[32];
1847 memset(buf, 0, pr_aptpl_buf_len);
1849 * Called to clear metadata once APTPL has been deactivated.
1851 if (clear_aptpl_metadata) {
1852 snprintf(buf, pr_aptpl_buf_len,
1853 "No Registrations or Reservations\n");
1857 * Walk the registration list..
1859 spin_lock(&dev->t10_pr.registration_lock);
1860 list_for_each_entry(pr_reg, &dev->t10_pr.registration_list,
1865 tpg = pr_reg->pr_reg_nacl->se_tpg;
1866 lun = pr_reg->pr_reg_tg_pt_lun;
1868 * Write out any ISID value to APTPL metadata that was included
1869 * in the original registration.
1871 if (pr_reg->isid_present_at_reg)
1872 snprintf(isid_buf, 32, "initiator_sid=%s\n",
1873 pr_reg->pr_reg_isid);
1875 * Include special metadata if the pr_reg matches the
1876 * reservation holder.
1878 if (dev->dev_pr_res_holder == pr_reg) {
1879 snprintf(tmp, 512, "PR_REG_START: %d"
1880 "\ninitiator_fabric=%s\n"
1881 "initiator_node=%s\n%s"
1883 "res_holder=1\nres_type=%02x\n"
1884 "res_scope=%02x\nres_all_tg_pt=%d\n"
1885 "mapped_lun=%u\n", reg_count,
1886 tpg->se_tpg_tfo->get_fabric_name(),
1887 pr_reg->pr_reg_nacl->initiatorname, isid_buf,
1888 pr_reg->pr_res_key, pr_reg->pr_res_type,
1889 pr_reg->pr_res_scope, pr_reg->pr_reg_all_tg_pt,
1890 pr_reg->pr_res_mapped_lun);
1892 snprintf(tmp, 512, "PR_REG_START: %d\n"
1893 "initiator_fabric=%s\ninitiator_node=%s\n%s"
1894 "sa_res_key=%llu\nres_holder=0\n"
1895 "res_all_tg_pt=%d\nmapped_lun=%u\n",
1896 reg_count, tpg->se_tpg_tfo->get_fabric_name(),
1897 pr_reg->pr_reg_nacl->initiatorname, isid_buf,
1898 pr_reg->pr_res_key, pr_reg->pr_reg_all_tg_pt,
1899 pr_reg->pr_res_mapped_lun);
1902 if ((len + strlen(tmp) >= pr_aptpl_buf_len)) {
1903 pr_err("Unable to update renaming"
1904 " APTPL metadata\n");
1905 spin_unlock(&dev->t10_pr.registration_lock);
1908 len += sprintf(buf+len, "%s", tmp);
1911 * Include information about the associated SCSI target port.
1913 snprintf(tmp, 512, "target_fabric=%s\ntarget_node=%s\n"
1914 "tpgt=%hu\nport_rtpi=%hu\ntarget_lun=%u\nPR_REG_END:"
1915 " %d\n", tpg->se_tpg_tfo->get_fabric_name(),
1916 tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1917 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1918 lun->lun_sep->sep_rtpi, lun->unpacked_lun, reg_count);
1920 if ((len + strlen(tmp) >= pr_aptpl_buf_len)) {
1921 pr_err("Unable to update renaming"
1922 " APTPL metadata\n");
1923 spin_unlock(&dev->t10_pr.registration_lock);
1926 len += sprintf(buf+len, "%s", tmp);
1929 spin_unlock(&dev->t10_pr.registration_lock);
1932 len += sprintf(buf+len, "No Registrations or Reservations");
1937 static int core_scsi3_update_aptpl_buf(
1938 struct se_device *dev,
1940 u32 pr_aptpl_buf_len,
1941 int clear_aptpl_metadata)
1945 spin_lock(&dev->dev_reservation_lock);
1946 ret = __core_scsi3_update_aptpl_buf(dev, buf, pr_aptpl_buf_len,
1947 clear_aptpl_metadata);
1948 spin_unlock(&dev->dev_reservation_lock);
1954 * Called with struct se_device->aptpl_file_mutex held
1956 static int __core_scsi3_write_aptpl_to_file(
1957 struct se_device *dev,
1959 u32 pr_aptpl_buf_len)
1961 struct t10_wwn *wwn = &dev->t10_wwn;
1963 int flags = O_RDWR | O_CREAT | O_TRUNC;
1967 memset(path, 0, 512);
1969 if (strlen(&wwn->unit_serial[0]) >= 512) {
1970 pr_err("WWN value for struct se_device does not fit"
1971 " into path buffer\n");
1975 snprintf(path, 512, "/var/target/pr/aptpl_%s", &wwn->unit_serial[0]);
1976 file = filp_open(path, flags, 0600);
1978 pr_err("filp_open(%s) for APTPL metadata"
1980 return PTR_ERR(file);
1983 if (!pr_aptpl_buf_len)
1984 pr_aptpl_buf_len = (strlen(&buf[0]) + 1); /* Add extra for NULL */
1986 ret = kernel_write(file, buf, pr_aptpl_buf_len, 0);
1989 pr_debug("Error writing APTPL metadata file: %s\n", path);
1992 return ret ? -EIO : 0;
1996 core_scsi3_update_and_write_aptpl(struct se_device *dev, unsigned char *in_buf,
1997 u32 in_pr_aptpl_buf_len)
1999 unsigned char null_buf[64], *buf;
2000 u32 pr_aptpl_buf_len;
2001 int clear_aptpl_metadata = 0;
2005 * Can be called with a NULL pointer from PROUT service action CLEAR
2008 memset(null_buf, 0, 64);
2011 * This will clear the APTPL metadata to:
2012 * "No Registrations or Reservations" status
2014 pr_aptpl_buf_len = 64;
2015 clear_aptpl_metadata = 1;
2018 pr_aptpl_buf_len = in_pr_aptpl_buf_len;
2021 ret = core_scsi3_update_aptpl_buf(dev, buf, pr_aptpl_buf_len,
2022 clear_aptpl_metadata);
2027 * __core_scsi3_write_aptpl_to_file() will call strlen()
2028 * on the passed buf to determine pr_aptpl_buf_len.
2030 return __core_scsi3_write_aptpl_to_file(dev, buf, 0);
2033 static sense_reason_t
2034 core_scsi3_emulate_pro_register(struct se_cmd *cmd, u64 res_key, u64 sa_res_key,
2035 int aptpl, int all_tg_pt, int spec_i_pt, enum register_type register_type)
2037 struct se_session *se_sess = cmd->se_sess;
2038 struct se_device *dev = cmd->se_dev;
2039 struct se_dev_entry *se_deve;
2040 struct se_lun *se_lun = cmd->se_lun;
2041 struct se_portal_group *se_tpg;
2042 struct t10_pr_registration *pr_reg, *pr_reg_p, *pr_reg_tmp, *pr_reg_e;
2043 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2044 /* Used for APTPL metadata w/ UNREGISTER */
2045 unsigned char *pr_aptpl_buf = NULL;
2046 unsigned char isid_buf[PR_REG_ISID_LEN], *isid_ptr = NULL;
2047 sense_reason_t ret = TCM_NO_SENSE;
2048 int pr_holder = 0, type;
2050 if (!se_sess || !se_lun) {
2051 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2052 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2054 se_tpg = se_sess->se_tpg;
2055 se_deve = se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
2057 if (se_tpg->se_tpg_tfo->sess_get_initiator_sid) {
2058 memset(&isid_buf[0], 0, PR_REG_ISID_LEN);
2059 se_tpg->se_tpg_tfo->sess_get_initiator_sid(se_sess, &isid_buf[0],
2061 isid_ptr = &isid_buf[0];
2064 * Follow logic from spc4r17 Section 5.7.7, Register Behaviors Table 47
2066 pr_reg_e = core_scsi3_locate_pr_reg(dev, se_sess->se_node_acl, se_sess);
2069 pr_warn("SPC-3 PR: Reservation Key non-zero"
2070 " for SA REGISTER, returning CONFLICT\n");
2071 return TCM_RESERVATION_CONFLICT;
2074 * Do nothing but return GOOD status.
2081 * Perform the Service Action REGISTER on the Initiator
2082 * Port Endpoint that the PRO was received from on the
2083 * Logical Unit of the SCSI device server.
2085 if (core_scsi3_alloc_registration(cmd->se_dev,
2086 se_sess->se_node_acl, se_deve, isid_ptr,
2087 sa_res_key, all_tg_pt, aptpl,
2088 register_type, 0)) {
2089 pr_err("Unable to allocate"
2090 " struct t10_pr_registration\n");
2091 return TCM_INVALID_PARAMETER_LIST;
2095 * Register both the Initiator port that received
2096 * PROUT SA REGISTER + SPEC_I_PT=1 and extract SCSI
2097 * TransportID from Parameter list and loop through
2098 * fabric dependent parameter list while calling
2099 * logic from of core_scsi3_alloc_registration() for
2100 * each TransportID provided SCSI Initiator Port/Device
2102 ret = core_scsi3_decode_spec_i_port(cmd, se_tpg,
2103 isid_ptr, sa_res_key, all_tg_pt, aptpl);
2108 * Nothing left to do for the APTPL=0 case.
2111 pr_tmpl->pr_aptpl_active = 0;
2112 core_scsi3_update_and_write_aptpl(cmd->se_dev, NULL, 0);
2113 pr_debug("SPC-3 PR: Set APTPL Bit Deactivated for"
2118 * Locate the newly allocated local I_T Nexus *pr_reg, and
2119 * update the APTPL metadata information using its
2120 * preallocated *pr_reg->pr_aptpl_buf.
2122 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev,
2123 se_sess->se_node_acl, se_sess);
2125 if (core_scsi3_update_and_write_aptpl(cmd->se_dev,
2126 &pr_reg->pr_aptpl_buf[0],
2127 pr_tmpl->pr_aptpl_buf_len)) {
2128 pr_tmpl->pr_aptpl_active = 1;
2129 pr_debug("SPC-3 PR: Set APTPL Bit Activated for REGISTER\n");
2132 goto out_put_pr_reg;
2136 * Locate the existing *pr_reg via struct se_node_acl pointers
2139 type = pr_reg->pr_res_type;
2141 if (register_type == REGISTER) {
2142 if (res_key != pr_reg->pr_res_key) {
2143 pr_err("SPC-3 PR REGISTER: Received"
2144 " res_key: 0x%016Lx does not match"
2145 " existing SA REGISTER res_key:"
2146 " 0x%016Lx\n", res_key,
2147 pr_reg->pr_res_key);
2148 ret = TCM_RESERVATION_CONFLICT;
2149 goto out_put_pr_reg;
2154 pr_err("SPC-3 PR REGISTER: SPEC_I_PT"
2155 " set on a registered nexus\n");
2156 ret = TCM_INVALID_PARAMETER_LIST;
2157 goto out_put_pr_reg;
2161 * An existing ALL_TG_PT=1 registration being released
2162 * must also set ALL_TG_PT=1 in the incoming PROUT.
2164 if (pr_reg->pr_reg_all_tg_pt && !all_tg_pt) {
2165 pr_err("SPC-3 PR REGISTER: ALL_TG_PT=1"
2166 " registration exists, but ALL_TG_PT=1 bit not"
2167 " present in received PROUT\n");
2168 ret = TCM_INVALID_CDB_FIELD;
2169 goto out_put_pr_reg;
2173 * Allocate APTPL metadata buffer used for UNREGISTER ops
2176 pr_aptpl_buf = kzalloc(pr_tmpl->pr_aptpl_buf_len,
2178 if (!pr_aptpl_buf) {
2179 pr_err("Unable to allocate"
2181 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2182 goto out_put_pr_reg;
2187 * sa_res_key=0 Unregister Reservation Key for registered I_T
2188 * Nexus sa_res_key=1 Change Reservation Key for registered I_T
2192 pr_holder = core_scsi3_check_implict_release(
2193 cmd->se_dev, pr_reg);
2194 if (pr_holder < 0) {
2195 kfree(pr_aptpl_buf);
2196 ret = TCM_RESERVATION_CONFLICT;
2197 goto out_put_pr_reg;
2200 spin_lock(&pr_tmpl->registration_lock);
2202 * Release all ALL_TG_PT=1 for the matching SCSI Initiator Port
2203 * and matching pr_res_key.
2205 if (pr_reg->pr_reg_all_tg_pt) {
2206 list_for_each_entry_safe(pr_reg_p, pr_reg_tmp,
2207 &pr_tmpl->registration_list,
2210 if (!pr_reg_p->pr_reg_all_tg_pt)
2212 if (pr_reg_p->pr_res_key != res_key)
2214 if (pr_reg == pr_reg_p)
2216 if (strcmp(pr_reg->pr_reg_nacl->initiatorname,
2217 pr_reg_p->pr_reg_nacl->initiatorname))
2220 __core_scsi3_free_registration(dev,
2226 * Release the calling I_T Nexus registration now..
2228 __core_scsi3_free_registration(cmd->se_dev, pr_reg, NULL, 1);
2231 * From spc4r17, section 5.7.11.3 Unregistering
2233 * If the persistent reservation is a registrants only
2234 * type, the device server shall establish a unit
2235 * attention condition for the initiator port associated
2236 * with every registered I_T nexus except for the I_T
2237 * nexus on which the PERSISTENT RESERVE OUT command was
2238 * received, with the additional sense code set to
2239 * RESERVATIONS RELEASED.
2242 (type == PR_TYPE_WRITE_EXCLUSIVE_REGONLY ||
2243 type == PR_TYPE_EXCLUSIVE_ACCESS_REGONLY)) {
2244 list_for_each_entry(pr_reg_p,
2245 &pr_tmpl->registration_list,
2248 core_scsi3_ua_allocate(
2249 pr_reg_p->pr_reg_nacl,
2250 pr_reg_p->pr_res_mapped_lun,
2252 ASCQ_2AH_RESERVATIONS_RELEASED);
2255 spin_unlock(&pr_tmpl->registration_lock);
2258 pr_tmpl->pr_aptpl_active = 0;
2259 core_scsi3_update_and_write_aptpl(dev, NULL, 0);
2260 pr_debug("SPC-3 PR: Set APTPL Bit Deactivated"
2261 " for UNREGISTER\n");
2265 if (!core_scsi3_update_and_write_aptpl(dev, &pr_aptpl_buf[0],
2266 pr_tmpl->pr_aptpl_buf_len)) {
2267 pr_tmpl->pr_aptpl_active = 1;
2268 pr_debug("SPC-3 PR: Set APTPL Bit Activated"
2269 " for UNREGISTER\n");
2272 goto out_free_aptpl_buf;
2276 * Increment PRgeneration counter for struct se_device"
2277 * upon a successful REGISTER, see spc4r17 section 6.3.2
2278 * READ_KEYS service action.
2280 pr_reg->pr_res_generation = core_scsi3_pr_generation(cmd->se_dev);
2281 pr_reg->pr_res_key = sa_res_key;
2282 pr_debug("SPC-3 PR [%s] REGISTER%s: Changed Reservation"
2283 " Key for %s to: 0x%016Lx PRgeneration:"
2284 " 0x%08x\n", cmd->se_tfo->get_fabric_name(),
2285 (register_type == REGISTER_AND_IGNORE_EXISTING_KEY) ? "_AND_IGNORE_EXISTING_KEY" : "",
2286 pr_reg->pr_reg_nacl->initiatorname,
2287 pr_reg->pr_res_key, pr_reg->pr_res_generation);
2290 pr_tmpl->pr_aptpl_active = 0;
2291 core_scsi3_update_and_write_aptpl(dev, NULL, 0);
2292 pr_debug("SPC-3 PR: Set APTPL Bit Deactivated"
2295 goto out_put_pr_reg;
2298 if (!core_scsi3_update_and_write_aptpl(dev, &pr_aptpl_buf[0],
2299 pr_tmpl->pr_aptpl_buf_len)) {
2300 pr_tmpl->pr_aptpl_active = 1;
2301 pr_debug("SPC-3 PR: Set APTPL Bit Activated"
2306 kfree(pr_aptpl_buf);
2309 core_scsi3_put_pr_reg(pr_reg);
2313 unsigned char *core_scsi3_pr_dump_type(int type)
2316 case PR_TYPE_WRITE_EXCLUSIVE:
2317 return "Write Exclusive Access";
2318 case PR_TYPE_EXCLUSIVE_ACCESS:
2319 return "Exclusive Access";
2320 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
2321 return "Write Exclusive Access, Registrants Only";
2322 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
2323 return "Exclusive Access, Registrants Only";
2324 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
2325 return "Write Exclusive Access, All Registrants";
2326 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
2327 return "Exclusive Access, All Registrants";
2332 return "Unknown SPC-3 PR Type";
2335 static sense_reason_t
2336 core_scsi3_pro_reserve(struct se_cmd *cmd, int type, int scope, u64 res_key)
2338 struct se_device *dev = cmd->se_dev;
2339 struct se_session *se_sess = cmd->se_sess;
2340 struct se_lun *se_lun = cmd->se_lun;
2341 struct t10_pr_registration *pr_reg, *pr_res_holder;
2342 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2343 char i_buf[PR_REG_ISID_ID_LEN];
2346 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2348 if (!se_sess || !se_lun) {
2349 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2350 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2353 * Locate the existing *pr_reg via struct se_node_acl pointers
2355 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
2358 pr_err("SPC-3 PR: Unable to locate"
2359 " PR_REGISTERED *pr_reg for RESERVE\n");
2360 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2363 * From spc4r17 Section 5.7.9: Reserving:
2365 * An application client creates a persistent reservation by issuing
2366 * a PERSISTENT RESERVE OUT command with RESERVE service action through
2367 * a registered I_T nexus with the following parameters:
2368 * a) RESERVATION KEY set to the value of the reservation key that is
2369 * registered with the logical unit for the I_T nexus; and
2371 if (res_key != pr_reg->pr_res_key) {
2372 pr_err("SPC-3 PR RESERVE: Received res_key: 0x%016Lx"
2373 " does not match existing SA REGISTER res_key:"
2374 " 0x%016Lx\n", res_key, pr_reg->pr_res_key);
2375 ret = TCM_RESERVATION_CONFLICT;
2376 goto out_put_pr_reg;
2379 * From spc4r17 Section 5.7.9: Reserving:
2382 * b) TYPE field and SCOPE field set to the persistent reservation
2385 * Only one persistent reservation is allowed at a time per logical unit
2386 * and that persistent reservation has a scope of LU_SCOPE.
2388 if (scope != PR_SCOPE_LU_SCOPE) {
2389 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope);
2390 ret = TCM_INVALID_PARAMETER_LIST;
2391 goto out_put_pr_reg;
2394 * See if we have an existing PR reservation holder pointer at
2395 * struct se_device->dev_pr_res_holder in the form struct t10_pr_registration
2398 spin_lock(&dev->dev_reservation_lock);
2399 pr_res_holder = dev->dev_pr_res_holder;
2400 if (pr_res_holder) {
2402 * From spc4r17 Section 5.7.9: Reserving:
2404 * If the device server receives a PERSISTENT RESERVE OUT
2405 * command from an I_T nexus other than a persistent reservation
2406 * holder (see 5.7.10) that attempts to create a persistent
2407 * reservation when a persistent reservation already exists for
2408 * the logical unit, then the command shall be completed with
2409 * RESERVATION CONFLICT status.
2411 if (pr_res_holder != pr_reg) {
2412 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2413 pr_err("SPC-3 PR: Attempted RESERVE from"
2414 " [%s]: %s while reservation already held by"
2415 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2416 cmd->se_tfo->get_fabric_name(),
2417 se_sess->se_node_acl->initiatorname,
2418 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2419 pr_res_holder->pr_reg_nacl->initiatorname);
2421 spin_unlock(&dev->dev_reservation_lock);
2422 ret = TCM_RESERVATION_CONFLICT;
2423 goto out_put_pr_reg;
2426 * From spc4r17 Section 5.7.9: Reserving:
2428 * If a persistent reservation holder attempts to modify the
2429 * type or scope of an existing persistent reservation, the
2430 * command shall be completed with RESERVATION CONFLICT status.
2432 if ((pr_res_holder->pr_res_type != type) ||
2433 (pr_res_holder->pr_res_scope != scope)) {
2434 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2435 pr_err("SPC-3 PR: Attempted RESERVE from"
2436 " [%s]: %s trying to change TYPE and/or SCOPE,"
2437 " while reservation already held by [%s]: %s,"
2438 " returning RESERVATION_CONFLICT\n",
2439 cmd->se_tfo->get_fabric_name(),
2440 se_sess->se_node_acl->initiatorname,
2441 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2442 pr_res_holder->pr_reg_nacl->initiatorname);
2444 spin_unlock(&dev->dev_reservation_lock);
2445 ret = TCM_RESERVATION_CONFLICT;
2446 goto out_put_pr_reg;
2449 * From spc4r17 Section 5.7.9: Reserving:
2451 * If the device server receives a PERSISTENT RESERVE OUT
2452 * command with RESERVE service action where the TYPE field and
2453 * the SCOPE field contain the same values as the existing type
2454 * and scope from a persistent reservation holder, it shall not
2455 * make any change to the existing persistent reservation and
2456 * shall completethe command with GOOD status.
2458 spin_unlock(&dev->dev_reservation_lock);
2460 goto out_put_pr_reg;
2463 * Otherwise, our *pr_reg becomes the PR reservation holder for said
2464 * TYPE/SCOPE. Also set the received scope and type in *pr_reg.
2466 pr_reg->pr_res_scope = scope;
2467 pr_reg->pr_res_type = type;
2468 pr_reg->pr_res_holder = 1;
2469 dev->dev_pr_res_holder = pr_reg;
2470 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2472 pr_debug("SPC-3 PR [%s] Service Action: RESERVE created new"
2473 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2474 cmd->se_tfo->get_fabric_name(), core_scsi3_pr_dump_type(type),
2475 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2476 pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
2477 cmd->se_tfo->get_fabric_name(),
2478 se_sess->se_node_acl->initiatorname,
2480 spin_unlock(&dev->dev_reservation_lock);
2482 if (pr_tmpl->pr_aptpl_active) {
2483 if (!core_scsi3_update_and_write_aptpl(cmd->se_dev,
2484 &pr_reg->pr_aptpl_buf[0],
2485 pr_tmpl->pr_aptpl_buf_len)) {
2486 pr_debug("SPC-3 PR: Updated APTPL metadata"
2493 core_scsi3_put_pr_reg(pr_reg);
2497 static sense_reason_t
2498 core_scsi3_emulate_pro_reserve(struct se_cmd *cmd, int type, int scope,
2502 case PR_TYPE_WRITE_EXCLUSIVE:
2503 case PR_TYPE_EXCLUSIVE_ACCESS:
2504 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
2505 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
2506 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
2507 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
2508 return core_scsi3_pro_reserve(cmd, type, scope, res_key);
2510 pr_err("SPC-3 PR: Unknown Service Action RESERVE Type:"
2512 return TCM_INVALID_CDB_FIELD;
2517 * Called with struct se_device->dev_reservation_lock held.
2519 static void __core_scsi3_complete_pro_release(
2520 struct se_device *dev,
2521 struct se_node_acl *se_nacl,
2522 struct t10_pr_registration *pr_reg,
2525 struct target_core_fabric_ops *tfo = se_nacl->se_tpg->se_tpg_tfo;
2526 char i_buf[PR_REG_ISID_ID_LEN];
2528 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2529 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2531 * Go ahead and release the current PR reservation holder.
2533 dev->dev_pr_res_holder = NULL;
2535 pr_debug("SPC-3 PR [%s] Service Action: %s RELEASE cleared"
2536 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2537 tfo->get_fabric_name(), (explict) ? "explict" : "implict",
2538 core_scsi3_pr_dump_type(pr_reg->pr_res_type),
2539 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2540 pr_debug("SPC-3 PR [%s] RELEASE Node: %s%s\n",
2541 tfo->get_fabric_name(), se_nacl->initiatorname,
2544 * Clear TYPE and SCOPE for the next PROUT Service Action: RESERVE
2546 pr_reg->pr_res_holder = pr_reg->pr_res_type = pr_reg->pr_res_scope = 0;
2549 static sense_reason_t
2550 core_scsi3_emulate_pro_release(struct se_cmd *cmd, int type, int scope,
2553 struct se_device *dev = cmd->se_dev;
2554 struct se_session *se_sess = cmd->se_sess;
2555 struct se_lun *se_lun = cmd->se_lun;
2556 struct t10_pr_registration *pr_reg, *pr_reg_p, *pr_res_holder;
2557 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2559 sense_reason_t ret = 0;
2561 if (!se_sess || !se_lun) {
2562 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2563 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2566 * Locate the existing *pr_reg via struct se_node_acl pointers
2568 pr_reg = core_scsi3_locate_pr_reg(dev, se_sess->se_node_acl, se_sess);
2570 pr_err("SPC-3 PR: Unable to locate"
2571 " PR_REGISTERED *pr_reg for RELEASE\n");
2572 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2575 * From spc4r17 Section 5.7.11.2 Releasing:
2577 * If there is no persistent reservation or in response to a persistent
2578 * reservation release request from a registered I_T nexus that is not a
2579 * persistent reservation holder (see 5.7.10), the device server shall
2582 * a) Not release the persistent reservation, if any;
2583 * b) Not remove any registrations; and
2584 * c) Complete the command with GOOD status.
2586 spin_lock(&dev->dev_reservation_lock);
2587 pr_res_holder = dev->dev_pr_res_holder;
2588 if (!pr_res_holder) {
2590 * No persistent reservation, return GOOD status.
2592 spin_unlock(&dev->dev_reservation_lock);
2593 goto out_put_pr_reg;
2595 if ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2596 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))
2599 if ((all_reg == 0) && (pr_res_holder != pr_reg)) {
2601 * Non 'All Registrants' PR Type cases..
2602 * Release request from a registered I_T nexus that is not a
2603 * persistent reservation holder. return GOOD status.
2605 spin_unlock(&dev->dev_reservation_lock);
2606 goto out_put_pr_reg;
2610 * From spc4r17 Section 5.7.11.2 Releasing:
2612 * Only the persistent reservation holder (see 5.7.10) is allowed to
2613 * release a persistent reservation.
2615 * An application client releases the persistent reservation by issuing
2616 * a PERSISTENT RESERVE OUT command with RELEASE service action through
2617 * an I_T nexus that is a persistent reservation holder with the
2618 * following parameters:
2620 * a) RESERVATION KEY field set to the value of the reservation key
2621 * that is registered with the logical unit for the I_T nexus;
2623 if (res_key != pr_reg->pr_res_key) {
2624 pr_err("SPC-3 PR RELEASE: Received res_key: 0x%016Lx"
2625 " does not match existing SA REGISTER res_key:"
2626 " 0x%016Lx\n", res_key, pr_reg->pr_res_key);
2627 spin_unlock(&dev->dev_reservation_lock);
2628 ret = TCM_RESERVATION_CONFLICT;
2629 goto out_put_pr_reg;
2632 * From spc4r17 Section 5.7.11.2 Releasing and above:
2634 * b) TYPE field and SCOPE field set to match the persistent
2635 * reservation being released.
2637 if ((pr_res_holder->pr_res_type != type) ||
2638 (pr_res_holder->pr_res_scope != scope)) {
2639 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2640 pr_err("SPC-3 PR RELEASE: Attempted to release"
2641 " reservation from [%s]: %s with different TYPE "
2642 "and/or SCOPE while reservation already held by"
2643 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2644 cmd->se_tfo->get_fabric_name(),
2645 se_sess->se_node_acl->initiatorname,
2646 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2647 pr_res_holder->pr_reg_nacl->initiatorname);
2649 spin_unlock(&dev->dev_reservation_lock);
2650 ret = TCM_RESERVATION_CONFLICT;
2651 goto out_put_pr_reg;
2654 * In response to a persistent reservation release request from the
2655 * persistent reservation holder the device server shall perform a
2656 * release by doing the following as an uninterrupted series of actions:
2657 * a) Release the persistent reservation;
2658 * b) Not remove any registration(s);
2659 * c) If the released persistent reservation is a registrants only type
2660 * or all registrants type persistent reservation,
2661 * the device server shall establish a unit attention condition for
2662 * the initiator port associated with every regis-
2663 * tered I_T nexus other than I_T nexus on which the PERSISTENT
2664 * RESERVE OUT command with RELEASE service action was received,
2665 * with the additional sense code set to RESERVATIONS RELEASED; and
2666 * d) If the persistent reservation is of any other type, the device
2667 * server shall not establish a unit attention condition.
2669 __core_scsi3_complete_pro_release(dev, se_sess->se_node_acl,
2672 spin_unlock(&dev->dev_reservation_lock);
2674 if ((type != PR_TYPE_WRITE_EXCLUSIVE_REGONLY) &&
2675 (type != PR_TYPE_EXCLUSIVE_ACCESS_REGONLY) &&
2676 (type != PR_TYPE_WRITE_EXCLUSIVE_ALLREG) &&
2677 (type != PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
2679 * If no UNIT ATTENTION conditions will be established for
2680 * PR_TYPE_WRITE_EXCLUSIVE or PR_TYPE_EXCLUSIVE_ACCESS
2681 * go ahead and check for APTPL=1 update+write below
2686 spin_lock(&pr_tmpl->registration_lock);
2687 list_for_each_entry(pr_reg_p, &pr_tmpl->registration_list,
2690 * Do not establish a UNIT ATTENTION condition
2691 * for the calling I_T Nexus
2693 if (pr_reg_p == pr_reg)
2696 core_scsi3_ua_allocate(pr_reg_p->pr_reg_nacl,
2697 pr_reg_p->pr_res_mapped_lun,
2698 0x2A, ASCQ_2AH_RESERVATIONS_RELEASED);
2700 spin_unlock(&pr_tmpl->registration_lock);
2703 if (pr_tmpl->pr_aptpl_active) {
2704 if (!core_scsi3_update_and_write_aptpl(cmd->se_dev,
2705 &pr_reg->pr_aptpl_buf[0], pr_tmpl->pr_aptpl_buf_len)) {
2706 pr_debug("SPC-3 PR: Updated APTPL metadata for RELEASE\n");
2710 core_scsi3_put_pr_reg(pr_reg);
2714 static sense_reason_t
2715 core_scsi3_emulate_pro_clear(struct se_cmd *cmd, u64 res_key)
2717 struct se_device *dev = cmd->se_dev;
2718 struct se_node_acl *pr_reg_nacl;
2719 struct se_session *se_sess = cmd->se_sess;
2720 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2721 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_reg_n, *pr_res_holder;
2722 u32 pr_res_mapped_lun = 0;
2723 int calling_it_nexus = 0;
2725 * Locate the existing *pr_reg via struct se_node_acl pointers
2727 pr_reg_n = core_scsi3_locate_pr_reg(cmd->se_dev,
2728 se_sess->se_node_acl, se_sess);
2730 pr_err("SPC-3 PR: Unable to locate"
2731 " PR_REGISTERED *pr_reg for CLEAR\n");
2732 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2735 * From spc4r17 section 5.7.11.6, Clearing:
2737 * Any application client may release the persistent reservation and
2738 * remove all registrations from a device server by issuing a
2739 * PERSISTENT RESERVE OUT command with CLEAR service action through a
2740 * registered I_T nexus with the following parameter:
2742 * a) RESERVATION KEY field set to the value of the reservation key
2743 * that is registered with the logical unit for the I_T nexus.
2745 if (res_key != pr_reg_n->pr_res_key) {
2746 pr_err("SPC-3 PR REGISTER: Received"
2747 " res_key: 0x%016Lx does not match"
2748 " existing SA REGISTER res_key:"
2749 " 0x%016Lx\n", res_key, pr_reg_n->pr_res_key);
2750 core_scsi3_put_pr_reg(pr_reg_n);
2751 return TCM_RESERVATION_CONFLICT;
2754 * a) Release the persistent reservation, if any;
2756 spin_lock(&dev->dev_reservation_lock);
2757 pr_res_holder = dev->dev_pr_res_holder;
2758 if (pr_res_holder) {
2759 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2760 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
2763 spin_unlock(&dev->dev_reservation_lock);
2765 * b) Remove all registration(s) (see spc4r17 5.7.7);
2767 spin_lock(&pr_tmpl->registration_lock);
2768 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2769 &pr_tmpl->registration_list, pr_reg_list) {
2771 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2772 pr_reg_nacl = pr_reg->pr_reg_nacl;
2773 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2774 __core_scsi3_free_registration(dev, pr_reg, NULL,
2777 * e) Establish a unit attention condition for the initiator
2778 * port associated with every registered I_T nexus other
2779 * than the I_T nexus on which the PERSISTENT RESERVE OUT
2780 * command with CLEAR service action was received, with the
2781 * additional sense code set to RESERVATIONS PREEMPTED.
2783 if (!calling_it_nexus)
2784 core_scsi3_ua_allocate(pr_reg_nacl, pr_res_mapped_lun,
2785 0x2A, ASCQ_2AH_RESERVATIONS_PREEMPTED);
2787 spin_unlock(&pr_tmpl->registration_lock);
2789 pr_debug("SPC-3 PR [%s] Service Action: CLEAR complete\n",
2790 cmd->se_tfo->get_fabric_name());
2792 if (pr_tmpl->pr_aptpl_active) {
2793 core_scsi3_update_and_write_aptpl(cmd->se_dev, NULL, 0);
2794 pr_debug("SPC-3 PR: Updated APTPL metadata"
2798 core_scsi3_pr_generation(dev);
2803 * Called with struct se_device->dev_reservation_lock held.
2805 static void __core_scsi3_complete_pro_preempt(
2806 struct se_device *dev,
2807 struct t10_pr_registration *pr_reg,
2808 struct list_head *preempt_and_abort_list,
2811 enum preempt_type preempt_type)
2813 struct se_node_acl *nacl = pr_reg->pr_reg_nacl;
2814 struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
2815 char i_buf[PR_REG_ISID_ID_LEN];
2817 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2818 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2820 * Do an implict RELEASE of the existing reservation.
2822 if (dev->dev_pr_res_holder)
2823 __core_scsi3_complete_pro_release(dev, nacl,
2824 dev->dev_pr_res_holder, 0);
2826 dev->dev_pr_res_holder = pr_reg;
2827 pr_reg->pr_res_holder = 1;
2828 pr_reg->pr_res_type = type;
2829 pr_reg->pr_res_scope = scope;
2831 pr_debug("SPC-3 PR [%s] Service Action: PREEMPT%s created new"
2832 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2833 tfo->get_fabric_name(), (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "",
2834 core_scsi3_pr_dump_type(type),
2835 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2836 pr_debug("SPC-3 PR [%s] PREEMPT%s from Node: %s%s\n",
2837 tfo->get_fabric_name(), (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "",
2838 nacl->initiatorname, i_buf);
2840 * For PREEMPT_AND_ABORT, add the preempting reservation's
2841 * struct t10_pr_registration to the list that will be compared
2842 * against received CDBs..
2844 if (preempt_and_abort_list)
2845 list_add_tail(&pr_reg->pr_reg_abort_list,
2846 preempt_and_abort_list);
2849 static void core_scsi3_release_preempt_and_abort(
2850 struct list_head *preempt_and_abort_list,
2851 struct t10_pr_registration *pr_reg_holder)
2853 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
2855 list_for_each_entry_safe(pr_reg, pr_reg_tmp, preempt_and_abort_list,
2856 pr_reg_abort_list) {
2858 list_del(&pr_reg->pr_reg_abort_list);
2859 if (pr_reg_holder == pr_reg)
2861 if (pr_reg->pr_res_holder) {
2862 pr_warn("pr_reg->pr_res_holder still set\n");
2866 pr_reg->pr_reg_deve = NULL;
2867 pr_reg->pr_reg_nacl = NULL;
2868 kfree(pr_reg->pr_aptpl_buf);
2869 kmem_cache_free(t10_pr_reg_cache, pr_reg);
2873 static sense_reason_t
2874 core_scsi3_pro_preempt(struct se_cmd *cmd, int type, int scope, u64 res_key,
2875 u64 sa_res_key, enum preempt_type preempt_type)
2877 struct se_device *dev = cmd->se_dev;
2878 struct se_node_acl *pr_reg_nacl;
2879 struct se_session *se_sess = cmd->se_sess;
2880 LIST_HEAD(preempt_and_abort_list);
2881 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_reg_n, *pr_res_holder;
2882 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2883 u32 pr_res_mapped_lun = 0;
2884 int all_reg = 0, calling_it_nexus = 0, released_regs = 0;
2885 int prh_type = 0, prh_scope = 0;
2888 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2890 pr_reg_n = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
2893 pr_err("SPC-3 PR: Unable to locate"
2894 " PR_REGISTERED *pr_reg for PREEMPT%s\n",
2895 (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "");
2896 return TCM_RESERVATION_CONFLICT;
2898 if (pr_reg_n->pr_res_key != res_key) {
2899 core_scsi3_put_pr_reg(pr_reg_n);
2900 return TCM_RESERVATION_CONFLICT;
2902 if (scope != PR_SCOPE_LU_SCOPE) {
2903 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope);
2904 core_scsi3_put_pr_reg(pr_reg_n);
2905 return TCM_INVALID_PARAMETER_LIST;
2908 spin_lock(&dev->dev_reservation_lock);
2909 pr_res_holder = dev->dev_pr_res_holder;
2910 if (pr_res_holder &&
2911 ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2912 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)))
2915 if (!all_reg && !sa_res_key) {
2916 spin_unlock(&dev->dev_reservation_lock);
2917 core_scsi3_put_pr_reg(pr_reg_n);
2918 return TCM_INVALID_PARAMETER_LIST;
2921 * From spc4r17, section 5.7.11.4.4 Removing Registrations:
2923 * If the SERVICE ACTION RESERVATION KEY field does not identify a
2924 * persistent reservation holder or there is no persistent reservation
2925 * holder (i.e., there is no persistent reservation), then the device
2926 * server shall perform a preempt by doing the following in an
2927 * uninterrupted series of actions. (See below..)
2929 if (!pr_res_holder || (pr_res_holder->pr_res_key != sa_res_key)) {
2931 * No existing or SA Reservation Key matching reservations..
2933 * PROUT SA PREEMPT with All Registrant type reservations are
2934 * allowed to be processed without a matching SA Reservation Key
2936 spin_lock(&pr_tmpl->registration_lock);
2937 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2938 &pr_tmpl->registration_list, pr_reg_list) {
2940 * Removing of registrations in non all registrants
2941 * type reservations without a matching SA reservation
2944 * a) Remove the registrations for all I_T nexuses
2945 * specified by the SERVICE ACTION RESERVATION KEY
2947 * b) Ignore the contents of the SCOPE and TYPE fields;
2948 * c) Process tasks as defined in 5.7.1; and
2949 * d) Establish a unit attention condition for the
2950 * initiator port associated with every I_T nexus
2951 * that lost its registration other than the I_T
2952 * nexus on which the PERSISTENT RESERVE OUT command
2953 * was received, with the additional sense code set
2954 * to REGISTRATIONS PREEMPTED.
2957 if (pr_reg->pr_res_key != sa_res_key)
2960 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2961 pr_reg_nacl = pr_reg->pr_reg_nacl;
2962 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2963 __core_scsi3_free_registration(dev, pr_reg,
2964 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list :
2965 NULL, calling_it_nexus);
2969 * Case for any existing all registrants type
2970 * reservation, follow logic in spc4r17 section
2971 * 5.7.11.4 Preempting, Table 52 and Figure 7.
2973 * For a ZERO SA Reservation key, release
2974 * all other registrations and do an implict
2975 * release of active persistent reservation.
2977 * For a non-ZERO SA Reservation key, only
2978 * release the matching reservation key from
2982 (pr_reg->pr_res_key != sa_res_key))
2985 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2986 if (calling_it_nexus)
2989 pr_reg_nacl = pr_reg->pr_reg_nacl;
2990 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2991 __core_scsi3_free_registration(dev, pr_reg,
2992 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list :
2996 if (!calling_it_nexus)
2997 core_scsi3_ua_allocate(pr_reg_nacl,
2998 pr_res_mapped_lun, 0x2A,
2999 ASCQ_2AH_REGISTRATIONS_PREEMPTED);
3001 spin_unlock(&pr_tmpl->registration_lock);
3003 * If a PERSISTENT RESERVE OUT with a PREEMPT service action or
3004 * a PREEMPT AND ABORT service action sets the SERVICE ACTION
3005 * RESERVATION KEY field to a value that does not match any
3006 * registered reservation key, then the device server shall
3007 * complete the command with RESERVATION CONFLICT status.
3009 if (!released_regs) {
3010 spin_unlock(&dev->dev_reservation_lock);
3011 core_scsi3_put_pr_reg(pr_reg_n);
3012 return TCM_RESERVATION_CONFLICT;
3015 * For an existing all registrants type reservation
3016 * with a zero SA rservation key, preempt the existing
3017 * reservation with the new PR type and scope.
3019 if (pr_res_holder && all_reg && !(sa_res_key)) {
3020 __core_scsi3_complete_pro_preempt(dev, pr_reg_n,
3021 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
3022 type, scope, preempt_type);
3024 if (preempt_type == PREEMPT_AND_ABORT)
3025 core_scsi3_release_preempt_and_abort(
3026 &preempt_and_abort_list, pr_reg_n);
3028 spin_unlock(&dev->dev_reservation_lock);
3030 if (pr_tmpl->pr_aptpl_active) {
3031 if (!core_scsi3_update_and_write_aptpl(cmd->se_dev,
3032 &pr_reg_n->pr_aptpl_buf[0],
3033 pr_tmpl->pr_aptpl_buf_len)) {
3034 pr_debug("SPC-3 PR: Updated APTPL"
3035 " metadata for PREEMPT%s\n", (preempt_type == PREEMPT_AND_ABORT) ?
3040 core_scsi3_put_pr_reg(pr_reg_n);
3041 core_scsi3_pr_generation(cmd->se_dev);
3045 * The PREEMPTing SA reservation key matches that of the
3046 * existing persistent reservation, first, we check if
3047 * we are preempting our own reservation.
3048 * From spc4r17, section 5.7.11.4.3 Preempting
3049 * persistent reservations and registration handling
3051 * If an all registrants persistent reservation is not
3052 * present, it is not an error for the persistent
3053 * reservation holder to preempt itself (i.e., a
3054 * PERSISTENT RESERVE OUT with a PREEMPT service action
3055 * or a PREEMPT AND ABORT service action with the
3056 * SERVICE ACTION RESERVATION KEY value equal to the
3057 * persistent reservation holder's reservation key that
3058 * is received from the persistent reservation holder).
3059 * In that case, the device server shall establish the
3060 * new persistent reservation and maintain the
3063 prh_type = pr_res_holder->pr_res_type;
3064 prh_scope = pr_res_holder->pr_res_scope;
3066 * If the SERVICE ACTION RESERVATION KEY field identifies a
3067 * persistent reservation holder (see 5.7.10), the device
3068 * server shall perform a preempt by doing the following as
3069 * an uninterrupted series of actions:
3071 * a) Release the persistent reservation for the holder
3072 * identified by the SERVICE ACTION RESERVATION KEY field;
3074 if (pr_reg_n != pr_res_holder)
3075 __core_scsi3_complete_pro_release(dev,
3076 pr_res_holder->pr_reg_nacl,
3077 dev->dev_pr_res_holder, 0);
3079 * b) Remove the registrations for all I_T nexuses identified
3080 * by the SERVICE ACTION RESERVATION KEY field, except the
3081 * I_T nexus that is being used for the PERSISTENT RESERVE
3082 * OUT command. If an all registrants persistent reservation
3083 * is present and the SERVICE ACTION RESERVATION KEY field
3084 * is set to zero, then all registrations shall be removed
3085 * except for that of the I_T nexus that is being used for
3086 * the PERSISTENT RESERVE OUT command;
3088 spin_lock(&pr_tmpl->registration_lock);
3089 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3090 &pr_tmpl->registration_list, pr_reg_list) {
3092 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
3093 if (calling_it_nexus)
3096 if (pr_reg->pr_res_key != sa_res_key)
3099 pr_reg_nacl = pr_reg->pr_reg_nacl;
3100 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
3101 __core_scsi3_free_registration(dev, pr_reg,
3102 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
3105 * e) Establish a unit attention condition for the initiator
3106 * port associated with every I_T nexus that lost its
3107 * persistent reservation and/or registration, with the
3108 * additional sense code set to REGISTRATIONS PREEMPTED;
3110 core_scsi3_ua_allocate(pr_reg_nacl, pr_res_mapped_lun, 0x2A,
3111 ASCQ_2AH_REGISTRATIONS_PREEMPTED);
3113 spin_unlock(&pr_tmpl->registration_lock);
3115 * c) Establish a persistent reservation for the preempting
3116 * I_T nexus using the contents of the SCOPE and TYPE fields;
3118 __core_scsi3_complete_pro_preempt(dev, pr_reg_n,
3119 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
3120 type, scope, preempt_type);
3122 * d) Process tasks as defined in 5.7.1;
3124 * f) If the type or scope has changed, then for every I_T nexus
3125 * whose reservation key was not removed, except for the I_T
3126 * nexus on which the PERSISTENT RESERVE OUT command was
3127 * received, the device server shall establish a unit
3128 * attention condition for the initiator port associated with
3129 * that I_T nexus, with the additional sense code set to
3130 * RESERVATIONS RELEASED. If the type or scope have not
3131 * changed, then no unit attention condition(s) shall be
3132 * established for this reason.
3134 if ((prh_type != type) || (prh_scope != scope)) {
3135 spin_lock(&pr_tmpl->registration_lock);
3136 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3137 &pr_tmpl->registration_list, pr_reg_list) {
3139 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
3140 if (calling_it_nexus)
3143 core_scsi3_ua_allocate(pr_reg->pr_reg_nacl,
3144 pr_reg->pr_res_mapped_lun, 0x2A,
3145 ASCQ_2AH_RESERVATIONS_RELEASED);
3147 spin_unlock(&pr_tmpl->registration_lock);
3149 spin_unlock(&dev->dev_reservation_lock);
3151 * Call LUN_RESET logic upon list of struct t10_pr_registration,
3152 * All received CDBs for the matching existing reservation and
3153 * registrations undergo ABORT_TASK logic.
3155 * From there, core_scsi3_release_preempt_and_abort() will
3156 * release every registration in the list (which have already
3157 * been removed from the primary pr_reg list), except the
3158 * new persistent reservation holder, the calling Initiator Port.
3160 if (preempt_type == PREEMPT_AND_ABORT) {
3161 core_tmr_lun_reset(dev, NULL, &preempt_and_abort_list, cmd);
3162 core_scsi3_release_preempt_and_abort(&preempt_and_abort_list,
3166 if (pr_tmpl->pr_aptpl_active) {
3167 if (!core_scsi3_update_and_write_aptpl(cmd->se_dev,
3168 &pr_reg_n->pr_aptpl_buf[0],
3169 pr_tmpl->pr_aptpl_buf_len)) {
3170 pr_debug("SPC-3 PR: Updated APTPL metadata for PREEMPT"
3171 "%s\n", (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "");
3175 core_scsi3_put_pr_reg(pr_reg_n);
3176 core_scsi3_pr_generation(cmd->se_dev);
3180 static sense_reason_t
3181 core_scsi3_emulate_pro_preempt(struct se_cmd *cmd, int type, int scope,
3182 u64 res_key, u64 sa_res_key, enum preempt_type preempt_type)
3185 case PR_TYPE_WRITE_EXCLUSIVE:
3186 case PR_TYPE_EXCLUSIVE_ACCESS:
3187 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
3188 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
3189 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
3190 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
3191 return core_scsi3_pro_preempt(cmd, type, scope, res_key,
3192 sa_res_key, preempt_type);
3194 pr_err("SPC-3 PR: Unknown Service Action PREEMPT%s"
3195 " Type: 0x%02x\n", (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "", type);
3196 return TCM_INVALID_CDB_FIELD;
3201 static sense_reason_t
3202 core_scsi3_emulate_pro_register_and_move(struct se_cmd *cmd, u64 res_key,
3203 u64 sa_res_key, int aptpl, int unreg)
3205 struct se_session *se_sess = cmd->se_sess;
3206 struct se_device *dev = cmd->se_dev;
3207 struct se_dev_entry *dest_se_deve = NULL;
3208 struct se_lun *se_lun = cmd->se_lun;
3209 struct se_node_acl *pr_res_nacl, *pr_reg_nacl, *dest_node_acl = NULL;
3210 struct se_port *se_port;
3211 struct se_portal_group *se_tpg, *dest_se_tpg = NULL;
3212 struct target_core_fabric_ops *dest_tf_ops = NULL, *tf_ops;
3213 struct t10_pr_registration *pr_reg, *pr_res_holder, *dest_pr_reg;
3214 struct t10_reservation *pr_tmpl = &dev->t10_pr;
3216 unsigned char *initiator_str;
3217 char *iport_ptr = NULL, dest_iport[64], i_buf[PR_REG_ISID_ID_LEN];
3218 u32 tid_len, tmp_tid_len;
3219 int new_reg = 0, type, scope, matching_iname;
3221 unsigned short rtpi;
3222 unsigned char proto_ident;
3224 if (!se_sess || !se_lun) {
3225 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
3226 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3229 memset(dest_iport, 0, 64);
3230 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
3231 se_tpg = se_sess->se_tpg;
3232 tf_ops = se_tpg->se_tpg_tfo;
3234 * Follow logic from spc4r17 Section 5.7.8, Table 50 --
3235 * Register behaviors for a REGISTER AND MOVE service action
3237 * Locate the existing *pr_reg via struct se_node_acl pointers
3239 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
3242 pr_err("SPC-3 PR: Unable to locate PR_REGISTERED"
3243 " *pr_reg for REGISTER_AND_MOVE\n");
3244 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3247 * The provided reservation key much match the existing reservation key
3248 * provided during this initiator's I_T nexus registration.
3250 if (res_key != pr_reg->pr_res_key) {
3251 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received"
3252 " res_key: 0x%016Lx does not match existing SA REGISTER"
3253 " res_key: 0x%016Lx\n", res_key, pr_reg->pr_res_key);
3254 ret = TCM_RESERVATION_CONFLICT;
3255 goto out_put_pr_reg;
3258 * The service active reservation key needs to be non zero
3261 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received zero"
3263 ret = TCM_INVALID_PARAMETER_LIST;
3264 goto out_put_pr_reg;
3268 * Determine the Relative Target Port Identifier where the reservation
3269 * will be moved to for the TransportID containing SCSI initiator WWN
3272 buf = transport_kmap_data_sg(cmd);
3274 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3275 goto out_put_pr_reg;
3278 rtpi = (buf[18] & 0xff) << 8;
3279 rtpi |= buf[19] & 0xff;
3280 tid_len = (buf[20] & 0xff) << 24;
3281 tid_len |= (buf[21] & 0xff) << 16;
3282 tid_len |= (buf[22] & 0xff) << 8;
3283 tid_len |= buf[23] & 0xff;
3284 transport_kunmap_data_sg(cmd);
3287 if ((tid_len + 24) != cmd->data_length) {
3288 pr_err("SPC-3 PR: Illegal tid_len: %u + 24 byte header"
3289 " does not equal CDB data_length: %u\n", tid_len,
3291 ret = TCM_INVALID_PARAMETER_LIST;
3292 goto out_put_pr_reg;
3295 spin_lock(&dev->se_port_lock);
3296 list_for_each_entry(se_port, &dev->dev_sep_list, sep_list) {
3297 if (se_port->sep_rtpi != rtpi)
3299 dest_se_tpg = se_port->sep_tpg;
3302 dest_tf_ops = dest_se_tpg->se_tpg_tfo;
3306 atomic_inc(&dest_se_tpg->tpg_pr_ref_count);
3307 smp_mb__after_atomic_inc();
3308 spin_unlock(&dev->se_port_lock);
3310 if (core_scsi3_tpg_depend_item(dest_se_tpg)) {
3311 pr_err("core_scsi3_tpg_depend_item() failed"
3312 " for dest_se_tpg\n");
3313 atomic_dec(&dest_se_tpg->tpg_pr_ref_count);
3314 smp_mb__after_atomic_dec();
3315 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3316 goto out_put_pr_reg;
3319 spin_lock(&dev->se_port_lock);
3322 spin_unlock(&dev->se_port_lock);
3324 if (!dest_se_tpg || !dest_tf_ops) {
3325 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3326 " fabric ops from Relative Target Port Identifier:"
3328 ret = TCM_INVALID_PARAMETER_LIST;
3329 goto out_put_pr_reg;
3332 buf = transport_kmap_data_sg(cmd);
3334 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3335 goto out_put_pr_reg;
3337 proto_ident = (buf[24] & 0x0f);
3339 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Extracted Protocol Identifier:"
3340 " 0x%02x\n", proto_ident);
3342 if (proto_ident != dest_tf_ops->get_fabric_proto_ident(dest_se_tpg)) {
3343 pr_err("SPC-3 PR REGISTER_AND_MOVE: Received"
3344 " proto_ident: 0x%02x does not match ident: 0x%02x"
3345 " from fabric: %s\n", proto_ident,
3346 dest_tf_ops->get_fabric_proto_ident(dest_se_tpg),
3347 dest_tf_ops->get_fabric_name());
3348 ret = TCM_INVALID_PARAMETER_LIST;
3351 if (dest_tf_ops->tpg_parse_pr_out_transport_id == NULL) {
3352 pr_err("SPC-3 PR REGISTER_AND_MOVE: Fabric does not"
3353 " containg a valid tpg_parse_pr_out_transport_id"
3354 " function pointer\n");
3355 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3358 initiator_str = dest_tf_ops->tpg_parse_pr_out_transport_id(dest_se_tpg,
3359 (const char *)&buf[24], &tmp_tid_len, &iport_ptr);
3360 if (!initiator_str) {
3361 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3362 " initiator_str from Transport ID\n");
3363 ret = TCM_INVALID_PARAMETER_LIST;
3367 transport_kunmap_data_sg(cmd);
3370 pr_debug("SPC-3 PR [%s] Extracted initiator %s identifier: %s"
3371 " %s\n", dest_tf_ops->get_fabric_name(), (iport_ptr != NULL) ?
3372 "port" : "device", initiator_str, (iport_ptr != NULL) ?
3375 * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3376 * action specifies a TransportID that is the same as the initiator port
3377 * of the I_T nexus for the command received, then the command shall
3378 * be terminated with CHECK CONDITION status, with the sense key set to
3379 * ILLEGAL REQUEST, and the additional sense code set to INVALID FIELD
3380 * IN PARAMETER LIST.
3382 pr_reg_nacl = pr_reg->pr_reg_nacl;
3383 matching_iname = (!strcmp(initiator_str,
3384 pr_reg_nacl->initiatorname)) ? 1 : 0;
3385 if (!matching_iname)
3386 goto after_iport_check;
3388 if (!iport_ptr || !pr_reg->isid_present_at_reg) {
3389 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s"
3390 " matches: %s on received I_T Nexus\n", initiator_str,
3391 pr_reg_nacl->initiatorname);
3392 ret = TCM_INVALID_PARAMETER_LIST;
3395 if (!strcmp(iport_ptr, pr_reg->pr_reg_isid)) {
3396 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s %s"
3397 " matches: %s %s on received I_T Nexus\n",
3398 initiator_str, iport_ptr, pr_reg_nacl->initiatorname,
3399 pr_reg->pr_reg_isid);
3400 ret = TCM_INVALID_PARAMETER_LIST;
3405 * Locate the destination struct se_node_acl from the received Transport ID
3407 spin_lock_irq(&dest_se_tpg->acl_node_lock);
3408 dest_node_acl = __core_tpg_get_initiator_node_acl(dest_se_tpg,
3410 if (dest_node_acl) {
3411 atomic_inc(&dest_node_acl->acl_pr_ref_count);
3412 smp_mb__after_atomic_inc();
3414 spin_unlock_irq(&dest_se_tpg->acl_node_lock);
3416 if (!dest_node_acl) {
3417 pr_err("Unable to locate %s dest_node_acl for"
3418 " TransportID%s\n", dest_tf_ops->get_fabric_name(),
3420 ret = TCM_INVALID_PARAMETER_LIST;
3424 if (core_scsi3_nodeacl_depend_item(dest_node_acl)) {
3425 pr_err("core_scsi3_nodeacl_depend_item() for"
3426 " dest_node_acl\n");
3427 atomic_dec(&dest_node_acl->acl_pr_ref_count);
3428 smp_mb__after_atomic_dec();
3429 dest_node_acl = NULL;
3430 ret = TCM_INVALID_PARAMETER_LIST;
3434 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Found %s dest_node_acl:"
3435 " %s from TransportID\n", dest_tf_ops->get_fabric_name(),
3436 dest_node_acl->initiatorname);
3439 * Locate the struct se_dev_entry pointer for the matching RELATIVE TARGET
3442 dest_se_deve = core_get_se_deve_from_rtpi(dest_node_acl, rtpi);
3443 if (!dest_se_deve) {
3444 pr_err("Unable to locate %s dest_se_deve from RTPI:"
3445 " %hu\n", dest_tf_ops->get_fabric_name(), rtpi);
3446 ret = TCM_INVALID_PARAMETER_LIST;
3450 if (core_scsi3_lunacl_depend_item(dest_se_deve)) {
3451 pr_err("core_scsi3_lunacl_depend_item() failed\n");
3452 atomic_dec(&dest_se_deve->pr_ref_count);
3453 smp_mb__after_atomic_dec();
3454 dest_se_deve = NULL;
3455 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3459 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Located %s node %s LUN"
3460 " ACL for dest_se_deve->mapped_lun: %u\n",
3461 dest_tf_ops->get_fabric_name(), dest_node_acl->initiatorname,
3462 dest_se_deve->mapped_lun);
3465 * A persistent reservation needs to already existing in order to
3466 * successfully complete the REGISTER_AND_MOVE service action..
3468 spin_lock(&dev->dev_reservation_lock);
3469 pr_res_holder = dev->dev_pr_res_holder;
3470 if (!pr_res_holder) {
3471 pr_warn("SPC-3 PR REGISTER_AND_MOVE: No reservation"
3472 " currently held\n");
3473 spin_unlock(&dev->dev_reservation_lock);
3474 ret = TCM_INVALID_CDB_FIELD;
3478 * The received on I_T Nexus must be the reservation holder.
3480 * From spc4r17 section 5.7.8 Table 50 --
3481 * Register behaviors for a REGISTER AND MOVE service action
3483 if (pr_res_holder != pr_reg) {
3484 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Calling I_T"
3485 " Nexus is not reservation holder\n");
3486 spin_unlock(&dev->dev_reservation_lock);
3487 ret = TCM_RESERVATION_CONFLICT;
3491 * From spc4r17 section 5.7.8: registering and moving reservation
3493 * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3494 * action is received and the established persistent reservation is a
3495 * Write Exclusive - All Registrants type or Exclusive Access -
3496 * All Registrants type reservation, then the command shall be completed
3497 * with RESERVATION CONFLICT status.
3499 if ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
3500 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
3501 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Unable to move"
3502 " reservation for type: %s\n",
3503 core_scsi3_pr_dump_type(pr_res_holder->pr_res_type));
3504 spin_unlock(&dev->dev_reservation_lock);
3505 ret = TCM_RESERVATION_CONFLICT;
3508 pr_res_nacl = pr_res_holder->pr_reg_nacl;
3510 * b) Ignore the contents of the (received) SCOPE and TYPE fields;
3512 type = pr_res_holder->pr_res_type;
3513 scope = pr_res_holder->pr_res_type;
3515 * c) Associate the reservation key specified in the SERVICE ACTION
3516 * RESERVATION KEY field with the I_T nexus specified as the
3517 * destination of the register and move, where:
3518 * A) The I_T nexus is specified by the TransportID and the
3519 * RELATIVE TARGET PORT IDENTIFIER field (see 6.14.4); and
3520 * B) Regardless of the TransportID format used, the association for
3521 * the initiator port is based on either the initiator port name
3522 * (see 3.1.71) on SCSI transport protocols where port names are
3523 * required or the initiator port identifier (see 3.1.70) on SCSI
3524 * transport protocols where port names are not required;
3525 * d) Register the reservation key specified in the SERVICE ACTION
3526 * RESERVATION KEY field;
3527 * e) Retain the reservation key specified in the SERVICE ACTION
3528 * RESERVATION KEY field and associated information;
3530 * Also, It is not an error for a REGISTER AND MOVE service action to
3531 * register an I_T nexus that is already registered with the same
3532 * reservation key or a different reservation key.
3534 dest_pr_reg = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
3537 if (core_scsi3_alloc_registration(cmd->se_dev,
3538 dest_node_acl, dest_se_deve, iport_ptr,
3539 sa_res_key, 0, aptpl, 2, 1)) {
3540 spin_unlock(&dev->dev_reservation_lock);
3541 ret = TCM_INVALID_PARAMETER_LIST;
3544 dest_pr_reg = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
3549 * f) Release the persistent reservation for the persistent reservation
3550 * holder (i.e., the I_T nexus on which the
3552 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
3553 dev->dev_pr_res_holder, 0);
3555 * g) Move the persistent reservation to the specified I_T nexus using
3556 * the same scope and type as the persistent reservation released in
3559 dev->dev_pr_res_holder = dest_pr_reg;
3560 dest_pr_reg->pr_res_holder = 1;
3561 dest_pr_reg->pr_res_type = type;
3562 pr_reg->pr_res_scope = scope;
3563 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
3565 * Increment PRGeneration for existing registrations..
3568 dest_pr_reg->pr_res_generation = pr_tmpl->pr_generation++;
3569 spin_unlock(&dev->dev_reservation_lock);
3571 pr_debug("SPC-3 PR [%s] Service Action: REGISTER_AND_MOVE"
3572 " created new reservation holder TYPE: %s on object RTPI:"
3573 " %hu PRGeneration: 0x%08x\n", dest_tf_ops->get_fabric_name(),
3574 core_scsi3_pr_dump_type(type), rtpi,
3575 dest_pr_reg->pr_res_generation);
3576 pr_debug("SPC-3 PR Successfully moved reservation from"
3577 " %s Fabric Node: %s%s -> %s Fabric Node: %s %s\n",
3578 tf_ops->get_fabric_name(), pr_reg_nacl->initiatorname,
3579 i_buf, dest_tf_ops->get_fabric_name(),
3580 dest_node_acl->initiatorname, (iport_ptr != NULL) ?
3583 * It is now safe to release configfs group dependencies for destination
3584 * of Transport ID Initiator Device/Port Identifier
3586 core_scsi3_lunacl_undepend_item(dest_se_deve);
3587 core_scsi3_nodeacl_undepend_item(dest_node_acl);
3588 core_scsi3_tpg_undepend_item(dest_se_tpg);
3590 * h) If the UNREG bit is set to one, unregister (see 5.7.11.3) the I_T
3591 * nexus on which PERSISTENT RESERVE OUT command was received.
3594 spin_lock(&pr_tmpl->registration_lock);
3595 __core_scsi3_free_registration(dev, pr_reg, NULL, 1);
3596 spin_unlock(&pr_tmpl->registration_lock);
3598 core_scsi3_put_pr_reg(pr_reg);
3601 * Clear the APTPL metadata if APTPL has been disabled, otherwise
3602 * write out the updated metadata to struct file for this SCSI device.
3605 pr_tmpl->pr_aptpl_active = 0;
3606 core_scsi3_update_and_write_aptpl(cmd->se_dev, NULL, 0);
3607 pr_debug("SPC-3 PR: Set APTPL Bit Deactivated for"
3608 " REGISTER_AND_MOVE\n");
3610 pr_tmpl->pr_aptpl_active = 1;
3611 if (!core_scsi3_update_and_write_aptpl(cmd->se_dev,
3612 &dest_pr_reg->pr_aptpl_buf[0],
3613 pr_tmpl->pr_aptpl_buf_len)) {
3614 pr_debug("SPC-3 PR: Set APTPL Bit Activated for"
3615 " REGISTER_AND_MOVE\n");
3619 transport_kunmap_data_sg(cmd);
3621 core_scsi3_put_pr_reg(dest_pr_reg);
3625 transport_kunmap_data_sg(cmd);
3627 core_scsi3_lunacl_undepend_item(dest_se_deve);
3629 core_scsi3_nodeacl_undepend_item(dest_node_acl);
3630 core_scsi3_tpg_undepend_item(dest_se_tpg);
3633 core_scsi3_put_pr_reg(pr_reg);
3637 static unsigned long long core_scsi3_extract_reservation_key(unsigned char *cdb)
3639 unsigned int __v1, __v2;
3641 __v1 = (cdb[0] << 24) | (cdb[1] << 16) | (cdb[2] << 8) | cdb[3];
3642 __v2 = (cdb[4] << 24) | (cdb[5] << 16) | (cdb[6] << 8) | cdb[7];
3644 return ((unsigned long long)__v2) | (unsigned long long)__v1 << 32;
3648 * See spc4r17 section 6.14 Table 170
3651 target_scsi3_emulate_pr_out(struct se_cmd *cmd)
3653 unsigned char *cdb = &cmd->t_task_cdb[0];
3655 u64 res_key, sa_res_key;
3656 int sa, scope, type, aptpl;
3657 int spec_i_pt = 0, all_tg_pt = 0, unreg = 0;
3661 * Following spc2r20 5.5.1 Reservations overview:
3663 * If a logical unit has been reserved by any RESERVE command and is
3664 * still reserved by any initiator, all PERSISTENT RESERVE IN and all
3665 * PERSISTENT RESERVE OUT commands shall conflict regardless of
3666 * initiator or service action and shall terminate with a RESERVATION
3669 if (cmd->se_dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS) {
3670 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
3671 " SPC-2 reservation is held, returning"
3672 " RESERVATION_CONFLICT\n");
3673 return TCM_RESERVATION_CONFLICT;
3677 * FIXME: A NULL struct se_session pointer means an this is not coming from
3678 * a $FABRIC_MOD's nexus, but from internal passthrough ops.
3681 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3683 if (cmd->data_length < 24) {
3684 pr_warn("SPC-PR: Received PR OUT parameter list"
3685 " length too small: %u\n", cmd->data_length);
3686 return TCM_INVALID_PARAMETER_LIST;
3690 * From the PERSISTENT_RESERVE_OUT command descriptor block (CDB)
3692 sa = (cdb[1] & 0x1f);
3693 scope = (cdb[2] & 0xf0);
3694 type = (cdb[2] & 0x0f);
3696 buf = transport_kmap_data_sg(cmd);
3698 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3701 * From PERSISTENT_RESERVE_OUT parameter list (payload)
3703 res_key = core_scsi3_extract_reservation_key(&buf[0]);
3704 sa_res_key = core_scsi3_extract_reservation_key(&buf[8]);
3706 * REGISTER_AND_MOVE uses a different SA parameter list containing
3707 * SCSI TransportIDs.
3709 if (sa != PRO_REGISTER_AND_MOVE) {
3710 spec_i_pt = (buf[20] & 0x08);
3711 all_tg_pt = (buf[20] & 0x04);
3712 aptpl = (buf[20] & 0x01);
3714 aptpl = (buf[17] & 0x01);
3715 unreg = (buf[17] & 0x02);
3717 transport_kunmap_data_sg(cmd);
3721 * SPEC_I_PT=1 is only valid for Service action: REGISTER
3723 if (spec_i_pt && ((cdb[1] & 0x1f) != PRO_REGISTER))
3724 return TCM_INVALID_PARAMETER_LIST;
3727 * From spc4r17 section 6.14:
3729 * If the SPEC_I_PT bit is set to zero, the service action is not
3730 * REGISTER AND MOVE, and the parameter list length is not 24, then
3731 * the command shall be terminated with CHECK CONDITION status, with
3732 * the sense key set to ILLEGAL REQUEST, and the additional sense
3733 * code set to PARAMETER LIST LENGTH ERROR.
3735 if (!spec_i_pt && ((cdb[1] & 0x1f) != PRO_REGISTER_AND_MOVE) &&
3736 (cmd->data_length != 24)) {
3737 pr_warn("SPC-PR: Received PR OUT illegal parameter"
3738 " list length: %u\n", cmd->data_length);
3739 return TCM_INVALID_PARAMETER_LIST;
3743 * (core_scsi3_emulate_pro_* function parameters
3744 * are defined by spc4r17 Table 174:
3745 * PERSISTENT_RESERVE_OUT service actions and valid parameters.
3749 ret = core_scsi3_emulate_pro_register(cmd,
3750 res_key, sa_res_key, aptpl, all_tg_pt, spec_i_pt, REGISTER);
3753 ret = core_scsi3_emulate_pro_reserve(cmd, type, scope, res_key);
3756 ret = core_scsi3_emulate_pro_release(cmd, type, scope, res_key);
3759 ret = core_scsi3_emulate_pro_clear(cmd, res_key);
3762 ret = core_scsi3_emulate_pro_preempt(cmd, type, scope,
3763 res_key, sa_res_key, PREEMPT);
3765 case PRO_PREEMPT_AND_ABORT:
3766 ret = core_scsi3_emulate_pro_preempt(cmd, type, scope,
3767 res_key, sa_res_key, PREEMPT_AND_ABORT);
3769 case PRO_REGISTER_AND_IGNORE_EXISTING_KEY:
3770 ret = core_scsi3_emulate_pro_register(cmd,
3771 0, sa_res_key, aptpl, all_tg_pt, spec_i_pt, REGISTER_AND_IGNORE_EXISTING_KEY);
3773 case PRO_REGISTER_AND_MOVE:
3774 ret = core_scsi3_emulate_pro_register_and_move(cmd, res_key,
3775 sa_res_key, aptpl, unreg);
3778 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
3779 " action: 0x%02x\n", cdb[1] & 0x1f);
3780 return TCM_INVALID_CDB_FIELD;
3784 target_complete_cmd(cmd, GOOD);
3789 * PERSISTENT_RESERVE_IN Service Action READ_KEYS
3791 * See spc4r17 section 5.7.6.2 and section 6.13.2, Table 160
3793 static sense_reason_t
3794 core_scsi3_pri_read_keys(struct se_cmd *cmd)
3796 struct se_device *dev = cmd->se_dev;
3797 struct t10_pr_registration *pr_reg;
3799 u32 add_len = 0, off = 8;
3801 if (cmd->data_length < 8) {
3802 pr_err("PRIN SA READ_KEYS SCSI Data Length: %u"
3803 " too small\n", cmd->data_length);
3804 return TCM_INVALID_CDB_FIELD;
3807 buf = transport_kmap_data_sg(cmd);
3809 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3811 buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3812 buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3813 buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3814 buf[3] = (dev->t10_pr.pr_generation & 0xff);
3816 spin_lock(&dev->t10_pr.registration_lock);
3817 list_for_each_entry(pr_reg, &dev->t10_pr.registration_list,
3820 * Check for overflow of 8byte PRI READ_KEYS payload and
3821 * next reservation key list descriptor.
3823 if ((add_len + 8) > (cmd->data_length - 8))
3826 buf[off++] = ((pr_reg->pr_res_key >> 56) & 0xff);
3827 buf[off++] = ((pr_reg->pr_res_key >> 48) & 0xff);
3828 buf[off++] = ((pr_reg->pr_res_key >> 40) & 0xff);
3829 buf[off++] = ((pr_reg->pr_res_key >> 32) & 0xff);
3830 buf[off++] = ((pr_reg->pr_res_key >> 24) & 0xff);
3831 buf[off++] = ((pr_reg->pr_res_key >> 16) & 0xff);
3832 buf[off++] = ((pr_reg->pr_res_key >> 8) & 0xff);
3833 buf[off++] = (pr_reg->pr_res_key & 0xff);
3837 spin_unlock(&dev->t10_pr.registration_lock);
3839 buf[4] = ((add_len >> 24) & 0xff);
3840 buf[5] = ((add_len >> 16) & 0xff);
3841 buf[6] = ((add_len >> 8) & 0xff);
3842 buf[7] = (add_len & 0xff);
3844 transport_kunmap_data_sg(cmd);
3850 * PERSISTENT_RESERVE_IN Service Action READ_RESERVATION
3852 * See spc4r17 section 5.7.6.3 and section 6.13.3.2 Table 161 and 162
3854 static sense_reason_t
3855 core_scsi3_pri_read_reservation(struct se_cmd *cmd)
3857 struct se_device *dev = cmd->se_dev;
3858 struct t10_pr_registration *pr_reg;
3861 u32 add_len = 16; /* Hardcoded to 16 when a reservation is held. */
3863 if (cmd->data_length < 8) {
3864 pr_err("PRIN SA READ_RESERVATIONS SCSI Data Length: %u"
3865 " too small\n", cmd->data_length);
3866 return TCM_INVALID_CDB_FIELD;
3869 buf = transport_kmap_data_sg(cmd);
3871 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3873 buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3874 buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3875 buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3876 buf[3] = (dev->t10_pr.pr_generation & 0xff);
3878 spin_lock(&dev->dev_reservation_lock);
3879 pr_reg = dev->dev_pr_res_holder;
3882 * Set the hardcoded Additional Length
3884 buf[4] = ((add_len >> 24) & 0xff);
3885 buf[5] = ((add_len >> 16) & 0xff);
3886 buf[6] = ((add_len >> 8) & 0xff);
3887 buf[7] = (add_len & 0xff);
3889 if (cmd->data_length < 22)
3893 * Set the Reservation key.
3895 * From spc4r17, section 5.7.10:
3896 * A persistent reservation holder has its reservation key
3897 * returned in the parameter data from a PERSISTENT
3898 * RESERVE IN command with READ RESERVATION service action as
3900 * a) For a persistent reservation of the type Write Exclusive
3901 * - All Registrants or Exclusive Access  All Regitrants,
3902 * the reservation key shall be set to zero; or
3903 * b) For all other persistent reservation types, the
3904 * reservation key shall be set to the registered
3905 * reservation key for the I_T nexus that holds the
3906 * persistent reservation.
3908 if ((pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
3909 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))
3912 pr_res_key = pr_reg->pr_res_key;
3914 buf[8] = ((pr_res_key >> 56) & 0xff);
3915 buf[9] = ((pr_res_key >> 48) & 0xff);
3916 buf[10] = ((pr_res_key >> 40) & 0xff);
3917 buf[11] = ((pr_res_key >> 32) & 0xff);
3918 buf[12] = ((pr_res_key >> 24) & 0xff);
3919 buf[13] = ((pr_res_key >> 16) & 0xff);
3920 buf[14] = ((pr_res_key >> 8) & 0xff);
3921 buf[15] = (pr_res_key & 0xff);
3923 * Set the SCOPE and TYPE
3925 buf[21] = (pr_reg->pr_res_scope & 0xf0) |
3926 (pr_reg->pr_res_type & 0x0f);
3930 spin_unlock(&dev->dev_reservation_lock);
3931 transport_kunmap_data_sg(cmd);
3937 * PERSISTENT_RESERVE_IN Service Action REPORT_CAPABILITIES
3939 * See spc4r17 section 6.13.4 Table 165
3941 static sense_reason_t
3942 core_scsi3_pri_report_capabilities(struct se_cmd *cmd)
3944 struct se_device *dev = cmd->se_dev;
3945 struct t10_reservation *pr_tmpl = &dev->t10_pr;
3947 u16 add_len = 8; /* Hardcoded to 8. */
3949 if (cmd->data_length < 6) {
3950 pr_err("PRIN SA REPORT_CAPABILITIES SCSI Data Length:"
3951 " %u too small\n", cmd->data_length);
3952 return TCM_INVALID_CDB_FIELD;
3955 buf = transport_kmap_data_sg(cmd);
3957 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3959 buf[0] = ((add_len << 8) & 0xff);
3960 buf[1] = (add_len & 0xff);
3961 buf[2] |= 0x10; /* CRH: Compatible Reservation Hanlding bit. */
3962 buf[2] |= 0x08; /* SIP_C: Specify Initiator Ports Capable bit */
3963 buf[2] |= 0x04; /* ATP_C: All Target Ports Capable bit */
3964 buf[2] |= 0x01; /* PTPL_C: Persistence across Target Power Loss bit */
3966 * We are filling in the PERSISTENT RESERVATION TYPE MASK below, so
3967 * set the TMV: Task Mask Valid bit.
3971 * Change ALLOW COMMANDs to 0x20 or 0x40 later from Table 166
3973 buf[3] |= 0x10; /* ALLOW COMMANDs field 001b */
3975 * PTPL_A: Persistence across Target Power Loss Active bit
3977 if (pr_tmpl->pr_aptpl_active)
3980 * Setup the PERSISTENT RESERVATION TYPE MASK from Table 167
3982 buf[4] |= 0x80; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3983 buf[4] |= 0x40; /* PR_TYPE_EXCLUSIVE_ACCESS_REGONLY */
3984 buf[4] |= 0x20; /* PR_TYPE_WRITE_EXCLUSIVE_REGONLY */
3985 buf[4] |= 0x08; /* PR_TYPE_EXCLUSIVE_ACCESS */
3986 buf[4] |= 0x02; /* PR_TYPE_WRITE_EXCLUSIVE */
3987 buf[5] |= 0x01; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3989 transport_kunmap_data_sg(cmd);
3995 * PERSISTENT_RESERVE_IN Service Action READ_FULL_STATUS
3997 * See spc4r17 section 6.13.5 Table 168 and 169
3999 static sense_reason_t
4000 core_scsi3_pri_read_full_status(struct se_cmd *cmd)
4002 struct se_device *dev = cmd->se_dev;
4003 struct se_node_acl *se_nacl;
4004 struct se_portal_group *se_tpg;
4005 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
4006 struct t10_reservation *pr_tmpl = &dev->t10_pr;
4008 u32 add_desc_len = 0, add_len = 0, desc_len, exp_desc_len;
4009 u32 off = 8; /* off into first Full Status descriptor */
4010 int format_code = 0;
4012 if (cmd->data_length < 8) {
4013 pr_err("PRIN SA READ_FULL_STATUS SCSI Data Length: %u"
4014 " too small\n", cmd->data_length);
4015 return TCM_INVALID_CDB_FIELD;
4018 buf = transport_kmap_data_sg(cmd);
4020 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
4022 buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
4023 buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
4024 buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
4025 buf[3] = (dev->t10_pr.pr_generation & 0xff);
4027 spin_lock(&pr_tmpl->registration_lock);
4028 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
4029 &pr_tmpl->registration_list, pr_reg_list) {
4031 se_nacl = pr_reg->pr_reg_nacl;
4032 se_tpg = pr_reg->pr_reg_nacl->se_tpg;
4035 atomic_inc(&pr_reg->pr_res_holders);
4036 smp_mb__after_atomic_inc();
4037 spin_unlock(&pr_tmpl->registration_lock);
4039 * Determine expected length of $FABRIC_MOD specific
4040 * TransportID full status descriptor..
4042 exp_desc_len = se_tpg->se_tpg_tfo->tpg_get_pr_transport_id_len(
4043 se_tpg, se_nacl, pr_reg, &format_code);
4045 if ((exp_desc_len + add_len) > cmd->data_length) {
4046 pr_warn("SPC-3 PRIN READ_FULL_STATUS ran"
4047 " out of buffer: %d\n", cmd->data_length);
4048 spin_lock(&pr_tmpl->registration_lock);
4049 atomic_dec(&pr_reg->pr_res_holders);
4050 smp_mb__after_atomic_dec();
4054 * Set RESERVATION KEY
4056 buf[off++] = ((pr_reg->pr_res_key >> 56) & 0xff);
4057 buf[off++] = ((pr_reg->pr_res_key >> 48) & 0xff);
4058 buf[off++] = ((pr_reg->pr_res_key >> 40) & 0xff);
4059 buf[off++] = ((pr_reg->pr_res_key >> 32) & 0xff);
4060 buf[off++] = ((pr_reg->pr_res_key >> 24) & 0xff);
4061 buf[off++] = ((pr_reg->pr_res_key >> 16) & 0xff);
4062 buf[off++] = ((pr_reg->pr_res_key >> 8) & 0xff);
4063 buf[off++] = (pr_reg->pr_res_key & 0xff);
4064 off += 4; /* Skip Over Reserved area */
4067 * Set ALL_TG_PT bit if PROUT SA REGISTER had this set.
4069 if (pr_reg->pr_reg_all_tg_pt)
4072 * The struct se_lun pointer will be present for the
4073 * reservation holder for PR_HOLDER bit.
4075 * Also, if this registration is the reservation
4076 * holder, fill in SCOPE and TYPE in the next byte.
4078 if (pr_reg->pr_res_holder) {
4080 buf[off++] = (pr_reg->pr_res_scope & 0xf0) |
4081 (pr_reg->pr_res_type & 0x0f);
4085 off += 4; /* Skip over reserved area */
4087 * From spc4r17 6.3.15:
4089 * If the ALL_TG_PT bit set to zero, the RELATIVE TARGET PORT
4090 * IDENTIFIER field contains the relative port identifier (see
4091 * 3.1.120) of the target port that is part of the I_T nexus
4092 * described by this full status descriptor. If the ALL_TG_PT
4093 * bit is set to one, the contents of the RELATIVE TARGET PORT
4094 * IDENTIFIER field are not defined by this standard.
4096 if (!pr_reg->pr_reg_all_tg_pt) {
4097 struct se_port *port = pr_reg->pr_reg_tg_pt_lun->lun_sep;
4099 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
4100 buf[off++] = (port->sep_rtpi & 0xff);
4102 off += 2; /* Skip over RELATIVE TARGET PORT IDENTIFIER */
4105 * Now, have the $FABRIC_MOD fill in the protocol identifier
4107 desc_len = se_tpg->se_tpg_tfo->tpg_get_pr_transport_id(se_tpg,
4108 se_nacl, pr_reg, &format_code, &buf[off+4]);
4110 spin_lock(&pr_tmpl->registration_lock);
4111 atomic_dec(&pr_reg->pr_res_holders);
4112 smp_mb__after_atomic_dec();
4114 * Set the ADDITIONAL DESCRIPTOR LENGTH
4116 buf[off++] = ((desc_len >> 24) & 0xff);
4117 buf[off++] = ((desc_len >> 16) & 0xff);
4118 buf[off++] = ((desc_len >> 8) & 0xff);
4119 buf[off++] = (desc_len & 0xff);
4121 * Size of full desctipor header minus TransportID
4122 * containing $FABRIC_MOD specific) initiator device/port
4125 * See spc4r17 Section 6.13.5 Table 169
4127 add_desc_len = (24 + desc_len);
4130 add_len += add_desc_len;
4132 spin_unlock(&pr_tmpl->registration_lock);
4134 * Set ADDITIONAL_LENGTH
4136 buf[4] = ((add_len >> 24) & 0xff);
4137 buf[5] = ((add_len >> 16) & 0xff);
4138 buf[6] = ((add_len >> 8) & 0xff);
4139 buf[7] = (add_len & 0xff);
4141 transport_kunmap_data_sg(cmd);
4147 target_scsi3_emulate_pr_in(struct se_cmd *cmd)
4152 * Following spc2r20 5.5.1 Reservations overview:
4154 * If a logical unit has been reserved by any RESERVE command and is
4155 * still reserved by any initiator, all PERSISTENT RESERVE IN and all
4156 * PERSISTENT RESERVE OUT commands shall conflict regardless of
4157 * initiator or service action and shall terminate with a RESERVATION
4160 if (cmd->se_dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS) {
4161 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
4162 " SPC-2 reservation is held, returning"
4163 " RESERVATION_CONFLICT\n");
4164 return TCM_RESERVATION_CONFLICT;
4167 switch (cmd->t_task_cdb[1] & 0x1f) {
4169 ret = core_scsi3_pri_read_keys(cmd);
4171 case PRI_READ_RESERVATION:
4172 ret = core_scsi3_pri_read_reservation(cmd);
4174 case PRI_REPORT_CAPABILITIES:
4175 ret = core_scsi3_pri_report_capabilities(cmd);
4177 case PRI_READ_FULL_STATUS:
4178 ret = core_scsi3_pri_read_full_status(cmd);
4181 pr_err("Unknown PERSISTENT_RESERVE_IN service"
4182 " action: 0x%02x\n", cmd->t_task_cdb[1] & 0x1f);
4183 return TCM_INVALID_CDB_FIELD;
4187 target_complete_cmd(cmd, GOOD);
4192 target_check_reservation(struct se_cmd *cmd)
4194 struct se_device *dev = cmd->se_dev;
4199 if (dev->se_hba->hba_flags & HBA_FLAGS_INTERNAL_USE)
4201 if (dev->transport->transport_type == TRANSPORT_PLUGIN_PHBA_PDEV)
4204 spin_lock(&dev->dev_reservation_lock);
4205 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS)
4206 ret = target_scsi2_reservation_check(cmd);
4208 ret = target_scsi3_pr_reservation_check(cmd);
4209 spin_unlock(&dev->dev_reservation_lock);