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