[deliverable/linux.git] / drivers / target / target_core_rd.c

/*******************************************************************************
 * Filename:  target_core_rd.c
 *
 * This file contains the Storage Engine <-> Ramdisk transport
 * specific functions.
 *
 * (c) Copyright 2003-2012 RisingTide Systems LLC.
 *
 * Nicholas A. Bellinger <nab@kernel.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 ******************************************************************************/

#include <linux/string.h>
#include <linux/parser.h>
#include <linux/timer.h>
#include <linux/blkdev.h>
#include <linux/slab.h>
#include <linux/spinlock.h>
#include <scsi/scsi.h>
#include <scsi/scsi_host.h>

#include <target/target_core_base.h>
#include <target/target_core_backend.h>

#include "target_core_rd.h"

static inline struct rd_dev *RD_DEV(struct se_device *dev)
{
	return container_of(dev, struct rd_dev, dev);
}

/*	rd_attach_hba(): (Part of se_subsystem_api_t template)
 *
 *
 */
static int rd_attach_hba(struct se_hba *hba, u32 host_id)
{
	struct rd_host *rd_host;

	rd_host = kzalloc(sizeof(struct rd_host), GFP_KERNEL);
	if (!rd_host) {
		pr_err("Unable to allocate memory for struct rd_host\n");
		return -ENOMEM;
	}

	rd_host->rd_host_id = host_id;

	hba->hba_ptr = rd_host;

	pr_debug("CORE_HBA[%d] - TCM Ramdisk HBA Driver %s on"
		" Generic Target Core Stack %s\n", hba->hba_id,
		RD_HBA_VERSION, TARGET_CORE_MOD_VERSION);

	return 0;
}

static void rd_detach_hba(struct se_hba *hba)
{
	struct rd_host *rd_host = hba->hba_ptr;

	pr_debug("CORE_HBA[%d] - Detached Ramdisk HBA: %u from"
		" Generic Target Core\n", hba->hba_id, rd_host->rd_host_id);

	kfree(rd_host);
	hba->hba_ptr = NULL;
}

/*	rd_release_device_space():
 *
 *
 */
static void rd_release_device_space(struct rd_dev *rd_dev)
{
	u32 i, j, page_count = 0, sg_per_table;
	struct rd_dev_sg_table *sg_table;
	struct page *pg;
	struct scatterlist *sg;

	if (!rd_dev->sg_table_array || !rd_dev->sg_table_count)
		return;

	sg_table = rd_dev->sg_table_array;

	for (i = 0; i < rd_dev->sg_table_count; i++) {
		sg = sg_table[i].sg_table;
		sg_per_table = sg_table[i].rd_sg_count;

		for (j = 0; j < sg_per_table; j++) {
			pg = sg_page(&sg[j]);
			if (pg) {
				__free_page(pg);
				page_count++;
			}
		}

		kfree(sg);
	}

	pr_debug("CORE_RD[%u] - Released device space for Ramdisk"
		" Device ID: %u, pages %u in %u tables total bytes %lu\n",
		rd_dev->rd_host->rd_host_id, rd_dev->rd_dev_id, page_count,
		rd_dev->sg_table_count, (unsigned long)page_count * PAGE_SIZE);

	kfree(sg_table);
	rd_dev->sg_table_array = NULL;
	rd_dev->sg_table_count = 0;
}


/*	rd_build_device_space():
 *
 *
 */
static int rd_build_device_space(struct rd_dev *rd_dev)
{
	u32 i = 0, j, page_offset = 0, sg_per_table, sg_tables, total_sg_needed;
	u32 max_sg_per_table = (RD_MAX_ALLOCATION_SIZE /
				sizeof(struct scatterlist));
	struct rd_dev_sg_table *sg_table;
	struct page *pg;
	struct scatterlist *sg;

	if (rd_dev->rd_page_count <= 0) {
		pr_err("Illegal page count: %u for Ramdisk device\n",
			rd_dev->rd_page_count);
		return -EINVAL;
	}

	/* Don't need backing pages for NULLIO */
	if (rd_dev->rd_flags & RDF_NULLIO)
		return 0;

	total_sg_needed = rd_dev->rd_page_count;

	sg_tables = (total_sg_needed / max_sg_per_table) + 1;

	sg_table = kzalloc(sg_tables * sizeof(struct rd_dev_sg_table), GFP_KERNEL);
	if (!sg_table) {
		pr_err("Unable to allocate memory for Ramdisk"
			" scatterlist tables\n");
		return -ENOMEM;
	}

	rd_dev->sg_table_array = sg_table;
	rd_dev->sg_table_count = sg_tables;

	while (total_sg_needed) {
		sg_per_table = (total_sg_needed > max_sg_per_table) ?
			max_sg_per_table : total_sg_needed;

		sg = kzalloc(sg_per_table * sizeof(struct scatterlist),
				GFP_KERNEL);
		if (!sg) {
			pr_err("Unable to allocate scatterlist array"
				" for struct rd_dev\n");
			return -ENOMEM;
		}

		sg_init_table(sg, sg_per_table);

		sg_table[i].sg_table = sg;
		sg_table[i].rd_sg_count = sg_per_table;
		sg_table[i].page_start_offset = page_offset;
		sg_table[i++].page_end_offset = (page_offset + sg_per_table)
						- 1;

		for (j = 0; j < sg_per_table; j++) {
			pg = alloc_pages(GFP_KERNEL, 0);
			if (!pg) {
				pr_err("Unable to allocate scatterlist"
					" pages for struct rd_dev_sg_table\n");
				return -ENOMEM;
			}
			sg_assign_page(&sg[j], pg);
			sg[j].length = PAGE_SIZE;
		}

		page_offset += sg_per_table;
		total_sg_needed -= sg_per_table;
	}

	pr_debug("CORE_RD[%u] - Built Ramdisk Device ID: %u space of"
		" %u pages in %u tables\n", rd_dev->rd_host->rd_host_id,
		rd_dev->rd_dev_id, rd_dev->rd_page_count,
		rd_dev->sg_table_count);

	return 0;
}

static struct se_device *rd_alloc_device(struct se_hba *hba, const char *name)
{
	struct rd_dev *rd_dev;
	struct rd_host *rd_host = hba->hba_ptr;

	rd_dev = kzalloc(sizeof(struct rd_dev), GFP_KERNEL);
	if (!rd_dev) {
		pr_err("Unable to allocate memory for struct rd_dev\n");
		return NULL;
	}

	rd_dev->rd_host = rd_host;

	return &rd_dev->dev;
}

static int rd_configure_device(struct se_device *dev)
{
	struct rd_dev *rd_dev = RD_DEV(dev);
	struct rd_host *rd_host = dev->se_hba->hba_ptr;
	int ret;

	if (!(rd_dev->rd_flags & RDF_HAS_PAGE_COUNT)) {
		pr_debug("Missing rd_pages= parameter\n");
		return -EINVAL;
	}

	ret = rd_build_device_space(rd_dev);
	if (ret < 0)
		goto fail;

	dev->dev_attrib.hw_block_size = RD_BLOCKSIZE;
	dev->dev_attrib.hw_max_sectors = UINT_MAX;
	dev->dev_attrib.hw_queue_depth = RD_MAX_DEVICE_QUEUE_DEPTH;

	rd_dev->rd_dev_id = rd_host->rd_host_dev_id_count++;

	pr_debug("CORE_RD[%u] - Added TCM MEMCPY Ramdisk Device ID: %u of"
		" %u pages in %u tables, %lu total bytes\n",
		rd_host->rd_host_id, rd_dev->rd_dev_id, rd_dev->rd_page_count,
		rd_dev->sg_table_count,
		(unsigned long)(rd_dev->rd_page_count * PAGE_SIZE));

	return 0;

fail:
	rd_release_device_space(rd_dev);
	return ret;
}

static void rd_free_device(struct se_device *dev)
{
	struct rd_dev *rd_dev = RD_DEV(dev);

	rd_release_device_space(rd_dev);
	kfree(rd_dev);
}

static struct rd_dev_sg_table *rd_get_sg_table(struct rd_dev *rd_dev, u32 page)
{
	struct rd_dev_sg_table *sg_table;
	u32 i, sg_per_table = (RD_MAX_ALLOCATION_SIZE /
				sizeof(struct scatterlist));

	i = page / sg_per_table;
	if (i < rd_dev->sg_table_count) {
		sg_table = &rd_dev->sg_table_array[i];
		if ((sg_table->page_start_offset <= page) &&
		    (sg_table->page_end_offset >= page))
			return sg_table;
	}

	pr_err("Unable to locate struct rd_dev_sg_table for page: %u\n",
			page);

	return NULL;
}

static sense_reason_t
rd_execute_rw(struct se_cmd *cmd)
{
	struct scatterlist *sgl = cmd->t_data_sg;
	u32 sgl_nents = cmd->t_data_nents;
	enum dma_data_direction data_direction = cmd->data_direction;
	struct se_device *se_dev = cmd->se_dev;
	struct rd_dev *dev = RD_DEV(se_dev);
	struct rd_dev_sg_table *table;
	struct scatterlist *rd_sg;
	struct sg_mapping_iter m;
	u32 rd_offset;
	u32 rd_size;
	u32 rd_page;
	u32 src_len;
	u64 tmp;

	if (dev->rd_flags & RDF_NULLIO) {
		target_complete_cmd(cmd, SAM_STAT_GOOD);
		return 0;
	}

	tmp = cmd->t_task_lba * se_dev->dev_attrib.block_size;
	rd_offset = do_div(tmp, PAGE_SIZE);
	rd_page = tmp;
	rd_size = cmd->data_length;

	table = rd_get_sg_table(dev, rd_page);
	if (!table)
		return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;

	rd_sg = &table->sg_table[rd_page - table->page_start_offset];

	pr_debug("RD[%u]: %s LBA: %llu, Size: %u Page: %u, Offset: %u\n",
			dev->rd_dev_id,
			data_direction == DMA_FROM_DEVICE ? "Read" : "Write",
			cmd->t_task_lba, rd_size, rd_page, rd_offset);

	src_len = PAGE_SIZE - rd_offset;
	sg_miter_start(&m, sgl, sgl_nents,
			data_direction == DMA_FROM_DEVICE ?
				SG_MITER_TO_SG : SG_MITER_FROM_SG);
	while (rd_size) {
		u32 len;
		void *rd_addr;

		sg_miter_next(&m);
		if (!(u32)m.length) {
			pr_debug("RD[%u]: invalid sgl %p len %zu\n",
				 dev->rd_dev_id, m.addr, m.length);
			sg_miter_stop(&m);
			return TCM_INCORRECT_AMOUNT_OF_DATA;
		}
		len = min((u32)m.length, src_len);
		if (len > rd_size) {
			pr_debug("RD[%u]: size underrun page %d offset %d "
				 "size %d\n", dev->rd_dev_id,
				 rd_page, rd_offset, rd_size);
			len = rd_size;
		}
		m.consumed = len;

		rd_addr = sg_virt(rd_sg) + rd_offset;

		if (data_direction == DMA_FROM_DEVICE)
			memcpy(m.addr, rd_addr, len);
		else
			memcpy(rd_addr, m.addr, len);

		rd_size -= len;
		if (!rd_size)
			continue;

		src_len -= len;
		if (src_len) {
			rd_offset += len;
			continue;
		}

		/* rd page completed, next one please */
		rd_page++;
		rd_offset = 0;
		src_len = PAGE_SIZE;
		if (rd_page <= table->page_end_offset) {
			rd_sg++;
			continue;
		}

		table = rd_get_sg_table(dev, rd_page);
		if (!table) {
			sg_miter_stop(&m);
			return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
		}

		/* since we increment, the first sg entry is correct */
		rd_sg = table->sg_table;
	}
	sg_miter_stop(&m);

	target_complete_cmd(cmd, SAM_STAT_GOOD);
	return 0;
}

enum {
	Opt_rd_pages, Opt_rd_nullio, Opt_err
};

static match_table_t tokens = {
	{Opt_rd_pages, "rd_pages=%d"},
	{Opt_rd_nullio, "rd_nullio=%d"},
	{Opt_err, NULL}
};

static ssize_t rd_set_configfs_dev_params(struct se_device *dev,
		const char *page, ssize_t count)
{
	struct rd_dev *rd_dev = RD_DEV(dev);
	char *orig, *ptr, *opts;
	substring_t args[MAX_OPT_ARGS];
	int ret = 0, arg, token;

	opts = kstrdup(page, GFP_KERNEL);
	if (!opts)
		return -ENOMEM;

	orig = opts;

	while ((ptr = strsep(&opts, ",\n")) != NULL) {
		if (!*ptr)
			continue;

		token = match_token(ptr, tokens, args);
		switch (token) {
		case Opt_rd_pages:
			match_int(args, &arg);
			rd_dev->rd_page_count = arg;
			pr_debug("RAMDISK: Referencing Page"
				" Count: %u\n", rd_dev->rd_page_count);
			rd_dev->rd_flags |= RDF_HAS_PAGE_COUNT;
			break;
		case Opt_rd_nullio:
			match_int(args, &arg);
			if (arg != 1)
				break;

			pr_debug("RAMDISK: Setting NULLIO flag: %d\n", arg);
			rd_dev->rd_flags |= RDF_NULLIO;
			break;
		default:
			break;
		}
	}

	kfree(orig);
	return (!ret) ? count : ret;
}

static ssize_t rd_show_configfs_dev_params(struct se_device *dev, char *b)
{
	struct rd_dev *rd_dev = RD_DEV(dev);

	ssize_t bl = sprintf(b, "TCM RamDisk ID: %u  RamDisk Makeup: rd_mcp\n",
			rd_dev->rd_dev_id);
	bl += sprintf(b + bl, "        PAGES/PAGE_SIZE: %u*%lu"
			"  SG_table_count: %u  nullio: %d\n", rd_dev->rd_page_count,
			PAGE_SIZE, rd_dev->sg_table_count,
			!!(rd_dev->rd_flags & RDF_NULLIO));
	return bl;
}

static sector_t rd_get_blocks(struct se_device *dev)
{
	struct rd_dev *rd_dev = RD_DEV(dev);

	unsigned long long blocks_long = ((rd_dev->rd_page_count * PAGE_SIZE) /
			dev->dev_attrib.block_size) - 1;

	return blocks_long;
}

static struct sbc_ops rd_sbc_ops = {
	.execute_rw		= rd_execute_rw,
};

static sense_reason_t
rd_parse_cdb(struct se_cmd *cmd)
{
	return sbc_parse_cdb(cmd, &rd_sbc_ops);
}

static struct se_subsystem_api rd_mcp_template = {
	.name			= "rd_mcp",
	.inquiry_prod		= "RAMDISK-MCP",
	.inquiry_rev		= RD_MCP_VERSION,
	.transport_type		= TRANSPORT_PLUGIN_VHBA_VDEV,
	.attach_hba		= rd_attach_hba,
	.detach_hba		= rd_detach_hba,
	.alloc_device		= rd_alloc_device,
	.configure_device	= rd_configure_device,
	.free_device		= rd_free_device,
	.parse_cdb		= rd_parse_cdb,
	.set_configfs_dev_params = rd_set_configfs_dev_params,
	.show_configfs_dev_params = rd_show_configfs_dev_params,
	.get_device_type	= sbc_get_device_type,
	.get_blocks		= rd_get_blocks,
};

int __init rd_module_init(void)
{
	int ret;

	ret = transport_subsystem_register(&rd_mcp_template);
	if (ret < 0) {
		return ret;
	}

	return 0;
}

void rd_module_exit(void)
{
	transport_subsystem_release(&rd_mcp_template);
}
Commit	Line	Data
c66ac9db NB	1	/*******************************************************************************
	2	* Filename: target_core_rd.c
	3	*
	4	* This file contains the Storage Engine <-> Ramdisk transport
	5	* specific functions.
	6	*
fd9a11d7	7	* (c) Copyright 2003-2012 RisingTide Systems LLC.
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	41	static 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	*/
	50	static 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) {
6708bb27 AG	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,
c66ac9db NB	66	RD_HBA_VERSION, TARGET_CORE_MOD_VERSION);
c66ac9db NB	67
	68	return 0;
	69	}
	70
	71	static 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	*/
	86	static 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	*/
	128	static 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) {
6708bb27 AG	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) {
6708bb27 AG	168	pr_err("Unable to allocate scatterlist array"
c66ac9db	169	" for struct rd_dev\n");
065f9716	170	return -ENOMEM;
c66ac9db NB	171	}
c66ac9db NB	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) {
6708bb27 AG	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	204	static 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) {
6708bb27 AG	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	}
c66ac9db NB	219
0fd97ccf	220	static 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);
065f9716 DC	232	if (ret < 0)
c66ac9db NB	233	goto fail;
c66ac9db NB	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
c66ac9db NB	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
	249	fail:
	250	rd_release_device_space(rd_dev);
0fd97ccf	251	return ret;
c66ac9db NB	252	}
c66ac9db NB	253
0fd97ccf	254	static 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	262	static struct rd_dev_sg_table rd_get_sg_table(struct rd_dev rd_dev, u32 page)
c66ac9db NB	263	{
c66ac9db	264	struct rd_dev_sg_table *sg_table;
8f67835f MS	265	u32 i, sg_per_table = (RD_MAX_ALLOCATION_SIZE /
8f67835f MS	266	sizeof(struct scatterlist));
c66ac9db	267
8f67835f MS	268	i = page / sg_per_table;
8f67835f MS	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 CH	282	static sense_reason_t
de103c93 CH	283	rd_execute_rw(struct se_cmd *cmd)
c66ac9db	284	{
0c2ad7d1 CH	285	struct scatterlist *sgl = cmd->t_data_sg;
	286	u32 sgl_nents = cmd->t_data_nents;
	287	enum dma_data_direction data_direction = cmd->data_direction;
5787cacd	288	struct se_device *se_dev = cmd->se_dev;
0fd97ccf	289	struct rd_dev *dev = RD_DEV(se_dev);
c66ac9db	290	struct rd_dev_sg_table *table;
65b0c78d SAS	291	struct scatterlist *rd_sg;
65b0c78d SAS	292	struct sg_mapping_iter m;
8feb58d0 CH	293	u32 rd_offset;
	294	u32 rd_size;
	295	u32 rd_page;
65b0c78d	296	u32 src_len;
8feb58d0	297	u64 tmp;
c66ac9db	298
52c07423 NB	299	if (dev->rd_flags & RDF_NULLIO) {
	300	target_complete_cmd(cmd, SAM_STAT_GOOD);
	301	return 0;
	302	}
	303
0fd97ccf	304	tmp = cmd->t_task_lba * se_dev->dev_attrib.block_size;
8feb58d0 CH	305	rd_offset = do_div(tmp, PAGE_SIZE);
8feb58d0 CH	306	rd_page = tmp;
5787cacd	307	rd_size = cmd->data_length;
8feb58d0 CH	308
8feb58d0 CH	309	table = rd_get_sg_table(dev, rd_page);
6708bb27	310	if (!table)
de103c93	311	return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
c66ac9db	312
8feb58d0	313	rd_sg = &table->sg_table[rd_page - table->page_start_offset];
6708bb27	314
65b0c78d	315	pr_debug("RD[%u]: %s LBA: %llu, Size: %u Page: %u, Offset: %u\n",
8feb58d0	316	dev->rd_dev_id,
5787cacd CH	317	data_direction == DMA_FROM_DEVICE ? "Read" : "Write",
5787cacd CH	318	cmd->t_task_lba, rd_size, rd_page, rd_offset);
c66ac9db	319
65b0c78d	320	src_len = PAGE_SIZE - rd_offset;
5787cacd CH	321	sg_miter_start(&m, sgl, sgl_nents,
5787cacd CH	322	data_direction == DMA_FROM_DEVICE ?
8feb58d0 CH	323	SG_MITER_TO_SG : SG_MITER_FROM_SG);
8feb58d0 CH	324	while (rd_size) {
65b0c78d SAS	325	u32 len;
65b0c78d SAS	326	void *rd_addr;
c66ac9db	327
65b0c78d	328	sg_miter_next(&m);
bbf344e5 HR	329	if (!(u32)m.length) {
	330	pr_debug("RD[%u]: invalid sgl %p len %zu\n",
	331	dev->rd_dev_id, m.addr, m.length);
	332	sg_miter_stop(&m);
	333	return TCM_INCORRECT_AMOUNT_OF_DATA;
	334	}
65b0c78d	335	len = min((u32)m.length, src_len);
bbf344e5 HR	336	if (len > rd_size) {
	337	pr_debug("RD[%u]: size underrun page %d offset %d "
	338	"size %d\n", dev->rd_dev_id,
	339	rd_page, rd_offset, rd_size);
	340	len = rd_size;
	341	}
65b0c78d	342	m.consumed = len;
c66ac9db	343
65b0c78d	344	rd_addr = sg_virt(rd_sg) + rd_offset;
6708bb27	345
5787cacd	346	if (data_direction == DMA_FROM_DEVICE)
65b0c78d SAS	347	memcpy(m.addr, rd_addr, len);
	348	else
	349	memcpy(rd_addr, m.addr, len);
c66ac9db	350
8feb58d0 CH	351	rd_size -= len;
8feb58d0 CH	352	if (!rd_size)
c66ac9db NB	353	continue;
c66ac9db NB	354
65b0c78d SAS	355	src_len -= len;
	356	if (src_len) {
	357	rd_offset += len;
c66ac9db NB	358	continue;
c66ac9db NB	359	}
6708bb27	360
65b0c78d	361	/* rd page completed, next one please */
8feb58d0	362	rd_page++;
65b0c78d SAS	363	rd_offset = 0;
65b0c78d SAS	364	src_len = PAGE_SIZE;
8feb58d0	365	if (rd_page <= table->page_end_offset) {
65b0c78d	366	rd_sg++;
c66ac9db NB	367	continue;
c66ac9db NB	368	}
6708bb27	369
8feb58d0	370	table = rd_get_sg_table(dev, rd_page);
65b0c78d SAS	371	if (!table) {
65b0c78d SAS	372	sg_miter_stop(&m);
de103c93	373	return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
65b0c78d	374	}
c66ac9db	375
65b0c78d SAS	376	/* since we increment, the first sg entry is correct */
65b0c78d SAS	377	rd_sg = table->sg_table;
c66ac9db	378	}
65b0c78d	379	sg_miter_stop(&m);
c66ac9db	380
5787cacd	381	target_complete_cmd(cmd, SAM_STAT_GOOD);
03e98c9e	382	return 0;
c66ac9db NB	383	}
c66ac9db NB	384
c66ac9db	385	enum {
52c07423	386	Opt_rd_pages, Opt_rd_nullio, Opt_err
c66ac9db NB	387	};
	388
	389	static match_table_t tokens = {
	390	{Opt_rd_pages, "rd_pages=%d"},
52c07423	391	{Opt_rd_nullio, "rd_nullio=%d"},
c66ac9db NB	392	{Opt_err, NULL}
	393	};
	394
0fd97ccf CH	395	static ssize_t rd_set_configfs_dev_params(struct se_device *dev,
0fd97ccf CH	396	const char *page, ssize_t count)
c66ac9db	397	{
0fd97ccf	398	struct rd_dev *rd_dev = RD_DEV(dev);
c66ac9db NB	399	char orig, ptr, *opts;
	400	substring_t args[MAX_OPT_ARGS];
	401	int ret = 0, arg, token;
	402
	403	opts = kstrdup(page, GFP_KERNEL);
	404	if (!opts)
	405	return -ENOMEM;
	406
	407	orig = opts;
	408
90c161b6	409	while ((ptr = strsep(&opts, ",\n")) != NULL) {
c66ac9db NB	410	if (!*ptr)
	411	continue;
	412
	413	token = match_token(ptr, tokens, args);
	414	switch (token) {
	415	case Opt_rd_pages:
	416	match_int(args, &arg);
	417	rd_dev->rd_page_count = arg;
6708bb27	418	pr_debug("RAMDISK: Referencing Page"
c66ac9db NB	419	" Count: %u\n", rd_dev->rd_page_count);
	420	rd_dev->rd_flags \|= RDF_HAS_PAGE_COUNT;
	421	break;
52c07423 NB	422	case Opt_rd_nullio:
	423	match_int(args, &arg);
	424	if (arg != 1)
	425	break;
	426
	427	pr_debug("RAMDISK: Setting NULLIO flag: %d\n", arg);
	428	rd_dev->rd_flags \|= RDF_NULLIO;
	429	break;
c66ac9db NB	430	default:
	431	break;
	432	}
	433	}
	434
	435	kfree(orig);
	436	return (!ret) ? count : ret;
	437	}
	438
0fd97ccf	439	static ssize_t rd_show_configfs_dev_params(struct se_device dev, char b)
c66ac9db	440	{
0fd97ccf	441	struct rd_dev *rd_dev = RD_DEV(dev);
c66ac9db	442
8feb58d0 CH	443	ssize_t bl = sprintf(b, "TCM RamDisk ID: %u RamDisk Makeup: rd_mcp\n",
8feb58d0 CH	444	rd_dev->rd_dev_id);
c66ac9db	445	bl += sprintf(b + bl, " PAGES/PAGE_SIZE: %u*%lu"
52c07423 NB	446	" SG_table_count: %u nullio: %d\n", rd_dev->rd_page_count,
	447	PAGE_SIZE, rd_dev->sg_table_count,
	448	!!(rd_dev->rd_flags & RDF_NULLIO));
c66ac9db NB	449	return bl;
	450	}
	451
c66ac9db NB	452	static sector_t rd_get_blocks(struct se_device *dev)
c66ac9db NB	453	{
0fd97ccf CH	454	struct rd_dev *rd_dev = RD_DEV(dev);
0fd97ccf CH	455
c66ac9db	456	unsigned long long blocks_long = ((rd_dev->rd_page_count * PAGE_SIZE) /
0fd97ccf	457	dev->dev_attrib.block_size) - 1;
c66ac9db NB	458
	459	return blocks_long;
	460	}
	461
9e999a6c	462	static struct sbc_ops rd_sbc_ops = {
0c2ad7d1 CH	463	.execute_rw = rd_execute_rw,
	464	};
	465
de103c93 CH	466	static sense_reason_t
de103c93 CH	467	rd_parse_cdb(struct se_cmd *cmd)
0c2ad7d1	468	{
9e999a6c	469	return sbc_parse_cdb(cmd, &rd_sbc_ops);
0c2ad7d1 CH	470	}
0c2ad7d1 CH	471
c66ac9db NB	472	static struct se_subsystem_api rd_mcp_template = {
c66ac9db NB	473	.name = "rd_mcp",
0fd97ccf CH	474	.inquiry_prod = "RAMDISK-MCP",
0fd97ccf CH	475	.inquiry_rev = RD_MCP_VERSION,
c66ac9db NB	476	.transport_type = TRANSPORT_PLUGIN_VHBA_VDEV,
	477	.attach_hba = rd_attach_hba,
	478	.detach_hba = rd_detach_hba,
0fd97ccf CH	479	.alloc_device = rd_alloc_device,
0fd97ccf CH	480	.configure_device = rd_configure_device,
c66ac9db	481	.free_device = rd_free_device,
0c2ad7d1	482	.parse_cdb = rd_parse_cdb,
c66ac9db NB	483	.set_configfs_dev_params = rd_set_configfs_dev_params,
c66ac9db NB	484	.show_configfs_dev_params = rd_show_configfs_dev_params,
6f23ac8a	485	.get_device_type = sbc_get_device_type,
c66ac9db NB	486	.get_blocks = rd_get_blocks,
	487	};
	488
	489	int __init rd_module_init(void)
	490	{
	491	int ret;
	492
c66ac9db NB	493	ret = transport_subsystem_register(&rd_mcp_template);
c66ac9db NB	494	if (ret < 0) {
c66ac9db NB	495	return ret;
	496	}
	497
	498	return 0;
	499	}
	500
	501	void rd_module_exit(void)
	502	{
c66ac9db NB	503	transport_subsystem_release(&rd_mcp_template);
c66ac9db NB	504	}