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