1 /*******************************************************************************
2 * Vhost kernel TCM fabric driver for virtio SCSI initiators
4 * (C) Copyright 2010-2013 Datera, Inc.
5 * (C) Copyright 2010-2012 IBM Corp.
7 * Licensed to the Linux Foundation under the General Public License (GPL) version 2.
9 * Authors: Nicholas A. Bellinger <nab@daterainc.com>
10 * Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 ****************************************************************************/
24 #include <linux/module.h>
25 #include <linux/moduleparam.h>
26 #include <generated/utsrelease.h>
27 #include <linux/utsname.h>
28 #include <linux/init.h>
29 #include <linux/slab.h>
30 #include <linux/kthread.h>
31 #include <linux/types.h>
32 #include <linux/string.h>
33 #include <linux/configfs.h>
34 #include <linux/ctype.h>
35 #include <linux/compat.h>
36 #include <linux/eventfd.h>
38 #include <linux/vmalloc.h>
39 #include <linux/miscdevice.h>
40 #include <asm/unaligned.h>
41 #include <scsi/scsi_common.h>
42 #include <scsi/scsi_proto.h>
43 #include <target/target_core_base.h>
44 #include <target/target_core_fabric.h>
45 #include <linux/vhost.h>
46 #include <linux/virtio_scsi.h>
47 #include <linux/llist.h>
48 #include <linux/bitmap.h>
52 #define VHOST_SCSI_VERSION "v0.1"
53 #define VHOST_SCSI_NAMELEN 256
54 #define VHOST_SCSI_MAX_CDB_SIZE 32
55 #define VHOST_SCSI_DEFAULT_TAGS 256
56 #define VHOST_SCSI_PREALLOC_SGLS 2048
57 #define VHOST_SCSI_PREALLOC_UPAGES 2048
58 #define VHOST_SCSI_PREALLOC_PROT_SGLS 2048
60 struct vhost_scsi_inflight {
61 /* Wait for the flush operation to finish */
62 struct completion comp;
63 /* Refcount for the inflight reqs */
67 struct vhost_scsi_cmd {
68 /* Descriptor from vhost_get_vq_desc() for virt_queue segment */
70 /* virtio-scsi initiator task attribute */
72 /* virtio-scsi response incoming iovecs */
74 /* virtio-scsi initiator data direction */
75 enum dma_data_direction tvc_data_direction;
76 /* Expected data transfer length from virtio-scsi header */
78 /* The Tag from include/linux/virtio_scsi.h:struct virtio_scsi_cmd_req */
80 /* The number of scatterlists associated with this cmd */
82 u32 tvc_prot_sgl_count;
83 /* Saved unpacked SCSI LUN for vhost_scsi_submission_work() */
85 /* Pointer to the SGL formatted memory from virtio-scsi */
86 struct scatterlist *tvc_sgl;
87 struct scatterlist *tvc_prot_sgl;
88 struct page **tvc_upages;
89 /* Pointer to response header iovec */
90 struct iovec tvc_resp_iov;
91 /* Pointer to vhost_scsi for our device */
92 struct vhost_scsi *tvc_vhost;
93 /* Pointer to vhost_virtqueue for the cmd */
94 struct vhost_virtqueue *tvc_vq;
95 /* Pointer to vhost nexus memory */
96 struct vhost_scsi_nexus *tvc_nexus;
97 /* The TCM I/O descriptor that is accessed via container_of() */
98 struct se_cmd tvc_se_cmd;
99 /* work item used for cmwq dispatch to vhost_scsi_submission_work() */
100 struct work_struct work;
101 /* Copy of the incoming SCSI command descriptor block (CDB) */
102 unsigned char tvc_cdb[VHOST_SCSI_MAX_CDB_SIZE];
103 /* Sense buffer that will be mapped into outgoing status */
104 unsigned char tvc_sense_buf[TRANSPORT_SENSE_BUFFER];
105 /* Completed commands list, serviced from vhost worker thread */
106 struct llist_node tvc_completion_list;
107 /* Used to track inflight cmd */
108 struct vhost_scsi_inflight *inflight;
111 struct vhost_scsi_nexus {
112 /* Pointer to TCM session for I_T Nexus */
113 struct se_session *tvn_se_sess;
116 struct vhost_scsi_tpg {
117 /* Vhost port target portal group tag for TCM */
119 /* Used to track number of TPG Port/Lun Links wrt to explict I_T Nexus shutdown */
120 int tv_tpg_port_count;
121 /* Used for vhost_scsi device reference to tpg_nexus, protected by tv_tpg_mutex */
122 int tv_tpg_vhost_count;
123 /* Used for enabling T10-PI with legacy devices */
124 int tv_fabric_prot_type;
125 /* list for vhost_scsi_list */
126 struct list_head tv_tpg_list;
127 /* Used to protect access for tpg_nexus */
128 struct mutex tv_tpg_mutex;
129 /* Pointer to the TCM VHost I_T Nexus for this TPG endpoint */
130 struct vhost_scsi_nexus *tpg_nexus;
131 /* Pointer back to vhost_scsi_tport */
132 struct vhost_scsi_tport *tport;
133 /* Returned by vhost_scsi_make_tpg() */
134 struct se_portal_group se_tpg;
135 /* Pointer back to vhost_scsi, protected by tv_tpg_mutex */
136 struct vhost_scsi *vhost_scsi;
139 struct vhost_scsi_tport {
140 /* SCSI protocol the tport is providing */
142 /* Binary World Wide unique Port Name for Vhost Target port */
144 /* ASCII formatted WWPN for Vhost Target port */
145 char tport_name[VHOST_SCSI_NAMELEN];
146 /* Returned by vhost_scsi_make_tport() */
147 struct se_wwn tport_wwn;
150 struct vhost_scsi_evt {
151 /* event to be sent to guest */
152 struct virtio_scsi_event event;
153 /* event list, serviced from vhost worker thread */
154 struct llist_node list;
158 VHOST_SCSI_VQ_CTL = 0,
159 VHOST_SCSI_VQ_EVT = 1,
160 VHOST_SCSI_VQ_IO = 2,
163 /* Note: can't set VIRTIO_F_VERSION_1 yet, since that implies ANY_LAYOUT. */
165 VHOST_SCSI_FEATURES = VHOST_FEATURES | (1ULL << VIRTIO_SCSI_F_HOTPLUG) |
166 (1ULL << VIRTIO_SCSI_F_T10_PI)
169 #define VHOST_SCSI_MAX_TARGET 256
170 #define VHOST_SCSI_MAX_VQ 128
171 #define VHOST_SCSI_MAX_EVENT 128
173 struct vhost_scsi_virtqueue {
174 struct vhost_virtqueue vq;
176 * Reference counting for inflight reqs, used for flush operation. At
177 * each time, one reference tracks new commands submitted, while we
178 * wait for another one to reach 0.
180 struct vhost_scsi_inflight inflights[2];
182 * Indicate current inflight in use, protected by vq->mutex.
183 * Writers must also take dev mutex and flush under it.
189 /* Protected by vhost_scsi->dev.mutex */
190 struct vhost_scsi_tpg **vs_tpg;
191 char vs_vhost_wwpn[TRANSPORT_IQN_LEN];
193 struct vhost_dev dev;
194 struct vhost_scsi_virtqueue vqs[VHOST_SCSI_MAX_VQ];
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 */
207 * Context for processing request and control queue operations.
209 struct vhost_scsi_ctx {
211 unsigned int out, in;
212 size_t req_size, rsp_size;
213 size_t out_size, in_size;
216 struct iov_iter out_iter;
219 static struct workqueue_struct *vhost_scsi_workqueue;
221 /* Global spinlock to protect vhost_scsi TPG list for vhost IOCTL access */
222 static DEFINE_MUTEX(vhost_scsi_mutex);
223 static LIST_HEAD(vhost_scsi_list);
225 static void vhost_scsi_done_inflight(struct kref *kref)
227 struct vhost_scsi_inflight *inflight;
229 inflight = container_of(kref, struct vhost_scsi_inflight, kref);
230 complete(&inflight->comp);
233 static void vhost_scsi_init_inflight(struct vhost_scsi *vs,
234 struct vhost_scsi_inflight *old_inflight[])
236 struct vhost_scsi_inflight *new_inflight;
237 struct vhost_virtqueue *vq;
240 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
243 mutex_lock(&vq->mutex);
245 /* store old infight */
246 idx = vs->vqs[i].inflight_idx;
248 old_inflight[i] = &vs->vqs[i].inflights[idx];
250 /* setup new infight */
251 vs->vqs[i].inflight_idx = idx ^ 1;
252 new_inflight = &vs->vqs[i].inflights[idx ^ 1];
253 kref_init(&new_inflight->kref);
254 init_completion(&new_inflight->comp);
256 mutex_unlock(&vq->mutex);
260 static struct vhost_scsi_inflight *
261 vhost_scsi_get_inflight(struct vhost_virtqueue *vq)
263 struct vhost_scsi_inflight *inflight;
264 struct vhost_scsi_virtqueue *svq;
266 svq = container_of(vq, struct vhost_scsi_virtqueue, vq);
267 inflight = &svq->inflights[svq->inflight_idx];
268 kref_get(&inflight->kref);
273 static void vhost_scsi_put_inflight(struct vhost_scsi_inflight *inflight)
275 kref_put(&inflight->kref, vhost_scsi_done_inflight);
278 static int vhost_scsi_check_true(struct se_portal_group *se_tpg)
283 static int vhost_scsi_check_false(struct se_portal_group *se_tpg)
288 static char *vhost_scsi_get_fabric_wwn(struct se_portal_group *se_tpg)
290 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
291 struct vhost_scsi_tpg, se_tpg);
292 struct vhost_scsi_tport *tport = tpg->tport;
294 return &tport->tport_name[0];
297 static u16 vhost_scsi_get_tpgt(struct se_portal_group *se_tpg)
299 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
300 struct vhost_scsi_tpg, se_tpg);
301 return tpg->tport_tpgt;
304 static int vhost_scsi_check_prot_fabric_only(struct se_portal_group *se_tpg)
306 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
307 struct vhost_scsi_tpg, se_tpg);
309 return tpg->tv_fabric_prot_type;
312 static u32 vhost_scsi_tpg_get_inst_index(struct se_portal_group *se_tpg)
317 static void vhost_scsi_release_cmd(struct se_cmd *se_cmd)
319 struct vhost_scsi_cmd *tv_cmd = container_of(se_cmd,
320 struct vhost_scsi_cmd, tvc_se_cmd);
321 struct se_session *se_sess = tv_cmd->tvc_nexus->tvn_se_sess;
324 if (tv_cmd->tvc_sgl_count) {
325 for (i = 0; i < tv_cmd->tvc_sgl_count; i++)
326 put_page(sg_page(&tv_cmd->tvc_sgl[i]));
328 if (tv_cmd->tvc_prot_sgl_count) {
329 for (i = 0; i < tv_cmd->tvc_prot_sgl_count; i++)
330 put_page(sg_page(&tv_cmd->tvc_prot_sgl[i]));
333 vhost_scsi_put_inflight(tv_cmd->inflight);
334 target_free_tag(se_sess, se_cmd);
337 static u32 vhost_scsi_sess_get_index(struct se_session *se_sess)
342 static int vhost_scsi_write_pending(struct se_cmd *se_cmd)
344 /* Go ahead and process the write immediately */
345 target_execute_cmd(se_cmd);
349 static void vhost_scsi_set_default_node_attrs(struct se_node_acl *nacl)
354 static int vhost_scsi_get_cmd_state(struct se_cmd *se_cmd)
359 static void vhost_scsi_complete_cmd(struct vhost_scsi_cmd *cmd)
361 struct vhost_scsi *vs = cmd->tvc_vhost;
363 llist_add(&cmd->tvc_completion_list, &vs->vs_completion_list);
365 vhost_work_queue(&vs->dev, &vs->vs_completion_work);
368 static int vhost_scsi_queue_data_in(struct se_cmd *se_cmd)
370 struct vhost_scsi_cmd *cmd = container_of(se_cmd,
371 struct vhost_scsi_cmd, tvc_se_cmd);
372 vhost_scsi_complete_cmd(cmd);
376 static int vhost_scsi_queue_status(struct se_cmd *se_cmd)
378 struct vhost_scsi_cmd *cmd = container_of(se_cmd,
379 struct vhost_scsi_cmd, tvc_se_cmd);
380 vhost_scsi_complete_cmd(cmd);
384 static void vhost_scsi_queue_tm_rsp(struct se_cmd *se_cmd)
389 static void vhost_scsi_aborted_task(struct se_cmd *se_cmd)
394 static void vhost_scsi_free_evt(struct vhost_scsi *vs, struct vhost_scsi_evt *evt)
400 static struct vhost_scsi_evt *
401 vhost_scsi_allocate_evt(struct vhost_scsi *vs,
402 u32 event, u32 reason)
404 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
405 struct vhost_scsi_evt *evt;
407 if (vs->vs_events_nr > VHOST_SCSI_MAX_EVENT) {
408 vs->vs_events_missed = true;
412 evt = kzalloc(sizeof(*evt), GFP_KERNEL);
414 vq_err(vq, "Failed to allocate vhost_scsi_evt\n");
415 vs->vs_events_missed = true;
419 evt->event.event = cpu_to_vhost32(vq, event);
420 evt->event.reason = cpu_to_vhost32(vq, reason);
426 static void vhost_scsi_free_cmd(struct vhost_scsi_cmd *cmd)
428 struct se_cmd *se_cmd = &cmd->tvc_se_cmd;
430 /* TODO locking against target/backend threads? */
431 transport_generic_free_cmd(se_cmd, 0);
435 static int vhost_scsi_check_stop_free(struct se_cmd *se_cmd)
437 return target_put_sess_cmd(se_cmd);
441 vhost_scsi_do_evt_work(struct vhost_scsi *vs, struct vhost_scsi_evt *evt)
443 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
444 struct virtio_scsi_event *event = &evt->event;
445 struct virtio_scsi_event __user *eventp;
449 if (!vq->private_data) {
450 vs->vs_events_missed = true;
455 vhost_disable_notify(&vs->dev, vq);
456 head = vhost_get_vq_desc(vq, vq->iov,
457 ARRAY_SIZE(vq->iov), &out, &in,
460 vs->vs_events_missed = true;
463 if (head == vq->num) {
464 if (vhost_enable_notify(&vs->dev, vq))
466 vs->vs_events_missed = true;
470 if ((vq->iov[out].iov_len != sizeof(struct virtio_scsi_event))) {
471 vq_err(vq, "Expecting virtio_scsi_event, got %zu bytes\n",
472 vq->iov[out].iov_len);
473 vs->vs_events_missed = true;
477 if (vs->vs_events_missed) {
478 event->event |= cpu_to_vhost32(vq, VIRTIO_SCSI_T_EVENTS_MISSED);
479 vs->vs_events_missed = false;
482 eventp = vq->iov[out].iov_base;
483 ret = __copy_to_user(eventp, event, sizeof(*event));
485 vhost_add_used_and_signal(&vs->dev, vq, head, 0);
487 vq_err(vq, "Faulted on vhost_scsi_send_event\n");
490 static void vhost_scsi_evt_work(struct vhost_work *work)
492 struct vhost_scsi *vs = container_of(work, struct vhost_scsi,
494 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
495 struct vhost_scsi_evt *evt, *t;
496 struct llist_node *llnode;
498 mutex_lock(&vq->mutex);
499 llnode = llist_del_all(&vs->vs_event_list);
500 llist_for_each_entry_safe(evt, t, llnode, list) {
501 vhost_scsi_do_evt_work(vs, evt);
502 vhost_scsi_free_evt(vs, evt);
504 mutex_unlock(&vq->mutex);
507 /* Fill in status and signal that we are done processing this command
509 * This is scheduled in the vhost work queue so we are called with the owner
510 * process mm and can access the vring.
512 static void vhost_scsi_complete_cmd_work(struct vhost_work *work)
514 struct vhost_scsi *vs = container_of(work, struct vhost_scsi,
516 DECLARE_BITMAP(signal, VHOST_SCSI_MAX_VQ);
517 struct virtio_scsi_cmd_resp v_rsp;
518 struct vhost_scsi_cmd *cmd, *t;
519 struct llist_node *llnode;
520 struct se_cmd *se_cmd;
521 struct iov_iter iov_iter;
524 bitmap_zero(signal, VHOST_SCSI_MAX_VQ);
525 llnode = llist_del_all(&vs->vs_completion_list);
526 llist_for_each_entry_safe(cmd, t, llnode, tvc_completion_list) {
527 se_cmd = &cmd->tvc_se_cmd;
529 pr_debug("%s tv_cmd %p resid %u status %#02x\n", __func__,
530 cmd, se_cmd->residual_count, se_cmd->scsi_status);
532 memset(&v_rsp, 0, sizeof(v_rsp));
533 v_rsp.resid = cpu_to_vhost32(cmd->tvc_vq, se_cmd->residual_count);
534 /* TODO is status_qualifier field needed? */
535 v_rsp.status = se_cmd->scsi_status;
536 v_rsp.sense_len = cpu_to_vhost32(cmd->tvc_vq,
537 se_cmd->scsi_sense_length);
538 memcpy(v_rsp.sense, cmd->tvc_sense_buf,
539 se_cmd->scsi_sense_length);
541 iov_iter_init(&iov_iter, READ, &cmd->tvc_resp_iov,
542 cmd->tvc_in_iovs, sizeof(v_rsp));
543 ret = copy_to_iter(&v_rsp, sizeof(v_rsp), &iov_iter);
544 if (likely(ret == sizeof(v_rsp))) {
545 struct vhost_scsi_virtqueue *q;
546 vhost_add_used(cmd->tvc_vq, cmd->tvc_vq_desc, 0);
547 q = container_of(cmd->tvc_vq, struct vhost_scsi_virtqueue, vq);
549 __set_bit(vq, signal);
551 pr_err("Faulted on virtio_scsi_cmd_resp\n");
553 vhost_scsi_free_cmd(cmd);
557 while ((vq = find_next_bit(signal, VHOST_SCSI_MAX_VQ, vq + 1))
559 vhost_signal(&vs->dev, &vs->vqs[vq].vq);
562 static struct vhost_scsi_cmd *
563 vhost_scsi_get_tag(struct vhost_virtqueue *vq, struct vhost_scsi_tpg *tpg,
564 unsigned char *cdb, u64 scsi_tag, u16 lun, u8 task_attr,
565 u32 exp_data_len, int data_direction)
567 struct vhost_scsi_cmd *cmd;
568 struct vhost_scsi_nexus *tv_nexus;
569 struct se_session *se_sess;
570 struct scatterlist *sg, *prot_sg;
574 tv_nexus = tpg->tpg_nexus;
576 pr_err("Unable to locate active struct vhost_scsi_nexus\n");
577 return ERR_PTR(-EIO);
579 se_sess = tv_nexus->tvn_se_sess;
581 tag = sbitmap_queue_get(&se_sess->sess_tag_pool, &cpu);
583 pr_err("Unable to obtain tag for vhost_scsi_cmd\n");
584 return ERR_PTR(-ENOMEM);
587 cmd = &((struct vhost_scsi_cmd *)se_sess->sess_cmd_map)[tag];
589 prot_sg = cmd->tvc_prot_sgl;
590 pages = cmd->tvc_upages;
591 memset(cmd, 0, sizeof(*cmd));
593 cmd->tvc_prot_sgl = prot_sg;
594 cmd->tvc_upages = pages;
595 cmd->tvc_se_cmd.map_tag = tag;
596 cmd->tvc_se_cmd.map_cpu = cpu;
597 cmd->tvc_tag = scsi_tag;
599 cmd->tvc_task_attr = task_attr;
600 cmd->tvc_exp_data_len = exp_data_len;
601 cmd->tvc_data_direction = data_direction;
602 cmd->tvc_nexus = tv_nexus;
603 cmd->inflight = vhost_scsi_get_inflight(vq);
605 memcpy(cmd->tvc_cdb, cdb, VHOST_SCSI_MAX_CDB_SIZE);
611 * Map a user memory range into a scatterlist
613 * Returns the number of scatterlist entries used or -errno on error.
616 vhost_scsi_map_to_sgl(struct vhost_scsi_cmd *cmd,
617 struct iov_iter *iter,
618 struct scatterlist *sgl,
621 struct page **pages = cmd->tvc_upages;
622 struct scatterlist *sg = sgl;
625 unsigned int npages = 0;
627 bytes = iov_iter_get_pages(iter, pages, LONG_MAX,
628 VHOST_SCSI_PREALLOC_UPAGES, &offset);
629 /* No pages were pinned */
631 return bytes < 0 ? bytes : -EFAULT;
633 iov_iter_advance(iter, bytes);
636 unsigned n = min_t(unsigned, PAGE_SIZE - offset, bytes);
637 sg_set_page(sg++, pages[npages++], n, offset);
645 vhost_scsi_calc_sgls(struct iov_iter *iter, size_t bytes, int max_sgls)
649 if (!iter || !iter->iov) {
650 pr_err("%s: iter->iov is NULL, but expected bytes: %zu"
651 " present\n", __func__, bytes);
655 sgl_count = iov_iter_npages(iter, 0xffff);
656 if (sgl_count > max_sgls) {
657 pr_err("%s: requested sgl_count: %d exceeds pre-allocated"
658 " max_sgls: %d\n", __func__, sgl_count, max_sgls);
665 vhost_scsi_iov_to_sgl(struct vhost_scsi_cmd *cmd, bool write,
666 struct iov_iter *iter,
667 struct scatterlist *sg, int sg_count)
669 struct scatterlist *p = sg;
672 while (iov_iter_count(iter)) {
673 ret = vhost_scsi_map_to_sgl(cmd, iter, sg, write);
676 struct page *page = sg_page(p++);
688 vhost_scsi_mapal(struct vhost_scsi_cmd *cmd,
689 size_t prot_bytes, struct iov_iter *prot_iter,
690 size_t data_bytes, struct iov_iter *data_iter)
693 bool write = (cmd->tvc_data_direction == DMA_FROM_DEVICE);
696 sgl_count = vhost_scsi_calc_sgls(prot_iter, prot_bytes,
697 VHOST_SCSI_PREALLOC_PROT_SGLS);
701 sg_init_table(cmd->tvc_prot_sgl, sgl_count);
702 cmd->tvc_prot_sgl_count = sgl_count;
703 pr_debug("%s prot_sg %p prot_sgl_count %u\n", __func__,
704 cmd->tvc_prot_sgl, cmd->tvc_prot_sgl_count);
706 ret = vhost_scsi_iov_to_sgl(cmd, write, prot_iter,
708 cmd->tvc_prot_sgl_count);
710 cmd->tvc_prot_sgl_count = 0;
714 sgl_count = vhost_scsi_calc_sgls(data_iter, data_bytes,
715 VHOST_SCSI_PREALLOC_SGLS);
719 sg_init_table(cmd->tvc_sgl, sgl_count);
720 cmd->tvc_sgl_count = sgl_count;
721 pr_debug("%s data_sg %p data_sgl_count %u\n", __func__,
722 cmd->tvc_sgl, cmd->tvc_sgl_count);
724 ret = vhost_scsi_iov_to_sgl(cmd, write, data_iter,
725 cmd->tvc_sgl, cmd->tvc_sgl_count);
727 cmd->tvc_sgl_count = 0;
733 static int vhost_scsi_to_tcm_attr(int attr)
736 case VIRTIO_SCSI_S_SIMPLE:
737 return TCM_SIMPLE_TAG;
738 case VIRTIO_SCSI_S_ORDERED:
739 return TCM_ORDERED_TAG;
740 case VIRTIO_SCSI_S_HEAD:
742 case VIRTIO_SCSI_S_ACA:
747 return TCM_SIMPLE_TAG;
750 static void vhost_scsi_submission_work(struct work_struct *work)
752 struct vhost_scsi_cmd *cmd =
753 container_of(work, struct vhost_scsi_cmd, work);
754 struct vhost_scsi_nexus *tv_nexus;
755 struct se_cmd *se_cmd = &cmd->tvc_se_cmd;
756 struct scatterlist *sg_ptr, *sg_prot_ptr = NULL;
759 /* FIXME: BIDI operation */
760 if (cmd->tvc_sgl_count) {
761 sg_ptr = cmd->tvc_sgl;
763 if (cmd->tvc_prot_sgl_count)
764 sg_prot_ptr = cmd->tvc_prot_sgl;
766 se_cmd->prot_pto = true;
770 tv_nexus = cmd->tvc_nexus;
773 rc = target_submit_cmd_map_sgls(se_cmd, tv_nexus->tvn_se_sess,
774 cmd->tvc_cdb, &cmd->tvc_sense_buf[0],
775 cmd->tvc_lun, cmd->tvc_exp_data_len,
776 vhost_scsi_to_tcm_attr(cmd->tvc_task_attr),
777 cmd->tvc_data_direction, TARGET_SCF_ACK_KREF,
778 sg_ptr, cmd->tvc_sgl_count, NULL, 0, sg_prot_ptr,
779 cmd->tvc_prot_sgl_count);
781 transport_send_check_condition_and_sense(se_cmd,
782 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE, 0);
783 transport_generic_free_cmd(se_cmd, 0);
788 vhost_scsi_send_bad_target(struct vhost_scsi *vs,
789 struct vhost_virtqueue *vq,
790 int head, unsigned out)
792 struct virtio_scsi_cmd_resp __user *resp;
793 struct virtio_scsi_cmd_resp rsp;
796 memset(&rsp, 0, sizeof(rsp));
797 rsp.response = VIRTIO_SCSI_S_BAD_TARGET;
798 resp = vq->iov[out].iov_base;
799 ret = __copy_to_user(resp, &rsp, sizeof(rsp));
801 vhost_add_used_and_signal(&vs->dev, vq, head, 0);
803 pr_err("Faulted on virtio_scsi_cmd_resp\n");
807 vhost_scsi_get_desc(struct vhost_scsi *vs, struct vhost_virtqueue *vq,
808 struct vhost_scsi_ctx *vc)
812 vc->head = vhost_get_vq_desc(vq, vq->iov,
813 ARRAY_SIZE(vq->iov), &vc->out, &vc->in,
816 pr_debug("vhost_get_vq_desc: head: %d, out: %u in: %u\n",
817 vc->head, vc->out, vc->in);
819 /* On error, stop handling until the next kick. */
820 if (unlikely(vc->head < 0))
823 /* Nothing new? Wait for eventfd to tell us they refilled. */
824 if (vc->head == vq->num) {
825 if (unlikely(vhost_enable_notify(&vs->dev, vq))) {
826 vhost_disable_notify(&vs->dev, vq);
833 * Get the size of request and response buffers.
834 * FIXME: Not correct for BIDI operation
836 vc->out_size = iov_length(vq->iov, vc->out);
837 vc->in_size = iov_length(&vq->iov[vc->out], vc->in);
840 * Copy over the virtio-scsi request header, which for a
841 * ANY_LAYOUT enabled guest may span multiple iovecs, or a
842 * single iovec may contain both the header + outgoing
845 * copy_from_iter() will advance out_iter, so that it will
846 * point at the start of the outgoing WRITE payload, if
847 * DMA_TO_DEVICE is set.
849 iov_iter_init(&vc->out_iter, WRITE, vq->iov, vc->out, vc->out_size);
857 vhost_scsi_chk_size(struct vhost_virtqueue *vq, struct vhost_scsi_ctx *vc)
859 if (unlikely(vc->in_size < vc->rsp_size)) {
861 "Response buf too small, need min %zu bytes got %zu",
862 vc->rsp_size, vc->in_size);
864 } else if (unlikely(vc->out_size < vc->req_size)) {
866 "Request buf too small, need min %zu bytes got %zu",
867 vc->req_size, vc->out_size);
875 vhost_scsi_get_req(struct vhost_virtqueue *vq, struct vhost_scsi_ctx *vc,
876 struct vhost_scsi_tpg **tpgp)
880 if (unlikely(!copy_from_iter_full(vc->req, vc->req_size,
882 vq_err(vq, "Faulted on copy_from_iter_full\n");
883 } else if (unlikely(*vc->lunp != 1)) {
884 /* virtio-scsi spec requires byte 0 of the lun to be 1 */
885 vq_err(vq, "Illegal virtio-scsi lun: %u\n", *vc->lunp);
887 struct vhost_scsi_tpg **vs_tpg, *tpg;
889 vs_tpg = vq->private_data; /* validated at handler entry */
891 tpg = READ_ONCE(vs_tpg[*vc->target]);
892 if (unlikely(!tpg)) {
893 vq_err(vq, "Target 0x%x does not exist\n", *vc->target);
905 vhost_scsi_handle_vq(struct vhost_scsi *vs, struct vhost_virtqueue *vq)
907 struct vhost_scsi_tpg **vs_tpg, *tpg;
908 struct virtio_scsi_cmd_req v_req;
909 struct virtio_scsi_cmd_req_pi v_req_pi;
910 struct vhost_scsi_ctx vc;
911 struct vhost_scsi_cmd *cmd;
912 struct iov_iter in_iter, prot_iter, data_iter;
914 u32 exp_data_len, data_direction;
918 bool t10_pi = vhost_has_feature(vq, VIRTIO_SCSI_F_T10_PI);
921 mutex_lock(&vq->mutex);
923 * We can handle the vq only after the endpoint is setup by calling the
924 * VHOST_SCSI_SET_ENDPOINT ioctl.
926 vs_tpg = vq->private_data;
930 memset(&vc, 0, sizeof(vc));
931 vc.rsp_size = sizeof(struct virtio_scsi_cmd_resp);
933 vhost_disable_notify(&vs->dev, vq);
936 ret = vhost_scsi_get_desc(vs, vq, &vc);
941 * Setup pointers and values based upon different virtio-scsi
942 * request header if T10_PI is enabled in KVM guest.
946 vc.req_size = sizeof(v_req_pi);
947 vc.lunp = &v_req_pi.lun[0];
948 vc.target = &v_req_pi.lun[1];
951 vc.req_size = sizeof(v_req);
952 vc.lunp = &v_req.lun[0];
953 vc.target = &v_req.lun[1];
957 * Validate the size of request and response buffers.
958 * Check for a sane response buffer so we can report
959 * early errors back to the guest.
961 ret = vhost_scsi_chk_size(vq, &vc);
965 ret = vhost_scsi_get_req(vq, &vc, &tpg);
969 ret = -EIO; /* bad target on any error from here on */
972 * Determine data_direction by calculating the total outgoing
973 * iovec sizes + incoming iovec sizes vs. virtio-scsi request +
974 * response headers respectively.
976 * For DMA_TO_DEVICE this is out_iter, which is already pointing
977 * to the right place.
979 * For DMA_FROM_DEVICE, the iovec will be just past the end
980 * of the virtio-scsi response header in either the same
981 * or immediately following iovec.
983 * Any associated T10_PI bytes for the outgoing / incoming
984 * payloads are included in calculation of exp_data_len here.
988 if (vc.out_size > vc.req_size) {
989 data_direction = DMA_TO_DEVICE;
990 exp_data_len = vc.out_size - vc.req_size;
991 data_iter = vc.out_iter;
992 } else if (vc.in_size > vc.rsp_size) {
993 data_direction = DMA_FROM_DEVICE;
994 exp_data_len = vc.in_size - vc.rsp_size;
996 iov_iter_init(&in_iter, READ, &vq->iov[vc.out], vc.in,
997 vc.rsp_size + exp_data_len);
998 iov_iter_advance(&in_iter, vc.rsp_size);
1001 data_direction = DMA_NONE;
1005 * If T10_PI header + payload is present, setup prot_iter values
1006 * and recalculate data_iter for vhost_scsi_mapal() mapping to
1007 * host scatterlists via get_user_pages_fast().
1010 if (v_req_pi.pi_bytesout) {
1011 if (data_direction != DMA_TO_DEVICE) {
1012 vq_err(vq, "Received non zero pi_bytesout,"
1013 " but wrong data_direction\n");
1016 prot_bytes = vhost32_to_cpu(vq, v_req_pi.pi_bytesout);
1017 } else if (v_req_pi.pi_bytesin) {
1018 if (data_direction != DMA_FROM_DEVICE) {
1019 vq_err(vq, "Received non zero pi_bytesin,"
1020 " but wrong data_direction\n");
1023 prot_bytes = vhost32_to_cpu(vq, v_req_pi.pi_bytesin);
1026 * Set prot_iter to data_iter and truncate it to
1027 * prot_bytes, and advance data_iter past any
1028 * preceeding prot_bytes that may be present.
1030 * Also fix up the exp_data_len to reflect only the
1031 * actual data payload length.
1034 exp_data_len -= prot_bytes;
1035 prot_iter = data_iter;
1036 iov_iter_truncate(&prot_iter, prot_bytes);
1037 iov_iter_advance(&data_iter, prot_bytes);
1039 tag = vhost64_to_cpu(vq, v_req_pi.tag);
1040 task_attr = v_req_pi.task_attr;
1041 cdb = &v_req_pi.cdb[0];
1042 lun = ((v_req_pi.lun[2] << 8) | v_req_pi.lun[3]) & 0x3FFF;
1044 tag = vhost64_to_cpu(vq, v_req.tag);
1045 task_attr = v_req.task_attr;
1046 cdb = &v_req.cdb[0];
1047 lun = ((v_req.lun[2] << 8) | v_req.lun[3]) & 0x3FFF;
1050 * Check that the received CDB size does not exceeded our
1051 * hardcoded max for vhost-scsi, then get a pre-allocated
1052 * cmd descriptor for the new virtio-scsi tag.
1054 * TODO what if cdb was too small for varlen cdb header?
1056 if (unlikely(scsi_command_size(cdb) > VHOST_SCSI_MAX_CDB_SIZE)) {
1057 vq_err(vq, "Received SCSI CDB with command_size: %d that"
1058 " exceeds SCSI_MAX_VARLEN_CDB_SIZE: %d\n",
1059 scsi_command_size(cdb), VHOST_SCSI_MAX_CDB_SIZE);
1062 cmd = vhost_scsi_get_tag(vq, tpg, cdb, tag, lun, task_attr,
1063 exp_data_len + prot_bytes,
1066 vq_err(vq, "vhost_scsi_get_tag failed %ld\n",
1070 cmd->tvc_vhost = vs;
1072 cmd->tvc_resp_iov = vq->iov[vc.out];
1073 cmd->tvc_in_iovs = vc.in;
1075 pr_debug("vhost_scsi got command opcode: %#02x, lun: %d\n",
1076 cmd->tvc_cdb[0], cmd->tvc_lun);
1077 pr_debug("cmd: %p exp_data_len: %d, prot_bytes: %d data_direction:"
1078 " %d\n", cmd, exp_data_len, prot_bytes, data_direction);
1080 if (data_direction != DMA_NONE) {
1081 if (unlikely(vhost_scsi_mapal(cmd, prot_bytes,
1082 &prot_iter, exp_data_len,
1084 vq_err(vq, "Failed to map iov to sgl\n");
1085 vhost_scsi_release_cmd(&cmd->tvc_se_cmd);
1090 * Save the descriptor from vhost_get_vq_desc() to be used to
1091 * complete the virtio-scsi request in TCM callback context via
1092 * vhost_scsi_queue_data_in() and vhost_scsi_queue_status()
1094 cmd->tvc_vq_desc = vc.head;
1096 * Dispatch cmd descriptor for cmwq execution in process
1097 * context provided by vhost_scsi_workqueue. This also ensures
1098 * cmd is executed on the same kworker CPU as this vhost
1099 * thread to gain positive L2 cache locality effects.
1101 INIT_WORK(&cmd->work, vhost_scsi_submission_work);
1102 queue_work(vhost_scsi_workqueue, &cmd->work);
1106 * ENXIO: No more requests, or read error, wait for next kick
1107 * EINVAL: Invalid response buffer, drop the request
1108 * EIO: Respond with bad target
1109 * EAGAIN: Pending request
1113 else if (ret == -EIO)
1114 vhost_scsi_send_bad_target(vs, vq, vc.head, vc.out);
1117 mutex_unlock(&vq->mutex);
1121 vhost_scsi_send_tmf_reject(struct vhost_scsi *vs,
1122 struct vhost_virtqueue *vq,
1123 struct vhost_scsi_ctx *vc)
1125 struct virtio_scsi_ctrl_tmf_resp rsp;
1126 struct iov_iter iov_iter;
1129 pr_debug("%s\n", __func__);
1130 memset(&rsp, 0, sizeof(rsp));
1131 rsp.response = VIRTIO_SCSI_S_FUNCTION_REJECTED;
1133 iov_iter_init(&iov_iter, READ, &vq->iov[vc->out], vc->in, sizeof(rsp));
1135 ret = copy_to_iter(&rsp, sizeof(rsp), &iov_iter);
1136 if (likely(ret == sizeof(rsp)))
1137 vhost_add_used_and_signal(&vs->dev, vq, vc->head, 0);
1139 pr_err("Faulted on virtio_scsi_ctrl_tmf_resp\n");
1143 vhost_scsi_send_an_resp(struct vhost_scsi *vs,
1144 struct vhost_virtqueue *vq,
1145 struct vhost_scsi_ctx *vc)
1147 struct virtio_scsi_ctrl_an_resp rsp;
1148 struct iov_iter iov_iter;
1151 pr_debug("%s\n", __func__);
1152 memset(&rsp, 0, sizeof(rsp)); /* event_actual = 0 */
1153 rsp.response = VIRTIO_SCSI_S_OK;
1155 iov_iter_init(&iov_iter, READ, &vq->iov[vc->out], vc->in, sizeof(rsp));
1157 ret = copy_to_iter(&rsp, sizeof(rsp), &iov_iter);
1158 if (likely(ret == sizeof(rsp)))
1159 vhost_add_used_and_signal(&vs->dev, vq, vc->head, 0);
1161 pr_err("Faulted on virtio_scsi_ctrl_an_resp\n");
1165 vhost_scsi_ctl_handle_vq(struct vhost_scsi *vs, struct vhost_virtqueue *vq)
1169 struct virtio_scsi_ctrl_an_req an;
1170 struct virtio_scsi_ctrl_tmf_req tmf;
1172 struct vhost_scsi_ctx vc;
1176 mutex_lock(&vq->mutex);
1178 * We can handle the vq only after the endpoint is setup by calling the
1179 * VHOST_SCSI_SET_ENDPOINT ioctl.
1181 if (!vq->private_data)
1184 memset(&vc, 0, sizeof(vc));
1186 vhost_disable_notify(&vs->dev, vq);
1189 ret = vhost_scsi_get_desc(vs, vq, &vc);
1194 * Get the request type first in order to setup
1195 * other parameters dependent on the type.
1197 vc.req = &v_req.type;
1198 typ_size = sizeof(v_req.type);
1200 if (unlikely(!copy_from_iter_full(vc.req, typ_size,
1202 vq_err(vq, "Faulted on copy_from_iter tmf type\n");
1204 * The size of the response buffer depends on the
1205 * request type and must be validated against it.
1206 * Since the request type is not known, don't send
1212 switch (v_req.type) {
1213 case VIRTIO_SCSI_T_TMF:
1214 vc.req = &v_req.tmf;
1215 vc.req_size = sizeof(struct virtio_scsi_ctrl_tmf_req);
1216 vc.rsp_size = sizeof(struct virtio_scsi_ctrl_tmf_resp);
1217 vc.lunp = &v_req.tmf.lun[0];
1218 vc.target = &v_req.tmf.lun[1];
1220 case VIRTIO_SCSI_T_AN_QUERY:
1221 case VIRTIO_SCSI_T_AN_SUBSCRIBE:
1223 vc.req_size = sizeof(struct virtio_scsi_ctrl_an_req);
1224 vc.rsp_size = sizeof(struct virtio_scsi_ctrl_an_resp);
1225 vc.lunp = &v_req.an.lun[0];
1229 vq_err(vq, "Unknown control request %d", v_req.type);
1234 * Validate the size of request and response buffers.
1235 * Check for a sane response buffer so we can report
1236 * early errors back to the guest.
1238 ret = vhost_scsi_chk_size(vq, &vc);
1243 * Get the rest of the request now that its size is known.
1246 vc.req_size -= typ_size;
1248 ret = vhost_scsi_get_req(vq, &vc, NULL);
1252 if (v_req.type == VIRTIO_SCSI_T_TMF)
1253 vhost_scsi_send_tmf_reject(vs, vq, &vc);
1255 vhost_scsi_send_an_resp(vs, vq, &vc);
1258 * ENXIO: No more requests, or read error, wait for next kick
1259 * EINVAL: Invalid response buffer, drop the request
1260 * EIO: Respond with bad target
1261 * EAGAIN: Pending request
1265 else if (ret == -EIO)
1266 vhost_scsi_send_bad_target(vs, vq, vc.head, vc.out);
1269 mutex_unlock(&vq->mutex);
1272 static void vhost_scsi_ctl_handle_kick(struct vhost_work *work)
1274 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1276 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1278 pr_debug("%s: The handling func for control queue.\n", __func__);
1279 vhost_scsi_ctl_handle_vq(vs, vq);
1283 vhost_scsi_send_evt(struct vhost_scsi *vs,
1284 struct vhost_scsi_tpg *tpg,
1289 struct vhost_scsi_evt *evt;
1291 evt = vhost_scsi_allocate_evt(vs, event, reason);
1296 /* TODO: share lun setup code with virtio-scsi.ko */
1298 * Note: evt->event is zeroed when we allocate it and
1299 * lun[4-7] need to be zero according to virtio-scsi spec.
1301 evt->event.lun[0] = 0x01;
1302 evt->event.lun[1] = tpg->tport_tpgt;
1303 if (lun->unpacked_lun >= 256)
1304 evt->event.lun[2] = lun->unpacked_lun >> 8 | 0x40 ;
1305 evt->event.lun[3] = lun->unpacked_lun & 0xFF;
1308 llist_add(&evt->list, &vs->vs_event_list);
1309 vhost_work_queue(&vs->dev, &vs->vs_event_work);
1312 static void vhost_scsi_evt_handle_kick(struct vhost_work *work)
1314 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1316 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1318 mutex_lock(&vq->mutex);
1319 if (!vq->private_data)
1322 if (vs->vs_events_missed)
1323 vhost_scsi_send_evt(vs, NULL, NULL, VIRTIO_SCSI_T_NO_EVENT, 0);
1325 mutex_unlock(&vq->mutex);
1328 static void vhost_scsi_handle_kick(struct vhost_work *work)
1330 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1332 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1334 vhost_scsi_handle_vq(vs, vq);
1337 static void vhost_scsi_flush_vq(struct vhost_scsi *vs, int index)
1339 vhost_poll_flush(&vs->vqs[index].vq.poll);
1342 /* Callers must hold dev mutex */
1343 static void vhost_scsi_flush(struct vhost_scsi *vs)
1345 struct vhost_scsi_inflight *old_inflight[VHOST_SCSI_MAX_VQ];
1348 /* Init new inflight and remember the old inflight */
1349 vhost_scsi_init_inflight(vs, old_inflight);
1352 * The inflight->kref was initialized to 1. We decrement it here to
1353 * indicate the start of the flush operation so that it will reach 0
1354 * when all the reqs are finished.
1356 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1357 kref_put(&old_inflight[i]->kref, vhost_scsi_done_inflight);
1359 /* Flush both the vhost poll and vhost work */
1360 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1361 vhost_scsi_flush_vq(vs, i);
1362 vhost_work_flush(&vs->dev, &vs->vs_completion_work);
1363 vhost_work_flush(&vs->dev, &vs->vs_event_work);
1365 /* Wait for all reqs issued before the flush to be finished */
1366 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1367 wait_for_completion(&old_inflight[i]->comp);
1371 * Called from vhost_scsi_ioctl() context to walk the list of available
1372 * vhost_scsi_tpg with an active struct vhost_scsi_nexus
1374 * The lock nesting rule is:
1375 * vhost_scsi_mutex -> vs->dev.mutex -> tpg->tv_tpg_mutex -> vq->mutex
1378 vhost_scsi_set_endpoint(struct vhost_scsi *vs,
1379 struct vhost_scsi_target *t)
1381 struct se_portal_group *se_tpg;
1382 struct vhost_scsi_tport *tv_tport;
1383 struct vhost_scsi_tpg *tpg;
1384 struct vhost_scsi_tpg **vs_tpg;
1385 struct vhost_virtqueue *vq;
1386 int index, ret, i, len;
1389 mutex_lock(&vhost_scsi_mutex);
1390 mutex_lock(&vs->dev.mutex);
1392 /* Verify that ring has been setup correctly. */
1393 for (index = 0; index < vs->dev.nvqs; ++index) {
1394 /* Verify that ring has been setup correctly. */
1395 if (!vhost_vq_access_ok(&vs->vqs[index].vq)) {
1401 len = sizeof(vs_tpg[0]) * VHOST_SCSI_MAX_TARGET;
1402 vs_tpg = kzalloc(len, GFP_KERNEL);
1408 memcpy(vs_tpg, vs->vs_tpg, len);
1410 list_for_each_entry(tpg, &vhost_scsi_list, tv_tpg_list) {
1411 mutex_lock(&tpg->tv_tpg_mutex);
1412 if (!tpg->tpg_nexus) {
1413 mutex_unlock(&tpg->tv_tpg_mutex);
1416 if (tpg->tv_tpg_vhost_count != 0) {
1417 mutex_unlock(&tpg->tv_tpg_mutex);
1420 tv_tport = tpg->tport;
1422 if (!strcmp(tv_tport->tport_name, t->vhost_wwpn)) {
1423 if (vs->vs_tpg && vs->vs_tpg[tpg->tport_tpgt]) {
1425 mutex_unlock(&tpg->tv_tpg_mutex);
1430 * In order to ensure individual vhost-scsi configfs
1431 * groups cannot be removed while in use by vhost ioctl,
1432 * go ahead and take an explicit se_tpg->tpg_group.cg_item
1435 se_tpg = &tpg->se_tpg;
1436 ret = target_depend_item(&se_tpg->tpg_group.cg_item);
1438 pr_warn("target_depend_item() failed: %d\n", ret);
1440 mutex_unlock(&tpg->tv_tpg_mutex);
1443 tpg->tv_tpg_vhost_count++;
1444 tpg->vhost_scsi = vs;
1445 vs_tpg[tpg->tport_tpgt] = tpg;
1448 mutex_unlock(&tpg->tv_tpg_mutex);
1452 memcpy(vs->vs_vhost_wwpn, t->vhost_wwpn,
1453 sizeof(vs->vs_vhost_wwpn));
1454 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1455 vq = &vs->vqs[i].vq;
1456 mutex_lock(&vq->mutex);
1457 vq->private_data = vs_tpg;
1458 vhost_vq_init_access(vq);
1459 mutex_unlock(&vq->mutex);
1467 * Act as synchronize_rcu to make sure access to
1468 * old vs->vs_tpg is finished.
1470 vhost_scsi_flush(vs);
1472 vs->vs_tpg = vs_tpg;
1475 mutex_unlock(&vs->dev.mutex);
1476 mutex_unlock(&vhost_scsi_mutex);
1481 vhost_scsi_clear_endpoint(struct vhost_scsi *vs,
1482 struct vhost_scsi_target *t)
1484 struct se_portal_group *se_tpg;
1485 struct vhost_scsi_tport *tv_tport;
1486 struct vhost_scsi_tpg *tpg;
1487 struct vhost_virtqueue *vq;
1492 mutex_lock(&vhost_scsi_mutex);
1493 mutex_lock(&vs->dev.mutex);
1494 /* Verify that ring has been setup correctly. */
1495 for (index = 0; index < vs->dev.nvqs; ++index) {
1496 if (!vhost_vq_access_ok(&vs->vqs[index].vq)) {
1507 for (i = 0; i < VHOST_SCSI_MAX_TARGET; i++) {
1509 tpg = vs->vs_tpg[target];
1513 mutex_lock(&tpg->tv_tpg_mutex);
1514 tv_tport = tpg->tport;
1520 if (strcmp(tv_tport->tport_name, t->vhost_wwpn)) {
1521 pr_warn("tv_tport->tport_name: %s, tpg->tport_tpgt: %hu"
1522 " does not match t->vhost_wwpn: %s, t->vhost_tpgt: %hu\n",
1523 tv_tport->tport_name, tpg->tport_tpgt,
1524 t->vhost_wwpn, t->vhost_tpgt);
1528 tpg->tv_tpg_vhost_count--;
1529 tpg->vhost_scsi = NULL;
1530 vs->vs_tpg[target] = NULL;
1532 mutex_unlock(&tpg->tv_tpg_mutex);
1534 * Release se_tpg->tpg_group.cg_item configfs dependency now
1535 * to allow vhost-scsi WWPN se_tpg->tpg_group shutdown to occur.
1537 se_tpg = &tpg->se_tpg;
1538 target_undepend_item(&se_tpg->tpg_group.cg_item);
1541 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1542 vq = &vs->vqs[i].vq;
1543 mutex_lock(&vq->mutex);
1544 vq->private_data = NULL;
1545 mutex_unlock(&vq->mutex);
1549 * Act as synchronize_rcu to make sure access to
1550 * old vs->vs_tpg is finished.
1552 vhost_scsi_flush(vs);
1555 WARN_ON(vs->vs_events_nr);
1556 mutex_unlock(&vs->dev.mutex);
1557 mutex_unlock(&vhost_scsi_mutex);
1561 mutex_unlock(&tpg->tv_tpg_mutex);
1563 mutex_unlock(&vs->dev.mutex);
1564 mutex_unlock(&vhost_scsi_mutex);
1568 static int vhost_scsi_set_features(struct vhost_scsi *vs, u64 features)
1570 struct vhost_virtqueue *vq;
1573 if (features & ~VHOST_SCSI_FEATURES)
1576 mutex_lock(&vs->dev.mutex);
1577 if ((features & (1 << VHOST_F_LOG_ALL)) &&
1578 !vhost_log_access_ok(&vs->dev)) {
1579 mutex_unlock(&vs->dev.mutex);
1583 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1584 vq = &vs->vqs[i].vq;
1585 mutex_lock(&vq->mutex);
1586 vq->acked_features = features;
1587 mutex_unlock(&vq->mutex);
1589 mutex_unlock(&vs->dev.mutex);
1593 static int vhost_scsi_open(struct inode *inode, struct file *f)
1595 struct vhost_scsi *vs;
1596 struct vhost_virtqueue **vqs;
1599 vs = kzalloc(sizeof(*vs), GFP_KERNEL | __GFP_NOWARN | __GFP_RETRY_MAYFAIL);
1601 vs = vzalloc(sizeof(*vs));
1606 vqs = kmalloc_array(VHOST_SCSI_MAX_VQ, sizeof(*vqs), GFP_KERNEL);
1610 vhost_work_init(&vs->vs_completion_work, vhost_scsi_complete_cmd_work);
1611 vhost_work_init(&vs->vs_event_work, vhost_scsi_evt_work);
1613 vs->vs_events_nr = 0;
1614 vs->vs_events_missed = false;
1616 vqs[VHOST_SCSI_VQ_CTL] = &vs->vqs[VHOST_SCSI_VQ_CTL].vq;
1617 vqs[VHOST_SCSI_VQ_EVT] = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1618 vs->vqs[VHOST_SCSI_VQ_CTL].vq.handle_kick = vhost_scsi_ctl_handle_kick;
1619 vs->vqs[VHOST_SCSI_VQ_EVT].vq.handle_kick = vhost_scsi_evt_handle_kick;
1620 for (i = VHOST_SCSI_VQ_IO; i < VHOST_SCSI_MAX_VQ; i++) {
1621 vqs[i] = &vs->vqs[i].vq;
1622 vs->vqs[i].vq.handle_kick = vhost_scsi_handle_kick;
1624 vhost_dev_init(&vs->dev, vqs, VHOST_SCSI_MAX_VQ, UIO_MAXIOV);
1626 vhost_scsi_init_inflight(vs, NULL);
1628 f->private_data = vs;
1637 static int vhost_scsi_release(struct inode *inode, struct file *f)
1639 struct vhost_scsi *vs = f->private_data;
1640 struct vhost_scsi_target t;
1642 mutex_lock(&vs->dev.mutex);
1643 memcpy(t.vhost_wwpn, vs->vs_vhost_wwpn, sizeof(t.vhost_wwpn));
1644 mutex_unlock(&vs->dev.mutex);
1645 vhost_scsi_clear_endpoint(vs, &t);
1646 vhost_dev_stop(&vs->dev);
1647 vhost_dev_cleanup(&vs->dev);
1648 /* Jobs can re-queue themselves in evt kick handler. Do extra flush. */
1649 vhost_scsi_flush(vs);
1656 vhost_scsi_ioctl(struct file *f,
1660 struct vhost_scsi *vs = f->private_data;
1661 struct vhost_scsi_target backend;
1662 void __user *argp = (void __user *)arg;
1663 u64 __user *featurep = argp;
1664 u32 __user *eventsp = argp;
1667 int r, abi_version = VHOST_SCSI_ABI_VERSION;
1668 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1671 case VHOST_SCSI_SET_ENDPOINT:
1672 if (copy_from_user(&backend, argp, sizeof backend))
1674 if (backend.reserved != 0)
1677 return vhost_scsi_set_endpoint(vs, &backend);
1678 case VHOST_SCSI_CLEAR_ENDPOINT:
1679 if (copy_from_user(&backend, argp, sizeof backend))
1681 if (backend.reserved != 0)
1684 return vhost_scsi_clear_endpoint(vs, &backend);
1685 case VHOST_SCSI_GET_ABI_VERSION:
1686 if (copy_to_user(argp, &abi_version, sizeof abi_version))
1689 case VHOST_SCSI_SET_EVENTS_MISSED:
1690 if (get_user(events_missed, eventsp))
1692 mutex_lock(&vq->mutex);
1693 vs->vs_events_missed = events_missed;
1694 mutex_unlock(&vq->mutex);
1696 case VHOST_SCSI_GET_EVENTS_MISSED:
1697 mutex_lock(&vq->mutex);
1698 events_missed = vs->vs_events_missed;
1699 mutex_unlock(&vq->mutex);
1700 if (put_user(events_missed, eventsp))
1703 case VHOST_GET_FEATURES:
1704 features = VHOST_SCSI_FEATURES;
1705 if (copy_to_user(featurep, &features, sizeof features))
1708 case VHOST_SET_FEATURES:
1709 if (copy_from_user(&features, featurep, sizeof features))
1711 return vhost_scsi_set_features(vs, features);
1713 mutex_lock(&vs->dev.mutex);
1714 r = vhost_dev_ioctl(&vs->dev, ioctl, argp);
1715 /* TODO: flush backend after dev ioctl. */
1716 if (r == -ENOIOCTLCMD)
1717 r = vhost_vring_ioctl(&vs->dev, ioctl, argp);
1718 mutex_unlock(&vs->dev.mutex);
1723 #ifdef CONFIG_COMPAT
1724 static long vhost_scsi_compat_ioctl(struct file *f, unsigned int ioctl,
1727 return vhost_scsi_ioctl(f, ioctl, (unsigned long)compat_ptr(arg));
1731 static const struct file_operations vhost_scsi_fops = {
1732 .owner = THIS_MODULE,
1733 .release = vhost_scsi_release,
1734 .unlocked_ioctl = vhost_scsi_ioctl,
1735 #ifdef CONFIG_COMPAT
1736 .compat_ioctl = vhost_scsi_compat_ioctl,
1738 .open = vhost_scsi_open,
1739 .llseek = noop_llseek,
1742 static struct miscdevice vhost_scsi_misc = {
1748 static int __init vhost_scsi_register(void)
1750 return misc_register(&vhost_scsi_misc);
1753 static void vhost_scsi_deregister(void)
1755 misc_deregister(&vhost_scsi_misc);
1758 static char *vhost_scsi_dump_proto_id(struct vhost_scsi_tport *tport)
1760 switch (tport->tport_proto_id) {
1761 case SCSI_PROTOCOL_SAS:
1763 case SCSI_PROTOCOL_FCP:
1765 case SCSI_PROTOCOL_ISCSI:
1775 vhost_scsi_do_plug(struct vhost_scsi_tpg *tpg,
1776 struct se_lun *lun, bool plug)
1779 struct vhost_scsi *vs = tpg->vhost_scsi;
1780 struct vhost_virtqueue *vq;
1786 mutex_lock(&vs->dev.mutex);
1789 reason = VIRTIO_SCSI_EVT_RESET_RESCAN;
1791 reason = VIRTIO_SCSI_EVT_RESET_REMOVED;
1793 vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1794 mutex_lock(&vq->mutex);
1795 if (vhost_has_feature(vq, VIRTIO_SCSI_F_HOTPLUG))
1796 vhost_scsi_send_evt(vs, tpg, lun,
1797 VIRTIO_SCSI_T_TRANSPORT_RESET, reason);
1798 mutex_unlock(&vq->mutex);
1799 mutex_unlock(&vs->dev.mutex);
1802 static void vhost_scsi_hotplug(struct vhost_scsi_tpg *tpg, struct se_lun *lun)
1804 vhost_scsi_do_plug(tpg, lun, true);
1807 static void vhost_scsi_hotunplug(struct vhost_scsi_tpg *tpg, struct se_lun *lun)
1809 vhost_scsi_do_plug(tpg, lun, false);
1812 static int vhost_scsi_port_link(struct se_portal_group *se_tpg,
1815 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1816 struct vhost_scsi_tpg, se_tpg);
1818 mutex_lock(&vhost_scsi_mutex);
1820 mutex_lock(&tpg->tv_tpg_mutex);
1821 tpg->tv_tpg_port_count++;
1822 mutex_unlock(&tpg->tv_tpg_mutex);
1824 vhost_scsi_hotplug(tpg, lun);
1826 mutex_unlock(&vhost_scsi_mutex);
1831 static void vhost_scsi_port_unlink(struct se_portal_group *se_tpg,
1834 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1835 struct vhost_scsi_tpg, se_tpg);
1837 mutex_lock(&vhost_scsi_mutex);
1839 mutex_lock(&tpg->tv_tpg_mutex);
1840 tpg->tv_tpg_port_count--;
1841 mutex_unlock(&tpg->tv_tpg_mutex);
1843 vhost_scsi_hotunplug(tpg, lun);
1845 mutex_unlock(&vhost_scsi_mutex);
1848 static void vhost_scsi_free_cmd_map_res(struct se_session *se_sess)
1850 struct vhost_scsi_cmd *tv_cmd;
1853 if (!se_sess->sess_cmd_map)
1856 for (i = 0; i < VHOST_SCSI_DEFAULT_TAGS; i++) {
1857 tv_cmd = &((struct vhost_scsi_cmd *)se_sess->sess_cmd_map)[i];
1859 kfree(tv_cmd->tvc_sgl);
1860 kfree(tv_cmd->tvc_prot_sgl);
1861 kfree(tv_cmd->tvc_upages);
1865 static ssize_t vhost_scsi_tpg_attrib_fabric_prot_type_store(
1866 struct config_item *item, const char *page, size_t count)
1868 struct se_portal_group *se_tpg = attrib_to_tpg(item);
1869 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1870 struct vhost_scsi_tpg, se_tpg);
1872 int ret = kstrtoul(page, 0, &val);
1875 pr_err("kstrtoul() returned %d for fabric_prot_type\n", ret);
1878 if (val != 0 && val != 1 && val != 3) {
1879 pr_err("Invalid vhost_scsi fabric_prot_type: %lu\n", val);
1882 tpg->tv_fabric_prot_type = val;
1887 static ssize_t vhost_scsi_tpg_attrib_fabric_prot_type_show(
1888 struct config_item *item, char *page)
1890 struct se_portal_group *se_tpg = attrib_to_tpg(item);
1891 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1892 struct vhost_scsi_tpg, se_tpg);
1894 return sprintf(page, "%d\n", tpg->tv_fabric_prot_type);
1897 CONFIGFS_ATTR(vhost_scsi_tpg_attrib_, fabric_prot_type);
1899 static struct configfs_attribute *vhost_scsi_tpg_attrib_attrs[] = {
1900 &vhost_scsi_tpg_attrib_attr_fabric_prot_type,
1904 static int vhost_scsi_nexus_cb(struct se_portal_group *se_tpg,
1905 struct se_session *se_sess, void *p)
1907 struct vhost_scsi_cmd *tv_cmd;
1910 for (i = 0; i < VHOST_SCSI_DEFAULT_TAGS; i++) {
1911 tv_cmd = &((struct vhost_scsi_cmd *)se_sess->sess_cmd_map)[i];
1913 tv_cmd->tvc_sgl = kcalloc(VHOST_SCSI_PREALLOC_SGLS,
1914 sizeof(struct scatterlist),
1916 if (!tv_cmd->tvc_sgl) {
1917 pr_err("Unable to allocate tv_cmd->tvc_sgl\n");
1921 tv_cmd->tvc_upages = kcalloc(VHOST_SCSI_PREALLOC_UPAGES,
1922 sizeof(struct page *),
1924 if (!tv_cmd->tvc_upages) {
1925 pr_err("Unable to allocate tv_cmd->tvc_upages\n");
1929 tv_cmd->tvc_prot_sgl = kcalloc(VHOST_SCSI_PREALLOC_PROT_SGLS,
1930 sizeof(struct scatterlist),
1932 if (!tv_cmd->tvc_prot_sgl) {
1933 pr_err("Unable to allocate tv_cmd->tvc_prot_sgl\n");
1939 vhost_scsi_free_cmd_map_res(se_sess);
1943 static int vhost_scsi_make_nexus(struct vhost_scsi_tpg *tpg,
1946 struct vhost_scsi_nexus *tv_nexus;
1948 mutex_lock(&tpg->tv_tpg_mutex);
1949 if (tpg->tpg_nexus) {
1950 mutex_unlock(&tpg->tv_tpg_mutex);
1951 pr_debug("tpg->tpg_nexus already exists\n");
1955 tv_nexus = kzalloc(sizeof(*tv_nexus), GFP_KERNEL);
1957 mutex_unlock(&tpg->tv_tpg_mutex);
1958 pr_err("Unable to allocate struct vhost_scsi_nexus\n");
1962 * Since we are running in 'demo mode' this call with generate a
1963 * struct se_node_acl for the vhost_scsi struct se_portal_group with
1964 * the SCSI Initiator port name of the passed configfs group 'name'.
1966 tv_nexus->tvn_se_sess = target_setup_session(&tpg->se_tpg,
1967 VHOST_SCSI_DEFAULT_TAGS,
1968 sizeof(struct vhost_scsi_cmd),
1969 TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS,
1970 (unsigned char *)name, tv_nexus,
1971 vhost_scsi_nexus_cb);
1972 if (IS_ERR(tv_nexus->tvn_se_sess)) {
1973 mutex_unlock(&tpg->tv_tpg_mutex);
1977 tpg->tpg_nexus = tv_nexus;
1979 mutex_unlock(&tpg->tv_tpg_mutex);
1983 static int vhost_scsi_drop_nexus(struct vhost_scsi_tpg *tpg)
1985 struct se_session *se_sess;
1986 struct vhost_scsi_nexus *tv_nexus;
1988 mutex_lock(&tpg->tv_tpg_mutex);
1989 tv_nexus = tpg->tpg_nexus;
1991 mutex_unlock(&tpg->tv_tpg_mutex);
1995 se_sess = tv_nexus->tvn_se_sess;
1997 mutex_unlock(&tpg->tv_tpg_mutex);
2001 if (tpg->tv_tpg_port_count != 0) {
2002 mutex_unlock(&tpg->tv_tpg_mutex);
2003 pr_err("Unable to remove TCM_vhost I_T Nexus with"
2004 " active TPG port count: %d\n",
2005 tpg->tv_tpg_port_count);
2009 if (tpg->tv_tpg_vhost_count != 0) {
2010 mutex_unlock(&tpg->tv_tpg_mutex);
2011 pr_err("Unable to remove TCM_vhost I_T Nexus with"
2012 " active TPG vhost count: %d\n",
2013 tpg->tv_tpg_vhost_count);
2017 pr_debug("TCM_vhost_ConfigFS: Removing I_T Nexus to emulated"
2018 " %s Initiator Port: %s\n", vhost_scsi_dump_proto_id(tpg->tport),
2019 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
2021 vhost_scsi_free_cmd_map_res(se_sess);
2023 * Release the SCSI I_T Nexus to the emulated vhost Target Port
2025 target_remove_session(se_sess);
2026 tpg->tpg_nexus = NULL;
2027 mutex_unlock(&tpg->tv_tpg_mutex);
2033 static ssize_t vhost_scsi_tpg_nexus_show(struct config_item *item, char *page)
2035 struct se_portal_group *se_tpg = to_tpg(item);
2036 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2037 struct vhost_scsi_tpg, se_tpg);
2038 struct vhost_scsi_nexus *tv_nexus;
2041 mutex_lock(&tpg->tv_tpg_mutex);
2042 tv_nexus = tpg->tpg_nexus;
2044 mutex_unlock(&tpg->tv_tpg_mutex);
2047 ret = snprintf(page, PAGE_SIZE, "%s\n",
2048 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
2049 mutex_unlock(&tpg->tv_tpg_mutex);
2054 static ssize_t vhost_scsi_tpg_nexus_store(struct config_item *item,
2055 const char *page, size_t count)
2057 struct se_portal_group *se_tpg = to_tpg(item);
2058 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2059 struct vhost_scsi_tpg, se_tpg);
2060 struct vhost_scsi_tport *tport_wwn = tpg->tport;
2061 unsigned char i_port[VHOST_SCSI_NAMELEN], *ptr, *port_ptr;
2064 * Shutdown the active I_T nexus if 'NULL' is passed..
2066 if (!strncmp(page, "NULL", 4)) {
2067 ret = vhost_scsi_drop_nexus(tpg);
2068 return (!ret) ? count : ret;
2071 * Otherwise make sure the passed virtual Initiator port WWN matches
2072 * the fabric protocol_id set in vhost_scsi_make_tport(), and call
2073 * vhost_scsi_make_nexus().
2075 if (strlen(page) >= VHOST_SCSI_NAMELEN) {
2076 pr_err("Emulated NAA Sas Address: %s, exceeds"
2077 " max: %d\n", page, VHOST_SCSI_NAMELEN);
2080 snprintf(&i_port[0], VHOST_SCSI_NAMELEN, "%s", page);
2082 ptr = strstr(i_port, "naa.");
2084 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_SAS) {
2085 pr_err("Passed SAS Initiator Port %s does not"
2086 " match target port protoid: %s\n", i_port,
2087 vhost_scsi_dump_proto_id(tport_wwn));
2090 port_ptr = &i_port[0];
2093 ptr = strstr(i_port, "fc.");
2095 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_FCP) {
2096 pr_err("Passed FCP Initiator Port %s does not"
2097 " match target port protoid: %s\n", i_port,
2098 vhost_scsi_dump_proto_id(tport_wwn));
2101 port_ptr = &i_port[3]; /* Skip over "fc." */
2104 ptr = strstr(i_port, "iqn.");
2106 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_ISCSI) {
2107 pr_err("Passed iSCSI Initiator Port %s does not"
2108 " match target port protoid: %s\n", i_port,
2109 vhost_scsi_dump_proto_id(tport_wwn));
2112 port_ptr = &i_port[0];
2115 pr_err("Unable to locate prefix for emulated Initiator Port:"
2119 * Clear any trailing newline for the NAA WWN
2122 if (i_port[strlen(i_port)-1] == '\n')
2123 i_port[strlen(i_port)-1] = '\0';
2125 ret = vhost_scsi_make_nexus(tpg, port_ptr);
2132 CONFIGFS_ATTR(vhost_scsi_tpg_, nexus);
2134 static struct configfs_attribute *vhost_scsi_tpg_attrs[] = {
2135 &vhost_scsi_tpg_attr_nexus,
2139 static struct se_portal_group *
2140 vhost_scsi_make_tpg(struct se_wwn *wwn, const char *name)
2142 struct vhost_scsi_tport *tport = container_of(wwn,
2143 struct vhost_scsi_tport, tport_wwn);
2145 struct vhost_scsi_tpg *tpg;
2149 if (strstr(name, "tpgt_") != name)
2150 return ERR_PTR(-EINVAL);
2151 if (kstrtou16(name + 5, 10, &tpgt) || tpgt >= VHOST_SCSI_MAX_TARGET)
2152 return ERR_PTR(-EINVAL);
2154 tpg = kzalloc(sizeof(*tpg), GFP_KERNEL);
2156 pr_err("Unable to allocate struct vhost_scsi_tpg");
2157 return ERR_PTR(-ENOMEM);
2159 mutex_init(&tpg->tv_tpg_mutex);
2160 INIT_LIST_HEAD(&tpg->tv_tpg_list);
2162 tpg->tport_tpgt = tpgt;
2164 ret = core_tpg_register(wwn, &tpg->se_tpg, tport->tport_proto_id);
2169 mutex_lock(&vhost_scsi_mutex);
2170 list_add_tail(&tpg->tv_tpg_list, &vhost_scsi_list);
2171 mutex_unlock(&vhost_scsi_mutex);
2173 return &tpg->se_tpg;
2176 static void vhost_scsi_drop_tpg(struct se_portal_group *se_tpg)
2178 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2179 struct vhost_scsi_tpg, se_tpg);
2181 mutex_lock(&vhost_scsi_mutex);
2182 list_del(&tpg->tv_tpg_list);
2183 mutex_unlock(&vhost_scsi_mutex);
2185 * Release the virtual I_T Nexus for this vhost TPG
2187 vhost_scsi_drop_nexus(tpg);
2189 * Deregister the se_tpg from TCM..
2191 core_tpg_deregister(se_tpg);
2195 static struct se_wwn *
2196 vhost_scsi_make_tport(struct target_fabric_configfs *tf,
2197 struct config_group *group,
2200 struct vhost_scsi_tport *tport;
2205 /* if (vhost_scsi_parse_wwn(name, &wwpn, 1) < 0)
2206 return ERR_PTR(-EINVAL); */
2208 tport = kzalloc(sizeof(*tport), GFP_KERNEL);
2210 pr_err("Unable to allocate struct vhost_scsi_tport");
2211 return ERR_PTR(-ENOMEM);
2213 tport->tport_wwpn = wwpn;
2215 * Determine the emulated Protocol Identifier and Target Port Name
2216 * based on the incoming configfs directory name.
2218 ptr = strstr(name, "naa.");
2220 tport->tport_proto_id = SCSI_PROTOCOL_SAS;
2223 ptr = strstr(name, "fc.");
2225 tport->tport_proto_id = SCSI_PROTOCOL_FCP;
2226 off = 3; /* Skip over "fc." */
2229 ptr = strstr(name, "iqn.");
2231 tport->tport_proto_id = SCSI_PROTOCOL_ISCSI;
2235 pr_err("Unable to locate prefix for emulated Target Port:"
2238 return ERR_PTR(-EINVAL);
2241 if (strlen(name) >= VHOST_SCSI_NAMELEN) {
2242 pr_err("Emulated %s Address: %s, exceeds"
2243 " max: %d\n", name, vhost_scsi_dump_proto_id(tport),
2244 VHOST_SCSI_NAMELEN);
2246 return ERR_PTR(-EINVAL);
2248 snprintf(&tport->tport_name[0], VHOST_SCSI_NAMELEN, "%s", &name[off]);
2250 pr_debug("TCM_VHost_ConfigFS: Allocated emulated Target"
2251 " %s Address: %s\n", vhost_scsi_dump_proto_id(tport), name);
2253 return &tport->tport_wwn;
2256 static void vhost_scsi_drop_tport(struct se_wwn *wwn)
2258 struct vhost_scsi_tport *tport = container_of(wwn,
2259 struct vhost_scsi_tport, tport_wwn);
2261 pr_debug("TCM_VHost_ConfigFS: Deallocating emulated Target"
2262 " %s Address: %s\n", vhost_scsi_dump_proto_id(tport),
2269 vhost_scsi_wwn_version_show(struct config_item *item, char *page)
2271 return sprintf(page, "TCM_VHOST fabric module %s on %s/%s"
2272 "on "UTS_RELEASE"\n", VHOST_SCSI_VERSION, utsname()->sysname,
2273 utsname()->machine);
2276 CONFIGFS_ATTR_RO(vhost_scsi_wwn_, version);
2278 static struct configfs_attribute *vhost_scsi_wwn_attrs[] = {
2279 &vhost_scsi_wwn_attr_version,
2283 static const struct target_core_fabric_ops vhost_scsi_ops = {
2284 .module = THIS_MODULE,
2285 .fabric_name = "vhost",
2286 .tpg_get_wwn = vhost_scsi_get_fabric_wwn,
2287 .tpg_get_tag = vhost_scsi_get_tpgt,
2288 .tpg_check_demo_mode = vhost_scsi_check_true,
2289 .tpg_check_demo_mode_cache = vhost_scsi_check_true,
2290 .tpg_check_demo_mode_write_protect = vhost_scsi_check_false,
2291 .tpg_check_prod_mode_write_protect = vhost_scsi_check_false,
2292 .tpg_check_prot_fabric_only = vhost_scsi_check_prot_fabric_only,
2293 .tpg_get_inst_index = vhost_scsi_tpg_get_inst_index,
2294 .release_cmd = vhost_scsi_release_cmd,
2295 .check_stop_free = vhost_scsi_check_stop_free,
2296 .sess_get_index = vhost_scsi_sess_get_index,
2297 .sess_get_initiator_sid = NULL,
2298 .write_pending = vhost_scsi_write_pending,
2299 .set_default_node_attributes = vhost_scsi_set_default_node_attrs,
2300 .get_cmd_state = vhost_scsi_get_cmd_state,
2301 .queue_data_in = vhost_scsi_queue_data_in,
2302 .queue_status = vhost_scsi_queue_status,
2303 .queue_tm_rsp = vhost_scsi_queue_tm_rsp,
2304 .aborted_task = vhost_scsi_aborted_task,
2306 * Setup callers for generic logic in target_core_fabric_configfs.c
2308 .fabric_make_wwn = vhost_scsi_make_tport,
2309 .fabric_drop_wwn = vhost_scsi_drop_tport,
2310 .fabric_make_tpg = vhost_scsi_make_tpg,
2311 .fabric_drop_tpg = vhost_scsi_drop_tpg,
2312 .fabric_post_link = vhost_scsi_port_link,
2313 .fabric_pre_unlink = vhost_scsi_port_unlink,
2315 .tfc_wwn_attrs = vhost_scsi_wwn_attrs,
2316 .tfc_tpg_base_attrs = vhost_scsi_tpg_attrs,
2317 .tfc_tpg_attrib_attrs = vhost_scsi_tpg_attrib_attrs,
2320 static int __init vhost_scsi_init(void)
2324 pr_debug("TCM_VHOST fabric module %s on %s/%s"
2325 " on "UTS_RELEASE"\n", VHOST_SCSI_VERSION, utsname()->sysname,
2326 utsname()->machine);
2329 * Use our own dedicated workqueue for submitting I/O into
2330 * target core to avoid contention within system_wq.
2332 vhost_scsi_workqueue = alloc_workqueue("vhost_scsi", 0, 0);
2333 if (!vhost_scsi_workqueue)
2336 ret = vhost_scsi_register();
2338 goto out_destroy_workqueue;
2340 ret = target_register_template(&vhost_scsi_ops);
2342 goto out_vhost_scsi_deregister;
2346 out_vhost_scsi_deregister:
2347 vhost_scsi_deregister();
2348 out_destroy_workqueue:
2349 destroy_workqueue(vhost_scsi_workqueue);
2354 static void vhost_scsi_exit(void)
2356 target_unregister_template(&vhost_scsi_ops);
2357 vhost_scsi_deregister();
2358 destroy_workqueue(vhost_scsi_workqueue);
2361 MODULE_DESCRIPTION("VHOST_SCSI series fabric driver");
2362 MODULE_ALIAS("tcm_vhost");
2363 MODULE_LICENSE("GPL");
2364 module_init(vhost_scsi_init);
2365 module_exit(vhost_scsi_exit);