2 * Xen SCSI backend driver
4 * Copyright (c) 2008, FUJITSU Limited
6 * Based on the blkback driver code.
7 * Adaption to kernel taget core infrastructure taken from vhost/scsi.c
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License version 2
11 * as published by the Free Software Foundation; or, when distributed
12 * separately from the Linux kernel or incorporated into other
13 * software packages, subject to the following license:
15 * Permission is hereby granted, free of charge, to any person obtaining a copy
16 * of this source file (the "Software"), to deal in the Software without
17 * restriction, including without limitation the rights to use, copy, modify,
18 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
19 * and to permit persons to whom the Software is furnished to do so, subject to
20 * the following conditions:
22 * The above copyright notice and this permission notice shall be included in
23 * all copies or substantial portions of the Software.
25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
29 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
30 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
34 #define pr_fmt(fmt) "xen-pvscsi: " fmt
36 #include <linux/module.h>
37 #include <linux/utsname.h>
38 #include <linux/interrupt.h>
39 #include <linux/slab.h>
40 #include <linux/wait.h>
41 #include <linux/sched.h>
42 #include <linux/list.h>
43 #include <linux/gfp.h>
44 #include <linux/delay.h>
45 #include <linux/spinlock.h>
46 #include <linux/configfs.h>
48 #include <generated/utsrelease.h>
50 #include <scsi/scsi_host.h> /* SG_ALL */
52 #include <target/target_core_base.h>
53 #include <target/target_core_fabric.h>
55 #include <asm/hypervisor.h>
58 #include <xen/balloon.h>
59 #include <xen/events.h>
60 #include <xen/xenbus.h>
61 #include <xen/grant_table.h>
64 #include <xen/interface/grant_table.h>
65 #include <xen/interface/io/vscsiif.h>
67 #define VSCSI_VERSION "v0.1"
68 #define VSCSI_NAMELEN 32
71 unsigned int hst; /* host */
72 unsigned int chn; /* channel */
73 unsigned int tgt; /* target */
74 unsigned int lun; /* LUN */
78 struct ids_tuple v; /* translate from */
79 struct scsiback_tpg *tpg; /* translate to */
86 struct xenbus_device *dev;
91 struct vscsiif_back_ring ring;
94 atomic_t nr_unreplied_reqs;
97 struct list_head v2p_entry_lists;
99 wait_queue_head_t waiting_to_free;
101 struct gnttab_page_cache free_pages;
104 /* theoretical maximum of grants for one request */
105 #define VSCSI_MAX_GRANTS (SG_ALL + VSCSIIF_SG_TABLESIZE)
108 * VSCSI_GRANT_BATCH is the maximum number of grants to be processed in one
109 * call to map/unmap grants. Don't choose it too large, as there are arrays
110 * with VSCSI_GRANT_BATCH elements allocated on the stack.
112 #define VSCSI_GRANT_BATCH 16
114 struct vscsibk_pend {
117 uint8_t cmnd[VSCSIIF_MAX_COMMAND_SIZE];
120 uint8_t sc_data_direction;
121 uint16_t n_sg; /* real length of SG list */
122 uint16_t n_grants; /* SG pages and potentially SG list */
126 struct vscsibk_info *info;
127 struct v2p_entry *v2p;
128 struct scatterlist *sgl;
130 uint8_t sense_buffer[VSCSIIF_SENSE_BUFFERSIZE];
132 grant_handle_t grant_handles[VSCSI_MAX_GRANTS];
133 struct page *pages[VSCSI_MAX_GRANTS];
135 struct se_cmd se_cmd;
137 struct completion tmr_done;
140 #define VSCSI_DEFAULT_SESSION_TAGS 128
142 struct scsiback_nexus {
143 /* Pointer to TCM session for I_T Nexus */
144 struct se_session *tvn_se_sess;
147 struct scsiback_tport {
148 /* SCSI protocol the tport is providing */
150 /* Binary World Wide unique Port Name for pvscsi Target port */
152 /* ASCII formatted WWPN for pvscsi Target port */
153 char tport_name[VSCSI_NAMELEN];
154 /* Returned by scsiback_make_tport() */
155 struct se_wwn tport_wwn;
158 struct scsiback_tpg {
159 /* scsiback port target portal group tag for TCM */
161 /* track number of TPG Port/Lun Links wrt explicit I_T Nexus shutdown */
162 int tv_tpg_port_count;
163 /* xen-pvscsi references to tpg_nexus, protected by tv_tpg_mutex */
165 /* list for scsiback_list */
166 struct list_head tv_tpg_list;
167 /* Used to protect access for tpg_nexus */
168 struct mutex tv_tpg_mutex;
169 /* Pointer to the TCM pvscsi I_T Nexus for this TPG endpoint */
170 struct scsiback_nexus *tpg_nexus;
171 /* Pointer back to scsiback_tport */
172 struct scsiback_tport *tport;
173 /* Returned by scsiback_make_tpg() */
174 struct se_portal_group se_tpg;
175 /* alias used in xenstore */
176 char param_alias[VSCSI_NAMELEN];
177 /* list of info structures related to this target portal group */
178 struct list_head info_list;
181 #define SCSIBACK_INVALID_HANDLE (~0)
183 static bool log_print_stat;
184 module_param(log_print_stat, bool, 0644);
186 static int scsiback_max_buffer_pages = 1024;
187 module_param_named(max_buffer_pages, scsiback_max_buffer_pages, int, 0644);
188 MODULE_PARM_DESC(max_buffer_pages,
189 "Maximum number of free pages to keep in backend buffer");
191 /* Global spinlock to protect scsiback TPG list */
192 static DEFINE_MUTEX(scsiback_mutex);
193 static LIST_HEAD(scsiback_list);
195 static void scsiback_get(struct vscsibk_info *info)
197 atomic_inc(&info->nr_unreplied_reqs);
200 static void scsiback_put(struct vscsibk_info *info)
202 if (atomic_dec_and_test(&info->nr_unreplied_reqs))
203 wake_up(&info->waiting_to_free);
206 static unsigned long vaddr_page(struct page *page)
208 unsigned long pfn = page_to_pfn(page);
210 return (unsigned long)pfn_to_kaddr(pfn);
213 static unsigned long vaddr(struct vscsibk_pend *req, int seg)
215 return vaddr_page(req->pages[seg]);
218 static void scsiback_print_status(char *sense_buffer, int errors,
219 struct vscsibk_pend *pending_req)
221 struct scsiback_tpg *tpg = pending_req->v2p->tpg;
223 pr_err("[%s:%d] cmnd[0]=%02x -> st=%02x msg=%02x host=%02x\n",
224 tpg->tport->tport_name, pending_req->v2p->lun,
225 pending_req->cmnd[0], errors & 0xff, COMMAND_COMPLETE,
229 static void scsiback_fast_flush_area(struct vscsibk_pend *req)
231 struct gnttab_unmap_grant_ref unmap[VSCSI_GRANT_BATCH];
232 struct page *pages[VSCSI_GRANT_BATCH];
233 unsigned int i, invcount = 0;
234 grant_handle_t handle;
244 for (i = 0; i < req->n_grants; i++) {
245 handle = req->grant_handles[i];
246 if (handle == SCSIBACK_INVALID_HANDLE)
248 gnttab_set_unmap_op(&unmap[invcount], vaddr(req, i),
249 GNTMAP_host_map, handle);
250 req->grant_handles[i] = SCSIBACK_INVALID_HANDLE;
251 pages[invcount] = req->pages[i];
252 put_page(pages[invcount]);
254 if (invcount < VSCSI_GRANT_BATCH)
256 err = gnttab_unmap_refs(unmap, NULL, pages, invcount);
262 err = gnttab_unmap_refs(unmap, NULL, pages, invcount);
266 gnttab_page_cache_put(&req->info->free_pages, req->pages,
271 static void scsiback_free_translation_entry(struct kref *kref)
273 struct v2p_entry *entry = container_of(kref, struct v2p_entry, kref);
274 struct scsiback_tpg *tpg = entry->tpg;
276 mutex_lock(&tpg->tv_tpg_mutex);
277 tpg->tv_tpg_fe_count--;
278 mutex_unlock(&tpg->tv_tpg_mutex);
283 static int32_t scsiback_result(int32_t result)
287 switch (XEN_VSCSIIF_RSLT_HOST(result)) {
289 host_status = XEN_VSCSIIF_RSLT_HOST_OK;
292 host_status = XEN_VSCSIIF_RSLT_HOST_NO_CONNECT;
295 host_status = XEN_VSCSIIF_RSLT_HOST_BUS_BUSY;
298 host_status = XEN_VSCSIIF_RSLT_HOST_TIME_OUT;
301 host_status = XEN_VSCSIIF_RSLT_HOST_BAD_TARGET;
304 host_status = XEN_VSCSIIF_RSLT_HOST_ABORT;
307 host_status = XEN_VSCSIIF_RSLT_HOST_PARITY;
310 host_status = XEN_VSCSIIF_RSLT_HOST_ERROR;
313 host_status = XEN_VSCSIIF_RSLT_HOST_RESET;
316 host_status = XEN_VSCSIIF_RSLT_HOST_BAD_INTR;
318 case DID_PASSTHROUGH:
319 host_status = XEN_VSCSIIF_RSLT_HOST_PASSTHROUGH;
322 host_status = XEN_VSCSIIF_RSLT_HOST_SOFT_ERROR;
325 host_status = XEN_VSCSIIF_RSLT_HOST_IMM_RETRY;
328 host_status = XEN_VSCSIIF_RSLT_HOST_REQUEUE;
330 case DID_TRANSPORT_DISRUPTED:
331 host_status = XEN_VSCSIIF_RSLT_HOST_TRANSPORT_DISRUPTED;
333 case DID_TRANSPORT_FAILFAST:
334 host_status = XEN_VSCSIIF_RSLT_HOST_TRANSPORT_FAILFAST;
336 case DID_TARGET_FAILURE:
337 host_status = XEN_VSCSIIF_RSLT_HOST_TARGET_FAILURE;
339 case DID_NEXUS_FAILURE:
340 host_status = XEN_VSCSIIF_RSLT_HOST_NEXUS_FAILURE;
342 case DID_ALLOC_FAILURE:
343 host_status = XEN_VSCSIIF_RSLT_HOST_ALLOC_FAILURE;
345 case DID_MEDIUM_ERROR:
346 host_status = XEN_VSCSIIF_RSLT_HOST_MEDIUM_ERROR;
348 case DID_TRANSPORT_MARGINAL:
349 host_status = XEN_VSCSIIF_RSLT_HOST_TRANSPORT_MARGINAL;
352 host_status = XEN_VSCSIIF_RSLT_HOST_ERROR;
356 return (host_status << 16) | (result & 0x00ffff);
359 static void scsiback_send_response(struct vscsibk_info *info,
360 char *sense_buffer, int32_t result, uint32_t resid,
363 struct vscsiif_response *ring_res;
365 struct scsi_sense_hdr sshdr;
369 spin_lock_irqsave(&info->ring_lock, flags);
371 ring_res = RING_GET_RESPONSE(&info->ring, info->ring.rsp_prod_pvt);
372 info->ring.rsp_prod_pvt++;
374 ring_res->rslt = scsiback_result(result);
375 ring_res->rqid = rqid;
377 if (sense_buffer != NULL &&
378 scsi_normalize_sense(sense_buffer, VSCSIIF_SENSE_BUFFERSIZE,
380 len = min_t(unsigned, 8 + sense_buffer[7],
381 VSCSIIF_SENSE_BUFFERSIZE);
382 memcpy(ring_res->sense_buffer, sense_buffer, len);
383 ring_res->sense_len = len;
385 ring_res->sense_len = 0;
388 ring_res->residual_len = resid;
390 RING_PUSH_RESPONSES_AND_CHECK_NOTIFY(&info->ring, notify);
391 spin_unlock_irqrestore(&info->ring_lock, flags);
394 notify_remote_via_irq(info->irq);
397 static void scsiback_do_resp_with_sense(char *sense_buffer, int32_t result,
398 uint32_t resid, struct vscsibk_pend *pending_req)
400 scsiback_send_response(pending_req->info, sense_buffer, result,
401 resid, pending_req->rqid);
403 if (pending_req->v2p)
404 kref_put(&pending_req->v2p->kref,
405 scsiback_free_translation_entry);
408 static void scsiback_cmd_done(struct vscsibk_pend *pending_req)
410 struct vscsibk_info *info = pending_req->info;
411 unsigned char *sense_buffer;
415 sense_buffer = pending_req->sense_buffer;
416 resid = pending_req->se_cmd.residual_count;
417 errors = pending_req->result;
419 if (errors && log_print_stat)
420 scsiback_print_status(sense_buffer, errors, pending_req);
422 scsiback_fast_flush_area(pending_req);
423 scsiback_do_resp_with_sense(sense_buffer, errors, resid, pending_req);
426 * Drop the extra KREF_ACK reference taken by target_submit_cmd_map_sgls()
427 * ahead of scsiback_check_stop_free() -> transport_generic_free_cmd()
428 * final se_cmd->cmd_kref put.
430 target_put_sess_cmd(&pending_req->se_cmd);
433 static void scsiback_cmd_exec(struct vscsibk_pend *pending_req)
435 struct se_cmd *se_cmd = &pending_req->se_cmd;
436 struct se_session *sess = pending_req->v2p->tpg->tpg_nexus->tvn_se_sess;
438 scsiback_get(pending_req->info);
439 se_cmd->tag = pending_req->rqid;
440 target_init_cmd(se_cmd, sess, pending_req->sense_buffer,
441 pending_req->v2p->lun, pending_req->data_len, 0,
442 pending_req->sc_data_direction, TARGET_SCF_ACK_KREF);
444 if (target_submit_prep(se_cmd, pending_req->cmnd, pending_req->sgl,
445 pending_req->n_sg, NULL, 0, NULL, 0, GFP_KERNEL))
448 target_submit(se_cmd);
451 static int scsiback_gnttab_data_map_batch(struct gnttab_map_grant_ref *map,
452 struct page **pg, grant_handle_t *grant, int cnt)
459 err = gnttab_map_refs(map, NULL, pg, cnt);
460 for (i = 0; i < cnt; i++) {
461 if (unlikely(map[i].status != GNTST_okay)) {
462 pr_err("invalid buffer -- could not remap it\n");
463 map[i].handle = SCSIBACK_INVALID_HANDLE;
469 grant[i] = map[i].handle;
474 static int scsiback_gnttab_data_map_list(struct vscsibk_pend *pending_req,
475 struct scsiif_request_segment *seg, struct page **pg,
476 grant_handle_t *grant, int cnt, u32 flags)
478 int mapcount = 0, i, err = 0;
479 struct gnttab_map_grant_ref map[VSCSI_GRANT_BATCH];
480 struct vscsibk_info *info = pending_req->info;
482 for (i = 0; i < cnt; i++) {
483 if (gnttab_page_cache_get(&info->free_pages, pg + mapcount)) {
484 gnttab_page_cache_put(&info->free_pages, pg, mapcount);
485 pr_err("no grant page\n");
488 gnttab_set_map_op(&map[mapcount], vaddr_page(pg[mapcount]),
489 flags, seg[i].gref, info->domid);
491 if (mapcount < VSCSI_GRANT_BATCH)
493 err = scsiback_gnttab_data_map_batch(map, pg, grant, mapcount);
496 pending_req->n_grants += mapcount;
501 err = scsiback_gnttab_data_map_batch(map, pg, grant, mapcount);
502 pending_req->n_grants += mapcount;
506 static int scsiback_gnttab_data_map(struct vscsiif_request *ring_req,
507 struct vscsibk_pend *pending_req)
510 int i, err, n_segs, i_seg = 0;
512 struct scsiif_request_segment *seg;
513 unsigned long end_seg = 0;
514 unsigned int nr_segments = (unsigned int)ring_req->nr_segments;
515 unsigned int nr_sgl = 0;
516 struct scatterlist *sg;
517 grant_handle_t *grant;
519 pending_req->n_sg = 0;
520 pending_req->n_grants = 0;
521 pending_req->data_len = 0;
523 nr_segments &= ~VSCSIIF_SG_GRANT;
527 if (nr_segments > VSCSIIF_SG_TABLESIZE) {
528 pr_debug("invalid parameter nr_seg = %d\n",
529 ring_req->nr_segments);
533 if (ring_req->nr_segments & VSCSIIF_SG_GRANT) {
534 err = scsiback_gnttab_data_map_list(pending_req, ring_req->seg,
535 pending_req->pages, pending_req->grant_handles,
536 nr_segments, GNTMAP_host_map | GNTMAP_readonly);
539 nr_sgl = nr_segments;
541 for (i = 0; i < nr_sgl; i++) {
542 n_segs = ring_req->seg[i].length /
543 sizeof(struct scsiif_request_segment);
544 if ((unsigned)ring_req->seg[i].offset +
545 (unsigned)ring_req->seg[i].length > PAGE_SIZE ||
546 n_segs * sizeof(struct scsiif_request_segment) !=
547 ring_req->seg[i].length)
549 nr_segments += n_segs;
551 if (nr_segments > SG_ALL) {
552 pr_debug("invalid nr_seg = %d\n", nr_segments);
557 /* free of (sgl) in fast_flush_area() */
558 pending_req->sgl = kmalloc_array(nr_segments,
559 sizeof(struct scatterlist), GFP_KERNEL);
560 if (!pending_req->sgl)
563 sg_init_table(pending_req->sgl, nr_segments);
564 pending_req->n_sg = nr_segments;
566 flags = GNTMAP_host_map;
567 if (pending_req->sc_data_direction == DMA_TO_DEVICE)
568 flags |= GNTMAP_readonly;
570 pg = pending_req->pages + nr_sgl;
571 grant = pending_req->grant_handles + nr_sgl;
574 err = scsiback_gnttab_data_map_list(pending_req, seg,
575 pg, grant, nr_segments, flags);
579 for (i = 0; i < nr_sgl; i++) {
580 seg = (struct scsiif_request_segment *)(
581 vaddr(pending_req, i) + ring_req->seg[i].offset);
582 n_segs = ring_req->seg[i].length /
583 sizeof(struct scsiif_request_segment);
584 err = scsiback_gnttab_data_map_list(pending_req, seg,
585 pg, grant, n_segs, flags);
591 end_seg = vaddr(pending_req, 0) + ring_req->seg[0].offset;
592 seg = (struct scsiif_request_segment *)end_seg;
593 end_seg += ring_req->seg[0].length;
594 pg = pending_req->pages + nr_sgl;
597 for_each_sg(pending_req->sgl, sg, nr_segments, i) {
598 sg_set_page(sg, pg[i], seg->length, seg->offset);
599 pending_req->data_len += seg->length;
601 if (nr_sgl && (unsigned long)seg >= end_seg) {
603 end_seg = vaddr(pending_req, i_seg) +
604 ring_req->seg[i_seg].offset;
605 seg = (struct scsiif_request_segment *)end_seg;
606 end_seg += ring_req->seg[i_seg].length;
608 if (sg->offset >= PAGE_SIZE ||
609 sg->length > PAGE_SIZE ||
610 sg->offset + sg->length > PAGE_SIZE)
617 static void scsiback_disconnect(struct vscsibk_info *info)
619 wait_event(info->waiting_to_free,
620 atomic_read(&info->nr_unreplied_reqs) == 0);
622 unbind_from_irqhandler(info->irq, info);
624 xenbus_unmap_ring_vfree(info->dev, info->ring.sring);
627 static void scsiback_device_action(struct vscsibk_pend *pending_req,
628 enum tcm_tmreq_table act, int tag)
630 struct scsiback_tpg *tpg = pending_req->v2p->tpg;
631 struct scsiback_nexus *nexus = tpg->tpg_nexus;
632 struct se_cmd *se_cmd = &pending_req->se_cmd;
633 u64 unpacked_lun = pending_req->v2p->lun;
634 int rc, err = XEN_VSCSIIF_RSLT_RESET_FAILED;
636 init_completion(&pending_req->tmr_done);
638 rc = target_submit_tmr(&pending_req->se_cmd, nexus->tvn_se_sess,
639 &pending_req->sense_buffer[0],
640 unpacked_lun, NULL, act, GFP_KERNEL,
641 tag, TARGET_SCF_ACK_KREF);
645 wait_for_completion(&pending_req->tmr_done);
647 err = (se_cmd->se_tmr_req->response == TMR_FUNCTION_COMPLETE) ?
648 XEN_VSCSIIF_RSLT_RESET_SUCCESS : XEN_VSCSIIF_RSLT_RESET_FAILED;
650 scsiback_do_resp_with_sense(NULL, err, 0, pending_req);
651 transport_generic_free_cmd(&pending_req->se_cmd, 0);
655 scsiback_do_resp_with_sense(NULL, err, 0, pending_req);
659 Perform virtual to physical translation
661 static struct v2p_entry *scsiback_do_translation(struct vscsibk_info *info,
664 struct v2p_entry *entry;
665 struct list_head *head = &(info->v2p_entry_lists);
668 spin_lock_irqsave(&info->v2p_lock, flags);
669 list_for_each_entry(entry, head, l) {
670 if ((entry->v.chn == v->chn) &&
671 (entry->v.tgt == v->tgt) &&
672 (entry->v.lun == v->lun)) {
673 kref_get(&entry->kref);
680 spin_unlock_irqrestore(&info->v2p_lock, flags);
684 static struct vscsibk_pend *scsiback_get_pend_req(struct vscsiif_back_ring *ring,
685 struct v2p_entry *v2p)
687 struct scsiback_tpg *tpg = v2p->tpg;
688 struct scsiback_nexus *nexus = tpg->tpg_nexus;
689 struct se_session *se_sess = nexus->tvn_se_sess;
690 struct vscsibk_pend *req;
693 tag = sbitmap_queue_get(&se_sess->sess_tag_pool, &cpu);
695 pr_err("Unable to obtain tag for vscsiif_request\n");
696 return ERR_PTR(-ENOMEM);
699 req = &((struct vscsibk_pend *)se_sess->sess_cmd_map)[tag];
700 memset(req, 0, sizeof(*req));
701 req->se_cmd.map_tag = tag;
702 req->se_cmd.map_cpu = cpu;
704 for (i = 0; i < VSCSI_MAX_GRANTS; i++)
705 req->grant_handles[i] = SCSIBACK_INVALID_HANDLE;
710 static struct vscsibk_pend *prepare_pending_reqs(struct vscsibk_info *info,
711 struct vscsiif_back_ring *ring,
712 struct vscsiif_request *ring_req)
714 struct vscsibk_pend *pending_req;
715 struct v2p_entry *v2p;
716 struct ids_tuple vir;
718 /* request range check from frontend */
719 if ((ring_req->sc_data_direction != DMA_BIDIRECTIONAL) &&
720 (ring_req->sc_data_direction != DMA_TO_DEVICE) &&
721 (ring_req->sc_data_direction != DMA_FROM_DEVICE) &&
722 (ring_req->sc_data_direction != DMA_NONE)) {
723 pr_debug("invalid parameter data_dir = %d\n",
724 ring_req->sc_data_direction);
725 return ERR_PTR(-EINVAL);
727 if (ring_req->cmd_len > VSCSIIF_MAX_COMMAND_SIZE) {
728 pr_debug("invalid parameter cmd_len = %d\n",
730 return ERR_PTR(-EINVAL);
733 vir.chn = ring_req->channel;
734 vir.tgt = ring_req->id;
735 vir.lun = ring_req->lun;
737 v2p = scsiback_do_translation(info, &vir);
739 pr_debug("the v2p of (chn:%d, tgt:%d, lun:%d) doesn't exist.\n",
740 vir.chn, vir.tgt, vir.lun);
741 return ERR_PTR(-ENODEV);
744 pending_req = scsiback_get_pend_req(ring, v2p);
745 if (IS_ERR(pending_req)) {
746 kref_put(&v2p->kref, scsiback_free_translation_entry);
747 return ERR_PTR(-ENOMEM);
749 pending_req->rqid = ring_req->rqid;
750 pending_req->info = info;
751 pending_req->v2p = v2p;
752 pending_req->sc_data_direction = ring_req->sc_data_direction;
753 pending_req->cmd_len = ring_req->cmd_len;
754 memcpy(pending_req->cmnd, ring_req->cmnd, pending_req->cmd_len);
759 static int scsiback_do_cmd_fn(struct vscsibk_info *info,
760 unsigned int *eoi_flags)
762 struct vscsiif_back_ring *ring = &info->ring;
763 struct vscsiif_request ring_req;
764 struct vscsibk_pend *pending_req;
770 rp = ring->sring->req_prod;
771 rmb(); /* guest system is accessing ring, too */
773 if (RING_REQUEST_PROD_OVERFLOW(ring, rp)) {
774 rc = ring->rsp_prod_pvt;
775 pr_warn("Dom%d provided bogus ring requests (%#x - %#x = %u). Halting ring processing\n",
776 info->domid, rp, rc, rp - rc);
781 *eoi_flags &= ~XEN_EOI_FLAG_SPURIOUS;
783 if (RING_REQUEST_CONS_OVERFLOW(ring, rc))
786 RING_COPY_REQUEST(ring, rc, &ring_req);
787 ring->req_cons = ++rc;
789 pending_req = prepare_pending_reqs(info, ring, &ring_req);
790 if (IS_ERR(pending_req)) {
791 switch (PTR_ERR(pending_req)) {
793 result = DID_NO_CONNECT;
799 scsiback_send_response(info, NULL, result << 16, 0,
804 switch (ring_req.act) {
805 case VSCSIIF_ACT_SCSI_CDB:
806 if (scsiback_gnttab_data_map(&ring_req, pending_req)) {
807 scsiback_fast_flush_area(pending_req);
808 scsiback_do_resp_with_sense(NULL,
809 DID_ERROR << 16, 0, pending_req);
810 transport_generic_free_cmd(&pending_req->se_cmd, 0);
812 scsiback_cmd_exec(pending_req);
815 case VSCSIIF_ACT_SCSI_ABORT:
816 scsiback_device_action(pending_req, TMR_ABORT_TASK,
819 case VSCSIIF_ACT_SCSI_RESET:
820 scsiback_device_action(pending_req, TMR_LUN_RESET, 0);
823 pr_err_ratelimited("invalid request\n");
824 scsiback_do_resp_with_sense(NULL, DID_ERROR << 16, 0,
826 transport_generic_free_cmd(&pending_req->se_cmd, 0);
830 /* Yield point for this unbounded loop. */
834 gnttab_page_cache_shrink(&info->free_pages, scsiback_max_buffer_pages);
836 RING_FINAL_CHECK_FOR_REQUESTS(&info->ring, more_to_do);
840 static irqreturn_t scsiback_irq_fn(int irq, void *dev_id)
842 struct vscsibk_info *info = dev_id;
844 unsigned int eoi_flags = XEN_EOI_FLAG_SPURIOUS;
846 while ((rc = scsiback_do_cmd_fn(info, &eoi_flags)) > 0)
849 /* In case of a ring error we keep the event channel masked. */
851 xen_irq_lateeoi(irq, eoi_flags);
856 static int scsiback_init_sring(struct vscsibk_info *info, grant_ref_t ring_ref,
857 evtchn_port_t evtchn)
860 struct vscsiif_sring *sring;
866 err = xenbus_map_ring_valloc(info->dev, &ring_ref, 1, &area);
870 sring = (struct vscsiif_sring *)area;
871 BACK_RING_INIT(&info->ring, sring, PAGE_SIZE);
873 err = bind_interdomain_evtchn_to_irq_lateeoi(info->dev, evtchn);
879 err = request_threaded_irq(info->irq, NULL, scsiback_irq_fn,
880 IRQF_ONESHOT, "vscsiif-backend", info);
887 unbind_from_irqhandler(info->irq, info);
890 xenbus_unmap_ring_vfree(info->dev, area);
895 static int scsiback_map(struct vscsibk_info *info)
897 struct xenbus_device *dev = info->dev;
898 unsigned int ring_ref;
899 evtchn_port_t evtchn;
902 err = xenbus_gather(XBT_NIL, dev->otherend,
903 "ring-ref", "%u", &ring_ref,
904 "event-channel", "%u", &evtchn, NULL);
906 xenbus_dev_fatal(dev, err, "reading %s ring", dev->otherend);
910 return scsiback_init_sring(info, ring_ref, evtchn);
914 Check for a translation entry being present
916 static struct v2p_entry *scsiback_chk_translation_entry(
917 struct vscsibk_info *info, struct ids_tuple *v)
919 struct list_head *head = &(info->v2p_entry_lists);
920 struct v2p_entry *entry;
922 list_for_each_entry(entry, head, l)
923 if ((entry->v.chn == v->chn) &&
924 (entry->v.tgt == v->tgt) &&
925 (entry->v.lun == v->lun))
932 Add a new translation entry
934 static int scsiback_add_translation_entry(struct vscsibk_info *info,
935 char *phy, struct ids_tuple *v)
938 struct v2p_entry *new;
941 unsigned long long unpacked_lun;
942 struct se_lun *se_lun;
943 struct scsiback_tpg *tpg_entry, *tpg = NULL;
944 char *error = "doesn't exist";
946 lunp = strrchr(phy, ':');
948 pr_err("illegal format of physical device %s\n", phy);
953 err = kstrtoull(lunp, 10, &unpacked_lun);
955 pr_err("lun number not valid: %s\n", lunp);
959 mutex_lock(&scsiback_mutex);
960 list_for_each_entry(tpg_entry, &scsiback_list, tv_tpg_list) {
961 if (!strcmp(phy, tpg_entry->tport->tport_name) ||
962 !strcmp(phy, tpg_entry->param_alias)) {
963 mutex_lock(&tpg_entry->se_tpg.tpg_lun_mutex);
964 hlist_for_each_entry(se_lun, &tpg_entry->se_tpg.tpg_lun_hlist, link) {
965 if (se_lun->unpacked_lun == unpacked_lun) {
966 if (!tpg_entry->tpg_nexus)
967 error = "nexus undefined";
973 mutex_unlock(&tpg_entry->se_tpg.tpg_lun_mutex);
978 mutex_lock(&tpg->tv_tpg_mutex);
979 tpg->tv_tpg_fe_count++;
980 mutex_unlock(&tpg->tv_tpg_mutex);
982 mutex_unlock(&scsiback_mutex);
985 pr_err("%s:%llu %s\n", phy, unpacked_lun, error);
989 new = kmalloc(sizeof(struct v2p_entry), GFP_KERNEL);
995 spin_lock_irqsave(&info->v2p_lock, flags);
997 /* Check double assignment to identical virtual ID */
998 if (scsiback_chk_translation_entry(info, v)) {
999 pr_warn("Virtual ID is already used. Assignment was not performed.\n");
1004 /* Create a new translation entry and add to the list */
1005 kref_init(&new->kref);
1008 new->lun = unpacked_lun;
1009 list_add_tail(&new->l, &info->v2p_entry_lists);
1012 spin_unlock_irqrestore(&info->v2p_lock, flags);
1016 mutex_lock(&tpg->tv_tpg_mutex);
1017 tpg->tv_tpg_fe_count--;
1018 mutex_unlock(&tpg->tv_tpg_mutex);
1025 static void __scsiback_del_translation_entry(struct v2p_entry *entry)
1027 list_del(&entry->l);
1028 kref_put(&entry->kref, scsiback_free_translation_entry);
1032 Delete the translation entry specified
1034 static int scsiback_del_translation_entry(struct vscsibk_info *info,
1035 struct ids_tuple *v)
1037 struct v2p_entry *entry;
1038 unsigned long flags;
1041 spin_lock_irqsave(&info->v2p_lock, flags);
1042 /* Find out the translation entry specified */
1043 entry = scsiback_chk_translation_entry(info, v);
1045 __scsiback_del_translation_entry(entry);
1049 spin_unlock_irqrestore(&info->v2p_lock, flags);
1053 static void scsiback_do_add_lun(struct vscsibk_info *info, const char *state,
1054 char *phy, struct ids_tuple *vir, int try)
1056 struct v2p_entry *entry;
1057 unsigned long flags;
1061 spin_lock_irqsave(&info->v2p_lock, flags);
1062 entry = scsiback_chk_translation_entry(info, vir);
1063 spin_unlock_irqrestore(&info->v2p_lock, flags);
1067 if (!scsiback_add_translation_entry(info, phy, vir)) {
1068 if (xenbus_printf(XBT_NIL, info->dev->nodename, state,
1069 "%d", XenbusStateInitialised)) {
1070 pr_err("xenbus_printf error %s\n", state);
1071 scsiback_del_translation_entry(info, vir);
1074 err = xenbus_printf(XBT_NIL, info->dev->nodename, state,
1075 "%d", XenbusStateClosed);
1077 xenbus_dev_error(info->dev, err,
1078 "%s: writing %s", __func__, state);
1082 static void scsiback_do_del_lun(struct vscsibk_info *info, const char *state,
1083 struct ids_tuple *vir)
1085 if (!scsiback_del_translation_entry(info, vir)) {
1086 if (xenbus_printf(XBT_NIL, info->dev->nodename, state,
1087 "%d", XenbusStateClosed))
1088 pr_err("xenbus_printf error %s\n", state);
1092 #define VSCSIBACK_OP_ADD_OR_DEL_LUN 1
1093 #define VSCSIBACK_OP_UPDATEDEV_STATE 2
1095 static void scsiback_do_1lun_hotplug(struct vscsibk_info *info, int op,
1099 struct ids_tuple vir;
1102 char phy[VSCSI_NAMELEN];
1105 struct xenbus_device *dev = info->dev;
1108 snprintf(state, sizeof(state), "vscsi-devs/%s/state", ent);
1109 err = xenbus_scanf(XBT_NIL, dev->nodename, state, "%u", &device_state);
1110 if (XENBUS_EXIST_ERR(err))
1113 /* physical SCSI device */
1114 snprintf(str, sizeof(str), "vscsi-devs/%s/p-dev", ent);
1115 val = xenbus_read(XBT_NIL, dev->nodename, str, NULL);
1117 err = xenbus_printf(XBT_NIL, dev->nodename, state,
1118 "%d", XenbusStateClosed);
1120 xenbus_dev_error(info->dev, err,
1121 "%s: writing %s", __func__, state);
1124 strscpy(phy, val, VSCSI_NAMELEN);
1127 /* virtual SCSI device */
1128 snprintf(str, sizeof(str), "vscsi-devs/%s/v-dev", ent);
1129 err = xenbus_scanf(XBT_NIL, dev->nodename, str, "%u:%u:%u:%u",
1130 &vir.hst, &vir.chn, &vir.tgt, &vir.lun);
1131 if (XENBUS_EXIST_ERR(err)) {
1132 err = xenbus_printf(XBT_NIL, dev->nodename, state,
1133 "%d", XenbusStateClosed);
1135 xenbus_dev_error(info->dev, err,
1136 "%s: writing %s", __func__, state);
1141 case VSCSIBACK_OP_ADD_OR_DEL_LUN:
1142 switch (device_state) {
1143 case XenbusStateInitialising:
1144 scsiback_do_add_lun(info, state, phy, &vir, 0);
1146 case XenbusStateConnected:
1147 scsiback_do_add_lun(info, state, phy, &vir, 1);
1149 case XenbusStateClosing:
1150 scsiback_do_del_lun(info, state, &vir);
1157 case VSCSIBACK_OP_UPDATEDEV_STATE:
1158 if (device_state == XenbusStateInitialised) {
1159 /* modify vscsi-devs/dev-x/state */
1160 if (xenbus_printf(XBT_NIL, dev->nodename, state,
1161 "%d", XenbusStateConnected)) {
1162 pr_err("xenbus_printf error %s\n", str);
1163 scsiback_del_translation_entry(info, &vir);
1164 xenbus_printf(XBT_NIL, dev->nodename, state,
1165 "%d", XenbusStateClosed);
1169 /* When it is necessary, processing is added here. */
1175 static void scsiback_do_lun_hotplug(struct vscsibk_info *info, int op)
1179 unsigned int ndir = 0;
1181 dir = xenbus_directory(XBT_NIL, info->dev->nodename, "vscsi-devs",
1186 for (i = 0; i < ndir; i++)
1187 scsiback_do_1lun_hotplug(info, op, dir[i]);
1192 static void scsiback_frontend_changed(struct xenbus_device *dev,
1193 enum xenbus_state frontend_state)
1195 struct vscsibk_info *info = dev_get_drvdata(&dev->dev);
1197 switch (frontend_state) {
1198 case XenbusStateInitialising:
1201 case XenbusStateInitialised:
1202 if (scsiback_map(info))
1205 scsiback_do_lun_hotplug(info, VSCSIBACK_OP_ADD_OR_DEL_LUN);
1206 xenbus_switch_state(dev, XenbusStateConnected);
1209 case XenbusStateConnected:
1210 scsiback_do_lun_hotplug(info, VSCSIBACK_OP_UPDATEDEV_STATE);
1212 if (dev->state == XenbusStateConnected)
1215 xenbus_switch_state(dev, XenbusStateConnected);
1218 case XenbusStateClosing:
1220 scsiback_disconnect(info);
1222 xenbus_switch_state(dev, XenbusStateClosing);
1225 case XenbusStateClosed:
1226 xenbus_switch_state(dev, XenbusStateClosed);
1227 if (xenbus_dev_is_online(dev))
1229 fallthrough; /* if not online */
1230 case XenbusStateUnknown:
1231 device_unregister(&dev->dev);
1234 case XenbusStateReconfiguring:
1235 scsiback_do_lun_hotplug(info, VSCSIBACK_OP_ADD_OR_DEL_LUN);
1236 xenbus_switch_state(dev, XenbusStateReconfigured);
1241 xenbus_dev_fatal(dev, -EINVAL, "saw state %d at frontend",
1248 Release the translation entry specfied
1250 static void scsiback_release_translation_entry(struct vscsibk_info *info)
1252 struct v2p_entry *entry, *tmp;
1253 struct list_head *head = &(info->v2p_entry_lists);
1254 unsigned long flags;
1256 spin_lock_irqsave(&info->v2p_lock, flags);
1258 list_for_each_entry_safe(entry, tmp, head, l)
1259 __scsiback_del_translation_entry(entry);
1261 spin_unlock_irqrestore(&info->v2p_lock, flags);
1264 static int scsiback_remove(struct xenbus_device *dev)
1266 struct vscsibk_info *info = dev_get_drvdata(&dev->dev);
1269 scsiback_disconnect(info);
1271 scsiback_release_translation_entry(info);
1273 gnttab_page_cache_shrink(&info->free_pages, 0);
1275 dev_set_drvdata(&dev->dev, NULL);
1280 static int scsiback_probe(struct xenbus_device *dev,
1281 const struct xenbus_device_id *id)
1285 struct vscsibk_info *info = kzalloc(sizeof(struct vscsibk_info),
1288 pr_debug("%s %p %d\n", __func__, dev, dev->otherend_id);
1291 xenbus_dev_fatal(dev, -ENOMEM, "allocating backend structure");
1295 dev_set_drvdata(&dev->dev, info);
1297 info->domid = dev->otherend_id;
1298 spin_lock_init(&info->ring_lock);
1299 atomic_set(&info->nr_unreplied_reqs, 0);
1300 init_waitqueue_head(&info->waiting_to_free);
1303 INIT_LIST_HEAD(&info->v2p_entry_lists);
1304 spin_lock_init(&info->v2p_lock);
1305 gnttab_page_cache_init(&info->free_pages);
1307 err = xenbus_printf(XBT_NIL, dev->nodename, "feature-sg-grant", "%u",
1310 xenbus_dev_error(dev, err, "writing feature-sg-grant");
1312 err = xenbus_switch_state(dev, XenbusStateInitWait);
1319 pr_warn("%s failed\n", __func__);
1320 scsiback_remove(dev);
1325 static char *scsiback_dump_proto_id(struct scsiback_tport *tport)
1327 switch (tport->tport_proto_id) {
1328 case SCSI_PROTOCOL_SAS:
1330 case SCSI_PROTOCOL_FCP:
1332 case SCSI_PROTOCOL_ISCSI:
1341 static char *scsiback_get_fabric_wwn(struct se_portal_group *se_tpg)
1343 struct scsiback_tpg *tpg = container_of(se_tpg,
1344 struct scsiback_tpg, se_tpg);
1345 struct scsiback_tport *tport = tpg->tport;
1347 return &tport->tport_name[0];
1350 static u16 scsiback_get_tag(struct se_portal_group *se_tpg)
1352 struct scsiback_tpg *tpg = container_of(se_tpg,
1353 struct scsiback_tpg, se_tpg);
1354 return tpg->tport_tpgt;
1357 static struct se_wwn *
1358 scsiback_make_tport(struct target_fabric_configfs *tf,
1359 struct config_group *group,
1362 struct scsiback_tport *tport;
1367 tport = kzalloc(sizeof(struct scsiback_tport), GFP_KERNEL);
1369 return ERR_PTR(-ENOMEM);
1371 tport->tport_wwpn = wwpn;
1373 * Determine the emulated Protocol Identifier and Target Port Name
1374 * based on the incoming configfs directory name.
1376 ptr = strstr(name, "naa.");
1378 tport->tport_proto_id = SCSI_PROTOCOL_SAS;
1381 ptr = strstr(name, "fc.");
1383 tport->tport_proto_id = SCSI_PROTOCOL_FCP;
1384 off = 3; /* Skip over "fc." */
1387 ptr = strstr(name, "iqn.");
1389 tport->tport_proto_id = SCSI_PROTOCOL_ISCSI;
1393 pr_err("Unable to locate prefix for emulated Target Port: %s\n", name);
1395 return ERR_PTR(-EINVAL);
1398 if (strlen(name) >= VSCSI_NAMELEN) {
1399 pr_err("Emulated %s Address: %s, exceeds max: %d\n", name,
1400 scsiback_dump_proto_id(tport), VSCSI_NAMELEN);
1402 return ERR_PTR(-EINVAL);
1404 snprintf(&tport->tport_name[0], VSCSI_NAMELEN, "%s", &name[off]);
1406 pr_debug("Allocated emulated Target %s Address: %s\n",
1407 scsiback_dump_proto_id(tport), name);
1409 return &tport->tport_wwn;
1412 static void scsiback_drop_tport(struct se_wwn *wwn)
1414 struct scsiback_tport *tport = container_of(wwn,
1415 struct scsiback_tport, tport_wwn);
1417 pr_debug("Deallocating emulated Target %s Address: %s\n",
1418 scsiback_dump_proto_id(tport), tport->tport_name);
1423 static u32 scsiback_tpg_get_inst_index(struct se_portal_group *se_tpg)
1428 static int scsiback_check_stop_free(struct se_cmd *se_cmd)
1430 return transport_generic_free_cmd(se_cmd, 0);
1433 static void scsiback_release_cmd(struct se_cmd *se_cmd)
1435 target_free_tag(se_cmd->se_sess, se_cmd);
1438 static u32 scsiback_sess_get_index(struct se_session *se_sess)
1443 static int scsiback_write_pending(struct se_cmd *se_cmd)
1445 /* Go ahead and process the write immediately */
1446 target_execute_cmd(se_cmd);
1451 static void scsiback_set_default_node_attrs(struct se_node_acl *nacl)
1455 static int scsiback_get_cmd_state(struct se_cmd *se_cmd)
1460 static int scsiback_queue_data_in(struct se_cmd *se_cmd)
1462 struct vscsibk_pend *pending_req = container_of(se_cmd,
1463 struct vscsibk_pend, se_cmd);
1465 pending_req->result = SAM_STAT_GOOD;
1466 scsiback_cmd_done(pending_req);
1470 static int scsiback_queue_status(struct se_cmd *se_cmd)
1472 struct vscsibk_pend *pending_req = container_of(se_cmd,
1473 struct vscsibk_pend, se_cmd);
1475 if (se_cmd->sense_buffer &&
1476 ((se_cmd->se_cmd_flags & SCF_TRANSPORT_TASK_SENSE) ||
1477 (se_cmd->se_cmd_flags & SCF_EMULATED_TASK_SENSE)))
1478 pending_req->result = SAM_STAT_CHECK_CONDITION;
1480 pending_req->result = se_cmd->scsi_status;
1482 scsiback_cmd_done(pending_req);
1486 static void scsiback_queue_tm_rsp(struct se_cmd *se_cmd)
1488 struct vscsibk_pend *pending_req = container_of(se_cmd,
1489 struct vscsibk_pend, se_cmd);
1491 complete(&pending_req->tmr_done);
1494 static void scsiback_aborted_task(struct se_cmd *se_cmd)
1498 static ssize_t scsiback_tpg_param_alias_show(struct config_item *item,
1501 struct se_portal_group *se_tpg = param_to_tpg(item);
1502 struct scsiback_tpg *tpg = container_of(se_tpg, struct scsiback_tpg,
1506 mutex_lock(&tpg->tv_tpg_mutex);
1507 rb = snprintf(page, PAGE_SIZE, "%s\n", tpg->param_alias);
1508 mutex_unlock(&tpg->tv_tpg_mutex);
1513 static ssize_t scsiback_tpg_param_alias_store(struct config_item *item,
1514 const char *page, size_t count)
1516 struct se_portal_group *se_tpg = param_to_tpg(item);
1517 struct scsiback_tpg *tpg = container_of(se_tpg, struct scsiback_tpg,
1521 if (strlen(page) >= VSCSI_NAMELEN) {
1522 pr_err("param alias: %s, exceeds max: %d\n", page,
1527 mutex_lock(&tpg->tv_tpg_mutex);
1528 len = snprintf(tpg->param_alias, VSCSI_NAMELEN, "%s", page);
1529 if (tpg->param_alias[len - 1] == '\n')
1530 tpg->param_alias[len - 1] = '\0';
1531 mutex_unlock(&tpg->tv_tpg_mutex);
1536 CONFIGFS_ATTR(scsiback_tpg_param_, alias);
1538 static struct configfs_attribute *scsiback_param_attrs[] = {
1539 &scsiback_tpg_param_attr_alias,
1543 static int scsiback_alloc_sess_cb(struct se_portal_group *se_tpg,
1544 struct se_session *se_sess, void *p)
1546 struct scsiback_tpg *tpg = container_of(se_tpg,
1547 struct scsiback_tpg, se_tpg);
1553 static int scsiback_make_nexus(struct scsiback_tpg *tpg,
1556 struct scsiback_nexus *tv_nexus;
1559 mutex_lock(&tpg->tv_tpg_mutex);
1560 if (tpg->tpg_nexus) {
1561 pr_debug("tpg->tpg_nexus already exists\n");
1566 tv_nexus = kzalloc(sizeof(struct scsiback_nexus), GFP_KERNEL);
1572 tv_nexus->tvn_se_sess = target_setup_session(&tpg->se_tpg,
1573 VSCSI_DEFAULT_SESSION_TAGS,
1574 sizeof(struct vscsibk_pend),
1575 TARGET_PROT_NORMAL, name,
1576 tv_nexus, scsiback_alloc_sess_cb);
1577 if (IS_ERR(tv_nexus->tvn_se_sess)) {
1584 mutex_unlock(&tpg->tv_tpg_mutex);
1588 static int scsiback_drop_nexus(struct scsiback_tpg *tpg)
1590 struct se_session *se_sess;
1591 struct scsiback_nexus *tv_nexus;
1593 mutex_lock(&tpg->tv_tpg_mutex);
1594 tv_nexus = tpg->tpg_nexus;
1596 mutex_unlock(&tpg->tv_tpg_mutex);
1600 se_sess = tv_nexus->tvn_se_sess;
1602 mutex_unlock(&tpg->tv_tpg_mutex);
1606 if (tpg->tv_tpg_port_count != 0) {
1607 mutex_unlock(&tpg->tv_tpg_mutex);
1608 pr_err("Unable to remove xen-pvscsi I_T Nexus with active TPG port count: %d\n",
1609 tpg->tv_tpg_port_count);
1613 if (tpg->tv_tpg_fe_count != 0) {
1614 mutex_unlock(&tpg->tv_tpg_mutex);
1615 pr_err("Unable to remove xen-pvscsi I_T Nexus with active TPG frontend count: %d\n",
1616 tpg->tv_tpg_fe_count);
1620 pr_debug("Removing I_T Nexus to emulated %s Initiator Port: %s\n",
1621 scsiback_dump_proto_id(tpg->tport),
1622 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1625 * Release the SCSI I_T Nexus to the emulated xen-pvscsi Target Port
1627 target_remove_session(se_sess);
1628 tpg->tpg_nexus = NULL;
1629 mutex_unlock(&tpg->tv_tpg_mutex);
1635 static ssize_t scsiback_tpg_nexus_show(struct config_item *item, char *page)
1637 struct se_portal_group *se_tpg = to_tpg(item);
1638 struct scsiback_tpg *tpg = container_of(se_tpg,
1639 struct scsiback_tpg, se_tpg);
1640 struct scsiback_nexus *tv_nexus;
1643 mutex_lock(&tpg->tv_tpg_mutex);
1644 tv_nexus = tpg->tpg_nexus;
1646 mutex_unlock(&tpg->tv_tpg_mutex);
1649 ret = snprintf(page, PAGE_SIZE, "%s\n",
1650 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1651 mutex_unlock(&tpg->tv_tpg_mutex);
1656 static ssize_t scsiback_tpg_nexus_store(struct config_item *item,
1657 const char *page, size_t count)
1659 struct se_portal_group *se_tpg = to_tpg(item);
1660 struct scsiback_tpg *tpg = container_of(se_tpg,
1661 struct scsiback_tpg, se_tpg);
1662 struct scsiback_tport *tport_wwn = tpg->tport;
1663 unsigned char i_port[VSCSI_NAMELEN], *ptr, *port_ptr;
1666 * Shutdown the active I_T nexus if 'NULL' is passed.
1668 if (!strncmp(page, "NULL", 4)) {
1669 ret = scsiback_drop_nexus(tpg);
1670 return (!ret) ? count : ret;
1673 * Otherwise make sure the passed virtual Initiator port WWN matches
1674 * the fabric protocol_id set in scsiback_make_tport(), and call
1675 * scsiback_make_nexus().
1677 if (strlen(page) >= VSCSI_NAMELEN) {
1678 pr_err("Emulated NAA Sas Address: %s, exceeds max: %d\n",
1679 page, VSCSI_NAMELEN);
1682 snprintf(&i_port[0], VSCSI_NAMELEN, "%s", page);
1684 ptr = strstr(i_port, "naa.");
1686 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_SAS) {
1687 pr_err("Passed SAS Initiator Port %s does not match target port protoid: %s\n",
1688 i_port, scsiback_dump_proto_id(tport_wwn));
1691 port_ptr = &i_port[0];
1694 ptr = strstr(i_port, "fc.");
1696 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_FCP) {
1697 pr_err("Passed FCP Initiator Port %s does not match target port protoid: %s\n",
1698 i_port, scsiback_dump_proto_id(tport_wwn));
1701 port_ptr = &i_port[3]; /* Skip over "fc." */
1704 ptr = strstr(i_port, "iqn.");
1706 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_ISCSI) {
1707 pr_err("Passed iSCSI Initiator Port %s does not match target port protoid: %s\n",
1708 i_port, scsiback_dump_proto_id(tport_wwn));
1711 port_ptr = &i_port[0];
1714 pr_err("Unable to locate prefix for emulated Initiator Port: %s\n",
1718 * Clear any trailing newline for the NAA WWN
1721 if (i_port[strlen(i_port) - 1] == '\n')
1722 i_port[strlen(i_port) - 1] = '\0';
1724 ret = scsiback_make_nexus(tpg, port_ptr);
1731 CONFIGFS_ATTR(scsiback_tpg_, nexus);
1733 static struct configfs_attribute *scsiback_tpg_attrs[] = {
1734 &scsiback_tpg_attr_nexus,
1739 scsiback_wwn_version_show(struct config_item *item, char *page)
1741 return sprintf(page, "xen-pvscsi fabric module %s on %s/%s on "
1743 VSCSI_VERSION, utsname()->sysname, utsname()->machine);
1746 CONFIGFS_ATTR_RO(scsiback_wwn_, version);
1748 static struct configfs_attribute *scsiback_wwn_attrs[] = {
1749 &scsiback_wwn_attr_version,
1753 static int scsiback_port_link(struct se_portal_group *se_tpg,
1756 struct scsiback_tpg *tpg = container_of(se_tpg,
1757 struct scsiback_tpg, se_tpg);
1759 mutex_lock(&tpg->tv_tpg_mutex);
1760 tpg->tv_tpg_port_count++;
1761 mutex_unlock(&tpg->tv_tpg_mutex);
1766 static void scsiback_port_unlink(struct se_portal_group *se_tpg,
1769 struct scsiback_tpg *tpg = container_of(se_tpg,
1770 struct scsiback_tpg, se_tpg);
1772 mutex_lock(&tpg->tv_tpg_mutex);
1773 tpg->tv_tpg_port_count--;
1774 mutex_unlock(&tpg->tv_tpg_mutex);
1777 static struct se_portal_group *
1778 scsiback_make_tpg(struct se_wwn *wwn, const char *name)
1780 struct scsiback_tport *tport = container_of(wwn,
1781 struct scsiback_tport, tport_wwn);
1783 struct scsiback_tpg *tpg;
1787 if (strstr(name, "tpgt_") != name)
1788 return ERR_PTR(-EINVAL);
1789 ret = kstrtou16(name + 5, 10, &tpgt);
1791 return ERR_PTR(ret);
1793 tpg = kzalloc(sizeof(struct scsiback_tpg), GFP_KERNEL);
1795 return ERR_PTR(-ENOMEM);
1797 mutex_init(&tpg->tv_tpg_mutex);
1798 INIT_LIST_HEAD(&tpg->tv_tpg_list);
1799 INIT_LIST_HEAD(&tpg->info_list);
1801 tpg->tport_tpgt = tpgt;
1803 ret = core_tpg_register(wwn, &tpg->se_tpg, tport->tport_proto_id);
1808 mutex_lock(&scsiback_mutex);
1809 list_add_tail(&tpg->tv_tpg_list, &scsiback_list);
1810 mutex_unlock(&scsiback_mutex);
1812 return &tpg->se_tpg;
1815 static void scsiback_drop_tpg(struct se_portal_group *se_tpg)
1817 struct scsiback_tpg *tpg = container_of(se_tpg,
1818 struct scsiback_tpg, se_tpg);
1820 mutex_lock(&scsiback_mutex);
1821 list_del(&tpg->tv_tpg_list);
1822 mutex_unlock(&scsiback_mutex);
1824 * Release the virtual I_T Nexus for this xen-pvscsi TPG
1826 scsiback_drop_nexus(tpg);
1828 * Deregister the se_tpg from TCM.
1830 core_tpg_deregister(se_tpg);
1834 static int scsiback_check_true(struct se_portal_group *se_tpg)
1839 static int scsiback_check_false(struct se_portal_group *se_tpg)
1844 static const struct target_core_fabric_ops scsiback_ops = {
1845 .module = THIS_MODULE,
1846 .fabric_name = "xen-pvscsi",
1847 .tpg_get_wwn = scsiback_get_fabric_wwn,
1848 .tpg_get_tag = scsiback_get_tag,
1849 .tpg_check_demo_mode = scsiback_check_true,
1850 .tpg_check_demo_mode_cache = scsiback_check_true,
1851 .tpg_check_demo_mode_write_protect = scsiback_check_false,
1852 .tpg_check_prod_mode_write_protect = scsiback_check_false,
1853 .tpg_get_inst_index = scsiback_tpg_get_inst_index,
1854 .check_stop_free = scsiback_check_stop_free,
1855 .release_cmd = scsiback_release_cmd,
1856 .sess_get_index = scsiback_sess_get_index,
1857 .sess_get_initiator_sid = NULL,
1858 .write_pending = scsiback_write_pending,
1859 .set_default_node_attributes = scsiback_set_default_node_attrs,
1860 .get_cmd_state = scsiback_get_cmd_state,
1861 .queue_data_in = scsiback_queue_data_in,
1862 .queue_status = scsiback_queue_status,
1863 .queue_tm_rsp = scsiback_queue_tm_rsp,
1864 .aborted_task = scsiback_aborted_task,
1866 * Setup callers for generic logic in target_core_fabric_configfs.c
1868 .fabric_make_wwn = scsiback_make_tport,
1869 .fabric_drop_wwn = scsiback_drop_tport,
1870 .fabric_make_tpg = scsiback_make_tpg,
1871 .fabric_drop_tpg = scsiback_drop_tpg,
1872 .fabric_post_link = scsiback_port_link,
1873 .fabric_pre_unlink = scsiback_port_unlink,
1875 .tfc_wwn_attrs = scsiback_wwn_attrs,
1876 .tfc_tpg_base_attrs = scsiback_tpg_attrs,
1877 .tfc_tpg_param_attrs = scsiback_param_attrs,
1880 static const struct xenbus_device_id scsiback_ids[] = {
1885 static struct xenbus_driver scsiback_driver = {
1886 .ids = scsiback_ids,
1887 .probe = scsiback_probe,
1888 .remove = scsiback_remove,
1889 .otherend_changed = scsiback_frontend_changed
1892 static int __init scsiback_init(void)
1899 pr_debug("xen-pvscsi: fabric module %s on %s/%s on "UTS_RELEASE"\n",
1900 VSCSI_VERSION, utsname()->sysname, utsname()->machine);
1902 ret = xenbus_register_backend(&scsiback_driver);
1906 ret = target_register_template(&scsiback_ops);
1908 goto out_unregister_xenbus;
1912 out_unregister_xenbus:
1913 xenbus_unregister_driver(&scsiback_driver);
1915 pr_err("%s: error %d\n", __func__, ret);
1919 static void __exit scsiback_exit(void)
1921 target_unregister_template(&scsiback_ops);
1922 xenbus_unregister_driver(&scsiback_driver);
1925 module_init(scsiback_init);
1926 module_exit(scsiback_exit);
1928 MODULE_DESCRIPTION("Xen SCSI backend driver");
1929 MODULE_LICENSE("Dual BSD/GPL");
1930 MODULE_ALIAS("xen-backend:vscsi");