Linux 3.18.86
[linux/fpc-iii.git] / drivers / target / target_core_pr.c
blob45837a4e950d7e10b9bee51d84c57d2f2f2abe4a
1 /*******************************************************************************
2 * Filename: target_core_pr.c
4 * This file contains SPC-3 compliant persistent reservations and
5 * legacy SPC-2 reservations with compatible reservation handling (CRH=1)
7 * (c) Copyright 2009-2013 Datera, Inc.
9 * Nicholas A. Bellinger <nab@kernel.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25 ******************************************************************************/
27 #include <linux/slab.h>
28 #include <linux/spinlock.h>
29 #include <linux/list.h>
30 #include <linux/file.h>
31 #include <scsi/scsi.h>
32 #include <scsi/scsi_cmnd.h>
33 #include <asm/unaligned.h>
35 #include <target/target_core_base.h>
36 #include <target/target_core_backend.h>
37 #include <target/target_core_fabric.h>
38 #include <target/target_core_configfs.h>
40 #include "target_core_internal.h"
41 #include "target_core_pr.h"
42 #include "target_core_ua.h"
45 * Used for Specify Initiator Ports Capable Bit (SPEC_I_PT)
47 struct pr_transport_id_holder {
48 int dest_local_nexus;
49 struct t10_pr_registration *dest_pr_reg;
50 struct se_portal_group *dest_tpg;
51 struct se_node_acl *dest_node_acl;
52 struct se_dev_entry *dest_se_deve;
53 struct list_head dest_list;
56 void core_pr_dump_initiator_port(
57 struct t10_pr_registration *pr_reg,
58 char *buf,
59 u32 size)
61 if (!pr_reg->isid_present_at_reg)
62 buf[0] = '\0';
64 snprintf(buf, size, ",i,0x%s", pr_reg->pr_reg_isid);
67 enum register_type {
68 REGISTER,
69 REGISTER_AND_IGNORE_EXISTING_KEY,
70 REGISTER_AND_MOVE,
73 enum preempt_type {
74 PREEMPT,
75 PREEMPT_AND_ABORT,
78 static void __core_scsi3_complete_pro_release(struct se_device *, struct se_node_acl *,
79 struct t10_pr_registration *, int);
81 static sense_reason_t
82 target_scsi2_reservation_check(struct se_cmd *cmd)
84 struct se_device *dev = cmd->se_dev;
85 struct se_session *sess = cmd->se_sess;
87 switch (cmd->t_task_cdb[0]) {
88 case INQUIRY:
89 case RELEASE:
90 case RELEASE_10:
91 return 0;
92 default:
93 break;
96 if (!dev->dev_reserved_node_acl || !sess)
97 return 0;
99 if (dev->dev_reserved_node_acl != sess->se_node_acl)
100 return TCM_RESERVATION_CONFLICT;
102 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS_WITH_ISID) {
103 if (dev->dev_res_bin_isid != sess->sess_bin_isid)
104 return TCM_RESERVATION_CONFLICT;
107 return 0;
110 static struct t10_pr_registration *core_scsi3_locate_pr_reg(struct se_device *,
111 struct se_node_acl *, struct se_session *);
112 static void core_scsi3_put_pr_reg(struct t10_pr_registration *);
114 static int target_check_scsi2_reservation_conflict(struct se_cmd *cmd)
116 struct se_session *se_sess = cmd->se_sess;
117 struct se_device *dev = cmd->se_dev;
118 struct t10_pr_registration *pr_reg;
119 struct t10_reservation *pr_tmpl = &dev->t10_pr;
120 int conflict = 0;
122 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
123 se_sess);
124 if (pr_reg) {
126 * From spc4r17 5.7.3 Exceptions to SPC-2 RESERVE and RELEASE
127 * behavior
129 * A RESERVE(6) or RESERVE(10) command shall complete with GOOD
130 * status, but no reservation shall be established and the
131 * persistent reservation shall not be changed, if the command
132 * is received from a) and b) below.
134 * A RELEASE(6) or RELEASE(10) command shall complete with GOOD
135 * status, but the persistent reservation shall not be released,
136 * if the command is received from a) and b)
138 * a) An I_T nexus that is a persistent reservation holder; or
139 * b) An I_T nexus that is registered if a registrants only or
140 * all registrants type persistent reservation is present.
142 * In all other cases, a RESERVE(6) command, RESERVE(10) command,
143 * RELEASE(6) command, or RELEASE(10) command shall be processed
144 * as defined in SPC-2.
146 if (pr_reg->pr_res_holder) {
147 core_scsi3_put_pr_reg(pr_reg);
148 return 1;
150 if ((pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_REGONLY) ||
151 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_REGONLY) ||
152 (pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
153 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
154 core_scsi3_put_pr_reg(pr_reg);
155 return 1;
157 core_scsi3_put_pr_reg(pr_reg);
158 conflict = 1;
159 } else {
161 * Following spc2r20 5.5.1 Reservations overview:
163 * If a logical unit has executed a PERSISTENT RESERVE OUT
164 * command with the REGISTER or the REGISTER AND IGNORE
165 * EXISTING KEY service action and is still registered by any
166 * initiator, all RESERVE commands and all RELEASE commands
167 * regardless of initiator shall conflict and shall terminate
168 * with a RESERVATION CONFLICT status.
170 spin_lock(&pr_tmpl->registration_lock);
171 conflict = (list_empty(&pr_tmpl->registration_list)) ? 0 : 1;
172 spin_unlock(&pr_tmpl->registration_lock);
175 if (conflict) {
176 pr_err("Received legacy SPC-2 RESERVE/RELEASE"
177 " while active SPC-3 registrations exist,"
178 " returning RESERVATION_CONFLICT\n");
179 return -EBUSY;
182 return 0;
185 sense_reason_t
186 target_scsi2_reservation_release(struct se_cmd *cmd)
188 struct se_device *dev = cmd->se_dev;
189 struct se_session *sess = cmd->se_sess;
190 struct se_portal_group *tpg;
191 int rc;
193 if (!sess || !sess->se_tpg)
194 goto out;
195 rc = target_check_scsi2_reservation_conflict(cmd);
196 if (rc == 1)
197 goto out;
198 if (rc < 0)
199 return TCM_RESERVATION_CONFLICT;
201 spin_lock(&dev->dev_reservation_lock);
202 if (!dev->dev_reserved_node_acl || !sess)
203 goto out_unlock;
205 if (dev->dev_reserved_node_acl != sess->se_node_acl)
206 goto out_unlock;
208 if (dev->dev_res_bin_isid != sess->sess_bin_isid)
209 goto out_unlock;
211 dev->dev_reserved_node_acl = NULL;
212 dev->dev_reservation_flags &= ~DRF_SPC2_RESERVATIONS;
213 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS_WITH_ISID) {
214 dev->dev_res_bin_isid = 0;
215 dev->dev_reservation_flags &= ~DRF_SPC2_RESERVATIONS_WITH_ISID;
217 tpg = sess->se_tpg;
218 pr_debug("SCSI-2 Released reservation for %s LUN: %u ->"
219 " MAPPED LUN: %u for %s\n", tpg->se_tpg_tfo->get_fabric_name(),
220 cmd->se_lun->unpacked_lun, cmd->se_deve->mapped_lun,
221 sess->se_node_acl->initiatorname);
223 out_unlock:
224 spin_unlock(&dev->dev_reservation_lock);
225 out:
226 target_complete_cmd(cmd, GOOD);
227 return 0;
230 sense_reason_t
231 target_scsi2_reservation_reserve(struct se_cmd *cmd)
233 struct se_device *dev = cmd->se_dev;
234 struct se_session *sess = cmd->se_sess;
235 struct se_portal_group *tpg;
236 sense_reason_t ret = 0;
237 int rc;
239 if ((cmd->t_task_cdb[1] & 0x01) &&
240 (cmd->t_task_cdb[1] & 0x02)) {
241 pr_err("LongIO and Obselete Bits set, returning"
242 " ILLEGAL_REQUEST\n");
243 return TCM_UNSUPPORTED_SCSI_OPCODE;
246 * This is currently the case for target_core_mod passthrough struct se_cmd
247 * ops
249 if (!sess || !sess->se_tpg)
250 goto out;
251 rc = target_check_scsi2_reservation_conflict(cmd);
252 if (rc == 1)
253 goto out;
255 if (rc < 0)
256 return TCM_RESERVATION_CONFLICT;
258 tpg = sess->se_tpg;
259 spin_lock(&dev->dev_reservation_lock);
260 if (dev->dev_reserved_node_acl &&
261 (dev->dev_reserved_node_acl != sess->se_node_acl)) {
262 pr_err("SCSI-2 RESERVATION CONFLIFT for %s fabric\n",
263 tpg->se_tpg_tfo->get_fabric_name());
264 pr_err("Original reserver LUN: %u %s\n",
265 cmd->se_lun->unpacked_lun,
266 dev->dev_reserved_node_acl->initiatorname);
267 pr_err("Current attempt - LUN: %u -> MAPPED LUN: %u"
268 " from %s \n", cmd->se_lun->unpacked_lun,
269 cmd->se_deve->mapped_lun,
270 sess->se_node_acl->initiatorname);
271 ret = TCM_RESERVATION_CONFLICT;
272 goto out_unlock;
275 dev->dev_reserved_node_acl = sess->se_node_acl;
276 dev->dev_reservation_flags |= DRF_SPC2_RESERVATIONS;
277 if (sess->sess_bin_isid != 0) {
278 dev->dev_res_bin_isid = sess->sess_bin_isid;
279 dev->dev_reservation_flags |= DRF_SPC2_RESERVATIONS_WITH_ISID;
281 pr_debug("SCSI-2 Reserved %s LUN: %u -> MAPPED LUN: %u"
282 " for %s\n", tpg->se_tpg_tfo->get_fabric_name(),
283 cmd->se_lun->unpacked_lun, cmd->se_deve->mapped_lun,
284 sess->se_node_acl->initiatorname);
286 out_unlock:
287 spin_unlock(&dev->dev_reservation_lock);
288 out:
289 if (!ret)
290 target_complete_cmd(cmd, GOOD);
291 return ret;
296 * Begin SPC-3/SPC-4 Persistent Reservations emulation support
298 * This function is called by those initiator ports who are *NOT*
299 * the active PR reservation holder when a reservation is present.
301 static int core_scsi3_pr_seq_non_holder(
302 struct se_cmd *cmd,
303 u32 pr_reg_type)
305 unsigned char *cdb = cmd->t_task_cdb;
306 struct se_dev_entry *se_deve;
307 struct se_session *se_sess = cmd->se_sess;
308 int other_cdb = 0, ignore_reg;
309 int registered_nexus = 0, ret = 1; /* Conflict by default */
310 int all_reg = 0, reg_only = 0; /* ALL_REG, REG_ONLY */
311 int we = 0; /* Write Exclusive */
312 int legacy = 0; /* Act like a legacy device and return
313 * RESERVATION CONFLICT on some CDBs */
315 se_deve = se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
317 * Determine if the registration should be ignored due to
318 * non-matching ISIDs in target_scsi3_pr_reservation_check().
320 ignore_reg = (pr_reg_type & 0x80000000);
321 if (ignore_reg)
322 pr_reg_type &= ~0x80000000;
324 switch (pr_reg_type) {
325 case PR_TYPE_WRITE_EXCLUSIVE:
326 we = 1;
327 case PR_TYPE_EXCLUSIVE_ACCESS:
329 * Some commands are only allowed for the persistent reservation
330 * holder.
332 if ((se_deve->def_pr_registered) && !(ignore_reg))
333 registered_nexus = 1;
334 break;
335 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
336 we = 1;
337 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
339 * Some commands are only allowed for registered I_T Nexuses.
341 reg_only = 1;
342 if ((se_deve->def_pr_registered) && !(ignore_reg))
343 registered_nexus = 1;
344 break;
345 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
346 we = 1;
347 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
349 * Each registered I_T Nexus is a reservation holder.
351 all_reg = 1;
352 if ((se_deve->def_pr_registered) && !(ignore_reg))
353 registered_nexus = 1;
354 break;
355 default:
356 return -EINVAL;
359 * Referenced from spc4r17 table 45 for *NON* PR holder access
361 switch (cdb[0]) {
362 case SECURITY_PROTOCOL_IN:
363 if (registered_nexus)
364 return 0;
365 ret = (we) ? 0 : 1;
366 break;
367 case MODE_SENSE:
368 case MODE_SENSE_10:
369 case READ_ATTRIBUTE:
370 case READ_BUFFER:
371 case RECEIVE_DIAGNOSTIC:
372 if (legacy) {
373 ret = 1;
374 break;
376 if (registered_nexus) {
377 ret = 0;
378 break;
380 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
381 break;
382 case PERSISTENT_RESERVE_OUT:
384 * This follows PERSISTENT_RESERVE_OUT service actions that
385 * are allowed in the presence of various reservations.
386 * See spc4r17, table 46
388 switch (cdb[1] & 0x1f) {
389 case PRO_CLEAR:
390 case PRO_PREEMPT:
391 case PRO_PREEMPT_AND_ABORT:
392 ret = (registered_nexus) ? 0 : 1;
393 break;
394 case PRO_REGISTER:
395 case PRO_REGISTER_AND_IGNORE_EXISTING_KEY:
396 ret = 0;
397 break;
398 case PRO_REGISTER_AND_MOVE:
399 case PRO_RESERVE:
400 ret = 1;
401 break;
402 case PRO_RELEASE:
403 ret = (registered_nexus) ? 0 : 1;
404 break;
405 default:
406 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
407 " action: 0x%02x\n", cdb[1] & 0x1f);
408 return -EINVAL;
410 break;
411 case RELEASE:
412 case RELEASE_10:
413 /* Handled by CRH=1 in target_scsi2_reservation_release() */
414 ret = 0;
415 break;
416 case RESERVE:
417 case RESERVE_10:
418 /* Handled by CRH=1 in target_scsi2_reservation_reserve() */
419 ret = 0;
420 break;
421 case TEST_UNIT_READY:
422 ret = (legacy) ? 1 : 0; /* Conflict for legacy */
423 break;
424 case MAINTENANCE_IN:
425 switch (cdb[1] & 0x1f) {
426 case MI_MANAGEMENT_PROTOCOL_IN:
427 if (registered_nexus) {
428 ret = 0;
429 break;
431 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
432 break;
433 case MI_REPORT_SUPPORTED_OPERATION_CODES:
434 case MI_REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS:
435 if (legacy) {
436 ret = 1;
437 break;
439 if (registered_nexus) {
440 ret = 0;
441 break;
443 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
444 break;
445 case MI_REPORT_ALIASES:
446 case MI_REPORT_IDENTIFYING_INFORMATION:
447 case MI_REPORT_PRIORITY:
448 case MI_REPORT_TARGET_PGS:
449 case MI_REPORT_TIMESTAMP:
450 ret = 0; /* Allowed */
451 break;
452 default:
453 pr_err("Unknown MI Service Action: 0x%02x\n",
454 (cdb[1] & 0x1f));
455 return -EINVAL;
457 break;
458 case ACCESS_CONTROL_IN:
459 case ACCESS_CONTROL_OUT:
460 case INQUIRY:
461 case LOG_SENSE:
462 case READ_MEDIA_SERIAL_NUMBER:
463 case REPORT_LUNS:
464 case REQUEST_SENSE:
465 case PERSISTENT_RESERVE_IN:
466 ret = 0; /*/ Allowed CDBs */
467 break;
468 default:
469 other_cdb = 1;
470 break;
473 * Case where the CDB is explicitly allowed in the above switch
474 * statement.
476 if (!ret && !other_cdb) {
477 pr_debug("Allowing explicit CDB: 0x%02x for %s"
478 " reservation holder\n", cdb[0],
479 core_scsi3_pr_dump_type(pr_reg_type));
481 return ret;
484 * Check if write exclusive initiator ports *NOT* holding the
485 * WRITE_EXCLUSIVE_* reservation.
487 if (we && !registered_nexus) {
488 if (cmd->data_direction == DMA_TO_DEVICE) {
490 * Conflict for write exclusive
492 pr_debug("%s Conflict for unregistered nexus"
493 " %s CDB: 0x%02x to %s reservation\n",
494 transport_dump_cmd_direction(cmd),
495 se_sess->se_node_acl->initiatorname, cdb[0],
496 core_scsi3_pr_dump_type(pr_reg_type));
497 return 1;
498 } else {
500 * Allow non WRITE CDBs for all Write Exclusive
501 * PR TYPEs to pass for registered and
502 * non-registered_nexuxes NOT holding the reservation.
504 * We only make noise for the unregisterd nexuses,
505 * as we expect registered non-reservation holding
506 * nexuses to issue CDBs.
509 if (!registered_nexus) {
510 pr_debug("Allowing implicit CDB: 0x%02x"
511 " for %s reservation on unregistered"
512 " nexus\n", cdb[0],
513 core_scsi3_pr_dump_type(pr_reg_type));
516 return 0;
518 } else if ((reg_only) || (all_reg)) {
519 if (registered_nexus) {
521 * For PR_*_REG_ONLY and PR_*_ALL_REG reservations,
522 * allow commands from registered nexuses.
525 pr_debug("Allowing implicit CDB: 0x%02x for %s"
526 " reservation\n", cdb[0],
527 core_scsi3_pr_dump_type(pr_reg_type));
529 return 0;
532 pr_debug("%s Conflict for %sregistered nexus %s CDB: 0x%2x"
533 " for %s reservation\n", transport_dump_cmd_direction(cmd),
534 (registered_nexus) ? "" : "un",
535 se_sess->se_node_acl->initiatorname, cdb[0],
536 core_scsi3_pr_dump_type(pr_reg_type));
538 return 1; /* Conflict by default */
541 static sense_reason_t
542 target_scsi3_pr_reservation_check(struct se_cmd *cmd)
544 struct se_device *dev = cmd->se_dev;
545 struct se_session *sess = cmd->se_sess;
546 u32 pr_reg_type;
548 if (!dev->dev_pr_res_holder)
549 return 0;
551 pr_reg_type = dev->dev_pr_res_holder->pr_res_type;
552 cmd->pr_res_key = dev->dev_pr_res_holder->pr_res_key;
553 if (dev->dev_pr_res_holder->pr_reg_nacl != sess->se_node_acl)
554 goto check_nonholder;
556 if (dev->dev_pr_res_holder->isid_present_at_reg) {
557 if (dev->dev_pr_res_holder->pr_reg_bin_isid !=
558 sess->sess_bin_isid) {
559 pr_reg_type |= 0x80000000;
560 goto check_nonholder;
564 return 0;
566 check_nonholder:
567 if (core_scsi3_pr_seq_non_holder(cmd, pr_reg_type))
568 return TCM_RESERVATION_CONFLICT;
569 return 0;
572 static u32 core_scsi3_pr_generation(struct se_device *dev)
574 u32 prg;
577 * PRGeneration field shall contain the value of a 32-bit wrapping
578 * counter mainted by the device server.
580 * Note that this is done regardless of Active Persist across
581 * Target PowerLoss (APTPL)
583 * See spc4r17 section 6.3.12 READ_KEYS service action
585 spin_lock(&dev->dev_reservation_lock);
586 prg = dev->t10_pr.pr_generation++;
587 spin_unlock(&dev->dev_reservation_lock);
589 return prg;
592 static struct t10_pr_registration *__core_scsi3_do_alloc_registration(
593 struct se_device *dev,
594 struct se_node_acl *nacl,
595 struct se_dev_entry *deve,
596 unsigned char *isid,
597 u64 sa_res_key,
598 int all_tg_pt,
599 int aptpl)
601 struct t10_pr_registration *pr_reg;
603 pr_reg = kmem_cache_zalloc(t10_pr_reg_cache, GFP_ATOMIC);
604 if (!pr_reg) {
605 pr_err("Unable to allocate struct t10_pr_registration\n");
606 return NULL;
609 INIT_LIST_HEAD(&pr_reg->pr_reg_list);
610 INIT_LIST_HEAD(&pr_reg->pr_reg_abort_list);
611 INIT_LIST_HEAD(&pr_reg->pr_reg_aptpl_list);
612 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_list);
613 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_mem_list);
614 atomic_set(&pr_reg->pr_res_holders, 0);
615 pr_reg->pr_reg_nacl = nacl;
616 pr_reg->pr_reg_deve = deve;
617 pr_reg->pr_res_mapped_lun = deve->mapped_lun;
618 pr_reg->pr_aptpl_target_lun = deve->se_lun->unpacked_lun;
619 pr_reg->pr_res_key = sa_res_key;
620 pr_reg->pr_reg_all_tg_pt = all_tg_pt;
621 pr_reg->pr_reg_aptpl = aptpl;
622 pr_reg->pr_reg_tg_pt_lun = deve->se_lun;
624 * If an ISID value for this SCSI Initiator Port exists,
625 * save it to the registration now.
627 if (isid != NULL) {
628 pr_reg->pr_reg_bin_isid = get_unaligned_be64(isid);
629 snprintf(pr_reg->pr_reg_isid, PR_REG_ISID_LEN, "%s", isid);
630 pr_reg->isid_present_at_reg = 1;
633 return pr_reg;
636 static int core_scsi3_lunacl_depend_item(struct se_dev_entry *);
637 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry *);
640 * Function used for handling PR registrations for ALL_TG_PT=1 and ALL_TG_PT=0
641 * modes.
643 static struct t10_pr_registration *__core_scsi3_alloc_registration(
644 struct se_device *dev,
645 struct se_node_acl *nacl,
646 struct se_dev_entry *deve,
647 unsigned char *isid,
648 u64 sa_res_key,
649 int all_tg_pt,
650 int aptpl)
652 struct se_dev_entry *deve_tmp;
653 struct se_node_acl *nacl_tmp;
654 struct se_port *port, *port_tmp;
655 struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
656 struct t10_pr_registration *pr_reg, *pr_reg_atp, *pr_reg_tmp, *pr_reg_tmp_safe;
657 int ret;
659 * Create a registration for the I_T Nexus upon which the
660 * PROUT REGISTER was received.
662 pr_reg = __core_scsi3_do_alloc_registration(dev, nacl, deve, isid,
663 sa_res_key, all_tg_pt, aptpl);
664 if (!pr_reg)
665 return NULL;
667 * Return pointer to pr_reg for ALL_TG_PT=0
669 if (!all_tg_pt)
670 return pr_reg;
672 * Create list of matching SCSI Initiator Port registrations
673 * for ALL_TG_PT=1
675 spin_lock(&dev->se_port_lock);
676 list_for_each_entry_safe(port, port_tmp, &dev->dev_sep_list, sep_list) {
677 atomic_inc_mb(&port->sep_tg_pt_ref_cnt);
678 spin_unlock(&dev->se_port_lock);
680 spin_lock_bh(&port->sep_alua_lock);
681 list_for_each_entry(deve_tmp, &port->sep_alua_list,
682 alua_port_list) {
684 * This pointer will be NULL for demo mode MappedLUNs
685 * that have not been make explicit via a ConfigFS
686 * MappedLUN group for the SCSI Initiator Node ACL.
688 if (!deve_tmp->se_lun_acl)
689 continue;
691 nacl_tmp = deve_tmp->se_lun_acl->se_lun_nacl;
693 * Skip the matching struct se_node_acl that is allocated
694 * above..
696 if (nacl == nacl_tmp)
697 continue;
699 * Only perform PR registrations for target ports on
700 * the same fabric module as the REGISTER w/ ALL_TG_PT=1
701 * arrived.
703 if (tfo != nacl_tmp->se_tpg->se_tpg_tfo)
704 continue;
706 * Look for a matching Initiator Node ACL in ASCII format
708 if (strcmp(nacl->initiatorname, nacl_tmp->initiatorname))
709 continue;
711 atomic_inc_mb(&deve_tmp->pr_ref_count);
712 spin_unlock_bh(&port->sep_alua_lock);
714 * Grab a configfs group dependency that is released
715 * for the exception path at label out: below, or upon
716 * completion of adding ALL_TG_PT=1 registrations in
717 * __core_scsi3_add_registration()
719 ret = core_scsi3_lunacl_depend_item(deve_tmp);
720 if (ret < 0) {
721 pr_err("core_scsi3_lunacl_depend"
722 "_item() failed\n");
723 atomic_dec_mb(&port->sep_tg_pt_ref_cnt);
724 atomic_dec_mb(&deve_tmp->pr_ref_count);
725 goto out;
728 * Located a matching SCSI Initiator Port on a different
729 * port, allocate the pr_reg_atp and attach it to the
730 * pr_reg->pr_reg_atp_list that will be processed once
731 * the original *pr_reg is processed in
732 * __core_scsi3_add_registration()
734 pr_reg_atp = __core_scsi3_do_alloc_registration(dev,
735 nacl_tmp, deve_tmp, NULL,
736 sa_res_key, all_tg_pt, aptpl);
737 if (!pr_reg_atp) {
738 atomic_dec_mb(&port->sep_tg_pt_ref_cnt);
739 atomic_dec_mb(&deve_tmp->pr_ref_count);
740 core_scsi3_lunacl_undepend_item(deve_tmp);
741 goto out;
744 list_add_tail(&pr_reg_atp->pr_reg_atp_mem_list,
745 &pr_reg->pr_reg_atp_list);
746 spin_lock_bh(&port->sep_alua_lock);
748 spin_unlock_bh(&port->sep_alua_lock);
750 spin_lock(&dev->se_port_lock);
751 atomic_dec_mb(&port->sep_tg_pt_ref_cnt);
753 spin_unlock(&dev->se_port_lock);
755 return pr_reg;
756 out:
757 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
758 &pr_reg->pr_reg_atp_list, pr_reg_atp_mem_list) {
759 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
760 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
761 kmem_cache_free(t10_pr_reg_cache, pr_reg_tmp);
763 kmem_cache_free(t10_pr_reg_cache, pr_reg);
764 return NULL;
767 int core_scsi3_alloc_aptpl_registration(
768 struct t10_reservation *pr_tmpl,
769 u64 sa_res_key,
770 unsigned char *i_port,
771 unsigned char *isid,
772 u32 mapped_lun,
773 unsigned char *t_port,
774 u16 tpgt,
775 u32 target_lun,
776 int res_holder,
777 int all_tg_pt,
778 u8 type)
780 struct t10_pr_registration *pr_reg;
782 if (!i_port || !t_port || !sa_res_key) {
783 pr_err("Illegal parameters for APTPL registration\n");
784 return -EINVAL;
787 pr_reg = kmem_cache_zalloc(t10_pr_reg_cache, GFP_KERNEL);
788 if (!pr_reg) {
789 pr_err("Unable to allocate struct t10_pr_registration\n");
790 return -ENOMEM;
793 INIT_LIST_HEAD(&pr_reg->pr_reg_list);
794 INIT_LIST_HEAD(&pr_reg->pr_reg_abort_list);
795 INIT_LIST_HEAD(&pr_reg->pr_reg_aptpl_list);
796 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_list);
797 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_mem_list);
798 atomic_set(&pr_reg->pr_res_holders, 0);
799 pr_reg->pr_reg_nacl = NULL;
800 pr_reg->pr_reg_deve = NULL;
801 pr_reg->pr_res_mapped_lun = mapped_lun;
802 pr_reg->pr_aptpl_target_lun = target_lun;
803 pr_reg->pr_res_key = sa_res_key;
804 pr_reg->pr_reg_all_tg_pt = all_tg_pt;
805 pr_reg->pr_reg_aptpl = 1;
806 pr_reg->pr_reg_tg_pt_lun = NULL;
807 pr_reg->pr_res_scope = 0; /* Always LUN_SCOPE */
808 pr_reg->pr_res_type = type;
810 * If an ISID value had been saved in APTPL metadata for this
811 * SCSI Initiator Port, restore it now.
813 if (isid != NULL) {
814 pr_reg->pr_reg_bin_isid = get_unaligned_be64(isid);
815 snprintf(pr_reg->pr_reg_isid, PR_REG_ISID_LEN, "%s", isid);
816 pr_reg->isid_present_at_reg = 1;
819 * Copy the i_port and t_port information from caller.
821 snprintf(pr_reg->pr_iport, PR_APTPL_MAX_IPORT_LEN, "%s", i_port);
822 snprintf(pr_reg->pr_tport, PR_APTPL_MAX_TPORT_LEN, "%s", t_port);
823 pr_reg->pr_reg_tpgt = tpgt;
825 * Set pr_res_holder from caller, the pr_reg who is the reservation
826 * holder will get it's pointer set in core_scsi3_aptpl_reserve() once
827 * the Initiator Node LUN ACL from the fabric module is created for
828 * this registration.
830 pr_reg->pr_res_holder = res_holder;
832 list_add_tail(&pr_reg->pr_reg_aptpl_list, &pr_tmpl->aptpl_reg_list);
833 pr_debug("SPC-3 PR APTPL Successfully added registration%s from"
834 " metadata\n", (res_holder) ? "+reservation" : "");
835 return 0;
838 static void core_scsi3_aptpl_reserve(
839 struct se_device *dev,
840 struct se_portal_group *tpg,
841 struct se_node_acl *node_acl,
842 struct t10_pr_registration *pr_reg)
844 char i_buf[PR_REG_ISID_ID_LEN];
846 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
847 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
849 spin_lock(&dev->dev_reservation_lock);
850 dev->dev_pr_res_holder = pr_reg;
851 spin_unlock(&dev->dev_reservation_lock);
853 pr_debug("SPC-3 PR [%s] Service Action: APTPL RESERVE created"
854 " new reservation holder TYPE: %s ALL_TG_PT: %d\n",
855 tpg->se_tpg_tfo->get_fabric_name(),
856 core_scsi3_pr_dump_type(pr_reg->pr_res_type),
857 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
858 pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
859 tpg->se_tpg_tfo->get_fabric_name(), node_acl->initiatorname,
860 i_buf);
863 static void __core_scsi3_add_registration(struct se_device *, struct se_node_acl *,
864 struct t10_pr_registration *, enum register_type, int);
866 static int __core_scsi3_check_aptpl_registration(
867 struct se_device *dev,
868 struct se_portal_group *tpg,
869 struct se_lun *lun,
870 u32 target_lun,
871 struct se_node_acl *nacl,
872 struct se_dev_entry *deve)
874 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
875 struct t10_reservation *pr_tmpl = &dev->t10_pr;
876 unsigned char i_port[PR_APTPL_MAX_IPORT_LEN];
877 unsigned char t_port[PR_APTPL_MAX_TPORT_LEN];
878 u16 tpgt;
880 memset(i_port, 0, PR_APTPL_MAX_IPORT_LEN);
881 memset(t_port, 0, PR_APTPL_MAX_TPORT_LEN);
883 * Copy Initiator Port information from struct se_node_acl
885 snprintf(i_port, PR_APTPL_MAX_IPORT_LEN, "%s", nacl->initiatorname);
886 snprintf(t_port, PR_APTPL_MAX_TPORT_LEN, "%s",
887 tpg->se_tpg_tfo->tpg_get_wwn(tpg));
888 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
890 * Look for the matching registrations+reservation from those
891 * created from APTPL metadata. Note that multiple registrations
892 * may exist for fabrics that use ISIDs in their SCSI Initiator Port
893 * TransportIDs.
895 spin_lock(&pr_tmpl->aptpl_reg_lock);
896 list_for_each_entry_safe(pr_reg, pr_reg_tmp, &pr_tmpl->aptpl_reg_list,
897 pr_reg_aptpl_list) {
899 if (!strcmp(pr_reg->pr_iport, i_port) &&
900 (pr_reg->pr_res_mapped_lun == deve->mapped_lun) &&
901 !(strcmp(pr_reg->pr_tport, t_port)) &&
902 (pr_reg->pr_reg_tpgt == tpgt) &&
903 (pr_reg->pr_aptpl_target_lun == target_lun)) {
905 pr_reg->pr_reg_nacl = nacl;
906 pr_reg->pr_reg_deve = deve;
907 pr_reg->pr_reg_tg_pt_lun = lun;
909 list_del(&pr_reg->pr_reg_aptpl_list);
910 spin_unlock(&pr_tmpl->aptpl_reg_lock);
912 * At this point all of the pointers in *pr_reg will
913 * be setup, so go ahead and add the registration.
916 __core_scsi3_add_registration(dev, nacl, pr_reg, 0, 0);
918 * If this registration is the reservation holder,
919 * make that happen now..
921 if (pr_reg->pr_res_holder)
922 core_scsi3_aptpl_reserve(dev, tpg,
923 nacl, pr_reg);
925 * Reenable pr_aptpl_active to accept new metadata
926 * updates once the SCSI device is active again..
928 spin_lock(&pr_tmpl->aptpl_reg_lock);
929 pr_tmpl->pr_aptpl_active = 1;
932 spin_unlock(&pr_tmpl->aptpl_reg_lock);
934 return 0;
937 int core_scsi3_check_aptpl_registration(
938 struct se_device *dev,
939 struct se_portal_group *tpg,
940 struct se_lun *lun,
941 struct se_node_acl *nacl,
942 u32 mapped_lun)
944 struct se_dev_entry *deve = nacl->device_list[mapped_lun];
946 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS)
947 return 0;
949 return __core_scsi3_check_aptpl_registration(dev, tpg, lun,
950 lun->unpacked_lun, nacl, deve);
953 static void __core_scsi3_dump_registration(
954 struct target_core_fabric_ops *tfo,
955 struct se_device *dev,
956 struct se_node_acl *nacl,
957 struct t10_pr_registration *pr_reg,
958 enum register_type register_type)
960 struct se_portal_group *se_tpg = nacl->se_tpg;
961 char i_buf[PR_REG_ISID_ID_LEN];
963 memset(&i_buf[0], 0, PR_REG_ISID_ID_LEN);
964 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
966 pr_debug("SPC-3 PR [%s] Service Action: REGISTER%s Initiator"
967 " Node: %s%s\n", tfo->get_fabric_name(), (register_type == REGISTER_AND_MOVE) ?
968 "_AND_MOVE" : (register_type == REGISTER_AND_IGNORE_EXISTING_KEY) ?
969 "_AND_IGNORE_EXISTING_KEY" : "", nacl->initiatorname,
970 i_buf);
971 pr_debug("SPC-3 PR [%s] registration on Target Port: %s,0x%04x\n",
972 tfo->get_fabric_name(), tfo->tpg_get_wwn(se_tpg),
973 tfo->tpg_get_tag(se_tpg));
974 pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
975 " Port(s)\n", tfo->get_fabric_name(),
976 (pr_reg->pr_reg_all_tg_pt) ? "ALL" : "SINGLE",
977 dev->transport->name);
978 pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
979 " 0x%08x APTPL: %d\n", tfo->get_fabric_name(),
980 pr_reg->pr_res_key, pr_reg->pr_res_generation,
981 pr_reg->pr_reg_aptpl);
985 * this function can be called with struct se_device->dev_reservation_lock
986 * when register_move = 1
988 static void __core_scsi3_add_registration(
989 struct se_device *dev,
990 struct se_node_acl *nacl,
991 struct t10_pr_registration *pr_reg,
992 enum register_type register_type,
993 int register_move)
995 struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
996 struct t10_pr_registration *pr_reg_tmp, *pr_reg_tmp_safe;
997 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1000 * Increment PRgeneration counter for struct se_device upon a successful
1001 * REGISTER, see spc4r17 section 6.3.2 READ_KEYS service action
1003 * Also, when register_move = 1 for PROUT REGISTER_AND_MOVE service
1004 * action, the struct se_device->dev_reservation_lock will already be held,
1005 * so we do not call core_scsi3_pr_generation() which grabs the lock
1006 * for the REGISTER.
1008 pr_reg->pr_res_generation = (register_move) ?
1009 dev->t10_pr.pr_generation++ :
1010 core_scsi3_pr_generation(dev);
1012 spin_lock(&pr_tmpl->registration_lock);
1013 list_add_tail(&pr_reg->pr_reg_list, &pr_tmpl->registration_list);
1014 pr_reg->pr_reg_deve->def_pr_registered = 1;
1016 __core_scsi3_dump_registration(tfo, dev, nacl, pr_reg, register_type);
1017 spin_unlock(&pr_tmpl->registration_lock);
1019 * Skip extra processing for ALL_TG_PT=0 or REGISTER_AND_MOVE.
1021 if (!pr_reg->pr_reg_all_tg_pt || register_move)
1022 return;
1024 * Walk pr_reg->pr_reg_atp_list and add registrations for ALL_TG_PT=1
1025 * allocated in __core_scsi3_alloc_registration()
1027 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
1028 &pr_reg->pr_reg_atp_list, pr_reg_atp_mem_list) {
1029 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
1031 pr_reg_tmp->pr_res_generation = core_scsi3_pr_generation(dev);
1033 spin_lock(&pr_tmpl->registration_lock);
1034 list_add_tail(&pr_reg_tmp->pr_reg_list,
1035 &pr_tmpl->registration_list);
1036 pr_reg_tmp->pr_reg_deve->def_pr_registered = 1;
1038 __core_scsi3_dump_registration(tfo, dev,
1039 pr_reg_tmp->pr_reg_nacl, pr_reg_tmp,
1040 register_type);
1041 spin_unlock(&pr_tmpl->registration_lock);
1043 * Drop configfs group dependency reference from
1044 * __core_scsi3_alloc_registration()
1046 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
1050 static int core_scsi3_alloc_registration(
1051 struct se_device *dev,
1052 struct se_node_acl *nacl,
1053 struct se_dev_entry *deve,
1054 unsigned char *isid,
1055 u64 sa_res_key,
1056 int all_tg_pt,
1057 int aptpl,
1058 enum register_type register_type,
1059 int register_move)
1061 struct t10_pr_registration *pr_reg;
1063 pr_reg = __core_scsi3_alloc_registration(dev, nacl, deve, isid,
1064 sa_res_key, all_tg_pt, aptpl);
1065 if (!pr_reg)
1066 return -EPERM;
1068 __core_scsi3_add_registration(dev, nacl, pr_reg,
1069 register_type, register_move);
1070 return 0;
1073 static struct t10_pr_registration *__core_scsi3_locate_pr_reg(
1074 struct se_device *dev,
1075 struct se_node_acl *nacl,
1076 unsigned char *isid)
1078 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1079 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
1080 struct se_portal_group *tpg;
1082 spin_lock(&pr_tmpl->registration_lock);
1083 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1084 &pr_tmpl->registration_list, pr_reg_list) {
1086 * First look for a matching struct se_node_acl
1088 if (pr_reg->pr_reg_nacl != nacl)
1089 continue;
1091 tpg = pr_reg->pr_reg_nacl->se_tpg;
1093 * If this registration does NOT contain a fabric provided
1094 * ISID, then we have found a match.
1096 if (!pr_reg->isid_present_at_reg) {
1098 * Determine if this SCSI device server requires that
1099 * SCSI Intiatior TransportID w/ ISIDs is enforced
1100 * for fabric modules (iSCSI) requiring them.
1102 if (tpg->se_tpg_tfo->sess_get_initiator_sid != NULL) {
1103 if (dev->dev_attrib.enforce_pr_isids)
1104 continue;
1106 atomic_inc_mb(&pr_reg->pr_res_holders);
1107 spin_unlock(&pr_tmpl->registration_lock);
1108 return pr_reg;
1111 * If the *pr_reg contains a fabric defined ISID for multi-value
1112 * SCSI Initiator Port TransportIDs, then we expect a valid
1113 * matching ISID to be provided by the local SCSI Initiator Port.
1115 if (!isid)
1116 continue;
1117 if (strcmp(isid, pr_reg->pr_reg_isid))
1118 continue;
1120 atomic_inc_mb(&pr_reg->pr_res_holders);
1121 spin_unlock(&pr_tmpl->registration_lock);
1122 return pr_reg;
1124 spin_unlock(&pr_tmpl->registration_lock);
1126 return NULL;
1129 static struct t10_pr_registration *core_scsi3_locate_pr_reg(
1130 struct se_device *dev,
1131 struct se_node_acl *nacl,
1132 struct se_session *sess)
1134 struct se_portal_group *tpg = nacl->se_tpg;
1135 unsigned char buf[PR_REG_ISID_LEN], *isid_ptr = NULL;
1137 if (tpg->se_tpg_tfo->sess_get_initiator_sid != NULL) {
1138 memset(&buf[0], 0, PR_REG_ISID_LEN);
1139 tpg->se_tpg_tfo->sess_get_initiator_sid(sess, &buf[0],
1140 PR_REG_ISID_LEN);
1141 isid_ptr = &buf[0];
1144 return __core_scsi3_locate_pr_reg(dev, nacl, isid_ptr);
1147 static void core_scsi3_put_pr_reg(struct t10_pr_registration *pr_reg)
1149 atomic_dec_mb(&pr_reg->pr_res_holders);
1152 static int core_scsi3_check_implicit_release(
1153 struct se_device *dev,
1154 struct t10_pr_registration *pr_reg)
1156 struct se_node_acl *nacl = pr_reg->pr_reg_nacl;
1157 struct t10_pr_registration *pr_res_holder;
1158 int ret = 0;
1160 spin_lock(&dev->dev_reservation_lock);
1161 pr_res_holder = dev->dev_pr_res_holder;
1162 if (!pr_res_holder) {
1163 spin_unlock(&dev->dev_reservation_lock);
1164 return ret;
1166 if (pr_res_holder == pr_reg) {
1168 * Perform an implicit RELEASE if the registration that
1169 * is being released is holding the reservation.
1171 * From spc4r17, section 5.7.11.1:
1173 * e) If the I_T nexus is the persistent reservation holder
1174 * and the persistent reservation is not an all registrants
1175 * type, then a PERSISTENT RESERVE OUT command with REGISTER
1176 * service action or REGISTER AND IGNORE EXISTING KEY
1177 * service action with the SERVICE ACTION RESERVATION KEY
1178 * field set to zero (see 5.7.11.3).
1180 __core_scsi3_complete_pro_release(dev, nacl, pr_reg, 0);
1181 ret = 1;
1183 * For 'All Registrants' reservation types, all existing
1184 * registrations are still processed as reservation holders
1185 * in core_scsi3_pr_seq_non_holder() after the initial
1186 * reservation holder is implicitly released here.
1188 } else if (pr_reg->pr_reg_all_tg_pt &&
1189 (!strcmp(pr_res_holder->pr_reg_nacl->initiatorname,
1190 pr_reg->pr_reg_nacl->initiatorname)) &&
1191 (pr_res_holder->pr_res_key == pr_reg->pr_res_key)) {
1192 pr_err("SPC-3 PR: Unable to perform ALL_TG_PT=1"
1193 " UNREGISTER while existing reservation with matching"
1194 " key 0x%016Lx is present from another SCSI Initiator"
1195 " Port\n", pr_reg->pr_res_key);
1196 ret = -EPERM;
1198 spin_unlock(&dev->dev_reservation_lock);
1200 return ret;
1204 * Called with struct t10_reservation->registration_lock held.
1206 static void __core_scsi3_free_registration(
1207 struct se_device *dev,
1208 struct t10_pr_registration *pr_reg,
1209 struct list_head *preempt_and_abort_list,
1210 int dec_holders)
1212 struct target_core_fabric_ops *tfo =
1213 pr_reg->pr_reg_nacl->se_tpg->se_tpg_tfo;
1214 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1215 char i_buf[PR_REG_ISID_ID_LEN];
1217 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
1218 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
1220 pr_reg->pr_reg_deve->def_pr_registered = 0;
1221 pr_reg->pr_reg_deve->pr_res_key = 0;
1222 list_del(&pr_reg->pr_reg_list);
1224 * Caller accessing *pr_reg using core_scsi3_locate_pr_reg(),
1225 * so call core_scsi3_put_pr_reg() to decrement our reference.
1227 if (dec_holders)
1228 core_scsi3_put_pr_reg(pr_reg);
1230 * Wait until all reference from any other I_T nexuses for this
1231 * *pr_reg have been released. Because list_del() is called above,
1232 * the last core_scsi3_put_pr_reg(pr_reg) will release this reference
1233 * count back to zero, and we release *pr_reg.
1235 while (atomic_read(&pr_reg->pr_res_holders) != 0) {
1236 spin_unlock(&pr_tmpl->registration_lock);
1237 pr_debug("SPC-3 PR [%s] waiting for pr_res_holders\n",
1238 tfo->get_fabric_name());
1239 cpu_relax();
1240 spin_lock(&pr_tmpl->registration_lock);
1243 pr_debug("SPC-3 PR [%s] Service Action: UNREGISTER Initiator"
1244 " Node: %s%s\n", tfo->get_fabric_name(),
1245 pr_reg->pr_reg_nacl->initiatorname,
1246 i_buf);
1247 pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
1248 " Port(s)\n", tfo->get_fabric_name(),
1249 (pr_reg->pr_reg_all_tg_pt) ? "ALL" : "SINGLE",
1250 dev->transport->name);
1251 pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
1252 " 0x%08x\n", tfo->get_fabric_name(), pr_reg->pr_res_key,
1253 pr_reg->pr_res_generation);
1255 if (!preempt_and_abort_list) {
1256 pr_reg->pr_reg_deve = NULL;
1257 pr_reg->pr_reg_nacl = NULL;
1258 kmem_cache_free(t10_pr_reg_cache, pr_reg);
1259 return;
1262 * For PREEMPT_AND_ABORT, the list of *pr_reg in preempt_and_abort_list
1263 * are released once the ABORT_TASK_SET has completed..
1265 list_add_tail(&pr_reg->pr_reg_abort_list, preempt_and_abort_list);
1268 void core_scsi3_free_pr_reg_from_nacl(
1269 struct se_device *dev,
1270 struct se_node_acl *nacl)
1272 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1273 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_res_holder;
1275 * If the passed se_node_acl matches the reservation holder,
1276 * release the reservation.
1278 spin_lock(&dev->dev_reservation_lock);
1279 pr_res_holder = dev->dev_pr_res_holder;
1280 if ((pr_res_holder != NULL) &&
1281 (pr_res_holder->pr_reg_nacl == nacl))
1282 __core_scsi3_complete_pro_release(dev, nacl, pr_res_holder, 0);
1283 spin_unlock(&dev->dev_reservation_lock);
1285 * Release any registration associated with the struct se_node_acl.
1287 spin_lock(&pr_tmpl->registration_lock);
1288 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1289 &pr_tmpl->registration_list, pr_reg_list) {
1291 if (pr_reg->pr_reg_nacl != nacl)
1292 continue;
1294 __core_scsi3_free_registration(dev, pr_reg, NULL, 0);
1296 spin_unlock(&pr_tmpl->registration_lock);
1299 void core_scsi3_free_all_registrations(
1300 struct se_device *dev)
1302 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1303 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_res_holder;
1305 spin_lock(&dev->dev_reservation_lock);
1306 pr_res_holder = dev->dev_pr_res_holder;
1307 if (pr_res_holder != NULL) {
1308 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
1309 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
1310 pr_res_holder, 0);
1312 spin_unlock(&dev->dev_reservation_lock);
1314 spin_lock(&pr_tmpl->registration_lock);
1315 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1316 &pr_tmpl->registration_list, pr_reg_list) {
1318 __core_scsi3_free_registration(dev, pr_reg, NULL, 0);
1320 spin_unlock(&pr_tmpl->registration_lock);
1322 spin_lock(&pr_tmpl->aptpl_reg_lock);
1323 list_for_each_entry_safe(pr_reg, pr_reg_tmp, &pr_tmpl->aptpl_reg_list,
1324 pr_reg_aptpl_list) {
1325 list_del(&pr_reg->pr_reg_aptpl_list);
1326 kmem_cache_free(t10_pr_reg_cache, pr_reg);
1328 spin_unlock(&pr_tmpl->aptpl_reg_lock);
1331 static int core_scsi3_tpg_depend_item(struct se_portal_group *tpg)
1333 return configfs_depend_item(tpg->se_tpg_tfo->tf_subsys,
1334 &tpg->tpg_group.cg_item);
1337 static void core_scsi3_tpg_undepend_item(struct se_portal_group *tpg)
1339 configfs_undepend_item(tpg->se_tpg_tfo->tf_subsys,
1340 &tpg->tpg_group.cg_item);
1342 atomic_dec_mb(&tpg->tpg_pr_ref_count);
1345 static int core_scsi3_nodeacl_depend_item(struct se_node_acl *nacl)
1347 struct se_portal_group *tpg = nacl->se_tpg;
1349 if (nacl->dynamic_node_acl)
1350 return 0;
1352 return configfs_depend_item(tpg->se_tpg_tfo->tf_subsys,
1353 &nacl->acl_group.cg_item);
1356 static void core_scsi3_nodeacl_undepend_item(struct se_node_acl *nacl)
1358 struct se_portal_group *tpg = nacl->se_tpg;
1360 if (nacl->dynamic_node_acl) {
1361 atomic_dec_mb(&nacl->acl_pr_ref_count);
1362 return;
1365 configfs_undepend_item(tpg->se_tpg_tfo->tf_subsys,
1366 &nacl->acl_group.cg_item);
1368 atomic_dec_mb(&nacl->acl_pr_ref_count);
1371 static int core_scsi3_lunacl_depend_item(struct se_dev_entry *se_deve)
1373 struct se_lun_acl *lun_acl = se_deve->se_lun_acl;
1374 struct se_node_acl *nacl;
1375 struct se_portal_group *tpg;
1377 * For nacl->dynamic_node_acl=1
1379 if (!lun_acl)
1380 return 0;
1382 nacl = lun_acl->se_lun_nacl;
1383 tpg = nacl->se_tpg;
1385 return configfs_depend_item(tpg->se_tpg_tfo->tf_subsys,
1386 &lun_acl->se_lun_group.cg_item);
1389 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry *se_deve)
1391 struct se_lun_acl *lun_acl = se_deve->se_lun_acl;
1392 struct se_node_acl *nacl;
1393 struct se_portal_group *tpg;
1395 * For nacl->dynamic_node_acl=1
1397 if (!lun_acl) {
1398 atomic_dec_mb(&se_deve->pr_ref_count);
1399 return;
1401 nacl = lun_acl->se_lun_nacl;
1402 tpg = nacl->se_tpg;
1404 configfs_undepend_item(tpg->se_tpg_tfo->tf_subsys,
1405 &lun_acl->se_lun_group.cg_item);
1407 atomic_dec_mb(&se_deve->pr_ref_count);
1410 static sense_reason_t
1411 core_scsi3_decode_spec_i_port(
1412 struct se_cmd *cmd,
1413 struct se_portal_group *tpg,
1414 unsigned char *l_isid,
1415 u64 sa_res_key,
1416 int all_tg_pt,
1417 int aptpl)
1419 struct se_device *dev = cmd->se_dev;
1420 struct se_port *tmp_port;
1421 struct se_portal_group *dest_tpg = NULL, *tmp_tpg;
1422 struct se_session *se_sess = cmd->se_sess;
1423 struct se_node_acl *dest_node_acl = NULL;
1424 struct se_dev_entry *dest_se_deve = NULL, *local_se_deve;
1425 struct t10_pr_registration *dest_pr_reg, *local_pr_reg, *pr_reg_e;
1426 struct t10_pr_registration *pr_reg_tmp, *pr_reg_tmp_safe;
1427 LIST_HEAD(tid_dest_list);
1428 struct pr_transport_id_holder *tidh_new, *tidh, *tidh_tmp;
1429 struct target_core_fabric_ops *tmp_tf_ops;
1430 unsigned char *buf;
1431 unsigned char *ptr, *i_str = NULL, proto_ident, tmp_proto_ident;
1432 char *iport_ptr = NULL, dest_iport[64], i_buf[PR_REG_ISID_ID_LEN];
1433 sense_reason_t ret;
1434 u32 tpdl, tid_len = 0;
1435 int dest_local_nexus;
1436 u32 dest_rtpi = 0;
1438 memset(dest_iport, 0, 64);
1440 local_se_deve = se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
1442 * Allocate a struct pr_transport_id_holder and setup the
1443 * local_node_acl and local_se_deve pointers and add to
1444 * struct list_head tid_dest_list for add registration
1445 * processing in the loop of tid_dest_list below.
1447 tidh_new = kzalloc(sizeof(struct pr_transport_id_holder), GFP_KERNEL);
1448 if (!tidh_new) {
1449 pr_err("Unable to allocate tidh_new\n");
1450 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1452 INIT_LIST_HEAD(&tidh_new->dest_list);
1453 tidh_new->dest_tpg = tpg;
1454 tidh_new->dest_node_acl = se_sess->se_node_acl;
1455 tidh_new->dest_se_deve = local_se_deve;
1457 local_pr_reg = __core_scsi3_alloc_registration(cmd->se_dev,
1458 se_sess->se_node_acl, local_se_deve, l_isid,
1459 sa_res_key, all_tg_pt, aptpl);
1460 if (!local_pr_reg) {
1461 kfree(tidh_new);
1462 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1464 tidh_new->dest_pr_reg = local_pr_reg;
1466 * The local I_T nexus does not hold any configfs dependances,
1467 * so we set tid_h->dest_local_nexus=1 to prevent the
1468 * configfs_undepend_item() calls in the tid_dest_list loops below.
1470 tidh_new->dest_local_nexus = 1;
1471 list_add_tail(&tidh_new->dest_list, &tid_dest_list);
1473 if (cmd->data_length < 28) {
1474 pr_warn("SPC-PR: Received PR OUT parameter list"
1475 " length too small: %u\n", cmd->data_length);
1476 ret = TCM_INVALID_PARAMETER_LIST;
1477 goto out;
1480 buf = transport_kmap_data_sg(cmd);
1481 if (!buf) {
1482 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1483 goto out;
1487 * For a PERSISTENT RESERVE OUT specify initiator ports payload,
1488 * first extract TransportID Parameter Data Length, and make sure
1489 * the value matches up to the SCSI expected data transfer length.
1491 tpdl = (buf[24] & 0xff) << 24;
1492 tpdl |= (buf[25] & 0xff) << 16;
1493 tpdl |= (buf[26] & 0xff) << 8;
1494 tpdl |= buf[27] & 0xff;
1496 if ((tpdl + 28) != cmd->data_length) {
1497 pr_err("SPC-3 PR: Illegal tpdl: %u + 28 byte header"
1498 " does not equal CDB data_length: %u\n", tpdl,
1499 cmd->data_length);
1500 ret = TCM_INVALID_PARAMETER_LIST;
1501 goto out_unmap;
1504 * Start processing the received transport IDs using the
1505 * receiving I_T Nexus portal's fabric dependent methods to
1506 * obtain the SCSI Initiator Port/Device Identifiers.
1508 ptr = &buf[28];
1510 while (tpdl > 0) {
1511 proto_ident = (ptr[0] & 0x0f);
1512 dest_tpg = NULL;
1514 spin_lock(&dev->se_port_lock);
1515 list_for_each_entry(tmp_port, &dev->dev_sep_list, sep_list) {
1516 tmp_tpg = tmp_port->sep_tpg;
1517 if (!tmp_tpg)
1518 continue;
1519 tmp_tf_ops = tmp_tpg->se_tpg_tfo;
1520 if (!tmp_tf_ops)
1521 continue;
1522 if (!tmp_tf_ops->get_fabric_proto_ident ||
1523 !tmp_tf_ops->tpg_parse_pr_out_transport_id)
1524 continue;
1526 * Look for the matching proto_ident provided by
1527 * the received TransportID
1529 tmp_proto_ident = tmp_tf_ops->get_fabric_proto_ident(tmp_tpg);
1530 if (tmp_proto_ident != proto_ident)
1531 continue;
1532 dest_rtpi = tmp_port->sep_rtpi;
1534 i_str = tmp_tf_ops->tpg_parse_pr_out_transport_id(
1535 tmp_tpg, (const char *)ptr, &tid_len,
1536 &iport_ptr);
1537 if (!i_str)
1538 continue;
1540 atomic_inc_mb(&tmp_tpg->tpg_pr_ref_count);
1541 spin_unlock(&dev->se_port_lock);
1543 if (core_scsi3_tpg_depend_item(tmp_tpg)) {
1544 pr_err(" core_scsi3_tpg_depend_item()"
1545 " for tmp_tpg\n");
1546 atomic_dec_mb(&tmp_tpg->tpg_pr_ref_count);
1547 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1548 goto out_unmap;
1551 * Locate the destination initiator ACL to be registered
1552 * from the decoded fabric module specific TransportID
1553 * at *i_str.
1555 spin_lock_irq(&tmp_tpg->acl_node_lock);
1556 dest_node_acl = __core_tpg_get_initiator_node_acl(
1557 tmp_tpg, i_str);
1558 if (dest_node_acl)
1559 atomic_inc_mb(&dest_node_acl->acl_pr_ref_count);
1560 spin_unlock_irq(&tmp_tpg->acl_node_lock);
1562 if (!dest_node_acl) {
1563 core_scsi3_tpg_undepend_item(tmp_tpg);
1564 spin_lock(&dev->se_port_lock);
1565 continue;
1568 if (core_scsi3_nodeacl_depend_item(dest_node_acl)) {
1569 pr_err("configfs_depend_item() failed"
1570 " for dest_node_acl->acl_group\n");
1571 atomic_dec_mb(&dest_node_acl->acl_pr_ref_count);
1572 core_scsi3_tpg_undepend_item(tmp_tpg);
1573 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1574 goto out_unmap;
1577 dest_tpg = tmp_tpg;
1578 pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node:"
1579 " %s Port RTPI: %hu\n",
1580 dest_tpg->se_tpg_tfo->get_fabric_name(),
1581 dest_node_acl->initiatorname, dest_rtpi);
1583 spin_lock(&dev->se_port_lock);
1584 break;
1586 spin_unlock(&dev->se_port_lock);
1588 if (!dest_tpg) {
1589 pr_err("SPC-3 PR SPEC_I_PT: Unable to locate"
1590 " dest_tpg\n");
1591 ret = TCM_INVALID_PARAMETER_LIST;
1592 goto out_unmap;
1595 pr_debug("SPC-3 PR SPEC_I_PT: Got %s data_length: %u tpdl: %u"
1596 " tid_len: %d for %s + %s\n",
1597 dest_tpg->se_tpg_tfo->get_fabric_name(), cmd->data_length,
1598 tpdl, tid_len, i_str, iport_ptr);
1600 if (tid_len > tpdl) {
1601 pr_err("SPC-3 PR SPEC_I_PT: Illegal tid_len:"
1602 " %u for Transport ID: %s\n", tid_len, ptr);
1603 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1604 core_scsi3_tpg_undepend_item(dest_tpg);
1605 ret = TCM_INVALID_PARAMETER_LIST;
1606 goto out_unmap;
1609 * Locate the desintation struct se_dev_entry pointer for matching
1610 * RELATIVE TARGET PORT IDENTIFIER on the receiving I_T Nexus
1611 * Target Port.
1613 dest_se_deve = core_get_se_deve_from_rtpi(dest_node_acl,
1614 dest_rtpi);
1615 if (!dest_se_deve) {
1616 pr_err("Unable to locate %s dest_se_deve"
1617 " from destination RTPI: %hu\n",
1618 dest_tpg->se_tpg_tfo->get_fabric_name(),
1619 dest_rtpi);
1621 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1622 core_scsi3_tpg_undepend_item(dest_tpg);
1623 ret = TCM_INVALID_PARAMETER_LIST;
1624 goto out_unmap;
1627 if (core_scsi3_lunacl_depend_item(dest_se_deve)) {
1628 pr_err("core_scsi3_lunacl_depend_item()"
1629 " failed\n");
1630 atomic_dec_mb(&dest_se_deve->pr_ref_count);
1631 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1632 core_scsi3_tpg_undepend_item(dest_tpg);
1633 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1634 goto out_unmap;
1637 pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node: %s"
1638 " dest_se_deve mapped_lun: %u\n",
1639 dest_tpg->se_tpg_tfo->get_fabric_name(),
1640 dest_node_acl->initiatorname, dest_se_deve->mapped_lun);
1643 * Skip any TransportIDs that already have a registration for
1644 * this target port.
1646 pr_reg_e = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
1647 iport_ptr);
1648 if (pr_reg_e) {
1649 core_scsi3_put_pr_reg(pr_reg_e);
1650 core_scsi3_lunacl_undepend_item(dest_se_deve);
1651 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1652 core_scsi3_tpg_undepend_item(dest_tpg);
1653 ptr += tid_len;
1654 tpdl -= tid_len;
1655 tid_len = 0;
1656 continue;
1659 * Allocate a struct pr_transport_id_holder and setup
1660 * the dest_node_acl and dest_se_deve pointers for the
1661 * loop below.
1663 tidh_new = kzalloc(sizeof(struct pr_transport_id_holder),
1664 GFP_KERNEL);
1665 if (!tidh_new) {
1666 pr_err("Unable to allocate tidh_new\n");
1667 core_scsi3_lunacl_undepend_item(dest_se_deve);
1668 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1669 core_scsi3_tpg_undepend_item(dest_tpg);
1670 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1671 goto out_unmap;
1673 INIT_LIST_HEAD(&tidh_new->dest_list);
1674 tidh_new->dest_tpg = dest_tpg;
1675 tidh_new->dest_node_acl = dest_node_acl;
1676 tidh_new->dest_se_deve = dest_se_deve;
1679 * Allocate, but do NOT add the registration for the
1680 * TransportID referenced SCSI Initiator port. This
1681 * done because of the following from spc4r17 in section
1682 * 6.14.3 wrt SPEC_I_PT:
1684 * "If a registration fails for any initiator port (e.g., if th
1685 * logical unit does not have enough resources available to
1686 * hold the registration information), no registrations shall be
1687 * made, and the command shall be terminated with
1688 * CHECK CONDITION status."
1690 * That means we call __core_scsi3_alloc_registration() here,
1691 * and then call __core_scsi3_add_registration() in the
1692 * 2nd loop which will never fail.
1694 dest_pr_reg = __core_scsi3_alloc_registration(cmd->se_dev,
1695 dest_node_acl, dest_se_deve, iport_ptr,
1696 sa_res_key, all_tg_pt, aptpl);
1697 if (!dest_pr_reg) {
1698 core_scsi3_lunacl_undepend_item(dest_se_deve);
1699 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1700 core_scsi3_tpg_undepend_item(dest_tpg);
1701 kfree(tidh_new);
1702 ret = TCM_INVALID_PARAMETER_LIST;
1703 goto out_unmap;
1705 tidh_new->dest_pr_reg = dest_pr_reg;
1706 list_add_tail(&tidh_new->dest_list, &tid_dest_list);
1708 ptr += tid_len;
1709 tpdl -= tid_len;
1710 tid_len = 0;
1714 transport_kunmap_data_sg(cmd);
1717 * Go ahead and create a registrations from tid_dest_list for the
1718 * SPEC_I_PT provided TransportID for the *tidh referenced dest_node_acl
1719 * and dest_se_deve.
1721 * The SA Reservation Key from the PROUT is set for the
1722 * registration, and ALL_TG_PT is also passed. ALL_TG_PT=1
1723 * means that the TransportID Initiator port will be
1724 * registered on all of the target ports in the SCSI target device
1725 * ALL_TG_PT=0 means the registration will only be for the
1726 * SCSI target port the PROUT REGISTER with SPEC_I_PT=1
1727 * was received.
1729 list_for_each_entry_safe(tidh, tidh_tmp, &tid_dest_list, dest_list) {
1730 dest_tpg = tidh->dest_tpg;
1731 dest_node_acl = tidh->dest_node_acl;
1732 dest_se_deve = tidh->dest_se_deve;
1733 dest_pr_reg = tidh->dest_pr_reg;
1734 dest_local_nexus = tidh->dest_local_nexus;
1736 list_del(&tidh->dest_list);
1737 kfree(tidh);
1739 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
1740 core_pr_dump_initiator_port(dest_pr_reg, i_buf, PR_REG_ISID_ID_LEN);
1742 __core_scsi3_add_registration(cmd->se_dev, dest_node_acl,
1743 dest_pr_reg, 0, 0);
1745 pr_debug("SPC-3 PR [%s] SPEC_I_PT: Successfully"
1746 " registered Transport ID for Node: %s%s Mapped LUN:"
1747 " %u\n", dest_tpg->se_tpg_tfo->get_fabric_name(),
1748 dest_node_acl->initiatorname, i_buf, dest_se_deve->mapped_lun);
1750 if (dest_local_nexus)
1751 continue;
1753 core_scsi3_lunacl_undepend_item(dest_se_deve);
1754 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1755 core_scsi3_tpg_undepend_item(dest_tpg);
1758 return 0;
1759 out_unmap:
1760 transport_kunmap_data_sg(cmd);
1761 out:
1763 * For the failure case, release everything from tid_dest_list
1764 * including *dest_pr_reg and the configfs dependances..
1766 list_for_each_entry_safe(tidh, tidh_tmp, &tid_dest_list, dest_list) {
1767 dest_tpg = tidh->dest_tpg;
1768 dest_node_acl = tidh->dest_node_acl;
1769 dest_se_deve = tidh->dest_se_deve;
1770 dest_pr_reg = tidh->dest_pr_reg;
1771 dest_local_nexus = tidh->dest_local_nexus;
1773 list_del(&tidh->dest_list);
1774 kfree(tidh);
1776 * Release any extra ALL_TG_PT=1 registrations for
1777 * the SPEC_I_PT=1 case.
1779 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
1780 &dest_pr_reg->pr_reg_atp_list,
1781 pr_reg_atp_mem_list) {
1782 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
1783 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
1784 kmem_cache_free(t10_pr_reg_cache, pr_reg_tmp);
1787 kmem_cache_free(t10_pr_reg_cache, dest_pr_reg);
1789 if (dest_local_nexus)
1790 continue;
1792 core_scsi3_lunacl_undepend_item(dest_se_deve);
1793 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1794 core_scsi3_tpg_undepend_item(dest_tpg);
1796 return ret;
1799 static int core_scsi3_update_aptpl_buf(
1800 struct se_device *dev,
1801 unsigned char *buf,
1802 u32 pr_aptpl_buf_len)
1804 struct se_lun *lun;
1805 struct se_portal_group *tpg;
1806 struct t10_pr_registration *pr_reg;
1807 unsigned char tmp[512], isid_buf[32];
1808 ssize_t len = 0;
1809 int reg_count = 0;
1810 int ret = 0;
1812 spin_lock(&dev->dev_reservation_lock);
1813 spin_lock(&dev->t10_pr.registration_lock);
1815 * Walk the registration list..
1817 list_for_each_entry(pr_reg, &dev->t10_pr.registration_list,
1818 pr_reg_list) {
1820 tmp[0] = '\0';
1821 isid_buf[0] = '\0';
1822 tpg = pr_reg->pr_reg_nacl->se_tpg;
1823 lun = pr_reg->pr_reg_tg_pt_lun;
1825 * Write out any ISID value to APTPL metadata that was included
1826 * in the original registration.
1828 if (pr_reg->isid_present_at_reg)
1829 snprintf(isid_buf, 32, "initiator_sid=%s\n",
1830 pr_reg->pr_reg_isid);
1832 * Include special metadata if the pr_reg matches the
1833 * reservation holder.
1835 if (dev->dev_pr_res_holder == pr_reg) {
1836 snprintf(tmp, 512, "PR_REG_START: %d"
1837 "\ninitiator_fabric=%s\n"
1838 "initiator_node=%s\n%s"
1839 "sa_res_key=%llu\n"
1840 "res_holder=1\nres_type=%02x\n"
1841 "res_scope=%02x\nres_all_tg_pt=%d\n"
1842 "mapped_lun=%u\n", reg_count,
1843 tpg->se_tpg_tfo->get_fabric_name(),
1844 pr_reg->pr_reg_nacl->initiatorname, isid_buf,
1845 pr_reg->pr_res_key, pr_reg->pr_res_type,
1846 pr_reg->pr_res_scope, pr_reg->pr_reg_all_tg_pt,
1847 pr_reg->pr_res_mapped_lun);
1848 } else {
1849 snprintf(tmp, 512, "PR_REG_START: %d\n"
1850 "initiator_fabric=%s\ninitiator_node=%s\n%s"
1851 "sa_res_key=%llu\nres_holder=0\n"
1852 "res_all_tg_pt=%d\nmapped_lun=%u\n",
1853 reg_count, tpg->se_tpg_tfo->get_fabric_name(),
1854 pr_reg->pr_reg_nacl->initiatorname, isid_buf,
1855 pr_reg->pr_res_key, pr_reg->pr_reg_all_tg_pt,
1856 pr_reg->pr_res_mapped_lun);
1859 if ((len + strlen(tmp) >= pr_aptpl_buf_len)) {
1860 pr_err("Unable to update renaming APTPL metadata,"
1861 " reallocating larger buffer\n");
1862 ret = -EMSGSIZE;
1863 goto out;
1865 len += sprintf(buf+len, "%s", tmp);
1868 * Include information about the associated SCSI target port.
1870 snprintf(tmp, 512, "target_fabric=%s\ntarget_node=%s\n"
1871 "tpgt=%hu\nport_rtpi=%hu\ntarget_lun=%u\nPR_REG_END:"
1872 " %d\n", tpg->se_tpg_tfo->get_fabric_name(),
1873 tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1874 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1875 lun->lun_sep->sep_rtpi, lun->unpacked_lun, reg_count);
1877 if ((len + strlen(tmp) >= pr_aptpl_buf_len)) {
1878 pr_err("Unable to update renaming APTPL metadata,"
1879 " reallocating larger buffer\n");
1880 ret = -EMSGSIZE;
1881 goto out;
1883 len += sprintf(buf+len, "%s", tmp);
1884 reg_count++;
1887 if (!reg_count)
1888 len += sprintf(buf+len, "No Registrations or Reservations");
1890 out:
1891 spin_unlock(&dev->t10_pr.registration_lock);
1892 spin_unlock(&dev->dev_reservation_lock);
1894 return ret;
1897 static int __core_scsi3_write_aptpl_to_file(
1898 struct se_device *dev,
1899 unsigned char *buf)
1901 struct t10_wwn *wwn = &dev->t10_wwn;
1902 struct file *file;
1903 int flags = O_RDWR | O_CREAT | O_TRUNC;
1904 char path[512];
1905 u32 pr_aptpl_buf_len;
1906 int ret;
1908 memset(path, 0, 512);
1910 if (strlen(&wwn->unit_serial[0]) >= 512) {
1911 pr_err("WWN value for struct se_device does not fit"
1912 " into path buffer\n");
1913 return -EMSGSIZE;
1916 snprintf(path, 512, "/var/target/pr/aptpl_%s", &wwn->unit_serial[0]);
1917 file = filp_open(path, flags, 0600);
1918 if (IS_ERR(file)) {
1919 pr_err("filp_open(%s) for APTPL metadata"
1920 " failed\n", path);
1921 return PTR_ERR(file);
1924 pr_aptpl_buf_len = (strlen(buf) + 1); /* Add extra for NULL */
1926 ret = kernel_write(file, buf, pr_aptpl_buf_len, 0);
1928 if (ret < 0)
1929 pr_debug("Error writing APTPL metadata file: %s\n", path);
1930 fput(file);
1932 return (ret < 0) ? -EIO : 0;
1936 * Clear the APTPL metadata if APTPL has been disabled, otherwise
1937 * write out the updated metadata to struct file for this SCSI device.
1939 static sense_reason_t core_scsi3_update_and_write_aptpl(struct se_device *dev, bool aptpl)
1941 unsigned char *buf;
1942 int rc, len = PR_APTPL_BUF_LEN;
1944 if (!aptpl) {
1945 char *null_buf = "No Registrations or Reservations\n";
1947 rc = __core_scsi3_write_aptpl_to_file(dev, null_buf);
1948 dev->t10_pr.pr_aptpl_active = 0;
1949 pr_debug("SPC-3 PR: Set APTPL Bit Deactivated\n");
1951 if (rc)
1952 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1954 return 0;
1956 retry:
1957 buf = vzalloc(len);
1958 if (!buf)
1959 return TCM_OUT_OF_RESOURCES;
1961 rc = core_scsi3_update_aptpl_buf(dev, buf, len);
1962 if (rc < 0) {
1963 vfree(buf);
1964 len *= 2;
1965 goto retry;
1968 rc = __core_scsi3_write_aptpl_to_file(dev, buf);
1969 if (rc != 0) {
1970 pr_err("SPC-3 PR: Could not update APTPL\n");
1971 vfree(buf);
1972 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1974 dev->t10_pr.pr_aptpl_active = 1;
1975 vfree(buf);
1976 pr_debug("SPC-3 PR: Set APTPL Bit Activated\n");
1977 return 0;
1980 static sense_reason_t
1981 core_scsi3_emulate_pro_register(struct se_cmd *cmd, u64 res_key, u64 sa_res_key,
1982 bool aptpl, bool all_tg_pt, bool spec_i_pt, enum register_type register_type)
1984 struct se_session *se_sess = cmd->se_sess;
1985 struct se_device *dev = cmd->se_dev;
1986 struct se_dev_entry *se_deve;
1987 struct se_lun *se_lun = cmd->se_lun;
1988 struct se_portal_group *se_tpg;
1989 struct t10_pr_registration *pr_reg, *pr_reg_p, *pr_reg_tmp;
1990 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1991 unsigned char isid_buf[PR_REG_ISID_LEN], *isid_ptr = NULL;
1992 sense_reason_t ret = TCM_NO_SENSE;
1993 int pr_holder = 0, type;
1995 if (!se_sess || !se_lun) {
1996 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
1997 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1999 se_tpg = se_sess->se_tpg;
2000 se_deve = se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
2002 if (se_tpg->se_tpg_tfo->sess_get_initiator_sid) {
2003 memset(&isid_buf[0], 0, PR_REG_ISID_LEN);
2004 se_tpg->se_tpg_tfo->sess_get_initiator_sid(se_sess, &isid_buf[0],
2005 PR_REG_ISID_LEN);
2006 isid_ptr = &isid_buf[0];
2009 * Follow logic from spc4r17 Section 5.7.7, Register Behaviors Table 47
2011 pr_reg = core_scsi3_locate_pr_reg(dev, se_sess->se_node_acl, se_sess);
2012 if (!pr_reg) {
2013 if (res_key) {
2014 pr_warn("SPC-3 PR: Reservation Key non-zero"
2015 " for SA REGISTER, returning CONFLICT\n");
2016 return TCM_RESERVATION_CONFLICT;
2019 * Do nothing but return GOOD status.
2021 if (!sa_res_key)
2022 return 0;
2024 if (!spec_i_pt) {
2026 * Perform the Service Action REGISTER on the Initiator
2027 * Port Endpoint that the PRO was received from on the
2028 * Logical Unit of the SCSI device server.
2030 if (core_scsi3_alloc_registration(cmd->se_dev,
2031 se_sess->se_node_acl, se_deve, isid_ptr,
2032 sa_res_key, all_tg_pt, aptpl,
2033 register_type, 0)) {
2034 pr_err("Unable to allocate"
2035 " struct t10_pr_registration\n");
2036 return TCM_INVALID_PARAMETER_LIST;
2038 } else {
2040 * Register both the Initiator port that received
2041 * PROUT SA REGISTER + SPEC_I_PT=1 and extract SCSI
2042 * TransportID from Parameter list and loop through
2043 * fabric dependent parameter list while calling
2044 * logic from of core_scsi3_alloc_registration() for
2045 * each TransportID provided SCSI Initiator Port/Device
2047 ret = core_scsi3_decode_spec_i_port(cmd, se_tpg,
2048 isid_ptr, sa_res_key, all_tg_pt, aptpl);
2049 if (ret != 0)
2050 return ret;
2053 return core_scsi3_update_and_write_aptpl(dev, aptpl);
2056 /* ok, existing registration */
2058 if ((register_type == REGISTER) && (res_key != pr_reg->pr_res_key)) {
2059 pr_err("SPC-3 PR REGISTER: Received"
2060 " res_key: 0x%016Lx does not match"
2061 " existing SA REGISTER res_key:"
2062 " 0x%016Lx\n", res_key,
2063 pr_reg->pr_res_key);
2064 ret = TCM_RESERVATION_CONFLICT;
2065 goto out;
2068 if (spec_i_pt) {
2069 pr_err("SPC-3 PR REGISTER: SPEC_I_PT"
2070 " set on a registered nexus\n");
2071 ret = TCM_INVALID_PARAMETER_LIST;
2072 goto out;
2076 * An existing ALL_TG_PT=1 registration being released
2077 * must also set ALL_TG_PT=1 in the incoming PROUT.
2079 if (pr_reg->pr_reg_all_tg_pt && !all_tg_pt) {
2080 pr_err("SPC-3 PR REGISTER: ALL_TG_PT=1"
2081 " registration exists, but ALL_TG_PT=1 bit not"
2082 " present in received PROUT\n");
2083 ret = TCM_INVALID_CDB_FIELD;
2084 goto out;
2088 * sa_res_key=1 Change Reservation Key for registered I_T Nexus.
2090 if (sa_res_key) {
2092 * Increment PRgeneration counter for struct se_device"
2093 * upon a successful REGISTER, see spc4r17 section 6.3.2
2094 * READ_KEYS service action.
2096 pr_reg->pr_res_generation = core_scsi3_pr_generation(cmd->se_dev);
2097 pr_reg->pr_res_key = sa_res_key;
2098 pr_debug("SPC-3 PR [%s] REGISTER%s: Changed Reservation"
2099 " Key for %s to: 0x%016Lx PRgeneration:"
2100 " 0x%08x\n", cmd->se_tfo->get_fabric_name(),
2101 (register_type == REGISTER_AND_IGNORE_EXISTING_KEY) ? "_AND_IGNORE_EXISTING_KEY" : "",
2102 pr_reg->pr_reg_nacl->initiatorname,
2103 pr_reg->pr_res_key, pr_reg->pr_res_generation);
2105 } else {
2107 * sa_res_key=0 Unregister Reservation Key for registered I_T Nexus.
2109 pr_holder = core_scsi3_check_implicit_release(
2110 cmd->se_dev, pr_reg);
2111 if (pr_holder < 0) {
2112 ret = TCM_RESERVATION_CONFLICT;
2113 goto out;
2115 type = pr_reg->pr_res_type;
2117 spin_lock(&pr_tmpl->registration_lock);
2119 * Release all ALL_TG_PT=1 for the matching SCSI Initiator Port
2120 * and matching pr_res_key.
2122 if (pr_reg->pr_reg_all_tg_pt) {
2123 list_for_each_entry_safe(pr_reg_p, pr_reg_tmp,
2124 &pr_tmpl->registration_list,
2125 pr_reg_list) {
2127 if (!pr_reg_p->pr_reg_all_tg_pt)
2128 continue;
2129 if (pr_reg_p->pr_res_key != res_key)
2130 continue;
2131 if (pr_reg == pr_reg_p)
2132 continue;
2133 if (strcmp(pr_reg->pr_reg_nacl->initiatorname,
2134 pr_reg_p->pr_reg_nacl->initiatorname))
2135 continue;
2137 __core_scsi3_free_registration(dev,
2138 pr_reg_p, NULL, 0);
2143 * Release the calling I_T Nexus registration now..
2145 __core_scsi3_free_registration(cmd->se_dev, pr_reg, NULL, 1);
2146 pr_reg = NULL;
2149 * From spc4r17, section 5.7.11.3 Unregistering
2151 * If the persistent reservation is a registrants only
2152 * type, the device server shall establish a unit
2153 * attention condition for the initiator port associated
2154 * with every registered I_T nexus except for the I_T
2155 * nexus on which the PERSISTENT RESERVE OUT command was
2156 * received, with the additional sense code set to
2157 * RESERVATIONS RELEASED.
2159 if (pr_holder &&
2160 (type == PR_TYPE_WRITE_EXCLUSIVE_REGONLY ||
2161 type == PR_TYPE_EXCLUSIVE_ACCESS_REGONLY)) {
2162 list_for_each_entry(pr_reg_p,
2163 &pr_tmpl->registration_list,
2164 pr_reg_list) {
2166 core_scsi3_ua_allocate(
2167 pr_reg_p->pr_reg_nacl,
2168 pr_reg_p->pr_res_mapped_lun,
2169 0x2A,
2170 ASCQ_2AH_RESERVATIONS_RELEASED);
2174 spin_unlock(&pr_tmpl->registration_lock);
2177 ret = core_scsi3_update_and_write_aptpl(dev, aptpl);
2179 out:
2180 if (pr_reg)
2181 core_scsi3_put_pr_reg(pr_reg);
2182 return ret;
2185 unsigned char *core_scsi3_pr_dump_type(int type)
2187 switch (type) {
2188 case PR_TYPE_WRITE_EXCLUSIVE:
2189 return "Write Exclusive Access";
2190 case PR_TYPE_EXCLUSIVE_ACCESS:
2191 return "Exclusive Access";
2192 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
2193 return "Write Exclusive Access, Registrants Only";
2194 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
2195 return "Exclusive Access, Registrants Only";
2196 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
2197 return "Write Exclusive Access, All Registrants";
2198 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
2199 return "Exclusive Access, All Registrants";
2200 default:
2201 break;
2204 return "Unknown SPC-3 PR Type";
2207 static sense_reason_t
2208 core_scsi3_pro_reserve(struct se_cmd *cmd, int type, int scope, u64 res_key)
2210 struct se_device *dev = cmd->se_dev;
2211 struct se_session *se_sess = cmd->se_sess;
2212 struct se_lun *se_lun = cmd->se_lun;
2213 struct t10_pr_registration *pr_reg, *pr_res_holder;
2214 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2215 char i_buf[PR_REG_ISID_ID_LEN];
2216 sense_reason_t ret;
2218 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2220 if (!se_sess || !se_lun) {
2221 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2222 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2225 * Locate the existing *pr_reg via struct se_node_acl pointers
2227 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
2228 se_sess);
2229 if (!pr_reg) {
2230 pr_err("SPC-3 PR: Unable to locate"
2231 " PR_REGISTERED *pr_reg for RESERVE\n");
2232 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2235 * From spc4r17 Section 5.7.9: Reserving:
2237 * An application client creates a persistent reservation by issuing
2238 * a PERSISTENT RESERVE OUT command with RESERVE service action through
2239 * a registered I_T nexus with the following parameters:
2240 * a) RESERVATION KEY set to the value of the reservation key that is
2241 * registered with the logical unit for the I_T nexus; and
2243 if (res_key != pr_reg->pr_res_key) {
2244 pr_err("SPC-3 PR RESERVE: Received res_key: 0x%016Lx"
2245 " does not match existing SA REGISTER res_key:"
2246 " 0x%016Lx\n", res_key, pr_reg->pr_res_key);
2247 ret = TCM_RESERVATION_CONFLICT;
2248 goto out_put_pr_reg;
2251 * From spc4r17 Section 5.7.9: Reserving:
2253 * From above:
2254 * b) TYPE field and SCOPE field set to the persistent reservation
2255 * being created.
2257 * Only one persistent reservation is allowed at a time per logical unit
2258 * and that persistent reservation has a scope of LU_SCOPE.
2260 if (scope != PR_SCOPE_LU_SCOPE) {
2261 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope);
2262 ret = TCM_INVALID_PARAMETER_LIST;
2263 goto out_put_pr_reg;
2266 * See if we have an existing PR reservation holder pointer at
2267 * struct se_device->dev_pr_res_holder in the form struct t10_pr_registration
2268 * *pr_res_holder.
2270 spin_lock(&dev->dev_reservation_lock);
2271 pr_res_holder = dev->dev_pr_res_holder;
2272 if (pr_res_holder) {
2274 * From spc4r17 Section 5.7.9: Reserving:
2276 * If the device server receives a PERSISTENT RESERVE OUT
2277 * command from an I_T nexus other than a persistent reservation
2278 * holder (see 5.7.10) that attempts to create a persistent
2279 * reservation when a persistent reservation already exists for
2280 * the logical unit, then the command shall be completed with
2281 * RESERVATION CONFLICT status.
2283 if (pr_res_holder != pr_reg) {
2284 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2285 pr_err("SPC-3 PR: Attempted RESERVE from"
2286 " [%s]: %s while reservation already held by"
2287 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2288 cmd->se_tfo->get_fabric_name(),
2289 se_sess->se_node_acl->initiatorname,
2290 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2291 pr_res_holder->pr_reg_nacl->initiatorname);
2293 spin_unlock(&dev->dev_reservation_lock);
2294 ret = TCM_RESERVATION_CONFLICT;
2295 goto out_put_pr_reg;
2298 * From spc4r17 Section 5.7.9: Reserving:
2300 * If a persistent reservation holder attempts to modify the
2301 * type or scope of an existing persistent reservation, the
2302 * command shall be completed with RESERVATION CONFLICT status.
2304 if ((pr_res_holder->pr_res_type != type) ||
2305 (pr_res_holder->pr_res_scope != scope)) {
2306 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2307 pr_err("SPC-3 PR: Attempted RESERVE from"
2308 " [%s]: %s trying to change TYPE and/or SCOPE,"
2309 " while reservation already held by [%s]: %s,"
2310 " returning RESERVATION_CONFLICT\n",
2311 cmd->se_tfo->get_fabric_name(),
2312 se_sess->se_node_acl->initiatorname,
2313 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2314 pr_res_holder->pr_reg_nacl->initiatorname);
2316 spin_unlock(&dev->dev_reservation_lock);
2317 ret = TCM_RESERVATION_CONFLICT;
2318 goto out_put_pr_reg;
2321 * From spc4r17 Section 5.7.9: Reserving:
2323 * If the device server receives a PERSISTENT RESERVE OUT
2324 * command with RESERVE service action where the TYPE field and
2325 * the SCOPE field contain the same values as the existing type
2326 * and scope from a persistent reservation holder, it shall not
2327 * make any change to the existing persistent reservation and
2328 * shall completethe command with GOOD status.
2330 spin_unlock(&dev->dev_reservation_lock);
2331 ret = 0;
2332 goto out_put_pr_reg;
2335 * Otherwise, our *pr_reg becomes the PR reservation holder for said
2336 * TYPE/SCOPE. Also set the received scope and type in *pr_reg.
2338 pr_reg->pr_res_scope = scope;
2339 pr_reg->pr_res_type = type;
2340 pr_reg->pr_res_holder = 1;
2341 dev->dev_pr_res_holder = pr_reg;
2342 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2344 pr_debug("SPC-3 PR [%s] Service Action: RESERVE created new"
2345 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2346 cmd->se_tfo->get_fabric_name(), core_scsi3_pr_dump_type(type),
2347 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2348 pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
2349 cmd->se_tfo->get_fabric_name(),
2350 se_sess->se_node_acl->initiatorname,
2351 i_buf);
2352 spin_unlock(&dev->dev_reservation_lock);
2354 if (pr_tmpl->pr_aptpl_active)
2355 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
2357 ret = 0;
2358 out_put_pr_reg:
2359 core_scsi3_put_pr_reg(pr_reg);
2360 return ret;
2363 static sense_reason_t
2364 core_scsi3_emulate_pro_reserve(struct se_cmd *cmd, int type, int scope,
2365 u64 res_key)
2367 switch (type) {
2368 case PR_TYPE_WRITE_EXCLUSIVE:
2369 case PR_TYPE_EXCLUSIVE_ACCESS:
2370 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
2371 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
2372 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
2373 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
2374 return core_scsi3_pro_reserve(cmd, type, scope, res_key);
2375 default:
2376 pr_err("SPC-3 PR: Unknown Service Action RESERVE Type:"
2377 " 0x%02x\n", type);
2378 return TCM_INVALID_CDB_FIELD;
2383 * Called with struct se_device->dev_reservation_lock held.
2385 static void __core_scsi3_complete_pro_release(
2386 struct se_device *dev,
2387 struct se_node_acl *se_nacl,
2388 struct t10_pr_registration *pr_reg,
2389 int explicit)
2391 struct target_core_fabric_ops *tfo = se_nacl->se_tpg->se_tpg_tfo;
2392 char i_buf[PR_REG_ISID_ID_LEN];
2394 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2395 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2397 * Go ahead and release the current PR reservation holder.
2399 dev->dev_pr_res_holder = NULL;
2401 pr_debug("SPC-3 PR [%s] Service Action: %s RELEASE cleared"
2402 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2403 tfo->get_fabric_name(), (explicit) ? "explicit" : "implicit",
2404 core_scsi3_pr_dump_type(pr_reg->pr_res_type),
2405 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2406 pr_debug("SPC-3 PR [%s] RELEASE Node: %s%s\n",
2407 tfo->get_fabric_name(), se_nacl->initiatorname,
2408 i_buf);
2410 * Clear TYPE and SCOPE for the next PROUT Service Action: RESERVE
2412 pr_reg->pr_res_holder = pr_reg->pr_res_type = pr_reg->pr_res_scope = 0;
2415 static sense_reason_t
2416 core_scsi3_emulate_pro_release(struct se_cmd *cmd, int type, int scope,
2417 u64 res_key)
2419 struct se_device *dev = cmd->se_dev;
2420 struct se_session *se_sess = cmd->se_sess;
2421 struct se_lun *se_lun = cmd->se_lun;
2422 struct t10_pr_registration *pr_reg, *pr_reg_p, *pr_res_holder;
2423 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2424 int all_reg = 0;
2425 sense_reason_t ret = 0;
2427 if (!se_sess || !se_lun) {
2428 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2429 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2432 * Locate the existing *pr_reg via struct se_node_acl pointers
2434 pr_reg = core_scsi3_locate_pr_reg(dev, se_sess->se_node_acl, se_sess);
2435 if (!pr_reg) {
2436 pr_err("SPC-3 PR: Unable to locate"
2437 " PR_REGISTERED *pr_reg for RELEASE\n");
2438 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2441 * From spc4r17 Section 5.7.11.2 Releasing:
2443 * If there is no persistent reservation or in response to a persistent
2444 * reservation release request from a registered I_T nexus that is not a
2445 * persistent reservation holder (see 5.7.10), the device server shall
2446 * do the following:
2448 * a) Not release the persistent reservation, if any;
2449 * b) Not remove any registrations; and
2450 * c) Complete the command with GOOD status.
2452 spin_lock(&dev->dev_reservation_lock);
2453 pr_res_holder = dev->dev_pr_res_holder;
2454 if (!pr_res_holder) {
2456 * No persistent reservation, return GOOD status.
2458 spin_unlock(&dev->dev_reservation_lock);
2459 goto out_put_pr_reg;
2461 if ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2462 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))
2463 all_reg = 1;
2465 if ((all_reg == 0) && (pr_res_holder != pr_reg)) {
2467 * Non 'All Registrants' PR Type cases..
2468 * Release request from a registered I_T nexus that is not a
2469 * persistent reservation holder. return GOOD status.
2471 spin_unlock(&dev->dev_reservation_lock);
2472 goto out_put_pr_reg;
2476 * From spc4r17 Section 5.7.11.2 Releasing:
2478 * Only the persistent reservation holder (see 5.7.10) is allowed to
2479 * release a persistent reservation.
2481 * An application client releases the persistent reservation by issuing
2482 * a PERSISTENT RESERVE OUT command with RELEASE service action through
2483 * an I_T nexus that is a persistent reservation holder with the
2484 * following parameters:
2486 * a) RESERVATION KEY field set to the value of the reservation key
2487 * that is registered with the logical unit for the I_T nexus;
2489 if (res_key != pr_reg->pr_res_key) {
2490 pr_err("SPC-3 PR RELEASE: Received res_key: 0x%016Lx"
2491 " does not match existing SA REGISTER res_key:"
2492 " 0x%016Lx\n", res_key, pr_reg->pr_res_key);
2493 spin_unlock(&dev->dev_reservation_lock);
2494 ret = TCM_RESERVATION_CONFLICT;
2495 goto out_put_pr_reg;
2498 * From spc4r17 Section 5.7.11.2 Releasing and above:
2500 * b) TYPE field and SCOPE field set to match the persistent
2501 * reservation being released.
2503 if ((pr_res_holder->pr_res_type != type) ||
2504 (pr_res_holder->pr_res_scope != scope)) {
2505 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2506 pr_err("SPC-3 PR RELEASE: Attempted to release"
2507 " reservation from [%s]: %s with different TYPE "
2508 "and/or SCOPE while reservation already held by"
2509 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2510 cmd->se_tfo->get_fabric_name(),
2511 se_sess->se_node_acl->initiatorname,
2512 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2513 pr_res_holder->pr_reg_nacl->initiatorname);
2515 spin_unlock(&dev->dev_reservation_lock);
2516 ret = TCM_RESERVATION_CONFLICT;
2517 goto out_put_pr_reg;
2520 * In response to a persistent reservation release request from the
2521 * persistent reservation holder the device server shall perform a
2522 * release by doing the following as an uninterrupted series of actions:
2523 * a) Release the persistent reservation;
2524 * b) Not remove any registration(s);
2525 * c) If the released persistent reservation is a registrants only type
2526 * or all registrants type persistent reservation,
2527 * the device server shall establish a unit attention condition for
2528 * the initiator port associated with every regis-
2529 * tered I_T nexus other than I_T nexus on which the PERSISTENT
2530 * RESERVE OUT command with RELEASE service action was received,
2531 * with the additional sense code set to RESERVATIONS RELEASED; and
2532 * d) If the persistent reservation is of any other type, the device
2533 * server shall not establish a unit attention condition.
2535 __core_scsi3_complete_pro_release(dev, se_sess->se_node_acl,
2536 pr_reg, 1);
2538 spin_unlock(&dev->dev_reservation_lock);
2540 if ((type != PR_TYPE_WRITE_EXCLUSIVE_REGONLY) &&
2541 (type != PR_TYPE_EXCLUSIVE_ACCESS_REGONLY) &&
2542 (type != PR_TYPE_WRITE_EXCLUSIVE_ALLREG) &&
2543 (type != PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
2545 * If no UNIT ATTENTION conditions will be established for
2546 * PR_TYPE_WRITE_EXCLUSIVE or PR_TYPE_EXCLUSIVE_ACCESS
2547 * go ahead and check for APTPL=1 update+write below
2549 goto write_aptpl;
2552 spin_lock(&pr_tmpl->registration_lock);
2553 list_for_each_entry(pr_reg_p, &pr_tmpl->registration_list,
2554 pr_reg_list) {
2556 * Do not establish a UNIT ATTENTION condition
2557 * for the calling I_T Nexus
2559 if (pr_reg_p == pr_reg)
2560 continue;
2562 core_scsi3_ua_allocate(pr_reg_p->pr_reg_nacl,
2563 pr_reg_p->pr_res_mapped_lun,
2564 0x2A, ASCQ_2AH_RESERVATIONS_RELEASED);
2566 spin_unlock(&pr_tmpl->registration_lock);
2568 write_aptpl:
2569 if (pr_tmpl->pr_aptpl_active)
2570 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
2572 out_put_pr_reg:
2573 core_scsi3_put_pr_reg(pr_reg);
2574 return ret;
2577 static sense_reason_t
2578 core_scsi3_emulate_pro_clear(struct se_cmd *cmd, u64 res_key)
2580 struct se_device *dev = cmd->se_dev;
2581 struct se_node_acl *pr_reg_nacl;
2582 struct se_session *se_sess = cmd->se_sess;
2583 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2584 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_reg_n, *pr_res_holder;
2585 u32 pr_res_mapped_lun = 0;
2586 int calling_it_nexus = 0;
2588 * Locate the existing *pr_reg via struct se_node_acl pointers
2590 pr_reg_n = core_scsi3_locate_pr_reg(cmd->se_dev,
2591 se_sess->se_node_acl, se_sess);
2592 if (!pr_reg_n) {
2593 pr_err("SPC-3 PR: Unable to locate"
2594 " PR_REGISTERED *pr_reg for CLEAR\n");
2595 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2598 * From spc4r17 section 5.7.11.6, Clearing:
2600 * Any application client may release the persistent reservation and
2601 * remove all registrations from a device server by issuing a
2602 * PERSISTENT RESERVE OUT command with CLEAR service action through a
2603 * registered I_T nexus with the following parameter:
2605 * a) RESERVATION KEY field set to the value of the reservation key
2606 * that is registered with the logical unit for the I_T nexus.
2608 if (res_key != pr_reg_n->pr_res_key) {
2609 pr_err("SPC-3 PR REGISTER: Received"
2610 " res_key: 0x%016Lx does not match"
2611 " existing SA REGISTER res_key:"
2612 " 0x%016Lx\n", res_key, pr_reg_n->pr_res_key);
2613 core_scsi3_put_pr_reg(pr_reg_n);
2614 return TCM_RESERVATION_CONFLICT;
2617 * a) Release the persistent reservation, if any;
2619 spin_lock(&dev->dev_reservation_lock);
2620 pr_res_holder = dev->dev_pr_res_holder;
2621 if (pr_res_holder) {
2622 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2623 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
2624 pr_res_holder, 0);
2626 spin_unlock(&dev->dev_reservation_lock);
2628 * b) Remove all registration(s) (see spc4r17 5.7.7);
2630 spin_lock(&pr_tmpl->registration_lock);
2631 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2632 &pr_tmpl->registration_list, pr_reg_list) {
2634 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2635 pr_reg_nacl = pr_reg->pr_reg_nacl;
2636 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2637 __core_scsi3_free_registration(dev, pr_reg, NULL,
2638 calling_it_nexus);
2640 * e) Establish a unit attention condition for the initiator
2641 * port associated with every registered I_T nexus other
2642 * than the I_T nexus on which the PERSISTENT RESERVE OUT
2643 * command with CLEAR service action was received, with the
2644 * additional sense code set to RESERVATIONS PREEMPTED.
2646 if (!calling_it_nexus)
2647 core_scsi3_ua_allocate(pr_reg_nacl, pr_res_mapped_lun,
2648 0x2A, ASCQ_2AH_RESERVATIONS_PREEMPTED);
2650 spin_unlock(&pr_tmpl->registration_lock);
2652 pr_debug("SPC-3 PR [%s] Service Action: CLEAR complete\n",
2653 cmd->se_tfo->get_fabric_name());
2655 core_scsi3_update_and_write_aptpl(cmd->se_dev, false);
2657 core_scsi3_pr_generation(dev);
2658 return 0;
2662 * Called with struct se_device->dev_reservation_lock held.
2664 static void __core_scsi3_complete_pro_preempt(
2665 struct se_device *dev,
2666 struct t10_pr_registration *pr_reg,
2667 struct list_head *preempt_and_abort_list,
2668 int type,
2669 int scope,
2670 enum preempt_type preempt_type)
2672 struct se_node_acl *nacl = pr_reg->pr_reg_nacl;
2673 struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
2674 char i_buf[PR_REG_ISID_ID_LEN];
2676 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2677 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2679 * Do an implicit RELEASE of the existing reservation.
2681 if (dev->dev_pr_res_holder)
2682 __core_scsi3_complete_pro_release(dev, nacl,
2683 dev->dev_pr_res_holder, 0);
2685 dev->dev_pr_res_holder = pr_reg;
2686 pr_reg->pr_res_holder = 1;
2687 pr_reg->pr_res_type = type;
2688 pr_reg->pr_res_scope = scope;
2690 pr_debug("SPC-3 PR [%s] Service Action: PREEMPT%s created new"
2691 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2692 tfo->get_fabric_name(), (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "",
2693 core_scsi3_pr_dump_type(type),
2694 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2695 pr_debug("SPC-3 PR [%s] PREEMPT%s from Node: %s%s\n",
2696 tfo->get_fabric_name(), (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "",
2697 nacl->initiatorname, i_buf);
2699 * For PREEMPT_AND_ABORT, add the preempting reservation's
2700 * struct t10_pr_registration to the list that will be compared
2701 * against received CDBs..
2703 if (preempt_and_abort_list)
2704 list_add_tail(&pr_reg->pr_reg_abort_list,
2705 preempt_and_abort_list);
2708 static void core_scsi3_release_preempt_and_abort(
2709 struct list_head *preempt_and_abort_list,
2710 struct t10_pr_registration *pr_reg_holder)
2712 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
2714 list_for_each_entry_safe(pr_reg, pr_reg_tmp, preempt_and_abort_list,
2715 pr_reg_abort_list) {
2717 list_del(&pr_reg->pr_reg_abort_list);
2718 if (pr_reg_holder == pr_reg)
2719 continue;
2720 if (pr_reg->pr_res_holder) {
2721 pr_warn("pr_reg->pr_res_holder still set\n");
2722 continue;
2725 pr_reg->pr_reg_deve = NULL;
2726 pr_reg->pr_reg_nacl = NULL;
2727 kmem_cache_free(t10_pr_reg_cache, pr_reg);
2731 static sense_reason_t
2732 core_scsi3_pro_preempt(struct se_cmd *cmd, int type, int scope, u64 res_key,
2733 u64 sa_res_key, enum preempt_type preempt_type)
2735 struct se_device *dev = cmd->se_dev;
2736 struct se_node_acl *pr_reg_nacl;
2737 struct se_session *se_sess = cmd->se_sess;
2738 LIST_HEAD(preempt_and_abort_list);
2739 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_reg_n, *pr_res_holder;
2740 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2741 u32 pr_res_mapped_lun = 0;
2742 int all_reg = 0, calling_it_nexus = 0;
2743 bool sa_res_key_unmatched = sa_res_key != 0;
2744 int prh_type = 0, prh_scope = 0;
2746 if (!se_sess)
2747 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2749 pr_reg_n = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
2750 se_sess);
2751 if (!pr_reg_n) {
2752 pr_err("SPC-3 PR: Unable to locate"
2753 " PR_REGISTERED *pr_reg for PREEMPT%s\n",
2754 (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "");
2755 return TCM_RESERVATION_CONFLICT;
2757 if (pr_reg_n->pr_res_key != res_key) {
2758 core_scsi3_put_pr_reg(pr_reg_n);
2759 return TCM_RESERVATION_CONFLICT;
2761 if (scope != PR_SCOPE_LU_SCOPE) {
2762 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope);
2763 core_scsi3_put_pr_reg(pr_reg_n);
2764 return TCM_INVALID_PARAMETER_LIST;
2767 spin_lock(&dev->dev_reservation_lock);
2768 pr_res_holder = dev->dev_pr_res_holder;
2769 if (pr_res_holder &&
2770 ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2771 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)))
2772 all_reg = 1;
2774 if (!all_reg && !sa_res_key) {
2775 spin_unlock(&dev->dev_reservation_lock);
2776 core_scsi3_put_pr_reg(pr_reg_n);
2777 return TCM_INVALID_PARAMETER_LIST;
2780 * From spc4r17, section 5.7.11.4.4 Removing Registrations:
2782 * If the SERVICE ACTION RESERVATION KEY field does not identify a
2783 * persistent reservation holder or there is no persistent reservation
2784 * holder (i.e., there is no persistent reservation), then the device
2785 * server shall perform a preempt by doing the following in an
2786 * uninterrupted series of actions. (See below..)
2788 if (!pr_res_holder || (pr_res_holder->pr_res_key != sa_res_key)) {
2790 * No existing or SA Reservation Key matching reservations..
2792 * PROUT SA PREEMPT with All Registrant type reservations are
2793 * allowed to be processed without a matching SA Reservation Key
2795 spin_lock(&pr_tmpl->registration_lock);
2796 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2797 &pr_tmpl->registration_list, pr_reg_list) {
2799 * Removing of registrations in non all registrants
2800 * type reservations without a matching SA reservation
2801 * key.
2803 * a) Remove the registrations for all I_T nexuses
2804 * specified by the SERVICE ACTION RESERVATION KEY
2805 * field;
2806 * b) Ignore the contents of the SCOPE and TYPE fields;
2807 * c) Process tasks as defined in 5.7.1; and
2808 * d) Establish a unit attention condition for the
2809 * initiator port associated with every I_T nexus
2810 * that lost its registration other than the I_T
2811 * nexus on which the PERSISTENT RESERVE OUT command
2812 * was received, with the additional sense code set
2813 * to REGISTRATIONS PREEMPTED.
2815 if (!all_reg) {
2816 if (pr_reg->pr_res_key != sa_res_key)
2817 continue;
2818 sa_res_key_unmatched = false;
2820 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2821 pr_reg_nacl = pr_reg->pr_reg_nacl;
2822 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2823 __core_scsi3_free_registration(dev, pr_reg,
2824 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list :
2825 NULL, calling_it_nexus);
2826 } else {
2828 * Case for any existing all registrants type
2829 * reservation, follow logic in spc4r17 section
2830 * 5.7.11.4 Preempting, Table 52 and Figure 7.
2832 * For a ZERO SA Reservation key, release
2833 * all other registrations and do an implicit
2834 * release of active persistent reservation.
2836 * For a non-ZERO SA Reservation key, only
2837 * release the matching reservation key from
2838 * registrations.
2840 if ((sa_res_key) &&
2841 (pr_reg->pr_res_key != sa_res_key))
2842 continue;
2843 sa_res_key_unmatched = false;
2845 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2846 if (calling_it_nexus)
2847 continue;
2849 pr_reg_nacl = pr_reg->pr_reg_nacl;
2850 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2851 __core_scsi3_free_registration(dev, pr_reg,
2852 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list :
2853 NULL, 0);
2855 if (!calling_it_nexus)
2856 core_scsi3_ua_allocate(pr_reg_nacl,
2857 pr_res_mapped_lun, 0x2A,
2858 ASCQ_2AH_REGISTRATIONS_PREEMPTED);
2860 spin_unlock(&pr_tmpl->registration_lock);
2862 * If a PERSISTENT RESERVE OUT with a PREEMPT service action or
2863 * a PREEMPT AND ABORT service action sets the SERVICE ACTION
2864 * RESERVATION KEY field to a value that does not match any
2865 * registered reservation key, then the device server shall
2866 * complete the command with RESERVATION CONFLICT status.
2868 if (sa_res_key_unmatched) {
2869 spin_unlock(&dev->dev_reservation_lock);
2870 core_scsi3_put_pr_reg(pr_reg_n);
2871 return TCM_RESERVATION_CONFLICT;
2874 * For an existing all registrants type reservation
2875 * with a zero SA rservation key, preempt the existing
2876 * reservation with the new PR type and scope.
2878 if (pr_res_holder && all_reg && !(sa_res_key)) {
2879 __core_scsi3_complete_pro_preempt(dev, pr_reg_n,
2880 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
2881 type, scope, preempt_type);
2883 if (preempt_type == PREEMPT_AND_ABORT)
2884 core_scsi3_release_preempt_and_abort(
2885 &preempt_and_abort_list, pr_reg_n);
2887 spin_unlock(&dev->dev_reservation_lock);
2889 if (pr_tmpl->pr_aptpl_active)
2890 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
2892 core_scsi3_put_pr_reg(pr_reg_n);
2893 core_scsi3_pr_generation(cmd->se_dev);
2894 return 0;
2897 * The PREEMPTing SA reservation key matches that of the
2898 * existing persistent reservation, first, we check if
2899 * we are preempting our own reservation.
2900 * From spc4r17, section 5.7.11.4.3 Preempting
2901 * persistent reservations and registration handling
2903 * If an all registrants persistent reservation is not
2904 * present, it is not an error for the persistent
2905 * reservation holder to preempt itself (i.e., a
2906 * PERSISTENT RESERVE OUT with a PREEMPT service action
2907 * or a PREEMPT AND ABORT service action with the
2908 * SERVICE ACTION RESERVATION KEY value equal to the
2909 * persistent reservation holder's reservation key that
2910 * is received from the persistent reservation holder).
2911 * In that case, the device server shall establish the
2912 * new persistent reservation and maintain the
2913 * registration.
2915 prh_type = pr_res_holder->pr_res_type;
2916 prh_scope = pr_res_holder->pr_res_scope;
2918 * If the SERVICE ACTION RESERVATION KEY field identifies a
2919 * persistent reservation holder (see 5.7.10), the device
2920 * server shall perform a preempt by doing the following as
2921 * an uninterrupted series of actions:
2923 * a) Release the persistent reservation for the holder
2924 * identified by the SERVICE ACTION RESERVATION KEY field;
2926 if (pr_reg_n != pr_res_holder)
2927 __core_scsi3_complete_pro_release(dev,
2928 pr_res_holder->pr_reg_nacl,
2929 dev->dev_pr_res_holder, 0);
2931 * b) Remove the registrations for all I_T nexuses identified
2932 * by the SERVICE ACTION RESERVATION KEY field, except the
2933 * I_T nexus that is being used for the PERSISTENT RESERVE
2934 * OUT command. If an all registrants persistent reservation
2935 * is present and the SERVICE ACTION RESERVATION KEY field
2936 * is set to zero, then all registrations shall be removed
2937 * except for that of the I_T nexus that is being used for
2938 * the PERSISTENT RESERVE OUT command;
2940 spin_lock(&pr_tmpl->registration_lock);
2941 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2942 &pr_tmpl->registration_list, pr_reg_list) {
2944 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2945 if (calling_it_nexus)
2946 continue;
2948 if (pr_reg->pr_res_key != sa_res_key)
2949 continue;
2951 pr_reg_nacl = pr_reg->pr_reg_nacl;
2952 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2953 __core_scsi3_free_registration(dev, pr_reg,
2954 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
2955 calling_it_nexus);
2957 * e) Establish a unit attention condition for the initiator
2958 * port associated with every I_T nexus that lost its
2959 * persistent reservation and/or registration, with the
2960 * additional sense code set to REGISTRATIONS PREEMPTED;
2962 core_scsi3_ua_allocate(pr_reg_nacl, pr_res_mapped_lun, 0x2A,
2963 ASCQ_2AH_REGISTRATIONS_PREEMPTED);
2965 spin_unlock(&pr_tmpl->registration_lock);
2967 * c) Establish a persistent reservation for the preempting
2968 * I_T nexus using the contents of the SCOPE and TYPE fields;
2970 __core_scsi3_complete_pro_preempt(dev, pr_reg_n,
2971 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
2972 type, scope, preempt_type);
2974 * d) Process tasks as defined in 5.7.1;
2975 * e) See above..
2976 * f) If the type or scope has changed, then for every I_T nexus
2977 * whose reservation key was not removed, except for the I_T
2978 * nexus on which the PERSISTENT RESERVE OUT command was
2979 * received, the device server shall establish a unit
2980 * attention condition for the initiator port associated with
2981 * that I_T nexus, with the additional sense code set to
2982 * RESERVATIONS RELEASED. If the type or scope have not
2983 * changed, then no unit attention condition(s) shall be
2984 * established for this reason.
2986 if ((prh_type != type) || (prh_scope != scope)) {
2987 spin_lock(&pr_tmpl->registration_lock);
2988 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2989 &pr_tmpl->registration_list, pr_reg_list) {
2991 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2992 if (calling_it_nexus)
2993 continue;
2995 core_scsi3_ua_allocate(pr_reg->pr_reg_nacl,
2996 pr_reg->pr_res_mapped_lun, 0x2A,
2997 ASCQ_2AH_RESERVATIONS_RELEASED);
2999 spin_unlock(&pr_tmpl->registration_lock);
3001 spin_unlock(&dev->dev_reservation_lock);
3003 * Call LUN_RESET logic upon list of struct t10_pr_registration,
3004 * All received CDBs for the matching existing reservation and
3005 * registrations undergo ABORT_TASK logic.
3007 * From there, core_scsi3_release_preempt_and_abort() will
3008 * release every registration in the list (which have already
3009 * been removed from the primary pr_reg list), except the
3010 * new persistent reservation holder, the calling Initiator Port.
3012 if (preempt_type == PREEMPT_AND_ABORT) {
3013 core_tmr_lun_reset(dev, NULL, &preempt_and_abort_list, cmd);
3014 core_scsi3_release_preempt_and_abort(&preempt_and_abort_list,
3015 pr_reg_n);
3018 if (pr_tmpl->pr_aptpl_active)
3019 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
3021 core_scsi3_put_pr_reg(pr_reg_n);
3022 core_scsi3_pr_generation(cmd->se_dev);
3023 return 0;
3026 static sense_reason_t
3027 core_scsi3_emulate_pro_preempt(struct se_cmd *cmd, int type, int scope,
3028 u64 res_key, u64 sa_res_key, enum preempt_type preempt_type)
3030 switch (type) {
3031 case PR_TYPE_WRITE_EXCLUSIVE:
3032 case PR_TYPE_EXCLUSIVE_ACCESS:
3033 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
3034 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
3035 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
3036 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
3037 return core_scsi3_pro_preempt(cmd, type, scope, res_key,
3038 sa_res_key, preempt_type);
3039 default:
3040 pr_err("SPC-3 PR: Unknown Service Action PREEMPT%s"
3041 " Type: 0x%02x\n", (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "", type);
3042 return TCM_INVALID_CDB_FIELD;
3047 static sense_reason_t
3048 core_scsi3_emulate_pro_register_and_move(struct se_cmd *cmd, u64 res_key,
3049 u64 sa_res_key, int aptpl, int unreg)
3051 struct se_session *se_sess = cmd->se_sess;
3052 struct se_device *dev = cmd->se_dev;
3053 struct se_dev_entry *dest_se_deve = NULL;
3054 struct se_lun *se_lun = cmd->se_lun;
3055 struct se_node_acl *pr_res_nacl, *pr_reg_nacl, *dest_node_acl = NULL;
3056 struct se_port *se_port;
3057 struct se_portal_group *se_tpg, *dest_se_tpg = NULL;
3058 struct target_core_fabric_ops *dest_tf_ops = NULL, *tf_ops;
3059 struct t10_pr_registration *pr_reg, *pr_res_holder, *dest_pr_reg;
3060 struct t10_reservation *pr_tmpl = &dev->t10_pr;
3061 unsigned char *buf;
3062 unsigned char *initiator_str;
3063 char *iport_ptr = NULL, dest_iport[64], i_buf[PR_REG_ISID_ID_LEN];
3064 u32 tid_len, tmp_tid_len;
3065 int new_reg = 0, type, scope, matching_iname;
3066 sense_reason_t ret;
3067 unsigned short rtpi;
3068 unsigned char proto_ident;
3070 if (!se_sess || !se_lun) {
3071 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
3072 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3075 memset(dest_iport, 0, 64);
3076 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
3077 se_tpg = se_sess->se_tpg;
3078 tf_ops = se_tpg->se_tpg_tfo;
3080 * Follow logic from spc4r17 Section 5.7.8, Table 50 --
3081 * Register behaviors for a REGISTER AND MOVE service action
3083 * Locate the existing *pr_reg via struct se_node_acl pointers
3085 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
3086 se_sess);
3087 if (!pr_reg) {
3088 pr_err("SPC-3 PR: Unable to locate PR_REGISTERED"
3089 " *pr_reg for REGISTER_AND_MOVE\n");
3090 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3093 * The provided reservation key much match the existing reservation key
3094 * provided during this initiator's I_T nexus registration.
3096 if (res_key != pr_reg->pr_res_key) {
3097 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received"
3098 " res_key: 0x%016Lx does not match existing SA REGISTER"
3099 " res_key: 0x%016Lx\n", res_key, pr_reg->pr_res_key);
3100 ret = TCM_RESERVATION_CONFLICT;
3101 goto out_put_pr_reg;
3104 * The service active reservation key needs to be non zero
3106 if (!sa_res_key) {
3107 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received zero"
3108 " sa_res_key\n");
3109 ret = TCM_INVALID_PARAMETER_LIST;
3110 goto out_put_pr_reg;
3114 * Determine the Relative Target Port Identifier where the reservation
3115 * will be moved to for the TransportID containing SCSI initiator WWN
3116 * information.
3118 buf = transport_kmap_data_sg(cmd);
3119 if (!buf) {
3120 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3121 goto out_put_pr_reg;
3124 rtpi = (buf[18] & 0xff) << 8;
3125 rtpi |= buf[19] & 0xff;
3126 tid_len = (buf[20] & 0xff) << 24;
3127 tid_len |= (buf[21] & 0xff) << 16;
3128 tid_len |= (buf[22] & 0xff) << 8;
3129 tid_len |= buf[23] & 0xff;
3130 transport_kunmap_data_sg(cmd);
3131 buf = NULL;
3133 if ((tid_len + 24) != cmd->data_length) {
3134 pr_err("SPC-3 PR: Illegal tid_len: %u + 24 byte header"
3135 " does not equal CDB data_length: %u\n", tid_len,
3136 cmd->data_length);
3137 ret = TCM_INVALID_PARAMETER_LIST;
3138 goto out_put_pr_reg;
3141 spin_lock(&dev->se_port_lock);
3142 list_for_each_entry(se_port, &dev->dev_sep_list, sep_list) {
3143 if (se_port->sep_rtpi != rtpi)
3144 continue;
3145 dest_se_tpg = se_port->sep_tpg;
3146 if (!dest_se_tpg)
3147 continue;
3148 dest_tf_ops = dest_se_tpg->se_tpg_tfo;
3149 if (!dest_tf_ops)
3150 continue;
3152 atomic_inc_mb(&dest_se_tpg->tpg_pr_ref_count);
3153 spin_unlock(&dev->se_port_lock);
3155 if (core_scsi3_tpg_depend_item(dest_se_tpg)) {
3156 pr_err("core_scsi3_tpg_depend_item() failed"
3157 " for dest_se_tpg\n");
3158 atomic_dec_mb(&dest_se_tpg->tpg_pr_ref_count);
3159 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3160 goto out_put_pr_reg;
3163 spin_lock(&dev->se_port_lock);
3164 break;
3166 spin_unlock(&dev->se_port_lock);
3168 if (!dest_se_tpg || !dest_tf_ops) {
3169 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3170 " fabric ops from Relative Target Port Identifier:"
3171 " %hu\n", rtpi);
3172 ret = TCM_INVALID_PARAMETER_LIST;
3173 goto out_put_pr_reg;
3176 buf = transport_kmap_data_sg(cmd);
3177 if (!buf) {
3178 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3179 goto out_put_pr_reg;
3181 proto_ident = (buf[24] & 0x0f);
3183 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Extracted Protocol Identifier:"
3184 " 0x%02x\n", proto_ident);
3186 if (proto_ident != dest_tf_ops->get_fabric_proto_ident(dest_se_tpg)) {
3187 pr_err("SPC-3 PR REGISTER_AND_MOVE: Received"
3188 " proto_ident: 0x%02x does not match ident: 0x%02x"
3189 " from fabric: %s\n", proto_ident,
3190 dest_tf_ops->get_fabric_proto_ident(dest_se_tpg),
3191 dest_tf_ops->get_fabric_name());
3192 ret = TCM_INVALID_PARAMETER_LIST;
3193 goto out;
3195 if (dest_tf_ops->tpg_parse_pr_out_transport_id == NULL) {
3196 pr_err("SPC-3 PR REGISTER_AND_MOVE: Fabric does not"
3197 " containg a valid tpg_parse_pr_out_transport_id"
3198 " function pointer\n");
3199 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3200 goto out;
3202 initiator_str = dest_tf_ops->tpg_parse_pr_out_transport_id(dest_se_tpg,
3203 (const char *)&buf[24], &tmp_tid_len, &iport_ptr);
3204 if (!initiator_str) {
3205 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3206 " initiator_str from Transport ID\n");
3207 ret = TCM_INVALID_PARAMETER_LIST;
3208 goto out;
3211 transport_kunmap_data_sg(cmd);
3212 buf = NULL;
3214 pr_debug("SPC-3 PR [%s] Extracted initiator %s identifier: %s"
3215 " %s\n", dest_tf_ops->get_fabric_name(), (iport_ptr != NULL) ?
3216 "port" : "device", initiator_str, (iport_ptr != NULL) ?
3217 iport_ptr : "");
3219 * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3220 * action specifies a TransportID that is the same as the initiator port
3221 * of the I_T nexus for the command received, then the command shall
3222 * be terminated with CHECK CONDITION status, with the sense key set to
3223 * ILLEGAL REQUEST, and the additional sense code set to INVALID FIELD
3224 * IN PARAMETER LIST.
3226 pr_reg_nacl = pr_reg->pr_reg_nacl;
3227 matching_iname = (!strcmp(initiator_str,
3228 pr_reg_nacl->initiatorname)) ? 1 : 0;
3229 if (!matching_iname)
3230 goto after_iport_check;
3232 if (!iport_ptr || !pr_reg->isid_present_at_reg) {
3233 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s"
3234 " matches: %s on received I_T Nexus\n", initiator_str,
3235 pr_reg_nacl->initiatorname);
3236 ret = TCM_INVALID_PARAMETER_LIST;
3237 goto out;
3239 if (!strcmp(iport_ptr, pr_reg->pr_reg_isid)) {
3240 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s %s"
3241 " matches: %s %s on received I_T Nexus\n",
3242 initiator_str, iport_ptr, pr_reg_nacl->initiatorname,
3243 pr_reg->pr_reg_isid);
3244 ret = TCM_INVALID_PARAMETER_LIST;
3245 goto out;
3247 after_iport_check:
3249 * Locate the destination struct se_node_acl from the received Transport ID
3251 spin_lock_irq(&dest_se_tpg->acl_node_lock);
3252 dest_node_acl = __core_tpg_get_initiator_node_acl(dest_se_tpg,
3253 initiator_str);
3254 if (dest_node_acl)
3255 atomic_inc_mb(&dest_node_acl->acl_pr_ref_count);
3256 spin_unlock_irq(&dest_se_tpg->acl_node_lock);
3258 if (!dest_node_acl) {
3259 pr_err("Unable to locate %s dest_node_acl for"
3260 " TransportID%s\n", dest_tf_ops->get_fabric_name(),
3261 initiator_str);
3262 ret = TCM_INVALID_PARAMETER_LIST;
3263 goto out;
3266 if (core_scsi3_nodeacl_depend_item(dest_node_acl)) {
3267 pr_err("core_scsi3_nodeacl_depend_item() for"
3268 " dest_node_acl\n");
3269 atomic_dec_mb(&dest_node_acl->acl_pr_ref_count);
3270 dest_node_acl = NULL;
3271 ret = TCM_INVALID_PARAMETER_LIST;
3272 goto out;
3275 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Found %s dest_node_acl:"
3276 " %s from TransportID\n", dest_tf_ops->get_fabric_name(),
3277 dest_node_acl->initiatorname);
3280 * Locate the struct se_dev_entry pointer for the matching RELATIVE TARGET
3281 * PORT IDENTIFIER.
3283 dest_se_deve = core_get_se_deve_from_rtpi(dest_node_acl, rtpi);
3284 if (!dest_se_deve) {
3285 pr_err("Unable to locate %s dest_se_deve from RTPI:"
3286 " %hu\n", dest_tf_ops->get_fabric_name(), rtpi);
3287 ret = TCM_INVALID_PARAMETER_LIST;
3288 goto out;
3291 if (core_scsi3_lunacl_depend_item(dest_se_deve)) {
3292 pr_err("core_scsi3_lunacl_depend_item() failed\n");
3293 atomic_dec_mb(&dest_se_deve->pr_ref_count);
3294 dest_se_deve = NULL;
3295 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3296 goto out;
3299 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Located %s node %s LUN"
3300 " ACL for dest_se_deve->mapped_lun: %u\n",
3301 dest_tf_ops->get_fabric_name(), dest_node_acl->initiatorname,
3302 dest_se_deve->mapped_lun);
3305 * A persistent reservation needs to already existing in order to
3306 * successfully complete the REGISTER_AND_MOVE service action..
3308 spin_lock(&dev->dev_reservation_lock);
3309 pr_res_holder = dev->dev_pr_res_holder;
3310 if (!pr_res_holder) {
3311 pr_warn("SPC-3 PR REGISTER_AND_MOVE: No reservation"
3312 " currently held\n");
3313 spin_unlock(&dev->dev_reservation_lock);
3314 ret = TCM_INVALID_CDB_FIELD;
3315 goto out;
3318 * The received on I_T Nexus must be the reservation holder.
3320 * From spc4r17 section 5.7.8 Table 50 --
3321 * Register behaviors for a REGISTER AND MOVE service action
3323 if (pr_res_holder != pr_reg) {
3324 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Calling I_T"
3325 " Nexus is not reservation holder\n");
3326 spin_unlock(&dev->dev_reservation_lock);
3327 ret = TCM_RESERVATION_CONFLICT;
3328 goto out;
3331 * From spc4r17 section 5.7.8: registering and moving reservation
3333 * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3334 * action is received and the established persistent reservation is a
3335 * Write Exclusive - All Registrants type or Exclusive Access -
3336 * All Registrants type reservation, then the command shall be completed
3337 * with RESERVATION CONFLICT status.
3339 if ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
3340 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
3341 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Unable to move"
3342 " reservation for type: %s\n",
3343 core_scsi3_pr_dump_type(pr_res_holder->pr_res_type));
3344 spin_unlock(&dev->dev_reservation_lock);
3345 ret = TCM_RESERVATION_CONFLICT;
3346 goto out;
3348 pr_res_nacl = pr_res_holder->pr_reg_nacl;
3350 * b) Ignore the contents of the (received) SCOPE and TYPE fields;
3352 type = pr_res_holder->pr_res_type;
3353 scope = pr_res_holder->pr_res_type;
3355 * c) Associate the reservation key specified in the SERVICE ACTION
3356 * RESERVATION KEY field with the I_T nexus specified as the
3357 * destination of the register and move, where:
3358 * A) The I_T nexus is specified by the TransportID and the
3359 * RELATIVE TARGET PORT IDENTIFIER field (see 6.14.4); and
3360 * B) Regardless of the TransportID format used, the association for
3361 * the initiator port is based on either the initiator port name
3362 * (see 3.1.71) on SCSI transport protocols where port names are
3363 * required or the initiator port identifier (see 3.1.70) on SCSI
3364 * transport protocols where port names are not required;
3365 * d) Register the reservation key specified in the SERVICE ACTION
3366 * RESERVATION KEY field;
3367 * e) Retain the reservation key specified in the SERVICE ACTION
3368 * RESERVATION KEY field and associated information;
3370 * Also, It is not an error for a REGISTER AND MOVE service action to
3371 * register an I_T nexus that is already registered with the same
3372 * reservation key or a different reservation key.
3374 dest_pr_reg = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
3375 iport_ptr);
3376 if (!dest_pr_reg) {
3377 if (core_scsi3_alloc_registration(cmd->se_dev,
3378 dest_node_acl, dest_se_deve, iport_ptr,
3379 sa_res_key, 0, aptpl, 2, 1)) {
3380 spin_unlock(&dev->dev_reservation_lock);
3381 ret = TCM_INVALID_PARAMETER_LIST;
3382 goto out;
3384 dest_pr_reg = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
3385 iport_ptr);
3386 new_reg = 1;
3389 * f) Release the persistent reservation for the persistent reservation
3390 * holder (i.e., the I_T nexus on which the
3392 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
3393 dev->dev_pr_res_holder, 0);
3395 * g) Move the persistent reservation to the specified I_T nexus using
3396 * the same scope and type as the persistent reservation released in
3397 * item f); and
3399 dev->dev_pr_res_holder = dest_pr_reg;
3400 dest_pr_reg->pr_res_holder = 1;
3401 dest_pr_reg->pr_res_type = type;
3402 pr_reg->pr_res_scope = scope;
3403 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
3405 * Increment PRGeneration for existing registrations..
3407 if (!new_reg)
3408 dest_pr_reg->pr_res_generation = pr_tmpl->pr_generation++;
3409 spin_unlock(&dev->dev_reservation_lock);
3411 pr_debug("SPC-3 PR [%s] Service Action: REGISTER_AND_MOVE"
3412 " created new reservation holder TYPE: %s on object RTPI:"
3413 " %hu PRGeneration: 0x%08x\n", dest_tf_ops->get_fabric_name(),
3414 core_scsi3_pr_dump_type(type), rtpi,
3415 dest_pr_reg->pr_res_generation);
3416 pr_debug("SPC-3 PR Successfully moved reservation from"
3417 " %s Fabric Node: %s%s -> %s Fabric Node: %s %s\n",
3418 tf_ops->get_fabric_name(), pr_reg_nacl->initiatorname,
3419 i_buf, dest_tf_ops->get_fabric_name(),
3420 dest_node_acl->initiatorname, (iport_ptr != NULL) ?
3421 iport_ptr : "");
3423 * It is now safe to release configfs group dependencies for destination
3424 * of Transport ID Initiator Device/Port Identifier
3426 core_scsi3_lunacl_undepend_item(dest_se_deve);
3427 core_scsi3_nodeacl_undepend_item(dest_node_acl);
3428 core_scsi3_tpg_undepend_item(dest_se_tpg);
3430 * h) If the UNREG bit is set to one, unregister (see 5.7.11.3) the I_T
3431 * nexus on which PERSISTENT RESERVE OUT command was received.
3433 if (unreg) {
3434 spin_lock(&pr_tmpl->registration_lock);
3435 __core_scsi3_free_registration(dev, pr_reg, NULL, 1);
3436 spin_unlock(&pr_tmpl->registration_lock);
3437 } else
3438 core_scsi3_put_pr_reg(pr_reg);
3440 core_scsi3_update_and_write_aptpl(cmd->se_dev, aptpl);
3442 transport_kunmap_data_sg(cmd);
3444 core_scsi3_put_pr_reg(dest_pr_reg);
3445 return 0;
3446 out:
3447 if (buf)
3448 transport_kunmap_data_sg(cmd);
3449 if (dest_se_deve)
3450 core_scsi3_lunacl_undepend_item(dest_se_deve);
3451 if (dest_node_acl)
3452 core_scsi3_nodeacl_undepend_item(dest_node_acl);
3453 core_scsi3_tpg_undepend_item(dest_se_tpg);
3455 out_put_pr_reg:
3456 core_scsi3_put_pr_reg(pr_reg);
3457 return ret;
3460 static unsigned long long core_scsi3_extract_reservation_key(unsigned char *cdb)
3462 unsigned int __v1, __v2;
3464 __v1 = (cdb[0] << 24) | (cdb[1] << 16) | (cdb[2] << 8) | cdb[3];
3465 __v2 = (cdb[4] << 24) | (cdb[5] << 16) | (cdb[6] << 8) | cdb[7];
3467 return ((unsigned long long)__v2) | (unsigned long long)__v1 << 32;
3471 * See spc4r17 section 6.14 Table 170
3473 sense_reason_t
3474 target_scsi3_emulate_pr_out(struct se_cmd *cmd)
3476 struct se_device *dev = cmd->se_dev;
3477 unsigned char *cdb = &cmd->t_task_cdb[0];
3478 unsigned char *buf;
3479 u64 res_key, sa_res_key;
3480 int sa, scope, type, aptpl;
3481 int spec_i_pt = 0, all_tg_pt = 0, unreg = 0;
3482 sense_reason_t ret;
3485 * Following spc2r20 5.5.1 Reservations overview:
3487 * If a logical unit has been reserved by any RESERVE command and is
3488 * still reserved by any initiator, all PERSISTENT RESERVE IN and all
3489 * PERSISTENT RESERVE OUT commands shall conflict regardless of
3490 * initiator or service action and shall terminate with a RESERVATION
3491 * CONFLICT status.
3493 if (cmd->se_dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS) {
3494 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
3495 " SPC-2 reservation is held, returning"
3496 " RESERVATION_CONFLICT\n");
3497 return TCM_RESERVATION_CONFLICT;
3501 * FIXME: A NULL struct se_session pointer means an this is not coming from
3502 * a $FABRIC_MOD's nexus, but from internal passthrough ops.
3504 if (!cmd->se_sess)
3505 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3507 if (cmd->data_length < 24) {
3508 pr_warn("SPC-PR: Received PR OUT parameter list"
3509 " length too small: %u\n", cmd->data_length);
3510 return TCM_INVALID_PARAMETER_LIST;
3514 * From the PERSISTENT_RESERVE_OUT command descriptor block (CDB)
3516 sa = (cdb[1] & 0x1f);
3517 scope = (cdb[2] & 0xf0);
3518 type = (cdb[2] & 0x0f);
3520 buf = transport_kmap_data_sg(cmd);
3521 if (!buf)
3522 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3525 * From PERSISTENT_RESERVE_OUT parameter list (payload)
3527 res_key = core_scsi3_extract_reservation_key(&buf[0]);
3528 sa_res_key = core_scsi3_extract_reservation_key(&buf[8]);
3530 * REGISTER_AND_MOVE uses a different SA parameter list containing
3531 * SCSI TransportIDs.
3533 if (sa != PRO_REGISTER_AND_MOVE) {
3534 spec_i_pt = (buf[20] & 0x08);
3535 all_tg_pt = (buf[20] & 0x04);
3536 aptpl = (buf[20] & 0x01);
3537 } else {
3538 aptpl = (buf[17] & 0x01);
3539 unreg = (buf[17] & 0x02);
3542 * If the backend device has been configured to force APTPL metadata
3543 * write-out, go ahead and propigate aptpl=1 down now.
3545 if (dev->dev_attrib.force_pr_aptpl)
3546 aptpl = 1;
3548 transport_kunmap_data_sg(cmd);
3549 buf = NULL;
3552 * SPEC_I_PT=1 is only valid for Service action: REGISTER
3554 if (spec_i_pt && ((cdb[1] & 0x1f) != PRO_REGISTER))
3555 return TCM_INVALID_PARAMETER_LIST;
3558 * From spc4r17 section 6.14:
3560 * If the SPEC_I_PT bit is set to zero, the service action is not
3561 * REGISTER AND MOVE, and the parameter list length is not 24, then
3562 * the command shall be terminated with CHECK CONDITION status, with
3563 * the sense key set to ILLEGAL REQUEST, and the additional sense
3564 * code set to PARAMETER LIST LENGTH ERROR.
3566 if (!spec_i_pt && ((cdb[1] & 0x1f) != PRO_REGISTER_AND_MOVE) &&
3567 (cmd->data_length != 24)) {
3568 pr_warn("SPC-PR: Received PR OUT illegal parameter"
3569 " list length: %u\n", cmd->data_length);
3570 return TCM_INVALID_PARAMETER_LIST;
3574 * (core_scsi3_emulate_pro_* function parameters
3575 * are defined by spc4r17 Table 174:
3576 * PERSISTENT_RESERVE_OUT service actions and valid parameters.
3578 switch (sa) {
3579 case PRO_REGISTER:
3580 ret = core_scsi3_emulate_pro_register(cmd,
3581 res_key, sa_res_key, aptpl, all_tg_pt, spec_i_pt, REGISTER);
3582 break;
3583 case PRO_RESERVE:
3584 ret = core_scsi3_emulate_pro_reserve(cmd, type, scope, res_key);
3585 break;
3586 case PRO_RELEASE:
3587 ret = core_scsi3_emulate_pro_release(cmd, type, scope, res_key);
3588 break;
3589 case PRO_CLEAR:
3590 ret = core_scsi3_emulate_pro_clear(cmd, res_key);
3591 break;
3592 case PRO_PREEMPT:
3593 ret = core_scsi3_emulate_pro_preempt(cmd, type, scope,
3594 res_key, sa_res_key, PREEMPT);
3595 break;
3596 case PRO_PREEMPT_AND_ABORT:
3597 ret = core_scsi3_emulate_pro_preempt(cmd, type, scope,
3598 res_key, sa_res_key, PREEMPT_AND_ABORT);
3599 break;
3600 case PRO_REGISTER_AND_IGNORE_EXISTING_KEY:
3601 ret = core_scsi3_emulate_pro_register(cmd,
3602 0, sa_res_key, aptpl, all_tg_pt, spec_i_pt, REGISTER_AND_IGNORE_EXISTING_KEY);
3603 break;
3604 case PRO_REGISTER_AND_MOVE:
3605 ret = core_scsi3_emulate_pro_register_and_move(cmd, res_key,
3606 sa_res_key, aptpl, unreg);
3607 break;
3608 default:
3609 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
3610 " action: 0x%02x\n", cdb[1] & 0x1f);
3611 return TCM_INVALID_CDB_FIELD;
3614 if (!ret)
3615 target_complete_cmd(cmd, GOOD);
3616 return ret;
3620 * PERSISTENT_RESERVE_IN Service Action READ_KEYS
3622 * See spc4r17 section 5.7.6.2 and section 6.13.2, Table 160
3624 static sense_reason_t
3625 core_scsi3_pri_read_keys(struct se_cmd *cmd)
3627 struct se_device *dev = cmd->se_dev;
3628 struct t10_pr_registration *pr_reg;
3629 unsigned char *buf;
3630 u32 add_len = 0, off = 8;
3632 if (cmd->data_length < 8) {
3633 pr_err("PRIN SA READ_KEYS SCSI Data Length: %u"
3634 " too small\n", cmd->data_length);
3635 return TCM_INVALID_CDB_FIELD;
3638 buf = transport_kmap_data_sg(cmd);
3639 if (!buf)
3640 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3642 buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3643 buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3644 buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3645 buf[3] = (dev->t10_pr.pr_generation & 0xff);
3647 spin_lock(&dev->t10_pr.registration_lock);
3648 list_for_each_entry(pr_reg, &dev->t10_pr.registration_list,
3649 pr_reg_list) {
3651 * Check for overflow of 8byte PRI READ_KEYS payload and
3652 * next reservation key list descriptor.
3654 if ((add_len + 8) > (cmd->data_length - 8))
3655 break;
3657 buf[off++] = ((pr_reg->pr_res_key >> 56) & 0xff);
3658 buf[off++] = ((pr_reg->pr_res_key >> 48) & 0xff);
3659 buf[off++] = ((pr_reg->pr_res_key >> 40) & 0xff);
3660 buf[off++] = ((pr_reg->pr_res_key >> 32) & 0xff);
3661 buf[off++] = ((pr_reg->pr_res_key >> 24) & 0xff);
3662 buf[off++] = ((pr_reg->pr_res_key >> 16) & 0xff);
3663 buf[off++] = ((pr_reg->pr_res_key >> 8) & 0xff);
3664 buf[off++] = (pr_reg->pr_res_key & 0xff);
3666 add_len += 8;
3668 spin_unlock(&dev->t10_pr.registration_lock);
3670 buf[4] = ((add_len >> 24) & 0xff);
3671 buf[5] = ((add_len >> 16) & 0xff);
3672 buf[6] = ((add_len >> 8) & 0xff);
3673 buf[7] = (add_len & 0xff);
3675 transport_kunmap_data_sg(cmd);
3677 return 0;
3681 * PERSISTENT_RESERVE_IN Service Action READ_RESERVATION
3683 * See spc4r17 section 5.7.6.3 and section 6.13.3.2 Table 161 and 162
3685 static sense_reason_t
3686 core_scsi3_pri_read_reservation(struct se_cmd *cmd)
3688 struct se_device *dev = cmd->se_dev;
3689 struct t10_pr_registration *pr_reg;
3690 unsigned char *buf;
3691 u64 pr_res_key;
3692 u32 add_len = 16; /* Hardcoded to 16 when a reservation is held. */
3694 if (cmd->data_length < 8) {
3695 pr_err("PRIN SA READ_RESERVATIONS SCSI Data Length: %u"
3696 " too small\n", cmd->data_length);
3697 return TCM_INVALID_CDB_FIELD;
3700 buf = transport_kmap_data_sg(cmd);
3701 if (!buf)
3702 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3704 buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3705 buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3706 buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3707 buf[3] = (dev->t10_pr.pr_generation & 0xff);
3709 spin_lock(&dev->dev_reservation_lock);
3710 pr_reg = dev->dev_pr_res_holder;
3711 if (pr_reg) {
3713 * Set the hardcoded Additional Length
3715 buf[4] = ((add_len >> 24) & 0xff);
3716 buf[5] = ((add_len >> 16) & 0xff);
3717 buf[6] = ((add_len >> 8) & 0xff);
3718 buf[7] = (add_len & 0xff);
3720 if (cmd->data_length < 22)
3721 goto err;
3724 * Set the Reservation key.
3726 * From spc4r17, section 5.7.10:
3727 * A persistent reservation holder has its reservation key
3728 * returned in the parameter data from a PERSISTENT
3729 * RESERVE IN command with READ RESERVATION service action as
3730 * follows:
3731 * a) For a persistent reservation of the type Write Exclusive
3732 * - All Registrants or Exclusive Access ­ All Regitrants,
3733 * the reservation key shall be set to zero; or
3734 * b) For all other persistent reservation types, the
3735 * reservation key shall be set to the registered
3736 * reservation key for the I_T nexus that holds the
3737 * persistent reservation.
3739 if ((pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
3740 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))
3741 pr_res_key = 0;
3742 else
3743 pr_res_key = pr_reg->pr_res_key;
3745 buf[8] = ((pr_res_key >> 56) & 0xff);
3746 buf[9] = ((pr_res_key >> 48) & 0xff);
3747 buf[10] = ((pr_res_key >> 40) & 0xff);
3748 buf[11] = ((pr_res_key >> 32) & 0xff);
3749 buf[12] = ((pr_res_key >> 24) & 0xff);
3750 buf[13] = ((pr_res_key >> 16) & 0xff);
3751 buf[14] = ((pr_res_key >> 8) & 0xff);
3752 buf[15] = (pr_res_key & 0xff);
3754 * Set the SCOPE and TYPE
3756 buf[21] = (pr_reg->pr_res_scope & 0xf0) |
3757 (pr_reg->pr_res_type & 0x0f);
3760 err:
3761 spin_unlock(&dev->dev_reservation_lock);
3762 transport_kunmap_data_sg(cmd);
3764 return 0;
3768 * PERSISTENT_RESERVE_IN Service Action REPORT_CAPABILITIES
3770 * See spc4r17 section 6.13.4 Table 165
3772 static sense_reason_t
3773 core_scsi3_pri_report_capabilities(struct se_cmd *cmd)
3775 struct se_device *dev = cmd->se_dev;
3776 struct t10_reservation *pr_tmpl = &dev->t10_pr;
3777 unsigned char *buf;
3778 u16 add_len = 8; /* Hardcoded to 8. */
3780 if (cmd->data_length < 6) {
3781 pr_err("PRIN SA REPORT_CAPABILITIES SCSI Data Length:"
3782 " %u too small\n", cmd->data_length);
3783 return TCM_INVALID_CDB_FIELD;
3786 buf = transport_kmap_data_sg(cmd);
3787 if (!buf)
3788 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3790 buf[0] = ((add_len >> 8) & 0xff);
3791 buf[1] = (add_len & 0xff);
3792 buf[2] |= 0x10; /* CRH: Compatible Reservation Hanlding bit. */
3793 buf[2] |= 0x08; /* SIP_C: Specify Initiator Ports Capable bit */
3794 buf[2] |= 0x04; /* ATP_C: All Target Ports Capable bit */
3795 buf[2] |= 0x01; /* PTPL_C: Persistence across Target Power Loss bit */
3797 * We are filling in the PERSISTENT RESERVATION TYPE MASK below, so
3798 * set the TMV: Task Mask Valid bit.
3800 buf[3] |= 0x80;
3802 * Change ALLOW COMMANDs to 0x20 or 0x40 later from Table 166
3804 buf[3] |= 0x10; /* ALLOW COMMANDs field 001b */
3806 * PTPL_A: Persistence across Target Power Loss Active bit
3808 if (pr_tmpl->pr_aptpl_active)
3809 buf[3] |= 0x01;
3811 * Setup the PERSISTENT RESERVATION TYPE MASK from Table 167
3813 buf[4] |= 0x80; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3814 buf[4] |= 0x40; /* PR_TYPE_EXCLUSIVE_ACCESS_REGONLY */
3815 buf[4] |= 0x20; /* PR_TYPE_WRITE_EXCLUSIVE_REGONLY */
3816 buf[4] |= 0x08; /* PR_TYPE_EXCLUSIVE_ACCESS */
3817 buf[4] |= 0x02; /* PR_TYPE_WRITE_EXCLUSIVE */
3818 buf[5] |= 0x01; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3820 transport_kunmap_data_sg(cmd);
3822 return 0;
3826 * PERSISTENT_RESERVE_IN Service Action READ_FULL_STATUS
3828 * See spc4r17 section 6.13.5 Table 168 and 169
3830 static sense_reason_t
3831 core_scsi3_pri_read_full_status(struct se_cmd *cmd)
3833 struct se_device *dev = cmd->se_dev;
3834 struct se_node_acl *se_nacl;
3835 struct se_portal_group *se_tpg;
3836 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
3837 struct t10_reservation *pr_tmpl = &dev->t10_pr;
3838 unsigned char *buf;
3839 u32 add_desc_len = 0, add_len = 0, desc_len, exp_desc_len;
3840 u32 off = 8; /* off into first Full Status descriptor */
3841 int format_code = 0;
3843 if (cmd->data_length < 8) {
3844 pr_err("PRIN SA READ_FULL_STATUS SCSI Data Length: %u"
3845 " too small\n", cmd->data_length);
3846 return TCM_INVALID_CDB_FIELD;
3849 buf = transport_kmap_data_sg(cmd);
3850 if (!buf)
3851 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3853 buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3854 buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3855 buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3856 buf[3] = (dev->t10_pr.pr_generation & 0xff);
3858 spin_lock(&pr_tmpl->registration_lock);
3859 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3860 &pr_tmpl->registration_list, pr_reg_list) {
3862 se_nacl = pr_reg->pr_reg_nacl;
3863 se_tpg = pr_reg->pr_reg_nacl->se_tpg;
3864 add_desc_len = 0;
3866 atomic_inc_mb(&pr_reg->pr_res_holders);
3867 spin_unlock(&pr_tmpl->registration_lock);
3869 * Determine expected length of $FABRIC_MOD specific
3870 * TransportID full status descriptor..
3872 exp_desc_len = se_tpg->se_tpg_tfo->tpg_get_pr_transport_id_len(
3873 se_tpg, se_nacl, pr_reg, &format_code);
3875 if ((exp_desc_len + add_len) > cmd->data_length) {
3876 pr_warn("SPC-3 PRIN READ_FULL_STATUS ran"
3877 " out of buffer: %d\n", cmd->data_length);
3878 spin_lock(&pr_tmpl->registration_lock);
3879 atomic_dec_mb(&pr_reg->pr_res_holders);
3880 break;
3883 * Set RESERVATION KEY
3885 buf[off++] = ((pr_reg->pr_res_key >> 56) & 0xff);
3886 buf[off++] = ((pr_reg->pr_res_key >> 48) & 0xff);
3887 buf[off++] = ((pr_reg->pr_res_key >> 40) & 0xff);
3888 buf[off++] = ((pr_reg->pr_res_key >> 32) & 0xff);
3889 buf[off++] = ((pr_reg->pr_res_key >> 24) & 0xff);
3890 buf[off++] = ((pr_reg->pr_res_key >> 16) & 0xff);
3891 buf[off++] = ((pr_reg->pr_res_key >> 8) & 0xff);
3892 buf[off++] = (pr_reg->pr_res_key & 0xff);
3893 off += 4; /* Skip Over Reserved area */
3896 * Set ALL_TG_PT bit if PROUT SA REGISTER had this set.
3898 if (pr_reg->pr_reg_all_tg_pt)
3899 buf[off] = 0x02;
3901 * The struct se_lun pointer will be present for the
3902 * reservation holder for PR_HOLDER bit.
3904 * Also, if this registration is the reservation
3905 * holder, fill in SCOPE and TYPE in the next byte.
3907 if (pr_reg->pr_res_holder) {
3908 buf[off++] |= 0x01;
3909 buf[off++] = (pr_reg->pr_res_scope & 0xf0) |
3910 (pr_reg->pr_res_type & 0x0f);
3911 } else
3912 off += 2;
3914 off += 4; /* Skip over reserved area */
3916 * From spc4r17 6.3.15:
3918 * If the ALL_TG_PT bit set to zero, the RELATIVE TARGET PORT
3919 * IDENTIFIER field contains the relative port identifier (see
3920 * 3.1.120) of the target port that is part of the I_T nexus
3921 * described by this full status descriptor. If the ALL_TG_PT
3922 * bit is set to one, the contents of the RELATIVE TARGET PORT
3923 * IDENTIFIER field are not defined by this standard.
3925 if (!pr_reg->pr_reg_all_tg_pt) {
3926 struct se_port *port = pr_reg->pr_reg_tg_pt_lun->lun_sep;
3928 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
3929 buf[off++] = (port->sep_rtpi & 0xff);
3930 } else
3931 off += 2; /* Skip over RELATIVE TARGET PORT IDENTIFIER */
3934 * Now, have the $FABRIC_MOD fill in the protocol identifier
3936 desc_len = se_tpg->se_tpg_tfo->tpg_get_pr_transport_id(se_tpg,
3937 se_nacl, pr_reg, &format_code, &buf[off+4]);
3939 spin_lock(&pr_tmpl->registration_lock);
3940 atomic_dec_mb(&pr_reg->pr_res_holders);
3942 * Set the ADDITIONAL DESCRIPTOR LENGTH
3944 buf[off++] = ((desc_len >> 24) & 0xff);
3945 buf[off++] = ((desc_len >> 16) & 0xff);
3946 buf[off++] = ((desc_len >> 8) & 0xff);
3947 buf[off++] = (desc_len & 0xff);
3949 * Size of full desctipor header minus TransportID
3950 * containing $FABRIC_MOD specific) initiator device/port
3951 * WWN information.
3953 * See spc4r17 Section 6.13.5 Table 169
3955 add_desc_len = (24 + desc_len);
3957 off += desc_len;
3958 add_len += add_desc_len;
3960 spin_unlock(&pr_tmpl->registration_lock);
3962 * Set ADDITIONAL_LENGTH
3964 buf[4] = ((add_len >> 24) & 0xff);
3965 buf[5] = ((add_len >> 16) & 0xff);
3966 buf[6] = ((add_len >> 8) & 0xff);
3967 buf[7] = (add_len & 0xff);
3969 transport_kunmap_data_sg(cmd);
3971 return 0;
3974 sense_reason_t
3975 target_scsi3_emulate_pr_in(struct se_cmd *cmd)
3977 sense_reason_t ret;
3980 * Following spc2r20 5.5.1 Reservations overview:
3982 * If a logical unit has been reserved by any RESERVE command and is
3983 * still reserved by any initiator, all PERSISTENT RESERVE IN and all
3984 * PERSISTENT RESERVE OUT commands shall conflict regardless of
3985 * initiator or service action and shall terminate with a RESERVATION
3986 * CONFLICT status.
3988 if (cmd->se_dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS) {
3989 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
3990 " SPC-2 reservation is held, returning"
3991 " RESERVATION_CONFLICT\n");
3992 return TCM_RESERVATION_CONFLICT;
3995 switch (cmd->t_task_cdb[1] & 0x1f) {
3996 case PRI_READ_KEYS:
3997 ret = core_scsi3_pri_read_keys(cmd);
3998 break;
3999 case PRI_READ_RESERVATION:
4000 ret = core_scsi3_pri_read_reservation(cmd);
4001 break;
4002 case PRI_REPORT_CAPABILITIES:
4003 ret = core_scsi3_pri_report_capabilities(cmd);
4004 break;
4005 case PRI_READ_FULL_STATUS:
4006 ret = core_scsi3_pri_read_full_status(cmd);
4007 break;
4008 default:
4009 pr_err("Unknown PERSISTENT_RESERVE_IN service"
4010 " action: 0x%02x\n", cmd->t_task_cdb[1] & 0x1f);
4011 return TCM_INVALID_CDB_FIELD;
4014 if (!ret)
4015 target_complete_cmd(cmd, GOOD);
4016 return ret;
4019 sense_reason_t
4020 target_check_reservation(struct se_cmd *cmd)
4022 struct se_device *dev = cmd->se_dev;
4023 sense_reason_t ret;
4025 if (!cmd->se_sess)
4026 return 0;
4027 if (dev->se_hba->hba_flags & HBA_FLAGS_INTERNAL_USE)
4028 return 0;
4029 if (dev->transport->transport_type == TRANSPORT_PLUGIN_PHBA_PDEV)
4030 return 0;
4032 spin_lock(&dev->dev_reservation_lock);
4033 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS)
4034 ret = target_scsi2_reservation_check(cmd);
4035 else
4036 ret = target_scsi3_pr_reservation_check(cmd);
4037 spin_unlock(&dev->dev_reservation_lock);
4039 return ret;