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 <asm/unaligned.h>
29 #include <scsi/scsi_common.h>
30 #include <scsi/scsi_proto.h>
31 #include <target/target_core_base.h>
32 #include <target/target_core_fabric.h>
33 #include <linux/vhost.h>
34 #include <linux/virtio_scsi.h>
35 #include <linux/llist.h>
36 #include <linux/bitmap.h>
40 #define VHOST_SCSI_VERSION "v0.1"
41 #define VHOST_SCSI_NAMELEN 256
42 #define VHOST_SCSI_MAX_CDB_SIZE 32
43 #define VHOST_SCSI_PREALLOC_SGLS 2048
44 #define VHOST_SCSI_PREALLOC_UPAGES 2048
45 #define VHOST_SCSI_PREALLOC_PROT_SGLS 2048
47 /* Max number of requests before requeueing the job.
48 * Using this limit prevents one virtqueue from starving others with
51 #define VHOST_SCSI_WEIGHT 256
53 struct vhost_scsi_inflight {
54 /* Wait for the flush operation to finish */
55 struct completion comp;
56 /* Refcount for the inflight reqs */
60 struct vhost_scsi_cmd {
61 /* Descriptor from vhost_get_vq_desc() for virt_queue segment */
63 /* virtio-scsi initiator task attribute */
65 /* virtio-scsi response incoming iovecs */
67 /* virtio-scsi initiator data direction */
68 enum dma_data_direction tvc_data_direction;
69 /* Expected data transfer length from virtio-scsi header */
71 /* The Tag from include/linux/virtio_scsi.h:struct virtio_scsi_cmd_req */
73 /* The number of scatterlists associated with this cmd */
75 u32 tvc_prot_sgl_count;
76 /* Saved unpacked SCSI LUN for vhost_scsi_target_queue_cmd() */
78 /* Pointer to the SGL formatted memory from virtio-scsi */
79 struct scatterlist *tvc_sgl;
80 struct scatterlist *tvc_prot_sgl;
81 struct page **tvc_upages;
82 /* Pointer to response header iovec */
83 struct iovec *tvc_resp_iov;
84 /* Pointer to vhost_scsi for our device */
85 struct vhost_scsi *tvc_vhost;
86 /* Pointer to vhost_virtqueue for the cmd */
87 struct vhost_virtqueue *tvc_vq;
88 /* Pointer to vhost nexus memory */
89 struct vhost_scsi_nexus *tvc_nexus;
90 /* The TCM I/O descriptor that is accessed via container_of() */
91 struct se_cmd tvc_se_cmd;
92 /* Copy of the incoming SCSI command descriptor block (CDB) */
93 unsigned char tvc_cdb[VHOST_SCSI_MAX_CDB_SIZE];
94 /* Sense buffer that will be mapped into outgoing status */
95 unsigned char tvc_sense_buf[TRANSPORT_SENSE_BUFFER];
96 /* Completed commands list, serviced from vhost worker thread */
97 struct llist_node tvc_completion_list;
98 /* Used to track inflight cmd */
99 struct vhost_scsi_inflight *inflight;
102 struct vhost_scsi_nexus {
103 /* Pointer to TCM session for I_T Nexus */
104 struct se_session *tvn_se_sess;
107 struct vhost_scsi_tpg {
108 /* Vhost port target portal group tag for TCM */
110 /* Used to track number of TPG Port/Lun Links wrt to explict I_T Nexus shutdown */
111 int tv_tpg_port_count;
112 /* Used for vhost_scsi device reference to tpg_nexus, protected by tv_tpg_mutex */
113 int tv_tpg_vhost_count;
114 /* Used for enabling T10-PI with legacy devices */
115 int tv_fabric_prot_type;
116 /* list for vhost_scsi_list */
117 struct list_head tv_tpg_list;
118 /* Used to protect access for tpg_nexus */
119 struct mutex tv_tpg_mutex;
120 /* Pointer to the TCM VHost I_T Nexus for this TPG endpoint */
121 struct vhost_scsi_nexus *tpg_nexus;
122 /* Pointer back to vhost_scsi_tport */
123 struct vhost_scsi_tport *tport;
124 /* Returned by vhost_scsi_make_tpg() */
125 struct se_portal_group se_tpg;
126 /* Pointer back to vhost_scsi, protected by tv_tpg_mutex */
127 struct vhost_scsi *vhost_scsi;
130 struct vhost_scsi_tport {
131 /* SCSI protocol the tport is providing */
133 /* Binary World Wide unique Port Name for Vhost Target port */
135 /* ASCII formatted WWPN for Vhost Target port */
136 char tport_name[VHOST_SCSI_NAMELEN];
137 /* Returned by vhost_scsi_make_tport() */
138 struct se_wwn tport_wwn;
141 struct vhost_scsi_evt {
142 /* event to be sent to guest */
143 struct virtio_scsi_event event;
144 /* event list, serviced from vhost worker thread */
145 struct llist_node list;
149 VHOST_SCSI_VQ_CTL = 0,
150 VHOST_SCSI_VQ_EVT = 1,
151 VHOST_SCSI_VQ_IO = 2,
154 /* Note: can't set VIRTIO_F_VERSION_1 yet, since that implies ANY_LAYOUT. */
156 VHOST_SCSI_FEATURES = VHOST_FEATURES | (1ULL << VIRTIO_SCSI_F_HOTPLUG) |
157 (1ULL << VIRTIO_SCSI_F_T10_PI)
160 #define VHOST_SCSI_MAX_TARGET 256
161 #define VHOST_SCSI_MAX_IO_VQ 1024
162 #define VHOST_SCSI_MAX_EVENT 128
164 static unsigned vhost_scsi_max_io_vqs = 128;
165 module_param_named(max_io_vqs, vhost_scsi_max_io_vqs, uint, 0644);
166 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.");
168 struct vhost_scsi_virtqueue {
169 struct vhost_virtqueue vq;
171 * Reference counting for inflight reqs, used for flush operation. At
172 * each time, one reference tracks new commands submitted, while we
173 * wait for another one to reach 0.
175 struct vhost_scsi_inflight inflights[2];
177 * Indicate current inflight in use, protected by vq->mutex.
178 * Writers must also take dev mutex and flush under it.
181 struct vhost_scsi_cmd *scsi_cmds;
182 struct sbitmap scsi_tags;
187 /* Protected by vhost_scsi->dev.mutex */
188 struct vhost_scsi_tpg **vs_tpg;
189 char vs_vhost_wwpn[TRANSPORT_IQN_LEN];
191 struct vhost_dev dev;
192 struct vhost_scsi_virtqueue *vqs;
193 unsigned long *compl_bitmap;
194 struct vhost_scsi_inflight **old_inflight;
196 struct vhost_work vs_completion_work; /* cmd completion work item */
197 struct llist_head vs_completion_list; /* cmd completion queue */
199 struct vhost_work vs_event_work; /* evt injection work item */
200 struct llist_head vs_event_list; /* evt injection queue */
202 bool vs_events_missed; /* any missed events, protected by vq->mutex */
203 int vs_events_nr; /* num of pending events, protected by vq->mutex */
206 struct vhost_scsi_tmf {
207 struct vhost_work vwork;
208 struct vhost_scsi *vhost;
209 struct vhost_scsi_virtqueue *svq;
211 struct se_cmd se_cmd;
213 struct vhost_scsi_inflight *inflight;
214 struct iovec resp_iov;
220 * Context for processing request and control queue operations.
222 struct vhost_scsi_ctx {
224 unsigned int out, in;
225 size_t req_size, rsp_size;
226 size_t out_size, in_size;
229 struct iov_iter out_iter;
232 /* Global spinlock to protect vhost_scsi TPG list for vhost IOCTL access */
233 static DEFINE_MUTEX(vhost_scsi_mutex);
234 static LIST_HEAD(vhost_scsi_list);
236 static void vhost_scsi_done_inflight(struct kref *kref)
238 struct vhost_scsi_inflight *inflight;
240 inflight = container_of(kref, struct vhost_scsi_inflight, kref);
241 complete(&inflight->comp);
244 static void vhost_scsi_init_inflight(struct vhost_scsi *vs,
245 struct vhost_scsi_inflight *old_inflight[])
247 struct vhost_scsi_inflight *new_inflight;
248 struct vhost_virtqueue *vq;
251 for (i = 0; i < vs->dev.nvqs; i++) {
254 mutex_lock(&vq->mutex);
256 /* store old infight */
257 idx = vs->vqs[i].inflight_idx;
259 old_inflight[i] = &vs->vqs[i].inflights[idx];
261 /* setup new infight */
262 vs->vqs[i].inflight_idx = idx ^ 1;
263 new_inflight = &vs->vqs[i].inflights[idx ^ 1];
264 kref_init(&new_inflight->kref);
265 init_completion(&new_inflight->comp);
267 mutex_unlock(&vq->mutex);
271 static struct vhost_scsi_inflight *
272 vhost_scsi_get_inflight(struct vhost_virtqueue *vq)
274 struct vhost_scsi_inflight *inflight;
275 struct vhost_scsi_virtqueue *svq;
277 svq = container_of(vq, struct vhost_scsi_virtqueue, vq);
278 inflight = &svq->inflights[svq->inflight_idx];
279 kref_get(&inflight->kref);
284 static void vhost_scsi_put_inflight(struct vhost_scsi_inflight *inflight)
286 kref_put(&inflight->kref, vhost_scsi_done_inflight);
289 static int vhost_scsi_check_true(struct se_portal_group *se_tpg)
294 static char *vhost_scsi_get_fabric_wwn(struct se_portal_group *se_tpg)
296 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
297 struct vhost_scsi_tpg, se_tpg);
298 struct vhost_scsi_tport *tport = tpg->tport;
300 return &tport->tport_name[0];
303 static u16 vhost_scsi_get_tpgt(struct se_portal_group *se_tpg)
305 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
306 struct vhost_scsi_tpg, se_tpg);
307 return tpg->tport_tpgt;
310 static int vhost_scsi_check_prot_fabric_only(struct se_portal_group *se_tpg)
312 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
313 struct vhost_scsi_tpg, se_tpg);
315 return tpg->tv_fabric_prot_type;
318 static void vhost_scsi_release_cmd_res(struct se_cmd *se_cmd)
320 struct vhost_scsi_cmd *tv_cmd = container_of(se_cmd,
321 struct vhost_scsi_cmd, tvc_se_cmd);
322 struct vhost_scsi_virtqueue *svq = container_of(tv_cmd->tvc_vq,
323 struct vhost_scsi_virtqueue, vq);
324 struct vhost_scsi_inflight *inflight = tv_cmd->inflight;
327 if (tv_cmd->tvc_sgl_count) {
328 for (i = 0; i < tv_cmd->tvc_sgl_count; i++)
329 put_page(sg_page(&tv_cmd->tvc_sgl[i]));
331 if (tv_cmd->tvc_prot_sgl_count) {
332 for (i = 0; i < tv_cmd->tvc_prot_sgl_count; i++)
333 put_page(sg_page(&tv_cmd->tvc_prot_sgl[i]));
336 sbitmap_clear_bit(&svq->scsi_tags, se_cmd->map_tag);
337 vhost_scsi_put_inflight(inflight);
340 static void vhost_scsi_release_tmf_res(struct vhost_scsi_tmf *tmf)
342 struct vhost_scsi_inflight *inflight = tmf->inflight;
345 vhost_scsi_put_inflight(inflight);
348 static void vhost_scsi_release_cmd(struct se_cmd *se_cmd)
350 if (se_cmd->se_cmd_flags & SCF_SCSI_TMR_CDB) {
351 struct vhost_scsi_tmf *tmf = container_of(se_cmd,
352 struct vhost_scsi_tmf, se_cmd);
354 vhost_work_queue(&tmf->vhost->dev, &tmf->vwork);
356 struct vhost_scsi_cmd *cmd = container_of(se_cmd,
357 struct vhost_scsi_cmd, tvc_se_cmd);
358 struct vhost_scsi *vs = cmd->tvc_vhost;
360 llist_add(&cmd->tvc_completion_list, &vs->vs_completion_list);
361 vhost_work_queue(&vs->dev, &vs->vs_completion_work);
365 static int vhost_scsi_write_pending(struct se_cmd *se_cmd)
367 /* Go ahead and process the write immediately */
368 target_execute_cmd(se_cmd);
372 static int vhost_scsi_queue_data_in(struct se_cmd *se_cmd)
374 transport_generic_free_cmd(se_cmd, 0);
378 static int vhost_scsi_queue_status(struct se_cmd *se_cmd)
380 transport_generic_free_cmd(se_cmd, 0);
384 static void vhost_scsi_queue_tm_rsp(struct se_cmd *se_cmd)
386 struct vhost_scsi_tmf *tmf = container_of(se_cmd, struct vhost_scsi_tmf,
389 tmf->scsi_resp = se_cmd->se_tmr_req->response;
390 transport_generic_free_cmd(&tmf->se_cmd, 0);
393 static void vhost_scsi_aborted_task(struct se_cmd *se_cmd)
398 static void vhost_scsi_free_evt(struct vhost_scsi *vs, struct vhost_scsi_evt *evt)
404 static struct vhost_scsi_evt *
405 vhost_scsi_allocate_evt(struct vhost_scsi *vs,
406 u32 event, u32 reason)
408 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
409 struct vhost_scsi_evt *evt;
411 if (vs->vs_events_nr > VHOST_SCSI_MAX_EVENT) {
412 vs->vs_events_missed = true;
416 evt = kzalloc(sizeof(*evt), GFP_KERNEL);
418 vq_err(vq, "Failed to allocate vhost_scsi_evt\n");
419 vs->vs_events_missed = true;
423 evt->event.event = cpu_to_vhost32(vq, event);
424 evt->event.reason = cpu_to_vhost32(vq, reason);
430 static int vhost_scsi_check_stop_free(struct se_cmd *se_cmd)
432 return target_put_sess_cmd(se_cmd);
436 vhost_scsi_do_evt_work(struct vhost_scsi *vs, struct vhost_scsi_evt *evt)
438 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
439 struct virtio_scsi_event *event = &evt->event;
440 struct virtio_scsi_event __user *eventp;
444 if (!vhost_vq_get_backend(vq)) {
445 vs->vs_events_missed = true;
450 vhost_disable_notify(&vs->dev, vq);
451 head = vhost_get_vq_desc(vq, vq->iov,
452 ARRAY_SIZE(vq->iov), &out, &in,
455 vs->vs_events_missed = true;
458 if (head == vq->num) {
459 if (vhost_enable_notify(&vs->dev, vq))
461 vs->vs_events_missed = true;
465 if ((vq->iov[out].iov_len != sizeof(struct virtio_scsi_event))) {
466 vq_err(vq, "Expecting virtio_scsi_event, got %zu bytes\n",
467 vq->iov[out].iov_len);
468 vs->vs_events_missed = true;
472 if (vs->vs_events_missed) {
473 event->event |= cpu_to_vhost32(vq, VIRTIO_SCSI_T_EVENTS_MISSED);
474 vs->vs_events_missed = false;
477 eventp = vq->iov[out].iov_base;
478 ret = __copy_to_user(eventp, event, sizeof(*event));
480 vhost_add_used_and_signal(&vs->dev, vq, head, 0);
482 vq_err(vq, "Faulted on vhost_scsi_send_event\n");
485 static void vhost_scsi_evt_work(struct vhost_work *work)
487 struct vhost_scsi *vs = container_of(work, struct vhost_scsi,
489 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
490 struct vhost_scsi_evt *evt, *t;
491 struct llist_node *llnode;
493 mutex_lock(&vq->mutex);
494 llnode = llist_del_all(&vs->vs_event_list);
495 llist_for_each_entry_safe(evt, t, llnode, list) {
496 vhost_scsi_do_evt_work(vs, evt);
497 vhost_scsi_free_evt(vs, evt);
499 mutex_unlock(&vq->mutex);
502 /* Fill in status and signal that we are done processing this command
504 * This is scheduled in the vhost work queue so we are called with the owner
505 * process mm and can access the vring.
507 static void vhost_scsi_complete_cmd_work(struct vhost_work *work)
509 struct vhost_scsi *vs = container_of(work, struct vhost_scsi,
511 struct virtio_scsi_cmd_resp v_rsp;
512 struct vhost_scsi_cmd *cmd, *t;
513 struct llist_node *llnode;
514 struct se_cmd *se_cmd;
515 struct iov_iter iov_iter;
518 bitmap_zero(vs->compl_bitmap, vs->dev.nvqs);
519 llnode = llist_del_all(&vs->vs_completion_list);
520 llist_for_each_entry_safe(cmd, t, llnode, tvc_completion_list) {
521 se_cmd = &cmd->tvc_se_cmd;
523 pr_debug("%s tv_cmd %p resid %u status %#02x\n", __func__,
524 cmd, se_cmd->residual_count, se_cmd->scsi_status);
526 memset(&v_rsp, 0, sizeof(v_rsp));
527 v_rsp.resid = cpu_to_vhost32(cmd->tvc_vq, se_cmd->residual_count);
528 /* TODO is status_qualifier field needed? */
529 v_rsp.status = se_cmd->scsi_status;
530 v_rsp.sense_len = cpu_to_vhost32(cmd->tvc_vq,
531 se_cmd->scsi_sense_length);
532 memcpy(v_rsp.sense, cmd->tvc_sense_buf,
533 se_cmd->scsi_sense_length);
535 iov_iter_init(&iov_iter, ITER_DEST, cmd->tvc_resp_iov,
536 cmd->tvc_in_iovs, sizeof(v_rsp));
537 ret = copy_to_iter(&v_rsp, sizeof(v_rsp), &iov_iter);
538 if (likely(ret == sizeof(v_rsp))) {
539 struct vhost_scsi_virtqueue *q;
540 vhost_add_used(cmd->tvc_vq, cmd->tvc_vq_desc, 0);
541 q = container_of(cmd->tvc_vq, struct vhost_scsi_virtqueue, vq);
543 __set_bit(vq, vs->compl_bitmap);
545 pr_err("Faulted on virtio_scsi_cmd_resp\n");
547 vhost_scsi_release_cmd_res(se_cmd);
551 while ((vq = find_next_bit(vs->compl_bitmap, vs->dev.nvqs, vq + 1))
553 vhost_signal(&vs->dev, &vs->vqs[vq].vq);
556 static struct vhost_scsi_cmd *
557 vhost_scsi_get_cmd(struct vhost_virtqueue *vq, struct vhost_scsi_tpg *tpg,
558 unsigned char *cdb, u64 scsi_tag, u16 lun, u8 task_attr,
559 u32 exp_data_len, int data_direction)
561 struct vhost_scsi_virtqueue *svq = container_of(vq,
562 struct vhost_scsi_virtqueue, vq);
563 struct vhost_scsi_cmd *cmd;
564 struct vhost_scsi_nexus *tv_nexus;
565 struct scatterlist *sg, *prot_sg;
566 struct iovec *tvc_resp_iov;
570 tv_nexus = tpg->tpg_nexus;
572 pr_err("Unable to locate active struct vhost_scsi_nexus\n");
573 return ERR_PTR(-EIO);
576 tag = sbitmap_get(&svq->scsi_tags);
578 pr_err("Unable to obtain tag for vhost_scsi_cmd\n");
579 return ERR_PTR(-ENOMEM);
582 cmd = &svq->scsi_cmds[tag];
584 prot_sg = cmd->tvc_prot_sgl;
585 pages = cmd->tvc_upages;
586 tvc_resp_iov = cmd->tvc_resp_iov;
587 memset(cmd, 0, sizeof(*cmd));
589 cmd->tvc_prot_sgl = prot_sg;
590 cmd->tvc_upages = pages;
591 cmd->tvc_se_cmd.map_tag = tag;
592 cmd->tvc_tag = scsi_tag;
594 cmd->tvc_task_attr = task_attr;
595 cmd->tvc_exp_data_len = exp_data_len;
596 cmd->tvc_data_direction = data_direction;
597 cmd->tvc_nexus = tv_nexus;
598 cmd->inflight = vhost_scsi_get_inflight(vq);
599 cmd->tvc_resp_iov = tvc_resp_iov;
601 memcpy(cmd->tvc_cdb, cdb, VHOST_SCSI_MAX_CDB_SIZE);
607 * Map a user memory range into a scatterlist
609 * Returns the number of scatterlist entries used or -errno on error.
612 vhost_scsi_map_to_sgl(struct vhost_scsi_cmd *cmd,
613 struct iov_iter *iter,
614 struct scatterlist *sgl,
617 struct page **pages = cmd->tvc_upages;
618 struct scatterlist *sg = sgl;
621 unsigned int npages = 0;
623 bytes = iov_iter_get_pages2(iter, pages, LONG_MAX,
624 VHOST_SCSI_PREALLOC_UPAGES, &offset);
625 /* No pages were pinned */
627 return bytes < 0 ? bytes : -EFAULT;
630 unsigned n = min_t(unsigned, PAGE_SIZE - offset, bytes);
631 sg_set_page(sg++, pages[npages++], n, offset);
639 vhost_scsi_calc_sgls(struct iov_iter *iter, size_t bytes, int max_sgls)
643 if (!iter || !iter_iov(iter)) {
644 pr_err("%s: iter->iov is NULL, but expected bytes: %zu"
645 " present\n", __func__, bytes);
649 sgl_count = iov_iter_npages(iter, 0xffff);
650 if (sgl_count > max_sgls) {
651 pr_err("%s: requested sgl_count: %d exceeds pre-allocated"
652 " max_sgls: %d\n", __func__, sgl_count, max_sgls);
659 vhost_scsi_iov_to_sgl(struct vhost_scsi_cmd *cmd, bool write,
660 struct iov_iter *iter,
661 struct scatterlist *sg, int sg_count)
663 struct scatterlist *p = sg;
666 while (iov_iter_count(iter)) {
667 ret = vhost_scsi_map_to_sgl(cmd, iter, sg, write);
670 struct page *page = sg_page(p++);
682 vhost_scsi_mapal(struct vhost_scsi_cmd *cmd,
683 size_t prot_bytes, struct iov_iter *prot_iter,
684 size_t data_bytes, struct iov_iter *data_iter)
687 bool write = (cmd->tvc_data_direction == DMA_FROM_DEVICE);
690 sgl_count = vhost_scsi_calc_sgls(prot_iter, prot_bytes,
691 VHOST_SCSI_PREALLOC_PROT_SGLS);
695 sg_init_table(cmd->tvc_prot_sgl, sgl_count);
696 cmd->tvc_prot_sgl_count = sgl_count;
697 pr_debug("%s prot_sg %p prot_sgl_count %u\n", __func__,
698 cmd->tvc_prot_sgl, cmd->tvc_prot_sgl_count);
700 ret = vhost_scsi_iov_to_sgl(cmd, write, prot_iter,
702 cmd->tvc_prot_sgl_count);
704 cmd->tvc_prot_sgl_count = 0;
708 sgl_count = vhost_scsi_calc_sgls(data_iter, data_bytes,
709 VHOST_SCSI_PREALLOC_SGLS);
713 sg_init_table(cmd->tvc_sgl, sgl_count);
714 cmd->tvc_sgl_count = sgl_count;
715 pr_debug("%s data_sg %p data_sgl_count %u\n", __func__,
716 cmd->tvc_sgl, cmd->tvc_sgl_count);
718 ret = vhost_scsi_iov_to_sgl(cmd, write, data_iter,
719 cmd->tvc_sgl, cmd->tvc_sgl_count);
721 cmd->tvc_sgl_count = 0;
727 static int vhost_scsi_to_tcm_attr(int attr)
730 case VIRTIO_SCSI_S_SIMPLE:
731 return TCM_SIMPLE_TAG;
732 case VIRTIO_SCSI_S_ORDERED:
733 return TCM_ORDERED_TAG;
734 case VIRTIO_SCSI_S_HEAD:
736 case VIRTIO_SCSI_S_ACA:
741 return TCM_SIMPLE_TAG;
744 static void vhost_scsi_target_queue_cmd(struct vhost_scsi_cmd *cmd)
746 struct se_cmd *se_cmd = &cmd->tvc_se_cmd;
747 struct vhost_scsi_nexus *tv_nexus;
748 struct scatterlist *sg_ptr, *sg_prot_ptr = NULL;
750 /* FIXME: BIDI operation */
751 if (cmd->tvc_sgl_count) {
752 sg_ptr = cmd->tvc_sgl;
754 if (cmd->tvc_prot_sgl_count)
755 sg_prot_ptr = cmd->tvc_prot_sgl;
757 se_cmd->prot_pto = true;
761 tv_nexus = cmd->tvc_nexus;
764 target_init_cmd(se_cmd, tv_nexus->tvn_se_sess, &cmd->tvc_sense_buf[0],
765 cmd->tvc_lun, cmd->tvc_exp_data_len,
766 vhost_scsi_to_tcm_attr(cmd->tvc_task_attr),
767 cmd->tvc_data_direction, TARGET_SCF_ACK_KREF);
769 if (target_submit_prep(se_cmd, cmd->tvc_cdb, sg_ptr,
770 cmd->tvc_sgl_count, NULL, 0, sg_prot_ptr,
771 cmd->tvc_prot_sgl_count, GFP_KERNEL))
774 target_queue_submission(se_cmd);
778 vhost_scsi_send_bad_target(struct vhost_scsi *vs,
779 struct vhost_virtqueue *vq,
780 int head, unsigned out)
782 struct virtio_scsi_cmd_resp __user *resp;
783 struct virtio_scsi_cmd_resp rsp;
786 memset(&rsp, 0, sizeof(rsp));
787 rsp.response = VIRTIO_SCSI_S_BAD_TARGET;
788 resp = vq->iov[out].iov_base;
789 ret = __copy_to_user(resp, &rsp, sizeof(rsp));
791 vhost_add_used_and_signal(&vs->dev, vq, head, 0);
793 pr_err("Faulted on virtio_scsi_cmd_resp\n");
797 vhost_scsi_get_desc(struct vhost_scsi *vs, struct vhost_virtqueue *vq,
798 struct vhost_scsi_ctx *vc)
802 vc->head = vhost_get_vq_desc(vq, vq->iov,
803 ARRAY_SIZE(vq->iov), &vc->out, &vc->in,
806 pr_debug("vhost_get_vq_desc: head: %d, out: %u in: %u\n",
807 vc->head, vc->out, vc->in);
809 /* On error, stop handling until the next kick. */
810 if (unlikely(vc->head < 0))
813 /* Nothing new? Wait for eventfd to tell us they refilled. */
814 if (vc->head == vq->num) {
815 if (unlikely(vhost_enable_notify(&vs->dev, vq))) {
816 vhost_disable_notify(&vs->dev, vq);
823 * Get the size of request and response buffers.
824 * FIXME: Not correct for BIDI operation
826 vc->out_size = iov_length(vq->iov, vc->out);
827 vc->in_size = iov_length(&vq->iov[vc->out], vc->in);
830 * Copy over the virtio-scsi request header, which for a
831 * ANY_LAYOUT enabled guest may span multiple iovecs, or a
832 * single iovec may contain both the header + outgoing
835 * copy_from_iter() will advance out_iter, so that it will
836 * point at the start of the outgoing WRITE payload, if
837 * DMA_TO_DEVICE is set.
839 iov_iter_init(&vc->out_iter, ITER_SOURCE, vq->iov, vc->out, vc->out_size);
847 vhost_scsi_chk_size(struct vhost_virtqueue *vq, struct vhost_scsi_ctx *vc)
849 if (unlikely(vc->in_size < vc->rsp_size)) {
851 "Response buf too small, need min %zu bytes got %zu",
852 vc->rsp_size, vc->in_size);
854 } else if (unlikely(vc->out_size < vc->req_size)) {
856 "Request buf too small, need min %zu bytes got %zu",
857 vc->req_size, vc->out_size);
865 vhost_scsi_get_req(struct vhost_virtqueue *vq, struct vhost_scsi_ctx *vc,
866 struct vhost_scsi_tpg **tpgp)
870 if (unlikely(!copy_from_iter_full(vc->req, vc->req_size,
872 vq_err(vq, "Faulted on copy_from_iter_full\n");
873 } else if (unlikely(*vc->lunp != 1)) {
874 /* virtio-scsi spec requires byte 0 of the lun to be 1 */
875 vq_err(vq, "Illegal virtio-scsi lun: %u\n", *vc->lunp);
877 struct vhost_scsi_tpg **vs_tpg, *tpg;
879 vs_tpg = vhost_vq_get_backend(vq); /* validated at handler entry */
881 tpg = READ_ONCE(vs_tpg[*vc->target]);
882 if (unlikely(!tpg)) {
883 vq_err(vq, "Target 0x%x does not exist\n", *vc->target);
894 static u16 vhost_buf_to_lun(u8 *lun_buf)
896 return ((lun_buf[2] << 8) | lun_buf[3]) & 0x3FFF;
900 vhost_scsi_handle_vq(struct vhost_scsi *vs, struct vhost_virtqueue *vq)
902 struct vhost_scsi_tpg **vs_tpg, *tpg;
903 struct virtio_scsi_cmd_req v_req;
904 struct virtio_scsi_cmd_req_pi v_req_pi;
905 struct vhost_scsi_ctx vc;
906 struct vhost_scsi_cmd *cmd;
907 struct iov_iter in_iter, prot_iter, data_iter;
909 u32 exp_data_len, data_direction;
910 int ret, prot_bytes, i, c = 0;
913 bool t10_pi = vhost_has_feature(vq, VIRTIO_SCSI_F_T10_PI);
916 mutex_lock(&vq->mutex);
918 * We can handle the vq only after the endpoint is setup by calling the
919 * VHOST_SCSI_SET_ENDPOINT ioctl.
921 vs_tpg = vhost_vq_get_backend(vq);
925 memset(&vc, 0, sizeof(vc));
926 vc.rsp_size = sizeof(struct virtio_scsi_cmd_resp);
928 vhost_disable_notify(&vs->dev, vq);
931 ret = vhost_scsi_get_desc(vs, vq, &vc);
936 * Setup pointers and values based upon different virtio-scsi
937 * request header if T10_PI is enabled in KVM guest.
941 vc.req_size = sizeof(v_req_pi);
942 vc.lunp = &v_req_pi.lun[0];
943 vc.target = &v_req_pi.lun[1];
946 vc.req_size = sizeof(v_req);
947 vc.lunp = &v_req.lun[0];
948 vc.target = &v_req.lun[1];
952 * Validate the size of request and response buffers.
953 * Check for a sane response buffer so we can report
954 * early errors back to the guest.
956 ret = vhost_scsi_chk_size(vq, &vc);
960 ret = vhost_scsi_get_req(vq, &vc, &tpg);
964 ret = -EIO; /* bad target on any error from here on */
967 * Determine data_direction by calculating the total outgoing
968 * iovec sizes + incoming iovec sizes vs. virtio-scsi request +
969 * response headers respectively.
971 * For DMA_TO_DEVICE this is out_iter, which is already pointing
972 * to the right place.
974 * For DMA_FROM_DEVICE, the iovec will be just past the end
975 * of the virtio-scsi response header in either the same
976 * or immediately following iovec.
978 * Any associated T10_PI bytes for the outgoing / incoming
979 * payloads are included in calculation of exp_data_len here.
983 if (vc.out_size > vc.req_size) {
984 data_direction = DMA_TO_DEVICE;
985 exp_data_len = vc.out_size - vc.req_size;
986 data_iter = vc.out_iter;
987 } else if (vc.in_size > vc.rsp_size) {
988 data_direction = DMA_FROM_DEVICE;
989 exp_data_len = vc.in_size - vc.rsp_size;
991 iov_iter_init(&in_iter, ITER_DEST, &vq->iov[vc.out], vc.in,
992 vc.rsp_size + exp_data_len);
993 iov_iter_advance(&in_iter, vc.rsp_size);
996 data_direction = DMA_NONE;
1000 * If T10_PI header + payload is present, setup prot_iter values
1001 * and recalculate data_iter for vhost_scsi_mapal() mapping to
1002 * host scatterlists via get_user_pages_fast().
1005 if (v_req_pi.pi_bytesout) {
1006 if (data_direction != DMA_TO_DEVICE) {
1007 vq_err(vq, "Received non zero pi_bytesout,"
1008 " but wrong data_direction\n");
1011 prot_bytes = vhost32_to_cpu(vq, v_req_pi.pi_bytesout);
1012 } else if (v_req_pi.pi_bytesin) {
1013 if (data_direction != DMA_FROM_DEVICE) {
1014 vq_err(vq, "Received non zero pi_bytesin,"
1015 " but wrong data_direction\n");
1018 prot_bytes = vhost32_to_cpu(vq, v_req_pi.pi_bytesin);
1021 * Set prot_iter to data_iter and truncate it to
1022 * prot_bytes, and advance data_iter past any
1023 * preceeding prot_bytes that may be present.
1025 * Also fix up the exp_data_len to reflect only the
1026 * actual data payload length.
1029 exp_data_len -= prot_bytes;
1030 prot_iter = data_iter;
1031 iov_iter_truncate(&prot_iter, prot_bytes);
1032 iov_iter_advance(&data_iter, prot_bytes);
1034 tag = vhost64_to_cpu(vq, v_req_pi.tag);
1035 task_attr = v_req_pi.task_attr;
1036 cdb = &v_req_pi.cdb[0];
1037 lun = vhost_buf_to_lun(v_req_pi.lun);
1039 tag = vhost64_to_cpu(vq, v_req.tag);
1040 task_attr = v_req.task_attr;
1041 cdb = &v_req.cdb[0];
1042 lun = vhost_buf_to_lun(v_req.lun);
1045 * Check that the received CDB size does not exceeded our
1046 * hardcoded max for vhost-scsi, then get a pre-allocated
1047 * cmd descriptor for the new virtio-scsi tag.
1049 * TODO what if cdb was too small for varlen cdb header?
1051 if (unlikely(scsi_command_size(cdb) > VHOST_SCSI_MAX_CDB_SIZE)) {
1052 vq_err(vq, "Received SCSI CDB with command_size: %d that"
1053 " exceeds SCSI_MAX_VARLEN_CDB_SIZE: %d\n",
1054 scsi_command_size(cdb), VHOST_SCSI_MAX_CDB_SIZE);
1057 cmd = vhost_scsi_get_cmd(vq, tpg, cdb, tag, lun, task_attr,
1058 exp_data_len + prot_bytes,
1061 vq_err(vq, "vhost_scsi_get_cmd failed %ld\n",
1065 cmd->tvc_vhost = vs;
1067 for (i = 0; i < vc.in ; i++)
1068 cmd->tvc_resp_iov[i] = vq->iov[vc.out + i];
1069 cmd->tvc_in_iovs = vc.in;
1071 pr_debug("vhost_scsi got command opcode: %#02x, lun: %d\n",
1072 cmd->tvc_cdb[0], cmd->tvc_lun);
1073 pr_debug("cmd: %p exp_data_len: %d, prot_bytes: %d data_direction:"
1074 " %d\n", cmd, exp_data_len, prot_bytes, data_direction);
1076 if (data_direction != DMA_NONE) {
1077 if (unlikely(vhost_scsi_mapal(cmd, prot_bytes,
1078 &prot_iter, exp_data_len,
1080 vq_err(vq, "Failed to map iov to sgl\n");
1081 vhost_scsi_release_cmd_res(&cmd->tvc_se_cmd);
1086 * Save the descriptor from vhost_get_vq_desc() to be used to
1087 * complete the virtio-scsi request in TCM callback context via
1088 * vhost_scsi_queue_data_in() and vhost_scsi_queue_status()
1090 cmd->tvc_vq_desc = vc.head;
1091 vhost_scsi_target_queue_cmd(cmd);
1095 * ENXIO: No more requests, or read error, wait for next kick
1096 * EINVAL: Invalid response buffer, drop the request
1097 * EIO: Respond with bad target
1098 * EAGAIN: Pending request
1102 else if (ret == -EIO)
1103 vhost_scsi_send_bad_target(vs, vq, vc.head, vc.out);
1104 } while (likely(!vhost_exceeds_weight(vq, ++c, 0)));
1106 mutex_unlock(&vq->mutex);
1110 vhost_scsi_send_tmf_resp(struct vhost_scsi *vs, struct vhost_virtqueue *vq,
1111 int in_iovs, int vq_desc, struct iovec *resp_iov,
1114 struct virtio_scsi_ctrl_tmf_resp rsp;
1115 struct iov_iter iov_iter;
1118 pr_debug("%s\n", __func__);
1119 memset(&rsp, 0, sizeof(rsp));
1120 rsp.response = tmf_resp_code;
1122 iov_iter_init(&iov_iter, ITER_DEST, resp_iov, in_iovs, sizeof(rsp));
1124 ret = copy_to_iter(&rsp, sizeof(rsp), &iov_iter);
1125 if (likely(ret == sizeof(rsp)))
1126 vhost_add_used_and_signal(&vs->dev, vq, vq_desc, 0);
1128 pr_err("Faulted on virtio_scsi_ctrl_tmf_resp\n");
1131 static void vhost_scsi_tmf_resp_work(struct vhost_work *work)
1133 struct vhost_scsi_tmf *tmf = container_of(work, struct vhost_scsi_tmf,
1137 if (tmf->scsi_resp == TMR_FUNCTION_COMPLETE)
1138 resp_code = VIRTIO_SCSI_S_FUNCTION_SUCCEEDED;
1140 resp_code = VIRTIO_SCSI_S_FUNCTION_REJECTED;
1142 vhost_scsi_send_tmf_resp(tmf->vhost, &tmf->svq->vq, tmf->in_iovs,
1143 tmf->vq_desc, &tmf->resp_iov, resp_code);
1144 vhost_scsi_release_tmf_res(tmf);
1148 vhost_scsi_handle_tmf(struct vhost_scsi *vs, struct vhost_scsi_tpg *tpg,
1149 struct vhost_virtqueue *vq,
1150 struct virtio_scsi_ctrl_tmf_req *vtmf,
1151 struct vhost_scsi_ctx *vc)
1153 struct vhost_scsi_virtqueue *svq = container_of(vq,
1154 struct vhost_scsi_virtqueue, vq);
1155 struct vhost_scsi_tmf *tmf;
1157 if (vhost32_to_cpu(vq, vtmf->subtype) !=
1158 VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET)
1161 if (!tpg->tpg_nexus || !tpg->tpg_nexus->tvn_se_sess) {
1162 pr_err("Unable to locate active struct vhost_scsi_nexus for LUN RESET.\n");
1166 tmf = kzalloc(sizeof(*tmf), GFP_KERNEL);
1170 vhost_work_init(&tmf->vwork, vhost_scsi_tmf_resp_work);
1173 tmf->resp_iov = vq->iov[vc->out];
1174 tmf->vq_desc = vc->head;
1175 tmf->in_iovs = vc->in;
1176 tmf->inflight = vhost_scsi_get_inflight(vq);
1178 if (target_submit_tmr(&tmf->se_cmd, tpg->tpg_nexus->tvn_se_sess, NULL,
1179 vhost_buf_to_lun(vtmf->lun), NULL,
1180 TMR_LUN_RESET, GFP_KERNEL, 0,
1181 TARGET_SCF_ACK_KREF) < 0) {
1182 vhost_scsi_release_tmf_res(tmf);
1189 vhost_scsi_send_tmf_resp(vs, vq, vc->in, vc->head, &vq->iov[vc->out],
1190 VIRTIO_SCSI_S_FUNCTION_REJECTED);
1194 vhost_scsi_send_an_resp(struct vhost_scsi *vs,
1195 struct vhost_virtqueue *vq,
1196 struct vhost_scsi_ctx *vc)
1198 struct virtio_scsi_ctrl_an_resp rsp;
1199 struct iov_iter iov_iter;
1202 pr_debug("%s\n", __func__);
1203 memset(&rsp, 0, sizeof(rsp)); /* event_actual = 0 */
1204 rsp.response = VIRTIO_SCSI_S_OK;
1206 iov_iter_init(&iov_iter, ITER_DEST, &vq->iov[vc->out], vc->in, sizeof(rsp));
1208 ret = copy_to_iter(&rsp, sizeof(rsp), &iov_iter);
1209 if (likely(ret == sizeof(rsp)))
1210 vhost_add_used_and_signal(&vs->dev, vq, vc->head, 0);
1212 pr_err("Faulted on virtio_scsi_ctrl_an_resp\n");
1216 vhost_scsi_ctl_handle_vq(struct vhost_scsi *vs, struct vhost_virtqueue *vq)
1218 struct vhost_scsi_tpg *tpg;
1221 struct virtio_scsi_ctrl_an_req an;
1222 struct virtio_scsi_ctrl_tmf_req tmf;
1224 struct vhost_scsi_ctx vc;
1228 mutex_lock(&vq->mutex);
1230 * We can handle the vq only after the endpoint is setup by calling the
1231 * VHOST_SCSI_SET_ENDPOINT ioctl.
1233 if (!vhost_vq_get_backend(vq))
1236 memset(&vc, 0, sizeof(vc));
1238 vhost_disable_notify(&vs->dev, vq);
1241 ret = vhost_scsi_get_desc(vs, vq, &vc);
1246 * Get the request type first in order to setup
1247 * other parameters dependent on the type.
1249 vc.req = &v_req.type;
1250 typ_size = sizeof(v_req.type);
1252 if (unlikely(!copy_from_iter_full(vc.req, typ_size,
1254 vq_err(vq, "Faulted on copy_from_iter tmf type\n");
1256 * The size of the response buffer depends on the
1257 * request type and must be validated against it.
1258 * Since the request type is not known, don't send
1264 switch (vhost32_to_cpu(vq, v_req.type)) {
1265 case VIRTIO_SCSI_T_TMF:
1266 vc.req = &v_req.tmf;
1267 vc.req_size = sizeof(struct virtio_scsi_ctrl_tmf_req);
1268 vc.rsp_size = sizeof(struct virtio_scsi_ctrl_tmf_resp);
1269 vc.lunp = &v_req.tmf.lun[0];
1270 vc.target = &v_req.tmf.lun[1];
1272 case VIRTIO_SCSI_T_AN_QUERY:
1273 case VIRTIO_SCSI_T_AN_SUBSCRIBE:
1275 vc.req_size = sizeof(struct virtio_scsi_ctrl_an_req);
1276 vc.rsp_size = sizeof(struct virtio_scsi_ctrl_an_resp);
1277 vc.lunp = &v_req.an.lun[0];
1281 vq_err(vq, "Unknown control request %d", v_req.type);
1286 * Validate the size of request and response buffers.
1287 * Check for a sane response buffer so we can report
1288 * early errors back to the guest.
1290 ret = vhost_scsi_chk_size(vq, &vc);
1295 * Get the rest of the request now that its size is known.
1298 vc.req_size -= typ_size;
1300 ret = vhost_scsi_get_req(vq, &vc, &tpg);
1304 if (v_req.type == VIRTIO_SCSI_T_TMF)
1305 vhost_scsi_handle_tmf(vs, tpg, vq, &v_req.tmf, &vc);
1307 vhost_scsi_send_an_resp(vs, vq, &vc);
1310 * ENXIO: No more requests, or read error, wait for next kick
1311 * EINVAL: Invalid response buffer, drop the request
1312 * EIO: Respond with bad target
1313 * EAGAIN: Pending request
1317 else if (ret == -EIO)
1318 vhost_scsi_send_bad_target(vs, vq, vc.head, vc.out);
1319 } while (likely(!vhost_exceeds_weight(vq, ++c, 0)));
1321 mutex_unlock(&vq->mutex);
1324 static void vhost_scsi_ctl_handle_kick(struct vhost_work *work)
1326 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1328 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1330 pr_debug("%s: The handling func for control queue.\n", __func__);
1331 vhost_scsi_ctl_handle_vq(vs, vq);
1335 vhost_scsi_send_evt(struct vhost_scsi *vs,
1336 struct vhost_scsi_tpg *tpg,
1341 struct vhost_scsi_evt *evt;
1343 evt = vhost_scsi_allocate_evt(vs, event, reason);
1348 /* TODO: share lun setup code with virtio-scsi.ko */
1350 * Note: evt->event is zeroed when we allocate it and
1351 * lun[4-7] need to be zero according to virtio-scsi spec.
1353 evt->event.lun[0] = 0x01;
1354 evt->event.lun[1] = tpg->tport_tpgt;
1355 if (lun->unpacked_lun >= 256)
1356 evt->event.lun[2] = lun->unpacked_lun >> 8 | 0x40 ;
1357 evt->event.lun[3] = lun->unpacked_lun & 0xFF;
1360 llist_add(&evt->list, &vs->vs_event_list);
1361 vhost_work_queue(&vs->dev, &vs->vs_event_work);
1364 static void vhost_scsi_evt_handle_kick(struct vhost_work *work)
1366 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1368 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1370 mutex_lock(&vq->mutex);
1371 if (!vhost_vq_get_backend(vq))
1374 if (vs->vs_events_missed)
1375 vhost_scsi_send_evt(vs, NULL, NULL, VIRTIO_SCSI_T_NO_EVENT, 0);
1377 mutex_unlock(&vq->mutex);
1380 static void vhost_scsi_handle_kick(struct vhost_work *work)
1382 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1384 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1386 vhost_scsi_handle_vq(vs, vq);
1389 /* Callers must hold dev mutex */
1390 static void vhost_scsi_flush(struct vhost_scsi *vs)
1394 /* Init new inflight and remember the old inflight */
1395 vhost_scsi_init_inflight(vs, vs->old_inflight);
1398 * The inflight->kref was initialized to 1. We decrement it here to
1399 * indicate the start of the flush operation so that it will reach 0
1400 * when all the reqs are finished.
1402 for (i = 0; i < vs->dev.nvqs; i++)
1403 kref_put(&vs->old_inflight[i]->kref, vhost_scsi_done_inflight);
1405 /* Flush both the vhost poll and vhost work */
1406 vhost_dev_flush(&vs->dev);
1408 /* Wait for all reqs issued before the flush to be finished */
1409 for (i = 0; i < vs->dev.nvqs; i++)
1410 wait_for_completion(&vs->old_inflight[i]->comp);
1413 static void vhost_scsi_destroy_vq_cmds(struct vhost_virtqueue *vq)
1415 struct vhost_scsi_virtqueue *svq = container_of(vq,
1416 struct vhost_scsi_virtqueue, vq);
1417 struct vhost_scsi_cmd *tv_cmd;
1420 if (!svq->scsi_cmds)
1423 for (i = 0; i < svq->max_cmds; i++) {
1424 tv_cmd = &svq->scsi_cmds[i];
1426 kfree(tv_cmd->tvc_sgl);
1427 kfree(tv_cmd->tvc_prot_sgl);
1428 kfree(tv_cmd->tvc_upages);
1429 kfree(tv_cmd->tvc_resp_iov);
1432 sbitmap_free(&svq->scsi_tags);
1433 kfree(svq->scsi_cmds);
1434 svq->scsi_cmds = NULL;
1437 static int vhost_scsi_setup_vq_cmds(struct vhost_virtqueue *vq, int max_cmds)
1439 struct vhost_scsi_virtqueue *svq = container_of(vq,
1440 struct vhost_scsi_virtqueue, vq);
1441 struct vhost_scsi_cmd *tv_cmd;
1447 if (sbitmap_init_node(&svq->scsi_tags, max_cmds, -1, GFP_KERNEL,
1448 NUMA_NO_NODE, false, true))
1450 svq->max_cmds = max_cmds;
1452 svq->scsi_cmds = kcalloc(max_cmds, sizeof(*tv_cmd), GFP_KERNEL);
1453 if (!svq->scsi_cmds) {
1454 sbitmap_free(&svq->scsi_tags);
1458 for (i = 0; i < max_cmds; i++) {
1459 tv_cmd = &svq->scsi_cmds[i];
1461 tv_cmd->tvc_sgl = kcalloc(VHOST_SCSI_PREALLOC_SGLS,
1462 sizeof(struct scatterlist),
1464 if (!tv_cmd->tvc_sgl) {
1465 pr_err("Unable to allocate tv_cmd->tvc_sgl\n");
1469 tv_cmd->tvc_upages = kcalloc(VHOST_SCSI_PREALLOC_UPAGES,
1470 sizeof(struct page *),
1472 if (!tv_cmd->tvc_upages) {
1473 pr_err("Unable to allocate tv_cmd->tvc_upages\n");
1477 tv_cmd->tvc_resp_iov = kcalloc(UIO_MAXIOV,
1478 sizeof(struct iovec),
1480 if (!tv_cmd->tvc_resp_iov) {
1481 pr_err("Unable to allocate tv_cmd->tvc_resp_iov\n");
1485 tv_cmd->tvc_prot_sgl = kcalloc(VHOST_SCSI_PREALLOC_PROT_SGLS,
1486 sizeof(struct scatterlist),
1488 if (!tv_cmd->tvc_prot_sgl) {
1489 pr_err("Unable to allocate tv_cmd->tvc_prot_sgl\n");
1495 vhost_scsi_destroy_vq_cmds(vq);
1500 * Called from vhost_scsi_ioctl() context to walk the list of available
1501 * vhost_scsi_tpg with an active struct vhost_scsi_nexus
1503 * The lock nesting rule is:
1504 * vhost_scsi_mutex -> vs->dev.mutex -> tpg->tv_tpg_mutex -> vq->mutex
1507 vhost_scsi_set_endpoint(struct vhost_scsi *vs,
1508 struct vhost_scsi_target *t)
1510 struct se_portal_group *se_tpg;
1511 struct vhost_scsi_tport *tv_tport;
1512 struct vhost_scsi_tpg *tpg;
1513 struct vhost_scsi_tpg **vs_tpg;
1514 struct vhost_virtqueue *vq;
1515 int index, ret, i, len;
1518 mutex_lock(&vhost_scsi_mutex);
1519 mutex_lock(&vs->dev.mutex);
1521 /* Verify that ring has been setup correctly. */
1522 for (index = 0; index < vs->dev.nvqs; ++index) {
1523 /* Verify that ring has been setup correctly. */
1524 if (!vhost_vq_access_ok(&vs->vqs[index].vq)) {
1530 len = sizeof(vs_tpg[0]) * VHOST_SCSI_MAX_TARGET;
1531 vs_tpg = kzalloc(len, GFP_KERNEL);
1537 memcpy(vs_tpg, vs->vs_tpg, len);
1539 list_for_each_entry(tpg, &vhost_scsi_list, tv_tpg_list) {
1540 mutex_lock(&tpg->tv_tpg_mutex);
1541 if (!tpg->tpg_nexus) {
1542 mutex_unlock(&tpg->tv_tpg_mutex);
1545 if (tpg->tv_tpg_vhost_count != 0) {
1546 mutex_unlock(&tpg->tv_tpg_mutex);
1549 tv_tport = tpg->tport;
1551 if (!strcmp(tv_tport->tport_name, t->vhost_wwpn)) {
1552 if (vs->vs_tpg && vs->vs_tpg[tpg->tport_tpgt]) {
1553 mutex_unlock(&tpg->tv_tpg_mutex);
1558 * In order to ensure individual vhost-scsi configfs
1559 * groups cannot be removed while in use by vhost ioctl,
1560 * go ahead and take an explicit se_tpg->tpg_group.cg_item
1563 se_tpg = &tpg->se_tpg;
1564 ret = target_depend_item(&se_tpg->tpg_group.cg_item);
1566 pr_warn("target_depend_item() failed: %d\n", ret);
1567 mutex_unlock(&tpg->tv_tpg_mutex);
1570 tpg->tv_tpg_vhost_count++;
1571 tpg->vhost_scsi = vs;
1572 vs_tpg[tpg->tport_tpgt] = tpg;
1575 mutex_unlock(&tpg->tv_tpg_mutex);
1579 memcpy(vs->vs_vhost_wwpn, t->vhost_wwpn,
1580 sizeof(vs->vs_vhost_wwpn));
1582 for (i = VHOST_SCSI_VQ_IO; i < vs->dev.nvqs; i++) {
1583 vq = &vs->vqs[i].vq;
1584 if (!vhost_vq_is_setup(vq))
1587 ret = vhost_scsi_setup_vq_cmds(vq, vq->num);
1589 goto destroy_vq_cmds;
1592 for (i = 0; i < vs->dev.nvqs; i++) {
1593 vq = &vs->vqs[i].vq;
1594 mutex_lock(&vq->mutex);
1595 vhost_vq_set_backend(vq, vs_tpg);
1596 vhost_vq_init_access(vq);
1597 mutex_unlock(&vq->mutex);
1605 * Act as synchronize_rcu to make sure access to
1606 * old vs->vs_tpg is finished.
1608 vhost_scsi_flush(vs);
1610 vs->vs_tpg = vs_tpg;
1614 for (i--; i >= VHOST_SCSI_VQ_IO; i--) {
1615 if (!vhost_vq_get_backend(&vs->vqs[i].vq))
1616 vhost_scsi_destroy_vq_cmds(&vs->vqs[i].vq);
1619 for (i = 0; i < VHOST_SCSI_MAX_TARGET; i++) {
1622 mutex_lock(&tpg->tv_tpg_mutex);
1623 tpg->vhost_scsi = NULL;
1624 tpg->tv_tpg_vhost_count--;
1625 mutex_unlock(&tpg->tv_tpg_mutex);
1626 target_undepend_item(&tpg->se_tpg.tpg_group.cg_item);
1631 mutex_unlock(&vs->dev.mutex);
1632 mutex_unlock(&vhost_scsi_mutex);
1637 vhost_scsi_clear_endpoint(struct vhost_scsi *vs,
1638 struct vhost_scsi_target *t)
1640 struct se_portal_group *se_tpg;
1641 struct vhost_scsi_tport *tv_tport;
1642 struct vhost_scsi_tpg *tpg;
1643 struct vhost_virtqueue *vq;
1648 mutex_lock(&vhost_scsi_mutex);
1649 mutex_lock(&vs->dev.mutex);
1650 /* Verify that ring has been setup correctly. */
1651 for (index = 0; index < vs->dev.nvqs; ++index) {
1652 if (!vhost_vq_access_ok(&vs->vqs[index].vq)) {
1663 for (i = 0; i < VHOST_SCSI_MAX_TARGET; i++) {
1665 tpg = vs->vs_tpg[target];
1669 mutex_lock(&tpg->tv_tpg_mutex);
1670 tv_tport = tpg->tport;
1676 if (strcmp(tv_tport->tport_name, t->vhost_wwpn)) {
1677 pr_warn("tv_tport->tport_name: %s, tpg->tport_tpgt: %hu"
1678 " does not match t->vhost_wwpn: %s, t->vhost_tpgt: %hu\n",
1679 tv_tport->tport_name, tpg->tport_tpgt,
1680 t->vhost_wwpn, t->vhost_tpgt);
1684 tpg->tv_tpg_vhost_count--;
1685 tpg->vhost_scsi = NULL;
1686 vs->vs_tpg[target] = NULL;
1688 mutex_unlock(&tpg->tv_tpg_mutex);
1690 * Release se_tpg->tpg_group.cg_item configfs dependency now
1691 * to allow vhost-scsi WWPN se_tpg->tpg_group shutdown to occur.
1693 se_tpg = &tpg->se_tpg;
1694 target_undepend_item(&se_tpg->tpg_group.cg_item);
1697 for (i = 0; i < vs->dev.nvqs; i++) {
1698 vq = &vs->vqs[i].vq;
1699 mutex_lock(&vq->mutex);
1700 vhost_vq_set_backend(vq, NULL);
1701 mutex_unlock(&vq->mutex);
1703 /* Make sure cmds are not running before tearing them down. */
1704 vhost_scsi_flush(vs);
1706 for (i = 0; i < vs->dev.nvqs; i++) {
1707 vq = &vs->vqs[i].vq;
1708 vhost_scsi_destroy_vq_cmds(vq);
1712 * Act as synchronize_rcu to make sure access to
1713 * old vs->vs_tpg is finished.
1715 vhost_scsi_flush(vs);
1718 WARN_ON(vs->vs_events_nr);
1719 mutex_unlock(&vs->dev.mutex);
1720 mutex_unlock(&vhost_scsi_mutex);
1724 mutex_unlock(&tpg->tv_tpg_mutex);
1726 mutex_unlock(&vs->dev.mutex);
1727 mutex_unlock(&vhost_scsi_mutex);
1731 static int vhost_scsi_set_features(struct vhost_scsi *vs, u64 features)
1733 struct vhost_virtqueue *vq;
1736 if (features & ~VHOST_SCSI_FEATURES)
1739 mutex_lock(&vs->dev.mutex);
1740 if ((features & (1 << VHOST_F_LOG_ALL)) &&
1741 !vhost_log_access_ok(&vs->dev)) {
1742 mutex_unlock(&vs->dev.mutex);
1746 for (i = 0; i < vs->dev.nvqs; i++) {
1747 vq = &vs->vqs[i].vq;
1748 mutex_lock(&vq->mutex);
1749 vq->acked_features = features;
1750 mutex_unlock(&vq->mutex);
1752 mutex_unlock(&vs->dev.mutex);
1756 static int vhost_scsi_open(struct inode *inode, struct file *f)
1758 struct vhost_scsi *vs;
1759 struct vhost_virtqueue **vqs;
1760 int r = -ENOMEM, i, nvqs = vhost_scsi_max_io_vqs;
1762 vs = kvzalloc(sizeof(*vs), GFP_KERNEL);
1766 if (nvqs > VHOST_SCSI_MAX_IO_VQ) {
1767 pr_err("Invalid max_io_vqs of %d. Using %d.\n", nvqs,
1768 VHOST_SCSI_MAX_IO_VQ);
1769 nvqs = VHOST_SCSI_MAX_IO_VQ;
1770 } else if (nvqs == 0) {
1771 pr_err("Invalid max_io_vqs of %d. Using 1.\n", nvqs);
1774 nvqs += VHOST_SCSI_VQ_IO;
1776 vs->compl_bitmap = bitmap_alloc(nvqs, GFP_KERNEL);
1777 if (!vs->compl_bitmap)
1778 goto err_compl_bitmap;
1780 vs->old_inflight = kmalloc_array(nvqs, sizeof(*vs->old_inflight),
1781 GFP_KERNEL | __GFP_ZERO);
1782 if (!vs->old_inflight)
1785 vs->vqs = kmalloc_array(nvqs, sizeof(*vs->vqs),
1786 GFP_KERNEL | __GFP_ZERO);
1790 vqs = kmalloc_array(nvqs, sizeof(*vqs), GFP_KERNEL);
1794 vhost_work_init(&vs->vs_completion_work, vhost_scsi_complete_cmd_work);
1795 vhost_work_init(&vs->vs_event_work, vhost_scsi_evt_work);
1797 vs->vs_events_nr = 0;
1798 vs->vs_events_missed = false;
1800 vqs[VHOST_SCSI_VQ_CTL] = &vs->vqs[VHOST_SCSI_VQ_CTL].vq;
1801 vqs[VHOST_SCSI_VQ_EVT] = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1802 vs->vqs[VHOST_SCSI_VQ_CTL].vq.handle_kick = vhost_scsi_ctl_handle_kick;
1803 vs->vqs[VHOST_SCSI_VQ_EVT].vq.handle_kick = vhost_scsi_evt_handle_kick;
1804 for (i = VHOST_SCSI_VQ_IO; i < nvqs; i++) {
1805 vqs[i] = &vs->vqs[i].vq;
1806 vs->vqs[i].vq.handle_kick = vhost_scsi_handle_kick;
1808 vhost_dev_init(&vs->dev, vqs, nvqs, UIO_MAXIOV,
1809 VHOST_SCSI_WEIGHT, 0, true, NULL);
1811 vhost_scsi_init_inflight(vs, NULL);
1813 f->private_data = vs;
1819 kfree(vs->old_inflight);
1821 bitmap_free(vs->compl_bitmap);
1828 static int vhost_scsi_release(struct inode *inode, struct file *f)
1830 struct vhost_scsi *vs = f->private_data;
1831 struct vhost_scsi_target t;
1833 mutex_lock(&vs->dev.mutex);
1834 memcpy(t.vhost_wwpn, vs->vs_vhost_wwpn, sizeof(t.vhost_wwpn));
1835 mutex_unlock(&vs->dev.mutex);
1836 vhost_scsi_clear_endpoint(vs, &t);
1837 vhost_dev_stop(&vs->dev);
1838 vhost_dev_cleanup(&vs->dev);
1841 kfree(vs->old_inflight);
1842 bitmap_free(vs->compl_bitmap);
1848 vhost_scsi_ioctl(struct file *f,
1852 struct vhost_scsi *vs = f->private_data;
1853 struct vhost_scsi_target backend;
1854 void __user *argp = (void __user *)arg;
1855 u64 __user *featurep = argp;
1856 u32 __user *eventsp = argp;
1859 int r, abi_version = VHOST_SCSI_ABI_VERSION;
1860 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1863 case VHOST_SCSI_SET_ENDPOINT:
1864 if (copy_from_user(&backend, argp, sizeof backend))
1866 if (backend.reserved != 0)
1869 return vhost_scsi_set_endpoint(vs, &backend);
1870 case VHOST_SCSI_CLEAR_ENDPOINT:
1871 if (copy_from_user(&backend, argp, sizeof backend))
1873 if (backend.reserved != 0)
1876 return vhost_scsi_clear_endpoint(vs, &backend);
1877 case VHOST_SCSI_GET_ABI_VERSION:
1878 if (copy_to_user(argp, &abi_version, sizeof abi_version))
1881 case VHOST_SCSI_SET_EVENTS_MISSED:
1882 if (get_user(events_missed, eventsp))
1884 mutex_lock(&vq->mutex);
1885 vs->vs_events_missed = events_missed;
1886 mutex_unlock(&vq->mutex);
1888 case VHOST_SCSI_GET_EVENTS_MISSED:
1889 mutex_lock(&vq->mutex);
1890 events_missed = vs->vs_events_missed;
1891 mutex_unlock(&vq->mutex);
1892 if (put_user(events_missed, eventsp))
1895 case VHOST_GET_FEATURES:
1896 features = VHOST_SCSI_FEATURES;
1897 if (copy_to_user(featurep, &features, sizeof features))
1900 case VHOST_SET_FEATURES:
1901 if (copy_from_user(&features, featurep, sizeof features))
1903 return vhost_scsi_set_features(vs, features);
1905 mutex_lock(&vs->dev.mutex);
1906 r = vhost_dev_ioctl(&vs->dev, ioctl, argp);
1907 /* TODO: flush backend after dev ioctl. */
1908 if (r == -ENOIOCTLCMD)
1909 r = vhost_vring_ioctl(&vs->dev, ioctl, argp);
1910 mutex_unlock(&vs->dev.mutex);
1915 static const struct file_operations vhost_scsi_fops = {
1916 .owner = THIS_MODULE,
1917 .release = vhost_scsi_release,
1918 .unlocked_ioctl = vhost_scsi_ioctl,
1919 .compat_ioctl = compat_ptr_ioctl,
1920 .open = vhost_scsi_open,
1921 .llseek = noop_llseek,
1924 static struct miscdevice vhost_scsi_misc = {
1930 static int __init vhost_scsi_register(void)
1932 return misc_register(&vhost_scsi_misc);
1935 static void vhost_scsi_deregister(void)
1937 misc_deregister(&vhost_scsi_misc);
1940 static char *vhost_scsi_dump_proto_id(struct vhost_scsi_tport *tport)
1942 switch (tport->tport_proto_id) {
1943 case SCSI_PROTOCOL_SAS:
1945 case SCSI_PROTOCOL_FCP:
1947 case SCSI_PROTOCOL_ISCSI:
1957 vhost_scsi_do_plug(struct vhost_scsi_tpg *tpg,
1958 struct se_lun *lun, bool plug)
1961 struct vhost_scsi *vs = tpg->vhost_scsi;
1962 struct vhost_virtqueue *vq;
1968 mutex_lock(&vs->dev.mutex);
1971 reason = VIRTIO_SCSI_EVT_RESET_RESCAN;
1973 reason = VIRTIO_SCSI_EVT_RESET_REMOVED;
1975 vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1976 mutex_lock(&vq->mutex);
1977 if (vhost_has_feature(vq, VIRTIO_SCSI_F_HOTPLUG))
1978 vhost_scsi_send_evt(vs, tpg, lun,
1979 VIRTIO_SCSI_T_TRANSPORT_RESET, reason);
1980 mutex_unlock(&vq->mutex);
1981 mutex_unlock(&vs->dev.mutex);
1984 static void vhost_scsi_hotplug(struct vhost_scsi_tpg *tpg, struct se_lun *lun)
1986 vhost_scsi_do_plug(tpg, lun, true);
1989 static void vhost_scsi_hotunplug(struct vhost_scsi_tpg *tpg, struct se_lun *lun)
1991 vhost_scsi_do_plug(tpg, lun, false);
1994 static int vhost_scsi_port_link(struct se_portal_group *se_tpg,
1997 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1998 struct vhost_scsi_tpg, se_tpg);
2000 mutex_lock(&vhost_scsi_mutex);
2002 mutex_lock(&tpg->tv_tpg_mutex);
2003 tpg->tv_tpg_port_count++;
2004 mutex_unlock(&tpg->tv_tpg_mutex);
2006 vhost_scsi_hotplug(tpg, lun);
2008 mutex_unlock(&vhost_scsi_mutex);
2013 static void vhost_scsi_port_unlink(struct se_portal_group *se_tpg,
2016 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2017 struct vhost_scsi_tpg, se_tpg);
2019 mutex_lock(&vhost_scsi_mutex);
2021 mutex_lock(&tpg->tv_tpg_mutex);
2022 tpg->tv_tpg_port_count--;
2023 mutex_unlock(&tpg->tv_tpg_mutex);
2025 vhost_scsi_hotunplug(tpg, lun);
2027 mutex_unlock(&vhost_scsi_mutex);
2030 static ssize_t vhost_scsi_tpg_attrib_fabric_prot_type_store(
2031 struct config_item *item, const char *page, size_t count)
2033 struct se_portal_group *se_tpg = attrib_to_tpg(item);
2034 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2035 struct vhost_scsi_tpg, se_tpg);
2037 int ret = kstrtoul(page, 0, &val);
2040 pr_err("kstrtoul() returned %d for fabric_prot_type\n", ret);
2043 if (val != 0 && val != 1 && val != 3) {
2044 pr_err("Invalid vhost_scsi fabric_prot_type: %lu\n", val);
2047 tpg->tv_fabric_prot_type = val;
2052 static ssize_t vhost_scsi_tpg_attrib_fabric_prot_type_show(
2053 struct config_item *item, char *page)
2055 struct se_portal_group *se_tpg = attrib_to_tpg(item);
2056 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2057 struct vhost_scsi_tpg, se_tpg);
2059 return sysfs_emit(page, "%d\n", tpg->tv_fabric_prot_type);
2062 CONFIGFS_ATTR(vhost_scsi_tpg_attrib_, fabric_prot_type);
2064 static struct configfs_attribute *vhost_scsi_tpg_attrib_attrs[] = {
2065 &vhost_scsi_tpg_attrib_attr_fabric_prot_type,
2069 static int vhost_scsi_make_nexus(struct vhost_scsi_tpg *tpg,
2072 struct vhost_scsi_nexus *tv_nexus;
2074 mutex_lock(&tpg->tv_tpg_mutex);
2075 if (tpg->tpg_nexus) {
2076 mutex_unlock(&tpg->tv_tpg_mutex);
2077 pr_debug("tpg->tpg_nexus already exists\n");
2081 tv_nexus = kzalloc(sizeof(*tv_nexus), GFP_KERNEL);
2083 mutex_unlock(&tpg->tv_tpg_mutex);
2084 pr_err("Unable to allocate struct vhost_scsi_nexus\n");
2088 * Since we are running in 'demo mode' this call with generate a
2089 * struct se_node_acl for the vhost_scsi struct se_portal_group with
2090 * the SCSI Initiator port name of the passed configfs group 'name'.
2092 tv_nexus->tvn_se_sess = target_setup_session(&tpg->se_tpg, 0, 0,
2093 TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS,
2094 (unsigned char *)name, tv_nexus, NULL);
2095 if (IS_ERR(tv_nexus->tvn_se_sess)) {
2096 mutex_unlock(&tpg->tv_tpg_mutex);
2100 tpg->tpg_nexus = tv_nexus;
2102 mutex_unlock(&tpg->tv_tpg_mutex);
2106 static int vhost_scsi_drop_nexus(struct vhost_scsi_tpg *tpg)
2108 struct se_session *se_sess;
2109 struct vhost_scsi_nexus *tv_nexus;
2111 mutex_lock(&tpg->tv_tpg_mutex);
2112 tv_nexus = tpg->tpg_nexus;
2114 mutex_unlock(&tpg->tv_tpg_mutex);
2118 se_sess = tv_nexus->tvn_se_sess;
2120 mutex_unlock(&tpg->tv_tpg_mutex);
2124 if (tpg->tv_tpg_port_count != 0) {
2125 mutex_unlock(&tpg->tv_tpg_mutex);
2126 pr_err("Unable to remove TCM_vhost I_T Nexus with"
2127 " active TPG port count: %d\n",
2128 tpg->tv_tpg_port_count);
2132 if (tpg->tv_tpg_vhost_count != 0) {
2133 mutex_unlock(&tpg->tv_tpg_mutex);
2134 pr_err("Unable to remove TCM_vhost I_T Nexus with"
2135 " active TPG vhost count: %d\n",
2136 tpg->tv_tpg_vhost_count);
2140 pr_debug("TCM_vhost_ConfigFS: Removing I_T Nexus to emulated"
2141 " %s Initiator Port: %s\n", vhost_scsi_dump_proto_id(tpg->tport),
2142 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
2145 * Release the SCSI I_T Nexus to the emulated vhost Target Port
2147 target_remove_session(se_sess);
2148 tpg->tpg_nexus = NULL;
2149 mutex_unlock(&tpg->tv_tpg_mutex);
2155 static ssize_t vhost_scsi_tpg_nexus_show(struct config_item *item, char *page)
2157 struct se_portal_group *se_tpg = to_tpg(item);
2158 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2159 struct vhost_scsi_tpg, se_tpg);
2160 struct vhost_scsi_nexus *tv_nexus;
2163 mutex_lock(&tpg->tv_tpg_mutex);
2164 tv_nexus = tpg->tpg_nexus;
2166 mutex_unlock(&tpg->tv_tpg_mutex);
2169 ret = sysfs_emit(page, "%s\n",
2170 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
2171 mutex_unlock(&tpg->tv_tpg_mutex);
2176 static ssize_t vhost_scsi_tpg_nexus_store(struct config_item *item,
2177 const char *page, size_t count)
2179 struct se_portal_group *se_tpg = to_tpg(item);
2180 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2181 struct vhost_scsi_tpg, se_tpg);
2182 struct vhost_scsi_tport *tport_wwn = tpg->tport;
2183 unsigned char i_port[VHOST_SCSI_NAMELEN], *ptr, *port_ptr;
2186 * Shutdown the active I_T nexus if 'NULL' is passed..
2188 if (!strncmp(page, "NULL", 4)) {
2189 ret = vhost_scsi_drop_nexus(tpg);
2190 return (!ret) ? count : ret;
2193 * Otherwise make sure the passed virtual Initiator port WWN matches
2194 * the fabric protocol_id set in vhost_scsi_make_tport(), and call
2195 * vhost_scsi_make_nexus().
2197 if (strlen(page) >= VHOST_SCSI_NAMELEN) {
2198 pr_err("Emulated NAA Sas Address: %s, exceeds"
2199 " max: %d\n", page, VHOST_SCSI_NAMELEN);
2202 snprintf(&i_port[0], VHOST_SCSI_NAMELEN, "%s", page);
2204 ptr = strstr(i_port, "naa.");
2206 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_SAS) {
2207 pr_err("Passed SAS Initiator Port %s does not"
2208 " match target port protoid: %s\n", i_port,
2209 vhost_scsi_dump_proto_id(tport_wwn));
2212 port_ptr = &i_port[0];
2215 ptr = strstr(i_port, "fc.");
2217 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_FCP) {
2218 pr_err("Passed FCP Initiator Port %s does not"
2219 " match target port protoid: %s\n", i_port,
2220 vhost_scsi_dump_proto_id(tport_wwn));
2223 port_ptr = &i_port[3]; /* Skip over "fc." */
2226 ptr = strstr(i_port, "iqn.");
2228 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_ISCSI) {
2229 pr_err("Passed iSCSI Initiator Port %s does not"
2230 " match target port protoid: %s\n", i_port,
2231 vhost_scsi_dump_proto_id(tport_wwn));
2234 port_ptr = &i_port[0];
2237 pr_err("Unable to locate prefix for emulated Initiator Port:"
2241 * Clear any trailing newline for the NAA WWN
2244 if (i_port[strlen(i_port)-1] == '\n')
2245 i_port[strlen(i_port)-1] = '\0';
2247 ret = vhost_scsi_make_nexus(tpg, port_ptr);
2254 CONFIGFS_ATTR(vhost_scsi_tpg_, nexus);
2256 static struct configfs_attribute *vhost_scsi_tpg_attrs[] = {
2257 &vhost_scsi_tpg_attr_nexus,
2261 static struct se_portal_group *
2262 vhost_scsi_make_tpg(struct se_wwn *wwn, const char *name)
2264 struct vhost_scsi_tport *tport = container_of(wwn,
2265 struct vhost_scsi_tport, tport_wwn);
2267 struct vhost_scsi_tpg *tpg;
2271 if (strstr(name, "tpgt_") != name)
2272 return ERR_PTR(-EINVAL);
2273 if (kstrtou16(name + 5, 10, &tpgt) || tpgt >= VHOST_SCSI_MAX_TARGET)
2274 return ERR_PTR(-EINVAL);
2276 tpg = kzalloc(sizeof(*tpg), GFP_KERNEL);
2278 pr_err("Unable to allocate struct vhost_scsi_tpg");
2279 return ERR_PTR(-ENOMEM);
2281 mutex_init(&tpg->tv_tpg_mutex);
2282 INIT_LIST_HEAD(&tpg->tv_tpg_list);
2284 tpg->tport_tpgt = tpgt;
2286 ret = core_tpg_register(wwn, &tpg->se_tpg, tport->tport_proto_id);
2291 mutex_lock(&vhost_scsi_mutex);
2292 list_add_tail(&tpg->tv_tpg_list, &vhost_scsi_list);
2293 mutex_unlock(&vhost_scsi_mutex);
2295 return &tpg->se_tpg;
2298 static void vhost_scsi_drop_tpg(struct se_portal_group *se_tpg)
2300 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2301 struct vhost_scsi_tpg, se_tpg);
2303 mutex_lock(&vhost_scsi_mutex);
2304 list_del(&tpg->tv_tpg_list);
2305 mutex_unlock(&vhost_scsi_mutex);
2307 * Release the virtual I_T Nexus for this vhost TPG
2309 vhost_scsi_drop_nexus(tpg);
2311 * Deregister the se_tpg from TCM..
2313 core_tpg_deregister(se_tpg);
2317 static struct se_wwn *
2318 vhost_scsi_make_tport(struct target_fabric_configfs *tf,
2319 struct config_group *group,
2322 struct vhost_scsi_tport *tport;
2327 /* if (vhost_scsi_parse_wwn(name, &wwpn, 1) < 0)
2328 return ERR_PTR(-EINVAL); */
2330 tport = kzalloc(sizeof(*tport), GFP_KERNEL);
2332 pr_err("Unable to allocate struct vhost_scsi_tport");
2333 return ERR_PTR(-ENOMEM);
2335 tport->tport_wwpn = wwpn;
2337 * Determine the emulated Protocol Identifier and Target Port Name
2338 * based on the incoming configfs directory name.
2340 ptr = strstr(name, "naa.");
2342 tport->tport_proto_id = SCSI_PROTOCOL_SAS;
2345 ptr = strstr(name, "fc.");
2347 tport->tport_proto_id = SCSI_PROTOCOL_FCP;
2348 off = 3; /* Skip over "fc." */
2351 ptr = strstr(name, "iqn.");
2353 tport->tport_proto_id = SCSI_PROTOCOL_ISCSI;
2357 pr_err("Unable to locate prefix for emulated Target Port:"
2360 return ERR_PTR(-EINVAL);
2363 if (strlen(name) >= VHOST_SCSI_NAMELEN) {
2364 pr_err("Emulated %s Address: %s, exceeds"
2365 " max: %d\n", name, vhost_scsi_dump_proto_id(tport),
2366 VHOST_SCSI_NAMELEN);
2368 return ERR_PTR(-EINVAL);
2370 snprintf(&tport->tport_name[0], VHOST_SCSI_NAMELEN, "%s", &name[off]);
2372 pr_debug("TCM_VHost_ConfigFS: Allocated emulated Target"
2373 " %s Address: %s\n", vhost_scsi_dump_proto_id(tport), name);
2375 return &tport->tport_wwn;
2378 static void vhost_scsi_drop_tport(struct se_wwn *wwn)
2380 struct vhost_scsi_tport *tport = container_of(wwn,
2381 struct vhost_scsi_tport, tport_wwn);
2383 pr_debug("TCM_VHost_ConfigFS: Deallocating emulated Target"
2384 " %s Address: %s\n", vhost_scsi_dump_proto_id(tport),
2391 vhost_scsi_wwn_version_show(struct config_item *item, char *page)
2393 return sysfs_emit(page, "TCM_VHOST fabric module %s on %s/%s"
2394 "on "UTS_RELEASE"\n", VHOST_SCSI_VERSION, utsname()->sysname,
2395 utsname()->machine);
2398 CONFIGFS_ATTR_RO(vhost_scsi_wwn_, version);
2400 static struct configfs_attribute *vhost_scsi_wwn_attrs[] = {
2401 &vhost_scsi_wwn_attr_version,
2405 static const struct target_core_fabric_ops vhost_scsi_ops = {
2406 .module = THIS_MODULE,
2407 .fabric_name = "vhost",
2408 .max_data_sg_nents = VHOST_SCSI_PREALLOC_SGLS,
2409 .tpg_get_wwn = vhost_scsi_get_fabric_wwn,
2410 .tpg_get_tag = vhost_scsi_get_tpgt,
2411 .tpg_check_demo_mode = vhost_scsi_check_true,
2412 .tpg_check_demo_mode_cache = vhost_scsi_check_true,
2413 .tpg_check_prot_fabric_only = vhost_scsi_check_prot_fabric_only,
2414 .release_cmd = vhost_scsi_release_cmd,
2415 .check_stop_free = vhost_scsi_check_stop_free,
2416 .sess_get_initiator_sid = NULL,
2417 .write_pending = vhost_scsi_write_pending,
2418 .queue_data_in = vhost_scsi_queue_data_in,
2419 .queue_status = vhost_scsi_queue_status,
2420 .queue_tm_rsp = vhost_scsi_queue_tm_rsp,
2421 .aborted_task = vhost_scsi_aborted_task,
2423 * Setup callers for generic logic in target_core_fabric_configfs.c
2425 .fabric_make_wwn = vhost_scsi_make_tport,
2426 .fabric_drop_wwn = vhost_scsi_drop_tport,
2427 .fabric_make_tpg = vhost_scsi_make_tpg,
2428 .fabric_drop_tpg = vhost_scsi_drop_tpg,
2429 .fabric_post_link = vhost_scsi_port_link,
2430 .fabric_pre_unlink = vhost_scsi_port_unlink,
2432 .tfc_wwn_attrs = vhost_scsi_wwn_attrs,
2433 .tfc_tpg_base_attrs = vhost_scsi_tpg_attrs,
2434 .tfc_tpg_attrib_attrs = vhost_scsi_tpg_attrib_attrs,
2437 static int __init vhost_scsi_init(void)
2441 pr_debug("TCM_VHOST fabric module %s on %s/%s"
2442 " on "UTS_RELEASE"\n", VHOST_SCSI_VERSION, utsname()->sysname,
2443 utsname()->machine);
2445 ret = vhost_scsi_register();
2449 ret = target_register_template(&vhost_scsi_ops);
2451 goto out_vhost_scsi_deregister;
2455 out_vhost_scsi_deregister:
2456 vhost_scsi_deregister();
2461 static void vhost_scsi_exit(void)
2463 target_unregister_template(&vhost_scsi_ops);
2464 vhost_scsi_deregister();
2467 MODULE_DESCRIPTION("VHOST_SCSI series fabric driver");
2468 MODULE_ALIAS("tcm_vhost");
2469 MODULE_LICENSE("GPL");
2470 module_init(vhost_scsi_init);
2471 module_exit(vhost_scsi_exit);