Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2013 Shaohua Li <shli@kernel.org> |
| 3 | * Copyright (C) 2014 Red Hat, Inc. |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 4 | * Copyright (C) 2015 Arrikto, Inc. |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify it |
| 7 | * under the terms and conditions of the GNU General Public License, |
| 8 | * version 2, as published by the Free Software Foundation. |
| 9 | * |
| 10 | * This program is distributed in the hope it will be useful, but WITHOUT |
| 11 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 12 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for |
| 13 | * more details. |
| 14 | * |
| 15 | * You should have received a copy of the GNU General Public License along with |
| 16 | * this program; if not, write to the Free Software Foundation, Inc., |
| 17 | * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. |
| 18 | */ |
| 19 | |
| 20 | #include <linux/spinlock.h> |
| 21 | #include <linux/module.h> |
| 22 | #include <linux/idr.h> |
Bart Van Assche | ba92999 | 2015-05-08 10:11:12 +0200 | [diff] [blame] | 23 | #include <linux/kernel.h> |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 24 | #include <linux/timer.h> |
| 25 | #include <linux/parser.h> |
David S. Miller | 5538d29 | 2015-05-28 11:35:41 -0700 | [diff] [blame] | 26 | #include <linux/vmalloc.h> |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 27 | #include <linux/uio_driver.h> |
David Disseldorp | ac64a2c | 2015-09-04 01:39:56 +0200 | [diff] [blame] | 28 | #include <linux/stringify.h> |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 29 | #include <linux/bitops.h> |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 30 | #include <net/genetlink.h> |
Bart Van Assche | ba92999 | 2015-05-08 10:11:12 +0200 | [diff] [blame] | 31 | #include <scsi/scsi_common.h> |
| 32 | #include <scsi/scsi_proto.h> |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 33 | #include <target/target_core_base.h> |
| 34 | #include <target/target_core_fabric.h> |
| 35 | #include <target/target_core_backend.h> |
Nicholas Bellinger | e9f720d | 2014-11-28 05:11:24 +0000 | [diff] [blame] | 36 | |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 37 | #include <linux/target_core_user.h> |
| 38 | |
| 39 | /* |
| 40 | * Define a shared-memory interface for LIO to pass SCSI commands and |
| 41 | * data to userspace for processing. This is to allow backends that |
| 42 | * are too complex for in-kernel support to be possible. |
| 43 | * |
| 44 | * It uses the UIO framework to do a lot of the device-creation and |
| 45 | * introspection work for us. |
| 46 | * |
| 47 | * See the .h file for how the ring is laid out. Note that while the |
| 48 | * command ring is defined, the particulars of the data area are |
| 49 | * not. Offset values in the command entry point to other locations |
| 50 | * internal to the mmap()ed area. There is separate space outside the |
| 51 | * command ring for data buffers. This leaves maximum flexibility for |
| 52 | * moving buffer allocations, or even page flipping or other |
| 53 | * allocation techniques, without altering the command ring layout. |
| 54 | * |
| 55 | * SECURITY: |
| 56 | * The user process must be assumed to be malicious. There's no way to |
| 57 | * prevent it breaking the command ring protocol if it wants, but in |
| 58 | * order to prevent other issues we must only ever read *data* from |
| 59 | * the shared memory area, not offsets or sizes. This applies to |
| 60 | * command ring entries as well as the mailbox. Extra code needed for |
| 61 | * this may have a 'UAM' comment. |
| 62 | */ |
| 63 | |
| 64 | |
| 65 | #define TCMU_TIME_OUT (30 * MSEC_PER_SEC) |
| 66 | |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 67 | #define DATA_BLOCK_BITS 256 |
| 68 | #define DATA_BLOCK_SIZE 4096 |
| 69 | |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 70 | #define CMDR_SIZE (16 * 4096) |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 71 | #define DATA_SIZE (DATA_BLOCK_BITS * DATA_BLOCK_SIZE) |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 72 | |
| 73 | #define TCMU_RING_SIZE (CMDR_SIZE + DATA_SIZE) |
| 74 | |
| 75 | static struct device *tcmu_root_device; |
| 76 | |
| 77 | struct tcmu_hba { |
| 78 | u32 host_id; |
| 79 | }; |
| 80 | |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 81 | #define TCMU_CONFIG_LEN 256 |
| 82 | |
| 83 | struct tcmu_dev { |
| 84 | struct se_device se_dev; |
| 85 | |
| 86 | char *name; |
| 87 | struct se_hba *hba; |
| 88 | |
| 89 | #define TCMU_DEV_BIT_OPEN 0 |
| 90 | #define TCMU_DEV_BIT_BROKEN 1 |
| 91 | unsigned long flags; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 92 | |
| 93 | struct uio_info uio_info; |
| 94 | |
| 95 | struct tcmu_mailbox *mb_addr; |
| 96 | size_t dev_size; |
| 97 | u32 cmdr_size; |
| 98 | u32 cmdr_last_cleaned; |
Andy Grover | 3d9b955 | 2016-08-25 08:55:54 -0700 | [diff] [blame] | 99 | /* Offset of data area from start of mb */ |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 100 | /* Must add data_off and mb_addr to get the address */ |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 101 | size_t data_off; |
| 102 | size_t data_size; |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 103 | |
| 104 | DECLARE_BITMAP(data_bitmap, DATA_BLOCK_BITS); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 105 | |
| 106 | wait_queue_head_t wait_cmdr; |
| 107 | /* TODO should this be a mutex? */ |
| 108 | spinlock_t cmdr_lock; |
| 109 | |
| 110 | struct idr commands; |
| 111 | spinlock_t commands_lock; |
| 112 | |
| 113 | struct timer_list timeout; |
| 114 | |
| 115 | char dev_config[TCMU_CONFIG_LEN]; |
| 116 | }; |
| 117 | |
| 118 | #define TCMU_DEV(_se_dev) container_of(_se_dev, struct tcmu_dev, se_dev) |
| 119 | |
| 120 | #define CMDR_OFF sizeof(struct tcmu_mailbox) |
| 121 | |
| 122 | struct tcmu_cmd { |
| 123 | struct se_cmd *se_cmd; |
| 124 | struct tcmu_dev *tcmu_dev; |
| 125 | |
| 126 | uint16_t cmd_id; |
| 127 | |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 128 | /* Can't use se_cmd when cleaning up expired cmds, because if |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 129 | cmd has been completed then accessing se_cmd is off limits */ |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 130 | DECLARE_BITMAP(data_bitmap, DATA_BLOCK_BITS); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 131 | |
| 132 | unsigned long deadline; |
| 133 | |
| 134 | #define TCMU_CMD_BIT_EXPIRED 0 |
| 135 | unsigned long flags; |
| 136 | }; |
| 137 | |
| 138 | static struct kmem_cache *tcmu_cmd_cache; |
| 139 | |
| 140 | /* multicast group */ |
| 141 | enum tcmu_multicast_groups { |
| 142 | TCMU_MCGRP_CONFIG, |
| 143 | }; |
| 144 | |
| 145 | static const struct genl_multicast_group tcmu_mcgrps[] = { |
| 146 | [TCMU_MCGRP_CONFIG] = { .name = "config", }, |
| 147 | }; |
| 148 | |
| 149 | /* Our generic netlink family */ |
| 150 | static struct genl_family tcmu_genl_family = { |
| 151 | .id = GENL_ID_GENERATE, |
| 152 | .hdrsize = 0, |
| 153 | .name = "TCM-USER", |
| 154 | .version = 1, |
| 155 | .maxattr = TCMU_ATTR_MAX, |
| 156 | .mcgrps = tcmu_mcgrps, |
| 157 | .n_mcgrps = ARRAY_SIZE(tcmu_mcgrps), |
Sheng Yang | 20c08b3 | 2016-01-13 17:26:13 -0800 | [diff] [blame] | 158 | .netnsok = true, |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 159 | }; |
| 160 | |
| 161 | static struct tcmu_cmd *tcmu_alloc_cmd(struct se_cmd *se_cmd) |
| 162 | { |
| 163 | struct se_device *se_dev = se_cmd->se_dev; |
| 164 | struct tcmu_dev *udev = TCMU_DEV(se_dev); |
| 165 | struct tcmu_cmd *tcmu_cmd; |
| 166 | int cmd_id; |
| 167 | |
| 168 | tcmu_cmd = kmem_cache_zalloc(tcmu_cmd_cache, GFP_KERNEL); |
| 169 | if (!tcmu_cmd) |
| 170 | return NULL; |
| 171 | |
| 172 | tcmu_cmd->se_cmd = se_cmd; |
| 173 | tcmu_cmd->tcmu_dev = udev; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 174 | tcmu_cmd->deadline = jiffies + msecs_to_jiffies(TCMU_TIME_OUT); |
| 175 | |
| 176 | idr_preload(GFP_KERNEL); |
| 177 | spin_lock_irq(&udev->commands_lock); |
| 178 | cmd_id = idr_alloc(&udev->commands, tcmu_cmd, 0, |
| 179 | USHRT_MAX, GFP_NOWAIT); |
| 180 | spin_unlock_irq(&udev->commands_lock); |
| 181 | idr_preload_end(); |
| 182 | |
| 183 | if (cmd_id < 0) { |
| 184 | kmem_cache_free(tcmu_cmd_cache, tcmu_cmd); |
| 185 | return NULL; |
| 186 | } |
| 187 | tcmu_cmd->cmd_id = cmd_id; |
| 188 | |
| 189 | return tcmu_cmd; |
| 190 | } |
| 191 | |
| 192 | static inline void tcmu_flush_dcache_range(void *vaddr, size_t size) |
| 193 | { |
Geliang Tang | b75d806 | 2015-11-25 21:49:27 +0800 | [diff] [blame] | 194 | unsigned long offset = offset_in_page(vaddr); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 195 | |
| 196 | size = round_up(size+offset, PAGE_SIZE); |
| 197 | vaddr -= offset; |
| 198 | |
| 199 | while (size) { |
| 200 | flush_dcache_page(virt_to_page(vaddr)); |
| 201 | size -= PAGE_SIZE; |
| 202 | } |
| 203 | } |
| 204 | |
| 205 | /* |
| 206 | * Some ring helper functions. We don't assume size is a power of 2 so |
| 207 | * we can't use circ_buf.h. |
| 208 | */ |
| 209 | static inline size_t spc_used(size_t head, size_t tail, size_t size) |
| 210 | { |
| 211 | int diff = head - tail; |
| 212 | |
| 213 | if (diff >= 0) |
| 214 | return diff; |
| 215 | else |
| 216 | return size + diff; |
| 217 | } |
| 218 | |
| 219 | static inline size_t spc_free(size_t head, size_t tail, size_t size) |
| 220 | { |
| 221 | /* Keep 1 byte unused or we can't tell full from empty */ |
| 222 | return (size - spc_used(head, tail, size) - 1); |
| 223 | } |
| 224 | |
| 225 | static inline size_t head_to_end(size_t head, size_t size) |
| 226 | { |
| 227 | return size - head; |
| 228 | } |
| 229 | |
Sheng Yang | f1dbd08 | 2016-02-26 14:59:55 -0800 | [diff] [blame] | 230 | static inline void new_iov(struct iovec **iov, int *iov_cnt, |
| 231 | struct tcmu_dev *udev) |
| 232 | { |
| 233 | struct iovec *iovec; |
| 234 | |
| 235 | if (*iov_cnt != 0) |
| 236 | (*iov)++; |
| 237 | (*iov_cnt)++; |
| 238 | |
| 239 | iovec = *iov; |
| 240 | memset(iovec, 0, sizeof(struct iovec)); |
Sheng Yang | f1dbd08 | 2016-02-26 14:59:55 -0800 | [diff] [blame] | 241 | } |
| 242 | |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 243 | #define UPDATE_HEAD(head, used, size) smp_store_release(&head, ((head % size) + used) % size) |
| 244 | |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 245 | /* offset is relative to mb_addr */ |
| 246 | static inline size_t get_block_offset(struct tcmu_dev *dev, |
| 247 | int block, int remaining) |
| 248 | { |
| 249 | return dev->data_off + block * DATA_BLOCK_SIZE + |
| 250 | DATA_BLOCK_SIZE - remaining; |
| 251 | } |
| 252 | |
| 253 | static inline size_t iov_tail(struct tcmu_dev *udev, struct iovec *iov) |
| 254 | { |
| 255 | return (size_t)iov->iov_base + iov->iov_len; |
| 256 | } |
| 257 | |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 258 | static void alloc_and_scatter_data_area(struct tcmu_dev *udev, |
| 259 | struct scatterlist *data_sg, unsigned int data_nents, |
| 260 | struct iovec **iov, int *iov_cnt, bool copy_data) |
| 261 | { |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 262 | int i, block; |
| 263 | int block_remaining = 0; |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 264 | void *from, *to; |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 265 | size_t copy_bytes, to_offset; |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 266 | struct scatterlist *sg; |
| 267 | |
| 268 | for_each_sg(data_sg, sg, data_nents, i) { |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 269 | int sg_remaining = sg->length; |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 270 | from = kmap_atomic(sg_page(sg)) + sg->offset; |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 271 | while (sg_remaining > 0) { |
| 272 | if (block_remaining == 0) { |
| 273 | block = find_first_zero_bit(udev->data_bitmap, |
| 274 | DATA_BLOCK_BITS); |
| 275 | block_remaining = DATA_BLOCK_SIZE; |
| 276 | set_bit(block, udev->data_bitmap); |
| 277 | } |
| 278 | copy_bytes = min_t(size_t, sg_remaining, |
| 279 | block_remaining); |
| 280 | to_offset = get_block_offset(udev, block, |
| 281 | block_remaining); |
| 282 | to = (void *)udev->mb_addr + to_offset; |
| 283 | if (*iov_cnt != 0 && |
| 284 | to_offset == iov_tail(udev, *iov)) { |
| 285 | (*iov)->iov_len += copy_bytes; |
| 286 | } else { |
| 287 | new_iov(iov, iov_cnt, udev); |
| 288 | (*iov)->iov_base = (void __user *) to_offset; |
| 289 | (*iov)->iov_len = copy_bytes; |
| 290 | } |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 291 | if (copy_data) { |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 292 | memcpy(to, from + sg->length - sg_remaining, |
| 293 | copy_bytes); |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 294 | tcmu_flush_dcache_range(to, copy_bytes); |
| 295 | } |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 296 | sg_remaining -= copy_bytes; |
| 297 | block_remaining -= copy_bytes; |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 298 | } |
Sagi Grimberg | e2e21bd | 2015-06-11 19:58:34 +0300 | [diff] [blame] | 299 | kunmap_atomic(from - sg->offset); |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 300 | } |
| 301 | } |
| 302 | |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 303 | static void free_data_area(struct tcmu_dev *udev, struct tcmu_cmd *cmd) |
Sheng Yang | 0c28481 | 2016-02-26 14:59:56 -0800 | [diff] [blame] | 304 | { |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 305 | bitmap_xor(udev->data_bitmap, udev->data_bitmap, cmd->data_bitmap, |
| 306 | DATA_BLOCK_BITS); |
Sheng Yang | 0c28481 | 2016-02-26 14:59:56 -0800 | [diff] [blame] | 307 | } |
| 308 | |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 309 | static void gather_data_area(struct tcmu_dev *udev, unsigned long *cmd_bitmap, |
| 310 | struct scatterlist *data_sg, unsigned int data_nents) |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 311 | { |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 312 | int i, block; |
| 313 | int block_remaining = 0; |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 314 | void *from, *to; |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 315 | size_t copy_bytes, from_offset; |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 316 | struct scatterlist *sg; |
| 317 | |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 318 | for_each_sg(data_sg, sg, data_nents, i) { |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 319 | int sg_remaining = sg->length; |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 320 | to = kmap_atomic(sg_page(sg)) + sg->offset; |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 321 | while (sg_remaining > 0) { |
| 322 | if (block_remaining == 0) { |
| 323 | block = find_first_bit(cmd_bitmap, |
| 324 | DATA_BLOCK_BITS); |
| 325 | block_remaining = DATA_BLOCK_SIZE; |
| 326 | clear_bit(block, cmd_bitmap); |
| 327 | } |
| 328 | copy_bytes = min_t(size_t, sg_remaining, |
| 329 | block_remaining); |
| 330 | from_offset = get_block_offset(udev, block, |
| 331 | block_remaining); |
| 332 | from = (void *) udev->mb_addr + from_offset; |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 333 | tcmu_flush_dcache_range(from, copy_bytes); |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 334 | memcpy(to + sg->length - sg_remaining, from, |
| 335 | copy_bytes); |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 336 | |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 337 | sg_remaining -= copy_bytes; |
| 338 | block_remaining -= copy_bytes; |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 339 | } |
Sagi Grimberg | e2e21bd | 2015-06-11 19:58:34 +0300 | [diff] [blame] | 340 | kunmap_atomic(to - sg->offset); |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 341 | } |
| 342 | } |
| 343 | |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 344 | static inline size_t spc_bitmap_free(unsigned long *bitmap) |
| 345 | { |
| 346 | return DATA_BLOCK_SIZE * (DATA_BLOCK_BITS - |
| 347 | bitmap_weight(bitmap, DATA_BLOCK_BITS)); |
| 348 | } |
| 349 | |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 350 | /* |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 351 | * We can't queue a command until we have space available on the cmd ring *and* |
Andy Grover | 3d9b955 | 2016-08-25 08:55:54 -0700 | [diff] [blame] | 352 | * space available on the data area. |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 353 | * |
| 354 | * Called with ring lock held. |
| 355 | */ |
Andy Grover | f56574a | 2014-10-02 10:23:15 -0700 | [diff] [blame] | 356 | static bool is_ring_space_avail(struct tcmu_dev *udev, size_t cmd_size, size_t data_needed) |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 357 | { |
| 358 | struct tcmu_mailbox *mb = udev->mb_addr; |
Nicholas Bellinger | 0241fd39 | 2016-02-27 18:25:22 -0800 | [diff] [blame] | 359 | size_t space, cmd_needed; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 360 | u32 cmd_head; |
| 361 | |
| 362 | tcmu_flush_dcache_range(mb, sizeof(*mb)); |
| 363 | |
| 364 | cmd_head = mb->cmd_head % udev->cmdr_size; /* UAM */ |
| 365 | |
Andy Grover | f56574a | 2014-10-02 10:23:15 -0700 | [diff] [blame] | 366 | /* |
| 367 | * If cmd end-of-ring space is too small then we need space for a NOP plus |
| 368 | * original cmd - cmds are internally contiguous. |
| 369 | */ |
| 370 | if (head_to_end(cmd_head, udev->cmdr_size) >= cmd_size) |
| 371 | cmd_needed = cmd_size; |
| 372 | else |
| 373 | cmd_needed = cmd_size + head_to_end(cmd_head, udev->cmdr_size); |
| 374 | |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 375 | space = spc_free(cmd_head, udev->cmdr_last_cleaned, udev->cmdr_size); |
| 376 | if (space < cmd_needed) { |
| 377 | pr_debug("no cmd space: %u %u %u\n", cmd_head, |
| 378 | udev->cmdr_last_cleaned, udev->cmdr_size); |
| 379 | return false; |
| 380 | } |
| 381 | |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 382 | space = spc_bitmap_free(udev->data_bitmap); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 383 | if (space < data_needed) { |
Nicholas Bellinger | 0241fd39 | 2016-02-27 18:25:22 -0800 | [diff] [blame] | 384 | pr_debug("no data space: only %zu available, but ask for %zu\n", |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 385 | space, data_needed); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 386 | return false; |
| 387 | } |
| 388 | |
| 389 | return true; |
| 390 | } |
| 391 | |
Xiubo Li | ef599fa | 2017-03-27 17:07:40 +0800 | [diff] [blame^] | 392 | static inline size_t tcmu_cmd_get_data_length(struct tcmu_cmd *tcmu_cmd) |
| 393 | { |
| 394 | struct se_cmd *se_cmd = tcmu_cmd->se_cmd; |
| 395 | size_t data_length = round_up(se_cmd->data_length, DATA_BLOCK_SIZE); |
| 396 | |
| 397 | if (se_cmd->se_cmd_flags & SCF_BIDI) { |
| 398 | BUG_ON(!(se_cmd->t_bidi_data_sg && se_cmd->t_bidi_data_nents)); |
| 399 | data_length += round_up(se_cmd->t_bidi_data_sg->length, |
| 400 | DATA_BLOCK_SIZE); |
| 401 | } |
| 402 | |
| 403 | return data_length; |
| 404 | } |
| 405 | |
Andy Grover | 02eb924 | 2016-10-06 10:07:07 -0500 | [diff] [blame] | 406 | static sense_reason_t |
| 407 | tcmu_queue_cmd_ring(struct tcmu_cmd *tcmu_cmd) |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 408 | { |
| 409 | struct tcmu_dev *udev = tcmu_cmd->tcmu_dev; |
| 410 | struct se_cmd *se_cmd = tcmu_cmd->se_cmd; |
| 411 | size_t base_command_size, command_size; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 412 | struct tcmu_mailbox *mb; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 413 | struct tcmu_cmd_entry *entry; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 414 | struct iovec *iov; |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 415 | int iov_cnt; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 416 | uint32_t cmd_head; |
| 417 | uint64_t cdb_off; |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 418 | bool copy_to_data_area; |
Xiubo Li | ef599fa | 2017-03-27 17:07:40 +0800 | [diff] [blame^] | 419 | size_t data_length = tcmu_cmd_get_data_length(tcmu_cmd); |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 420 | DECLARE_BITMAP(old_bitmap, DATA_BLOCK_BITS); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 421 | |
| 422 | if (test_bit(TCMU_DEV_BIT_BROKEN, &udev->flags)) |
Andy Grover | 02eb924 | 2016-10-06 10:07:07 -0500 | [diff] [blame] | 423 | return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 424 | |
| 425 | /* |
| 426 | * Must be a certain minimum size for response sense info, but |
| 427 | * also may be larger if the iov array is large. |
| 428 | * |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 429 | * We prepare way too many iovs for potential uses here, because it's |
| 430 | * expensive to tell how many regions are freed in the bitmap |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 431 | */ |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 432 | base_command_size = max(offsetof(struct tcmu_cmd_entry, |
| 433 | req.iov[se_cmd->t_bidi_data_nents + |
| 434 | se_cmd->t_data_nents]), |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 435 | sizeof(struct tcmu_cmd_entry)); |
| 436 | command_size = base_command_size |
| 437 | + round_up(scsi_command_size(se_cmd->t_task_cdb), TCMU_OP_ALIGN_SIZE); |
| 438 | |
| 439 | WARN_ON(command_size & (TCMU_OP_ALIGN_SIZE-1)); |
| 440 | |
| 441 | spin_lock_irq(&udev->cmdr_lock); |
| 442 | |
| 443 | mb = udev->mb_addr; |
| 444 | cmd_head = mb->cmd_head % udev->cmdr_size; /* UAM */ |
Andy Grover | 554617b | 2016-08-25 08:55:53 -0700 | [diff] [blame] | 445 | if ((command_size > (udev->cmdr_size / 2)) || |
| 446 | data_length > udev->data_size) { |
| 447 | pr_warn("TCMU: Request of size %zu/%zu is too big for %u/%zu " |
Andy Grover | 3d9b955 | 2016-08-25 08:55:54 -0700 | [diff] [blame] | 448 | "cmd ring/data area\n", command_size, data_length, |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 449 | udev->cmdr_size, udev->data_size); |
Andy Grover | 554617b | 2016-08-25 08:55:53 -0700 | [diff] [blame] | 450 | spin_unlock_irq(&udev->cmdr_lock); |
| 451 | return TCM_INVALID_CDB_FIELD; |
| 452 | } |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 453 | |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 454 | while (!is_ring_space_avail(udev, command_size, data_length)) { |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 455 | int ret; |
| 456 | DEFINE_WAIT(__wait); |
| 457 | |
| 458 | prepare_to_wait(&udev->wait_cmdr, &__wait, TASK_INTERRUPTIBLE); |
| 459 | |
| 460 | pr_debug("sleeping for ring space\n"); |
| 461 | spin_unlock_irq(&udev->cmdr_lock); |
| 462 | ret = schedule_timeout(msecs_to_jiffies(TCMU_TIME_OUT)); |
| 463 | finish_wait(&udev->wait_cmdr, &__wait); |
| 464 | if (!ret) { |
| 465 | pr_warn("tcmu: command timed out\n"); |
Andy Grover | 02eb924 | 2016-10-06 10:07:07 -0500 | [diff] [blame] | 466 | return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 467 | } |
| 468 | |
| 469 | spin_lock_irq(&udev->cmdr_lock); |
| 470 | |
| 471 | /* We dropped cmdr_lock, cmd_head is stale */ |
| 472 | cmd_head = mb->cmd_head % udev->cmdr_size; /* UAM */ |
| 473 | } |
| 474 | |
Andy Grover | f56574a | 2014-10-02 10:23:15 -0700 | [diff] [blame] | 475 | /* Insert a PAD if end-of-ring space is too small */ |
| 476 | if (head_to_end(cmd_head, udev->cmdr_size) < command_size) { |
| 477 | size_t pad_size = head_to_end(cmd_head, udev->cmdr_size); |
| 478 | |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 479 | entry = (void *) mb + CMDR_OFF + cmd_head; |
| 480 | tcmu_flush_dcache_range(entry, sizeof(*entry)); |
Andy Grover | 0ad46af | 2015-04-14 17:30:04 -0700 | [diff] [blame] | 481 | tcmu_hdr_set_op(&entry->hdr.len_op, TCMU_OP_PAD); |
| 482 | tcmu_hdr_set_len(&entry->hdr.len_op, pad_size); |
| 483 | entry->hdr.cmd_id = 0; /* not used for PAD */ |
| 484 | entry->hdr.kflags = 0; |
| 485 | entry->hdr.uflags = 0; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 486 | |
| 487 | UPDATE_HEAD(mb->cmd_head, pad_size, udev->cmdr_size); |
| 488 | |
| 489 | cmd_head = mb->cmd_head % udev->cmdr_size; /* UAM */ |
| 490 | WARN_ON(cmd_head != 0); |
| 491 | } |
| 492 | |
| 493 | entry = (void *) mb + CMDR_OFF + cmd_head; |
| 494 | tcmu_flush_dcache_range(entry, sizeof(*entry)); |
Andy Grover | 0ad46af | 2015-04-14 17:30:04 -0700 | [diff] [blame] | 495 | tcmu_hdr_set_op(&entry->hdr.len_op, TCMU_OP_CMD); |
| 496 | tcmu_hdr_set_len(&entry->hdr.len_op, command_size); |
| 497 | entry->hdr.cmd_id = tcmu_cmd->cmd_id; |
| 498 | entry->hdr.kflags = 0; |
| 499 | entry->hdr.uflags = 0; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 500 | |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 501 | bitmap_copy(old_bitmap, udev->data_bitmap, DATA_BLOCK_BITS); |
| 502 | |
Andy Grover | 3d9b955 | 2016-08-25 08:55:54 -0700 | [diff] [blame] | 503 | /* Handle allocating space from the data area */ |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 504 | iov = &entry->req.iov[0]; |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 505 | iov_cnt = 0; |
Ilias Tsitsimpis | e4648b0 | 2015-04-23 21:30:09 +0300 | [diff] [blame] | 506 | copy_to_data_area = (se_cmd->data_direction == DMA_TO_DEVICE |
| 507 | || se_cmd->se_cmd_flags & SCF_BIDI); |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 508 | alloc_and_scatter_data_area(udev, se_cmd->t_data_sg, |
| 509 | se_cmd->t_data_nents, &iov, &iov_cnt, copy_to_data_area); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 510 | entry->req.iov_cnt = iov_cnt; |
Andy Grover | 0ad46af | 2015-04-14 17:30:04 -0700 | [diff] [blame] | 511 | entry->req.iov_dif_cnt = 0; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 512 | |
Ilias Tsitsimpis | e4648b0 | 2015-04-23 21:30:09 +0300 | [diff] [blame] | 513 | /* Handle BIDI commands */ |
Xiubo Li | ef599fa | 2017-03-27 17:07:40 +0800 | [diff] [blame^] | 514 | if (se_cmd->se_cmd_flags & SCF_BIDI) { |
| 515 | iov_cnt = 0; |
| 516 | iov++; |
| 517 | alloc_and_scatter_data_area(udev, se_cmd->t_bidi_data_sg, |
| 518 | se_cmd->t_bidi_data_nents, &iov, &iov_cnt, |
| 519 | false); |
| 520 | entry->req.iov_bidi_cnt = iov_cnt; |
| 521 | } |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 522 | /* cmd's data_bitmap is what changed in process */ |
| 523 | bitmap_xor(tcmu_cmd->data_bitmap, old_bitmap, udev->data_bitmap, |
| 524 | DATA_BLOCK_BITS); |
| 525 | |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 526 | /* All offsets relative to mb_addr, not start of entry! */ |
| 527 | cdb_off = CMDR_OFF + cmd_head + base_command_size; |
| 528 | memcpy((void *) mb + cdb_off, se_cmd->t_task_cdb, scsi_command_size(se_cmd->t_task_cdb)); |
| 529 | entry->req.cdb_off = cdb_off; |
| 530 | tcmu_flush_dcache_range(entry, sizeof(*entry)); |
| 531 | |
| 532 | UPDATE_HEAD(mb->cmd_head, command_size, udev->cmdr_size); |
| 533 | tcmu_flush_dcache_range(mb, sizeof(*mb)); |
| 534 | |
| 535 | spin_unlock_irq(&udev->cmdr_lock); |
| 536 | |
| 537 | /* TODO: only if FLUSH and FUA? */ |
| 538 | uio_event_notify(&udev->uio_info); |
| 539 | |
| 540 | mod_timer(&udev->timeout, |
| 541 | round_jiffies_up(jiffies + msecs_to_jiffies(TCMU_TIME_OUT))); |
| 542 | |
Andy Grover | 02eb924 | 2016-10-06 10:07:07 -0500 | [diff] [blame] | 543 | return TCM_NO_SENSE; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 544 | } |
| 545 | |
Andy Grover | 02eb924 | 2016-10-06 10:07:07 -0500 | [diff] [blame] | 546 | static sense_reason_t |
| 547 | tcmu_queue_cmd(struct se_cmd *se_cmd) |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 548 | { |
| 549 | struct se_device *se_dev = se_cmd->se_dev; |
| 550 | struct tcmu_dev *udev = TCMU_DEV(se_dev); |
| 551 | struct tcmu_cmd *tcmu_cmd; |
| 552 | int ret; |
| 553 | |
| 554 | tcmu_cmd = tcmu_alloc_cmd(se_cmd); |
| 555 | if (!tcmu_cmd) |
Andy Grover | 02eb924 | 2016-10-06 10:07:07 -0500 | [diff] [blame] | 556 | return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 557 | |
| 558 | ret = tcmu_queue_cmd_ring(tcmu_cmd); |
Andy Grover | 02eb924 | 2016-10-06 10:07:07 -0500 | [diff] [blame] | 559 | if (ret != TCM_NO_SENSE) { |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 560 | pr_err("TCMU: Could not queue command\n"); |
| 561 | spin_lock_irq(&udev->commands_lock); |
| 562 | idr_remove(&udev->commands, tcmu_cmd->cmd_id); |
| 563 | spin_unlock_irq(&udev->commands_lock); |
| 564 | |
| 565 | kmem_cache_free(tcmu_cmd_cache, tcmu_cmd); |
| 566 | } |
| 567 | |
| 568 | return ret; |
| 569 | } |
| 570 | |
| 571 | static void tcmu_handle_completion(struct tcmu_cmd *cmd, struct tcmu_cmd_entry *entry) |
| 572 | { |
| 573 | struct se_cmd *se_cmd = cmd->se_cmd; |
| 574 | struct tcmu_dev *udev = cmd->tcmu_dev; |
| 575 | |
| 576 | if (test_bit(TCMU_CMD_BIT_EXPIRED, &cmd->flags)) { |
Sheng Yang | b25c786 | 2016-02-26 14:59:58 -0800 | [diff] [blame] | 577 | /* |
| 578 | * cmd has been completed already from timeout, just reclaim |
Andy Grover | 3d9b955 | 2016-08-25 08:55:54 -0700 | [diff] [blame] | 579 | * data area space and free cmd |
Sheng Yang | b25c786 | 2016-02-26 14:59:58 -0800 | [diff] [blame] | 580 | */ |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 581 | free_data_area(udev, cmd); |
Sheng Yang | b25c786 | 2016-02-26 14:59:58 -0800 | [diff] [blame] | 582 | |
| 583 | kmem_cache_free(tcmu_cmd_cache, cmd); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 584 | return; |
| 585 | } |
| 586 | |
Andy Grover | 0ad46af | 2015-04-14 17:30:04 -0700 | [diff] [blame] | 587 | if (entry->hdr.uflags & TCMU_UFLAG_UNKNOWN_OP) { |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 588 | free_data_area(udev, cmd); |
Andy Grover | 0ad46af | 2015-04-14 17:30:04 -0700 | [diff] [blame] | 589 | pr_warn("TCMU: Userspace set UNKNOWN_OP flag on se_cmd %p\n", |
| 590 | cmd->se_cmd); |
Andy Grover | ed97d0c | 2015-09-03 16:03:44 -0700 | [diff] [blame] | 591 | entry->rsp.scsi_status = SAM_STAT_CHECK_CONDITION; |
| 592 | } else if (entry->rsp.scsi_status == SAM_STAT_CHECK_CONDITION) { |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 593 | memcpy(se_cmd->sense_buffer, entry->rsp.sense_buffer, |
| 594 | se_cmd->scsi_sense_length); |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 595 | free_data_area(udev, cmd); |
Ilias Tsitsimpis | e4648b0 | 2015-04-23 21:30:09 +0300 | [diff] [blame] | 596 | } else if (se_cmd->se_cmd_flags & SCF_BIDI) { |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 597 | DECLARE_BITMAP(bitmap, DATA_BLOCK_BITS); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 598 | |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 599 | /* Get Data-In buffer before clean up */ |
| 600 | bitmap_copy(bitmap, cmd->data_bitmap, DATA_BLOCK_BITS); |
| 601 | gather_data_area(udev, bitmap, |
Ilias Tsitsimpis | e4648b0 | 2015-04-23 21:30:09 +0300 | [diff] [blame] | 602 | se_cmd->t_bidi_data_sg, se_cmd->t_bidi_data_nents); |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 603 | free_data_area(udev, cmd); |
Ilias Tsitsimpis | e4648b0 | 2015-04-23 21:30:09 +0300 | [diff] [blame] | 604 | } else if (se_cmd->data_direction == DMA_FROM_DEVICE) { |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 605 | DECLARE_BITMAP(bitmap, DATA_BLOCK_BITS); |
| 606 | |
| 607 | bitmap_copy(bitmap, cmd->data_bitmap, DATA_BLOCK_BITS); |
| 608 | gather_data_area(udev, bitmap, |
Ilias Tsitsimpis | f97ec7d | 2015-04-23 21:47:00 +0300 | [diff] [blame] | 609 | se_cmd->t_data_sg, se_cmd->t_data_nents); |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 610 | free_data_area(udev, cmd); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 611 | } else if (se_cmd->data_direction == DMA_TO_DEVICE) { |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 612 | free_data_area(udev, cmd); |
Ilias Tsitsimpis | 2bc396a | 2015-04-23 21:30:05 +0300 | [diff] [blame] | 613 | } else if (se_cmd->data_direction != DMA_NONE) { |
| 614 | pr_warn("TCMU: data direction was %d!\n", |
| 615 | se_cmd->data_direction); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 616 | } |
| 617 | |
| 618 | target_complete_cmd(cmd->se_cmd, entry->rsp.scsi_status); |
| 619 | cmd->se_cmd = NULL; |
| 620 | |
| 621 | kmem_cache_free(tcmu_cmd_cache, cmd); |
| 622 | } |
| 623 | |
| 624 | static unsigned int tcmu_handle_completions(struct tcmu_dev *udev) |
| 625 | { |
| 626 | struct tcmu_mailbox *mb; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 627 | unsigned long flags; |
| 628 | int handled = 0; |
| 629 | |
| 630 | if (test_bit(TCMU_DEV_BIT_BROKEN, &udev->flags)) { |
| 631 | pr_err("ring broken, not handling completions\n"); |
| 632 | return 0; |
| 633 | } |
| 634 | |
| 635 | spin_lock_irqsave(&udev->cmdr_lock, flags); |
| 636 | |
| 637 | mb = udev->mb_addr; |
| 638 | tcmu_flush_dcache_range(mb, sizeof(*mb)); |
| 639 | |
| 640 | while (udev->cmdr_last_cleaned != ACCESS_ONCE(mb->cmd_tail)) { |
| 641 | |
| 642 | struct tcmu_cmd_entry *entry = (void *) mb + CMDR_OFF + udev->cmdr_last_cleaned; |
| 643 | struct tcmu_cmd *cmd; |
| 644 | |
| 645 | tcmu_flush_dcache_range(entry, sizeof(*entry)); |
| 646 | |
Andy Grover | 0ad46af | 2015-04-14 17:30:04 -0700 | [diff] [blame] | 647 | if (tcmu_hdr_get_op(entry->hdr.len_op) == TCMU_OP_PAD) { |
| 648 | UPDATE_HEAD(udev->cmdr_last_cleaned, |
| 649 | tcmu_hdr_get_len(entry->hdr.len_op), |
| 650 | udev->cmdr_size); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 651 | continue; |
| 652 | } |
Andy Grover | 0ad46af | 2015-04-14 17:30:04 -0700 | [diff] [blame] | 653 | WARN_ON(tcmu_hdr_get_op(entry->hdr.len_op) != TCMU_OP_CMD); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 654 | |
| 655 | spin_lock(&udev->commands_lock); |
Andy Grover | 0ad46af | 2015-04-14 17:30:04 -0700 | [diff] [blame] | 656 | cmd = idr_find(&udev->commands, entry->hdr.cmd_id); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 657 | if (cmd) |
| 658 | idr_remove(&udev->commands, cmd->cmd_id); |
| 659 | spin_unlock(&udev->commands_lock); |
| 660 | |
| 661 | if (!cmd) { |
| 662 | pr_err("cmd_id not found, ring is broken\n"); |
| 663 | set_bit(TCMU_DEV_BIT_BROKEN, &udev->flags); |
| 664 | break; |
| 665 | } |
| 666 | |
| 667 | tcmu_handle_completion(cmd, entry); |
| 668 | |
Andy Grover | 0ad46af | 2015-04-14 17:30:04 -0700 | [diff] [blame] | 669 | UPDATE_HEAD(udev->cmdr_last_cleaned, |
| 670 | tcmu_hdr_get_len(entry->hdr.len_op), |
| 671 | udev->cmdr_size); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 672 | |
| 673 | handled++; |
| 674 | } |
| 675 | |
| 676 | if (mb->cmd_tail == mb->cmd_head) |
| 677 | del_timer(&udev->timeout); /* no more pending cmds */ |
| 678 | |
| 679 | spin_unlock_irqrestore(&udev->cmdr_lock, flags); |
| 680 | |
| 681 | wake_up(&udev->wait_cmdr); |
| 682 | |
| 683 | return handled; |
| 684 | } |
| 685 | |
| 686 | static int tcmu_check_expired_cmd(int id, void *p, void *data) |
| 687 | { |
| 688 | struct tcmu_cmd *cmd = p; |
| 689 | |
| 690 | if (test_bit(TCMU_CMD_BIT_EXPIRED, &cmd->flags)) |
| 691 | return 0; |
| 692 | |
Andy Grover | 611e226 | 2015-11-13 10:42:19 -0800 | [diff] [blame] | 693 | if (!time_after(jiffies, cmd->deadline)) |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 694 | return 0; |
| 695 | |
| 696 | set_bit(TCMU_CMD_BIT_EXPIRED, &cmd->flags); |
| 697 | target_complete_cmd(cmd->se_cmd, SAM_STAT_CHECK_CONDITION); |
| 698 | cmd->se_cmd = NULL; |
| 699 | |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 700 | return 0; |
| 701 | } |
| 702 | |
| 703 | static void tcmu_device_timedout(unsigned long data) |
| 704 | { |
| 705 | struct tcmu_dev *udev = (struct tcmu_dev *)data; |
| 706 | unsigned long flags; |
| 707 | int handled; |
| 708 | |
| 709 | handled = tcmu_handle_completions(udev); |
| 710 | |
| 711 | pr_warn("%d completions handled from timeout\n", handled); |
| 712 | |
| 713 | spin_lock_irqsave(&udev->commands_lock, flags); |
| 714 | idr_for_each(&udev->commands, tcmu_check_expired_cmd, NULL); |
| 715 | spin_unlock_irqrestore(&udev->commands_lock, flags); |
| 716 | |
| 717 | /* |
| 718 | * We don't need to wakeup threads on wait_cmdr since they have their |
| 719 | * own timeout. |
| 720 | */ |
| 721 | } |
| 722 | |
| 723 | static int tcmu_attach_hba(struct se_hba *hba, u32 host_id) |
| 724 | { |
| 725 | struct tcmu_hba *tcmu_hba; |
| 726 | |
| 727 | tcmu_hba = kzalloc(sizeof(struct tcmu_hba), GFP_KERNEL); |
| 728 | if (!tcmu_hba) |
| 729 | return -ENOMEM; |
| 730 | |
| 731 | tcmu_hba->host_id = host_id; |
| 732 | hba->hba_ptr = tcmu_hba; |
| 733 | |
| 734 | return 0; |
| 735 | } |
| 736 | |
| 737 | static void tcmu_detach_hba(struct se_hba *hba) |
| 738 | { |
| 739 | kfree(hba->hba_ptr); |
| 740 | hba->hba_ptr = NULL; |
| 741 | } |
| 742 | |
| 743 | static struct se_device *tcmu_alloc_device(struct se_hba *hba, const char *name) |
| 744 | { |
| 745 | struct tcmu_dev *udev; |
| 746 | |
| 747 | udev = kzalloc(sizeof(struct tcmu_dev), GFP_KERNEL); |
| 748 | if (!udev) |
| 749 | return NULL; |
| 750 | |
| 751 | udev->name = kstrdup(name, GFP_KERNEL); |
| 752 | if (!udev->name) { |
| 753 | kfree(udev); |
| 754 | return NULL; |
| 755 | } |
| 756 | |
| 757 | udev->hba = hba; |
| 758 | |
| 759 | init_waitqueue_head(&udev->wait_cmdr); |
| 760 | spin_lock_init(&udev->cmdr_lock); |
| 761 | |
| 762 | idr_init(&udev->commands); |
| 763 | spin_lock_init(&udev->commands_lock); |
| 764 | |
| 765 | setup_timer(&udev->timeout, tcmu_device_timedout, |
| 766 | (unsigned long)udev); |
| 767 | |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 768 | return &udev->se_dev; |
| 769 | } |
| 770 | |
| 771 | static int tcmu_irqcontrol(struct uio_info *info, s32 irq_on) |
| 772 | { |
| 773 | struct tcmu_dev *tcmu_dev = container_of(info, struct tcmu_dev, uio_info); |
| 774 | |
| 775 | tcmu_handle_completions(tcmu_dev); |
| 776 | |
| 777 | return 0; |
| 778 | } |
| 779 | |
| 780 | /* |
| 781 | * mmap code from uio.c. Copied here because we want to hook mmap() |
| 782 | * and this stuff must come along. |
| 783 | */ |
| 784 | static int tcmu_find_mem_index(struct vm_area_struct *vma) |
| 785 | { |
| 786 | struct tcmu_dev *udev = vma->vm_private_data; |
| 787 | struct uio_info *info = &udev->uio_info; |
| 788 | |
| 789 | if (vma->vm_pgoff < MAX_UIO_MAPS) { |
| 790 | if (info->mem[vma->vm_pgoff].size == 0) |
| 791 | return -1; |
| 792 | return (int)vma->vm_pgoff; |
| 793 | } |
| 794 | return -1; |
| 795 | } |
| 796 | |
| 797 | static int tcmu_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf) |
| 798 | { |
| 799 | struct tcmu_dev *udev = vma->vm_private_data; |
| 800 | struct uio_info *info = &udev->uio_info; |
| 801 | struct page *page; |
| 802 | unsigned long offset; |
| 803 | void *addr; |
| 804 | |
| 805 | int mi = tcmu_find_mem_index(vma); |
| 806 | if (mi < 0) |
| 807 | return VM_FAULT_SIGBUS; |
| 808 | |
| 809 | /* |
| 810 | * We need to subtract mi because userspace uses offset = N*PAGE_SIZE |
| 811 | * to use mem[N]. |
| 812 | */ |
| 813 | offset = (vmf->pgoff - mi) << PAGE_SHIFT; |
| 814 | |
| 815 | addr = (void *)(unsigned long)info->mem[mi].addr + offset; |
| 816 | if (info->mem[mi].memtype == UIO_MEM_LOGICAL) |
| 817 | page = virt_to_page(addr); |
| 818 | else |
| 819 | page = vmalloc_to_page(addr); |
| 820 | get_page(page); |
| 821 | vmf->page = page; |
| 822 | return 0; |
| 823 | } |
| 824 | |
| 825 | static const struct vm_operations_struct tcmu_vm_ops = { |
| 826 | .fault = tcmu_vma_fault, |
| 827 | }; |
| 828 | |
| 829 | static int tcmu_mmap(struct uio_info *info, struct vm_area_struct *vma) |
| 830 | { |
| 831 | struct tcmu_dev *udev = container_of(info, struct tcmu_dev, uio_info); |
| 832 | |
| 833 | vma->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP; |
| 834 | vma->vm_ops = &tcmu_vm_ops; |
| 835 | |
| 836 | vma->vm_private_data = udev; |
| 837 | |
| 838 | /* Ensure the mmap is exactly the right size */ |
| 839 | if (vma_pages(vma) != (TCMU_RING_SIZE >> PAGE_SHIFT)) |
| 840 | return -EINVAL; |
| 841 | |
| 842 | return 0; |
| 843 | } |
| 844 | |
| 845 | static int tcmu_open(struct uio_info *info, struct inode *inode) |
| 846 | { |
| 847 | struct tcmu_dev *udev = container_of(info, struct tcmu_dev, uio_info); |
| 848 | |
| 849 | /* O_EXCL not supported for char devs, so fake it? */ |
| 850 | if (test_and_set_bit(TCMU_DEV_BIT_OPEN, &udev->flags)) |
| 851 | return -EBUSY; |
| 852 | |
| 853 | pr_debug("open\n"); |
| 854 | |
| 855 | return 0; |
| 856 | } |
| 857 | |
| 858 | static int tcmu_release(struct uio_info *info, struct inode *inode) |
| 859 | { |
| 860 | struct tcmu_dev *udev = container_of(info, struct tcmu_dev, uio_info); |
| 861 | |
| 862 | clear_bit(TCMU_DEV_BIT_OPEN, &udev->flags); |
| 863 | |
| 864 | pr_debug("close\n"); |
| 865 | |
| 866 | return 0; |
| 867 | } |
| 868 | |
| 869 | static int tcmu_netlink_event(enum tcmu_genl_cmd cmd, const char *name, int minor) |
| 870 | { |
| 871 | struct sk_buff *skb; |
| 872 | void *msg_header; |
Nicholas Bellinger | 6e14eab | 2014-10-01 23:01:15 -0700 | [diff] [blame] | 873 | int ret = -ENOMEM; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 874 | |
| 875 | skb = genlmsg_new(NLMSG_GOODSIZE, GFP_KERNEL); |
| 876 | if (!skb) |
Nicholas Bellinger | 6e14eab | 2014-10-01 23:01:15 -0700 | [diff] [blame] | 877 | return ret; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 878 | |
| 879 | msg_header = genlmsg_put(skb, 0, 0, &tcmu_genl_family, 0, cmd); |
Nicholas Bellinger | 6e14eab | 2014-10-01 23:01:15 -0700 | [diff] [blame] | 880 | if (!msg_header) |
| 881 | goto free_skb; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 882 | |
| 883 | ret = nla_put_string(skb, TCMU_ATTR_DEVICE, name); |
Nicholas Bellinger | 6e14eab | 2014-10-01 23:01:15 -0700 | [diff] [blame] | 884 | if (ret < 0) |
| 885 | goto free_skb; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 886 | |
| 887 | ret = nla_put_u32(skb, TCMU_ATTR_MINOR, minor); |
Nicholas Bellinger | 6e14eab | 2014-10-01 23:01:15 -0700 | [diff] [blame] | 888 | if (ret < 0) |
| 889 | goto free_skb; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 890 | |
Johannes Berg | 053c095 | 2015-01-16 22:09:00 +0100 | [diff] [blame] | 891 | genlmsg_end(skb, msg_header); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 892 | |
Sheng Yang | 20c08b3 | 2016-01-13 17:26:13 -0800 | [diff] [blame] | 893 | ret = genlmsg_multicast_allns(&tcmu_genl_family, skb, 0, |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 894 | TCMU_MCGRP_CONFIG, GFP_KERNEL); |
| 895 | |
| 896 | /* We don't care if no one is listening */ |
| 897 | if (ret == -ESRCH) |
| 898 | ret = 0; |
| 899 | |
| 900 | return ret; |
Nicholas Bellinger | 6e14eab | 2014-10-01 23:01:15 -0700 | [diff] [blame] | 901 | free_skb: |
| 902 | nlmsg_free(skb); |
| 903 | return ret; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 904 | } |
| 905 | |
| 906 | static int tcmu_configure_device(struct se_device *dev) |
| 907 | { |
| 908 | struct tcmu_dev *udev = TCMU_DEV(dev); |
| 909 | struct tcmu_hba *hba = udev->hba->hba_ptr; |
| 910 | struct uio_info *info; |
| 911 | struct tcmu_mailbox *mb; |
| 912 | size_t size; |
| 913 | size_t used; |
| 914 | int ret = 0; |
| 915 | char *str; |
| 916 | |
| 917 | info = &udev->uio_info; |
| 918 | |
| 919 | size = snprintf(NULL, 0, "tcm-user/%u/%s/%s", hba->host_id, udev->name, |
| 920 | udev->dev_config); |
| 921 | size += 1; /* for \0 */ |
| 922 | str = kmalloc(size, GFP_KERNEL); |
| 923 | if (!str) |
| 924 | return -ENOMEM; |
| 925 | |
| 926 | used = snprintf(str, size, "tcm-user/%u/%s", hba->host_id, udev->name); |
| 927 | |
| 928 | if (udev->dev_config[0]) |
| 929 | snprintf(str + used, size - used, "/%s", udev->dev_config); |
| 930 | |
| 931 | info->name = str; |
| 932 | |
| 933 | udev->mb_addr = vzalloc(TCMU_RING_SIZE); |
| 934 | if (!udev->mb_addr) { |
| 935 | ret = -ENOMEM; |
| 936 | goto err_vzalloc; |
| 937 | } |
| 938 | |
| 939 | /* mailbox fits in first part of CMDR space */ |
| 940 | udev->cmdr_size = CMDR_SIZE - CMDR_OFF; |
| 941 | udev->data_off = CMDR_SIZE; |
| 942 | udev->data_size = TCMU_RING_SIZE - CMDR_SIZE; |
| 943 | |
| 944 | mb = udev->mb_addr; |
Andy Grover | 0ad46af | 2015-04-14 17:30:04 -0700 | [diff] [blame] | 945 | mb->version = TCMU_MAILBOX_VERSION; |
Sheng Yang | 32c76de | 2016-02-29 16:02:15 -0800 | [diff] [blame] | 946 | mb->flags = TCMU_MAILBOX_FLAG_CAP_OOOC; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 947 | mb->cmdr_off = CMDR_OFF; |
| 948 | mb->cmdr_size = udev->cmdr_size; |
| 949 | |
| 950 | WARN_ON(!PAGE_ALIGNED(udev->data_off)); |
| 951 | WARN_ON(udev->data_size % PAGE_SIZE); |
Sheng Yang | 2641864 | 2016-02-26 14:59:57 -0800 | [diff] [blame] | 952 | WARN_ON(udev->data_size % DATA_BLOCK_SIZE); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 953 | |
David Disseldorp | ac64a2c | 2015-09-04 01:39:56 +0200 | [diff] [blame] | 954 | info->version = __stringify(TCMU_MAILBOX_VERSION); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 955 | |
| 956 | info->mem[0].name = "tcm-user command & data buffer"; |
Arnd Bergmann | 0633e12 | 2016-02-01 17:29:45 +0100 | [diff] [blame] | 957 | info->mem[0].addr = (phys_addr_t)(uintptr_t)udev->mb_addr; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 958 | info->mem[0].size = TCMU_RING_SIZE; |
| 959 | info->mem[0].memtype = UIO_MEM_VIRTUAL; |
| 960 | |
| 961 | info->irqcontrol = tcmu_irqcontrol; |
| 962 | info->irq = UIO_IRQ_CUSTOM; |
| 963 | |
| 964 | info->mmap = tcmu_mmap; |
| 965 | info->open = tcmu_open; |
| 966 | info->release = tcmu_release; |
| 967 | |
| 968 | ret = uio_register_device(tcmu_root_device, info); |
| 969 | if (ret) |
| 970 | goto err_register; |
| 971 | |
Sheng Yang | 81ee28d | 2015-12-28 11:57:39 -0800 | [diff] [blame] | 972 | /* User can set hw_block_size before enable the device */ |
| 973 | if (dev->dev_attrib.hw_block_size == 0) |
| 974 | dev->dev_attrib.hw_block_size = 512; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 975 | /* Other attributes can be configured in userspace */ |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 976 | dev->dev_attrib.hw_max_sectors = 128; |
| 977 | dev->dev_attrib.hw_queue_depth = 128; |
| 978 | |
| 979 | ret = tcmu_netlink_event(TCMU_CMD_ADDED_DEVICE, udev->uio_info.name, |
| 980 | udev->uio_info.uio_dev->minor); |
| 981 | if (ret) |
| 982 | goto err_netlink; |
| 983 | |
| 984 | return 0; |
| 985 | |
| 986 | err_netlink: |
| 987 | uio_unregister_device(&udev->uio_info); |
| 988 | err_register: |
| 989 | vfree(udev->mb_addr); |
| 990 | err_vzalloc: |
| 991 | kfree(info->name); |
| 992 | |
| 993 | return ret; |
| 994 | } |
| 995 | |
Sheng Yang | b25c786 | 2016-02-26 14:59:58 -0800 | [diff] [blame] | 996 | static int tcmu_check_and_free_pending_cmd(struct tcmu_cmd *cmd) |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 997 | { |
Sheng Yang | b25c786 | 2016-02-26 14:59:58 -0800 | [diff] [blame] | 998 | if (test_bit(TCMU_CMD_BIT_EXPIRED, &cmd->flags)) { |
| 999 | kmem_cache_free(tcmu_cmd_cache, cmd); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1000 | return 0; |
Sheng Yang | b25c786 | 2016-02-26 14:59:58 -0800 | [diff] [blame] | 1001 | } |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1002 | return -EINVAL; |
| 1003 | } |
| 1004 | |
Nicholas Bellinger | 4cc987e | 2015-05-19 00:03:07 -0700 | [diff] [blame] | 1005 | static void tcmu_dev_call_rcu(struct rcu_head *p) |
| 1006 | { |
| 1007 | struct se_device *dev = container_of(p, struct se_device, rcu_head); |
| 1008 | struct tcmu_dev *udev = TCMU_DEV(dev); |
| 1009 | |
| 1010 | kfree(udev); |
| 1011 | } |
| 1012 | |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1013 | static void tcmu_free_device(struct se_device *dev) |
| 1014 | { |
| 1015 | struct tcmu_dev *udev = TCMU_DEV(dev); |
Sheng Yang | b25c786 | 2016-02-26 14:59:58 -0800 | [diff] [blame] | 1016 | struct tcmu_cmd *cmd; |
| 1017 | bool all_expired = true; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1018 | int i; |
| 1019 | |
| 1020 | del_timer_sync(&udev->timeout); |
| 1021 | |
| 1022 | vfree(udev->mb_addr); |
| 1023 | |
| 1024 | /* Upper layer should drain all requests before calling this */ |
| 1025 | spin_lock_irq(&udev->commands_lock); |
Sheng Yang | b25c786 | 2016-02-26 14:59:58 -0800 | [diff] [blame] | 1026 | idr_for_each_entry(&udev->commands, cmd, i) { |
| 1027 | if (tcmu_check_and_free_pending_cmd(cmd) != 0) |
| 1028 | all_expired = false; |
| 1029 | } |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1030 | idr_destroy(&udev->commands); |
| 1031 | spin_unlock_irq(&udev->commands_lock); |
Sheng Yang | b25c786 | 2016-02-26 14:59:58 -0800 | [diff] [blame] | 1032 | WARN_ON(!all_expired); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1033 | |
| 1034 | /* Device was configured */ |
| 1035 | if (udev->uio_info.uio_dev) { |
| 1036 | tcmu_netlink_event(TCMU_CMD_REMOVED_DEVICE, udev->uio_info.name, |
| 1037 | udev->uio_info.uio_dev->minor); |
| 1038 | |
| 1039 | uio_unregister_device(&udev->uio_info); |
| 1040 | kfree(udev->uio_info.name); |
| 1041 | kfree(udev->name); |
| 1042 | } |
Nicholas Bellinger | 4cc987e | 2015-05-19 00:03:07 -0700 | [diff] [blame] | 1043 | call_rcu(&dev->rcu_head, tcmu_dev_call_rcu); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1044 | } |
| 1045 | |
| 1046 | enum { |
Andy Grover | 9c1cd1b | 2015-05-19 14:44:39 -0700 | [diff] [blame] | 1047 | Opt_dev_config, Opt_dev_size, Opt_hw_block_size, Opt_err, |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1048 | }; |
| 1049 | |
| 1050 | static match_table_t tokens = { |
| 1051 | {Opt_dev_config, "dev_config=%s"}, |
| 1052 | {Opt_dev_size, "dev_size=%u"}, |
Andy Grover | 9c1cd1b | 2015-05-19 14:44:39 -0700 | [diff] [blame] | 1053 | {Opt_hw_block_size, "hw_block_size=%u"}, |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1054 | {Opt_err, NULL} |
| 1055 | }; |
| 1056 | |
| 1057 | static ssize_t tcmu_set_configfs_dev_params(struct se_device *dev, |
| 1058 | const char *page, ssize_t count) |
| 1059 | { |
| 1060 | struct tcmu_dev *udev = TCMU_DEV(dev); |
| 1061 | char *orig, *ptr, *opts, *arg_p; |
| 1062 | substring_t args[MAX_OPT_ARGS]; |
| 1063 | int ret = 0, token; |
Andy Grover | 9c1cd1b | 2015-05-19 14:44:39 -0700 | [diff] [blame] | 1064 | unsigned long tmp_ul; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1065 | |
| 1066 | opts = kstrdup(page, GFP_KERNEL); |
| 1067 | if (!opts) |
| 1068 | return -ENOMEM; |
| 1069 | |
| 1070 | orig = opts; |
| 1071 | |
| 1072 | while ((ptr = strsep(&opts, ",\n")) != NULL) { |
| 1073 | if (!*ptr) |
| 1074 | continue; |
| 1075 | |
| 1076 | token = match_token(ptr, tokens, args); |
| 1077 | switch (token) { |
| 1078 | case Opt_dev_config: |
| 1079 | if (match_strlcpy(udev->dev_config, &args[0], |
| 1080 | TCMU_CONFIG_LEN) == 0) { |
| 1081 | ret = -EINVAL; |
| 1082 | break; |
| 1083 | } |
| 1084 | pr_debug("TCMU: Referencing Path: %s\n", udev->dev_config); |
| 1085 | break; |
| 1086 | case Opt_dev_size: |
| 1087 | arg_p = match_strdup(&args[0]); |
| 1088 | if (!arg_p) { |
| 1089 | ret = -ENOMEM; |
| 1090 | break; |
| 1091 | } |
| 1092 | ret = kstrtoul(arg_p, 0, (unsigned long *) &udev->dev_size); |
| 1093 | kfree(arg_p); |
| 1094 | if (ret < 0) |
| 1095 | pr_err("kstrtoul() failed for dev_size=\n"); |
| 1096 | break; |
Andy Grover | 9c1cd1b | 2015-05-19 14:44:39 -0700 | [diff] [blame] | 1097 | case Opt_hw_block_size: |
| 1098 | arg_p = match_strdup(&args[0]); |
| 1099 | if (!arg_p) { |
| 1100 | ret = -ENOMEM; |
| 1101 | break; |
| 1102 | } |
| 1103 | ret = kstrtoul(arg_p, 0, &tmp_ul); |
| 1104 | kfree(arg_p); |
| 1105 | if (ret < 0) { |
| 1106 | pr_err("kstrtoul() failed for hw_block_size=\n"); |
| 1107 | break; |
| 1108 | } |
| 1109 | if (!tmp_ul) { |
| 1110 | pr_err("hw_block_size must be nonzero\n"); |
| 1111 | break; |
| 1112 | } |
| 1113 | dev->dev_attrib.hw_block_size = tmp_ul; |
| 1114 | break; |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1115 | default: |
| 1116 | break; |
| 1117 | } |
| 1118 | } |
| 1119 | |
| 1120 | kfree(orig); |
| 1121 | return (!ret) ? count : ret; |
| 1122 | } |
| 1123 | |
| 1124 | static ssize_t tcmu_show_configfs_dev_params(struct se_device *dev, char *b) |
| 1125 | { |
| 1126 | struct tcmu_dev *udev = TCMU_DEV(dev); |
| 1127 | ssize_t bl = 0; |
| 1128 | |
| 1129 | bl = sprintf(b + bl, "Config: %s ", |
| 1130 | udev->dev_config[0] ? udev->dev_config : "NULL"); |
Andy Grover | 8ee83a7 | 2015-05-01 10:43:45 -0700 | [diff] [blame] | 1131 | bl += sprintf(b + bl, "Size: %zu\n", udev->dev_size); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1132 | |
| 1133 | return bl; |
| 1134 | } |
| 1135 | |
| 1136 | static sector_t tcmu_get_blocks(struct se_device *dev) |
| 1137 | { |
| 1138 | struct tcmu_dev *udev = TCMU_DEV(dev); |
| 1139 | |
| 1140 | return div_u64(udev->dev_size - dev->dev_attrib.block_size, |
| 1141 | dev->dev_attrib.block_size); |
| 1142 | } |
| 1143 | |
| 1144 | static sense_reason_t |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1145 | tcmu_parse_cdb(struct se_cmd *cmd) |
| 1146 | { |
Andy Grover | 02eb924 | 2016-10-06 10:07:07 -0500 | [diff] [blame] | 1147 | return passthrough_parse_cdb(cmd, tcmu_queue_cmd); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1148 | } |
| 1149 | |
Christoph Hellwig | 0a06d43 | 2015-05-10 18:14:56 +0200 | [diff] [blame] | 1150 | static const struct target_backend_ops tcmu_ops = { |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1151 | .name = "user", |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1152 | .owner = THIS_MODULE, |
Andy Grover | a354170 | 2015-05-19 14:44:41 -0700 | [diff] [blame] | 1153 | .transport_flags = TRANSPORT_FLAG_PASSTHROUGH, |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1154 | .attach_hba = tcmu_attach_hba, |
| 1155 | .detach_hba = tcmu_detach_hba, |
| 1156 | .alloc_device = tcmu_alloc_device, |
| 1157 | .configure_device = tcmu_configure_device, |
| 1158 | .free_device = tcmu_free_device, |
| 1159 | .parse_cdb = tcmu_parse_cdb, |
| 1160 | .set_configfs_dev_params = tcmu_set_configfs_dev_params, |
| 1161 | .show_configfs_dev_params = tcmu_show_configfs_dev_params, |
| 1162 | .get_device_type = sbc_get_device_type, |
| 1163 | .get_blocks = tcmu_get_blocks, |
Christoph Hellwig | 5873c4d | 2015-05-10 18:14:57 +0200 | [diff] [blame] | 1164 | .tb_dev_attrib_attrs = passthrough_attrib_attrs, |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1165 | }; |
| 1166 | |
| 1167 | static int __init tcmu_module_init(void) |
| 1168 | { |
| 1169 | int ret; |
| 1170 | |
| 1171 | BUILD_BUG_ON((sizeof(struct tcmu_cmd_entry) % TCMU_OP_ALIGN_SIZE) != 0); |
| 1172 | |
| 1173 | tcmu_cmd_cache = kmem_cache_create("tcmu_cmd_cache", |
| 1174 | sizeof(struct tcmu_cmd), |
| 1175 | __alignof__(struct tcmu_cmd), |
| 1176 | 0, NULL); |
| 1177 | if (!tcmu_cmd_cache) |
| 1178 | return -ENOMEM; |
| 1179 | |
| 1180 | tcmu_root_device = root_device_register("tcm_user"); |
| 1181 | if (IS_ERR(tcmu_root_device)) { |
| 1182 | ret = PTR_ERR(tcmu_root_device); |
| 1183 | goto out_free_cache; |
| 1184 | } |
| 1185 | |
| 1186 | ret = genl_register_family(&tcmu_genl_family); |
| 1187 | if (ret < 0) { |
| 1188 | goto out_unreg_device; |
| 1189 | } |
| 1190 | |
Christoph Hellwig | 0a06d43 | 2015-05-10 18:14:56 +0200 | [diff] [blame] | 1191 | ret = transport_backend_register(&tcmu_ops); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1192 | if (ret) |
| 1193 | goto out_unreg_genl; |
| 1194 | |
| 1195 | return 0; |
| 1196 | |
| 1197 | out_unreg_genl: |
| 1198 | genl_unregister_family(&tcmu_genl_family); |
| 1199 | out_unreg_device: |
| 1200 | root_device_unregister(tcmu_root_device); |
| 1201 | out_free_cache: |
| 1202 | kmem_cache_destroy(tcmu_cmd_cache); |
| 1203 | |
| 1204 | return ret; |
| 1205 | } |
| 1206 | |
| 1207 | static void __exit tcmu_module_exit(void) |
| 1208 | { |
Christoph Hellwig | 0a06d43 | 2015-05-10 18:14:56 +0200 | [diff] [blame] | 1209 | target_backend_unregister(&tcmu_ops); |
Andy Grover | 7c9e7a6 | 2014-10-01 16:07:05 -0700 | [diff] [blame] | 1210 | genl_unregister_family(&tcmu_genl_family); |
| 1211 | root_device_unregister(tcmu_root_device); |
| 1212 | kmem_cache_destroy(tcmu_cmd_cache); |
| 1213 | } |
| 1214 | |
| 1215 | MODULE_DESCRIPTION("TCM USER subsystem plugin"); |
| 1216 | MODULE_AUTHOR("Shaohua Li <shli@kernel.org>"); |
| 1217 | MODULE_AUTHOR("Andy Grover <agrover@redhat.com>"); |
| 1218 | MODULE_LICENSE("GPL"); |
| 1219 | |
| 1220 | module_init(tcmu_module_init); |
| 1221 | module_exit(tcmu_module_exit); |