1 /*******************************************************************************
2 * Filename: target_core_xcopy.c
3 *
4 * This file contains support for SPC-4 Extended-Copy offload with generic
5 * TCM backends.
6 *
7 * Copyright (c) 2011-2013 Datera, Inc. All rights reserved.
8 *
9 * Author:
10 * Nicholas A. Bellinger <nab@daterainc.com>
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 ******************************************************************************/
23
24 #include <linux/slab.h>
25 #include <linux/spinlock.h>
26 #include <linux/list.h>
27 #include <linux/configfs.h>
28 #include <scsi/scsi_proto.h>
29 #include <asm/unaligned.h>
30
31 #include <target/target_core_base.h>
32 #include <target/target_core_backend.h>
33 #include <target/target_core_fabric.h>
34
35 #include "target_core_internal.h"
36 #include "target_core_pr.h"
37 #include "target_core_ua.h"
38 #include "target_core_xcopy.h"
39
40 static struct workqueue_struct *xcopy_wq = NULL;
41
target_xcopy_gen_naa_ieee(struct se_device * dev,unsigned char * buf)42 static int target_xcopy_gen_naa_ieee(struct se_device *dev, unsigned char *buf)
43 {
44 int off = 0;
45
46 buf[off++] = (0x6 << 4);
47 buf[off++] = 0x01;
48 buf[off++] = 0x40;
49 buf[off] = (0x5 << 4);
50
51 spc_parse_naa_6h_vendor_specific(dev, &buf[off]);
52 return 0;
53 }
54
55 /**
56 * target_xcopy_locate_se_dev_e4_iter - compare XCOPY NAA device identifiers
57 *
58 * @se_dev: device being considered for match
59 * @dev_wwn: XCOPY requested NAA dev_wwn
60 * @return: 1 on match, 0 on no-match
61 */
target_xcopy_locate_se_dev_e4_iter(struct se_device * se_dev,const unsigned char * dev_wwn)62 static int target_xcopy_locate_se_dev_e4_iter(struct se_device *se_dev,
63 const unsigned char *dev_wwn)
64 {
65 unsigned char tmp_dev_wwn[XCOPY_NAA_IEEE_REGEX_LEN];
66 int rc;
67
68 if (!se_dev->dev_attrib.emulate_3pc) {
69 pr_debug("XCOPY: emulate_3pc disabled on se_dev %p\n", se_dev);
70 return 0;
71 }
72
73 memset(&tmp_dev_wwn[0], 0, XCOPY_NAA_IEEE_REGEX_LEN);
74 target_xcopy_gen_naa_ieee(se_dev, &tmp_dev_wwn[0]);
75
76 rc = memcmp(&tmp_dev_wwn[0], dev_wwn, XCOPY_NAA_IEEE_REGEX_LEN);
77 if (rc != 0) {
78 pr_debug("XCOPY: skip non-matching: %*ph\n",
79 XCOPY_NAA_IEEE_REGEX_LEN, tmp_dev_wwn);
80 return 0;
81 }
82 pr_debug("XCOPY 0xe4: located se_dev: %p\n", se_dev);
83
84 return 1;
85 }
86
target_xcopy_locate_se_dev_e4(struct se_session * sess,const unsigned char * dev_wwn,struct se_device ** _found_dev,struct percpu_ref ** _found_lun_ref)87 static int target_xcopy_locate_se_dev_e4(struct se_session *sess,
88 const unsigned char *dev_wwn,
89 struct se_device **_found_dev,
90 struct percpu_ref **_found_lun_ref)
91 {
92 struct se_dev_entry *deve;
93 struct se_node_acl *nacl;
94 struct se_lun *this_lun = NULL;
95 struct se_device *found_dev = NULL;
96
97 /* cmd with NULL sess indicates no associated $FABRIC_MOD */
98 if (!sess)
99 goto err_out;
100
101 pr_debug("XCOPY 0xe4: searching for: %*ph\n",
102 XCOPY_NAA_IEEE_REGEX_LEN, dev_wwn);
103
104 nacl = sess->se_node_acl;
105 rcu_read_lock();
106 hlist_for_each_entry_rcu(deve, &nacl->lun_entry_hlist, link) {
107 struct se_device *this_dev;
108 int rc;
109
110 this_lun = rcu_dereference(deve->se_lun);
111 this_dev = rcu_dereference_raw(this_lun->lun_se_dev);
112
113 rc = target_xcopy_locate_se_dev_e4_iter(this_dev, dev_wwn);
114 if (rc) {
115 if (percpu_ref_tryget_live(&this_lun->lun_ref))
116 found_dev = this_dev;
117 break;
118 }
119 }
120 rcu_read_unlock();
121 if (found_dev == NULL)
122 goto err_out;
123
124 pr_debug("lun_ref held for se_dev: %p se_dev->se_dev_group: %p\n",
125 found_dev, &found_dev->dev_group);
126 *_found_dev = found_dev;
127 *_found_lun_ref = &this_lun->lun_ref;
128 return 0;
129 err_out:
130 pr_debug_ratelimited("Unable to locate 0xe4 descriptor for EXTENDED_COPY\n");
131 return -EINVAL;
132 }
133
target_xcopy_parse_tiddesc_e4(struct se_cmd * se_cmd,struct xcopy_op * xop,unsigned char * p,unsigned short cscd_index)134 static int target_xcopy_parse_tiddesc_e4(struct se_cmd *se_cmd, struct xcopy_op *xop,
135 unsigned char *p, unsigned short cscd_index)
136 {
137 unsigned char *desc = p;
138 unsigned short ript;
139 u8 desig_len;
140 /*
141 * Extract RELATIVE INITIATOR PORT IDENTIFIER
142 */
143 ript = get_unaligned_be16(&desc[2]);
144 pr_debug("XCOPY 0xe4: RELATIVE INITIATOR PORT IDENTIFIER: %hu\n", ript);
145 /*
146 * Check for supported code set, association, and designator type
147 */
148 if ((desc[4] & 0x0f) != 0x1) {
149 pr_err("XCOPY 0xe4: code set of non binary type not supported\n");
150 return -EINVAL;
151 }
152 if ((desc[5] & 0x30) != 0x00) {
153 pr_err("XCOPY 0xe4: association other than LUN not supported\n");
154 return -EINVAL;
155 }
156 if ((desc[5] & 0x0f) != 0x3) {
157 pr_err("XCOPY 0xe4: designator type unsupported: 0x%02x\n",
158 (desc[5] & 0x0f));
159 return -EINVAL;
160 }
161 /*
162 * Check for matching 16 byte length for NAA IEEE Registered Extended
163 * Assigned designator
164 */
165 desig_len = desc[7];
166 if (desig_len != 16) {
167 pr_err("XCOPY 0xe4: invalid desig_len: %d\n", (int)desig_len);
168 return -EINVAL;
169 }
170 pr_debug("XCOPY 0xe4: desig_len: %d\n", (int)desig_len);
171 /*
172 * Check for NAA IEEE Registered Extended Assigned header..
173 */
174 if ((desc[8] & 0xf0) != 0x60) {
175 pr_err("XCOPY 0xe4: Unsupported DESIGNATOR TYPE: 0x%02x\n",
176 (desc[8] & 0xf0));
177 return -EINVAL;
178 }
179
180 if (cscd_index != xop->stdi && cscd_index != xop->dtdi) {
181 pr_debug("XCOPY 0xe4: ignoring CSCD entry %d - neither src nor "
182 "dest\n", cscd_index);
183 return 0;
184 }
185
186 if (cscd_index == xop->stdi) {
187 memcpy(&xop->src_tid_wwn[0], &desc[8], XCOPY_NAA_IEEE_REGEX_LEN);
188 /*
189 * Determine if the source designator matches the local device
190 */
191 if (!memcmp(&xop->local_dev_wwn[0], &xop->src_tid_wwn[0],
192 XCOPY_NAA_IEEE_REGEX_LEN)) {
193 xop->op_origin = XCOL_SOURCE_RECV_OP;
194 xop->src_dev = se_cmd->se_dev;
195 pr_debug("XCOPY 0xe4: Set xop->src_dev %p from source"
196 " received xop\n", xop->src_dev);
197 }
198 }
199
200 if (cscd_index == xop->dtdi) {
201 memcpy(&xop->dst_tid_wwn[0], &desc[8], XCOPY_NAA_IEEE_REGEX_LEN);
202 /*
203 * Determine if the destination designator matches the local
204 * device. If @cscd_index corresponds to both source (stdi) and
205 * destination (dtdi), or dtdi comes after stdi, then
206 * XCOL_DEST_RECV_OP wins.
207 */
208 if (!memcmp(&xop->local_dev_wwn[0], &xop->dst_tid_wwn[0],
209 XCOPY_NAA_IEEE_REGEX_LEN)) {
210 xop->op_origin = XCOL_DEST_RECV_OP;
211 xop->dst_dev = se_cmd->se_dev;
212 pr_debug("XCOPY 0xe4: Set xop->dst_dev: %p from destination"
213 " received xop\n", xop->dst_dev);
214 }
215 }
216
217 return 0;
218 }
219
target_xcopy_parse_target_descriptors(struct se_cmd * se_cmd,struct xcopy_op * xop,unsigned char * p,unsigned short tdll,sense_reason_t * sense_ret)220 static int target_xcopy_parse_target_descriptors(struct se_cmd *se_cmd,
221 struct xcopy_op *xop, unsigned char *p,
222 unsigned short tdll, sense_reason_t *sense_ret)
223 {
224 struct se_device *local_dev = se_cmd->se_dev;
225 unsigned char *desc = p;
226 int offset = tdll % XCOPY_TARGET_DESC_LEN, rc;
227 unsigned short cscd_index = 0;
228 unsigned short start = 0;
229
230 *sense_ret = TCM_INVALID_PARAMETER_LIST;
231
232 if (offset != 0) {
233 pr_err("XCOPY target descriptor list length is not"
234 " multiple of %d\n", XCOPY_TARGET_DESC_LEN);
235 return -EINVAL;
236 }
237 if (tdll > 64) {
238 pr_err("XCOPY target descriptor supports a maximum"
239 " two src/dest descriptors, tdll: %hu too large..\n", tdll);
240 return -EINVAL;
241 }
242 /*
243 * Generate an IEEE Registered Extended designator based upon the
244 * se_device the XCOPY was received upon..
245 */
246 memset(&xop->local_dev_wwn[0], 0, XCOPY_NAA_IEEE_REGEX_LEN);
247 target_xcopy_gen_naa_ieee(local_dev, &xop->local_dev_wwn[0]);
248
249 while (start < tdll) {
250 /*
251 * Check target descriptor identification with 0xE4 type, and
252 * compare the current index with the CSCD descriptor IDs in
253 * the segment descriptor. Use VPD 0x83 WWPN matching ..
254 */
255 switch (desc[0]) {
256 case 0xe4:
257 rc = target_xcopy_parse_tiddesc_e4(se_cmd, xop,
258 &desc[0], cscd_index);
259 if (rc != 0)
260 goto out;
261 start += XCOPY_TARGET_DESC_LEN;
262 desc += XCOPY_TARGET_DESC_LEN;
263 cscd_index++;
264 break;
265 default:
266 pr_err("XCOPY unsupported descriptor type code:"
267 " 0x%02x\n", desc[0]);
268 goto out;
269 }
270 }
271
272 switch (xop->op_origin) {
273 case XCOL_SOURCE_RECV_OP:
274 rc = target_xcopy_locate_se_dev_e4(se_cmd->se_sess,
275 xop->dst_tid_wwn,
276 &xop->dst_dev,
277 &xop->remote_lun_ref);
278 break;
279 case XCOL_DEST_RECV_OP:
280 rc = target_xcopy_locate_se_dev_e4(se_cmd->se_sess,
281 xop->src_tid_wwn,
282 &xop->src_dev,
283 &xop->remote_lun_ref);
284 break;
285 default:
286 pr_err("XCOPY CSCD descriptor IDs not found in CSCD list - "
287 "stdi: %hu dtdi: %hu\n", xop->stdi, xop->dtdi);
288 rc = -EINVAL;
289 break;
290 }
291 /*
292 * If a matching IEEE NAA 0x83 descriptor for the requested device
293 * is not located on this node, return COPY_ABORTED with ASQ/ASQC
294 * 0x0d/0x02 - COPY_TARGET_DEVICE_NOT_REACHABLE to request the
295 * initiator to fall back to normal copy method.
296 */
297 if (rc < 0) {
298 *sense_ret = TCM_COPY_TARGET_DEVICE_NOT_REACHABLE;
299 goto out;
300 }
301
302 pr_debug("XCOPY TGT desc: Source dev: %p NAA IEEE WWN: 0x%16phN\n",
303 xop->src_dev, &xop->src_tid_wwn[0]);
304 pr_debug("XCOPY TGT desc: Dest dev: %p NAA IEEE WWN: 0x%16phN\n",
305 xop->dst_dev, &xop->dst_tid_wwn[0]);
306
307 return cscd_index;
308
309 out:
310 return -EINVAL;
311 }
312
target_xcopy_parse_segdesc_02(struct se_cmd * se_cmd,struct xcopy_op * xop,unsigned char * p)313 static int target_xcopy_parse_segdesc_02(struct se_cmd *se_cmd, struct xcopy_op *xop,
314 unsigned char *p)
315 {
316 unsigned char *desc = p;
317 int dc = (desc[1] & 0x02);
318 unsigned short desc_len;
319
320 desc_len = get_unaligned_be16(&desc[2]);
321 if (desc_len != 0x18) {
322 pr_err("XCOPY segment desc 0x02: Illegal desc_len:"
323 " %hu\n", desc_len);
324 return -EINVAL;
325 }
326
327 xop->stdi = get_unaligned_be16(&desc[4]);
328 xop->dtdi = get_unaligned_be16(&desc[6]);
329 pr_debug("XCOPY seg desc 0x02: desc_len: %hu stdi: %hu dtdi: %hu, DC: %d\n",
330 desc_len, xop->stdi, xop->dtdi, dc);
331
332 xop->nolb = get_unaligned_be16(&desc[10]);
333 xop->src_lba = get_unaligned_be64(&desc[12]);
334 xop->dst_lba = get_unaligned_be64(&desc[20]);
335 pr_debug("XCOPY seg desc 0x02: nolb: %hu src_lba: %llu dst_lba: %llu\n",
336 xop->nolb, (unsigned long long)xop->src_lba,
337 (unsigned long long)xop->dst_lba);
338
339 if (dc != 0) {
340 xop->dbl = (desc[29] & 0xff) << 16;
341 xop->dbl |= (desc[30] & 0xff) << 8;
342 xop->dbl |= desc[31] & 0xff;
343
344 pr_debug("XCOPY seg desc 0x02: DC=1 w/ dbl: %u\n", xop->dbl);
345 }
346 return 0;
347 }
348
target_xcopy_parse_segment_descriptors(struct se_cmd * se_cmd,struct xcopy_op * xop,unsigned char * p,unsigned int sdll,sense_reason_t * sense_ret)349 static int target_xcopy_parse_segment_descriptors(struct se_cmd *se_cmd,
350 struct xcopy_op *xop, unsigned char *p,
351 unsigned int sdll, sense_reason_t *sense_ret)
352 {
353 unsigned char *desc = p;
354 unsigned int start = 0;
355 int offset = sdll % XCOPY_SEGMENT_DESC_LEN, rc, ret = 0;
356
357 *sense_ret = TCM_INVALID_PARAMETER_LIST;
358
359 if (offset != 0) {
360 pr_err("XCOPY segment descriptor list length is not"
361 " multiple of %d\n", XCOPY_SEGMENT_DESC_LEN);
362 return -EINVAL;
363 }
364 if (sdll > RCR_OP_MAX_SG_DESC_COUNT * XCOPY_SEGMENT_DESC_LEN) {
365 pr_err("XCOPY supports %u segment descriptor(s), sdll: %u too"
366 " large..\n", RCR_OP_MAX_SG_DESC_COUNT, sdll);
367 /* spc4r37 6.4.3.5 SEGMENT DESCRIPTOR LIST LENGTH field */
368 *sense_ret = TCM_TOO_MANY_SEGMENT_DESCS;
369 return -EINVAL;
370 }
371
372 while (start < sdll) {
373 /*
374 * Check segment descriptor type code for block -> block
375 */
376 switch (desc[0]) {
377 case 0x02:
378 rc = target_xcopy_parse_segdesc_02(se_cmd, xop, desc);
379 if (rc < 0)
380 goto out;
381
382 ret++;
383 start += XCOPY_SEGMENT_DESC_LEN;
384 desc += XCOPY_SEGMENT_DESC_LEN;
385 break;
386 default:
387 pr_err("XCOPY unsupported segment descriptor"
388 "type: 0x%02x\n", desc[0]);
389 goto out;
390 }
391 }
392
393 return ret;
394
395 out:
396 return -EINVAL;
397 }
398
399 /*
400 * Start xcopy_pt ops
401 */
402
403 struct xcopy_pt_cmd {
404 bool remote_port;
405 struct se_cmd se_cmd;
406 struct xcopy_op *xcopy_op;
407 struct completion xpt_passthrough_sem;
408 unsigned char sense_buffer[TRANSPORT_SENSE_BUFFER];
409 };
410
411 struct se_portal_group xcopy_pt_tpg;
412 static struct se_session xcopy_pt_sess;
413 static struct se_node_acl xcopy_pt_nacl;
414
xcopy_pt_get_fabric_name(void)415 static char *xcopy_pt_get_fabric_name(void)
416 {
417 return "xcopy-pt";
418 }
419
xcopy_pt_get_cmd_state(struct se_cmd * se_cmd)420 static int xcopy_pt_get_cmd_state(struct se_cmd *se_cmd)
421 {
422 return 0;
423 }
424
xcopy_pt_undepend_remotedev(struct xcopy_op * xop)425 static void xcopy_pt_undepend_remotedev(struct xcopy_op *xop)
426 {
427 if (xop->op_origin == XCOL_SOURCE_RECV_OP)
428 pr_debug("putting dst lun_ref for %p\n", xop->dst_dev);
429 else
430 pr_debug("putting src lun_ref for %p\n", xop->src_dev);
431
432 percpu_ref_put(xop->remote_lun_ref);
433 }
434
xcopy_pt_release_cmd(struct se_cmd * se_cmd)435 static void xcopy_pt_release_cmd(struct se_cmd *se_cmd)
436 {
437 struct xcopy_pt_cmd *xpt_cmd = container_of(se_cmd,
438 struct xcopy_pt_cmd, se_cmd);
439
440 kfree(xpt_cmd);
441 }
442
xcopy_pt_check_stop_free(struct se_cmd * se_cmd)443 static int xcopy_pt_check_stop_free(struct se_cmd *se_cmd)
444 {
445 struct xcopy_pt_cmd *xpt_cmd = container_of(se_cmd,
446 struct xcopy_pt_cmd, se_cmd);
447
448 complete(&xpt_cmd->xpt_passthrough_sem);
449 return 0;
450 }
451
xcopy_pt_write_pending(struct se_cmd * se_cmd)452 static int xcopy_pt_write_pending(struct se_cmd *se_cmd)
453 {
454 return 0;
455 }
456
xcopy_pt_write_pending_status(struct se_cmd * se_cmd)457 static int xcopy_pt_write_pending_status(struct se_cmd *se_cmd)
458 {
459 return 0;
460 }
461
xcopy_pt_queue_data_in(struct se_cmd * se_cmd)462 static int xcopy_pt_queue_data_in(struct se_cmd *se_cmd)
463 {
464 return 0;
465 }
466
xcopy_pt_queue_status(struct se_cmd * se_cmd)467 static int xcopy_pt_queue_status(struct se_cmd *se_cmd)
468 {
469 return 0;
470 }
471
472 static const struct target_core_fabric_ops xcopy_pt_tfo = {
473 .get_fabric_name = xcopy_pt_get_fabric_name,
474 .get_cmd_state = xcopy_pt_get_cmd_state,
475 .release_cmd = xcopy_pt_release_cmd,
476 .check_stop_free = xcopy_pt_check_stop_free,
477 .write_pending = xcopy_pt_write_pending,
478 .write_pending_status = xcopy_pt_write_pending_status,
479 .queue_data_in = xcopy_pt_queue_data_in,
480 .queue_status = xcopy_pt_queue_status,
481 };
482
483 /*
484 * End xcopy_pt_ops
485 */
486
target_xcopy_setup_pt(void)487 int target_xcopy_setup_pt(void)
488 {
489 xcopy_wq = alloc_workqueue("xcopy_wq", WQ_MEM_RECLAIM, 0);
490 if (!xcopy_wq) {
491 pr_err("Unable to allocate xcopy_wq\n");
492 return -ENOMEM;
493 }
494
495 memset(&xcopy_pt_tpg, 0, sizeof(struct se_portal_group));
496 INIT_LIST_HEAD(&xcopy_pt_tpg.se_tpg_node);
497 INIT_LIST_HEAD(&xcopy_pt_tpg.acl_node_list);
498 INIT_LIST_HEAD(&xcopy_pt_tpg.tpg_sess_list);
499
500 xcopy_pt_tpg.se_tpg_tfo = &xcopy_pt_tfo;
501
502 memset(&xcopy_pt_nacl, 0, sizeof(struct se_node_acl));
503 INIT_LIST_HEAD(&xcopy_pt_nacl.acl_list);
504 INIT_LIST_HEAD(&xcopy_pt_nacl.acl_sess_list);
505 memset(&xcopy_pt_sess, 0, sizeof(struct se_session));
506 INIT_LIST_HEAD(&xcopy_pt_sess.sess_list);
507 INIT_LIST_HEAD(&xcopy_pt_sess.sess_acl_list);
508 INIT_LIST_HEAD(&xcopy_pt_sess.sess_cmd_list);
509 spin_lock_init(&xcopy_pt_sess.sess_cmd_lock);
510
511 xcopy_pt_nacl.se_tpg = &xcopy_pt_tpg;
512 xcopy_pt_nacl.nacl_sess = &xcopy_pt_sess;
513
514 xcopy_pt_sess.se_tpg = &xcopy_pt_tpg;
515 xcopy_pt_sess.se_node_acl = &xcopy_pt_nacl;
516
517 return 0;
518 }
519
target_xcopy_release_pt(void)520 void target_xcopy_release_pt(void)
521 {
522 if (xcopy_wq)
523 destroy_workqueue(xcopy_wq);
524 }
525
target_xcopy_setup_pt_port(struct xcopy_pt_cmd * xpt_cmd,struct xcopy_op * xop,bool remote_port)526 static void target_xcopy_setup_pt_port(
527 struct xcopy_pt_cmd *xpt_cmd,
528 struct xcopy_op *xop,
529 bool remote_port)
530 {
531 struct se_cmd *ec_cmd = xop->xop_se_cmd;
532 struct se_cmd *pt_cmd = &xpt_cmd->se_cmd;
533
534 if (xop->op_origin == XCOL_SOURCE_RECV_OP) {
535 /*
536 * Honor destination port reservations for X-COPY PUSH emulation
537 * when CDB is received on local source port, and READs blocks to
538 * WRITE on remote destination port.
539 */
540 if (remote_port) {
541 xpt_cmd->remote_port = remote_port;
542 } else {
543 pt_cmd->se_lun = ec_cmd->se_lun;
544 pt_cmd->se_dev = ec_cmd->se_dev;
545
546 pr_debug("Honoring local SRC port from ec_cmd->se_dev:"
547 " %p\n", pt_cmd->se_dev);
548 pt_cmd->se_lun = ec_cmd->se_lun;
549 pr_debug("Honoring local SRC port from ec_cmd->se_lun: %p\n",
550 pt_cmd->se_lun);
551 }
552 } else {
553 /*
554 * Honor source port reservation for X-COPY PULL emulation
555 * when CDB is received on local desintation port, and READs
556 * blocks from the remote source port to WRITE on local
557 * destination port.
558 */
559 if (remote_port) {
560 xpt_cmd->remote_port = remote_port;
561 } else {
562 pt_cmd->se_lun = ec_cmd->se_lun;
563 pt_cmd->se_dev = ec_cmd->se_dev;
564
565 pr_debug("Honoring local DST port from ec_cmd->se_dev:"
566 " %p\n", pt_cmd->se_dev);
567 pt_cmd->se_lun = ec_cmd->se_lun;
568 pr_debug("Honoring local DST port from ec_cmd->se_lun: %p\n",
569 pt_cmd->se_lun);
570 }
571 }
572 }
573
target_xcopy_init_pt_lun(struct se_device * se_dev,struct se_cmd * pt_cmd,bool remote_port)574 static void target_xcopy_init_pt_lun(struct se_device *se_dev,
575 struct se_cmd *pt_cmd, bool remote_port)
576 {
577 /*
578 * Don't allocate + init an pt_cmd->se_lun if honoring local port for
579 * reservations. The pt_cmd->se_lun pointer will be setup from within
580 * target_xcopy_setup_pt_port()
581 */
582 if (remote_port) {
583 pr_debug("Setup emulated se_dev: %p from se_dev\n",
584 pt_cmd->se_dev);
585 pt_cmd->se_lun = &se_dev->xcopy_lun;
586 pt_cmd->se_dev = se_dev;
587 }
588
589 pt_cmd->se_cmd_flags |= SCF_SE_LUN_CMD;
590 }
591
target_xcopy_setup_pt_cmd(struct xcopy_pt_cmd * xpt_cmd,struct xcopy_op * xop,struct se_device * se_dev,unsigned char * cdb,bool remote_port,bool alloc_mem)592 static int target_xcopy_setup_pt_cmd(
593 struct xcopy_pt_cmd *xpt_cmd,
594 struct xcopy_op *xop,
595 struct se_device *se_dev,
596 unsigned char *cdb,
597 bool remote_port,
598 bool alloc_mem)
599 {
600 struct se_cmd *cmd = &xpt_cmd->se_cmd;
601 sense_reason_t sense_rc;
602 int ret = 0, rc;
603 /*
604 * Setup LUN+port to honor reservations based upon xop->op_origin for
605 * X-COPY PUSH or X-COPY PULL based upon where the CDB was received.
606 */
607 target_xcopy_init_pt_lun(se_dev, cmd, remote_port);
608
609 xpt_cmd->xcopy_op = xop;
610 target_xcopy_setup_pt_port(xpt_cmd, xop, remote_port);
611
612 cmd->tag = 0;
613 sense_rc = target_setup_cmd_from_cdb(cmd, cdb);
614 if (sense_rc) {
615 ret = -EINVAL;
616 goto out;
617 }
618
619 if (alloc_mem) {
620 rc = target_alloc_sgl(&cmd->t_data_sg, &cmd->t_data_nents,
621 cmd->data_length, false);
622 if (rc < 0) {
623 ret = rc;
624 goto out;
625 }
626 /*
627 * Set this bit so that transport_free_pages() allows the
628 * caller to release SGLs + physical memory allocated by
629 * transport_generic_get_mem()..
630 */
631 cmd->se_cmd_flags |= SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
632 } else {
633 /*
634 * Here the previously allocated SGLs for the internal READ
635 * are mapped zero-copy to the internal WRITE.
636 */
637 sense_rc = transport_generic_map_mem_to_cmd(cmd,
638 xop->xop_data_sg, xop->xop_data_nents,
639 NULL, 0);
640 if (sense_rc) {
641 ret = -EINVAL;
642 goto out;
643 }
644
645 pr_debug("Setup PASSTHROUGH_NOALLOC t_data_sg: %p t_data_nents:"
646 " %u\n", cmd->t_data_sg, cmd->t_data_nents);
647 }
648
649 return 0;
650
651 out:
652 return ret;
653 }
654
target_xcopy_issue_pt_cmd(struct xcopy_pt_cmd * xpt_cmd)655 static int target_xcopy_issue_pt_cmd(struct xcopy_pt_cmd *xpt_cmd)
656 {
657 struct se_cmd *se_cmd = &xpt_cmd->se_cmd;
658 sense_reason_t sense_rc;
659
660 sense_rc = transport_generic_new_cmd(se_cmd);
661 if (sense_rc)
662 return -EINVAL;
663
664 if (se_cmd->data_direction == DMA_TO_DEVICE)
665 target_execute_cmd(se_cmd);
666
667 wait_for_completion_interruptible(&xpt_cmd->xpt_passthrough_sem);
668
669 pr_debug("target_xcopy_issue_pt_cmd(): SCSI status: 0x%02x\n",
670 se_cmd->scsi_status);
671
672 return (se_cmd->scsi_status) ? -EINVAL : 0;
673 }
674
target_xcopy_read_source(struct se_cmd * ec_cmd,struct xcopy_op * xop,struct se_device * src_dev,sector_t src_lba,u32 src_sectors)675 static int target_xcopy_read_source(
676 struct se_cmd *ec_cmd,
677 struct xcopy_op *xop,
678 struct se_device *src_dev,
679 sector_t src_lba,
680 u32 src_sectors)
681 {
682 struct xcopy_pt_cmd *xpt_cmd;
683 struct se_cmd *se_cmd;
684 u32 length = (src_sectors * src_dev->dev_attrib.block_size);
685 int rc;
686 unsigned char cdb[16];
687 bool remote_port = (xop->op_origin == XCOL_DEST_RECV_OP);
688
689 xpt_cmd = kzalloc(sizeof(struct xcopy_pt_cmd), GFP_KERNEL);
690 if (!xpt_cmd) {
691 pr_err("Unable to allocate xcopy_pt_cmd\n");
692 return -ENOMEM;
693 }
694 init_completion(&xpt_cmd->xpt_passthrough_sem);
695 se_cmd = &xpt_cmd->se_cmd;
696
697 memset(&cdb[0], 0, 16);
698 cdb[0] = READ_16;
699 put_unaligned_be64(src_lba, &cdb[2]);
700 put_unaligned_be32(src_sectors, &cdb[10]);
701 pr_debug("XCOPY: Built READ_16: LBA: %llu Sectors: %u Length: %u\n",
702 (unsigned long long)src_lba, src_sectors, length);
703
704 transport_init_se_cmd(se_cmd, &xcopy_pt_tfo, &xcopy_pt_sess, length,
705 DMA_FROM_DEVICE, 0, &xpt_cmd->sense_buffer[0]);
706 xop->src_pt_cmd = xpt_cmd;
707
708 rc = target_xcopy_setup_pt_cmd(xpt_cmd, xop, src_dev, &cdb[0],
709 remote_port, true);
710 if (rc < 0) {
711 ec_cmd->scsi_status = xpt_cmd->se_cmd.scsi_status;
712 transport_generic_free_cmd(se_cmd, 0);
713 return rc;
714 }
715
716 xop->xop_data_sg = se_cmd->t_data_sg;
717 xop->xop_data_nents = se_cmd->t_data_nents;
718 pr_debug("XCOPY-READ: Saved xop->xop_data_sg: %p, num: %u for READ"
719 " memory\n", xop->xop_data_sg, xop->xop_data_nents);
720
721 rc = target_xcopy_issue_pt_cmd(xpt_cmd);
722 if (rc < 0) {
723 ec_cmd->scsi_status = xpt_cmd->se_cmd.scsi_status;
724 transport_generic_free_cmd(se_cmd, 0);
725 return rc;
726 }
727 /*
728 * Clear off the allocated t_data_sg, that has been saved for
729 * zero-copy WRITE submission reuse in struct xcopy_op..
730 */
731 se_cmd->t_data_sg = NULL;
732 se_cmd->t_data_nents = 0;
733
734 return 0;
735 }
736
target_xcopy_write_destination(struct se_cmd * ec_cmd,struct xcopy_op * xop,struct se_device * dst_dev,sector_t dst_lba,u32 dst_sectors)737 static int target_xcopy_write_destination(
738 struct se_cmd *ec_cmd,
739 struct xcopy_op *xop,
740 struct se_device *dst_dev,
741 sector_t dst_lba,
742 u32 dst_sectors)
743 {
744 struct xcopy_pt_cmd *xpt_cmd;
745 struct se_cmd *se_cmd;
746 u32 length = (dst_sectors * dst_dev->dev_attrib.block_size);
747 int rc;
748 unsigned char cdb[16];
749 bool remote_port = (xop->op_origin == XCOL_SOURCE_RECV_OP);
750
751 xpt_cmd = kzalloc(sizeof(struct xcopy_pt_cmd), GFP_KERNEL);
752 if (!xpt_cmd) {
753 pr_err("Unable to allocate xcopy_pt_cmd\n");
754 return -ENOMEM;
755 }
756 init_completion(&xpt_cmd->xpt_passthrough_sem);
757 se_cmd = &xpt_cmd->se_cmd;
758
759 memset(&cdb[0], 0, 16);
760 cdb[0] = WRITE_16;
761 put_unaligned_be64(dst_lba, &cdb[2]);
762 put_unaligned_be32(dst_sectors, &cdb[10]);
763 pr_debug("XCOPY: Built WRITE_16: LBA: %llu Sectors: %u Length: %u\n",
764 (unsigned long long)dst_lba, dst_sectors, length);
765
766 transport_init_se_cmd(se_cmd, &xcopy_pt_tfo, &xcopy_pt_sess, length,
767 DMA_TO_DEVICE, 0, &xpt_cmd->sense_buffer[0]);
768 xop->dst_pt_cmd = xpt_cmd;
769
770 rc = target_xcopy_setup_pt_cmd(xpt_cmd, xop, dst_dev, &cdb[0],
771 remote_port, false);
772 if (rc < 0) {
773 struct se_cmd *src_cmd = &xop->src_pt_cmd->se_cmd;
774 ec_cmd->scsi_status = xpt_cmd->se_cmd.scsi_status;
775 /*
776 * If the failure happened before the t_mem_list hand-off in
777 * target_xcopy_setup_pt_cmd(), Reset memory + clear flag so that
778 * core releases this memory on error during X-COPY WRITE I/O.
779 */
780 src_cmd->se_cmd_flags &= ~SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
781 src_cmd->t_data_sg = xop->xop_data_sg;
782 src_cmd->t_data_nents = xop->xop_data_nents;
783
784 transport_generic_free_cmd(se_cmd, 0);
785 return rc;
786 }
787
788 rc = target_xcopy_issue_pt_cmd(xpt_cmd);
789 if (rc < 0) {
790 ec_cmd->scsi_status = xpt_cmd->se_cmd.scsi_status;
791 se_cmd->se_cmd_flags &= ~SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
792 transport_generic_free_cmd(se_cmd, 0);
793 return rc;
794 }
795
796 return 0;
797 }
798
target_xcopy_do_work(struct work_struct * work)799 static void target_xcopy_do_work(struct work_struct *work)
800 {
801 struct xcopy_op *xop = container_of(work, struct xcopy_op, xop_work);
802 struct se_device *src_dev = xop->src_dev, *dst_dev = xop->dst_dev;
803 struct se_cmd *ec_cmd = xop->xop_se_cmd;
804 sector_t src_lba = xop->src_lba, dst_lba = xop->dst_lba, end_lba;
805 unsigned int max_sectors;
806 int rc;
807 unsigned short nolb = xop->nolb, cur_nolb, max_nolb, copied_nolb = 0;
808
809 end_lba = src_lba + nolb;
810 /*
811 * Break up XCOPY I/O into hw_max_sectors sized I/O based on the
812 * smallest max_sectors between src_dev + dev_dev, or
813 */
814 max_sectors = min(src_dev->dev_attrib.hw_max_sectors,
815 dst_dev->dev_attrib.hw_max_sectors);
816 max_sectors = min_t(u32, max_sectors, XCOPY_MAX_SECTORS);
817
818 max_nolb = min_t(u16, max_sectors, ((u16)(~0U)));
819
820 pr_debug("target_xcopy_do_work: nolb: %hu, max_nolb: %hu end_lba: %llu\n",
821 nolb, max_nolb, (unsigned long long)end_lba);
822 pr_debug("target_xcopy_do_work: Starting src_lba: %llu, dst_lba: %llu\n",
823 (unsigned long long)src_lba, (unsigned long long)dst_lba);
824
825 while (src_lba < end_lba) {
826 cur_nolb = min(nolb, max_nolb);
827
828 pr_debug("target_xcopy_do_work: Calling read src_dev: %p src_lba: %llu,"
829 " cur_nolb: %hu\n", src_dev, (unsigned long long)src_lba, cur_nolb);
830
831 rc = target_xcopy_read_source(ec_cmd, xop, src_dev, src_lba, cur_nolb);
832 if (rc < 0)
833 goto out;
834
835 src_lba += cur_nolb;
836 pr_debug("target_xcopy_do_work: Incremented READ src_lba to %llu\n",
837 (unsigned long long)src_lba);
838
839 pr_debug("target_xcopy_do_work: Calling write dst_dev: %p dst_lba: %llu,"
840 " cur_nolb: %hu\n", dst_dev, (unsigned long long)dst_lba, cur_nolb);
841
842 rc = target_xcopy_write_destination(ec_cmd, xop, dst_dev,
843 dst_lba, cur_nolb);
844 if (rc < 0) {
845 transport_generic_free_cmd(&xop->src_pt_cmd->se_cmd, 0);
846 goto out;
847 }
848
849 dst_lba += cur_nolb;
850 pr_debug("target_xcopy_do_work: Incremented WRITE dst_lba to %llu\n",
851 (unsigned long long)dst_lba);
852
853 copied_nolb += cur_nolb;
854 nolb -= cur_nolb;
855
856 transport_generic_free_cmd(&xop->src_pt_cmd->se_cmd, 0);
857 xop->dst_pt_cmd->se_cmd.se_cmd_flags &= ~SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
858
859 transport_generic_free_cmd(&xop->dst_pt_cmd->se_cmd, 0);
860 }
861
862 xcopy_pt_undepend_remotedev(xop);
863 kfree(xop);
864
865 pr_debug("target_xcopy_do_work: Final src_lba: %llu, dst_lba: %llu\n",
866 (unsigned long long)src_lba, (unsigned long long)dst_lba);
867 pr_debug("target_xcopy_do_work: Blocks copied: %hu, Bytes Copied: %u\n",
868 copied_nolb, copied_nolb * dst_dev->dev_attrib.block_size);
869
870 pr_debug("target_xcopy_do_work: Setting X-COPY GOOD status -> sending response\n");
871 target_complete_cmd(ec_cmd, SAM_STAT_GOOD);
872 return;
873
874 out:
875 xcopy_pt_undepend_remotedev(xop);
876 kfree(xop);
877 /*
878 * Don't override an error scsi status if it has already been set
879 */
880 if (ec_cmd->scsi_status == SAM_STAT_GOOD) {
881 pr_warn_ratelimited("target_xcopy_do_work: rc: %d, Setting X-COPY"
882 " CHECK_CONDITION -> sending response\n", rc);
883 ec_cmd->scsi_status = SAM_STAT_CHECK_CONDITION;
884 }
885 target_complete_cmd(ec_cmd, ec_cmd->scsi_status);
886 }
887
target_do_xcopy(struct se_cmd * se_cmd)888 sense_reason_t target_do_xcopy(struct se_cmd *se_cmd)
889 {
890 struct se_device *dev = se_cmd->se_dev;
891 struct xcopy_op *xop = NULL;
892 unsigned char *p = NULL, *seg_desc;
893 unsigned int list_id, list_id_usage, sdll, inline_dl, sa;
894 sense_reason_t ret = TCM_INVALID_PARAMETER_LIST;
895 int rc;
896 unsigned short tdll;
897
898 if (!dev->dev_attrib.emulate_3pc) {
899 pr_err("EXTENDED_COPY operation explicitly disabled\n");
900 return TCM_UNSUPPORTED_SCSI_OPCODE;
901 }
902
903 sa = se_cmd->t_task_cdb[1] & 0x1f;
904 if (sa != 0x00) {
905 pr_err("EXTENDED_COPY(LID4) not supported\n");
906 return TCM_UNSUPPORTED_SCSI_OPCODE;
907 }
908
909 xop = kzalloc(sizeof(struct xcopy_op), GFP_KERNEL);
910 if (!xop) {
911 pr_err("Unable to allocate xcopy_op\n");
912 return TCM_OUT_OF_RESOURCES;
913 }
914 xop->xop_se_cmd = se_cmd;
915
916 p = transport_kmap_data_sg(se_cmd);
917 if (!p) {
918 pr_err("transport_kmap_data_sg() failed in target_do_xcopy\n");
919 kfree(xop);
920 return TCM_OUT_OF_RESOURCES;
921 }
922
923 list_id = p[0];
924 list_id_usage = (p[1] & 0x18) >> 3;
925
926 /*
927 * Determine TARGET DESCRIPTOR LIST LENGTH + SEGMENT DESCRIPTOR LIST LENGTH
928 */
929 tdll = get_unaligned_be16(&p[2]);
930 sdll = get_unaligned_be32(&p[8]);
931
932 inline_dl = get_unaligned_be32(&p[12]);
933 if (inline_dl != 0) {
934 pr_err("XCOPY with non zero inline data length\n");
935 goto out;
936 }
937
938 pr_debug("Processing XCOPY with list_id: 0x%02x list_id_usage: 0x%02x"
939 " tdll: %hu sdll: %u inline_dl: %u\n", list_id, list_id_usage,
940 tdll, sdll, inline_dl);
941
942 /*
943 * skip over the target descriptors until segment descriptors
944 * have been passed - CSCD ids are needed to determine src and dest.
945 */
946 seg_desc = &p[16] + tdll;
947
948 rc = target_xcopy_parse_segment_descriptors(se_cmd, xop, seg_desc,
949 sdll, &ret);
950 if (rc <= 0)
951 goto out;
952
953 pr_debug("XCOPY: Processed %d segment descriptors, length: %u\n", rc,
954 rc * XCOPY_SEGMENT_DESC_LEN);
955
956 rc = target_xcopy_parse_target_descriptors(se_cmd, xop, &p[16], tdll, &ret);
957 if (rc <= 0)
958 goto out;
959
960 if (xop->src_dev->dev_attrib.block_size !=
961 xop->dst_dev->dev_attrib.block_size) {
962 pr_err("XCOPY: Non matching src_dev block_size: %u + dst_dev"
963 " block_size: %u currently unsupported\n",
964 xop->src_dev->dev_attrib.block_size,
965 xop->dst_dev->dev_attrib.block_size);
966 xcopy_pt_undepend_remotedev(xop);
967 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
968 goto out;
969 }
970
971 pr_debug("XCOPY: Processed %d target descriptors, length: %u\n", rc,
972 rc * XCOPY_TARGET_DESC_LEN);
973 transport_kunmap_data_sg(se_cmd);
974
975 INIT_WORK(&xop->xop_work, target_xcopy_do_work);
976 queue_work(xcopy_wq, &xop->xop_work);
977 return TCM_NO_SENSE;
978
979 out:
980 if (p)
981 transport_kunmap_data_sg(se_cmd);
982 kfree(xop);
983 return ret;
984 }
985
target_rcr_operating_parameters(struct se_cmd * se_cmd)986 static sense_reason_t target_rcr_operating_parameters(struct se_cmd *se_cmd)
987 {
988 unsigned char *p;
989
990 p = transport_kmap_data_sg(se_cmd);
991 if (!p) {
992 pr_err("transport_kmap_data_sg failed in"
993 " target_rcr_operating_parameters\n");
994 return TCM_OUT_OF_RESOURCES;
995 }
996
997 if (se_cmd->data_length < 54) {
998 pr_err("Receive Copy Results Op Parameters length"
999 " too small: %u\n", se_cmd->data_length);
1000 transport_kunmap_data_sg(se_cmd);
1001 return TCM_INVALID_CDB_FIELD;
1002 }
1003 /*
1004 * Set SNLID=1 (Supports no List ID)
1005 */
1006 p[4] = 0x1;
1007 /*
1008 * MAXIMUM TARGET DESCRIPTOR COUNT
1009 */
1010 put_unaligned_be16(RCR_OP_MAX_TARGET_DESC_COUNT, &p[8]);
1011 /*
1012 * MAXIMUM SEGMENT DESCRIPTOR COUNT
1013 */
1014 put_unaligned_be16(RCR_OP_MAX_SG_DESC_COUNT, &p[10]);
1015 /*
1016 * MAXIMUM DESCRIPTOR LIST LENGTH
1017 */
1018 put_unaligned_be32(RCR_OP_MAX_DESC_LIST_LEN, &p[12]);
1019 /*
1020 * MAXIMUM SEGMENT LENGTH
1021 */
1022 put_unaligned_be32(RCR_OP_MAX_SEGMENT_LEN, &p[16]);
1023 /*
1024 * MAXIMUM INLINE DATA LENGTH for SA 0x04 (NOT SUPPORTED)
1025 */
1026 put_unaligned_be32(0x0, &p[20]);
1027 /*
1028 * HELD DATA LIMIT
1029 */
1030 put_unaligned_be32(0x0, &p[24]);
1031 /*
1032 * MAXIMUM STREAM DEVICE TRANSFER SIZE
1033 */
1034 put_unaligned_be32(0x0, &p[28]);
1035 /*
1036 * TOTAL CONCURRENT COPIES
1037 */
1038 put_unaligned_be16(RCR_OP_TOTAL_CONCURR_COPIES, &p[34]);
1039 /*
1040 * MAXIMUM CONCURRENT COPIES
1041 */
1042 p[36] = RCR_OP_MAX_CONCURR_COPIES;
1043 /*
1044 * DATA SEGMENT GRANULARITY (log 2)
1045 */
1046 p[37] = RCR_OP_DATA_SEG_GRAN_LOG2;
1047 /*
1048 * INLINE DATA GRANULARITY log 2)
1049 */
1050 p[38] = RCR_OP_INLINE_DATA_GRAN_LOG2;
1051 /*
1052 * HELD DATA GRANULARITY
1053 */
1054 p[39] = RCR_OP_HELD_DATA_GRAN_LOG2;
1055 /*
1056 * IMPLEMENTED DESCRIPTOR LIST LENGTH
1057 */
1058 p[43] = 0x2;
1059 /*
1060 * List of implemented descriptor type codes (ordered)
1061 */
1062 p[44] = 0x02; /* Copy Block to Block device */
1063 p[45] = 0xe4; /* Identification descriptor target descriptor */
1064
1065 /*
1066 * AVAILABLE DATA (n-3)
1067 */
1068 put_unaligned_be32(42, &p[0]);
1069
1070 transport_kunmap_data_sg(se_cmd);
1071 target_complete_cmd(se_cmd, GOOD);
1072
1073 return TCM_NO_SENSE;
1074 }
1075
target_do_receive_copy_results(struct se_cmd * se_cmd)1076 sense_reason_t target_do_receive_copy_results(struct se_cmd *se_cmd)
1077 {
1078 unsigned char *cdb = &se_cmd->t_task_cdb[0];
1079 int sa = (cdb[1] & 0x1f), list_id = cdb[2];
1080 sense_reason_t rc = TCM_NO_SENSE;
1081
1082 pr_debug("Entering target_do_receive_copy_results: SA: 0x%02x, List ID:"
1083 " 0x%02x, AL: %u\n", sa, list_id, se_cmd->data_length);
1084
1085 if (list_id != 0) {
1086 pr_err("Receive Copy Results with non zero list identifier"
1087 " not supported\n");
1088 return TCM_INVALID_CDB_FIELD;
1089 }
1090
1091 switch (sa) {
1092 case RCR_SA_OPERATING_PARAMETERS:
1093 rc = target_rcr_operating_parameters(se_cmd);
1094 break;
1095 case RCR_SA_COPY_STATUS:
1096 case RCR_SA_RECEIVE_DATA:
1097 case RCR_SA_FAILED_SEGMENT_DETAILS:
1098 default:
1099 pr_err("Unsupported SA for receive copy results: 0x%02x\n", sa);
1100 return TCM_INVALID_CDB_FIELD;
1101 }
1102
1103 return rc;
1104 }
1105