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 * Copyright (c) 2009, 2010 Rising Tide Systems
8 * Copyright (c) 2009, 2010 Linux-iSCSI.org
10 * Nicholas A. Bellinger <nab@kernel.org>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26 ******************************************************************************/
28 #include <linux/slab.h>
29 #include <linux/spinlock.h>
30 #include <linux/list.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_device.h>
37 #include <target/target_core_tmr.h>
38 #include <target/target_core_tpg.h>
39 #include <target/target_core_transport.h>
40 #include <target/target_core_fabric_ops.h>
41 #include <target/target_core_configfs.h>
43 #include "target_core_hba.h"
44 #include "target_core_pr.h"
45 #include "target_core_ua.h"
48 * Used for Specify Initiator Ports Capable Bit (SPEC_I_PT)
50 struct pr_transport_id_holder {
52 struct t10_pr_registration *dest_pr_reg;
53 struct se_portal_group *dest_tpg;
54 struct se_node_acl *dest_node_acl;
55 struct se_dev_entry *dest_se_deve;
56 struct list_head dest_list;
59 int core_pr_dump_initiator_port(
60 struct t10_pr_registration *pr_reg,
64 if (!pr_reg->isid_present_at_reg)
67 snprintf(buf, size, ",i,0x%s", &pr_reg->pr_reg_isid[0]);
71 static void __core_scsi3_complete_pro_release(struct se_device *, struct se_node_acl *,
72 struct t10_pr_registration *, int);
74 static int core_scsi2_reservation_seq_non_holder(
91 static int core_scsi2_reservation_check(struct se_cmd *cmd, u32 *pr_reg_type)
93 struct se_device *dev = cmd->se_dev;
94 struct se_session *sess = cmd->se_sess;
100 spin_lock(&dev->dev_reservation_lock);
101 if (!dev->dev_reserved_node_acl || !sess) {
102 spin_unlock(&dev->dev_reservation_lock);
105 if (dev->dev_reserved_node_acl != sess->se_node_acl) {
106 spin_unlock(&dev->dev_reservation_lock);
109 if (!(dev->dev_flags & DF_SPC2_RESERVATIONS_WITH_ISID)) {
110 spin_unlock(&dev->dev_reservation_lock);
113 ret = (dev->dev_res_bin_isid == sess->sess_bin_isid) ? 0 : -EINVAL;
114 spin_unlock(&dev->dev_reservation_lock);
119 static struct t10_pr_registration *core_scsi3_locate_pr_reg(struct se_device *,
120 struct se_node_acl *, struct se_session *);
121 static void core_scsi3_put_pr_reg(struct t10_pr_registration *);
123 static int target_check_scsi2_reservation_conflict(struct se_cmd *cmd, int *ret)
125 struct se_session *se_sess = cmd->se_sess;
126 struct se_subsystem_dev *su_dev = cmd->se_dev->se_sub_dev;
127 struct t10_pr_registration *pr_reg;
128 struct t10_reservation *pr_tmpl = &su_dev->t10_pr;
129 int crh = (su_dev->t10_pr.res_type == SPC3_PERSISTENT_RESERVATIONS);
135 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
139 * From spc4r17 5.7.3 Exceptions to SPC-2 RESERVE and RELEASE
142 * A RESERVE(6) or RESERVE(10) command shall complete with GOOD
143 * status, but no reservation shall be established and the
144 * persistent reservation shall not be changed, if the command
145 * is received from a) and b) below.
147 * A RELEASE(6) or RELEASE(10) command shall complete with GOOD
148 * status, but the persistent reservation shall not be released,
149 * if the command is received from a) and b)
151 * a) An I_T nexus that is a persistent reservation holder; or
152 * b) An I_T nexus that is registered if a registrants only or
153 * all registrants type persistent reservation is present.
155 * In all other cases, a RESERVE(6) command, RESERVE(10) command,
156 * RELEASE(6) command, or RELEASE(10) command shall be processed
157 * as defined in SPC-2.
159 if (pr_reg->pr_res_holder) {
160 core_scsi3_put_pr_reg(pr_reg);
164 if ((pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_REGONLY) ||
165 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_REGONLY) ||
166 (pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
167 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
168 core_scsi3_put_pr_reg(pr_reg);
172 core_scsi3_put_pr_reg(pr_reg);
176 * Following spc2r20 5.5.1 Reservations overview:
178 * If a logical unit has executed a PERSISTENT RESERVE OUT
179 * command with the REGISTER or the REGISTER AND IGNORE
180 * EXISTING KEY service action and is still registered by any
181 * initiator, all RESERVE commands and all RELEASE commands
182 * regardless of initiator shall conflict and shall terminate
183 * with a RESERVATION CONFLICT status.
185 spin_lock(&pr_tmpl->registration_lock);
186 conflict = (list_empty(&pr_tmpl->registration_list)) ? 0 : 1;
187 spin_unlock(&pr_tmpl->registration_lock);
191 pr_err("Received legacy SPC-2 RESERVE/RELEASE"
192 " while active SPC-3 registrations exist,"
193 " returning RESERVATION_CONFLICT\n");
194 *ret = PYX_TRANSPORT_RESERVATION_CONFLICT;
201 int target_scsi2_reservation_release(struct se_cmd *cmd)
203 struct se_device *dev = cmd->se_dev;
204 struct se_session *sess = cmd->se_sess;
205 struct se_portal_group *tpg = sess->se_tpg;
210 if (target_check_scsi2_reservation_conflict(cmd, &ret))
213 spin_lock(&dev->dev_reservation_lock);
214 if (!dev->dev_reserved_node_acl || !sess) {
215 spin_unlock(&dev->dev_reservation_lock);
219 if (dev->dev_reserved_node_acl != sess->se_node_acl) {
220 spin_unlock(&dev->dev_reservation_lock);
223 dev->dev_reserved_node_acl = NULL;
224 dev->dev_flags &= ~DF_SPC2_RESERVATIONS;
225 if (dev->dev_flags & DF_SPC2_RESERVATIONS_WITH_ISID) {
226 dev->dev_res_bin_isid = 0;
227 dev->dev_flags &= ~DF_SPC2_RESERVATIONS_WITH_ISID;
229 pr_debug("SCSI-2 Released reservation for %s LUN: %u ->"
230 " MAPPED LUN: %u for %s\n", tpg->se_tpg_tfo->get_fabric_name(),
231 cmd->se_lun->unpacked_lun, cmd->se_deve->mapped_lun,
232 sess->se_node_acl->initiatorname);
233 spin_unlock(&dev->dev_reservation_lock);
238 int target_scsi2_reservation_reserve(struct se_cmd *cmd)
240 struct se_device *dev = cmd->se_dev;
241 struct se_session *sess = cmd->se_sess;
242 struct se_portal_group *tpg = sess->se_tpg;
245 if ((cmd->t_task_cdb[1] & 0x01) &&
246 (cmd->t_task_cdb[1] & 0x02)) {
247 pr_err("LongIO and Obselete Bits set, returning"
248 " ILLEGAL_REQUEST\n");
249 return PYX_TRANSPORT_ILLEGAL_REQUEST;
252 * This is currently the case for target_core_mod passthrough struct se_cmd
257 if (target_check_scsi2_reservation_conflict(cmd, &ret))
260 spin_lock(&dev->dev_reservation_lock);
261 if (dev->dev_reserved_node_acl &&
262 (dev->dev_reserved_node_acl != sess->se_node_acl)) {
263 pr_err("SCSI-2 RESERVATION CONFLIFT for %s fabric\n",
264 tpg->se_tpg_tfo->get_fabric_name());
265 pr_err("Original reserver LUN: %u %s\n",
266 cmd->se_lun->unpacked_lun,
267 dev->dev_reserved_node_acl->initiatorname);
268 pr_err("Current attempt - LUN: %u -> MAPPED LUN: %u"
269 " from %s \n", cmd->se_lun->unpacked_lun,
270 cmd->se_deve->mapped_lun,
271 sess->se_node_acl->initiatorname);
272 spin_unlock(&dev->dev_reservation_lock);
273 return PYX_TRANSPORT_RESERVATION_CONFLICT;
276 dev->dev_reserved_node_acl = sess->se_node_acl;
277 dev->dev_flags |= DF_SPC2_RESERVATIONS;
278 if (sess->sess_bin_isid != 0) {
279 dev->dev_res_bin_isid = sess->sess_bin_isid;
280 dev->dev_flags |= DF_SPC2_RESERVATIONS_WITH_ISID;
282 pr_debug("SCSI-2 Reserved %s LUN: %u -> MAPPED LUN: %u"
283 " for %s\n", tpg->se_tpg_tfo->get_fabric_name(),
284 cmd->se_lun->unpacked_lun, cmd->se_deve->mapped_lun,
285 sess->se_node_acl->initiatorname);
286 spin_unlock(&dev->dev_reservation_lock);
293 * Begin SPC-3/SPC-4 Persistent Reservations emulation support
295 * This function is called by those initiator ports who are *NOT*
296 * the active PR reservation holder when a reservation is present.
298 static int core_scsi3_pr_seq_non_holder(
303 struct se_dev_entry *se_deve;
304 struct se_session *se_sess = cmd->se_sess;
305 int other_cdb = 0, ignore_reg;
306 int registered_nexus = 0, ret = 1; /* Conflict by default */
307 int all_reg = 0, reg_only = 0; /* ALL_REG, REG_ONLY */
308 int we = 0; /* Write Exclusive */
309 int legacy = 0; /* Act like a legacy device and return
310 * RESERVATION CONFLICT on some CDBs */
312 * A legacy SPC-2 reservation is being held.
314 if (cmd->se_dev->dev_flags & DF_SPC2_RESERVATIONS)
315 return core_scsi2_reservation_seq_non_holder(cmd,
318 se_deve = &se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
320 * Determine if the registration should be ignored due to
321 * non-matching ISIDs in core_scsi3_pr_reservation_check().
323 ignore_reg = (pr_reg_type & 0x80000000);
325 pr_reg_type &= ~0x80000000;
327 switch (pr_reg_type) {
328 case PR_TYPE_WRITE_EXCLUSIVE:
330 case PR_TYPE_EXCLUSIVE_ACCESS:
332 * Some commands are only allowed for the persistent reservation
335 if ((se_deve->def_pr_registered) && !(ignore_reg))
336 registered_nexus = 1;
338 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
340 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
342 * Some commands are only allowed for registered I_T Nexuses.
345 if ((se_deve->def_pr_registered) && !(ignore_reg))
346 registered_nexus = 1;
348 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
350 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
352 * Each registered I_T Nexus is a reservation holder.
355 if ((se_deve->def_pr_registered) && !(ignore_reg))
356 registered_nexus = 1;
362 * Referenced from spc4r17 table 45 for *NON* PR holder access
365 case SECURITY_PROTOCOL_IN:
366 if (registered_nexus)
374 case RECEIVE_DIAGNOSTIC:
379 if (registered_nexus) {
383 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
385 case PERSISTENT_RESERVE_OUT:
387 * This follows PERSISTENT_RESERVE_OUT service actions that
388 * are allowed in the presence of various reservations.
389 * See spc4r17, table 46
391 switch (cdb[1] & 0x1f) {
394 case PRO_PREEMPT_AND_ABORT:
395 ret = (registered_nexus) ? 0 : 1;
398 case PRO_REGISTER_AND_IGNORE_EXISTING_KEY:
401 case PRO_REGISTER_AND_MOVE:
406 ret = (registered_nexus) ? 0 : 1;
409 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
410 " action: 0x%02x\n", cdb[1] & 0x1f);
416 /* Handled by CRH=1 in target_scsi2_reservation_release() */
421 /* Handled by CRH=1 in target_scsi2_reservation_reserve() */
424 case TEST_UNIT_READY:
425 ret = (legacy) ? 1 : 0; /* Conflict for legacy */
428 switch (cdb[1] & 0x1f) {
429 case MI_MANAGEMENT_PROTOCOL_IN:
430 if (registered_nexus) {
434 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
436 case MI_REPORT_SUPPORTED_OPERATION_CODES:
437 case MI_REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS:
442 if (registered_nexus) {
446 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
448 case MI_REPORT_ALIASES:
449 case MI_REPORT_IDENTIFYING_INFORMATION:
450 case MI_REPORT_PRIORITY:
451 case MI_REPORT_TARGET_PGS:
452 case MI_REPORT_TIMESTAMP:
453 ret = 0; /* Allowed */
456 pr_err("Unknown MI Service Action: 0x%02x\n",
461 case ACCESS_CONTROL_IN:
462 case ACCESS_CONTROL_OUT:
465 case READ_MEDIA_SERIAL_NUMBER:
468 ret = 0; /*/ Allowed CDBs */
475 * Case where the CDB is explicitly allowed in the above switch
478 if (!ret && !other_cdb) {
480 pr_debug("Allowing explict CDB: 0x%02x for %s"
481 " reservation holder\n", cdb[0],
482 core_scsi3_pr_dump_type(pr_reg_type));
487 * Check if write exclusive initiator ports *NOT* holding the
488 * WRITE_EXCLUSIVE_* reservation.
490 if ((we) && !(registered_nexus)) {
491 if (cmd->data_direction == DMA_TO_DEVICE) {
493 * Conflict for write exclusive
495 pr_debug("%s Conflict for unregistered nexus"
496 " %s CDB: 0x%02x to %s reservation\n",
497 transport_dump_cmd_direction(cmd),
498 se_sess->se_node_acl->initiatorname, cdb[0],
499 core_scsi3_pr_dump_type(pr_reg_type));
503 * Allow non WRITE CDBs for all Write Exclusive
504 * PR TYPEs to pass for registered and
505 * non-registered_nexuxes NOT holding the reservation.
507 * We only make noise for the unregisterd nexuses,
508 * as we expect registered non-reservation holding
509 * nexuses to issue CDBs.
512 if (!registered_nexus) {
513 pr_debug("Allowing implict CDB: 0x%02x"
514 " for %s reservation on unregistered"
516 core_scsi3_pr_dump_type(pr_reg_type));
521 } else if ((reg_only) || (all_reg)) {
522 if (registered_nexus) {
524 * For PR_*_REG_ONLY and PR_*_ALL_REG reservations,
525 * allow commands from registered nexuses.
528 pr_debug("Allowing implict CDB: 0x%02x for %s"
529 " reservation\n", cdb[0],
530 core_scsi3_pr_dump_type(pr_reg_type));
535 pr_debug("%s Conflict for %sregistered nexus %s CDB: 0x%2x"
536 " for %s reservation\n", transport_dump_cmd_direction(cmd),
537 (registered_nexus) ? "" : "un",
538 se_sess->se_node_acl->initiatorname, cdb[0],
539 core_scsi3_pr_dump_type(pr_reg_type));
541 return 1; /* Conflict by default */
544 static u32 core_scsi3_pr_generation(struct se_device *dev)
546 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
549 * PRGeneration field shall contain the value of a 32-bit wrapping
550 * counter mainted by the device server.
552 * Note that this is done regardless of Active Persist across
553 * Target PowerLoss (APTPL)
555 * See spc4r17 section 6.3.12 READ_KEYS service action
557 spin_lock(&dev->dev_reservation_lock);
558 prg = su_dev->t10_pr.pr_generation++;
559 spin_unlock(&dev->dev_reservation_lock);
564 static int core_scsi3_pr_reservation_check(
568 struct se_device *dev = cmd->se_dev;
569 struct se_session *sess = cmd->se_sess;
575 * A legacy SPC-2 reservation is being held.
577 if (dev->dev_flags & DF_SPC2_RESERVATIONS)
578 return core_scsi2_reservation_check(cmd, pr_reg_type);
580 spin_lock(&dev->dev_reservation_lock);
581 if (!dev->dev_pr_res_holder) {
582 spin_unlock(&dev->dev_reservation_lock);
585 *pr_reg_type = dev->dev_pr_res_holder->pr_res_type;
586 cmd->pr_res_key = dev->dev_pr_res_holder->pr_res_key;
587 if (dev->dev_pr_res_holder->pr_reg_nacl != sess->se_node_acl) {
588 spin_unlock(&dev->dev_reservation_lock);
591 if (!dev->dev_pr_res_holder->isid_present_at_reg) {
592 spin_unlock(&dev->dev_reservation_lock);
595 ret = (dev->dev_pr_res_holder->pr_reg_bin_isid ==
596 sess->sess_bin_isid) ? 0 : -EINVAL;
598 * Use bit in *pr_reg_type to notify ISID mismatch in
599 * core_scsi3_pr_seq_non_holder().
602 *pr_reg_type |= 0x80000000;
603 spin_unlock(&dev->dev_reservation_lock);
608 static struct t10_pr_registration *__core_scsi3_do_alloc_registration(
609 struct se_device *dev,
610 struct se_node_acl *nacl,
611 struct se_dev_entry *deve,
617 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
618 struct t10_pr_registration *pr_reg;
620 pr_reg = kmem_cache_zalloc(t10_pr_reg_cache, GFP_ATOMIC);
622 pr_err("Unable to allocate struct t10_pr_registration\n");
626 pr_reg->pr_aptpl_buf = kzalloc(su_dev->t10_pr.pr_aptpl_buf_len,
628 if (!pr_reg->pr_aptpl_buf) {
629 pr_err("Unable to allocate pr_reg->pr_aptpl_buf\n");
630 kmem_cache_free(t10_pr_reg_cache, pr_reg);
634 INIT_LIST_HEAD(&pr_reg->pr_reg_list);
635 INIT_LIST_HEAD(&pr_reg->pr_reg_abort_list);
636 INIT_LIST_HEAD(&pr_reg->pr_reg_aptpl_list);
637 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_list);
638 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_mem_list);
639 atomic_set(&pr_reg->pr_res_holders, 0);
640 pr_reg->pr_reg_nacl = nacl;
641 pr_reg->pr_reg_deve = deve;
642 pr_reg->pr_res_mapped_lun = deve->mapped_lun;
643 pr_reg->pr_aptpl_target_lun = deve->se_lun->unpacked_lun;
644 pr_reg->pr_res_key = sa_res_key;
645 pr_reg->pr_reg_all_tg_pt = all_tg_pt;
646 pr_reg->pr_reg_aptpl = aptpl;
647 pr_reg->pr_reg_tg_pt_lun = deve->se_lun;
649 * If an ISID value for this SCSI Initiator Port exists,
650 * save it to the registration now.
653 pr_reg->pr_reg_bin_isid = get_unaligned_be64(isid);
654 snprintf(pr_reg->pr_reg_isid, PR_REG_ISID_LEN, "%s", isid);
655 pr_reg->isid_present_at_reg = 1;
661 static int core_scsi3_lunacl_depend_item(struct se_dev_entry *);
662 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry *);
665 * Function used for handling PR registrations for ALL_TG_PT=1 and ALL_TG_PT=0
668 static struct t10_pr_registration *__core_scsi3_alloc_registration(
669 struct se_device *dev,
670 struct se_node_acl *nacl,
671 struct se_dev_entry *deve,
677 struct se_dev_entry *deve_tmp;
678 struct se_node_acl *nacl_tmp;
679 struct se_port *port, *port_tmp;
680 struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
681 struct t10_pr_registration *pr_reg, *pr_reg_atp, *pr_reg_tmp, *pr_reg_tmp_safe;
684 * Create a registration for the I_T Nexus upon which the
685 * PROUT REGISTER was received.
687 pr_reg = __core_scsi3_do_alloc_registration(dev, nacl, deve, isid,
688 sa_res_key, all_tg_pt, aptpl);
692 * Return pointer to pr_reg for ALL_TG_PT=0
697 * Create list of matching SCSI Initiator Port registrations
700 spin_lock(&dev->se_port_lock);
701 list_for_each_entry_safe(port, port_tmp, &dev->dev_sep_list, sep_list) {
702 atomic_inc(&port->sep_tg_pt_ref_cnt);
703 smp_mb__after_atomic_inc();
704 spin_unlock(&dev->se_port_lock);
706 spin_lock_bh(&port->sep_alua_lock);
707 list_for_each_entry(deve_tmp, &port->sep_alua_list,
710 * This pointer will be NULL for demo mode MappedLUNs
711 * that have not been make explict via a ConfigFS
712 * MappedLUN group for the SCSI Initiator Node ACL.
714 if (!deve_tmp->se_lun_acl)
717 nacl_tmp = deve_tmp->se_lun_acl->se_lun_nacl;
719 * Skip the matching struct se_node_acl that is allocated
722 if (nacl == nacl_tmp)
725 * Only perform PR registrations for target ports on
726 * the same fabric module as the REGISTER w/ ALL_TG_PT=1
729 if (tfo != nacl_tmp->se_tpg->se_tpg_tfo)
732 * Look for a matching Initiator Node ACL in ASCII format
734 if (strcmp(nacl->initiatorname, nacl_tmp->initiatorname))
737 atomic_inc(&deve_tmp->pr_ref_count);
738 smp_mb__after_atomic_inc();
739 spin_unlock_bh(&port->sep_alua_lock);
741 * Grab a configfs group dependency that is released
742 * for the exception path at label out: below, or upon
743 * completion of adding ALL_TG_PT=1 registrations in
744 * __core_scsi3_add_registration()
746 ret = core_scsi3_lunacl_depend_item(deve_tmp);
748 pr_err("core_scsi3_lunacl_depend"
750 atomic_dec(&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();
757 * Located a matching SCSI Initiator Port on a different
758 * port, allocate the pr_reg_atp and attach it to the
759 * pr_reg->pr_reg_atp_list that will be processed once
760 * the original *pr_reg is processed in
761 * __core_scsi3_add_registration()
763 pr_reg_atp = __core_scsi3_do_alloc_registration(dev,
764 nacl_tmp, deve_tmp, NULL,
765 sa_res_key, all_tg_pt, aptpl);
767 atomic_dec(&port->sep_tg_pt_ref_cnt);
768 smp_mb__after_atomic_dec();
769 atomic_dec(&deve_tmp->pr_ref_count);
770 smp_mb__after_atomic_dec();
771 core_scsi3_lunacl_undepend_item(deve_tmp);
775 list_add_tail(&pr_reg_atp->pr_reg_atp_mem_list,
776 &pr_reg->pr_reg_atp_list);
777 spin_lock_bh(&port->sep_alua_lock);
779 spin_unlock_bh(&port->sep_alua_lock);
781 spin_lock(&dev->se_port_lock);
782 atomic_dec(&port->sep_tg_pt_ref_cnt);
783 smp_mb__after_atomic_dec();
785 spin_unlock(&dev->se_port_lock);
789 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
790 &pr_reg->pr_reg_atp_list, pr_reg_atp_mem_list) {
791 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
792 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
793 kmem_cache_free(t10_pr_reg_cache, pr_reg_tmp);
795 kmem_cache_free(t10_pr_reg_cache, pr_reg);
799 int core_scsi3_alloc_aptpl_registration(
800 struct t10_reservation *pr_tmpl,
802 unsigned char *i_port,
805 unsigned char *t_port,
812 struct t10_pr_registration *pr_reg;
814 if (!i_port || !t_port || !sa_res_key) {
815 pr_err("Illegal parameters for APTPL registration\n");
819 pr_reg = kmem_cache_zalloc(t10_pr_reg_cache, GFP_KERNEL);
821 pr_err("Unable to allocate struct t10_pr_registration\n");
824 pr_reg->pr_aptpl_buf = kzalloc(pr_tmpl->pr_aptpl_buf_len, GFP_KERNEL);
826 INIT_LIST_HEAD(&pr_reg->pr_reg_list);
827 INIT_LIST_HEAD(&pr_reg->pr_reg_abort_list);
828 INIT_LIST_HEAD(&pr_reg->pr_reg_aptpl_list);
829 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_list);
830 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_mem_list);
831 atomic_set(&pr_reg->pr_res_holders, 0);
832 pr_reg->pr_reg_nacl = NULL;
833 pr_reg->pr_reg_deve = NULL;
834 pr_reg->pr_res_mapped_lun = mapped_lun;
835 pr_reg->pr_aptpl_target_lun = target_lun;
836 pr_reg->pr_res_key = sa_res_key;
837 pr_reg->pr_reg_all_tg_pt = all_tg_pt;
838 pr_reg->pr_reg_aptpl = 1;
839 pr_reg->pr_reg_tg_pt_lun = NULL;
840 pr_reg->pr_res_scope = 0; /* Always LUN_SCOPE */
841 pr_reg->pr_res_type = type;
843 * If an ISID value had been saved in APTPL metadata for this
844 * SCSI Initiator Port, restore it now.
847 pr_reg->pr_reg_bin_isid = get_unaligned_be64(isid);
848 snprintf(pr_reg->pr_reg_isid, PR_REG_ISID_LEN, "%s", isid);
849 pr_reg->isid_present_at_reg = 1;
852 * Copy the i_port and t_port information from caller.
854 snprintf(pr_reg->pr_iport, PR_APTPL_MAX_IPORT_LEN, "%s", i_port);
855 snprintf(pr_reg->pr_tport, PR_APTPL_MAX_TPORT_LEN, "%s", t_port);
856 pr_reg->pr_reg_tpgt = tpgt;
858 * Set pr_res_holder from caller, the pr_reg who is the reservation
859 * holder will get it's pointer set in core_scsi3_aptpl_reserve() once
860 * the Initiator Node LUN ACL from the fabric module is created for
863 pr_reg->pr_res_holder = res_holder;
865 list_add_tail(&pr_reg->pr_reg_aptpl_list, &pr_tmpl->aptpl_reg_list);
866 pr_debug("SPC-3 PR APTPL Successfully added registration%s from"
867 " metadata\n", (res_holder) ? "+reservation" : "");
871 static void core_scsi3_aptpl_reserve(
872 struct se_device *dev,
873 struct se_portal_group *tpg,
874 struct se_node_acl *node_acl,
875 struct t10_pr_registration *pr_reg)
877 char i_buf[PR_REG_ISID_ID_LEN];
880 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
881 prf_isid = core_pr_dump_initiator_port(pr_reg, &i_buf[0],
884 spin_lock(&dev->dev_reservation_lock);
885 dev->dev_pr_res_holder = pr_reg;
886 spin_unlock(&dev->dev_reservation_lock);
888 pr_debug("SPC-3 PR [%s] Service Action: APTPL RESERVE created"
889 " new reservation holder TYPE: %s ALL_TG_PT: %d\n",
890 tpg->se_tpg_tfo->get_fabric_name(),
891 core_scsi3_pr_dump_type(pr_reg->pr_res_type),
892 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
893 pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
894 tpg->se_tpg_tfo->get_fabric_name(), node_acl->initiatorname,
895 (prf_isid) ? &i_buf[0] : "");
898 static void __core_scsi3_add_registration(struct se_device *, struct se_node_acl *,
899 struct t10_pr_registration *, int, int);
901 static int __core_scsi3_check_aptpl_registration(
902 struct se_device *dev,
903 struct se_portal_group *tpg,
906 struct se_node_acl *nacl,
907 struct se_dev_entry *deve)
909 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
910 struct t10_reservation *pr_tmpl = &dev->se_sub_dev->t10_pr;
911 unsigned char i_port[PR_APTPL_MAX_IPORT_LEN];
912 unsigned char t_port[PR_APTPL_MAX_TPORT_LEN];
915 memset(i_port, 0, PR_APTPL_MAX_IPORT_LEN);
916 memset(t_port, 0, PR_APTPL_MAX_TPORT_LEN);
918 * Copy Initiator Port information from struct se_node_acl
920 snprintf(i_port, PR_APTPL_MAX_IPORT_LEN, "%s", nacl->initiatorname);
921 snprintf(t_port, PR_APTPL_MAX_TPORT_LEN, "%s",
922 tpg->se_tpg_tfo->tpg_get_wwn(tpg));
923 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
925 * Look for the matching registrations+reservation from those
926 * created from APTPL metadata. Note that multiple registrations
927 * may exist for fabrics that use ISIDs in their SCSI Initiator Port
930 spin_lock(&pr_tmpl->aptpl_reg_lock);
931 list_for_each_entry_safe(pr_reg, pr_reg_tmp, &pr_tmpl->aptpl_reg_list,
933 if (!strcmp(pr_reg->pr_iport, i_port) &&
934 (pr_reg->pr_res_mapped_lun == deve->mapped_lun) &&
935 !(strcmp(pr_reg->pr_tport, t_port)) &&
936 (pr_reg->pr_reg_tpgt == tpgt) &&
937 (pr_reg->pr_aptpl_target_lun == target_lun)) {
939 pr_reg->pr_reg_nacl = nacl;
940 pr_reg->pr_reg_deve = deve;
941 pr_reg->pr_reg_tg_pt_lun = lun;
943 list_del(&pr_reg->pr_reg_aptpl_list);
944 spin_unlock(&pr_tmpl->aptpl_reg_lock);
946 * At this point all of the pointers in *pr_reg will
947 * be setup, so go ahead and add the registration.
950 __core_scsi3_add_registration(dev, nacl, pr_reg, 0, 0);
952 * If this registration is the reservation holder,
953 * make that happen now..
955 if (pr_reg->pr_res_holder)
956 core_scsi3_aptpl_reserve(dev, tpg,
959 * Reenable pr_aptpl_active to accept new metadata
960 * updates once the SCSI device is active again..
962 spin_lock(&pr_tmpl->aptpl_reg_lock);
963 pr_tmpl->pr_aptpl_active = 1;
966 spin_unlock(&pr_tmpl->aptpl_reg_lock);
971 int core_scsi3_check_aptpl_registration(
972 struct se_device *dev,
973 struct se_portal_group *tpg,
975 struct se_lun_acl *lun_acl)
977 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
978 struct se_node_acl *nacl = lun_acl->se_lun_nacl;
979 struct se_dev_entry *deve = &nacl->device_list[lun_acl->mapped_lun];
981 if (su_dev->t10_pr.res_type != SPC3_PERSISTENT_RESERVATIONS)
984 return __core_scsi3_check_aptpl_registration(dev, tpg, lun,
985 lun->unpacked_lun, nacl, deve);
988 static void __core_scsi3_dump_registration(
989 struct target_core_fabric_ops *tfo,
990 struct se_device *dev,
991 struct se_node_acl *nacl,
992 struct t10_pr_registration *pr_reg,
995 struct se_portal_group *se_tpg = nacl->se_tpg;
996 char i_buf[PR_REG_ISID_ID_LEN];
999 memset(&i_buf[0], 0, PR_REG_ISID_ID_LEN);
1000 prf_isid = core_pr_dump_initiator_port(pr_reg, &i_buf[0],
1001 PR_REG_ISID_ID_LEN);
1003 pr_debug("SPC-3 PR [%s] Service Action: REGISTER%s Initiator"
1004 " Node: %s%s\n", tfo->get_fabric_name(), (register_type == 2) ?
1005 "_AND_MOVE" : (register_type == 1) ?
1006 "_AND_IGNORE_EXISTING_KEY" : "", nacl->initiatorname,
1007 (prf_isid) ? i_buf : "");
1008 pr_debug("SPC-3 PR [%s] registration on Target Port: %s,0x%04x\n",
1009 tfo->get_fabric_name(), tfo->tpg_get_wwn(se_tpg),
1010 tfo->tpg_get_tag(se_tpg));
1011 pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
1012 " Port(s)\n", tfo->get_fabric_name(),
1013 (pr_reg->pr_reg_all_tg_pt) ? "ALL" : "SINGLE",
1014 dev->transport->name);
1015 pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
1016 " 0x%08x APTPL: %d\n", tfo->get_fabric_name(),
1017 pr_reg->pr_res_key, pr_reg->pr_res_generation,
1018 pr_reg->pr_reg_aptpl);
1022 * this function can be called with struct se_device->dev_reservation_lock
1023 * when register_move = 1
1025 static void __core_scsi3_add_registration(
1026 struct se_device *dev,
1027 struct se_node_acl *nacl,
1028 struct t10_pr_registration *pr_reg,
1032 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
1033 struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
1034 struct t10_pr_registration *pr_reg_tmp, *pr_reg_tmp_safe;
1035 struct t10_reservation *pr_tmpl = &dev->se_sub_dev->t10_pr;
1038 * Increment PRgeneration counter for struct se_device upon a successful
1039 * REGISTER, see spc4r17 section 6.3.2 READ_KEYS service action
1041 * Also, when register_move = 1 for PROUT REGISTER_AND_MOVE service
1042 * action, the struct se_device->dev_reservation_lock will already be held,
1043 * so we do not call core_scsi3_pr_generation() which grabs the lock
1046 pr_reg->pr_res_generation = (register_move) ?
1047 su_dev->t10_pr.pr_generation++ :
1048 core_scsi3_pr_generation(dev);
1050 spin_lock(&pr_tmpl->registration_lock);
1051 list_add_tail(&pr_reg->pr_reg_list, &pr_tmpl->registration_list);
1052 pr_reg->pr_reg_deve->def_pr_registered = 1;
1054 __core_scsi3_dump_registration(tfo, dev, nacl, pr_reg, register_type);
1055 spin_unlock(&pr_tmpl->registration_lock);
1057 * Skip extra processing for ALL_TG_PT=0 or REGISTER_AND_MOVE.
1059 if (!pr_reg->pr_reg_all_tg_pt || register_move)
1062 * Walk pr_reg->pr_reg_atp_list and add registrations for ALL_TG_PT=1
1063 * allocated in __core_scsi3_alloc_registration()
1065 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
1066 &pr_reg->pr_reg_atp_list, pr_reg_atp_mem_list) {
1067 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
1069 pr_reg_tmp->pr_res_generation = core_scsi3_pr_generation(dev);
1071 spin_lock(&pr_tmpl->registration_lock);
1072 list_add_tail(&pr_reg_tmp->pr_reg_list,
1073 &pr_tmpl->registration_list);
1074 pr_reg_tmp->pr_reg_deve->def_pr_registered = 1;
1076 __core_scsi3_dump_registration(tfo, dev,
1077 pr_reg_tmp->pr_reg_nacl, pr_reg_tmp,
1079 spin_unlock(&pr_tmpl->registration_lock);
1081 * Drop configfs group dependency reference from
1082 * __core_scsi3_alloc_registration()
1084 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
1088 static int core_scsi3_alloc_registration(
1089 struct se_device *dev,
1090 struct se_node_acl *nacl,
1091 struct se_dev_entry *deve,
1092 unsigned char *isid,
1099 struct t10_pr_registration *pr_reg;
1101 pr_reg = __core_scsi3_alloc_registration(dev, nacl, deve, isid,
1102 sa_res_key, all_tg_pt, aptpl);
1106 __core_scsi3_add_registration(dev, nacl, pr_reg,
1107 register_type, register_move);
1111 static struct t10_pr_registration *__core_scsi3_locate_pr_reg(
1112 struct se_device *dev,
1113 struct se_node_acl *nacl,
1114 unsigned char *isid)
1116 struct t10_reservation *pr_tmpl = &dev->se_sub_dev->t10_pr;
1117 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
1118 struct se_portal_group *tpg;
1120 spin_lock(&pr_tmpl->registration_lock);
1121 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1122 &pr_tmpl->registration_list, pr_reg_list) {
1124 * First look for a matching struct se_node_acl
1126 if (pr_reg->pr_reg_nacl != nacl)
1129 tpg = pr_reg->pr_reg_nacl->se_tpg;
1131 * If this registration does NOT contain a fabric provided
1132 * ISID, then we have found a match.
1134 if (!pr_reg->isid_present_at_reg) {
1136 * Determine if this SCSI device server requires that
1137 * SCSI Intiatior TransportID w/ ISIDs is enforced
1138 * for fabric modules (iSCSI) requiring them.
1140 if (tpg->se_tpg_tfo->sess_get_initiator_sid != NULL) {
1141 if (dev->se_sub_dev->se_dev_attrib.enforce_pr_isids)
1144 atomic_inc(&pr_reg->pr_res_holders);
1145 smp_mb__after_atomic_inc();
1146 spin_unlock(&pr_tmpl->registration_lock);
1150 * If the *pr_reg contains a fabric defined ISID for multi-value
1151 * SCSI Initiator Port TransportIDs, then we expect a valid
1152 * matching ISID to be provided by the local SCSI Initiator Port.
1156 if (strcmp(isid, pr_reg->pr_reg_isid))
1159 atomic_inc(&pr_reg->pr_res_holders);
1160 smp_mb__after_atomic_inc();
1161 spin_unlock(&pr_tmpl->registration_lock);
1164 spin_unlock(&pr_tmpl->registration_lock);
1169 static struct t10_pr_registration *core_scsi3_locate_pr_reg(
1170 struct se_device *dev,
1171 struct se_node_acl *nacl,
1172 struct se_session *sess)
1174 struct se_portal_group *tpg = nacl->se_tpg;
1175 unsigned char buf[PR_REG_ISID_LEN], *isid_ptr = NULL;
1177 if (tpg->se_tpg_tfo->sess_get_initiator_sid != NULL) {
1178 memset(&buf[0], 0, PR_REG_ISID_LEN);
1179 tpg->se_tpg_tfo->sess_get_initiator_sid(sess, &buf[0],
1184 return __core_scsi3_locate_pr_reg(dev, nacl, isid_ptr);
1187 static void core_scsi3_put_pr_reg(struct t10_pr_registration *pr_reg)
1189 atomic_dec(&pr_reg->pr_res_holders);
1190 smp_mb__after_atomic_dec();
1193 static int core_scsi3_check_implict_release(
1194 struct se_device *dev,
1195 struct t10_pr_registration *pr_reg)
1197 struct se_node_acl *nacl = pr_reg->pr_reg_nacl;
1198 struct t10_pr_registration *pr_res_holder;
1201 spin_lock(&dev->dev_reservation_lock);
1202 pr_res_holder = dev->dev_pr_res_holder;
1203 if (!pr_res_holder) {
1204 spin_unlock(&dev->dev_reservation_lock);
1207 if (pr_res_holder == pr_reg) {
1209 * Perform an implict RELEASE if the registration that
1210 * is being released is holding the reservation.
1212 * From spc4r17, section 5.7.11.1:
1214 * e) If the I_T nexus is the persistent reservation holder
1215 * and the persistent reservation is not an all registrants
1216 * type, then a PERSISTENT RESERVE OUT command with REGISTER
1217 * service action or REGISTER AND IGNORE EXISTING KEY
1218 * service action with the SERVICE ACTION RESERVATION KEY
1219 * field set to zero (see 5.7.11.3).
1221 __core_scsi3_complete_pro_release(dev, nacl, pr_reg, 0);
1224 * For 'All Registrants' reservation types, all existing
1225 * registrations are still processed as reservation holders
1226 * in core_scsi3_pr_seq_non_holder() after the initial
1227 * reservation holder is implictly released here.
1229 } else if (pr_reg->pr_reg_all_tg_pt &&
1230 (!strcmp(pr_res_holder->pr_reg_nacl->initiatorname,
1231 pr_reg->pr_reg_nacl->initiatorname)) &&
1232 (pr_res_holder->pr_res_key == pr_reg->pr_res_key)) {
1233 pr_err("SPC-3 PR: Unable to perform ALL_TG_PT=1"
1234 " UNREGISTER while existing reservation with matching"
1235 " key 0x%016Lx is present from another SCSI Initiator"
1236 " Port\n", pr_reg->pr_res_key);
1239 spin_unlock(&dev->dev_reservation_lock);
1245 * Called with struct t10_reservation->registration_lock held.
1247 static void __core_scsi3_free_registration(
1248 struct se_device *dev,
1249 struct t10_pr_registration *pr_reg,
1250 struct list_head *preempt_and_abort_list,
1253 struct target_core_fabric_ops *tfo =
1254 pr_reg->pr_reg_nacl->se_tpg->se_tpg_tfo;
1255 struct t10_reservation *pr_tmpl = &dev->se_sub_dev->t10_pr;
1256 char i_buf[PR_REG_ISID_ID_LEN];
1259 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
1260 prf_isid = core_pr_dump_initiator_port(pr_reg, &i_buf[0],
1261 PR_REG_ISID_ID_LEN);
1263 pr_reg->pr_reg_deve->def_pr_registered = 0;
1264 pr_reg->pr_reg_deve->pr_res_key = 0;
1265 list_del(&pr_reg->pr_reg_list);
1267 * Caller accessing *pr_reg using core_scsi3_locate_pr_reg(),
1268 * so call core_scsi3_put_pr_reg() to decrement our reference.
1271 core_scsi3_put_pr_reg(pr_reg);
1273 * Wait until all reference from any other I_T nexuses for this
1274 * *pr_reg have been released. Because list_del() is called above,
1275 * the last core_scsi3_put_pr_reg(pr_reg) will release this reference
1276 * count back to zero, and we release *pr_reg.
1278 while (atomic_read(&pr_reg->pr_res_holders) != 0) {
1279 spin_unlock(&pr_tmpl->registration_lock);
1280 pr_debug("SPC-3 PR [%s] waiting for pr_res_holders\n",
1281 tfo->get_fabric_name());
1283 spin_lock(&pr_tmpl->registration_lock);
1286 pr_debug("SPC-3 PR [%s] Service Action: UNREGISTER Initiator"
1287 " Node: %s%s\n", tfo->get_fabric_name(),
1288 pr_reg->pr_reg_nacl->initiatorname,
1289 (prf_isid) ? &i_buf[0] : "");
1290 pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
1291 " Port(s)\n", tfo->get_fabric_name(),
1292 (pr_reg->pr_reg_all_tg_pt) ? "ALL" : "SINGLE",
1293 dev->transport->name);
1294 pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
1295 " 0x%08x\n", tfo->get_fabric_name(), pr_reg->pr_res_key,
1296 pr_reg->pr_res_generation);
1298 if (!preempt_and_abort_list) {
1299 pr_reg->pr_reg_deve = NULL;
1300 pr_reg->pr_reg_nacl = NULL;
1301 kfree(pr_reg->pr_aptpl_buf);
1302 kmem_cache_free(t10_pr_reg_cache, pr_reg);
1306 * For PREEMPT_AND_ABORT, the list of *pr_reg in preempt_and_abort_list
1307 * are released once the ABORT_TASK_SET has completed..
1309 list_add_tail(&pr_reg->pr_reg_abort_list, preempt_and_abort_list);
1312 void core_scsi3_free_pr_reg_from_nacl(
1313 struct se_device *dev,
1314 struct se_node_acl *nacl)
1316 struct t10_reservation *pr_tmpl = &dev->se_sub_dev->t10_pr;
1317 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_res_holder;
1319 * If the passed se_node_acl matches the reservation holder,
1320 * release the reservation.
1322 spin_lock(&dev->dev_reservation_lock);
1323 pr_res_holder = dev->dev_pr_res_holder;
1324 if ((pr_res_holder != NULL) &&
1325 (pr_res_holder->pr_reg_nacl == nacl))
1326 __core_scsi3_complete_pro_release(dev, nacl, pr_res_holder, 0);
1327 spin_unlock(&dev->dev_reservation_lock);
1329 * Release any registration associated with the struct se_node_acl.
1331 spin_lock(&pr_tmpl->registration_lock);
1332 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1333 &pr_tmpl->registration_list, pr_reg_list) {
1335 if (pr_reg->pr_reg_nacl != nacl)
1338 __core_scsi3_free_registration(dev, pr_reg, NULL, 0);
1340 spin_unlock(&pr_tmpl->registration_lock);
1343 void core_scsi3_free_all_registrations(
1344 struct se_device *dev)
1346 struct t10_reservation *pr_tmpl = &dev->se_sub_dev->t10_pr;
1347 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_res_holder;
1349 spin_lock(&dev->dev_reservation_lock);
1350 pr_res_holder = dev->dev_pr_res_holder;
1351 if (pr_res_holder != NULL) {
1352 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
1353 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
1356 spin_unlock(&dev->dev_reservation_lock);
1358 spin_lock(&pr_tmpl->registration_lock);
1359 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1360 &pr_tmpl->registration_list, pr_reg_list) {
1362 __core_scsi3_free_registration(dev, pr_reg, NULL, 0);
1364 spin_unlock(&pr_tmpl->registration_lock);
1366 spin_lock(&pr_tmpl->aptpl_reg_lock);
1367 list_for_each_entry_safe(pr_reg, pr_reg_tmp, &pr_tmpl->aptpl_reg_list,
1368 pr_reg_aptpl_list) {
1369 list_del(&pr_reg->pr_reg_aptpl_list);
1370 kfree(pr_reg->pr_aptpl_buf);
1371 kmem_cache_free(t10_pr_reg_cache, pr_reg);
1373 spin_unlock(&pr_tmpl->aptpl_reg_lock);
1376 static int core_scsi3_tpg_depend_item(struct se_portal_group *tpg)
1378 return configfs_depend_item(tpg->se_tpg_tfo->tf_subsys,
1379 &tpg->tpg_group.cg_item);
1382 static void core_scsi3_tpg_undepend_item(struct se_portal_group *tpg)
1384 configfs_undepend_item(tpg->se_tpg_tfo->tf_subsys,
1385 &tpg->tpg_group.cg_item);
1387 atomic_dec(&tpg->tpg_pr_ref_count);
1388 smp_mb__after_atomic_dec();
1391 static int core_scsi3_nodeacl_depend_item(struct se_node_acl *nacl)
1393 struct se_portal_group *tpg = nacl->se_tpg;
1395 if (nacl->dynamic_node_acl)
1398 return configfs_depend_item(tpg->se_tpg_tfo->tf_subsys,
1399 &nacl->acl_group.cg_item);
1402 static void core_scsi3_nodeacl_undepend_item(struct se_node_acl *nacl)
1404 struct se_portal_group *tpg = nacl->se_tpg;
1406 if (nacl->dynamic_node_acl) {
1407 atomic_dec(&nacl->acl_pr_ref_count);
1408 smp_mb__after_atomic_dec();
1412 configfs_undepend_item(tpg->se_tpg_tfo->tf_subsys,
1413 &nacl->acl_group.cg_item);
1415 atomic_dec(&nacl->acl_pr_ref_count);
1416 smp_mb__after_atomic_dec();
1419 static int core_scsi3_lunacl_depend_item(struct se_dev_entry *se_deve)
1421 struct se_lun_acl *lun_acl = se_deve->se_lun_acl;
1422 struct se_node_acl *nacl;
1423 struct se_portal_group *tpg;
1425 * For nacl->dynamic_node_acl=1
1430 nacl = lun_acl->se_lun_nacl;
1433 return configfs_depend_item(tpg->se_tpg_tfo->tf_subsys,
1434 &lun_acl->se_lun_group.cg_item);
1437 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry *se_deve)
1439 struct se_lun_acl *lun_acl = se_deve->se_lun_acl;
1440 struct se_node_acl *nacl;
1441 struct se_portal_group *tpg;
1443 * For nacl->dynamic_node_acl=1
1446 atomic_dec(&se_deve->pr_ref_count);
1447 smp_mb__after_atomic_dec();
1450 nacl = lun_acl->se_lun_nacl;
1453 configfs_undepend_item(tpg->se_tpg_tfo->tf_subsys,
1454 &lun_acl->se_lun_group.cg_item);
1456 atomic_dec(&se_deve->pr_ref_count);
1457 smp_mb__after_atomic_dec();
1460 static int core_scsi3_decode_spec_i_port(
1462 struct se_portal_group *tpg,
1463 unsigned char *l_isid,
1468 struct se_device *dev = cmd->se_dev;
1469 struct se_port *tmp_port;
1470 struct se_portal_group *dest_tpg = NULL, *tmp_tpg;
1471 struct se_session *se_sess = cmd->se_sess;
1472 struct se_node_acl *dest_node_acl = NULL;
1473 struct se_dev_entry *dest_se_deve = NULL, *local_se_deve;
1474 struct t10_pr_registration *dest_pr_reg, *local_pr_reg, *pr_reg_e;
1475 struct t10_pr_registration *pr_reg_tmp, *pr_reg_tmp_safe;
1476 struct list_head tid_dest_list;
1477 struct pr_transport_id_holder *tidh_new, *tidh, *tidh_tmp;
1478 struct target_core_fabric_ops *tmp_tf_ops;
1480 unsigned char *ptr, *i_str = NULL, proto_ident, tmp_proto_ident;
1481 char *iport_ptr = NULL, dest_iport[64], i_buf[PR_REG_ISID_ID_LEN];
1482 u32 tpdl, tid_len = 0;
1483 int ret, dest_local_nexus, prf_isid;
1486 memset(dest_iport, 0, 64);
1487 INIT_LIST_HEAD(&tid_dest_list);
1489 local_se_deve = &se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
1491 * Allocate a struct pr_transport_id_holder and setup the
1492 * local_node_acl and local_se_deve pointers and add to
1493 * struct list_head tid_dest_list for add registration
1494 * processing in the loop of tid_dest_list below.
1496 tidh_new = kzalloc(sizeof(struct pr_transport_id_holder), GFP_KERNEL);
1498 pr_err("Unable to allocate tidh_new\n");
1499 return PYX_TRANSPORT_LU_COMM_FAILURE;
1501 INIT_LIST_HEAD(&tidh_new->dest_list);
1502 tidh_new->dest_tpg = tpg;
1503 tidh_new->dest_node_acl = se_sess->se_node_acl;
1504 tidh_new->dest_se_deve = local_se_deve;
1506 local_pr_reg = __core_scsi3_alloc_registration(cmd->se_dev,
1507 se_sess->se_node_acl, local_se_deve, l_isid,
1508 sa_res_key, all_tg_pt, aptpl);
1509 if (!local_pr_reg) {
1511 return PYX_TRANSPORT_LU_COMM_FAILURE;
1513 tidh_new->dest_pr_reg = local_pr_reg;
1515 * The local I_T nexus does not hold any configfs dependances,
1516 * so we set tid_h->dest_local_nexus=1 to prevent the
1517 * configfs_undepend_item() calls in the tid_dest_list loops below.
1519 tidh_new->dest_local_nexus = 1;
1520 list_add_tail(&tidh_new->dest_list, &tid_dest_list);
1522 buf = transport_kmap_first_data_page(cmd);
1524 * For a PERSISTENT RESERVE OUT specify initiator ports payload,
1525 * first extract TransportID Parameter Data Length, and make sure
1526 * the value matches up to the SCSI expected data transfer length.
1528 tpdl = (buf[24] & 0xff) << 24;
1529 tpdl |= (buf[25] & 0xff) << 16;
1530 tpdl |= (buf[26] & 0xff) << 8;
1531 tpdl |= buf[27] & 0xff;
1533 if ((tpdl + 28) != cmd->data_length) {
1534 pr_err("SPC-3 PR: Illegal tpdl: %u + 28 byte header"
1535 " does not equal CDB data_length: %u\n", tpdl,
1537 ret = PYX_TRANSPORT_INVALID_PARAMETER_LIST;
1541 * Start processing the received transport IDs using the
1542 * receiving I_T Nexus portal's fabric dependent methods to
1543 * obtain the SCSI Initiator Port/Device Identifiers.
1548 proto_ident = (ptr[0] & 0x0f);
1551 spin_lock(&dev->se_port_lock);
1552 list_for_each_entry(tmp_port, &dev->dev_sep_list, sep_list) {
1553 tmp_tpg = tmp_port->sep_tpg;
1556 tmp_tf_ops = tmp_tpg->se_tpg_tfo;
1559 if (!tmp_tf_ops->get_fabric_proto_ident ||
1560 !tmp_tf_ops->tpg_parse_pr_out_transport_id)
1563 * Look for the matching proto_ident provided by
1564 * the received TransportID
1566 tmp_proto_ident = tmp_tf_ops->get_fabric_proto_ident(tmp_tpg);
1567 if (tmp_proto_ident != proto_ident)
1569 dest_rtpi = tmp_port->sep_rtpi;
1571 i_str = tmp_tf_ops->tpg_parse_pr_out_transport_id(
1572 tmp_tpg, (const char *)ptr, &tid_len,
1577 atomic_inc(&tmp_tpg->tpg_pr_ref_count);
1578 smp_mb__after_atomic_inc();
1579 spin_unlock(&dev->se_port_lock);
1581 ret = core_scsi3_tpg_depend_item(tmp_tpg);
1583 pr_err(" core_scsi3_tpg_depend_item()"
1585 atomic_dec(&tmp_tpg->tpg_pr_ref_count);
1586 smp_mb__after_atomic_dec();
1587 ret = PYX_TRANSPORT_LU_COMM_FAILURE;
1591 * Locate the desination initiator ACL to be registered
1592 * from the decoded fabric module specific TransportID
1595 spin_lock_irq(&tmp_tpg->acl_node_lock);
1596 dest_node_acl = __core_tpg_get_initiator_node_acl(
1598 if (dest_node_acl) {
1599 atomic_inc(&dest_node_acl->acl_pr_ref_count);
1600 smp_mb__after_atomic_inc();
1602 spin_unlock_irq(&tmp_tpg->acl_node_lock);
1604 if (!dest_node_acl) {
1605 core_scsi3_tpg_undepend_item(tmp_tpg);
1606 spin_lock(&dev->se_port_lock);
1610 ret = core_scsi3_nodeacl_depend_item(dest_node_acl);
1612 pr_err("configfs_depend_item() failed"
1613 " for dest_node_acl->acl_group\n");
1614 atomic_dec(&dest_node_acl->acl_pr_ref_count);
1615 smp_mb__after_atomic_dec();
1616 core_scsi3_tpg_undepend_item(tmp_tpg);
1617 ret = PYX_TRANSPORT_LU_COMM_FAILURE;
1622 pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node:"
1623 " %s Port RTPI: %hu\n",
1624 dest_tpg->se_tpg_tfo->get_fabric_name(),
1625 dest_node_acl->initiatorname, dest_rtpi);
1627 spin_lock(&dev->se_port_lock);
1630 spin_unlock(&dev->se_port_lock);
1633 pr_err("SPC-3 PR SPEC_I_PT: Unable to locate"
1635 ret = PYX_TRANSPORT_INVALID_PARAMETER_LIST;
1639 pr_debug("SPC-3 PR SPEC_I_PT: Got %s data_length: %u tpdl: %u"
1640 " tid_len: %d for %s + %s\n",
1641 dest_tpg->se_tpg_tfo->get_fabric_name(), cmd->data_length,
1642 tpdl, tid_len, i_str, iport_ptr);
1644 if (tid_len > tpdl) {
1645 pr_err("SPC-3 PR SPEC_I_PT: Illegal tid_len:"
1646 " %u for Transport ID: %s\n", tid_len, ptr);
1647 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1648 core_scsi3_tpg_undepend_item(dest_tpg);
1649 ret = PYX_TRANSPORT_INVALID_PARAMETER_LIST;
1653 * Locate the desintation struct se_dev_entry pointer for matching
1654 * RELATIVE TARGET PORT IDENTIFIER on the receiving I_T Nexus
1657 dest_se_deve = core_get_se_deve_from_rtpi(dest_node_acl,
1659 if (!dest_se_deve) {
1660 pr_err("Unable to locate %s dest_se_deve"
1661 " from destination RTPI: %hu\n",
1662 dest_tpg->se_tpg_tfo->get_fabric_name(),
1665 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1666 core_scsi3_tpg_undepend_item(dest_tpg);
1667 ret = PYX_TRANSPORT_INVALID_PARAMETER_LIST;
1671 ret = core_scsi3_lunacl_depend_item(dest_se_deve);
1673 pr_err("core_scsi3_lunacl_depend_item()"
1675 atomic_dec(&dest_se_deve->pr_ref_count);
1676 smp_mb__after_atomic_dec();
1677 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1678 core_scsi3_tpg_undepend_item(dest_tpg);
1679 ret = PYX_TRANSPORT_LU_COMM_FAILURE;
1683 pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node: %s"
1684 " dest_se_deve mapped_lun: %u\n",
1685 dest_tpg->se_tpg_tfo->get_fabric_name(),
1686 dest_node_acl->initiatorname, dest_se_deve->mapped_lun);
1689 * Skip any TransportIDs that already have a registration for
1692 pr_reg_e = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
1695 core_scsi3_put_pr_reg(pr_reg_e);
1696 core_scsi3_lunacl_undepend_item(dest_se_deve);
1697 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1698 core_scsi3_tpg_undepend_item(dest_tpg);
1705 * Allocate a struct pr_transport_id_holder and setup
1706 * the dest_node_acl and dest_se_deve pointers for the
1709 tidh_new = kzalloc(sizeof(struct pr_transport_id_holder),
1712 pr_err("Unable to allocate tidh_new\n");
1713 core_scsi3_lunacl_undepend_item(dest_se_deve);
1714 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1715 core_scsi3_tpg_undepend_item(dest_tpg);
1716 ret = PYX_TRANSPORT_LU_COMM_FAILURE;
1719 INIT_LIST_HEAD(&tidh_new->dest_list);
1720 tidh_new->dest_tpg = dest_tpg;
1721 tidh_new->dest_node_acl = dest_node_acl;
1722 tidh_new->dest_se_deve = dest_se_deve;
1725 * Allocate, but do NOT add the registration for the
1726 * TransportID referenced SCSI Initiator port. This
1727 * done because of the following from spc4r17 in section
1728 * 6.14.3 wrt SPEC_I_PT:
1730 * "If a registration fails for any initiator port (e.g., if th
1731 * logical unit does not have enough resources available to
1732 * hold the registration information), no registrations shall be
1733 * made, and the command shall be terminated with
1734 * CHECK CONDITION status."
1736 * That means we call __core_scsi3_alloc_registration() here,
1737 * and then call __core_scsi3_add_registration() in the
1738 * 2nd loop which will never fail.
1740 dest_pr_reg = __core_scsi3_alloc_registration(cmd->se_dev,
1741 dest_node_acl, dest_se_deve, iport_ptr,
1742 sa_res_key, all_tg_pt, aptpl);
1744 core_scsi3_lunacl_undepend_item(dest_se_deve);
1745 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1746 core_scsi3_tpg_undepend_item(dest_tpg);
1748 ret = PYX_TRANSPORT_INVALID_PARAMETER_LIST;
1751 tidh_new->dest_pr_reg = dest_pr_reg;
1752 list_add_tail(&tidh_new->dest_list, &tid_dest_list);
1760 transport_kunmap_first_data_page(cmd);
1763 * Go ahead and create a registrations from tid_dest_list for the
1764 * SPEC_I_PT provided TransportID for the *tidh referenced dest_node_acl
1767 * The SA Reservation Key from the PROUT is set for the
1768 * registration, and ALL_TG_PT is also passed. ALL_TG_PT=1
1769 * means that the TransportID Initiator port will be
1770 * registered on all of the target ports in the SCSI target device
1771 * ALL_TG_PT=0 means the registration will only be for the
1772 * SCSI target port the PROUT REGISTER with SPEC_I_PT=1
1775 list_for_each_entry_safe(tidh, tidh_tmp, &tid_dest_list, dest_list) {
1776 dest_tpg = tidh->dest_tpg;
1777 dest_node_acl = tidh->dest_node_acl;
1778 dest_se_deve = tidh->dest_se_deve;
1779 dest_pr_reg = tidh->dest_pr_reg;
1780 dest_local_nexus = tidh->dest_local_nexus;
1782 list_del(&tidh->dest_list);
1785 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
1786 prf_isid = core_pr_dump_initiator_port(dest_pr_reg, &i_buf[0],
1787 PR_REG_ISID_ID_LEN);
1789 __core_scsi3_add_registration(cmd->se_dev, dest_node_acl,
1792 pr_debug("SPC-3 PR [%s] SPEC_I_PT: Successfully"
1793 " registered Transport ID for Node: %s%s Mapped LUN:"
1794 " %u\n", dest_tpg->se_tpg_tfo->get_fabric_name(),
1795 dest_node_acl->initiatorname, (prf_isid) ?
1796 &i_buf[0] : "", dest_se_deve->mapped_lun);
1798 if (dest_local_nexus)
1801 core_scsi3_lunacl_undepend_item(dest_se_deve);
1802 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1803 core_scsi3_tpg_undepend_item(dest_tpg);
1808 transport_kunmap_first_data_page(cmd);
1810 * For the failure case, release everything from tid_dest_list
1811 * including *dest_pr_reg and the configfs dependances..
1813 list_for_each_entry_safe(tidh, tidh_tmp, &tid_dest_list, dest_list) {
1814 dest_tpg = tidh->dest_tpg;
1815 dest_node_acl = tidh->dest_node_acl;
1816 dest_se_deve = tidh->dest_se_deve;
1817 dest_pr_reg = tidh->dest_pr_reg;
1818 dest_local_nexus = tidh->dest_local_nexus;
1820 list_del(&tidh->dest_list);
1823 * Release any extra ALL_TG_PT=1 registrations for
1824 * the SPEC_I_PT=1 case.
1826 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
1827 &dest_pr_reg->pr_reg_atp_list,
1828 pr_reg_atp_mem_list) {
1829 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
1830 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
1831 kmem_cache_free(t10_pr_reg_cache, pr_reg_tmp);
1834 kfree(dest_pr_reg->pr_aptpl_buf);
1835 kmem_cache_free(t10_pr_reg_cache, dest_pr_reg);
1837 if (dest_local_nexus)
1840 core_scsi3_lunacl_undepend_item(dest_se_deve);
1841 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1842 core_scsi3_tpg_undepend_item(dest_tpg);
1848 * Called with struct se_device->dev_reservation_lock held
1850 static int __core_scsi3_update_aptpl_buf(
1851 struct se_device *dev,
1853 u32 pr_aptpl_buf_len,
1854 int clear_aptpl_metadata)
1857 struct se_portal_group *tpg;
1858 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
1859 struct t10_pr_registration *pr_reg;
1860 unsigned char tmp[512], isid_buf[32];
1864 memset(buf, 0, pr_aptpl_buf_len);
1866 * Called to clear metadata once APTPL has been deactivated.
1868 if (clear_aptpl_metadata) {
1869 snprintf(buf, pr_aptpl_buf_len,
1870 "No Registrations or Reservations\n");
1874 * Walk the registration list..
1876 spin_lock(&su_dev->t10_pr.registration_lock);
1877 list_for_each_entry(pr_reg, &su_dev->t10_pr.registration_list,
1882 tpg = pr_reg->pr_reg_nacl->se_tpg;
1883 lun = pr_reg->pr_reg_tg_pt_lun;
1885 * Write out any ISID value to APTPL metadata that was included
1886 * in the original registration.
1888 if (pr_reg->isid_present_at_reg)
1889 snprintf(isid_buf, 32, "initiator_sid=%s\n",
1890 pr_reg->pr_reg_isid);
1892 * Include special metadata if the pr_reg matches the
1893 * reservation holder.
1895 if (dev->dev_pr_res_holder == pr_reg) {
1896 snprintf(tmp, 512, "PR_REG_START: %d"
1897 "\ninitiator_fabric=%s\n"
1898 "initiator_node=%s\n%s"
1900 "res_holder=1\nres_type=%02x\n"
1901 "res_scope=%02x\nres_all_tg_pt=%d\n"
1902 "mapped_lun=%u\n", reg_count,
1903 tpg->se_tpg_tfo->get_fabric_name(),
1904 pr_reg->pr_reg_nacl->initiatorname, isid_buf,
1905 pr_reg->pr_res_key, pr_reg->pr_res_type,
1906 pr_reg->pr_res_scope, pr_reg->pr_reg_all_tg_pt,
1907 pr_reg->pr_res_mapped_lun);
1909 snprintf(tmp, 512, "PR_REG_START: %d\n"
1910 "initiator_fabric=%s\ninitiator_node=%s\n%s"
1911 "sa_res_key=%llu\nres_holder=0\n"
1912 "res_all_tg_pt=%d\nmapped_lun=%u\n",
1913 reg_count, tpg->se_tpg_tfo->get_fabric_name(),
1914 pr_reg->pr_reg_nacl->initiatorname, isid_buf,
1915 pr_reg->pr_res_key, pr_reg->pr_reg_all_tg_pt,
1916 pr_reg->pr_res_mapped_lun);
1919 if ((len + strlen(tmp) >= pr_aptpl_buf_len)) {
1920 pr_err("Unable to update renaming"
1921 " APTPL metadata\n");
1922 spin_unlock(&su_dev->t10_pr.registration_lock);
1925 len += sprintf(buf+len, "%s", tmp);
1928 * Include information about the associated SCSI target port.
1930 snprintf(tmp, 512, "target_fabric=%s\ntarget_node=%s\n"
1931 "tpgt=%hu\nport_rtpi=%hu\ntarget_lun=%u\nPR_REG_END:"
1932 " %d\n", tpg->se_tpg_tfo->get_fabric_name(),
1933 tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1934 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1935 lun->lun_sep->sep_rtpi, lun->unpacked_lun, reg_count);
1937 if ((len + strlen(tmp) >= pr_aptpl_buf_len)) {
1938 pr_err("Unable to update renaming"
1939 " APTPL metadata\n");
1940 spin_unlock(&su_dev->t10_pr.registration_lock);
1943 len += sprintf(buf+len, "%s", tmp);
1946 spin_unlock(&su_dev->t10_pr.registration_lock);
1949 len += sprintf(buf+len, "No Registrations or Reservations");
1954 static int core_scsi3_update_aptpl_buf(
1955 struct se_device *dev,
1957 u32 pr_aptpl_buf_len,
1958 int clear_aptpl_metadata)
1962 spin_lock(&dev->dev_reservation_lock);
1963 ret = __core_scsi3_update_aptpl_buf(dev, buf, pr_aptpl_buf_len,
1964 clear_aptpl_metadata);
1965 spin_unlock(&dev->dev_reservation_lock);
1971 * Called with struct se_device->aptpl_file_mutex held
1973 static int __core_scsi3_write_aptpl_to_file(
1974 struct se_device *dev,
1976 u32 pr_aptpl_buf_len)
1978 struct t10_wwn *wwn = &dev->se_sub_dev->t10_wwn;
1980 struct iovec iov[1];
1981 mm_segment_t old_fs;
1982 int flags = O_RDWR | O_CREAT | O_TRUNC;
1986 memset(iov, 0, sizeof(struct iovec));
1987 memset(path, 0, 512);
1989 if (strlen(&wwn->unit_serial[0]) >= 512) {
1990 pr_err("WWN value for struct se_device does not fit"
1991 " into path buffer\n");
1995 snprintf(path, 512, "/var/target/pr/aptpl_%s", &wwn->unit_serial[0]);
1996 file = filp_open(path, flags, 0600);
1997 if (IS_ERR(file) || !file || !file->f_dentry) {
1998 pr_err("filp_open(%s) for APTPL metadata"
2000 return (PTR_ERR(file) < 0 ? PTR_ERR(file) : -ENOENT);
2003 iov[0].iov_base = &buf[0];
2004 if (!pr_aptpl_buf_len)
2005 iov[0].iov_len = (strlen(&buf[0]) + 1); /* Add extra for NULL */
2007 iov[0].iov_len = pr_aptpl_buf_len;
2011 ret = vfs_writev(file, &iov[0], 1, &file->f_pos);
2015 pr_debug("Error writing APTPL metadata file: %s\n", path);
2016 filp_close(file, NULL);
2019 filp_close(file, NULL);
2024 static int core_scsi3_update_and_write_aptpl(
2025 struct se_device *dev,
2026 unsigned char *in_buf,
2027 u32 in_pr_aptpl_buf_len)
2029 unsigned char null_buf[64], *buf;
2030 u32 pr_aptpl_buf_len;
2031 int ret, clear_aptpl_metadata = 0;
2033 * Can be called with a NULL pointer from PROUT service action CLEAR
2036 memset(null_buf, 0, 64);
2039 * This will clear the APTPL metadata to:
2040 * "No Registrations or Reservations" status
2042 pr_aptpl_buf_len = 64;
2043 clear_aptpl_metadata = 1;
2046 pr_aptpl_buf_len = in_pr_aptpl_buf_len;
2049 ret = core_scsi3_update_aptpl_buf(dev, buf, pr_aptpl_buf_len,
2050 clear_aptpl_metadata);
2054 * __core_scsi3_write_aptpl_to_file() will call strlen()
2055 * on the passed buf to determine pr_aptpl_buf_len.
2057 ret = __core_scsi3_write_aptpl_to_file(dev, buf, 0);
2064 static int core_scsi3_emulate_pro_register(
2073 struct se_session *se_sess = cmd->se_sess;
2074 struct se_device *dev = cmd->se_dev;
2075 struct se_dev_entry *se_deve;
2076 struct se_lun *se_lun = cmd->se_lun;
2077 struct se_portal_group *se_tpg;
2078 struct t10_pr_registration *pr_reg, *pr_reg_p, *pr_reg_tmp, *pr_reg_e;
2079 struct t10_reservation *pr_tmpl = &dev->se_sub_dev->t10_pr;
2080 /* Used for APTPL metadata w/ UNREGISTER */
2081 unsigned char *pr_aptpl_buf = NULL;
2082 unsigned char isid_buf[PR_REG_ISID_LEN], *isid_ptr = NULL;
2083 int pr_holder = 0, ret = 0, type;
2085 if (!se_sess || !se_lun) {
2086 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2087 return PYX_TRANSPORT_LU_COMM_FAILURE;
2089 se_tpg = se_sess->se_tpg;
2090 se_deve = &se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
2092 if (se_tpg->se_tpg_tfo->sess_get_initiator_sid) {
2093 memset(&isid_buf[0], 0, PR_REG_ISID_LEN);
2094 se_tpg->se_tpg_tfo->sess_get_initiator_sid(se_sess, &isid_buf[0],
2096 isid_ptr = &isid_buf[0];
2099 * Follow logic from spc4r17 Section 5.7.7, Register Behaviors Table 47
2101 pr_reg_e = core_scsi3_locate_pr_reg(dev, se_sess->se_node_acl, se_sess);
2104 pr_warn("SPC-3 PR: Reservation Key non-zero"
2105 " for SA REGISTER, returning CONFLICT\n");
2106 return PYX_TRANSPORT_RESERVATION_CONFLICT;
2109 * Do nothing but return GOOD status.
2112 return PYX_TRANSPORT_SENT_TO_TRANSPORT;
2116 * Perform the Service Action REGISTER on the Initiator
2117 * Port Endpoint that the PRO was received from on the
2118 * Logical Unit of the SCSI device server.
2120 ret = core_scsi3_alloc_registration(cmd->se_dev,
2121 se_sess->se_node_acl, se_deve, isid_ptr,
2122 sa_res_key, all_tg_pt, aptpl,
2125 pr_err("Unable to allocate"
2126 " struct t10_pr_registration\n");
2127 return PYX_TRANSPORT_INVALID_PARAMETER_LIST;
2131 * Register both the Initiator port that received
2132 * PROUT SA REGISTER + SPEC_I_PT=1 and extract SCSI
2133 * TransportID from Parameter list and loop through
2134 * fabric dependent parameter list while calling
2135 * logic from of core_scsi3_alloc_registration() for
2136 * each TransportID provided SCSI Initiator Port/Device
2138 ret = core_scsi3_decode_spec_i_port(cmd, se_tpg,
2139 isid_ptr, sa_res_key, all_tg_pt, aptpl);
2144 * Nothing left to do for the APTPL=0 case.
2147 pr_tmpl->pr_aptpl_active = 0;
2148 core_scsi3_update_and_write_aptpl(cmd->se_dev, NULL, 0);
2149 pr_debug("SPC-3 PR: Set APTPL Bit Deactivated for"
2154 * Locate the newly allocated local I_T Nexus *pr_reg, and
2155 * update the APTPL metadata information using its
2156 * preallocated *pr_reg->pr_aptpl_buf.
2158 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev,
2159 se_sess->se_node_acl, se_sess);
2161 ret = core_scsi3_update_and_write_aptpl(cmd->se_dev,
2162 &pr_reg->pr_aptpl_buf[0],
2163 pr_tmpl->pr_aptpl_buf_len);
2165 pr_tmpl->pr_aptpl_active = 1;
2166 pr_debug("SPC-3 PR: Set APTPL Bit Activated for REGISTER\n");
2169 core_scsi3_put_pr_reg(pr_reg);
2173 * Locate the existing *pr_reg via struct se_node_acl pointers
2176 type = pr_reg->pr_res_type;
2179 if (res_key != pr_reg->pr_res_key) {
2180 pr_err("SPC-3 PR REGISTER: Received"
2181 " res_key: 0x%016Lx does not match"
2182 " existing SA REGISTER res_key:"
2183 " 0x%016Lx\n", res_key,
2184 pr_reg->pr_res_key);
2185 core_scsi3_put_pr_reg(pr_reg);
2186 return PYX_TRANSPORT_RESERVATION_CONFLICT;
2190 pr_err("SPC-3 PR UNREGISTER: SPEC_I_PT"
2191 " set while sa_res_key=0\n");
2192 core_scsi3_put_pr_reg(pr_reg);
2193 return PYX_TRANSPORT_INVALID_PARAMETER_LIST;
2196 * An existing ALL_TG_PT=1 registration being released
2197 * must also set ALL_TG_PT=1 in the incoming PROUT.
2199 if (pr_reg->pr_reg_all_tg_pt && !(all_tg_pt)) {
2200 pr_err("SPC-3 PR UNREGISTER: ALL_TG_PT=1"
2201 " registration exists, but ALL_TG_PT=1 bit not"
2202 " present in received PROUT\n");
2203 core_scsi3_put_pr_reg(pr_reg);
2204 return PYX_TRANSPORT_INVALID_CDB_FIELD;
2207 * Allocate APTPL metadata buffer used for UNREGISTER ops
2210 pr_aptpl_buf = kzalloc(pr_tmpl->pr_aptpl_buf_len,
2212 if (!pr_aptpl_buf) {
2213 pr_err("Unable to allocate"
2215 core_scsi3_put_pr_reg(pr_reg);
2216 return PYX_TRANSPORT_LU_COMM_FAILURE;
2220 * sa_res_key=0 Unregister Reservation Key for registered I_T
2221 * Nexus sa_res_key=1 Change Reservation Key for registered I_T
2225 pr_holder = core_scsi3_check_implict_release(
2226 cmd->se_dev, pr_reg);
2227 if (pr_holder < 0) {
2228 kfree(pr_aptpl_buf);
2229 core_scsi3_put_pr_reg(pr_reg);
2230 return PYX_TRANSPORT_RESERVATION_CONFLICT;
2233 spin_lock(&pr_tmpl->registration_lock);
2235 * Release all ALL_TG_PT=1 for the matching SCSI Initiator Port
2236 * and matching pr_res_key.
2238 if (pr_reg->pr_reg_all_tg_pt) {
2239 list_for_each_entry_safe(pr_reg_p, pr_reg_tmp,
2240 &pr_tmpl->registration_list,
2243 if (!pr_reg_p->pr_reg_all_tg_pt)
2246 if (pr_reg_p->pr_res_key != res_key)
2249 if (pr_reg == pr_reg_p)
2252 if (strcmp(pr_reg->pr_reg_nacl->initiatorname,
2253 pr_reg_p->pr_reg_nacl->initiatorname))
2256 __core_scsi3_free_registration(dev,
2261 * Release the calling I_T Nexus registration now..
2263 __core_scsi3_free_registration(cmd->se_dev, pr_reg,
2266 * From spc4r17, section 5.7.11.3 Unregistering
2268 * If the persistent reservation is a registrants only
2269 * type, the device server shall establish a unit
2270 * attention condition for the initiator port associated
2271 * with every registered I_T nexus except for the I_T
2272 * nexus on which the PERSISTENT RESERVE OUT command was
2273 * received, with the additional sense code set to
2274 * RESERVATIONS RELEASED.
2277 ((type == PR_TYPE_WRITE_EXCLUSIVE_REGONLY) ||
2278 (type == PR_TYPE_EXCLUSIVE_ACCESS_REGONLY))) {
2279 list_for_each_entry(pr_reg_p,
2280 &pr_tmpl->registration_list,
2283 core_scsi3_ua_allocate(
2284 pr_reg_p->pr_reg_nacl,
2285 pr_reg_p->pr_res_mapped_lun,
2287 ASCQ_2AH_RESERVATIONS_RELEASED);
2290 spin_unlock(&pr_tmpl->registration_lock);
2293 pr_tmpl->pr_aptpl_active = 0;
2294 core_scsi3_update_and_write_aptpl(dev, NULL, 0);
2295 pr_debug("SPC-3 PR: Set APTPL Bit Deactivated"
2296 " for UNREGISTER\n");
2300 ret = core_scsi3_update_and_write_aptpl(dev,
2302 pr_tmpl->pr_aptpl_buf_len);
2304 pr_tmpl->pr_aptpl_active = 1;
2305 pr_debug("SPC-3 PR: Set APTPL Bit Activated"
2306 " for UNREGISTER\n");
2309 kfree(pr_aptpl_buf);
2313 * Increment PRgeneration counter for struct se_device"
2314 * upon a successful REGISTER, see spc4r17 section 6.3.2
2315 * READ_KEYS service action.
2317 pr_reg->pr_res_generation = core_scsi3_pr_generation(
2319 pr_reg->pr_res_key = sa_res_key;
2320 pr_debug("SPC-3 PR [%s] REGISTER%s: Changed Reservation"
2321 " Key for %s to: 0x%016Lx PRgeneration:"
2322 " 0x%08x\n", cmd->se_tfo->get_fabric_name(),
2323 (ignore_key) ? "_AND_IGNORE_EXISTING_KEY" : "",
2324 pr_reg->pr_reg_nacl->initiatorname,
2325 pr_reg->pr_res_key, pr_reg->pr_res_generation);
2328 pr_tmpl->pr_aptpl_active = 0;
2329 core_scsi3_update_and_write_aptpl(dev, NULL, 0);
2330 core_scsi3_put_pr_reg(pr_reg);
2331 pr_debug("SPC-3 PR: Set APTPL Bit Deactivated"
2336 ret = core_scsi3_update_and_write_aptpl(dev,
2338 pr_tmpl->pr_aptpl_buf_len);
2340 pr_tmpl->pr_aptpl_active = 1;
2341 pr_debug("SPC-3 PR: Set APTPL Bit Activated"
2345 kfree(pr_aptpl_buf);
2346 core_scsi3_put_pr_reg(pr_reg);
2352 unsigned char *core_scsi3_pr_dump_type(int type)
2355 case PR_TYPE_WRITE_EXCLUSIVE:
2356 return "Write Exclusive Access";
2357 case PR_TYPE_EXCLUSIVE_ACCESS:
2358 return "Exclusive Access";
2359 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
2360 return "Write Exclusive Access, Registrants Only";
2361 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
2362 return "Exclusive Access, Registrants Only";
2363 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
2364 return "Write Exclusive Access, All Registrants";
2365 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
2366 return "Exclusive Access, All Registrants";
2371 return "Unknown SPC-3 PR Type";
2374 static int core_scsi3_pro_reserve(
2376 struct se_device *dev,
2381 struct se_session *se_sess = cmd->se_sess;
2382 struct se_dev_entry *se_deve;
2383 struct se_lun *se_lun = cmd->se_lun;
2384 struct se_portal_group *se_tpg;
2385 struct t10_pr_registration *pr_reg, *pr_res_holder;
2386 struct t10_reservation *pr_tmpl = &dev->se_sub_dev->t10_pr;
2387 char i_buf[PR_REG_ISID_ID_LEN];
2390 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2392 if (!se_sess || !se_lun) {
2393 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2394 return PYX_TRANSPORT_LU_COMM_FAILURE;
2396 se_tpg = se_sess->se_tpg;
2397 se_deve = &se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
2399 * Locate the existing *pr_reg via struct se_node_acl pointers
2401 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
2404 pr_err("SPC-3 PR: Unable to locate"
2405 " PR_REGISTERED *pr_reg for RESERVE\n");
2406 return PYX_TRANSPORT_LU_COMM_FAILURE;
2409 * From spc4r17 Section 5.7.9: Reserving:
2411 * An application client creates a persistent reservation by issuing
2412 * a PERSISTENT RESERVE OUT command with RESERVE service action through
2413 * a registered I_T nexus with the following parameters:
2414 * a) RESERVATION KEY set to the value of the reservation key that is
2415 * registered with the logical unit for the I_T nexus; and
2417 if (res_key != pr_reg->pr_res_key) {
2418 pr_err("SPC-3 PR RESERVE: Received res_key: 0x%016Lx"
2419 " does not match existing SA REGISTER res_key:"
2420 " 0x%016Lx\n", res_key, pr_reg->pr_res_key);
2421 core_scsi3_put_pr_reg(pr_reg);
2422 return PYX_TRANSPORT_RESERVATION_CONFLICT;
2425 * From spc4r17 Section 5.7.9: Reserving:
2428 * b) TYPE field and SCOPE field set to the persistent reservation
2431 * Only one persistent reservation is allowed at a time per logical unit
2432 * and that persistent reservation has a scope of LU_SCOPE.
2434 if (scope != PR_SCOPE_LU_SCOPE) {
2435 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope);
2436 core_scsi3_put_pr_reg(pr_reg);
2437 return PYX_TRANSPORT_INVALID_PARAMETER_LIST;
2440 * See if we have an existing PR reservation holder pointer at
2441 * struct se_device->dev_pr_res_holder in the form struct t10_pr_registration
2444 spin_lock(&dev->dev_reservation_lock);
2445 pr_res_holder = dev->dev_pr_res_holder;
2446 if ((pr_res_holder)) {
2448 * From spc4r17 Section 5.7.9: Reserving:
2450 * If the device server receives a PERSISTENT RESERVE OUT
2451 * command from an I_T nexus other than a persistent reservation
2452 * holder (see 5.7.10) that attempts to create a persistent
2453 * reservation when a persistent reservation already exists for
2454 * the logical unit, then the command shall be completed with
2455 * RESERVATION CONFLICT status.
2457 if (pr_res_holder != pr_reg) {
2458 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2459 pr_err("SPC-3 PR: Attempted RESERVE from"
2460 " [%s]: %s while reservation already held by"
2461 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2462 cmd->se_tfo->get_fabric_name(),
2463 se_sess->se_node_acl->initiatorname,
2464 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2465 pr_res_holder->pr_reg_nacl->initiatorname);
2467 spin_unlock(&dev->dev_reservation_lock);
2468 core_scsi3_put_pr_reg(pr_reg);
2469 return PYX_TRANSPORT_RESERVATION_CONFLICT;
2472 * From spc4r17 Section 5.7.9: Reserving:
2474 * If a persistent reservation holder attempts to modify the
2475 * type or scope of an existing persistent reservation, the
2476 * command shall be completed with RESERVATION CONFLICT status.
2478 if ((pr_res_holder->pr_res_type != type) ||
2479 (pr_res_holder->pr_res_scope != scope)) {
2480 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2481 pr_err("SPC-3 PR: Attempted RESERVE from"
2482 " [%s]: %s trying to change TYPE and/or SCOPE,"
2483 " while reservation already held by [%s]: %s,"
2484 " returning RESERVATION_CONFLICT\n",
2485 cmd->se_tfo->get_fabric_name(),
2486 se_sess->se_node_acl->initiatorname,
2487 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2488 pr_res_holder->pr_reg_nacl->initiatorname);
2490 spin_unlock(&dev->dev_reservation_lock);
2491 core_scsi3_put_pr_reg(pr_reg);
2492 return PYX_TRANSPORT_RESERVATION_CONFLICT;
2495 * From spc4r17 Section 5.7.9: Reserving:
2497 * If the device server receives a PERSISTENT RESERVE OUT
2498 * command with RESERVE service action where the TYPE field and
2499 * the SCOPE field contain the same values as the existing type
2500 * and scope from a persistent reservation holder, it shall not
2501 * make any change to the existing persistent reservation and
2502 * shall completethe command with GOOD status.
2504 spin_unlock(&dev->dev_reservation_lock);
2505 core_scsi3_put_pr_reg(pr_reg);
2506 return PYX_TRANSPORT_SENT_TO_TRANSPORT;
2509 * Otherwise, our *pr_reg becomes the PR reservation holder for said
2510 * TYPE/SCOPE. Also set the received scope and type in *pr_reg.
2512 pr_reg->pr_res_scope = scope;
2513 pr_reg->pr_res_type = type;
2514 pr_reg->pr_res_holder = 1;
2515 dev->dev_pr_res_holder = pr_reg;
2516 prf_isid = core_pr_dump_initiator_port(pr_reg, &i_buf[0],
2517 PR_REG_ISID_ID_LEN);
2519 pr_debug("SPC-3 PR [%s] Service Action: RESERVE created new"
2520 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2521 cmd->se_tfo->get_fabric_name(), core_scsi3_pr_dump_type(type),
2522 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2523 pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
2524 cmd->se_tfo->get_fabric_name(),
2525 se_sess->se_node_acl->initiatorname,
2526 (prf_isid) ? &i_buf[0] : "");
2527 spin_unlock(&dev->dev_reservation_lock);
2529 if (pr_tmpl->pr_aptpl_active) {
2530 ret = core_scsi3_update_and_write_aptpl(cmd->se_dev,
2531 &pr_reg->pr_aptpl_buf[0],
2532 pr_tmpl->pr_aptpl_buf_len);
2534 pr_debug("SPC-3 PR: Updated APTPL metadata"
2538 core_scsi3_put_pr_reg(pr_reg);
2542 static int core_scsi3_emulate_pro_reserve(
2548 struct se_device *dev = cmd->se_dev;
2552 case PR_TYPE_WRITE_EXCLUSIVE:
2553 case PR_TYPE_EXCLUSIVE_ACCESS:
2554 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
2555 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
2556 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
2557 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
2558 ret = core_scsi3_pro_reserve(cmd, dev, type, scope, res_key);
2561 pr_err("SPC-3 PR: Unknown Service Action RESERVE Type:"
2563 return PYX_TRANSPORT_INVALID_CDB_FIELD;
2570 * Called with struct se_device->dev_reservation_lock held.
2572 static void __core_scsi3_complete_pro_release(
2573 struct se_device *dev,
2574 struct se_node_acl *se_nacl,
2575 struct t10_pr_registration *pr_reg,
2578 struct target_core_fabric_ops *tfo = se_nacl->se_tpg->se_tpg_tfo;
2579 char i_buf[PR_REG_ISID_ID_LEN];
2582 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2583 prf_isid = core_pr_dump_initiator_port(pr_reg, &i_buf[0],
2584 PR_REG_ISID_ID_LEN);
2586 * Go ahead and release the current PR reservation holder.
2588 dev->dev_pr_res_holder = NULL;
2590 pr_debug("SPC-3 PR [%s] Service Action: %s RELEASE cleared"
2591 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2592 tfo->get_fabric_name(), (explict) ? "explict" : "implict",
2593 core_scsi3_pr_dump_type(pr_reg->pr_res_type),
2594 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2595 pr_debug("SPC-3 PR [%s] RELEASE Node: %s%s\n",
2596 tfo->get_fabric_name(), se_nacl->initiatorname,
2597 (prf_isid) ? &i_buf[0] : "");
2599 * Clear TYPE and SCOPE for the next PROUT Service Action: RESERVE
2601 pr_reg->pr_res_holder = pr_reg->pr_res_type = pr_reg->pr_res_scope = 0;
2604 static int core_scsi3_emulate_pro_release(
2610 struct se_device *dev = cmd->se_dev;
2611 struct se_session *se_sess = cmd->se_sess;
2612 struct se_lun *se_lun = cmd->se_lun;
2613 struct t10_pr_registration *pr_reg, *pr_reg_p, *pr_res_holder;
2614 struct t10_reservation *pr_tmpl = &dev->se_sub_dev->t10_pr;
2615 int ret, all_reg = 0;
2617 if (!se_sess || !se_lun) {
2618 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2619 return PYX_TRANSPORT_LU_COMM_FAILURE;
2622 * Locate the existing *pr_reg via struct se_node_acl pointers
2624 pr_reg = core_scsi3_locate_pr_reg(dev, se_sess->se_node_acl, se_sess);
2626 pr_err("SPC-3 PR: Unable to locate"
2627 " PR_REGISTERED *pr_reg for RELEASE\n");
2628 return PYX_TRANSPORT_LU_COMM_FAILURE;
2631 * From spc4r17 Section 5.7.11.2 Releasing:
2633 * If there is no persistent reservation or in response to a persistent
2634 * reservation release request from a registered I_T nexus that is not a
2635 * persistent reservation holder (see 5.7.10), the device server shall
2638 * a) Not release the persistent reservation, if any;
2639 * b) Not remove any registrations; and
2640 * c) Complete the command with GOOD status.
2642 spin_lock(&dev->dev_reservation_lock);
2643 pr_res_holder = dev->dev_pr_res_holder;
2644 if (!pr_res_holder) {
2646 * No persistent reservation, return GOOD status.
2648 spin_unlock(&dev->dev_reservation_lock);
2649 core_scsi3_put_pr_reg(pr_reg);
2650 return PYX_TRANSPORT_SENT_TO_TRANSPORT;
2652 if ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2653 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))
2656 if ((all_reg == 0) && (pr_res_holder != pr_reg)) {
2658 * Non 'All Registrants' PR Type cases..
2659 * Release request from a registered I_T nexus that is not a
2660 * persistent reservation holder. return GOOD status.
2662 spin_unlock(&dev->dev_reservation_lock);
2663 core_scsi3_put_pr_reg(pr_reg);
2664 return PYX_TRANSPORT_SENT_TO_TRANSPORT;
2667 * From spc4r17 Section 5.7.11.2 Releasing:
2669 * Only the persistent reservation holder (see 5.7.10) is allowed to
2670 * release a persistent reservation.
2672 * An application client releases the persistent reservation by issuing
2673 * a PERSISTENT RESERVE OUT command with RELEASE service action through
2674 * an I_T nexus that is a persistent reservation holder with the
2675 * following parameters:
2677 * a) RESERVATION KEY field set to the value of the reservation key
2678 * that is registered with the logical unit for the I_T nexus;
2680 if (res_key != pr_reg->pr_res_key) {
2681 pr_err("SPC-3 PR RELEASE: Received res_key: 0x%016Lx"
2682 " does not match existing SA REGISTER res_key:"
2683 " 0x%016Lx\n", res_key, pr_reg->pr_res_key);
2684 spin_unlock(&dev->dev_reservation_lock);
2685 core_scsi3_put_pr_reg(pr_reg);
2686 return PYX_TRANSPORT_RESERVATION_CONFLICT;
2689 * From spc4r17 Section 5.7.11.2 Releasing and above:
2691 * b) TYPE field and SCOPE field set to match the persistent
2692 * reservation being released.
2694 if ((pr_res_holder->pr_res_type != type) ||
2695 (pr_res_holder->pr_res_scope != scope)) {
2696 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2697 pr_err("SPC-3 PR RELEASE: Attempted to release"
2698 " reservation from [%s]: %s with different TYPE "
2699 "and/or SCOPE while reservation already held by"
2700 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2701 cmd->se_tfo->get_fabric_name(),
2702 se_sess->se_node_acl->initiatorname,
2703 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2704 pr_res_holder->pr_reg_nacl->initiatorname);
2706 spin_unlock(&dev->dev_reservation_lock);
2707 core_scsi3_put_pr_reg(pr_reg);
2708 return PYX_TRANSPORT_RESERVATION_CONFLICT;
2711 * In response to a persistent reservation release request from the
2712 * persistent reservation holder the device server shall perform a
2713 * release by doing the following as an uninterrupted series of actions:
2714 * a) Release the persistent reservation;
2715 * b) Not remove any registration(s);
2716 * c) If the released persistent reservation is a registrants only type
2717 * or all registrants type persistent reservation,
2718 * the device server shall establish a unit attention condition for
2719 * the initiator port associated with every regis-
2720 * tered I_T nexus other than I_T nexus on which the PERSISTENT
2721 * RESERVE OUT command with RELEASE service action was received,
2722 * with the additional sense code set to RESERVATIONS RELEASED; and
2723 * d) If the persistent reservation is of any other type, the device
2724 * server shall not establish a unit attention condition.
2726 __core_scsi3_complete_pro_release(dev, se_sess->se_node_acl,
2729 spin_unlock(&dev->dev_reservation_lock);
2731 if ((type != PR_TYPE_WRITE_EXCLUSIVE_REGONLY) &&
2732 (type != PR_TYPE_EXCLUSIVE_ACCESS_REGONLY) &&
2733 (type != PR_TYPE_WRITE_EXCLUSIVE_ALLREG) &&
2734 (type != PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
2736 * If no UNIT ATTENTION conditions will be established for
2737 * PR_TYPE_WRITE_EXCLUSIVE or PR_TYPE_EXCLUSIVE_ACCESS
2738 * go ahead and check for APTPL=1 update+write below
2743 spin_lock(&pr_tmpl->registration_lock);
2744 list_for_each_entry(pr_reg_p, &pr_tmpl->registration_list,
2747 * Do not establish a UNIT ATTENTION condition
2748 * for the calling I_T Nexus
2750 if (pr_reg_p == pr_reg)
2753 core_scsi3_ua_allocate(pr_reg_p->pr_reg_nacl,
2754 pr_reg_p->pr_res_mapped_lun,
2755 0x2A, ASCQ_2AH_RESERVATIONS_RELEASED);
2757 spin_unlock(&pr_tmpl->registration_lock);
2760 if (pr_tmpl->pr_aptpl_active) {
2761 ret = core_scsi3_update_and_write_aptpl(cmd->se_dev,
2762 &pr_reg->pr_aptpl_buf[0],
2763 pr_tmpl->pr_aptpl_buf_len);
2765 pr_debug("SPC-3 PR: Updated APTPL metadata for RELEASE\n");
2768 core_scsi3_put_pr_reg(pr_reg);
2772 static int core_scsi3_emulate_pro_clear(
2776 struct se_device *dev = cmd->se_dev;
2777 struct se_node_acl *pr_reg_nacl;
2778 struct se_session *se_sess = cmd->se_sess;
2779 struct t10_reservation *pr_tmpl = &dev->se_sub_dev->t10_pr;
2780 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_reg_n, *pr_res_holder;
2781 u32 pr_res_mapped_lun = 0;
2782 int calling_it_nexus = 0;
2784 * Locate the existing *pr_reg via struct se_node_acl pointers
2786 pr_reg_n = core_scsi3_locate_pr_reg(cmd->se_dev,
2787 se_sess->se_node_acl, se_sess);
2789 pr_err("SPC-3 PR: Unable to locate"
2790 " PR_REGISTERED *pr_reg for CLEAR\n");
2791 return PYX_TRANSPORT_LU_COMM_FAILURE;
2794 * From spc4r17 section 5.7.11.6, Clearing:
2796 * Any application client may release the persistent reservation and
2797 * remove all registrations from a device server by issuing a
2798 * PERSISTENT RESERVE OUT command with CLEAR service action through a
2799 * registered I_T nexus with the following parameter:
2801 * a) RESERVATION KEY field set to the value of the reservation key
2802 * that is registered with the logical unit for the I_T nexus.
2804 if (res_key != pr_reg_n->pr_res_key) {
2805 pr_err("SPC-3 PR REGISTER: Received"
2806 " res_key: 0x%016Lx does not match"
2807 " existing SA REGISTER res_key:"
2808 " 0x%016Lx\n", res_key, pr_reg_n->pr_res_key);
2809 core_scsi3_put_pr_reg(pr_reg_n);
2810 return PYX_TRANSPORT_RESERVATION_CONFLICT;
2813 * a) Release the persistent reservation, if any;
2815 spin_lock(&dev->dev_reservation_lock);
2816 pr_res_holder = dev->dev_pr_res_holder;
2817 if (pr_res_holder) {
2818 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2819 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
2822 spin_unlock(&dev->dev_reservation_lock);
2824 * b) Remove all registration(s) (see spc4r17 5.7.7);
2826 spin_lock(&pr_tmpl->registration_lock);
2827 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2828 &pr_tmpl->registration_list, pr_reg_list) {
2830 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2831 pr_reg_nacl = pr_reg->pr_reg_nacl;
2832 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2833 __core_scsi3_free_registration(dev, pr_reg, NULL,
2836 * e) Establish a unit attention condition for the initiator
2837 * port associated with every registered I_T nexus other
2838 * than the I_T nexus on which the PERSISTENT RESERVE OUT
2839 * command with CLEAR service action was received, with the
2840 * additional sense code set to RESERVATIONS PREEMPTED.
2842 if (!calling_it_nexus)
2843 core_scsi3_ua_allocate(pr_reg_nacl, pr_res_mapped_lun,
2844 0x2A, ASCQ_2AH_RESERVATIONS_PREEMPTED);
2846 spin_unlock(&pr_tmpl->registration_lock);
2848 pr_debug("SPC-3 PR [%s] Service Action: CLEAR complete\n",
2849 cmd->se_tfo->get_fabric_name());
2851 if (pr_tmpl->pr_aptpl_active) {
2852 core_scsi3_update_and_write_aptpl(cmd->se_dev, NULL, 0);
2853 pr_debug("SPC-3 PR: Updated APTPL metadata"
2857 core_scsi3_pr_generation(dev);
2862 * Called with struct se_device->dev_reservation_lock held.
2864 static void __core_scsi3_complete_pro_preempt(
2865 struct se_device *dev,
2866 struct t10_pr_registration *pr_reg,
2867 struct list_head *preempt_and_abort_list,
2872 struct se_node_acl *nacl = pr_reg->pr_reg_nacl;
2873 struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
2874 char i_buf[PR_REG_ISID_ID_LEN];
2877 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2878 prf_isid = core_pr_dump_initiator_port(pr_reg, &i_buf[0],
2879 PR_REG_ISID_ID_LEN);
2881 * Do an implict RELEASE of the existing reservation.
2883 if (dev->dev_pr_res_holder)
2884 __core_scsi3_complete_pro_release(dev, nacl,
2885 dev->dev_pr_res_holder, 0);
2887 dev->dev_pr_res_holder = pr_reg;
2888 pr_reg->pr_res_holder = 1;
2889 pr_reg->pr_res_type = type;
2890 pr_reg->pr_res_scope = scope;
2892 pr_debug("SPC-3 PR [%s] Service Action: PREEMPT%s created new"
2893 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2894 tfo->get_fabric_name(), (abort) ? "_AND_ABORT" : "",
2895 core_scsi3_pr_dump_type(type),
2896 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2897 pr_debug("SPC-3 PR [%s] PREEMPT%s from Node: %s%s\n",
2898 tfo->get_fabric_name(), (abort) ? "_AND_ABORT" : "",
2899 nacl->initiatorname, (prf_isid) ? &i_buf[0] : "");
2901 * For PREEMPT_AND_ABORT, add the preempting reservation's
2902 * struct t10_pr_registration to the list that will be compared
2903 * against received CDBs..
2905 if (preempt_and_abort_list)
2906 list_add_tail(&pr_reg->pr_reg_abort_list,
2907 preempt_and_abort_list);
2910 static void core_scsi3_release_preempt_and_abort(
2911 struct list_head *preempt_and_abort_list,
2912 struct t10_pr_registration *pr_reg_holder)
2914 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
2916 list_for_each_entry_safe(pr_reg, pr_reg_tmp, preempt_and_abort_list,
2917 pr_reg_abort_list) {
2919 list_del(&pr_reg->pr_reg_abort_list);
2920 if (pr_reg_holder == pr_reg)
2922 if (pr_reg->pr_res_holder) {
2923 pr_warn("pr_reg->pr_res_holder still set\n");
2927 pr_reg->pr_reg_deve = NULL;
2928 pr_reg->pr_reg_nacl = NULL;
2929 kfree(pr_reg->pr_aptpl_buf);
2930 kmem_cache_free(t10_pr_reg_cache, pr_reg);
2934 int core_scsi3_check_cdb_abort_and_preempt(
2935 struct list_head *preempt_and_abort_list,
2938 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
2940 list_for_each_entry_safe(pr_reg, pr_reg_tmp, preempt_and_abort_list,
2941 pr_reg_abort_list) {
2942 if (pr_reg->pr_res_key == cmd->pr_res_key)
2949 static int core_scsi3_pro_preempt(
2957 struct se_device *dev = cmd->se_dev;
2958 struct se_dev_entry *se_deve;
2959 struct se_node_acl *pr_reg_nacl;
2960 struct se_session *se_sess = cmd->se_sess;
2961 struct list_head preempt_and_abort_list;
2962 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_reg_n, *pr_res_holder;
2963 struct t10_reservation *pr_tmpl = &dev->se_sub_dev->t10_pr;
2964 u32 pr_res_mapped_lun = 0;
2965 int all_reg = 0, calling_it_nexus = 0, released_regs = 0;
2966 int prh_type = 0, prh_scope = 0, ret;
2969 return PYX_TRANSPORT_LU_COMM_FAILURE;
2971 se_deve = &se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
2972 pr_reg_n = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
2975 pr_err("SPC-3 PR: Unable to locate"
2976 " PR_REGISTERED *pr_reg for PREEMPT%s\n",
2977 (abort) ? "_AND_ABORT" : "");
2978 return PYX_TRANSPORT_RESERVATION_CONFLICT;
2980 if (pr_reg_n->pr_res_key != res_key) {
2981 core_scsi3_put_pr_reg(pr_reg_n);
2982 return PYX_TRANSPORT_RESERVATION_CONFLICT;
2984 if (scope != PR_SCOPE_LU_SCOPE) {
2985 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope);
2986 core_scsi3_put_pr_reg(pr_reg_n);
2987 return PYX_TRANSPORT_INVALID_PARAMETER_LIST;
2989 INIT_LIST_HEAD(&preempt_and_abort_list);
2991 spin_lock(&dev->dev_reservation_lock);
2992 pr_res_holder = dev->dev_pr_res_holder;
2993 if (pr_res_holder &&
2994 ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2995 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)))
2998 if (!all_reg && !sa_res_key) {
2999 spin_unlock(&dev->dev_reservation_lock);
3000 core_scsi3_put_pr_reg(pr_reg_n);
3001 return PYX_TRANSPORT_INVALID_PARAMETER_LIST;
3004 * From spc4r17, section 5.7.11.4.4 Removing Registrations:
3006 * If the SERVICE ACTION RESERVATION KEY field does not identify a
3007 * persistent reservation holder or there is no persistent reservation
3008 * holder (i.e., there is no persistent reservation), then the device
3009 * server shall perform a preempt by doing the following in an
3010 * uninterrupted series of actions. (See below..)
3012 if (!pr_res_holder || (pr_res_holder->pr_res_key != sa_res_key)) {
3014 * No existing or SA Reservation Key matching reservations..
3016 * PROUT SA PREEMPT with All Registrant type reservations are
3017 * allowed to be processed without a matching SA Reservation Key
3019 spin_lock(&pr_tmpl->registration_lock);
3020 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3021 &pr_tmpl->registration_list, pr_reg_list) {
3023 * Removing of registrations in non all registrants
3024 * type reservations without a matching SA reservation
3027 * a) Remove the registrations for all I_T nexuses
3028 * specified by the SERVICE ACTION RESERVATION KEY
3030 * b) Ignore the contents of the SCOPE and TYPE fields;
3031 * c) Process tasks as defined in 5.7.1; and
3032 * d) Establish a unit attention condition for the
3033 * initiator port associated with every I_T nexus
3034 * that lost its registration other than the I_T
3035 * nexus on which the PERSISTENT RESERVE OUT command
3036 * was received, with the additional sense code set
3037 * to REGISTRATIONS PREEMPTED.
3040 if (pr_reg->pr_res_key != sa_res_key)
3043 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
3044 pr_reg_nacl = pr_reg->pr_reg_nacl;
3045 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
3046 __core_scsi3_free_registration(dev, pr_reg,
3047 (abort) ? &preempt_and_abort_list :
3048 NULL, calling_it_nexus);
3052 * Case for any existing all registrants type
3053 * reservation, follow logic in spc4r17 section
3054 * 5.7.11.4 Preempting, Table 52 and Figure 7.
3056 * For a ZERO SA Reservation key, release
3057 * all other registrations and do an implict
3058 * release of active persistent reservation.
3060 * For a non-ZERO SA Reservation key, only
3061 * release the matching reservation key from
3065 (pr_reg->pr_res_key != sa_res_key))
3068 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
3069 if (calling_it_nexus)
3072 pr_reg_nacl = pr_reg->pr_reg_nacl;
3073 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
3074 __core_scsi3_free_registration(dev, pr_reg,
3075 (abort) ? &preempt_and_abort_list :
3079 if (!calling_it_nexus)
3080 core_scsi3_ua_allocate(pr_reg_nacl,
3081 pr_res_mapped_lun, 0x2A,
3082 ASCQ_2AH_RESERVATIONS_PREEMPTED);
3084 spin_unlock(&pr_tmpl->registration_lock);
3086 * If a PERSISTENT RESERVE OUT with a PREEMPT service action or
3087 * a PREEMPT AND ABORT service action sets the SERVICE ACTION
3088 * RESERVATION KEY field to a value that does not match any
3089 * registered reservation key, then the device server shall
3090 * complete the command with RESERVATION CONFLICT status.
3092 if (!released_regs) {
3093 spin_unlock(&dev->dev_reservation_lock);
3094 core_scsi3_put_pr_reg(pr_reg_n);
3095 return PYX_TRANSPORT_RESERVATION_CONFLICT;
3098 * For an existing all registrants type reservation
3099 * with a zero SA rservation key, preempt the existing
3100 * reservation with the new PR type and scope.
3102 if (pr_res_holder && all_reg && !(sa_res_key)) {
3103 __core_scsi3_complete_pro_preempt(dev, pr_reg_n,
3104 (abort) ? &preempt_and_abort_list : NULL,
3105 type, scope, abort);
3108 core_scsi3_release_preempt_and_abort(
3109 &preempt_and_abort_list, pr_reg_n);
3111 spin_unlock(&dev->dev_reservation_lock);
3113 if (pr_tmpl->pr_aptpl_active) {
3114 ret = core_scsi3_update_and_write_aptpl(cmd->se_dev,
3115 &pr_reg_n->pr_aptpl_buf[0],
3116 pr_tmpl->pr_aptpl_buf_len);
3118 pr_debug("SPC-3 PR: Updated APTPL"
3119 " metadata for PREEMPT%s\n", (abort) ?
3123 core_scsi3_put_pr_reg(pr_reg_n);
3124 core_scsi3_pr_generation(cmd->se_dev);
3128 * The PREEMPTing SA reservation key matches that of the
3129 * existing persistent reservation, first, we check if
3130 * we are preempting our own reservation.
3131 * From spc4r17, section 5.7.11.4.3 Preempting
3132 * persistent reservations and registration handling
3134 * If an all registrants persistent reservation is not
3135 * present, it is not an error for the persistent
3136 * reservation holder to preempt itself (i.e., a
3137 * PERSISTENT RESERVE OUT with a PREEMPT service action
3138 * or a PREEMPT AND ABORT service action with the
3139 * SERVICE ACTION RESERVATION KEY value equal to the
3140 * persistent reservation holder's reservation key that
3141 * is received from the persistent reservation holder).
3142 * In that case, the device server shall establish the
3143 * new persistent reservation and maintain the
3146 prh_type = pr_res_holder->pr_res_type;
3147 prh_scope = pr_res_holder->pr_res_scope;
3149 * If the SERVICE ACTION RESERVATION KEY field identifies a
3150 * persistent reservation holder (see 5.7.10), the device
3151 * server shall perform a preempt by doing the following as
3152 * an uninterrupted series of actions:
3154 * a) Release the persistent reservation for the holder
3155 * identified by the SERVICE ACTION RESERVATION KEY field;
3157 if (pr_reg_n != pr_res_holder)
3158 __core_scsi3_complete_pro_release(dev,
3159 pr_res_holder->pr_reg_nacl,
3160 dev->dev_pr_res_holder, 0);
3162 * b) Remove the registrations for all I_T nexuses identified
3163 * by the SERVICE ACTION RESERVATION KEY field, except the
3164 * I_T nexus that is being used for the PERSISTENT RESERVE
3165 * OUT command. If an all registrants persistent reservation
3166 * is present and the SERVICE ACTION RESERVATION KEY field
3167 * is set to zero, then all registrations shall be removed
3168 * except for that of the I_T nexus that is being used for
3169 * the PERSISTENT RESERVE OUT command;
3171 spin_lock(&pr_tmpl->registration_lock);
3172 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3173 &pr_tmpl->registration_list, pr_reg_list) {
3175 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
3176 if (calling_it_nexus)
3179 if (pr_reg->pr_res_key != sa_res_key)
3182 pr_reg_nacl = pr_reg->pr_reg_nacl;
3183 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
3184 __core_scsi3_free_registration(dev, pr_reg,
3185 (abort) ? &preempt_and_abort_list : NULL,
3188 * e) Establish a unit attention condition for the initiator
3189 * port associated with every I_T nexus that lost its
3190 * persistent reservation and/or registration, with the
3191 * additional sense code set to REGISTRATIONS PREEMPTED;
3193 core_scsi3_ua_allocate(pr_reg_nacl, pr_res_mapped_lun, 0x2A,
3194 ASCQ_2AH_RESERVATIONS_PREEMPTED);
3196 spin_unlock(&pr_tmpl->registration_lock);
3198 * c) Establish a persistent reservation for the preempting
3199 * I_T nexus using the contents of the SCOPE and TYPE fields;
3201 __core_scsi3_complete_pro_preempt(dev, pr_reg_n,
3202 (abort) ? &preempt_and_abort_list : NULL,
3203 type, scope, abort);
3205 * d) Process tasks as defined in 5.7.1;
3207 * f) If the type or scope has changed, then for every I_T nexus
3208 * whose reservation key was not removed, except for the I_T
3209 * nexus on which the PERSISTENT RESERVE OUT command was
3210 * received, the device server shall establish a unit
3211 * attention condition for the initiator port associated with
3212 * that I_T nexus, with the additional sense code set to
3213 * RESERVATIONS RELEASED. If the type or scope have not
3214 * changed, then no unit attention condition(s) shall be
3215 * established for this reason.
3217 if ((prh_type != type) || (prh_scope != scope)) {
3218 spin_lock(&pr_tmpl->registration_lock);
3219 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3220 &pr_tmpl->registration_list, pr_reg_list) {
3222 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
3223 if (calling_it_nexus)
3226 core_scsi3_ua_allocate(pr_reg->pr_reg_nacl,
3227 pr_reg->pr_res_mapped_lun, 0x2A,
3228 ASCQ_2AH_RESERVATIONS_RELEASED);
3230 spin_unlock(&pr_tmpl->registration_lock);
3232 spin_unlock(&dev->dev_reservation_lock);
3234 * Call LUN_RESET logic upon list of struct t10_pr_registration,
3235 * All received CDBs for the matching existing reservation and
3236 * registrations undergo ABORT_TASK logic.
3238 * From there, core_scsi3_release_preempt_and_abort() will
3239 * release every registration in the list (which have already
3240 * been removed from the primary pr_reg list), except the
3241 * new persistent reservation holder, the calling Initiator Port.
3244 core_tmr_lun_reset(dev, NULL, &preempt_and_abort_list, cmd);
3245 core_scsi3_release_preempt_and_abort(&preempt_and_abort_list,
3249 if (pr_tmpl->pr_aptpl_active) {
3250 ret = core_scsi3_update_and_write_aptpl(cmd->se_dev,
3251 &pr_reg_n->pr_aptpl_buf[0],
3252 pr_tmpl->pr_aptpl_buf_len);
3254 pr_debug("SPC-3 PR: Updated APTPL metadata for PREEMPT"
3255 "%s\n", (abort) ? "_AND_ABORT" : "");
3258 core_scsi3_put_pr_reg(pr_reg_n);
3259 core_scsi3_pr_generation(cmd->se_dev);
3263 static int core_scsi3_emulate_pro_preempt(
3274 case PR_TYPE_WRITE_EXCLUSIVE:
3275 case PR_TYPE_EXCLUSIVE_ACCESS:
3276 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
3277 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
3278 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
3279 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
3280 ret = core_scsi3_pro_preempt(cmd, type, scope,
3281 res_key, sa_res_key, abort);
3284 pr_err("SPC-3 PR: Unknown Service Action PREEMPT%s"
3285 " Type: 0x%02x\n", (abort) ? "_AND_ABORT" : "", type);
3286 return PYX_TRANSPORT_INVALID_CDB_FIELD;
3293 static int core_scsi3_emulate_pro_register_and_move(
3300 struct se_session *se_sess = cmd->se_sess;
3301 struct se_device *dev = cmd->se_dev;
3302 struct se_dev_entry *se_deve, *dest_se_deve = NULL;
3303 struct se_lun *se_lun = cmd->se_lun;
3304 struct se_node_acl *pr_res_nacl, *pr_reg_nacl, *dest_node_acl = NULL;
3305 struct se_port *se_port;
3306 struct se_portal_group *se_tpg, *dest_se_tpg = NULL;
3307 struct target_core_fabric_ops *dest_tf_ops = NULL, *tf_ops;
3308 struct t10_pr_registration *pr_reg, *pr_res_holder, *dest_pr_reg;
3309 struct t10_reservation *pr_tmpl = &dev->se_sub_dev->t10_pr;
3311 unsigned char *initiator_str;
3312 char *iport_ptr = NULL, dest_iport[64], i_buf[PR_REG_ISID_ID_LEN];
3313 u32 tid_len, tmp_tid_len;
3314 int new_reg = 0, type, scope, ret, matching_iname, prf_isid;
3315 unsigned short rtpi;
3316 unsigned char proto_ident;
3318 if (!se_sess || !se_lun) {
3319 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
3320 return PYX_TRANSPORT_LU_COMM_FAILURE;
3322 memset(dest_iport, 0, 64);
3323 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
3324 se_tpg = se_sess->se_tpg;
3325 tf_ops = se_tpg->se_tpg_tfo;
3326 se_deve = &se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
3328 * Follow logic from spc4r17 Section 5.7.8, Table 50 --
3329 * Register behaviors for a REGISTER AND MOVE service action
3331 * Locate the existing *pr_reg via struct se_node_acl pointers
3333 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
3336 pr_err("SPC-3 PR: Unable to locate PR_REGISTERED"
3337 " *pr_reg for REGISTER_AND_MOVE\n");
3338 return PYX_TRANSPORT_LU_COMM_FAILURE;
3341 * The provided reservation key much match the existing reservation key
3342 * provided during this initiator's I_T nexus registration.
3344 if (res_key != pr_reg->pr_res_key) {
3345 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received"
3346 " res_key: 0x%016Lx does not match existing SA REGISTER"
3347 " res_key: 0x%016Lx\n", res_key, pr_reg->pr_res_key);
3348 core_scsi3_put_pr_reg(pr_reg);
3349 return PYX_TRANSPORT_RESERVATION_CONFLICT;
3352 * The service active reservation key needs to be non zero
3355 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received zero"
3357 core_scsi3_put_pr_reg(pr_reg);
3358 return PYX_TRANSPORT_INVALID_PARAMETER_LIST;
3362 * Determine the Relative Target Port Identifier where the reservation
3363 * will be moved to for the TransportID containing SCSI initiator WWN
3366 buf = transport_kmap_first_data_page(cmd);
3367 rtpi = (buf[18] & 0xff) << 8;
3368 rtpi |= buf[19] & 0xff;
3369 tid_len = (buf[20] & 0xff) << 24;
3370 tid_len |= (buf[21] & 0xff) << 16;
3371 tid_len |= (buf[22] & 0xff) << 8;
3372 tid_len |= buf[23] & 0xff;
3373 transport_kunmap_first_data_page(cmd);
3376 if ((tid_len + 24) != cmd->data_length) {
3377 pr_err("SPC-3 PR: Illegal tid_len: %u + 24 byte header"
3378 " does not equal CDB data_length: %u\n", tid_len,
3380 core_scsi3_put_pr_reg(pr_reg);
3381 return PYX_TRANSPORT_INVALID_PARAMETER_LIST;
3384 spin_lock(&dev->se_port_lock);
3385 list_for_each_entry(se_port, &dev->dev_sep_list, sep_list) {
3386 if (se_port->sep_rtpi != rtpi)
3388 dest_se_tpg = se_port->sep_tpg;
3391 dest_tf_ops = dest_se_tpg->se_tpg_tfo;
3395 atomic_inc(&dest_se_tpg->tpg_pr_ref_count);
3396 smp_mb__after_atomic_inc();
3397 spin_unlock(&dev->se_port_lock);
3399 ret = core_scsi3_tpg_depend_item(dest_se_tpg);
3401 pr_err("core_scsi3_tpg_depend_item() failed"
3402 " for dest_se_tpg\n");
3403 atomic_dec(&dest_se_tpg->tpg_pr_ref_count);
3404 smp_mb__after_atomic_dec();
3405 core_scsi3_put_pr_reg(pr_reg);
3406 return PYX_TRANSPORT_LU_COMM_FAILURE;
3409 spin_lock(&dev->se_port_lock);
3412 spin_unlock(&dev->se_port_lock);
3414 if (!dest_se_tpg || !dest_tf_ops) {
3415 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3416 " fabric ops from Relative Target Port Identifier:"
3418 core_scsi3_put_pr_reg(pr_reg);
3419 return PYX_TRANSPORT_INVALID_PARAMETER_LIST;
3422 buf = transport_kmap_first_data_page(cmd);
3423 proto_ident = (buf[24] & 0x0f);
3425 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Extracted Protocol Identifier:"
3426 " 0x%02x\n", proto_ident);
3428 if (proto_ident != dest_tf_ops->get_fabric_proto_ident(dest_se_tpg)) {
3429 pr_err("SPC-3 PR REGISTER_AND_MOVE: Received"
3430 " proto_ident: 0x%02x does not match ident: 0x%02x"
3431 " from fabric: %s\n", proto_ident,
3432 dest_tf_ops->get_fabric_proto_ident(dest_se_tpg),
3433 dest_tf_ops->get_fabric_name());
3434 ret = PYX_TRANSPORT_INVALID_PARAMETER_LIST;
3437 if (dest_tf_ops->tpg_parse_pr_out_transport_id == NULL) {
3438 pr_err("SPC-3 PR REGISTER_AND_MOVE: Fabric does not"
3439 " containg a valid tpg_parse_pr_out_transport_id"
3440 " function pointer\n");
3441 ret = PYX_TRANSPORT_LU_COMM_FAILURE;
3444 initiator_str = dest_tf_ops->tpg_parse_pr_out_transport_id(dest_se_tpg,
3445 (const char *)&buf[24], &tmp_tid_len, &iport_ptr);
3446 if (!initiator_str) {
3447 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3448 " initiator_str from Transport ID\n");
3449 ret = PYX_TRANSPORT_INVALID_PARAMETER_LIST;
3453 transport_kunmap_first_data_page(cmd);
3456 pr_debug("SPC-3 PR [%s] Extracted initiator %s identifier: %s"
3457 " %s\n", dest_tf_ops->get_fabric_name(), (iport_ptr != NULL) ?
3458 "port" : "device", initiator_str, (iport_ptr != NULL) ?
3461 * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3462 * action specifies a TransportID that is the same as the initiator port
3463 * of the I_T nexus for the command received, then the command shall
3464 * be terminated with CHECK CONDITION status, with the sense key set to
3465 * ILLEGAL REQUEST, and the additional sense code set to INVALID FIELD
3466 * IN PARAMETER LIST.
3468 pr_reg_nacl = pr_reg->pr_reg_nacl;
3469 matching_iname = (!strcmp(initiator_str,
3470 pr_reg_nacl->initiatorname)) ? 1 : 0;
3471 if (!matching_iname)
3472 goto after_iport_check;
3474 if (!iport_ptr || !pr_reg->isid_present_at_reg) {
3475 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s"
3476 " matches: %s on received I_T Nexus\n", initiator_str,
3477 pr_reg_nacl->initiatorname);
3478 ret = PYX_TRANSPORT_INVALID_PARAMETER_LIST;
3481 if (!strcmp(iport_ptr, pr_reg->pr_reg_isid)) {
3482 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s %s"
3483 " matches: %s %s on received I_T Nexus\n",
3484 initiator_str, iport_ptr, pr_reg_nacl->initiatorname,
3485 pr_reg->pr_reg_isid);
3486 ret = PYX_TRANSPORT_INVALID_PARAMETER_LIST;
3491 * Locate the destination struct se_node_acl from the received Transport ID
3493 spin_lock_irq(&dest_se_tpg->acl_node_lock);
3494 dest_node_acl = __core_tpg_get_initiator_node_acl(dest_se_tpg,
3496 if (dest_node_acl) {
3497 atomic_inc(&dest_node_acl->acl_pr_ref_count);
3498 smp_mb__after_atomic_inc();
3500 spin_unlock_irq(&dest_se_tpg->acl_node_lock);
3502 if (!dest_node_acl) {
3503 pr_err("Unable to locate %s dest_node_acl for"
3504 " TransportID%s\n", dest_tf_ops->get_fabric_name(),
3506 ret = PYX_TRANSPORT_INVALID_PARAMETER_LIST;
3509 ret = core_scsi3_nodeacl_depend_item(dest_node_acl);
3511 pr_err("core_scsi3_nodeacl_depend_item() for"
3512 " dest_node_acl\n");
3513 atomic_dec(&dest_node_acl->acl_pr_ref_count);
3514 smp_mb__after_atomic_dec();
3515 dest_node_acl = NULL;
3516 ret = PYX_TRANSPORT_LU_COMM_FAILURE;
3520 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Found %s dest_node_acl:"
3521 " %s from TransportID\n", dest_tf_ops->get_fabric_name(),
3522 dest_node_acl->initiatorname);
3525 * Locate the struct se_dev_entry pointer for the matching RELATIVE TARGET
3528 dest_se_deve = core_get_se_deve_from_rtpi(dest_node_acl, rtpi);
3529 if (!dest_se_deve) {
3530 pr_err("Unable to locate %s dest_se_deve from RTPI:"
3531 " %hu\n", dest_tf_ops->get_fabric_name(), rtpi);
3532 ret = PYX_TRANSPORT_INVALID_PARAMETER_LIST;
3536 ret = core_scsi3_lunacl_depend_item(dest_se_deve);
3538 pr_err("core_scsi3_lunacl_depend_item() failed\n");
3539 atomic_dec(&dest_se_deve->pr_ref_count);
3540 smp_mb__after_atomic_dec();
3541 dest_se_deve = NULL;
3542 ret = PYX_TRANSPORT_LU_COMM_FAILURE;
3546 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Located %s node %s LUN"
3547 " ACL for dest_se_deve->mapped_lun: %u\n",
3548 dest_tf_ops->get_fabric_name(), dest_node_acl->initiatorname,
3549 dest_se_deve->mapped_lun);
3552 * A persistent reservation needs to already existing in order to
3553 * successfully complete the REGISTER_AND_MOVE service action..
3555 spin_lock(&dev->dev_reservation_lock);
3556 pr_res_holder = dev->dev_pr_res_holder;
3557 if (!pr_res_holder) {
3558 pr_warn("SPC-3 PR REGISTER_AND_MOVE: No reservation"
3559 " currently held\n");
3560 spin_unlock(&dev->dev_reservation_lock);
3561 ret = PYX_TRANSPORT_INVALID_CDB_FIELD;
3565 * The received on I_T Nexus must be the reservation holder.
3567 * From spc4r17 section 5.7.8 Table 50 --
3568 * Register behaviors for a REGISTER AND MOVE service action
3570 if (pr_res_holder != pr_reg) {
3571 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Calling I_T"
3572 " Nexus is not reservation holder\n");
3573 spin_unlock(&dev->dev_reservation_lock);
3574 ret = PYX_TRANSPORT_RESERVATION_CONFLICT;
3578 * From spc4r17 section 5.7.8: registering and moving reservation
3580 * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3581 * action is received and the established persistent reservation is a
3582 * Write Exclusive - All Registrants type or Exclusive Access -
3583 * All Registrants type reservation, then the command shall be completed
3584 * with RESERVATION CONFLICT status.
3586 if ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
3587 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
3588 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Unable to move"
3589 " reservation for type: %s\n",
3590 core_scsi3_pr_dump_type(pr_res_holder->pr_res_type));
3591 spin_unlock(&dev->dev_reservation_lock);
3592 ret = PYX_TRANSPORT_RESERVATION_CONFLICT;
3595 pr_res_nacl = pr_res_holder->pr_reg_nacl;
3597 * b) Ignore the contents of the (received) SCOPE and TYPE fields;
3599 type = pr_res_holder->pr_res_type;
3600 scope = pr_res_holder->pr_res_type;
3602 * c) Associate the reservation key specified in the SERVICE ACTION
3603 * RESERVATION KEY field with the I_T nexus specified as the
3604 * destination of the register and move, where:
3605 * A) The I_T nexus is specified by the TransportID and the
3606 * RELATIVE TARGET PORT IDENTIFIER field (see 6.14.4); and
3607 * B) Regardless of the TransportID format used, the association for
3608 * the initiator port is based on either the initiator port name
3609 * (see 3.1.71) on SCSI transport protocols where port names are
3610 * required or the initiator port identifier (see 3.1.70) on SCSI
3611 * transport protocols where port names are not required;
3612 * d) Register the reservation key specified in the SERVICE ACTION
3613 * RESERVATION KEY field;
3614 * e) Retain the reservation key specified in the SERVICE ACTION
3615 * RESERVATION KEY field and associated information;
3617 * Also, It is not an error for a REGISTER AND MOVE service action to
3618 * register an I_T nexus that is already registered with the same
3619 * reservation key or a different reservation key.
3621 dest_pr_reg = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
3624 ret = core_scsi3_alloc_registration(cmd->se_dev,
3625 dest_node_acl, dest_se_deve, iport_ptr,
3626 sa_res_key, 0, aptpl, 2, 1);
3628 spin_unlock(&dev->dev_reservation_lock);
3629 ret = PYX_TRANSPORT_INVALID_PARAMETER_LIST;
3632 dest_pr_reg = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
3637 * f) Release the persistent reservation for the persistent reservation
3638 * holder (i.e., the I_T nexus on which the
3640 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
3641 dev->dev_pr_res_holder, 0);
3643 * g) Move the persistent reservation to the specified I_T nexus using
3644 * the same scope and type as the persistent reservation released in
3647 dev->dev_pr_res_holder = dest_pr_reg;
3648 dest_pr_reg->pr_res_holder = 1;
3649 dest_pr_reg->pr_res_type = type;
3650 pr_reg->pr_res_scope = scope;
3651 prf_isid = core_pr_dump_initiator_port(pr_reg, &i_buf[0],
3652 PR_REG_ISID_ID_LEN);
3654 * Increment PRGeneration for existing registrations..
3657 dest_pr_reg->pr_res_generation = pr_tmpl->pr_generation++;
3658 spin_unlock(&dev->dev_reservation_lock);
3660 pr_debug("SPC-3 PR [%s] Service Action: REGISTER_AND_MOVE"
3661 " created new reservation holder TYPE: %s on object RTPI:"
3662 " %hu PRGeneration: 0x%08x\n", dest_tf_ops->get_fabric_name(),
3663 core_scsi3_pr_dump_type(type), rtpi,
3664 dest_pr_reg->pr_res_generation);
3665 pr_debug("SPC-3 PR Successfully moved reservation from"
3666 " %s Fabric Node: %s%s -> %s Fabric Node: %s %s\n",
3667 tf_ops->get_fabric_name(), pr_reg_nacl->initiatorname,
3668 (prf_isid) ? &i_buf[0] : "", dest_tf_ops->get_fabric_name(),
3669 dest_node_acl->initiatorname, (iport_ptr != NULL) ?
3672 * It is now safe to release configfs group dependencies for destination
3673 * of Transport ID Initiator Device/Port Identifier
3675 core_scsi3_lunacl_undepend_item(dest_se_deve);
3676 core_scsi3_nodeacl_undepend_item(dest_node_acl);
3677 core_scsi3_tpg_undepend_item(dest_se_tpg);
3679 * h) If the UNREG bit is set to one, unregister (see 5.7.11.3) the I_T
3680 * nexus on which PERSISTENT RESERVE OUT command was received.
3683 spin_lock(&pr_tmpl->registration_lock);
3684 __core_scsi3_free_registration(dev, pr_reg, NULL, 1);
3685 spin_unlock(&pr_tmpl->registration_lock);
3687 core_scsi3_put_pr_reg(pr_reg);
3690 * Clear the APTPL metadata if APTPL has been disabled, otherwise
3691 * write out the updated metadata to struct file for this SCSI device.
3694 pr_tmpl->pr_aptpl_active = 0;
3695 core_scsi3_update_and_write_aptpl(cmd->se_dev, NULL, 0);
3696 pr_debug("SPC-3 PR: Set APTPL Bit Deactivated for"
3697 " REGISTER_AND_MOVE\n");
3699 pr_tmpl->pr_aptpl_active = 1;
3700 ret = core_scsi3_update_and_write_aptpl(cmd->se_dev,
3701 &dest_pr_reg->pr_aptpl_buf[0],
3702 pr_tmpl->pr_aptpl_buf_len);
3704 pr_debug("SPC-3 PR: Set APTPL Bit Activated for"
3705 " REGISTER_AND_MOVE\n");
3708 transport_kunmap_first_data_page(cmd);
3710 core_scsi3_put_pr_reg(dest_pr_reg);
3714 transport_kunmap_first_data_page(cmd);
3716 core_scsi3_lunacl_undepend_item(dest_se_deve);
3718 core_scsi3_nodeacl_undepend_item(dest_node_acl);
3719 core_scsi3_tpg_undepend_item(dest_se_tpg);
3720 core_scsi3_put_pr_reg(pr_reg);
3724 static unsigned long long core_scsi3_extract_reservation_key(unsigned char *cdb)
3726 unsigned int __v1, __v2;
3728 __v1 = (cdb[0] << 24) | (cdb[1] << 16) | (cdb[2] << 8) | cdb[3];
3729 __v2 = (cdb[4] << 24) | (cdb[5] << 16) | (cdb[6] << 8) | cdb[7];
3731 return ((unsigned long long)__v2) | (unsigned long long)__v1 << 32;
3735 * See spc4r17 section 6.14 Table 170
3737 static int core_scsi3_emulate_pr_out(struct se_cmd *cmd, unsigned char *cdb)
3740 u64 res_key, sa_res_key;
3741 int sa, scope, type, aptpl;
3742 int spec_i_pt = 0, all_tg_pt = 0, unreg = 0;
3744 * FIXME: A NULL struct se_session pointer means an this is not coming from
3745 * a $FABRIC_MOD's nexus, but from internal passthrough ops.
3748 return PYX_TRANSPORT_LU_COMM_FAILURE;
3750 if (cmd->data_length < 24) {
3751 pr_warn("SPC-PR: Received PR OUT parameter list"
3752 " length too small: %u\n", cmd->data_length);
3753 return PYX_TRANSPORT_INVALID_PARAMETER_LIST;
3756 * From the PERSISTENT_RESERVE_OUT command descriptor block (CDB)
3758 sa = (cdb[1] & 0x1f);
3759 scope = (cdb[2] & 0xf0);
3760 type = (cdb[2] & 0x0f);
3762 buf = transport_kmap_first_data_page(cmd);
3764 * From PERSISTENT_RESERVE_OUT parameter list (payload)
3766 res_key = core_scsi3_extract_reservation_key(&buf[0]);
3767 sa_res_key = core_scsi3_extract_reservation_key(&buf[8]);
3769 * REGISTER_AND_MOVE uses a different SA parameter list containing
3770 * SCSI TransportIDs.
3772 if (sa != PRO_REGISTER_AND_MOVE) {
3773 spec_i_pt = (buf[20] & 0x08);
3774 all_tg_pt = (buf[20] & 0x04);
3775 aptpl = (buf[20] & 0x01);
3777 aptpl = (buf[17] & 0x01);
3778 unreg = (buf[17] & 0x02);
3780 transport_kunmap_first_data_page(cmd);
3784 * SPEC_I_PT=1 is only valid for Service action: REGISTER
3786 if (spec_i_pt && ((cdb[1] & 0x1f) != PRO_REGISTER))
3787 return PYX_TRANSPORT_INVALID_PARAMETER_LIST;
3789 * From spc4r17 section 6.14:
3791 * If the SPEC_I_PT bit is set to zero, the service action is not
3792 * REGISTER AND MOVE, and the parameter list length is not 24, then
3793 * the command shall be terminated with CHECK CONDITION status, with
3794 * the sense key set to ILLEGAL REQUEST, and the additional sense
3795 * code set to PARAMETER LIST LENGTH ERROR.
3797 if (!spec_i_pt && ((cdb[1] & 0x1f) != PRO_REGISTER_AND_MOVE) &&
3798 (cmd->data_length != 24)) {
3799 pr_warn("SPC-PR: Received PR OUT illegal parameter"
3800 " list length: %u\n", cmd->data_length);
3801 return PYX_TRANSPORT_INVALID_PARAMETER_LIST;
3804 * (core_scsi3_emulate_pro_* function parameters
3805 * are defined by spc4r17 Table 174:
3806 * PERSISTENT_RESERVE_OUT service actions and valid parameters.
3810 return core_scsi3_emulate_pro_register(cmd,
3811 res_key, sa_res_key, aptpl, all_tg_pt, spec_i_pt, 0);
3813 return core_scsi3_emulate_pro_reserve(cmd,
3814 type, scope, res_key);
3816 return core_scsi3_emulate_pro_release(cmd,
3817 type, scope, res_key);
3819 return core_scsi3_emulate_pro_clear(cmd, res_key);
3821 return core_scsi3_emulate_pro_preempt(cmd, type, scope,
3822 res_key, sa_res_key, 0);
3823 case PRO_PREEMPT_AND_ABORT:
3824 return core_scsi3_emulate_pro_preempt(cmd, type, scope,
3825 res_key, sa_res_key, 1);
3826 case PRO_REGISTER_AND_IGNORE_EXISTING_KEY:
3827 return core_scsi3_emulate_pro_register(cmd,
3828 0, sa_res_key, aptpl, all_tg_pt, spec_i_pt, 1);
3829 case PRO_REGISTER_AND_MOVE:
3830 return core_scsi3_emulate_pro_register_and_move(cmd, res_key,
3831 sa_res_key, aptpl, unreg);
3833 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
3834 " action: 0x%02x\n", cdb[1] & 0x1f);
3835 return PYX_TRANSPORT_INVALID_CDB_FIELD;
3838 return PYX_TRANSPORT_INVALID_CDB_FIELD;
3842 * PERSISTENT_RESERVE_IN Service Action READ_KEYS
3844 * See spc4r17 section 5.7.6.2 and section 6.13.2, Table 160
3846 static int core_scsi3_pri_read_keys(struct se_cmd *cmd)
3848 struct se_device *se_dev = cmd->se_dev;
3849 struct se_subsystem_dev *su_dev = se_dev->se_sub_dev;
3850 struct t10_pr_registration *pr_reg;
3852 u32 add_len = 0, off = 8;
3854 if (cmd->data_length < 8) {
3855 pr_err("PRIN SA READ_KEYS SCSI Data Length: %u"
3856 " too small\n", cmd->data_length);
3857 return PYX_TRANSPORT_INVALID_CDB_FIELD;
3860 buf = transport_kmap_first_data_page(cmd);
3861 buf[0] = ((su_dev->t10_pr.pr_generation >> 24) & 0xff);
3862 buf[1] = ((su_dev->t10_pr.pr_generation >> 16) & 0xff);
3863 buf[2] = ((su_dev->t10_pr.pr_generation >> 8) & 0xff);
3864 buf[3] = (su_dev->t10_pr.pr_generation & 0xff);
3866 spin_lock(&su_dev->t10_pr.registration_lock);
3867 list_for_each_entry(pr_reg, &su_dev->t10_pr.registration_list,
3870 * Check for overflow of 8byte PRI READ_KEYS payload and
3871 * next reservation key list descriptor.
3873 if ((add_len + 8) > (cmd->data_length - 8))
3876 buf[off++] = ((pr_reg->pr_res_key >> 56) & 0xff);
3877 buf[off++] = ((pr_reg->pr_res_key >> 48) & 0xff);
3878 buf[off++] = ((pr_reg->pr_res_key >> 40) & 0xff);
3879 buf[off++] = ((pr_reg->pr_res_key >> 32) & 0xff);
3880 buf[off++] = ((pr_reg->pr_res_key >> 24) & 0xff);
3881 buf[off++] = ((pr_reg->pr_res_key >> 16) & 0xff);
3882 buf[off++] = ((pr_reg->pr_res_key >> 8) & 0xff);
3883 buf[off++] = (pr_reg->pr_res_key & 0xff);
3887 spin_unlock(&su_dev->t10_pr.registration_lock);
3889 buf[4] = ((add_len >> 24) & 0xff);
3890 buf[5] = ((add_len >> 16) & 0xff);
3891 buf[6] = ((add_len >> 8) & 0xff);
3892 buf[7] = (add_len & 0xff);
3894 transport_kunmap_first_data_page(cmd);
3900 * PERSISTENT_RESERVE_IN Service Action READ_RESERVATION
3902 * See spc4r17 section 5.7.6.3 and section 6.13.3.2 Table 161 and 162
3904 static int core_scsi3_pri_read_reservation(struct se_cmd *cmd)
3906 struct se_device *se_dev = cmd->se_dev;
3907 struct se_subsystem_dev *su_dev = se_dev->se_sub_dev;
3908 struct t10_pr_registration *pr_reg;
3911 u32 add_len = 16; /* Hardcoded to 16 when a reservation is held. */
3913 if (cmd->data_length < 8) {
3914 pr_err("PRIN SA READ_RESERVATIONS SCSI Data Length: %u"
3915 " too small\n", cmd->data_length);
3916 return PYX_TRANSPORT_INVALID_CDB_FIELD;
3919 buf = transport_kmap_first_data_page(cmd);
3920 buf[0] = ((su_dev->t10_pr.pr_generation >> 24) & 0xff);
3921 buf[1] = ((su_dev->t10_pr.pr_generation >> 16) & 0xff);
3922 buf[2] = ((su_dev->t10_pr.pr_generation >> 8) & 0xff);
3923 buf[3] = (su_dev->t10_pr.pr_generation & 0xff);
3925 spin_lock(&se_dev->dev_reservation_lock);
3926 pr_reg = se_dev->dev_pr_res_holder;
3929 * Set the hardcoded Additional Length
3931 buf[4] = ((add_len >> 24) & 0xff);
3932 buf[5] = ((add_len >> 16) & 0xff);
3933 buf[6] = ((add_len >> 8) & 0xff);
3934 buf[7] = (add_len & 0xff);
3936 if (cmd->data_length < 22)
3940 * Set the Reservation key.
3942 * From spc4r17, section 5.7.10:
3943 * A persistent reservation holder has its reservation key
3944 * returned in the parameter data from a PERSISTENT
3945 * RESERVE IN command with READ RESERVATION service action as
3947 * a) For a persistent reservation of the type Write Exclusive
3948 * - All Registrants or Exclusive Access  All Regitrants,
3949 * the reservation key shall be set to zero; or
3950 * b) For all other persistent reservation types, the
3951 * reservation key shall be set to the registered
3952 * reservation key for the I_T nexus that holds the
3953 * persistent reservation.
3955 if ((pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
3956 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))
3959 pr_res_key = pr_reg->pr_res_key;
3961 buf[8] = ((pr_res_key >> 56) & 0xff);
3962 buf[9] = ((pr_res_key >> 48) & 0xff);
3963 buf[10] = ((pr_res_key >> 40) & 0xff);
3964 buf[11] = ((pr_res_key >> 32) & 0xff);
3965 buf[12] = ((pr_res_key >> 24) & 0xff);
3966 buf[13] = ((pr_res_key >> 16) & 0xff);
3967 buf[14] = ((pr_res_key >> 8) & 0xff);
3968 buf[15] = (pr_res_key & 0xff);
3970 * Set the SCOPE and TYPE
3972 buf[21] = (pr_reg->pr_res_scope & 0xf0) |
3973 (pr_reg->pr_res_type & 0x0f);
3977 spin_unlock(&se_dev->dev_reservation_lock);
3978 transport_kunmap_first_data_page(cmd);
3984 * PERSISTENT_RESERVE_IN Service Action REPORT_CAPABILITIES
3986 * See spc4r17 section 6.13.4 Table 165
3988 static int core_scsi3_pri_report_capabilities(struct se_cmd *cmd)
3990 struct se_device *dev = cmd->se_dev;
3991 struct t10_reservation *pr_tmpl = &dev->se_sub_dev->t10_pr;
3993 u16 add_len = 8; /* Hardcoded to 8. */
3995 if (cmd->data_length < 6) {
3996 pr_err("PRIN SA REPORT_CAPABILITIES SCSI Data Length:"
3997 " %u too small\n", cmd->data_length);
3998 return PYX_TRANSPORT_INVALID_CDB_FIELD;
4001 buf = transport_kmap_first_data_page(cmd);
4003 buf[0] = ((add_len << 8) & 0xff);
4004 buf[1] = (add_len & 0xff);
4005 buf[2] |= 0x10; /* CRH: Compatible Reservation Hanlding bit. */
4006 buf[2] |= 0x08; /* SIP_C: Specify Initiator Ports Capable bit */
4007 buf[2] |= 0x04; /* ATP_C: All Target Ports Capable bit */
4008 buf[2] |= 0x01; /* PTPL_C: Persistence across Target Power Loss bit */
4010 * We are filling in the PERSISTENT RESERVATION TYPE MASK below, so
4011 * set the TMV: Task Mask Valid bit.
4015 * Change ALLOW COMMANDs to 0x20 or 0x40 later from Table 166
4017 buf[3] |= 0x10; /* ALLOW COMMANDs field 001b */
4019 * PTPL_A: Persistence across Target Power Loss Active bit
4021 if (pr_tmpl->pr_aptpl_active)
4024 * Setup the PERSISTENT RESERVATION TYPE MASK from Table 167
4026 buf[4] |= 0x80; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
4027 buf[4] |= 0x40; /* PR_TYPE_EXCLUSIVE_ACCESS_REGONLY */
4028 buf[4] |= 0x20; /* PR_TYPE_WRITE_EXCLUSIVE_REGONLY */
4029 buf[4] |= 0x08; /* PR_TYPE_EXCLUSIVE_ACCESS */
4030 buf[4] |= 0x02; /* PR_TYPE_WRITE_EXCLUSIVE */
4031 buf[5] |= 0x01; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
4033 transport_kunmap_first_data_page(cmd);
4039 * PERSISTENT_RESERVE_IN Service Action READ_FULL_STATUS
4041 * See spc4r17 section 6.13.5 Table 168 and 169
4043 static int core_scsi3_pri_read_full_status(struct se_cmd *cmd)
4045 struct se_device *se_dev = cmd->se_dev;
4046 struct se_node_acl *se_nacl;
4047 struct se_subsystem_dev *su_dev = se_dev->se_sub_dev;
4048 struct se_portal_group *se_tpg;
4049 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
4050 struct t10_reservation *pr_tmpl = &se_dev->se_sub_dev->t10_pr;
4052 u32 add_desc_len = 0, add_len = 0, desc_len, exp_desc_len;
4053 u32 off = 8; /* off into first Full Status descriptor */
4054 int format_code = 0;
4056 if (cmd->data_length < 8) {
4057 pr_err("PRIN SA READ_FULL_STATUS SCSI Data Length: %u"
4058 " too small\n", cmd->data_length);
4059 return PYX_TRANSPORT_INVALID_CDB_FIELD;
4062 buf = transport_kmap_first_data_page(cmd);
4064 buf[0] = ((su_dev->t10_pr.pr_generation >> 24) & 0xff);
4065 buf[1] = ((su_dev->t10_pr.pr_generation >> 16) & 0xff);
4066 buf[2] = ((su_dev->t10_pr.pr_generation >> 8) & 0xff);
4067 buf[3] = (su_dev->t10_pr.pr_generation & 0xff);
4069 spin_lock(&pr_tmpl->registration_lock);
4070 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
4071 &pr_tmpl->registration_list, pr_reg_list) {
4073 se_nacl = pr_reg->pr_reg_nacl;
4074 se_tpg = pr_reg->pr_reg_nacl->se_tpg;
4077 atomic_inc(&pr_reg->pr_res_holders);
4078 smp_mb__after_atomic_inc();
4079 spin_unlock(&pr_tmpl->registration_lock);
4081 * Determine expected length of $FABRIC_MOD specific
4082 * TransportID full status descriptor..
4084 exp_desc_len = se_tpg->se_tpg_tfo->tpg_get_pr_transport_id_len(
4085 se_tpg, se_nacl, pr_reg, &format_code);
4087 if ((exp_desc_len + add_len) > cmd->data_length) {
4088 pr_warn("SPC-3 PRIN READ_FULL_STATUS ran"
4089 " out of buffer: %d\n", cmd->data_length);
4090 spin_lock(&pr_tmpl->registration_lock);
4091 atomic_dec(&pr_reg->pr_res_holders);
4092 smp_mb__after_atomic_dec();
4096 * Set RESERVATION KEY
4098 buf[off++] = ((pr_reg->pr_res_key >> 56) & 0xff);
4099 buf[off++] = ((pr_reg->pr_res_key >> 48) & 0xff);
4100 buf[off++] = ((pr_reg->pr_res_key >> 40) & 0xff);
4101 buf[off++] = ((pr_reg->pr_res_key >> 32) & 0xff);
4102 buf[off++] = ((pr_reg->pr_res_key >> 24) & 0xff);
4103 buf[off++] = ((pr_reg->pr_res_key >> 16) & 0xff);
4104 buf[off++] = ((pr_reg->pr_res_key >> 8) & 0xff);
4105 buf[off++] = (pr_reg->pr_res_key & 0xff);
4106 off += 4; /* Skip Over Reserved area */
4109 * Set ALL_TG_PT bit if PROUT SA REGISTER had this set.
4111 if (pr_reg->pr_reg_all_tg_pt)
4114 * The struct se_lun pointer will be present for the
4115 * reservation holder for PR_HOLDER bit.
4117 * Also, if this registration is the reservation
4118 * holder, fill in SCOPE and TYPE in the next byte.
4120 if (pr_reg->pr_res_holder) {
4122 buf[off++] = (pr_reg->pr_res_scope & 0xf0) |
4123 (pr_reg->pr_res_type & 0x0f);
4127 off += 4; /* Skip over reserved area */
4129 * From spc4r17 6.3.15:
4131 * If the ALL_TG_PT bit set to zero, the RELATIVE TARGET PORT
4132 * IDENTIFIER field contains the relative port identifier (see
4133 * 3.1.120) of the target port that is part of the I_T nexus
4134 * described by this full status descriptor. If the ALL_TG_PT
4135 * bit is set to one, the contents of the RELATIVE TARGET PORT
4136 * IDENTIFIER field are not defined by this standard.
4138 if (!pr_reg->pr_reg_all_tg_pt) {
4139 struct se_port *port = pr_reg->pr_reg_tg_pt_lun->lun_sep;
4141 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
4142 buf[off++] = (port->sep_rtpi & 0xff);
4144 off += 2; /* Skip over RELATIVE TARGET PORT IDENTIFER */
4147 * Now, have the $FABRIC_MOD fill in the protocol identifier
4149 desc_len = se_tpg->se_tpg_tfo->tpg_get_pr_transport_id(se_tpg,
4150 se_nacl, pr_reg, &format_code, &buf[off+4]);
4152 spin_lock(&pr_tmpl->registration_lock);
4153 atomic_dec(&pr_reg->pr_res_holders);
4154 smp_mb__after_atomic_dec();
4156 * Set the ADDITIONAL DESCRIPTOR LENGTH
4158 buf[off++] = ((desc_len >> 24) & 0xff);
4159 buf[off++] = ((desc_len >> 16) & 0xff);
4160 buf[off++] = ((desc_len >> 8) & 0xff);
4161 buf[off++] = (desc_len & 0xff);
4163 * Size of full desctipor header minus TransportID
4164 * containing $FABRIC_MOD specific) initiator device/port
4167 * See spc4r17 Section 6.13.5 Table 169
4169 add_desc_len = (24 + desc_len);
4172 add_len += add_desc_len;
4174 spin_unlock(&pr_tmpl->registration_lock);
4176 * Set ADDITIONAL_LENGTH
4178 buf[4] = ((add_len >> 24) & 0xff);
4179 buf[5] = ((add_len >> 16) & 0xff);
4180 buf[6] = ((add_len >> 8) & 0xff);
4181 buf[7] = (add_len & 0xff);
4183 transport_kunmap_first_data_page(cmd);
4188 static int core_scsi3_emulate_pr_in(struct se_cmd *cmd, unsigned char *cdb)
4190 switch (cdb[1] & 0x1f) {
4192 return core_scsi3_pri_read_keys(cmd);
4193 case PRI_READ_RESERVATION:
4194 return core_scsi3_pri_read_reservation(cmd);
4195 case PRI_REPORT_CAPABILITIES:
4196 return core_scsi3_pri_report_capabilities(cmd);
4197 case PRI_READ_FULL_STATUS:
4198 return core_scsi3_pri_read_full_status(cmd);
4200 pr_err("Unknown PERSISTENT_RESERVE_IN service"
4201 " action: 0x%02x\n", cdb[1] & 0x1f);
4202 return PYX_TRANSPORT_INVALID_CDB_FIELD;
4207 int core_scsi3_emulate_pr(struct se_cmd *cmd)
4209 unsigned char *cdb = &cmd->t_task_cdb[0];
4210 struct se_device *dev = cmd->se_dev;
4212 * Following spc2r20 5.5.1 Reservations overview:
4214 * If a logical unit has been reserved by any RESERVE command and is
4215 * still reserved by any initiator, all PERSISTENT RESERVE IN and all
4216 * PERSISTENT RESERVE OUT commands shall conflict regardless of
4217 * initiator or service action and shall terminate with a RESERVATION
4220 if (dev->dev_flags & DF_SPC2_RESERVATIONS) {
4221 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
4222 " SPC-2 reservation is held, returning"
4223 " RESERVATION_CONFLICT\n");
4224 return PYX_TRANSPORT_RESERVATION_CONFLICT;
4227 return (cdb[0] == PERSISTENT_RESERVE_OUT) ?
4228 core_scsi3_emulate_pr_out(cmd, cdb) :
4229 core_scsi3_emulate_pr_in(cmd, cdb);
4232 static int core_pt_reservation_check(struct se_cmd *cmd, u32 *pr_res_type)
4237 static int core_pt_seq_non_holder(
4245 int core_setup_reservations(struct se_device *dev, int force_pt)
4247 struct se_subsystem_dev *su_dev = dev->se_sub_dev;
4248 struct t10_reservation *rest = &su_dev->t10_pr;
4250 * If this device is from Target_Core_Mod/pSCSI, use the reservations
4251 * of the Underlying SCSI hardware. In Linux/SCSI terms, this can
4252 * cause a problem because libata and some SATA RAID HBAs appear
4253 * under Linux/SCSI, but to emulate reservations themselves.
4255 if (((dev->transport->transport_type == TRANSPORT_PLUGIN_PHBA_PDEV) &&
4256 !(dev->se_sub_dev->se_dev_attrib.emulate_reservations)) || force_pt) {
4257 rest->res_type = SPC_PASSTHROUGH;
4258 rest->pr_ops.t10_reservation_check = &core_pt_reservation_check;
4259 rest->pr_ops.t10_seq_non_holder = &core_pt_seq_non_holder;
4260 pr_debug("%s: Using SPC_PASSTHROUGH, no reservation"
4261 " emulation\n", dev->transport->name);
4265 * If SPC-3 or above is reported by real or emulated struct se_device,
4266 * use emulated Persistent Reservations.
4268 if (dev->transport->get_device_rev(dev) >= SCSI_3) {
4269 rest->res_type = SPC3_PERSISTENT_RESERVATIONS;
4270 rest->pr_ops.t10_reservation_check = &core_scsi3_pr_reservation_check;
4271 rest->pr_ops.t10_seq_non_holder = &core_scsi3_pr_seq_non_holder;
4272 pr_debug("%s: Using SPC3_PERSISTENT_RESERVATIONS"
4273 " emulation\n", dev->transport->name);
4275 rest->res_type = SPC2_RESERVATIONS;
4276 rest->pr_ops.t10_reservation_check = &core_scsi2_reservation_check;
4277 rest->pr_ops.t10_seq_non_holder =
4278 &core_scsi2_reservation_seq_non_holder;
4279 pr_debug("%s: Using SPC2_RESERVATIONS emulation\n",
4280 dev->transport->name);