1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*******************************************************************************
3 * Filename: target_core_pr.c
4 *
5 * This file contains SPC-3 compliant persistent reservations and
6 * legacy SPC-2 reservations with compatible reservation handling (CRH=1)
7 *
8 * (c) Copyright 2009-2013 Datera, Inc.
9 *
10 * Nicholas A. Bellinger <nab@kernel.org>
11 *
12 ******************************************************************************/
13
14 #include <linux/slab.h>
15 #include <linux/spinlock.h>
16 #include <linux/list.h>
17 #include <linux/vmalloc.h>
18 #include <linux/file.h>
19 #include <linux/fcntl.h>
20 #include <linux/fs.h>
21 #include <scsi/scsi_proto.h>
22 #include <linux/unaligned.h>
23
24 #include <target/target_core_base.h>
25 #include <target/target_core_backend.h>
26 #include <target/target_core_fabric.h>
27
28 #include "target_core_internal.h"
29 #include "target_core_pr.h"
30 #include "target_core_ua.h"
31
32 /*
33 * Used for Specify Initiator Ports Capable Bit (SPEC_I_PT)
34 */
35 struct pr_transport_id_holder {
36 struct t10_pr_registration *dest_pr_reg;
37 struct se_portal_group *dest_tpg;
38 struct se_node_acl *dest_node_acl;
39 struct se_dev_entry *dest_se_deve;
40 struct list_head dest_list;
41 };
42
core_pr_dump_initiator_port(struct t10_pr_registration * pr_reg,char * buf,u32 size)43 void core_pr_dump_initiator_port(
44 struct t10_pr_registration *pr_reg,
45 char *buf,
46 u32 size)
47 {
48 if (!pr_reg->isid_present_at_reg) {
49 buf[0] = '\0';
50 return;
51 }
52
53 snprintf(buf, size, ",i,0x%s", pr_reg->pr_reg_isid);
54 }
55
56 enum register_type {
57 REGISTER,
58 REGISTER_AND_IGNORE_EXISTING_KEY,
59 REGISTER_AND_MOVE,
60 };
61
62 enum preempt_type {
63 PREEMPT,
64 PREEMPT_AND_ABORT,
65 };
66
67 static void __core_scsi3_complete_pro_release(struct se_device *, struct se_node_acl *,
68 struct t10_pr_registration *, int, int);
69
is_reservation_holder(struct t10_pr_registration * pr_res_holder,struct t10_pr_registration * pr_reg)70 static int is_reservation_holder(
71 struct t10_pr_registration *pr_res_holder,
72 struct t10_pr_registration *pr_reg)
73 {
74 int pr_res_type;
75
76 if (pr_res_holder) {
77 pr_res_type = pr_res_holder->pr_res_type;
78
79 return pr_res_holder == pr_reg ||
80 pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG ||
81 pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG;
82 }
83 return 0;
84 }
85
86 static sense_reason_t
target_scsi2_reservation_check(struct se_cmd * cmd)87 target_scsi2_reservation_check(struct se_cmd *cmd)
88 {
89 struct se_device *dev = cmd->se_dev;
90 struct se_session *sess = cmd->se_sess;
91
92 switch (cmd->t_task_cdb[0]) {
93 case INQUIRY:
94 case RELEASE_6:
95 case RELEASE_10:
96 return 0;
97 default:
98 break;
99 }
100
101 if (!dev->reservation_holder || !sess)
102 return 0;
103
104 if (dev->reservation_holder->se_node_acl != sess->se_node_acl)
105 return TCM_RESERVATION_CONFLICT;
106
107 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS_WITH_ISID) {
108 if (dev->dev_res_bin_isid != sess->sess_bin_isid)
109 return TCM_RESERVATION_CONFLICT;
110 }
111
112 return 0;
113 }
114
115 static struct t10_pr_registration *core_scsi3_locate_pr_reg(struct se_device *,
116 struct se_node_acl *, struct se_session *);
117 static void core_scsi3_put_pr_reg(struct t10_pr_registration *);
118
target_check_scsi2_reservation_conflict(struct se_cmd * cmd)119 static int target_check_scsi2_reservation_conflict(struct se_cmd *cmd)
120 {
121 struct se_session *se_sess = cmd->se_sess;
122 struct se_device *dev = cmd->se_dev;
123 struct t10_pr_registration *pr_reg;
124 struct t10_reservation *pr_tmpl = &dev->t10_pr;
125 int conflict = 0;
126
127 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
128 se_sess);
129 if (pr_reg) {
130 /*
131 * From spc4r17 5.7.3 Exceptions to SPC-2 RESERVE and RELEASE
132 * behavior
133 *
134 * A RESERVE(6) or RESERVE(10) command shall complete with GOOD
135 * status, but no reservation shall be established and the
136 * persistent reservation shall not be changed, if the command
137 * is received from a) and b) below.
138 *
139 * A RELEASE(6) or RELEASE(10) command shall complete with GOOD
140 * status, but the persistent reservation shall not be released,
141 * if the command is received from a) and b)
142 *
143 * a) An I_T nexus that is a persistent reservation holder; or
144 * b) An I_T nexus that is registered if a registrants only or
145 * all registrants type persistent reservation is present.
146 *
147 * In all other cases, a RESERVE(6) command, RESERVE(10) command,
148 * RELEASE(6) command, or RELEASE(10) command shall be processed
149 * as defined in SPC-2.
150 */
151 if (pr_reg->pr_res_holder) {
152 core_scsi3_put_pr_reg(pr_reg);
153 return 1;
154 }
155 if ((pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_REGONLY) ||
156 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_REGONLY) ||
157 (pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
158 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
159 core_scsi3_put_pr_reg(pr_reg);
160 return 1;
161 }
162 core_scsi3_put_pr_reg(pr_reg);
163 conflict = 1;
164 } else {
165 /*
166 * Following spc2r20 5.5.1 Reservations overview:
167 *
168 * If a logical unit has executed a PERSISTENT RESERVE OUT
169 * command with the REGISTER or the REGISTER AND IGNORE
170 * EXISTING KEY service action and is still registered by any
171 * initiator, all RESERVE commands and all RELEASE commands
172 * regardless of initiator shall conflict and shall terminate
173 * with a RESERVATION CONFLICT status.
174 */
175 spin_lock(&pr_tmpl->registration_lock);
176 conflict = (list_empty(&pr_tmpl->registration_list)) ? 0 : 1;
177 spin_unlock(&pr_tmpl->registration_lock);
178 }
179
180 if (conflict) {
181 pr_err("Received legacy SPC-2 RESERVE/RELEASE"
182 " while active SPC-3 registrations exist,"
183 " returning RESERVATION_CONFLICT\n");
184 return -EBUSY;
185 }
186
187 return 0;
188 }
189
target_release_reservation(struct se_device * dev)190 void target_release_reservation(struct se_device *dev)
191 {
192 dev->reservation_holder = NULL;
193 dev->dev_reservation_flags &= ~DRF_SPC2_RESERVATIONS;
194 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS_WITH_ISID) {
195 dev->dev_res_bin_isid = 0;
196 dev->dev_reservation_flags &= ~DRF_SPC2_RESERVATIONS_WITH_ISID;
197 }
198 }
199
200 sense_reason_t
target_scsi2_reservation_release(struct se_cmd * cmd)201 target_scsi2_reservation_release(struct se_cmd *cmd)
202 {
203 struct se_device *dev = cmd->se_dev;
204 struct se_session *sess = cmd->se_sess;
205 struct se_portal_group *tpg;
206 int rc;
207
208 if (!sess || !sess->se_tpg)
209 goto out;
210 rc = target_check_scsi2_reservation_conflict(cmd);
211 if (rc == 1)
212 goto out;
213 if (rc < 0)
214 return TCM_RESERVATION_CONFLICT;
215
216 spin_lock(&dev->dev_reservation_lock);
217 if (!dev->reservation_holder || !sess)
218 goto out_unlock;
219
220 if (dev->reservation_holder->se_node_acl != sess->se_node_acl)
221 goto out_unlock;
222
223 if (dev->dev_res_bin_isid != sess->sess_bin_isid)
224 goto out_unlock;
225
226 target_release_reservation(dev);
227 tpg = sess->se_tpg;
228 pr_debug("SCSI-2 Released reservation for %s LUN: %llu ->"
229 " MAPPED LUN: %llu for %s\n",
230 tpg->se_tpg_tfo->fabric_name,
231 cmd->se_lun->unpacked_lun, cmd->orig_fe_lun,
232 sess->se_node_acl->initiatorname);
233
234 out_unlock:
235 spin_unlock(&dev->dev_reservation_lock);
236 out:
237 target_complete_cmd(cmd, SAM_STAT_GOOD);
238 return 0;
239 }
240
241 sense_reason_t
target_scsi2_reservation_reserve(struct se_cmd * cmd)242 target_scsi2_reservation_reserve(struct se_cmd *cmd)
243 {
244 struct se_device *dev = cmd->se_dev;
245 struct se_session *sess = cmd->se_sess;
246 struct se_portal_group *tpg;
247 sense_reason_t ret = 0;
248 int rc;
249
250 if ((cmd->t_task_cdb[1] & 0x01) &&
251 (cmd->t_task_cdb[1] & 0x02)) {
252 pr_err("LongIO and Obsolete Bits set, returning ILLEGAL_REQUEST\n");
253 return TCM_UNSUPPORTED_SCSI_OPCODE;
254 }
255 /*
256 * This is currently the case for target_core_mod passthrough struct se_cmd
257 * ops
258 */
259 if (!sess || !sess->se_tpg)
260 goto out;
261 rc = target_check_scsi2_reservation_conflict(cmd);
262 if (rc == 1)
263 goto out;
264
265 if (rc < 0)
266 return TCM_RESERVATION_CONFLICT;
267
268 tpg = sess->se_tpg;
269 spin_lock(&dev->dev_reservation_lock);
270 if (dev->reservation_holder &&
271 dev->reservation_holder->se_node_acl != sess->se_node_acl) {
272 pr_err("SCSI-2 RESERVATION CONFLICT for %s fabric\n",
273 tpg->se_tpg_tfo->fabric_name);
274 pr_err("Original reserver LUN: %llu %s\n",
275 cmd->se_lun->unpacked_lun,
276 dev->reservation_holder->se_node_acl->initiatorname);
277 pr_err("Current attempt - LUN: %llu -> MAPPED LUN: %llu"
278 " from %s \n", cmd->se_lun->unpacked_lun,
279 cmd->orig_fe_lun,
280 sess->se_node_acl->initiatorname);
281 ret = TCM_RESERVATION_CONFLICT;
282 goto out_unlock;
283 }
284
285 dev->reservation_holder = sess;
286 dev->dev_reservation_flags |= DRF_SPC2_RESERVATIONS;
287 if (sess->sess_bin_isid != 0) {
288 dev->dev_res_bin_isid = sess->sess_bin_isid;
289 dev->dev_reservation_flags |= DRF_SPC2_RESERVATIONS_WITH_ISID;
290 }
291 pr_debug("SCSI-2 Reserved %s LUN: %llu -> MAPPED LUN: %llu"
292 " for %s\n", tpg->se_tpg_tfo->fabric_name,
293 cmd->se_lun->unpacked_lun, cmd->orig_fe_lun,
294 sess->se_node_acl->initiatorname);
295
296 out_unlock:
297 spin_unlock(&dev->dev_reservation_lock);
298 out:
299 if (!ret)
300 target_complete_cmd(cmd, SAM_STAT_GOOD);
301 return ret;
302 }
303
304
305 /*
306 * Begin SPC-3/SPC-4 Persistent Reservations emulation support
307 *
308 * This function is called by those initiator ports who are *NOT*
309 * the active PR reservation holder when a reservation is present.
310 */
core_scsi3_pr_seq_non_holder(struct se_cmd * cmd,u32 pr_reg_type,bool isid_mismatch)311 static int core_scsi3_pr_seq_non_holder(struct se_cmd *cmd, u32 pr_reg_type,
312 bool isid_mismatch)
313 {
314 unsigned char *cdb = cmd->t_task_cdb;
315 struct se_session *se_sess = cmd->se_sess;
316 struct se_node_acl *nacl = se_sess->se_node_acl;
317 int other_cdb = 0;
318 int registered_nexus = 0, ret = 1; /* Conflict by default */
319 int all_reg = 0, reg_only = 0; /* ALL_REG, REG_ONLY */
320 int we = 0; /* Write Exclusive */
321 int legacy = 0; /* Act like a legacy device and return
322 * RESERVATION CONFLICT on some CDBs */
323
324 if (isid_mismatch) {
325 registered_nexus = 0;
326 } else {
327 struct se_dev_entry *se_deve;
328
329 rcu_read_lock();
330 se_deve = target_nacl_find_deve(nacl, cmd->orig_fe_lun);
331 if (se_deve)
332 registered_nexus = test_bit(DEF_PR_REG_ACTIVE,
333 &se_deve->deve_flags);
334 rcu_read_unlock();
335 }
336
337 switch (pr_reg_type) {
338 case PR_TYPE_WRITE_EXCLUSIVE:
339 we = 1;
340 fallthrough;
341 case PR_TYPE_EXCLUSIVE_ACCESS:
342 /*
343 * Some commands are only allowed for the persistent reservation
344 * holder.
345 */
346 break;
347 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
348 we = 1;
349 fallthrough;
350 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
351 /*
352 * Some commands are only allowed for registered I_T Nexuses.
353 */
354 reg_only = 1;
355 break;
356 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
357 we = 1;
358 fallthrough;
359 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
360 /*
361 * Each registered I_T Nexus is a reservation holder.
362 */
363 all_reg = 1;
364 break;
365 default:
366 return -EINVAL;
367 }
368 /*
369 * Referenced from spc4r17 table 45 for *NON* PR holder access
370 */
371 switch (cdb[0]) {
372 case SECURITY_PROTOCOL_IN:
373 if (registered_nexus)
374 return 0;
375 ret = (we) ? 0 : 1;
376 break;
377 case MODE_SENSE:
378 case MODE_SENSE_10:
379 case READ_ATTRIBUTE:
380 case READ_BUFFER:
381 case RECEIVE_DIAGNOSTIC:
382 if (legacy) {
383 ret = 1;
384 break;
385 }
386 if (registered_nexus) {
387 ret = 0;
388 break;
389 }
390 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
391 break;
392 case PERSISTENT_RESERVE_OUT:
393 /*
394 * This follows PERSISTENT_RESERVE_OUT service actions that
395 * are allowed in the presence of various reservations.
396 * See spc4r17, table 46
397 */
398 switch (cdb[1] & 0x1f) {
399 case PRO_CLEAR:
400 case PRO_PREEMPT:
401 case PRO_PREEMPT_AND_ABORT:
402 ret = (registered_nexus) ? 0 : 1;
403 break;
404 case PRO_REGISTER:
405 case PRO_REGISTER_AND_IGNORE_EXISTING_KEY:
406 ret = 0;
407 break;
408 case PRO_REGISTER_AND_MOVE:
409 case PRO_RESERVE:
410 ret = 1;
411 break;
412 case PRO_RELEASE:
413 ret = (registered_nexus) ? 0 : 1;
414 break;
415 default:
416 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
417 " action: 0x%02x\n", cdb[1] & 0x1f);
418 return -EINVAL;
419 }
420 break;
421 case RELEASE_6:
422 case RELEASE_10:
423 /* Handled by CRH=1 in target_scsi2_reservation_release() */
424 ret = 0;
425 break;
426 case RESERVE_6:
427 case RESERVE_10:
428 /* Handled by CRH=1 in target_scsi2_reservation_reserve() */
429 ret = 0;
430 break;
431 case TEST_UNIT_READY:
432 ret = (legacy) ? 1 : 0; /* Conflict for legacy */
433 break;
434 case MAINTENANCE_IN:
435 switch (cdb[1] & 0x1f) {
436 case MI_MANAGEMENT_PROTOCOL_IN:
437 if (registered_nexus) {
438 ret = 0;
439 break;
440 }
441 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
442 break;
443 case MI_REPORT_SUPPORTED_OPERATION_CODES:
444 case MI_REPORT_SUPPORTED_TASK_MANAGEMENT_FUNCTIONS:
445 if (legacy) {
446 ret = 1;
447 break;
448 }
449 if (registered_nexus) {
450 ret = 0;
451 break;
452 }
453 ret = (we) ? 0 : 1; /* Allowed Write Exclusive */
454 break;
455 case MI_REPORT_ALIASES:
456 case MI_REPORT_IDENTIFYING_INFORMATION:
457 case MI_REPORT_PRIORITY:
458 case MI_REPORT_TARGET_PGS:
459 case MI_REPORT_TIMESTAMP:
460 ret = 0; /* Allowed */
461 break;
462 default:
463 pr_err("Unknown MI Service Action: 0x%02x\n",
464 (cdb[1] & 0x1f));
465 return -EINVAL;
466 }
467 break;
468 case ACCESS_CONTROL_IN:
469 case ACCESS_CONTROL_OUT:
470 case INQUIRY:
471 case LOG_SENSE:
472 case SERVICE_ACTION_IN_12:
473 case READ_CAPACITY:
474 case REPORT_LUNS:
475 case REQUEST_SENSE:
476 case PERSISTENT_RESERVE_IN:
477 ret = 0; /*/ Allowed CDBs */
478 break;
479 default:
480 other_cdb = 1;
481 break;
482 }
483 /*
484 * Case where the CDB is explicitly allowed in the above switch
485 * statement.
486 */
487 if (!ret && !other_cdb) {
488 pr_debug("Allowing explicit CDB: 0x%02x for %s"
489 " reservation holder\n", cdb[0],
490 core_scsi3_pr_dump_type(pr_reg_type));
491
492 return ret;
493 }
494 /*
495 * Check if write exclusive initiator ports *NOT* holding the
496 * WRITE_EXCLUSIVE_* reservation.
497 */
498 if (we && !registered_nexus) {
499 if (cmd->data_direction == DMA_TO_DEVICE) {
500 /*
501 * Conflict for write exclusive
502 */
503 pr_debug("%s Conflict for unregistered nexus"
504 " %s CDB: 0x%02x to %s reservation\n",
505 transport_dump_cmd_direction(cmd),
506 se_sess->se_node_acl->initiatorname, cdb[0],
507 core_scsi3_pr_dump_type(pr_reg_type));
508 return 1;
509 } else {
510 /*
511 * Allow non WRITE CDBs for all Write Exclusive
512 * PR TYPEs to pass for registered and
513 * non-registered_nexuxes NOT holding the reservation.
514 *
515 * We only make noise for the unregisterd nexuses,
516 * as we expect registered non-reservation holding
517 * nexuses to issue CDBs.
518 */
519
520 if (!registered_nexus) {
521 pr_debug("Allowing implicit CDB: 0x%02x"
522 " for %s reservation on unregistered"
523 " nexus\n", cdb[0],
524 core_scsi3_pr_dump_type(pr_reg_type));
525 }
526
527 return 0;
528 }
529 } else if ((reg_only) || (all_reg)) {
530 if (registered_nexus) {
531 /*
532 * For PR_*_REG_ONLY and PR_*_ALL_REG reservations,
533 * allow commands from registered nexuses.
534 */
535
536 pr_debug("Allowing implicit CDB: 0x%02x for %s"
537 " reservation\n", cdb[0],
538 core_scsi3_pr_dump_type(pr_reg_type));
539
540 return 0;
541 }
542 } else if (we && registered_nexus) {
543 /*
544 * Reads are allowed for Write Exclusive locks
545 * from all registrants.
546 */
547 if (cmd->data_direction == DMA_FROM_DEVICE) {
548 pr_debug("Allowing READ CDB: 0x%02x for %s"
549 " reservation\n", cdb[0],
550 core_scsi3_pr_dump_type(pr_reg_type));
551
552 return 0;
553 }
554 }
555 pr_debug("%s Conflict for %sregistered nexus %s CDB: 0x%2x"
556 " for %s reservation\n", transport_dump_cmd_direction(cmd),
557 (registered_nexus) ? "" : "un",
558 se_sess->se_node_acl->initiatorname, cdb[0],
559 core_scsi3_pr_dump_type(pr_reg_type));
560
561 return 1; /* Conflict by default */
562 }
563
564 static sense_reason_t
target_scsi3_pr_reservation_check(struct se_cmd * cmd)565 target_scsi3_pr_reservation_check(struct se_cmd *cmd)
566 {
567 struct se_device *dev = cmd->se_dev;
568 struct se_session *sess = cmd->se_sess;
569 u32 pr_reg_type;
570 bool isid_mismatch = false;
571
572 if (!dev->dev_pr_res_holder)
573 return 0;
574
575 pr_reg_type = dev->dev_pr_res_holder->pr_res_type;
576 cmd->pr_res_key = dev->dev_pr_res_holder->pr_res_key;
577 if (dev->dev_pr_res_holder->pr_reg_nacl != sess->se_node_acl)
578 goto check_nonholder;
579
580 if (dev->dev_pr_res_holder->isid_present_at_reg) {
581 if (dev->dev_pr_res_holder->pr_reg_bin_isid !=
582 sess->sess_bin_isid) {
583 isid_mismatch = true;
584 goto check_nonholder;
585 }
586 }
587
588 return 0;
589
590 check_nonholder:
591 if (core_scsi3_pr_seq_non_holder(cmd, pr_reg_type, isid_mismatch))
592 return TCM_RESERVATION_CONFLICT;
593 return 0;
594 }
595
core_scsi3_pr_generation(struct se_device * dev)596 static u32 core_scsi3_pr_generation(struct se_device *dev)
597 {
598 u32 prg;
599
600 /*
601 * PRGeneration field shall contain the value of a 32-bit wrapping
602 * counter mainted by the device server.
603 *
604 * Note that this is done regardless of Active Persist across
605 * Target PowerLoss (APTPL)
606 *
607 * See spc4r17 section 6.3.12 READ_KEYS service action
608 */
609 spin_lock(&dev->dev_reservation_lock);
610 prg = dev->t10_pr.pr_generation++;
611 spin_unlock(&dev->dev_reservation_lock);
612
613 return prg;
614 }
615
__core_scsi3_do_alloc_registration(struct se_device * dev,struct se_node_acl * nacl,struct se_lun * lun,struct se_dev_entry * dest_deve,u64 mapped_lun,unsigned char * isid,u64 sa_res_key,int all_tg_pt,int aptpl)616 static struct t10_pr_registration *__core_scsi3_do_alloc_registration(
617 struct se_device *dev,
618 struct se_node_acl *nacl,
619 struct se_lun *lun,
620 struct se_dev_entry *dest_deve,
621 u64 mapped_lun,
622 unsigned char *isid,
623 u64 sa_res_key,
624 int all_tg_pt,
625 int aptpl)
626 {
627 struct t10_pr_registration *pr_reg;
628
629 pr_reg = kmem_cache_zalloc(t10_pr_reg_cache, GFP_ATOMIC);
630 if (!pr_reg) {
631 pr_err("Unable to allocate struct t10_pr_registration\n");
632 return NULL;
633 }
634
635 INIT_LIST_HEAD(&pr_reg->pr_reg_list);
636 INIT_LIST_HEAD(&pr_reg->pr_reg_abort_list);
637 INIT_LIST_HEAD(&pr_reg->pr_reg_aptpl_list);
638 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_list);
639 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_mem_list);
640 atomic_set(&pr_reg->pr_res_holders, 0);
641 pr_reg->pr_reg_nacl = nacl;
642 /*
643 * For destination registrations for ALL_TG_PT=1 and SPEC_I_PT=1,
644 * the se_dev_entry->pr_ref will have been already obtained by
645 * core_get_se_deve_from_rtpi() or __core_scsi3_alloc_registration().
646 *
647 * Otherwise, locate se_dev_entry now and obtain a reference until
648 * registration completes in __core_scsi3_add_registration().
649 */
650 if (dest_deve) {
651 pr_reg->pr_reg_deve = dest_deve;
652 } else {
653 rcu_read_lock();
654 pr_reg->pr_reg_deve = target_nacl_find_deve(nacl, mapped_lun);
655 if (!pr_reg->pr_reg_deve) {
656 rcu_read_unlock();
657 pr_err("Unable to locate PR deve %s mapped_lun: %llu\n",
658 nacl->initiatorname, mapped_lun);
659 kmem_cache_free(t10_pr_reg_cache, pr_reg);
660 return NULL;
661 }
662 kref_get(&pr_reg->pr_reg_deve->pr_kref);
663 rcu_read_unlock();
664 }
665 pr_reg->pr_res_mapped_lun = mapped_lun;
666 pr_reg->pr_aptpl_target_lun = lun->unpacked_lun;
667 pr_reg->tg_pt_sep_rtpi = lun->lun_tpg->tpg_rtpi;
668 pr_reg->pr_res_key = sa_res_key;
669 pr_reg->pr_reg_all_tg_pt = all_tg_pt;
670 pr_reg->pr_reg_aptpl = aptpl;
671 /*
672 * If an ISID value for this SCSI Initiator Port exists,
673 * save it to the registration now.
674 */
675 if (isid != NULL) {
676 pr_reg->pr_reg_bin_isid = get_unaligned_be64(isid);
677 snprintf(pr_reg->pr_reg_isid, PR_REG_ISID_LEN, "%s", isid);
678 pr_reg->isid_present_at_reg = 1;
679 }
680
681 return pr_reg;
682 }
683
684 static int core_scsi3_lunacl_depend_item(struct se_dev_entry *);
685 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry *);
686
687 /*
688 * Function used for handling PR registrations for ALL_TG_PT=1 and ALL_TG_PT=0
689 * modes.
690 */
__core_scsi3_alloc_registration(struct se_device * dev,struct se_node_acl * nacl,struct se_lun * lun,struct se_dev_entry * deve,u64 mapped_lun,unsigned char * isid,u64 sa_res_key,int all_tg_pt,int aptpl)691 static struct t10_pr_registration *__core_scsi3_alloc_registration(
692 struct se_device *dev,
693 struct se_node_acl *nacl,
694 struct se_lun *lun,
695 struct se_dev_entry *deve,
696 u64 mapped_lun,
697 unsigned char *isid,
698 u64 sa_res_key,
699 int all_tg_pt,
700 int aptpl)
701 {
702 struct se_dev_entry *deve_tmp;
703 struct se_node_acl *nacl_tmp;
704 struct se_lun_acl *lacl_tmp;
705 struct se_lun *lun_tmp, *next, *dest_lun;
706 const struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
707 struct t10_pr_registration *pr_reg, *pr_reg_atp, *pr_reg_tmp, *pr_reg_tmp_safe;
708 int ret;
709 /*
710 * Create a registration for the I_T Nexus upon which the
711 * PROUT REGISTER was received.
712 */
713 pr_reg = __core_scsi3_do_alloc_registration(dev, nacl, lun, deve, mapped_lun,
714 isid, sa_res_key, all_tg_pt,
715 aptpl);
716 if (!pr_reg)
717 return NULL;
718 /*
719 * Return pointer to pr_reg for ALL_TG_PT=0
720 */
721 if (!all_tg_pt)
722 return pr_reg;
723 /*
724 * Create list of matching SCSI Initiator Port registrations
725 * for ALL_TG_PT=1
726 */
727 spin_lock(&dev->se_port_lock);
728 list_for_each_entry_safe(lun_tmp, next, &dev->dev_sep_list, lun_dev_link) {
729 if (!percpu_ref_tryget_live(&lun_tmp->lun_ref))
730 continue;
731 spin_unlock(&dev->se_port_lock);
732
733 spin_lock(&lun_tmp->lun_deve_lock);
734 list_for_each_entry(deve_tmp, &lun_tmp->lun_deve_list, lun_link) {
735 /*
736 * This pointer will be NULL for demo mode MappedLUNs
737 * that have not been make explicit via a ConfigFS
738 * MappedLUN group for the SCSI Initiator Node ACL.
739 */
740 if (!deve_tmp->se_lun_acl)
741 continue;
742
743 lacl_tmp = deve_tmp->se_lun_acl;
744 nacl_tmp = lacl_tmp->se_lun_nacl;
745 /*
746 * Skip the matching struct se_node_acl that is allocated
747 * above..
748 */
749 if (nacl == nacl_tmp)
750 continue;
751 /*
752 * Only perform PR registrations for target ports on
753 * the same fabric module as the REGISTER w/ ALL_TG_PT=1
754 * arrived.
755 */
756 if (tfo != nacl_tmp->se_tpg->se_tpg_tfo)
757 continue;
758 /*
759 * Look for a matching Initiator Node ACL in ASCII format
760 */
761 if (strcmp(nacl->initiatorname, nacl_tmp->initiatorname))
762 continue;
763
764 kref_get(&deve_tmp->pr_kref);
765 spin_unlock(&lun_tmp->lun_deve_lock);
766 /*
767 * Grab a configfs group dependency that is released
768 * for the exception path at label out: below, or upon
769 * completion of adding ALL_TG_PT=1 registrations in
770 * __core_scsi3_add_registration()
771 */
772 ret = core_scsi3_lunacl_depend_item(deve_tmp);
773 if (ret < 0) {
774 pr_err("core_scsi3_lunacl_depend"
775 "_item() failed\n");
776 percpu_ref_put(&lun_tmp->lun_ref);
777 kref_put(&deve_tmp->pr_kref, target_pr_kref_release);
778 goto out;
779 }
780 /*
781 * Located a matching SCSI Initiator Port on a different
782 * port, allocate the pr_reg_atp and attach it to the
783 * pr_reg->pr_reg_atp_list that will be processed once
784 * the original *pr_reg is processed in
785 * __core_scsi3_add_registration()
786 */
787 dest_lun = deve_tmp->se_lun;
788
789 pr_reg_atp = __core_scsi3_do_alloc_registration(dev,
790 nacl_tmp, dest_lun, deve_tmp,
791 deve_tmp->mapped_lun, NULL,
792 sa_res_key, all_tg_pt, aptpl);
793 if (!pr_reg_atp) {
794 percpu_ref_put(&lun_tmp->lun_ref);
795 core_scsi3_lunacl_undepend_item(deve_tmp);
796 goto out;
797 }
798
799 list_add_tail(&pr_reg_atp->pr_reg_atp_mem_list,
800 &pr_reg->pr_reg_atp_list);
801 spin_lock(&lun_tmp->lun_deve_lock);
802 }
803 spin_unlock(&lun_tmp->lun_deve_lock);
804
805 spin_lock(&dev->se_port_lock);
806 percpu_ref_put(&lun_tmp->lun_ref);
807 }
808 spin_unlock(&dev->se_port_lock);
809
810 return pr_reg;
811 out:
812 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
813 &pr_reg->pr_reg_atp_list, pr_reg_atp_mem_list) {
814 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
815 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
816 kmem_cache_free(t10_pr_reg_cache, pr_reg_tmp);
817 }
818 kmem_cache_free(t10_pr_reg_cache, pr_reg);
819 return NULL;
820 }
821
core_scsi3_alloc_aptpl_registration(struct t10_reservation * pr_tmpl,u64 sa_res_key,unsigned char * i_port,unsigned char * isid,u64 mapped_lun,unsigned char * t_port,u16 tpgt,u64 target_lun,int res_holder,int all_tg_pt,u8 type)822 int core_scsi3_alloc_aptpl_registration(
823 struct t10_reservation *pr_tmpl,
824 u64 sa_res_key,
825 unsigned char *i_port,
826 unsigned char *isid,
827 u64 mapped_lun,
828 unsigned char *t_port,
829 u16 tpgt,
830 u64 target_lun,
831 int res_holder,
832 int all_tg_pt,
833 u8 type)
834 {
835 struct t10_pr_registration *pr_reg;
836
837 if (!i_port || !t_port || !sa_res_key) {
838 pr_err("Illegal parameters for APTPL registration\n");
839 return -EINVAL;
840 }
841
842 pr_reg = kmem_cache_zalloc(t10_pr_reg_cache, GFP_KERNEL);
843 if (!pr_reg) {
844 pr_err("Unable to allocate struct t10_pr_registration\n");
845 return -ENOMEM;
846 }
847
848 INIT_LIST_HEAD(&pr_reg->pr_reg_list);
849 INIT_LIST_HEAD(&pr_reg->pr_reg_abort_list);
850 INIT_LIST_HEAD(&pr_reg->pr_reg_aptpl_list);
851 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_list);
852 INIT_LIST_HEAD(&pr_reg->pr_reg_atp_mem_list);
853 atomic_set(&pr_reg->pr_res_holders, 0);
854 pr_reg->pr_reg_nacl = NULL;
855 pr_reg->pr_reg_deve = NULL;
856 pr_reg->pr_res_mapped_lun = mapped_lun;
857 pr_reg->pr_aptpl_target_lun = target_lun;
858 pr_reg->pr_res_key = sa_res_key;
859 pr_reg->pr_reg_all_tg_pt = all_tg_pt;
860 pr_reg->pr_reg_aptpl = 1;
861 pr_reg->pr_res_scope = 0; /* Always LUN_SCOPE */
862 pr_reg->pr_res_type = type;
863 /*
864 * If an ISID value had been saved in APTPL metadata for this
865 * SCSI Initiator Port, restore it now.
866 */
867 if (isid != NULL) {
868 pr_reg->pr_reg_bin_isid = get_unaligned_be64(isid);
869 snprintf(pr_reg->pr_reg_isid, PR_REG_ISID_LEN, "%s", isid);
870 pr_reg->isid_present_at_reg = 1;
871 }
872 /*
873 * Copy the i_port and t_port information from caller.
874 */
875 snprintf(pr_reg->pr_iport, PR_APTPL_MAX_IPORT_LEN, "%s", i_port);
876 snprintf(pr_reg->pr_tport, PR_APTPL_MAX_TPORT_LEN, "%s", t_port);
877 pr_reg->pr_reg_tpgt = tpgt;
878 /*
879 * Set pr_res_holder from caller, the pr_reg who is the reservation
880 * holder will get it's pointer set in core_scsi3_aptpl_reserve() once
881 * the Initiator Node LUN ACL from the fabric module is created for
882 * this registration.
883 */
884 pr_reg->pr_res_holder = res_holder;
885
886 list_add_tail(&pr_reg->pr_reg_aptpl_list, &pr_tmpl->aptpl_reg_list);
887 pr_debug("SPC-3 PR APTPL Successfully added registration%s from"
888 " metadata\n", (res_holder) ? "+reservation" : "");
889 return 0;
890 }
891
core_scsi3_aptpl_reserve(struct se_device * dev,struct se_portal_group * tpg,struct se_node_acl * node_acl,struct t10_pr_registration * pr_reg)892 static void core_scsi3_aptpl_reserve(
893 struct se_device *dev,
894 struct se_portal_group *tpg,
895 struct se_node_acl *node_acl,
896 struct t10_pr_registration *pr_reg)
897 {
898 char i_buf[PR_REG_ISID_ID_LEN] = { };
899
900 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
901
902 spin_lock(&dev->dev_reservation_lock);
903 dev->dev_pr_res_holder = pr_reg;
904 spin_unlock(&dev->dev_reservation_lock);
905
906 pr_debug("SPC-3 PR [%s] Service Action: APTPL RESERVE created"
907 " new reservation holder TYPE: %s ALL_TG_PT: %d\n",
908 tpg->se_tpg_tfo->fabric_name,
909 core_scsi3_pr_dump_type(pr_reg->pr_res_type),
910 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
911 pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
912 tpg->se_tpg_tfo->fabric_name, node_acl->initiatorname,
913 i_buf);
914 }
915
916 static void __core_scsi3_add_registration(struct se_device *, struct se_node_acl *,
917 struct t10_pr_registration *, enum register_type, int);
918
__core_scsi3_check_aptpl_registration(struct se_device * dev,struct se_portal_group * tpg,struct se_lun * lun,u64 target_lun,struct se_node_acl * nacl,u64 mapped_lun)919 static int __core_scsi3_check_aptpl_registration(
920 struct se_device *dev,
921 struct se_portal_group *tpg,
922 struct se_lun *lun,
923 u64 target_lun,
924 struct se_node_acl *nacl,
925 u64 mapped_lun)
926 {
927 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
928 struct t10_reservation *pr_tmpl = &dev->t10_pr;
929 unsigned char i_port[PR_APTPL_MAX_IPORT_LEN] = { };
930 unsigned char t_port[PR_APTPL_MAX_TPORT_LEN] = { };
931 u16 tpgt;
932
933 /*
934 * Copy Initiator Port information from struct se_node_acl
935 */
936 snprintf(i_port, PR_APTPL_MAX_IPORT_LEN, "%s", nacl->initiatorname);
937 snprintf(t_port, PR_APTPL_MAX_TPORT_LEN, "%s",
938 tpg->se_tpg_tfo->tpg_get_wwn(tpg));
939 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
940 /*
941 * Look for the matching registrations+reservation from those
942 * created from APTPL metadata. Note that multiple registrations
943 * may exist for fabrics that use ISIDs in their SCSI Initiator Port
944 * TransportIDs.
945 */
946 spin_lock(&pr_tmpl->aptpl_reg_lock);
947 list_for_each_entry_safe(pr_reg, pr_reg_tmp, &pr_tmpl->aptpl_reg_list,
948 pr_reg_aptpl_list) {
949
950 if (!strcmp(pr_reg->pr_iport, i_port) &&
951 (pr_reg->pr_res_mapped_lun == mapped_lun) &&
952 !(strcmp(pr_reg->pr_tport, t_port)) &&
953 (pr_reg->pr_reg_tpgt == tpgt) &&
954 (pr_reg->pr_aptpl_target_lun == target_lun)) {
955 /*
956 * Obtain the ->pr_reg_deve pointer + reference, that
957 * is released by __core_scsi3_add_registration() below.
958 */
959 rcu_read_lock();
960 pr_reg->pr_reg_deve = target_nacl_find_deve(nacl, mapped_lun);
961 if (!pr_reg->pr_reg_deve) {
962 pr_err("Unable to locate PR APTPL %s mapped_lun:"
963 " %llu\n", nacl->initiatorname, mapped_lun);
964 rcu_read_unlock();
965 continue;
966 }
967 kref_get(&pr_reg->pr_reg_deve->pr_kref);
968 rcu_read_unlock();
969
970 pr_reg->pr_reg_nacl = nacl;
971 pr_reg->tg_pt_sep_rtpi = lun->lun_tpg->tpg_rtpi;
972 list_del(&pr_reg->pr_reg_aptpl_list);
973 spin_unlock(&pr_tmpl->aptpl_reg_lock);
974 /*
975 * At this point all of the pointers in *pr_reg will
976 * be setup, so go ahead and add the registration.
977 */
978 __core_scsi3_add_registration(dev, nacl, pr_reg, 0, 0);
979 /*
980 * If this registration is the reservation holder,
981 * make that happen now..
982 */
983 if (pr_reg->pr_res_holder)
984 core_scsi3_aptpl_reserve(dev, tpg,
985 nacl, pr_reg);
986 /*
987 * Reenable pr_aptpl_active to accept new metadata
988 * updates once the SCSI device is active again..
989 */
990 spin_lock(&pr_tmpl->aptpl_reg_lock);
991 pr_tmpl->pr_aptpl_active = 1;
992 }
993 }
994 spin_unlock(&pr_tmpl->aptpl_reg_lock);
995
996 return 0;
997 }
998
core_scsi3_check_aptpl_registration(struct se_device * dev,struct se_portal_group * tpg,struct se_lun * lun,struct se_node_acl * nacl,u64 mapped_lun)999 int core_scsi3_check_aptpl_registration(
1000 struct se_device *dev,
1001 struct se_portal_group *tpg,
1002 struct se_lun *lun,
1003 struct se_node_acl *nacl,
1004 u64 mapped_lun)
1005 {
1006 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS)
1007 return 0;
1008
1009 return __core_scsi3_check_aptpl_registration(dev, tpg, lun,
1010 lun->unpacked_lun, nacl,
1011 mapped_lun);
1012 }
1013
__core_scsi3_dump_registration(const struct target_core_fabric_ops * tfo,struct se_device * dev,struct se_node_acl * nacl,struct t10_pr_registration * pr_reg,enum register_type register_type)1014 static void __core_scsi3_dump_registration(
1015 const struct target_core_fabric_ops *tfo,
1016 struct se_device *dev,
1017 struct se_node_acl *nacl,
1018 struct t10_pr_registration *pr_reg,
1019 enum register_type register_type)
1020 {
1021 struct se_portal_group *se_tpg = nacl->se_tpg;
1022 char i_buf[PR_REG_ISID_ID_LEN] = { };
1023
1024 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
1025
1026 pr_debug("SPC-3 PR [%s] Service Action: REGISTER%s Initiator"
1027 " Node: %s%s\n", tfo->fabric_name, (register_type == REGISTER_AND_MOVE) ?
1028 "_AND_MOVE" : (register_type == REGISTER_AND_IGNORE_EXISTING_KEY) ?
1029 "_AND_IGNORE_EXISTING_KEY" : "", nacl->initiatorname,
1030 i_buf);
1031 pr_debug("SPC-3 PR [%s] registration on Target Port: %s,0x%04x\n",
1032 tfo->fabric_name, tfo->tpg_get_wwn(se_tpg),
1033 tfo->tpg_get_tag(se_tpg));
1034 pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
1035 " Port(s)\n", tfo->fabric_name,
1036 (pr_reg->pr_reg_all_tg_pt) ? "ALL" : "SINGLE",
1037 dev->transport->name);
1038 pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
1039 " 0x%08x APTPL: %d\n", tfo->fabric_name,
1040 pr_reg->pr_res_key, pr_reg->pr_res_generation,
1041 pr_reg->pr_reg_aptpl);
1042 }
1043
__core_scsi3_add_registration(struct se_device * dev,struct se_node_acl * nacl,struct t10_pr_registration * pr_reg,enum register_type register_type,int register_move)1044 static void __core_scsi3_add_registration(
1045 struct se_device *dev,
1046 struct se_node_acl *nacl,
1047 struct t10_pr_registration *pr_reg,
1048 enum register_type register_type,
1049 int register_move)
1050 {
1051 const struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
1052 struct t10_pr_registration *pr_reg_tmp, *pr_reg_tmp_safe;
1053 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1054 struct se_dev_entry *deve;
1055
1056 /*
1057 * Increment PRgeneration counter for struct se_device upon a successful
1058 * REGISTER, see spc4r17 section 6.3.2 READ_KEYS service action
1059 *
1060 * Also, when register_move = 1 for PROUT REGISTER_AND_MOVE service
1061 * action, the struct se_device->dev_reservation_lock will already be held,
1062 * so we do not call core_scsi3_pr_generation() which grabs the lock
1063 * for the REGISTER.
1064 */
1065 pr_reg->pr_res_generation = (register_move) ?
1066 dev->t10_pr.pr_generation++ :
1067 core_scsi3_pr_generation(dev);
1068
1069 spin_lock(&pr_tmpl->registration_lock);
1070 list_add_tail(&pr_reg->pr_reg_list, &pr_tmpl->registration_list);
1071
1072 __core_scsi3_dump_registration(tfo, dev, nacl, pr_reg, register_type);
1073 spin_unlock(&pr_tmpl->registration_lock);
1074 /*
1075 * Skip extra processing for ALL_TG_PT=0 or REGISTER_AND_MOVE.
1076 */
1077 if (!pr_reg->pr_reg_all_tg_pt || register_move)
1078 goto out;
1079 /*
1080 * Walk pr_reg->pr_reg_atp_list and add registrations for ALL_TG_PT=1
1081 * allocated in __core_scsi3_alloc_registration()
1082 */
1083 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
1084 &pr_reg->pr_reg_atp_list, pr_reg_atp_mem_list) {
1085 struct se_node_acl *nacl_tmp = pr_reg_tmp->pr_reg_nacl;
1086
1087 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
1088
1089 pr_reg_tmp->pr_res_generation = core_scsi3_pr_generation(dev);
1090
1091 spin_lock(&pr_tmpl->registration_lock);
1092 list_add_tail(&pr_reg_tmp->pr_reg_list,
1093 &pr_tmpl->registration_list);
1094
1095 __core_scsi3_dump_registration(tfo, dev, nacl_tmp, pr_reg_tmp,
1096 register_type);
1097 spin_unlock(&pr_tmpl->registration_lock);
1098 /*
1099 * Drop configfs group dependency reference and deve->pr_kref
1100 * obtained from __core_scsi3_alloc_registration() code.
1101 */
1102 rcu_read_lock();
1103 deve = pr_reg_tmp->pr_reg_deve;
1104 if (deve) {
1105 set_bit(DEF_PR_REG_ACTIVE, &deve->deve_flags);
1106 core_scsi3_lunacl_undepend_item(deve);
1107 pr_reg_tmp->pr_reg_deve = NULL;
1108 }
1109 rcu_read_unlock();
1110 }
1111 out:
1112 /*
1113 * Drop deve->pr_kref obtained in __core_scsi3_do_alloc_registration()
1114 */
1115 rcu_read_lock();
1116 deve = pr_reg->pr_reg_deve;
1117 if (deve) {
1118 set_bit(DEF_PR_REG_ACTIVE, &deve->deve_flags);
1119 kref_put(&deve->pr_kref, target_pr_kref_release);
1120 pr_reg->pr_reg_deve = NULL;
1121 }
1122 rcu_read_unlock();
1123 }
1124
core_scsi3_alloc_registration(struct se_device * dev,struct se_node_acl * nacl,struct se_lun * lun,struct se_dev_entry * deve,u64 mapped_lun,unsigned char * isid,u64 sa_res_key,int all_tg_pt,int aptpl,enum register_type register_type,int register_move)1125 static int core_scsi3_alloc_registration(
1126 struct se_device *dev,
1127 struct se_node_acl *nacl,
1128 struct se_lun *lun,
1129 struct se_dev_entry *deve,
1130 u64 mapped_lun,
1131 unsigned char *isid,
1132 u64 sa_res_key,
1133 int all_tg_pt,
1134 int aptpl,
1135 enum register_type register_type,
1136 int register_move)
1137 {
1138 struct t10_pr_registration *pr_reg;
1139
1140 pr_reg = __core_scsi3_alloc_registration(dev, nacl, lun, deve, mapped_lun,
1141 isid, sa_res_key, all_tg_pt,
1142 aptpl);
1143 if (!pr_reg)
1144 return -EPERM;
1145
1146 __core_scsi3_add_registration(dev, nacl, pr_reg,
1147 register_type, register_move);
1148 return 0;
1149 }
1150
__core_scsi3_locate_pr_reg(struct se_device * dev,struct se_node_acl * nacl,unsigned char * isid)1151 static struct t10_pr_registration *__core_scsi3_locate_pr_reg(
1152 struct se_device *dev,
1153 struct se_node_acl *nacl,
1154 unsigned char *isid)
1155 {
1156 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1157 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
1158
1159 spin_lock(&pr_tmpl->registration_lock);
1160 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1161 &pr_tmpl->registration_list, pr_reg_list) {
1162 /*
1163 * First look for a matching struct se_node_acl
1164 */
1165 if (pr_reg->pr_reg_nacl != nacl)
1166 continue;
1167
1168 /*
1169 * If this registration does NOT contain a fabric provided
1170 * ISID, then we have found a match.
1171 */
1172 if (!pr_reg->isid_present_at_reg) {
1173 atomic_inc_mb(&pr_reg->pr_res_holders);
1174 spin_unlock(&pr_tmpl->registration_lock);
1175 return pr_reg;
1176 }
1177 /*
1178 * If the *pr_reg contains a fabric defined ISID for multi-value
1179 * SCSI Initiator Port TransportIDs, then we expect a valid
1180 * matching ISID to be provided by the local SCSI Initiator Port.
1181 */
1182 if (!isid)
1183 continue;
1184 if (strcmp(isid, pr_reg->pr_reg_isid))
1185 continue;
1186
1187 atomic_inc_mb(&pr_reg->pr_res_holders);
1188 spin_unlock(&pr_tmpl->registration_lock);
1189 return pr_reg;
1190 }
1191 spin_unlock(&pr_tmpl->registration_lock);
1192
1193 return NULL;
1194 }
1195
core_scsi3_locate_pr_reg(struct se_device * dev,struct se_node_acl * nacl,struct se_session * sess)1196 static struct t10_pr_registration *core_scsi3_locate_pr_reg(
1197 struct se_device *dev,
1198 struct se_node_acl *nacl,
1199 struct se_session *sess)
1200 {
1201 struct se_portal_group *tpg = nacl->se_tpg;
1202 unsigned char buf[PR_REG_ISID_LEN] = { };
1203 unsigned char *isid_ptr = NULL;
1204
1205 if (tpg->se_tpg_tfo->sess_get_initiator_sid != NULL) {
1206 tpg->se_tpg_tfo->sess_get_initiator_sid(sess, &buf[0],
1207 PR_REG_ISID_LEN);
1208 isid_ptr = &buf[0];
1209 }
1210
1211 return __core_scsi3_locate_pr_reg(dev, nacl, isid_ptr);
1212 }
1213
core_scsi3_put_pr_reg(struct t10_pr_registration * pr_reg)1214 static void core_scsi3_put_pr_reg(struct t10_pr_registration *pr_reg)
1215 {
1216 atomic_dec_mb(&pr_reg->pr_res_holders);
1217 }
1218
core_scsi3_check_implicit_release(struct se_device * dev,struct t10_pr_registration * pr_reg)1219 static int core_scsi3_check_implicit_release(
1220 struct se_device *dev,
1221 struct t10_pr_registration *pr_reg)
1222 {
1223 struct se_node_acl *nacl = pr_reg->pr_reg_nacl;
1224 struct t10_pr_registration *pr_res_holder;
1225 int ret = 0;
1226
1227 spin_lock(&dev->dev_reservation_lock);
1228 pr_res_holder = dev->dev_pr_res_holder;
1229 if (!pr_res_holder) {
1230 spin_unlock(&dev->dev_reservation_lock);
1231 return ret;
1232 }
1233 if (pr_res_holder == pr_reg) {
1234 /*
1235 * Perform an implicit RELEASE if the registration that
1236 * is being released is holding the reservation.
1237 *
1238 * From spc4r17, section 5.7.11.1:
1239 *
1240 * e) If the I_T nexus is the persistent reservation holder
1241 * and the persistent reservation is not an all registrants
1242 * type, then a PERSISTENT RESERVE OUT command with REGISTER
1243 * service action or REGISTER AND IGNORE EXISTING KEY
1244 * service action with the SERVICE ACTION RESERVATION KEY
1245 * field set to zero (see 5.7.11.3).
1246 */
1247 __core_scsi3_complete_pro_release(dev, nacl, pr_reg, 0, 1);
1248 ret = 1;
1249 /*
1250 * For 'All Registrants' reservation types, all existing
1251 * registrations are still processed as reservation holders
1252 * in core_scsi3_pr_seq_non_holder() after the initial
1253 * reservation holder is implicitly released here.
1254 */
1255 } else if (pr_reg->pr_reg_all_tg_pt &&
1256 (!strcmp(pr_res_holder->pr_reg_nacl->initiatorname,
1257 pr_reg->pr_reg_nacl->initiatorname)) &&
1258 (pr_res_holder->pr_res_key == pr_reg->pr_res_key)) {
1259 pr_err("SPC-3 PR: Unable to perform ALL_TG_PT=1"
1260 " UNREGISTER while existing reservation with matching"
1261 " key 0x%016Lx is present from another SCSI Initiator"
1262 " Port\n", pr_reg->pr_res_key);
1263 ret = -EPERM;
1264 }
1265 spin_unlock(&dev->dev_reservation_lock);
1266
1267 return ret;
1268 }
1269
__core_scsi3_free_registration(struct se_device * dev,struct t10_pr_registration * pr_reg,struct list_head * preempt_and_abort_list,int dec_holders)1270 static void __core_scsi3_free_registration(
1271 struct se_device *dev,
1272 struct t10_pr_registration *pr_reg,
1273 struct list_head *preempt_and_abort_list,
1274 int dec_holders)
1275 __releases(&pr_tmpl->registration_lock)
1276 __acquires(&pr_tmpl->registration_lock)
1277 {
1278 const struct target_core_fabric_ops *tfo =
1279 pr_reg->pr_reg_nacl->se_tpg->se_tpg_tfo;
1280 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1281 struct se_node_acl *nacl = pr_reg->pr_reg_nacl;
1282 struct se_dev_entry *deve;
1283 char i_buf[PR_REG_ISID_ID_LEN] = { };
1284
1285 lockdep_assert_held(&pr_tmpl->registration_lock);
1286
1287 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
1288
1289 if (!list_empty(&pr_reg->pr_reg_list))
1290 list_del(&pr_reg->pr_reg_list);
1291 /*
1292 * Caller accessing *pr_reg using core_scsi3_locate_pr_reg(),
1293 * so call core_scsi3_put_pr_reg() to decrement our reference.
1294 */
1295 if (dec_holders)
1296 core_scsi3_put_pr_reg(pr_reg);
1297
1298 spin_unlock(&pr_tmpl->registration_lock);
1299 /*
1300 * Wait until all reference from any other I_T nexuses for this
1301 * *pr_reg have been released. Because list_del() is called above,
1302 * the last core_scsi3_put_pr_reg(pr_reg) will release this reference
1303 * count back to zero, and we release *pr_reg.
1304 */
1305 while (atomic_read(&pr_reg->pr_res_holders) != 0) {
1306 pr_debug("SPC-3 PR [%s] waiting for pr_res_holders\n",
1307 tfo->fabric_name);
1308 cpu_relax();
1309 }
1310
1311 rcu_read_lock();
1312 deve = target_nacl_find_deve(nacl, pr_reg->pr_res_mapped_lun);
1313 if (deve)
1314 clear_bit(DEF_PR_REG_ACTIVE, &deve->deve_flags);
1315 rcu_read_unlock();
1316
1317 spin_lock(&pr_tmpl->registration_lock);
1318 pr_debug("SPC-3 PR [%s] Service Action: UNREGISTER Initiator"
1319 " Node: %s%s\n", tfo->fabric_name,
1320 pr_reg->pr_reg_nacl->initiatorname,
1321 i_buf);
1322 pr_debug("SPC-3 PR [%s] for %s TCM Subsystem %s Object Target"
1323 " Port(s)\n", tfo->fabric_name,
1324 (pr_reg->pr_reg_all_tg_pt) ? "ALL" : "SINGLE",
1325 dev->transport->name);
1326 pr_debug("SPC-3 PR [%s] SA Res Key: 0x%016Lx PRgeneration:"
1327 " 0x%08x\n", tfo->fabric_name, pr_reg->pr_res_key,
1328 pr_reg->pr_res_generation);
1329
1330 if (!preempt_and_abort_list) {
1331 pr_reg->pr_reg_deve = NULL;
1332 pr_reg->pr_reg_nacl = NULL;
1333 kmem_cache_free(t10_pr_reg_cache, pr_reg);
1334 return;
1335 }
1336 /*
1337 * For PREEMPT_AND_ABORT, the list of *pr_reg in preempt_and_abort_list
1338 * are released once the ABORT_TASK_SET has completed..
1339 */
1340 list_add_tail(&pr_reg->pr_reg_abort_list, preempt_and_abort_list);
1341 }
1342
core_scsi3_free_pr_reg_from_nacl(struct se_device * dev,struct se_node_acl * nacl)1343 void core_scsi3_free_pr_reg_from_nacl(
1344 struct se_device *dev,
1345 struct se_node_acl *nacl)
1346 {
1347 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1348 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_res_holder;
1349 bool free_reg = false;
1350 /*
1351 * If the passed se_node_acl matches the reservation holder,
1352 * release the reservation.
1353 */
1354 spin_lock(&dev->dev_reservation_lock);
1355 pr_res_holder = dev->dev_pr_res_holder;
1356 if ((pr_res_holder != NULL) &&
1357 (pr_res_holder->pr_reg_nacl == nacl)) {
1358 __core_scsi3_complete_pro_release(dev, nacl, pr_res_holder, 0, 1);
1359 free_reg = true;
1360 }
1361 spin_unlock(&dev->dev_reservation_lock);
1362 /*
1363 * Release any registration associated with the struct se_node_acl.
1364 */
1365 spin_lock(&pr_tmpl->registration_lock);
1366 if (pr_res_holder && free_reg)
1367 __core_scsi3_free_registration(dev, pr_res_holder, NULL, 0);
1368
1369 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1370 &pr_tmpl->registration_list, pr_reg_list) {
1371
1372 if (pr_reg->pr_reg_nacl != nacl)
1373 continue;
1374
1375 __core_scsi3_free_registration(dev, pr_reg, NULL, 0);
1376 }
1377 spin_unlock(&pr_tmpl->registration_lock);
1378 }
1379
core_scsi3_free_all_registrations(struct se_device * dev)1380 void core_scsi3_free_all_registrations(
1381 struct se_device *dev)
1382 {
1383 struct t10_reservation *pr_tmpl = &dev->t10_pr;
1384 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_res_holder;
1385
1386 spin_lock(&dev->dev_reservation_lock);
1387 pr_res_holder = dev->dev_pr_res_holder;
1388 if (pr_res_holder != NULL) {
1389 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
1390 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
1391 pr_res_holder, 0, 0);
1392 }
1393 spin_unlock(&dev->dev_reservation_lock);
1394
1395 spin_lock(&pr_tmpl->registration_lock);
1396 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
1397 &pr_tmpl->registration_list, pr_reg_list) {
1398
1399 __core_scsi3_free_registration(dev, pr_reg, NULL, 0);
1400 }
1401 spin_unlock(&pr_tmpl->registration_lock);
1402
1403 spin_lock(&pr_tmpl->aptpl_reg_lock);
1404 list_for_each_entry_safe(pr_reg, pr_reg_tmp, &pr_tmpl->aptpl_reg_list,
1405 pr_reg_aptpl_list) {
1406 list_del(&pr_reg->pr_reg_aptpl_list);
1407 kmem_cache_free(t10_pr_reg_cache, pr_reg);
1408 }
1409 spin_unlock(&pr_tmpl->aptpl_reg_lock);
1410 }
1411
core_scsi3_tpg_depend_item(struct se_portal_group * tpg)1412 static int core_scsi3_tpg_depend_item(struct se_portal_group *tpg)
1413 {
1414 return target_depend_item(&tpg->tpg_group.cg_item);
1415 }
1416
core_scsi3_tpg_undepend_item(struct se_portal_group * tpg)1417 static void core_scsi3_tpg_undepend_item(struct se_portal_group *tpg)
1418 {
1419 target_undepend_item(&tpg->tpg_group.cg_item);
1420 atomic_dec_mb(&tpg->tpg_pr_ref_count);
1421 }
1422
core_scsi3_nodeacl_depend_item(struct se_node_acl * nacl)1423 static int core_scsi3_nodeacl_depend_item(struct se_node_acl *nacl)
1424 {
1425 if (nacl->dynamic_node_acl)
1426 return 0;
1427 return target_depend_item(&nacl->acl_group.cg_item);
1428 }
1429
core_scsi3_nodeacl_undepend_item(struct se_node_acl * nacl)1430 static void core_scsi3_nodeacl_undepend_item(struct se_node_acl *nacl)
1431 {
1432 if (!nacl->dynamic_node_acl)
1433 target_undepend_item(&nacl->acl_group.cg_item);
1434 atomic_dec_mb(&nacl->acl_pr_ref_count);
1435 }
1436
core_scsi3_lunacl_depend_item(struct se_dev_entry * se_deve)1437 static int core_scsi3_lunacl_depend_item(struct se_dev_entry *se_deve)
1438 {
1439 /*
1440 * For nacl->dynamic_node_acl=1
1441 */
1442 if (!se_deve->se_lun_acl)
1443 return 0;
1444
1445 return target_depend_item(&se_deve->se_lun_acl->se_lun_group.cg_item);
1446 }
1447
core_scsi3_lunacl_undepend_item(struct se_dev_entry * se_deve)1448 static void core_scsi3_lunacl_undepend_item(struct se_dev_entry *se_deve)
1449 {
1450 /*
1451 * For nacl->dynamic_node_acl=1
1452 */
1453 if (!se_deve->se_lun_acl) {
1454 kref_put(&se_deve->pr_kref, target_pr_kref_release);
1455 return;
1456 }
1457
1458 target_undepend_item(&se_deve->se_lun_acl->se_lun_group.cg_item);
1459 kref_put(&se_deve->pr_kref, target_pr_kref_release);
1460 }
1461
1462 static sense_reason_t
core_scsi3_decode_spec_i_port(struct se_cmd * cmd,struct se_portal_group * tpg,unsigned char * l_isid,u64 sa_res_key,int all_tg_pt,int aptpl)1463 core_scsi3_decode_spec_i_port(
1464 struct se_cmd *cmd,
1465 struct se_portal_group *tpg,
1466 unsigned char *l_isid,
1467 u64 sa_res_key,
1468 int all_tg_pt,
1469 int aptpl)
1470 {
1471 struct se_device *dev = cmd->se_dev;
1472 struct se_portal_group *dest_tpg = NULL, *tmp_tpg;
1473 struct se_session *se_sess = cmd->se_sess;
1474 struct se_node_acl *dest_node_acl = NULL;
1475 struct se_dev_entry *dest_se_deve = NULL;
1476 struct t10_pr_registration *dest_pr_reg, *local_pr_reg, *pr_reg_e;
1477 struct t10_pr_registration *pr_reg_tmp, *pr_reg_tmp_safe;
1478 LIST_HEAD(tid_dest_list);
1479 struct pr_transport_id_holder *tidh_new, *tidh, *tidh_tmp;
1480 unsigned char *buf, *ptr, proto_ident;
1481 const unsigned char *i_str = NULL;
1482 char *iport_ptr = NULL, i_buf[PR_REG_ISID_ID_LEN];
1483 sense_reason_t ret;
1484 u32 tpdl, tid_len = 0;
1485 u32 dest_rtpi = 0;
1486
1487 /*
1488 * Allocate a struct pr_transport_id_holder and setup the
1489 * local_node_acl pointer and add to struct list_head tid_dest_list
1490 * for add registration processing in the loop of tid_dest_list below.
1491 */
1492 tidh_new = kzalloc(sizeof(struct pr_transport_id_holder), GFP_KERNEL);
1493 if (!tidh_new) {
1494 pr_err("Unable to allocate tidh_new\n");
1495 return TCM_INSUFFICIENT_REGISTRATION_RESOURCES;
1496 }
1497 INIT_LIST_HEAD(&tidh_new->dest_list);
1498 tidh_new->dest_tpg = tpg;
1499 tidh_new->dest_node_acl = se_sess->se_node_acl;
1500
1501 local_pr_reg = __core_scsi3_alloc_registration(cmd->se_dev,
1502 se_sess->se_node_acl, cmd->se_lun,
1503 NULL, cmd->orig_fe_lun, l_isid,
1504 sa_res_key, all_tg_pt, aptpl);
1505 if (!local_pr_reg) {
1506 kfree(tidh_new);
1507 return TCM_INSUFFICIENT_REGISTRATION_RESOURCES;
1508 }
1509
1510 if (core_scsi3_lunacl_depend_item(local_pr_reg->pr_reg_deve)) {
1511 kfree(tidh_new);
1512 kref_put(&local_pr_reg->pr_reg_deve->pr_kref,
1513 target_pr_kref_release);
1514 kmem_cache_free(t10_pr_reg_cache, local_pr_reg);
1515 return TCM_INSUFFICIENT_REGISTRATION_RESOURCES;
1516 }
1517
1518 tidh_new->dest_pr_reg = local_pr_reg;
1519 list_add_tail(&tidh_new->dest_list, &tid_dest_list);
1520
1521 if (cmd->data_length < 28) {
1522 pr_warn("SPC-PR: Received PR OUT parameter list"
1523 " length too small: %u\n", cmd->data_length);
1524 ret = TCM_INVALID_PARAMETER_LIST;
1525 goto out;
1526 }
1527
1528 buf = transport_kmap_data_sg(cmd);
1529 if (!buf) {
1530 ret = TCM_INSUFFICIENT_REGISTRATION_RESOURCES;
1531 goto out;
1532 }
1533
1534 /*
1535 * For a PERSISTENT RESERVE OUT specify initiator ports payload,
1536 * first extract TransportID Parameter Data Length, and make sure
1537 * the value matches up to the SCSI expected data transfer length.
1538 */
1539 tpdl = get_unaligned_be32(&buf[24]);
1540
1541 if ((tpdl + 28) != cmd->data_length) {
1542 pr_err("SPC-3 PR: Illegal tpdl: %u + 28 byte header"
1543 " does not equal CDB data_length: %u\n", tpdl,
1544 cmd->data_length);
1545 ret = TCM_INVALID_PARAMETER_LIST;
1546 goto out_unmap;
1547 }
1548 /*
1549 * Start processing the received transport IDs using the
1550 * receiving I_T Nexus portal's fabric dependent methods to
1551 * obtain the SCSI Initiator Port/Device Identifiers.
1552 */
1553 ptr = &buf[28];
1554
1555 while (tpdl > 0) {
1556 struct se_lun *dest_lun, *tmp_lun;
1557
1558 proto_ident = (ptr[0] & 0x0f);
1559 dest_tpg = NULL;
1560
1561 spin_lock(&dev->se_port_lock);
1562 list_for_each_entry(tmp_lun, &dev->dev_sep_list, lun_dev_link) {
1563 tmp_tpg = tmp_lun->lun_tpg;
1564
1565 /*
1566 * Look for the matching proto_ident provided by
1567 * the received TransportID
1568 */
1569 if (tmp_tpg->proto_id != proto_ident)
1570 continue;
1571 dest_rtpi = tmp_lun->lun_tpg->tpg_rtpi;
1572
1573 iport_ptr = NULL;
1574 i_str = target_parse_pr_out_transport_id(tmp_tpg,
1575 ptr, &tid_len, &iport_ptr);
1576 if (!i_str)
1577 continue;
1578 /*
1579 * Determine if this SCSI device server requires that
1580 * SCSI Intiatior TransportID w/ ISIDs is enforced
1581 * for fabric modules (iSCSI) requiring them.
1582 */
1583 if (tpg->se_tpg_tfo->sess_get_initiator_sid &&
1584 dev->dev_attrib.enforce_pr_isids &&
1585 !iport_ptr) {
1586 pr_warn("SPC-PR: enforce_pr_isids is set but a isid has not been sent in the SPEC_I_PT data for %s.",
1587 i_str);
1588 ret = TCM_INVALID_PARAMETER_LIST;
1589 spin_unlock(&dev->se_port_lock);
1590 goto out_unmap;
1591 }
1592
1593 atomic_inc_mb(&tmp_tpg->tpg_pr_ref_count);
1594 spin_unlock(&dev->se_port_lock);
1595
1596 if (core_scsi3_tpg_depend_item(tmp_tpg)) {
1597 pr_err(" core_scsi3_tpg_depend_item()"
1598 " for tmp_tpg\n");
1599 atomic_dec_mb(&tmp_tpg->tpg_pr_ref_count);
1600 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1601 goto out_unmap;
1602 }
1603 /*
1604 * Locate the destination initiator ACL to be registered
1605 * from the decoded fabric module specific TransportID
1606 * at *i_str.
1607 */
1608 mutex_lock(&tmp_tpg->acl_node_mutex);
1609 dest_node_acl = __core_tpg_get_initiator_node_acl(
1610 tmp_tpg, i_str);
1611 if (dest_node_acl)
1612 atomic_inc_mb(&dest_node_acl->acl_pr_ref_count);
1613 mutex_unlock(&tmp_tpg->acl_node_mutex);
1614
1615 if (!dest_node_acl) {
1616 core_scsi3_tpg_undepend_item(tmp_tpg);
1617 spin_lock(&dev->se_port_lock);
1618 continue;
1619 }
1620
1621 if (core_scsi3_nodeacl_depend_item(dest_node_acl)) {
1622 pr_err("configfs_depend_item() failed"
1623 " for dest_node_acl->acl_group\n");
1624 atomic_dec_mb(&dest_node_acl->acl_pr_ref_count);
1625 core_scsi3_tpg_undepend_item(tmp_tpg);
1626 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1627 goto out_unmap;
1628 }
1629
1630 dest_tpg = tmp_tpg;
1631 pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node: %s Port RTPI: %u\n",
1632 dest_tpg->se_tpg_tfo->fabric_name,
1633 dest_node_acl->initiatorname, dest_rtpi);
1634
1635 spin_lock(&dev->se_port_lock);
1636 break;
1637 }
1638 spin_unlock(&dev->se_port_lock);
1639
1640 if (!dest_tpg) {
1641 pr_err("SPC-3 PR SPEC_I_PT: Unable to locate"
1642 " dest_tpg\n");
1643 ret = TCM_INVALID_PARAMETER_LIST;
1644 goto out_unmap;
1645 }
1646
1647 pr_debug("SPC-3 PR SPEC_I_PT: Got %s data_length: %u tpdl: %u"
1648 " tid_len: %d for %s + %s\n",
1649 dest_tpg->se_tpg_tfo->fabric_name, cmd->data_length,
1650 tpdl, tid_len, i_str, iport_ptr);
1651
1652 if (tid_len > tpdl) {
1653 pr_err("SPC-3 PR SPEC_I_PT: Illegal tid_len:"
1654 " %u for Transport ID: %s\n", tid_len, ptr);
1655 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1656 core_scsi3_tpg_undepend_item(dest_tpg);
1657 ret = TCM_INVALID_PARAMETER_LIST;
1658 goto out_unmap;
1659 }
1660 /*
1661 * Locate the desintation struct se_dev_entry pointer for matching
1662 * RELATIVE TARGET PORT IDENTIFIER on the receiving I_T Nexus
1663 * Target Port.
1664 */
1665 dest_se_deve = core_get_se_deve_from_rtpi(dest_node_acl,
1666 dest_rtpi);
1667 if (!dest_se_deve) {
1668 pr_err("Unable to locate %s dest_se_deve from destination RTPI: %u\n",
1669 dest_tpg->se_tpg_tfo->fabric_name,
1670 dest_rtpi);
1671
1672 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1673 core_scsi3_tpg_undepend_item(dest_tpg);
1674 ret = TCM_INVALID_PARAMETER_LIST;
1675 goto out_unmap;
1676 }
1677
1678 if (core_scsi3_lunacl_depend_item(dest_se_deve)) {
1679 pr_err("core_scsi3_lunacl_depend_item()"
1680 " failed\n");
1681 kref_put(&dest_se_deve->pr_kref, target_pr_kref_release);
1682 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1683 core_scsi3_tpg_undepend_item(dest_tpg);
1684 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1685 goto out_unmap;
1686 }
1687
1688 pr_debug("SPC-3 PR SPEC_I_PT: Located %s Node: %s"
1689 " dest_se_deve mapped_lun: %llu\n",
1690 dest_tpg->se_tpg_tfo->fabric_name,
1691 dest_node_acl->initiatorname, dest_se_deve->mapped_lun);
1692
1693 /*
1694 * Skip any TransportIDs that already have a registration for
1695 * this target port.
1696 */
1697 pr_reg_e = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
1698 iport_ptr);
1699 if (pr_reg_e) {
1700 core_scsi3_put_pr_reg(pr_reg_e);
1701 core_scsi3_lunacl_undepend_item(dest_se_deve);
1702 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1703 core_scsi3_tpg_undepend_item(dest_tpg);
1704 ptr += tid_len;
1705 tpdl -= tid_len;
1706 tid_len = 0;
1707 continue;
1708 }
1709 /*
1710 * Allocate a struct pr_transport_id_holder and setup
1711 * the dest_node_acl and dest_se_deve pointers for the
1712 * loop below.
1713 */
1714 tidh_new = kzalloc(sizeof(struct pr_transport_id_holder),
1715 GFP_KERNEL);
1716 if (!tidh_new) {
1717 pr_err("Unable to allocate tidh_new\n");
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 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1722 goto out_unmap;
1723 }
1724 INIT_LIST_HEAD(&tidh_new->dest_list);
1725 tidh_new->dest_tpg = dest_tpg;
1726 tidh_new->dest_node_acl = dest_node_acl;
1727 tidh_new->dest_se_deve = dest_se_deve;
1728
1729 /*
1730 * Allocate, but do NOT add the registration for the
1731 * TransportID referenced SCSI Initiator port. This
1732 * done because of the following from spc4r17 in section
1733 * 6.14.3 wrt SPEC_I_PT:
1734 *
1735 * "If a registration fails for any initiator port (e.g., if th
1736 * logical unit does not have enough resources available to
1737 * hold the registration information), no registrations shall be
1738 * made, and the command shall be terminated with
1739 * CHECK CONDITION status."
1740 *
1741 * That means we call __core_scsi3_alloc_registration() here,
1742 * and then call __core_scsi3_add_registration() in the
1743 * 2nd loop which will never fail.
1744 */
1745 dest_lun = dest_se_deve->se_lun;
1746
1747 dest_pr_reg = __core_scsi3_alloc_registration(cmd->se_dev,
1748 dest_node_acl, dest_lun, dest_se_deve,
1749 dest_se_deve->mapped_lun, iport_ptr,
1750 sa_res_key, all_tg_pt, aptpl);
1751 if (!dest_pr_reg) {
1752 core_scsi3_lunacl_undepend_item(dest_se_deve);
1753 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1754 core_scsi3_tpg_undepend_item(dest_tpg);
1755 kfree(tidh_new);
1756 ret = TCM_INSUFFICIENT_REGISTRATION_RESOURCES;
1757 goto out_unmap;
1758 }
1759 tidh_new->dest_pr_reg = dest_pr_reg;
1760 list_add_tail(&tidh_new->dest_list, &tid_dest_list);
1761
1762 ptr += tid_len;
1763 tpdl -= tid_len;
1764 tid_len = 0;
1765
1766 }
1767
1768 transport_kunmap_data_sg(cmd);
1769
1770 /*
1771 * Go ahead and create a registrations from tid_dest_list for the
1772 * SPEC_I_PT provided TransportID for the *tidh referenced dest_node_acl
1773 * and dest_se_deve.
1774 *
1775 * The SA Reservation Key from the PROUT is set for the
1776 * registration, and ALL_TG_PT is also passed. ALL_TG_PT=1
1777 * means that the TransportID Initiator port will be
1778 * registered on all of the target ports in the SCSI target device
1779 * ALL_TG_PT=0 means the registration will only be for the
1780 * SCSI target port the PROUT REGISTER with SPEC_I_PT=1
1781 * was received.
1782 */
1783 list_for_each_entry_safe(tidh, tidh_tmp, &tid_dest_list, dest_list) {
1784 dest_tpg = tidh->dest_tpg;
1785 dest_node_acl = tidh->dest_node_acl;
1786 dest_se_deve = tidh->dest_se_deve;
1787 dest_pr_reg = tidh->dest_pr_reg;
1788
1789 list_del(&tidh->dest_list);
1790 kfree(tidh);
1791
1792 memset(i_buf, 0, PR_REG_ISID_ID_LEN);
1793 core_pr_dump_initiator_port(dest_pr_reg, i_buf, PR_REG_ISID_ID_LEN);
1794
1795 __core_scsi3_add_registration(cmd->se_dev, dest_node_acl,
1796 dest_pr_reg, 0, 0);
1797
1798 pr_debug("SPC-3 PR [%s] SPEC_I_PT: Successfully"
1799 " registered Transport ID for Node: %s%s Mapped LUN:"
1800 " %llu\n", dest_tpg->se_tpg_tfo->fabric_name,
1801 dest_node_acl->initiatorname, i_buf, (dest_se_deve) ?
1802 dest_se_deve->mapped_lun : 0);
1803
1804 if (dest_pr_reg == local_pr_reg)
1805 continue;
1806
1807 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1808 core_scsi3_tpg_undepend_item(dest_tpg);
1809 }
1810
1811 return 0;
1812 out_unmap:
1813 transport_kunmap_data_sg(cmd);
1814 out:
1815 /*
1816 * For the failure case, release everything from tid_dest_list
1817 * including *dest_pr_reg and the configfs dependances..
1818 */
1819 list_for_each_entry_safe(tidh, tidh_tmp, &tid_dest_list, dest_list) {
1820 bool is_local = false;
1821
1822 dest_tpg = tidh->dest_tpg;
1823 dest_node_acl = tidh->dest_node_acl;
1824 dest_se_deve = tidh->dest_se_deve;
1825 dest_pr_reg = tidh->dest_pr_reg;
1826
1827 if (dest_pr_reg == local_pr_reg)
1828 is_local = true;
1829
1830 list_del(&tidh->dest_list);
1831 kfree(tidh);
1832 /*
1833 * Release any extra ALL_TG_PT=1 registrations for
1834 * the SPEC_I_PT=1 case.
1835 */
1836 list_for_each_entry_safe(pr_reg_tmp, pr_reg_tmp_safe,
1837 &dest_pr_reg->pr_reg_atp_list,
1838 pr_reg_atp_mem_list) {
1839 list_del(&pr_reg_tmp->pr_reg_atp_mem_list);
1840 core_scsi3_lunacl_undepend_item(pr_reg_tmp->pr_reg_deve);
1841 kmem_cache_free(t10_pr_reg_cache, pr_reg_tmp);
1842 }
1843
1844 kmem_cache_free(t10_pr_reg_cache, dest_pr_reg);
1845
1846 if (dest_se_deve)
1847 core_scsi3_lunacl_undepend_item(dest_se_deve);
1848
1849 if (is_local)
1850 continue;
1851
1852 core_scsi3_nodeacl_undepend_item(dest_node_acl);
1853 core_scsi3_tpg_undepend_item(dest_tpg);
1854 }
1855 return ret;
1856 }
1857
core_scsi3_update_aptpl_buf(struct se_device * dev,unsigned char * buf,u32 pr_aptpl_buf_len)1858 static int core_scsi3_update_aptpl_buf(
1859 struct se_device *dev,
1860 unsigned char *buf,
1861 u32 pr_aptpl_buf_len)
1862 {
1863 struct se_portal_group *tpg;
1864 struct t10_pr_registration *pr_reg;
1865 unsigned char tmp[512], isid_buf[32];
1866 ssize_t len = 0;
1867 int reg_count = 0;
1868 int ret = 0;
1869
1870 spin_lock(&dev->dev_reservation_lock);
1871 spin_lock(&dev->t10_pr.registration_lock);
1872 /*
1873 * Walk the registration list..
1874 */
1875 list_for_each_entry(pr_reg, &dev->t10_pr.registration_list,
1876 pr_reg_list) {
1877
1878 tmp[0] = '\0';
1879 isid_buf[0] = '\0';
1880 tpg = pr_reg->pr_reg_nacl->se_tpg;
1881 /*
1882 * Write out any ISID value to APTPL metadata that was included
1883 * in the original registration.
1884 */
1885 if (pr_reg->isid_present_at_reg)
1886 snprintf(isid_buf, 32, "initiator_sid=%s\n",
1887 pr_reg->pr_reg_isid);
1888 /*
1889 * Include special metadata if the pr_reg matches the
1890 * reservation holder.
1891 */
1892 if (dev->dev_pr_res_holder == pr_reg) {
1893 snprintf(tmp, 512, "PR_REG_START: %d"
1894 "\ninitiator_fabric=%s\n"
1895 "initiator_node=%s\n%s"
1896 "sa_res_key=%llu\n"
1897 "res_holder=1\nres_type=%02x\n"
1898 "res_scope=%02x\nres_all_tg_pt=%d\n"
1899 "mapped_lun=%llu\n", reg_count,
1900 tpg->se_tpg_tfo->fabric_name,
1901 pr_reg->pr_reg_nacl->initiatorname, isid_buf,
1902 pr_reg->pr_res_key, pr_reg->pr_res_type,
1903 pr_reg->pr_res_scope, pr_reg->pr_reg_all_tg_pt,
1904 pr_reg->pr_res_mapped_lun);
1905 } else {
1906 snprintf(tmp, 512, "PR_REG_START: %d\n"
1907 "initiator_fabric=%s\ninitiator_node=%s\n%s"
1908 "sa_res_key=%llu\nres_holder=0\n"
1909 "res_all_tg_pt=%d\nmapped_lun=%llu\n",
1910 reg_count, tpg->se_tpg_tfo->fabric_name,
1911 pr_reg->pr_reg_nacl->initiatorname, isid_buf,
1912 pr_reg->pr_res_key, pr_reg->pr_reg_all_tg_pt,
1913 pr_reg->pr_res_mapped_lun);
1914 }
1915
1916 if ((len + strlen(tmp) >= pr_aptpl_buf_len)) {
1917 pr_err("Unable to update renaming APTPL metadata,"
1918 " reallocating larger buffer\n");
1919 ret = -EMSGSIZE;
1920 goto out;
1921 }
1922 len += sprintf(buf+len, "%s", tmp);
1923
1924 /*
1925 * Include information about the associated SCSI target port.
1926 */
1927 snprintf(tmp, 512, "target_fabric=%s\ntarget_node=%s\n"
1928 "tpgt=%hu\nport_rtpi=%hu\ntarget_lun=%llu\nPR_REG_END:"
1929 " %d\n", tpg->se_tpg_tfo->fabric_name,
1930 tpg->se_tpg_tfo->tpg_get_wwn(tpg),
1931 tpg->se_tpg_tfo->tpg_get_tag(tpg),
1932 pr_reg->tg_pt_sep_rtpi, pr_reg->pr_aptpl_target_lun,
1933 reg_count);
1934
1935 if ((len + strlen(tmp) >= pr_aptpl_buf_len)) {
1936 pr_err("Unable to update renaming APTPL metadata,"
1937 " reallocating larger buffer\n");
1938 ret = -EMSGSIZE;
1939 goto out;
1940 }
1941 len += sprintf(buf+len, "%s", tmp);
1942 reg_count++;
1943 }
1944
1945 if (!reg_count)
1946 len += sprintf(buf+len, "No Registrations or Reservations");
1947
1948 out:
1949 spin_unlock(&dev->t10_pr.registration_lock);
1950 spin_unlock(&dev->dev_reservation_lock);
1951
1952 return ret;
1953 }
1954
__core_scsi3_write_aptpl_to_file(struct se_device * dev,unsigned char * buf)1955 static int __core_scsi3_write_aptpl_to_file(
1956 struct se_device *dev,
1957 unsigned char *buf)
1958 {
1959 struct t10_wwn *wwn = &dev->t10_wwn;
1960 struct file *file;
1961 int flags = O_RDWR | O_CREAT | O_TRUNC;
1962 char *path;
1963 u32 pr_aptpl_buf_len;
1964 int ret;
1965 loff_t pos = 0;
1966
1967 path = kasprintf(GFP_KERNEL, "%s/pr/aptpl_%s", db_root,
1968 &wwn->unit_serial[0]);
1969 if (!path)
1970 return -ENOMEM;
1971
1972 file = filp_open(path, flags, 0600);
1973 if (IS_ERR(file)) {
1974 pr_err("filp_open(%s) for APTPL metadata"
1975 " failed\n", path);
1976 kfree(path);
1977 return PTR_ERR(file);
1978 }
1979
1980 pr_aptpl_buf_len = (strlen(buf) + 1); /* Add extra for NULL */
1981
1982 ret = kernel_write(file, buf, pr_aptpl_buf_len, &pos);
1983
1984 if (ret < 0)
1985 pr_debug("Error writing APTPL metadata file: %s\n", path);
1986 fput(file);
1987 kfree(path);
1988
1989 return (ret < 0) ? -EIO : 0;
1990 }
1991
1992 /*
1993 * Clear the APTPL metadata if APTPL has been disabled, otherwise
1994 * write out the updated metadata to struct file for this SCSI device.
1995 */
core_scsi3_update_and_write_aptpl(struct se_device * dev,bool aptpl)1996 static sense_reason_t core_scsi3_update_and_write_aptpl(struct se_device *dev, bool aptpl)
1997 {
1998 unsigned char *buf;
1999 int rc, len = PR_APTPL_BUF_LEN;
2000
2001 if (!aptpl) {
2002 char *null_buf = "No Registrations or Reservations\n";
2003
2004 rc = __core_scsi3_write_aptpl_to_file(dev, null_buf);
2005 dev->t10_pr.pr_aptpl_active = 0;
2006 pr_debug("SPC-3 PR: Set APTPL Bit Deactivated\n");
2007
2008 if (rc)
2009 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2010
2011 return 0;
2012 }
2013 retry:
2014 buf = vzalloc(len);
2015 if (!buf)
2016 return TCM_OUT_OF_RESOURCES;
2017
2018 rc = core_scsi3_update_aptpl_buf(dev, buf, len);
2019 if (rc < 0) {
2020 vfree(buf);
2021 len *= 2;
2022 goto retry;
2023 }
2024
2025 rc = __core_scsi3_write_aptpl_to_file(dev, buf);
2026 if (rc != 0) {
2027 pr_err("SPC-3 PR: Could not update APTPL\n");
2028 vfree(buf);
2029 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2030 }
2031 dev->t10_pr.pr_aptpl_active = 1;
2032 vfree(buf);
2033 pr_debug("SPC-3 PR: Set APTPL Bit Activated\n");
2034 return 0;
2035 }
2036
2037 static sense_reason_t
core_scsi3_emulate_pro_register(struct se_cmd * cmd,u64 res_key,u64 sa_res_key,bool aptpl,bool all_tg_pt,bool spec_i_pt,enum register_type register_type)2038 core_scsi3_emulate_pro_register(struct se_cmd *cmd, u64 res_key, u64 sa_res_key,
2039 bool aptpl, bool all_tg_pt, bool spec_i_pt, enum register_type register_type)
2040 {
2041 struct se_session *se_sess = cmd->se_sess;
2042 struct se_device *dev = cmd->se_dev;
2043 struct se_lun *se_lun = cmd->se_lun;
2044 struct se_portal_group *se_tpg;
2045 struct t10_pr_registration *pr_reg, *pr_reg_p, *pr_reg_tmp;
2046 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2047 unsigned char isid_buf[PR_REG_ISID_LEN] = { };
2048 unsigned char *isid_ptr = NULL;
2049 sense_reason_t ret = TCM_NO_SENSE;
2050 int pr_holder = 0, type;
2051
2052 if (!se_sess || !se_lun) {
2053 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2054 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2055 }
2056 se_tpg = se_sess->se_tpg;
2057
2058 if (se_tpg->se_tpg_tfo->sess_get_initiator_sid) {
2059 se_tpg->se_tpg_tfo->sess_get_initiator_sid(se_sess, &isid_buf[0],
2060 PR_REG_ISID_LEN);
2061 isid_ptr = &isid_buf[0];
2062 }
2063 /*
2064 * Follow logic from spc4r17 Section 5.7.7, Register Behaviors Table 47
2065 */
2066 pr_reg = core_scsi3_locate_pr_reg(dev, se_sess->se_node_acl, se_sess);
2067 if (!pr_reg) {
2068 if (res_key) {
2069 pr_warn("SPC-3 PR: Reservation Key non-zero"
2070 " for SA REGISTER, returning CONFLICT\n");
2071 return TCM_RESERVATION_CONFLICT;
2072 }
2073 /*
2074 * Do nothing but return GOOD status.
2075 */
2076 if (!sa_res_key)
2077 return 0;
2078
2079 if (!spec_i_pt) {
2080 /*
2081 * Perform the Service Action REGISTER on the Initiator
2082 * Port Endpoint that the PRO was received from on the
2083 * Logical Unit of the SCSI device server.
2084 */
2085 if (core_scsi3_alloc_registration(cmd->se_dev,
2086 se_sess->se_node_acl, cmd->se_lun,
2087 NULL, cmd->orig_fe_lun, isid_ptr,
2088 sa_res_key, all_tg_pt, aptpl,
2089 register_type, 0)) {
2090 pr_err("Unable to allocate"
2091 " struct t10_pr_registration\n");
2092 return TCM_INSUFFICIENT_REGISTRATION_RESOURCES;
2093 }
2094 } else {
2095 /*
2096 * Register both the Initiator port that received
2097 * PROUT SA REGISTER + SPEC_I_PT=1 and extract SCSI
2098 * TransportID from Parameter list and loop through
2099 * fabric dependent parameter list while calling
2100 * logic from of core_scsi3_alloc_registration() for
2101 * each TransportID provided SCSI Initiator Port/Device
2102 */
2103 ret = core_scsi3_decode_spec_i_port(cmd, se_tpg,
2104 isid_ptr, sa_res_key, all_tg_pt, aptpl);
2105 if (ret != 0)
2106 return ret;
2107 }
2108 return core_scsi3_update_and_write_aptpl(dev, aptpl);
2109 }
2110
2111 /* ok, existing registration */
2112
2113 if ((register_type == REGISTER) && (res_key != pr_reg->pr_res_key)) {
2114 pr_err("SPC-3 PR REGISTER: Received"
2115 " res_key: 0x%016Lx does not match"
2116 " existing SA REGISTER res_key:"
2117 " 0x%016Lx\n", res_key,
2118 pr_reg->pr_res_key);
2119 ret = TCM_RESERVATION_CONFLICT;
2120 goto out;
2121 }
2122
2123 if (spec_i_pt) {
2124 pr_err("SPC-3 PR REGISTER: SPEC_I_PT"
2125 " set on a registered nexus\n");
2126 ret = TCM_INVALID_PARAMETER_LIST;
2127 goto out;
2128 }
2129
2130 /*
2131 * An existing ALL_TG_PT=1 registration being released
2132 * must also set ALL_TG_PT=1 in the incoming PROUT.
2133 */
2134 if (pr_reg->pr_reg_all_tg_pt && !all_tg_pt) {
2135 pr_err("SPC-3 PR REGISTER: ALL_TG_PT=1"
2136 " registration exists, but ALL_TG_PT=1 bit not"
2137 " present in received PROUT\n");
2138 ret = TCM_INVALID_CDB_FIELD;
2139 goto out;
2140 }
2141
2142 /*
2143 * sa_res_key=1 Change Reservation Key for registered I_T Nexus.
2144 */
2145 if (sa_res_key) {
2146 /*
2147 * Increment PRgeneration counter for struct se_device"
2148 * upon a successful REGISTER, see spc4r17 section 6.3.2
2149 * READ_KEYS service action.
2150 */
2151 pr_reg->pr_res_generation = core_scsi3_pr_generation(cmd->se_dev);
2152 pr_reg->pr_res_key = sa_res_key;
2153 pr_debug("SPC-3 PR [%s] REGISTER%s: Changed Reservation"
2154 " Key for %s to: 0x%016Lx PRgeneration:"
2155 " 0x%08x\n", cmd->se_tfo->fabric_name,
2156 (register_type == REGISTER_AND_IGNORE_EXISTING_KEY) ? "_AND_IGNORE_EXISTING_KEY" : "",
2157 pr_reg->pr_reg_nacl->initiatorname,
2158 pr_reg->pr_res_key, pr_reg->pr_res_generation);
2159
2160 } else {
2161 /*
2162 * sa_res_key=0 Unregister Reservation Key for registered I_T Nexus.
2163 */
2164 type = pr_reg->pr_res_type;
2165 pr_holder = core_scsi3_check_implicit_release(cmd->se_dev,
2166 pr_reg);
2167 if (pr_holder < 0) {
2168 ret = TCM_RESERVATION_CONFLICT;
2169 goto out;
2170 }
2171
2172 spin_lock(&pr_tmpl->registration_lock);
2173 /*
2174 * Release all ALL_TG_PT=1 for the matching SCSI Initiator Port
2175 * and matching pr_res_key.
2176 */
2177 if (pr_reg->pr_reg_all_tg_pt) {
2178 list_for_each_entry_safe(pr_reg_p, pr_reg_tmp,
2179 &pr_tmpl->registration_list,
2180 pr_reg_list) {
2181
2182 if (!pr_reg_p->pr_reg_all_tg_pt)
2183 continue;
2184 if (pr_reg_p->pr_res_key != res_key)
2185 continue;
2186 if (pr_reg == pr_reg_p)
2187 continue;
2188 if (strcmp(pr_reg->pr_reg_nacl->initiatorname,
2189 pr_reg_p->pr_reg_nacl->initiatorname))
2190 continue;
2191
2192 __core_scsi3_free_registration(dev,
2193 pr_reg_p, NULL, 0);
2194 }
2195 }
2196
2197 /*
2198 * Release the calling I_T Nexus registration now..
2199 */
2200 __core_scsi3_free_registration(cmd->se_dev, pr_reg, NULL, 1);
2201 pr_reg = NULL;
2202
2203 /*
2204 * From spc4r17, section 5.7.11.3 Unregistering
2205 *
2206 * If the persistent reservation is a registrants only
2207 * type, the device server shall establish a unit
2208 * attention condition for the initiator port associated
2209 * with every registered I_T nexus except for the I_T
2210 * nexus on which the PERSISTENT RESERVE OUT command was
2211 * received, with the additional sense code set to
2212 * RESERVATIONS RELEASED.
2213 */
2214 if (pr_holder &&
2215 (type == PR_TYPE_WRITE_EXCLUSIVE_REGONLY ||
2216 type == PR_TYPE_EXCLUSIVE_ACCESS_REGONLY)) {
2217 list_for_each_entry(pr_reg_p,
2218 &pr_tmpl->registration_list,
2219 pr_reg_list) {
2220
2221 target_ua_allocate_lun(
2222 pr_reg_p->pr_reg_nacl,
2223 pr_reg_p->pr_res_mapped_lun,
2224 0x2A,
2225 ASCQ_2AH_RESERVATIONS_RELEASED);
2226 }
2227 }
2228
2229 spin_unlock(&pr_tmpl->registration_lock);
2230 }
2231
2232 ret = core_scsi3_update_and_write_aptpl(dev, aptpl);
2233
2234 out:
2235 if (pr_reg)
2236 core_scsi3_put_pr_reg(pr_reg);
2237 return ret;
2238 }
2239
core_scsi3_pr_dump_type(int type)2240 unsigned char *core_scsi3_pr_dump_type(int type)
2241 {
2242 switch (type) {
2243 case PR_TYPE_WRITE_EXCLUSIVE:
2244 return "Write Exclusive Access";
2245 case PR_TYPE_EXCLUSIVE_ACCESS:
2246 return "Exclusive Access";
2247 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
2248 return "Write Exclusive Access, Registrants Only";
2249 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
2250 return "Exclusive Access, Registrants Only";
2251 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
2252 return "Write Exclusive Access, All Registrants";
2253 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
2254 return "Exclusive Access, All Registrants";
2255 default:
2256 break;
2257 }
2258
2259 return "Unknown SPC-3 PR Type";
2260 }
2261
2262 static sense_reason_t
core_scsi3_pro_reserve(struct se_cmd * cmd,int type,int scope,u64 res_key)2263 core_scsi3_pro_reserve(struct se_cmd *cmd, int type, int scope, u64 res_key)
2264 {
2265 struct se_device *dev = cmd->se_dev;
2266 struct se_session *se_sess = cmd->se_sess;
2267 struct se_lun *se_lun = cmd->se_lun;
2268 struct t10_pr_registration *pr_reg, *pr_res_holder;
2269 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2270 char i_buf[PR_REG_ISID_ID_LEN] = { };
2271 sense_reason_t ret;
2272
2273 if (!se_sess || !se_lun) {
2274 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2275 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2276 }
2277 /*
2278 * Locate the existing *pr_reg via struct se_node_acl pointers
2279 */
2280 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
2281 se_sess);
2282 if (!pr_reg) {
2283 pr_err("SPC-3 PR: Unable to locate"
2284 " PR_REGISTERED *pr_reg for RESERVE\n");
2285 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2286 }
2287 /*
2288 * From spc4r17 Section 5.7.9: Reserving:
2289 *
2290 * An application client creates a persistent reservation by issuing
2291 * a PERSISTENT RESERVE OUT command with RESERVE service action through
2292 * a registered I_T nexus with the following parameters:
2293 * a) RESERVATION KEY set to the value of the reservation key that is
2294 * registered with the logical unit for the I_T nexus; and
2295 */
2296 if (res_key != pr_reg->pr_res_key) {
2297 pr_err("SPC-3 PR RESERVE: Received res_key: 0x%016Lx"
2298 " does not match existing SA REGISTER res_key:"
2299 " 0x%016Lx\n", res_key, pr_reg->pr_res_key);
2300 ret = TCM_RESERVATION_CONFLICT;
2301 goto out_put_pr_reg;
2302 }
2303 /*
2304 * From spc4r17 Section 5.7.9: Reserving:
2305 *
2306 * From above:
2307 * b) TYPE field and SCOPE field set to the persistent reservation
2308 * being created.
2309 *
2310 * Only one persistent reservation is allowed at a time per logical unit
2311 * and that persistent reservation has a scope of LU_SCOPE.
2312 */
2313 if (scope != PR_SCOPE_LU_SCOPE) {
2314 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope);
2315 ret = TCM_INVALID_PARAMETER_LIST;
2316 goto out_put_pr_reg;
2317 }
2318 /*
2319 * See if we have an existing PR reservation holder pointer at
2320 * struct se_device->dev_pr_res_holder in the form struct t10_pr_registration
2321 * *pr_res_holder.
2322 */
2323 spin_lock(&dev->dev_reservation_lock);
2324 pr_res_holder = dev->dev_pr_res_holder;
2325 if (pr_res_holder) {
2326 /*
2327 * From spc4r17 Section 5.7.9: Reserving:
2328 *
2329 * If the device server receives a PERSISTENT RESERVE OUT
2330 * command from an I_T nexus other than a persistent reservation
2331 * holder (see 5.7.10) that attempts to create a persistent
2332 * reservation when a persistent reservation already exists for
2333 * the logical unit, then the command shall be completed with
2334 * RESERVATION CONFLICT status.
2335 */
2336 if (!is_reservation_holder(pr_res_holder, pr_reg)) {
2337 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2338 pr_err("SPC-3 PR: Attempted RESERVE from"
2339 " [%s]: %s while reservation already held by"
2340 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2341 cmd->se_tfo->fabric_name,
2342 se_sess->se_node_acl->initiatorname,
2343 pr_res_nacl->se_tpg->se_tpg_tfo->fabric_name,
2344 pr_res_holder->pr_reg_nacl->initiatorname);
2345
2346 spin_unlock(&dev->dev_reservation_lock);
2347 ret = TCM_RESERVATION_CONFLICT;
2348 goto out_put_pr_reg;
2349 }
2350 /*
2351 * From spc4r17 Section 5.7.9: Reserving:
2352 *
2353 * If a persistent reservation holder attempts to modify the
2354 * type or scope of an existing persistent reservation, the
2355 * command shall be completed with RESERVATION CONFLICT status.
2356 */
2357 if ((pr_res_holder->pr_res_type != type) ||
2358 (pr_res_holder->pr_res_scope != scope)) {
2359 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2360 pr_err("SPC-3 PR: Attempted RESERVE from"
2361 " [%s]: %s trying to change TYPE and/or SCOPE,"
2362 " while reservation already held by [%s]: %s,"
2363 " returning RESERVATION_CONFLICT\n",
2364 cmd->se_tfo->fabric_name,
2365 se_sess->se_node_acl->initiatorname,
2366 pr_res_nacl->se_tpg->se_tpg_tfo->fabric_name,
2367 pr_res_holder->pr_reg_nacl->initiatorname);
2368
2369 spin_unlock(&dev->dev_reservation_lock);
2370 ret = TCM_RESERVATION_CONFLICT;
2371 goto out_put_pr_reg;
2372 }
2373 /*
2374 * From spc4r17 Section 5.7.9: Reserving:
2375 *
2376 * If the device server receives a PERSISTENT RESERVE OUT
2377 * command with RESERVE service action where the TYPE field and
2378 * the SCOPE field contain the same values as the existing type
2379 * and scope from a persistent reservation holder, it shall not
2380 * make any change to the existing persistent reservation and
2381 * shall completethe command with GOOD status.
2382 */
2383 spin_unlock(&dev->dev_reservation_lock);
2384 ret = 0;
2385 goto out_put_pr_reg;
2386 }
2387 /*
2388 * Otherwise, our *pr_reg becomes the PR reservation holder for said
2389 * TYPE/SCOPE. Also set the received scope and type in *pr_reg.
2390 */
2391 pr_reg->pr_res_scope = scope;
2392 pr_reg->pr_res_type = type;
2393 pr_reg->pr_res_holder = 1;
2394 dev->dev_pr_res_holder = pr_reg;
2395 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2396
2397 pr_debug("SPC-3 PR [%s] Service Action: RESERVE created new"
2398 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2399 cmd->se_tfo->fabric_name, core_scsi3_pr_dump_type(type),
2400 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2401 pr_debug("SPC-3 PR [%s] RESERVE Node: %s%s\n",
2402 cmd->se_tfo->fabric_name,
2403 se_sess->se_node_acl->initiatorname,
2404 i_buf);
2405 spin_unlock(&dev->dev_reservation_lock);
2406
2407 if (pr_tmpl->pr_aptpl_active)
2408 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
2409
2410 ret = 0;
2411 out_put_pr_reg:
2412 core_scsi3_put_pr_reg(pr_reg);
2413 return ret;
2414 }
2415
2416 static sense_reason_t
core_scsi3_emulate_pro_reserve(struct se_cmd * cmd,int type,int scope,u64 res_key)2417 core_scsi3_emulate_pro_reserve(struct se_cmd *cmd, int type, int scope,
2418 u64 res_key)
2419 {
2420 switch (type) {
2421 case PR_TYPE_WRITE_EXCLUSIVE:
2422 case PR_TYPE_EXCLUSIVE_ACCESS:
2423 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
2424 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
2425 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
2426 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
2427 return core_scsi3_pro_reserve(cmd, type, scope, res_key);
2428 default:
2429 pr_err("SPC-3 PR: Unknown Service Action RESERVE Type:"
2430 " 0x%02x\n", type);
2431 return TCM_INVALID_CDB_FIELD;
2432 }
2433 }
2434
__core_scsi3_complete_pro_release(struct se_device * dev,struct se_node_acl * se_nacl,struct t10_pr_registration * pr_reg,int explicit,int unreg)2435 static void __core_scsi3_complete_pro_release(
2436 struct se_device *dev,
2437 struct se_node_acl *se_nacl,
2438 struct t10_pr_registration *pr_reg,
2439 int explicit,
2440 int unreg)
2441 {
2442 const struct target_core_fabric_ops *tfo = se_nacl->se_tpg->se_tpg_tfo;
2443 char i_buf[PR_REG_ISID_ID_LEN] = { };
2444 int pr_res_type = 0, pr_res_scope = 0;
2445
2446 lockdep_assert_held(&dev->dev_reservation_lock);
2447
2448 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2449 /*
2450 * Go ahead and release the current PR reservation holder.
2451 * If an All Registrants reservation is currently active and
2452 * a unregister operation is requested, replace the current
2453 * dev_pr_res_holder with another active registration.
2454 */
2455 if (dev->dev_pr_res_holder) {
2456 pr_res_type = dev->dev_pr_res_holder->pr_res_type;
2457 pr_res_scope = dev->dev_pr_res_holder->pr_res_scope;
2458 dev->dev_pr_res_holder->pr_res_type = 0;
2459 dev->dev_pr_res_holder->pr_res_scope = 0;
2460 dev->dev_pr_res_holder->pr_res_holder = 0;
2461 dev->dev_pr_res_holder = NULL;
2462 }
2463 if (!unreg)
2464 goto out;
2465
2466 spin_lock(&dev->t10_pr.registration_lock);
2467 list_del_init(&pr_reg->pr_reg_list);
2468 /*
2469 * If the I_T nexus is a reservation holder, the persistent reservation
2470 * is of an all registrants type, and the I_T nexus is the last remaining
2471 * registered I_T nexus, then the device server shall also release the
2472 * persistent reservation.
2473 */
2474 if (!list_empty(&dev->t10_pr.registration_list) &&
2475 ((pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2476 (pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))) {
2477 dev->dev_pr_res_holder =
2478 list_entry(dev->t10_pr.registration_list.next,
2479 struct t10_pr_registration, pr_reg_list);
2480 dev->dev_pr_res_holder->pr_res_type = pr_res_type;
2481 dev->dev_pr_res_holder->pr_res_scope = pr_res_scope;
2482 dev->dev_pr_res_holder->pr_res_holder = 1;
2483 }
2484 spin_unlock(&dev->t10_pr.registration_lock);
2485 out:
2486 if (!dev->dev_pr_res_holder) {
2487 pr_debug("SPC-3 PR [%s] Service Action: %s RELEASE cleared"
2488 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2489 tfo->fabric_name, (explicit) ? "explicit" :
2490 "implicit", core_scsi3_pr_dump_type(pr_res_type),
2491 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2492 }
2493 pr_debug("SPC-3 PR [%s] RELEASE Node: %s%s\n",
2494 tfo->fabric_name, se_nacl->initiatorname,
2495 i_buf);
2496 /*
2497 * Clear TYPE and SCOPE for the next PROUT Service Action: RESERVE
2498 */
2499 pr_reg->pr_res_holder = pr_reg->pr_res_type = pr_reg->pr_res_scope = 0;
2500 }
2501
2502 static sense_reason_t
core_scsi3_emulate_pro_release(struct se_cmd * cmd,int type,int scope,u64 res_key)2503 core_scsi3_emulate_pro_release(struct se_cmd *cmd, int type, int scope,
2504 u64 res_key)
2505 {
2506 struct se_device *dev = cmd->se_dev;
2507 struct se_session *se_sess = cmd->se_sess;
2508 struct se_lun *se_lun = cmd->se_lun;
2509 struct t10_pr_registration *pr_reg, *pr_reg_p, *pr_res_holder;
2510 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2511 sense_reason_t ret = 0;
2512
2513 if (!se_sess || !se_lun) {
2514 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
2515 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2516 }
2517 /*
2518 * Locate the existing *pr_reg via struct se_node_acl pointers
2519 */
2520 pr_reg = core_scsi3_locate_pr_reg(dev, se_sess->se_node_acl, se_sess);
2521 if (!pr_reg) {
2522 pr_err("SPC-3 PR: Unable to locate"
2523 " PR_REGISTERED *pr_reg for RELEASE\n");
2524 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2525 }
2526 /*
2527 * From spc4r17 Section 5.7.11.2 Releasing:
2528 *
2529 * If there is no persistent reservation or in response to a persistent
2530 * reservation release request from a registered I_T nexus that is not a
2531 * persistent reservation holder (see 5.7.10), the device server shall
2532 * do the following:
2533 *
2534 * a) Not release the persistent reservation, if any;
2535 * b) Not remove any registrations; and
2536 * c) Complete the command with GOOD status.
2537 */
2538 spin_lock(&dev->dev_reservation_lock);
2539 pr_res_holder = dev->dev_pr_res_holder;
2540 if (!pr_res_holder) {
2541 /*
2542 * No persistent reservation, return GOOD status.
2543 */
2544 spin_unlock(&dev->dev_reservation_lock);
2545 goto out_put_pr_reg;
2546 }
2547
2548 if (!is_reservation_holder(pr_res_holder, pr_reg)) {
2549 /*
2550 * Release request from a registered I_T nexus that is not a
2551 * persistent reservation holder. return GOOD status.
2552 */
2553 spin_unlock(&dev->dev_reservation_lock);
2554 goto out_put_pr_reg;
2555 }
2556
2557 /*
2558 * From spc4r17 Section 5.7.11.2 Releasing:
2559 *
2560 * Only the persistent reservation holder (see 5.7.10) is allowed to
2561 * release a persistent reservation.
2562 *
2563 * An application client releases the persistent reservation by issuing
2564 * a PERSISTENT RESERVE OUT command with RELEASE service action through
2565 * an I_T nexus that is a persistent reservation holder with the
2566 * following parameters:
2567 *
2568 * a) RESERVATION KEY field set to the value of the reservation key
2569 * that is registered with the logical unit for the I_T nexus;
2570 */
2571 if (res_key != pr_reg->pr_res_key) {
2572 pr_err("SPC-3 PR RELEASE: Received res_key: 0x%016Lx"
2573 " does not match existing SA REGISTER res_key:"
2574 " 0x%016Lx\n", res_key, pr_reg->pr_res_key);
2575 spin_unlock(&dev->dev_reservation_lock);
2576 ret = TCM_RESERVATION_CONFLICT;
2577 goto out_put_pr_reg;
2578 }
2579 /*
2580 * From spc4r17 Section 5.7.11.2 Releasing and above:
2581 *
2582 * b) TYPE field and SCOPE field set to match the persistent
2583 * reservation being released.
2584 */
2585 if ((pr_res_holder->pr_res_type != type) ||
2586 (pr_res_holder->pr_res_scope != scope)) {
2587 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2588 pr_err("SPC-3 PR RELEASE: Attempted to release"
2589 " reservation from [%s]: %s with different TYPE "
2590 "and/or SCOPE while reservation already held by"
2591 " [%s]: %s, returning RESERVATION_CONFLICT\n",
2592 cmd->se_tfo->fabric_name,
2593 se_sess->se_node_acl->initiatorname,
2594 pr_res_nacl->se_tpg->se_tpg_tfo->fabric_name,
2595 pr_res_holder->pr_reg_nacl->initiatorname);
2596
2597 spin_unlock(&dev->dev_reservation_lock);
2598 ret = TCM_RESERVATION_CONFLICT;
2599 goto out_put_pr_reg;
2600 }
2601 /*
2602 * In response to a persistent reservation release request from the
2603 * persistent reservation holder the device server shall perform a
2604 * release by doing the following as an uninterrupted series of actions:
2605 * a) Release the persistent reservation;
2606 * b) Not remove any registration(s);
2607 * c) If the released persistent reservation is a registrants only type
2608 * or all registrants type persistent reservation,
2609 * the device server shall establish a unit attention condition for
2610 * the initiator port associated with every regis-
2611 * tered I_T nexus other than I_T nexus on which the PERSISTENT
2612 * RESERVE OUT command with RELEASE service action was received,
2613 * with the additional sense code set to RESERVATIONS RELEASED; and
2614 * d) If the persistent reservation is of any other type, the device
2615 * server shall not establish a unit attention condition.
2616 */
2617 __core_scsi3_complete_pro_release(dev, se_sess->se_node_acl,
2618 pr_reg, 1, 0);
2619
2620 spin_unlock(&dev->dev_reservation_lock);
2621
2622 if ((type != PR_TYPE_WRITE_EXCLUSIVE_REGONLY) &&
2623 (type != PR_TYPE_EXCLUSIVE_ACCESS_REGONLY) &&
2624 (type != PR_TYPE_WRITE_EXCLUSIVE_ALLREG) &&
2625 (type != PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
2626 /*
2627 * If no UNIT ATTENTION conditions will be established for
2628 * PR_TYPE_WRITE_EXCLUSIVE or PR_TYPE_EXCLUSIVE_ACCESS
2629 * go ahead and check for APTPL=1 update+write below
2630 */
2631 goto write_aptpl;
2632 }
2633
2634 spin_lock(&pr_tmpl->registration_lock);
2635 list_for_each_entry(pr_reg_p, &pr_tmpl->registration_list,
2636 pr_reg_list) {
2637 /*
2638 * Do not establish a UNIT ATTENTION condition
2639 * for the calling I_T Nexus
2640 */
2641 if (pr_reg_p == pr_reg)
2642 continue;
2643
2644 target_ua_allocate_lun(pr_reg_p->pr_reg_nacl,
2645 pr_reg_p->pr_res_mapped_lun,
2646 0x2A, ASCQ_2AH_RESERVATIONS_RELEASED);
2647 }
2648 spin_unlock(&pr_tmpl->registration_lock);
2649
2650 write_aptpl:
2651 if (pr_tmpl->pr_aptpl_active)
2652 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
2653
2654 out_put_pr_reg:
2655 core_scsi3_put_pr_reg(pr_reg);
2656 return ret;
2657 }
2658
2659 static sense_reason_t
core_scsi3_emulate_pro_clear(struct se_cmd * cmd,u64 res_key)2660 core_scsi3_emulate_pro_clear(struct se_cmd *cmd, u64 res_key)
2661 {
2662 struct se_device *dev = cmd->se_dev;
2663 struct se_node_acl *pr_reg_nacl;
2664 struct se_session *se_sess = cmd->se_sess;
2665 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2666 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_reg_n, *pr_res_holder;
2667 u64 pr_res_mapped_lun = 0;
2668 int calling_it_nexus = 0;
2669 /*
2670 * Locate the existing *pr_reg via struct se_node_acl pointers
2671 */
2672 pr_reg_n = core_scsi3_locate_pr_reg(cmd->se_dev,
2673 se_sess->se_node_acl, se_sess);
2674 if (!pr_reg_n) {
2675 pr_err("SPC-3 PR: Unable to locate"
2676 " PR_REGISTERED *pr_reg for CLEAR\n");
2677 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2678 }
2679 /*
2680 * From spc4r17 section 5.7.11.6, Clearing:
2681 *
2682 * Any application client may release the persistent reservation and
2683 * remove all registrations from a device server by issuing a
2684 * PERSISTENT RESERVE OUT command with CLEAR service action through a
2685 * registered I_T nexus with the following parameter:
2686 *
2687 * a) RESERVATION KEY field set to the value of the reservation key
2688 * that is registered with the logical unit for the I_T nexus.
2689 */
2690 if (res_key != pr_reg_n->pr_res_key) {
2691 pr_err("SPC-3 PR REGISTER: Received"
2692 " res_key: 0x%016Lx does not match"
2693 " existing SA REGISTER res_key:"
2694 " 0x%016Lx\n", res_key, pr_reg_n->pr_res_key);
2695 core_scsi3_put_pr_reg(pr_reg_n);
2696 return TCM_RESERVATION_CONFLICT;
2697 }
2698 /*
2699 * a) Release the persistent reservation, if any;
2700 */
2701 spin_lock(&dev->dev_reservation_lock);
2702 pr_res_holder = dev->dev_pr_res_holder;
2703 if (pr_res_holder) {
2704 struct se_node_acl *pr_res_nacl = pr_res_holder->pr_reg_nacl;
2705 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
2706 pr_res_holder, 0, 0);
2707 }
2708 spin_unlock(&dev->dev_reservation_lock);
2709 /*
2710 * b) Remove all registration(s) (see spc4r17 5.7.7);
2711 */
2712 spin_lock(&pr_tmpl->registration_lock);
2713 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2714 &pr_tmpl->registration_list, pr_reg_list) {
2715
2716 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2717 pr_reg_nacl = pr_reg->pr_reg_nacl;
2718 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2719 __core_scsi3_free_registration(dev, pr_reg, NULL,
2720 calling_it_nexus);
2721 /*
2722 * e) Establish a unit attention condition for the initiator
2723 * port associated with every registered I_T nexus other
2724 * than the I_T nexus on which the PERSISTENT RESERVE OUT
2725 * command with CLEAR service action was received, with the
2726 * additional sense code set to RESERVATIONS PREEMPTED.
2727 */
2728 if (!calling_it_nexus)
2729 target_ua_allocate_lun(pr_reg_nacl, pr_res_mapped_lun,
2730 0x2A, ASCQ_2AH_RESERVATIONS_PREEMPTED);
2731 }
2732 spin_unlock(&pr_tmpl->registration_lock);
2733
2734 pr_debug("SPC-3 PR [%s] Service Action: CLEAR complete\n",
2735 cmd->se_tfo->fabric_name);
2736
2737 core_scsi3_update_and_write_aptpl(cmd->se_dev, false);
2738
2739 core_scsi3_pr_generation(dev);
2740 return 0;
2741 }
2742
__core_scsi3_complete_pro_preempt(struct se_device * dev,struct t10_pr_registration * pr_reg,struct list_head * preempt_and_abort_list,int type,int scope,enum preempt_type preempt_type)2743 static void __core_scsi3_complete_pro_preempt(
2744 struct se_device *dev,
2745 struct t10_pr_registration *pr_reg,
2746 struct list_head *preempt_and_abort_list,
2747 int type,
2748 int scope,
2749 enum preempt_type preempt_type)
2750 {
2751 struct se_node_acl *nacl = pr_reg->pr_reg_nacl;
2752 const struct target_core_fabric_ops *tfo = nacl->se_tpg->se_tpg_tfo;
2753 char i_buf[PR_REG_ISID_ID_LEN] = { };
2754
2755 lockdep_assert_held(&dev->dev_reservation_lock);
2756
2757 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
2758 /*
2759 * Do an implicit RELEASE of the existing reservation.
2760 */
2761 if (dev->dev_pr_res_holder)
2762 __core_scsi3_complete_pro_release(dev, nacl,
2763 dev->dev_pr_res_holder, 0, 0);
2764
2765 dev->dev_pr_res_holder = pr_reg;
2766 pr_reg->pr_res_holder = 1;
2767 pr_reg->pr_res_type = type;
2768 pr_reg->pr_res_scope = scope;
2769
2770 pr_debug("SPC-3 PR [%s] Service Action: PREEMPT%s created new"
2771 " reservation holder TYPE: %s ALL_TG_PT: %d\n",
2772 tfo->fabric_name, (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "",
2773 core_scsi3_pr_dump_type(type),
2774 (pr_reg->pr_reg_all_tg_pt) ? 1 : 0);
2775 pr_debug("SPC-3 PR [%s] PREEMPT%s from Node: %s%s\n",
2776 tfo->fabric_name, (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "",
2777 nacl->initiatorname, i_buf);
2778 /*
2779 * For PREEMPT_AND_ABORT, add the preempting reservation's
2780 * struct t10_pr_registration to the list that will be compared
2781 * against received CDBs..
2782 */
2783 if (preempt_and_abort_list)
2784 list_add_tail(&pr_reg->pr_reg_abort_list,
2785 preempt_and_abort_list);
2786 }
2787
core_scsi3_release_preempt_and_abort(struct list_head * preempt_and_abort_list,struct t10_pr_registration * pr_reg_holder)2788 static void core_scsi3_release_preempt_and_abort(
2789 struct list_head *preempt_and_abort_list,
2790 struct t10_pr_registration *pr_reg_holder)
2791 {
2792 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
2793
2794 list_for_each_entry_safe(pr_reg, pr_reg_tmp, preempt_and_abort_list,
2795 pr_reg_abort_list) {
2796
2797 list_del(&pr_reg->pr_reg_abort_list);
2798 if (pr_reg_holder == pr_reg)
2799 continue;
2800 if (pr_reg->pr_res_holder) {
2801 pr_warn("pr_reg->pr_res_holder still set\n");
2802 continue;
2803 }
2804
2805 pr_reg->pr_reg_deve = NULL;
2806 pr_reg->pr_reg_nacl = NULL;
2807 kmem_cache_free(t10_pr_reg_cache, pr_reg);
2808 }
2809 }
2810
2811 static sense_reason_t
core_scsi3_pro_preempt(struct se_cmd * cmd,int type,int scope,u64 res_key,u64 sa_res_key,enum preempt_type preempt_type)2812 core_scsi3_pro_preempt(struct se_cmd *cmd, int type, int scope, u64 res_key,
2813 u64 sa_res_key, enum preempt_type preempt_type)
2814 {
2815 struct se_device *dev = cmd->se_dev;
2816 struct se_node_acl *pr_reg_nacl;
2817 struct se_session *se_sess = cmd->se_sess;
2818 LIST_HEAD(preempt_and_abort_list);
2819 struct t10_pr_registration *pr_reg, *pr_reg_tmp, *pr_reg_n, *pr_res_holder;
2820 struct t10_reservation *pr_tmpl = &dev->t10_pr;
2821 u64 pr_res_mapped_lun = 0;
2822 int all_reg = 0, calling_it_nexus = 0;
2823 bool sa_res_key_unmatched = sa_res_key != 0;
2824 int prh_type = 0, prh_scope = 0;
2825
2826 if (!se_sess)
2827 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
2828
2829 pr_reg_n = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
2830 se_sess);
2831 if (!pr_reg_n) {
2832 pr_err("SPC-3 PR: Unable to locate"
2833 " PR_REGISTERED *pr_reg for PREEMPT%s\n",
2834 (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "");
2835 return TCM_RESERVATION_CONFLICT;
2836 }
2837 if (pr_reg_n->pr_res_key != res_key) {
2838 core_scsi3_put_pr_reg(pr_reg_n);
2839 return TCM_RESERVATION_CONFLICT;
2840 }
2841 if (scope != PR_SCOPE_LU_SCOPE) {
2842 pr_err("SPC-3 PR: Illegal SCOPE: 0x%02x\n", scope);
2843 core_scsi3_put_pr_reg(pr_reg_n);
2844 return TCM_INVALID_PARAMETER_LIST;
2845 }
2846
2847 spin_lock(&dev->dev_reservation_lock);
2848 pr_res_holder = dev->dev_pr_res_holder;
2849 if (pr_res_holder &&
2850 ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
2851 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)))
2852 all_reg = 1;
2853
2854 if (!all_reg && !sa_res_key) {
2855 spin_unlock(&dev->dev_reservation_lock);
2856 core_scsi3_put_pr_reg(pr_reg_n);
2857 return TCM_INVALID_PARAMETER_LIST;
2858 }
2859 /*
2860 * From spc4r17, section 5.7.11.4.4 Removing Registrations:
2861 *
2862 * If the SERVICE ACTION RESERVATION KEY field does not identify a
2863 * persistent reservation holder or there is no persistent reservation
2864 * holder (i.e., there is no persistent reservation), then the device
2865 * server shall perform a preempt by doing the following in an
2866 * uninterrupted series of actions. (See below..)
2867 */
2868 if (!pr_res_holder || (pr_res_holder->pr_res_key != sa_res_key)) {
2869 /*
2870 * No existing or SA Reservation Key matching reservations..
2871 *
2872 * PROUT SA PREEMPT with All Registrant type reservations are
2873 * allowed to be processed without a matching SA Reservation Key
2874 */
2875 spin_lock(&pr_tmpl->registration_lock);
2876 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
2877 &pr_tmpl->registration_list, pr_reg_list) {
2878 /*
2879 * Removing of registrations in non all registrants
2880 * type reservations without a matching SA reservation
2881 * key.
2882 *
2883 * a) Remove the registrations for all I_T nexuses
2884 * specified by the SERVICE ACTION RESERVATION KEY
2885 * field;
2886 * b) Ignore the contents of the SCOPE and TYPE fields;
2887 * c) Process tasks as defined in 5.7.1; and
2888 * d) Establish a unit attention condition for the
2889 * initiator port associated with every I_T nexus
2890 * that lost its registration other than the I_T
2891 * nexus on which the PERSISTENT RESERVE OUT command
2892 * was received, with the additional sense code set
2893 * to REGISTRATIONS PREEMPTED.
2894 */
2895 if (!all_reg) {
2896 if (pr_reg->pr_res_key != sa_res_key)
2897 continue;
2898 sa_res_key_unmatched = false;
2899
2900 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2901 pr_reg_nacl = pr_reg->pr_reg_nacl;
2902 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2903 __core_scsi3_free_registration(dev, pr_reg,
2904 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list :
2905 NULL, calling_it_nexus);
2906 } else {
2907 /*
2908 * Case for any existing all registrants type
2909 * reservation, follow logic in spc4r17 section
2910 * 5.7.11.4 Preempting, Table 52 and Figure 7.
2911 *
2912 * For a ZERO SA Reservation key, release
2913 * all other registrations and do an implicit
2914 * release of active persistent reservation.
2915 *
2916 * For a non-ZERO SA Reservation key, only
2917 * release the matching reservation key from
2918 * registrations.
2919 */
2920 if ((sa_res_key) &&
2921 (pr_reg->pr_res_key != sa_res_key))
2922 continue;
2923 sa_res_key_unmatched = false;
2924
2925 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
2926 if (calling_it_nexus)
2927 continue;
2928
2929 pr_reg_nacl = pr_reg->pr_reg_nacl;
2930 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
2931 __core_scsi3_free_registration(dev, pr_reg,
2932 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list :
2933 NULL, 0);
2934 }
2935 if (!calling_it_nexus)
2936 target_ua_allocate_lun(pr_reg_nacl,
2937 pr_res_mapped_lun, 0x2A,
2938 ASCQ_2AH_REGISTRATIONS_PREEMPTED);
2939 }
2940 spin_unlock(&pr_tmpl->registration_lock);
2941 /*
2942 * If a PERSISTENT RESERVE OUT with a PREEMPT service action or
2943 * a PREEMPT AND ABORT service action sets the SERVICE ACTION
2944 * RESERVATION KEY field to a value that does not match any
2945 * registered reservation key, then the device server shall
2946 * complete the command with RESERVATION CONFLICT status.
2947 */
2948 if (sa_res_key_unmatched) {
2949 spin_unlock(&dev->dev_reservation_lock);
2950 core_scsi3_put_pr_reg(pr_reg_n);
2951 return TCM_RESERVATION_CONFLICT;
2952 }
2953 /*
2954 * For an existing all registrants type reservation
2955 * with a zero SA rservation key, preempt the existing
2956 * reservation with the new PR type and scope.
2957 */
2958 if (pr_res_holder && all_reg && !(sa_res_key)) {
2959 __core_scsi3_complete_pro_preempt(dev, pr_reg_n,
2960 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
2961 type, scope, preempt_type);
2962 }
2963
2964 spin_unlock(&dev->dev_reservation_lock);
2965
2966 /*
2967 * SPC-4 5.12.11.2.6 Preempting and aborting
2968 * The actions described in this subclause shall be performed
2969 * for all I_T nexuses that are registered with the non-zero
2970 * SERVICE ACTION RESERVATION KEY value, without regard for
2971 * whether the preempted I_T nexuses hold the persistent
2972 * reservation. If the SERVICE ACTION RESERVATION KEY field is
2973 * set to zero and an all registrants persistent reservation is
2974 * present, the device server shall abort all commands for all
2975 * registered I_T nexuses.
2976 */
2977 if (preempt_type == PREEMPT_AND_ABORT) {
2978 core_tmr_lun_reset(dev, NULL, &preempt_and_abort_list,
2979 cmd);
2980 core_scsi3_release_preempt_and_abort(
2981 &preempt_and_abort_list, pr_reg_n);
2982 }
2983
2984 if (pr_tmpl->pr_aptpl_active)
2985 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
2986
2987 core_scsi3_put_pr_reg(pr_reg_n);
2988 core_scsi3_pr_generation(cmd->se_dev);
2989 return 0;
2990 }
2991 /*
2992 * The PREEMPTing SA reservation key matches that of the
2993 * existing persistent reservation, first, we check if
2994 * we are preempting our own reservation.
2995 * From spc4r17, section 5.7.11.4.3 Preempting
2996 * persistent reservations and registration handling
2997 *
2998 * If an all registrants persistent reservation is not
2999 * present, it is not an error for the persistent
3000 * reservation holder to preempt itself (i.e., a
3001 * PERSISTENT RESERVE OUT with a PREEMPT service action
3002 * or a PREEMPT AND ABORT service action with the
3003 * SERVICE ACTION RESERVATION KEY value equal to the
3004 * persistent reservation holder's reservation key that
3005 * is received from the persistent reservation holder).
3006 * In that case, the device server shall establish the
3007 * new persistent reservation and maintain the
3008 * registration.
3009 */
3010 prh_type = pr_res_holder->pr_res_type;
3011 prh_scope = pr_res_holder->pr_res_scope;
3012 /*
3013 * If the SERVICE ACTION RESERVATION KEY field identifies a
3014 * persistent reservation holder (see 5.7.10), the device
3015 * server shall perform a preempt by doing the following as
3016 * an uninterrupted series of actions:
3017 *
3018 * a) Release the persistent reservation for the holder
3019 * identified by the SERVICE ACTION RESERVATION KEY field;
3020 */
3021 if (pr_reg_n != pr_res_holder)
3022 __core_scsi3_complete_pro_release(dev,
3023 pr_res_holder->pr_reg_nacl,
3024 dev->dev_pr_res_holder, 0, 0);
3025 /*
3026 * b) Remove the registrations for all I_T nexuses identified
3027 * by the SERVICE ACTION RESERVATION KEY field, except the
3028 * I_T nexus that is being used for the PERSISTENT RESERVE
3029 * OUT command. If an all registrants persistent reservation
3030 * is present and the SERVICE ACTION RESERVATION KEY field
3031 * is set to zero, then all registrations shall be removed
3032 * except for that of the I_T nexus that is being used for
3033 * the PERSISTENT RESERVE OUT command;
3034 */
3035 spin_lock(&pr_tmpl->registration_lock);
3036 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3037 &pr_tmpl->registration_list, pr_reg_list) {
3038
3039 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
3040 if (calling_it_nexus)
3041 continue;
3042
3043 if (sa_res_key && pr_reg->pr_res_key != sa_res_key)
3044 continue;
3045
3046 pr_reg_nacl = pr_reg->pr_reg_nacl;
3047 pr_res_mapped_lun = pr_reg->pr_res_mapped_lun;
3048 __core_scsi3_free_registration(dev, pr_reg,
3049 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
3050 calling_it_nexus);
3051 /*
3052 * e) Establish a unit attention condition for the initiator
3053 * port associated with every I_T nexus that lost its
3054 * persistent reservation and/or registration, with the
3055 * additional sense code set to REGISTRATIONS PREEMPTED;
3056 */
3057 target_ua_allocate_lun(pr_reg_nacl, pr_res_mapped_lun, 0x2A,
3058 ASCQ_2AH_REGISTRATIONS_PREEMPTED);
3059 }
3060 spin_unlock(&pr_tmpl->registration_lock);
3061 /*
3062 * c) Establish a persistent reservation for the preempting
3063 * I_T nexus using the contents of the SCOPE and TYPE fields;
3064 */
3065 __core_scsi3_complete_pro_preempt(dev, pr_reg_n,
3066 (preempt_type == PREEMPT_AND_ABORT) ? &preempt_and_abort_list : NULL,
3067 type, scope, preempt_type);
3068 /*
3069 * d) Process tasks as defined in 5.7.1;
3070 * e) See above..
3071 * f) If the type or scope has changed, then for every I_T nexus
3072 * whose reservation key was not removed, except for the I_T
3073 * nexus on which the PERSISTENT RESERVE OUT command was
3074 * received, the device server shall establish a unit
3075 * attention condition for the initiator port associated with
3076 * that I_T nexus, with the additional sense code set to
3077 * RESERVATIONS RELEASED. If the type or scope have not
3078 * changed, then no unit attention condition(s) shall be
3079 * established for this reason.
3080 */
3081 if ((prh_type != type) || (prh_scope != scope)) {
3082 spin_lock(&pr_tmpl->registration_lock);
3083 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3084 &pr_tmpl->registration_list, pr_reg_list) {
3085
3086 calling_it_nexus = (pr_reg_n == pr_reg) ? 1 : 0;
3087 if (calling_it_nexus)
3088 continue;
3089
3090 target_ua_allocate_lun(pr_reg->pr_reg_nacl,
3091 pr_reg->pr_res_mapped_lun, 0x2A,
3092 ASCQ_2AH_RESERVATIONS_RELEASED);
3093 }
3094 spin_unlock(&pr_tmpl->registration_lock);
3095 }
3096 spin_unlock(&dev->dev_reservation_lock);
3097 /*
3098 * Call LUN_RESET logic upon list of struct t10_pr_registration,
3099 * All received CDBs for the matching existing reservation and
3100 * registrations undergo ABORT_TASK logic.
3101 *
3102 * From there, core_scsi3_release_preempt_and_abort() will
3103 * release every registration in the list (which have already
3104 * been removed from the primary pr_reg list), except the
3105 * new persistent reservation holder, the calling Initiator Port.
3106 */
3107 if (preempt_type == PREEMPT_AND_ABORT) {
3108 core_tmr_lun_reset(dev, NULL, &preempt_and_abort_list, cmd);
3109 core_scsi3_release_preempt_and_abort(&preempt_and_abort_list,
3110 pr_reg_n);
3111 }
3112
3113 if (pr_tmpl->pr_aptpl_active)
3114 core_scsi3_update_and_write_aptpl(cmd->se_dev, true);
3115
3116 core_scsi3_put_pr_reg(pr_reg_n);
3117 core_scsi3_pr_generation(cmd->se_dev);
3118 return 0;
3119 }
3120
3121 static sense_reason_t
core_scsi3_emulate_pro_preempt(struct se_cmd * cmd,int type,int scope,u64 res_key,u64 sa_res_key,enum preempt_type preempt_type)3122 core_scsi3_emulate_pro_preempt(struct se_cmd *cmd, int type, int scope,
3123 u64 res_key, u64 sa_res_key, enum preempt_type preempt_type)
3124 {
3125 switch (type) {
3126 case PR_TYPE_WRITE_EXCLUSIVE:
3127 case PR_TYPE_EXCLUSIVE_ACCESS:
3128 case PR_TYPE_WRITE_EXCLUSIVE_REGONLY:
3129 case PR_TYPE_EXCLUSIVE_ACCESS_REGONLY:
3130 case PR_TYPE_WRITE_EXCLUSIVE_ALLREG:
3131 case PR_TYPE_EXCLUSIVE_ACCESS_ALLREG:
3132 return core_scsi3_pro_preempt(cmd, type, scope, res_key,
3133 sa_res_key, preempt_type);
3134 default:
3135 pr_err("SPC-3 PR: Unknown Service Action PREEMPT%s"
3136 " Type: 0x%02x\n", (preempt_type == PREEMPT_AND_ABORT) ? "_AND_ABORT" : "", type);
3137 return TCM_INVALID_CDB_FIELD;
3138 }
3139 }
3140
3141
3142 static sense_reason_t
core_scsi3_emulate_pro_register_and_move(struct se_cmd * cmd,u64 res_key,u64 sa_res_key,int aptpl,int unreg)3143 core_scsi3_emulate_pro_register_and_move(struct se_cmd *cmd, u64 res_key,
3144 u64 sa_res_key, int aptpl, int unreg)
3145 {
3146 struct se_session *se_sess = cmd->se_sess;
3147 struct se_device *dev = cmd->se_dev;
3148 struct se_dev_entry *dest_se_deve = NULL;
3149 struct se_lun *se_lun = cmd->se_lun, *tmp_lun;
3150 struct se_node_acl *pr_res_nacl, *pr_reg_nacl, *dest_node_acl = NULL;
3151 struct se_portal_group *se_tpg, *dest_se_tpg = NULL;
3152 const struct target_core_fabric_ops *dest_tf_ops = NULL, *tf_ops;
3153 struct t10_pr_registration *pr_reg, *pr_res_holder, *dest_pr_reg;
3154 struct t10_reservation *pr_tmpl = &dev->t10_pr;
3155 unsigned char *buf;
3156 const unsigned char *initiator_str;
3157 char *iport_ptr = NULL, i_buf[PR_REG_ISID_ID_LEN] = { };
3158 u32 tid_len, tmp_tid_len;
3159 int new_reg = 0, type, scope, matching_iname;
3160 sense_reason_t ret;
3161 unsigned short rtpi;
3162 unsigned char proto_ident;
3163
3164 if (!se_sess || !se_lun) {
3165 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
3166 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3167 }
3168
3169 se_tpg = se_sess->se_tpg;
3170 tf_ops = se_tpg->se_tpg_tfo;
3171 /*
3172 * Follow logic from spc4r17 Section 5.7.8, Table 50 --
3173 * Register behaviors for a REGISTER AND MOVE service action
3174 *
3175 * Locate the existing *pr_reg via struct se_node_acl pointers
3176 */
3177 pr_reg = core_scsi3_locate_pr_reg(cmd->se_dev, se_sess->se_node_acl,
3178 se_sess);
3179 if (!pr_reg) {
3180 pr_err("SPC-3 PR: Unable to locate PR_REGISTERED"
3181 " *pr_reg for REGISTER_AND_MOVE\n");
3182 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3183 }
3184 /*
3185 * The provided reservation key much match the existing reservation key
3186 * provided during this initiator's I_T nexus registration.
3187 */
3188 if (res_key != pr_reg->pr_res_key) {
3189 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received"
3190 " res_key: 0x%016Lx does not match existing SA REGISTER"
3191 " res_key: 0x%016Lx\n", res_key, pr_reg->pr_res_key);
3192 ret = TCM_RESERVATION_CONFLICT;
3193 goto out_put_pr_reg;
3194 }
3195 /*
3196 * The service active reservation key needs to be non zero
3197 */
3198 if (!sa_res_key) {
3199 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Received zero"
3200 " sa_res_key\n");
3201 ret = TCM_INVALID_PARAMETER_LIST;
3202 goto out_put_pr_reg;
3203 }
3204
3205 /*
3206 * Determine the Relative Target Port Identifier where the reservation
3207 * will be moved to for the TransportID containing SCSI initiator WWN
3208 * information.
3209 */
3210 buf = transport_kmap_data_sg(cmd);
3211 if (!buf) {
3212 ret = TCM_INSUFFICIENT_REGISTRATION_RESOURCES;
3213 goto out_put_pr_reg;
3214 }
3215
3216 rtpi = get_unaligned_be16(&buf[18]);
3217 tid_len = get_unaligned_be32(&buf[20]);
3218 transport_kunmap_data_sg(cmd);
3219 buf = NULL;
3220
3221 if ((tid_len + 24) != cmd->data_length) {
3222 pr_err("SPC-3 PR: Illegal tid_len: %u + 24 byte header"
3223 " does not equal CDB data_length: %u\n", tid_len,
3224 cmd->data_length);
3225 ret = TCM_INVALID_PARAMETER_LIST;
3226 goto out_put_pr_reg;
3227 }
3228
3229 spin_lock(&dev->se_port_lock);
3230 list_for_each_entry(tmp_lun, &dev->dev_sep_list, lun_dev_link) {
3231 if (tmp_lun->lun_tpg->tpg_rtpi != rtpi)
3232 continue;
3233 dest_se_tpg = tmp_lun->lun_tpg;
3234 dest_tf_ops = dest_se_tpg->se_tpg_tfo;
3235 if (!dest_tf_ops)
3236 continue;
3237
3238 atomic_inc_mb(&dest_se_tpg->tpg_pr_ref_count);
3239 spin_unlock(&dev->se_port_lock);
3240
3241 if (core_scsi3_tpg_depend_item(dest_se_tpg)) {
3242 pr_err("core_scsi3_tpg_depend_item() failed"
3243 " for dest_se_tpg\n");
3244 atomic_dec_mb(&dest_se_tpg->tpg_pr_ref_count);
3245 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3246 goto out_put_pr_reg;
3247 }
3248
3249 spin_lock(&dev->se_port_lock);
3250 break;
3251 }
3252 spin_unlock(&dev->se_port_lock);
3253
3254 if (!dest_se_tpg || !dest_tf_ops) {
3255 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3256 " fabric ops from Relative Target Port Identifier:"
3257 " %hu\n", rtpi);
3258 ret = TCM_INVALID_PARAMETER_LIST;
3259 goto out_put_pr_reg;
3260 }
3261
3262 buf = transport_kmap_data_sg(cmd);
3263 if (!buf) {
3264 ret = TCM_INSUFFICIENT_REGISTRATION_RESOURCES;
3265 goto out_put_pr_reg;
3266 }
3267 proto_ident = (buf[24] & 0x0f);
3268
3269 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Extracted Protocol Identifier:"
3270 " 0x%02x\n", proto_ident);
3271
3272 if (proto_ident != dest_se_tpg->proto_id) {
3273 pr_err("SPC-3 PR REGISTER_AND_MOVE: Received"
3274 " proto_ident: 0x%02x does not match ident: 0x%02x"
3275 " from fabric: %s\n", proto_ident,
3276 dest_se_tpg->proto_id,
3277 dest_tf_ops->fabric_name);
3278 ret = TCM_INVALID_PARAMETER_LIST;
3279 goto out;
3280 }
3281 initiator_str = target_parse_pr_out_transport_id(dest_se_tpg,
3282 &buf[24], &tmp_tid_len, &iport_ptr);
3283 if (!initiator_str) {
3284 pr_err("SPC-3 PR REGISTER_AND_MOVE: Unable to locate"
3285 " initiator_str from Transport ID\n");
3286 ret = TCM_INVALID_PARAMETER_LIST;
3287 goto out;
3288 }
3289
3290 transport_kunmap_data_sg(cmd);
3291 buf = NULL;
3292
3293 pr_debug("SPC-3 PR [%s] Extracted initiator %s identifier: %s"
3294 " %s\n", dest_tf_ops->fabric_name, (iport_ptr != NULL) ?
3295 "port" : "device", initiator_str, (iport_ptr != NULL) ?
3296 iport_ptr : "");
3297 /*
3298 * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3299 * action specifies a TransportID that is the same as the initiator port
3300 * of the I_T nexus for the command received, then the command shall
3301 * be terminated with CHECK CONDITION status, with the sense key set to
3302 * ILLEGAL REQUEST, and the additional sense code set to INVALID FIELD
3303 * IN PARAMETER LIST.
3304 */
3305 pr_reg_nacl = pr_reg->pr_reg_nacl;
3306 matching_iname = (!strcmp(initiator_str,
3307 pr_reg_nacl->initiatorname)) ? 1 : 0;
3308 if (!matching_iname)
3309 goto after_iport_check;
3310
3311 if (!iport_ptr || !pr_reg->isid_present_at_reg) {
3312 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s"
3313 " matches: %s on received I_T Nexus\n", initiator_str,
3314 pr_reg_nacl->initiatorname);
3315 ret = TCM_INVALID_PARAMETER_LIST;
3316 goto out;
3317 }
3318 if (!strcmp(iport_ptr, pr_reg->pr_reg_isid)) {
3319 pr_err("SPC-3 PR REGISTER_AND_MOVE: TransportID: %s %s"
3320 " matches: %s %s on received I_T Nexus\n",
3321 initiator_str, iport_ptr, pr_reg_nacl->initiatorname,
3322 pr_reg->pr_reg_isid);
3323 ret = TCM_INVALID_PARAMETER_LIST;
3324 goto out;
3325 }
3326 after_iport_check:
3327 /*
3328 * Locate the destination struct se_node_acl from the received Transport ID
3329 */
3330 mutex_lock(&dest_se_tpg->acl_node_mutex);
3331 dest_node_acl = __core_tpg_get_initiator_node_acl(dest_se_tpg,
3332 initiator_str);
3333 if (dest_node_acl)
3334 atomic_inc_mb(&dest_node_acl->acl_pr_ref_count);
3335 mutex_unlock(&dest_se_tpg->acl_node_mutex);
3336
3337 if (!dest_node_acl) {
3338 pr_err("Unable to locate %s dest_node_acl for"
3339 " TransportID%s\n", dest_tf_ops->fabric_name,
3340 initiator_str);
3341 ret = TCM_INVALID_PARAMETER_LIST;
3342 goto out;
3343 }
3344
3345 if (core_scsi3_nodeacl_depend_item(dest_node_acl)) {
3346 pr_err("core_scsi3_nodeacl_depend_item() for"
3347 " dest_node_acl\n");
3348 atomic_dec_mb(&dest_node_acl->acl_pr_ref_count);
3349 dest_node_acl = NULL;
3350 ret = TCM_INVALID_PARAMETER_LIST;
3351 goto out;
3352 }
3353
3354 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Found %s dest_node_acl:"
3355 " %s from TransportID\n", dest_tf_ops->fabric_name,
3356 dest_node_acl->initiatorname);
3357
3358 /*
3359 * Locate the struct se_dev_entry pointer for the matching RELATIVE TARGET
3360 * PORT IDENTIFIER.
3361 */
3362 dest_se_deve = core_get_se_deve_from_rtpi(dest_node_acl, rtpi);
3363 if (!dest_se_deve) {
3364 pr_err("Unable to locate %s dest_se_deve from RTPI:"
3365 " %hu\n", dest_tf_ops->fabric_name, rtpi);
3366 ret = TCM_INVALID_PARAMETER_LIST;
3367 goto out;
3368 }
3369
3370 if (core_scsi3_lunacl_depend_item(dest_se_deve)) {
3371 pr_err("core_scsi3_lunacl_depend_item() failed\n");
3372 kref_put(&dest_se_deve->pr_kref, target_pr_kref_release);
3373 dest_se_deve = NULL;
3374 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3375 goto out;
3376 }
3377
3378 pr_debug("SPC-3 PR REGISTER_AND_MOVE: Located %s node %s LUN"
3379 " ACL for dest_se_deve->mapped_lun: %llu\n",
3380 dest_tf_ops->fabric_name, dest_node_acl->initiatorname,
3381 dest_se_deve->mapped_lun);
3382
3383 /*
3384 * A persistent reservation needs to already existing in order to
3385 * successfully complete the REGISTER_AND_MOVE service action..
3386 */
3387 spin_lock(&dev->dev_reservation_lock);
3388 pr_res_holder = dev->dev_pr_res_holder;
3389 if (!pr_res_holder) {
3390 pr_warn("SPC-3 PR REGISTER_AND_MOVE: No reservation"
3391 " currently held\n");
3392 spin_unlock(&dev->dev_reservation_lock);
3393 ret = TCM_INVALID_CDB_FIELD;
3394 goto out;
3395 }
3396 /*
3397 * The received on I_T Nexus must be the reservation holder.
3398 *
3399 * From spc4r17 section 5.7.8 Table 50 --
3400 * Register behaviors for a REGISTER AND MOVE service action
3401 */
3402 if (!is_reservation_holder(pr_res_holder, pr_reg)) {
3403 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Calling I_T"
3404 " Nexus is not reservation holder\n");
3405 spin_unlock(&dev->dev_reservation_lock);
3406 ret = TCM_RESERVATION_CONFLICT;
3407 goto out;
3408 }
3409 /*
3410 * From spc4r17 section 5.7.8: registering and moving reservation
3411 *
3412 * If a PERSISTENT RESERVE OUT command with a REGISTER AND MOVE service
3413 * action is received and the established persistent reservation is a
3414 * Write Exclusive - All Registrants type or Exclusive Access -
3415 * All Registrants type reservation, then the command shall be completed
3416 * with RESERVATION CONFLICT status.
3417 */
3418 if ((pr_res_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
3419 (pr_res_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG)) {
3420 pr_warn("SPC-3 PR REGISTER_AND_MOVE: Unable to move"
3421 " reservation for type: %s\n",
3422 core_scsi3_pr_dump_type(pr_res_holder->pr_res_type));
3423 spin_unlock(&dev->dev_reservation_lock);
3424 ret = TCM_RESERVATION_CONFLICT;
3425 goto out;
3426 }
3427 pr_res_nacl = pr_res_holder->pr_reg_nacl;
3428 /*
3429 * b) Ignore the contents of the (received) SCOPE and TYPE fields;
3430 */
3431 type = pr_res_holder->pr_res_type;
3432 scope = pr_res_holder->pr_res_type;
3433 /*
3434 * c) Associate the reservation key specified in the SERVICE ACTION
3435 * RESERVATION KEY field with the I_T nexus specified as the
3436 * destination of the register and move, where:
3437 * A) The I_T nexus is specified by the TransportID and the
3438 * RELATIVE TARGET PORT IDENTIFIER field (see 6.14.4); and
3439 * B) Regardless of the TransportID format used, the association for
3440 * the initiator port is based on either the initiator port name
3441 * (see 3.1.71) on SCSI transport protocols where port names are
3442 * required or the initiator port identifier (see 3.1.70) on SCSI
3443 * transport protocols where port names are not required;
3444 * d) Register the reservation key specified in the SERVICE ACTION
3445 * RESERVATION KEY field;
3446 *
3447 * Also, It is not an error for a REGISTER AND MOVE service action to
3448 * register an I_T nexus that is already registered with the same
3449 * reservation key or a different reservation key.
3450 */
3451 dest_pr_reg = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
3452 iport_ptr);
3453 if (!dest_pr_reg) {
3454 struct se_lun *dest_lun = dest_se_deve->se_lun;
3455
3456 spin_unlock(&dev->dev_reservation_lock);
3457 if (core_scsi3_alloc_registration(cmd->se_dev, dest_node_acl,
3458 dest_lun, dest_se_deve, dest_se_deve->mapped_lun,
3459 iport_ptr, sa_res_key, 0, aptpl, 2, 1)) {
3460 ret = TCM_INSUFFICIENT_REGISTRATION_RESOURCES;
3461 goto out;
3462 }
3463 spin_lock(&dev->dev_reservation_lock);
3464 dest_pr_reg = __core_scsi3_locate_pr_reg(dev, dest_node_acl,
3465 iport_ptr);
3466 new_reg = 1;
3467 } else {
3468 /*
3469 * e) Retain the reservation key specified in the SERVICE ACTION
3470 * RESERVATION KEY field and associated information;
3471 */
3472 dest_pr_reg->pr_res_key = sa_res_key;
3473 }
3474 /*
3475 * f) Release the persistent reservation for the persistent reservation
3476 * holder (i.e., the I_T nexus on which the
3477 */
3478 __core_scsi3_complete_pro_release(dev, pr_res_nacl,
3479 dev->dev_pr_res_holder, 0, 0);
3480 /*
3481 * g) Move the persistent reservation to the specified I_T nexus using
3482 * the same scope and type as the persistent reservation released in
3483 * item f); and
3484 */
3485 dev->dev_pr_res_holder = dest_pr_reg;
3486 dest_pr_reg->pr_res_holder = 1;
3487 dest_pr_reg->pr_res_type = type;
3488 pr_reg->pr_res_scope = scope;
3489 core_pr_dump_initiator_port(pr_reg, i_buf, PR_REG_ISID_ID_LEN);
3490 /*
3491 * Increment PRGeneration for existing registrations..
3492 */
3493 if (!new_reg)
3494 dest_pr_reg->pr_res_generation = pr_tmpl->pr_generation++;
3495 spin_unlock(&dev->dev_reservation_lock);
3496
3497 pr_debug("SPC-3 PR [%s] Service Action: REGISTER_AND_MOVE"
3498 " created new reservation holder TYPE: %s on object RTPI:"
3499 " %hu PRGeneration: 0x%08x\n", dest_tf_ops->fabric_name,
3500 core_scsi3_pr_dump_type(type), rtpi,
3501 dest_pr_reg->pr_res_generation);
3502 pr_debug("SPC-3 PR Successfully moved reservation from"
3503 " %s Fabric Node: %s%s -> %s Fabric Node: %s %s\n",
3504 tf_ops->fabric_name, pr_reg_nacl->initiatorname,
3505 i_buf, dest_tf_ops->fabric_name,
3506 dest_node_acl->initiatorname, (iport_ptr != NULL) ?
3507 iport_ptr : "");
3508 /*
3509 * It is now safe to release configfs group dependencies for destination
3510 * of Transport ID Initiator Device/Port Identifier
3511 */
3512 core_scsi3_lunacl_undepend_item(dest_se_deve);
3513 core_scsi3_nodeacl_undepend_item(dest_node_acl);
3514 core_scsi3_tpg_undepend_item(dest_se_tpg);
3515 /*
3516 * h) If the UNREG bit is set to one, unregister (see 5.7.11.3) the I_T
3517 * nexus on which PERSISTENT RESERVE OUT command was received.
3518 */
3519 if (unreg) {
3520 spin_lock(&pr_tmpl->registration_lock);
3521 __core_scsi3_free_registration(dev, pr_reg, NULL, 1);
3522 spin_unlock(&pr_tmpl->registration_lock);
3523 } else
3524 core_scsi3_put_pr_reg(pr_reg);
3525
3526 core_scsi3_update_and_write_aptpl(cmd->se_dev, aptpl);
3527
3528 core_scsi3_put_pr_reg(dest_pr_reg);
3529 return 0;
3530 out:
3531 if (buf)
3532 transport_kunmap_data_sg(cmd);
3533 if (dest_se_deve)
3534 core_scsi3_lunacl_undepend_item(dest_se_deve);
3535 if (dest_node_acl)
3536 core_scsi3_nodeacl_undepend_item(dest_node_acl);
3537 core_scsi3_tpg_undepend_item(dest_se_tpg);
3538
3539 out_put_pr_reg:
3540 core_scsi3_put_pr_reg(pr_reg);
3541 return ret;
3542 }
3543
3544 static sense_reason_t
target_try_pr_out_pt(struct se_cmd * cmd,u8 sa,u64 res_key,u64 sa_res_key,u8 type,bool aptpl,bool all_tg_pt,bool spec_i_pt)3545 target_try_pr_out_pt(struct se_cmd *cmd, u8 sa, u64 res_key, u64 sa_res_key,
3546 u8 type, bool aptpl, bool all_tg_pt, bool spec_i_pt)
3547 {
3548 struct exec_cmd_ops *ops = cmd->protocol_data;
3549
3550 if (!cmd->se_sess || !cmd->se_lun) {
3551 pr_err("SPC-3 PR: se_sess || struct se_lun is NULL!\n");
3552 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3553 }
3554
3555 if (!ops->execute_pr_out) {
3556 pr_err("SPC-3 PR: Device has been configured for PR passthrough but it's not supported by the backend.\n");
3557 return TCM_UNSUPPORTED_SCSI_OPCODE;
3558 }
3559
3560 switch (sa) {
3561 case PRO_REGISTER_AND_MOVE:
3562 case PRO_REPLACE_LOST_RESERVATION:
3563 pr_err("SPC-3 PR: PRO_REGISTER_AND_MOVE and PRO_REPLACE_LOST_RESERVATION are not supported by PR passthrough.\n");
3564 return TCM_UNSUPPORTED_SCSI_OPCODE;
3565 }
3566
3567 if (spec_i_pt || all_tg_pt) {
3568 pr_err("SPC-3 PR: SPEC_I_PT and ALL_TG_PT are not supported by PR passthrough.\n");
3569 return TCM_UNSUPPORTED_SCSI_OPCODE;
3570 }
3571
3572 return ops->execute_pr_out(cmd, sa, res_key, sa_res_key, type, aptpl);
3573 }
3574
3575 /*
3576 * See spc4r17 section 6.14 Table 170
3577 */
3578 sense_reason_t
target_scsi3_emulate_pr_out(struct se_cmd * cmd)3579 target_scsi3_emulate_pr_out(struct se_cmd *cmd)
3580 {
3581 struct se_device *dev = cmd->se_dev;
3582 unsigned char *cdb = &cmd->t_task_cdb[0];
3583 unsigned char *buf;
3584 u64 res_key, sa_res_key;
3585 int sa, scope, type, aptpl;
3586 int spec_i_pt = 0, all_tg_pt = 0, unreg = 0;
3587 sense_reason_t ret;
3588
3589 /*
3590 * Following spc2r20 5.5.1 Reservations overview:
3591 *
3592 * If a logical unit has been reserved by any RESERVE command and is
3593 * still reserved by any initiator, all PERSISTENT RESERVE IN and all
3594 * PERSISTENT RESERVE OUT commands shall conflict regardless of
3595 * initiator or service action and shall terminate with a RESERVATION
3596 * CONFLICT status.
3597 */
3598 if (cmd->se_dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS) {
3599 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
3600 " SPC-2 reservation is held, returning"
3601 " RESERVATION_CONFLICT\n");
3602 return TCM_RESERVATION_CONFLICT;
3603 }
3604
3605 /*
3606 * FIXME: A NULL struct se_session pointer means an this is not coming from
3607 * a $FABRIC_MOD's nexus, but from internal passthrough ops.
3608 */
3609 if (!cmd->se_sess)
3610 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3611
3612 if (cmd->data_length < 24) {
3613 pr_warn("SPC-PR: Received PR OUT parameter list"
3614 " length too small: %u\n", cmd->data_length);
3615 return TCM_PARAMETER_LIST_LENGTH_ERROR;
3616 }
3617
3618 /*
3619 * From the PERSISTENT_RESERVE_OUT command descriptor block (CDB)
3620 */
3621 sa = (cdb[1] & 0x1f);
3622 scope = (cdb[2] & 0xf0);
3623 type = (cdb[2] & 0x0f);
3624
3625 buf = transport_kmap_data_sg(cmd);
3626 if (!buf)
3627 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3628
3629 /*
3630 * From PERSISTENT_RESERVE_OUT parameter list (payload)
3631 */
3632 res_key = get_unaligned_be64(&buf[0]);
3633 sa_res_key = get_unaligned_be64(&buf[8]);
3634 /*
3635 * REGISTER_AND_MOVE uses a different SA parameter list containing
3636 * SCSI TransportIDs.
3637 */
3638 if (sa != PRO_REGISTER_AND_MOVE) {
3639 spec_i_pt = (buf[20] & 0x08);
3640 all_tg_pt = (buf[20] & 0x04);
3641 aptpl = (buf[20] & 0x01);
3642 } else {
3643 aptpl = (buf[17] & 0x01);
3644 unreg = (buf[17] & 0x02);
3645 }
3646 /*
3647 * If the backend device has been configured to force APTPL metadata
3648 * write-out, go ahead and propigate aptpl=1 down now.
3649 */
3650 if (dev->dev_attrib.force_pr_aptpl)
3651 aptpl = 1;
3652
3653 transport_kunmap_data_sg(cmd);
3654 buf = NULL;
3655
3656 /*
3657 * SPEC_I_PT=1 is only valid for Service action: REGISTER
3658 */
3659 if (spec_i_pt && (sa != PRO_REGISTER))
3660 return TCM_INVALID_PARAMETER_LIST;
3661
3662 /*
3663 * From spc4r17 section 6.14:
3664 *
3665 * If the SPEC_I_PT bit is set to zero, the service action is not
3666 * REGISTER AND MOVE, and the parameter list length is not 24, then
3667 * the command shall be terminated with CHECK CONDITION status, with
3668 * the sense key set to ILLEGAL REQUEST, and the additional sense
3669 * code set to PARAMETER LIST LENGTH ERROR.
3670 */
3671 if (!spec_i_pt && (sa != PRO_REGISTER_AND_MOVE) &&
3672 (cmd->data_length != 24)) {
3673 pr_warn("SPC-PR: Received PR OUT illegal parameter"
3674 " list length: %u\n", cmd->data_length);
3675 return TCM_PARAMETER_LIST_LENGTH_ERROR;
3676 }
3677
3678 if (dev->transport_flags & TRANSPORT_FLAG_PASSTHROUGH_PGR) {
3679 ret = target_try_pr_out_pt(cmd, sa, res_key, sa_res_key, type,
3680 aptpl, all_tg_pt, spec_i_pt);
3681 goto done;
3682 }
3683
3684 /*
3685 * (core_scsi3_emulate_pro_* function parameters
3686 * are defined by spc4r17 Table 174:
3687 * PERSISTENT_RESERVE_OUT service actions and valid parameters.
3688 */
3689 switch (sa) {
3690 case PRO_REGISTER:
3691 ret = core_scsi3_emulate_pro_register(cmd,
3692 res_key, sa_res_key, aptpl, all_tg_pt, spec_i_pt, REGISTER);
3693 break;
3694 case PRO_RESERVE:
3695 ret = core_scsi3_emulate_pro_reserve(cmd, type, scope, res_key);
3696 break;
3697 case PRO_RELEASE:
3698 ret = core_scsi3_emulate_pro_release(cmd, type, scope, res_key);
3699 break;
3700 case PRO_CLEAR:
3701 ret = core_scsi3_emulate_pro_clear(cmd, res_key);
3702 break;
3703 case PRO_PREEMPT:
3704 ret = core_scsi3_emulate_pro_preempt(cmd, type, scope,
3705 res_key, sa_res_key, PREEMPT);
3706 break;
3707 case PRO_PREEMPT_AND_ABORT:
3708 ret = core_scsi3_emulate_pro_preempt(cmd, type, scope,
3709 res_key, sa_res_key, PREEMPT_AND_ABORT);
3710 break;
3711 case PRO_REGISTER_AND_IGNORE_EXISTING_KEY:
3712 ret = core_scsi3_emulate_pro_register(cmd,
3713 0, sa_res_key, aptpl, all_tg_pt, spec_i_pt, REGISTER_AND_IGNORE_EXISTING_KEY);
3714 break;
3715 case PRO_REGISTER_AND_MOVE:
3716 ret = core_scsi3_emulate_pro_register_and_move(cmd, res_key,
3717 sa_res_key, aptpl, unreg);
3718 break;
3719 default:
3720 pr_err("Unknown PERSISTENT_RESERVE_OUT service"
3721 " action: 0x%02x\n", sa);
3722 return TCM_INVALID_CDB_FIELD;
3723 }
3724
3725 done:
3726 if (!ret)
3727 target_complete_cmd(cmd, SAM_STAT_GOOD);
3728 return ret;
3729 }
3730
3731 /*
3732 * PERSISTENT_RESERVE_IN Service Action READ_KEYS
3733 *
3734 * See spc4r17 section 5.7.6.2 and section 6.13.2, Table 160
3735 */
3736 static sense_reason_t
core_scsi3_pri_read_keys(struct se_cmd * cmd)3737 core_scsi3_pri_read_keys(struct se_cmd *cmd)
3738 {
3739 struct se_device *dev = cmd->se_dev;
3740 struct t10_pr_registration *pr_reg;
3741 unsigned char *buf;
3742 u32 add_len = 0, off = 8;
3743
3744 if (cmd->data_length < 8) {
3745 pr_err("PRIN SA READ_KEYS SCSI Data Length: %u"
3746 " too small\n", cmd->data_length);
3747 return TCM_INVALID_CDB_FIELD;
3748 }
3749
3750 buf = transport_kmap_data_sg(cmd);
3751 if (!buf)
3752 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3753
3754 put_unaligned_be32(dev->t10_pr.pr_generation, buf);
3755
3756 spin_lock(&dev->t10_pr.registration_lock);
3757 list_for_each_entry(pr_reg, &dev->t10_pr.registration_list,
3758 pr_reg_list) {
3759 /*
3760 * Check for overflow of 8byte PRI READ_KEYS payload and
3761 * next reservation key list descriptor.
3762 */
3763 if (off + 8 <= cmd->data_length) {
3764 put_unaligned_be64(pr_reg->pr_res_key, &buf[off]);
3765 off += 8;
3766 }
3767 /*
3768 * SPC5r17: 6.16.2 READ KEYS service action
3769 * The ADDITIONAL LENGTH field indicates the number of bytes in
3770 * the Reservation key list. The contents of the ADDITIONAL
3771 * LENGTH field are not altered based on the allocation length
3772 */
3773 add_len += 8;
3774 }
3775 spin_unlock(&dev->t10_pr.registration_lock);
3776
3777 put_unaligned_be32(add_len, &buf[4]);
3778 target_set_cmd_data_length(cmd, 8 + add_len);
3779
3780 transport_kunmap_data_sg(cmd);
3781
3782 return 0;
3783 }
3784
3785 /*
3786 * PERSISTENT_RESERVE_IN Service Action READ_RESERVATION
3787 *
3788 * See spc4r17 section 5.7.6.3 and section 6.13.3.2 Table 161 and 162
3789 */
3790 static sense_reason_t
core_scsi3_pri_read_reservation(struct se_cmd * cmd)3791 core_scsi3_pri_read_reservation(struct se_cmd *cmd)
3792 {
3793 struct se_device *dev = cmd->se_dev;
3794 struct t10_pr_registration *pr_reg;
3795 unsigned char *buf;
3796 u64 pr_res_key;
3797 u32 add_len = 0;
3798
3799 if (cmd->data_length < 8) {
3800 pr_err("PRIN SA READ_RESERVATIONS SCSI Data Length: %u"
3801 " too small\n", cmd->data_length);
3802 return TCM_INVALID_CDB_FIELD;
3803 }
3804
3805 buf = transport_kmap_data_sg(cmd);
3806 if (!buf)
3807 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3808
3809 put_unaligned_be32(dev->t10_pr.pr_generation, &buf[0]);
3810
3811 spin_lock(&dev->dev_reservation_lock);
3812 pr_reg = dev->dev_pr_res_holder;
3813 if (pr_reg) {
3814 /*
3815 * Set the Additional Length to 16 when a reservation is held
3816 */
3817 add_len = 16;
3818 put_unaligned_be32(add_len, &buf[4]);
3819
3820 if (cmd->data_length < 22)
3821 goto err;
3822
3823 /*
3824 * Set the Reservation key.
3825 *
3826 * From spc4r17, section 5.7.10:
3827 * A persistent reservation holder has its reservation key
3828 * returned in the parameter data from a PERSISTENT
3829 * RESERVE IN command with READ RESERVATION service action as
3830 * follows:
3831 * a) For a persistent reservation of the type Write Exclusive
3832 * - All Registrants or Exclusive Access All Regitrants,
3833 * the reservation key shall be set to zero; or
3834 * b) For all other persistent reservation types, the
3835 * reservation key shall be set to the registered
3836 * reservation key for the I_T nexus that holds the
3837 * persistent reservation.
3838 */
3839 if ((pr_reg->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG) ||
3840 (pr_reg->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG))
3841 pr_res_key = 0;
3842 else
3843 pr_res_key = pr_reg->pr_res_key;
3844
3845 put_unaligned_be64(pr_res_key, &buf[8]);
3846 /*
3847 * Set the SCOPE and TYPE
3848 */
3849 buf[21] = (pr_reg->pr_res_scope & 0xf0) |
3850 (pr_reg->pr_res_type & 0x0f);
3851 }
3852
3853 target_set_cmd_data_length(cmd, 8 + add_len);
3854
3855 err:
3856 spin_unlock(&dev->dev_reservation_lock);
3857 transport_kunmap_data_sg(cmd);
3858
3859 return 0;
3860 }
3861
3862 /*
3863 * PERSISTENT_RESERVE_IN Service Action REPORT_CAPABILITIES
3864 *
3865 * See spc4r17 section 6.13.4 Table 165
3866 */
3867 static sense_reason_t
core_scsi3_pri_report_capabilities(struct se_cmd * cmd)3868 core_scsi3_pri_report_capabilities(struct se_cmd *cmd)
3869 {
3870 struct se_device *dev = cmd->se_dev;
3871 struct t10_reservation *pr_tmpl = &dev->t10_pr;
3872 unsigned char *buf;
3873 u16 len = 8; /* Hardcoded to 8. */
3874
3875 if (cmd->data_length < 6) {
3876 pr_err("PRIN SA REPORT_CAPABILITIES SCSI Data Length:"
3877 " %u too small\n", cmd->data_length);
3878 return TCM_INVALID_CDB_FIELD;
3879 }
3880
3881 buf = transport_kmap_data_sg(cmd);
3882 if (!buf)
3883 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3884
3885 put_unaligned_be16(len, &buf[0]);
3886 buf[2] |= 0x10; /* CRH: Compatible Reservation Hanlding bit. */
3887 buf[2] |= 0x08; /* SIP_C: Specify Initiator Ports Capable bit */
3888 buf[2] |= 0x04; /* ATP_C: All Target Ports Capable bit */
3889 buf[2] |= 0x01; /* PTPL_C: Persistence across Target Power Loss bit */
3890 /*
3891 * We are filling in the PERSISTENT RESERVATION TYPE MASK below, so
3892 * set the TMV: Task Mask Valid bit.
3893 */
3894 buf[3] |= 0x80;
3895 /*
3896 * Change ALLOW COMMANDs to 0x20 or 0x40 later from Table 166
3897 */
3898 buf[3] |= 0x10; /* ALLOW COMMANDs field 001b */
3899 /*
3900 * PTPL_A: Persistence across Target Power Loss Active bit
3901 */
3902 if (pr_tmpl->pr_aptpl_active)
3903 buf[3] |= 0x01;
3904 /*
3905 * Setup the PERSISTENT RESERVATION TYPE MASK from Table 167
3906 */
3907 buf[4] |= 0x80; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3908 buf[4] |= 0x40; /* PR_TYPE_EXCLUSIVE_ACCESS_REGONLY */
3909 buf[4] |= 0x20; /* PR_TYPE_WRITE_EXCLUSIVE_REGONLY */
3910 buf[4] |= 0x08; /* PR_TYPE_EXCLUSIVE_ACCESS */
3911 buf[4] |= 0x02; /* PR_TYPE_WRITE_EXCLUSIVE */
3912 buf[5] |= 0x01; /* PR_TYPE_EXCLUSIVE_ACCESS_ALLREG */
3913
3914 target_set_cmd_data_length(cmd, len);
3915
3916 transport_kunmap_data_sg(cmd);
3917
3918 return 0;
3919 }
3920
3921 /*
3922 * PERSISTENT_RESERVE_IN Service Action READ_FULL_STATUS
3923 *
3924 * See spc4r17 section 6.13.5 Table 168 and 169
3925 */
3926 static sense_reason_t
core_scsi3_pri_read_full_status(struct se_cmd * cmd)3927 core_scsi3_pri_read_full_status(struct se_cmd *cmd)
3928 {
3929 struct se_device *dev = cmd->se_dev;
3930 struct se_node_acl *se_nacl;
3931 struct se_portal_group *se_tpg;
3932 struct t10_pr_registration *pr_reg, *pr_reg_tmp;
3933 struct t10_reservation *pr_tmpl = &dev->t10_pr;
3934 unsigned char *buf;
3935 u32 add_desc_len = 0, add_len = 0;
3936 u32 off = 8; /* off into first Full Status descriptor */
3937 int format_code = 0, pr_res_type = 0, pr_res_scope = 0;
3938 int exp_desc_len, desc_len;
3939 bool all_reg = false;
3940
3941 if (cmd->data_length < 8) {
3942 pr_err("PRIN SA READ_FULL_STATUS SCSI Data Length: %u"
3943 " too small\n", cmd->data_length);
3944 return TCM_INVALID_CDB_FIELD;
3945 }
3946
3947 buf = transport_kmap_data_sg(cmd);
3948 if (!buf)
3949 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
3950
3951 put_unaligned_be32(dev->t10_pr.pr_generation, &buf[0]);
3952
3953 spin_lock(&dev->dev_reservation_lock);
3954 if (dev->dev_pr_res_holder) {
3955 struct t10_pr_registration *pr_holder = dev->dev_pr_res_holder;
3956
3957 if (pr_holder->pr_res_type == PR_TYPE_WRITE_EXCLUSIVE_ALLREG ||
3958 pr_holder->pr_res_type == PR_TYPE_EXCLUSIVE_ACCESS_ALLREG) {
3959 all_reg = true;
3960 pr_res_type = pr_holder->pr_res_type;
3961 pr_res_scope = pr_holder->pr_res_scope;
3962 }
3963 }
3964 spin_unlock(&dev->dev_reservation_lock);
3965
3966 spin_lock(&pr_tmpl->registration_lock);
3967 list_for_each_entry_safe(pr_reg, pr_reg_tmp,
3968 &pr_tmpl->registration_list, pr_reg_list) {
3969
3970 se_nacl = pr_reg->pr_reg_nacl;
3971 se_tpg = pr_reg->pr_reg_nacl->se_tpg;
3972 add_desc_len = 0;
3973
3974 atomic_inc_mb(&pr_reg->pr_res_holders);
3975 spin_unlock(&pr_tmpl->registration_lock);
3976 /*
3977 * Determine expected length of $FABRIC_MOD specific
3978 * TransportID full status descriptor..
3979 */
3980 exp_desc_len = target_get_pr_transport_id_len(se_nacl, pr_reg,
3981 &format_code);
3982 if (exp_desc_len < 0 ||
3983 exp_desc_len + add_len > cmd->data_length) {
3984 pr_warn("SPC-3 PRIN READ_FULL_STATUS ran"
3985 " out of buffer: %d\n", cmd->data_length);
3986 spin_lock(&pr_tmpl->registration_lock);
3987 atomic_dec_mb(&pr_reg->pr_res_holders);
3988 break;
3989 }
3990 /*
3991 * Set RESERVATION KEY
3992 */
3993 put_unaligned_be64(pr_reg->pr_res_key, &buf[off]);
3994 off += 8;
3995 off += 4; /* Skip Over Reserved area */
3996
3997 /*
3998 * Set ALL_TG_PT bit if PROUT SA REGISTER had this set.
3999 */
4000 if (pr_reg->pr_reg_all_tg_pt)
4001 buf[off] = 0x02;
4002 /*
4003 * The struct se_lun pointer will be present for the
4004 * reservation holder for PR_HOLDER bit.
4005 *
4006 * Also, if this registration is the reservation
4007 * holder or there is an All Registrants reservation
4008 * active, fill in SCOPE and TYPE in the next byte.
4009 */
4010 if (pr_reg->pr_res_holder) {
4011 buf[off++] |= 0x01;
4012 buf[off++] = (pr_reg->pr_res_scope & 0xf0) |
4013 (pr_reg->pr_res_type & 0x0f);
4014 } else if (all_reg) {
4015 buf[off++] |= 0x01;
4016 buf[off++] = (pr_res_scope & 0xf0) |
4017 (pr_res_type & 0x0f);
4018 } else {
4019 off += 2;
4020 }
4021
4022 off += 4; /* Skip over reserved area */
4023 /*
4024 * From spc4r17 6.3.15:
4025 *
4026 * If the ALL_TG_PT bit set to zero, the RELATIVE TARGET PORT
4027 * IDENTIFIER field contains the relative port identifier (see
4028 * 3.1.120) of the target port that is part of the I_T nexus
4029 * described by this full status descriptor. If the ALL_TG_PT
4030 * bit is set to one, the contents of the RELATIVE TARGET PORT
4031 * IDENTIFIER field are not defined by this standard.
4032 */
4033 if (!pr_reg->pr_reg_all_tg_pt) {
4034 u16 sep_rtpi = pr_reg->tg_pt_sep_rtpi;
4035
4036 put_unaligned_be16(sep_rtpi, &buf[off]);
4037 off += 2;
4038 } else
4039 off += 2; /* Skip over RELATIVE TARGET PORT IDENTIFIER */
4040
4041 buf[off+4] = se_tpg->proto_id;
4042
4043 /*
4044 * Now, have the $FABRIC_MOD fill in the transport ID.
4045 */
4046 desc_len = target_get_pr_transport_id(se_nacl, pr_reg,
4047 &format_code, &buf[off+4]);
4048
4049 spin_lock(&pr_tmpl->registration_lock);
4050 atomic_dec_mb(&pr_reg->pr_res_holders);
4051
4052 if (desc_len < 0)
4053 break;
4054 /*
4055 * Set the ADDITIONAL DESCRIPTOR LENGTH
4056 */
4057 put_unaligned_be32(desc_len, &buf[off]);
4058 off += 4;
4059 /*
4060 * Size of full desctipor header minus TransportID
4061 * containing $FABRIC_MOD specific) initiator device/port
4062 * WWN information.
4063 *
4064 * See spc4r17 Section 6.13.5 Table 169
4065 */
4066 add_desc_len = (24 + desc_len);
4067
4068 off += desc_len;
4069 add_len += add_desc_len;
4070 }
4071 spin_unlock(&pr_tmpl->registration_lock);
4072 /*
4073 * Set ADDITIONAL_LENGTH
4074 */
4075 put_unaligned_be32(add_len, &buf[4]);
4076 target_set_cmd_data_length(cmd, 8 + add_len);
4077
4078 transport_kunmap_data_sg(cmd);
4079
4080 return 0;
4081 }
4082
target_try_pr_in_pt(struct se_cmd * cmd,u8 sa)4083 static sense_reason_t target_try_pr_in_pt(struct se_cmd *cmd, u8 sa)
4084 {
4085 struct exec_cmd_ops *ops = cmd->protocol_data;
4086 unsigned char *buf;
4087 sense_reason_t ret;
4088
4089 if (cmd->data_length < 8) {
4090 pr_err("PRIN SA SCSI Data Length: %u too small\n",
4091 cmd->data_length);
4092 return TCM_INVALID_CDB_FIELD;
4093 }
4094
4095 if (!ops->execute_pr_in) {
4096 pr_err("SPC-3 PR: Device has been configured for PR passthrough but it's not supported by the backend.\n");
4097 return TCM_UNSUPPORTED_SCSI_OPCODE;
4098 }
4099
4100 if (sa == PRI_READ_FULL_STATUS) {
4101 pr_err("SPC-3 PR: PRI_READ_FULL_STATUS is not supported by PR passthrough.\n");
4102 return TCM_UNSUPPORTED_SCSI_OPCODE;
4103 }
4104
4105 buf = transport_kmap_data_sg(cmd);
4106 if (!buf)
4107 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
4108
4109 ret = ops->execute_pr_in(cmd, sa, buf);
4110
4111 transport_kunmap_data_sg(cmd);
4112 return ret;
4113 }
4114
4115 sense_reason_t
target_scsi3_emulate_pr_in(struct se_cmd * cmd)4116 target_scsi3_emulate_pr_in(struct se_cmd *cmd)
4117 {
4118 u8 sa = cmd->t_task_cdb[1] & 0x1f;
4119 sense_reason_t ret;
4120
4121 /*
4122 * Following spc2r20 5.5.1 Reservations overview:
4123 *
4124 * If a logical unit has been reserved by any RESERVE command and is
4125 * still reserved by any initiator, all PERSISTENT RESERVE IN and all
4126 * PERSISTENT RESERVE OUT commands shall conflict regardless of
4127 * initiator or service action and shall terminate with a RESERVATION
4128 * CONFLICT status.
4129 */
4130 if (cmd->se_dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS) {
4131 pr_err("Received PERSISTENT_RESERVE CDB while legacy"
4132 " SPC-2 reservation is held, returning"
4133 " RESERVATION_CONFLICT\n");
4134 return TCM_RESERVATION_CONFLICT;
4135 }
4136
4137 if (cmd->se_dev->transport_flags & TRANSPORT_FLAG_PASSTHROUGH_PGR) {
4138 ret = target_try_pr_in_pt(cmd, sa);
4139 goto done;
4140 }
4141
4142 switch (sa) {
4143 case PRI_READ_KEYS:
4144 ret = core_scsi3_pri_read_keys(cmd);
4145 break;
4146 case PRI_READ_RESERVATION:
4147 ret = core_scsi3_pri_read_reservation(cmd);
4148 break;
4149 case PRI_REPORT_CAPABILITIES:
4150 ret = core_scsi3_pri_report_capabilities(cmd);
4151 break;
4152 case PRI_READ_FULL_STATUS:
4153 ret = core_scsi3_pri_read_full_status(cmd);
4154 break;
4155 default:
4156 pr_err("Unknown PERSISTENT_RESERVE_IN service"
4157 " action: 0x%02x\n", cmd->t_task_cdb[1] & 0x1f);
4158 return TCM_INVALID_CDB_FIELD;
4159 }
4160
4161 done:
4162 if (!ret)
4163 target_complete_cmd(cmd, SAM_STAT_GOOD);
4164 return ret;
4165 }
4166
4167 sense_reason_t
target_check_reservation(struct se_cmd * cmd)4168 target_check_reservation(struct se_cmd *cmd)
4169 {
4170 struct se_device *dev = cmd->se_dev;
4171 sense_reason_t ret;
4172
4173 if (!cmd->se_sess)
4174 return 0;
4175 if (dev->se_hba->hba_flags & HBA_FLAGS_INTERNAL_USE)
4176 return 0;
4177 if (!dev->dev_attrib.emulate_pr)
4178 return 0;
4179 if (dev->transport_flags & TRANSPORT_FLAG_PASSTHROUGH_PGR)
4180 return 0;
4181
4182 spin_lock(&dev->dev_reservation_lock);
4183 if (dev->dev_reservation_flags & DRF_SPC2_RESERVATIONS)
4184 ret = target_scsi2_reservation_check(cmd);
4185 else
4186 ret = target_scsi3_pr_reservation_check(cmd);
4187 spin_unlock(&dev->dev_reservation_lock);
4188
4189 return ret;
4190 }
4191