Merge branch 'for-upstream' of git://git.kernel.org/pub/scm/linux/kernel/git/bluetoot...
[linux-2.6-block.git] / drivers / target / target_core_rd.c
CommitLineData
c66ac9db
NB
1/*******************************************************************************
2 * Filename: target_core_rd.c
3 *
4 * This file contains the Storage Engine <-> Ramdisk transport
5 * specific functions.
6 *
4c76251e 7 * (c) Copyright 2003-2013 Datera, Inc.
c66ac9db
NB
8 *
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
c66ac9db
NB
27#include <linux/string.h>
28#include <linux/parser.h>
29#include <linux/timer.h>
30#include <linux/blkdev.h>
31#include <linux/slab.h>
32#include <linux/spinlock.h>
c66ac9db
NB
33#include <scsi/scsi.h>
34#include <scsi/scsi_host.h>
35
36#include <target/target_core_base.h>
c4795fb2 37#include <target/target_core_backend.h>
c66ac9db
NB
38
39#include "target_core_rd.h"
40
0fd97ccf
CH
41static inline struct rd_dev *RD_DEV(struct se_device *dev)
42{
43 return container_of(dev, struct rd_dev, dev);
44}
c66ac9db 45
c66ac9db
NB
46/* 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);
6708bb27
AG
55 if (!rd_host) {
56 pr_err("Unable to allocate memory for struct rd_host\n");
c66ac9db
NB
57 return -ENOMEM;
58 }
59
60 rd_host->rd_host_id = host_id;
61
5951146d 62 hba->hba_ptr = rd_host;
c66ac9db 63
6708bb27 64 pr_debug("CORE_HBA[%d] - TCM Ramdisk HBA Driver %s on"
c66ac9db
NB
65 " Generic Target Core Stack %s\n", hba->hba_id,
66 RD_HBA_VERSION, TARGET_CORE_MOD_VERSION);
c66ac9db
NB
67
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
6708bb27 75 pr_debug("CORE_HBA[%d] - Detached Ramdisk HBA: %u from"
c66ac9db
NB
76 " Generic Target Core\n", hba->hba_id, rd_host->rd_host_id);
77
78 kfree(rd_host);
79 hba->hba_ptr = NULL;
80}
81
82/* rd_release_device_space():
83 *
84 *
85 */
86static void rd_release_device_space(struct rd_dev *rd_dev)
87{
88 u32 i, j, page_count = 0, sg_per_table;
89 struct rd_dev_sg_table *sg_table;
90 struct page *pg;
91 struct scatterlist *sg;
92
93 if (!rd_dev->sg_table_array || !rd_dev->sg_table_count)
94 return;
95
96 sg_table = rd_dev->sg_table_array;
97
98 for (i = 0; i < rd_dev->sg_table_count; i++) {
99 sg = sg_table[i].sg_table;
100 sg_per_table = sg_table[i].rd_sg_count;
101
102 for (j = 0; j < sg_per_table; j++) {
103 pg = sg_page(&sg[j]);
6708bb27 104 if (pg) {
c66ac9db
NB
105 __free_page(pg);
106 page_count++;
107 }
108 }
109
110 kfree(sg);
111 }
112
6708bb27 113 pr_debug("CORE_RD[%u] - Released device space for Ramdisk"
c66ac9db
NB
114 " Device ID: %u, pages %u in %u tables total bytes %lu\n",
115 rd_dev->rd_host->rd_host_id, rd_dev->rd_dev_id, page_count,
116 rd_dev->sg_table_count, (unsigned long)page_count * PAGE_SIZE);
117
118 kfree(sg_table);
119 rd_dev->sg_table_array = NULL;
120 rd_dev->sg_table_count = 0;
121}
122
123
124/* rd_build_device_space():
125 *
126 *
127 */
128static int rd_build_device_space(struct rd_dev *rd_dev)
129{
130 u32 i = 0, j, page_offset = 0, sg_per_table, sg_tables, total_sg_needed;
131 u32 max_sg_per_table = (RD_MAX_ALLOCATION_SIZE /
132 sizeof(struct scatterlist));
133 struct rd_dev_sg_table *sg_table;
134 struct page *pg;
135 struct scatterlist *sg;
136
137 if (rd_dev->rd_page_count <= 0) {
6708bb27 138 pr_err("Illegal page count: %u for Ramdisk device\n",
c66ac9db 139 rd_dev->rd_page_count);
065f9716 140 return -EINVAL;
c66ac9db 141 }
670caa9f
AG
142
143 /* Don't need backing pages for NULLIO */
144 if (rd_dev->rd_flags & RDF_NULLIO)
145 return 0;
146
c66ac9db
NB
147 total_sg_needed = rd_dev->rd_page_count;
148
149 sg_tables = (total_sg_needed / max_sg_per_table) + 1;
150
151 sg_table = kzalloc(sg_tables * sizeof(struct rd_dev_sg_table), GFP_KERNEL);
6708bb27
AG
152 if (!sg_table) {
153 pr_err("Unable to allocate memory for Ramdisk"
c66ac9db 154 " scatterlist tables\n");
065f9716 155 return -ENOMEM;
c66ac9db
NB
156 }
157
158 rd_dev->sg_table_array = sg_table;
159 rd_dev->sg_table_count = sg_tables;
160
161 while (total_sg_needed) {
162 sg_per_table = (total_sg_needed > max_sg_per_table) ?
163 max_sg_per_table : total_sg_needed;
164
165 sg = kzalloc(sg_per_table * sizeof(struct scatterlist),
166 GFP_KERNEL);
6708bb27
AG
167 if (!sg) {
168 pr_err("Unable to allocate scatterlist array"
c66ac9db 169 " for struct rd_dev\n");
065f9716 170 return -ENOMEM;
c66ac9db
NB
171 }
172
6708bb27 173 sg_init_table(sg, sg_per_table);
c66ac9db
NB
174
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);
6708bb27
AG
183 if (!pg) {
184 pr_err("Unable to allocate scatterlist"
c66ac9db 185 " pages for struct rd_dev_sg_table\n");
065f9716 186 return -ENOMEM;
c66ac9db
NB
187 }
188 sg_assign_page(&sg[j], pg);
189 sg[j].length = PAGE_SIZE;
190 }
191
192 page_offset += sg_per_table;
193 total_sg_needed -= sg_per_table;
194 }
195
6708bb27 196 pr_debug("CORE_RD[%u] - Built Ramdisk Device ID: %u space of"
c66ac9db
NB
197 " %u pages in %u tables\n", rd_dev->rd_host->rd_host_id,
198 rd_dev->rd_dev_id, rd_dev->rd_page_count,
199 rd_dev->sg_table_count);
200
201 return 0;
202}
203
0fd97ccf 204static struct se_device *rd_alloc_device(struct se_hba *hba, const char *name)
c66ac9db
NB
205{
206 struct rd_dev *rd_dev;
207 struct rd_host *rd_host = hba->hba_ptr;
208
209 rd_dev = kzalloc(sizeof(struct rd_dev), GFP_KERNEL);
6708bb27
AG
210 if (!rd_dev) {
211 pr_err("Unable to allocate memory for struct rd_dev\n");
c66ac9db
NB
212 return NULL;
213 }
214
215 rd_dev->rd_host = rd_host;
c66ac9db 216
0fd97ccf 217 return &rd_dev->dev;
c66ac9db
NB
218}
219
0fd97ccf 220static int rd_configure_device(struct se_device *dev)
c66ac9db 221{
0fd97ccf
CH
222 struct rd_dev *rd_dev = RD_DEV(dev);
223 struct rd_host *rd_host = dev->se_hba->hba_ptr;
224 int ret;
c66ac9db 225
0fd97ccf
CH
226 if (!(rd_dev->rd_flags & RDF_HAS_PAGE_COUNT)) {
227 pr_debug("Missing rd_pages= parameter\n");
228 return -EINVAL;
229 }
c66ac9db 230
065f9716
DC
231 ret = rd_build_device_space(rd_dev);
232 if (ret < 0)
c66ac9db
NB
233 goto fail;
234
0fd97ccf
CH
235 dev->dev_attrib.hw_block_size = RD_BLOCKSIZE;
236 dev->dev_attrib.hw_max_sectors = UINT_MAX;
237 dev->dev_attrib.hw_queue_depth = RD_MAX_DEVICE_QUEUE_DEPTH;
c66ac9db
NB
238
239 rd_dev->rd_dev_id = rd_host->rd_host_dev_id_count++;
c66ac9db 240
8feb58d0 241 pr_debug("CORE_RD[%u] - Added TCM MEMCPY Ramdisk Device ID: %u of"
c66ac9db 242 " %u pages in %u tables, %lu total bytes\n",
8feb58d0 243 rd_host->rd_host_id, rd_dev->rd_dev_id, rd_dev->rd_page_count,
c66ac9db
NB
244 rd_dev->sg_table_count,
245 (unsigned long)(rd_dev->rd_page_count * PAGE_SIZE));
246
0fd97ccf 247 return 0;
c66ac9db
NB
248
249fail:
250 rd_release_device_space(rd_dev);
0fd97ccf 251 return ret;
c66ac9db
NB
252}
253
0fd97ccf 254static void rd_free_device(struct se_device *dev)
c66ac9db 255{
0fd97ccf 256 struct rd_dev *rd_dev = RD_DEV(dev);
c66ac9db
NB
257
258 rd_release_device_space(rd_dev);
259 kfree(rd_dev);
260}
261
c66ac9db
NB
262static struct rd_dev_sg_table *rd_get_sg_table(struct rd_dev *rd_dev, u32 page)
263{
c66ac9db 264 struct rd_dev_sg_table *sg_table;
8f67835f
MS
265 u32 i, sg_per_table = (RD_MAX_ALLOCATION_SIZE /
266 sizeof(struct scatterlist));
c66ac9db 267
8f67835f
MS
268 i = page / sg_per_table;
269 if (i < rd_dev->sg_table_count) {
c66ac9db
NB
270 sg_table = &rd_dev->sg_table_array[i];
271 if ((sg_table->page_start_offset <= page) &&
272 (sg_table->page_end_offset >= page))
273 return sg_table;
274 }
275
6708bb27 276 pr_err("Unable to locate struct rd_dev_sg_table for page: %u\n",
c66ac9db
NB
277 page);
278
279 return NULL;
280}
281
de103c93 282static sense_reason_t
a82a9538
NB
283rd_execute_rw(struct se_cmd *cmd, struct scatterlist *sgl, u32 sgl_nents,
284 enum dma_data_direction data_direction)
c66ac9db 285{
5787cacd 286 struct se_device *se_dev = cmd->se_dev;
0fd97ccf 287 struct rd_dev *dev = RD_DEV(se_dev);
c66ac9db 288 struct rd_dev_sg_table *table;
65b0c78d
SAS
289 struct scatterlist *rd_sg;
290 struct sg_mapping_iter m;
8feb58d0
CH
291 u32 rd_offset;
292 u32 rd_size;
293 u32 rd_page;
65b0c78d 294 u32 src_len;
8feb58d0 295 u64 tmp;
c66ac9db 296
52c07423
NB
297 if (dev->rd_flags & RDF_NULLIO) {
298 target_complete_cmd(cmd, SAM_STAT_GOOD);
299 return 0;
300 }
301
0fd97ccf 302 tmp = cmd->t_task_lba * se_dev->dev_attrib.block_size;
8feb58d0
CH
303 rd_offset = do_div(tmp, PAGE_SIZE);
304 rd_page = tmp;
5787cacd 305 rd_size = cmd->data_length;
8feb58d0
CH
306
307 table = rd_get_sg_table(dev, rd_page);
6708bb27 308 if (!table)
de103c93 309 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
c66ac9db 310
8feb58d0 311 rd_sg = &table->sg_table[rd_page - table->page_start_offset];
6708bb27 312
65b0c78d 313 pr_debug("RD[%u]: %s LBA: %llu, Size: %u Page: %u, Offset: %u\n",
8feb58d0 314 dev->rd_dev_id,
5787cacd
CH
315 data_direction == DMA_FROM_DEVICE ? "Read" : "Write",
316 cmd->t_task_lba, rd_size, rd_page, rd_offset);
c66ac9db 317
65b0c78d 318 src_len = PAGE_SIZE - rd_offset;
5787cacd
CH
319 sg_miter_start(&m, sgl, sgl_nents,
320 data_direction == DMA_FROM_DEVICE ?
8feb58d0
CH
321 SG_MITER_TO_SG : SG_MITER_FROM_SG);
322 while (rd_size) {
65b0c78d
SAS
323 u32 len;
324 void *rd_addr;
c66ac9db 325
65b0c78d 326 sg_miter_next(&m);
bbf344e5
HR
327 if (!(u32)m.length) {
328 pr_debug("RD[%u]: invalid sgl %p len %zu\n",
329 dev->rd_dev_id, m.addr, m.length);
330 sg_miter_stop(&m);
331 return TCM_INCORRECT_AMOUNT_OF_DATA;
332 }
65b0c78d 333 len = min((u32)m.length, src_len);
bbf344e5
HR
334 if (len > rd_size) {
335 pr_debug("RD[%u]: size underrun page %d offset %d "
336 "size %d\n", dev->rd_dev_id,
337 rd_page, rd_offset, rd_size);
338 len = rd_size;
339 }
65b0c78d 340 m.consumed = len;
c66ac9db 341
65b0c78d 342 rd_addr = sg_virt(rd_sg) + rd_offset;
6708bb27 343
5787cacd 344 if (data_direction == DMA_FROM_DEVICE)
65b0c78d
SAS
345 memcpy(m.addr, rd_addr, len);
346 else
347 memcpy(rd_addr, m.addr, len);
c66ac9db 348
8feb58d0
CH
349 rd_size -= len;
350 if (!rd_size)
c66ac9db
NB
351 continue;
352
65b0c78d
SAS
353 src_len -= len;
354 if (src_len) {
355 rd_offset += len;
c66ac9db
NB
356 continue;
357 }
6708bb27 358
65b0c78d 359 /* rd page completed, next one please */
8feb58d0 360 rd_page++;
65b0c78d
SAS
361 rd_offset = 0;
362 src_len = PAGE_SIZE;
8feb58d0 363 if (rd_page <= table->page_end_offset) {
65b0c78d 364 rd_sg++;
c66ac9db
NB
365 continue;
366 }
6708bb27 367
8feb58d0 368 table = rd_get_sg_table(dev, rd_page);
65b0c78d
SAS
369 if (!table) {
370 sg_miter_stop(&m);
de103c93 371 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
65b0c78d 372 }
c66ac9db 373
65b0c78d
SAS
374 /* since we increment, the first sg entry is correct */
375 rd_sg = table->sg_table;
c66ac9db 376 }
65b0c78d 377 sg_miter_stop(&m);
c66ac9db 378
5787cacd 379 target_complete_cmd(cmd, SAM_STAT_GOOD);
03e98c9e 380 return 0;
c66ac9db
NB
381}
382
c66ac9db 383enum {
52c07423 384 Opt_rd_pages, Opt_rd_nullio, Opt_err
c66ac9db
NB
385};
386
387static match_table_t tokens = {
388 {Opt_rd_pages, "rd_pages=%d"},
52c07423 389 {Opt_rd_nullio, "rd_nullio=%d"},
c66ac9db
NB
390 {Opt_err, NULL}
391};
392
0fd97ccf
CH
393static ssize_t rd_set_configfs_dev_params(struct se_device *dev,
394 const char *page, ssize_t count)
c66ac9db 395{
0fd97ccf 396 struct rd_dev *rd_dev = RD_DEV(dev);
c66ac9db
NB
397 char *orig, *ptr, *opts;
398 substring_t args[MAX_OPT_ARGS];
399 int ret = 0, arg, token;
400
401 opts = kstrdup(page, GFP_KERNEL);
402 if (!opts)
403 return -ENOMEM;
404
405 orig = opts;
406
90c161b6 407 while ((ptr = strsep(&opts, ",\n")) != NULL) {
c66ac9db
NB
408 if (!*ptr)
409 continue;
410
411 token = match_token(ptr, tokens, args);
412 switch (token) {
413 case Opt_rd_pages:
414 match_int(args, &arg);
415 rd_dev->rd_page_count = arg;
6708bb27 416 pr_debug("RAMDISK: Referencing Page"
c66ac9db
NB
417 " Count: %u\n", rd_dev->rd_page_count);
418 rd_dev->rd_flags |= RDF_HAS_PAGE_COUNT;
419 break;
52c07423
NB
420 case Opt_rd_nullio:
421 match_int(args, &arg);
422 if (arg != 1)
423 break;
424
425 pr_debug("RAMDISK: Setting NULLIO flag: %d\n", arg);
426 rd_dev->rd_flags |= RDF_NULLIO;
427 break;
c66ac9db
NB
428 default:
429 break;
430 }
431 }
432
433 kfree(orig);
434 return (!ret) ? count : ret;
435}
436
0fd97ccf 437static ssize_t rd_show_configfs_dev_params(struct se_device *dev, char *b)
c66ac9db 438{
0fd97ccf 439 struct rd_dev *rd_dev = RD_DEV(dev);
c66ac9db 440
8feb58d0
CH
441 ssize_t bl = sprintf(b, "TCM RamDisk ID: %u RamDisk Makeup: rd_mcp\n",
442 rd_dev->rd_dev_id);
c66ac9db 443 bl += sprintf(b + bl, " PAGES/PAGE_SIZE: %u*%lu"
52c07423
NB
444 " SG_table_count: %u nullio: %d\n", rd_dev->rd_page_count,
445 PAGE_SIZE, rd_dev->sg_table_count,
446 !!(rd_dev->rd_flags & RDF_NULLIO));
c66ac9db
NB
447 return bl;
448}
449
c66ac9db
NB
450static sector_t rd_get_blocks(struct se_device *dev)
451{
0fd97ccf
CH
452 struct rd_dev *rd_dev = RD_DEV(dev);
453
c66ac9db 454 unsigned long long blocks_long = ((rd_dev->rd_page_count * PAGE_SIZE) /
0fd97ccf 455 dev->dev_attrib.block_size) - 1;
c66ac9db
NB
456
457 return blocks_long;
458}
459
9e999a6c 460static struct sbc_ops rd_sbc_ops = {
0c2ad7d1
CH
461 .execute_rw = rd_execute_rw,
462};
463
de103c93
CH
464static sense_reason_t
465rd_parse_cdb(struct se_cmd *cmd)
0c2ad7d1 466{
9e999a6c 467 return sbc_parse_cdb(cmd, &rd_sbc_ops);
0c2ad7d1
CH
468}
469
c66ac9db
NB
470static struct se_subsystem_api rd_mcp_template = {
471 .name = "rd_mcp",
0fd97ccf
CH
472 .inquiry_prod = "RAMDISK-MCP",
473 .inquiry_rev = RD_MCP_VERSION,
c66ac9db
NB
474 .transport_type = TRANSPORT_PLUGIN_VHBA_VDEV,
475 .attach_hba = rd_attach_hba,
476 .detach_hba = rd_detach_hba,
0fd97ccf
CH
477 .alloc_device = rd_alloc_device,
478 .configure_device = rd_configure_device,
c66ac9db 479 .free_device = rd_free_device,
0c2ad7d1 480 .parse_cdb = rd_parse_cdb,
c66ac9db
NB
481 .set_configfs_dev_params = rd_set_configfs_dev_params,
482 .show_configfs_dev_params = rd_show_configfs_dev_params,
6f23ac8a 483 .get_device_type = sbc_get_device_type,
c66ac9db
NB
484 .get_blocks = rd_get_blocks,
485};
486
487int __init rd_module_init(void)
488{
489 int ret;
490
c66ac9db
NB
491 ret = transport_subsystem_register(&rd_mcp_template);
492 if (ret < 0) {
c66ac9db
NB
493 return ret;
494 }
495
496 return 0;
497}
498
499void rd_module_exit(void)
500{
c66ac9db
NB
501 transport_subsystem_release(&rd_mcp_template);
502}