17c9e7a6fSAndy Grover /* 27c9e7a6fSAndy Grover * Copyright (C) 2013 Shaohua Li <shli@kernel.org> 37c9e7a6fSAndy Grover * Copyright (C) 2014 Red Hat, Inc. 4f97ec7dbSIlias Tsitsimpis * Copyright (C) 2015 Arrikto, Inc. 57c9e7a6fSAndy Grover * 67c9e7a6fSAndy Grover * This program is free software; you can redistribute it and/or modify it 77c9e7a6fSAndy Grover * under the terms and conditions of the GNU General Public License, 87c9e7a6fSAndy Grover * version 2, as published by the Free Software Foundation. 97c9e7a6fSAndy Grover * 107c9e7a6fSAndy Grover * This program is distributed in the hope it will be useful, but WITHOUT 117c9e7a6fSAndy Grover * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 127c9e7a6fSAndy Grover * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 137c9e7a6fSAndy Grover * more details. 147c9e7a6fSAndy Grover * 157c9e7a6fSAndy Grover * You should have received a copy of the GNU General Public License along with 167c9e7a6fSAndy Grover * this program; if not, write to the Free Software Foundation, Inc., 177c9e7a6fSAndy Grover * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 187c9e7a6fSAndy Grover */ 197c9e7a6fSAndy Grover 207c9e7a6fSAndy Grover #include <linux/spinlock.h> 217c9e7a6fSAndy Grover #include <linux/module.h> 227c9e7a6fSAndy Grover #include <linux/idr.h> 23ba929992SBart Van Assche #include <linux/kernel.h> 247c9e7a6fSAndy Grover #include <linux/timer.h> 257c9e7a6fSAndy Grover #include <linux/parser.h> 265538d294SDavid S. Miller #include <linux/vmalloc.h> 277c9e7a6fSAndy Grover #include <linux/uio_driver.h> 28ac64a2ceSDavid Disseldorp #include <linux/stringify.h> 2926418649SSheng Yang #include <linux/bitops.h> 30f5045724SBart Van Assche #include <linux/highmem.h> 317d7a7435SNicholas Bellinger #include <linux/configfs.h> 327c9e7a6fSAndy Grover #include <net/genetlink.h> 33ba929992SBart Van Assche #include <scsi/scsi_common.h> 34ba929992SBart Van Assche #include <scsi/scsi_proto.h> 357c9e7a6fSAndy Grover #include <target/target_core_base.h> 367c9e7a6fSAndy Grover #include <target/target_core_fabric.h> 377c9e7a6fSAndy Grover #include <target/target_core_backend.h> 38e9f720d6SNicholas Bellinger 397c9e7a6fSAndy Grover #include <linux/target_core_user.h> 407c9e7a6fSAndy Grover 417c9e7a6fSAndy Grover /* 427c9e7a6fSAndy Grover * Define a shared-memory interface for LIO to pass SCSI commands and 437c9e7a6fSAndy Grover * data to userspace for processing. This is to allow backends that 447c9e7a6fSAndy Grover * are too complex for in-kernel support to be possible. 457c9e7a6fSAndy Grover * 467c9e7a6fSAndy Grover * It uses the UIO framework to do a lot of the device-creation and 477c9e7a6fSAndy Grover * introspection work for us. 487c9e7a6fSAndy Grover * 497c9e7a6fSAndy Grover * See the .h file for how the ring is laid out. Note that while the 507c9e7a6fSAndy Grover * command ring is defined, the particulars of the data area are 517c9e7a6fSAndy Grover * not. Offset values in the command entry point to other locations 527c9e7a6fSAndy Grover * internal to the mmap()ed area. There is separate space outside the 537c9e7a6fSAndy Grover * command ring for data buffers. This leaves maximum flexibility for 547c9e7a6fSAndy Grover * moving buffer allocations, or even page flipping or other 557c9e7a6fSAndy Grover * allocation techniques, without altering the command ring layout. 567c9e7a6fSAndy Grover * 577c9e7a6fSAndy Grover * SECURITY: 587c9e7a6fSAndy Grover * The user process must be assumed to be malicious. There's no way to 597c9e7a6fSAndy Grover * prevent it breaking the command ring protocol if it wants, but in 607c9e7a6fSAndy Grover * order to prevent other issues we must only ever read *data* from 617c9e7a6fSAndy Grover * the shared memory area, not offsets or sizes. This applies to 627c9e7a6fSAndy Grover * command ring entries as well as the mailbox. Extra code needed for 637c9e7a6fSAndy Grover * this may have a 'UAM' comment. 647c9e7a6fSAndy Grover */ 657c9e7a6fSAndy Grover 667c9e7a6fSAndy Grover 677c9e7a6fSAndy Grover #define TCMU_TIME_OUT (30 * MSEC_PER_SEC) 687c9e7a6fSAndy Grover 6926418649SSheng Yang #define DATA_BLOCK_BITS 256 7026418649SSheng Yang #define DATA_BLOCK_SIZE 4096 7126418649SSheng Yang 727c9e7a6fSAndy Grover #define CMDR_SIZE (16 * 4096) 7326418649SSheng Yang #define DATA_SIZE (DATA_BLOCK_BITS * DATA_BLOCK_SIZE) 747c9e7a6fSAndy Grover 757c9e7a6fSAndy Grover #define TCMU_RING_SIZE (CMDR_SIZE + DATA_SIZE) 767c9e7a6fSAndy Grover 777c9e7a6fSAndy Grover static struct device *tcmu_root_device; 787c9e7a6fSAndy Grover 797c9e7a6fSAndy Grover struct tcmu_hba { 807c9e7a6fSAndy Grover u32 host_id; 817c9e7a6fSAndy Grover }; 827c9e7a6fSAndy Grover 837c9e7a6fSAndy Grover #define TCMU_CONFIG_LEN 256 847c9e7a6fSAndy Grover 857c9e7a6fSAndy Grover struct tcmu_dev { 867c9e7a6fSAndy Grover struct se_device se_dev; 877c9e7a6fSAndy Grover 887c9e7a6fSAndy Grover char *name; 897c9e7a6fSAndy Grover struct se_hba *hba; 907c9e7a6fSAndy Grover 917c9e7a6fSAndy Grover #define TCMU_DEV_BIT_OPEN 0 927c9e7a6fSAndy Grover #define TCMU_DEV_BIT_BROKEN 1 937c9e7a6fSAndy Grover unsigned long flags; 947c9e7a6fSAndy Grover 957c9e7a6fSAndy Grover struct uio_info uio_info; 967c9e7a6fSAndy Grover 977c9e7a6fSAndy Grover struct tcmu_mailbox *mb_addr; 987c9e7a6fSAndy Grover size_t dev_size; 997c9e7a6fSAndy Grover u32 cmdr_size; 1007c9e7a6fSAndy Grover u32 cmdr_last_cleaned; 1013d9b9555SAndy Grover /* Offset of data area from start of mb */ 10226418649SSheng Yang /* Must add data_off and mb_addr to get the address */ 1037c9e7a6fSAndy Grover size_t data_off; 1047c9e7a6fSAndy Grover size_t data_size; 10526418649SSheng Yang 10626418649SSheng Yang DECLARE_BITMAP(data_bitmap, DATA_BLOCK_BITS); 1077c9e7a6fSAndy Grover 1087c9e7a6fSAndy Grover wait_queue_head_t wait_cmdr; 1097c9e7a6fSAndy Grover /* TODO should this be a mutex? */ 1107c9e7a6fSAndy Grover spinlock_t cmdr_lock; 1117c9e7a6fSAndy Grover 1127c9e7a6fSAndy Grover struct idr commands; 1137c9e7a6fSAndy Grover spinlock_t commands_lock; 1147c9e7a6fSAndy Grover 1157c9e7a6fSAndy Grover struct timer_list timeout; 116af980e46SMike Christie unsigned int cmd_time_out; 1177c9e7a6fSAndy Grover 1187c9e7a6fSAndy Grover char dev_config[TCMU_CONFIG_LEN]; 1197c9e7a6fSAndy Grover }; 1207c9e7a6fSAndy Grover 1217c9e7a6fSAndy Grover #define TCMU_DEV(_se_dev) container_of(_se_dev, struct tcmu_dev, se_dev) 1227c9e7a6fSAndy Grover 1237c9e7a6fSAndy Grover #define CMDR_OFF sizeof(struct tcmu_mailbox) 1247c9e7a6fSAndy Grover 1257c9e7a6fSAndy Grover struct tcmu_cmd { 1267c9e7a6fSAndy Grover struct se_cmd *se_cmd; 1277c9e7a6fSAndy Grover struct tcmu_dev *tcmu_dev; 1287c9e7a6fSAndy Grover 1297c9e7a6fSAndy Grover uint16_t cmd_id; 1307c9e7a6fSAndy Grover 13126418649SSheng Yang /* Can't use se_cmd when cleaning up expired cmds, because if 1327c9e7a6fSAndy Grover cmd has been completed then accessing se_cmd is off limits */ 13326418649SSheng Yang DECLARE_BITMAP(data_bitmap, DATA_BLOCK_BITS); 1347c9e7a6fSAndy Grover 1357c9e7a6fSAndy Grover unsigned long deadline; 1367c9e7a6fSAndy Grover 1377c9e7a6fSAndy Grover #define TCMU_CMD_BIT_EXPIRED 0 1387c9e7a6fSAndy Grover unsigned long flags; 1397c9e7a6fSAndy Grover }; 1407c9e7a6fSAndy Grover 1417c9e7a6fSAndy Grover static struct kmem_cache *tcmu_cmd_cache; 1427c9e7a6fSAndy Grover 1437c9e7a6fSAndy Grover /* multicast group */ 1447c9e7a6fSAndy Grover enum tcmu_multicast_groups { 1457c9e7a6fSAndy Grover TCMU_MCGRP_CONFIG, 1467c9e7a6fSAndy Grover }; 1477c9e7a6fSAndy Grover 1487c9e7a6fSAndy Grover static const struct genl_multicast_group tcmu_mcgrps[] = { 1497c9e7a6fSAndy Grover [TCMU_MCGRP_CONFIG] = { .name = "config", }, 1507c9e7a6fSAndy Grover }; 1517c9e7a6fSAndy Grover 1527c9e7a6fSAndy Grover /* Our generic netlink family */ 15356989f6dSJohannes Berg static struct genl_family tcmu_genl_family __ro_after_init = { 154489111e5SJohannes Berg .module = THIS_MODULE, 1557c9e7a6fSAndy Grover .hdrsize = 0, 1567c9e7a6fSAndy Grover .name = "TCM-USER", 1577c9e7a6fSAndy Grover .version = 1, 1587c9e7a6fSAndy Grover .maxattr = TCMU_ATTR_MAX, 1597c9e7a6fSAndy Grover .mcgrps = tcmu_mcgrps, 1607c9e7a6fSAndy Grover .n_mcgrps = ARRAY_SIZE(tcmu_mcgrps), 16120c08b36SSheng Yang .netnsok = true, 1627c9e7a6fSAndy Grover }; 1637c9e7a6fSAndy Grover 1647c9e7a6fSAndy Grover static struct tcmu_cmd *tcmu_alloc_cmd(struct se_cmd *se_cmd) 1657c9e7a6fSAndy Grover { 1667c9e7a6fSAndy Grover struct se_device *se_dev = se_cmd->se_dev; 1677c9e7a6fSAndy Grover struct tcmu_dev *udev = TCMU_DEV(se_dev); 1687c9e7a6fSAndy Grover struct tcmu_cmd *tcmu_cmd; 1697c9e7a6fSAndy Grover int cmd_id; 1707c9e7a6fSAndy Grover 1717c9e7a6fSAndy Grover tcmu_cmd = kmem_cache_zalloc(tcmu_cmd_cache, GFP_KERNEL); 1727c9e7a6fSAndy Grover if (!tcmu_cmd) 1737c9e7a6fSAndy Grover return NULL; 1747c9e7a6fSAndy Grover 1757c9e7a6fSAndy Grover tcmu_cmd->se_cmd = se_cmd; 1767c9e7a6fSAndy Grover tcmu_cmd->tcmu_dev = udev; 177af980e46SMike Christie if (udev->cmd_time_out) 178af980e46SMike Christie tcmu_cmd->deadline = jiffies + 179af980e46SMike Christie msecs_to_jiffies(udev->cmd_time_out); 1807c9e7a6fSAndy Grover 1817c9e7a6fSAndy Grover idr_preload(GFP_KERNEL); 1827c9e7a6fSAndy Grover spin_lock_irq(&udev->commands_lock); 1837c9e7a6fSAndy Grover cmd_id = idr_alloc(&udev->commands, tcmu_cmd, 0, 1847c9e7a6fSAndy Grover USHRT_MAX, GFP_NOWAIT); 1857c9e7a6fSAndy Grover spin_unlock_irq(&udev->commands_lock); 1867c9e7a6fSAndy Grover idr_preload_end(); 1877c9e7a6fSAndy Grover 1887c9e7a6fSAndy Grover if (cmd_id < 0) { 1897c9e7a6fSAndy Grover kmem_cache_free(tcmu_cmd_cache, tcmu_cmd); 1907c9e7a6fSAndy Grover return NULL; 1917c9e7a6fSAndy Grover } 1927c9e7a6fSAndy Grover tcmu_cmd->cmd_id = cmd_id; 1937c9e7a6fSAndy Grover 1947c9e7a6fSAndy Grover return tcmu_cmd; 1957c9e7a6fSAndy Grover } 1967c9e7a6fSAndy Grover 1977c9e7a6fSAndy Grover static inline void tcmu_flush_dcache_range(void *vaddr, size_t size) 1987c9e7a6fSAndy Grover { 199b75d8063SGeliang Tang unsigned long offset = offset_in_page(vaddr); 2007c9e7a6fSAndy Grover 2017c9e7a6fSAndy Grover size = round_up(size+offset, PAGE_SIZE); 2027c9e7a6fSAndy Grover vaddr -= offset; 2037c9e7a6fSAndy Grover 2047c9e7a6fSAndy Grover while (size) { 2057c9e7a6fSAndy Grover flush_dcache_page(virt_to_page(vaddr)); 2067c9e7a6fSAndy Grover size -= PAGE_SIZE; 2077c9e7a6fSAndy Grover } 2087c9e7a6fSAndy Grover } 2097c9e7a6fSAndy Grover 2107c9e7a6fSAndy Grover /* 2117c9e7a6fSAndy Grover * Some ring helper functions. We don't assume size is a power of 2 so 2127c9e7a6fSAndy Grover * we can't use circ_buf.h. 2137c9e7a6fSAndy Grover */ 2147c9e7a6fSAndy Grover static inline size_t spc_used(size_t head, size_t tail, size_t size) 2157c9e7a6fSAndy Grover { 2167c9e7a6fSAndy Grover int diff = head - tail; 2177c9e7a6fSAndy Grover 2187c9e7a6fSAndy Grover if (diff >= 0) 2197c9e7a6fSAndy Grover return diff; 2207c9e7a6fSAndy Grover else 2217c9e7a6fSAndy Grover return size + diff; 2227c9e7a6fSAndy Grover } 2237c9e7a6fSAndy Grover 2247c9e7a6fSAndy Grover static inline size_t spc_free(size_t head, size_t tail, size_t size) 2257c9e7a6fSAndy Grover { 2267c9e7a6fSAndy Grover /* Keep 1 byte unused or we can't tell full from empty */ 2277c9e7a6fSAndy Grover return (size - spc_used(head, tail, size) - 1); 2287c9e7a6fSAndy Grover } 2297c9e7a6fSAndy Grover 2307c9e7a6fSAndy Grover static inline size_t head_to_end(size_t head, size_t size) 2317c9e7a6fSAndy Grover { 2327c9e7a6fSAndy Grover return size - head; 2337c9e7a6fSAndy Grover } 2347c9e7a6fSAndy Grover 235f1dbd087SSheng Yang static inline void new_iov(struct iovec **iov, int *iov_cnt, 236f1dbd087SSheng Yang struct tcmu_dev *udev) 237f1dbd087SSheng Yang { 238f1dbd087SSheng Yang struct iovec *iovec; 239f1dbd087SSheng Yang 240f1dbd087SSheng Yang if (*iov_cnt != 0) 241f1dbd087SSheng Yang (*iov)++; 242f1dbd087SSheng Yang (*iov_cnt)++; 243f1dbd087SSheng Yang 244f1dbd087SSheng Yang iovec = *iov; 245f1dbd087SSheng Yang memset(iovec, 0, sizeof(struct iovec)); 246f1dbd087SSheng Yang } 247f1dbd087SSheng Yang 2487c9e7a6fSAndy Grover #define UPDATE_HEAD(head, used, size) smp_store_release(&head, ((head % size) + used) % size) 2497c9e7a6fSAndy Grover 25026418649SSheng Yang /* offset is relative to mb_addr */ 25126418649SSheng Yang static inline size_t get_block_offset(struct tcmu_dev *dev, 25226418649SSheng Yang int block, int remaining) 25326418649SSheng Yang { 25426418649SSheng Yang return dev->data_off + block * DATA_BLOCK_SIZE + 25526418649SSheng Yang DATA_BLOCK_SIZE - remaining; 25626418649SSheng Yang } 25726418649SSheng Yang 25826418649SSheng Yang static inline size_t iov_tail(struct tcmu_dev *udev, struct iovec *iov) 25926418649SSheng Yang { 26026418649SSheng Yang return (size_t)iov->iov_base + iov->iov_len; 26126418649SSheng Yang } 26226418649SSheng Yang 263f97ec7dbSIlias Tsitsimpis static void alloc_and_scatter_data_area(struct tcmu_dev *udev, 264f97ec7dbSIlias Tsitsimpis struct scatterlist *data_sg, unsigned int data_nents, 265f97ec7dbSIlias Tsitsimpis struct iovec **iov, int *iov_cnt, bool copy_data) 266f97ec7dbSIlias Tsitsimpis { 26726418649SSheng Yang int i, block; 26826418649SSheng Yang int block_remaining = 0; 269f97ec7dbSIlias Tsitsimpis void *from, *to; 27026418649SSheng Yang size_t copy_bytes, to_offset; 271f97ec7dbSIlias Tsitsimpis struct scatterlist *sg; 272f97ec7dbSIlias Tsitsimpis 273f97ec7dbSIlias Tsitsimpis for_each_sg(data_sg, sg, data_nents, i) { 27426418649SSheng Yang int sg_remaining = sg->length; 275f97ec7dbSIlias Tsitsimpis from = kmap_atomic(sg_page(sg)) + sg->offset; 27626418649SSheng Yang while (sg_remaining > 0) { 27726418649SSheng Yang if (block_remaining == 0) { 27826418649SSheng Yang block = find_first_zero_bit(udev->data_bitmap, 27926418649SSheng Yang DATA_BLOCK_BITS); 28026418649SSheng Yang block_remaining = DATA_BLOCK_SIZE; 28126418649SSheng Yang set_bit(block, udev->data_bitmap); 282f97ec7dbSIlias Tsitsimpis } 28326418649SSheng Yang copy_bytes = min_t(size_t, sg_remaining, 28426418649SSheng Yang block_remaining); 28526418649SSheng Yang to_offset = get_block_offset(udev, block, 28626418649SSheng Yang block_remaining); 28726418649SSheng Yang to = (void *)udev->mb_addr + to_offset; 28826418649SSheng Yang if (*iov_cnt != 0 && 28926418649SSheng Yang to_offset == iov_tail(udev, *iov)) { 290f1dbd087SSheng Yang (*iov)->iov_len += copy_bytes; 29126418649SSheng Yang } else { 292f1dbd087SSheng Yang new_iov(iov, iov_cnt, udev); 29326418649SSheng Yang (*iov)->iov_base = (void __user *) to_offset; 294f97ec7dbSIlias Tsitsimpis (*iov)->iov_len = copy_bytes; 29526418649SSheng Yang } 296f97ec7dbSIlias Tsitsimpis if (copy_data) { 29726418649SSheng Yang memcpy(to, from + sg->length - sg_remaining, 29826418649SSheng Yang copy_bytes); 299f97ec7dbSIlias Tsitsimpis tcmu_flush_dcache_range(to, copy_bytes); 300f97ec7dbSIlias Tsitsimpis } 30126418649SSheng Yang sg_remaining -= copy_bytes; 30226418649SSheng Yang block_remaining -= copy_bytes; 303f97ec7dbSIlias Tsitsimpis } 304e2e21bd8SSagi Grimberg kunmap_atomic(from - sg->offset); 305f97ec7dbSIlias Tsitsimpis } 306f97ec7dbSIlias Tsitsimpis } 307f97ec7dbSIlias Tsitsimpis 30826418649SSheng Yang static void free_data_area(struct tcmu_dev *udev, struct tcmu_cmd *cmd) 3090c28481fSSheng Yang { 31026418649SSheng Yang bitmap_xor(udev->data_bitmap, udev->data_bitmap, cmd->data_bitmap, 31126418649SSheng Yang DATA_BLOCK_BITS); 3120c28481fSSheng Yang } 3130c28481fSSheng Yang 31426418649SSheng Yang static void gather_data_area(struct tcmu_dev *udev, unsigned long *cmd_bitmap, 315f97ec7dbSIlias Tsitsimpis struct scatterlist *data_sg, unsigned int data_nents) 316f97ec7dbSIlias Tsitsimpis { 31726418649SSheng Yang int i, block; 31826418649SSheng Yang int block_remaining = 0; 319f97ec7dbSIlias Tsitsimpis void *from, *to; 32026418649SSheng Yang size_t copy_bytes, from_offset; 321f97ec7dbSIlias Tsitsimpis struct scatterlist *sg; 322f97ec7dbSIlias Tsitsimpis 323f97ec7dbSIlias Tsitsimpis for_each_sg(data_sg, sg, data_nents, i) { 32426418649SSheng Yang int sg_remaining = sg->length; 325f97ec7dbSIlias Tsitsimpis to = kmap_atomic(sg_page(sg)) + sg->offset; 32626418649SSheng Yang while (sg_remaining > 0) { 32726418649SSheng Yang if (block_remaining == 0) { 32826418649SSheng Yang block = find_first_bit(cmd_bitmap, 32926418649SSheng Yang DATA_BLOCK_BITS); 33026418649SSheng Yang block_remaining = DATA_BLOCK_SIZE; 33126418649SSheng Yang clear_bit(block, cmd_bitmap); 33226418649SSheng Yang } 33326418649SSheng Yang copy_bytes = min_t(size_t, sg_remaining, 33426418649SSheng Yang block_remaining); 33526418649SSheng Yang from_offset = get_block_offset(udev, block, 33626418649SSheng Yang block_remaining); 33726418649SSheng Yang from = (void *) udev->mb_addr + from_offset; 338f97ec7dbSIlias Tsitsimpis tcmu_flush_dcache_range(from, copy_bytes); 33926418649SSheng Yang memcpy(to + sg->length - sg_remaining, from, 34026418649SSheng Yang copy_bytes); 341f97ec7dbSIlias Tsitsimpis 34226418649SSheng Yang sg_remaining -= copy_bytes; 34326418649SSheng Yang block_remaining -= copy_bytes; 344f97ec7dbSIlias Tsitsimpis } 345e2e21bd8SSagi Grimberg kunmap_atomic(to - sg->offset); 346f97ec7dbSIlias Tsitsimpis } 347f97ec7dbSIlias Tsitsimpis } 348f97ec7dbSIlias Tsitsimpis 34926418649SSheng Yang static inline size_t spc_bitmap_free(unsigned long *bitmap) 35026418649SSheng Yang { 35126418649SSheng Yang return DATA_BLOCK_SIZE * (DATA_BLOCK_BITS - 35226418649SSheng Yang bitmap_weight(bitmap, DATA_BLOCK_BITS)); 35326418649SSheng Yang } 35426418649SSheng Yang 3557c9e7a6fSAndy Grover /* 356f97ec7dbSIlias Tsitsimpis * We can't queue a command until we have space available on the cmd ring *and* 3573d9b9555SAndy Grover * space available on the data area. 3587c9e7a6fSAndy Grover * 3597c9e7a6fSAndy Grover * Called with ring lock held. 3607c9e7a6fSAndy Grover */ 361f56574a2SAndy Grover static bool is_ring_space_avail(struct tcmu_dev *udev, size_t cmd_size, size_t data_needed) 3627c9e7a6fSAndy Grover { 3637c9e7a6fSAndy Grover struct tcmu_mailbox *mb = udev->mb_addr; 3640241fd39SNicholas Bellinger size_t space, cmd_needed; 3657c9e7a6fSAndy Grover u32 cmd_head; 3667c9e7a6fSAndy Grover 3677c9e7a6fSAndy Grover tcmu_flush_dcache_range(mb, sizeof(*mb)); 3687c9e7a6fSAndy Grover 3697c9e7a6fSAndy Grover cmd_head = mb->cmd_head % udev->cmdr_size; /* UAM */ 3707c9e7a6fSAndy Grover 371f56574a2SAndy Grover /* 372f56574a2SAndy Grover * If cmd end-of-ring space is too small then we need space for a NOP plus 373f56574a2SAndy Grover * original cmd - cmds are internally contiguous. 374f56574a2SAndy Grover */ 375f56574a2SAndy Grover if (head_to_end(cmd_head, udev->cmdr_size) >= cmd_size) 376f56574a2SAndy Grover cmd_needed = cmd_size; 377f56574a2SAndy Grover else 378f56574a2SAndy Grover cmd_needed = cmd_size + head_to_end(cmd_head, udev->cmdr_size); 379f56574a2SAndy Grover 3807c9e7a6fSAndy Grover space = spc_free(cmd_head, udev->cmdr_last_cleaned, udev->cmdr_size); 3817c9e7a6fSAndy Grover if (space < cmd_needed) { 3827c9e7a6fSAndy Grover pr_debug("no cmd space: %u %u %u\n", cmd_head, 3837c9e7a6fSAndy Grover udev->cmdr_last_cleaned, udev->cmdr_size); 3847c9e7a6fSAndy Grover return false; 3857c9e7a6fSAndy Grover } 3867c9e7a6fSAndy Grover 38726418649SSheng Yang space = spc_bitmap_free(udev->data_bitmap); 3887c9e7a6fSAndy Grover if (space < data_needed) { 3890241fd39SNicholas Bellinger pr_debug("no data space: only %zu available, but ask for %zu\n", 39026418649SSheng Yang space, data_needed); 3917c9e7a6fSAndy Grover return false; 3927c9e7a6fSAndy Grover } 3937c9e7a6fSAndy Grover 3947c9e7a6fSAndy Grover return true; 3957c9e7a6fSAndy Grover } 3967c9e7a6fSAndy Grover 39702eb924fSAndy Grover static sense_reason_t 39802eb924fSAndy Grover tcmu_queue_cmd_ring(struct tcmu_cmd *tcmu_cmd) 3997c9e7a6fSAndy Grover { 4007c9e7a6fSAndy Grover struct tcmu_dev *udev = tcmu_cmd->tcmu_dev; 4017c9e7a6fSAndy Grover struct se_cmd *se_cmd = tcmu_cmd->se_cmd; 4027c9e7a6fSAndy Grover size_t base_command_size, command_size; 4037c9e7a6fSAndy Grover struct tcmu_mailbox *mb; 4047c9e7a6fSAndy Grover struct tcmu_cmd_entry *entry; 4057c9e7a6fSAndy Grover struct iovec *iov; 406f97ec7dbSIlias Tsitsimpis int iov_cnt; 4077c9e7a6fSAndy Grover uint32_t cmd_head; 4087c9e7a6fSAndy Grover uint64_t cdb_off; 409f97ec7dbSIlias Tsitsimpis bool copy_to_data_area; 41026418649SSheng Yang size_t data_length; 41126418649SSheng Yang DECLARE_BITMAP(old_bitmap, DATA_BLOCK_BITS); 4127c9e7a6fSAndy Grover 4137c9e7a6fSAndy Grover if (test_bit(TCMU_DEV_BIT_BROKEN, &udev->flags)) 41402eb924fSAndy Grover return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE; 4157c9e7a6fSAndy Grover 4167c9e7a6fSAndy Grover /* 4177c9e7a6fSAndy Grover * Must be a certain minimum size for response sense info, but 4187c9e7a6fSAndy Grover * also may be larger if the iov array is large. 4197c9e7a6fSAndy Grover * 42026418649SSheng Yang * We prepare way too many iovs for potential uses here, because it's 42126418649SSheng Yang * expensive to tell how many regions are freed in the bitmap 4227c9e7a6fSAndy Grover */ 42326418649SSheng Yang base_command_size = max(offsetof(struct tcmu_cmd_entry, 42426418649SSheng Yang req.iov[se_cmd->t_bidi_data_nents + 42526418649SSheng Yang se_cmd->t_data_nents]), 4267c9e7a6fSAndy Grover sizeof(struct tcmu_cmd_entry)); 4277c9e7a6fSAndy Grover command_size = base_command_size 4287c9e7a6fSAndy Grover + round_up(scsi_command_size(se_cmd->t_task_cdb), TCMU_OP_ALIGN_SIZE); 4297c9e7a6fSAndy Grover 4307c9e7a6fSAndy Grover WARN_ON(command_size & (TCMU_OP_ALIGN_SIZE-1)); 4317c9e7a6fSAndy Grover 4327c9e7a6fSAndy Grover spin_lock_irq(&udev->cmdr_lock); 4337c9e7a6fSAndy Grover 4347c9e7a6fSAndy Grover mb = udev->mb_addr; 4357c9e7a6fSAndy Grover cmd_head = mb->cmd_head % udev->cmdr_size; /* UAM */ 43626418649SSheng Yang data_length = se_cmd->data_length; 43726418649SSheng Yang if (se_cmd->se_cmd_flags & SCF_BIDI) { 43826418649SSheng Yang BUG_ON(!(se_cmd->t_bidi_data_sg && se_cmd->t_bidi_data_nents)); 43926418649SSheng Yang data_length += se_cmd->t_bidi_data_sg->length; 44026418649SSheng Yang } 441554617b2SAndy Grover if ((command_size > (udev->cmdr_size / 2)) || 442554617b2SAndy Grover data_length > udev->data_size) { 443554617b2SAndy Grover pr_warn("TCMU: Request of size %zu/%zu is too big for %u/%zu " 4443d9b9555SAndy Grover "cmd ring/data area\n", command_size, data_length, 4457c9e7a6fSAndy Grover udev->cmdr_size, udev->data_size); 446554617b2SAndy Grover spin_unlock_irq(&udev->cmdr_lock); 447554617b2SAndy Grover return TCM_INVALID_CDB_FIELD; 448554617b2SAndy Grover } 4497c9e7a6fSAndy Grover 45026418649SSheng Yang while (!is_ring_space_avail(udev, command_size, data_length)) { 4517c9e7a6fSAndy Grover int ret; 4527c9e7a6fSAndy Grover DEFINE_WAIT(__wait); 4537c9e7a6fSAndy Grover 4547c9e7a6fSAndy Grover prepare_to_wait(&udev->wait_cmdr, &__wait, TASK_INTERRUPTIBLE); 4557c9e7a6fSAndy Grover 4567c9e7a6fSAndy Grover pr_debug("sleeping for ring space\n"); 4577c9e7a6fSAndy Grover spin_unlock_irq(&udev->cmdr_lock); 458af980e46SMike Christie if (udev->cmd_time_out) 459af980e46SMike Christie ret = schedule_timeout( 460af980e46SMike Christie msecs_to_jiffies(udev->cmd_time_out)); 461af980e46SMike Christie else 4627c9e7a6fSAndy Grover ret = schedule_timeout(msecs_to_jiffies(TCMU_TIME_OUT)); 4637c9e7a6fSAndy Grover finish_wait(&udev->wait_cmdr, &__wait); 4647c9e7a6fSAndy Grover if (!ret) { 4657c9e7a6fSAndy Grover pr_warn("tcmu: command timed out\n"); 46602eb924fSAndy Grover return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE; 4677c9e7a6fSAndy Grover } 4687c9e7a6fSAndy Grover 4697c9e7a6fSAndy Grover spin_lock_irq(&udev->cmdr_lock); 4707c9e7a6fSAndy Grover 4717c9e7a6fSAndy Grover /* We dropped cmdr_lock, cmd_head is stale */ 4727c9e7a6fSAndy Grover cmd_head = mb->cmd_head % udev->cmdr_size; /* UAM */ 4737c9e7a6fSAndy Grover } 4747c9e7a6fSAndy Grover 475f56574a2SAndy Grover /* Insert a PAD if end-of-ring space is too small */ 476f56574a2SAndy Grover if (head_to_end(cmd_head, udev->cmdr_size) < command_size) { 477f56574a2SAndy Grover size_t pad_size = head_to_end(cmd_head, udev->cmdr_size); 478f56574a2SAndy Grover 4797c9e7a6fSAndy Grover entry = (void *) mb + CMDR_OFF + cmd_head; 4807c9e7a6fSAndy Grover tcmu_flush_dcache_range(entry, sizeof(*entry)); 4810ad46af8SAndy Grover tcmu_hdr_set_op(&entry->hdr.len_op, TCMU_OP_PAD); 4820ad46af8SAndy Grover tcmu_hdr_set_len(&entry->hdr.len_op, pad_size); 4830ad46af8SAndy Grover entry->hdr.cmd_id = 0; /* not used for PAD */ 4840ad46af8SAndy Grover entry->hdr.kflags = 0; 4850ad46af8SAndy Grover entry->hdr.uflags = 0; 4867c9e7a6fSAndy Grover 4877c9e7a6fSAndy Grover UPDATE_HEAD(mb->cmd_head, pad_size, udev->cmdr_size); 4887c9e7a6fSAndy Grover 4897c9e7a6fSAndy Grover cmd_head = mb->cmd_head % udev->cmdr_size; /* UAM */ 4907c9e7a6fSAndy Grover WARN_ON(cmd_head != 0); 4917c9e7a6fSAndy Grover } 4927c9e7a6fSAndy Grover 4937c9e7a6fSAndy Grover entry = (void *) mb + CMDR_OFF + cmd_head; 4947c9e7a6fSAndy Grover tcmu_flush_dcache_range(entry, sizeof(*entry)); 4950ad46af8SAndy Grover tcmu_hdr_set_op(&entry->hdr.len_op, TCMU_OP_CMD); 4960ad46af8SAndy Grover tcmu_hdr_set_len(&entry->hdr.len_op, command_size); 4970ad46af8SAndy Grover entry->hdr.cmd_id = tcmu_cmd->cmd_id; 4980ad46af8SAndy Grover entry->hdr.kflags = 0; 4990ad46af8SAndy Grover entry->hdr.uflags = 0; 5007c9e7a6fSAndy Grover 50126418649SSheng Yang bitmap_copy(old_bitmap, udev->data_bitmap, DATA_BLOCK_BITS); 50226418649SSheng Yang 5033d9b9555SAndy Grover /* Handle allocating space from the data area */ 5047c9e7a6fSAndy Grover iov = &entry->req.iov[0]; 505f97ec7dbSIlias Tsitsimpis iov_cnt = 0; 506e4648b01SIlias Tsitsimpis copy_to_data_area = (se_cmd->data_direction == DMA_TO_DEVICE 507e4648b01SIlias Tsitsimpis || se_cmd->se_cmd_flags & SCF_BIDI); 508f97ec7dbSIlias Tsitsimpis alloc_and_scatter_data_area(udev, se_cmd->t_data_sg, 509f97ec7dbSIlias Tsitsimpis se_cmd->t_data_nents, &iov, &iov_cnt, copy_to_data_area); 5107c9e7a6fSAndy Grover entry->req.iov_cnt = iov_cnt; 5110ad46af8SAndy Grover entry->req.iov_dif_cnt = 0; 5127c9e7a6fSAndy Grover 513e4648b01SIlias Tsitsimpis /* Handle BIDI commands */ 514e4648b01SIlias Tsitsimpis iov_cnt = 0; 515e4648b01SIlias Tsitsimpis alloc_and_scatter_data_area(udev, se_cmd->t_bidi_data_sg, 516e4648b01SIlias Tsitsimpis se_cmd->t_bidi_data_nents, &iov, &iov_cnt, false); 517e4648b01SIlias Tsitsimpis entry->req.iov_bidi_cnt = iov_cnt; 518e4648b01SIlias Tsitsimpis 51926418649SSheng Yang /* cmd's data_bitmap is what changed in process */ 52026418649SSheng Yang bitmap_xor(tcmu_cmd->data_bitmap, old_bitmap, udev->data_bitmap, 52126418649SSheng Yang DATA_BLOCK_BITS); 52226418649SSheng Yang 5237c9e7a6fSAndy Grover /* All offsets relative to mb_addr, not start of entry! */ 5247c9e7a6fSAndy Grover cdb_off = CMDR_OFF + cmd_head + base_command_size; 5257c9e7a6fSAndy Grover memcpy((void *) mb + cdb_off, se_cmd->t_task_cdb, scsi_command_size(se_cmd->t_task_cdb)); 5267c9e7a6fSAndy Grover entry->req.cdb_off = cdb_off; 5277c9e7a6fSAndy Grover tcmu_flush_dcache_range(entry, sizeof(*entry)); 5287c9e7a6fSAndy Grover 5297c9e7a6fSAndy Grover UPDATE_HEAD(mb->cmd_head, command_size, udev->cmdr_size); 5307c9e7a6fSAndy Grover tcmu_flush_dcache_range(mb, sizeof(*mb)); 5317c9e7a6fSAndy Grover 5327c9e7a6fSAndy Grover spin_unlock_irq(&udev->cmdr_lock); 5337c9e7a6fSAndy Grover 5347c9e7a6fSAndy Grover /* TODO: only if FLUSH and FUA? */ 5357c9e7a6fSAndy Grover uio_event_notify(&udev->uio_info); 5367c9e7a6fSAndy Grover 537af980e46SMike Christie if (udev->cmd_time_out) 538af980e46SMike Christie mod_timer(&udev->timeout, round_jiffies_up(jiffies + 539af980e46SMike Christie msecs_to_jiffies(udev->cmd_time_out))); 5407c9e7a6fSAndy Grover 54102eb924fSAndy Grover return TCM_NO_SENSE; 5427c9e7a6fSAndy Grover } 5437c9e7a6fSAndy Grover 54402eb924fSAndy Grover static sense_reason_t 54502eb924fSAndy Grover tcmu_queue_cmd(struct se_cmd *se_cmd) 5467c9e7a6fSAndy Grover { 5477c9e7a6fSAndy Grover struct se_device *se_dev = se_cmd->se_dev; 5487c9e7a6fSAndy Grover struct tcmu_dev *udev = TCMU_DEV(se_dev); 5497c9e7a6fSAndy Grover struct tcmu_cmd *tcmu_cmd; 550ecaf597bSBart Van Assche sense_reason_t ret; 5517c9e7a6fSAndy Grover 5527c9e7a6fSAndy Grover tcmu_cmd = tcmu_alloc_cmd(se_cmd); 5537c9e7a6fSAndy Grover if (!tcmu_cmd) 55402eb924fSAndy Grover return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE; 5557c9e7a6fSAndy Grover 5567c9e7a6fSAndy Grover ret = tcmu_queue_cmd_ring(tcmu_cmd); 55702eb924fSAndy Grover if (ret != TCM_NO_SENSE) { 5587c9e7a6fSAndy Grover pr_err("TCMU: Could not queue command\n"); 5597c9e7a6fSAndy Grover spin_lock_irq(&udev->commands_lock); 5607c9e7a6fSAndy Grover idr_remove(&udev->commands, tcmu_cmd->cmd_id); 5617c9e7a6fSAndy Grover spin_unlock_irq(&udev->commands_lock); 5627c9e7a6fSAndy Grover 5637c9e7a6fSAndy Grover kmem_cache_free(tcmu_cmd_cache, tcmu_cmd); 5647c9e7a6fSAndy Grover } 5657c9e7a6fSAndy Grover 5667c9e7a6fSAndy Grover return ret; 5677c9e7a6fSAndy Grover } 5687c9e7a6fSAndy Grover 5697c9e7a6fSAndy Grover static void tcmu_handle_completion(struct tcmu_cmd *cmd, struct tcmu_cmd_entry *entry) 5707c9e7a6fSAndy Grover { 5717c9e7a6fSAndy Grover struct se_cmd *se_cmd = cmd->se_cmd; 5727c9e7a6fSAndy Grover struct tcmu_dev *udev = cmd->tcmu_dev; 5737c9e7a6fSAndy Grover 5747c9e7a6fSAndy Grover if (test_bit(TCMU_CMD_BIT_EXPIRED, &cmd->flags)) { 575b25c7863SSheng Yang /* 576b25c7863SSheng Yang * cmd has been completed already from timeout, just reclaim 5773d9b9555SAndy Grover * data area space and free cmd 578b25c7863SSheng Yang */ 57926418649SSheng Yang free_data_area(udev, cmd); 580b25c7863SSheng Yang 581b25c7863SSheng Yang kmem_cache_free(tcmu_cmd_cache, cmd); 5827c9e7a6fSAndy Grover return; 5837c9e7a6fSAndy Grover } 5847c9e7a6fSAndy Grover 5850ad46af8SAndy Grover if (entry->hdr.uflags & TCMU_UFLAG_UNKNOWN_OP) { 58626418649SSheng Yang free_data_area(udev, cmd); 5870ad46af8SAndy Grover pr_warn("TCMU: Userspace set UNKNOWN_OP flag on se_cmd %p\n", 5880ad46af8SAndy Grover cmd->se_cmd); 589ed97d0cdSAndy Grover entry->rsp.scsi_status = SAM_STAT_CHECK_CONDITION; 590ed97d0cdSAndy Grover } else if (entry->rsp.scsi_status == SAM_STAT_CHECK_CONDITION) { 5917c9e7a6fSAndy Grover memcpy(se_cmd->sense_buffer, entry->rsp.sense_buffer, 5927c9e7a6fSAndy Grover se_cmd->scsi_sense_length); 59326418649SSheng Yang free_data_area(udev, cmd); 594e4648b01SIlias Tsitsimpis } else if (se_cmd->se_cmd_flags & SCF_BIDI) { 59526418649SSheng Yang DECLARE_BITMAP(bitmap, DATA_BLOCK_BITS); 5967c9e7a6fSAndy Grover 59726418649SSheng Yang /* Get Data-In buffer before clean up */ 59826418649SSheng Yang bitmap_copy(bitmap, cmd->data_bitmap, DATA_BLOCK_BITS); 59926418649SSheng Yang gather_data_area(udev, bitmap, 600e4648b01SIlias Tsitsimpis se_cmd->t_bidi_data_sg, se_cmd->t_bidi_data_nents); 60126418649SSheng Yang free_data_area(udev, cmd); 602e4648b01SIlias Tsitsimpis } else if (se_cmd->data_direction == DMA_FROM_DEVICE) { 60326418649SSheng Yang DECLARE_BITMAP(bitmap, DATA_BLOCK_BITS); 60426418649SSheng Yang 60526418649SSheng Yang bitmap_copy(bitmap, cmd->data_bitmap, DATA_BLOCK_BITS); 60626418649SSheng Yang gather_data_area(udev, bitmap, 607f97ec7dbSIlias Tsitsimpis se_cmd->t_data_sg, se_cmd->t_data_nents); 60826418649SSheng Yang free_data_area(udev, cmd); 6097c9e7a6fSAndy Grover } else if (se_cmd->data_direction == DMA_TO_DEVICE) { 61026418649SSheng Yang free_data_area(udev, cmd); 6112bc396a2SIlias Tsitsimpis } else if (se_cmd->data_direction != DMA_NONE) { 6122bc396a2SIlias Tsitsimpis pr_warn("TCMU: data direction was %d!\n", 6132bc396a2SIlias Tsitsimpis se_cmd->data_direction); 6147c9e7a6fSAndy Grover } 6157c9e7a6fSAndy Grover 6167c9e7a6fSAndy Grover target_complete_cmd(cmd->se_cmd, entry->rsp.scsi_status); 6177c9e7a6fSAndy Grover cmd->se_cmd = NULL; 6187c9e7a6fSAndy Grover 6197c9e7a6fSAndy Grover kmem_cache_free(tcmu_cmd_cache, cmd); 6207c9e7a6fSAndy Grover } 6217c9e7a6fSAndy Grover 6227c9e7a6fSAndy Grover static unsigned int tcmu_handle_completions(struct tcmu_dev *udev) 6237c9e7a6fSAndy Grover { 6247c9e7a6fSAndy Grover struct tcmu_mailbox *mb; 6257c9e7a6fSAndy Grover unsigned long flags; 6267c9e7a6fSAndy Grover int handled = 0; 6277c9e7a6fSAndy Grover 6287c9e7a6fSAndy Grover if (test_bit(TCMU_DEV_BIT_BROKEN, &udev->flags)) { 6297c9e7a6fSAndy Grover pr_err("ring broken, not handling completions\n"); 6307c9e7a6fSAndy Grover return 0; 6317c9e7a6fSAndy Grover } 6327c9e7a6fSAndy Grover 6337c9e7a6fSAndy Grover spin_lock_irqsave(&udev->cmdr_lock, flags); 6347c9e7a6fSAndy Grover 6357c9e7a6fSAndy Grover mb = udev->mb_addr; 6367c9e7a6fSAndy Grover tcmu_flush_dcache_range(mb, sizeof(*mb)); 6377c9e7a6fSAndy Grover 6387c9e7a6fSAndy Grover while (udev->cmdr_last_cleaned != ACCESS_ONCE(mb->cmd_tail)) { 6397c9e7a6fSAndy Grover 6407c9e7a6fSAndy Grover struct tcmu_cmd_entry *entry = (void *) mb + CMDR_OFF + udev->cmdr_last_cleaned; 6417c9e7a6fSAndy Grover struct tcmu_cmd *cmd; 6427c9e7a6fSAndy Grover 6437c9e7a6fSAndy Grover tcmu_flush_dcache_range(entry, sizeof(*entry)); 6447c9e7a6fSAndy Grover 6450ad46af8SAndy Grover if (tcmu_hdr_get_op(entry->hdr.len_op) == TCMU_OP_PAD) { 6460ad46af8SAndy Grover UPDATE_HEAD(udev->cmdr_last_cleaned, 6470ad46af8SAndy Grover tcmu_hdr_get_len(entry->hdr.len_op), 6480ad46af8SAndy Grover udev->cmdr_size); 6497c9e7a6fSAndy Grover continue; 6507c9e7a6fSAndy Grover } 6510ad46af8SAndy Grover WARN_ON(tcmu_hdr_get_op(entry->hdr.len_op) != TCMU_OP_CMD); 6527c9e7a6fSAndy Grover 6537c9e7a6fSAndy Grover spin_lock(&udev->commands_lock); 654d3e709e6SMatthew Wilcox cmd = idr_remove(&udev->commands, entry->hdr.cmd_id); 6557c9e7a6fSAndy Grover spin_unlock(&udev->commands_lock); 6567c9e7a6fSAndy Grover 6577c9e7a6fSAndy Grover if (!cmd) { 6587c9e7a6fSAndy Grover pr_err("cmd_id not found, ring is broken\n"); 6597c9e7a6fSAndy Grover set_bit(TCMU_DEV_BIT_BROKEN, &udev->flags); 6607c9e7a6fSAndy Grover break; 6617c9e7a6fSAndy Grover } 6627c9e7a6fSAndy Grover 6637c9e7a6fSAndy Grover tcmu_handle_completion(cmd, entry); 6647c9e7a6fSAndy Grover 6650ad46af8SAndy Grover UPDATE_HEAD(udev->cmdr_last_cleaned, 6660ad46af8SAndy Grover tcmu_hdr_get_len(entry->hdr.len_op), 6670ad46af8SAndy Grover udev->cmdr_size); 6687c9e7a6fSAndy Grover 6697c9e7a6fSAndy Grover handled++; 6707c9e7a6fSAndy Grover } 6717c9e7a6fSAndy Grover 6727c9e7a6fSAndy Grover if (mb->cmd_tail == mb->cmd_head) 6737c9e7a6fSAndy Grover del_timer(&udev->timeout); /* no more pending cmds */ 6747c9e7a6fSAndy Grover 6757c9e7a6fSAndy Grover spin_unlock_irqrestore(&udev->cmdr_lock, flags); 6767c9e7a6fSAndy Grover 6777c9e7a6fSAndy Grover wake_up(&udev->wait_cmdr); 6787c9e7a6fSAndy Grover 6797c9e7a6fSAndy Grover return handled; 6807c9e7a6fSAndy Grover } 6817c9e7a6fSAndy Grover 6827c9e7a6fSAndy Grover static int tcmu_check_expired_cmd(int id, void *p, void *data) 6837c9e7a6fSAndy Grover { 6847c9e7a6fSAndy Grover struct tcmu_cmd *cmd = p; 6857c9e7a6fSAndy Grover 6867c9e7a6fSAndy Grover if (test_bit(TCMU_CMD_BIT_EXPIRED, &cmd->flags)) 6877c9e7a6fSAndy Grover return 0; 6887c9e7a6fSAndy Grover 689611e2267SAndy Grover if (!time_after(jiffies, cmd->deadline)) 6907c9e7a6fSAndy Grover return 0; 6917c9e7a6fSAndy Grover 6927c9e7a6fSAndy Grover set_bit(TCMU_CMD_BIT_EXPIRED, &cmd->flags); 6937c9e7a6fSAndy Grover target_complete_cmd(cmd->se_cmd, SAM_STAT_CHECK_CONDITION); 6947c9e7a6fSAndy Grover cmd->se_cmd = NULL; 6957c9e7a6fSAndy Grover 6967c9e7a6fSAndy Grover return 0; 6977c9e7a6fSAndy Grover } 6987c9e7a6fSAndy Grover 6997c9e7a6fSAndy Grover static void tcmu_device_timedout(unsigned long data) 7007c9e7a6fSAndy Grover { 7017c9e7a6fSAndy Grover struct tcmu_dev *udev = (struct tcmu_dev *)data; 7027c9e7a6fSAndy Grover unsigned long flags; 7037c9e7a6fSAndy Grover int handled; 7047c9e7a6fSAndy Grover 7057c9e7a6fSAndy Grover handled = tcmu_handle_completions(udev); 7067c9e7a6fSAndy Grover 7077c9e7a6fSAndy Grover pr_warn("%d completions handled from timeout\n", handled); 7087c9e7a6fSAndy Grover 7097c9e7a6fSAndy Grover spin_lock_irqsave(&udev->commands_lock, flags); 7107c9e7a6fSAndy Grover idr_for_each(&udev->commands, tcmu_check_expired_cmd, NULL); 7117c9e7a6fSAndy Grover spin_unlock_irqrestore(&udev->commands_lock, flags); 7127c9e7a6fSAndy Grover 7137c9e7a6fSAndy Grover /* 7147c9e7a6fSAndy Grover * We don't need to wakeup threads on wait_cmdr since they have their 7157c9e7a6fSAndy Grover * own timeout. 7167c9e7a6fSAndy Grover */ 7177c9e7a6fSAndy Grover } 7187c9e7a6fSAndy Grover 7197c9e7a6fSAndy Grover static int tcmu_attach_hba(struct se_hba *hba, u32 host_id) 7207c9e7a6fSAndy Grover { 7217c9e7a6fSAndy Grover struct tcmu_hba *tcmu_hba; 7227c9e7a6fSAndy Grover 7237c9e7a6fSAndy Grover tcmu_hba = kzalloc(sizeof(struct tcmu_hba), GFP_KERNEL); 7247c9e7a6fSAndy Grover if (!tcmu_hba) 7257c9e7a6fSAndy Grover return -ENOMEM; 7267c9e7a6fSAndy Grover 7277c9e7a6fSAndy Grover tcmu_hba->host_id = host_id; 7287c9e7a6fSAndy Grover hba->hba_ptr = tcmu_hba; 7297c9e7a6fSAndy Grover 7307c9e7a6fSAndy Grover return 0; 7317c9e7a6fSAndy Grover } 7327c9e7a6fSAndy Grover 7337c9e7a6fSAndy Grover static void tcmu_detach_hba(struct se_hba *hba) 7347c9e7a6fSAndy Grover { 7357c9e7a6fSAndy Grover kfree(hba->hba_ptr); 7367c9e7a6fSAndy Grover hba->hba_ptr = NULL; 7377c9e7a6fSAndy Grover } 7387c9e7a6fSAndy Grover 7397c9e7a6fSAndy Grover static struct se_device *tcmu_alloc_device(struct se_hba *hba, const char *name) 7407c9e7a6fSAndy Grover { 7417c9e7a6fSAndy Grover struct tcmu_dev *udev; 7427c9e7a6fSAndy Grover 7437c9e7a6fSAndy Grover udev = kzalloc(sizeof(struct tcmu_dev), GFP_KERNEL); 7447c9e7a6fSAndy Grover if (!udev) 7457c9e7a6fSAndy Grover return NULL; 7467c9e7a6fSAndy Grover 7477c9e7a6fSAndy Grover udev->name = kstrdup(name, GFP_KERNEL); 7487c9e7a6fSAndy Grover if (!udev->name) { 7497c9e7a6fSAndy Grover kfree(udev); 7507c9e7a6fSAndy Grover return NULL; 7517c9e7a6fSAndy Grover } 7527c9e7a6fSAndy Grover 7537c9e7a6fSAndy Grover udev->hba = hba; 754af980e46SMike Christie udev->cmd_time_out = TCMU_TIME_OUT; 7557c9e7a6fSAndy Grover 7567c9e7a6fSAndy Grover init_waitqueue_head(&udev->wait_cmdr); 7577c9e7a6fSAndy Grover spin_lock_init(&udev->cmdr_lock); 7587c9e7a6fSAndy Grover 7597c9e7a6fSAndy Grover idr_init(&udev->commands); 7607c9e7a6fSAndy Grover spin_lock_init(&udev->commands_lock); 7617c9e7a6fSAndy Grover 7627c9e7a6fSAndy Grover setup_timer(&udev->timeout, tcmu_device_timedout, 7637c9e7a6fSAndy Grover (unsigned long)udev); 7647c9e7a6fSAndy Grover 7657c9e7a6fSAndy Grover return &udev->se_dev; 7667c9e7a6fSAndy Grover } 7677c9e7a6fSAndy Grover 7687c9e7a6fSAndy Grover static int tcmu_irqcontrol(struct uio_info *info, s32 irq_on) 7697c9e7a6fSAndy Grover { 7707c9e7a6fSAndy Grover struct tcmu_dev *tcmu_dev = container_of(info, struct tcmu_dev, uio_info); 7717c9e7a6fSAndy Grover 7727c9e7a6fSAndy Grover tcmu_handle_completions(tcmu_dev); 7737c9e7a6fSAndy Grover 7747c9e7a6fSAndy Grover return 0; 7757c9e7a6fSAndy Grover } 7767c9e7a6fSAndy Grover 7777c9e7a6fSAndy Grover /* 7787c9e7a6fSAndy Grover * mmap code from uio.c. Copied here because we want to hook mmap() 7797c9e7a6fSAndy Grover * and this stuff must come along. 7807c9e7a6fSAndy Grover */ 7817c9e7a6fSAndy Grover static int tcmu_find_mem_index(struct vm_area_struct *vma) 7827c9e7a6fSAndy Grover { 7837c9e7a6fSAndy Grover struct tcmu_dev *udev = vma->vm_private_data; 7847c9e7a6fSAndy Grover struct uio_info *info = &udev->uio_info; 7857c9e7a6fSAndy Grover 7867c9e7a6fSAndy Grover if (vma->vm_pgoff < MAX_UIO_MAPS) { 7877c9e7a6fSAndy Grover if (info->mem[vma->vm_pgoff].size == 0) 7887c9e7a6fSAndy Grover return -1; 7897c9e7a6fSAndy Grover return (int)vma->vm_pgoff; 7907c9e7a6fSAndy Grover } 7917c9e7a6fSAndy Grover return -1; 7927c9e7a6fSAndy Grover } 7937c9e7a6fSAndy Grover 79411bac800SDave Jiang static int tcmu_vma_fault(struct vm_fault *vmf) 7957c9e7a6fSAndy Grover { 79611bac800SDave Jiang struct tcmu_dev *udev = vmf->vma->vm_private_data; 7977c9e7a6fSAndy Grover struct uio_info *info = &udev->uio_info; 7987c9e7a6fSAndy Grover struct page *page; 7997c9e7a6fSAndy Grover unsigned long offset; 8007c9e7a6fSAndy Grover void *addr; 8017c9e7a6fSAndy Grover 80211bac800SDave Jiang int mi = tcmu_find_mem_index(vmf->vma); 8037c9e7a6fSAndy Grover if (mi < 0) 8047c9e7a6fSAndy Grover return VM_FAULT_SIGBUS; 8057c9e7a6fSAndy Grover 8067c9e7a6fSAndy Grover /* 8077c9e7a6fSAndy Grover * We need to subtract mi because userspace uses offset = N*PAGE_SIZE 8087c9e7a6fSAndy Grover * to use mem[N]. 8097c9e7a6fSAndy Grover */ 8107c9e7a6fSAndy Grover offset = (vmf->pgoff - mi) << PAGE_SHIFT; 8117c9e7a6fSAndy Grover 8127c9e7a6fSAndy Grover addr = (void *)(unsigned long)info->mem[mi].addr + offset; 8137c9e7a6fSAndy Grover if (info->mem[mi].memtype == UIO_MEM_LOGICAL) 8147c9e7a6fSAndy Grover page = virt_to_page(addr); 8157c9e7a6fSAndy Grover else 8167c9e7a6fSAndy Grover page = vmalloc_to_page(addr); 8177c9e7a6fSAndy Grover get_page(page); 8187c9e7a6fSAndy Grover vmf->page = page; 8197c9e7a6fSAndy Grover return 0; 8207c9e7a6fSAndy Grover } 8217c9e7a6fSAndy Grover 8227c9e7a6fSAndy Grover static const struct vm_operations_struct tcmu_vm_ops = { 8237c9e7a6fSAndy Grover .fault = tcmu_vma_fault, 8247c9e7a6fSAndy Grover }; 8257c9e7a6fSAndy Grover 8267c9e7a6fSAndy Grover static int tcmu_mmap(struct uio_info *info, struct vm_area_struct *vma) 8277c9e7a6fSAndy Grover { 8287c9e7a6fSAndy Grover struct tcmu_dev *udev = container_of(info, struct tcmu_dev, uio_info); 8297c9e7a6fSAndy Grover 8307c9e7a6fSAndy Grover vma->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP; 8317c9e7a6fSAndy Grover vma->vm_ops = &tcmu_vm_ops; 8327c9e7a6fSAndy Grover 8337c9e7a6fSAndy Grover vma->vm_private_data = udev; 8347c9e7a6fSAndy Grover 8357c9e7a6fSAndy Grover /* Ensure the mmap is exactly the right size */ 8367c9e7a6fSAndy Grover if (vma_pages(vma) != (TCMU_RING_SIZE >> PAGE_SHIFT)) 8377c9e7a6fSAndy Grover return -EINVAL; 8387c9e7a6fSAndy Grover 8397c9e7a6fSAndy Grover return 0; 8407c9e7a6fSAndy Grover } 8417c9e7a6fSAndy Grover 8427c9e7a6fSAndy Grover static int tcmu_open(struct uio_info *info, struct inode *inode) 8437c9e7a6fSAndy Grover { 8447c9e7a6fSAndy Grover struct tcmu_dev *udev = container_of(info, struct tcmu_dev, uio_info); 8457c9e7a6fSAndy Grover 8467c9e7a6fSAndy Grover /* O_EXCL not supported for char devs, so fake it? */ 8477c9e7a6fSAndy Grover if (test_and_set_bit(TCMU_DEV_BIT_OPEN, &udev->flags)) 8487c9e7a6fSAndy Grover return -EBUSY; 8497c9e7a6fSAndy Grover 8507c9e7a6fSAndy Grover pr_debug("open\n"); 8517c9e7a6fSAndy Grover 8527c9e7a6fSAndy Grover return 0; 8537c9e7a6fSAndy Grover } 8547c9e7a6fSAndy Grover 8557c9e7a6fSAndy Grover static int tcmu_release(struct uio_info *info, struct inode *inode) 8567c9e7a6fSAndy Grover { 8577c9e7a6fSAndy Grover struct tcmu_dev *udev = container_of(info, struct tcmu_dev, uio_info); 8587c9e7a6fSAndy Grover 8597c9e7a6fSAndy Grover clear_bit(TCMU_DEV_BIT_OPEN, &udev->flags); 8607c9e7a6fSAndy Grover 8617c9e7a6fSAndy Grover pr_debug("close\n"); 8627c9e7a6fSAndy Grover 8637c9e7a6fSAndy Grover return 0; 8647c9e7a6fSAndy Grover } 8657c9e7a6fSAndy Grover 8667c9e7a6fSAndy Grover static int tcmu_netlink_event(enum tcmu_genl_cmd cmd, const char *name, int minor) 8677c9e7a6fSAndy Grover { 8687c9e7a6fSAndy Grover struct sk_buff *skb; 8697c9e7a6fSAndy Grover void *msg_header; 8706e14eab9SNicholas Bellinger int ret = -ENOMEM; 8717c9e7a6fSAndy Grover 8727c9e7a6fSAndy Grover skb = genlmsg_new(NLMSG_GOODSIZE, GFP_KERNEL); 8737c9e7a6fSAndy Grover if (!skb) 8746e14eab9SNicholas Bellinger return ret; 8757c9e7a6fSAndy Grover 8767c9e7a6fSAndy Grover msg_header = genlmsg_put(skb, 0, 0, &tcmu_genl_family, 0, cmd); 8776e14eab9SNicholas Bellinger if (!msg_header) 8786e14eab9SNicholas Bellinger goto free_skb; 8797c9e7a6fSAndy Grover 8807c9e7a6fSAndy Grover ret = nla_put_string(skb, TCMU_ATTR_DEVICE, name); 8816e14eab9SNicholas Bellinger if (ret < 0) 8826e14eab9SNicholas Bellinger goto free_skb; 8837c9e7a6fSAndy Grover 8847c9e7a6fSAndy Grover ret = nla_put_u32(skb, TCMU_ATTR_MINOR, minor); 8856e14eab9SNicholas Bellinger if (ret < 0) 8866e14eab9SNicholas Bellinger goto free_skb; 8877c9e7a6fSAndy Grover 888053c095aSJohannes Berg genlmsg_end(skb, msg_header); 8897c9e7a6fSAndy Grover 89020c08b36SSheng Yang ret = genlmsg_multicast_allns(&tcmu_genl_family, skb, 0, 8917c9e7a6fSAndy Grover TCMU_MCGRP_CONFIG, GFP_KERNEL); 8927c9e7a6fSAndy Grover 8937c9e7a6fSAndy Grover /* We don't care if no one is listening */ 8947c9e7a6fSAndy Grover if (ret == -ESRCH) 8957c9e7a6fSAndy Grover ret = 0; 8967c9e7a6fSAndy Grover 8977c9e7a6fSAndy Grover return ret; 8986e14eab9SNicholas Bellinger free_skb: 8996e14eab9SNicholas Bellinger nlmsg_free(skb); 9006e14eab9SNicholas Bellinger return ret; 9017c9e7a6fSAndy Grover } 9027c9e7a6fSAndy Grover 9037c9e7a6fSAndy Grover static int tcmu_configure_device(struct se_device *dev) 9047c9e7a6fSAndy Grover { 9057c9e7a6fSAndy Grover struct tcmu_dev *udev = TCMU_DEV(dev); 9067c9e7a6fSAndy Grover struct tcmu_hba *hba = udev->hba->hba_ptr; 9077c9e7a6fSAndy Grover struct uio_info *info; 9087c9e7a6fSAndy Grover struct tcmu_mailbox *mb; 9097c9e7a6fSAndy Grover size_t size; 9107c9e7a6fSAndy Grover size_t used; 9117c9e7a6fSAndy Grover int ret = 0; 9127c9e7a6fSAndy Grover char *str; 9137c9e7a6fSAndy Grover 9147c9e7a6fSAndy Grover info = &udev->uio_info; 9157c9e7a6fSAndy Grover 9167c9e7a6fSAndy Grover size = snprintf(NULL, 0, "tcm-user/%u/%s/%s", hba->host_id, udev->name, 9177c9e7a6fSAndy Grover udev->dev_config); 9187c9e7a6fSAndy Grover size += 1; /* for \0 */ 9197c9e7a6fSAndy Grover str = kmalloc(size, GFP_KERNEL); 9207c9e7a6fSAndy Grover if (!str) 9217c9e7a6fSAndy Grover return -ENOMEM; 9227c9e7a6fSAndy Grover 9237c9e7a6fSAndy Grover used = snprintf(str, size, "tcm-user/%u/%s", hba->host_id, udev->name); 9247c9e7a6fSAndy Grover 9257c9e7a6fSAndy Grover if (udev->dev_config[0]) 9267c9e7a6fSAndy Grover snprintf(str + used, size - used, "/%s", udev->dev_config); 9277c9e7a6fSAndy Grover 9287c9e7a6fSAndy Grover info->name = str; 9297c9e7a6fSAndy Grover 9307c9e7a6fSAndy Grover udev->mb_addr = vzalloc(TCMU_RING_SIZE); 9317c9e7a6fSAndy Grover if (!udev->mb_addr) { 9327c9e7a6fSAndy Grover ret = -ENOMEM; 9337c9e7a6fSAndy Grover goto err_vzalloc; 9347c9e7a6fSAndy Grover } 9357c9e7a6fSAndy Grover 9367c9e7a6fSAndy Grover /* mailbox fits in first part of CMDR space */ 9377c9e7a6fSAndy Grover udev->cmdr_size = CMDR_SIZE - CMDR_OFF; 9387c9e7a6fSAndy Grover udev->data_off = CMDR_SIZE; 9397c9e7a6fSAndy Grover udev->data_size = TCMU_RING_SIZE - CMDR_SIZE; 9407c9e7a6fSAndy Grover 9417c9e7a6fSAndy Grover mb = udev->mb_addr; 9420ad46af8SAndy Grover mb->version = TCMU_MAILBOX_VERSION; 94332c76de3SSheng Yang mb->flags = TCMU_MAILBOX_FLAG_CAP_OOOC; 9447c9e7a6fSAndy Grover mb->cmdr_off = CMDR_OFF; 9457c9e7a6fSAndy Grover mb->cmdr_size = udev->cmdr_size; 9467c9e7a6fSAndy Grover 9477c9e7a6fSAndy Grover WARN_ON(!PAGE_ALIGNED(udev->data_off)); 9487c9e7a6fSAndy Grover WARN_ON(udev->data_size % PAGE_SIZE); 94926418649SSheng Yang WARN_ON(udev->data_size % DATA_BLOCK_SIZE); 9507c9e7a6fSAndy Grover 951ac64a2ceSDavid Disseldorp info->version = __stringify(TCMU_MAILBOX_VERSION); 9527c9e7a6fSAndy Grover 9537c9e7a6fSAndy Grover info->mem[0].name = "tcm-user command & data buffer"; 9540633e123SArnd Bergmann info->mem[0].addr = (phys_addr_t)(uintptr_t)udev->mb_addr; 9557c9e7a6fSAndy Grover info->mem[0].size = TCMU_RING_SIZE; 9567c9e7a6fSAndy Grover info->mem[0].memtype = UIO_MEM_VIRTUAL; 9577c9e7a6fSAndy Grover 9587c9e7a6fSAndy Grover info->irqcontrol = tcmu_irqcontrol; 9597c9e7a6fSAndy Grover info->irq = UIO_IRQ_CUSTOM; 9607c9e7a6fSAndy Grover 9617c9e7a6fSAndy Grover info->mmap = tcmu_mmap; 9627c9e7a6fSAndy Grover info->open = tcmu_open; 9637c9e7a6fSAndy Grover info->release = tcmu_release; 9647c9e7a6fSAndy Grover 9657c9e7a6fSAndy Grover ret = uio_register_device(tcmu_root_device, info); 9667c9e7a6fSAndy Grover if (ret) 9677c9e7a6fSAndy Grover goto err_register; 9687c9e7a6fSAndy Grover 96981ee28deSSheng Yang /* User can set hw_block_size before enable the device */ 97081ee28deSSheng Yang if (dev->dev_attrib.hw_block_size == 0) 9717c9e7a6fSAndy Grover dev->dev_attrib.hw_block_size = 512; 97281ee28deSSheng Yang /* Other attributes can be configured in userspace */ 9733abaa2bfSMike Christie if (!dev->dev_attrib.hw_max_sectors) 9747c9e7a6fSAndy Grover dev->dev_attrib.hw_max_sectors = 128; 9757c9e7a6fSAndy Grover dev->dev_attrib.hw_queue_depth = 128; 9767c9e7a6fSAndy Grover 9777c9e7a6fSAndy Grover ret = tcmu_netlink_event(TCMU_CMD_ADDED_DEVICE, udev->uio_info.name, 9787c9e7a6fSAndy Grover udev->uio_info.uio_dev->minor); 9797c9e7a6fSAndy Grover if (ret) 9807c9e7a6fSAndy Grover goto err_netlink; 9817c9e7a6fSAndy Grover 9827c9e7a6fSAndy Grover return 0; 9837c9e7a6fSAndy Grover 9847c9e7a6fSAndy Grover err_netlink: 9857c9e7a6fSAndy Grover uio_unregister_device(&udev->uio_info); 9867c9e7a6fSAndy Grover err_register: 9877c9e7a6fSAndy Grover vfree(udev->mb_addr); 9887c9e7a6fSAndy Grover err_vzalloc: 9897c9e7a6fSAndy Grover kfree(info->name); 9907c9e7a6fSAndy Grover 9917c9e7a6fSAndy Grover return ret; 9927c9e7a6fSAndy Grover } 9937c9e7a6fSAndy Grover 994b25c7863SSheng Yang static int tcmu_check_and_free_pending_cmd(struct tcmu_cmd *cmd) 9957c9e7a6fSAndy Grover { 996b25c7863SSheng Yang if (test_bit(TCMU_CMD_BIT_EXPIRED, &cmd->flags)) { 997b25c7863SSheng Yang kmem_cache_free(tcmu_cmd_cache, cmd); 9987c9e7a6fSAndy Grover return 0; 999b25c7863SSheng Yang } 10007c9e7a6fSAndy Grover return -EINVAL; 10017c9e7a6fSAndy Grover } 10027c9e7a6fSAndy Grover 10034cc987eaSNicholas Bellinger static void tcmu_dev_call_rcu(struct rcu_head *p) 10044cc987eaSNicholas Bellinger { 10054cc987eaSNicholas Bellinger struct se_device *dev = container_of(p, struct se_device, rcu_head); 10064cc987eaSNicholas Bellinger struct tcmu_dev *udev = TCMU_DEV(dev); 10074cc987eaSNicholas Bellinger 10084cc987eaSNicholas Bellinger kfree(udev); 10094cc987eaSNicholas Bellinger } 10104cc987eaSNicholas Bellinger 1011972c7f16SMike Christie static bool tcmu_dev_configured(struct tcmu_dev *udev) 1012972c7f16SMike Christie { 1013972c7f16SMike Christie return udev->uio_info.uio_dev ? true : false; 1014972c7f16SMike Christie } 1015972c7f16SMike Christie 10167c9e7a6fSAndy Grover static void tcmu_free_device(struct se_device *dev) 10177c9e7a6fSAndy Grover { 10187c9e7a6fSAndy Grover struct tcmu_dev *udev = TCMU_DEV(dev); 1019b25c7863SSheng Yang struct tcmu_cmd *cmd; 1020b25c7863SSheng Yang bool all_expired = true; 10217c9e7a6fSAndy Grover int i; 10227c9e7a6fSAndy Grover 10237c9e7a6fSAndy Grover del_timer_sync(&udev->timeout); 10247c9e7a6fSAndy Grover 10257c9e7a6fSAndy Grover vfree(udev->mb_addr); 10267c9e7a6fSAndy Grover 10277c9e7a6fSAndy Grover /* Upper layer should drain all requests before calling this */ 10287c9e7a6fSAndy Grover spin_lock_irq(&udev->commands_lock); 1029b25c7863SSheng Yang idr_for_each_entry(&udev->commands, cmd, i) { 1030b25c7863SSheng Yang if (tcmu_check_and_free_pending_cmd(cmd) != 0) 1031b25c7863SSheng Yang all_expired = false; 1032b25c7863SSheng Yang } 10337c9e7a6fSAndy Grover idr_destroy(&udev->commands); 10347c9e7a6fSAndy Grover spin_unlock_irq(&udev->commands_lock); 1035b25c7863SSheng Yang WARN_ON(!all_expired); 10367c9e7a6fSAndy Grover 1037972c7f16SMike Christie if (tcmu_dev_configured(udev)) { 10387c9e7a6fSAndy Grover tcmu_netlink_event(TCMU_CMD_REMOVED_DEVICE, udev->uio_info.name, 10397c9e7a6fSAndy Grover udev->uio_info.uio_dev->minor); 10407c9e7a6fSAndy Grover 10417c9e7a6fSAndy Grover uio_unregister_device(&udev->uio_info); 10427c9e7a6fSAndy Grover kfree(udev->uio_info.name); 10437c9e7a6fSAndy Grover kfree(udev->name); 10447c9e7a6fSAndy Grover } 10454cc987eaSNicholas Bellinger call_rcu(&dev->rcu_head, tcmu_dev_call_rcu); 10467c9e7a6fSAndy Grover } 10477c9e7a6fSAndy Grover 10487c9e7a6fSAndy Grover enum { 10493abaa2bfSMike Christie Opt_dev_config, Opt_dev_size, Opt_hw_block_size, Opt_hw_max_sectors, 10507d7a7435SNicholas Bellinger Opt_err, 10517c9e7a6fSAndy Grover }; 10527c9e7a6fSAndy Grover 10537c9e7a6fSAndy Grover static match_table_t tokens = { 10547c9e7a6fSAndy Grover {Opt_dev_config, "dev_config=%s"}, 10557c9e7a6fSAndy Grover {Opt_dev_size, "dev_size=%u"}, 10569c1cd1b6SAndy Grover {Opt_hw_block_size, "hw_block_size=%u"}, 10573abaa2bfSMike Christie {Opt_hw_max_sectors, "hw_max_sectors=%u"}, 10587c9e7a6fSAndy Grover {Opt_err, NULL} 10597c9e7a6fSAndy Grover }; 10607c9e7a6fSAndy Grover 10613abaa2bfSMike Christie static int tcmu_set_dev_attrib(substring_t *arg, u32 *dev_attrib) 10623abaa2bfSMike Christie { 10633abaa2bfSMike Christie unsigned long tmp_ul; 10643abaa2bfSMike Christie char *arg_p; 10653abaa2bfSMike Christie int ret; 10663abaa2bfSMike Christie 10673abaa2bfSMike Christie arg_p = match_strdup(arg); 10683abaa2bfSMike Christie if (!arg_p) 10693abaa2bfSMike Christie return -ENOMEM; 10703abaa2bfSMike Christie 10713abaa2bfSMike Christie ret = kstrtoul(arg_p, 0, &tmp_ul); 10723abaa2bfSMike Christie kfree(arg_p); 10733abaa2bfSMike Christie if (ret < 0) { 10743abaa2bfSMike Christie pr_err("kstrtoul() failed for dev attrib\n"); 10753abaa2bfSMike Christie return ret; 10763abaa2bfSMike Christie } 10773abaa2bfSMike Christie if (!tmp_ul) { 10783abaa2bfSMike Christie pr_err("dev attrib must be nonzero\n"); 10793abaa2bfSMike Christie return -EINVAL; 10803abaa2bfSMike Christie } 10813abaa2bfSMike Christie *dev_attrib = tmp_ul; 10823abaa2bfSMike Christie return 0; 10833abaa2bfSMike Christie } 10843abaa2bfSMike Christie 10857c9e7a6fSAndy Grover static ssize_t tcmu_set_configfs_dev_params(struct se_device *dev, 10867c9e7a6fSAndy Grover const char *page, ssize_t count) 10877c9e7a6fSAndy Grover { 10887c9e7a6fSAndy Grover struct tcmu_dev *udev = TCMU_DEV(dev); 10897c9e7a6fSAndy Grover char *orig, *ptr, *opts, *arg_p; 10907c9e7a6fSAndy Grover substring_t args[MAX_OPT_ARGS]; 10917c9e7a6fSAndy Grover int ret = 0, token; 10927c9e7a6fSAndy Grover 10937c9e7a6fSAndy Grover opts = kstrdup(page, GFP_KERNEL); 10947c9e7a6fSAndy Grover if (!opts) 10957c9e7a6fSAndy Grover return -ENOMEM; 10967c9e7a6fSAndy Grover 10977c9e7a6fSAndy Grover orig = opts; 10987c9e7a6fSAndy Grover 10997c9e7a6fSAndy Grover while ((ptr = strsep(&opts, ",\n")) != NULL) { 11007c9e7a6fSAndy Grover if (!*ptr) 11017c9e7a6fSAndy Grover continue; 11027c9e7a6fSAndy Grover 11037c9e7a6fSAndy Grover token = match_token(ptr, tokens, args); 11047c9e7a6fSAndy Grover switch (token) { 11057c9e7a6fSAndy Grover case Opt_dev_config: 11067c9e7a6fSAndy Grover if (match_strlcpy(udev->dev_config, &args[0], 11077c9e7a6fSAndy Grover TCMU_CONFIG_LEN) == 0) { 11087c9e7a6fSAndy Grover ret = -EINVAL; 11097c9e7a6fSAndy Grover break; 11107c9e7a6fSAndy Grover } 11117c9e7a6fSAndy Grover pr_debug("TCMU: Referencing Path: %s\n", udev->dev_config); 11127c9e7a6fSAndy Grover break; 11137c9e7a6fSAndy Grover case Opt_dev_size: 11147c9e7a6fSAndy Grover arg_p = match_strdup(&args[0]); 11157c9e7a6fSAndy Grover if (!arg_p) { 11167c9e7a6fSAndy Grover ret = -ENOMEM; 11177c9e7a6fSAndy Grover break; 11187c9e7a6fSAndy Grover } 11197c9e7a6fSAndy Grover ret = kstrtoul(arg_p, 0, (unsigned long *) &udev->dev_size); 11207c9e7a6fSAndy Grover kfree(arg_p); 11217c9e7a6fSAndy Grover if (ret < 0) 11227c9e7a6fSAndy Grover pr_err("kstrtoul() failed for dev_size=\n"); 11237c9e7a6fSAndy Grover break; 11249c1cd1b6SAndy Grover case Opt_hw_block_size: 11253abaa2bfSMike Christie ret = tcmu_set_dev_attrib(&args[0], 11263abaa2bfSMike Christie &(dev->dev_attrib.hw_block_size)); 11279c1cd1b6SAndy Grover break; 11283abaa2bfSMike Christie case Opt_hw_max_sectors: 11293abaa2bfSMike Christie ret = tcmu_set_dev_attrib(&args[0], 11303abaa2bfSMike Christie &(dev->dev_attrib.hw_max_sectors)); 11319c1cd1b6SAndy Grover break; 11327c9e7a6fSAndy Grover default: 11337c9e7a6fSAndy Grover break; 11347c9e7a6fSAndy Grover } 11352579325cSMike Christie 11362579325cSMike Christie if (ret) 11372579325cSMike Christie break; 11387c9e7a6fSAndy Grover } 11397c9e7a6fSAndy Grover 11407c9e7a6fSAndy Grover kfree(orig); 11417c9e7a6fSAndy Grover return (!ret) ? count : ret; 11427c9e7a6fSAndy Grover } 11437c9e7a6fSAndy Grover 11447c9e7a6fSAndy Grover static ssize_t tcmu_show_configfs_dev_params(struct se_device *dev, char *b) 11457c9e7a6fSAndy Grover { 11467c9e7a6fSAndy Grover struct tcmu_dev *udev = TCMU_DEV(dev); 11477c9e7a6fSAndy Grover ssize_t bl = 0; 11487c9e7a6fSAndy Grover 11497c9e7a6fSAndy Grover bl = sprintf(b + bl, "Config: %s ", 11507c9e7a6fSAndy Grover udev->dev_config[0] ? udev->dev_config : "NULL"); 11517d7a7435SNicholas Bellinger bl += sprintf(b + bl, "Size: %zu\n", udev->dev_size); 11527c9e7a6fSAndy Grover 11537c9e7a6fSAndy Grover return bl; 11547c9e7a6fSAndy Grover } 11557c9e7a6fSAndy Grover 11567c9e7a6fSAndy Grover static sector_t tcmu_get_blocks(struct se_device *dev) 11577c9e7a6fSAndy Grover { 11587c9e7a6fSAndy Grover struct tcmu_dev *udev = TCMU_DEV(dev); 11597c9e7a6fSAndy Grover 11607c9e7a6fSAndy Grover return div_u64(udev->dev_size - dev->dev_attrib.block_size, 11617c9e7a6fSAndy Grover dev->dev_attrib.block_size); 11627c9e7a6fSAndy Grover } 11637c9e7a6fSAndy Grover 11647c9e7a6fSAndy Grover static sense_reason_t 11657c9e7a6fSAndy Grover tcmu_parse_cdb(struct se_cmd *cmd) 11667c9e7a6fSAndy Grover { 116702eb924fSAndy Grover return passthrough_parse_cdb(cmd, tcmu_queue_cmd); 11689c1cd1b6SAndy Grover } 11699c1cd1b6SAndy Grover 11707d7a7435SNicholas Bellinger static ssize_t tcmu_cmd_time_out_show(struct config_item *item, char *page) 11717d7a7435SNicholas Bellinger { 11727d7a7435SNicholas Bellinger struct se_dev_attrib *da = container_of(to_config_group(item), 11737d7a7435SNicholas Bellinger struct se_dev_attrib, da_group); 11747d7a7435SNicholas Bellinger struct tcmu_dev *udev = container_of(da->da_dev, 11757d7a7435SNicholas Bellinger struct tcmu_dev, se_dev); 11767d7a7435SNicholas Bellinger 11777d7a7435SNicholas Bellinger return snprintf(page, PAGE_SIZE, "%lu\n", udev->cmd_time_out / MSEC_PER_SEC); 11787d7a7435SNicholas Bellinger } 11797d7a7435SNicholas Bellinger 11807d7a7435SNicholas Bellinger static ssize_t tcmu_cmd_time_out_store(struct config_item *item, const char *page, 11817d7a7435SNicholas Bellinger size_t count) 11827d7a7435SNicholas Bellinger { 11837d7a7435SNicholas Bellinger struct se_dev_attrib *da = container_of(to_config_group(item), 11847d7a7435SNicholas Bellinger struct se_dev_attrib, da_group); 11857d7a7435SNicholas Bellinger struct tcmu_dev *udev = container_of(da->da_dev, 11867d7a7435SNicholas Bellinger struct tcmu_dev, se_dev); 11877d7a7435SNicholas Bellinger u32 val; 11887d7a7435SNicholas Bellinger int ret; 11897d7a7435SNicholas Bellinger 11907d7a7435SNicholas Bellinger if (da->da_dev->export_count) { 11917d7a7435SNicholas Bellinger pr_err("Unable to set tcmu cmd_time_out while exports exist\n"); 11927d7a7435SNicholas Bellinger return -EINVAL; 11937d7a7435SNicholas Bellinger } 11947d7a7435SNicholas Bellinger 11957d7a7435SNicholas Bellinger ret = kstrtou32(page, 0, &val); 11967d7a7435SNicholas Bellinger if (ret < 0) 11977d7a7435SNicholas Bellinger return ret; 11987d7a7435SNicholas Bellinger 11997d7a7435SNicholas Bellinger if (!val) { 12007d7a7435SNicholas Bellinger pr_err("Illegal value for cmd_time_out\n"); 12017d7a7435SNicholas Bellinger return -EINVAL; 12027d7a7435SNicholas Bellinger } 12037d7a7435SNicholas Bellinger 12047d7a7435SNicholas Bellinger udev->cmd_time_out = val * MSEC_PER_SEC; 12057d7a7435SNicholas Bellinger return count; 12067d7a7435SNicholas Bellinger } 12077d7a7435SNicholas Bellinger CONFIGFS_ATTR(tcmu_, cmd_time_out); 12087d7a7435SNicholas Bellinger 12097d7a7435SNicholas Bellinger static struct configfs_attribute **tcmu_attrs; 12107d7a7435SNicholas Bellinger 12117d7a7435SNicholas Bellinger static struct target_backend_ops tcmu_ops = { 12127c9e7a6fSAndy Grover .name = "user", 12137c9e7a6fSAndy Grover .owner = THIS_MODULE, 1214a3541703SAndy Grover .transport_flags = TRANSPORT_FLAG_PASSTHROUGH, 12157c9e7a6fSAndy Grover .attach_hba = tcmu_attach_hba, 12167c9e7a6fSAndy Grover .detach_hba = tcmu_detach_hba, 12177c9e7a6fSAndy Grover .alloc_device = tcmu_alloc_device, 12187c9e7a6fSAndy Grover .configure_device = tcmu_configure_device, 12197c9e7a6fSAndy Grover .free_device = tcmu_free_device, 12207c9e7a6fSAndy Grover .parse_cdb = tcmu_parse_cdb, 12217c9e7a6fSAndy Grover .set_configfs_dev_params = tcmu_set_configfs_dev_params, 12227c9e7a6fSAndy Grover .show_configfs_dev_params = tcmu_show_configfs_dev_params, 12237c9e7a6fSAndy Grover .get_device_type = sbc_get_device_type, 12247c9e7a6fSAndy Grover .get_blocks = tcmu_get_blocks, 12257d7a7435SNicholas Bellinger .tb_dev_attrib_attrs = NULL, 12267c9e7a6fSAndy Grover }; 12277c9e7a6fSAndy Grover 12287c9e7a6fSAndy Grover static int __init tcmu_module_init(void) 12297c9e7a6fSAndy Grover { 12307d7a7435SNicholas Bellinger int ret, i, len = 0; 12317c9e7a6fSAndy Grover 12327c9e7a6fSAndy Grover BUILD_BUG_ON((sizeof(struct tcmu_cmd_entry) % TCMU_OP_ALIGN_SIZE) != 0); 12337c9e7a6fSAndy Grover 12347c9e7a6fSAndy Grover tcmu_cmd_cache = kmem_cache_create("tcmu_cmd_cache", 12357c9e7a6fSAndy Grover sizeof(struct tcmu_cmd), 12367c9e7a6fSAndy Grover __alignof__(struct tcmu_cmd), 12377c9e7a6fSAndy Grover 0, NULL); 12387c9e7a6fSAndy Grover if (!tcmu_cmd_cache) 12397c9e7a6fSAndy Grover return -ENOMEM; 12407c9e7a6fSAndy Grover 12417c9e7a6fSAndy Grover tcmu_root_device = root_device_register("tcm_user"); 12427c9e7a6fSAndy Grover if (IS_ERR(tcmu_root_device)) { 12437c9e7a6fSAndy Grover ret = PTR_ERR(tcmu_root_device); 12447c9e7a6fSAndy Grover goto out_free_cache; 12457c9e7a6fSAndy Grover } 12467c9e7a6fSAndy Grover 12477c9e7a6fSAndy Grover ret = genl_register_family(&tcmu_genl_family); 12487c9e7a6fSAndy Grover if (ret < 0) { 12497c9e7a6fSAndy Grover goto out_unreg_device; 12507c9e7a6fSAndy Grover } 12517c9e7a6fSAndy Grover 12527d7a7435SNicholas Bellinger for (i = 0; passthrough_attrib_attrs[i] != NULL; i++) { 12537d7a7435SNicholas Bellinger len += sizeof(struct configfs_attribute *); 12547d7a7435SNicholas Bellinger } 12557d7a7435SNicholas Bellinger len += sizeof(struct configfs_attribute *) * 2; 12567d7a7435SNicholas Bellinger 12577d7a7435SNicholas Bellinger tcmu_attrs = kzalloc(len, GFP_KERNEL); 12587d7a7435SNicholas Bellinger if (!tcmu_attrs) { 12597d7a7435SNicholas Bellinger ret = -ENOMEM; 12607d7a7435SNicholas Bellinger goto out_unreg_genl; 12617d7a7435SNicholas Bellinger } 12627d7a7435SNicholas Bellinger 12637d7a7435SNicholas Bellinger for (i = 0; passthrough_attrib_attrs[i] != NULL; i++) { 12647d7a7435SNicholas Bellinger tcmu_attrs[i] = passthrough_attrib_attrs[i]; 12657d7a7435SNicholas Bellinger } 12667d7a7435SNicholas Bellinger tcmu_attrs[i] = &tcmu_attr_cmd_time_out; 12677d7a7435SNicholas Bellinger tcmu_ops.tb_dev_attrib_attrs = tcmu_attrs; 12687d7a7435SNicholas Bellinger 12690a06d430SChristoph Hellwig ret = transport_backend_register(&tcmu_ops); 12707c9e7a6fSAndy Grover if (ret) 12717d7a7435SNicholas Bellinger goto out_attrs; 12727c9e7a6fSAndy Grover 12737c9e7a6fSAndy Grover return 0; 12747c9e7a6fSAndy Grover 12757d7a7435SNicholas Bellinger out_attrs: 12767d7a7435SNicholas Bellinger kfree(tcmu_attrs); 12777c9e7a6fSAndy Grover out_unreg_genl: 12787c9e7a6fSAndy Grover genl_unregister_family(&tcmu_genl_family); 12797c9e7a6fSAndy Grover out_unreg_device: 12807c9e7a6fSAndy Grover root_device_unregister(tcmu_root_device); 12817c9e7a6fSAndy Grover out_free_cache: 12827c9e7a6fSAndy Grover kmem_cache_destroy(tcmu_cmd_cache); 12837c9e7a6fSAndy Grover 12847c9e7a6fSAndy Grover return ret; 12857c9e7a6fSAndy Grover } 12867c9e7a6fSAndy Grover 12877c9e7a6fSAndy Grover static void __exit tcmu_module_exit(void) 12887c9e7a6fSAndy Grover { 12890a06d430SChristoph Hellwig target_backend_unregister(&tcmu_ops); 12907d7a7435SNicholas Bellinger kfree(tcmu_attrs); 12917c9e7a6fSAndy Grover genl_unregister_family(&tcmu_genl_family); 12927c9e7a6fSAndy Grover root_device_unregister(tcmu_root_device); 12937c9e7a6fSAndy Grover kmem_cache_destroy(tcmu_cmd_cache); 12947c9e7a6fSAndy Grover } 12957c9e7a6fSAndy Grover 12967c9e7a6fSAndy Grover MODULE_DESCRIPTION("TCM USER subsystem plugin"); 12977c9e7a6fSAndy Grover MODULE_AUTHOR("Shaohua Li <shli@kernel.org>"); 12987c9e7a6fSAndy Grover MODULE_AUTHOR("Andy Grover <agrover@redhat.com>"); 12997c9e7a6fSAndy Grover MODULE_LICENSE("GPL"); 13007c9e7a6fSAndy Grover 13017c9e7a6fSAndy Grover module_init(tcmu_module_init); 13027c9e7a6fSAndy Grover module_exit(tcmu_module_exit); 1303