blob: 8882686a12c07ed47d8f2f0b38ee8e0262d21ffb [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>
Bart Van Asscheba929992015-05-08 10:11:12 +020032#include <scsi/scsi_proto.h>
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080033
34#include <target/target_core_base.h>
Christoph Hellwigc4795fb2011-11-16 09:46:48 -050035#include <target/target_core_backend.h>
Nicholas Bellinger03a62742014-11-28 05:06:10 +000036#include <target/target_core_backend_configfs.h>
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080037
38#include "target_core_rd.h"
39
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -040040static inline struct rd_dev *RD_DEV(struct se_device *dev)
41{
42 return container_of(dev, struct rd_dev, dev);
43}
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080044
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080045/* rd_attach_hba(): (Part of se_subsystem_api_t template)
46 *
47 *
48 */
49static int rd_attach_hba(struct se_hba *hba, u32 host_id)
50{
51 struct rd_host *rd_host;
52
53 rd_host = kzalloc(sizeof(struct rd_host), GFP_KERNEL);
Andy Grover6708bb22011-06-08 10:36:43 -070054 if (!rd_host) {
55 pr_err("Unable to allocate memory for struct rd_host\n");
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080056 return -ENOMEM;
57 }
58
59 rd_host->rd_host_id = host_id;
60
Andy Grover5951146d2011-07-19 10:26:37 +000061 hba->hba_ptr = rd_host;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080062
Andy Grover6708bb22011-06-08 10:36:43 -070063 pr_debug("CORE_HBA[%d] - TCM Ramdisk HBA Driver %s on"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080064 " Generic Target Core Stack %s\n", hba->hba_id,
65 RD_HBA_VERSION, TARGET_CORE_MOD_VERSION);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080066
67 return 0;
68}
69
70static void rd_detach_hba(struct se_hba *hba)
71{
72 struct rd_host *rd_host = hba->hba_ptr;
73
Andy Grover6708bb22011-06-08 10:36:43 -070074 pr_debug("CORE_HBA[%d] - Detached Ramdisk HBA: %u from"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080075 " Generic Target Core\n", hba->hba_id, rd_host->rd_host_id);
76
77 kfree(rd_host);
78 hba->hba_ptr = NULL;
79}
80
Nicholas Bellinger4442dc82014-01-07 22:40:27 +000081static u32 rd_release_sgl_table(struct rd_dev *rd_dev, struct rd_dev_sg_table *sg_table,
82 u32 sg_table_count)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080083{
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080084 struct page *pg;
85 struct scatterlist *sg;
Nicholas Bellinger4442dc82014-01-07 22:40:27 +000086 u32 i, j, page_count = 0, sg_per_table;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080087
Nicholas Bellinger4442dc82014-01-07 22:40:27 +000088 for (i = 0; i < sg_table_count; i++) {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080089 sg = sg_table[i].sg_table;
90 sg_per_table = sg_table[i].rd_sg_count;
91
92 for (j = 0; j < sg_per_table; j++) {
93 pg = sg_page(&sg[j]);
Andy Grover6708bb22011-06-08 10:36:43 -070094 if (pg) {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080095 __free_page(pg);
96 page_count++;
97 }
98 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080099 kfree(sg);
100 }
101
Nicholas Bellinger4442dc82014-01-07 22:40:27 +0000102 kfree(sg_table);
103 return page_count;
104}
105
106static void rd_release_device_space(struct rd_dev *rd_dev)
107{
108 u32 page_count;
109
110 if (!rd_dev->sg_table_array || !rd_dev->sg_table_count)
111 return;
112
113 page_count = rd_release_sgl_table(rd_dev, rd_dev->sg_table_array,
114 rd_dev->sg_table_count);
115
Andy Grover6708bb22011-06-08 10:36:43 -0700116 pr_debug("CORE_RD[%u] - Released device space for Ramdisk"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800117 " Device ID: %u, pages %u in %u tables total bytes %lu\n",
118 rd_dev->rd_host->rd_host_id, rd_dev->rd_dev_id, page_count,
119 rd_dev->sg_table_count, (unsigned long)page_count * PAGE_SIZE);
120
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800121 rd_dev->sg_table_array = NULL;
122 rd_dev->sg_table_count = 0;
123}
124
125
126/* rd_build_device_space():
127 *
128 *
129 */
Nicholas Bellinger4442dc82014-01-07 22:40:27 +0000130static int rd_allocate_sgl_table(struct rd_dev *rd_dev, struct rd_dev_sg_table *sg_table,
131 u32 total_sg_needed, unsigned char init_payload)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800132{
Nicholas Bellinger4442dc82014-01-07 22:40:27 +0000133 u32 i = 0, j, page_offset = 0, sg_per_table;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800134 u32 max_sg_per_table = (RD_MAX_ALLOCATION_SIZE /
135 sizeof(struct scatterlist));
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800136 struct page *pg;
137 struct scatterlist *sg;
Nicholas Bellinger4442dc82014-01-07 22:40:27 +0000138 unsigned char *p;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800139
140 while (total_sg_needed) {
Akinobu Mitabfd9a532015-04-11 13:17:31 +0900141 unsigned int chain_entry = 0;
142
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800143 sg_per_table = (total_sg_needed > max_sg_per_table) ?
144 max_sg_per_table : total_sg_needed;
145
Akinobu Mitabfd9a532015-04-11 13:17:31 +0900146#ifdef CONFIG_ARCH_HAS_SG_CHAIN
147
148 /*
149 * Reserve extra element for chain entry
150 */
151 if (sg_per_table < total_sg_needed)
152 chain_entry = 1;
153
154#endif /* CONFIG_ARCH_HAS_SG_CHAIN */
155
156 sg = kcalloc(sg_per_table + chain_entry, sizeof(*sg),
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800157 GFP_KERNEL);
Andy Grover6708bb22011-06-08 10:36:43 -0700158 if (!sg) {
159 pr_err("Unable to allocate scatterlist array"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800160 " for struct rd_dev\n");
Dan Carpenter065f9712011-03-14 04:06:03 -0700161 return -ENOMEM;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800162 }
163
Akinobu Mitabfd9a532015-04-11 13:17:31 +0900164 sg_init_table(sg, sg_per_table + chain_entry);
165
166#ifdef CONFIG_ARCH_HAS_SG_CHAIN
167
168 if (i > 0) {
169 sg_chain(sg_table[i - 1].sg_table,
170 max_sg_per_table + 1, sg);
171 }
172
173#endif /* CONFIG_ARCH_HAS_SG_CHAIN */
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800174
175 sg_table[i].sg_table = sg;
176 sg_table[i].rd_sg_count = sg_per_table;
177 sg_table[i].page_start_offset = page_offset;
178 sg_table[i++].page_end_offset = (page_offset + sg_per_table)
179 - 1;
180
181 for (j = 0; j < sg_per_table; j++) {
182 pg = alloc_pages(GFP_KERNEL, 0);
Andy Grover6708bb22011-06-08 10:36:43 -0700183 if (!pg) {
184 pr_err("Unable to allocate scatterlist"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800185 " pages for struct rd_dev_sg_table\n");
Dan Carpenter065f9712011-03-14 04:06:03 -0700186 return -ENOMEM;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800187 }
188 sg_assign_page(&sg[j], pg);
189 sg[j].length = PAGE_SIZE;
Nicholas Bellinger4442dc82014-01-07 22:40:27 +0000190
191 p = kmap(pg);
192 memset(p, init_payload, PAGE_SIZE);
193 kunmap(pg);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800194 }
195
196 page_offset += sg_per_table;
197 total_sg_needed -= sg_per_table;
198 }
199
Nicholas Bellinger4442dc82014-01-07 22:40:27 +0000200 return 0;
201}
202
203static int rd_build_device_space(struct rd_dev *rd_dev)
204{
205 struct rd_dev_sg_table *sg_table;
206 u32 sg_tables, total_sg_needed;
207 u32 max_sg_per_table = (RD_MAX_ALLOCATION_SIZE /
208 sizeof(struct scatterlist));
209 int rc;
210
211 if (rd_dev->rd_page_count <= 0) {
212 pr_err("Illegal page count: %u for Ramdisk device\n",
213 rd_dev->rd_page_count);
214 return -EINVAL;
215 }
216
217 /* Don't need backing pages for NULLIO */
218 if (rd_dev->rd_flags & RDF_NULLIO)
219 return 0;
220
221 total_sg_needed = rd_dev->rd_page_count;
222
223 sg_tables = (total_sg_needed / max_sg_per_table) + 1;
224
225 sg_table = kzalloc(sg_tables * sizeof(struct rd_dev_sg_table), GFP_KERNEL);
226 if (!sg_table) {
227 pr_err("Unable to allocate memory for Ramdisk"
228 " scatterlist tables\n");
229 return -ENOMEM;
230 }
231
232 rd_dev->sg_table_array = sg_table;
233 rd_dev->sg_table_count = sg_tables;
234
235 rc = rd_allocate_sgl_table(rd_dev, sg_table, total_sg_needed, 0x00);
236 if (rc)
237 return rc;
238
Andy Grover6708bb22011-06-08 10:36:43 -0700239 pr_debug("CORE_RD[%u] - Built Ramdisk Device ID: %u space of"
Nicholas Bellinger4442dc82014-01-07 22:40:27 +0000240 " %u pages in %u tables\n", rd_dev->rd_host->rd_host_id,
241 rd_dev->rd_dev_id, rd_dev->rd_page_count,
242 rd_dev->sg_table_count);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800243
244 return 0;
245}
246
Nicholas Bellingerd7e8eb52014-01-07 23:24:14 +0000247static void rd_release_prot_space(struct rd_dev *rd_dev)
248{
249 u32 page_count;
250
251 if (!rd_dev->sg_prot_array || !rd_dev->sg_prot_count)
252 return;
253
254 page_count = rd_release_sgl_table(rd_dev, rd_dev->sg_prot_array,
255 rd_dev->sg_prot_count);
256
257 pr_debug("CORE_RD[%u] - Released protection space for Ramdisk"
258 " Device ID: %u, pages %u in %u tables total bytes %lu\n",
259 rd_dev->rd_host->rd_host_id, rd_dev->rd_dev_id, page_count,
260 rd_dev->sg_table_count, (unsigned long)page_count * PAGE_SIZE);
261
262 rd_dev->sg_prot_array = NULL;
263 rd_dev->sg_prot_count = 0;
264}
265
Quinn Tran9d2e59f2014-03-28 19:05:27 -0400266static int rd_build_prot_space(struct rd_dev *rd_dev, int prot_length, int block_size)
Nicholas Bellingerd7e8eb52014-01-07 23:24:14 +0000267{
268 struct rd_dev_sg_table *sg_table;
269 u32 total_sg_needed, sg_tables;
270 u32 max_sg_per_table = (RD_MAX_ALLOCATION_SIZE /
271 sizeof(struct scatterlist));
272 int rc;
273
274 if (rd_dev->rd_flags & RDF_NULLIO)
275 return 0;
Quinn Tran9d2e59f2014-03-28 19:05:27 -0400276 /*
277 * prot_length=8byte dif data
278 * tot sg needed = rd_page_count * (PGSZ/block_size) *
279 * (prot_length/block_size) + pad
280 * PGSZ canceled each other.
281 */
282 total_sg_needed = (rd_dev->rd_page_count * prot_length / block_size) + 1;
Nicholas Bellingerd7e8eb52014-01-07 23:24:14 +0000283
284 sg_tables = (total_sg_needed / max_sg_per_table) + 1;
285
286 sg_table = kzalloc(sg_tables * sizeof(struct rd_dev_sg_table), GFP_KERNEL);
287 if (!sg_table) {
288 pr_err("Unable to allocate memory for Ramdisk protection"
289 " scatterlist tables\n");
290 return -ENOMEM;
291 }
292
293 rd_dev->sg_prot_array = sg_table;
294 rd_dev->sg_prot_count = sg_tables;
295
296 rc = rd_allocate_sgl_table(rd_dev, sg_table, total_sg_needed, 0xff);
297 if (rc)
298 return rc;
299
300 pr_debug("CORE_RD[%u] - Built Ramdisk Device ID: %u prot space of"
301 " %u pages in %u tables\n", rd_dev->rd_host->rd_host_id,
302 rd_dev->rd_dev_id, total_sg_needed, rd_dev->sg_prot_count);
303
304 return 0;
305}
306
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400307static struct se_device *rd_alloc_device(struct se_hba *hba, const char *name)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800308{
309 struct rd_dev *rd_dev;
310 struct rd_host *rd_host = hba->hba_ptr;
311
312 rd_dev = kzalloc(sizeof(struct rd_dev), GFP_KERNEL);
Andy Grover6708bb22011-06-08 10:36:43 -0700313 if (!rd_dev) {
314 pr_err("Unable to allocate memory for struct rd_dev\n");
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800315 return NULL;
316 }
317
318 rd_dev->rd_host = rd_host;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800319
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400320 return &rd_dev->dev;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800321}
322
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400323static int rd_configure_device(struct se_device *dev)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800324{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400325 struct rd_dev *rd_dev = RD_DEV(dev);
326 struct rd_host *rd_host = dev->se_hba->hba_ptr;
327 int ret;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800328
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400329 if (!(rd_dev->rd_flags & RDF_HAS_PAGE_COUNT)) {
330 pr_debug("Missing rd_pages= parameter\n");
331 return -EINVAL;
332 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800333
Dan Carpenter065f9712011-03-14 04:06:03 -0700334 ret = rd_build_device_space(rd_dev);
335 if (ret < 0)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800336 goto fail;
337
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400338 dev->dev_attrib.hw_block_size = RD_BLOCKSIZE;
339 dev->dev_attrib.hw_max_sectors = UINT_MAX;
340 dev->dev_attrib.hw_queue_depth = RD_MAX_DEVICE_QUEUE_DEPTH;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800341
342 rd_dev->rd_dev_id = rd_host->rd_host_dev_id_count++;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800343
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400344 pr_debug("CORE_RD[%u] - Added TCM MEMCPY Ramdisk Device ID: %u of"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800345 " %u pages in %u tables, %lu total bytes\n",
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400346 rd_host->rd_host_id, rd_dev->rd_dev_id, rd_dev->rd_page_count,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800347 rd_dev->sg_table_count,
348 (unsigned long)(rd_dev->rd_page_count * PAGE_SIZE));
349
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400350 return 0;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800351
352fail:
353 rd_release_device_space(rd_dev);
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400354 return ret;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800355}
356
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400357static void rd_free_device(struct se_device *dev)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800358{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400359 struct rd_dev *rd_dev = RD_DEV(dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800360
361 rd_release_device_space(rd_dev);
362 kfree(rd_dev);
363}
364
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800365static struct rd_dev_sg_table *rd_get_sg_table(struct rd_dev *rd_dev, u32 page)
366{
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800367 struct rd_dev_sg_table *sg_table;
Martin Svec8f678352013-01-15 12:43:35 -0800368 u32 i, sg_per_table = (RD_MAX_ALLOCATION_SIZE /
369 sizeof(struct scatterlist));
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800370
Martin Svec8f678352013-01-15 12:43:35 -0800371 i = page / sg_per_table;
372 if (i < rd_dev->sg_table_count) {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800373 sg_table = &rd_dev->sg_table_array[i];
374 if ((sg_table->page_start_offset <= page) &&
375 (sg_table->page_end_offset >= page))
376 return sg_table;
377 }
378
Andy Grover6708bb22011-06-08 10:36:43 -0700379 pr_err("Unable to locate struct rd_dev_sg_table for page: %u\n",
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800380 page);
381
382 return NULL;
383}
384
Nicholas Bellinger6e611112014-01-08 12:06:30 +0000385static struct rd_dev_sg_table *rd_get_prot_table(struct rd_dev *rd_dev, u32 page)
386{
387 struct rd_dev_sg_table *sg_table;
388 u32 i, sg_per_table = (RD_MAX_ALLOCATION_SIZE /
389 sizeof(struct scatterlist));
390
391 i = page / sg_per_table;
392 if (i < rd_dev->sg_prot_count) {
393 sg_table = &rd_dev->sg_prot_array[i];
394 if ((sg_table->page_start_offset <= page) &&
395 (sg_table->page_end_offset >= page))
396 return sg_table;
397 }
398
399 pr_err("Unable to locate struct prot rd_dev_sg_table for page: %u\n",
400 page);
401
402 return NULL;
403}
404
Akinobu Mita6766cc82015-04-05 23:59:38 +0900405typedef sense_reason_t (*dif_verify)(struct se_cmd *, sector_t, unsigned int,
406 unsigned int, struct scatterlist *, int);
407
408static sense_reason_t rd_do_prot_rw(struct se_cmd *cmd, dif_verify dif_verify)
409{
410 struct se_device *se_dev = cmd->se_dev;
411 struct rd_dev *dev = RD_DEV(se_dev);
412 struct rd_dev_sg_table *prot_table;
Akinobu Mitabfd9a532015-04-11 13:17:31 +0900413 bool need_to_release = false;
Akinobu Mita6766cc82015-04-05 23:59:38 +0900414 struct scatterlist *prot_sg;
415 u32 sectors = cmd->data_length / se_dev->dev_attrib.block_size;
416 u32 prot_offset, prot_page;
Akinobu Mitabfd9a532015-04-11 13:17:31 +0900417 u32 prot_npages __maybe_unused;
Akinobu Mita6766cc82015-04-05 23:59:38 +0900418 u64 tmp;
Akinobu Mitabfd9a532015-04-11 13:17:31 +0900419 sense_reason_t rc = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
Akinobu Mita6766cc82015-04-05 23:59:38 +0900420
421 tmp = cmd->t_task_lba * se_dev->prot_length;
422 prot_offset = do_div(tmp, PAGE_SIZE);
423 prot_page = tmp;
424
425 prot_table = rd_get_prot_table(dev, prot_page);
426 if (!prot_table)
427 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
428
429 prot_sg = &prot_table->sg_table[prot_page -
430 prot_table->page_start_offset];
431
Akinobu Mitabfd9a532015-04-11 13:17:31 +0900432#ifndef CONFIG_ARCH_HAS_SG_CHAIN
433
434 prot_npages = DIV_ROUND_UP(prot_offset + sectors * se_dev->prot_length,
435 PAGE_SIZE);
436
437 /*
438 * Allocate temporaly contiguous scatterlist entries if prot pages
439 * straddles multiple scatterlist tables.
440 */
441 if (prot_table->page_end_offset < prot_page + prot_npages - 1) {
442 int i;
443
444 prot_sg = kcalloc(prot_npages, sizeof(*prot_sg), GFP_KERNEL);
445 if (!prot_sg)
446 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
447
448 need_to_release = true;
449 sg_init_table(prot_sg, prot_npages);
450
451 for (i = 0; i < prot_npages; i++) {
452 if (prot_page + i > prot_table->page_end_offset) {
453 prot_table = rd_get_prot_table(dev,
454 prot_page + i);
455 if (!prot_table) {
456 kfree(prot_sg);
457 return rc;
458 }
459 sg_unmark_end(&prot_sg[i - 1]);
460 }
461 prot_sg[i] = prot_table->sg_table[prot_page + i -
462 prot_table->page_start_offset];
463 }
464 }
465
466#endif /* !CONFIG_ARCH_HAS_SG_CHAIN */
467
Akinobu Mita6766cc82015-04-05 23:59:38 +0900468 rc = dif_verify(cmd, cmd->t_task_lba, sectors, 0, prot_sg, prot_offset);
Akinobu Mitabfd9a532015-04-11 13:17:31 +0900469 if (need_to_release)
470 kfree(prot_sg);
Akinobu Mita6766cc82015-04-05 23:59:38 +0900471
472 return rc;
473}
474
Christoph Hellwigde103c92012-11-06 12:24:09 -0800475static sense_reason_t
Nicholas Bellingera82a9532013-08-19 23:57:30 -0700476rd_execute_rw(struct se_cmd *cmd, struct scatterlist *sgl, u32 sgl_nents,
477 enum dma_data_direction data_direction)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800478{
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400479 struct se_device *se_dev = cmd->se_dev;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400480 struct rd_dev *dev = RD_DEV(se_dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800481 struct rd_dev_sg_table *table;
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100482 struct scatterlist *rd_sg;
483 struct sg_mapping_iter m;
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400484 u32 rd_offset;
485 u32 rd_size;
486 u32 rd_page;
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100487 u32 src_len;
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400488 u64 tmp;
Nicholas Bellinger6e611112014-01-08 12:06:30 +0000489 sense_reason_t rc;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800490
Nicholas Bellinger52c07422013-05-11 16:16:49 -0700491 if (dev->rd_flags & RDF_NULLIO) {
492 target_complete_cmd(cmd, SAM_STAT_GOOD);
493 return 0;
494 }
495
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400496 tmp = cmd->t_task_lba * se_dev->dev_attrib.block_size;
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400497 rd_offset = do_div(tmp, PAGE_SIZE);
498 rd_page = tmp;
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400499 rd_size = cmd->data_length;
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400500
501 table = rd_get_sg_table(dev, rd_page);
Andy Grover6708bb22011-06-08 10:36:43 -0700502 if (!table)
Christoph Hellwigde103c92012-11-06 12:24:09 -0800503 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800504
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400505 rd_sg = &table->sg_table[rd_page - table->page_start_offset];
Andy Grover6708bb22011-06-08 10:36:43 -0700506
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100507 pr_debug("RD[%u]: %s LBA: %llu, Size: %u Page: %u, Offset: %u\n",
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400508 dev->rd_dev_id,
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400509 data_direction == DMA_FROM_DEVICE ? "Read" : "Write",
510 cmd->t_task_lba, rd_size, rd_page, rd_offset);
Andy Grover6708bb22011-06-08 10:36:43 -0700511
Nicholas Bellinger17627422015-03-27 23:15:04 -0700512 if (cmd->prot_type && se_dev->dev_attrib.pi_prot_type &&
513 data_direction == DMA_TO_DEVICE) {
Akinobu Mita6766cc82015-04-05 23:59:38 +0900514 rc = rd_do_prot_rw(cmd, sbc_dif_verify_write);
Nicholas Bellinger6e611112014-01-08 12:06:30 +0000515 if (rc)
516 return rc;
517 }
518
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100519 src_len = PAGE_SIZE - rd_offset;
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400520 sg_miter_start(&m, sgl, sgl_nents,
521 data_direction == DMA_FROM_DEVICE ?
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400522 SG_MITER_TO_SG : SG_MITER_FROM_SG);
523 while (rd_size) {
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100524 u32 len;
525 void *rd_addr;
Andy Grover6708bb22011-06-08 10:36:43 -0700526
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100527 sg_miter_next(&m);
Hannes Reineckebbf344e2013-02-06 14:42:28 +0100528 if (!(u32)m.length) {
529 pr_debug("RD[%u]: invalid sgl %p len %zu\n",
530 dev->rd_dev_id, m.addr, m.length);
531 sg_miter_stop(&m);
532 return TCM_INCORRECT_AMOUNT_OF_DATA;
533 }
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100534 len = min((u32)m.length, src_len);
Hannes Reineckebbf344e2013-02-06 14:42:28 +0100535 if (len > rd_size) {
536 pr_debug("RD[%u]: size underrun page %d offset %d "
537 "size %d\n", dev->rd_dev_id,
538 rd_page, rd_offset, rd_size);
539 len = rd_size;
540 }
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100541 m.consumed = len;
Andy Grover6708bb22011-06-08 10:36:43 -0700542
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100543 rd_addr = sg_virt(rd_sg) + rd_offset;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800544
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400545 if (data_direction == DMA_FROM_DEVICE)
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100546 memcpy(m.addr, rd_addr, len);
547 else
548 memcpy(rd_addr, m.addr, len);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800549
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400550 rd_size -= len;
551 if (!rd_size)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800552 continue;
553
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100554 src_len -= len;
555 if (src_len) {
556 rd_offset += len;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800557 continue;
558 }
Andy Grover6708bb22011-06-08 10:36:43 -0700559
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100560 /* rd page completed, next one please */
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400561 rd_page++;
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100562 rd_offset = 0;
563 src_len = PAGE_SIZE;
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400564 if (rd_page <= table->page_end_offset) {
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100565 rd_sg++;
566 continue;
567 }
Andy Grover6708bb22011-06-08 10:36:43 -0700568
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400569 table = rd_get_sg_table(dev, rd_page);
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100570 if (!table) {
571 sg_miter_stop(&m);
Christoph Hellwigde103c92012-11-06 12:24:09 -0800572 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800573 }
574
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100575 /* since we increment, the first sg entry is correct */
576 rd_sg = table->sg_table;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800577 }
Sebastian Andrzej Siewior65b0c782011-11-30 10:48:30 +0100578 sg_miter_stop(&m);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800579
Nicholas Bellinger17627422015-03-27 23:15:04 -0700580 if (cmd->prot_type && se_dev->dev_attrib.pi_prot_type &&
581 data_direction == DMA_FROM_DEVICE) {
Akinobu Mita6766cc82015-04-05 23:59:38 +0900582 rc = rd_do_prot_rw(cmd, sbc_dif_verify_read);
Nicholas Bellinger6e611112014-01-08 12:06:30 +0000583 if (rc)
584 return rc;
585 }
586
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400587 target_complete_cmd(cmd, SAM_STAT_GOOD);
Nicholas Bellinger03e98c92011-11-04 02:36:16 -0700588 return 0;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800589}
590
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800591enum {
Nicholas Bellinger52c07422013-05-11 16:16:49 -0700592 Opt_rd_pages, Opt_rd_nullio, Opt_err
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800593};
594
595static match_table_t tokens = {
596 {Opt_rd_pages, "rd_pages=%d"},
Nicholas Bellinger52c07422013-05-11 16:16:49 -0700597 {Opt_rd_nullio, "rd_nullio=%d"},
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800598 {Opt_err, NULL}
599};
600
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400601static ssize_t rd_set_configfs_dev_params(struct se_device *dev,
602 const char *page, ssize_t count)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800603{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400604 struct rd_dev *rd_dev = RD_DEV(dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800605 char *orig, *ptr, *opts;
606 substring_t args[MAX_OPT_ARGS];
607 int ret = 0, arg, token;
608
609 opts = kstrdup(page, GFP_KERNEL);
610 if (!opts)
611 return -ENOMEM;
612
613 orig = opts;
614
Sebastian Andrzej Siewior90c161b2011-11-23 20:53:17 +0100615 while ((ptr = strsep(&opts, ",\n")) != NULL) {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800616 if (!*ptr)
617 continue;
618
619 token = match_token(ptr, tokens, args);
620 switch (token) {
621 case Opt_rd_pages:
622 match_int(args, &arg);
623 rd_dev->rd_page_count = arg;
Andy Grover6708bb22011-06-08 10:36:43 -0700624 pr_debug("RAMDISK: Referencing Page"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800625 " Count: %u\n", rd_dev->rd_page_count);
626 rd_dev->rd_flags |= RDF_HAS_PAGE_COUNT;
627 break;
Nicholas Bellinger52c07422013-05-11 16:16:49 -0700628 case Opt_rd_nullio:
629 match_int(args, &arg);
630 if (arg != 1)
631 break;
632
633 pr_debug("RAMDISK: Setting NULLIO flag: %d\n", arg);
634 rd_dev->rd_flags |= RDF_NULLIO;
635 break;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800636 default:
637 break;
638 }
639 }
640
641 kfree(orig);
642 return (!ret) ? count : ret;
643}
644
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400645static ssize_t rd_show_configfs_dev_params(struct se_device *dev, char *b)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800646{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400647 struct rd_dev *rd_dev = RD_DEV(dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800648
Christoph Hellwig8feb58d2012-03-26 04:56:41 -0400649 ssize_t bl = sprintf(b, "TCM RamDisk ID: %u RamDisk Makeup: rd_mcp\n",
650 rd_dev->rd_dev_id);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800651 bl += sprintf(b + bl, " PAGES/PAGE_SIZE: %u*%lu"
Nicholas Bellinger52c07422013-05-11 16:16:49 -0700652 " SG_table_count: %u nullio: %d\n", rd_dev->rd_page_count,
653 PAGE_SIZE, rd_dev->sg_table_count,
654 !!(rd_dev->rd_flags & RDF_NULLIO));
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800655 return bl;
656}
657
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800658static sector_t rd_get_blocks(struct se_device *dev)
659{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400660 struct rd_dev *rd_dev = RD_DEV(dev);
661
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800662 unsigned long long blocks_long = ((rd_dev->rd_page_count * PAGE_SIZE) /
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400663 dev->dev_attrib.block_size) - 1;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800664
665 return blocks_long;
666}
667
Nicholas Bellingerd7e8eb52014-01-07 23:24:14 +0000668static int rd_init_prot(struct se_device *dev)
669{
670 struct rd_dev *rd_dev = RD_DEV(dev);
671
672 if (!dev->dev_attrib.pi_prot_type)
673 return 0;
674
Quinn Tran9d2e59f2014-03-28 19:05:27 -0400675 return rd_build_prot_space(rd_dev, dev->prot_length,
676 dev->dev_attrib.block_size);
Nicholas Bellingerd7e8eb52014-01-07 23:24:14 +0000677}
678
679static void rd_free_prot(struct se_device *dev)
680{
681 struct rd_dev *rd_dev = RD_DEV(dev);
682
683 rd_release_prot_space(rd_dev);
684}
685
Christoph Hellwig9e999a62012-10-07 10:55:50 -0400686static struct sbc_ops rd_sbc_ops = {
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400687 .execute_rw = rd_execute_rw,
688};
689
Christoph Hellwigde103c92012-11-06 12:24:09 -0800690static sense_reason_t
691rd_parse_cdb(struct se_cmd *cmd)
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400692{
Christoph Hellwig9e999a62012-10-07 10:55:50 -0400693 return sbc_parse_cdb(cmd, &rd_sbc_ops);
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400694}
695
Nicholas Bellinger03a62742014-11-28 05:06:10 +0000696DEF_TB_DEFAULT_ATTRIBS(rd_mcp);
697
698static struct configfs_attribute *rd_mcp_backend_dev_attrs[] = {
699 &rd_mcp_dev_attrib_emulate_model_alias.attr,
700 &rd_mcp_dev_attrib_emulate_dpo.attr,
701 &rd_mcp_dev_attrib_emulate_fua_write.attr,
702 &rd_mcp_dev_attrib_emulate_fua_read.attr,
703 &rd_mcp_dev_attrib_emulate_write_cache.attr,
704 &rd_mcp_dev_attrib_emulate_ua_intlck_ctrl.attr,
705 &rd_mcp_dev_attrib_emulate_tas.attr,
706 &rd_mcp_dev_attrib_emulate_tpu.attr,
707 &rd_mcp_dev_attrib_emulate_tpws.attr,
708 &rd_mcp_dev_attrib_emulate_caw.attr,
709 &rd_mcp_dev_attrib_emulate_3pc.attr,
710 &rd_mcp_dev_attrib_pi_prot_type.attr,
711 &rd_mcp_dev_attrib_hw_pi_prot_type.attr,
712 &rd_mcp_dev_attrib_pi_prot_format.attr,
713 &rd_mcp_dev_attrib_enforce_pr_isids.attr,
714 &rd_mcp_dev_attrib_is_nonrot.attr,
715 &rd_mcp_dev_attrib_emulate_rest_reord.attr,
716 &rd_mcp_dev_attrib_force_pr_aptpl.attr,
717 &rd_mcp_dev_attrib_hw_block_size.attr,
718 &rd_mcp_dev_attrib_block_size.attr,
719 &rd_mcp_dev_attrib_hw_max_sectors.attr,
Nicholas Bellinger03a62742014-11-28 05:06:10 +0000720 &rd_mcp_dev_attrib_optimal_sectors.attr,
721 &rd_mcp_dev_attrib_hw_queue_depth.attr,
722 &rd_mcp_dev_attrib_queue_depth.attr,
723 &rd_mcp_dev_attrib_max_unmap_lba_count.attr,
724 &rd_mcp_dev_attrib_max_unmap_block_desc_count.attr,
725 &rd_mcp_dev_attrib_unmap_granularity.attr,
726 &rd_mcp_dev_attrib_unmap_granularity_alignment.attr,
727 &rd_mcp_dev_attrib_max_write_same_len.attr,
728 NULL,
729};
730
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800731static struct se_subsystem_api rd_mcp_template = {
732 .name = "rd_mcp",
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400733 .inquiry_prod = "RAMDISK-MCP",
734 .inquiry_rev = RD_MCP_VERSION,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800735 .transport_type = TRANSPORT_PLUGIN_VHBA_VDEV,
736 .attach_hba = rd_attach_hba,
737 .detach_hba = rd_detach_hba,
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400738 .alloc_device = rd_alloc_device,
739 .configure_device = rd_configure_device,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800740 .free_device = rd_free_device,
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400741 .parse_cdb = rd_parse_cdb,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800742 .set_configfs_dev_params = rd_set_configfs_dev_params,
743 .show_configfs_dev_params = rd_show_configfs_dev_params,
Christoph Hellwig6f23ac82012-10-07 10:55:53 -0400744 .get_device_type = sbc_get_device_type,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800745 .get_blocks = rd_get_blocks,
Nicholas Bellingerd7e8eb52014-01-07 23:24:14 +0000746 .init_prot = rd_init_prot,
747 .free_prot = rd_free_prot,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800748};
749
750int __init rd_module_init(void)
751{
Nicholas Bellinger03a62742014-11-28 05:06:10 +0000752 struct target_backend_cits *tbc = &rd_mcp_template.tb_cits;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800753 int ret;
754
Nicholas Bellinger03a62742014-11-28 05:06:10 +0000755 target_core_setup_sub_cits(&rd_mcp_template);
756 tbc->tb_dev_attrib_cit.ct_attrs = rd_mcp_backend_dev_attrs;
757
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800758 ret = transport_subsystem_register(&rd_mcp_template);
759 if (ret < 0) {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800760 return ret;
761 }
762
763 return 0;
764}
765
766void rd_module_exit(void)
767{
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800768 transport_subsystem_release(&rd_mcp_template);
769}