r8152: fix tx packets accounting
[linux/fpc-iii.git] / drivers / vhost / scsi.c
blob9e36632b6f0e4a60a63ed12d5fabec244d05b26c
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>
37 #include <linux/fs.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>
49 #include <linux/percpu_ida.h>
51 #include "vhost.h"
53 #define VHOST_SCSI_VERSION "v0.1"
54 #define VHOST_SCSI_NAMELEN 256
55 #define VHOST_SCSI_MAX_CDB_SIZE 32
56 #define VHOST_SCSI_DEFAULT_TAGS 256
57 #define VHOST_SCSI_PREALLOC_SGLS 2048
58 #define VHOST_SCSI_PREALLOC_UPAGES 2048
59 #define VHOST_SCSI_PREALLOC_PROT_SGLS 512
61 struct vhost_scsi_inflight {
62 /* Wait for the flush operation to finish */
63 struct completion comp;
64 /* Refcount for the inflight reqs */
65 struct kref kref;
68 struct vhost_scsi_cmd {
69 /* Descriptor from vhost_get_vq_desc() for virt_queue segment */
70 int tvc_vq_desc;
71 /* virtio-scsi initiator task attribute */
72 int tvc_task_attr;
73 /* virtio-scsi response incoming iovecs */
74 int tvc_in_iovs;
75 /* virtio-scsi initiator data direction */
76 enum dma_data_direction tvc_data_direction;
77 /* Expected data transfer length from virtio-scsi header */
78 u32 tvc_exp_data_len;
79 /* The Tag from include/linux/virtio_scsi.h:struct virtio_scsi_cmd_req */
80 u64 tvc_tag;
81 /* The number of scatterlists associated with this cmd */
82 u32 tvc_sgl_count;
83 u32 tvc_prot_sgl_count;
84 /* Saved unpacked SCSI LUN for vhost_scsi_submission_work() */
85 u32 tvc_lun;
86 /* Pointer to the SGL formatted memory from virtio-scsi */
87 struct scatterlist *tvc_sgl;
88 struct scatterlist *tvc_prot_sgl;
89 struct page **tvc_upages;
90 /* Pointer to response header iovec */
91 struct iovec tvc_resp_iov;
92 /* Pointer to vhost_scsi for our device */
93 struct vhost_scsi *tvc_vhost;
94 /* Pointer to vhost_virtqueue for the cmd */
95 struct vhost_virtqueue *tvc_vq;
96 /* Pointer to vhost nexus memory */
97 struct vhost_scsi_nexus *tvc_nexus;
98 /* The TCM I/O descriptor that is accessed via container_of() */
99 struct se_cmd tvc_se_cmd;
100 /* work item used for cmwq dispatch to vhost_scsi_submission_work() */
101 struct work_struct work;
102 /* Copy of the incoming SCSI command descriptor block (CDB) */
103 unsigned char tvc_cdb[VHOST_SCSI_MAX_CDB_SIZE];
104 /* Sense buffer that will be mapped into outgoing status */
105 unsigned char tvc_sense_buf[TRANSPORT_SENSE_BUFFER];
106 /* Completed commands list, serviced from vhost worker thread */
107 struct llist_node tvc_completion_list;
108 /* Used to track inflight cmd */
109 struct vhost_scsi_inflight *inflight;
112 struct vhost_scsi_nexus {
113 /* Pointer to TCM session for I_T Nexus */
114 struct se_session *tvn_se_sess;
117 struct vhost_scsi_tpg {
118 /* Vhost port target portal group tag for TCM */
119 u16 tport_tpgt;
120 /* Used to track number of TPG Port/Lun Links wrt to explict I_T Nexus shutdown */
121 int tv_tpg_port_count;
122 /* Used for vhost_scsi device reference to tpg_nexus, protected by tv_tpg_mutex */
123 int tv_tpg_vhost_count;
124 /* Used for enabling T10-PI with legacy devices */
125 int tv_fabric_prot_type;
126 /* list for vhost_scsi_list */
127 struct list_head tv_tpg_list;
128 /* Used to protect access for tpg_nexus */
129 struct mutex tv_tpg_mutex;
130 /* Pointer to the TCM VHost I_T Nexus for this TPG endpoint */
131 struct vhost_scsi_nexus *tpg_nexus;
132 /* Pointer back to vhost_scsi_tport */
133 struct vhost_scsi_tport *tport;
134 /* Returned by vhost_scsi_make_tpg() */
135 struct se_portal_group se_tpg;
136 /* Pointer back to vhost_scsi, protected by tv_tpg_mutex */
137 struct vhost_scsi *vhost_scsi;
140 struct vhost_scsi_tport {
141 /* SCSI protocol the tport is providing */
142 u8 tport_proto_id;
143 /* Binary World Wide unique Port Name for Vhost Target port */
144 u64 tport_wwpn;
145 /* ASCII formatted WWPN for Vhost Target port */
146 char tport_name[VHOST_SCSI_NAMELEN];
147 /* Returned by vhost_scsi_make_tport() */
148 struct se_wwn tport_wwn;
151 struct vhost_scsi_evt {
152 /* event to be sent to guest */
153 struct virtio_scsi_event event;
154 /* event list, serviced from vhost worker thread */
155 struct llist_node list;
158 enum {
159 VHOST_SCSI_VQ_CTL = 0,
160 VHOST_SCSI_VQ_EVT = 1,
161 VHOST_SCSI_VQ_IO = 2,
164 /* Note: can't set VIRTIO_F_VERSION_1 yet, since that implies ANY_LAYOUT. */
165 enum {
166 VHOST_SCSI_FEATURES = VHOST_FEATURES | (1ULL << VIRTIO_SCSI_F_HOTPLUG) |
167 (1ULL << VIRTIO_SCSI_F_T10_PI)
170 #define VHOST_SCSI_MAX_TARGET 256
171 #define VHOST_SCSI_MAX_VQ 128
172 #define VHOST_SCSI_MAX_EVENT 128
174 struct vhost_scsi_virtqueue {
175 struct vhost_virtqueue vq;
177 * Reference counting for inflight reqs, used for flush operation. At
178 * each time, one reference tracks new commands submitted, while we
179 * wait for another one to reach 0.
181 struct vhost_scsi_inflight inflights[2];
183 * Indicate current inflight in use, protected by vq->mutex.
184 * Writers must also take dev mutex and flush under it.
186 int inflight_idx;
189 struct vhost_scsi {
190 /* Protected by vhost_scsi->dev.mutex */
191 struct vhost_scsi_tpg **vs_tpg;
192 char vs_vhost_wwpn[TRANSPORT_IQN_LEN];
194 struct vhost_dev dev;
195 struct vhost_scsi_virtqueue vqs[VHOST_SCSI_MAX_VQ];
197 struct vhost_work vs_completion_work; /* cmd completion work item */
198 struct llist_head vs_completion_list; /* cmd completion queue */
200 struct vhost_work vs_event_work; /* evt injection work item */
201 struct llist_head vs_event_list; /* evt injection queue */
203 bool vs_events_missed; /* any missed events, protected by vq->mutex */
204 int vs_events_nr; /* num of pending events, protected by vq->mutex */
207 static struct workqueue_struct *vhost_scsi_workqueue;
209 /* Global spinlock to protect vhost_scsi TPG list for vhost IOCTL access */
210 static DEFINE_MUTEX(vhost_scsi_mutex);
211 static LIST_HEAD(vhost_scsi_list);
213 static int iov_num_pages(void __user *iov_base, size_t iov_len)
215 return (PAGE_ALIGN((unsigned long)iov_base + iov_len) -
216 ((unsigned long)iov_base & PAGE_MASK)) >> PAGE_SHIFT;
219 static void vhost_scsi_done_inflight(struct kref *kref)
221 struct vhost_scsi_inflight *inflight;
223 inflight = container_of(kref, struct vhost_scsi_inflight, kref);
224 complete(&inflight->comp);
227 static void vhost_scsi_init_inflight(struct vhost_scsi *vs,
228 struct vhost_scsi_inflight *old_inflight[])
230 struct vhost_scsi_inflight *new_inflight;
231 struct vhost_virtqueue *vq;
232 int idx, i;
234 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
235 vq = &vs->vqs[i].vq;
237 mutex_lock(&vq->mutex);
239 /* store old infight */
240 idx = vs->vqs[i].inflight_idx;
241 if (old_inflight)
242 old_inflight[i] = &vs->vqs[i].inflights[idx];
244 /* setup new infight */
245 vs->vqs[i].inflight_idx = idx ^ 1;
246 new_inflight = &vs->vqs[i].inflights[idx ^ 1];
247 kref_init(&new_inflight->kref);
248 init_completion(&new_inflight->comp);
250 mutex_unlock(&vq->mutex);
254 static struct vhost_scsi_inflight *
255 vhost_scsi_get_inflight(struct vhost_virtqueue *vq)
257 struct vhost_scsi_inflight *inflight;
258 struct vhost_scsi_virtqueue *svq;
260 svq = container_of(vq, struct vhost_scsi_virtqueue, vq);
261 inflight = &svq->inflights[svq->inflight_idx];
262 kref_get(&inflight->kref);
264 return inflight;
267 static void vhost_scsi_put_inflight(struct vhost_scsi_inflight *inflight)
269 kref_put(&inflight->kref, vhost_scsi_done_inflight);
272 static int vhost_scsi_check_true(struct se_portal_group *se_tpg)
274 return 1;
277 static int vhost_scsi_check_false(struct se_portal_group *se_tpg)
279 return 0;
282 static char *vhost_scsi_get_fabric_name(void)
284 return "vhost";
287 static char *vhost_scsi_get_fabric_wwn(struct se_portal_group *se_tpg)
289 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
290 struct vhost_scsi_tpg, se_tpg);
291 struct vhost_scsi_tport *tport = tpg->tport;
293 return &tport->tport_name[0];
296 static u16 vhost_scsi_get_tpgt(struct se_portal_group *se_tpg)
298 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
299 struct vhost_scsi_tpg, se_tpg);
300 return tpg->tport_tpgt;
303 static int vhost_scsi_check_prot_fabric_only(struct se_portal_group *se_tpg)
305 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
306 struct vhost_scsi_tpg, se_tpg);
308 return tpg->tv_fabric_prot_type;
311 static u32 vhost_scsi_tpg_get_inst_index(struct se_portal_group *se_tpg)
313 return 1;
316 static void vhost_scsi_release_cmd(struct se_cmd *se_cmd)
318 struct vhost_scsi_cmd *tv_cmd = container_of(se_cmd,
319 struct vhost_scsi_cmd, tvc_se_cmd);
320 struct se_session *se_sess = tv_cmd->tvc_nexus->tvn_se_sess;
321 int i;
323 if (tv_cmd->tvc_sgl_count) {
324 for (i = 0; i < tv_cmd->tvc_sgl_count; i++)
325 put_page(sg_page(&tv_cmd->tvc_sgl[i]));
327 if (tv_cmd->tvc_prot_sgl_count) {
328 for (i = 0; i < tv_cmd->tvc_prot_sgl_count; i++)
329 put_page(sg_page(&tv_cmd->tvc_prot_sgl[i]));
332 vhost_scsi_put_inflight(tv_cmd->inflight);
333 percpu_ida_free(&se_sess->sess_tag_pool, se_cmd->map_tag);
336 static u32 vhost_scsi_sess_get_index(struct se_session *se_sess)
338 return 0;
341 static int vhost_scsi_write_pending(struct se_cmd *se_cmd)
343 /* Go ahead and process the write immediately */
344 target_execute_cmd(se_cmd);
345 return 0;
348 static int vhost_scsi_write_pending_status(struct se_cmd *se_cmd)
350 return 0;
353 static void vhost_scsi_set_default_node_attrs(struct se_node_acl *nacl)
355 return;
358 static int vhost_scsi_get_cmd_state(struct se_cmd *se_cmd)
360 return 0;
363 static void vhost_scsi_complete_cmd(struct vhost_scsi_cmd *cmd)
365 struct vhost_scsi *vs = cmd->tvc_vhost;
367 llist_add(&cmd->tvc_completion_list, &vs->vs_completion_list);
369 vhost_work_queue(&vs->dev, &vs->vs_completion_work);
372 static int vhost_scsi_queue_data_in(struct se_cmd *se_cmd)
374 struct vhost_scsi_cmd *cmd = container_of(se_cmd,
375 struct vhost_scsi_cmd, tvc_se_cmd);
376 vhost_scsi_complete_cmd(cmd);
377 return 0;
380 static int vhost_scsi_queue_status(struct se_cmd *se_cmd)
382 struct vhost_scsi_cmd *cmd = container_of(se_cmd,
383 struct vhost_scsi_cmd, tvc_se_cmd);
384 vhost_scsi_complete_cmd(cmd);
385 return 0;
388 static void vhost_scsi_queue_tm_rsp(struct se_cmd *se_cmd)
390 return;
393 static void vhost_scsi_aborted_task(struct se_cmd *se_cmd)
395 return;
398 static void vhost_scsi_free_evt(struct vhost_scsi *vs, struct vhost_scsi_evt *evt)
400 vs->vs_events_nr--;
401 kfree(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;
413 return NULL;
416 evt = kzalloc(sizeof(*evt), GFP_KERNEL);
417 if (!evt) {
418 vq_err(vq, "Failed to allocate vhost_scsi_evt\n");
419 vs->vs_events_missed = true;
420 return NULL;
423 evt->event.event = cpu_to_vhost32(vq, event);
424 evt->event.reason = cpu_to_vhost32(vq, reason);
425 vs->vs_events_nr++;
427 return evt;
430 static void vhost_scsi_free_cmd(struct vhost_scsi_cmd *cmd)
432 struct se_cmd *se_cmd = &cmd->tvc_se_cmd;
434 /* TODO locking against target/backend threads? */
435 transport_generic_free_cmd(se_cmd, 0);
439 static int vhost_scsi_check_stop_free(struct se_cmd *se_cmd)
441 return target_put_sess_cmd(se_cmd);
444 static void
445 vhost_scsi_do_evt_work(struct vhost_scsi *vs, struct vhost_scsi_evt *evt)
447 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
448 struct virtio_scsi_event *event = &evt->event;
449 struct virtio_scsi_event __user *eventp;
450 unsigned out, in;
451 int head, ret;
453 if (!vq->private_data) {
454 vs->vs_events_missed = true;
455 return;
458 again:
459 vhost_disable_notify(&vs->dev, vq);
460 head = vhost_get_vq_desc(vq, vq->iov,
461 ARRAY_SIZE(vq->iov), &out, &in,
462 NULL, NULL);
463 if (head < 0) {
464 vs->vs_events_missed = true;
465 return;
467 if (head == vq->num) {
468 if (vhost_enable_notify(&vs->dev, vq))
469 goto again;
470 vs->vs_events_missed = true;
471 return;
474 if ((vq->iov[out].iov_len != sizeof(struct virtio_scsi_event))) {
475 vq_err(vq, "Expecting virtio_scsi_event, got %zu bytes\n",
476 vq->iov[out].iov_len);
477 vs->vs_events_missed = true;
478 return;
481 if (vs->vs_events_missed) {
482 event->event |= cpu_to_vhost32(vq, VIRTIO_SCSI_T_EVENTS_MISSED);
483 vs->vs_events_missed = false;
486 eventp = vq->iov[out].iov_base;
487 ret = __copy_to_user(eventp, event, sizeof(*event));
488 if (!ret)
489 vhost_add_used_and_signal(&vs->dev, vq, head, 0);
490 else
491 vq_err(vq, "Faulted on vhost_scsi_send_event\n");
494 static void vhost_scsi_evt_work(struct vhost_work *work)
496 struct vhost_scsi *vs = container_of(work, struct vhost_scsi,
497 vs_event_work);
498 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
499 struct vhost_scsi_evt *evt;
500 struct llist_node *llnode;
502 mutex_lock(&vq->mutex);
503 llnode = llist_del_all(&vs->vs_event_list);
504 while (llnode) {
505 evt = llist_entry(llnode, struct vhost_scsi_evt, list);
506 llnode = llist_next(llnode);
507 vhost_scsi_do_evt_work(vs, evt);
508 vhost_scsi_free_evt(vs, evt);
510 mutex_unlock(&vq->mutex);
513 /* Fill in status and signal that we are done processing this command
515 * This is scheduled in the vhost work queue so we are called with the owner
516 * process mm and can access the vring.
518 static void vhost_scsi_complete_cmd_work(struct vhost_work *work)
520 struct vhost_scsi *vs = container_of(work, struct vhost_scsi,
521 vs_completion_work);
522 DECLARE_BITMAP(signal, VHOST_SCSI_MAX_VQ);
523 struct virtio_scsi_cmd_resp v_rsp;
524 struct vhost_scsi_cmd *cmd;
525 struct llist_node *llnode;
526 struct se_cmd *se_cmd;
527 struct iov_iter iov_iter;
528 int ret, vq;
530 bitmap_zero(signal, VHOST_SCSI_MAX_VQ);
531 llnode = llist_del_all(&vs->vs_completion_list);
532 while (llnode) {
533 cmd = llist_entry(llnode, struct vhost_scsi_cmd,
534 tvc_completion_list);
535 llnode = llist_next(llnode);
536 se_cmd = &cmd->tvc_se_cmd;
538 pr_debug("%s tv_cmd %p resid %u status %#02x\n", __func__,
539 cmd, se_cmd->residual_count, se_cmd->scsi_status);
541 memset(&v_rsp, 0, sizeof(v_rsp));
542 v_rsp.resid = cpu_to_vhost32(cmd->tvc_vq, se_cmd->residual_count);
543 /* TODO is status_qualifier field needed? */
544 v_rsp.status = se_cmd->scsi_status;
545 v_rsp.sense_len = cpu_to_vhost32(cmd->tvc_vq,
546 se_cmd->scsi_sense_length);
547 memcpy(v_rsp.sense, cmd->tvc_sense_buf,
548 se_cmd->scsi_sense_length);
550 iov_iter_init(&iov_iter, READ, &cmd->tvc_resp_iov,
551 cmd->tvc_in_iovs, sizeof(v_rsp));
552 ret = copy_to_iter(&v_rsp, sizeof(v_rsp), &iov_iter);
553 if (likely(ret == sizeof(v_rsp))) {
554 struct vhost_scsi_virtqueue *q;
555 vhost_add_used(cmd->tvc_vq, cmd->tvc_vq_desc, 0);
556 q = container_of(cmd->tvc_vq, struct vhost_scsi_virtqueue, vq);
557 vq = q - vs->vqs;
558 __set_bit(vq, signal);
559 } else
560 pr_err("Faulted on virtio_scsi_cmd_resp\n");
562 vhost_scsi_free_cmd(cmd);
565 vq = -1;
566 while ((vq = find_next_bit(signal, VHOST_SCSI_MAX_VQ, vq + 1))
567 < VHOST_SCSI_MAX_VQ)
568 vhost_signal(&vs->dev, &vs->vqs[vq].vq);
571 static struct vhost_scsi_cmd *
572 vhost_scsi_get_tag(struct vhost_virtqueue *vq, struct vhost_scsi_tpg *tpg,
573 unsigned char *cdb, u64 scsi_tag, u16 lun, u8 task_attr,
574 u32 exp_data_len, int data_direction)
576 struct vhost_scsi_cmd *cmd;
577 struct vhost_scsi_nexus *tv_nexus;
578 struct se_session *se_sess;
579 struct scatterlist *sg, *prot_sg;
580 struct page **pages;
581 int tag;
583 tv_nexus = tpg->tpg_nexus;
584 if (!tv_nexus) {
585 pr_err("Unable to locate active struct vhost_scsi_nexus\n");
586 return ERR_PTR(-EIO);
588 se_sess = tv_nexus->tvn_se_sess;
590 tag = percpu_ida_alloc(&se_sess->sess_tag_pool, TASK_RUNNING);
591 if (tag < 0) {
592 pr_err("Unable to obtain tag for vhost_scsi_cmd\n");
593 return ERR_PTR(-ENOMEM);
596 cmd = &((struct vhost_scsi_cmd *)se_sess->sess_cmd_map)[tag];
597 sg = cmd->tvc_sgl;
598 prot_sg = cmd->tvc_prot_sgl;
599 pages = cmd->tvc_upages;
600 memset(cmd, 0, sizeof(struct vhost_scsi_cmd));
602 cmd->tvc_sgl = sg;
603 cmd->tvc_prot_sgl = prot_sg;
604 cmd->tvc_upages = pages;
605 cmd->tvc_se_cmd.map_tag = tag;
606 cmd->tvc_tag = scsi_tag;
607 cmd->tvc_lun = lun;
608 cmd->tvc_task_attr = task_attr;
609 cmd->tvc_exp_data_len = exp_data_len;
610 cmd->tvc_data_direction = data_direction;
611 cmd->tvc_nexus = tv_nexus;
612 cmd->inflight = vhost_scsi_get_inflight(vq);
614 memcpy(cmd->tvc_cdb, cdb, VHOST_SCSI_MAX_CDB_SIZE);
616 return cmd;
620 * Map a user memory range into a scatterlist
622 * Returns the number of scatterlist entries used or -errno on error.
624 static int
625 vhost_scsi_map_to_sgl(struct vhost_scsi_cmd *cmd,
626 void __user *ptr,
627 size_t len,
628 struct scatterlist *sgl,
629 bool write)
631 unsigned int npages = 0, offset, nbytes;
632 unsigned int pages_nr = iov_num_pages(ptr, len);
633 struct scatterlist *sg = sgl;
634 struct page **pages = cmd->tvc_upages;
635 int ret, i;
637 if (pages_nr > VHOST_SCSI_PREALLOC_UPAGES) {
638 pr_err("vhost_scsi_map_to_sgl() pages_nr: %u greater than"
639 " preallocated VHOST_SCSI_PREALLOC_UPAGES: %u\n",
640 pages_nr, VHOST_SCSI_PREALLOC_UPAGES);
641 return -ENOBUFS;
644 ret = get_user_pages_fast((unsigned long)ptr, pages_nr, write, pages);
645 /* No pages were pinned */
646 if (ret < 0)
647 goto out;
648 /* Less pages pinned than wanted */
649 if (ret != pages_nr) {
650 for (i = 0; i < ret; i++)
651 put_page(pages[i]);
652 ret = -EFAULT;
653 goto out;
656 while (len > 0) {
657 offset = (uintptr_t)ptr & ~PAGE_MASK;
658 nbytes = min_t(unsigned int, PAGE_SIZE - offset, len);
659 sg_set_page(sg, pages[npages], nbytes, offset);
660 ptr += nbytes;
661 len -= nbytes;
662 sg++;
663 npages++;
666 out:
667 return ret;
670 static int
671 vhost_scsi_calc_sgls(struct iov_iter *iter, size_t bytes, int max_sgls)
673 int sgl_count = 0;
675 if (!iter || !iter->iov) {
676 pr_err("%s: iter->iov is NULL, but expected bytes: %zu"
677 " present\n", __func__, bytes);
678 return -EINVAL;
681 sgl_count = iov_iter_npages(iter, 0xffff);
682 if (sgl_count > max_sgls) {
683 pr_err("%s: requested sgl_count: %d exceeds pre-allocated"
684 " max_sgls: %d\n", __func__, sgl_count, max_sgls);
685 return -EINVAL;
687 return sgl_count;
690 static int
691 vhost_scsi_iov_to_sgl(struct vhost_scsi_cmd *cmd, bool write,
692 struct iov_iter *iter,
693 struct scatterlist *sg, int sg_count)
695 size_t off = iter->iov_offset;
696 struct scatterlist *p = sg;
697 int i, ret;
699 for (i = 0; i < iter->nr_segs; i++) {
700 void __user *base = iter->iov[i].iov_base + off;
701 size_t len = iter->iov[i].iov_len - off;
703 ret = vhost_scsi_map_to_sgl(cmd, base, len, sg, write);
704 if (ret < 0) {
705 while (p < sg) {
706 struct page *page = sg_page(p++);
707 if (page)
708 put_page(page);
710 return ret;
712 sg += ret;
713 off = 0;
715 return 0;
718 static int
719 vhost_scsi_mapal(struct vhost_scsi_cmd *cmd,
720 size_t prot_bytes, struct iov_iter *prot_iter,
721 size_t data_bytes, struct iov_iter *data_iter)
723 int sgl_count, ret;
724 bool write = (cmd->tvc_data_direction == DMA_FROM_DEVICE);
726 if (prot_bytes) {
727 sgl_count = vhost_scsi_calc_sgls(prot_iter, prot_bytes,
728 VHOST_SCSI_PREALLOC_PROT_SGLS);
729 if (sgl_count < 0)
730 return sgl_count;
732 sg_init_table(cmd->tvc_prot_sgl, sgl_count);
733 cmd->tvc_prot_sgl_count = sgl_count;
734 pr_debug("%s prot_sg %p prot_sgl_count %u\n", __func__,
735 cmd->tvc_prot_sgl, cmd->tvc_prot_sgl_count);
737 ret = vhost_scsi_iov_to_sgl(cmd, write, prot_iter,
738 cmd->tvc_prot_sgl,
739 cmd->tvc_prot_sgl_count);
740 if (ret < 0) {
741 cmd->tvc_prot_sgl_count = 0;
742 return ret;
745 sgl_count = vhost_scsi_calc_sgls(data_iter, data_bytes,
746 VHOST_SCSI_PREALLOC_SGLS);
747 if (sgl_count < 0)
748 return sgl_count;
750 sg_init_table(cmd->tvc_sgl, sgl_count);
751 cmd->tvc_sgl_count = sgl_count;
752 pr_debug("%s data_sg %p data_sgl_count %u\n", __func__,
753 cmd->tvc_sgl, cmd->tvc_sgl_count);
755 ret = vhost_scsi_iov_to_sgl(cmd, write, data_iter,
756 cmd->tvc_sgl, cmd->tvc_sgl_count);
757 if (ret < 0) {
758 cmd->tvc_sgl_count = 0;
759 return ret;
761 return 0;
764 static int vhost_scsi_to_tcm_attr(int attr)
766 switch (attr) {
767 case VIRTIO_SCSI_S_SIMPLE:
768 return TCM_SIMPLE_TAG;
769 case VIRTIO_SCSI_S_ORDERED:
770 return TCM_ORDERED_TAG;
771 case VIRTIO_SCSI_S_HEAD:
772 return TCM_HEAD_TAG;
773 case VIRTIO_SCSI_S_ACA:
774 return TCM_ACA_TAG;
775 default:
776 break;
778 return TCM_SIMPLE_TAG;
781 static void vhost_scsi_submission_work(struct work_struct *work)
783 struct vhost_scsi_cmd *cmd =
784 container_of(work, struct vhost_scsi_cmd, work);
785 struct vhost_scsi_nexus *tv_nexus;
786 struct se_cmd *se_cmd = &cmd->tvc_se_cmd;
787 struct scatterlist *sg_ptr, *sg_prot_ptr = NULL;
788 int rc;
790 /* FIXME: BIDI operation */
791 if (cmd->tvc_sgl_count) {
792 sg_ptr = cmd->tvc_sgl;
794 if (cmd->tvc_prot_sgl_count)
795 sg_prot_ptr = cmd->tvc_prot_sgl;
796 else
797 se_cmd->prot_pto = true;
798 } else {
799 sg_ptr = NULL;
801 tv_nexus = cmd->tvc_nexus;
803 se_cmd->tag = 0;
804 rc = target_submit_cmd_map_sgls(se_cmd, tv_nexus->tvn_se_sess,
805 cmd->tvc_cdb, &cmd->tvc_sense_buf[0],
806 cmd->tvc_lun, cmd->tvc_exp_data_len,
807 vhost_scsi_to_tcm_attr(cmd->tvc_task_attr),
808 cmd->tvc_data_direction, TARGET_SCF_ACK_KREF,
809 sg_ptr, cmd->tvc_sgl_count, NULL, 0, sg_prot_ptr,
810 cmd->tvc_prot_sgl_count);
811 if (rc < 0) {
812 transport_send_check_condition_and_sense(se_cmd,
813 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE, 0);
814 transport_generic_free_cmd(se_cmd, 0);
818 static void
819 vhost_scsi_send_bad_target(struct vhost_scsi *vs,
820 struct vhost_virtqueue *vq,
821 int head, unsigned out)
823 struct virtio_scsi_cmd_resp __user *resp;
824 struct virtio_scsi_cmd_resp rsp;
825 int ret;
827 memset(&rsp, 0, sizeof(rsp));
828 rsp.response = VIRTIO_SCSI_S_BAD_TARGET;
829 resp = vq->iov[out].iov_base;
830 ret = __copy_to_user(resp, &rsp, sizeof(rsp));
831 if (!ret)
832 vhost_add_used_and_signal(&vs->dev, vq, head, 0);
833 else
834 pr_err("Faulted on virtio_scsi_cmd_resp\n");
837 static void
838 vhost_scsi_handle_vq(struct vhost_scsi *vs, struct vhost_virtqueue *vq)
840 struct vhost_scsi_tpg **vs_tpg, *tpg;
841 struct virtio_scsi_cmd_req v_req;
842 struct virtio_scsi_cmd_req_pi v_req_pi;
843 struct vhost_scsi_cmd *cmd;
844 struct iov_iter out_iter, in_iter, prot_iter, data_iter;
845 u64 tag;
846 u32 exp_data_len, data_direction;
847 unsigned out, in;
848 int head, ret, prot_bytes;
849 size_t req_size, rsp_size = sizeof(struct virtio_scsi_cmd_resp);
850 size_t out_size, in_size;
851 u16 lun;
852 u8 *target, *lunp, task_attr;
853 bool t10_pi = vhost_has_feature(vq, VIRTIO_SCSI_F_T10_PI);
854 void *req, *cdb;
856 mutex_lock(&vq->mutex);
858 * We can handle the vq only after the endpoint is setup by calling the
859 * VHOST_SCSI_SET_ENDPOINT ioctl.
861 vs_tpg = vq->private_data;
862 if (!vs_tpg)
863 goto out;
865 vhost_disable_notify(&vs->dev, vq);
867 for (;;) {
868 head = vhost_get_vq_desc(vq, vq->iov,
869 ARRAY_SIZE(vq->iov), &out, &in,
870 NULL, NULL);
871 pr_debug("vhost_get_vq_desc: head: %d, out: %u in: %u\n",
872 head, out, in);
873 /* On error, stop handling until the next kick. */
874 if (unlikely(head < 0))
875 break;
876 /* Nothing new? Wait for eventfd to tell us they refilled. */
877 if (head == vq->num) {
878 if (unlikely(vhost_enable_notify(&vs->dev, vq))) {
879 vhost_disable_notify(&vs->dev, vq);
880 continue;
882 break;
885 * Check for a sane response buffer so we can report early
886 * errors back to the guest.
888 if (unlikely(vq->iov[out].iov_len < rsp_size)) {
889 vq_err(vq, "Expecting at least virtio_scsi_cmd_resp"
890 " size, got %zu bytes\n", vq->iov[out].iov_len);
891 break;
894 * Setup pointers and values based upon different virtio-scsi
895 * request header if T10_PI is enabled in KVM guest.
897 if (t10_pi) {
898 req = &v_req_pi;
899 req_size = sizeof(v_req_pi);
900 lunp = &v_req_pi.lun[0];
901 target = &v_req_pi.lun[1];
902 } else {
903 req = &v_req;
904 req_size = sizeof(v_req);
905 lunp = &v_req.lun[0];
906 target = &v_req.lun[1];
909 * FIXME: Not correct for BIDI operation
911 out_size = iov_length(vq->iov, out);
912 in_size = iov_length(&vq->iov[out], in);
915 * Copy over the virtio-scsi request header, which for a
916 * ANY_LAYOUT enabled guest may span multiple iovecs, or a
917 * single iovec may contain both the header + outgoing
918 * WRITE payloads.
920 * copy_from_iter() will advance out_iter, so that it will
921 * point at the start of the outgoing WRITE payload, if
922 * DMA_TO_DEVICE is set.
924 iov_iter_init(&out_iter, WRITE, vq->iov, out, out_size);
926 ret = copy_from_iter(req, req_size, &out_iter);
927 if (unlikely(ret != req_size)) {
928 vq_err(vq, "Faulted on copy_from_iter\n");
929 vhost_scsi_send_bad_target(vs, vq, head, out);
930 continue;
932 /* virtio-scsi spec requires byte 0 of the lun to be 1 */
933 if (unlikely(*lunp != 1)) {
934 vq_err(vq, "Illegal virtio-scsi lun: %u\n", *lunp);
935 vhost_scsi_send_bad_target(vs, vq, head, out);
936 continue;
939 tpg = ACCESS_ONCE(vs_tpg[*target]);
940 if (unlikely(!tpg)) {
941 /* Target does not exist, fail the request */
942 vhost_scsi_send_bad_target(vs, vq, head, out);
943 continue;
946 * Determine data_direction by calculating the total outgoing
947 * iovec sizes + incoming iovec sizes vs. virtio-scsi request +
948 * response headers respectively.
950 * For DMA_TO_DEVICE this is out_iter, which is already pointing
951 * to the right place.
953 * For DMA_FROM_DEVICE, the iovec will be just past the end
954 * of the virtio-scsi response header in either the same
955 * or immediately following iovec.
957 * Any associated T10_PI bytes for the outgoing / incoming
958 * payloads are included in calculation of exp_data_len here.
960 prot_bytes = 0;
962 if (out_size > req_size) {
963 data_direction = DMA_TO_DEVICE;
964 exp_data_len = out_size - req_size;
965 data_iter = out_iter;
966 } else if (in_size > rsp_size) {
967 data_direction = DMA_FROM_DEVICE;
968 exp_data_len = in_size - rsp_size;
970 iov_iter_init(&in_iter, READ, &vq->iov[out], in,
971 rsp_size + exp_data_len);
972 iov_iter_advance(&in_iter, rsp_size);
973 data_iter = in_iter;
974 } else {
975 data_direction = DMA_NONE;
976 exp_data_len = 0;
979 * If T10_PI header + payload is present, setup prot_iter values
980 * and recalculate data_iter for vhost_scsi_mapal() mapping to
981 * host scatterlists via get_user_pages_fast().
983 if (t10_pi) {
984 if (v_req_pi.pi_bytesout) {
985 if (data_direction != DMA_TO_DEVICE) {
986 vq_err(vq, "Received non zero pi_bytesout,"
987 " but wrong data_direction\n");
988 vhost_scsi_send_bad_target(vs, vq, head, out);
989 continue;
991 prot_bytes = vhost32_to_cpu(vq, v_req_pi.pi_bytesout);
992 } else if (v_req_pi.pi_bytesin) {
993 if (data_direction != DMA_FROM_DEVICE) {
994 vq_err(vq, "Received non zero pi_bytesin,"
995 " but wrong data_direction\n");
996 vhost_scsi_send_bad_target(vs, vq, head, out);
997 continue;
999 prot_bytes = vhost32_to_cpu(vq, v_req_pi.pi_bytesin);
1002 * Set prot_iter to data_iter, and advance past any
1003 * preceeding prot_bytes that may be present.
1005 * Also fix up the exp_data_len to reflect only the
1006 * actual data payload length.
1008 if (prot_bytes) {
1009 exp_data_len -= prot_bytes;
1010 prot_iter = data_iter;
1011 iov_iter_advance(&data_iter, prot_bytes);
1013 tag = vhost64_to_cpu(vq, v_req_pi.tag);
1014 task_attr = v_req_pi.task_attr;
1015 cdb = &v_req_pi.cdb[0];
1016 lun = ((v_req_pi.lun[2] << 8) | v_req_pi.lun[3]) & 0x3FFF;
1017 } else {
1018 tag = vhost64_to_cpu(vq, v_req.tag);
1019 task_attr = v_req.task_attr;
1020 cdb = &v_req.cdb[0];
1021 lun = ((v_req.lun[2] << 8) | v_req.lun[3]) & 0x3FFF;
1024 * Check that the received CDB size does not exceeded our
1025 * hardcoded max for vhost-scsi, then get a pre-allocated
1026 * cmd descriptor for the new virtio-scsi tag.
1028 * TODO what if cdb was too small for varlen cdb header?
1030 if (unlikely(scsi_command_size(cdb) > VHOST_SCSI_MAX_CDB_SIZE)) {
1031 vq_err(vq, "Received SCSI CDB with command_size: %d that"
1032 " exceeds SCSI_MAX_VARLEN_CDB_SIZE: %d\n",
1033 scsi_command_size(cdb), VHOST_SCSI_MAX_CDB_SIZE);
1034 vhost_scsi_send_bad_target(vs, vq, head, out);
1035 continue;
1037 cmd = vhost_scsi_get_tag(vq, tpg, cdb, tag, lun, task_attr,
1038 exp_data_len + prot_bytes,
1039 data_direction);
1040 if (IS_ERR(cmd)) {
1041 vq_err(vq, "vhost_scsi_get_tag failed %ld\n",
1042 PTR_ERR(cmd));
1043 vhost_scsi_send_bad_target(vs, vq, head, out);
1044 continue;
1046 cmd->tvc_vhost = vs;
1047 cmd->tvc_vq = vq;
1048 cmd->tvc_resp_iov = vq->iov[out];
1049 cmd->tvc_in_iovs = in;
1051 pr_debug("vhost_scsi got command opcode: %#02x, lun: %d\n",
1052 cmd->tvc_cdb[0], cmd->tvc_lun);
1053 pr_debug("cmd: %p exp_data_len: %d, prot_bytes: %d data_direction:"
1054 " %d\n", cmd, exp_data_len, prot_bytes, data_direction);
1056 if (data_direction != DMA_NONE) {
1057 ret = vhost_scsi_mapal(cmd,
1058 prot_bytes, &prot_iter,
1059 exp_data_len, &data_iter);
1060 if (unlikely(ret)) {
1061 vq_err(vq, "Failed to map iov to sgl\n");
1062 vhost_scsi_release_cmd(&cmd->tvc_se_cmd);
1063 vhost_scsi_send_bad_target(vs, vq, head, out);
1064 continue;
1068 * Save the descriptor from vhost_get_vq_desc() to be used to
1069 * complete the virtio-scsi request in TCM callback context via
1070 * vhost_scsi_queue_data_in() and vhost_scsi_queue_status()
1072 cmd->tvc_vq_desc = head;
1074 * Dispatch cmd descriptor for cmwq execution in process
1075 * context provided by vhost_scsi_workqueue. This also ensures
1076 * cmd is executed on the same kworker CPU as this vhost
1077 * thread to gain positive L2 cache locality effects.
1079 INIT_WORK(&cmd->work, vhost_scsi_submission_work);
1080 queue_work(vhost_scsi_workqueue, &cmd->work);
1082 out:
1083 mutex_unlock(&vq->mutex);
1086 static void vhost_scsi_ctl_handle_kick(struct vhost_work *work)
1088 pr_debug("%s: The handling func for control queue.\n", __func__);
1091 static void
1092 vhost_scsi_send_evt(struct vhost_scsi *vs,
1093 struct vhost_scsi_tpg *tpg,
1094 struct se_lun *lun,
1095 u32 event,
1096 u32 reason)
1098 struct vhost_scsi_evt *evt;
1100 evt = vhost_scsi_allocate_evt(vs, event, reason);
1101 if (!evt)
1102 return;
1104 if (tpg && lun) {
1105 /* TODO: share lun setup code with virtio-scsi.ko */
1107 * Note: evt->event is zeroed when we allocate it and
1108 * lun[4-7] need to be zero according to virtio-scsi spec.
1110 evt->event.lun[0] = 0x01;
1111 evt->event.lun[1] = tpg->tport_tpgt;
1112 if (lun->unpacked_lun >= 256)
1113 evt->event.lun[2] = lun->unpacked_lun >> 8 | 0x40 ;
1114 evt->event.lun[3] = lun->unpacked_lun & 0xFF;
1117 llist_add(&evt->list, &vs->vs_event_list);
1118 vhost_work_queue(&vs->dev, &vs->vs_event_work);
1121 static void vhost_scsi_evt_handle_kick(struct vhost_work *work)
1123 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1124 poll.work);
1125 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1127 mutex_lock(&vq->mutex);
1128 if (!vq->private_data)
1129 goto out;
1131 if (vs->vs_events_missed)
1132 vhost_scsi_send_evt(vs, NULL, NULL, VIRTIO_SCSI_T_NO_EVENT, 0);
1133 out:
1134 mutex_unlock(&vq->mutex);
1137 static void vhost_scsi_handle_kick(struct vhost_work *work)
1139 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1140 poll.work);
1141 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1143 vhost_scsi_handle_vq(vs, vq);
1146 static void vhost_scsi_flush_vq(struct vhost_scsi *vs, int index)
1148 vhost_poll_flush(&vs->vqs[index].vq.poll);
1151 /* Callers must hold dev mutex */
1152 static void vhost_scsi_flush(struct vhost_scsi *vs)
1154 struct vhost_scsi_inflight *old_inflight[VHOST_SCSI_MAX_VQ];
1155 int i;
1157 /* Init new inflight and remember the old inflight */
1158 vhost_scsi_init_inflight(vs, old_inflight);
1161 * The inflight->kref was initialized to 1. We decrement it here to
1162 * indicate the start of the flush operation so that it will reach 0
1163 * when all the reqs are finished.
1165 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1166 kref_put(&old_inflight[i]->kref, vhost_scsi_done_inflight);
1168 /* Flush both the vhost poll and vhost work */
1169 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1170 vhost_scsi_flush_vq(vs, i);
1171 vhost_work_flush(&vs->dev, &vs->vs_completion_work);
1172 vhost_work_flush(&vs->dev, &vs->vs_event_work);
1174 /* Wait for all reqs issued before the flush to be finished */
1175 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1176 wait_for_completion(&old_inflight[i]->comp);
1180 * Called from vhost_scsi_ioctl() context to walk the list of available
1181 * vhost_scsi_tpg with an active struct vhost_scsi_nexus
1183 * The lock nesting rule is:
1184 * vhost_scsi_mutex -> vs->dev.mutex -> tpg->tv_tpg_mutex -> vq->mutex
1186 static int
1187 vhost_scsi_set_endpoint(struct vhost_scsi *vs,
1188 struct vhost_scsi_target *t)
1190 struct se_portal_group *se_tpg;
1191 struct vhost_scsi_tport *tv_tport;
1192 struct vhost_scsi_tpg *tpg;
1193 struct vhost_scsi_tpg **vs_tpg;
1194 struct vhost_virtqueue *vq;
1195 int index, ret, i, len;
1196 bool match = false;
1198 mutex_lock(&vhost_scsi_mutex);
1199 mutex_lock(&vs->dev.mutex);
1201 /* Verify that ring has been setup correctly. */
1202 for (index = 0; index < vs->dev.nvqs; ++index) {
1203 /* Verify that ring has been setup correctly. */
1204 if (!vhost_vq_access_ok(&vs->vqs[index].vq)) {
1205 ret = -EFAULT;
1206 goto out;
1210 len = sizeof(vs_tpg[0]) * VHOST_SCSI_MAX_TARGET;
1211 vs_tpg = kzalloc(len, GFP_KERNEL);
1212 if (!vs_tpg) {
1213 ret = -ENOMEM;
1214 goto out;
1216 if (vs->vs_tpg)
1217 memcpy(vs_tpg, vs->vs_tpg, len);
1219 list_for_each_entry(tpg, &vhost_scsi_list, tv_tpg_list) {
1220 mutex_lock(&tpg->tv_tpg_mutex);
1221 if (!tpg->tpg_nexus) {
1222 mutex_unlock(&tpg->tv_tpg_mutex);
1223 continue;
1225 if (tpg->tv_tpg_vhost_count != 0) {
1226 mutex_unlock(&tpg->tv_tpg_mutex);
1227 continue;
1229 tv_tport = tpg->tport;
1231 if (!strcmp(tv_tport->tport_name, t->vhost_wwpn)) {
1232 if (vs->vs_tpg && vs->vs_tpg[tpg->tport_tpgt]) {
1233 kfree(vs_tpg);
1234 mutex_unlock(&tpg->tv_tpg_mutex);
1235 ret = -EEXIST;
1236 goto out;
1239 * In order to ensure individual vhost-scsi configfs
1240 * groups cannot be removed while in use by vhost ioctl,
1241 * go ahead and take an explicit se_tpg->tpg_group.cg_item
1242 * dependency now.
1244 se_tpg = &tpg->se_tpg;
1245 ret = target_depend_item(&se_tpg->tpg_group.cg_item);
1246 if (ret) {
1247 pr_warn("configfs_depend_item() failed: %d\n", ret);
1248 kfree(vs_tpg);
1249 mutex_unlock(&tpg->tv_tpg_mutex);
1250 goto out;
1252 tpg->tv_tpg_vhost_count++;
1253 tpg->vhost_scsi = vs;
1254 vs_tpg[tpg->tport_tpgt] = tpg;
1255 smp_mb__after_atomic();
1256 match = true;
1258 mutex_unlock(&tpg->tv_tpg_mutex);
1261 if (match) {
1262 memcpy(vs->vs_vhost_wwpn, t->vhost_wwpn,
1263 sizeof(vs->vs_vhost_wwpn));
1264 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1265 vq = &vs->vqs[i].vq;
1266 mutex_lock(&vq->mutex);
1267 vq->private_data = vs_tpg;
1268 vhost_vq_init_access(vq);
1269 mutex_unlock(&vq->mutex);
1271 ret = 0;
1272 } else {
1273 ret = -EEXIST;
1277 * Act as synchronize_rcu to make sure access to
1278 * old vs->vs_tpg is finished.
1280 vhost_scsi_flush(vs);
1281 kfree(vs->vs_tpg);
1282 vs->vs_tpg = vs_tpg;
1284 out:
1285 mutex_unlock(&vs->dev.mutex);
1286 mutex_unlock(&vhost_scsi_mutex);
1287 return ret;
1290 static int
1291 vhost_scsi_clear_endpoint(struct vhost_scsi *vs,
1292 struct vhost_scsi_target *t)
1294 struct se_portal_group *se_tpg;
1295 struct vhost_scsi_tport *tv_tport;
1296 struct vhost_scsi_tpg *tpg;
1297 struct vhost_virtqueue *vq;
1298 bool match = false;
1299 int index, ret, i;
1300 u8 target;
1302 mutex_lock(&vhost_scsi_mutex);
1303 mutex_lock(&vs->dev.mutex);
1304 /* Verify that ring has been setup correctly. */
1305 for (index = 0; index < vs->dev.nvqs; ++index) {
1306 if (!vhost_vq_access_ok(&vs->vqs[index].vq)) {
1307 ret = -EFAULT;
1308 goto err_dev;
1312 if (!vs->vs_tpg) {
1313 ret = 0;
1314 goto err_dev;
1317 for (i = 0; i < VHOST_SCSI_MAX_TARGET; i++) {
1318 target = i;
1319 tpg = vs->vs_tpg[target];
1320 if (!tpg)
1321 continue;
1323 mutex_lock(&tpg->tv_tpg_mutex);
1324 tv_tport = tpg->tport;
1325 if (!tv_tport) {
1326 ret = -ENODEV;
1327 goto err_tpg;
1330 if (strcmp(tv_tport->tport_name, t->vhost_wwpn)) {
1331 pr_warn("tv_tport->tport_name: %s, tpg->tport_tpgt: %hu"
1332 " does not match t->vhost_wwpn: %s, t->vhost_tpgt: %hu\n",
1333 tv_tport->tport_name, tpg->tport_tpgt,
1334 t->vhost_wwpn, t->vhost_tpgt);
1335 ret = -EINVAL;
1336 goto err_tpg;
1338 tpg->tv_tpg_vhost_count--;
1339 tpg->vhost_scsi = NULL;
1340 vs->vs_tpg[target] = NULL;
1341 match = true;
1342 mutex_unlock(&tpg->tv_tpg_mutex);
1344 * Release se_tpg->tpg_group.cg_item configfs dependency now
1345 * to allow vhost-scsi WWPN se_tpg->tpg_group shutdown to occur.
1347 se_tpg = &tpg->se_tpg;
1348 target_undepend_item(&se_tpg->tpg_group.cg_item);
1350 if (match) {
1351 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1352 vq = &vs->vqs[i].vq;
1353 mutex_lock(&vq->mutex);
1354 vq->private_data = NULL;
1355 mutex_unlock(&vq->mutex);
1359 * Act as synchronize_rcu to make sure access to
1360 * old vs->vs_tpg is finished.
1362 vhost_scsi_flush(vs);
1363 kfree(vs->vs_tpg);
1364 vs->vs_tpg = NULL;
1365 WARN_ON(vs->vs_events_nr);
1366 mutex_unlock(&vs->dev.mutex);
1367 mutex_unlock(&vhost_scsi_mutex);
1368 return 0;
1370 err_tpg:
1371 mutex_unlock(&tpg->tv_tpg_mutex);
1372 err_dev:
1373 mutex_unlock(&vs->dev.mutex);
1374 mutex_unlock(&vhost_scsi_mutex);
1375 return ret;
1378 static int vhost_scsi_set_features(struct vhost_scsi *vs, u64 features)
1380 struct vhost_virtqueue *vq;
1381 int i;
1383 if (features & ~VHOST_SCSI_FEATURES)
1384 return -EOPNOTSUPP;
1386 mutex_lock(&vs->dev.mutex);
1387 if ((features & (1 << VHOST_F_LOG_ALL)) &&
1388 !vhost_log_access_ok(&vs->dev)) {
1389 mutex_unlock(&vs->dev.mutex);
1390 return -EFAULT;
1393 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1394 vq = &vs->vqs[i].vq;
1395 mutex_lock(&vq->mutex);
1396 vq->acked_features = features;
1397 mutex_unlock(&vq->mutex);
1399 mutex_unlock(&vs->dev.mutex);
1400 return 0;
1403 static int vhost_scsi_open(struct inode *inode, struct file *f)
1405 struct vhost_scsi *vs;
1406 struct vhost_virtqueue **vqs;
1407 int r = -ENOMEM, i;
1409 vs = kzalloc(sizeof(*vs), GFP_KERNEL | __GFP_NOWARN | __GFP_REPEAT);
1410 if (!vs) {
1411 vs = vzalloc(sizeof(*vs));
1412 if (!vs)
1413 goto err_vs;
1416 vqs = kmalloc(VHOST_SCSI_MAX_VQ * sizeof(*vqs), GFP_KERNEL);
1417 if (!vqs)
1418 goto err_vqs;
1420 vhost_work_init(&vs->vs_completion_work, vhost_scsi_complete_cmd_work);
1421 vhost_work_init(&vs->vs_event_work, vhost_scsi_evt_work);
1423 vs->vs_events_nr = 0;
1424 vs->vs_events_missed = false;
1426 vqs[VHOST_SCSI_VQ_CTL] = &vs->vqs[VHOST_SCSI_VQ_CTL].vq;
1427 vqs[VHOST_SCSI_VQ_EVT] = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1428 vs->vqs[VHOST_SCSI_VQ_CTL].vq.handle_kick = vhost_scsi_ctl_handle_kick;
1429 vs->vqs[VHOST_SCSI_VQ_EVT].vq.handle_kick = vhost_scsi_evt_handle_kick;
1430 for (i = VHOST_SCSI_VQ_IO; i < VHOST_SCSI_MAX_VQ; i++) {
1431 vqs[i] = &vs->vqs[i].vq;
1432 vs->vqs[i].vq.handle_kick = vhost_scsi_handle_kick;
1434 vhost_dev_init(&vs->dev, vqs, VHOST_SCSI_MAX_VQ);
1436 vhost_scsi_init_inflight(vs, NULL);
1438 f->private_data = vs;
1439 return 0;
1441 err_vqs:
1442 kvfree(vs);
1443 err_vs:
1444 return r;
1447 static int vhost_scsi_release(struct inode *inode, struct file *f)
1449 struct vhost_scsi *vs = f->private_data;
1450 struct vhost_scsi_target t;
1452 mutex_lock(&vs->dev.mutex);
1453 memcpy(t.vhost_wwpn, vs->vs_vhost_wwpn, sizeof(t.vhost_wwpn));
1454 mutex_unlock(&vs->dev.mutex);
1455 vhost_scsi_clear_endpoint(vs, &t);
1456 vhost_dev_stop(&vs->dev);
1457 vhost_dev_cleanup(&vs->dev, false);
1458 /* Jobs can re-queue themselves in evt kick handler. Do extra flush. */
1459 vhost_scsi_flush(vs);
1460 kfree(vs->dev.vqs);
1461 kvfree(vs);
1462 return 0;
1465 static long
1466 vhost_scsi_ioctl(struct file *f,
1467 unsigned int ioctl,
1468 unsigned long arg)
1470 struct vhost_scsi *vs = f->private_data;
1471 struct vhost_scsi_target backend;
1472 void __user *argp = (void __user *)arg;
1473 u64 __user *featurep = argp;
1474 u32 __user *eventsp = argp;
1475 u32 events_missed;
1476 u64 features;
1477 int r, abi_version = VHOST_SCSI_ABI_VERSION;
1478 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1480 switch (ioctl) {
1481 case VHOST_SCSI_SET_ENDPOINT:
1482 if (copy_from_user(&backend, argp, sizeof backend))
1483 return -EFAULT;
1484 if (backend.reserved != 0)
1485 return -EOPNOTSUPP;
1487 return vhost_scsi_set_endpoint(vs, &backend);
1488 case VHOST_SCSI_CLEAR_ENDPOINT:
1489 if (copy_from_user(&backend, argp, sizeof backend))
1490 return -EFAULT;
1491 if (backend.reserved != 0)
1492 return -EOPNOTSUPP;
1494 return vhost_scsi_clear_endpoint(vs, &backend);
1495 case VHOST_SCSI_GET_ABI_VERSION:
1496 if (copy_to_user(argp, &abi_version, sizeof abi_version))
1497 return -EFAULT;
1498 return 0;
1499 case VHOST_SCSI_SET_EVENTS_MISSED:
1500 if (get_user(events_missed, eventsp))
1501 return -EFAULT;
1502 mutex_lock(&vq->mutex);
1503 vs->vs_events_missed = events_missed;
1504 mutex_unlock(&vq->mutex);
1505 return 0;
1506 case VHOST_SCSI_GET_EVENTS_MISSED:
1507 mutex_lock(&vq->mutex);
1508 events_missed = vs->vs_events_missed;
1509 mutex_unlock(&vq->mutex);
1510 if (put_user(events_missed, eventsp))
1511 return -EFAULT;
1512 return 0;
1513 case VHOST_GET_FEATURES:
1514 features = VHOST_SCSI_FEATURES;
1515 if (copy_to_user(featurep, &features, sizeof features))
1516 return -EFAULT;
1517 return 0;
1518 case VHOST_SET_FEATURES:
1519 if (copy_from_user(&features, featurep, sizeof features))
1520 return -EFAULT;
1521 return vhost_scsi_set_features(vs, features);
1522 default:
1523 mutex_lock(&vs->dev.mutex);
1524 r = vhost_dev_ioctl(&vs->dev, ioctl, argp);
1525 /* TODO: flush backend after dev ioctl. */
1526 if (r == -ENOIOCTLCMD)
1527 r = vhost_vring_ioctl(&vs->dev, ioctl, argp);
1528 mutex_unlock(&vs->dev.mutex);
1529 return r;
1533 #ifdef CONFIG_COMPAT
1534 static long vhost_scsi_compat_ioctl(struct file *f, unsigned int ioctl,
1535 unsigned long arg)
1537 return vhost_scsi_ioctl(f, ioctl, (unsigned long)compat_ptr(arg));
1539 #endif
1541 static const struct file_operations vhost_scsi_fops = {
1542 .owner = THIS_MODULE,
1543 .release = vhost_scsi_release,
1544 .unlocked_ioctl = vhost_scsi_ioctl,
1545 #ifdef CONFIG_COMPAT
1546 .compat_ioctl = vhost_scsi_compat_ioctl,
1547 #endif
1548 .open = vhost_scsi_open,
1549 .llseek = noop_llseek,
1552 static struct miscdevice vhost_scsi_misc = {
1553 MISC_DYNAMIC_MINOR,
1554 "vhost-scsi",
1555 &vhost_scsi_fops,
1558 static int __init vhost_scsi_register(void)
1560 return misc_register(&vhost_scsi_misc);
1563 static void vhost_scsi_deregister(void)
1565 misc_deregister(&vhost_scsi_misc);
1568 static char *vhost_scsi_dump_proto_id(struct vhost_scsi_tport *tport)
1570 switch (tport->tport_proto_id) {
1571 case SCSI_PROTOCOL_SAS:
1572 return "SAS";
1573 case SCSI_PROTOCOL_FCP:
1574 return "FCP";
1575 case SCSI_PROTOCOL_ISCSI:
1576 return "iSCSI";
1577 default:
1578 break;
1581 return "Unknown";
1584 static void
1585 vhost_scsi_do_plug(struct vhost_scsi_tpg *tpg,
1586 struct se_lun *lun, bool plug)
1589 struct vhost_scsi *vs = tpg->vhost_scsi;
1590 struct vhost_virtqueue *vq;
1591 u32 reason;
1593 if (!vs)
1594 return;
1596 mutex_lock(&vs->dev.mutex);
1598 if (plug)
1599 reason = VIRTIO_SCSI_EVT_RESET_RESCAN;
1600 else
1601 reason = VIRTIO_SCSI_EVT_RESET_REMOVED;
1603 vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1604 mutex_lock(&vq->mutex);
1605 if (vhost_has_feature(vq, VIRTIO_SCSI_F_HOTPLUG))
1606 vhost_scsi_send_evt(vs, tpg, lun,
1607 VIRTIO_SCSI_T_TRANSPORT_RESET, reason);
1608 mutex_unlock(&vq->mutex);
1609 mutex_unlock(&vs->dev.mutex);
1612 static void vhost_scsi_hotplug(struct vhost_scsi_tpg *tpg, struct se_lun *lun)
1614 vhost_scsi_do_plug(tpg, lun, true);
1617 static void vhost_scsi_hotunplug(struct vhost_scsi_tpg *tpg, struct se_lun *lun)
1619 vhost_scsi_do_plug(tpg, lun, false);
1622 static int vhost_scsi_port_link(struct se_portal_group *se_tpg,
1623 struct se_lun *lun)
1625 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1626 struct vhost_scsi_tpg, se_tpg);
1628 mutex_lock(&vhost_scsi_mutex);
1630 mutex_lock(&tpg->tv_tpg_mutex);
1631 tpg->tv_tpg_port_count++;
1632 mutex_unlock(&tpg->tv_tpg_mutex);
1634 vhost_scsi_hotplug(tpg, lun);
1636 mutex_unlock(&vhost_scsi_mutex);
1638 return 0;
1641 static void vhost_scsi_port_unlink(struct se_portal_group *se_tpg,
1642 struct se_lun *lun)
1644 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1645 struct vhost_scsi_tpg, se_tpg);
1647 mutex_lock(&vhost_scsi_mutex);
1649 mutex_lock(&tpg->tv_tpg_mutex);
1650 tpg->tv_tpg_port_count--;
1651 mutex_unlock(&tpg->tv_tpg_mutex);
1653 vhost_scsi_hotunplug(tpg, lun);
1655 mutex_unlock(&vhost_scsi_mutex);
1658 static void vhost_scsi_free_cmd_map_res(struct se_session *se_sess)
1660 struct vhost_scsi_cmd *tv_cmd;
1661 unsigned int i;
1663 if (!se_sess->sess_cmd_map)
1664 return;
1666 for (i = 0; i < VHOST_SCSI_DEFAULT_TAGS; i++) {
1667 tv_cmd = &((struct vhost_scsi_cmd *)se_sess->sess_cmd_map)[i];
1669 kfree(tv_cmd->tvc_sgl);
1670 kfree(tv_cmd->tvc_prot_sgl);
1671 kfree(tv_cmd->tvc_upages);
1675 static ssize_t vhost_scsi_tpg_attrib_fabric_prot_type_store(
1676 struct config_item *item, const char *page, size_t count)
1678 struct se_portal_group *se_tpg = attrib_to_tpg(item);
1679 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1680 struct vhost_scsi_tpg, se_tpg);
1681 unsigned long val;
1682 int ret = kstrtoul(page, 0, &val);
1684 if (ret) {
1685 pr_err("kstrtoul() returned %d for fabric_prot_type\n", ret);
1686 return ret;
1688 if (val != 0 && val != 1 && val != 3) {
1689 pr_err("Invalid vhost_scsi fabric_prot_type: %lu\n", val);
1690 return -EINVAL;
1692 tpg->tv_fabric_prot_type = val;
1694 return count;
1697 static ssize_t vhost_scsi_tpg_attrib_fabric_prot_type_show(
1698 struct config_item *item, char *page)
1700 struct se_portal_group *se_tpg = attrib_to_tpg(item);
1701 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1702 struct vhost_scsi_tpg, se_tpg);
1704 return sprintf(page, "%d\n", tpg->tv_fabric_prot_type);
1707 CONFIGFS_ATTR(vhost_scsi_tpg_attrib_, fabric_prot_type);
1709 static struct configfs_attribute *vhost_scsi_tpg_attrib_attrs[] = {
1710 &vhost_scsi_tpg_attrib_attr_fabric_prot_type,
1711 NULL,
1714 static int vhost_scsi_nexus_cb(struct se_portal_group *se_tpg,
1715 struct se_session *se_sess, void *p)
1717 struct vhost_scsi_cmd *tv_cmd;
1718 unsigned int i;
1720 for (i = 0; i < VHOST_SCSI_DEFAULT_TAGS; i++) {
1721 tv_cmd = &((struct vhost_scsi_cmd *)se_sess->sess_cmd_map)[i];
1723 tv_cmd->tvc_sgl = kzalloc(sizeof(struct scatterlist) *
1724 VHOST_SCSI_PREALLOC_SGLS, GFP_KERNEL);
1725 if (!tv_cmd->tvc_sgl) {
1726 pr_err("Unable to allocate tv_cmd->tvc_sgl\n");
1727 goto out;
1730 tv_cmd->tvc_upages = kzalloc(sizeof(struct page *) *
1731 VHOST_SCSI_PREALLOC_UPAGES, GFP_KERNEL);
1732 if (!tv_cmd->tvc_upages) {
1733 pr_err("Unable to allocate tv_cmd->tvc_upages\n");
1734 goto out;
1737 tv_cmd->tvc_prot_sgl = kzalloc(sizeof(struct scatterlist) *
1738 VHOST_SCSI_PREALLOC_PROT_SGLS, GFP_KERNEL);
1739 if (!tv_cmd->tvc_prot_sgl) {
1740 pr_err("Unable to allocate tv_cmd->tvc_prot_sgl\n");
1741 goto out;
1744 return 0;
1745 out:
1746 vhost_scsi_free_cmd_map_res(se_sess);
1747 return -ENOMEM;
1750 static int vhost_scsi_make_nexus(struct vhost_scsi_tpg *tpg,
1751 const char *name)
1753 struct se_portal_group *se_tpg;
1754 struct vhost_scsi_nexus *tv_nexus;
1756 mutex_lock(&tpg->tv_tpg_mutex);
1757 if (tpg->tpg_nexus) {
1758 mutex_unlock(&tpg->tv_tpg_mutex);
1759 pr_debug("tpg->tpg_nexus already exists\n");
1760 return -EEXIST;
1762 se_tpg = &tpg->se_tpg;
1764 tv_nexus = kzalloc(sizeof(struct vhost_scsi_nexus), GFP_KERNEL);
1765 if (!tv_nexus) {
1766 mutex_unlock(&tpg->tv_tpg_mutex);
1767 pr_err("Unable to allocate struct vhost_scsi_nexus\n");
1768 return -ENOMEM;
1771 * Since we are running in 'demo mode' this call with generate a
1772 * struct se_node_acl for the vhost_scsi struct se_portal_group with
1773 * the SCSI Initiator port name of the passed configfs group 'name'.
1775 tv_nexus->tvn_se_sess = target_alloc_session(&tpg->se_tpg,
1776 VHOST_SCSI_DEFAULT_TAGS,
1777 sizeof(struct vhost_scsi_cmd),
1778 TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS,
1779 (unsigned char *)name, tv_nexus,
1780 vhost_scsi_nexus_cb);
1781 if (IS_ERR(tv_nexus->tvn_se_sess)) {
1782 mutex_unlock(&tpg->tv_tpg_mutex);
1783 kfree(tv_nexus);
1784 return -ENOMEM;
1786 tpg->tpg_nexus = tv_nexus;
1788 mutex_unlock(&tpg->tv_tpg_mutex);
1789 return 0;
1792 static int vhost_scsi_drop_nexus(struct vhost_scsi_tpg *tpg)
1794 struct se_session *se_sess;
1795 struct vhost_scsi_nexus *tv_nexus;
1797 mutex_lock(&tpg->tv_tpg_mutex);
1798 tv_nexus = tpg->tpg_nexus;
1799 if (!tv_nexus) {
1800 mutex_unlock(&tpg->tv_tpg_mutex);
1801 return -ENODEV;
1804 se_sess = tv_nexus->tvn_se_sess;
1805 if (!se_sess) {
1806 mutex_unlock(&tpg->tv_tpg_mutex);
1807 return -ENODEV;
1810 if (tpg->tv_tpg_port_count != 0) {
1811 mutex_unlock(&tpg->tv_tpg_mutex);
1812 pr_err("Unable to remove TCM_vhost I_T Nexus with"
1813 " active TPG port count: %d\n",
1814 tpg->tv_tpg_port_count);
1815 return -EBUSY;
1818 if (tpg->tv_tpg_vhost_count != 0) {
1819 mutex_unlock(&tpg->tv_tpg_mutex);
1820 pr_err("Unable to remove TCM_vhost I_T Nexus with"
1821 " active TPG vhost count: %d\n",
1822 tpg->tv_tpg_vhost_count);
1823 return -EBUSY;
1826 pr_debug("TCM_vhost_ConfigFS: Removing I_T Nexus to emulated"
1827 " %s Initiator Port: %s\n", vhost_scsi_dump_proto_id(tpg->tport),
1828 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1830 vhost_scsi_free_cmd_map_res(se_sess);
1832 * Release the SCSI I_T Nexus to the emulated vhost Target Port
1834 transport_deregister_session(tv_nexus->tvn_se_sess);
1835 tpg->tpg_nexus = NULL;
1836 mutex_unlock(&tpg->tv_tpg_mutex);
1838 kfree(tv_nexus);
1839 return 0;
1842 static ssize_t vhost_scsi_tpg_nexus_show(struct config_item *item, char *page)
1844 struct se_portal_group *se_tpg = to_tpg(item);
1845 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1846 struct vhost_scsi_tpg, se_tpg);
1847 struct vhost_scsi_nexus *tv_nexus;
1848 ssize_t ret;
1850 mutex_lock(&tpg->tv_tpg_mutex);
1851 tv_nexus = tpg->tpg_nexus;
1852 if (!tv_nexus) {
1853 mutex_unlock(&tpg->tv_tpg_mutex);
1854 return -ENODEV;
1856 ret = snprintf(page, PAGE_SIZE, "%s\n",
1857 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1858 mutex_unlock(&tpg->tv_tpg_mutex);
1860 return ret;
1863 static ssize_t vhost_scsi_tpg_nexus_store(struct config_item *item,
1864 const char *page, size_t count)
1866 struct se_portal_group *se_tpg = to_tpg(item);
1867 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1868 struct vhost_scsi_tpg, se_tpg);
1869 struct vhost_scsi_tport *tport_wwn = tpg->tport;
1870 unsigned char i_port[VHOST_SCSI_NAMELEN], *ptr, *port_ptr;
1871 int ret;
1873 * Shutdown the active I_T nexus if 'NULL' is passed..
1875 if (!strncmp(page, "NULL", 4)) {
1876 ret = vhost_scsi_drop_nexus(tpg);
1877 return (!ret) ? count : ret;
1880 * Otherwise make sure the passed virtual Initiator port WWN matches
1881 * the fabric protocol_id set in vhost_scsi_make_tport(), and call
1882 * vhost_scsi_make_nexus().
1884 if (strlen(page) >= VHOST_SCSI_NAMELEN) {
1885 pr_err("Emulated NAA Sas Address: %s, exceeds"
1886 " max: %d\n", page, VHOST_SCSI_NAMELEN);
1887 return -EINVAL;
1889 snprintf(&i_port[0], VHOST_SCSI_NAMELEN, "%s", page);
1891 ptr = strstr(i_port, "naa.");
1892 if (ptr) {
1893 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_SAS) {
1894 pr_err("Passed SAS Initiator Port %s does not"
1895 " match target port protoid: %s\n", i_port,
1896 vhost_scsi_dump_proto_id(tport_wwn));
1897 return -EINVAL;
1899 port_ptr = &i_port[0];
1900 goto check_newline;
1902 ptr = strstr(i_port, "fc.");
1903 if (ptr) {
1904 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_FCP) {
1905 pr_err("Passed FCP Initiator Port %s does not"
1906 " match target port protoid: %s\n", i_port,
1907 vhost_scsi_dump_proto_id(tport_wwn));
1908 return -EINVAL;
1910 port_ptr = &i_port[3]; /* Skip over "fc." */
1911 goto check_newline;
1913 ptr = strstr(i_port, "iqn.");
1914 if (ptr) {
1915 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_ISCSI) {
1916 pr_err("Passed iSCSI Initiator Port %s does not"
1917 " match target port protoid: %s\n", i_port,
1918 vhost_scsi_dump_proto_id(tport_wwn));
1919 return -EINVAL;
1921 port_ptr = &i_port[0];
1922 goto check_newline;
1924 pr_err("Unable to locate prefix for emulated Initiator Port:"
1925 " %s\n", i_port);
1926 return -EINVAL;
1928 * Clear any trailing newline for the NAA WWN
1930 check_newline:
1931 if (i_port[strlen(i_port)-1] == '\n')
1932 i_port[strlen(i_port)-1] = '\0';
1934 ret = vhost_scsi_make_nexus(tpg, port_ptr);
1935 if (ret < 0)
1936 return ret;
1938 return count;
1941 CONFIGFS_ATTR(vhost_scsi_tpg_, nexus);
1943 static struct configfs_attribute *vhost_scsi_tpg_attrs[] = {
1944 &vhost_scsi_tpg_attr_nexus,
1945 NULL,
1948 static struct se_portal_group *
1949 vhost_scsi_make_tpg(struct se_wwn *wwn,
1950 struct config_group *group,
1951 const char *name)
1953 struct vhost_scsi_tport *tport = container_of(wwn,
1954 struct vhost_scsi_tport, tport_wwn);
1956 struct vhost_scsi_tpg *tpg;
1957 u16 tpgt;
1958 int ret;
1960 if (strstr(name, "tpgt_") != name)
1961 return ERR_PTR(-EINVAL);
1962 if (kstrtou16(name + 5, 10, &tpgt) || tpgt >= VHOST_SCSI_MAX_TARGET)
1963 return ERR_PTR(-EINVAL);
1965 tpg = kzalloc(sizeof(struct vhost_scsi_tpg), GFP_KERNEL);
1966 if (!tpg) {
1967 pr_err("Unable to allocate struct vhost_scsi_tpg");
1968 return ERR_PTR(-ENOMEM);
1970 mutex_init(&tpg->tv_tpg_mutex);
1971 INIT_LIST_HEAD(&tpg->tv_tpg_list);
1972 tpg->tport = tport;
1973 tpg->tport_tpgt = tpgt;
1975 ret = core_tpg_register(wwn, &tpg->se_tpg, tport->tport_proto_id);
1976 if (ret < 0) {
1977 kfree(tpg);
1978 return NULL;
1980 mutex_lock(&vhost_scsi_mutex);
1981 list_add_tail(&tpg->tv_tpg_list, &vhost_scsi_list);
1982 mutex_unlock(&vhost_scsi_mutex);
1984 return &tpg->se_tpg;
1987 static void vhost_scsi_drop_tpg(struct se_portal_group *se_tpg)
1989 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1990 struct vhost_scsi_tpg, se_tpg);
1992 mutex_lock(&vhost_scsi_mutex);
1993 list_del(&tpg->tv_tpg_list);
1994 mutex_unlock(&vhost_scsi_mutex);
1996 * Release the virtual I_T Nexus for this vhost TPG
1998 vhost_scsi_drop_nexus(tpg);
2000 * Deregister the se_tpg from TCM..
2002 core_tpg_deregister(se_tpg);
2003 kfree(tpg);
2006 static struct se_wwn *
2007 vhost_scsi_make_tport(struct target_fabric_configfs *tf,
2008 struct config_group *group,
2009 const char *name)
2011 struct vhost_scsi_tport *tport;
2012 char *ptr;
2013 u64 wwpn = 0;
2014 int off = 0;
2016 /* if (vhost_scsi_parse_wwn(name, &wwpn, 1) < 0)
2017 return ERR_PTR(-EINVAL); */
2019 tport = kzalloc(sizeof(struct vhost_scsi_tport), GFP_KERNEL);
2020 if (!tport) {
2021 pr_err("Unable to allocate struct vhost_scsi_tport");
2022 return ERR_PTR(-ENOMEM);
2024 tport->tport_wwpn = wwpn;
2026 * Determine the emulated Protocol Identifier and Target Port Name
2027 * based on the incoming configfs directory name.
2029 ptr = strstr(name, "naa.");
2030 if (ptr) {
2031 tport->tport_proto_id = SCSI_PROTOCOL_SAS;
2032 goto check_len;
2034 ptr = strstr(name, "fc.");
2035 if (ptr) {
2036 tport->tport_proto_id = SCSI_PROTOCOL_FCP;
2037 off = 3; /* Skip over "fc." */
2038 goto check_len;
2040 ptr = strstr(name, "iqn.");
2041 if (ptr) {
2042 tport->tport_proto_id = SCSI_PROTOCOL_ISCSI;
2043 goto check_len;
2046 pr_err("Unable to locate prefix for emulated Target Port:"
2047 " %s\n", name);
2048 kfree(tport);
2049 return ERR_PTR(-EINVAL);
2051 check_len:
2052 if (strlen(name) >= VHOST_SCSI_NAMELEN) {
2053 pr_err("Emulated %s Address: %s, exceeds"
2054 " max: %d\n", name, vhost_scsi_dump_proto_id(tport),
2055 VHOST_SCSI_NAMELEN);
2056 kfree(tport);
2057 return ERR_PTR(-EINVAL);
2059 snprintf(&tport->tport_name[0], VHOST_SCSI_NAMELEN, "%s", &name[off]);
2061 pr_debug("TCM_VHost_ConfigFS: Allocated emulated Target"
2062 " %s Address: %s\n", vhost_scsi_dump_proto_id(tport), name);
2064 return &tport->tport_wwn;
2067 static void vhost_scsi_drop_tport(struct se_wwn *wwn)
2069 struct vhost_scsi_tport *tport = container_of(wwn,
2070 struct vhost_scsi_tport, tport_wwn);
2072 pr_debug("TCM_VHost_ConfigFS: Deallocating emulated Target"
2073 " %s Address: %s\n", vhost_scsi_dump_proto_id(tport),
2074 tport->tport_name);
2076 kfree(tport);
2079 static ssize_t
2080 vhost_scsi_wwn_version_show(struct config_item *item, char *page)
2082 return sprintf(page, "TCM_VHOST fabric module %s on %s/%s"
2083 "on "UTS_RELEASE"\n", VHOST_SCSI_VERSION, utsname()->sysname,
2084 utsname()->machine);
2087 CONFIGFS_ATTR_RO(vhost_scsi_wwn_, version);
2089 static struct configfs_attribute *vhost_scsi_wwn_attrs[] = {
2090 &vhost_scsi_wwn_attr_version,
2091 NULL,
2094 static struct target_core_fabric_ops vhost_scsi_ops = {
2095 .module = THIS_MODULE,
2096 .name = "vhost",
2097 .get_fabric_name = vhost_scsi_get_fabric_name,
2098 .tpg_get_wwn = vhost_scsi_get_fabric_wwn,
2099 .tpg_get_tag = vhost_scsi_get_tpgt,
2100 .tpg_check_demo_mode = vhost_scsi_check_true,
2101 .tpg_check_demo_mode_cache = vhost_scsi_check_true,
2102 .tpg_check_demo_mode_write_protect = vhost_scsi_check_false,
2103 .tpg_check_prod_mode_write_protect = vhost_scsi_check_false,
2104 .tpg_check_prot_fabric_only = vhost_scsi_check_prot_fabric_only,
2105 .tpg_get_inst_index = vhost_scsi_tpg_get_inst_index,
2106 .release_cmd = vhost_scsi_release_cmd,
2107 .check_stop_free = vhost_scsi_check_stop_free,
2108 .sess_get_index = vhost_scsi_sess_get_index,
2109 .sess_get_initiator_sid = NULL,
2110 .write_pending = vhost_scsi_write_pending,
2111 .write_pending_status = vhost_scsi_write_pending_status,
2112 .set_default_node_attributes = vhost_scsi_set_default_node_attrs,
2113 .get_cmd_state = vhost_scsi_get_cmd_state,
2114 .queue_data_in = vhost_scsi_queue_data_in,
2115 .queue_status = vhost_scsi_queue_status,
2116 .queue_tm_rsp = vhost_scsi_queue_tm_rsp,
2117 .aborted_task = vhost_scsi_aborted_task,
2119 * Setup callers for generic logic in target_core_fabric_configfs.c
2121 .fabric_make_wwn = vhost_scsi_make_tport,
2122 .fabric_drop_wwn = vhost_scsi_drop_tport,
2123 .fabric_make_tpg = vhost_scsi_make_tpg,
2124 .fabric_drop_tpg = vhost_scsi_drop_tpg,
2125 .fabric_post_link = vhost_scsi_port_link,
2126 .fabric_pre_unlink = vhost_scsi_port_unlink,
2128 .tfc_wwn_attrs = vhost_scsi_wwn_attrs,
2129 .tfc_tpg_base_attrs = vhost_scsi_tpg_attrs,
2130 .tfc_tpg_attrib_attrs = vhost_scsi_tpg_attrib_attrs,
2133 static int __init vhost_scsi_init(void)
2135 int ret = -ENOMEM;
2137 pr_debug("TCM_VHOST fabric module %s on %s/%s"
2138 " on "UTS_RELEASE"\n", VHOST_SCSI_VERSION, utsname()->sysname,
2139 utsname()->machine);
2142 * Use our own dedicated workqueue for submitting I/O into
2143 * target core to avoid contention within system_wq.
2145 vhost_scsi_workqueue = alloc_workqueue("vhost_scsi", 0, 0);
2146 if (!vhost_scsi_workqueue)
2147 goto out;
2149 ret = vhost_scsi_register();
2150 if (ret < 0)
2151 goto out_destroy_workqueue;
2153 ret = target_register_template(&vhost_scsi_ops);
2154 if (ret < 0)
2155 goto out_vhost_scsi_deregister;
2157 return 0;
2159 out_vhost_scsi_deregister:
2160 vhost_scsi_deregister();
2161 out_destroy_workqueue:
2162 destroy_workqueue(vhost_scsi_workqueue);
2163 out:
2164 return ret;
2167 static void vhost_scsi_exit(void)
2169 target_unregister_template(&vhost_scsi_ops);
2170 vhost_scsi_deregister();
2171 destroy_workqueue(vhost_scsi_workqueue);
2174 MODULE_DESCRIPTION("VHOST_SCSI series fabric driver");
2175 MODULE_ALIAS("tcm_vhost");
2176 MODULE_LICENSE("GPL");
2177 module_init(vhost_scsi_init);
2178 module_exit(vhost_scsi_exit);