clk: return probe defer when DT clock not yet ready
[linux-2.6/btrfs-unstable.git] / drivers / target / target_core_pr.c
blob3013287a2aaa192fdacdfde7eb87bcd48eb0aff4
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(&port->sep_tg_pt_ref_cnt);
678 smp_mb__after_atomic_inc();
679 spin_unlock(&dev->se_port_lock);
681 spin_lock_bh(&port->sep_alua_lock);
682 list_for_each_entry(deve_tmp, &port->sep_alua_list,
683 alua_port_list) {
685 * This pointer will be NULL for demo mode MappedLUNs
686 * that have not been make explicit via a ConfigFS
687 * MappedLUN group for the SCSI Initiator Node ACL.
689 if (!deve_tmp->se_lun_acl)
690 continue;
692 nacl_tmp = deve_tmp->se_lun_acl->se_lun_nacl;
694 * Skip the matching struct se_node_acl that is allocated
695 * above..
697 if (nacl == nacl_tmp)
698 continue;
700 * Only perform PR registrations for target ports on
701 * the same fabric module as the REGISTER w/ ALL_TG_PT=1
702 * arrived.
704 if (tfo != nacl_tmp->se_tpg->se_tpg_tfo)
705 continue;
707 * Look for a matching Initiator Node ACL in ASCII format
709 if (strcmp(nacl->initiatorname, nacl_tmp->initiatorname))
710 continue;
712 atomic_inc(&deve_tmp->pr_ref_count);
713 smp_mb__after_atomic_inc();
714 spin_unlock_bh(&port->sep_alua_lock);
716 * Grab a configfs group dependency that is released
717 * for the exception path at label out: below, or upon
718 * completion of adding ALL_TG_PT=1 registrations in
719 * __core_scsi3_add_registration()
721 ret = core_scsi3_lunacl_depend_item(deve_tmp);
722 if (ret < 0) {
723 pr_err("core_scsi3_lunacl_depend"
724 "_item() failed\n");
725 atomic_dec(&port->sep_tg_pt_ref_cnt);
726 smp_mb__after_atomic_dec();
727 atomic_dec(&deve_tmp->pr_ref_count);
728 smp_mb__after_atomic_dec();
729 goto out;
732 * Located a matching SCSI Initiator Port on a different
733 * port, allocate the pr_reg_atp and attach it to the
734 * pr_reg->pr_reg_atp_list that will be processed once
735 * the original *pr_reg is processed in
736 * __core_scsi3_add_registration()
738 pr_reg_atp = __core_scsi3_do_alloc_registration(dev,
739 nacl_tmp, deve_tmp, NULL,
740 sa_res_key, all_tg_pt, aptpl);
741 if (!pr_reg_atp) {
742 atomic_dec(&port->sep_tg_pt_ref_cnt);
743 smp_mb__after_atomic_dec();
744 atomic_dec(&deve_tmp->pr_ref_count);
745 smp_mb__after_atomic_dec();
746 core_scsi3_lunacl_undepend_item(deve_tmp);
747 goto out;
750 list_add_tail(&pr_reg_atp->pr_reg_atp_mem_list,
751 &pr_reg->pr_reg_atp_list);
752 spin_lock_bh(&port->sep_alua_lock);
754 spin_unlock_bh(&port->sep_alua_lock);
756 spin_lock(&dev->se_port_lock);
757 atomic_dec(&port->sep_tg_pt_ref_cnt);
758 smp_mb__after_atomic_dec();
760 spin_unlock(&dev->se_port_lock);
762 return pr_reg;
763 out:
764 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
765 &pr_reg->pr_reg_atp_list, pr_reg_atp_mem_list) {
766 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
767 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
768 kmem_cache_free(t10_pr_reg_cache, pr_reg_tmp);
770 kmem_cache_free(t10_pr_reg_cache, pr_reg);
771 return NULL;
774 int core_scsi3_alloc_aptpl_registration(
775 struct t10_reservation *pr_tmpl,
776 u64 sa_res_key,
777 unsigned char *i_port,
778 unsigned char *isid,
779 u32 mapped_lun,
780 unsigned char *t_port,
781 u16 tpgt,
782 u32 target_lun,
783 int res_holder,
784 int all_tg_pt,
785 u8 type)
787 struct t10_pr_registration *pr_reg;
789 if (!i_port || !t_port || !sa_res_key) {
790 pr_err("Illegal parameters for APTPL registration\n");
791 return -EINVAL;
794 pr_reg = kmem_cache_zalloc(t10_pr_reg_cache, GFP_KERNEL);
795 if (!pr_reg) {
796 pr_err("Unable to allocate struct t10_pr_registration\n");
797 return -ENOMEM;
800 INIT_LIST_HEAD(&pr_reg->pr_reg_list);
801 INIT_LIST_HEAD(&pr_reg->pr_reg_abort_list);
802 INIT_LIST_HEAD(&pr_reg->pr_reg_aptpl_list);
803 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_list);
804 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_mem_list);
805 atomic_set(&pr_reg->pr_res_holders, 0);
806 pr_reg->pr_reg_nacl = NULL;
807 pr_reg->pr_reg_deve = NULL;
808 pr_reg->pr_res_mapped_lun = mapped_lun;
809 pr_reg->pr_aptpl_target_lun = target_lun;
810 pr_reg->pr_res_key = sa_res_key;
811 pr_reg->pr_reg_all_tg_pt = all_tg_pt;
812 pr_reg->pr_reg_aptpl = 1;
813 pr_reg->pr_reg_tg_pt_lun = NULL;
814 pr_reg->pr_res_scope = 0; /* Always LUN_SCOPE */
815 pr_reg->pr_res_type = type;
817 * If an ISID value had been saved in APTPL metadata for this
818 * SCSI Initiator Port, restore it now.
820 if (isid != NULL) {
821 pr_reg->pr_reg_bin_isid = get_unaligned_be64(isid);
822 snprintf(pr_reg->pr_reg_isid, PR_REG_ISID_LEN, "%s", isid);
823 pr_reg->isid_present_at_reg = 1;
826 * Copy the i_port and t_port information from caller.
828 snprintf(pr_reg->pr_iport, PR_APTPL_MAX_IPORT_LEN, "%s", i_port);
829 snprintf(pr_reg->pr_tport, PR_APTPL_MAX_TPORT_LEN, "%s", t_port);
830 pr_reg->pr_reg_tpgt = tpgt;
832 * Set pr_res_holder from caller, the pr_reg who is the reservation
833 * holder will get it's pointer set in core_scsi3_aptpl_reserve() once
834 * the Initiator Node LUN ACL from the fabric module is created for
835 * this registration.
837 pr_reg->pr_res_holder = res_holder;
839 list_add_tail(&pr_reg->pr_reg_aptpl_list, &pr_tmpl->aptpl_reg_list);
840 pr_debug("SPC-3 PR APTPL Successfully added registration%s from"
841 " metadata\n", (res_holder) ? "+reservation" : "");
842 return 0;
845 static void core_scsi3_aptpl_reserve(
846 struct se_device *dev,
847 struct se_portal_group *tpg,
848 struct se_node_acl *node_acl,
849 struct t10_pr_registration *pr_reg)
851 char i_buf[PR_REG_ISID_ID_LEN];
853 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
854 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
856 spin_lock(&dev->dev_reservation_lock);
857 dev->dev_pr_res_holder = pr_reg;
858 spin_unlock(&dev->dev_reservation_lock);
860 pr_debug("SPC-3 PR [%s] Service Action: APTPL RESERVE created"
861 " new reservation holder TYPE: %s ALL_TG_PT: %d\n",
862 tpg->se_tpg_tfo->get_fabric_name(),
863 core_scsi3_pr_dump_type(pr_reg->pr_res_type),
864 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
865 pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
866 tpg->se_tpg_tfo->get_fabric_name(), node_acl->initiatorname,
867 i_buf);
870 static void __core_scsi3_add_registration(struct se_device *, struct se_node_acl *,
871 struct t10_pr_registration *, enum register_type, int);
873 static int __core_scsi3_check_aptpl_registration(
874 struct se_device *dev,
875 struct se_portal_group *tpg,
876 struct se_lun *lun,
877 u32 target_lun,
878 struct se_node_acl *nacl,
879 struct se_dev_entry *deve)
881 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
882 struct t10_reservation *pr_tmpl = &dev->t10_pr;
883 unsigned char i_port[PR_APTPL_MAX_IPORT_LEN];
884 unsigned char t_port[PR_APTPL_MAX_TPORT_LEN];
885 u16 tpgt;
887 memset(i_port, 0, PR_APTPL_MAX_IPORT_LEN);
888 memset(t_port, 0, PR_APTPL_MAX_TPORT_LEN);
890 * Copy Initiator Port information from struct se_node_acl
892 snprintf(i_port, PR_APTPL_MAX_IPORT_LEN, "%s", nacl->initiatorname);
893 snprintf(t_port, PR_APTPL_MAX_TPORT_LEN, "%s",
894 tpg->se_tpg_tfo->tpg_get_wwn(tpg));
895 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
897 * Look for the matching registrations+reservation from those
898 * created from APTPL metadata. Note that multiple registrations
899 * may exist for fabrics that use ISIDs in their SCSI Initiator Port
900 * TransportIDs.
902 spin_lock(&pr_tmpl->aptpl_reg_lock);
903 list_for_each_entry_safe(pr_reg, pr_reg_tmp, &pr_tmpl->aptpl_reg_list,
904 pr_reg_aptpl_list) {
905 if (!strcmp(pr_reg->pr_iport, i_port) &&
906 (pr_reg->pr_res_mapped_lun == deve->mapped_lun) &&
907 !(strcmp(pr_reg->pr_tport, t_port)) &&
908 (pr_reg->pr_reg_tpgt == tpgt) &&
909 (pr_reg->pr_aptpl_target_lun == target_lun)) {
911 pr_reg->pr_reg_nacl = nacl;
912 pr_reg->pr_reg_deve = deve;
913 pr_reg->pr_reg_tg_pt_lun = lun;
915 list_del(&pr_reg->pr_reg_aptpl_list);
916 spin_unlock(&pr_tmpl->aptpl_reg_lock);
918 * At this point all of the pointers in *pr_reg will
919 * be setup, so go ahead and add the registration.
922 __core_scsi3_add_registration(dev, nacl, pr_reg, 0, 0);
924 * If this registration is the reservation holder,
925 * make that happen now..
927 if (pr_reg->pr_res_holder)
928 core_scsi3_aptpl_reserve(dev, tpg,
929 nacl, pr_reg);
931 * Reenable pr_aptpl_active to accept new metadata
932 * updates once the SCSI device is active again..
934 spin_lock(&pr_tmpl->aptpl_reg_lock);
935 pr_tmpl->pr_aptpl_active = 1;
938 spin_unlock(&pr_tmpl->aptpl_reg_lock);
940 return 0;
943 int core_scsi3_check_aptpl_registration(
944 struct se_device *dev,
945 struct se_portal_group *tpg,
946 struct se_lun *lun,
947 struct se_lun_acl *lun_acl)
949 struct se_node_acl *nacl = lun_acl->se_lun_nacl;
950 struct se_dev_entry *deve = nacl->device_list[lun_acl->mapped_lun];
952 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS)
953 return 0;
955 return __core_scsi3_check_aptpl_registration(dev, tpg, lun,
956 lun->unpacked_lun, nacl, deve);
959 static void __core_scsi3_dump_registration(
960 struct target_core_fabric_ops *tfo,
961 struct se_device *dev,
962 struct se_node_acl *nacl,
963 struct t10_pr_registration *pr_reg,
964 enum register_type register_type)
966 struct se_portal_group *se_tpg = nacl->se_tpg;
967 char i_buf[PR_REG_ISID_ID_LEN];
969 memset(&i_buf[0], 0, PR_REG_ISID_ID_LEN);
970 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
972 pr_debug("SPC-3 PR [%s] Service Action: REGISTER%s Initiator"
973 " Node: %s%s\n", tfo->get_fabric_name(), (register_type == REGISTER_AND_MOVE) ?
974 "_AND_MOVE" : (register_type == REGISTER_AND_IGNORE_EXISTING_KEY) ?
975 "_AND_IGNORE_EXISTING_KEY" : "", nacl->initiatorname,
976 i_buf);
977 pr_debug("SPC-3 PR [%s] registration on Target Port: %s,0x%04x\n",
978 tfo->get_fabric_name(), tfo->tpg_get_wwn(se_tpg),
979 tfo->tpg_get_tag(se_tpg));
980 pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
981 " Port(s)\n", tfo->get_fabric_name(),
982 (pr_reg->pr_reg_all_tg_pt) ? "ALL" : "SINGLE",
983 dev->transport->name);
984 pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
985 " 0x%08x APTPL: %d\n", tfo->get_fabric_name(),
986 pr_reg->pr_res_key, pr_reg->pr_res_generation,
987 pr_reg->pr_reg_aptpl);
991 * this function can be called with struct se_device->dev_reservation_lock
992 * when register_move = 1
994 static void __core_scsi3_add_registration(
995 struct se_device *dev,
996 struct se_node_acl *nacl,
997 struct t10_pr_registration *pr_reg,
998 enum register_type register_type,
999 int register_move)
1001 struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
1002 struct t10_pr_registration *pr_reg_tmp, *pr_reg_tmp_safe;
1003 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1006 * Increment PRgeneration counter for struct se_device upon a successful
1007 * REGISTER, see spc4r17 section 6.3.2 READ_KEYS service action
1009 * Also, when register_move = 1 for PROUT REGISTER_AND_MOVE service
1010 * action, the struct se_device->dev_reservation_lock will already be held,
1011 * so we do not call core_scsi3_pr_generation() which grabs the lock
1012 * for the REGISTER.
1014 pr_reg->pr_res_generation = (register_move) ?
1015 dev->t10_pr.pr_generation++ :
1016 core_scsi3_pr_generation(dev);
1018 spin_lock(&pr_tmpl->registration_lock);
1019 list_add_tail(&pr_reg->pr_reg_list, &pr_tmpl->registration_list);
1020 pr_reg->pr_reg_deve->def_pr_registered = 1;
1022 __core_scsi3_dump_registration(tfo, dev, nacl, pr_reg, register_type);
1023 spin_unlock(&pr_tmpl->registration_lock);
1025 * Skip extra processing for ALL_TG_PT=0 or REGISTER_AND_MOVE.
1027 if (!pr_reg->pr_reg_all_tg_pt || register_move)
1028 return;
1030 * Walk pr_reg->pr_reg_atp_list and add registrations for ALL_TG_PT=1
1031 * allocated in __core_scsi3_alloc_registration()
1033 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
1034 &pr_reg->pr_reg_atp_list, pr_reg_atp_mem_list) {
1035 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
1037 pr_reg_tmp->pr_res_generation = core_scsi3_pr_generation(dev);
1039 spin_lock(&pr_tmpl->registration_lock);
1040 list_add_tail(&pr_reg_tmp->pr_reg_list,
1041 &pr_tmpl->registration_list);
1042 pr_reg_tmp->pr_reg_deve->def_pr_registered = 1;
1044 __core_scsi3_dump_registration(tfo, dev,
1045 pr_reg_tmp->pr_reg_nacl, pr_reg_tmp,
1046 register_type);
1047 spin_unlock(&pr_tmpl->registration_lock);
1049 * Drop configfs group dependency reference from
1050 * __core_scsi3_alloc_registration()
1052 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
1056 static int core_scsi3_alloc_registration(
1057 struct se_device *dev,
1058 struct se_node_acl *nacl,
1059 struct se_dev_entry *deve,
1060 unsigned char *isid,
1061 u64 sa_res_key,
1062 int all_tg_pt,
1063 int aptpl,
1064 enum register_type register_type,
1065 int register_move)
1067 struct t10_pr_registration *pr_reg;
1069 pr_reg = __core_scsi3_alloc_registration(dev, nacl, deve, isid,
1070 sa_res_key, all_tg_pt, aptpl);
1071 if (!pr_reg)
1072 return -EPERM;
1074 __core_scsi3_add_registration(dev, nacl, pr_reg,
1075 register_type, register_move);
1076 return 0;
1079 static struct t10_pr_registration *__core_scsi3_locate_pr_reg(
1080 struct se_device *dev,
1081 struct se_node_acl *nacl,
1082 unsigned char *isid)
1084 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1085 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
1086 struct se_portal_group *tpg;
1088 spin_lock(&pr_tmpl->registration_lock);
1089 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1090 &pr_tmpl->registration_list, pr_reg_list) {
1092 * First look for a matching struct se_node_acl
1094 if (pr_reg->pr_reg_nacl != nacl)
1095 continue;
1097 tpg = pr_reg->pr_reg_nacl->se_tpg;
1099 * If this registration does NOT contain a fabric provided
1100 * ISID, then we have found a match.
1102 if (!pr_reg->isid_present_at_reg) {
1104 * Determine if this SCSI device server requires that
1105 * SCSI Intiatior TransportID w/ ISIDs is enforced
1106 * for fabric modules (iSCSI) requiring them.
1108 if (tpg->se_tpg_tfo->sess_get_initiator_sid != NULL) {
1109 if (dev->dev_attrib.enforce_pr_isids)
1110 continue;
1112 atomic_inc(&pr_reg->pr_res_holders);
1113 smp_mb__after_atomic_inc();
1114 spin_unlock(&pr_tmpl->registration_lock);
1115 return pr_reg;
1118 * If the *pr_reg contains a fabric defined ISID for multi-value
1119 * SCSI Initiator Port TransportIDs, then we expect a valid
1120 * matching ISID to be provided by the local SCSI Initiator Port.
1122 if (!isid)
1123 continue;
1124 if (strcmp(isid, pr_reg->pr_reg_isid))
1125 continue;
1127 atomic_inc(&pr_reg->pr_res_holders);
1128 smp_mb__after_atomic_inc();
1129 spin_unlock(&pr_tmpl->registration_lock);
1130 return pr_reg;
1132 spin_unlock(&pr_tmpl->registration_lock);
1134 return NULL;
1137 static struct t10_pr_registration *core_scsi3_locate_pr_reg(
1138 struct se_device *dev,
1139 struct se_node_acl *nacl,
1140 struct se_session *sess)
1142 struct se_portal_group *tpg = nacl->se_tpg;
1143 unsigned char buf[PR_REG_ISID_LEN], *isid_ptr = NULL;
1145 if (tpg->se_tpg_tfo->sess_get_initiator_sid != NULL) {
1146 memset(&buf[0], 0, PR_REG_ISID_LEN);
1147 tpg->se_tpg_tfo->sess_get_initiator_sid(sess, &buf[0],
1148 PR_REG_ISID_LEN);
1149 isid_ptr = &buf[0];
1152 return __core_scsi3_locate_pr_reg(dev, nacl, isid_ptr);
1155 static void core_scsi3_put_pr_reg(struct t10_pr_registration *pr_reg)
1157 atomic_dec(&pr_reg->pr_res_holders);
1158 smp_mb__after_atomic_dec();
1161 static int core_scsi3_check_implicit_release(
1162 struct se_device *dev,
1163 struct t10_pr_registration *pr_reg)
1165 struct se_node_acl *nacl = pr_reg->pr_reg_nacl;
1166 struct t10_pr_registration *pr_res_holder;
1167 int ret = 0;
1169 spin_lock(&dev->dev_reservation_lock);
1170 pr_res_holder = dev->dev_pr_res_holder;
1171 if (!pr_res_holder) {
1172 spin_unlock(&dev->dev_reservation_lock);
1173 return ret;
1175 if (pr_res_holder == pr_reg) {
1177 * Perform an implicit RELEASE if the registration that
1178 * is being released is holding the reservation.
1180 * From spc4r17, section 5.7.11.1:
1182 * e) If the I_T nexus is the persistent reservation holder
1183 * and the persistent reservation is not an all registrants
1184 * type, then a PERSISTENT RESERVE OUT command with REGISTER
1185 * service action or REGISTER AND IGNORE EXISTING KEY
1186 * service action with the SERVICE ACTION RESERVATION KEY
1187 * field set to zero (see 5.7.11.3).
1189 __core_scsi3_complete_pro_release(dev, nacl, pr_reg, 0);
1190 ret = 1;
1192 * For 'All Registrants' reservation types, all existing
1193 * registrations are still processed as reservation holders
1194 * in core_scsi3_pr_seq_non_holder() after the initial
1195 * reservation holder is implicitly released here.
1197 } else if (pr_reg->pr_reg_all_tg_pt &&
1198 (!strcmp(pr_res_holder->pr_reg_nacl->initiatorname,
1199 pr_reg->pr_reg_nacl->initiatorname)) &&
1200 (pr_res_holder->pr_res_key == pr_reg->pr_res_key)) {
1201 pr_err("SPC-3 PR: Unable to perform ALL_TG_PT=1"
1202 " UNREGISTER while existing reservation with matching"
1203 " key 0x%016Lx is present from another SCSI Initiator"
1204 " Port\n", pr_reg->pr_res_key);
1205 ret = -EPERM;
1207 spin_unlock(&dev->dev_reservation_lock);
1209 return ret;
1213 * Called with struct t10_reservation->registration_lock held.
1215 static void __core_scsi3_free_registration(
1216 struct se_device *dev,
1217 struct t10_pr_registration *pr_reg,
1218 struct list_head *preempt_and_abort_list,
1219 int dec_holders)
1221 struct target_core_fabric_ops *tfo =
1222 pr_reg->pr_reg_nacl->se_tpg->se_tpg_tfo;
1223 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1224 char i_buf[PR_REG_ISID_ID_LEN];
1226 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
1227 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
1229 pr_reg->pr_reg_deve->def_pr_registered = 0;
1230 pr_reg->pr_reg_deve->pr_res_key = 0;
1231 list_del(&pr_reg->pr_reg_list);
1233 * Caller accessing *pr_reg using core_scsi3_locate_pr_reg(),
1234 * so call core_scsi3_put_pr_reg() to decrement our reference.
1236 if (dec_holders)
1237 core_scsi3_put_pr_reg(pr_reg);
1239 * Wait until all reference from any other I_T nexuses for this
1240 * *pr_reg have been released. Because list_del() is called above,
1241 * the last core_scsi3_put_pr_reg(pr_reg) will release this reference
1242 * count back to zero, and we release *pr_reg.
1244 while (atomic_read(&pr_reg->pr_res_holders) != 0) {
1245 spin_unlock(&pr_tmpl->registration_lock);
1246 pr_debug("SPC-3 PR [%s] waiting for pr_res_holders\n",
1247 tfo->get_fabric_name());
1248 cpu_relax();
1249 spin_lock(&pr_tmpl->registration_lock);
1252 pr_debug("SPC-3 PR [%s] Service Action: UNREGISTER Initiator"
1253 " Node: %s%s\n", tfo->get_fabric_name(),
1254 pr_reg->pr_reg_nacl->initiatorname,
1255 i_buf);
1256 pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
1257 " Port(s)\n", tfo->get_fabric_name(),
1258 (pr_reg->pr_reg_all_tg_pt) ? "ALL" : "SINGLE",
1259 dev->transport->name);
1260 pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
1261 " 0x%08x\n", tfo->get_fabric_name(), pr_reg->pr_res_key,
1262 pr_reg->pr_res_generation);
1264 if (!preempt_and_abort_list) {
1265 pr_reg->pr_reg_deve = NULL;
1266 pr_reg->pr_reg_nacl = NULL;
1267 kmem_cache_free(t10_pr_reg_cache, pr_reg);
1268 return;
1271 * For PREEMPT_AND_ABORT, the list of *pr_reg in preempt_and_abort_list
1272 * are released once the ABORT_TASK_SET has completed..
1274 list_add_tail(&pr_reg->pr_reg_abort_list, preempt_and_abort_list);
1277 void core_scsi3_free_pr_reg_from_nacl(
1278 struct se_device *dev,
1279 struct se_node_acl *nacl)
1281 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1282 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_res_holder;
1284 * If the passed se_node_acl matches the reservation holder,
1285 * release the reservation.
1287 spin_lock(&dev->dev_reservation_lock);
1288 pr_res_holder = dev->dev_pr_res_holder;
1289 if ((pr_res_holder != NULL) &&
1290 (pr_res_holder->pr_reg_nacl == nacl))
1291 __core_scsi3_complete_pro_release(dev, nacl, pr_res_holder, 0);
1292 spin_unlock(&dev->dev_reservation_lock);
1294 * Release any registration associated with the struct se_node_acl.
1296 spin_lock(&pr_tmpl->registration_lock);
1297 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1298 &pr_tmpl->registration_list, pr_reg_list) {
1300 if (pr_reg->pr_reg_nacl != nacl)
1301 continue;
1303 __core_scsi3_free_registration(dev, pr_reg, NULL, 0);
1305 spin_unlock(&pr_tmpl->registration_lock);
1308 void core_scsi3_free_all_registrations(
1309 struct se_device *dev)
1311 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1312 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_res_holder;
1314 spin_lock(&dev->dev_reservation_lock);
1315 pr_res_holder = dev->dev_pr_res_holder;
1316 if (pr_res_holder != NULL) {
1317 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
1318 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
1319 pr_res_holder, 0);
1321 spin_unlock(&dev->dev_reservation_lock);
1323 spin_lock(&pr_tmpl->registration_lock);
1324 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1325 &pr_tmpl->registration_list, pr_reg_list) {
1327 __core_scsi3_free_registration(dev, pr_reg, NULL, 0);
1329 spin_unlock(&pr_tmpl->registration_lock);
1331 spin_lock(&pr_tmpl->aptpl_reg_lock);
1332 list_for_each_entry_safe(pr_reg, pr_reg_tmp, &pr_tmpl->aptpl_reg_list,
1333 pr_reg_aptpl_list) {
1334 list_del(&pr_reg->pr_reg_aptpl_list);
1335 kmem_cache_free(t10_pr_reg_cache, pr_reg);
1337 spin_unlock(&pr_tmpl->aptpl_reg_lock);
1340 static int core_scsi3_tpg_depend_item(struct se_portal_group *tpg)
1342 return configfs_depend_item(tpg->se_tpg_tfo->tf_subsys,
1343 &tpg->tpg_group.cg_item);
1346 static void core_scsi3_tpg_undepend_item(struct se_portal_group *tpg)
1348 configfs_undepend_item(tpg->se_tpg_tfo->tf_subsys,
1349 &tpg->tpg_group.cg_item);
1351 atomic_dec(&tpg->tpg_pr_ref_count);
1352 smp_mb__after_atomic_dec();
1355 static int core_scsi3_nodeacl_depend_item(struct se_node_acl *nacl)
1357 struct se_portal_group *tpg = nacl->se_tpg;
1359 if (nacl->dynamic_node_acl)
1360 return 0;
1362 return configfs_depend_item(tpg->se_tpg_tfo->tf_subsys,
1363 &nacl->acl_group.cg_item);
1366 static void core_scsi3_nodeacl_undepend_item(struct se_node_acl *nacl)
1368 struct se_portal_group *tpg = nacl->se_tpg;
1370 if (nacl->dynamic_node_acl) {
1371 atomic_dec(&nacl->acl_pr_ref_count);
1372 smp_mb__after_atomic_dec();
1373 return;
1376 configfs_undepend_item(tpg->se_tpg_tfo->tf_subsys,
1377 &nacl->acl_group.cg_item);
1379 atomic_dec(&nacl->acl_pr_ref_count);
1380 smp_mb__after_atomic_dec();
1383 static int core_scsi3_lunacl_depend_item(struct se_dev_entry *se_deve)
1385 struct se_lun_acl *lun_acl = se_deve->se_lun_acl;
1386 struct se_node_acl *nacl;
1387 struct se_portal_group *tpg;
1389 * For nacl->dynamic_node_acl=1
1391 if (!lun_acl)
1392 return 0;
1394 nacl = lun_acl->se_lun_nacl;
1395 tpg = nacl->se_tpg;
1397 return configfs_depend_item(tpg->se_tpg_tfo->tf_subsys,
1398 &lun_acl->se_lun_group.cg_item);
1401 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry *se_deve)
1403 struct se_lun_acl *lun_acl = se_deve->se_lun_acl;
1404 struct se_node_acl *nacl;
1405 struct se_portal_group *tpg;
1407 * For nacl->dynamic_node_acl=1
1409 if (!lun_acl) {
1410 atomic_dec(&se_deve->pr_ref_count);
1411 smp_mb__after_atomic_dec();
1412 return;
1414 nacl = lun_acl->se_lun_nacl;
1415 tpg = nacl->se_tpg;
1417 configfs_undepend_item(tpg->se_tpg_tfo->tf_subsys,
1418 &lun_acl->se_lun_group.cg_item);
1420 atomic_dec(&se_deve->pr_ref_count);
1421 smp_mb__after_atomic_dec();
1424 static sense_reason_t
1425 core_scsi3_decode_spec_i_port(
1426 struct se_cmd *cmd,
1427 struct se_portal_group *tpg,
1428 unsigned char *l_isid,
1429 u64 sa_res_key,
1430 int all_tg_pt,
1431 int aptpl)
1433 struct se_device *dev = cmd->se_dev;
1434 struct se_port *tmp_port;
1435 struct se_portal_group *dest_tpg = NULL, *tmp_tpg;
1436 struct se_session *se_sess = cmd->se_sess;
1437 struct se_node_acl *dest_node_acl = NULL;
1438 struct se_dev_entry *dest_se_deve = NULL, *local_se_deve;
1439 struct t10_pr_registration *dest_pr_reg, *local_pr_reg, *pr_reg_e;
1440 struct t10_pr_registration *pr_reg_tmp, *pr_reg_tmp_safe;
1441 LIST_HEAD(tid_dest_list);
1442 struct pr_transport_id_holder *tidh_new, *tidh, *tidh_tmp;
1443 struct target_core_fabric_ops *tmp_tf_ops;
1444 unsigned char *buf;
1445 unsigned char *ptr, *i_str = NULL, proto_ident, tmp_proto_ident;
1446 char *iport_ptr = NULL, dest_iport[64], i_buf[PR_REG_ISID_ID_LEN];
1447 sense_reason_t ret;
1448 u32 tpdl, tid_len = 0;
1449 int dest_local_nexus;
1450 u32 dest_rtpi = 0;
1452 memset(dest_iport, 0, 64);
1454 local_se_deve = se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
1456 * Allocate a struct pr_transport_id_holder and setup the
1457 * local_node_acl and local_se_deve pointers and add to
1458 * struct list_head tid_dest_list for add registration
1459 * processing in the loop of tid_dest_list below.
1461 tidh_new = kzalloc(sizeof(struct pr_transport_id_holder), GFP_KERNEL);
1462 if (!tidh_new) {
1463 pr_err("Unable to allocate tidh_new\n");
1464 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1466 INIT_LIST_HEAD(&tidh_new->dest_list);
1467 tidh_new->dest_tpg = tpg;
1468 tidh_new->dest_node_acl = se_sess->se_node_acl;
1469 tidh_new->dest_se_deve = local_se_deve;
1471 local_pr_reg = __core_scsi3_alloc_registration(cmd->se_dev,
1472 se_sess->se_node_acl, local_se_deve, l_isid,
1473 sa_res_key, all_tg_pt, aptpl);
1474 if (!local_pr_reg) {
1475 kfree(tidh_new);
1476 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1478 tidh_new->dest_pr_reg = local_pr_reg;
1480 * The local I_T nexus does not hold any configfs dependances,
1481 * so we set tid_h->dest_local_nexus=1 to prevent the
1482 * configfs_undepend_item() calls in the tid_dest_list loops below.
1484 tidh_new->dest_local_nexus = 1;
1485 list_add_tail(&tidh_new->dest_list, &tid_dest_list);
1487 if (cmd->data_length < 28) {
1488 pr_warn("SPC-PR: Received PR OUT parameter list"
1489 " length too small: %u\n", cmd->data_length);
1490 ret = TCM_INVALID_PARAMETER_LIST;
1491 goto out;
1494 buf = transport_kmap_data_sg(cmd);
1495 if (!buf) {
1496 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1497 goto out;
1501 * For a PERSISTENT RESERVE OUT specify initiator ports payload,
1502 * first extract TransportID Parameter Data Length, and make sure
1503 * the value matches up to the SCSI expected data transfer length.
1505 tpdl = (buf[24] & 0xff) << 24;
1506 tpdl |= (buf[25] & 0xff) << 16;
1507 tpdl |= (buf[26] & 0xff) << 8;
1508 tpdl |= buf[27] & 0xff;
1510 if ((tpdl + 28) != cmd->data_length) {
1511 pr_err("SPC-3 PR: Illegal tpdl: %u + 28 byte header"
1512 " does not equal CDB data_length: %u\n", tpdl,
1513 cmd->data_length);
1514 ret = TCM_INVALID_PARAMETER_LIST;
1515 goto out_unmap;
1518 * Start processing the received transport IDs using the
1519 * receiving I_T Nexus portal's fabric dependent methods to
1520 * obtain the SCSI Initiator Port/Device Identifiers.
1522 ptr = &buf[28];
1524 while (tpdl > 0) {
1525 proto_ident = (ptr[0] & 0x0f);
1526 dest_tpg = NULL;
1528 spin_lock(&dev->se_port_lock);
1529 list_for_each_entry(tmp_port, &dev->dev_sep_list, sep_list) {
1530 tmp_tpg = tmp_port->sep_tpg;
1531 if (!tmp_tpg)
1532 continue;
1533 tmp_tf_ops = tmp_tpg->se_tpg_tfo;
1534 if (!tmp_tf_ops)
1535 continue;
1536 if (!tmp_tf_ops->get_fabric_proto_ident ||
1537 !tmp_tf_ops->tpg_parse_pr_out_transport_id)
1538 continue;
1540 * Look for the matching proto_ident provided by
1541 * the received TransportID
1543 tmp_proto_ident = tmp_tf_ops->get_fabric_proto_ident(tmp_tpg);
1544 if (tmp_proto_ident != proto_ident)
1545 continue;
1546 dest_rtpi = tmp_port->sep_rtpi;
1548 i_str = tmp_tf_ops->tpg_parse_pr_out_transport_id(
1549 tmp_tpg, (const char *)ptr, &tid_len,
1550 &iport_ptr);
1551 if (!i_str)
1552 continue;
1554 atomic_inc(&tmp_tpg->tpg_pr_ref_count);
1555 smp_mb__after_atomic_inc();
1556 spin_unlock(&dev->se_port_lock);
1558 if (core_scsi3_tpg_depend_item(tmp_tpg)) {
1559 pr_err(" core_scsi3_tpg_depend_item()"
1560 " for tmp_tpg\n");
1561 atomic_dec(&tmp_tpg->tpg_pr_ref_count);
1562 smp_mb__after_atomic_dec();
1563 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1564 goto out_unmap;
1567 * Locate the destination initiator ACL to be registered
1568 * from the decoded fabric module specific TransportID
1569 * at *i_str.
1571 spin_lock_irq(&tmp_tpg->acl_node_lock);
1572 dest_node_acl = __core_tpg_get_initiator_node_acl(
1573 tmp_tpg, i_str);
1574 if (dest_node_acl) {
1575 atomic_inc(&dest_node_acl->acl_pr_ref_count);
1576 smp_mb__after_atomic_inc();
1578 spin_unlock_irq(&tmp_tpg->acl_node_lock);
1580 if (!dest_node_acl) {
1581 core_scsi3_tpg_undepend_item(tmp_tpg);
1582 spin_lock(&dev->se_port_lock);
1583 continue;
1586 if (core_scsi3_nodeacl_depend_item(dest_node_acl)) {
1587 pr_err("configfs_depend_item() failed"
1588 " for dest_node_acl->acl_group\n");
1589 atomic_dec(&dest_node_acl->acl_pr_ref_count);
1590 smp_mb__after_atomic_dec();
1591 core_scsi3_tpg_undepend_item(tmp_tpg);
1592 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1593 goto out_unmap;
1596 dest_tpg = tmp_tpg;
1597 pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node:"
1598 " %s Port RTPI: %hu\n",
1599 dest_tpg->se_tpg_tfo->get_fabric_name(),
1600 dest_node_acl->initiatorname, dest_rtpi);
1602 spin_lock(&dev->se_port_lock);
1603 break;
1605 spin_unlock(&dev->se_port_lock);
1607 if (!dest_tpg) {
1608 pr_err("SPC-3 PR SPEC_I_PT: Unable to locate"
1609 " dest_tpg\n");
1610 ret = TCM_INVALID_PARAMETER_LIST;
1611 goto out_unmap;
1614 pr_debug("SPC-3 PR SPEC_I_PT: Got %s data_length: %u tpdl: %u"
1615 " tid_len: %d for %s + %s\n",
1616 dest_tpg->se_tpg_tfo->get_fabric_name(), cmd->data_length,
1617 tpdl, tid_len, i_str, iport_ptr);
1619 if (tid_len > tpdl) {
1620 pr_err("SPC-3 PR SPEC_I_PT: Illegal tid_len:"
1621 " %u for Transport ID: %s\n", tid_len, ptr);
1622 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1623 core_scsi3_tpg_undepend_item(dest_tpg);
1624 ret = TCM_INVALID_PARAMETER_LIST;
1625 goto out_unmap;
1628 * Locate the desintation struct se_dev_entry pointer for matching
1629 * RELATIVE TARGET PORT IDENTIFIER on the receiving I_T Nexus
1630 * Target Port.
1632 dest_se_deve = core_get_se_deve_from_rtpi(dest_node_acl,
1633 dest_rtpi);
1634 if (!dest_se_deve) {
1635 pr_err("Unable to locate %s dest_se_deve"
1636 " from destination RTPI: %hu\n",
1637 dest_tpg->se_tpg_tfo->get_fabric_name(),
1638 dest_rtpi);
1640 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1641 core_scsi3_tpg_undepend_item(dest_tpg);
1642 ret = TCM_INVALID_PARAMETER_LIST;
1643 goto out_unmap;
1646 if (core_scsi3_lunacl_depend_item(dest_se_deve)) {
1647 pr_err("core_scsi3_lunacl_depend_item()"
1648 " failed\n");
1649 atomic_dec(&dest_se_deve->pr_ref_count);
1650 smp_mb__after_atomic_dec();
1651 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1652 core_scsi3_tpg_undepend_item(dest_tpg);
1653 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1654 goto out_unmap;
1657 pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node: %s"
1658 " dest_se_deve mapped_lun: %u\n",
1659 dest_tpg->se_tpg_tfo->get_fabric_name(),
1660 dest_node_acl->initiatorname, dest_se_deve->mapped_lun);
1663 * Skip any TransportIDs that already have a registration for
1664 * this target port.
1666 pr_reg_e = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
1667 iport_ptr);
1668 if (pr_reg_e) {
1669 core_scsi3_put_pr_reg(pr_reg_e);
1670 core_scsi3_lunacl_undepend_item(dest_se_deve);
1671 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1672 core_scsi3_tpg_undepend_item(dest_tpg);
1673 ptr += tid_len;
1674 tpdl -= tid_len;
1675 tid_len = 0;
1676 continue;
1679 * Allocate a struct pr_transport_id_holder and setup
1680 * the dest_node_acl and dest_se_deve pointers for the
1681 * loop below.
1683 tidh_new = kzalloc(sizeof(struct pr_transport_id_holder),
1684 GFP_KERNEL);
1685 if (!tidh_new) {
1686 pr_err("Unable to allocate tidh_new\n");
1687 core_scsi3_lunacl_undepend_item(dest_se_deve);
1688 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1689 core_scsi3_tpg_undepend_item(dest_tpg);
1690 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1691 goto out_unmap;
1693 INIT_LIST_HEAD(&tidh_new->dest_list);
1694 tidh_new->dest_tpg = dest_tpg;
1695 tidh_new->dest_node_acl = dest_node_acl;
1696 tidh_new->dest_se_deve = dest_se_deve;
1699 * Allocate, but do NOT add the registration for the
1700 * TransportID referenced SCSI Initiator port. This
1701 * done because of the following from spc4r17 in section
1702 * 6.14.3 wrt SPEC_I_PT:
1704 * "If a registration fails for any initiator port (e.g., if th
1705 * logical unit does not have enough resources available to
1706 * hold the registration information), no registrations shall be
1707 * made, and the command shall be terminated with
1708 * CHECK CONDITION status."
1710 * That means we call __core_scsi3_alloc_registration() here,
1711 * and then call __core_scsi3_add_registration() in the
1712 * 2nd loop which will never fail.
1714 dest_pr_reg = __core_scsi3_alloc_registration(cmd->se_dev,
1715 dest_node_acl, dest_se_deve, iport_ptr,
1716 sa_res_key, all_tg_pt, aptpl);
1717 if (!dest_pr_reg) {
1718 core_scsi3_lunacl_undepend_item(dest_se_deve);
1719 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1720 core_scsi3_tpg_undepend_item(dest_tpg);
1721 kfree(tidh_new);
1722 ret = TCM_INVALID_PARAMETER_LIST;
1723 goto out_unmap;
1725 tidh_new->dest_pr_reg = dest_pr_reg;
1726 list_add_tail(&tidh_new->dest_list, &tid_dest_list);
1728 ptr += tid_len;
1729 tpdl -= tid_len;
1730 tid_len = 0;
1734 transport_kunmap_data_sg(cmd);
1737 * Go ahead and create a registrations from tid_dest_list for the
1738 * SPEC_I_PT provided TransportID for the *tidh referenced dest_node_acl
1739 * and dest_se_deve.
1741 * The SA Reservation Key from the PROUT is set for the
1742 * registration, and ALL_TG_PT is also passed. ALL_TG_PT=1
1743 * means that the TransportID Initiator port will be
1744 * registered on all of the target ports in the SCSI target device
1745 * ALL_TG_PT=0 means the registration will only be for the
1746 * SCSI target port the PROUT REGISTER with SPEC_I_PT=1
1747 * was received.
1749 list_for_each_entry_safe(tidh, tidh_tmp, &tid_dest_list, dest_list) {
1750 dest_tpg = tidh->dest_tpg;
1751 dest_node_acl = tidh->dest_node_acl;
1752 dest_se_deve = tidh->dest_se_deve;
1753 dest_pr_reg = tidh->dest_pr_reg;
1754 dest_local_nexus = tidh->dest_local_nexus;
1756 list_del(&tidh->dest_list);
1757 kfree(tidh);
1759 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
1760 core_pr_dump_initiator_port(dest_pr_reg, i_buf, PR_REG_ISID_ID_LEN);
1762 __core_scsi3_add_registration(cmd->se_dev, dest_node_acl,
1763 dest_pr_reg, 0, 0);
1765 pr_debug("SPC-3 PR [%s] SPEC_I_PT: Successfully"
1766 " registered Transport ID for Node: %s%s Mapped LUN:"
1767 " %u\n", dest_tpg->se_tpg_tfo->get_fabric_name(),
1768 dest_node_acl->initiatorname, i_buf, dest_se_deve->mapped_lun);
1770 if (dest_local_nexus)
1771 continue;
1773 core_scsi3_lunacl_undepend_item(dest_se_deve);
1774 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1775 core_scsi3_tpg_undepend_item(dest_tpg);
1778 return 0;
1779 out_unmap:
1780 transport_kunmap_data_sg(cmd);
1781 out:
1783 * For the failure case, release everything from tid_dest_list
1784 * including *dest_pr_reg and the configfs dependances..
1786 list_for_each_entry_safe(tidh, tidh_tmp, &tid_dest_list, dest_list) {
1787 dest_tpg = tidh->dest_tpg;
1788 dest_node_acl = tidh->dest_node_acl;
1789 dest_se_deve = tidh->dest_se_deve;
1790 dest_pr_reg = tidh->dest_pr_reg;
1791 dest_local_nexus = tidh->dest_local_nexus;
1793 list_del(&tidh->dest_list);
1794 kfree(tidh);
1796 * Release any extra ALL_TG_PT=1 registrations for
1797 * the SPEC_I_PT=1 case.
1799 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
1800 &dest_pr_reg->pr_reg_atp_list,
1801 pr_reg_atp_mem_list) {
1802 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
1803 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
1804 kmem_cache_free(t10_pr_reg_cache, pr_reg_tmp);
1807 kmem_cache_free(t10_pr_reg_cache, dest_pr_reg);
1809 if (dest_local_nexus)
1810 continue;
1812 core_scsi3_lunacl_undepend_item(dest_se_deve);
1813 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1814 core_scsi3_tpg_undepend_item(dest_tpg);
1816 return ret;
1819 static int core_scsi3_update_aptpl_buf(
1820 struct se_device *dev,
1821 unsigned char *buf,
1822 u32 pr_aptpl_buf_len)
1824 struct se_lun *lun;
1825 struct se_portal_group *tpg;
1826 struct t10_pr_registration *pr_reg;
1827 unsigned char tmp[512], isid_buf[32];
1828 ssize_t len = 0;
1829 int reg_count = 0;
1830 int ret = 0;
1832 spin_lock(&dev->dev_reservation_lock);
1833 spin_lock(&dev->t10_pr.registration_lock);
1835 * Walk the registration list..
1837 list_for_each_entry(pr_reg, &dev->t10_pr.registration_list,
1838 pr_reg_list) {
1840 tmp[0] = '\0';
1841 isid_buf[0] = '\0';
1842 tpg = pr_reg->pr_reg_nacl->se_tpg;
1843 lun = pr_reg->pr_reg_tg_pt_lun;
1845 * Write out any ISID value to APTPL metadata that was included
1846 * in the original registration.
1848 if (pr_reg->isid_present_at_reg)
1849 snprintf(isid_buf, 32, "initiator_sid=%s\n",
1850 pr_reg->pr_reg_isid);
1852 * Include special metadata if the pr_reg matches the
1853 * reservation holder.
1855 if (dev->dev_pr_res_holder == pr_reg) {
1856 snprintf(tmp, 512, "PR_REG_START: %d"
1857 "\ninitiator_fabric=%s\n"
1858 "initiator_node=%s\n%s"
1859 "sa_res_key=%llu\n"
1860 "res_holder=1\nres_type=%02x\n"
1861 "res_scope=%02x\nres_all_tg_pt=%d\n"
1862 "mapped_lun=%u\n", reg_count,
1863 tpg->se_tpg_tfo->get_fabric_name(),
1864 pr_reg->pr_reg_nacl->initiatorname, isid_buf,
1865 pr_reg->pr_res_key, pr_reg->pr_res_type,
1866 pr_reg->pr_res_scope, pr_reg->pr_reg_all_tg_pt,
1867 pr_reg->pr_res_mapped_lun);
1868 } else {
1869 snprintf(tmp, 512, "PR_REG_START: %d\n"
1870 "initiator_fabric=%s\ninitiator_node=%s\n%s"
1871 "sa_res_key=%llu\nres_holder=0\n"
1872 "res_all_tg_pt=%d\nmapped_lun=%u\n",
1873 reg_count, tpg->se_tpg_tfo->get_fabric_name(),
1874 pr_reg->pr_reg_nacl->initiatorname, isid_buf,
1875 pr_reg->pr_res_key, pr_reg->pr_reg_all_tg_pt,
1876 pr_reg->pr_res_mapped_lun);
1879 if ((len + strlen(tmp) >= pr_aptpl_buf_len)) {
1880 pr_err("Unable to update renaming"
1881 " APTPL metadata\n");
1882 ret = -EMSGSIZE;
1883 goto out;
1885 len += sprintf(buf+len, "%s", tmp);
1888 * Include information about the associated SCSI target port.
1890 snprintf(tmp, 512, "target_fabric=%s\ntarget_node=%s\n"
1891 "tpgt=%hu\nport_rtpi=%hu\ntarget_lun=%u\nPR_REG_END:"
1892 " %d\n", tpg->se_tpg_tfo->get_fabric_name(),
1893 tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1894 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1895 lun->lun_sep->sep_rtpi, lun->unpacked_lun, reg_count);
1897 if ((len + strlen(tmp) >= pr_aptpl_buf_len)) {
1898 pr_err("Unable to update renaming"
1899 " APTPL metadata\n");
1900 ret = -EMSGSIZE;
1901 goto out;
1903 len += sprintf(buf+len, "%s", tmp);
1904 reg_count++;
1907 if (!reg_count)
1908 len += sprintf(buf+len, "No Registrations or Reservations");
1910 out:
1911 spin_unlock(&dev->t10_pr.registration_lock);
1912 spin_unlock(&dev->dev_reservation_lock);
1914 return ret;
1917 static int __core_scsi3_write_aptpl_to_file(
1918 struct se_device *dev,
1919 unsigned char *buf)
1921 struct t10_wwn *wwn = &dev->t10_wwn;
1922 struct file *file;
1923 int flags = O_RDWR | O_CREAT | O_TRUNC;
1924 char path[512];
1925 u32 pr_aptpl_buf_len;
1926 int ret;
1928 memset(path, 0, 512);
1930 if (strlen(&wwn->unit_serial[0]) >= 512) {
1931 pr_err("WWN value for struct se_device does not fit"
1932 " into path buffer\n");
1933 return -EMSGSIZE;
1936 snprintf(path, 512, "/var/target/pr/aptpl_%s", &wwn->unit_serial[0]);
1937 file = filp_open(path, flags, 0600);
1938 if (IS_ERR(file)) {
1939 pr_err("filp_open(%s) for APTPL metadata"
1940 " failed\n", path);
1941 return PTR_ERR(file);
1944 pr_aptpl_buf_len = (strlen(buf) + 1); /* Add extra for NULL */
1946 ret = kernel_write(file, buf, pr_aptpl_buf_len, 0);
1948 if (ret < 0)
1949 pr_debug("Error writing APTPL metadata file: %s\n", path);
1950 fput(file);
1952 return (ret < 0) ? -EIO : 0;
1956 * Clear the APTPL metadata if APTPL has been disabled, otherwise
1957 * write out the updated metadata to struct file for this SCSI device.
1959 static sense_reason_t core_scsi3_update_and_write_aptpl(struct se_device *dev, bool aptpl)
1961 unsigned char *buf;
1962 int rc;
1964 if (!aptpl) {
1965 char *null_buf = "No Registrations or Reservations\n";
1967 rc = __core_scsi3_write_aptpl_to_file(dev, null_buf);
1968 dev->t10_pr.pr_aptpl_active = 0;
1969 pr_debug("SPC-3 PR: Set APTPL Bit Deactivated\n");
1971 if (rc)
1972 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1974 return 0;
1977 buf = kzalloc(PR_APTPL_BUF_LEN, GFP_KERNEL);
1978 if (!buf)
1979 return TCM_OUT_OF_RESOURCES;
1981 rc = core_scsi3_update_aptpl_buf(dev, buf, PR_APTPL_BUF_LEN);
1982 if (rc < 0) {
1983 kfree(buf);
1984 return TCM_OUT_OF_RESOURCES;
1987 rc = __core_scsi3_write_aptpl_to_file(dev, buf);
1988 if (rc != 0) {
1989 pr_err("SPC-3 PR: Could not update APTPL\n");
1990 kfree(buf);
1991 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1993 dev->t10_pr.pr_aptpl_active = 1;
1994 kfree(buf);
1995 pr_debug("SPC-3 PR: Set APTPL Bit Activated\n");
1996 return 0;
1999 static sense_reason_t
2000 core_scsi3_emulate_pro_register(struct se_cmd *cmd, u64 res_key, u64 sa_res_key,
2001 bool aptpl, bool all_tg_pt, bool spec_i_pt, enum register_type register_type)
2003 struct se_session *se_sess = cmd->se_sess;
2004 struct se_device *dev = cmd->se_dev;
2005 struct se_dev_entry *se_deve;
2006 struct se_lun *se_lun = cmd->se_lun;
2007 struct se_portal_group *se_tpg;
2008 struct t10_pr_registration *pr_reg, *pr_reg_p, *pr_reg_tmp;
2009 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2010 unsigned char isid_buf[PR_REG_ISID_LEN], *isid_ptr = NULL;
2011 sense_reason_t ret = TCM_NO_SENSE;
2012 int pr_holder = 0, type;
2014 if (!se_sess || !se_lun) {
2015 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2016 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2018 se_tpg = se_sess->se_tpg;
2019 se_deve = se_sess->se_node_acl->device_list[cmd->orig_fe_lun];
2021 if (se_tpg->se_tpg_tfo->sess_get_initiator_sid) {
2022 memset(&isid_buf[0], 0, PR_REG_ISID_LEN);
2023 se_tpg->se_tpg_tfo->sess_get_initiator_sid(se_sess, &isid_buf[0],
2024 PR_REG_ISID_LEN);
2025 isid_ptr = &isid_buf[0];
2028 * Follow logic from spc4r17 Section 5.7.7, Register Behaviors Table 47
2030 pr_reg = core_scsi3_locate_pr_reg(dev, se_sess->se_node_acl, se_sess);
2031 if (!pr_reg) {
2032 if (res_key) {
2033 pr_warn("SPC-3 PR: Reservation Key non-zero"
2034 " for SA REGISTER, returning CONFLICT\n");
2035 return TCM_RESERVATION_CONFLICT;
2038 * Do nothing but return GOOD status.
2040 if (!sa_res_key)
2041 return 0;
2043 if (!spec_i_pt) {
2045 * Perform the Service Action REGISTER on the Initiator
2046 * Port Endpoint that the PRO was received from on the
2047 * Logical Unit of the SCSI device server.
2049 if (core_scsi3_alloc_registration(cmd->se_dev,
2050 se_sess->se_node_acl, se_deve, isid_ptr,
2051 sa_res_key, all_tg_pt, aptpl,
2052 register_type, 0)) {
2053 pr_err("Unable to allocate"
2054 " struct t10_pr_registration\n");
2055 return TCM_INVALID_PARAMETER_LIST;
2057 } else {
2059 * Register both the Initiator port that received
2060 * PROUT SA REGISTER + SPEC_I_PT=1 and extract SCSI
2061 * TransportID from Parameter list and loop through
2062 * fabric dependent parameter list while calling
2063 * logic from of core_scsi3_alloc_registration() for
2064 * each TransportID provided SCSI Initiator Port/Device
2066 ret = core_scsi3_decode_spec_i_port(cmd, se_tpg,
2067 isid_ptr, sa_res_key, all_tg_pt, aptpl);
2068 if (ret != 0)
2069 return ret;
2072 return core_scsi3_update_and_write_aptpl(dev, aptpl);
2075 /* ok, existing registration */
2077 if ((register_type == REGISTER) && (res_key != pr_reg->pr_res_key)) {
2078 pr_err("SPC-3 PR REGISTER: Received"
2079 " res_key: 0x%016Lx does not match"
2080 " existing SA REGISTER res_key:"
2081 " 0x%016Lx\n", res_key,
2082 pr_reg->pr_res_key);
2083 ret = TCM_RESERVATION_CONFLICT;
2084 goto out;
2087 if (spec_i_pt) {
2088 pr_err("SPC-3 PR REGISTER: SPEC_I_PT"
2089 " set on a registered nexus\n");
2090 ret = TCM_INVALID_PARAMETER_LIST;
2091 goto out;
2095 * An existing ALL_TG_PT=1 registration being released
2096 * must also set ALL_TG_PT=1 in the incoming PROUT.
2098 if (pr_reg->pr_reg_all_tg_pt && !all_tg_pt) {
2099 pr_err("SPC-3 PR REGISTER: ALL_TG_PT=1"
2100 " registration exists, but ALL_TG_PT=1 bit not"
2101 " present in received PROUT\n");
2102 ret = TCM_INVALID_CDB_FIELD;
2103 goto out;
2107 * sa_res_key=1 Change Reservation Key for registered I_T Nexus.
2109 if (sa_res_key) {
2111 * Increment PRgeneration counter for struct se_device"
2112 * upon a successful REGISTER, see spc4r17 section 6.3.2
2113 * READ_KEYS service action.
2115 pr_reg->pr_res_generation = core_scsi3_pr_generation(cmd->se_dev);
2116 pr_reg->pr_res_key = sa_res_key;
2117 pr_debug("SPC-3 PR [%s] REGISTER%s: Changed Reservation"
2118 " Key for %s to: 0x%016Lx PRgeneration:"
2119 " 0x%08x\n", cmd->se_tfo->get_fabric_name(),
2120 (register_type == REGISTER_AND_IGNORE_EXISTING_KEY) ? "_AND_IGNORE_EXISTING_KEY" : "",
2121 pr_reg->pr_reg_nacl->initiatorname,
2122 pr_reg->pr_res_key, pr_reg->pr_res_generation);
2124 } else {
2126 * sa_res_key=0 Unregister Reservation Key for registered I_T Nexus.
2128 pr_holder = core_scsi3_check_implicit_release(
2129 cmd->se_dev, pr_reg);
2130 if (pr_holder < 0) {
2131 ret = TCM_RESERVATION_CONFLICT;
2132 goto out;
2134 type = pr_reg->pr_res_type;
2136 spin_lock(&pr_tmpl->registration_lock);
2138 * Release all ALL_TG_PT=1 for the matching SCSI Initiator Port
2139 * and matching pr_res_key.
2141 if (pr_reg->pr_reg_all_tg_pt) {
2142 list_for_each_entry_safe(pr_reg_p, pr_reg_tmp,
2143 &pr_tmpl->registration_list,
2144 pr_reg_list) {
2146 if (!pr_reg_p->pr_reg_all_tg_pt)
2147 continue;
2148 if (pr_reg_p->pr_res_key != res_key)
2149 continue;
2150 if (pr_reg == pr_reg_p)
2151 continue;
2152 if (strcmp(pr_reg->pr_reg_nacl->initiatorname,
2153 pr_reg_p->pr_reg_nacl->initiatorname))
2154 continue;
2156 __core_scsi3_free_registration(dev,
2157 pr_reg_p, NULL, 0);
2162 * Release the calling I_T Nexus registration now..
2164 __core_scsi3_free_registration(cmd->se_dev, pr_reg, NULL, 1);
2165 pr_reg = NULL;
2168 * From spc4r17, section 5.7.11.3 Unregistering
2170 * If the persistent reservation is a registrants only
2171 * type, the device server shall establish a unit
2172 * attention condition for the initiator port associated
2173 * with every registered I_T nexus except for the I_T
2174 * nexus on which the PERSISTENT RESERVE OUT command was
2175 * received, with the additional sense code set to
2176 * RESERVATIONS RELEASED.
2178 if (pr_holder &&
2179 (type == PR_TYPE_WRITE_EXCLUSIVE_REGONLY ||
2180 type == PR_TYPE_EXCLUSIVE_ACCESS_REGONLY)) {
2181 list_for_each_entry(pr_reg_p,
2182 &pr_tmpl->registration_list,
2183 pr_reg_list) {
2185 core_scsi3_ua_allocate(
2186 pr_reg_p->pr_reg_nacl,
2187 pr_reg_p->pr_res_mapped_lun,
2188 0x2A,
2189 ASCQ_2AH_RESERVATIONS_RELEASED);
2193 spin_unlock(&pr_tmpl->registration_lock);
2196 ret = core_scsi3_update_and_write_aptpl(dev, aptpl);
2198 out:
2199 if (pr_reg)
2200 core_scsi3_put_pr_reg(pr_reg);
2201 return ret;
2204 unsigned char *core_scsi3_pr_dump_type(int type)
2206 switch (type) {
2207 case PR_TYPE_WRITE_EXCLUSIVE:
2208 return "Write Exclusive Access";
2209 case PR_TYPE_EXCLUSIVE_ACCESS:
2210 return "Exclusive Access";
2211 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
2212 return "Write Exclusive Access, Registrants Only";
2213 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
2214 return "Exclusive Access, Registrants Only";
2215 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
2216 return "Write Exclusive Access, All Registrants";
2217 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
2218 return "Exclusive Access, All Registrants";
2219 default:
2220 break;
2223 return "Unknown SPC-3 PR Type";
2226 static sense_reason_t
2227 core_scsi3_pro_reserve(struct se_cmd *cmd, int type, int scope, u64 res_key)
2229 struct se_device *dev = cmd->se_dev;
2230 struct se_session *se_sess = cmd->se_sess;
2231 struct se_lun *se_lun = cmd->se_lun;
2232 struct t10_pr_registration *pr_reg, *pr_res_holder;
2233 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2234 char i_buf[PR_REG_ISID_ID_LEN];
2235 sense_reason_t ret;
2237 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2239 if (!se_sess || !se_lun) {
2240 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2241 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2244 * Locate the existing *pr_reg via struct se_node_acl pointers
2246 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
2247 se_sess);
2248 if (!pr_reg) {
2249 pr_err("SPC-3 PR: Unable to locate"
2250 " PR_REGISTERED *pr_reg for RESERVE\n");
2251 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2254 * From spc4r17 Section 5.7.9: Reserving:
2256 * An application client creates a persistent reservation by issuing
2257 * a PERSISTENT RESERVE OUT command with RESERVE service action through
2258 * a registered I_T nexus with the following parameters:
2259 * a) RESERVATION KEY set to the value of the reservation key that is
2260 * registered with the logical unit for the I_T nexus; and
2262 if (res_key != pr_reg->pr_res_key) {
2263 pr_err("SPC-3 PR RESERVE: Received res_key: 0x%016Lx"
2264 " does not match existing SA REGISTER res_key:"
2265 " 0x%016Lx\n", res_key, pr_reg->pr_res_key);
2266 ret = TCM_RESERVATION_CONFLICT;
2267 goto out_put_pr_reg;
2270 * From spc4r17 Section 5.7.9: Reserving:
2272 * From above:
2273 * b) TYPE field and SCOPE field set to the persistent reservation
2274 * being created.
2276 * Only one persistent reservation is allowed at a time per logical unit
2277 * and that persistent reservation has a scope of LU_SCOPE.
2279 if (scope != PR_SCOPE_LU_SCOPE) {
2280 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope);
2281 ret = TCM_INVALID_PARAMETER_LIST;
2282 goto out_put_pr_reg;
2285 * See if we have an existing PR reservation holder pointer at
2286 * struct se_device->dev_pr_res_holder in the form struct t10_pr_registration
2287 * *pr_res_holder.
2289 spin_lock(&dev->dev_reservation_lock);
2290 pr_res_holder = dev->dev_pr_res_holder;
2291 if (pr_res_holder) {
2293 * From spc4r17 Section 5.7.9: Reserving:
2295 * If the device server receives a PERSISTENT RESERVE OUT
2296 * command from an I_T nexus other than a persistent reservation
2297 * holder (see 5.7.10) that attempts to create a persistent
2298 * reservation when a persistent reservation already exists for
2299 * the logical unit, then the command shall be completed with
2300 * RESERVATION CONFLICT status.
2302 if (pr_res_holder != pr_reg) {
2303 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2304 pr_err("SPC-3 PR: Attempted RESERVE from"
2305 " [%s]: %s while reservation already held by"
2306 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2307 cmd->se_tfo->get_fabric_name(),
2308 se_sess->se_node_acl->initiatorname,
2309 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2310 pr_res_holder->pr_reg_nacl->initiatorname);
2312 spin_unlock(&dev->dev_reservation_lock);
2313 ret = TCM_RESERVATION_CONFLICT;
2314 goto out_put_pr_reg;
2317 * From spc4r17 Section 5.7.9: Reserving:
2319 * If a persistent reservation holder attempts to modify the
2320 * type or scope of an existing persistent reservation, the
2321 * command shall be completed with RESERVATION CONFLICT status.
2323 if ((pr_res_holder->pr_res_type != type) ||
2324 (pr_res_holder->pr_res_scope != scope)) {
2325 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2326 pr_err("SPC-3 PR: Attempted RESERVE from"
2327 " [%s]: %s trying to change TYPE and/or SCOPE,"
2328 " while reservation already held by [%s]: %s,"
2329 " returning RESERVATION_CONFLICT\n",
2330 cmd->se_tfo->get_fabric_name(),
2331 se_sess->se_node_acl->initiatorname,
2332 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2333 pr_res_holder->pr_reg_nacl->initiatorname);
2335 spin_unlock(&dev->dev_reservation_lock);
2336 ret = TCM_RESERVATION_CONFLICT;
2337 goto out_put_pr_reg;
2340 * From spc4r17 Section 5.7.9: Reserving:
2342 * If the device server receives a PERSISTENT RESERVE OUT
2343 * command with RESERVE service action where the TYPE field and
2344 * the SCOPE field contain the same values as the existing type
2345 * and scope from a persistent reservation holder, it shall not
2346 * make any change to the existing persistent reservation and
2347 * shall completethe command with GOOD status.
2349 spin_unlock(&dev->dev_reservation_lock);
2350 ret = 0;
2351 goto out_put_pr_reg;
2354 * Otherwise, our *pr_reg becomes the PR reservation holder for said
2355 * TYPE/SCOPE. Also set the received scope and type in *pr_reg.
2357 pr_reg->pr_res_scope = scope;
2358 pr_reg->pr_res_type = type;
2359 pr_reg->pr_res_holder = 1;
2360 dev->dev_pr_res_holder = pr_reg;
2361 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2363 pr_debug("SPC-3 PR [%s] Service Action: RESERVE created new"
2364 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2365 cmd->se_tfo->get_fabric_name(), core_scsi3_pr_dump_type(type),
2366 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2367 pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
2368 cmd->se_tfo->get_fabric_name(),
2369 se_sess->se_node_acl->initiatorname,
2370 i_buf);
2371 spin_unlock(&dev->dev_reservation_lock);
2373 if (pr_tmpl->pr_aptpl_active)
2374 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
2376 ret = 0;
2377 out_put_pr_reg:
2378 core_scsi3_put_pr_reg(pr_reg);
2379 return ret;
2382 static sense_reason_t
2383 core_scsi3_emulate_pro_reserve(struct se_cmd *cmd, int type, int scope,
2384 u64 res_key)
2386 switch (type) {
2387 case PR_TYPE_WRITE_EXCLUSIVE:
2388 case PR_TYPE_EXCLUSIVE_ACCESS:
2389 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
2390 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
2391 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
2392 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
2393 return core_scsi3_pro_reserve(cmd, type, scope, res_key);
2394 default:
2395 pr_err("SPC-3 PR: Unknown Service Action RESERVE Type:"
2396 " 0x%02x\n", type);
2397 return TCM_INVALID_CDB_FIELD;
2402 * Called with struct se_device->dev_reservation_lock held.
2404 static void __core_scsi3_complete_pro_release(
2405 struct se_device *dev,
2406 struct se_node_acl *se_nacl,
2407 struct t10_pr_registration *pr_reg,
2408 int explicit)
2410 struct target_core_fabric_ops *tfo = se_nacl->se_tpg->se_tpg_tfo;
2411 char i_buf[PR_REG_ISID_ID_LEN];
2413 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2414 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2416 * Go ahead and release the current PR reservation holder.
2418 dev->dev_pr_res_holder = NULL;
2420 pr_debug("SPC-3 PR [%s] Service Action: %s RELEASE cleared"
2421 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2422 tfo->get_fabric_name(), (explicit) ? "explicit" : "implicit",
2423 core_scsi3_pr_dump_type(pr_reg->pr_res_type),
2424 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2425 pr_debug("SPC-3 PR [%s] RELEASE Node: %s%s\n",
2426 tfo->get_fabric_name(), se_nacl->initiatorname,
2427 i_buf);
2429 * Clear TYPE and SCOPE for the next PROUT Service Action: RESERVE
2431 pr_reg->pr_res_holder = pr_reg->pr_res_type = pr_reg->pr_res_scope = 0;
2434 static sense_reason_t
2435 core_scsi3_emulate_pro_release(struct se_cmd *cmd, int type, int scope,
2436 u64 res_key)
2438 struct se_device *dev = cmd->se_dev;
2439 struct se_session *se_sess = cmd->se_sess;
2440 struct se_lun *se_lun = cmd->se_lun;
2441 struct t10_pr_registration *pr_reg, *pr_reg_p, *pr_res_holder;
2442 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2443 int all_reg = 0;
2444 sense_reason_t ret = 0;
2446 if (!se_sess || !se_lun) {
2447 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2448 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2451 * Locate the existing *pr_reg via struct se_node_acl pointers
2453 pr_reg = core_scsi3_locate_pr_reg(dev, se_sess->se_node_acl, se_sess);
2454 if (!pr_reg) {
2455 pr_err("SPC-3 PR: Unable to locate"
2456 " PR_REGISTERED *pr_reg for RELEASE\n");
2457 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2460 * From spc4r17 Section 5.7.11.2 Releasing:
2462 * If there is no persistent reservation or in response to a persistent
2463 * reservation release request from a registered I_T nexus that is not a
2464 * persistent reservation holder (see 5.7.10), the device server shall
2465 * do the following:
2467 * a) Not release the persistent reservation, if any;
2468 * b) Not remove any registrations; and
2469 * c) Complete the command with GOOD status.
2471 spin_lock(&dev->dev_reservation_lock);
2472 pr_res_holder = dev->dev_pr_res_holder;
2473 if (!pr_res_holder) {
2475 * No persistent reservation, return GOOD status.
2477 spin_unlock(&dev->dev_reservation_lock);
2478 goto out_put_pr_reg;
2480 if ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2481 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))
2482 all_reg = 1;
2484 if ((all_reg == 0) && (pr_res_holder != pr_reg)) {
2486 * Non 'All Registrants' PR Type cases..
2487 * Release request from a registered I_T nexus that is not a
2488 * persistent reservation holder. return GOOD status.
2490 spin_unlock(&dev->dev_reservation_lock);
2491 goto out_put_pr_reg;
2495 * From spc4r17 Section 5.7.11.2 Releasing:
2497 * Only the persistent reservation holder (see 5.7.10) is allowed to
2498 * release a persistent reservation.
2500 * An application client releases the persistent reservation by issuing
2501 * a PERSISTENT RESERVE OUT command with RELEASE service action through
2502 * an I_T nexus that is a persistent reservation holder with the
2503 * following parameters:
2505 * a) RESERVATION KEY field set to the value of the reservation key
2506 * that is registered with the logical unit for the I_T nexus;
2508 if (res_key != pr_reg->pr_res_key) {
2509 pr_err("SPC-3 PR RELEASE: Received res_key: 0x%016Lx"
2510 " does not match existing SA REGISTER res_key:"
2511 " 0x%016Lx\n", res_key, pr_reg->pr_res_key);
2512 spin_unlock(&dev->dev_reservation_lock);
2513 ret = TCM_RESERVATION_CONFLICT;
2514 goto out_put_pr_reg;
2517 * From spc4r17 Section 5.7.11.2 Releasing and above:
2519 * b) TYPE field and SCOPE field set to match the persistent
2520 * reservation being released.
2522 if ((pr_res_holder->pr_res_type != type) ||
2523 (pr_res_holder->pr_res_scope != scope)) {
2524 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2525 pr_err("SPC-3 PR RELEASE: Attempted to release"
2526 " reservation from [%s]: %s with different TYPE "
2527 "and/or SCOPE while reservation already held by"
2528 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2529 cmd->se_tfo->get_fabric_name(),
2530 se_sess->se_node_acl->initiatorname,
2531 pr_res_nacl->se_tpg->se_tpg_tfo->get_fabric_name(),
2532 pr_res_holder->pr_reg_nacl->initiatorname);
2534 spin_unlock(&dev->dev_reservation_lock);
2535 ret = TCM_RESERVATION_CONFLICT;
2536 goto out_put_pr_reg;
2539 * In response to a persistent reservation release request from the
2540 * persistent reservation holder the device server shall perform a
2541 * release by doing the following as an uninterrupted series of actions:
2542 * a) Release the persistent reservation;
2543 * b) Not remove any registration(s);
2544 * c) If the released persistent reservation is a registrants only type
2545 * or all registrants type persistent reservation,
2546 * the device server shall establish a unit attention condition for
2547 * the initiator port associated with every regis-
2548 * tered I_T nexus other than I_T nexus on which the PERSISTENT
2549 * RESERVE OUT command with RELEASE service action was received,
2550 * with the additional sense code set to RESERVATIONS RELEASED; and
2551 * d) If the persistent reservation is of any other type, the device
2552 * server shall not establish a unit attention condition.
2554 __core_scsi3_complete_pro_release(dev, se_sess->se_node_acl,
2555 pr_reg, 1);
2557 spin_unlock(&dev->dev_reservation_lock);
2559 if ((type != PR_TYPE_WRITE_EXCLUSIVE_REGONLY) &&
2560 (type != PR_TYPE_EXCLUSIVE_ACCESS_REGONLY) &&
2561 (type != PR_TYPE_WRITE_EXCLUSIVE_ALLREG) &&
2562 (type != PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
2564 * If no UNIT ATTENTION conditions will be established for
2565 * PR_TYPE_WRITE_EXCLUSIVE or PR_TYPE_EXCLUSIVE_ACCESS
2566 * go ahead and check for APTPL=1 update+write below
2568 goto write_aptpl;
2571 spin_lock(&pr_tmpl->registration_lock);
2572 list_for_each_entry(pr_reg_p, &pr_tmpl->registration_list,
2573 pr_reg_list) {
2575 * Do not establish a UNIT ATTENTION condition
2576 * for the calling I_T Nexus
2578 if (pr_reg_p == pr_reg)
2579 continue;
2581 core_scsi3_ua_allocate(pr_reg_p->pr_reg_nacl,
2582 pr_reg_p->pr_res_mapped_lun,
2583 0x2A, ASCQ_2AH_RESERVATIONS_RELEASED);
2585 spin_unlock(&pr_tmpl->registration_lock);
2587 write_aptpl:
2588 if (pr_tmpl->pr_aptpl_active)
2589 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
2591 out_put_pr_reg:
2592 core_scsi3_put_pr_reg(pr_reg);
2593 return ret;
2596 static sense_reason_t
2597 core_scsi3_emulate_pro_clear(struct se_cmd *cmd, u64 res_key)
2599 struct se_device *dev = cmd->se_dev;
2600 struct se_node_acl *pr_reg_nacl;
2601 struct se_session *se_sess = cmd->se_sess;
2602 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2603 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_reg_n, *pr_res_holder;
2604 u32 pr_res_mapped_lun = 0;
2605 int calling_it_nexus = 0;
2607 * Locate the existing *pr_reg via struct se_node_acl pointers
2609 pr_reg_n = core_scsi3_locate_pr_reg(cmd->se_dev,
2610 se_sess->se_node_acl, se_sess);
2611 if (!pr_reg_n) {
2612 pr_err("SPC-3 PR: Unable to locate"
2613 " PR_REGISTERED *pr_reg for CLEAR\n");
2614 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2617 * From spc4r17 section 5.7.11.6, Clearing:
2619 * Any application client may release the persistent reservation and
2620 * remove all registrations from a device server by issuing a
2621 * PERSISTENT RESERVE OUT command with CLEAR service action through a
2622 * registered I_T nexus with the following parameter:
2624 * a) RESERVATION KEY field set to the value of the reservation key
2625 * that is registered with the logical unit for the I_T nexus.
2627 if (res_key != pr_reg_n->pr_res_key) {
2628 pr_err("SPC-3 PR REGISTER: Received"
2629 " res_key: 0x%016Lx does not match"
2630 " existing SA REGISTER res_key:"
2631 " 0x%016Lx\n", res_key, pr_reg_n->pr_res_key);
2632 core_scsi3_put_pr_reg(pr_reg_n);
2633 return TCM_RESERVATION_CONFLICT;
2636 * a) Release the persistent reservation, if any;
2638 spin_lock(&dev->dev_reservation_lock);
2639 pr_res_holder = dev->dev_pr_res_holder;
2640 if (pr_res_holder) {
2641 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2642 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
2643 pr_res_holder, 0);
2645 spin_unlock(&dev->dev_reservation_lock);
2647 * b) Remove all registration(s) (see spc4r17 5.7.7);
2649 spin_lock(&pr_tmpl->registration_lock);
2650 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2651 &pr_tmpl->registration_list, pr_reg_list) {
2653 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2654 pr_reg_nacl = pr_reg->pr_reg_nacl;
2655 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2656 __core_scsi3_free_registration(dev, pr_reg, NULL,
2657 calling_it_nexus);
2659 * e) Establish a unit attention condition for the initiator
2660 * port associated with every registered I_T nexus other
2661 * than the I_T nexus on which the PERSISTENT RESERVE OUT
2662 * command with CLEAR service action was received, with the
2663 * additional sense code set to RESERVATIONS PREEMPTED.
2665 if (!calling_it_nexus)
2666 core_scsi3_ua_allocate(pr_reg_nacl, pr_res_mapped_lun,
2667 0x2A, ASCQ_2AH_RESERVATIONS_PREEMPTED);
2669 spin_unlock(&pr_tmpl->registration_lock);
2671 pr_debug("SPC-3 PR [%s] Service Action: CLEAR complete\n",
2672 cmd->se_tfo->get_fabric_name());
2674 core_scsi3_update_and_write_aptpl(cmd->se_dev, false);
2676 core_scsi3_pr_generation(dev);
2677 return 0;
2681 * Called with struct se_device->dev_reservation_lock held.
2683 static void __core_scsi3_complete_pro_preempt(
2684 struct se_device *dev,
2685 struct t10_pr_registration *pr_reg,
2686 struct list_head *preempt_and_abort_list,
2687 int type,
2688 int scope,
2689 enum preempt_type preempt_type)
2691 struct se_node_acl *nacl = pr_reg->pr_reg_nacl;
2692 struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
2693 char i_buf[PR_REG_ISID_ID_LEN];
2695 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
2696 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2698 * Do an implicit RELEASE of the existing reservation.
2700 if (dev->dev_pr_res_holder)
2701 __core_scsi3_complete_pro_release(dev, nacl,
2702 dev->dev_pr_res_holder, 0);
2704 dev->dev_pr_res_holder = pr_reg;
2705 pr_reg->pr_res_holder = 1;
2706 pr_reg->pr_res_type = type;
2707 pr_reg->pr_res_scope = scope;
2709 pr_debug("SPC-3 PR [%s] Service Action: PREEMPT%s created new"
2710 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2711 tfo->get_fabric_name(), (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "",
2712 core_scsi3_pr_dump_type(type),
2713 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2714 pr_debug("SPC-3 PR [%s] PREEMPT%s from Node: %s%s\n",
2715 tfo->get_fabric_name(), (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "",
2716 nacl->initiatorname, i_buf);
2718 * For PREEMPT_AND_ABORT, add the preempting reservation's
2719 * struct t10_pr_registration to the list that will be compared
2720 * against received CDBs..
2722 if (preempt_and_abort_list)
2723 list_add_tail(&pr_reg->pr_reg_abort_list,
2724 preempt_and_abort_list);
2727 static void core_scsi3_release_preempt_and_abort(
2728 struct list_head *preempt_and_abort_list,
2729 struct t10_pr_registration *pr_reg_holder)
2731 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
2733 list_for_each_entry_safe(pr_reg, pr_reg_tmp, preempt_and_abort_list,
2734 pr_reg_abort_list) {
2736 list_del(&pr_reg->pr_reg_abort_list);
2737 if (pr_reg_holder == pr_reg)
2738 continue;
2739 if (pr_reg->pr_res_holder) {
2740 pr_warn("pr_reg->pr_res_holder still set\n");
2741 continue;
2744 pr_reg->pr_reg_deve = NULL;
2745 pr_reg->pr_reg_nacl = NULL;
2746 kmem_cache_free(t10_pr_reg_cache, pr_reg);
2750 static sense_reason_t
2751 core_scsi3_pro_preempt(struct se_cmd *cmd, int type, int scope, u64 res_key,
2752 u64 sa_res_key, enum preempt_type preempt_type)
2754 struct se_device *dev = cmd->se_dev;
2755 struct se_node_acl *pr_reg_nacl;
2756 struct se_session *se_sess = cmd->se_sess;
2757 LIST_HEAD(preempt_and_abort_list);
2758 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_reg_n, *pr_res_holder;
2759 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2760 u32 pr_res_mapped_lun = 0;
2761 int all_reg = 0, calling_it_nexus = 0, released_regs = 0;
2762 int prh_type = 0, prh_scope = 0;
2764 if (!se_sess)
2765 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2767 pr_reg_n = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
2768 se_sess);
2769 if (!pr_reg_n) {
2770 pr_err("SPC-3 PR: Unable to locate"
2771 " PR_REGISTERED *pr_reg for PREEMPT%s\n",
2772 (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "");
2773 return TCM_RESERVATION_CONFLICT;
2775 if (pr_reg_n->pr_res_key != res_key) {
2776 core_scsi3_put_pr_reg(pr_reg_n);
2777 return TCM_RESERVATION_CONFLICT;
2779 if (scope != PR_SCOPE_LU_SCOPE) {
2780 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope);
2781 core_scsi3_put_pr_reg(pr_reg_n);
2782 return TCM_INVALID_PARAMETER_LIST;
2785 spin_lock(&dev->dev_reservation_lock);
2786 pr_res_holder = dev->dev_pr_res_holder;
2787 if (pr_res_holder &&
2788 ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2789 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)))
2790 all_reg = 1;
2792 if (!all_reg && !sa_res_key) {
2793 spin_unlock(&dev->dev_reservation_lock);
2794 core_scsi3_put_pr_reg(pr_reg_n);
2795 return TCM_INVALID_PARAMETER_LIST;
2798 * From spc4r17, section 5.7.11.4.4 Removing Registrations:
2800 * If the SERVICE ACTION RESERVATION KEY field does not identify a
2801 * persistent reservation holder or there is no persistent reservation
2802 * holder (i.e., there is no persistent reservation), then the device
2803 * server shall perform a preempt by doing the following in an
2804 * uninterrupted series of actions. (See below..)
2806 if (!pr_res_holder || (pr_res_holder->pr_res_key != sa_res_key)) {
2808 * No existing or SA Reservation Key matching reservations..
2810 * PROUT SA PREEMPT with All Registrant type reservations are
2811 * allowed to be processed without a matching SA Reservation Key
2813 spin_lock(&pr_tmpl->registration_lock);
2814 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2815 &pr_tmpl->registration_list, pr_reg_list) {
2817 * Removing of registrations in non all registrants
2818 * type reservations without a matching SA reservation
2819 * key.
2821 * a) Remove the registrations for all I_T nexuses
2822 * specified by the SERVICE ACTION RESERVATION KEY
2823 * field;
2824 * b) Ignore the contents of the SCOPE and TYPE fields;
2825 * c) Process tasks as defined in 5.7.1; and
2826 * d) Establish a unit attention condition for the
2827 * initiator port associated with every I_T nexus
2828 * that lost its registration other than the I_T
2829 * nexus on which the PERSISTENT RESERVE OUT command
2830 * was received, with the additional sense code set
2831 * to REGISTRATIONS PREEMPTED.
2833 if (!all_reg) {
2834 if (pr_reg->pr_res_key != sa_res_key)
2835 continue;
2837 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2838 pr_reg_nacl = pr_reg->pr_reg_nacl;
2839 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2840 __core_scsi3_free_registration(dev, pr_reg,
2841 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list :
2842 NULL, calling_it_nexus);
2843 released_regs++;
2844 } else {
2846 * Case for any existing all registrants type
2847 * reservation, follow logic in spc4r17 section
2848 * 5.7.11.4 Preempting, Table 52 and Figure 7.
2850 * For a ZERO SA Reservation key, release
2851 * all other registrations and do an implicit
2852 * release of active persistent reservation.
2854 * For a non-ZERO SA Reservation key, only
2855 * release the matching reservation key from
2856 * registrations.
2858 if ((sa_res_key) &&
2859 (pr_reg->pr_res_key != sa_res_key))
2860 continue;
2862 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2863 if (calling_it_nexus)
2864 continue;
2866 pr_reg_nacl = pr_reg->pr_reg_nacl;
2867 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2868 __core_scsi3_free_registration(dev, pr_reg,
2869 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list :
2870 NULL, 0);
2871 released_regs++;
2873 if (!calling_it_nexus)
2874 core_scsi3_ua_allocate(pr_reg_nacl,
2875 pr_res_mapped_lun, 0x2A,
2876 ASCQ_2AH_REGISTRATIONS_PREEMPTED);
2878 spin_unlock(&pr_tmpl->registration_lock);
2880 * If a PERSISTENT RESERVE OUT with a PREEMPT service action or
2881 * a PREEMPT AND ABORT service action sets the SERVICE ACTION
2882 * RESERVATION KEY field to a value that does not match any
2883 * registered reservation key, then the device server shall
2884 * complete the command with RESERVATION CONFLICT status.
2886 if (!released_regs) {
2887 spin_unlock(&dev->dev_reservation_lock);
2888 core_scsi3_put_pr_reg(pr_reg_n);
2889 return TCM_RESERVATION_CONFLICT;
2892 * For an existing all registrants type reservation
2893 * with a zero SA rservation key, preempt the existing
2894 * reservation with the new PR type and scope.
2896 if (pr_res_holder && all_reg && !(sa_res_key)) {
2897 __core_scsi3_complete_pro_preempt(dev, pr_reg_n,
2898 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
2899 type, scope, preempt_type);
2901 if (preempt_type == PREEMPT_AND_ABORT)
2902 core_scsi3_release_preempt_and_abort(
2903 &preempt_and_abort_list, pr_reg_n);
2905 spin_unlock(&dev->dev_reservation_lock);
2907 if (pr_tmpl->pr_aptpl_active)
2908 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
2910 core_scsi3_put_pr_reg(pr_reg_n);
2911 core_scsi3_pr_generation(cmd->se_dev);
2912 return 0;
2915 * The PREEMPTing SA reservation key matches that of the
2916 * existing persistent reservation, first, we check if
2917 * we are preempting our own reservation.
2918 * From spc4r17, section 5.7.11.4.3 Preempting
2919 * persistent reservations and registration handling
2921 * If an all registrants persistent reservation is not
2922 * present, it is not an error for the persistent
2923 * reservation holder to preempt itself (i.e., a
2924 * PERSISTENT RESERVE OUT with a PREEMPT service action
2925 * or a PREEMPT AND ABORT service action with the
2926 * SERVICE ACTION RESERVATION KEY value equal to the
2927 * persistent reservation holder's reservation key that
2928 * is received from the persistent reservation holder).
2929 * In that case, the device server shall establish the
2930 * new persistent reservation and maintain the
2931 * registration.
2933 prh_type = pr_res_holder->pr_res_type;
2934 prh_scope = pr_res_holder->pr_res_scope;
2936 * If the SERVICE ACTION RESERVATION KEY field identifies a
2937 * persistent reservation holder (see 5.7.10), the device
2938 * server shall perform a preempt by doing the following as
2939 * an uninterrupted series of actions:
2941 * a) Release the persistent reservation for the holder
2942 * identified by the SERVICE ACTION RESERVATION KEY field;
2944 if (pr_reg_n != pr_res_holder)
2945 __core_scsi3_complete_pro_release(dev,
2946 pr_res_holder->pr_reg_nacl,
2947 dev->dev_pr_res_holder, 0);
2949 * b) Remove the registrations for all I_T nexuses identified
2950 * by the SERVICE ACTION RESERVATION KEY field, except the
2951 * I_T nexus that is being used for the PERSISTENT RESERVE
2952 * OUT command. If an all registrants persistent reservation
2953 * is present and the SERVICE ACTION RESERVATION KEY field
2954 * is set to zero, then all registrations shall be removed
2955 * except for that of the I_T nexus that is being used for
2956 * the PERSISTENT RESERVE OUT command;
2958 spin_lock(&pr_tmpl->registration_lock);
2959 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2960 &pr_tmpl->registration_list, pr_reg_list) {
2962 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2963 if (calling_it_nexus)
2964 continue;
2966 if (pr_reg->pr_res_key != sa_res_key)
2967 continue;
2969 pr_reg_nacl = pr_reg->pr_reg_nacl;
2970 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2971 __core_scsi3_free_registration(dev, pr_reg,
2972 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
2973 calling_it_nexus);
2975 * e) Establish a unit attention condition for the initiator
2976 * port associated with every I_T nexus that lost its
2977 * persistent reservation and/or registration, with the
2978 * additional sense code set to REGISTRATIONS PREEMPTED;
2980 core_scsi3_ua_allocate(pr_reg_nacl, pr_res_mapped_lun, 0x2A,
2981 ASCQ_2AH_REGISTRATIONS_PREEMPTED);
2983 spin_unlock(&pr_tmpl->registration_lock);
2985 * c) Establish a persistent reservation for the preempting
2986 * I_T nexus using the contents of the SCOPE and TYPE fields;
2988 __core_scsi3_complete_pro_preempt(dev, pr_reg_n,
2989 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
2990 type, scope, preempt_type);
2992 * d) Process tasks as defined in 5.7.1;
2993 * e) See above..
2994 * f) If the type or scope has changed, then for every I_T nexus
2995 * whose reservation key was not removed, except for the I_T
2996 * nexus on which the PERSISTENT RESERVE OUT command was
2997 * received, the device server shall establish a unit
2998 * attention condition for the initiator port associated with
2999 * that I_T nexus, with the additional sense code set to
3000 * RESERVATIONS RELEASED. If the type or scope have not
3001 * changed, then no unit attention condition(s) shall be
3002 * established for this reason.
3004 if ((prh_type != type) || (prh_scope != scope)) {
3005 spin_lock(&pr_tmpl->registration_lock);
3006 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3007 &pr_tmpl->registration_list, pr_reg_list) {
3009 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
3010 if (calling_it_nexus)
3011 continue;
3013 core_scsi3_ua_allocate(pr_reg->pr_reg_nacl,
3014 pr_reg->pr_res_mapped_lun, 0x2A,
3015 ASCQ_2AH_RESERVATIONS_RELEASED);
3017 spin_unlock(&pr_tmpl->registration_lock);
3019 spin_unlock(&dev->dev_reservation_lock);
3021 * Call LUN_RESET logic upon list of struct t10_pr_registration,
3022 * All received CDBs for the matching existing reservation and
3023 * registrations undergo ABORT_TASK logic.
3025 * From there, core_scsi3_release_preempt_and_abort() will
3026 * release every registration in the list (which have already
3027 * been removed from the primary pr_reg list), except the
3028 * new persistent reservation holder, the calling Initiator Port.
3030 if (preempt_type == PREEMPT_AND_ABORT) {
3031 core_tmr_lun_reset(dev, NULL, &preempt_and_abort_list, cmd);
3032 core_scsi3_release_preempt_and_abort(&preempt_and_abort_list,
3033 pr_reg_n);
3036 if (pr_tmpl->pr_aptpl_active)
3037 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
3039 core_scsi3_put_pr_reg(pr_reg_n);
3040 core_scsi3_pr_generation(cmd->se_dev);
3041 return 0;
3044 static sense_reason_t
3045 core_scsi3_emulate_pro_preempt(struct se_cmd *cmd, int type, int scope,
3046 u64 res_key, u64 sa_res_key, enum preempt_type preempt_type)
3048 switch (type) {
3049 case PR_TYPE_WRITE_EXCLUSIVE:
3050 case PR_TYPE_EXCLUSIVE_ACCESS:
3051 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
3052 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
3053 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
3054 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
3055 return core_scsi3_pro_preempt(cmd, type, scope, res_key,
3056 sa_res_key, preempt_type);
3057 default:
3058 pr_err("SPC-3 PR: Unknown Service Action PREEMPT%s"
3059 " Type: 0x%02x\n", (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "", type);
3060 return TCM_INVALID_CDB_FIELD;
3065 static sense_reason_t
3066 core_scsi3_emulate_pro_register_and_move(struct se_cmd *cmd, u64 res_key,
3067 u64 sa_res_key, int aptpl, int unreg)
3069 struct se_session *se_sess = cmd->se_sess;
3070 struct se_device *dev = cmd->se_dev;
3071 struct se_dev_entry *dest_se_deve = NULL;
3072 struct se_lun *se_lun = cmd->se_lun;
3073 struct se_node_acl *pr_res_nacl, *pr_reg_nacl, *dest_node_acl = NULL;
3074 struct se_port *se_port;
3075 struct se_portal_group *se_tpg, *dest_se_tpg = NULL;
3076 struct target_core_fabric_ops *dest_tf_ops = NULL, *tf_ops;
3077 struct t10_pr_registration *pr_reg, *pr_res_holder, *dest_pr_reg;
3078 struct t10_reservation *pr_tmpl = &dev->t10_pr;
3079 unsigned char *buf;
3080 unsigned char *initiator_str;
3081 char *iport_ptr = NULL, dest_iport[64], i_buf[PR_REG_ISID_ID_LEN];
3082 u32 tid_len, tmp_tid_len;
3083 int new_reg = 0, type, scope, matching_iname;
3084 sense_reason_t ret;
3085 unsigned short rtpi;
3086 unsigned char proto_ident;
3088 if (!se_sess || !se_lun) {
3089 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
3090 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3093 memset(dest_iport, 0, 64);
3094 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
3095 se_tpg = se_sess->se_tpg;
3096 tf_ops = se_tpg->se_tpg_tfo;
3098 * Follow logic from spc4r17 Section 5.7.8, Table 50 --
3099 * Register behaviors for a REGISTER AND MOVE service action
3101 * Locate the existing *pr_reg via struct se_node_acl pointers
3103 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
3104 se_sess);
3105 if (!pr_reg) {
3106 pr_err("SPC-3 PR: Unable to locate PR_REGISTERED"
3107 " *pr_reg for REGISTER_AND_MOVE\n");
3108 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3111 * The provided reservation key much match the existing reservation key
3112 * provided during this initiator's I_T nexus registration.
3114 if (res_key != pr_reg->pr_res_key) {
3115 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received"
3116 " res_key: 0x%016Lx does not match existing SA REGISTER"
3117 " res_key: 0x%016Lx\n", res_key, pr_reg->pr_res_key);
3118 ret = TCM_RESERVATION_CONFLICT;
3119 goto out_put_pr_reg;
3122 * The service active reservation key needs to be non zero
3124 if (!sa_res_key) {
3125 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received zero"
3126 " sa_res_key\n");
3127 ret = TCM_INVALID_PARAMETER_LIST;
3128 goto out_put_pr_reg;
3132 * Determine the Relative Target Port Identifier where the reservation
3133 * will be moved to for the TransportID containing SCSI initiator WWN
3134 * information.
3136 buf = transport_kmap_data_sg(cmd);
3137 if (!buf) {
3138 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3139 goto out_put_pr_reg;
3142 rtpi = (buf[18] & 0xff) << 8;
3143 rtpi |= buf[19] & 0xff;
3144 tid_len = (buf[20] & 0xff) << 24;
3145 tid_len |= (buf[21] & 0xff) << 16;
3146 tid_len |= (buf[22] & 0xff) << 8;
3147 tid_len |= buf[23] & 0xff;
3148 transport_kunmap_data_sg(cmd);
3149 buf = NULL;
3151 if ((tid_len + 24) != cmd->data_length) {
3152 pr_err("SPC-3 PR: Illegal tid_len: %u + 24 byte header"
3153 " does not equal CDB data_length: %u\n", tid_len,
3154 cmd->data_length);
3155 ret = TCM_INVALID_PARAMETER_LIST;
3156 goto out_put_pr_reg;
3159 spin_lock(&dev->se_port_lock);
3160 list_for_each_entry(se_port, &dev->dev_sep_list, sep_list) {
3161 if (se_port->sep_rtpi != rtpi)
3162 continue;
3163 dest_se_tpg = se_port->sep_tpg;
3164 if (!dest_se_tpg)
3165 continue;
3166 dest_tf_ops = dest_se_tpg->se_tpg_tfo;
3167 if (!dest_tf_ops)
3168 continue;
3170 atomic_inc(&dest_se_tpg->tpg_pr_ref_count);
3171 smp_mb__after_atomic_inc();
3172 spin_unlock(&dev->se_port_lock);
3174 if (core_scsi3_tpg_depend_item(dest_se_tpg)) {
3175 pr_err("core_scsi3_tpg_depend_item() failed"
3176 " for dest_se_tpg\n");
3177 atomic_dec(&dest_se_tpg->tpg_pr_ref_count);
3178 smp_mb__after_atomic_dec();
3179 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3180 goto out_put_pr_reg;
3183 spin_lock(&dev->se_port_lock);
3184 break;
3186 spin_unlock(&dev->se_port_lock);
3188 if (!dest_se_tpg || !dest_tf_ops) {
3189 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3190 " fabric ops from Relative Target Port Identifier:"
3191 " %hu\n", rtpi);
3192 ret = TCM_INVALID_PARAMETER_LIST;
3193 goto out_put_pr_reg;
3196 buf = transport_kmap_data_sg(cmd);
3197 if (!buf) {
3198 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3199 goto out_put_pr_reg;
3201 proto_ident = (buf[24] & 0x0f);
3203 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Extracted Protocol Identifier:"
3204 " 0x%02x\n", proto_ident);
3206 if (proto_ident != dest_tf_ops->get_fabric_proto_ident(dest_se_tpg)) {
3207 pr_err("SPC-3 PR REGISTER_AND_MOVE: Received"
3208 " proto_ident: 0x%02x does not match ident: 0x%02x"
3209 " from fabric: %s\n", proto_ident,
3210 dest_tf_ops->get_fabric_proto_ident(dest_se_tpg),
3211 dest_tf_ops->get_fabric_name());
3212 ret = TCM_INVALID_PARAMETER_LIST;
3213 goto out;
3215 if (dest_tf_ops->tpg_parse_pr_out_transport_id == NULL) {
3216 pr_err("SPC-3 PR REGISTER_AND_MOVE: Fabric does not"
3217 " containg a valid tpg_parse_pr_out_transport_id"
3218 " function pointer\n");
3219 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3220 goto out;
3222 initiator_str = dest_tf_ops->tpg_parse_pr_out_transport_id(dest_se_tpg,
3223 (const char *)&buf[24], &tmp_tid_len, &iport_ptr);
3224 if (!initiator_str) {
3225 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3226 " initiator_str from Transport ID\n");
3227 ret = TCM_INVALID_PARAMETER_LIST;
3228 goto out;
3231 transport_kunmap_data_sg(cmd);
3232 buf = NULL;
3234 pr_debug("SPC-3 PR [%s] Extracted initiator %s identifier: %s"
3235 " %s\n", dest_tf_ops->get_fabric_name(), (iport_ptr != NULL) ?
3236 "port" : "device", initiator_str, (iport_ptr != NULL) ?
3237 iport_ptr : "");
3239 * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3240 * action specifies a TransportID that is the same as the initiator port
3241 * of the I_T nexus for the command received, then the command shall
3242 * be terminated with CHECK CONDITION status, with the sense key set to
3243 * ILLEGAL REQUEST, and the additional sense code set to INVALID FIELD
3244 * IN PARAMETER LIST.
3246 pr_reg_nacl = pr_reg->pr_reg_nacl;
3247 matching_iname = (!strcmp(initiator_str,
3248 pr_reg_nacl->initiatorname)) ? 1 : 0;
3249 if (!matching_iname)
3250 goto after_iport_check;
3252 if (!iport_ptr || !pr_reg->isid_present_at_reg) {
3253 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s"
3254 " matches: %s on received I_T Nexus\n", initiator_str,
3255 pr_reg_nacl->initiatorname);
3256 ret = TCM_INVALID_PARAMETER_LIST;
3257 goto out;
3259 if (!strcmp(iport_ptr, pr_reg->pr_reg_isid)) {
3260 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s %s"
3261 " matches: %s %s on received I_T Nexus\n",
3262 initiator_str, iport_ptr, pr_reg_nacl->initiatorname,
3263 pr_reg->pr_reg_isid);
3264 ret = TCM_INVALID_PARAMETER_LIST;
3265 goto out;
3267 after_iport_check:
3269 * Locate the destination struct se_node_acl from the received Transport ID
3271 spin_lock_irq(&dest_se_tpg->acl_node_lock);
3272 dest_node_acl = __core_tpg_get_initiator_node_acl(dest_se_tpg,
3273 initiator_str);
3274 if (dest_node_acl) {
3275 atomic_inc(&dest_node_acl->acl_pr_ref_count);
3276 smp_mb__after_atomic_inc();
3278 spin_unlock_irq(&dest_se_tpg->acl_node_lock);
3280 if (!dest_node_acl) {
3281 pr_err("Unable to locate %s dest_node_acl for"
3282 " TransportID%s\n", dest_tf_ops->get_fabric_name(),
3283 initiator_str);
3284 ret = TCM_INVALID_PARAMETER_LIST;
3285 goto out;
3288 if (core_scsi3_nodeacl_depend_item(dest_node_acl)) {
3289 pr_err("core_scsi3_nodeacl_depend_item() for"
3290 " dest_node_acl\n");
3291 atomic_dec(&dest_node_acl->acl_pr_ref_count);
3292 smp_mb__after_atomic_dec();
3293 dest_node_acl = NULL;
3294 ret = TCM_INVALID_PARAMETER_LIST;
3295 goto out;
3298 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Found %s dest_node_acl:"
3299 " %s from TransportID\n", dest_tf_ops->get_fabric_name(),
3300 dest_node_acl->initiatorname);
3303 * Locate the struct se_dev_entry pointer for the matching RELATIVE TARGET
3304 * PORT IDENTIFIER.
3306 dest_se_deve = core_get_se_deve_from_rtpi(dest_node_acl, rtpi);
3307 if (!dest_se_deve) {
3308 pr_err("Unable to locate %s dest_se_deve from RTPI:"
3309 " %hu\n", dest_tf_ops->get_fabric_name(), rtpi);
3310 ret = TCM_INVALID_PARAMETER_LIST;
3311 goto out;
3314 if (core_scsi3_lunacl_depend_item(dest_se_deve)) {
3315 pr_err("core_scsi3_lunacl_depend_item() failed\n");
3316 atomic_dec(&dest_se_deve->pr_ref_count);
3317 smp_mb__after_atomic_dec();
3318 dest_se_deve = NULL;
3319 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3320 goto out;
3323 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Located %s node %s LUN"
3324 " ACL for dest_se_deve->mapped_lun: %u\n",
3325 dest_tf_ops->get_fabric_name(), dest_node_acl->initiatorname,
3326 dest_se_deve->mapped_lun);
3329 * A persistent reservation needs to already existing in order to
3330 * successfully complete the REGISTER_AND_MOVE service action..
3332 spin_lock(&dev->dev_reservation_lock);
3333 pr_res_holder = dev->dev_pr_res_holder;
3334 if (!pr_res_holder) {
3335 pr_warn("SPC-3 PR REGISTER_AND_MOVE: No reservation"
3336 " currently held\n");
3337 spin_unlock(&dev->dev_reservation_lock);
3338 ret = TCM_INVALID_CDB_FIELD;
3339 goto out;
3342 * The received on I_T Nexus must be the reservation holder.
3344 * From spc4r17 section 5.7.8 Table 50 --
3345 * Register behaviors for a REGISTER AND MOVE service action
3347 if (pr_res_holder != pr_reg) {
3348 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Calling I_T"
3349 " Nexus is not reservation holder\n");
3350 spin_unlock(&dev->dev_reservation_lock);
3351 ret = TCM_RESERVATION_CONFLICT;
3352 goto out;
3355 * From spc4r17 section 5.7.8: registering and moving reservation
3357 * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3358 * action is received and the established persistent reservation is a
3359 * Write Exclusive - All Registrants type or Exclusive Access -
3360 * All Registrants type reservation, then the command shall be completed
3361 * with RESERVATION CONFLICT status.
3363 if ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
3364 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
3365 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Unable to move"
3366 " reservation for type: %s\n",
3367 core_scsi3_pr_dump_type(pr_res_holder->pr_res_type));
3368 spin_unlock(&dev->dev_reservation_lock);
3369 ret = TCM_RESERVATION_CONFLICT;
3370 goto out;
3372 pr_res_nacl = pr_res_holder->pr_reg_nacl;
3374 * b) Ignore the contents of the (received) SCOPE and TYPE fields;
3376 type = pr_res_holder->pr_res_type;
3377 scope = pr_res_holder->pr_res_type;
3379 * c) Associate the reservation key specified in the SERVICE ACTION
3380 * RESERVATION KEY field with the I_T nexus specified as the
3381 * destination of the register and move, where:
3382 * A) The I_T nexus is specified by the TransportID and the
3383 * RELATIVE TARGET PORT IDENTIFIER field (see 6.14.4); and
3384 * B) Regardless of the TransportID format used, the association for
3385 * the initiator port is based on either the initiator port name
3386 * (see 3.1.71) on SCSI transport protocols where port names are
3387 * required or the initiator port identifier (see 3.1.70) on SCSI
3388 * transport protocols where port names are not required;
3389 * d) Register the reservation key specified in the SERVICE ACTION
3390 * RESERVATION KEY field;
3391 * e) Retain the reservation key specified in the SERVICE ACTION
3392 * RESERVATION KEY field and associated information;
3394 * Also, It is not an error for a REGISTER AND MOVE service action to
3395 * register an I_T nexus that is already registered with the same
3396 * reservation key or a different reservation key.
3398 dest_pr_reg = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
3399 iport_ptr);
3400 if (!dest_pr_reg) {
3401 if (core_scsi3_alloc_registration(cmd->se_dev,
3402 dest_node_acl, dest_se_deve, iport_ptr,
3403 sa_res_key, 0, aptpl, 2, 1)) {
3404 spin_unlock(&dev->dev_reservation_lock);
3405 ret = TCM_INVALID_PARAMETER_LIST;
3406 goto out;
3408 dest_pr_reg = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
3409 iport_ptr);
3410 new_reg = 1;
3413 * f) Release the persistent reservation for the persistent reservation
3414 * holder (i.e., the I_T nexus on which the
3416 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
3417 dev->dev_pr_res_holder, 0);
3419 * g) Move the persistent reservation to the specified I_T nexus using
3420 * the same scope and type as the persistent reservation released in
3421 * item f); and
3423 dev->dev_pr_res_holder = dest_pr_reg;
3424 dest_pr_reg->pr_res_holder = 1;
3425 dest_pr_reg->pr_res_type = type;
3426 pr_reg->pr_res_scope = scope;
3427 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
3429 * Increment PRGeneration for existing registrations..
3431 if (!new_reg)
3432 dest_pr_reg->pr_res_generation = pr_tmpl->pr_generation++;
3433 spin_unlock(&dev->dev_reservation_lock);
3435 pr_debug("SPC-3 PR [%s] Service Action: REGISTER_AND_MOVE"
3436 " created new reservation holder TYPE: %s on object RTPI:"
3437 " %hu PRGeneration: 0x%08x\n", dest_tf_ops->get_fabric_name(),
3438 core_scsi3_pr_dump_type(type), rtpi,
3439 dest_pr_reg->pr_res_generation);
3440 pr_debug("SPC-3 PR Successfully moved reservation from"
3441 " %s Fabric Node: %s%s -> %s Fabric Node: %s %s\n",
3442 tf_ops->get_fabric_name(), pr_reg_nacl->initiatorname,
3443 i_buf, dest_tf_ops->get_fabric_name(),
3444 dest_node_acl->initiatorname, (iport_ptr != NULL) ?
3445 iport_ptr : "");
3447 * It is now safe to release configfs group dependencies for destination
3448 * of Transport ID Initiator Device/Port Identifier
3450 core_scsi3_lunacl_undepend_item(dest_se_deve);
3451 core_scsi3_nodeacl_undepend_item(dest_node_acl);
3452 core_scsi3_tpg_undepend_item(dest_se_tpg);
3454 * h) If the UNREG bit is set to one, unregister (see 5.7.11.3) the I_T
3455 * nexus on which PERSISTENT RESERVE OUT command was received.
3457 if (unreg) {
3458 spin_lock(&pr_tmpl->registration_lock);
3459 __core_scsi3_free_registration(dev, pr_reg, NULL, 1);
3460 spin_unlock(&pr_tmpl->registration_lock);
3461 } else
3462 core_scsi3_put_pr_reg(pr_reg);
3464 core_scsi3_update_and_write_aptpl(cmd->se_dev, aptpl);
3466 transport_kunmap_data_sg(cmd);
3468 core_scsi3_put_pr_reg(dest_pr_reg);
3469 return 0;
3470 out:
3471 if (buf)
3472 transport_kunmap_data_sg(cmd);
3473 if (dest_se_deve)
3474 core_scsi3_lunacl_undepend_item(dest_se_deve);
3475 if (dest_node_acl)
3476 core_scsi3_nodeacl_undepend_item(dest_node_acl);
3477 core_scsi3_tpg_undepend_item(dest_se_tpg);
3479 out_put_pr_reg:
3480 core_scsi3_put_pr_reg(pr_reg);
3481 return ret;
3484 static unsigned long long core_scsi3_extract_reservation_key(unsigned char *cdb)
3486 unsigned int __v1, __v2;
3488 __v1 = (cdb[0] << 24) | (cdb[1] << 16) | (cdb[2] << 8) | cdb[3];
3489 __v2 = (cdb[4] << 24) | (cdb[5] << 16) | (cdb[6] << 8) | cdb[7];
3491 return ((unsigned long long)__v2) | (unsigned long long)__v1 << 32;
3495 * See spc4r17 section 6.14 Table 170
3497 sense_reason_t
3498 target_scsi3_emulate_pr_out(struct se_cmd *cmd)
3500 unsigned char *cdb = &cmd->t_task_cdb[0];
3501 unsigned char *buf;
3502 u64 res_key, sa_res_key;
3503 int sa, scope, type, aptpl;
3504 int spec_i_pt = 0, all_tg_pt = 0, unreg = 0;
3505 sense_reason_t ret;
3508 * Following spc2r20 5.5.1 Reservations overview:
3510 * If a logical unit has been reserved by any RESERVE command and is
3511 * still reserved by any initiator, all PERSISTENT RESERVE IN and all
3512 * PERSISTENT RESERVE OUT commands shall conflict regardless of
3513 * initiator or service action and shall terminate with a RESERVATION
3514 * CONFLICT status.
3516 if (cmd->se_dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS) {
3517 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
3518 " SPC-2 reservation is held, returning"
3519 " RESERVATION_CONFLICT\n");
3520 return TCM_RESERVATION_CONFLICT;
3524 * FIXME: A NULL struct se_session pointer means an this is not coming from
3525 * a $FABRIC_MOD's nexus, but from internal passthrough ops.
3527 if (!cmd->se_sess)
3528 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3530 if (cmd->data_length < 24) {
3531 pr_warn("SPC-PR: Received PR OUT parameter list"
3532 " length too small: %u\n", cmd->data_length);
3533 return TCM_INVALID_PARAMETER_LIST;
3537 * From the PERSISTENT_RESERVE_OUT command descriptor block (CDB)
3539 sa = (cdb[1] & 0x1f);
3540 scope = (cdb[2] & 0xf0);
3541 type = (cdb[2] & 0x0f);
3543 buf = transport_kmap_data_sg(cmd);
3544 if (!buf)
3545 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3548 * From PERSISTENT_RESERVE_OUT parameter list (payload)
3550 res_key = core_scsi3_extract_reservation_key(&buf[0]);
3551 sa_res_key = core_scsi3_extract_reservation_key(&buf[8]);
3553 * REGISTER_AND_MOVE uses a different SA parameter list containing
3554 * SCSI TransportIDs.
3556 if (sa != PRO_REGISTER_AND_MOVE) {
3557 spec_i_pt = (buf[20] & 0x08);
3558 all_tg_pt = (buf[20] & 0x04);
3559 aptpl = (buf[20] & 0x01);
3560 } else {
3561 aptpl = (buf[17] & 0x01);
3562 unreg = (buf[17] & 0x02);
3564 transport_kunmap_data_sg(cmd);
3565 buf = NULL;
3568 * SPEC_I_PT=1 is only valid for Service action: REGISTER
3570 if (spec_i_pt && ((cdb[1] & 0x1f) != PRO_REGISTER))
3571 return TCM_INVALID_PARAMETER_LIST;
3574 * From spc4r17 section 6.14:
3576 * If the SPEC_I_PT bit is set to zero, the service action is not
3577 * REGISTER AND MOVE, and the parameter list length is not 24, then
3578 * the command shall be terminated with CHECK CONDITION status, with
3579 * the sense key set to ILLEGAL REQUEST, and the additional sense
3580 * code set to PARAMETER LIST LENGTH ERROR.
3582 if (!spec_i_pt && ((cdb[1] & 0x1f) != PRO_REGISTER_AND_MOVE) &&
3583 (cmd->data_length != 24)) {
3584 pr_warn("SPC-PR: Received PR OUT illegal parameter"
3585 " list length: %u\n", cmd->data_length);
3586 return TCM_INVALID_PARAMETER_LIST;
3590 * (core_scsi3_emulate_pro_* function parameters
3591 * are defined by spc4r17 Table 174:
3592 * PERSISTENT_RESERVE_OUT service actions and valid parameters.
3594 switch (sa) {
3595 case PRO_REGISTER:
3596 ret = core_scsi3_emulate_pro_register(cmd,
3597 res_key, sa_res_key, aptpl, all_tg_pt, spec_i_pt, REGISTER);
3598 break;
3599 case PRO_RESERVE:
3600 ret = core_scsi3_emulate_pro_reserve(cmd, type, scope, res_key);
3601 break;
3602 case PRO_RELEASE:
3603 ret = core_scsi3_emulate_pro_release(cmd, type, scope, res_key);
3604 break;
3605 case PRO_CLEAR:
3606 ret = core_scsi3_emulate_pro_clear(cmd, res_key);
3607 break;
3608 case PRO_PREEMPT:
3609 ret = core_scsi3_emulate_pro_preempt(cmd, type, scope,
3610 res_key, sa_res_key, PREEMPT);
3611 break;
3612 case PRO_PREEMPT_AND_ABORT:
3613 ret = core_scsi3_emulate_pro_preempt(cmd, type, scope,
3614 res_key, sa_res_key, PREEMPT_AND_ABORT);
3615 break;
3616 case PRO_REGISTER_AND_IGNORE_EXISTING_KEY:
3617 ret = core_scsi3_emulate_pro_register(cmd,
3618 0, sa_res_key, aptpl, all_tg_pt, spec_i_pt, REGISTER_AND_IGNORE_EXISTING_KEY);
3619 break;
3620 case PRO_REGISTER_AND_MOVE:
3621 ret = core_scsi3_emulate_pro_register_and_move(cmd, res_key,
3622 sa_res_key, aptpl, unreg);
3623 break;
3624 default:
3625 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
3626 " action: 0x%02x\n", cdb[1] & 0x1f);
3627 return TCM_INVALID_CDB_FIELD;
3630 if (!ret)
3631 target_complete_cmd(cmd, GOOD);
3632 return ret;
3636 * PERSISTENT_RESERVE_IN Service Action READ_KEYS
3638 * See spc4r17 section 5.7.6.2 and section 6.13.2, Table 160
3640 static sense_reason_t
3641 core_scsi3_pri_read_keys(struct se_cmd *cmd)
3643 struct se_device *dev = cmd->se_dev;
3644 struct t10_pr_registration *pr_reg;
3645 unsigned char *buf;
3646 u32 add_len = 0, off = 8;
3648 if (cmd->data_length < 8) {
3649 pr_err("PRIN SA READ_KEYS SCSI Data Length: %u"
3650 " too small\n", cmd->data_length);
3651 return TCM_INVALID_CDB_FIELD;
3654 buf = transport_kmap_data_sg(cmd);
3655 if (!buf)
3656 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3658 buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3659 buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3660 buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3661 buf[3] = (dev->t10_pr.pr_generation & 0xff);
3663 spin_lock(&dev->t10_pr.registration_lock);
3664 list_for_each_entry(pr_reg, &dev->t10_pr.registration_list,
3665 pr_reg_list) {
3667 * Check for overflow of 8byte PRI READ_KEYS payload and
3668 * next reservation key list descriptor.
3670 if ((add_len + 8) > (cmd->data_length - 8))
3671 break;
3673 buf[off++] = ((pr_reg->pr_res_key >> 56) & 0xff);
3674 buf[off++] = ((pr_reg->pr_res_key >> 48) & 0xff);
3675 buf[off++] = ((pr_reg->pr_res_key >> 40) & 0xff);
3676 buf[off++] = ((pr_reg->pr_res_key >> 32) & 0xff);
3677 buf[off++] = ((pr_reg->pr_res_key >> 24) & 0xff);
3678 buf[off++] = ((pr_reg->pr_res_key >> 16) & 0xff);
3679 buf[off++] = ((pr_reg->pr_res_key >> 8) & 0xff);
3680 buf[off++] = (pr_reg->pr_res_key & 0xff);
3682 add_len += 8;
3684 spin_unlock(&dev->t10_pr.registration_lock);
3686 buf[4] = ((add_len >> 24) & 0xff);
3687 buf[5] = ((add_len >> 16) & 0xff);
3688 buf[6] = ((add_len >> 8) & 0xff);
3689 buf[7] = (add_len & 0xff);
3691 transport_kunmap_data_sg(cmd);
3693 return 0;
3697 * PERSISTENT_RESERVE_IN Service Action READ_RESERVATION
3699 * See spc4r17 section 5.7.6.3 and section 6.13.3.2 Table 161 and 162
3701 static sense_reason_t
3702 core_scsi3_pri_read_reservation(struct se_cmd *cmd)
3704 struct se_device *dev = cmd->se_dev;
3705 struct t10_pr_registration *pr_reg;
3706 unsigned char *buf;
3707 u64 pr_res_key;
3708 u32 add_len = 16; /* Hardcoded to 16 when a reservation is held. */
3710 if (cmd->data_length < 8) {
3711 pr_err("PRIN SA READ_RESERVATIONS SCSI Data Length: %u"
3712 " too small\n", cmd->data_length);
3713 return TCM_INVALID_CDB_FIELD;
3716 buf = transport_kmap_data_sg(cmd);
3717 if (!buf)
3718 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3720 buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3721 buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3722 buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3723 buf[3] = (dev->t10_pr.pr_generation & 0xff);
3725 spin_lock(&dev->dev_reservation_lock);
3726 pr_reg = dev->dev_pr_res_holder;
3727 if (pr_reg) {
3729 * Set the hardcoded Additional Length
3731 buf[4] = ((add_len >> 24) & 0xff);
3732 buf[5] = ((add_len >> 16) & 0xff);
3733 buf[6] = ((add_len >> 8) & 0xff);
3734 buf[7] = (add_len & 0xff);
3736 if (cmd->data_length < 22)
3737 goto err;
3740 * Set the Reservation key.
3742 * From spc4r17, section 5.7.10:
3743 * A persistent reservation holder has its reservation key
3744 * returned in the parameter data from a PERSISTENT
3745 * RESERVE IN command with READ RESERVATION service action as
3746 * follows:
3747 * a) For a persistent reservation of the type Write Exclusive
3748 * - All Registrants or Exclusive Access ­ All Regitrants,
3749 * the reservation key shall be set to zero; or
3750 * b) For all other persistent reservation types, the
3751 * reservation key shall be set to the registered
3752 * reservation key for the I_T nexus that holds the
3753 * persistent reservation.
3755 if ((pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
3756 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))
3757 pr_res_key = 0;
3758 else
3759 pr_res_key = pr_reg->pr_res_key;
3761 buf[8] = ((pr_res_key >> 56) & 0xff);
3762 buf[9] = ((pr_res_key >> 48) & 0xff);
3763 buf[10] = ((pr_res_key >> 40) & 0xff);
3764 buf[11] = ((pr_res_key >> 32) & 0xff);
3765 buf[12] = ((pr_res_key >> 24) & 0xff);
3766 buf[13] = ((pr_res_key >> 16) & 0xff);
3767 buf[14] = ((pr_res_key >> 8) & 0xff);
3768 buf[15] = (pr_res_key & 0xff);
3770 * Set the SCOPE and TYPE
3772 buf[21] = (pr_reg->pr_res_scope & 0xf0) |
3773 (pr_reg->pr_res_type & 0x0f);
3776 err:
3777 spin_unlock(&dev->dev_reservation_lock);
3778 transport_kunmap_data_sg(cmd);
3780 return 0;
3784 * PERSISTENT_RESERVE_IN Service Action REPORT_CAPABILITIES
3786 * See spc4r17 section 6.13.4 Table 165
3788 static sense_reason_t
3789 core_scsi3_pri_report_capabilities(struct se_cmd *cmd)
3791 struct se_device *dev = cmd->se_dev;
3792 struct t10_reservation *pr_tmpl = &dev->t10_pr;
3793 unsigned char *buf;
3794 u16 add_len = 8; /* Hardcoded to 8. */
3796 if (cmd->data_length < 6) {
3797 pr_err("PRIN SA REPORT_CAPABILITIES SCSI Data Length:"
3798 " %u too small\n", cmd->data_length);
3799 return TCM_INVALID_CDB_FIELD;
3802 buf = transport_kmap_data_sg(cmd);
3803 if (!buf)
3804 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3806 buf[0] = ((add_len << 8) & 0xff);
3807 buf[1] = (add_len & 0xff);
3808 buf[2] |= 0x10; /* CRH: Compatible Reservation Hanlding bit. */
3809 buf[2] |= 0x08; /* SIP_C: Specify Initiator Ports Capable bit */
3810 buf[2] |= 0x04; /* ATP_C: All Target Ports Capable bit */
3811 buf[2] |= 0x01; /* PTPL_C: Persistence across Target Power Loss bit */
3813 * We are filling in the PERSISTENT RESERVATION TYPE MASK below, so
3814 * set the TMV: Task Mask Valid bit.
3816 buf[3] |= 0x80;
3818 * Change ALLOW COMMANDs to 0x20 or 0x40 later from Table 166
3820 buf[3] |= 0x10; /* ALLOW COMMANDs field 001b */
3822 * PTPL_A: Persistence across Target Power Loss Active bit
3824 if (pr_tmpl->pr_aptpl_active)
3825 buf[3] |= 0x01;
3827 * Setup the PERSISTENT RESERVATION TYPE MASK from Table 167
3829 buf[4] |= 0x80; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3830 buf[4] |= 0x40; /* PR_TYPE_EXCLUSIVE_ACCESS_REGONLY */
3831 buf[4] |= 0x20; /* PR_TYPE_WRITE_EXCLUSIVE_REGONLY */
3832 buf[4] |= 0x08; /* PR_TYPE_EXCLUSIVE_ACCESS */
3833 buf[4] |= 0x02; /* PR_TYPE_WRITE_EXCLUSIVE */
3834 buf[5] |= 0x01; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3836 transport_kunmap_data_sg(cmd);
3838 return 0;
3842 * PERSISTENT_RESERVE_IN Service Action READ_FULL_STATUS
3844 * See spc4r17 section 6.13.5 Table 168 and 169
3846 static sense_reason_t
3847 core_scsi3_pri_read_full_status(struct se_cmd *cmd)
3849 struct se_device *dev = cmd->se_dev;
3850 struct se_node_acl *se_nacl;
3851 struct se_portal_group *se_tpg;
3852 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
3853 struct t10_reservation *pr_tmpl = &dev->t10_pr;
3854 unsigned char *buf;
3855 u32 add_desc_len = 0, add_len = 0, desc_len, exp_desc_len;
3856 u32 off = 8; /* off into first Full Status descriptor */
3857 int format_code = 0;
3859 if (cmd->data_length < 8) {
3860 pr_err("PRIN SA READ_FULL_STATUS SCSI Data Length: %u"
3861 " too small\n", cmd->data_length);
3862 return TCM_INVALID_CDB_FIELD;
3865 buf = transport_kmap_data_sg(cmd);
3866 if (!buf)
3867 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3869 buf[0] = ((dev->t10_pr.pr_generation >> 24) & 0xff);
3870 buf[1] = ((dev->t10_pr.pr_generation >> 16) & 0xff);
3871 buf[2] = ((dev->t10_pr.pr_generation >> 8) & 0xff);
3872 buf[3] = (dev->t10_pr.pr_generation & 0xff);
3874 spin_lock(&pr_tmpl->registration_lock);
3875 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3876 &pr_tmpl->registration_list, pr_reg_list) {
3878 se_nacl = pr_reg->pr_reg_nacl;
3879 se_tpg = pr_reg->pr_reg_nacl->se_tpg;
3880 add_desc_len = 0;
3882 atomic_inc(&pr_reg->pr_res_holders);
3883 smp_mb__after_atomic_inc();
3884 spin_unlock(&pr_tmpl->registration_lock);
3886 * Determine expected length of $FABRIC_MOD specific
3887 * TransportID full status descriptor..
3889 exp_desc_len = se_tpg->se_tpg_tfo->tpg_get_pr_transport_id_len(
3890 se_tpg, se_nacl, pr_reg, &format_code);
3892 if ((exp_desc_len + add_len) > cmd->data_length) {
3893 pr_warn("SPC-3 PRIN READ_FULL_STATUS ran"
3894 " out of buffer: %d\n", cmd->data_length);
3895 spin_lock(&pr_tmpl->registration_lock);
3896 atomic_dec(&pr_reg->pr_res_holders);
3897 smp_mb__after_atomic_dec();
3898 break;
3901 * Set RESERVATION KEY
3903 buf[off++] = ((pr_reg->pr_res_key >> 56) & 0xff);
3904 buf[off++] = ((pr_reg->pr_res_key >> 48) & 0xff);
3905 buf[off++] = ((pr_reg->pr_res_key >> 40) & 0xff);
3906 buf[off++] = ((pr_reg->pr_res_key >> 32) & 0xff);
3907 buf[off++] = ((pr_reg->pr_res_key >> 24) & 0xff);
3908 buf[off++] = ((pr_reg->pr_res_key >> 16) & 0xff);
3909 buf[off++] = ((pr_reg->pr_res_key >> 8) & 0xff);
3910 buf[off++] = (pr_reg->pr_res_key & 0xff);
3911 off += 4; /* Skip Over Reserved area */
3914 * Set ALL_TG_PT bit if PROUT SA REGISTER had this set.
3916 if (pr_reg->pr_reg_all_tg_pt)
3917 buf[off] = 0x02;
3919 * The struct se_lun pointer will be present for the
3920 * reservation holder for PR_HOLDER bit.
3922 * Also, if this registration is the reservation
3923 * holder, fill in SCOPE and TYPE in the next byte.
3925 if (pr_reg->pr_res_holder) {
3926 buf[off++] |= 0x01;
3927 buf[off++] = (pr_reg->pr_res_scope & 0xf0) |
3928 (pr_reg->pr_res_type & 0x0f);
3929 } else
3930 off += 2;
3932 off += 4; /* Skip over reserved area */
3934 * From spc4r17 6.3.15:
3936 * If the ALL_TG_PT bit set to zero, the RELATIVE TARGET PORT
3937 * IDENTIFIER field contains the relative port identifier (see
3938 * 3.1.120) of the target port that is part of the I_T nexus
3939 * described by this full status descriptor. If the ALL_TG_PT
3940 * bit is set to one, the contents of the RELATIVE TARGET PORT
3941 * IDENTIFIER field are not defined by this standard.
3943 if (!pr_reg->pr_reg_all_tg_pt) {
3944 struct se_port *port = pr_reg->pr_reg_tg_pt_lun->lun_sep;
3946 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
3947 buf[off++] = (port->sep_rtpi & 0xff);
3948 } else
3949 off += 2; /* Skip over RELATIVE TARGET PORT IDENTIFIER */
3952 * Now, have the $FABRIC_MOD fill in the protocol identifier
3954 desc_len = se_tpg->se_tpg_tfo->tpg_get_pr_transport_id(se_tpg,
3955 se_nacl, pr_reg, &format_code, &buf[off+4]);
3957 spin_lock(&pr_tmpl->registration_lock);
3958 atomic_dec(&pr_reg->pr_res_holders);
3959 smp_mb__after_atomic_dec();
3961 * Set the ADDITIONAL DESCRIPTOR LENGTH
3963 buf[off++] = ((desc_len >> 24) & 0xff);
3964 buf[off++] = ((desc_len >> 16) & 0xff);
3965 buf[off++] = ((desc_len >> 8) & 0xff);
3966 buf[off++] = (desc_len & 0xff);
3968 * Size of full desctipor header minus TransportID
3969 * containing $FABRIC_MOD specific) initiator device/port
3970 * WWN information.
3972 * See spc4r17 Section 6.13.5 Table 169
3974 add_desc_len = (24 + desc_len);
3976 off += desc_len;
3977 add_len += add_desc_len;
3979 spin_unlock(&pr_tmpl->registration_lock);
3981 * Set ADDITIONAL_LENGTH
3983 buf[4] = ((add_len >> 24) & 0xff);
3984 buf[5] = ((add_len >> 16) & 0xff);
3985 buf[6] = ((add_len >> 8) & 0xff);
3986 buf[7] = (add_len & 0xff);
3988 transport_kunmap_data_sg(cmd);
3990 return 0;
3993 sense_reason_t
3994 target_scsi3_emulate_pr_in(struct se_cmd *cmd)
3996 sense_reason_t ret;
3999 * Following spc2r20 5.5.1 Reservations overview:
4001 * If a logical unit has been reserved by any RESERVE command and is
4002 * still reserved by any initiator, all PERSISTENT RESERVE IN and all
4003 * PERSISTENT RESERVE OUT commands shall conflict regardless of
4004 * initiator or service action and shall terminate with a RESERVATION
4005 * CONFLICT status.
4007 if (cmd->se_dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS) {
4008 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
4009 " SPC-2 reservation is held, returning"
4010 " RESERVATION_CONFLICT\n");
4011 return TCM_RESERVATION_CONFLICT;
4014 switch (cmd->t_task_cdb[1] & 0x1f) {
4015 case PRI_READ_KEYS:
4016 ret = core_scsi3_pri_read_keys(cmd);
4017 break;
4018 case PRI_READ_RESERVATION:
4019 ret = core_scsi3_pri_read_reservation(cmd);
4020 break;
4021 case PRI_REPORT_CAPABILITIES:
4022 ret = core_scsi3_pri_report_capabilities(cmd);
4023 break;
4024 case PRI_READ_FULL_STATUS:
4025 ret = core_scsi3_pri_read_full_status(cmd);
4026 break;
4027 default:
4028 pr_err("Unknown PERSISTENT_RESERVE_IN service"
4029 " action: 0x%02x\n", cmd->t_task_cdb[1] & 0x1f);
4030 return TCM_INVALID_CDB_FIELD;
4033 if (!ret)
4034 target_complete_cmd(cmd, GOOD);
4035 return ret;
4038 sense_reason_t
4039 target_check_reservation(struct se_cmd *cmd)
4041 struct se_device *dev = cmd->se_dev;
4042 sense_reason_t ret;
4044 if (!cmd->se_sess)
4045 return 0;
4046 if (dev->se_hba->hba_flags & HBA_FLAGS_INTERNAL_USE)
4047 return 0;
4048 if (dev->transport->transport_type == TRANSPORT_PLUGIN_PHBA_PDEV)
4049 return 0;
4051 spin_lock(&dev->dev_reservation_lock);
4052 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS)
4053 ret = target_scsi2_reservation_check(cmd);
4054 else
4055 ret = target_scsi3_pr_reservation_check(cmd);
4056 spin_unlock(&dev->dev_reservation_lock);
4058 return ret;