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