blob: a263bf5fab8d4538384f557aef1a3df7df3d9792 [file] [log] [blame]
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -08001/*******************************************************************************
2 * Filename: target_core_rd.c
3 *
4 * This file contains the Storage Engine <-> Ramdisk transport
5 * specific functions.
6 *
Nicholas Bellinger4c762512013-09-05 15:29:12 -07007 * (c) Copyright 2003-2013 Datera, Inc.
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -08008 *
9 * Nicholas A. Bellinger <nab@kernel.org>
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 *
25 ******************************************************************************/
26
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080027#include <linux/string.h>
28#include <linux/parser.h>
29#include <linux/timer.h>
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080030#include <linux/slab.h>
31#include <linux/spinlock.h>
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080032#include <scsi/scsi.h>
33#include <scsi/scsi_host.h>
34
35#include <target/target_core_base.h>
Christoph Hellwigc4795fb2011-11-16 09:46:48 -050036#include <target/target_core_backend.h>
Nicholas Bellinger03a62742014-11-28 05:06:10 +000037#include <target/target_core_backend_configfs.h>
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080038
39#include "target_core_rd.h"
40
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -040041static inline struct rd_dev *RD_DEV(struct se_device *dev)
42{
43 return container_of(dev, struct rd_dev, dev);
44}
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080045
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080046/* rd_attach_hba(): (Part of se_subsystem_api_t template)
47 *
48 *
49 */
50static int rd_attach_hba(struct se_hba *hba, u32 host_id)
51{
52 struct rd_host *rd_host;
53
54 rd_host = kzalloc(sizeof(struct rd_host), GFP_KERNEL);
Andy Grover6708bb22011-06-08 10:36:43 -070055 if (!rd_host) {
56 pr_err("Unable to allocate memory for struct rd_host\n");
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080057 return -ENOMEM;
58 }
59
60 rd_host->rd_host_id = host_id;
61
Andy Grover5951146d2011-07-19 10:26:37 +000062 hba->hba_ptr = rd_host;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080063
Andy Grover6708bb22011-06-08 10:36:43 -070064 pr_debug("CORE_HBA[%d] - TCM Ramdisk HBA Driver %s on"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080065 " Generic Target Core Stack %s\n", hba->hba_id,
66 RD_HBA_VERSION, TARGET_CORE_MOD_VERSION);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080067
68 return 0;
69}
70
71static void rd_detach_hba(struct se_hba *hba)
72{
73 struct rd_host *rd_host = hba->hba_ptr;
74
Andy Grover6708bb22011-06-08 10:36:43 -070075 pr_debug("CORE_HBA[%d] - Detached Ramdisk HBA: %u from"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080076 " Generic Target Core\n", hba->hba_id, rd_host->rd_host_id);
77
78 kfree(rd_host);
79 hba->hba_ptr = NULL;
80}
81
Nicholas Bellinger4442dc82014-01-07 22:40:27 +000082static u32 rd_release_sgl_table(struct rd_dev *rd_dev, struct rd_dev_sg_table *sg_table,
83 u32 sg_table_count)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080084{
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080085 struct page *pg;
86 struct scatterlist *sg;
Nicholas Bellinger4442dc82014-01-07 22:40:27 +000087 u32 i, j, page_count = 0, sg_per_table;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080088
Nicholas Bellinger4442dc82014-01-07 22:40:27 +000089 for (i = 0; i < sg_table_count; i++) {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080090 sg = sg_table[i].sg_table;
91 sg_per_table = sg_table[i].rd_sg_count;
92
93 for (j = 0; j < sg_per_table; j++) {
94 pg = sg_page(&sg[j]);
Andy Grover6708bb22011-06-08 10:36:43 -070095 if (pg) {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080096 __free_page(pg);
97 page_count++;
98 }
99 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800100 kfree(sg);
101 }
102
Nicholas Bellinger4442dc82014-01-07 22:40:27 +0000103 kfree(sg_table);
104 return page_count;
105}
106
107static void rd_release_device_space(struct rd_dev *rd_dev)
108{
109 u32 page_count;
110
111 if (!rd_dev->sg_table_array || !rd_dev->sg_table_count)
112 return;
113
114 page_count = rd_release_sgl_table(rd_dev, rd_dev->sg_table_array,
115 rd_dev->sg_table_count);
116
Andy Grover6708bb22011-06-08 10:36:43 -0700117 pr_debug("CORE_RD[%u] - Released device space for Ramdisk"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800118 " Device ID: %u, pages %u in %u tables total bytes %lu\n",
119 rd_dev->rd_host->rd_host_id, rd_dev->rd_dev_id, page_count,
120 rd_dev->sg_table_count, (unsigned long)page_count * PAGE_SIZE);
121
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800122 rd_dev->sg_table_array = NULL;
123 rd_dev->sg_table_count = 0;
124}
125
126
127/* rd_build_device_space():
128 *
129 *
130 */
Nicholas Bellinger4442dc82014-01-07 22:40:27 +0000131static int rd_allocate_sgl_table(struct rd_dev *rd_dev, struct rd_dev_sg_table *sg_table,
132 u32 total_sg_needed, unsigned char init_payload)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800133{
Nicholas Bellinger4442dc82014-01-07 22:40:27 +0000134 u32 i = 0, j, page_offset = 0, sg_per_table;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800135 u32 max_sg_per_table = (RD_MAX_ALLOCATION_SIZE /
136 sizeof(struct scatterlist));
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800137 struct page *pg;
138 struct scatterlist *sg;
Nicholas Bellinger4442dc82014-01-07 22:40:27 +0000139 unsigned char *p;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800140
141 while (total_sg_needed) {
Akinobu Mitabfd9a532015-04-11 13:17:31 +0900142 unsigned int chain_entry = 0;
143
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800144 sg_per_table = (total_sg_needed > max_sg_per_table) ?
145 max_sg_per_table : total_sg_needed;
146
Akinobu Mitabfd9a532015-04-11 13:17:31 +0900147#ifdef CONFIG_ARCH_HAS_SG_CHAIN
148
149 /*
150 * Reserve extra element for chain entry
151 */
152 if (sg_per_table < total_sg_needed)
153 chain_entry = 1;
154
155#endif /* CONFIG_ARCH_HAS_SG_CHAIN */
156
157 sg = kcalloc(sg_per_table + chain_entry, sizeof(*sg),
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800158 GFP_KERNEL);
Andy Grover6708bb22011-06-08 10:36:43 -0700159 if (!sg) {
160 pr_err("Unable to allocate scatterlist array"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800161 " for struct rd_dev\n");
Dan Carpenter065f9712011-03-14 04:06:03 -0700162 return -ENOMEM;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800163 }
164
Akinobu Mitabfd9a532015-04-11 13:17:31 +0900165 sg_init_table(sg, sg_per_table + chain_entry);
166
167#ifdef CONFIG_ARCH_HAS_SG_CHAIN
168
169 if (i > 0) {
170 sg_chain(sg_table[i - 1].sg_table,
171 max_sg_per_table + 1, sg);
172 }
173
174#endif /* CONFIG_ARCH_HAS_SG_CHAIN */
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800175
176 sg_table[i].sg_table = sg;
177 sg_table[i].rd_sg_count = sg_per_table;
178 sg_table[i].page_start_offset = page_offset;
179 sg_table[i++].page_end_offset = (page_offset + sg_per_table)
180 - 1;
181
182 for (j = 0; j < sg_per_table; j++) {
183 pg = alloc_pages(GFP_KERNEL, 0);
Andy Grover6708bb22011-06-08 10:36:43 -0700184 if (!pg) {
185 pr_err("Unable to allocate scatterlist"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800186 " pages for struct rd_dev_sg_table\n");
Dan Carpenter065f9712011-03-14 04:06:03 -0700187 return -ENOMEM;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800188 }
189 sg_assign_page(&sg[j], pg);
190 sg[j].length = PAGE_SIZE;
Nicholas Bellinger4442dc82014-01-07 22:40:27 +0000191
192 p = kmap(pg);
193 memset(p, init_payload, PAGE_SIZE);
194 kunmap(pg);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800195 }
196
197 page_offset += sg_per_table;
198 total_sg_needed -= sg_per_table;
199 }
200
Nicholas Bellinger4442dc82014-01-07 22:40:27 +0000201 return 0;
202}
203
204static int rd_build_device_space(struct rd_dev *rd_dev)
205{
206 struct rd_dev_sg_table *sg_table;
207 u32 sg_tables, total_sg_needed;
208 u32 max_sg_per_table = (RD_MAX_ALLOCATION_SIZE /
209 sizeof(struct scatterlist));
210 int rc;
211
212 if (rd_dev->rd_page_count <= 0) {
213 pr_err("Illegal page count: %u for Ramdisk device\n",
214 rd_dev->rd_page_count);
215 return -EINVAL;
216 }
217
218 /* Don't need backing pages for NULLIO */
219 if (rd_dev->rd_flags & RDF_NULLIO)
220 return 0;
221
222 total_sg_needed = rd_dev->rd_page_count;
223
224 sg_tables = (total_sg_needed / max_sg_per_table) + 1;
225
226 sg_table = kzalloc(sg_tables * sizeof(struct rd_dev_sg_table), GFP_KERNEL);
227 if (!sg_table) {
228 pr_err("Unable to allocate memory for Ramdisk"
229 " scatterlist tables\n");
230 return -ENOMEM;
231 }
232
233 rd_dev->sg_table_array = sg_table;
234 rd_dev->sg_table_count = sg_tables;
235
236 rc = rd_allocate_sgl_table(rd_dev, sg_table, total_sg_needed, 0x00);
237 if (rc)
238 return rc;
239
Andy Grover6708bb22011-06-08 10:36:43 -0700240 pr_debug("CORE_RD[%u] - Built Ramdisk Device ID: %u space of"
Nicholas Bellinger4442dc82014-01-07 22:40:27 +0000241 " %u pages in %u tables\n", rd_dev->rd_host->rd_host_id,
242 rd_dev->rd_dev_id, rd_dev->rd_page_count,
243 rd_dev->sg_table_count);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800244
245 return 0;
246}
247
Nicholas Bellingerd7e8eb52014-01-07 23:24:14 +0000248static void rd_release_prot_space(struct rd_dev *rd_dev)
249{
250 u32 page_count;
251
252 if (!rd_dev->sg_prot_array || !rd_dev->sg_prot_count)
253 return;
254
255 page_count = rd_release_sgl_table(rd_dev, rd_dev->sg_prot_array,
256 rd_dev->sg_prot_count);
257
258 pr_debug("CORE_RD[%u] - Released protection space for Ramdisk"
259 " Device ID: %u, pages %u in %u tables total bytes %lu\n",
260 rd_dev->rd_host->rd_host_id, rd_dev->rd_dev_id, page_count,
261 rd_dev->sg_table_count, (unsigned long)page_count * PAGE_SIZE);
262
263 rd_dev->sg_prot_array = NULL;
264 rd_dev->sg_prot_count = 0;
265}
266
Quinn Tran9d2e59f2014-03-28 19:05:27 -0400267static int rd_build_prot_space(struct rd_dev *rd_dev, int prot_length, int block_size)
Nicholas Bellingerd7e8eb52014-01-07 23:24:14 +0000268{
269 struct rd_dev_sg_table *sg_table;
270 u32 total_sg_needed, sg_tables;
271 u32 max_sg_per_table = (RD_MAX_ALLOCATION_SIZE /
272 sizeof(struct scatterlist));
273 int rc;
274
275 if (rd_dev->rd_flags & RDF_NULLIO)
276 return 0;
Quinn Tran9d2e59f2014-03-28 19:05:27 -0400277 /*
278 * prot_length=8byte dif data
279 * tot sg needed = rd_page_count * (PGSZ/block_size) *
280 * (prot_length/block_size) + pad
281 * PGSZ canceled each other.
282 */
283 total_sg_needed = (rd_dev->rd_page_count * prot_length / block_size) + 1;
Nicholas Bellingerd7e8eb52014-01-07 23:24:14 +0000284
285 sg_tables = (total_sg_needed / max_sg_per_table) + 1;
286
287 sg_table = kzalloc(sg_tables * sizeof(struct rd_dev_sg_table), GFP_KERNEL);
288 if (!sg_table) {
289 pr_err("Unable to allocate memory for Ramdisk protection"
290 " scatterlist tables\n");
291 return -ENOMEM;
292 }
293
294 rd_dev->sg_prot_array = sg_table;
295 rd_dev->sg_prot_count = sg_tables;
296
297 rc = rd_allocate_sgl_table(rd_dev, sg_table, total_sg_needed, 0xff);
298 if (rc)
299 return rc;
300
301 pr_debug("CORE_RD[%u] - Built Ramdisk Device ID: %u prot space of"
302 " %u pages in %u tables\n", rd_dev->rd_host->rd_host_id,
303 rd_dev->rd_dev_id, total_sg_needed, rd_dev->sg_prot_count);
304
305 return 0;
306}
307
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400308static struct se_device *rd_alloc_device(struct se_hba *hba, const char *name)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800309{
310 struct rd_dev *rd_dev;
311 struct rd_host *rd_host = hba->hba_ptr;
312
313 rd_dev = kzalloc(sizeof(struct rd_dev), GFP_KERNEL);
Andy Grover6708bb22011-06-08 10:36:43 -0700314 if (!rd_dev) {
315 pr_err("Unable to allocate memory for struct rd_dev\n");
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800316 return NULL;
317 }
318
319 rd_dev->rd_host = rd_host;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800320
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400321 return &rd_dev->dev;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800322}
323
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400324static int rd_configure_device(struct se_device *dev)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800325{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400326 struct rd_dev *rd_dev = RD_DEV(dev);
327 struct rd_host *rd_host = dev->se_hba->hba_ptr;
328 int ret;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800329
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400330 if (!(rd_dev->rd_flags & RDF_HAS_PAGE_COUNT)) {
331 pr_debug("Missing rd_pages= parameter\n");
332 return -EINVAL;
333 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800334
Dan Carpenter065f9712011-03-14 04:06:03 -0700335 ret = rd_build_device_space(rd_dev);
336 if (ret < 0)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800337 goto fail;
338
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400339 dev->dev_attrib.hw_block_size = RD_BLOCKSIZE;
340 dev->dev_attrib.hw_max_sectors = UINT_MAX;
341 dev->dev_attrib.hw_queue_depth = RD_MAX_DEVICE_QUEUE_DEPTH;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800342
343 rd_dev->rd_dev_id = rd_host->rd_host_dev_id_count++;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800344
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400345 pr_debug("CORE_RD[%u] - Added TCM MEMCPY Ramdisk Device ID: %u of"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800346 " %u pages in %u tables, %lu total bytes\n",
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400347 rd_host->rd_host_id, rd_dev->rd_dev_id, rd_dev->rd_page_count,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800348 rd_dev->sg_table_count,
349 (unsigned long)(rd_dev->rd_page_count * PAGE_SIZE));
350
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400351 return 0;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800352
353fail:
354 rd_release_device_space(rd_dev);
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400355 return ret;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800356}
357
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400358static void rd_free_device(struct se_device *dev)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800359{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400360 struct rd_dev *rd_dev = RD_DEV(dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800361
362 rd_release_device_space(rd_dev);
363 kfree(rd_dev);
364}
365
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800366static struct rd_dev_sg_table *rd_get_sg_table(struct rd_dev *rd_dev, u32 page)
367{
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800368 struct rd_dev_sg_table *sg_table;
Martin Svec8f678352013-01-15 12:43:35 -0800369 u32 i, sg_per_table = (RD_MAX_ALLOCATION_SIZE /
370 sizeof(struct scatterlist));
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800371
Martin Svec8f678352013-01-15 12:43:35 -0800372 i = page / sg_per_table;
373 if (i < rd_dev->sg_table_count) {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800374 sg_table = &rd_dev->sg_table_array[i];
375 if ((sg_table->page_start_offset <= page) &&
376 (sg_table->page_end_offset >= page))
377 return sg_table;
378 }
379
Andy Grover6708bb22011-06-08 10:36:43 -0700380 pr_err("Unable to locate struct rd_dev_sg_table for page: %u\n",
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800381 page);
382
383 return NULL;
384}
385
Nicholas Bellinger6e611112014-01-08 12:06:30 +0000386static struct rd_dev_sg_table *rd_get_prot_table(struct rd_dev *rd_dev, u32 page)
387{
388 struct rd_dev_sg_table *sg_table;
389 u32 i, sg_per_table = (RD_MAX_ALLOCATION_SIZE /
390 sizeof(struct scatterlist));
391
392 i = page / sg_per_table;
393 if (i < rd_dev->sg_prot_count) {
394 sg_table = &rd_dev->sg_prot_array[i];
395 if ((sg_table->page_start_offset <= page) &&
396 (sg_table->page_end_offset >= page))
397 return sg_table;
398 }
399
400 pr_err("Unable to locate struct prot rd_dev_sg_table for page: %u\n",
401 page);
402
403 return NULL;
404}
405
Akinobu Mita6766cc82015-04-05 23:59:38 +0900406typedef sense_reason_t (*dif_verify)(struct se_cmd *, sector_t, unsigned int,
407 unsigned int, struct scatterlist *, int);
408
409static sense_reason_t rd_do_prot_rw(struct se_cmd *cmd, dif_verify dif_verify)
410{
411 struct se_device *se_dev = cmd->se_dev;
412 struct rd_dev *dev = RD_DEV(se_dev);
413 struct rd_dev_sg_table *prot_table;
Akinobu Mitabfd9a532015-04-11 13:17:31 +0900414 bool need_to_release = false;
Akinobu Mita6766cc82015-04-05 23:59:38 +0900415 struct scatterlist *prot_sg;
416 u32 sectors = cmd->data_length / se_dev->dev_attrib.block_size;
417 u32 prot_offset, prot_page;
Akinobu Mitabfd9a532015-04-11 13:17:31 +0900418 u32 prot_npages __maybe_unused;
Akinobu Mita6766cc82015-04-05 23:59:38 +0900419 u64 tmp;
Akinobu Mitabfd9a532015-04-11 13:17:31 +0900420 sense_reason_t rc = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
Akinobu Mita6766cc82015-04-05 23:59:38 +0900421
422 tmp = cmd->t_task_lba * se_dev->prot_length;
423 prot_offset = do_div(tmp, PAGE_SIZE);
424 prot_page = tmp;
425
426 prot_table = rd_get_prot_table(dev, prot_page);
427 if (!prot_table)
428 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
429
430 prot_sg = &prot_table->sg_table[prot_page -
431 prot_table->page_start_offset];
432
Akinobu Mitabfd9a532015-04-11 13:17:31 +0900433#ifndef CONFIG_ARCH_HAS_SG_CHAIN
434
435 prot_npages = DIV_ROUND_UP(prot_offset + sectors * se_dev->prot_length,
436 PAGE_SIZE);
437
438 /*
439 * Allocate temporaly contiguous scatterlist entries if prot pages
440 * straddles multiple scatterlist tables.
441 */
442 if (prot_table->page_end_offset < prot_page + prot_npages - 1) {
443 int i;
444
445 prot_sg = kcalloc(prot_npages, sizeof(*prot_sg), GFP_KERNEL);
446 if (!prot_sg)
447 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
448
449 need_to_release = true;
450 sg_init_table(prot_sg, prot_npages);
451
452 for (i = 0; i < prot_npages; i++) {
453 if (prot_page + i > prot_table->page_end_offset) {
454 prot_table = rd_get_prot_table(dev,
455 prot_page + i);
456 if (!prot_table) {
457 kfree(prot_sg);
458 return rc;
459 }
460 sg_unmark_end(&prot_sg[i - 1]);
461 }
462 prot_sg[i] = prot_table->sg_table[prot_page + i -
463 prot_table->page_start_offset];
464 }
465 }
466
467#endif /* !CONFIG_ARCH_HAS_SG_CHAIN */
468
Akinobu Mita6766cc82015-04-05 23:59:38 +0900469 rc = dif_verify(cmd, cmd->t_task_lba, sectors, 0, prot_sg, prot_offset);
Akinobu Mitabfd9a532015-04-11 13:17:31 +0900470 if (need_to_release)
471 kfree(prot_sg);
Akinobu Mita6766cc82015-04-05 23:59:38 +0900472
473 return rc;
474}
475
Christoph Hellwigde103c92012-11-06 12:24:09 -0800476static sense_reason_t
Nicholas Bellingera82a9532013-08-19 23:57:30 -0700477rd_execute_rw(struct se_cmd *cmd, struct scatterlist *sgl, u32 sgl_nents,
478 enum dma_data_direction data_direction)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800479{
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400480 struct se_device *se_dev = cmd->se_dev;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400481 struct rd_dev *dev = RD_DEV(se_dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800482 struct rd_dev_sg_table *table;
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100483 struct scatterlist *rd_sg;
484 struct sg_mapping_iter m;
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400485 u32 rd_offset;
486 u32 rd_size;
487 u32 rd_page;
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100488 u32 src_len;
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400489 u64 tmp;
Nicholas Bellinger6e611112014-01-08 12:06:30 +0000490 sense_reason_t rc;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800491
Nicholas Bellinger52c07422013-05-11 16:16:49 -0700492 if (dev->rd_flags & RDF_NULLIO) {
493 target_complete_cmd(cmd, SAM_STAT_GOOD);
494 return 0;
495 }
496
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400497 tmp = cmd->t_task_lba * se_dev->dev_attrib.block_size;
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400498 rd_offset = do_div(tmp, PAGE_SIZE);
499 rd_page = tmp;
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400500 rd_size = cmd->data_length;
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400501
502 table = rd_get_sg_table(dev, rd_page);
Andy Grover6708bb22011-06-08 10:36:43 -0700503 if (!table)
Christoph Hellwigde103c92012-11-06 12:24:09 -0800504 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800505
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400506 rd_sg = &table->sg_table[rd_page - table->page_start_offset];
Andy Grover6708bb22011-06-08 10:36:43 -0700507
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100508 pr_debug("RD[%u]: %s LBA: %llu, Size: %u Page: %u, Offset: %u\n",
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400509 dev->rd_dev_id,
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400510 data_direction == DMA_FROM_DEVICE ? "Read" : "Write",
511 cmd->t_task_lba, rd_size, rd_page, rd_offset);
Andy Grover6708bb22011-06-08 10:36:43 -0700512
Nicholas Bellinger17627422015-03-27 23:15:04 -0700513 if (cmd->prot_type && se_dev->dev_attrib.pi_prot_type &&
514 data_direction == DMA_TO_DEVICE) {
Akinobu Mita6766cc82015-04-05 23:59:38 +0900515 rc = rd_do_prot_rw(cmd, sbc_dif_verify_write);
Nicholas Bellinger6e611112014-01-08 12:06:30 +0000516 if (rc)
517 return rc;
518 }
519
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100520 src_len = PAGE_SIZE - rd_offset;
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400521 sg_miter_start(&m, sgl, sgl_nents,
522 data_direction == DMA_FROM_DEVICE ?
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400523 SG_MITER_TO_SG : SG_MITER_FROM_SG);
524 while (rd_size) {
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100525 u32 len;
526 void *rd_addr;
Andy Grover6708bb22011-06-08 10:36:43 -0700527
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100528 sg_miter_next(&m);
Hannes Reineckebbf344e2013-02-06 14:42:28 +0100529 if (!(u32)m.length) {
530 pr_debug("RD[%u]: invalid sgl %p len %zu\n",
531 dev->rd_dev_id, m.addr, m.length);
532 sg_miter_stop(&m);
533 return TCM_INCORRECT_AMOUNT_OF_DATA;
534 }
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100535 len = min((u32)m.length, src_len);
Hannes Reineckebbf344e2013-02-06 14:42:28 +0100536 if (len > rd_size) {
537 pr_debug("RD[%u]: size underrun page %d offset %d "
538 "size %d\n", dev->rd_dev_id,
539 rd_page, rd_offset, rd_size);
540 len = rd_size;
541 }
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100542 m.consumed = len;
Andy Grover6708bb22011-06-08 10:36:43 -0700543
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100544 rd_addr = sg_virt(rd_sg) + rd_offset;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800545
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400546 if (data_direction == DMA_FROM_DEVICE)
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100547 memcpy(m.addr, rd_addr, len);
548 else
549 memcpy(rd_addr, m.addr, len);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800550
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400551 rd_size -= len;
552 if (!rd_size)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800553 continue;
554
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100555 src_len -= len;
556 if (src_len) {
557 rd_offset += len;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800558 continue;
559 }
Andy Grover6708bb22011-06-08 10:36:43 -0700560
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100561 /* rd page completed, next one please */
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400562 rd_page++;
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100563 rd_offset = 0;
564 src_len = PAGE_SIZE;
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400565 if (rd_page <= table->page_end_offset) {
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100566 rd_sg++;
567 continue;
568 }
Andy Grover6708bb22011-06-08 10:36:43 -0700569
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400570 table = rd_get_sg_table(dev, rd_page);
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100571 if (!table) {
572 sg_miter_stop(&m);
Christoph Hellwigde103c92012-11-06 12:24:09 -0800573 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800574 }
575
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100576 /* since we increment, the first sg entry is correct */
577 rd_sg = table->sg_table;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800578 }
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100579 sg_miter_stop(&m);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800580
Nicholas Bellinger17627422015-03-27 23:15:04 -0700581 if (cmd->prot_type && se_dev->dev_attrib.pi_prot_type &&
582 data_direction == DMA_FROM_DEVICE) {
Akinobu Mita6766cc82015-04-05 23:59:38 +0900583 rc = rd_do_prot_rw(cmd, sbc_dif_verify_read);
Nicholas Bellinger6e611112014-01-08 12:06:30 +0000584 if (rc)
585 return rc;
586 }
587
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400588 target_complete_cmd(cmd, SAM_STAT_GOOD);
Nicholas Bellinger03e98c92011-11-04 02:36:16 -0700589 return 0;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800590}
591
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800592enum {
Nicholas Bellinger52c07422013-05-11 16:16:49 -0700593 Opt_rd_pages, Opt_rd_nullio, Opt_err
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800594};
595
596static match_table_t tokens = {
597 {Opt_rd_pages, "rd_pages=%d"},
Nicholas Bellinger52c07422013-05-11 16:16:49 -0700598 {Opt_rd_nullio, "rd_nullio=%d"},
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800599 {Opt_err, NULL}
600};
601
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400602static ssize_t rd_set_configfs_dev_params(struct se_device *dev,
603 const char *page, ssize_t count)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800604{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400605 struct rd_dev *rd_dev = RD_DEV(dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800606 char *orig, *ptr, *opts;
607 substring_t args[MAX_OPT_ARGS];
608 int ret = 0, arg, token;
609
610 opts = kstrdup(page, GFP_KERNEL);
611 if (!opts)
612 return -ENOMEM;
613
614 orig = opts;
615
Sebastian Andrzej Siewior90c161b2011-11-23 20:53:17 +0100616 while ((ptr = strsep(&opts, ",\n")) != NULL) {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800617 if (!*ptr)
618 continue;
619
620 token = match_token(ptr, tokens, args);
621 switch (token) {
622 case Opt_rd_pages:
623 match_int(args, &arg);
624 rd_dev->rd_page_count = arg;
Andy Grover6708bb22011-06-08 10:36:43 -0700625 pr_debug("RAMDISK: Referencing Page"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800626 " Count: %u\n", rd_dev->rd_page_count);
627 rd_dev->rd_flags |= RDF_HAS_PAGE_COUNT;
628 break;
Nicholas Bellinger52c07422013-05-11 16:16:49 -0700629 case Opt_rd_nullio:
630 match_int(args, &arg);
631 if (arg != 1)
632 break;
633
634 pr_debug("RAMDISK: Setting NULLIO flag: %d\n", arg);
635 rd_dev->rd_flags |= RDF_NULLIO;
636 break;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800637 default:
638 break;
639 }
640 }
641
642 kfree(orig);
643 return (!ret) ? count : ret;
644}
645
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400646static ssize_t rd_show_configfs_dev_params(struct se_device *dev, char *b)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800647{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400648 struct rd_dev *rd_dev = RD_DEV(dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800649
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400650 ssize_t bl = sprintf(b, "TCM RamDisk ID: %u RamDisk Makeup: rd_mcp\n",
651 rd_dev->rd_dev_id);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800652 bl += sprintf(b + bl, " PAGES/PAGE_SIZE: %u*%lu"
Nicholas Bellinger52c07422013-05-11 16:16:49 -0700653 " SG_table_count: %u nullio: %d\n", rd_dev->rd_page_count,
654 PAGE_SIZE, rd_dev->sg_table_count,
655 !!(rd_dev->rd_flags & RDF_NULLIO));
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800656 return bl;
657}
658
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800659static sector_t rd_get_blocks(struct se_device *dev)
660{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400661 struct rd_dev *rd_dev = RD_DEV(dev);
662
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800663 unsigned long long blocks_long = ((rd_dev->rd_page_count * PAGE_SIZE) /
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400664 dev->dev_attrib.block_size) - 1;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800665
666 return blocks_long;
667}
668
Nicholas Bellingerd7e8eb52014-01-07 23:24:14 +0000669static int rd_init_prot(struct se_device *dev)
670{
671 struct rd_dev *rd_dev = RD_DEV(dev);
672
673 if (!dev->dev_attrib.pi_prot_type)
674 return 0;
675
Quinn Tran9d2e59f2014-03-28 19:05:27 -0400676 return rd_build_prot_space(rd_dev, dev->prot_length,
677 dev->dev_attrib.block_size);
Nicholas Bellingerd7e8eb52014-01-07 23:24:14 +0000678}
679
680static void rd_free_prot(struct se_device *dev)
681{
682 struct rd_dev *rd_dev = RD_DEV(dev);
683
684 rd_release_prot_space(rd_dev);
685}
686
Christoph Hellwig9e999a62012-10-07 10:55:50 -0400687static struct sbc_ops rd_sbc_ops = {
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400688 .execute_rw = rd_execute_rw,
689};
690
Christoph Hellwigde103c92012-11-06 12:24:09 -0800691static sense_reason_t
692rd_parse_cdb(struct se_cmd *cmd)
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400693{
Christoph Hellwig9e999a62012-10-07 10:55:50 -0400694 return sbc_parse_cdb(cmd, &rd_sbc_ops);
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400695}
696
Nicholas Bellinger03a62742014-11-28 05:06:10 +0000697DEF_TB_DEFAULT_ATTRIBS(rd_mcp);
698
699static struct configfs_attribute *rd_mcp_backend_dev_attrs[] = {
700 &rd_mcp_dev_attrib_emulate_model_alias.attr,
701 &rd_mcp_dev_attrib_emulate_dpo.attr,
702 &rd_mcp_dev_attrib_emulate_fua_write.attr,
703 &rd_mcp_dev_attrib_emulate_fua_read.attr,
704 &rd_mcp_dev_attrib_emulate_write_cache.attr,
705 &rd_mcp_dev_attrib_emulate_ua_intlck_ctrl.attr,
706 &rd_mcp_dev_attrib_emulate_tas.attr,
707 &rd_mcp_dev_attrib_emulate_tpu.attr,
708 &rd_mcp_dev_attrib_emulate_tpws.attr,
709 &rd_mcp_dev_attrib_emulate_caw.attr,
710 &rd_mcp_dev_attrib_emulate_3pc.attr,
711 &rd_mcp_dev_attrib_pi_prot_type.attr,
712 &rd_mcp_dev_attrib_hw_pi_prot_type.attr,
713 &rd_mcp_dev_attrib_pi_prot_format.attr,
714 &rd_mcp_dev_attrib_enforce_pr_isids.attr,
715 &rd_mcp_dev_attrib_is_nonrot.attr,
716 &rd_mcp_dev_attrib_emulate_rest_reord.attr,
717 &rd_mcp_dev_attrib_force_pr_aptpl.attr,
718 &rd_mcp_dev_attrib_hw_block_size.attr,
719 &rd_mcp_dev_attrib_block_size.attr,
720 &rd_mcp_dev_attrib_hw_max_sectors.attr,
Nicholas Bellinger03a62742014-11-28 05:06:10 +0000721 &rd_mcp_dev_attrib_optimal_sectors.attr,
722 &rd_mcp_dev_attrib_hw_queue_depth.attr,
723 &rd_mcp_dev_attrib_queue_depth.attr,
724 &rd_mcp_dev_attrib_max_unmap_lba_count.attr,
725 &rd_mcp_dev_attrib_max_unmap_block_desc_count.attr,
726 &rd_mcp_dev_attrib_unmap_granularity.attr,
727 &rd_mcp_dev_attrib_unmap_granularity_alignment.attr,
728 &rd_mcp_dev_attrib_max_write_same_len.attr,
729 NULL,
730};
731
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800732static struct se_subsystem_api rd_mcp_template = {
733 .name = "rd_mcp",
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400734 .inquiry_prod = "RAMDISK-MCP",
735 .inquiry_rev = RD_MCP_VERSION,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800736 .transport_type = TRANSPORT_PLUGIN_VHBA_VDEV,
737 .attach_hba = rd_attach_hba,
738 .detach_hba = rd_detach_hba,
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400739 .alloc_device = rd_alloc_device,
740 .configure_device = rd_configure_device,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800741 .free_device = rd_free_device,
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400742 .parse_cdb = rd_parse_cdb,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800743 .set_configfs_dev_params = rd_set_configfs_dev_params,
744 .show_configfs_dev_params = rd_show_configfs_dev_params,
Christoph Hellwig6f23ac82012-10-07 10:55:53 -0400745 .get_device_type = sbc_get_device_type,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800746 .get_blocks = rd_get_blocks,
Nicholas Bellingerd7e8eb52014-01-07 23:24:14 +0000747 .init_prot = rd_init_prot,
748 .free_prot = rd_free_prot,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800749};
750
751int __init rd_module_init(void)
752{
Nicholas Bellinger03a62742014-11-28 05:06:10 +0000753 struct target_backend_cits *tbc = &rd_mcp_template.tb_cits;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800754 int ret;
755
Nicholas Bellinger03a62742014-11-28 05:06:10 +0000756 target_core_setup_sub_cits(&rd_mcp_template);
757 tbc->tb_dev_attrib_cit.ct_attrs = rd_mcp_backend_dev_attrs;
758
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800759 ret = transport_subsystem_register(&rd_mcp_template);
760 if (ret < 0) {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800761 return ret;
762 }
763
764 return 0;
765}
766
767void rd_module_exit(void)
768{
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800769 transport_subsystem_release(&rd_mcp_template);
770}