1 // SPDX-License-Identifier: GPL-2.0+
2 /*******************************************************************************
3 * Vhost kernel TCM fabric driver for virtio SCSI initiators
5 * (C) Copyright 2010-2013 Datera, Inc.
6 * (C) Copyright 2010-2012 IBM Corp.
8 * Authors: Nicholas A. Bellinger <nab@daterainc.com>
9 * Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
10 ****************************************************************************/
12 #include <linux/module.h>
13 #include <linux/moduleparam.h>
14 #include <generated/utsrelease.h>
15 #include <linux/utsname.h>
16 #include <linux/init.h>
17 #include <linux/slab.h>
18 #include <linux/kthread.h>
19 #include <linux/types.h>
20 #include <linux/string.h>
21 #include <linux/configfs.h>
22 #include <linux/ctype.h>
23 #include <linux/compat.h>
24 #include <linux/eventfd.h>
26 #include <linux/vmalloc.h>
27 #include <linux/miscdevice.h>
28 #include <linux/blk_types.h>
29 #include <linux/bio.h>
30 #include <linux/unaligned.h>
31 #include <scsi/scsi_common.h>
32 #include <scsi/scsi_proto.h>
33 #include <target/target_core_base.h>
34 #include <target/target_core_fabric.h>
35 #include <linux/vhost.h>
36 #include <linux/virtio_scsi.h>
37 #include <linux/llist.h>
38 #include <linux/bitmap.h>
42 #define VHOST_SCSI_VERSION "v0.1"
43 #define VHOST_SCSI_NAMELEN 256
44 #define VHOST_SCSI_MAX_CDB_SIZE 32
45 #define VHOST_SCSI_PREALLOC_SGLS 2048
46 #define VHOST_SCSI_PREALLOC_UPAGES 2048
47 #define VHOST_SCSI_PREALLOC_PROT_SGLS 2048
49 /* Max number of requests before requeueing the job.
50 * Using this limit prevents one virtqueue from starving others with
53 #define VHOST_SCSI_WEIGHT 256
55 struct vhost_scsi_inflight
{
56 /* Wait for the flush operation to finish */
57 struct completion comp
;
58 /* Refcount for the inflight reqs */
62 struct vhost_scsi_cmd
{
63 /* Descriptor from vhost_get_vq_desc() for virt_queue segment */
65 /* virtio-scsi initiator task attribute */
67 /* virtio-scsi response incoming iovecs */
69 /* virtio-scsi initiator data direction */
70 enum dma_data_direction tvc_data_direction
;
71 /* Expected data transfer length from virtio-scsi header */
73 /* The Tag from include/linux/virtio_scsi.h:struct virtio_scsi_cmd_req */
75 /* The number of scatterlists associated with this cmd */
77 u32 tvc_prot_sgl_count
;
78 /* Saved unpacked SCSI LUN for vhost_scsi_target_queue_cmd() */
81 const void *saved_iter_addr
;
82 struct iov_iter saved_iter
;
83 /* Pointer to the SGL formatted memory from virtio-scsi */
84 struct scatterlist
*tvc_sgl
;
85 struct scatterlist
*tvc_prot_sgl
;
86 struct page
**tvc_upages
;
87 /* Pointer to response header iovec */
88 struct iovec
*tvc_resp_iov
;
89 /* Pointer to vhost_scsi for our device */
90 struct vhost_scsi
*tvc_vhost
;
91 /* Pointer to vhost_virtqueue for the cmd */
92 struct vhost_virtqueue
*tvc_vq
;
93 /* Pointer to vhost nexus memory */
94 struct vhost_scsi_nexus
*tvc_nexus
;
95 /* The TCM I/O descriptor that is accessed via container_of() */
96 struct se_cmd tvc_se_cmd
;
97 /* Copy of the incoming SCSI command descriptor block (CDB) */
98 unsigned char tvc_cdb
[VHOST_SCSI_MAX_CDB_SIZE
];
99 /* Sense buffer that will be mapped into outgoing status */
100 unsigned char tvc_sense_buf
[TRANSPORT_SENSE_BUFFER
];
101 /* Completed commands list, serviced from vhost worker thread */
102 struct llist_node tvc_completion_list
;
103 /* Used to track inflight cmd */
104 struct vhost_scsi_inflight
*inflight
;
107 struct vhost_scsi_nexus
{
108 /* Pointer to TCM session for I_T Nexus */
109 struct se_session
*tvn_se_sess
;
112 struct vhost_scsi_tpg
{
113 /* Vhost port target portal group tag for TCM */
115 /* Used to track number of TPG Port/Lun Links wrt to explict I_T Nexus shutdown */
116 int tv_tpg_port_count
;
117 /* Used for vhost_scsi device reference to tpg_nexus, protected by tv_tpg_mutex */
118 int tv_tpg_vhost_count
;
119 /* Used for enabling T10-PI with legacy devices */
120 int tv_fabric_prot_type
;
121 /* list for vhost_scsi_list */
122 struct list_head tv_tpg_list
;
123 /* Used to protect access for tpg_nexus */
124 struct mutex tv_tpg_mutex
;
125 /* Pointer to the TCM VHost I_T Nexus for this TPG endpoint */
126 struct vhost_scsi_nexus
*tpg_nexus
;
127 /* Pointer back to vhost_scsi_tport */
128 struct vhost_scsi_tport
*tport
;
129 /* Returned by vhost_scsi_make_tpg() */
130 struct se_portal_group se_tpg
;
131 /* Pointer back to vhost_scsi, protected by tv_tpg_mutex */
132 struct vhost_scsi
*vhost_scsi
;
135 struct vhost_scsi_tport
{
136 /* SCSI protocol the tport is providing */
138 /* Binary World Wide unique Port Name for Vhost Target port */
140 /* ASCII formatted WWPN for Vhost Target port */
141 char tport_name
[VHOST_SCSI_NAMELEN
];
142 /* Returned by vhost_scsi_make_tport() */
143 struct se_wwn tport_wwn
;
146 struct vhost_scsi_evt
{
147 /* event to be sent to guest */
148 struct virtio_scsi_event event
;
149 /* event list, serviced from vhost worker thread */
150 struct llist_node list
;
154 VHOST_SCSI_VQ_CTL
= 0,
155 VHOST_SCSI_VQ_EVT
= 1,
156 VHOST_SCSI_VQ_IO
= 2,
159 /* Note: can't set VIRTIO_F_VERSION_1 yet, since that implies ANY_LAYOUT. */
161 VHOST_SCSI_FEATURES
= VHOST_FEATURES
| (1ULL << VIRTIO_SCSI_F_HOTPLUG
) |
162 (1ULL << VIRTIO_SCSI_F_T10_PI
)
165 #define VHOST_SCSI_MAX_TARGET 256
166 #define VHOST_SCSI_MAX_IO_VQ 1024
167 #define VHOST_SCSI_MAX_EVENT 128
169 static unsigned vhost_scsi_max_io_vqs
= 128;
170 module_param_named(max_io_vqs
, vhost_scsi_max_io_vqs
, uint
, 0644);
171 MODULE_PARM_DESC(max_io_vqs
, "Set the max number of IO virtqueues a vhost scsi device can support. The default is 128. The max is 1024.");
173 struct vhost_scsi_virtqueue
{
174 struct vhost_virtqueue vq
;
175 struct vhost_scsi
*vs
;
177 * Reference counting for inflight reqs, used for flush operation. At
178 * each time, one reference tracks new commands submitted, while we
179 * wait for another one to reach 0.
181 struct vhost_scsi_inflight inflights
[2];
183 * Indicate current inflight in use, protected by vq->mutex.
184 * Writers must also take dev mutex and flush under it.
187 struct vhost_scsi_cmd
*scsi_cmds
;
188 struct sbitmap scsi_tags
;
191 struct vhost_work completion_work
;
192 struct llist_head completion_list
;
196 /* Protected by vhost_scsi->dev.mutex */
197 struct vhost_scsi_tpg
**vs_tpg
;
198 char vs_vhost_wwpn
[TRANSPORT_IQN_LEN
];
200 struct vhost_dev dev
;
201 struct vhost_scsi_virtqueue
*vqs
;
202 struct vhost_scsi_inflight
**old_inflight
;
204 struct vhost_work vs_event_work
; /* evt injection work item */
205 struct llist_head vs_event_list
; /* evt injection queue */
207 bool vs_events_missed
; /* any missed events, protected by vq->mutex */
208 int vs_events_nr
; /* num of pending events, protected by vq->mutex */
211 struct vhost_scsi_tmf
{
212 struct vhost_work vwork
;
213 struct work_struct flush_work
;
214 struct vhost_scsi
*vhost
;
215 struct vhost_scsi_virtqueue
*svq
;
217 struct se_cmd se_cmd
;
219 struct vhost_scsi_inflight
*inflight
;
220 struct iovec resp_iov
;
226 * Context for processing request and control queue operations.
228 struct vhost_scsi_ctx
{
230 unsigned int out
, in
;
231 size_t req_size
, rsp_size
;
232 size_t out_size
, in_size
;
235 struct iov_iter out_iter
;
239 * Global mutex to protect vhost_scsi TPG list for vhost IOCTLs and LIO
240 * configfs management operations.
242 static DEFINE_MUTEX(vhost_scsi_mutex
);
243 static LIST_HEAD(vhost_scsi_list
);
245 static void vhost_scsi_done_inflight(struct kref
*kref
)
247 struct vhost_scsi_inflight
*inflight
;
249 inflight
= container_of(kref
, struct vhost_scsi_inflight
, kref
);
250 complete(&inflight
->comp
);
253 static void vhost_scsi_init_inflight(struct vhost_scsi
*vs
,
254 struct vhost_scsi_inflight
*old_inflight
[])
256 struct vhost_scsi_inflight
*new_inflight
;
257 struct vhost_virtqueue
*vq
;
260 for (i
= 0; i
< vs
->dev
.nvqs
; i
++) {
263 mutex_lock(&vq
->mutex
);
265 /* store old infight */
266 idx
= vs
->vqs
[i
].inflight_idx
;
268 old_inflight
[i
] = &vs
->vqs
[i
].inflights
[idx
];
270 /* setup new infight */
271 vs
->vqs
[i
].inflight_idx
= idx
^ 1;
272 new_inflight
= &vs
->vqs
[i
].inflights
[idx
^ 1];
273 kref_init(&new_inflight
->kref
);
274 init_completion(&new_inflight
->comp
);
276 mutex_unlock(&vq
->mutex
);
280 static struct vhost_scsi_inflight
*
281 vhost_scsi_get_inflight(struct vhost_virtqueue
*vq
)
283 struct vhost_scsi_inflight
*inflight
;
284 struct vhost_scsi_virtqueue
*svq
;
286 svq
= container_of(vq
, struct vhost_scsi_virtqueue
, vq
);
287 inflight
= &svq
->inflights
[svq
->inflight_idx
];
288 kref_get(&inflight
->kref
);
293 static void vhost_scsi_put_inflight(struct vhost_scsi_inflight
*inflight
)
295 kref_put(&inflight
->kref
, vhost_scsi_done_inflight
);
298 static int vhost_scsi_check_true(struct se_portal_group
*se_tpg
)
303 static char *vhost_scsi_get_fabric_wwn(struct se_portal_group
*se_tpg
)
305 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
306 struct vhost_scsi_tpg
, se_tpg
);
307 struct vhost_scsi_tport
*tport
= tpg
->tport
;
309 return &tport
->tport_name
[0];
312 static u16
vhost_scsi_get_tpgt(struct se_portal_group
*se_tpg
)
314 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
315 struct vhost_scsi_tpg
, se_tpg
);
316 return tpg
->tport_tpgt
;
319 static int vhost_scsi_check_prot_fabric_only(struct se_portal_group
*se_tpg
)
321 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
322 struct vhost_scsi_tpg
, se_tpg
);
324 return tpg
->tv_fabric_prot_type
;
327 static void vhost_scsi_release_cmd_res(struct se_cmd
*se_cmd
)
329 struct vhost_scsi_cmd
*tv_cmd
= container_of(se_cmd
,
330 struct vhost_scsi_cmd
, tvc_se_cmd
);
331 struct vhost_scsi_virtqueue
*svq
= container_of(tv_cmd
->tvc_vq
,
332 struct vhost_scsi_virtqueue
, vq
);
333 struct vhost_scsi_inflight
*inflight
= tv_cmd
->inflight
;
336 if (tv_cmd
->tvc_sgl_count
) {
337 for (i
= 0; i
< tv_cmd
->tvc_sgl_count
; i
++) {
338 if (tv_cmd
->copied_iov
)
339 __free_page(sg_page(&tv_cmd
->tvc_sgl
[i
]));
341 put_page(sg_page(&tv_cmd
->tvc_sgl
[i
]));
343 kfree(tv_cmd
->saved_iter_addr
);
345 if (tv_cmd
->tvc_prot_sgl_count
) {
346 for (i
= 0; i
< tv_cmd
->tvc_prot_sgl_count
; i
++)
347 put_page(sg_page(&tv_cmd
->tvc_prot_sgl
[i
]));
350 sbitmap_clear_bit(&svq
->scsi_tags
, se_cmd
->map_tag
);
351 vhost_scsi_put_inflight(inflight
);
354 static void vhost_scsi_release_tmf_res(struct vhost_scsi_tmf
*tmf
)
356 struct vhost_scsi_inflight
*inflight
= tmf
->inflight
;
359 vhost_scsi_put_inflight(inflight
);
362 static void vhost_scsi_drop_cmds(struct vhost_scsi_virtqueue
*svq
)
364 struct vhost_scsi_cmd
*cmd
, *t
;
365 struct llist_node
*llnode
;
367 llnode
= llist_del_all(&svq
->completion_list
);
368 llist_for_each_entry_safe(cmd
, t
, llnode
, tvc_completion_list
)
369 vhost_scsi_release_cmd_res(&cmd
->tvc_se_cmd
);
372 static void vhost_scsi_release_cmd(struct se_cmd
*se_cmd
)
374 if (se_cmd
->se_cmd_flags
& SCF_SCSI_TMR_CDB
) {
375 struct vhost_scsi_tmf
*tmf
= container_of(se_cmd
,
376 struct vhost_scsi_tmf
, se_cmd
);
378 schedule_work(&tmf
->flush_work
);
380 struct vhost_scsi_cmd
*cmd
= container_of(se_cmd
,
381 struct vhost_scsi_cmd
, tvc_se_cmd
);
382 struct vhost_scsi_virtqueue
*svq
= container_of(cmd
->tvc_vq
,
383 struct vhost_scsi_virtqueue
, vq
);
385 llist_add(&cmd
->tvc_completion_list
, &svq
->completion_list
);
386 if (!vhost_vq_work_queue(&svq
->vq
, &svq
->completion_work
))
387 vhost_scsi_drop_cmds(svq
);
391 static int vhost_scsi_write_pending(struct se_cmd
*se_cmd
)
393 /* Go ahead and process the write immediately */
394 target_execute_cmd(se_cmd
);
398 static int vhost_scsi_queue_data_in(struct se_cmd
*se_cmd
)
400 transport_generic_free_cmd(se_cmd
, 0);
404 static int vhost_scsi_queue_status(struct se_cmd
*se_cmd
)
406 transport_generic_free_cmd(se_cmd
, 0);
410 static void vhost_scsi_queue_tm_rsp(struct se_cmd
*se_cmd
)
412 struct vhost_scsi_tmf
*tmf
= container_of(se_cmd
, struct vhost_scsi_tmf
,
415 tmf
->scsi_resp
= se_cmd
->se_tmr_req
->response
;
416 transport_generic_free_cmd(&tmf
->se_cmd
, 0);
419 static void vhost_scsi_aborted_task(struct se_cmd
*se_cmd
)
424 static void vhost_scsi_free_evt(struct vhost_scsi
*vs
, struct vhost_scsi_evt
*evt
)
430 static struct vhost_scsi_evt
*
431 vhost_scsi_allocate_evt(struct vhost_scsi
*vs
,
432 u32 event
, u32 reason
)
434 struct vhost_virtqueue
*vq
= &vs
->vqs
[VHOST_SCSI_VQ_EVT
].vq
;
435 struct vhost_scsi_evt
*evt
;
437 if (vs
->vs_events_nr
> VHOST_SCSI_MAX_EVENT
) {
438 vs
->vs_events_missed
= true;
442 evt
= kzalloc(sizeof(*evt
), GFP_KERNEL
);
444 vq_err(vq
, "Failed to allocate vhost_scsi_evt\n");
445 vs
->vs_events_missed
= true;
449 evt
->event
.event
= cpu_to_vhost32(vq
, event
);
450 evt
->event
.reason
= cpu_to_vhost32(vq
, reason
);
456 static int vhost_scsi_check_stop_free(struct se_cmd
*se_cmd
)
458 return target_put_sess_cmd(se_cmd
);
462 vhost_scsi_do_evt_work(struct vhost_scsi
*vs
, struct vhost_scsi_evt
*evt
)
464 struct vhost_virtqueue
*vq
= &vs
->vqs
[VHOST_SCSI_VQ_EVT
].vq
;
465 struct virtio_scsi_event
*event
= &evt
->event
;
466 struct virtio_scsi_event __user
*eventp
;
470 if (!vhost_vq_get_backend(vq
)) {
471 vs
->vs_events_missed
= true;
476 vhost_disable_notify(&vs
->dev
, vq
);
477 head
= vhost_get_vq_desc(vq
, vq
->iov
,
478 ARRAY_SIZE(vq
->iov
), &out
, &in
,
481 vs
->vs_events_missed
= true;
484 if (head
== vq
->num
) {
485 if (vhost_enable_notify(&vs
->dev
, vq
))
487 vs
->vs_events_missed
= true;
491 if ((vq
->iov
[out
].iov_len
!= sizeof(struct virtio_scsi_event
))) {
492 vq_err(vq
, "Expecting virtio_scsi_event, got %zu bytes\n",
493 vq
->iov
[out
].iov_len
);
494 vs
->vs_events_missed
= true;
498 if (vs
->vs_events_missed
) {
499 event
->event
|= cpu_to_vhost32(vq
, VIRTIO_SCSI_T_EVENTS_MISSED
);
500 vs
->vs_events_missed
= false;
503 eventp
= vq
->iov
[out
].iov_base
;
504 ret
= __copy_to_user(eventp
, event
, sizeof(*event
));
506 vhost_add_used_and_signal(&vs
->dev
, vq
, head
, 0);
508 vq_err(vq
, "Faulted on vhost_scsi_send_event\n");
511 static void vhost_scsi_complete_events(struct vhost_scsi
*vs
, bool drop
)
513 struct vhost_virtqueue
*vq
= &vs
->vqs
[VHOST_SCSI_VQ_EVT
].vq
;
514 struct vhost_scsi_evt
*evt
, *t
;
515 struct llist_node
*llnode
;
517 mutex_lock(&vq
->mutex
);
518 llnode
= llist_del_all(&vs
->vs_event_list
);
519 llist_for_each_entry_safe(evt
, t
, llnode
, list
) {
521 vhost_scsi_do_evt_work(vs
, evt
);
522 vhost_scsi_free_evt(vs
, evt
);
524 mutex_unlock(&vq
->mutex
);
527 static void vhost_scsi_evt_work(struct vhost_work
*work
)
529 struct vhost_scsi
*vs
= container_of(work
, struct vhost_scsi
,
531 vhost_scsi_complete_events(vs
, false);
534 static int vhost_scsi_copy_sgl_to_iov(struct vhost_scsi_cmd
*cmd
)
536 struct iov_iter
*iter
= &cmd
->saved_iter
;
537 struct scatterlist
*sg
= cmd
->tvc_sgl
;
542 for (i
= 0; i
< cmd
->tvc_sgl_count
; i
++) {
543 page
= sg_page(&sg
[i
]);
546 if (copy_page_to_iter(page
, 0, len
, iter
) != len
) {
547 pr_err("Could not copy data while handling misaligned cmd. Error %zu\n",
556 /* Fill in status and signal that we are done processing this command
558 * This is scheduled in the vhost work queue so we are called with the owner
559 * process mm and can access the vring.
561 static void vhost_scsi_complete_cmd_work(struct vhost_work
*work
)
563 struct vhost_scsi_virtqueue
*svq
= container_of(work
,
564 struct vhost_scsi_virtqueue
, completion_work
);
565 struct virtio_scsi_cmd_resp v_rsp
;
566 struct vhost_scsi_cmd
*cmd
, *t
;
567 struct llist_node
*llnode
;
568 struct se_cmd
*se_cmd
;
569 struct iov_iter iov_iter
;
573 llnode
= llist_del_all(&svq
->completion_list
);
574 llist_for_each_entry_safe(cmd
, t
, llnode
, tvc_completion_list
) {
575 se_cmd
= &cmd
->tvc_se_cmd
;
577 pr_debug("%s tv_cmd %p resid %u status %#02x\n", __func__
,
578 cmd
, se_cmd
->residual_count
, se_cmd
->scsi_status
);
579 memset(&v_rsp
, 0, sizeof(v_rsp
));
581 if (cmd
->saved_iter_addr
&& vhost_scsi_copy_sgl_to_iov(cmd
)) {
582 v_rsp
.response
= VIRTIO_SCSI_S_BAD_TARGET
;
584 v_rsp
.resid
= cpu_to_vhost32(cmd
->tvc_vq
,
585 se_cmd
->residual_count
);
586 /* TODO is status_qualifier field needed? */
587 v_rsp
.status
= se_cmd
->scsi_status
;
588 v_rsp
.sense_len
= cpu_to_vhost32(cmd
->tvc_vq
,
589 se_cmd
->scsi_sense_length
);
590 memcpy(v_rsp
.sense
, cmd
->tvc_sense_buf
,
591 se_cmd
->scsi_sense_length
);
594 iov_iter_init(&iov_iter
, ITER_DEST
, cmd
->tvc_resp_iov
,
595 cmd
->tvc_in_iovs
, sizeof(v_rsp
));
596 ret
= copy_to_iter(&v_rsp
, sizeof(v_rsp
), &iov_iter
);
597 if (likely(ret
== sizeof(v_rsp
))) {
600 vhost_add_used(cmd
->tvc_vq
, cmd
->tvc_vq_desc
, 0);
602 pr_err("Faulted on virtio_scsi_cmd_resp\n");
604 vhost_scsi_release_cmd_res(se_cmd
);
608 vhost_signal(&svq
->vs
->dev
, &svq
->vq
);
611 static struct vhost_scsi_cmd
*
612 vhost_scsi_get_cmd(struct vhost_virtqueue
*vq
, struct vhost_scsi_tpg
*tpg
,
613 unsigned char *cdb
, u64 scsi_tag
, u16 lun
, u8 task_attr
,
614 u32 exp_data_len
, int data_direction
)
616 struct vhost_scsi_virtqueue
*svq
= container_of(vq
,
617 struct vhost_scsi_virtqueue
, vq
);
618 struct vhost_scsi_cmd
*cmd
;
619 struct vhost_scsi_nexus
*tv_nexus
;
620 struct scatterlist
*sg
, *prot_sg
;
621 struct iovec
*tvc_resp_iov
;
625 tv_nexus
= tpg
->tpg_nexus
;
627 pr_err("Unable to locate active struct vhost_scsi_nexus\n");
628 return ERR_PTR(-EIO
);
631 tag
= sbitmap_get(&svq
->scsi_tags
);
633 pr_err("Unable to obtain tag for vhost_scsi_cmd\n");
634 return ERR_PTR(-ENOMEM
);
637 cmd
= &svq
->scsi_cmds
[tag
];
639 prot_sg
= cmd
->tvc_prot_sgl
;
640 pages
= cmd
->tvc_upages
;
641 tvc_resp_iov
= cmd
->tvc_resp_iov
;
642 memset(cmd
, 0, sizeof(*cmd
));
644 cmd
->tvc_prot_sgl
= prot_sg
;
645 cmd
->tvc_upages
= pages
;
646 cmd
->tvc_se_cmd
.map_tag
= tag
;
647 cmd
->tvc_tag
= scsi_tag
;
649 cmd
->tvc_task_attr
= task_attr
;
650 cmd
->tvc_exp_data_len
= exp_data_len
;
651 cmd
->tvc_data_direction
= data_direction
;
652 cmd
->tvc_nexus
= tv_nexus
;
653 cmd
->inflight
= vhost_scsi_get_inflight(vq
);
654 cmd
->tvc_resp_iov
= tvc_resp_iov
;
656 memcpy(cmd
->tvc_cdb
, cdb
, VHOST_SCSI_MAX_CDB_SIZE
);
662 * Map a user memory range into a scatterlist
664 * Returns the number of scatterlist entries used or -errno on error.
667 vhost_scsi_map_to_sgl(struct vhost_scsi_cmd
*cmd
,
668 struct iov_iter
*iter
,
669 struct scatterlist
*sgl
,
672 struct page
**pages
= cmd
->tvc_upages
;
673 struct scatterlist
*sg
= sgl
;
674 ssize_t bytes
, mapped_bytes
;
675 size_t offset
, mapped_offset
;
676 unsigned int npages
= 0;
678 bytes
= iov_iter_get_pages2(iter
, pages
, LONG_MAX
,
679 VHOST_SCSI_PREALLOC_UPAGES
, &offset
);
680 /* No pages were pinned */
682 return bytes
< 0 ? bytes
: -EFAULT
;
684 mapped_bytes
= bytes
;
685 mapped_offset
= offset
;
688 unsigned n
= min_t(unsigned, PAGE_SIZE
- offset
, bytes
);
690 * The block layer requires bios/requests to be a multiple of
691 * 512 bytes, but Windows can send us vecs that are misaligned.
692 * This can result in bios and later requests with misaligned
693 * sizes if we have to break up a cmd/scatterlist into multiple
696 * We currently only break up a command into multiple bios if
697 * we hit the vec/seg limit, so check if our sgl_count is
698 * greater than the max and if a vec in the cmd has a
699 * misaligned offset/size.
702 (offset
& (SECTOR_SIZE
- 1) || n
& (SECTOR_SIZE
- 1)) &&
703 cmd
->tvc_sgl_count
> BIO_MAX_VECS
) {
705 "vhost-scsi detected misaligned IO. Performance may be degraded.");
706 goto revert_iter_get_pages
;
709 sg_set_page(sg
++, pages
[npages
++], n
, offset
);
716 revert_iter_get_pages
:
717 iov_iter_revert(iter
, mapped_bytes
);
720 while (mapped_bytes
) {
721 unsigned int n
= min_t(unsigned int, PAGE_SIZE
- mapped_offset
,
724 put_page(pages
[npages
++]);
734 vhost_scsi_calc_sgls(struct iov_iter
*iter
, size_t bytes
, int max_sgls
)
738 if (!iter
|| !iter_iov(iter
)) {
739 pr_err("%s: iter->iov is NULL, but expected bytes: %zu"
740 " present\n", __func__
, bytes
);
744 sgl_count
= iov_iter_npages(iter
, 0xffff);
745 if (sgl_count
> max_sgls
) {
746 pr_err("%s: requested sgl_count: %d exceeds pre-allocated"
747 " max_sgls: %d\n", __func__
, sgl_count
, max_sgls
);
754 vhost_scsi_copy_iov_to_sgl(struct vhost_scsi_cmd
*cmd
, struct iov_iter
*iter
,
755 struct scatterlist
*sg
, int sg_count
)
757 size_t len
= iov_iter_count(iter
);
758 unsigned int nbytes
= 0;
762 if (cmd
->tvc_data_direction
== DMA_FROM_DEVICE
) {
763 cmd
->saved_iter_addr
= dup_iter(&cmd
->saved_iter
, iter
,
765 if (!cmd
->saved_iter_addr
)
769 for (i
= 0; i
< sg_count
; i
++) {
770 page
= alloc_page(GFP_KERNEL
);
776 nbytes
= min_t(unsigned int, PAGE_SIZE
, len
);
777 sg_set_page(&sg
[i
], page
, nbytes
, 0);
779 if (cmd
->tvc_data_direction
== DMA_TO_DEVICE
&&
780 copy_page_from_iter(page
, 0, nbytes
, iter
) != nbytes
)
790 pr_err("Could not read %u bytes while handling misaligned cmd\n",
794 __free_page(sg_page(&sg
[i
]));
795 kfree(cmd
->saved_iter_addr
);
800 vhost_scsi_map_iov_to_sgl(struct vhost_scsi_cmd
*cmd
, struct iov_iter
*iter
,
801 struct scatterlist
*sg
, int sg_count
, bool is_prot
)
803 struct scatterlist
*p
= sg
;
807 while (iov_iter_count(iter
)) {
808 ret
= vhost_scsi_map_to_sgl(cmd
, iter
, sg
, is_prot
);
813 struct page
*page
= sg_page(p
);
817 revert_bytes
+= p
->length
;
822 iov_iter_revert(iter
, revert_bytes
);
832 vhost_scsi_mapal(struct vhost_scsi_cmd
*cmd
,
833 size_t prot_bytes
, struct iov_iter
*prot_iter
,
834 size_t data_bytes
, struct iov_iter
*data_iter
)
839 sgl_count
= vhost_scsi_calc_sgls(prot_iter
, prot_bytes
,
840 VHOST_SCSI_PREALLOC_PROT_SGLS
);
844 sg_init_table(cmd
->tvc_prot_sgl
, sgl_count
);
845 cmd
->tvc_prot_sgl_count
= sgl_count
;
846 pr_debug("%s prot_sg %p prot_sgl_count %u\n", __func__
,
847 cmd
->tvc_prot_sgl
, cmd
->tvc_prot_sgl_count
);
849 ret
= vhost_scsi_map_iov_to_sgl(cmd
, prot_iter
,
851 cmd
->tvc_prot_sgl_count
, true);
853 cmd
->tvc_prot_sgl_count
= 0;
857 sgl_count
= vhost_scsi_calc_sgls(data_iter
, data_bytes
,
858 VHOST_SCSI_PREALLOC_SGLS
);
862 sg_init_table(cmd
->tvc_sgl
, sgl_count
);
863 cmd
->tvc_sgl_count
= sgl_count
;
864 pr_debug("%s data_sg %p data_sgl_count %u\n", __func__
,
865 cmd
->tvc_sgl
, cmd
->tvc_sgl_count
);
867 ret
= vhost_scsi_map_iov_to_sgl(cmd
, data_iter
, cmd
->tvc_sgl
,
868 cmd
->tvc_sgl_count
, false);
869 if (ret
== -EINVAL
) {
870 sg_init_table(cmd
->tvc_sgl
, cmd
->tvc_sgl_count
);
871 ret
= vhost_scsi_copy_iov_to_sgl(cmd
, data_iter
, cmd
->tvc_sgl
,
876 cmd
->tvc_sgl_count
= 0;
882 static int vhost_scsi_to_tcm_attr(int attr
)
885 case VIRTIO_SCSI_S_SIMPLE
:
886 return TCM_SIMPLE_TAG
;
887 case VIRTIO_SCSI_S_ORDERED
:
888 return TCM_ORDERED_TAG
;
889 case VIRTIO_SCSI_S_HEAD
:
891 case VIRTIO_SCSI_S_ACA
:
896 return TCM_SIMPLE_TAG
;
899 static void vhost_scsi_target_queue_cmd(struct vhost_scsi_cmd
*cmd
)
901 struct se_cmd
*se_cmd
= &cmd
->tvc_se_cmd
;
902 struct vhost_scsi_nexus
*tv_nexus
;
903 struct scatterlist
*sg_ptr
, *sg_prot_ptr
= NULL
;
905 /* FIXME: BIDI operation */
906 if (cmd
->tvc_sgl_count
) {
907 sg_ptr
= cmd
->tvc_sgl
;
909 if (cmd
->tvc_prot_sgl_count
)
910 sg_prot_ptr
= cmd
->tvc_prot_sgl
;
912 se_cmd
->prot_pto
= true;
916 tv_nexus
= cmd
->tvc_nexus
;
919 target_init_cmd(se_cmd
, tv_nexus
->tvn_se_sess
, &cmd
->tvc_sense_buf
[0],
920 cmd
->tvc_lun
, cmd
->tvc_exp_data_len
,
921 vhost_scsi_to_tcm_attr(cmd
->tvc_task_attr
),
922 cmd
->tvc_data_direction
, TARGET_SCF_ACK_KREF
);
924 if (target_submit_prep(se_cmd
, cmd
->tvc_cdb
, sg_ptr
,
925 cmd
->tvc_sgl_count
, NULL
, 0, sg_prot_ptr
,
926 cmd
->tvc_prot_sgl_count
, GFP_KERNEL
))
929 target_submit(se_cmd
);
933 vhost_scsi_send_bad_target(struct vhost_scsi
*vs
,
934 struct vhost_virtqueue
*vq
,
935 int head
, unsigned out
)
937 struct virtio_scsi_cmd_resp __user
*resp
;
938 struct virtio_scsi_cmd_resp rsp
;
941 memset(&rsp
, 0, sizeof(rsp
));
942 rsp
.response
= VIRTIO_SCSI_S_BAD_TARGET
;
943 resp
= vq
->iov
[out
].iov_base
;
944 ret
= __copy_to_user(resp
, &rsp
, sizeof(rsp
));
946 vhost_add_used_and_signal(&vs
->dev
, vq
, head
, 0);
948 pr_err("Faulted on virtio_scsi_cmd_resp\n");
952 vhost_scsi_get_desc(struct vhost_scsi
*vs
, struct vhost_virtqueue
*vq
,
953 struct vhost_scsi_ctx
*vc
)
957 vc
->head
= vhost_get_vq_desc(vq
, vq
->iov
,
958 ARRAY_SIZE(vq
->iov
), &vc
->out
, &vc
->in
,
961 pr_debug("vhost_get_vq_desc: head: %d, out: %u in: %u\n",
962 vc
->head
, vc
->out
, vc
->in
);
964 /* On error, stop handling until the next kick. */
965 if (unlikely(vc
->head
< 0))
968 /* Nothing new? Wait for eventfd to tell us they refilled. */
969 if (vc
->head
== vq
->num
) {
970 if (unlikely(vhost_enable_notify(&vs
->dev
, vq
))) {
971 vhost_disable_notify(&vs
->dev
, vq
);
978 * Get the size of request and response buffers.
979 * FIXME: Not correct for BIDI operation
981 vc
->out_size
= iov_length(vq
->iov
, vc
->out
);
982 vc
->in_size
= iov_length(&vq
->iov
[vc
->out
], vc
->in
);
985 * Copy over the virtio-scsi request header, which for a
986 * ANY_LAYOUT enabled guest may span multiple iovecs, or a
987 * single iovec may contain both the header + outgoing
990 * copy_from_iter() will advance out_iter, so that it will
991 * point at the start of the outgoing WRITE payload, if
992 * DMA_TO_DEVICE is set.
994 iov_iter_init(&vc
->out_iter
, ITER_SOURCE
, vq
->iov
, vc
->out
, vc
->out_size
);
1002 vhost_scsi_chk_size(struct vhost_virtqueue
*vq
, struct vhost_scsi_ctx
*vc
)
1004 if (unlikely(vc
->in_size
< vc
->rsp_size
)) {
1006 "Response buf too small, need min %zu bytes got %zu",
1007 vc
->rsp_size
, vc
->in_size
);
1009 } else if (unlikely(vc
->out_size
< vc
->req_size
)) {
1011 "Request buf too small, need min %zu bytes got %zu",
1012 vc
->req_size
, vc
->out_size
);
1020 vhost_scsi_get_req(struct vhost_virtqueue
*vq
, struct vhost_scsi_ctx
*vc
,
1021 struct vhost_scsi_tpg
**tpgp
)
1025 if (unlikely(!copy_from_iter_full(vc
->req
, vc
->req_size
,
1027 vq_err(vq
, "Faulted on copy_from_iter_full\n");
1028 } else if (unlikely(*vc
->lunp
!= 1)) {
1029 /* virtio-scsi spec requires byte 0 of the lun to be 1 */
1030 vq_err(vq
, "Illegal virtio-scsi lun: %u\n", *vc
->lunp
);
1032 struct vhost_scsi_tpg
**vs_tpg
, *tpg
= NULL
;
1035 /* validated at handler entry */
1036 vs_tpg
= vhost_vq_get_backend(vq
);
1037 tpg
= READ_ONCE(vs_tpg
[*vc
->target
]);
1038 if (unlikely(!tpg
)) {
1039 vq_err(vq
, "Target 0x%x does not exist\n", *vc
->target
);
1052 static u16
vhost_buf_to_lun(u8
*lun_buf
)
1054 return ((lun_buf
[2] << 8) | lun_buf
[3]) & 0x3FFF;
1058 vhost_scsi_handle_vq(struct vhost_scsi
*vs
, struct vhost_virtqueue
*vq
)
1060 struct vhost_scsi_tpg
**vs_tpg
, *tpg
;
1061 struct virtio_scsi_cmd_req v_req
;
1062 struct virtio_scsi_cmd_req_pi v_req_pi
;
1063 struct vhost_scsi_ctx vc
;
1064 struct vhost_scsi_cmd
*cmd
;
1065 struct iov_iter in_iter
, prot_iter
, data_iter
;
1067 u32 exp_data_len
, data_direction
;
1068 int ret
, prot_bytes
, i
, c
= 0;
1071 bool t10_pi
= vhost_has_feature(vq
, VIRTIO_SCSI_F_T10_PI
);
1074 mutex_lock(&vq
->mutex
);
1076 * We can handle the vq only after the endpoint is setup by calling the
1077 * VHOST_SCSI_SET_ENDPOINT ioctl.
1079 vs_tpg
= vhost_vq_get_backend(vq
);
1083 memset(&vc
, 0, sizeof(vc
));
1084 vc
.rsp_size
= sizeof(struct virtio_scsi_cmd_resp
);
1086 vhost_disable_notify(&vs
->dev
, vq
);
1089 ret
= vhost_scsi_get_desc(vs
, vq
, &vc
);
1094 * Setup pointers and values based upon different virtio-scsi
1095 * request header if T10_PI is enabled in KVM guest.
1099 vc
.req_size
= sizeof(v_req_pi
);
1100 vc
.lunp
= &v_req_pi
.lun
[0];
1101 vc
.target
= &v_req_pi
.lun
[1];
1104 vc
.req_size
= sizeof(v_req
);
1105 vc
.lunp
= &v_req
.lun
[0];
1106 vc
.target
= &v_req
.lun
[1];
1110 * Validate the size of request and response buffers.
1111 * Check for a sane response buffer so we can report
1112 * early errors back to the guest.
1114 ret
= vhost_scsi_chk_size(vq
, &vc
);
1118 ret
= vhost_scsi_get_req(vq
, &vc
, &tpg
);
1122 ret
= -EIO
; /* bad target on any error from here on */
1125 * Determine data_direction by calculating the total outgoing
1126 * iovec sizes + incoming iovec sizes vs. virtio-scsi request +
1127 * response headers respectively.
1129 * For DMA_TO_DEVICE this is out_iter, which is already pointing
1130 * to the right place.
1132 * For DMA_FROM_DEVICE, the iovec will be just past the end
1133 * of the virtio-scsi response header in either the same
1134 * or immediately following iovec.
1136 * Any associated T10_PI bytes for the outgoing / incoming
1137 * payloads are included in calculation of exp_data_len here.
1141 if (vc
.out_size
> vc
.req_size
) {
1142 data_direction
= DMA_TO_DEVICE
;
1143 exp_data_len
= vc
.out_size
- vc
.req_size
;
1144 data_iter
= vc
.out_iter
;
1145 } else if (vc
.in_size
> vc
.rsp_size
) {
1146 data_direction
= DMA_FROM_DEVICE
;
1147 exp_data_len
= vc
.in_size
- vc
.rsp_size
;
1149 iov_iter_init(&in_iter
, ITER_DEST
, &vq
->iov
[vc
.out
], vc
.in
,
1150 vc
.rsp_size
+ exp_data_len
);
1151 iov_iter_advance(&in_iter
, vc
.rsp_size
);
1152 data_iter
= in_iter
;
1154 data_direction
= DMA_NONE
;
1158 * If T10_PI header + payload is present, setup prot_iter values
1159 * and recalculate data_iter for vhost_scsi_mapal() mapping to
1160 * host scatterlists via get_user_pages_fast().
1163 if (v_req_pi
.pi_bytesout
) {
1164 if (data_direction
!= DMA_TO_DEVICE
) {
1165 vq_err(vq
, "Received non zero pi_bytesout,"
1166 " but wrong data_direction\n");
1169 prot_bytes
= vhost32_to_cpu(vq
, v_req_pi
.pi_bytesout
);
1170 } else if (v_req_pi
.pi_bytesin
) {
1171 if (data_direction
!= DMA_FROM_DEVICE
) {
1172 vq_err(vq
, "Received non zero pi_bytesin,"
1173 " but wrong data_direction\n");
1176 prot_bytes
= vhost32_to_cpu(vq
, v_req_pi
.pi_bytesin
);
1179 * Set prot_iter to data_iter and truncate it to
1180 * prot_bytes, and advance data_iter past any
1181 * preceding prot_bytes that may be present.
1183 * Also fix up the exp_data_len to reflect only the
1184 * actual data payload length.
1187 exp_data_len
-= prot_bytes
;
1188 prot_iter
= data_iter
;
1189 iov_iter_truncate(&prot_iter
, prot_bytes
);
1190 iov_iter_advance(&data_iter
, prot_bytes
);
1192 tag
= vhost64_to_cpu(vq
, v_req_pi
.tag
);
1193 task_attr
= v_req_pi
.task_attr
;
1194 cdb
= &v_req_pi
.cdb
[0];
1195 lun
= vhost_buf_to_lun(v_req_pi
.lun
);
1197 tag
= vhost64_to_cpu(vq
, v_req
.tag
);
1198 task_attr
= v_req
.task_attr
;
1199 cdb
= &v_req
.cdb
[0];
1200 lun
= vhost_buf_to_lun(v_req
.lun
);
1203 * Check that the received CDB size does not exceeded our
1204 * hardcoded max for vhost-scsi, then get a pre-allocated
1205 * cmd descriptor for the new virtio-scsi tag.
1207 * TODO what if cdb was too small for varlen cdb header?
1209 if (unlikely(scsi_command_size(cdb
) > VHOST_SCSI_MAX_CDB_SIZE
)) {
1210 vq_err(vq
, "Received SCSI CDB with command_size: %d that"
1211 " exceeds SCSI_MAX_VARLEN_CDB_SIZE: %d\n",
1212 scsi_command_size(cdb
), VHOST_SCSI_MAX_CDB_SIZE
);
1215 cmd
= vhost_scsi_get_cmd(vq
, tpg
, cdb
, tag
, lun
, task_attr
,
1216 exp_data_len
+ prot_bytes
,
1219 vq_err(vq
, "vhost_scsi_get_cmd failed %ld\n",
1223 cmd
->tvc_vhost
= vs
;
1225 for (i
= 0; i
< vc
.in
; i
++)
1226 cmd
->tvc_resp_iov
[i
] = vq
->iov
[vc
.out
+ i
];
1227 cmd
->tvc_in_iovs
= vc
.in
;
1229 pr_debug("vhost_scsi got command opcode: %#02x, lun: %d\n",
1230 cmd
->tvc_cdb
[0], cmd
->tvc_lun
);
1231 pr_debug("cmd: %p exp_data_len: %d, prot_bytes: %d data_direction:"
1232 " %d\n", cmd
, exp_data_len
, prot_bytes
, data_direction
);
1234 if (data_direction
!= DMA_NONE
) {
1235 if (unlikely(vhost_scsi_mapal(cmd
, prot_bytes
,
1236 &prot_iter
, exp_data_len
,
1238 vq_err(vq
, "Failed to map iov to sgl\n");
1239 vhost_scsi_release_cmd_res(&cmd
->tvc_se_cmd
);
1244 * Save the descriptor from vhost_get_vq_desc() to be used to
1245 * complete the virtio-scsi request in TCM callback context via
1246 * vhost_scsi_queue_data_in() and vhost_scsi_queue_status()
1248 cmd
->tvc_vq_desc
= vc
.head
;
1249 vhost_scsi_target_queue_cmd(cmd
);
1253 * ENXIO: No more requests, or read error, wait for next kick
1254 * EINVAL: Invalid response buffer, drop the request
1255 * EIO: Respond with bad target
1256 * EAGAIN: Pending request
1260 else if (ret
== -EIO
)
1261 vhost_scsi_send_bad_target(vs
, vq
, vc
.head
, vc
.out
);
1262 } while (likely(!vhost_exceeds_weight(vq
, ++c
, 0)));
1264 mutex_unlock(&vq
->mutex
);
1268 vhost_scsi_send_tmf_resp(struct vhost_scsi
*vs
, struct vhost_virtqueue
*vq
,
1269 int in_iovs
, int vq_desc
, struct iovec
*resp_iov
,
1272 struct virtio_scsi_ctrl_tmf_resp rsp
;
1273 struct iov_iter iov_iter
;
1276 pr_debug("%s\n", __func__
);
1277 memset(&rsp
, 0, sizeof(rsp
));
1278 rsp
.response
= tmf_resp_code
;
1280 iov_iter_init(&iov_iter
, ITER_DEST
, resp_iov
, in_iovs
, sizeof(rsp
));
1282 ret
= copy_to_iter(&rsp
, sizeof(rsp
), &iov_iter
);
1283 if (likely(ret
== sizeof(rsp
)))
1284 vhost_add_used_and_signal(&vs
->dev
, vq
, vq_desc
, 0);
1286 pr_err("Faulted on virtio_scsi_ctrl_tmf_resp\n");
1289 static void vhost_scsi_tmf_resp_work(struct vhost_work
*work
)
1291 struct vhost_scsi_tmf
*tmf
= container_of(work
, struct vhost_scsi_tmf
,
1295 if (tmf
->scsi_resp
== TMR_FUNCTION_COMPLETE
)
1296 resp_code
= VIRTIO_SCSI_S_FUNCTION_SUCCEEDED
;
1298 resp_code
= VIRTIO_SCSI_S_FUNCTION_REJECTED
;
1300 vhost_scsi_send_tmf_resp(tmf
->vhost
, &tmf
->svq
->vq
, tmf
->in_iovs
,
1301 tmf
->vq_desc
, &tmf
->resp_iov
, resp_code
);
1302 vhost_scsi_release_tmf_res(tmf
);
1305 static void vhost_scsi_tmf_flush_work(struct work_struct
*work
)
1307 struct vhost_scsi_tmf
*tmf
= container_of(work
, struct vhost_scsi_tmf
,
1309 struct vhost_virtqueue
*vq
= &tmf
->svq
->vq
;
1311 * Make sure we have sent responses for other commands before we
1312 * send our response.
1314 vhost_dev_flush(vq
->dev
);
1315 if (!vhost_vq_work_queue(vq
, &tmf
->vwork
))
1316 vhost_scsi_release_tmf_res(tmf
);
1320 vhost_scsi_handle_tmf(struct vhost_scsi
*vs
, struct vhost_scsi_tpg
*tpg
,
1321 struct vhost_virtqueue
*vq
,
1322 struct virtio_scsi_ctrl_tmf_req
*vtmf
,
1323 struct vhost_scsi_ctx
*vc
)
1325 struct vhost_scsi_virtqueue
*svq
= container_of(vq
,
1326 struct vhost_scsi_virtqueue
, vq
);
1327 struct vhost_scsi_tmf
*tmf
;
1329 if (vhost32_to_cpu(vq
, vtmf
->subtype
) !=
1330 VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET
)
1333 if (!tpg
->tpg_nexus
|| !tpg
->tpg_nexus
->tvn_se_sess
) {
1334 pr_err("Unable to locate active struct vhost_scsi_nexus for LUN RESET.\n");
1338 tmf
= kzalloc(sizeof(*tmf
), GFP_KERNEL
);
1342 INIT_WORK(&tmf
->flush_work
, vhost_scsi_tmf_flush_work
);
1343 vhost_work_init(&tmf
->vwork
, vhost_scsi_tmf_resp_work
);
1346 tmf
->resp_iov
= vq
->iov
[vc
->out
];
1347 tmf
->vq_desc
= vc
->head
;
1348 tmf
->in_iovs
= vc
->in
;
1349 tmf
->inflight
= vhost_scsi_get_inflight(vq
);
1351 if (target_submit_tmr(&tmf
->se_cmd
, tpg
->tpg_nexus
->tvn_se_sess
, NULL
,
1352 vhost_buf_to_lun(vtmf
->lun
), NULL
,
1353 TMR_LUN_RESET
, GFP_KERNEL
, 0,
1354 TARGET_SCF_ACK_KREF
) < 0) {
1355 vhost_scsi_release_tmf_res(tmf
);
1362 vhost_scsi_send_tmf_resp(vs
, vq
, vc
->in
, vc
->head
, &vq
->iov
[vc
->out
],
1363 VIRTIO_SCSI_S_FUNCTION_REJECTED
);
1367 vhost_scsi_send_an_resp(struct vhost_scsi
*vs
,
1368 struct vhost_virtqueue
*vq
,
1369 struct vhost_scsi_ctx
*vc
)
1371 struct virtio_scsi_ctrl_an_resp rsp
;
1372 struct iov_iter iov_iter
;
1375 pr_debug("%s\n", __func__
);
1376 memset(&rsp
, 0, sizeof(rsp
)); /* event_actual = 0 */
1377 rsp
.response
= VIRTIO_SCSI_S_OK
;
1379 iov_iter_init(&iov_iter
, ITER_DEST
, &vq
->iov
[vc
->out
], vc
->in
, sizeof(rsp
));
1381 ret
= copy_to_iter(&rsp
, sizeof(rsp
), &iov_iter
);
1382 if (likely(ret
== sizeof(rsp
)))
1383 vhost_add_used_and_signal(&vs
->dev
, vq
, vc
->head
, 0);
1385 pr_err("Faulted on virtio_scsi_ctrl_an_resp\n");
1389 vhost_scsi_ctl_handle_vq(struct vhost_scsi
*vs
, struct vhost_virtqueue
*vq
)
1391 struct vhost_scsi_tpg
*tpg
;
1394 struct virtio_scsi_ctrl_an_req an
;
1395 struct virtio_scsi_ctrl_tmf_req tmf
;
1397 struct vhost_scsi_ctx vc
;
1401 mutex_lock(&vq
->mutex
);
1403 * We can handle the vq only after the endpoint is setup by calling the
1404 * VHOST_SCSI_SET_ENDPOINT ioctl.
1406 if (!vhost_vq_get_backend(vq
))
1409 memset(&vc
, 0, sizeof(vc
));
1411 vhost_disable_notify(&vs
->dev
, vq
);
1414 ret
= vhost_scsi_get_desc(vs
, vq
, &vc
);
1419 * Get the request type first in order to setup
1420 * other parameters dependent on the type.
1422 vc
.req
= &v_req
.type
;
1423 typ_size
= sizeof(v_req
.type
);
1425 if (unlikely(!copy_from_iter_full(vc
.req
, typ_size
,
1427 vq_err(vq
, "Faulted on copy_from_iter tmf type\n");
1429 * The size of the response buffer depends on the
1430 * request type and must be validated against it.
1431 * Since the request type is not known, don't send
1437 switch (vhost32_to_cpu(vq
, v_req
.type
)) {
1438 case VIRTIO_SCSI_T_TMF
:
1439 vc
.req
= &v_req
.tmf
;
1440 vc
.req_size
= sizeof(struct virtio_scsi_ctrl_tmf_req
);
1441 vc
.rsp_size
= sizeof(struct virtio_scsi_ctrl_tmf_resp
);
1442 vc
.lunp
= &v_req
.tmf
.lun
[0];
1443 vc
.target
= &v_req
.tmf
.lun
[1];
1445 case VIRTIO_SCSI_T_AN_QUERY
:
1446 case VIRTIO_SCSI_T_AN_SUBSCRIBE
:
1448 vc
.req_size
= sizeof(struct virtio_scsi_ctrl_an_req
);
1449 vc
.rsp_size
= sizeof(struct virtio_scsi_ctrl_an_resp
);
1450 vc
.lunp
= &v_req
.an
.lun
[0];
1454 vq_err(vq
, "Unknown control request %d", v_req
.type
);
1459 * Validate the size of request and response buffers.
1460 * Check for a sane response buffer so we can report
1461 * early errors back to the guest.
1463 ret
= vhost_scsi_chk_size(vq
, &vc
);
1468 * Get the rest of the request now that its size is known.
1471 vc
.req_size
-= typ_size
;
1473 ret
= vhost_scsi_get_req(vq
, &vc
, &tpg
);
1477 if (v_req
.type
== VIRTIO_SCSI_T_TMF
)
1478 vhost_scsi_handle_tmf(vs
, tpg
, vq
, &v_req
.tmf
, &vc
);
1480 vhost_scsi_send_an_resp(vs
, vq
, &vc
);
1483 * ENXIO: No more requests, or read error, wait for next kick
1484 * EINVAL: Invalid response buffer, drop the request
1485 * EIO: Respond with bad target
1486 * EAGAIN: Pending request
1490 else if (ret
== -EIO
)
1491 vhost_scsi_send_bad_target(vs
, vq
, vc
.head
, vc
.out
);
1492 } while (likely(!vhost_exceeds_weight(vq
, ++c
, 0)));
1494 mutex_unlock(&vq
->mutex
);
1497 static void vhost_scsi_ctl_handle_kick(struct vhost_work
*work
)
1499 struct vhost_virtqueue
*vq
= container_of(work
, struct vhost_virtqueue
,
1501 struct vhost_scsi
*vs
= container_of(vq
->dev
, struct vhost_scsi
, dev
);
1503 pr_debug("%s: The handling func for control queue.\n", __func__
);
1504 vhost_scsi_ctl_handle_vq(vs
, vq
);
1508 vhost_scsi_send_evt(struct vhost_scsi
*vs
, struct vhost_virtqueue
*vq
,
1509 struct vhost_scsi_tpg
*tpg
, struct se_lun
*lun
,
1510 u32 event
, u32 reason
)
1512 struct vhost_scsi_evt
*evt
;
1514 evt
= vhost_scsi_allocate_evt(vs
, event
, reason
);
1519 /* TODO: share lun setup code with virtio-scsi.ko */
1521 * Note: evt->event is zeroed when we allocate it and
1522 * lun[4-7] need to be zero according to virtio-scsi spec.
1524 evt
->event
.lun
[0] = 0x01;
1525 evt
->event
.lun
[1] = tpg
->tport_tpgt
;
1526 if (lun
->unpacked_lun
>= 256)
1527 evt
->event
.lun
[2] = lun
->unpacked_lun
>> 8 | 0x40 ;
1528 evt
->event
.lun
[3] = lun
->unpacked_lun
& 0xFF;
1531 llist_add(&evt
->list
, &vs
->vs_event_list
);
1532 if (!vhost_vq_work_queue(vq
, &vs
->vs_event_work
))
1533 vhost_scsi_complete_events(vs
, true);
1536 static void vhost_scsi_evt_handle_kick(struct vhost_work
*work
)
1538 struct vhost_virtqueue
*vq
= container_of(work
, struct vhost_virtqueue
,
1540 struct vhost_scsi
*vs
= container_of(vq
->dev
, struct vhost_scsi
, dev
);
1542 mutex_lock(&vq
->mutex
);
1543 if (!vhost_vq_get_backend(vq
))
1546 if (vs
->vs_events_missed
)
1547 vhost_scsi_send_evt(vs
, vq
, NULL
, NULL
, VIRTIO_SCSI_T_NO_EVENT
,
1550 mutex_unlock(&vq
->mutex
);
1553 static void vhost_scsi_handle_kick(struct vhost_work
*work
)
1555 struct vhost_virtqueue
*vq
= container_of(work
, struct vhost_virtqueue
,
1557 struct vhost_scsi
*vs
= container_of(vq
->dev
, struct vhost_scsi
, dev
);
1559 vhost_scsi_handle_vq(vs
, vq
);
1562 /* Callers must hold dev mutex */
1563 static void vhost_scsi_flush(struct vhost_scsi
*vs
)
1567 /* Init new inflight and remember the old inflight */
1568 vhost_scsi_init_inflight(vs
, vs
->old_inflight
);
1571 * The inflight->kref was initialized to 1. We decrement it here to
1572 * indicate the start of the flush operation so that it will reach 0
1573 * when all the reqs are finished.
1575 for (i
= 0; i
< vs
->dev
.nvqs
; i
++)
1576 kref_put(&vs
->old_inflight
[i
]->kref
, vhost_scsi_done_inflight
);
1578 /* Flush both the vhost poll and vhost work */
1579 vhost_dev_flush(&vs
->dev
);
1581 /* Wait for all reqs issued before the flush to be finished */
1582 for (i
= 0; i
< vs
->dev
.nvqs
; i
++)
1583 wait_for_completion(&vs
->old_inflight
[i
]->comp
);
1586 static void vhost_scsi_destroy_vq_cmds(struct vhost_virtqueue
*vq
)
1588 struct vhost_scsi_virtqueue
*svq
= container_of(vq
,
1589 struct vhost_scsi_virtqueue
, vq
);
1590 struct vhost_scsi_cmd
*tv_cmd
;
1593 if (!svq
->scsi_cmds
)
1596 for (i
= 0; i
< svq
->max_cmds
; i
++) {
1597 tv_cmd
= &svq
->scsi_cmds
[i
];
1599 kfree(tv_cmd
->tvc_sgl
);
1600 kfree(tv_cmd
->tvc_prot_sgl
);
1601 kfree(tv_cmd
->tvc_upages
);
1602 kfree(tv_cmd
->tvc_resp_iov
);
1605 sbitmap_free(&svq
->scsi_tags
);
1606 kfree(svq
->scsi_cmds
);
1607 svq
->scsi_cmds
= NULL
;
1610 static int vhost_scsi_setup_vq_cmds(struct vhost_virtqueue
*vq
, int max_cmds
)
1612 struct vhost_scsi_virtqueue
*svq
= container_of(vq
,
1613 struct vhost_scsi_virtqueue
, vq
);
1614 struct vhost_scsi_cmd
*tv_cmd
;
1620 if (sbitmap_init_node(&svq
->scsi_tags
, max_cmds
, -1, GFP_KERNEL
,
1621 NUMA_NO_NODE
, false, true))
1623 svq
->max_cmds
= max_cmds
;
1625 svq
->scsi_cmds
= kcalloc(max_cmds
, sizeof(*tv_cmd
), GFP_KERNEL
);
1626 if (!svq
->scsi_cmds
) {
1627 sbitmap_free(&svq
->scsi_tags
);
1631 for (i
= 0; i
< max_cmds
; i
++) {
1632 tv_cmd
= &svq
->scsi_cmds
[i
];
1634 tv_cmd
->tvc_sgl
= kcalloc(VHOST_SCSI_PREALLOC_SGLS
,
1635 sizeof(struct scatterlist
),
1637 if (!tv_cmd
->tvc_sgl
) {
1638 pr_err("Unable to allocate tv_cmd->tvc_sgl\n");
1642 tv_cmd
->tvc_upages
= kcalloc(VHOST_SCSI_PREALLOC_UPAGES
,
1643 sizeof(struct page
*),
1645 if (!tv_cmd
->tvc_upages
) {
1646 pr_err("Unable to allocate tv_cmd->tvc_upages\n");
1650 tv_cmd
->tvc_resp_iov
= kcalloc(UIO_MAXIOV
,
1651 sizeof(struct iovec
),
1653 if (!tv_cmd
->tvc_resp_iov
) {
1654 pr_err("Unable to allocate tv_cmd->tvc_resp_iov\n");
1658 tv_cmd
->tvc_prot_sgl
= kcalloc(VHOST_SCSI_PREALLOC_PROT_SGLS
,
1659 sizeof(struct scatterlist
),
1661 if (!tv_cmd
->tvc_prot_sgl
) {
1662 pr_err("Unable to allocate tv_cmd->tvc_prot_sgl\n");
1668 vhost_scsi_destroy_vq_cmds(vq
);
1673 * Called from vhost_scsi_ioctl() context to walk the list of available
1674 * vhost_scsi_tpg with an active struct vhost_scsi_nexus
1676 * The lock nesting rule is:
1677 * vs->dev.mutex -> vhost_scsi_mutex -> tpg->tv_tpg_mutex -> vq->mutex
1680 vhost_scsi_set_endpoint(struct vhost_scsi
*vs
,
1681 struct vhost_scsi_target
*t
)
1683 struct se_portal_group
*se_tpg
;
1684 struct vhost_scsi_tport
*tv_tport
;
1685 struct vhost_scsi_tpg
*tpg
;
1686 struct vhost_scsi_tpg
**vs_tpg
;
1687 struct vhost_virtqueue
*vq
;
1688 int index
, ret
, i
, len
;
1691 mutex_lock(&vs
->dev
.mutex
);
1693 /* Verify that ring has been setup correctly. */
1694 for (index
= 0; index
< vs
->dev
.nvqs
; ++index
) {
1695 /* Verify that ring has been setup correctly. */
1696 if (!vhost_vq_access_ok(&vs
->vqs
[index
].vq
)) {
1702 len
= sizeof(vs_tpg
[0]) * VHOST_SCSI_MAX_TARGET
;
1703 vs_tpg
= kzalloc(len
, GFP_KERNEL
);
1709 memcpy(vs_tpg
, vs
->vs_tpg
, len
);
1711 mutex_lock(&vhost_scsi_mutex
);
1712 list_for_each_entry(tpg
, &vhost_scsi_list
, tv_tpg_list
) {
1713 mutex_lock(&tpg
->tv_tpg_mutex
);
1714 if (!tpg
->tpg_nexus
) {
1715 mutex_unlock(&tpg
->tv_tpg_mutex
);
1718 if (tpg
->tv_tpg_vhost_count
!= 0) {
1719 mutex_unlock(&tpg
->tv_tpg_mutex
);
1722 tv_tport
= tpg
->tport
;
1724 if (!strcmp(tv_tport
->tport_name
, t
->vhost_wwpn
)) {
1725 if (vs
->vs_tpg
&& vs
->vs_tpg
[tpg
->tport_tpgt
]) {
1726 mutex_unlock(&tpg
->tv_tpg_mutex
);
1727 mutex_unlock(&vhost_scsi_mutex
);
1732 * In order to ensure individual vhost-scsi configfs
1733 * groups cannot be removed while in use by vhost ioctl,
1734 * go ahead and take an explicit se_tpg->tpg_group.cg_item
1737 se_tpg
= &tpg
->se_tpg
;
1738 ret
= target_depend_item(&se_tpg
->tpg_group
.cg_item
);
1740 pr_warn("target_depend_item() failed: %d\n", ret
);
1741 mutex_unlock(&tpg
->tv_tpg_mutex
);
1742 mutex_unlock(&vhost_scsi_mutex
);
1745 tpg
->tv_tpg_vhost_count
++;
1746 tpg
->vhost_scsi
= vs
;
1747 vs_tpg
[tpg
->tport_tpgt
] = tpg
;
1750 mutex_unlock(&tpg
->tv_tpg_mutex
);
1752 mutex_unlock(&vhost_scsi_mutex
);
1755 memcpy(vs
->vs_vhost_wwpn
, t
->vhost_wwpn
,
1756 sizeof(vs
->vs_vhost_wwpn
));
1758 for (i
= VHOST_SCSI_VQ_IO
; i
< vs
->dev
.nvqs
; i
++) {
1759 vq
= &vs
->vqs
[i
].vq
;
1760 if (!vhost_vq_is_setup(vq
))
1763 ret
= vhost_scsi_setup_vq_cmds(vq
, vq
->num
);
1765 goto destroy_vq_cmds
;
1768 for (i
= 0; i
< vs
->dev
.nvqs
; i
++) {
1769 vq
= &vs
->vqs
[i
].vq
;
1770 mutex_lock(&vq
->mutex
);
1771 vhost_vq_set_backend(vq
, vs_tpg
);
1772 vhost_vq_init_access(vq
);
1773 mutex_unlock(&vq
->mutex
);
1781 * Act as synchronize_rcu to make sure access to
1782 * old vs->vs_tpg is finished.
1784 vhost_scsi_flush(vs
);
1786 vs
->vs_tpg
= vs_tpg
;
1790 for (i
--; i
>= VHOST_SCSI_VQ_IO
; i
--) {
1791 if (!vhost_vq_get_backend(&vs
->vqs
[i
].vq
))
1792 vhost_scsi_destroy_vq_cmds(&vs
->vqs
[i
].vq
);
1795 for (i
= 0; i
< VHOST_SCSI_MAX_TARGET
; i
++) {
1798 mutex_lock(&tpg
->tv_tpg_mutex
);
1799 tpg
->vhost_scsi
= NULL
;
1800 tpg
->tv_tpg_vhost_count
--;
1801 mutex_unlock(&tpg
->tv_tpg_mutex
);
1802 target_undepend_item(&tpg
->se_tpg
.tpg_group
.cg_item
);
1807 mutex_unlock(&vs
->dev
.mutex
);
1812 vhost_scsi_clear_endpoint(struct vhost_scsi
*vs
,
1813 struct vhost_scsi_target
*t
)
1815 struct se_portal_group
*se_tpg
;
1816 struct vhost_scsi_tport
*tv_tport
;
1817 struct vhost_scsi_tpg
*tpg
;
1818 struct vhost_virtqueue
*vq
;
1823 mutex_lock(&vs
->dev
.mutex
);
1824 /* Verify that ring has been setup correctly. */
1825 for (index
= 0; index
< vs
->dev
.nvqs
; ++index
) {
1826 if (!vhost_vq_access_ok(&vs
->vqs
[index
].vq
)) {
1837 for (i
= 0; i
< VHOST_SCSI_MAX_TARGET
; i
++) {
1839 tpg
= vs
->vs_tpg
[target
];
1843 tv_tport
= tpg
->tport
;
1849 if (strcmp(tv_tport
->tport_name
, t
->vhost_wwpn
)) {
1850 pr_warn("tv_tport->tport_name: %s, tpg->tport_tpgt: %hu"
1851 " does not match t->vhost_wwpn: %s, t->vhost_tpgt: %hu\n",
1852 tv_tport
->tport_name
, tpg
->tport_tpgt
,
1853 t
->vhost_wwpn
, t
->vhost_tpgt
);
1862 /* Prevent new cmds from starting and accessing the tpgs/sessions */
1863 for (i
= 0; i
< vs
->dev
.nvqs
; i
++) {
1864 vq
= &vs
->vqs
[i
].vq
;
1865 mutex_lock(&vq
->mutex
);
1866 vhost_vq_set_backend(vq
, NULL
);
1867 mutex_unlock(&vq
->mutex
);
1869 /* Make sure cmds are not running before tearing them down. */
1870 vhost_scsi_flush(vs
);
1872 for (i
= 0; i
< vs
->dev
.nvqs
; i
++) {
1873 vq
= &vs
->vqs
[i
].vq
;
1874 vhost_scsi_destroy_vq_cmds(vq
);
1878 * We can now release our hold on the tpg and sessions and userspace
1879 * can free them after this point.
1881 for (i
= 0; i
< VHOST_SCSI_MAX_TARGET
; i
++) {
1883 tpg
= vs
->vs_tpg
[target
];
1887 mutex_lock(&tpg
->tv_tpg_mutex
);
1889 tpg
->tv_tpg_vhost_count
--;
1890 tpg
->vhost_scsi
= NULL
;
1891 vs
->vs_tpg
[target
] = NULL
;
1893 mutex_unlock(&tpg
->tv_tpg_mutex
);
1895 se_tpg
= &tpg
->se_tpg
;
1896 target_undepend_item(&se_tpg
->tpg_group
.cg_item
);
1901 * Act as synchronize_rcu to make sure access to
1902 * old vs->vs_tpg is finished.
1904 vhost_scsi_flush(vs
);
1907 WARN_ON(vs
->vs_events_nr
);
1908 mutex_unlock(&vs
->dev
.mutex
);
1912 mutex_unlock(&vs
->dev
.mutex
);
1916 static int vhost_scsi_set_features(struct vhost_scsi
*vs
, u64 features
)
1918 struct vhost_virtqueue
*vq
;
1921 if (features
& ~VHOST_SCSI_FEATURES
)
1924 mutex_lock(&vs
->dev
.mutex
);
1925 if ((features
& (1 << VHOST_F_LOG_ALL
)) &&
1926 !vhost_log_access_ok(&vs
->dev
)) {
1927 mutex_unlock(&vs
->dev
.mutex
);
1931 for (i
= 0; i
< vs
->dev
.nvqs
; i
++) {
1932 vq
= &vs
->vqs
[i
].vq
;
1933 mutex_lock(&vq
->mutex
);
1934 vq
->acked_features
= features
;
1935 mutex_unlock(&vq
->mutex
);
1937 mutex_unlock(&vs
->dev
.mutex
);
1941 static int vhost_scsi_open(struct inode
*inode
, struct file
*f
)
1943 struct vhost_scsi_virtqueue
*svq
;
1944 struct vhost_scsi
*vs
;
1945 struct vhost_virtqueue
**vqs
;
1946 int r
= -ENOMEM
, i
, nvqs
= vhost_scsi_max_io_vqs
;
1948 vs
= kvzalloc(sizeof(*vs
), GFP_KERNEL
);
1952 if (nvqs
> VHOST_SCSI_MAX_IO_VQ
) {
1953 pr_err("Invalid max_io_vqs of %d. Using %d.\n", nvqs
,
1954 VHOST_SCSI_MAX_IO_VQ
);
1955 nvqs
= VHOST_SCSI_MAX_IO_VQ
;
1956 } else if (nvqs
== 0) {
1957 pr_err("Invalid max_io_vqs of %d. Using 1.\n", nvqs
);
1960 nvqs
+= VHOST_SCSI_VQ_IO
;
1962 vs
->old_inflight
= kmalloc_array(nvqs
, sizeof(*vs
->old_inflight
),
1963 GFP_KERNEL
| __GFP_ZERO
);
1964 if (!vs
->old_inflight
)
1967 vs
->vqs
= kmalloc_array(nvqs
, sizeof(*vs
->vqs
),
1968 GFP_KERNEL
| __GFP_ZERO
);
1972 vqs
= kmalloc_array(nvqs
, sizeof(*vqs
), GFP_KERNEL
);
1976 vhost_work_init(&vs
->vs_event_work
, vhost_scsi_evt_work
);
1978 vs
->vs_events_nr
= 0;
1979 vs
->vs_events_missed
= false;
1981 vqs
[VHOST_SCSI_VQ_CTL
] = &vs
->vqs
[VHOST_SCSI_VQ_CTL
].vq
;
1982 vqs
[VHOST_SCSI_VQ_EVT
] = &vs
->vqs
[VHOST_SCSI_VQ_EVT
].vq
;
1983 vs
->vqs
[VHOST_SCSI_VQ_CTL
].vq
.handle_kick
= vhost_scsi_ctl_handle_kick
;
1984 vs
->vqs
[VHOST_SCSI_VQ_EVT
].vq
.handle_kick
= vhost_scsi_evt_handle_kick
;
1985 for (i
= VHOST_SCSI_VQ_IO
; i
< nvqs
; i
++) {
1990 init_llist_head(&svq
->completion_list
);
1991 vhost_work_init(&svq
->completion_work
,
1992 vhost_scsi_complete_cmd_work
);
1993 svq
->vq
.handle_kick
= vhost_scsi_handle_kick
;
1995 vhost_dev_init(&vs
->dev
, vqs
, nvqs
, UIO_MAXIOV
,
1996 VHOST_SCSI_WEIGHT
, 0, true, NULL
);
1998 vhost_scsi_init_inflight(vs
, NULL
);
2000 f
->private_data
= vs
;
2006 kfree(vs
->old_inflight
);
2013 static int vhost_scsi_release(struct inode
*inode
, struct file
*f
)
2015 struct vhost_scsi
*vs
= f
->private_data
;
2016 struct vhost_scsi_target t
;
2018 mutex_lock(&vs
->dev
.mutex
);
2019 memcpy(t
.vhost_wwpn
, vs
->vs_vhost_wwpn
, sizeof(t
.vhost_wwpn
));
2020 mutex_unlock(&vs
->dev
.mutex
);
2021 vhost_scsi_clear_endpoint(vs
, &t
);
2022 vhost_dev_stop(&vs
->dev
);
2023 vhost_dev_cleanup(&vs
->dev
);
2026 kfree(vs
->old_inflight
);
2032 vhost_scsi_ioctl(struct file
*f
,
2036 struct vhost_scsi
*vs
= f
->private_data
;
2037 struct vhost_scsi_target backend
;
2038 void __user
*argp
= (void __user
*)arg
;
2039 u64 __user
*featurep
= argp
;
2040 u32 __user
*eventsp
= argp
;
2043 int r
, abi_version
= VHOST_SCSI_ABI_VERSION
;
2044 struct vhost_virtqueue
*vq
= &vs
->vqs
[VHOST_SCSI_VQ_EVT
].vq
;
2047 case VHOST_SCSI_SET_ENDPOINT
:
2048 if (copy_from_user(&backend
, argp
, sizeof backend
))
2050 if (backend
.reserved
!= 0)
2053 return vhost_scsi_set_endpoint(vs
, &backend
);
2054 case VHOST_SCSI_CLEAR_ENDPOINT
:
2055 if (copy_from_user(&backend
, argp
, sizeof backend
))
2057 if (backend
.reserved
!= 0)
2060 return vhost_scsi_clear_endpoint(vs
, &backend
);
2061 case VHOST_SCSI_GET_ABI_VERSION
:
2062 if (copy_to_user(argp
, &abi_version
, sizeof abi_version
))
2065 case VHOST_SCSI_SET_EVENTS_MISSED
:
2066 if (get_user(events_missed
, eventsp
))
2068 mutex_lock(&vq
->mutex
);
2069 vs
->vs_events_missed
= events_missed
;
2070 mutex_unlock(&vq
->mutex
);
2072 case VHOST_SCSI_GET_EVENTS_MISSED
:
2073 mutex_lock(&vq
->mutex
);
2074 events_missed
= vs
->vs_events_missed
;
2075 mutex_unlock(&vq
->mutex
);
2076 if (put_user(events_missed
, eventsp
))
2079 case VHOST_GET_FEATURES
:
2080 features
= VHOST_SCSI_FEATURES
;
2081 if (copy_to_user(featurep
, &features
, sizeof features
))
2084 case VHOST_SET_FEATURES
:
2085 if (copy_from_user(&features
, featurep
, sizeof features
))
2087 return vhost_scsi_set_features(vs
, features
);
2088 case VHOST_NEW_WORKER
:
2089 case VHOST_FREE_WORKER
:
2090 case VHOST_ATTACH_VRING_WORKER
:
2091 case VHOST_GET_VRING_WORKER
:
2092 mutex_lock(&vs
->dev
.mutex
);
2093 r
= vhost_worker_ioctl(&vs
->dev
, ioctl
, argp
);
2094 mutex_unlock(&vs
->dev
.mutex
);
2097 mutex_lock(&vs
->dev
.mutex
);
2098 r
= vhost_dev_ioctl(&vs
->dev
, ioctl
, argp
);
2099 /* TODO: flush backend after dev ioctl. */
2100 if (r
== -ENOIOCTLCMD
)
2101 r
= vhost_vring_ioctl(&vs
->dev
, ioctl
, argp
);
2102 mutex_unlock(&vs
->dev
.mutex
);
2107 static const struct file_operations vhost_scsi_fops
= {
2108 .owner
= THIS_MODULE
,
2109 .release
= vhost_scsi_release
,
2110 .unlocked_ioctl
= vhost_scsi_ioctl
,
2111 .compat_ioctl
= compat_ptr_ioctl
,
2112 .open
= vhost_scsi_open
,
2113 .llseek
= noop_llseek
,
2116 static struct miscdevice vhost_scsi_misc
= {
2122 static int __init
vhost_scsi_register(void)
2124 return misc_register(&vhost_scsi_misc
);
2127 static void vhost_scsi_deregister(void)
2129 misc_deregister(&vhost_scsi_misc
);
2132 static char *vhost_scsi_dump_proto_id(struct vhost_scsi_tport
*tport
)
2134 switch (tport
->tport_proto_id
) {
2135 case SCSI_PROTOCOL_SAS
:
2137 case SCSI_PROTOCOL_FCP
:
2139 case SCSI_PROTOCOL_ISCSI
:
2149 vhost_scsi_do_plug(struct vhost_scsi_tpg
*tpg
,
2150 struct se_lun
*lun
, bool plug
)
2153 struct vhost_scsi
*vs
= tpg
->vhost_scsi
;
2154 struct vhost_virtqueue
*vq
;
2161 reason
= VIRTIO_SCSI_EVT_RESET_RESCAN
;
2163 reason
= VIRTIO_SCSI_EVT_RESET_REMOVED
;
2165 vq
= &vs
->vqs
[VHOST_SCSI_VQ_EVT
].vq
;
2166 mutex_lock(&vq
->mutex
);
2168 * We can't queue events if the backend has been cleared, because
2169 * we could end up queueing an event after the flush.
2171 if (!vhost_vq_get_backend(vq
))
2174 if (vhost_has_feature(vq
, VIRTIO_SCSI_F_HOTPLUG
))
2175 vhost_scsi_send_evt(vs
, vq
, tpg
, lun
,
2176 VIRTIO_SCSI_T_TRANSPORT_RESET
, reason
);
2178 mutex_unlock(&vq
->mutex
);
2181 static void vhost_scsi_hotplug(struct vhost_scsi_tpg
*tpg
, struct se_lun
*lun
)
2183 vhost_scsi_do_plug(tpg
, lun
, true);
2186 static void vhost_scsi_hotunplug(struct vhost_scsi_tpg
*tpg
, struct se_lun
*lun
)
2188 vhost_scsi_do_plug(tpg
, lun
, false);
2191 static int vhost_scsi_port_link(struct se_portal_group
*se_tpg
,
2194 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
2195 struct vhost_scsi_tpg
, se_tpg
);
2197 mutex_lock(&tpg
->tv_tpg_mutex
);
2198 tpg
->tv_tpg_port_count
++;
2199 vhost_scsi_hotplug(tpg
, lun
);
2200 mutex_unlock(&tpg
->tv_tpg_mutex
);
2205 static void vhost_scsi_port_unlink(struct se_portal_group
*se_tpg
,
2208 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
2209 struct vhost_scsi_tpg
, se_tpg
);
2211 mutex_lock(&tpg
->tv_tpg_mutex
);
2212 tpg
->tv_tpg_port_count
--;
2213 vhost_scsi_hotunplug(tpg
, lun
);
2214 mutex_unlock(&tpg
->tv_tpg_mutex
);
2217 static ssize_t
vhost_scsi_tpg_attrib_fabric_prot_type_store(
2218 struct config_item
*item
, const char *page
, size_t count
)
2220 struct se_portal_group
*se_tpg
= attrib_to_tpg(item
);
2221 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
2222 struct vhost_scsi_tpg
, se_tpg
);
2224 int ret
= kstrtoul(page
, 0, &val
);
2227 pr_err("kstrtoul() returned %d for fabric_prot_type\n", ret
);
2230 if (val
!= 0 && val
!= 1 && val
!= 3) {
2231 pr_err("Invalid vhost_scsi fabric_prot_type: %lu\n", val
);
2234 tpg
->tv_fabric_prot_type
= val
;
2239 static ssize_t
vhost_scsi_tpg_attrib_fabric_prot_type_show(
2240 struct config_item
*item
, char *page
)
2242 struct se_portal_group
*se_tpg
= attrib_to_tpg(item
);
2243 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
2244 struct vhost_scsi_tpg
, se_tpg
);
2246 return sysfs_emit(page
, "%d\n", tpg
->tv_fabric_prot_type
);
2249 CONFIGFS_ATTR(vhost_scsi_tpg_attrib_
, fabric_prot_type
);
2251 static struct configfs_attribute
*vhost_scsi_tpg_attrib_attrs
[] = {
2252 &vhost_scsi_tpg_attrib_attr_fabric_prot_type
,
2256 static int vhost_scsi_make_nexus(struct vhost_scsi_tpg
*tpg
,
2259 struct vhost_scsi_nexus
*tv_nexus
;
2261 mutex_lock(&tpg
->tv_tpg_mutex
);
2262 if (tpg
->tpg_nexus
) {
2263 mutex_unlock(&tpg
->tv_tpg_mutex
);
2264 pr_debug("tpg->tpg_nexus already exists\n");
2268 tv_nexus
= kzalloc(sizeof(*tv_nexus
), GFP_KERNEL
);
2270 mutex_unlock(&tpg
->tv_tpg_mutex
);
2271 pr_err("Unable to allocate struct vhost_scsi_nexus\n");
2275 * Since we are running in 'demo mode' this call with generate a
2276 * struct se_node_acl for the vhost_scsi struct se_portal_group with
2277 * the SCSI Initiator port name of the passed configfs group 'name'.
2279 tv_nexus
->tvn_se_sess
= target_setup_session(&tpg
->se_tpg
, 0, 0,
2280 TARGET_PROT_DIN_PASS
| TARGET_PROT_DOUT_PASS
,
2281 (unsigned char *)name
, tv_nexus
, NULL
);
2282 if (IS_ERR(tv_nexus
->tvn_se_sess
)) {
2283 mutex_unlock(&tpg
->tv_tpg_mutex
);
2287 tpg
->tpg_nexus
= tv_nexus
;
2289 mutex_unlock(&tpg
->tv_tpg_mutex
);
2293 static int vhost_scsi_drop_nexus(struct vhost_scsi_tpg
*tpg
)
2295 struct se_session
*se_sess
;
2296 struct vhost_scsi_nexus
*tv_nexus
;
2298 mutex_lock(&tpg
->tv_tpg_mutex
);
2299 tv_nexus
= tpg
->tpg_nexus
;
2301 mutex_unlock(&tpg
->tv_tpg_mutex
);
2305 se_sess
= tv_nexus
->tvn_se_sess
;
2307 mutex_unlock(&tpg
->tv_tpg_mutex
);
2311 if (tpg
->tv_tpg_port_count
!= 0) {
2312 mutex_unlock(&tpg
->tv_tpg_mutex
);
2313 pr_err("Unable to remove TCM_vhost I_T Nexus with"
2314 " active TPG port count: %d\n",
2315 tpg
->tv_tpg_port_count
);
2319 if (tpg
->tv_tpg_vhost_count
!= 0) {
2320 mutex_unlock(&tpg
->tv_tpg_mutex
);
2321 pr_err("Unable to remove TCM_vhost I_T Nexus with"
2322 " active TPG vhost count: %d\n",
2323 tpg
->tv_tpg_vhost_count
);
2327 pr_debug("TCM_vhost_ConfigFS: Removing I_T Nexus to emulated"
2328 " %s Initiator Port: %s\n", vhost_scsi_dump_proto_id(tpg
->tport
),
2329 tv_nexus
->tvn_se_sess
->se_node_acl
->initiatorname
);
2332 * Release the SCSI I_T Nexus to the emulated vhost Target Port
2334 target_remove_session(se_sess
);
2335 tpg
->tpg_nexus
= NULL
;
2336 mutex_unlock(&tpg
->tv_tpg_mutex
);
2342 static ssize_t
vhost_scsi_tpg_nexus_show(struct config_item
*item
, char *page
)
2344 struct se_portal_group
*se_tpg
= to_tpg(item
);
2345 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
2346 struct vhost_scsi_tpg
, se_tpg
);
2347 struct vhost_scsi_nexus
*tv_nexus
;
2350 mutex_lock(&tpg
->tv_tpg_mutex
);
2351 tv_nexus
= tpg
->tpg_nexus
;
2353 mutex_unlock(&tpg
->tv_tpg_mutex
);
2356 ret
= sysfs_emit(page
, "%s\n",
2357 tv_nexus
->tvn_se_sess
->se_node_acl
->initiatorname
);
2358 mutex_unlock(&tpg
->tv_tpg_mutex
);
2363 static ssize_t
vhost_scsi_tpg_nexus_store(struct config_item
*item
,
2364 const char *page
, size_t count
)
2366 struct se_portal_group
*se_tpg
= to_tpg(item
);
2367 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
2368 struct vhost_scsi_tpg
, se_tpg
);
2369 struct vhost_scsi_tport
*tport_wwn
= tpg
->tport
;
2370 unsigned char i_port
[VHOST_SCSI_NAMELEN
], *ptr
, *port_ptr
;
2373 * Shutdown the active I_T nexus if 'NULL' is passed..
2375 if (!strncmp(page
, "NULL", 4)) {
2376 ret
= vhost_scsi_drop_nexus(tpg
);
2377 return (!ret
) ? count
: ret
;
2380 * Otherwise make sure the passed virtual Initiator port WWN matches
2381 * the fabric protocol_id set in vhost_scsi_make_tport(), and call
2382 * vhost_scsi_make_nexus().
2384 if (strlen(page
) >= VHOST_SCSI_NAMELEN
) {
2385 pr_err("Emulated NAA Sas Address: %s, exceeds"
2386 " max: %d\n", page
, VHOST_SCSI_NAMELEN
);
2389 snprintf(&i_port
[0], VHOST_SCSI_NAMELEN
, "%s", page
);
2391 ptr
= strstr(i_port
, "naa.");
2393 if (tport_wwn
->tport_proto_id
!= SCSI_PROTOCOL_SAS
) {
2394 pr_err("Passed SAS Initiator Port %s does not"
2395 " match target port protoid: %s\n", i_port
,
2396 vhost_scsi_dump_proto_id(tport_wwn
));
2399 port_ptr
= &i_port
[0];
2402 ptr
= strstr(i_port
, "fc.");
2404 if (tport_wwn
->tport_proto_id
!= SCSI_PROTOCOL_FCP
) {
2405 pr_err("Passed FCP Initiator Port %s does not"
2406 " match target port protoid: %s\n", i_port
,
2407 vhost_scsi_dump_proto_id(tport_wwn
));
2410 port_ptr
= &i_port
[3]; /* Skip over "fc." */
2413 ptr
= strstr(i_port
, "iqn.");
2415 if (tport_wwn
->tport_proto_id
!= SCSI_PROTOCOL_ISCSI
) {
2416 pr_err("Passed iSCSI Initiator Port %s does not"
2417 " match target port protoid: %s\n", i_port
,
2418 vhost_scsi_dump_proto_id(tport_wwn
));
2421 port_ptr
= &i_port
[0];
2424 pr_err("Unable to locate prefix for emulated Initiator Port:"
2428 * Clear any trailing newline for the NAA WWN
2431 if (i_port
[strlen(i_port
)-1] == '\n')
2432 i_port
[strlen(i_port
)-1] = '\0';
2434 ret
= vhost_scsi_make_nexus(tpg
, port_ptr
);
2441 CONFIGFS_ATTR(vhost_scsi_tpg_
, nexus
);
2443 static struct configfs_attribute
*vhost_scsi_tpg_attrs
[] = {
2444 &vhost_scsi_tpg_attr_nexus
,
2448 static struct se_portal_group
*
2449 vhost_scsi_make_tpg(struct se_wwn
*wwn
, const char *name
)
2451 struct vhost_scsi_tport
*tport
= container_of(wwn
,
2452 struct vhost_scsi_tport
, tport_wwn
);
2454 struct vhost_scsi_tpg
*tpg
;
2458 if (strstr(name
, "tpgt_") != name
)
2459 return ERR_PTR(-EINVAL
);
2460 if (kstrtou16(name
+ 5, 10, &tpgt
) || tpgt
>= VHOST_SCSI_MAX_TARGET
)
2461 return ERR_PTR(-EINVAL
);
2463 tpg
= kzalloc(sizeof(*tpg
), GFP_KERNEL
);
2465 pr_err("Unable to allocate struct vhost_scsi_tpg");
2466 return ERR_PTR(-ENOMEM
);
2468 mutex_init(&tpg
->tv_tpg_mutex
);
2469 INIT_LIST_HEAD(&tpg
->tv_tpg_list
);
2471 tpg
->tport_tpgt
= tpgt
;
2473 ret
= core_tpg_register(wwn
, &tpg
->se_tpg
, tport
->tport_proto_id
);
2478 mutex_lock(&vhost_scsi_mutex
);
2479 list_add_tail(&tpg
->tv_tpg_list
, &vhost_scsi_list
);
2480 mutex_unlock(&vhost_scsi_mutex
);
2482 return &tpg
->se_tpg
;
2485 static void vhost_scsi_drop_tpg(struct se_portal_group
*se_tpg
)
2487 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
2488 struct vhost_scsi_tpg
, se_tpg
);
2490 mutex_lock(&vhost_scsi_mutex
);
2491 list_del(&tpg
->tv_tpg_list
);
2492 mutex_unlock(&vhost_scsi_mutex
);
2494 * Release the virtual I_T Nexus for this vhost TPG
2496 vhost_scsi_drop_nexus(tpg
);
2498 * Deregister the se_tpg from TCM..
2500 core_tpg_deregister(se_tpg
);
2504 static struct se_wwn
*
2505 vhost_scsi_make_tport(struct target_fabric_configfs
*tf
,
2506 struct config_group
*group
,
2509 struct vhost_scsi_tport
*tport
;
2514 /* if (vhost_scsi_parse_wwn(name, &wwpn, 1) < 0)
2515 return ERR_PTR(-EINVAL); */
2517 tport
= kzalloc(sizeof(*tport
), GFP_KERNEL
);
2519 pr_err("Unable to allocate struct vhost_scsi_tport");
2520 return ERR_PTR(-ENOMEM
);
2522 tport
->tport_wwpn
= wwpn
;
2524 * Determine the emulated Protocol Identifier and Target Port Name
2525 * based on the incoming configfs directory name.
2527 ptr
= strstr(name
, "naa.");
2529 tport
->tport_proto_id
= SCSI_PROTOCOL_SAS
;
2532 ptr
= strstr(name
, "fc.");
2534 tport
->tport_proto_id
= SCSI_PROTOCOL_FCP
;
2535 off
= 3; /* Skip over "fc." */
2538 ptr
= strstr(name
, "iqn.");
2540 tport
->tport_proto_id
= SCSI_PROTOCOL_ISCSI
;
2544 pr_err("Unable to locate prefix for emulated Target Port:"
2547 return ERR_PTR(-EINVAL
);
2550 if (strlen(name
) >= VHOST_SCSI_NAMELEN
) {
2551 pr_err("Emulated %s Address: %s, exceeds"
2552 " max: %d\n", name
, vhost_scsi_dump_proto_id(tport
),
2553 VHOST_SCSI_NAMELEN
);
2555 return ERR_PTR(-EINVAL
);
2557 snprintf(&tport
->tport_name
[0], VHOST_SCSI_NAMELEN
, "%s", &name
[off
]);
2559 pr_debug("TCM_VHost_ConfigFS: Allocated emulated Target"
2560 " %s Address: %s\n", vhost_scsi_dump_proto_id(tport
), name
);
2562 return &tport
->tport_wwn
;
2565 static void vhost_scsi_drop_tport(struct se_wwn
*wwn
)
2567 struct vhost_scsi_tport
*tport
= container_of(wwn
,
2568 struct vhost_scsi_tport
, tport_wwn
);
2570 pr_debug("TCM_VHost_ConfigFS: Deallocating emulated Target"
2571 " %s Address: %s\n", vhost_scsi_dump_proto_id(tport
),
2578 vhost_scsi_wwn_version_show(struct config_item
*item
, char *page
)
2580 return sysfs_emit(page
, "TCM_VHOST fabric module %s on %s/%s"
2581 "on "UTS_RELEASE
"\n", VHOST_SCSI_VERSION
, utsname()->sysname
,
2582 utsname()->machine
);
2585 CONFIGFS_ATTR_RO(vhost_scsi_wwn_
, version
);
2587 static struct configfs_attribute
*vhost_scsi_wwn_attrs
[] = {
2588 &vhost_scsi_wwn_attr_version
,
2592 static const struct target_core_fabric_ops vhost_scsi_ops
= {
2593 .module
= THIS_MODULE
,
2594 .fabric_name
= "vhost",
2595 .max_data_sg_nents
= VHOST_SCSI_PREALLOC_SGLS
,
2596 .tpg_get_wwn
= vhost_scsi_get_fabric_wwn
,
2597 .tpg_get_tag
= vhost_scsi_get_tpgt
,
2598 .tpg_check_demo_mode
= vhost_scsi_check_true
,
2599 .tpg_check_demo_mode_cache
= vhost_scsi_check_true
,
2600 .tpg_check_prot_fabric_only
= vhost_scsi_check_prot_fabric_only
,
2601 .release_cmd
= vhost_scsi_release_cmd
,
2602 .check_stop_free
= vhost_scsi_check_stop_free
,
2603 .sess_get_initiator_sid
= NULL
,
2604 .write_pending
= vhost_scsi_write_pending
,
2605 .queue_data_in
= vhost_scsi_queue_data_in
,
2606 .queue_status
= vhost_scsi_queue_status
,
2607 .queue_tm_rsp
= vhost_scsi_queue_tm_rsp
,
2608 .aborted_task
= vhost_scsi_aborted_task
,
2610 * Setup callers for generic logic in target_core_fabric_configfs.c
2612 .fabric_make_wwn
= vhost_scsi_make_tport
,
2613 .fabric_drop_wwn
= vhost_scsi_drop_tport
,
2614 .fabric_make_tpg
= vhost_scsi_make_tpg
,
2615 .fabric_drop_tpg
= vhost_scsi_drop_tpg
,
2616 .fabric_post_link
= vhost_scsi_port_link
,
2617 .fabric_pre_unlink
= vhost_scsi_port_unlink
,
2619 .tfc_wwn_attrs
= vhost_scsi_wwn_attrs
,
2620 .tfc_tpg_base_attrs
= vhost_scsi_tpg_attrs
,
2621 .tfc_tpg_attrib_attrs
= vhost_scsi_tpg_attrib_attrs
,
2623 .default_submit_type
= TARGET_QUEUE_SUBMIT
,
2624 .direct_submit_supp
= 1,
2627 static int __init
vhost_scsi_init(void)
2631 pr_debug("TCM_VHOST fabric module %s on %s/%s"
2632 " on "UTS_RELEASE
"\n", VHOST_SCSI_VERSION
, utsname()->sysname
,
2633 utsname()->machine
);
2635 ret
= vhost_scsi_register();
2639 ret
= target_register_template(&vhost_scsi_ops
);
2641 goto out_vhost_scsi_deregister
;
2645 out_vhost_scsi_deregister
:
2646 vhost_scsi_deregister();
2651 static void vhost_scsi_exit(void)
2653 target_unregister_template(&vhost_scsi_ops
);
2654 vhost_scsi_deregister();
2657 MODULE_DESCRIPTION("VHOST_SCSI series fabric driver");
2658 MODULE_ALIAS("tcm_vhost");
2659 MODULE_LICENSE("GPL");
2660 module_init(vhost_scsi_init
);
2661 module_exit(vhost_scsi_exit
);