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