mm: update get_user_pages_longterm to migrate pages allocated from CMA region
[linux-2.6-block.git] / drivers / vhost / scsi.c
... / ...
CommitLineData
1/*******************************************************************************
2 * Vhost kernel TCM fabric driver for virtio SCSI initiators
3 *
4 * (C) Copyright 2010-2013 Datera, Inc.
5 * (C) Copyright 2010-2012 IBM Corp.
6 *
7 * Licensed to the Linux Foundation under the General Public License (GPL) version 2.
8 *
9 * Authors: Nicholas A. Bellinger <nab@daterainc.com>
10 * Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
11 *
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.
16 *
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.
21 *
22 ****************************************************************************/
23
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
50#include "vhost.h"
51
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
59
60struct vhost_scsi_inflight {
61 /* Wait for the flush operation to finish */
62 struct completion comp;
63 /* Refcount for the inflight reqs */
64 struct kref kref;
65};
66
67struct vhost_scsi_cmd {
68 /* Descriptor from vhost_get_vq_desc() for virt_queue segment */
69 int tvc_vq_desc;
70 /* virtio-scsi initiator task attribute */
71 int tvc_task_attr;
72 /* virtio-scsi response incoming iovecs */
73 int tvc_in_iovs;
74 /* virtio-scsi initiator data direction */
75 enum dma_data_direction tvc_data_direction;
76 /* Expected data transfer length from virtio-scsi header */
77 u32 tvc_exp_data_len;
78 /* The Tag from include/linux/virtio_scsi.h:struct virtio_scsi_cmd_req */
79 u64 tvc_tag;
80 /* The number of scatterlists associated with this cmd */
81 u32 tvc_sgl_count;
82 u32 tvc_prot_sgl_count;
83 /* Saved unpacked SCSI LUN for vhost_scsi_submission_work() */
84 u32 tvc_lun;
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;
109};
110
111struct vhost_scsi_nexus {
112 /* Pointer to TCM session for I_T Nexus */
113 struct se_session *tvn_se_sess;
114};
115
116struct vhost_scsi_tpg {
117 /* Vhost port target portal group tag for TCM */
118 u16 tport_tpgt;
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;
137};
138
139struct vhost_scsi_tport {
140 /* SCSI protocol the tport is providing */
141 u8 tport_proto_id;
142 /* Binary World Wide unique Port Name for Vhost Target port */
143 u64 tport_wwpn;
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;
148};
149
150struct 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;
155};
156
157enum {
158 VHOST_SCSI_VQ_CTL = 0,
159 VHOST_SCSI_VQ_EVT = 1,
160 VHOST_SCSI_VQ_IO = 2,
161};
162
163/* Note: can't set VIRTIO_F_VERSION_1 yet, since that implies ANY_LAYOUT. */
164enum {
165 VHOST_SCSI_FEATURES = VHOST_FEATURES | (1ULL << VIRTIO_SCSI_F_HOTPLUG) |
166 (1ULL << VIRTIO_SCSI_F_T10_PI)
167};
168
169#define VHOST_SCSI_MAX_TARGET 256
170#define VHOST_SCSI_MAX_VQ 128
171#define VHOST_SCSI_MAX_EVENT 128
172
173struct vhost_scsi_virtqueue {
174 struct vhost_virtqueue vq;
175 /*
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.
179 */
180 struct vhost_scsi_inflight inflights[2];
181 /*
182 * Indicate current inflight in use, protected by vq->mutex.
183 * Writers must also take dev mutex and flush under it.
184 */
185 int inflight_idx;
186};
187
188struct vhost_scsi {
189 /* Protected by vhost_scsi->dev.mutex */
190 struct vhost_scsi_tpg **vs_tpg;
191 char vs_vhost_wwpn[TRANSPORT_IQN_LEN];
192
193 struct vhost_dev dev;
194 struct vhost_scsi_virtqueue vqs[VHOST_SCSI_MAX_VQ];
195
196 struct vhost_work vs_completion_work; /* cmd completion work item */
197 struct llist_head vs_completion_list; /* cmd completion queue */
198
199 struct vhost_work vs_event_work; /* evt injection work item */
200 struct llist_head vs_event_list; /* evt injection queue */
201
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 */
204};
205
206/*
207 * Context for processing request and control queue operations.
208 */
209struct vhost_scsi_ctx {
210 int head;
211 unsigned int out, in;
212 size_t req_size, rsp_size;
213 size_t out_size, in_size;
214 u8 *target, *lunp;
215 void *req;
216 struct iov_iter out_iter;
217};
218
219static struct workqueue_struct *vhost_scsi_workqueue;
220
221/* Global spinlock to protect vhost_scsi TPG list for vhost IOCTL access */
222static DEFINE_MUTEX(vhost_scsi_mutex);
223static LIST_HEAD(vhost_scsi_list);
224
225static void vhost_scsi_done_inflight(struct kref *kref)
226{
227 struct vhost_scsi_inflight *inflight;
228
229 inflight = container_of(kref, struct vhost_scsi_inflight, kref);
230 complete(&inflight->comp);
231}
232
233static void vhost_scsi_init_inflight(struct vhost_scsi *vs,
234 struct vhost_scsi_inflight *old_inflight[])
235{
236 struct vhost_scsi_inflight *new_inflight;
237 struct vhost_virtqueue *vq;
238 int idx, i;
239
240 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
241 vq = &vs->vqs[i].vq;
242
243 mutex_lock(&vq->mutex);
244
245 /* store old infight */
246 idx = vs->vqs[i].inflight_idx;
247 if (old_inflight)
248 old_inflight[i] = &vs->vqs[i].inflights[idx];
249
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);
255
256 mutex_unlock(&vq->mutex);
257 }
258}
259
260static struct vhost_scsi_inflight *
261vhost_scsi_get_inflight(struct vhost_virtqueue *vq)
262{
263 struct vhost_scsi_inflight *inflight;
264 struct vhost_scsi_virtqueue *svq;
265
266 svq = container_of(vq, struct vhost_scsi_virtqueue, vq);
267 inflight = &svq->inflights[svq->inflight_idx];
268 kref_get(&inflight->kref);
269
270 return inflight;
271}
272
273static void vhost_scsi_put_inflight(struct vhost_scsi_inflight *inflight)
274{
275 kref_put(&inflight->kref, vhost_scsi_done_inflight);
276}
277
278static int vhost_scsi_check_true(struct se_portal_group *se_tpg)
279{
280 return 1;
281}
282
283static int vhost_scsi_check_false(struct se_portal_group *se_tpg)
284{
285 return 0;
286}
287
288static char *vhost_scsi_get_fabric_wwn(struct se_portal_group *se_tpg)
289{
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;
293
294 return &tport->tport_name[0];
295}
296
297static u16 vhost_scsi_get_tpgt(struct se_portal_group *se_tpg)
298{
299 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
300 struct vhost_scsi_tpg, se_tpg);
301 return tpg->tport_tpgt;
302}
303
304static int vhost_scsi_check_prot_fabric_only(struct se_portal_group *se_tpg)
305{
306 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
307 struct vhost_scsi_tpg, se_tpg);
308
309 return tpg->tv_fabric_prot_type;
310}
311
312static u32 vhost_scsi_tpg_get_inst_index(struct se_portal_group *se_tpg)
313{
314 return 1;
315}
316
317static void vhost_scsi_release_cmd(struct se_cmd *se_cmd)
318{
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;
322 int i;
323
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]));
327 }
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]));
331 }
332
333 vhost_scsi_put_inflight(tv_cmd->inflight);
334 target_free_tag(se_sess, se_cmd);
335}
336
337static u32 vhost_scsi_sess_get_index(struct se_session *se_sess)
338{
339 return 0;
340}
341
342static int vhost_scsi_write_pending(struct se_cmd *se_cmd)
343{
344 /* Go ahead and process the write immediately */
345 target_execute_cmd(se_cmd);
346 return 0;
347}
348
349static int vhost_scsi_write_pending_status(struct se_cmd *se_cmd)
350{
351 return 0;
352}
353
354static void vhost_scsi_set_default_node_attrs(struct se_node_acl *nacl)
355{
356 return;
357}
358
359static int vhost_scsi_get_cmd_state(struct se_cmd *se_cmd)
360{
361 return 0;
362}
363
364static void vhost_scsi_complete_cmd(struct vhost_scsi_cmd *cmd)
365{
366 struct vhost_scsi *vs = cmd->tvc_vhost;
367
368 llist_add(&cmd->tvc_completion_list, &vs->vs_completion_list);
369
370 vhost_work_queue(&vs->dev, &vs->vs_completion_work);
371}
372
373static int vhost_scsi_queue_data_in(struct se_cmd *se_cmd)
374{
375 struct vhost_scsi_cmd *cmd = container_of(se_cmd,
376 struct vhost_scsi_cmd, tvc_se_cmd);
377 vhost_scsi_complete_cmd(cmd);
378 return 0;
379}
380
381static int vhost_scsi_queue_status(struct se_cmd *se_cmd)
382{
383 struct vhost_scsi_cmd *cmd = container_of(se_cmd,
384 struct vhost_scsi_cmd, tvc_se_cmd);
385 vhost_scsi_complete_cmd(cmd);
386 return 0;
387}
388
389static void vhost_scsi_queue_tm_rsp(struct se_cmd *se_cmd)
390{
391 return;
392}
393
394static void vhost_scsi_aborted_task(struct se_cmd *se_cmd)
395{
396 return;
397}
398
399static void vhost_scsi_free_evt(struct vhost_scsi *vs, struct vhost_scsi_evt *evt)
400{
401 vs->vs_events_nr--;
402 kfree(evt);
403}
404
405static struct vhost_scsi_evt *
406vhost_scsi_allocate_evt(struct vhost_scsi *vs,
407 u32 event, u32 reason)
408{
409 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
410 struct vhost_scsi_evt *evt;
411
412 if (vs->vs_events_nr > VHOST_SCSI_MAX_EVENT) {
413 vs->vs_events_missed = true;
414 return NULL;
415 }
416
417 evt = kzalloc(sizeof(*evt), GFP_KERNEL);
418 if (!evt) {
419 vq_err(vq, "Failed to allocate vhost_scsi_evt\n");
420 vs->vs_events_missed = true;
421 return NULL;
422 }
423
424 evt->event.event = cpu_to_vhost32(vq, event);
425 evt->event.reason = cpu_to_vhost32(vq, reason);
426 vs->vs_events_nr++;
427
428 return evt;
429}
430
431static void vhost_scsi_free_cmd(struct vhost_scsi_cmd *cmd)
432{
433 struct se_cmd *se_cmd = &cmd->tvc_se_cmd;
434
435 /* TODO locking against target/backend threads? */
436 transport_generic_free_cmd(se_cmd, 0);
437
438}
439
440static int vhost_scsi_check_stop_free(struct se_cmd *se_cmd)
441{
442 return target_put_sess_cmd(se_cmd);
443}
444
445static void
446vhost_scsi_do_evt_work(struct vhost_scsi *vs, struct vhost_scsi_evt *evt)
447{
448 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
449 struct virtio_scsi_event *event = &evt->event;
450 struct virtio_scsi_event __user *eventp;
451 unsigned out, in;
452 int head, ret;
453
454 if (!vq->private_data) {
455 vs->vs_events_missed = true;
456 return;
457 }
458
459again:
460 vhost_disable_notify(&vs->dev, vq);
461 head = vhost_get_vq_desc(vq, vq->iov,
462 ARRAY_SIZE(vq->iov), &out, &in,
463 NULL, NULL);
464 if (head < 0) {
465 vs->vs_events_missed = true;
466 return;
467 }
468 if (head == vq->num) {
469 if (vhost_enable_notify(&vs->dev, vq))
470 goto again;
471 vs->vs_events_missed = true;
472 return;
473 }
474
475 if ((vq->iov[out].iov_len != sizeof(struct virtio_scsi_event))) {
476 vq_err(vq, "Expecting virtio_scsi_event, got %zu bytes\n",
477 vq->iov[out].iov_len);
478 vs->vs_events_missed = true;
479 return;
480 }
481
482 if (vs->vs_events_missed) {
483 event->event |= cpu_to_vhost32(vq, VIRTIO_SCSI_T_EVENTS_MISSED);
484 vs->vs_events_missed = false;
485 }
486
487 eventp = vq->iov[out].iov_base;
488 ret = __copy_to_user(eventp, event, sizeof(*event));
489 if (!ret)
490 vhost_add_used_and_signal(&vs->dev, vq, head, 0);
491 else
492 vq_err(vq, "Faulted on vhost_scsi_send_event\n");
493}
494
495static void vhost_scsi_evt_work(struct vhost_work *work)
496{
497 struct vhost_scsi *vs = container_of(work, struct vhost_scsi,
498 vs_event_work);
499 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
500 struct vhost_scsi_evt *evt, *t;
501 struct llist_node *llnode;
502
503 mutex_lock(&vq->mutex);
504 llnode = llist_del_all(&vs->vs_event_list);
505 llist_for_each_entry_safe(evt, t, llnode, list) {
506 vhost_scsi_do_evt_work(vs, evt);
507 vhost_scsi_free_evt(vs, evt);
508 }
509 mutex_unlock(&vq->mutex);
510}
511
512/* Fill in status and signal that we are done processing this command
513 *
514 * This is scheduled in the vhost work queue so we are called with the owner
515 * process mm and can access the vring.
516 */
517static void vhost_scsi_complete_cmd_work(struct vhost_work *work)
518{
519 struct vhost_scsi *vs = container_of(work, struct vhost_scsi,
520 vs_completion_work);
521 DECLARE_BITMAP(signal, VHOST_SCSI_MAX_VQ);
522 struct virtio_scsi_cmd_resp v_rsp;
523 struct vhost_scsi_cmd *cmd, *t;
524 struct llist_node *llnode;
525 struct se_cmd *se_cmd;
526 struct iov_iter iov_iter;
527 int ret, vq;
528
529 bitmap_zero(signal, VHOST_SCSI_MAX_VQ);
530 llnode = llist_del_all(&vs->vs_completion_list);
531 llist_for_each_entry_safe(cmd, t, llnode, tvc_completion_list) {
532 se_cmd = &cmd->tvc_se_cmd;
533
534 pr_debug("%s tv_cmd %p resid %u status %#02x\n", __func__,
535 cmd, se_cmd->residual_count, se_cmd->scsi_status);
536
537 memset(&v_rsp, 0, sizeof(v_rsp));
538 v_rsp.resid = cpu_to_vhost32(cmd->tvc_vq, se_cmd->residual_count);
539 /* TODO is status_qualifier field needed? */
540 v_rsp.status = se_cmd->scsi_status;
541 v_rsp.sense_len = cpu_to_vhost32(cmd->tvc_vq,
542 se_cmd->scsi_sense_length);
543 memcpy(v_rsp.sense, cmd->tvc_sense_buf,
544 se_cmd->scsi_sense_length);
545
546 iov_iter_init(&iov_iter, READ, &cmd->tvc_resp_iov,
547 cmd->tvc_in_iovs, sizeof(v_rsp));
548 ret = copy_to_iter(&v_rsp, sizeof(v_rsp), &iov_iter);
549 if (likely(ret == sizeof(v_rsp))) {
550 struct vhost_scsi_virtqueue *q;
551 vhost_add_used(cmd->tvc_vq, cmd->tvc_vq_desc, 0);
552 q = container_of(cmd->tvc_vq, struct vhost_scsi_virtqueue, vq);
553 vq = q - vs->vqs;
554 __set_bit(vq, signal);
555 } else
556 pr_err("Faulted on virtio_scsi_cmd_resp\n");
557
558 vhost_scsi_free_cmd(cmd);
559 }
560
561 vq = -1;
562 while ((vq = find_next_bit(signal, VHOST_SCSI_MAX_VQ, vq + 1))
563 < VHOST_SCSI_MAX_VQ)
564 vhost_signal(&vs->dev, &vs->vqs[vq].vq);
565}
566
567static struct vhost_scsi_cmd *
568vhost_scsi_get_tag(struct vhost_virtqueue *vq, struct vhost_scsi_tpg *tpg,
569 unsigned char *cdb, u64 scsi_tag, u16 lun, u8 task_attr,
570 u32 exp_data_len, int data_direction)
571{
572 struct vhost_scsi_cmd *cmd;
573 struct vhost_scsi_nexus *tv_nexus;
574 struct se_session *se_sess;
575 struct scatterlist *sg, *prot_sg;
576 struct page **pages;
577 int tag, cpu;
578
579 tv_nexus = tpg->tpg_nexus;
580 if (!tv_nexus) {
581 pr_err("Unable to locate active struct vhost_scsi_nexus\n");
582 return ERR_PTR(-EIO);
583 }
584 se_sess = tv_nexus->tvn_se_sess;
585
586 tag = sbitmap_queue_get(&se_sess->sess_tag_pool, &cpu);
587 if (tag < 0) {
588 pr_err("Unable to obtain tag for vhost_scsi_cmd\n");
589 return ERR_PTR(-ENOMEM);
590 }
591
592 cmd = &((struct vhost_scsi_cmd *)se_sess->sess_cmd_map)[tag];
593 sg = cmd->tvc_sgl;
594 prot_sg = cmd->tvc_prot_sgl;
595 pages = cmd->tvc_upages;
596 memset(cmd, 0, sizeof(*cmd));
597 cmd->tvc_sgl = sg;
598 cmd->tvc_prot_sgl = prot_sg;
599 cmd->tvc_upages = pages;
600 cmd->tvc_se_cmd.map_tag = tag;
601 cmd->tvc_se_cmd.map_cpu = cpu;
602 cmd->tvc_tag = scsi_tag;
603 cmd->tvc_lun = lun;
604 cmd->tvc_task_attr = task_attr;
605 cmd->tvc_exp_data_len = exp_data_len;
606 cmd->tvc_data_direction = data_direction;
607 cmd->tvc_nexus = tv_nexus;
608 cmd->inflight = vhost_scsi_get_inflight(vq);
609
610 memcpy(cmd->tvc_cdb, cdb, VHOST_SCSI_MAX_CDB_SIZE);
611
612 return cmd;
613}
614
615/*
616 * Map a user memory range into a scatterlist
617 *
618 * Returns the number of scatterlist entries used or -errno on error.
619 */
620static int
621vhost_scsi_map_to_sgl(struct vhost_scsi_cmd *cmd,
622 struct iov_iter *iter,
623 struct scatterlist *sgl,
624 bool write)
625{
626 struct page **pages = cmd->tvc_upages;
627 struct scatterlist *sg = sgl;
628 ssize_t bytes;
629 size_t offset;
630 unsigned int npages = 0;
631
632 bytes = iov_iter_get_pages(iter, pages, LONG_MAX,
633 VHOST_SCSI_PREALLOC_UPAGES, &offset);
634 /* No pages were pinned */
635 if (bytes <= 0)
636 return bytes < 0 ? bytes : -EFAULT;
637
638 iov_iter_advance(iter, bytes);
639
640 while (bytes) {
641 unsigned n = min_t(unsigned, PAGE_SIZE - offset, bytes);
642 sg_set_page(sg++, pages[npages++], n, offset);
643 bytes -= n;
644 offset = 0;
645 }
646 return npages;
647}
648
649static int
650vhost_scsi_calc_sgls(struct iov_iter *iter, size_t bytes, int max_sgls)
651{
652 int sgl_count = 0;
653
654 if (!iter || !iter->iov) {
655 pr_err("%s: iter->iov is NULL, but expected bytes: %zu"
656 " present\n", __func__, bytes);
657 return -EINVAL;
658 }
659
660 sgl_count = iov_iter_npages(iter, 0xffff);
661 if (sgl_count > max_sgls) {
662 pr_err("%s: requested sgl_count: %d exceeds pre-allocated"
663 " max_sgls: %d\n", __func__, sgl_count, max_sgls);
664 return -EINVAL;
665 }
666 return sgl_count;
667}
668
669static int
670vhost_scsi_iov_to_sgl(struct vhost_scsi_cmd *cmd, bool write,
671 struct iov_iter *iter,
672 struct scatterlist *sg, int sg_count)
673{
674 struct scatterlist *p = sg;
675 int ret;
676
677 while (iov_iter_count(iter)) {
678 ret = vhost_scsi_map_to_sgl(cmd, iter, sg, write);
679 if (ret < 0) {
680 while (p < sg) {
681 struct page *page = sg_page(p++);
682 if (page)
683 put_page(page);
684 }
685 return ret;
686 }
687 sg += ret;
688 }
689 return 0;
690}
691
692static int
693vhost_scsi_mapal(struct vhost_scsi_cmd *cmd,
694 size_t prot_bytes, struct iov_iter *prot_iter,
695 size_t data_bytes, struct iov_iter *data_iter)
696{
697 int sgl_count, ret;
698 bool write = (cmd->tvc_data_direction == DMA_FROM_DEVICE);
699
700 if (prot_bytes) {
701 sgl_count = vhost_scsi_calc_sgls(prot_iter, prot_bytes,
702 VHOST_SCSI_PREALLOC_PROT_SGLS);
703 if (sgl_count < 0)
704 return sgl_count;
705
706 sg_init_table(cmd->tvc_prot_sgl, sgl_count);
707 cmd->tvc_prot_sgl_count = sgl_count;
708 pr_debug("%s prot_sg %p prot_sgl_count %u\n", __func__,
709 cmd->tvc_prot_sgl, cmd->tvc_prot_sgl_count);
710
711 ret = vhost_scsi_iov_to_sgl(cmd, write, prot_iter,
712 cmd->tvc_prot_sgl,
713 cmd->tvc_prot_sgl_count);
714 if (ret < 0) {
715 cmd->tvc_prot_sgl_count = 0;
716 return ret;
717 }
718 }
719 sgl_count = vhost_scsi_calc_sgls(data_iter, data_bytes,
720 VHOST_SCSI_PREALLOC_SGLS);
721 if (sgl_count < 0)
722 return sgl_count;
723
724 sg_init_table(cmd->tvc_sgl, sgl_count);
725 cmd->tvc_sgl_count = sgl_count;
726 pr_debug("%s data_sg %p data_sgl_count %u\n", __func__,
727 cmd->tvc_sgl, cmd->tvc_sgl_count);
728
729 ret = vhost_scsi_iov_to_sgl(cmd, write, data_iter,
730 cmd->tvc_sgl, cmd->tvc_sgl_count);
731 if (ret < 0) {
732 cmd->tvc_sgl_count = 0;
733 return ret;
734 }
735 return 0;
736}
737
738static int vhost_scsi_to_tcm_attr(int attr)
739{
740 switch (attr) {
741 case VIRTIO_SCSI_S_SIMPLE:
742 return TCM_SIMPLE_TAG;
743 case VIRTIO_SCSI_S_ORDERED:
744 return TCM_ORDERED_TAG;
745 case VIRTIO_SCSI_S_HEAD:
746 return TCM_HEAD_TAG;
747 case VIRTIO_SCSI_S_ACA:
748 return TCM_ACA_TAG;
749 default:
750 break;
751 }
752 return TCM_SIMPLE_TAG;
753}
754
755static void vhost_scsi_submission_work(struct work_struct *work)
756{
757 struct vhost_scsi_cmd *cmd =
758 container_of(work, struct vhost_scsi_cmd, work);
759 struct vhost_scsi_nexus *tv_nexus;
760 struct se_cmd *se_cmd = &cmd->tvc_se_cmd;
761 struct scatterlist *sg_ptr, *sg_prot_ptr = NULL;
762 int rc;
763
764 /* FIXME: BIDI operation */
765 if (cmd->tvc_sgl_count) {
766 sg_ptr = cmd->tvc_sgl;
767
768 if (cmd->tvc_prot_sgl_count)
769 sg_prot_ptr = cmd->tvc_prot_sgl;
770 else
771 se_cmd->prot_pto = true;
772 } else {
773 sg_ptr = NULL;
774 }
775 tv_nexus = cmd->tvc_nexus;
776
777 se_cmd->tag = 0;
778 rc = target_submit_cmd_map_sgls(se_cmd, tv_nexus->tvn_se_sess,
779 cmd->tvc_cdb, &cmd->tvc_sense_buf[0],
780 cmd->tvc_lun, cmd->tvc_exp_data_len,
781 vhost_scsi_to_tcm_attr(cmd->tvc_task_attr),
782 cmd->tvc_data_direction, TARGET_SCF_ACK_KREF,
783 sg_ptr, cmd->tvc_sgl_count, NULL, 0, sg_prot_ptr,
784 cmd->tvc_prot_sgl_count);
785 if (rc < 0) {
786 transport_send_check_condition_and_sense(se_cmd,
787 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE, 0);
788 transport_generic_free_cmd(se_cmd, 0);
789 }
790}
791
792static void
793vhost_scsi_send_bad_target(struct vhost_scsi *vs,
794 struct vhost_virtqueue *vq,
795 int head, unsigned out)
796{
797 struct virtio_scsi_cmd_resp __user *resp;
798 struct virtio_scsi_cmd_resp rsp;
799 int ret;
800
801 memset(&rsp, 0, sizeof(rsp));
802 rsp.response = VIRTIO_SCSI_S_BAD_TARGET;
803 resp = vq->iov[out].iov_base;
804 ret = __copy_to_user(resp, &rsp, sizeof(rsp));
805 if (!ret)
806 vhost_add_used_and_signal(&vs->dev, vq, head, 0);
807 else
808 pr_err("Faulted on virtio_scsi_cmd_resp\n");
809}
810
811static int
812vhost_scsi_get_desc(struct vhost_scsi *vs, struct vhost_virtqueue *vq,
813 struct vhost_scsi_ctx *vc)
814{
815 int ret = -ENXIO;
816
817 vc->head = vhost_get_vq_desc(vq, vq->iov,
818 ARRAY_SIZE(vq->iov), &vc->out, &vc->in,
819 NULL, NULL);
820
821 pr_debug("vhost_get_vq_desc: head: %d, out: %u in: %u\n",
822 vc->head, vc->out, vc->in);
823
824 /* On error, stop handling until the next kick. */
825 if (unlikely(vc->head < 0))
826 goto done;
827
828 /* Nothing new? Wait for eventfd to tell us they refilled. */
829 if (vc->head == vq->num) {
830 if (unlikely(vhost_enable_notify(&vs->dev, vq))) {
831 vhost_disable_notify(&vs->dev, vq);
832 ret = -EAGAIN;
833 }
834 goto done;
835 }
836
837 /*
838 * Get the size of request and response buffers.
839 * FIXME: Not correct for BIDI operation
840 */
841 vc->out_size = iov_length(vq->iov, vc->out);
842 vc->in_size = iov_length(&vq->iov[vc->out], vc->in);
843
844 /*
845 * Copy over the virtio-scsi request header, which for a
846 * ANY_LAYOUT enabled guest may span multiple iovecs, or a
847 * single iovec may contain both the header + outgoing
848 * WRITE payloads.
849 *
850 * copy_from_iter() will advance out_iter, so that it will
851 * point at the start of the outgoing WRITE payload, if
852 * DMA_TO_DEVICE is set.
853 */
854 iov_iter_init(&vc->out_iter, WRITE, vq->iov, vc->out, vc->out_size);
855 ret = 0;
856
857done:
858 return ret;
859}
860
861static int
862vhost_scsi_chk_size(struct vhost_virtqueue *vq, struct vhost_scsi_ctx *vc)
863{
864 if (unlikely(vc->in_size < vc->rsp_size)) {
865 vq_err(vq,
866 "Response buf too small, need min %zu bytes got %zu",
867 vc->rsp_size, vc->in_size);
868 return -EINVAL;
869 } else if (unlikely(vc->out_size < vc->req_size)) {
870 vq_err(vq,
871 "Request buf too small, need min %zu bytes got %zu",
872 vc->req_size, vc->out_size);
873 return -EIO;
874 }
875
876 return 0;
877}
878
879static int
880vhost_scsi_get_req(struct vhost_virtqueue *vq, struct vhost_scsi_ctx *vc,
881 struct vhost_scsi_tpg **tpgp)
882{
883 int ret = -EIO;
884
885 if (unlikely(!copy_from_iter_full(vc->req, vc->req_size,
886 &vc->out_iter))) {
887 vq_err(vq, "Faulted on copy_from_iter_full\n");
888 } else if (unlikely(*vc->lunp != 1)) {
889 /* virtio-scsi spec requires byte 0 of the lun to be 1 */
890 vq_err(vq, "Illegal virtio-scsi lun: %u\n", *vc->lunp);
891 } else {
892 struct vhost_scsi_tpg **vs_tpg, *tpg;
893
894 vs_tpg = vq->private_data; /* validated at handler entry */
895
896 tpg = READ_ONCE(vs_tpg[*vc->target]);
897 if (unlikely(!tpg)) {
898 vq_err(vq, "Target 0x%x does not exist\n", *vc->target);
899 } else {
900 if (tpgp)
901 *tpgp = tpg;
902 ret = 0;
903 }
904 }
905
906 return ret;
907}
908
909static void
910vhost_scsi_handle_vq(struct vhost_scsi *vs, struct vhost_virtqueue *vq)
911{
912 struct vhost_scsi_tpg **vs_tpg, *tpg;
913 struct virtio_scsi_cmd_req v_req;
914 struct virtio_scsi_cmd_req_pi v_req_pi;
915 struct vhost_scsi_ctx vc;
916 struct vhost_scsi_cmd *cmd;
917 struct iov_iter in_iter, prot_iter, data_iter;
918 u64 tag;
919 u32 exp_data_len, data_direction;
920 int ret, prot_bytes;
921 u16 lun;
922 u8 task_attr;
923 bool t10_pi = vhost_has_feature(vq, VIRTIO_SCSI_F_T10_PI);
924 void *cdb;
925
926 mutex_lock(&vq->mutex);
927 /*
928 * We can handle the vq only after the endpoint is setup by calling the
929 * VHOST_SCSI_SET_ENDPOINT ioctl.
930 */
931 vs_tpg = vq->private_data;
932 if (!vs_tpg)
933 goto out;
934
935 memset(&vc, 0, sizeof(vc));
936 vc.rsp_size = sizeof(struct virtio_scsi_cmd_resp);
937
938 vhost_disable_notify(&vs->dev, vq);
939
940 for (;;) {
941 ret = vhost_scsi_get_desc(vs, vq, &vc);
942 if (ret)
943 goto err;
944
945 /*
946 * Setup pointers and values based upon different virtio-scsi
947 * request header if T10_PI is enabled in KVM guest.
948 */
949 if (t10_pi) {
950 vc.req = &v_req_pi;
951 vc.req_size = sizeof(v_req_pi);
952 vc.lunp = &v_req_pi.lun[0];
953 vc.target = &v_req_pi.lun[1];
954 } else {
955 vc.req = &v_req;
956 vc.req_size = sizeof(v_req);
957 vc.lunp = &v_req.lun[0];
958 vc.target = &v_req.lun[1];
959 }
960
961 /*
962 * Validate the size of request and response buffers.
963 * Check for a sane response buffer so we can report
964 * early errors back to the guest.
965 */
966 ret = vhost_scsi_chk_size(vq, &vc);
967 if (ret)
968 goto err;
969
970 ret = vhost_scsi_get_req(vq, &vc, &tpg);
971 if (ret)
972 goto err;
973
974 ret = -EIO; /* bad target on any error from here on */
975
976 /*
977 * Determine data_direction by calculating the total outgoing
978 * iovec sizes + incoming iovec sizes vs. virtio-scsi request +
979 * response headers respectively.
980 *
981 * For DMA_TO_DEVICE this is out_iter, which is already pointing
982 * to the right place.
983 *
984 * For DMA_FROM_DEVICE, the iovec will be just past the end
985 * of the virtio-scsi response header in either the same
986 * or immediately following iovec.
987 *
988 * Any associated T10_PI bytes for the outgoing / incoming
989 * payloads are included in calculation of exp_data_len here.
990 */
991 prot_bytes = 0;
992
993 if (vc.out_size > vc.req_size) {
994 data_direction = DMA_TO_DEVICE;
995 exp_data_len = vc.out_size - vc.req_size;
996 data_iter = vc.out_iter;
997 } else if (vc.in_size > vc.rsp_size) {
998 data_direction = DMA_FROM_DEVICE;
999 exp_data_len = vc.in_size - vc.rsp_size;
1000
1001 iov_iter_init(&in_iter, READ, &vq->iov[vc.out], vc.in,
1002 vc.rsp_size + exp_data_len);
1003 iov_iter_advance(&in_iter, vc.rsp_size);
1004 data_iter = in_iter;
1005 } else {
1006 data_direction = DMA_NONE;
1007 exp_data_len = 0;
1008 }
1009 /*
1010 * If T10_PI header + payload is present, setup prot_iter values
1011 * and recalculate data_iter for vhost_scsi_mapal() mapping to
1012 * host scatterlists via get_user_pages_fast().
1013 */
1014 if (t10_pi) {
1015 if (v_req_pi.pi_bytesout) {
1016 if (data_direction != DMA_TO_DEVICE) {
1017 vq_err(vq, "Received non zero pi_bytesout,"
1018 " but wrong data_direction\n");
1019 goto err;
1020 }
1021 prot_bytes = vhost32_to_cpu(vq, v_req_pi.pi_bytesout);
1022 } else if (v_req_pi.pi_bytesin) {
1023 if (data_direction != DMA_FROM_DEVICE) {
1024 vq_err(vq, "Received non zero pi_bytesin,"
1025 " but wrong data_direction\n");
1026 goto err;
1027 }
1028 prot_bytes = vhost32_to_cpu(vq, v_req_pi.pi_bytesin);
1029 }
1030 /*
1031 * Set prot_iter to data_iter and truncate it to
1032 * prot_bytes, and advance data_iter past any
1033 * preceeding prot_bytes that may be present.
1034 *
1035 * Also fix up the exp_data_len to reflect only the
1036 * actual data payload length.
1037 */
1038 if (prot_bytes) {
1039 exp_data_len -= prot_bytes;
1040 prot_iter = data_iter;
1041 iov_iter_truncate(&prot_iter, prot_bytes);
1042 iov_iter_advance(&data_iter, prot_bytes);
1043 }
1044 tag = vhost64_to_cpu(vq, v_req_pi.tag);
1045 task_attr = v_req_pi.task_attr;
1046 cdb = &v_req_pi.cdb[0];
1047 lun = ((v_req_pi.lun[2] << 8) | v_req_pi.lun[3]) & 0x3FFF;
1048 } else {
1049 tag = vhost64_to_cpu(vq, v_req.tag);
1050 task_attr = v_req.task_attr;
1051 cdb = &v_req.cdb[0];
1052 lun = ((v_req.lun[2] << 8) | v_req.lun[3]) & 0x3FFF;
1053 }
1054 /*
1055 * Check that the received CDB size does not exceeded our
1056 * hardcoded max for vhost-scsi, then get a pre-allocated
1057 * cmd descriptor for the new virtio-scsi tag.
1058 *
1059 * TODO what if cdb was too small for varlen cdb header?
1060 */
1061 if (unlikely(scsi_command_size(cdb) > VHOST_SCSI_MAX_CDB_SIZE)) {
1062 vq_err(vq, "Received SCSI CDB with command_size: %d that"
1063 " exceeds SCSI_MAX_VARLEN_CDB_SIZE: %d\n",
1064 scsi_command_size(cdb), VHOST_SCSI_MAX_CDB_SIZE);
1065 goto err;
1066 }
1067 cmd = vhost_scsi_get_tag(vq, tpg, cdb, tag, lun, task_attr,
1068 exp_data_len + prot_bytes,
1069 data_direction);
1070 if (IS_ERR(cmd)) {
1071 vq_err(vq, "vhost_scsi_get_tag failed %ld\n",
1072 PTR_ERR(cmd));
1073 goto err;
1074 }
1075 cmd->tvc_vhost = vs;
1076 cmd->tvc_vq = vq;
1077 cmd->tvc_resp_iov = vq->iov[vc.out];
1078 cmd->tvc_in_iovs = vc.in;
1079
1080 pr_debug("vhost_scsi got command opcode: %#02x, lun: %d\n",
1081 cmd->tvc_cdb[0], cmd->tvc_lun);
1082 pr_debug("cmd: %p exp_data_len: %d, prot_bytes: %d data_direction:"
1083 " %d\n", cmd, exp_data_len, prot_bytes, data_direction);
1084
1085 if (data_direction != DMA_NONE) {
1086 if (unlikely(vhost_scsi_mapal(cmd, prot_bytes,
1087 &prot_iter, exp_data_len,
1088 &data_iter))) {
1089 vq_err(vq, "Failed to map iov to sgl\n");
1090 vhost_scsi_release_cmd(&cmd->tvc_se_cmd);
1091 goto err;
1092 }
1093 }
1094 /*
1095 * Save the descriptor from vhost_get_vq_desc() to be used to
1096 * complete the virtio-scsi request in TCM callback context via
1097 * vhost_scsi_queue_data_in() and vhost_scsi_queue_status()
1098 */
1099 cmd->tvc_vq_desc = vc.head;
1100 /*
1101 * Dispatch cmd descriptor for cmwq execution in process
1102 * context provided by vhost_scsi_workqueue. This also ensures
1103 * cmd is executed on the same kworker CPU as this vhost
1104 * thread to gain positive L2 cache locality effects.
1105 */
1106 INIT_WORK(&cmd->work, vhost_scsi_submission_work);
1107 queue_work(vhost_scsi_workqueue, &cmd->work);
1108 ret = 0;
1109err:
1110 /*
1111 * ENXIO: No more requests, or read error, wait for next kick
1112 * EINVAL: Invalid response buffer, drop the request
1113 * EIO: Respond with bad target
1114 * EAGAIN: Pending request
1115 */
1116 if (ret == -ENXIO)
1117 break;
1118 else if (ret == -EIO)
1119 vhost_scsi_send_bad_target(vs, vq, vc.head, vc.out);
1120 }
1121out:
1122 mutex_unlock(&vq->mutex);
1123}
1124
1125static void
1126vhost_scsi_send_tmf_reject(struct vhost_scsi *vs,
1127 struct vhost_virtqueue *vq,
1128 struct vhost_scsi_ctx *vc)
1129{
1130 struct virtio_scsi_ctrl_tmf_resp rsp;
1131 struct iov_iter iov_iter;
1132 int ret;
1133
1134 pr_debug("%s\n", __func__);
1135 memset(&rsp, 0, sizeof(rsp));
1136 rsp.response = VIRTIO_SCSI_S_FUNCTION_REJECTED;
1137
1138 iov_iter_init(&iov_iter, READ, &vq->iov[vc->out], vc->in, sizeof(rsp));
1139
1140 ret = copy_to_iter(&rsp, sizeof(rsp), &iov_iter);
1141 if (likely(ret == sizeof(rsp)))
1142 vhost_add_used_and_signal(&vs->dev, vq, vc->head, 0);
1143 else
1144 pr_err("Faulted on virtio_scsi_ctrl_tmf_resp\n");
1145}
1146
1147static void
1148vhost_scsi_send_an_resp(struct vhost_scsi *vs,
1149 struct vhost_virtqueue *vq,
1150 struct vhost_scsi_ctx *vc)
1151{
1152 struct virtio_scsi_ctrl_an_resp rsp;
1153 struct iov_iter iov_iter;
1154 int ret;
1155
1156 pr_debug("%s\n", __func__);
1157 memset(&rsp, 0, sizeof(rsp)); /* event_actual = 0 */
1158 rsp.response = VIRTIO_SCSI_S_OK;
1159
1160 iov_iter_init(&iov_iter, READ, &vq->iov[vc->out], vc->in, sizeof(rsp));
1161
1162 ret = copy_to_iter(&rsp, sizeof(rsp), &iov_iter);
1163 if (likely(ret == sizeof(rsp)))
1164 vhost_add_used_and_signal(&vs->dev, vq, vc->head, 0);
1165 else
1166 pr_err("Faulted on virtio_scsi_ctrl_an_resp\n");
1167}
1168
1169static void
1170vhost_scsi_ctl_handle_vq(struct vhost_scsi *vs, struct vhost_virtqueue *vq)
1171{
1172 union {
1173 __virtio32 type;
1174 struct virtio_scsi_ctrl_an_req an;
1175 struct virtio_scsi_ctrl_tmf_req tmf;
1176 } v_req;
1177 struct vhost_scsi_ctx vc;
1178 size_t typ_size;
1179 int ret;
1180
1181 mutex_lock(&vq->mutex);
1182 /*
1183 * We can handle the vq only after the endpoint is setup by calling the
1184 * VHOST_SCSI_SET_ENDPOINT ioctl.
1185 */
1186 if (!vq->private_data)
1187 goto out;
1188
1189 memset(&vc, 0, sizeof(vc));
1190
1191 vhost_disable_notify(&vs->dev, vq);
1192
1193 for (;;) {
1194 ret = vhost_scsi_get_desc(vs, vq, &vc);
1195 if (ret)
1196 goto err;
1197
1198 /*
1199 * Get the request type first in order to setup
1200 * other parameters dependent on the type.
1201 */
1202 vc.req = &v_req.type;
1203 typ_size = sizeof(v_req.type);
1204
1205 if (unlikely(!copy_from_iter_full(vc.req, typ_size,
1206 &vc.out_iter))) {
1207 vq_err(vq, "Faulted on copy_from_iter tmf type\n");
1208 /*
1209 * The size of the response buffer depends on the
1210 * request type and must be validated against it.
1211 * Since the request type is not known, don't send
1212 * a response.
1213 */
1214 continue;
1215 }
1216
1217 switch (v_req.type) {
1218 case VIRTIO_SCSI_T_TMF:
1219 vc.req = &v_req.tmf;
1220 vc.req_size = sizeof(struct virtio_scsi_ctrl_tmf_req);
1221 vc.rsp_size = sizeof(struct virtio_scsi_ctrl_tmf_resp);
1222 vc.lunp = &v_req.tmf.lun[0];
1223 vc.target = &v_req.tmf.lun[1];
1224 break;
1225 case VIRTIO_SCSI_T_AN_QUERY:
1226 case VIRTIO_SCSI_T_AN_SUBSCRIBE:
1227 vc.req = &v_req.an;
1228 vc.req_size = sizeof(struct virtio_scsi_ctrl_an_req);
1229 vc.rsp_size = sizeof(struct virtio_scsi_ctrl_an_resp);
1230 vc.lunp = &v_req.an.lun[0];
1231 vc.target = NULL;
1232 break;
1233 default:
1234 vq_err(vq, "Unknown control request %d", v_req.type);
1235 continue;
1236 }
1237
1238 /*
1239 * Validate the size of request and response buffers.
1240 * Check for a sane response buffer so we can report
1241 * early errors back to the guest.
1242 */
1243 ret = vhost_scsi_chk_size(vq, &vc);
1244 if (ret)
1245 goto err;
1246
1247 /*
1248 * Get the rest of the request now that its size is known.
1249 */
1250 vc.req += typ_size;
1251 vc.req_size -= typ_size;
1252
1253 ret = vhost_scsi_get_req(vq, &vc, NULL);
1254 if (ret)
1255 goto err;
1256
1257 if (v_req.type == VIRTIO_SCSI_T_TMF)
1258 vhost_scsi_send_tmf_reject(vs, vq, &vc);
1259 else
1260 vhost_scsi_send_an_resp(vs, vq, &vc);
1261err:
1262 /*
1263 * ENXIO: No more requests, or read error, wait for next kick
1264 * EINVAL: Invalid response buffer, drop the request
1265 * EIO: Respond with bad target
1266 * EAGAIN: Pending request
1267 */
1268 if (ret == -ENXIO)
1269 break;
1270 else if (ret == -EIO)
1271 vhost_scsi_send_bad_target(vs, vq, vc.head, vc.out);
1272 }
1273out:
1274 mutex_unlock(&vq->mutex);
1275}
1276
1277static void vhost_scsi_ctl_handle_kick(struct vhost_work *work)
1278{
1279 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1280 poll.work);
1281 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1282
1283 pr_debug("%s: The handling func for control queue.\n", __func__);
1284 vhost_scsi_ctl_handle_vq(vs, vq);
1285}
1286
1287static void
1288vhost_scsi_send_evt(struct vhost_scsi *vs,
1289 struct vhost_scsi_tpg *tpg,
1290 struct se_lun *lun,
1291 u32 event,
1292 u32 reason)
1293{
1294 struct vhost_scsi_evt *evt;
1295
1296 evt = vhost_scsi_allocate_evt(vs, event, reason);
1297 if (!evt)
1298 return;
1299
1300 if (tpg && lun) {
1301 /* TODO: share lun setup code with virtio-scsi.ko */
1302 /*
1303 * Note: evt->event is zeroed when we allocate it and
1304 * lun[4-7] need to be zero according to virtio-scsi spec.
1305 */
1306 evt->event.lun[0] = 0x01;
1307 evt->event.lun[1] = tpg->tport_tpgt;
1308 if (lun->unpacked_lun >= 256)
1309 evt->event.lun[2] = lun->unpacked_lun >> 8 | 0x40 ;
1310 evt->event.lun[3] = lun->unpacked_lun & 0xFF;
1311 }
1312
1313 llist_add(&evt->list, &vs->vs_event_list);
1314 vhost_work_queue(&vs->dev, &vs->vs_event_work);
1315}
1316
1317static void vhost_scsi_evt_handle_kick(struct vhost_work *work)
1318{
1319 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1320 poll.work);
1321 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1322
1323 mutex_lock(&vq->mutex);
1324 if (!vq->private_data)
1325 goto out;
1326
1327 if (vs->vs_events_missed)
1328 vhost_scsi_send_evt(vs, NULL, NULL, VIRTIO_SCSI_T_NO_EVENT, 0);
1329out:
1330 mutex_unlock(&vq->mutex);
1331}
1332
1333static void vhost_scsi_handle_kick(struct vhost_work *work)
1334{
1335 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1336 poll.work);
1337 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1338
1339 vhost_scsi_handle_vq(vs, vq);
1340}
1341
1342static void vhost_scsi_flush_vq(struct vhost_scsi *vs, int index)
1343{
1344 vhost_poll_flush(&vs->vqs[index].vq.poll);
1345}
1346
1347/* Callers must hold dev mutex */
1348static void vhost_scsi_flush(struct vhost_scsi *vs)
1349{
1350 struct vhost_scsi_inflight *old_inflight[VHOST_SCSI_MAX_VQ];
1351 int i;
1352
1353 /* Init new inflight and remember the old inflight */
1354 vhost_scsi_init_inflight(vs, old_inflight);
1355
1356 /*
1357 * The inflight->kref was initialized to 1. We decrement it here to
1358 * indicate the start of the flush operation so that it will reach 0
1359 * when all the reqs are finished.
1360 */
1361 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1362 kref_put(&old_inflight[i]->kref, vhost_scsi_done_inflight);
1363
1364 /* Flush both the vhost poll and vhost work */
1365 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1366 vhost_scsi_flush_vq(vs, i);
1367 vhost_work_flush(&vs->dev, &vs->vs_completion_work);
1368 vhost_work_flush(&vs->dev, &vs->vs_event_work);
1369
1370 /* Wait for all reqs issued before the flush to be finished */
1371 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1372 wait_for_completion(&old_inflight[i]->comp);
1373}
1374
1375/*
1376 * Called from vhost_scsi_ioctl() context to walk the list of available
1377 * vhost_scsi_tpg with an active struct vhost_scsi_nexus
1378 *
1379 * The lock nesting rule is:
1380 * vhost_scsi_mutex -> vs->dev.mutex -> tpg->tv_tpg_mutex -> vq->mutex
1381 */
1382static int
1383vhost_scsi_set_endpoint(struct vhost_scsi *vs,
1384 struct vhost_scsi_target *t)
1385{
1386 struct se_portal_group *se_tpg;
1387 struct vhost_scsi_tport *tv_tport;
1388 struct vhost_scsi_tpg *tpg;
1389 struct vhost_scsi_tpg **vs_tpg;
1390 struct vhost_virtqueue *vq;
1391 int index, ret, i, len;
1392 bool match = false;
1393
1394 mutex_lock(&vhost_scsi_mutex);
1395 mutex_lock(&vs->dev.mutex);
1396
1397 /* Verify that ring has been setup correctly. */
1398 for (index = 0; index < vs->dev.nvqs; ++index) {
1399 /* Verify that ring has been setup correctly. */
1400 if (!vhost_vq_access_ok(&vs->vqs[index].vq)) {
1401 ret = -EFAULT;
1402 goto out;
1403 }
1404 }
1405
1406 len = sizeof(vs_tpg[0]) * VHOST_SCSI_MAX_TARGET;
1407 vs_tpg = kzalloc(len, GFP_KERNEL);
1408 if (!vs_tpg) {
1409 ret = -ENOMEM;
1410 goto out;
1411 }
1412 if (vs->vs_tpg)
1413 memcpy(vs_tpg, vs->vs_tpg, len);
1414
1415 list_for_each_entry(tpg, &vhost_scsi_list, tv_tpg_list) {
1416 mutex_lock(&tpg->tv_tpg_mutex);
1417 if (!tpg->tpg_nexus) {
1418 mutex_unlock(&tpg->tv_tpg_mutex);
1419 continue;
1420 }
1421 if (tpg->tv_tpg_vhost_count != 0) {
1422 mutex_unlock(&tpg->tv_tpg_mutex);
1423 continue;
1424 }
1425 tv_tport = tpg->tport;
1426
1427 if (!strcmp(tv_tport->tport_name, t->vhost_wwpn)) {
1428 if (vs->vs_tpg && vs->vs_tpg[tpg->tport_tpgt]) {
1429 kfree(vs_tpg);
1430 mutex_unlock(&tpg->tv_tpg_mutex);
1431 ret = -EEXIST;
1432 goto out;
1433 }
1434 /*
1435 * In order to ensure individual vhost-scsi configfs
1436 * groups cannot be removed while in use by vhost ioctl,
1437 * go ahead and take an explicit se_tpg->tpg_group.cg_item
1438 * dependency now.
1439 */
1440 se_tpg = &tpg->se_tpg;
1441 ret = target_depend_item(&se_tpg->tpg_group.cg_item);
1442 if (ret) {
1443 pr_warn("target_depend_item() failed: %d\n", ret);
1444 kfree(vs_tpg);
1445 mutex_unlock(&tpg->tv_tpg_mutex);
1446 goto out;
1447 }
1448 tpg->tv_tpg_vhost_count++;
1449 tpg->vhost_scsi = vs;
1450 vs_tpg[tpg->tport_tpgt] = tpg;
1451 smp_mb__after_atomic();
1452 match = true;
1453 }
1454 mutex_unlock(&tpg->tv_tpg_mutex);
1455 }
1456
1457 if (match) {
1458 memcpy(vs->vs_vhost_wwpn, t->vhost_wwpn,
1459 sizeof(vs->vs_vhost_wwpn));
1460 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1461 vq = &vs->vqs[i].vq;
1462 mutex_lock(&vq->mutex);
1463 vq->private_data = vs_tpg;
1464 vhost_vq_init_access(vq);
1465 mutex_unlock(&vq->mutex);
1466 }
1467 ret = 0;
1468 } else {
1469 ret = -EEXIST;
1470 }
1471
1472 /*
1473 * Act as synchronize_rcu to make sure access to
1474 * old vs->vs_tpg is finished.
1475 */
1476 vhost_scsi_flush(vs);
1477 kfree(vs->vs_tpg);
1478 vs->vs_tpg = vs_tpg;
1479
1480out:
1481 mutex_unlock(&vs->dev.mutex);
1482 mutex_unlock(&vhost_scsi_mutex);
1483 return ret;
1484}
1485
1486static int
1487vhost_scsi_clear_endpoint(struct vhost_scsi *vs,
1488 struct vhost_scsi_target *t)
1489{
1490 struct se_portal_group *se_tpg;
1491 struct vhost_scsi_tport *tv_tport;
1492 struct vhost_scsi_tpg *tpg;
1493 struct vhost_virtqueue *vq;
1494 bool match = false;
1495 int index, ret, i;
1496 u8 target;
1497
1498 mutex_lock(&vhost_scsi_mutex);
1499 mutex_lock(&vs->dev.mutex);
1500 /* Verify that ring has been setup correctly. */
1501 for (index = 0; index < vs->dev.nvqs; ++index) {
1502 if (!vhost_vq_access_ok(&vs->vqs[index].vq)) {
1503 ret = -EFAULT;
1504 goto err_dev;
1505 }
1506 }
1507
1508 if (!vs->vs_tpg) {
1509 ret = 0;
1510 goto err_dev;
1511 }
1512
1513 for (i = 0; i < VHOST_SCSI_MAX_TARGET; i++) {
1514 target = i;
1515 tpg = vs->vs_tpg[target];
1516 if (!tpg)
1517 continue;
1518
1519 mutex_lock(&tpg->tv_tpg_mutex);
1520 tv_tport = tpg->tport;
1521 if (!tv_tport) {
1522 ret = -ENODEV;
1523 goto err_tpg;
1524 }
1525
1526 if (strcmp(tv_tport->tport_name, t->vhost_wwpn)) {
1527 pr_warn("tv_tport->tport_name: %s, tpg->tport_tpgt: %hu"
1528 " does not match t->vhost_wwpn: %s, t->vhost_tpgt: %hu\n",
1529 tv_tport->tport_name, tpg->tport_tpgt,
1530 t->vhost_wwpn, t->vhost_tpgt);
1531 ret = -EINVAL;
1532 goto err_tpg;
1533 }
1534 tpg->tv_tpg_vhost_count--;
1535 tpg->vhost_scsi = NULL;
1536 vs->vs_tpg[target] = NULL;
1537 match = true;
1538 mutex_unlock(&tpg->tv_tpg_mutex);
1539 /*
1540 * Release se_tpg->tpg_group.cg_item configfs dependency now
1541 * to allow vhost-scsi WWPN se_tpg->tpg_group shutdown to occur.
1542 */
1543 se_tpg = &tpg->se_tpg;
1544 target_undepend_item(&se_tpg->tpg_group.cg_item);
1545 }
1546 if (match) {
1547 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1548 vq = &vs->vqs[i].vq;
1549 mutex_lock(&vq->mutex);
1550 vq->private_data = NULL;
1551 mutex_unlock(&vq->mutex);
1552 }
1553 }
1554 /*
1555 * Act as synchronize_rcu to make sure access to
1556 * old vs->vs_tpg is finished.
1557 */
1558 vhost_scsi_flush(vs);
1559 kfree(vs->vs_tpg);
1560 vs->vs_tpg = NULL;
1561 WARN_ON(vs->vs_events_nr);
1562 mutex_unlock(&vs->dev.mutex);
1563 mutex_unlock(&vhost_scsi_mutex);
1564 return 0;
1565
1566err_tpg:
1567 mutex_unlock(&tpg->tv_tpg_mutex);
1568err_dev:
1569 mutex_unlock(&vs->dev.mutex);
1570 mutex_unlock(&vhost_scsi_mutex);
1571 return ret;
1572}
1573
1574static int vhost_scsi_set_features(struct vhost_scsi *vs, u64 features)
1575{
1576 struct vhost_virtqueue *vq;
1577 int i;
1578
1579 if (features & ~VHOST_SCSI_FEATURES)
1580 return -EOPNOTSUPP;
1581
1582 mutex_lock(&vs->dev.mutex);
1583 if ((features & (1 << VHOST_F_LOG_ALL)) &&
1584 !vhost_log_access_ok(&vs->dev)) {
1585 mutex_unlock(&vs->dev.mutex);
1586 return -EFAULT;
1587 }
1588
1589 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1590 vq = &vs->vqs[i].vq;
1591 mutex_lock(&vq->mutex);
1592 vq->acked_features = features;
1593 mutex_unlock(&vq->mutex);
1594 }
1595 mutex_unlock(&vs->dev.mutex);
1596 return 0;
1597}
1598
1599static int vhost_scsi_open(struct inode *inode, struct file *f)
1600{
1601 struct vhost_scsi *vs;
1602 struct vhost_virtqueue **vqs;
1603 int r = -ENOMEM, i;
1604
1605 vs = kzalloc(sizeof(*vs), GFP_KERNEL | __GFP_NOWARN | __GFP_RETRY_MAYFAIL);
1606 if (!vs) {
1607 vs = vzalloc(sizeof(*vs));
1608 if (!vs)
1609 goto err_vs;
1610 }
1611
1612 vqs = kmalloc_array(VHOST_SCSI_MAX_VQ, sizeof(*vqs), GFP_KERNEL);
1613 if (!vqs)
1614 goto err_vqs;
1615
1616 vhost_work_init(&vs->vs_completion_work, vhost_scsi_complete_cmd_work);
1617 vhost_work_init(&vs->vs_event_work, vhost_scsi_evt_work);
1618
1619 vs->vs_events_nr = 0;
1620 vs->vs_events_missed = false;
1621
1622 vqs[VHOST_SCSI_VQ_CTL] = &vs->vqs[VHOST_SCSI_VQ_CTL].vq;
1623 vqs[VHOST_SCSI_VQ_EVT] = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1624 vs->vqs[VHOST_SCSI_VQ_CTL].vq.handle_kick = vhost_scsi_ctl_handle_kick;
1625 vs->vqs[VHOST_SCSI_VQ_EVT].vq.handle_kick = vhost_scsi_evt_handle_kick;
1626 for (i = VHOST_SCSI_VQ_IO; i < VHOST_SCSI_MAX_VQ; i++) {
1627 vqs[i] = &vs->vqs[i].vq;
1628 vs->vqs[i].vq.handle_kick = vhost_scsi_handle_kick;
1629 }
1630 vhost_dev_init(&vs->dev, vqs, VHOST_SCSI_MAX_VQ, UIO_MAXIOV);
1631
1632 vhost_scsi_init_inflight(vs, NULL);
1633
1634 f->private_data = vs;
1635 return 0;
1636
1637err_vqs:
1638 kvfree(vs);
1639err_vs:
1640 return r;
1641}
1642
1643static int vhost_scsi_release(struct inode *inode, struct file *f)
1644{
1645 struct vhost_scsi *vs = f->private_data;
1646 struct vhost_scsi_target t;
1647
1648 mutex_lock(&vs->dev.mutex);
1649 memcpy(t.vhost_wwpn, vs->vs_vhost_wwpn, sizeof(t.vhost_wwpn));
1650 mutex_unlock(&vs->dev.mutex);
1651 vhost_scsi_clear_endpoint(vs, &t);
1652 vhost_dev_stop(&vs->dev);
1653 vhost_dev_cleanup(&vs->dev);
1654 /* Jobs can re-queue themselves in evt kick handler. Do extra flush. */
1655 vhost_scsi_flush(vs);
1656 kfree(vs->dev.vqs);
1657 kvfree(vs);
1658 return 0;
1659}
1660
1661static long
1662vhost_scsi_ioctl(struct file *f,
1663 unsigned int ioctl,
1664 unsigned long arg)
1665{
1666 struct vhost_scsi *vs = f->private_data;
1667 struct vhost_scsi_target backend;
1668 void __user *argp = (void __user *)arg;
1669 u64 __user *featurep = argp;
1670 u32 __user *eventsp = argp;
1671 u32 events_missed;
1672 u64 features;
1673 int r, abi_version = VHOST_SCSI_ABI_VERSION;
1674 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1675
1676 switch (ioctl) {
1677 case VHOST_SCSI_SET_ENDPOINT:
1678 if (copy_from_user(&backend, argp, sizeof backend))
1679 return -EFAULT;
1680 if (backend.reserved != 0)
1681 return -EOPNOTSUPP;
1682
1683 return vhost_scsi_set_endpoint(vs, &backend);
1684 case VHOST_SCSI_CLEAR_ENDPOINT:
1685 if (copy_from_user(&backend, argp, sizeof backend))
1686 return -EFAULT;
1687 if (backend.reserved != 0)
1688 return -EOPNOTSUPP;
1689
1690 return vhost_scsi_clear_endpoint(vs, &backend);
1691 case VHOST_SCSI_GET_ABI_VERSION:
1692 if (copy_to_user(argp, &abi_version, sizeof abi_version))
1693 return -EFAULT;
1694 return 0;
1695 case VHOST_SCSI_SET_EVENTS_MISSED:
1696 if (get_user(events_missed, eventsp))
1697 return -EFAULT;
1698 mutex_lock(&vq->mutex);
1699 vs->vs_events_missed = events_missed;
1700 mutex_unlock(&vq->mutex);
1701 return 0;
1702 case VHOST_SCSI_GET_EVENTS_MISSED:
1703 mutex_lock(&vq->mutex);
1704 events_missed = vs->vs_events_missed;
1705 mutex_unlock(&vq->mutex);
1706 if (put_user(events_missed, eventsp))
1707 return -EFAULT;
1708 return 0;
1709 case VHOST_GET_FEATURES:
1710 features = VHOST_SCSI_FEATURES;
1711 if (copy_to_user(featurep, &features, sizeof features))
1712 return -EFAULT;
1713 return 0;
1714 case VHOST_SET_FEATURES:
1715 if (copy_from_user(&features, featurep, sizeof features))
1716 return -EFAULT;
1717 return vhost_scsi_set_features(vs, features);
1718 default:
1719 mutex_lock(&vs->dev.mutex);
1720 r = vhost_dev_ioctl(&vs->dev, ioctl, argp);
1721 /* TODO: flush backend after dev ioctl. */
1722 if (r == -ENOIOCTLCMD)
1723 r = vhost_vring_ioctl(&vs->dev, ioctl, argp);
1724 mutex_unlock(&vs->dev.mutex);
1725 return r;
1726 }
1727}
1728
1729#ifdef CONFIG_COMPAT
1730static long vhost_scsi_compat_ioctl(struct file *f, unsigned int ioctl,
1731 unsigned long arg)
1732{
1733 return vhost_scsi_ioctl(f, ioctl, (unsigned long)compat_ptr(arg));
1734}
1735#endif
1736
1737static const struct file_operations vhost_scsi_fops = {
1738 .owner = THIS_MODULE,
1739 .release = vhost_scsi_release,
1740 .unlocked_ioctl = vhost_scsi_ioctl,
1741#ifdef CONFIG_COMPAT
1742 .compat_ioctl = vhost_scsi_compat_ioctl,
1743#endif
1744 .open = vhost_scsi_open,
1745 .llseek = noop_llseek,
1746};
1747
1748static struct miscdevice vhost_scsi_misc = {
1749 MISC_DYNAMIC_MINOR,
1750 "vhost-scsi",
1751 &vhost_scsi_fops,
1752};
1753
1754static int __init vhost_scsi_register(void)
1755{
1756 return misc_register(&vhost_scsi_misc);
1757}
1758
1759static void vhost_scsi_deregister(void)
1760{
1761 misc_deregister(&vhost_scsi_misc);
1762}
1763
1764static char *vhost_scsi_dump_proto_id(struct vhost_scsi_tport *tport)
1765{
1766 switch (tport->tport_proto_id) {
1767 case SCSI_PROTOCOL_SAS:
1768 return "SAS";
1769 case SCSI_PROTOCOL_FCP:
1770 return "FCP";
1771 case SCSI_PROTOCOL_ISCSI:
1772 return "iSCSI";
1773 default:
1774 break;
1775 }
1776
1777 return "Unknown";
1778}
1779
1780static void
1781vhost_scsi_do_plug(struct vhost_scsi_tpg *tpg,
1782 struct se_lun *lun, bool plug)
1783{
1784
1785 struct vhost_scsi *vs = tpg->vhost_scsi;
1786 struct vhost_virtqueue *vq;
1787 u32 reason;
1788
1789 if (!vs)
1790 return;
1791
1792 mutex_lock(&vs->dev.mutex);
1793
1794 if (plug)
1795 reason = VIRTIO_SCSI_EVT_RESET_RESCAN;
1796 else
1797 reason = VIRTIO_SCSI_EVT_RESET_REMOVED;
1798
1799 vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1800 mutex_lock(&vq->mutex);
1801 if (vhost_has_feature(vq, VIRTIO_SCSI_F_HOTPLUG))
1802 vhost_scsi_send_evt(vs, tpg, lun,
1803 VIRTIO_SCSI_T_TRANSPORT_RESET, reason);
1804 mutex_unlock(&vq->mutex);
1805 mutex_unlock(&vs->dev.mutex);
1806}
1807
1808static void vhost_scsi_hotplug(struct vhost_scsi_tpg *tpg, struct se_lun *lun)
1809{
1810 vhost_scsi_do_plug(tpg, lun, true);
1811}
1812
1813static void vhost_scsi_hotunplug(struct vhost_scsi_tpg *tpg, struct se_lun *lun)
1814{
1815 vhost_scsi_do_plug(tpg, lun, false);
1816}
1817
1818static int vhost_scsi_port_link(struct se_portal_group *se_tpg,
1819 struct se_lun *lun)
1820{
1821 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1822 struct vhost_scsi_tpg, se_tpg);
1823
1824 mutex_lock(&vhost_scsi_mutex);
1825
1826 mutex_lock(&tpg->tv_tpg_mutex);
1827 tpg->tv_tpg_port_count++;
1828 mutex_unlock(&tpg->tv_tpg_mutex);
1829
1830 vhost_scsi_hotplug(tpg, lun);
1831
1832 mutex_unlock(&vhost_scsi_mutex);
1833
1834 return 0;
1835}
1836
1837static void vhost_scsi_port_unlink(struct se_portal_group *se_tpg,
1838 struct se_lun *lun)
1839{
1840 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1841 struct vhost_scsi_tpg, se_tpg);
1842
1843 mutex_lock(&vhost_scsi_mutex);
1844
1845 mutex_lock(&tpg->tv_tpg_mutex);
1846 tpg->tv_tpg_port_count--;
1847 mutex_unlock(&tpg->tv_tpg_mutex);
1848
1849 vhost_scsi_hotunplug(tpg, lun);
1850
1851 mutex_unlock(&vhost_scsi_mutex);
1852}
1853
1854static void vhost_scsi_free_cmd_map_res(struct se_session *se_sess)
1855{
1856 struct vhost_scsi_cmd *tv_cmd;
1857 unsigned int i;
1858
1859 if (!se_sess->sess_cmd_map)
1860 return;
1861
1862 for (i = 0; i < VHOST_SCSI_DEFAULT_TAGS; i++) {
1863 tv_cmd = &((struct vhost_scsi_cmd *)se_sess->sess_cmd_map)[i];
1864
1865 kfree(tv_cmd->tvc_sgl);
1866 kfree(tv_cmd->tvc_prot_sgl);
1867 kfree(tv_cmd->tvc_upages);
1868 }
1869}
1870
1871static ssize_t vhost_scsi_tpg_attrib_fabric_prot_type_store(
1872 struct config_item *item, const char *page, size_t count)
1873{
1874 struct se_portal_group *se_tpg = attrib_to_tpg(item);
1875 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1876 struct vhost_scsi_tpg, se_tpg);
1877 unsigned long val;
1878 int ret = kstrtoul(page, 0, &val);
1879
1880 if (ret) {
1881 pr_err("kstrtoul() returned %d for fabric_prot_type\n", ret);
1882 return ret;
1883 }
1884 if (val != 0 && val != 1 && val != 3) {
1885 pr_err("Invalid vhost_scsi fabric_prot_type: %lu\n", val);
1886 return -EINVAL;
1887 }
1888 tpg->tv_fabric_prot_type = val;
1889
1890 return count;
1891}
1892
1893static ssize_t vhost_scsi_tpg_attrib_fabric_prot_type_show(
1894 struct config_item *item, char *page)
1895{
1896 struct se_portal_group *se_tpg = attrib_to_tpg(item);
1897 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1898 struct vhost_scsi_tpg, se_tpg);
1899
1900 return sprintf(page, "%d\n", tpg->tv_fabric_prot_type);
1901}
1902
1903CONFIGFS_ATTR(vhost_scsi_tpg_attrib_, fabric_prot_type);
1904
1905static struct configfs_attribute *vhost_scsi_tpg_attrib_attrs[] = {
1906 &vhost_scsi_tpg_attrib_attr_fabric_prot_type,
1907 NULL,
1908};
1909
1910static int vhost_scsi_nexus_cb(struct se_portal_group *se_tpg,
1911 struct se_session *se_sess, void *p)
1912{
1913 struct vhost_scsi_cmd *tv_cmd;
1914 unsigned int i;
1915
1916 for (i = 0; i < VHOST_SCSI_DEFAULT_TAGS; i++) {
1917 tv_cmd = &((struct vhost_scsi_cmd *)se_sess->sess_cmd_map)[i];
1918
1919 tv_cmd->tvc_sgl = kcalloc(VHOST_SCSI_PREALLOC_SGLS,
1920 sizeof(struct scatterlist),
1921 GFP_KERNEL);
1922 if (!tv_cmd->tvc_sgl) {
1923 pr_err("Unable to allocate tv_cmd->tvc_sgl\n");
1924 goto out;
1925 }
1926
1927 tv_cmd->tvc_upages = kcalloc(VHOST_SCSI_PREALLOC_UPAGES,
1928 sizeof(struct page *),
1929 GFP_KERNEL);
1930 if (!tv_cmd->tvc_upages) {
1931 pr_err("Unable to allocate tv_cmd->tvc_upages\n");
1932 goto out;
1933 }
1934
1935 tv_cmd->tvc_prot_sgl = kcalloc(VHOST_SCSI_PREALLOC_PROT_SGLS,
1936 sizeof(struct scatterlist),
1937 GFP_KERNEL);
1938 if (!tv_cmd->tvc_prot_sgl) {
1939 pr_err("Unable to allocate tv_cmd->tvc_prot_sgl\n");
1940 goto out;
1941 }
1942 }
1943 return 0;
1944out:
1945 vhost_scsi_free_cmd_map_res(se_sess);
1946 return -ENOMEM;
1947}
1948
1949static int vhost_scsi_make_nexus(struct vhost_scsi_tpg *tpg,
1950 const char *name)
1951{
1952 struct vhost_scsi_nexus *tv_nexus;
1953
1954 mutex_lock(&tpg->tv_tpg_mutex);
1955 if (tpg->tpg_nexus) {
1956 mutex_unlock(&tpg->tv_tpg_mutex);
1957 pr_debug("tpg->tpg_nexus already exists\n");
1958 return -EEXIST;
1959 }
1960
1961 tv_nexus = kzalloc(sizeof(*tv_nexus), GFP_KERNEL);
1962 if (!tv_nexus) {
1963 mutex_unlock(&tpg->tv_tpg_mutex);
1964 pr_err("Unable to allocate struct vhost_scsi_nexus\n");
1965 return -ENOMEM;
1966 }
1967 /*
1968 * Since we are running in 'demo mode' this call with generate a
1969 * struct se_node_acl for the vhost_scsi struct se_portal_group with
1970 * the SCSI Initiator port name of the passed configfs group 'name'.
1971 */
1972 tv_nexus->tvn_se_sess = target_setup_session(&tpg->se_tpg,
1973 VHOST_SCSI_DEFAULT_TAGS,
1974 sizeof(struct vhost_scsi_cmd),
1975 TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS,
1976 (unsigned char *)name, tv_nexus,
1977 vhost_scsi_nexus_cb);
1978 if (IS_ERR(tv_nexus->tvn_se_sess)) {
1979 mutex_unlock(&tpg->tv_tpg_mutex);
1980 kfree(tv_nexus);
1981 return -ENOMEM;
1982 }
1983 tpg->tpg_nexus = tv_nexus;
1984
1985 mutex_unlock(&tpg->tv_tpg_mutex);
1986 return 0;
1987}
1988
1989static int vhost_scsi_drop_nexus(struct vhost_scsi_tpg *tpg)
1990{
1991 struct se_session *se_sess;
1992 struct vhost_scsi_nexus *tv_nexus;
1993
1994 mutex_lock(&tpg->tv_tpg_mutex);
1995 tv_nexus = tpg->tpg_nexus;
1996 if (!tv_nexus) {
1997 mutex_unlock(&tpg->tv_tpg_mutex);
1998 return -ENODEV;
1999 }
2000
2001 se_sess = tv_nexus->tvn_se_sess;
2002 if (!se_sess) {
2003 mutex_unlock(&tpg->tv_tpg_mutex);
2004 return -ENODEV;
2005 }
2006
2007 if (tpg->tv_tpg_port_count != 0) {
2008 mutex_unlock(&tpg->tv_tpg_mutex);
2009 pr_err("Unable to remove TCM_vhost I_T Nexus with"
2010 " active TPG port count: %d\n",
2011 tpg->tv_tpg_port_count);
2012 return -EBUSY;
2013 }
2014
2015 if (tpg->tv_tpg_vhost_count != 0) {
2016 mutex_unlock(&tpg->tv_tpg_mutex);
2017 pr_err("Unable to remove TCM_vhost I_T Nexus with"
2018 " active TPG vhost count: %d\n",
2019 tpg->tv_tpg_vhost_count);
2020 return -EBUSY;
2021 }
2022
2023 pr_debug("TCM_vhost_ConfigFS: Removing I_T Nexus to emulated"
2024 " %s Initiator Port: %s\n", vhost_scsi_dump_proto_id(tpg->tport),
2025 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
2026
2027 vhost_scsi_free_cmd_map_res(se_sess);
2028 /*
2029 * Release the SCSI I_T Nexus to the emulated vhost Target Port
2030 */
2031 target_remove_session(se_sess);
2032 tpg->tpg_nexus = NULL;
2033 mutex_unlock(&tpg->tv_tpg_mutex);
2034
2035 kfree(tv_nexus);
2036 return 0;
2037}
2038
2039static ssize_t vhost_scsi_tpg_nexus_show(struct config_item *item, char *page)
2040{
2041 struct se_portal_group *se_tpg = to_tpg(item);
2042 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2043 struct vhost_scsi_tpg, se_tpg);
2044 struct vhost_scsi_nexus *tv_nexus;
2045 ssize_t ret;
2046
2047 mutex_lock(&tpg->tv_tpg_mutex);
2048 tv_nexus = tpg->tpg_nexus;
2049 if (!tv_nexus) {
2050 mutex_unlock(&tpg->tv_tpg_mutex);
2051 return -ENODEV;
2052 }
2053 ret = snprintf(page, PAGE_SIZE, "%s\n",
2054 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
2055 mutex_unlock(&tpg->tv_tpg_mutex);
2056
2057 return ret;
2058}
2059
2060static ssize_t vhost_scsi_tpg_nexus_store(struct config_item *item,
2061 const char *page, size_t count)
2062{
2063 struct se_portal_group *se_tpg = to_tpg(item);
2064 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2065 struct vhost_scsi_tpg, se_tpg);
2066 struct vhost_scsi_tport *tport_wwn = tpg->tport;
2067 unsigned char i_port[VHOST_SCSI_NAMELEN], *ptr, *port_ptr;
2068 int ret;
2069 /*
2070 * Shutdown the active I_T nexus if 'NULL' is passed..
2071 */
2072 if (!strncmp(page, "NULL", 4)) {
2073 ret = vhost_scsi_drop_nexus(tpg);
2074 return (!ret) ? count : ret;
2075 }
2076 /*
2077 * Otherwise make sure the passed virtual Initiator port WWN matches
2078 * the fabric protocol_id set in vhost_scsi_make_tport(), and call
2079 * vhost_scsi_make_nexus().
2080 */
2081 if (strlen(page) >= VHOST_SCSI_NAMELEN) {
2082 pr_err("Emulated NAA Sas Address: %s, exceeds"
2083 " max: %d\n", page, VHOST_SCSI_NAMELEN);
2084 return -EINVAL;
2085 }
2086 snprintf(&i_port[0], VHOST_SCSI_NAMELEN, "%s", page);
2087
2088 ptr = strstr(i_port, "naa.");
2089 if (ptr) {
2090 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_SAS) {
2091 pr_err("Passed SAS Initiator Port %s does not"
2092 " match target port protoid: %s\n", i_port,
2093 vhost_scsi_dump_proto_id(tport_wwn));
2094 return -EINVAL;
2095 }
2096 port_ptr = &i_port[0];
2097 goto check_newline;
2098 }
2099 ptr = strstr(i_port, "fc.");
2100 if (ptr) {
2101 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_FCP) {
2102 pr_err("Passed FCP Initiator Port %s does not"
2103 " match target port protoid: %s\n", i_port,
2104 vhost_scsi_dump_proto_id(tport_wwn));
2105 return -EINVAL;
2106 }
2107 port_ptr = &i_port[3]; /* Skip over "fc." */
2108 goto check_newline;
2109 }
2110 ptr = strstr(i_port, "iqn.");
2111 if (ptr) {
2112 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_ISCSI) {
2113 pr_err("Passed iSCSI Initiator Port %s does not"
2114 " match target port protoid: %s\n", i_port,
2115 vhost_scsi_dump_proto_id(tport_wwn));
2116 return -EINVAL;
2117 }
2118 port_ptr = &i_port[0];
2119 goto check_newline;
2120 }
2121 pr_err("Unable to locate prefix for emulated Initiator Port:"
2122 " %s\n", i_port);
2123 return -EINVAL;
2124 /*
2125 * Clear any trailing newline for the NAA WWN
2126 */
2127check_newline:
2128 if (i_port[strlen(i_port)-1] == '\n')
2129 i_port[strlen(i_port)-1] = '\0';
2130
2131 ret = vhost_scsi_make_nexus(tpg, port_ptr);
2132 if (ret < 0)
2133 return ret;
2134
2135 return count;
2136}
2137
2138CONFIGFS_ATTR(vhost_scsi_tpg_, nexus);
2139
2140static struct configfs_attribute *vhost_scsi_tpg_attrs[] = {
2141 &vhost_scsi_tpg_attr_nexus,
2142 NULL,
2143};
2144
2145static struct se_portal_group *
2146vhost_scsi_make_tpg(struct se_wwn *wwn, const char *name)
2147{
2148 struct vhost_scsi_tport *tport = container_of(wwn,
2149 struct vhost_scsi_tport, tport_wwn);
2150
2151 struct vhost_scsi_tpg *tpg;
2152 u16 tpgt;
2153 int ret;
2154
2155 if (strstr(name, "tpgt_") != name)
2156 return ERR_PTR(-EINVAL);
2157 if (kstrtou16(name + 5, 10, &tpgt) || tpgt >= VHOST_SCSI_MAX_TARGET)
2158 return ERR_PTR(-EINVAL);
2159
2160 tpg = kzalloc(sizeof(*tpg), GFP_KERNEL);
2161 if (!tpg) {
2162 pr_err("Unable to allocate struct vhost_scsi_tpg");
2163 return ERR_PTR(-ENOMEM);
2164 }
2165 mutex_init(&tpg->tv_tpg_mutex);
2166 INIT_LIST_HEAD(&tpg->tv_tpg_list);
2167 tpg->tport = tport;
2168 tpg->tport_tpgt = tpgt;
2169
2170 ret = core_tpg_register(wwn, &tpg->se_tpg, tport->tport_proto_id);
2171 if (ret < 0) {
2172 kfree(tpg);
2173 return NULL;
2174 }
2175 mutex_lock(&vhost_scsi_mutex);
2176 list_add_tail(&tpg->tv_tpg_list, &vhost_scsi_list);
2177 mutex_unlock(&vhost_scsi_mutex);
2178
2179 return &tpg->se_tpg;
2180}
2181
2182static void vhost_scsi_drop_tpg(struct se_portal_group *se_tpg)
2183{
2184 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2185 struct vhost_scsi_tpg, se_tpg);
2186
2187 mutex_lock(&vhost_scsi_mutex);
2188 list_del(&tpg->tv_tpg_list);
2189 mutex_unlock(&vhost_scsi_mutex);
2190 /*
2191 * Release the virtual I_T Nexus for this vhost TPG
2192 */
2193 vhost_scsi_drop_nexus(tpg);
2194 /*
2195 * Deregister the se_tpg from TCM..
2196 */
2197 core_tpg_deregister(se_tpg);
2198 kfree(tpg);
2199}
2200
2201static struct se_wwn *
2202vhost_scsi_make_tport(struct target_fabric_configfs *tf,
2203 struct config_group *group,
2204 const char *name)
2205{
2206 struct vhost_scsi_tport *tport;
2207 char *ptr;
2208 u64 wwpn = 0;
2209 int off = 0;
2210
2211 /* if (vhost_scsi_parse_wwn(name, &wwpn, 1) < 0)
2212 return ERR_PTR(-EINVAL); */
2213
2214 tport = kzalloc(sizeof(*tport), GFP_KERNEL);
2215 if (!tport) {
2216 pr_err("Unable to allocate struct vhost_scsi_tport");
2217 return ERR_PTR(-ENOMEM);
2218 }
2219 tport->tport_wwpn = wwpn;
2220 /*
2221 * Determine the emulated Protocol Identifier and Target Port Name
2222 * based on the incoming configfs directory name.
2223 */
2224 ptr = strstr(name, "naa.");
2225 if (ptr) {
2226 tport->tport_proto_id = SCSI_PROTOCOL_SAS;
2227 goto check_len;
2228 }
2229 ptr = strstr(name, "fc.");
2230 if (ptr) {
2231 tport->tport_proto_id = SCSI_PROTOCOL_FCP;
2232 off = 3; /* Skip over "fc." */
2233 goto check_len;
2234 }
2235 ptr = strstr(name, "iqn.");
2236 if (ptr) {
2237 tport->tport_proto_id = SCSI_PROTOCOL_ISCSI;
2238 goto check_len;
2239 }
2240
2241 pr_err("Unable to locate prefix for emulated Target Port:"
2242 " %s\n", name);
2243 kfree(tport);
2244 return ERR_PTR(-EINVAL);
2245
2246check_len:
2247 if (strlen(name) >= VHOST_SCSI_NAMELEN) {
2248 pr_err("Emulated %s Address: %s, exceeds"
2249 " max: %d\n", name, vhost_scsi_dump_proto_id(tport),
2250 VHOST_SCSI_NAMELEN);
2251 kfree(tport);
2252 return ERR_PTR(-EINVAL);
2253 }
2254 snprintf(&tport->tport_name[0], VHOST_SCSI_NAMELEN, "%s", &name[off]);
2255
2256 pr_debug("TCM_VHost_ConfigFS: Allocated emulated Target"
2257 " %s Address: %s\n", vhost_scsi_dump_proto_id(tport), name);
2258
2259 return &tport->tport_wwn;
2260}
2261
2262static void vhost_scsi_drop_tport(struct se_wwn *wwn)
2263{
2264 struct vhost_scsi_tport *tport = container_of(wwn,
2265 struct vhost_scsi_tport, tport_wwn);
2266
2267 pr_debug("TCM_VHost_ConfigFS: Deallocating emulated Target"
2268 " %s Address: %s\n", vhost_scsi_dump_proto_id(tport),
2269 tport->tport_name);
2270
2271 kfree(tport);
2272}
2273
2274static ssize_t
2275vhost_scsi_wwn_version_show(struct config_item *item, char *page)
2276{
2277 return sprintf(page, "TCM_VHOST fabric module %s on %s/%s"
2278 "on "UTS_RELEASE"\n", VHOST_SCSI_VERSION, utsname()->sysname,
2279 utsname()->machine);
2280}
2281
2282CONFIGFS_ATTR_RO(vhost_scsi_wwn_, version);
2283
2284static struct configfs_attribute *vhost_scsi_wwn_attrs[] = {
2285 &vhost_scsi_wwn_attr_version,
2286 NULL,
2287};
2288
2289static const struct target_core_fabric_ops vhost_scsi_ops = {
2290 .module = THIS_MODULE,
2291 .fabric_name = "vhost",
2292 .tpg_get_wwn = vhost_scsi_get_fabric_wwn,
2293 .tpg_get_tag = vhost_scsi_get_tpgt,
2294 .tpg_check_demo_mode = vhost_scsi_check_true,
2295 .tpg_check_demo_mode_cache = vhost_scsi_check_true,
2296 .tpg_check_demo_mode_write_protect = vhost_scsi_check_false,
2297 .tpg_check_prod_mode_write_protect = vhost_scsi_check_false,
2298 .tpg_check_prot_fabric_only = vhost_scsi_check_prot_fabric_only,
2299 .tpg_get_inst_index = vhost_scsi_tpg_get_inst_index,
2300 .release_cmd = vhost_scsi_release_cmd,
2301 .check_stop_free = vhost_scsi_check_stop_free,
2302 .sess_get_index = vhost_scsi_sess_get_index,
2303 .sess_get_initiator_sid = NULL,
2304 .write_pending = vhost_scsi_write_pending,
2305 .write_pending_status = vhost_scsi_write_pending_status,
2306 .set_default_node_attributes = vhost_scsi_set_default_node_attrs,
2307 .get_cmd_state = vhost_scsi_get_cmd_state,
2308 .queue_data_in = vhost_scsi_queue_data_in,
2309 .queue_status = vhost_scsi_queue_status,
2310 .queue_tm_rsp = vhost_scsi_queue_tm_rsp,
2311 .aborted_task = vhost_scsi_aborted_task,
2312 /*
2313 * Setup callers for generic logic in target_core_fabric_configfs.c
2314 */
2315 .fabric_make_wwn = vhost_scsi_make_tport,
2316 .fabric_drop_wwn = vhost_scsi_drop_tport,
2317 .fabric_make_tpg = vhost_scsi_make_tpg,
2318 .fabric_drop_tpg = vhost_scsi_drop_tpg,
2319 .fabric_post_link = vhost_scsi_port_link,
2320 .fabric_pre_unlink = vhost_scsi_port_unlink,
2321
2322 .tfc_wwn_attrs = vhost_scsi_wwn_attrs,
2323 .tfc_tpg_base_attrs = vhost_scsi_tpg_attrs,
2324 .tfc_tpg_attrib_attrs = vhost_scsi_tpg_attrib_attrs,
2325};
2326
2327static int __init vhost_scsi_init(void)
2328{
2329 int ret = -ENOMEM;
2330
2331 pr_debug("TCM_VHOST fabric module %s on %s/%s"
2332 " on "UTS_RELEASE"\n", VHOST_SCSI_VERSION, utsname()->sysname,
2333 utsname()->machine);
2334
2335 /*
2336 * Use our own dedicated workqueue for submitting I/O into
2337 * target core to avoid contention within system_wq.
2338 */
2339 vhost_scsi_workqueue = alloc_workqueue("vhost_scsi", 0, 0);
2340 if (!vhost_scsi_workqueue)
2341 goto out;
2342
2343 ret = vhost_scsi_register();
2344 if (ret < 0)
2345 goto out_destroy_workqueue;
2346
2347 ret = target_register_template(&vhost_scsi_ops);
2348 if (ret < 0)
2349 goto out_vhost_scsi_deregister;
2350
2351 return 0;
2352
2353out_vhost_scsi_deregister:
2354 vhost_scsi_deregister();
2355out_destroy_workqueue:
2356 destroy_workqueue(vhost_scsi_workqueue);
2357out:
2358 return ret;
2359};
2360
2361static void vhost_scsi_exit(void)
2362{
2363 target_unregister_template(&vhost_scsi_ops);
2364 vhost_scsi_deregister();
2365 destroy_workqueue(vhost_scsi_workqueue);
2366};
2367
2368MODULE_DESCRIPTION("VHOST_SCSI series fabric driver");
2369MODULE_ALIAS("tcm_vhost");
2370MODULE_LICENSE("GPL");
2371module_init(vhost_scsi_init);
2372module_exit(vhost_scsi_exit);