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
38 #include <linux/module.h>
39 #include <linux/utsname.h>
40 #include <linux/interrupt.h>
41 #include <linux/slab.h>
42 #include <linux/wait.h>
43 #include <linux/sched.h>
44 #include <linux/list.h>
45 #include <linux/gfp.h>
46 #include <linux/delay.h>
47 #include <linux/spinlock.h>
48 #include <linux/configfs.h>
50 #include <generated/utsrelease.h>
52 #include <scsi/scsi_host.h> /* SG_ALL */
54 #include <target/target_core_base.h>
55 #include <target/target_core_fabric.h>
57 #include <asm/hypervisor.h>
60 #include <xen/balloon.h>
61 #include <xen/events.h>
62 #include <xen/xenbus.h>
63 #include <xen/grant_table.h>
66 #include <xen/interface/grant_table.h>
67 #include <xen/interface/io/vscsiif.h>
69 #define VSCSI_VERSION "v0.1"
70 #define VSCSI_NAMELEN 32
73 unsigned int hst; /* host */
74 unsigned int chn; /* channel */
75 unsigned int tgt; /* target */
76 unsigned int lun; /* LUN */
80 struct ids_tuple v; /* translate from */
81 struct scsiback_tpg *tpg; /* translate to */
88 struct xenbus_device *dev;
93 struct vscsiif_back_ring ring;
96 atomic_t nr_unreplied_reqs;
99 struct list_head v2p_entry_lists;
101 wait_queue_head_t waiting_to_free;
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;
138 struct scsiback_tmr {
139 atomic_t tmr_complete;
140 wait_queue_head_t tmr_wait;
143 struct scsiback_nexus {
144 /* Pointer to TCM session for I_T Nexus */
145 struct se_session *tvn_se_sess;
148 struct scsiback_tport {
149 /* SCSI protocol the tport is providing */
151 /* Binary World Wide unique Port Name for pvscsi Target port */
153 /* ASCII formatted WWPN for pvscsi Target port */
154 char tport_name[VSCSI_NAMELEN];
155 /* Returned by scsiback_make_tport() */
156 struct se_wwn tport_wwn;
159 struct scsiback_tpg {
160 /* scsiback port target portal group tag for TCM */
162 /* track number of TPG Port/Lun Links wrt explicit I_T Nexus shutdown */
163 int tv_tpg_port_count;
164 /* xen-pvscsi references to tpg_nexus, protected by tv_tpg_mutex */
166 /* list for scsiback_list */
167 struct list_head tv_tpg_list;
168 /* Used to protect access for tpg_nexus */
169 struct mutex tv_tpg_mutex;
170 /* Pointer to the TCM pvscsi I_T Nexus for this TPG endpoint */
171 struct scsiback_nexus *tpg_nexus;
172 /* Pointer back to scsiback_tport */
173 struct scsiback_tport *tport;
174 /* Returned by scsiback_make_tpg() */
175 struct se_portal_group se_tpg;
176 /* alias used in xenstore */
177 char param_alias[VSCSI_NAMELEN];
178 /* list of info structures related to this target portal group */
179 struct list_head info_list;
182 #define SCSIBACK_INVALID_HANDLE (~0)
184 static bool log_print_stat;
185 module_param(log_print_stat, bool, 0644);
187 static int scsiback_max_buffer_pages = 1024;
188 module_param_named(max_buffer_pages, scsiback_max_buffer_pages, int, 0644);
189 MODULE_PARM_DESC(max_buffer_pages,
190 "Maximum number of free pages to keep in backend buffer");
192 static struct kmem_cache *scsiback_cachep;
193 static DEFINE_SPINLOCK(free_pages_lock);
194 static int free_pages_num;
195 static LIST_HEAD(scsiback_free_pages);
197 /* Global spinlock to protect scsiback TPG list */
198 static DEFINE_MUTEX(scsiback_mutex);
199 static LIST_HEAD(scsiback_list);
201 static void scsiback_get(struct vscsibk_info *info)
203 atomic_inc(&info->nr_unreplied_reqs);
206 static void scsiback_put(struct vscsibk_info *info)
208 if (atomic_dec_and_test(&info->nr_unreplied_reqs))
209 wake_up(&info->waiting_to_free);
212 static void put_free_pages(struct page **page, int num)
215 int i = free_pages_num + num, n = num;
219 if (i > scsiback_max_buffer_pages) {
220 n = min(num, i - scsiback_max_buffer_pages);
221 gnttab_free_pages(n, page + num - n);
224 spin_lock_irqsave(&free_pages_lock, flags);
225 for (i = 0; i < n; i++)
226 list_add(&page[i]->lru, &scsiback_free_pages);
228 spin_unlock_irqrestore(&free_pages_lock, flags);
231 static int get_free_page(struct page **page)
235 spin_lock_irqsave(&free_pages_lock, flags);
236 if (list_empty(&scsiback_free_pages)) {
237 spin_unlock_irqrestore(&free_pages_lock, flags);
238 return gnttab_alloc_pages(1, page);
240 page[0] = list_first_entry(&scsiback_free_pages, struct page, lru);
241 list_del(&page[0]->lru);
243 spin_unlock_irqrestore(&free_pages_lock, flags);
247 static unsigned long vaddr_page(struct page *page)
249 unsigned long pfn = page_to_pfn(page);
251 return (unsigned long)pfn_to_kaddr(pfn);
254 static unsigned long vaddr(struct vscsibk_pend *req, int seg)
256 return vaddr_page(req->pages[seg]);
259 static void scsiback_print_status(char *sense_buffer, int errors,
260 struct vscsibk_pend *pending_req)
262 struct scsiback_tpg *tpg = pending_req->v2p->tpg;
264 pr_err("[%s:%d] cmnd[0]=%02x -> st=%02x msg=%02x host=%02x drv=%02x\n",
265 tpg->tport->tport_name, pending_req->v2p->lun,
266 pending_req->cmnd[0], status_byte(errors), msg_byte(errors),
267 host_byte(errors), driver_byte(errors));
270 static void scsiback_fast_flush_area(struct vscsibk_pend *req)
272 struct gnttab_unmap_grant_ref unmap[VSCSI_GRANT_BATCH];
273 struct page *pages[VSCSI_GRANT_BATCH];
274 unsigned int i, invcount = 0;
275 grant_handle_t handle;
285 for (i = 0; i < req->n_grants; i++) {
286 handle = req->grant_handles[i];
287 if (handle == SCSIBACK_INVALID_HANDLE)
289 gnttab_set_unmap_op(&unmap[invcount], vaddr(req, i),
290 GNTMAP_host_map, handle);
291 req->grant_handles[i] = SCSIBACK_INVALID_HANDLE;
292 pages[invcount] = req->pages[i];
293 put_page(pages[invcount]);
295 if (invcount < VSCSI_GRANT_BATCH)
297 err = gnttab_unmap_refs(unmap, NULL, pages, invcount);
303 err = gnttab_unmap_refs(unmap, NULL, pages, invcount);
307 put_free_pages(req->pages, req->n_grants);
311 static void scsiback_free_translation_entry(struct kref *kref)
313 struct v2p_entry *entry = container_of(kref, struct v2p_entry, kref);
314 struct scsiback_tpg *tpg = entry->tpg;
316 mutex_lock(&tpg->tv_tpg_mutex);
317 tpg->tv_tpg_fe_count--;
318 mutex_unlock(&tpg->tv_tpg_mutex);
323 static void scsiback_do_resp_with_sense(char *sense_buffer, int32_t result,
324 uint32_t resid, struct vscsibk_pend *pending_req)
326 struct vscsiif_response *ring_res;
327 struct vscsibk_info *info = pending_req->info;
329 struct scsi_sense_hdr sshdr;
333 spin_lock_irqsave(&info->ring_lock, flags);
335 ring_res = RING_GET_RESPONSE(&info->ring, info->ring.rsp_prod_pvt);
336 info->ring.rsp_prod_pvt++;
338 ring_res->rslt = result;
339 ring_res->rqid = pending_req->rqid;
341 if (sense_buffer != NULL &&
342 scsi_normalize_sense(sense_buffer, VSCSIIF_SENSE_BUFFERSIZE,
344 len = min_t(unsigned, 8 + sense_buffer[7],
345 VSCSIIF_SENSE_BUFFERSIZE);
346 memcpy(ring_res->sense_buffer, sense_buffer, len);
347 ring_res->sense_len = len;
349 ring_res->sense_len = 0;
352 ring_res->residual_len = resid;
354 RING_PUSH_RESPONSES_AND_CHECK_NOTIFY(&info->ring, notify);
355 spin_unlock_irqrestore(&info->ring_lock, flags);
358 notify_remote_via_irq(info->irq);
360 if (pending_req->v2p)
361 kref_put(&pending_req->v2p->kref,
362 scsiback_free_translation_entry);
365 static void scsiback_cmd_done(struct vscsibk_pend *pending_req)
367 struct vscsibk_info *info = pending_req->info;
368 unsigned char *sense_buffer;
372 sense_buffer = pending_req->sense_buffer;
373 resid = pending_req->se_cmd.residual_count;
374 errors = pending_req->result;
376 if (errors && log_print_stat)
377 scsiback_print_status(sense_buffer, errors, pending_req);
379 scsiback_fast_flush_area(pending_req);
380 scsiback_do_resp_with_sense(sense_buffer, errors, resid, pending_req);
384 static void scsiback_cmd_exec(struct vscsibk_pend *pending_req)
386 struct se_cmd *se_cmd = &pending_req->se_cmd;
387 struct se_session *sess = pending_req->v2p->tpg->tpg_nexus->tvn_se_sess;
390 memset(pending_req->sense_buffer, 0, VSCSIIF_SENSE_BUFFERSIZE);
392 memset(se_cmd, 0, sizeof(*se_cmd));
394 scsiback_get(pending_req->info);
395 se_cmd->tag = pending_req->rqid;
396 rc = target_submit_cmd_map_sgls(se_cmd, sess, pending_req->cmnd,
397 pending_req->sense_buffer, pending_req->v2p->lun,
398 pending_req->data_len, 0,
399 pending_req->sc_data_direction, 0,
400 pending_req->sgl, pending_req->n_sg,
403 transport_send_check_condition_and_sense(se_cmd,
404 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE, 0);
405 transport_generic_free_cmd(se_cmd, 0);
409 static int scsiback_gnttab_data_map_batch(struct gnttab_map_grant_ref *map,
410 struct page **pg, grant_handle_t *grant, int cnt)
417 err = gnttab_map_refs(map, NULL, pg, cnt);
418 for (i = 0; i < cnt; i++) {
419 if (unlikely(map[i].status != GNTST_okay)) {
420 pr_err("invalid buffer -- could not remap it\n");
421 map[i].handle = SCSIBACK_INVALID_HANDLE;
427 grant[i] = map[i].handle;
432 static int scsiback_gnttab_data_map_list(struct vscsibk_pend *pending_req,
433 struct scsiif_request_segment *seg, struct page **pg,
434 grant_handle_t *grant, int cnt, u32 flags)
436 int mapcount = 0, i, err = 0;
437 struct gnttab_map_grant_ref map[VSCSI_GRANT_BATCH];
438 struct vscsibk_info *info = pending_req->info;
440 for (i = 0; i < cnt; i++) {
441 if (get_free_page(pg + mapcount)) {
442 put_free_pages(pg, mapcount);
443 pr_err("no grant page\n");
446 gnttab_set_map_op(&map[mapcount], vaddr_page(pg[mapcount]),
447 flags, seg[i].gref, info->domid);
449 if (mapcount < VSCSI_GRANT_BATCH)
451 err = scsiback_gnttab_data_map_batch(map, pg, grant, mapcount);
454 pending_req->n_grants += mapcount;
459 err = scsiback_gnttab_data_map_batch(map, pg, grant, mapcount);
460 pending_req->n_grants += mapcount;
464 static int scsiback_gnttab_data_map(struct vscsiif_request *ring_req,
465 struct vscsibk_pend *pending_req)
468 int i, err, n_segs, i_seg = 0;
470 struct scsiif_request_segment *seg;
471 unsigned long end_seg = 0;
472 unsigned int nr_segments = (unsigned int)ring_req->nr_segments;
473 unsigned int nr_sgl = 0;
474 struct scatterlist *sg;
475 grant_handle_t *grant;
477 pending_req->n_sg = 0;
478 pending_req->n_grants = 0;
479 pending_req->data_len = 0;
481 nr_segments &= ~VSCSIIF_SG_GRANT;
485 if (nr_segments > VSCSIIF_SG_TABLESIZE) {
486 pr_debug("invalid parameter nr_seg = %d\n",
487 ring_req->nr_segments);
491 if (ring_req->nr_segments & VSCSIIF_SG_GRANT) {
492 err = scsiback_gnttab_data_map_list(pending_req, ring_req->seg,
493 pending_req->pages, pending_req->grant_handles,
494 nr_segments, GNTMAP_host_map | GNTMAP_readonly);
497 nr_sgl = nr_segments;
499 for (i = 0; i < nr_sgl; i++) {
500 n_segs = ring_req->seg[i].length /
501 sizeof(struct scsiif_request_segment);
502 if ((unsigned)ring_req->seg[i].offset +
503 (unsigned)ring_req->seg[i].length > PAGE_SIZE ||
504 n_segs * sizeof(struct scsiif_request_segment) !=
505 ring_req->seg[i].length)
507 nr_segments += n_segs;
509 if (nr_segments > SG_ALL) {
510 pr_debug("invalid nr_seg = %d\n", nr_segments);
515 /* free of (sgl) in fast_flush_area() */
516 pending_req->sgl = kmalloc_array(nr_segments,
517 sizeof(struct scatterlist), GFP_KERNEL);
518 if (!pending_req->sgl)
521 sg_init_table(pending_req->sgl, nr_segments);
522 pending_req->n_sg = nr_segments;
524 flags = GNTMAP_host_map;
525 if (pending_req->sc_data_direction == DMA_TO_DEVICE)
526 flags |= GNTMAP_readonly;
528 pg = pending_req->pages + nr_sgl;
529 grant = pending_req->grant_handles + nr_sgl;
532 err = scsiback_gnttab_data_map_list(pending_req, seg,
533 pg, grant, nr_segments, flags);
537 for (i = 0; i < nr_sgl; i++) {
538 seg = (struct scsiif_request_segment *)(
539 vaddr(pending_req, i) + ring_req->seg[i].offset);
540 n_segs = ring_req->seg[i].length /
541 sizeof(struct scsiif_request_segment);
542 err = scsiback_gnttab_data_map_list(pending_req, seg,
543 pg, grant, n_segs, flags);
549 end_seg = vaddr(pending_req, 0) + ring_req->seg[0].offset;
550 seg = (struct scsiif_request_segment *)end_seg;
551 end_seg += ring_req->seg[0].length;
552 pg = pending_req->pages + nr_sgl;
555 for_each_sg(pending_req->sgl, sg, nr_segments, i) {
556 sg_set_page(sg, pg[i], seg->length, seg->offset);
557 pending_req->data_len += seg->length;
559 if (nr_sgl && (unsigned long)seg >= end_seg) {
561 end_seg = vaddr(pending_req, i_seg) +
562 ring_req->seg[i_seg].offset;
563 seg = (struct scsiif_request_segment *)end_seg;
564 end_seg += ring_req->seg[i_seg].length;
566 if (sg->offset >= PAGE_SIZE ||
567 sg->length > PAGE_SIZE ||
568 sg->offset + sg->length > PAGE_SIZE)
575 static void scsiback_disconnect(struct vscsibk_info *info)
577 wait_event(info->waiting_to_free,
578 atomic_read(&info->nr_unreplied_reqs) == 0);
580 unbind_from_irqhandler(info->irq, info);
582 xenbus_unmap_ring_vfree(info->dev, info->ring.sring);
585 static void scsiback_device_action(struct vscsibk_pend *pending_req,
586 enum tcm_tmreq_table act, int tag)
588 int rc, err = FAILED;
589 struct scsiback_tpg *tpg = pending_req->v2p->tpg;
590 struct se_cmd *se_cmd = &pending_req->se_cmd;
591 struct scsiback_tmr *tmr;
593 tmr = kzalloc(sizeof(struct scsiback_tmr), GFP_KERNEL);
597 init_waitqueue_head(&tmr->tmr_wait);
599 transport_init_se_cmd(se_cmd, tpg->se_tpg.se_tpg_tfo,
600 tpg->tpg_nexus->tvn_se_sess, 0, DMA_NONE, TCM_SIMPLE_TAG,
601 &pending_req->sense_buffer[0]);
603 rc = core_tmr_alloc_req(se_cmd, tmr, act, GFP_KERNEL);
607 se_cmd->se_tmr_req->ref_task_tag = tag;
609 if (transport_lookup_tmr_lun(se_cmd, pending_req->v2p->lun) < 0)
612 transport_generic_handle_tmr(se_cmd);
613 wait_event(tmr->tmr_wait, atomic_read(&tmr->tmr_complete));
615 err = (se_cmd->se_tmr_req->response == TMR_FUNCTION_COMPLETE) ?
620 transport_generic_free_cmd(&pending_req->se_cmd, 1);
624 scsiback_do_resp_with_sense(NULL, err, 0, pending_req);
626 kmem_cache_free(scsiback_cachep, pending_req);
630 Perform virtual to physical translation
632 static struct v2p_entry *scsiback_do_translation(struct vscsibk_info *info,
635 struct v2p_entry *entry;
636 struct list_head *head = &(info->v2p_entry_lists);
639 spin_lock_irqsave(&info->v2p_lock, flags);
640 list_for_each_entry(entry, head, l) {
641 if ((entry->v.chn == v->chn) &&
642 (entry->v.tgt == v->tgt) &&
643 (entry->v.lun == v->lun)) {
644 kref_get(&entry->kref);
651 spin_unlock_irqrestore(&info->v2p_lock, flags);
655 static int prepare_pending_reqs(struct vscsibk_info *info,
656 struct vscsiif_request *ring_req,
657 struct vscsibk_pend *pending_req)
659 struct v2p_entry *v2p;
660 struct ids_tuple vir;
662 pending_req->rqid = ring_req->rqid;
663 pending_req->info = info;
665 vir.chn = ring_req->channel;
666 vir.tgt = ring_req->id;
667 vir.lun = ring_req->lun;
669 v2p = scsiback_do_translation(info, &vir);
671 pending_req->v2p = NULL;
672 pr_debug("the v2p of (chn:%d, tgt:%d, lun:%d) doesn't exist.\n",
673 vir.chn, vir.tgt, vir.lun);
676 pending_req->v2p = v2p;
678 /* request range check from frontend */
679 pending_req->sc_data_direction = ring_req->sc_data_direction;
680 if ((pending_req->sc_data_direction != DMA_BIDIRECTIONAL) &&
681 (pending_req->sc_data_direction != DMA_TO_DEVICE) &&
682 (pending_req->sc_data_direction != DMA_FROM_DEVICE) &&
683 (pending_req->sc_data_direction != DMA_NONE)) {
684 pr_debug("invalid parameter data_dir = %d\n",
685 pending_req->sc_data_direction);
689 pending_req->cmd_len = ring_req->cmd_len;
690 if (pending_req->cmd_len > VSCSIIF_MAX_COMMAND_SIZE) {
691 pr_debug("invalid parameter cmd_len = %d\n",
692 pending_req->cmd_len);
695 memcpy(pending_req->cmnd, ring_req->cmnd, pending_req->cmd_len);
700 static int scsiback_do_cmd_fn(struct vscsibk_info *info,
701 unsigned int *eoi_flags)
703 struct vscsiif_back_ring *ring = &info->ring;
704 struct vscsiif_request ring_req;
705 struct vscsibk_pend *pending_req;
711 rp = ring->sring->req_prod;
712 rmb(); /* guest system is accessing ring, too */
714 if (RING_REQUEST_PROD_OVERFLOW(ring, rp)) {
715 rc = ring->rsp_prod_pvt;
716 pr_warn("Dom%d provided bogus ring requests (%#x - %#x = %u). Halting ring processing\n",
717 info->domid, rp, rc, rp - rc);
722 *eoi_flags &= ~XEN_EOI_FLAG_SPURIOUS;
724 if (RING_REQUEST_CONS_OVERFLOW(ring, rc))
726 pending_req = kmem_cache_alloc(scsiback_cachep, GFP_KERNEL);
730 RING_COPY_REQUEST(ring, rc, &ring_req);
731 ring->req_cons = ++rc;
733 err = prepare_pending_reqs(info, &ring_req, pending_req);
737 result = DID_NO_CONNECT;
740 result = DRIVER_ERROR;
743 scsiback_do_resp_with_sense(NULL, result << 24, 0,
745 kmem_cache_free(scsiback_cachep, pending_req);
749 switch (ring_req.act) {
750 case VSCSIIF_ACT_SCSI_CDB:
751 if (scsiback_gnttab_data_map(&ring_req, pending_req)) {
752 scsiback_fast_flush_area(pending_req);
753 scsiback_do_resp_with_sense(NULL,
754 DRIVER_ERROR << 24, 0, pending_req);
755 kmem_cache_free(scsiback_cachep, pending_req);
757 scsiback_cmd_exec(pending_req);
760 case VSCSIIF_ACT_SCSI_ABORT:
761 scsiback_device_action(pending_req, TMR_ABORT_TASK,
764 case VSCSIIF_ACT_SCSI_RESET:
765 scsiback_device_action(pending_req, TMR_LUN_RESET, 0);
768 pr_err_ratelimited("invalid request\n");
769 scsiback_do_resp_with_sense(NULL, DRIVER_ERROR << 24,
771 kmem_cache_free(scsiback_cachep, pending_req);
775 /* Yield point for this unbounded loop. */
779 RING_FINAL_CHECK_FOR_REQUESTS(&info->ring, more_to_do);
783 static irqreturn_t scsiback_irq_fn(int irq, void *dev_id)
785 struct vscsibk_info *info = dev_id;
787 unsigned int eoi_flags = XEN_EOI_FLAG_SPURIOUS;
789 while ((rc = scsiback_do_cmd_fn(info, &eoi_flags)) > 0)
792 /* In case of a ring error we keep the event channel masked. */
794 xen_irq_lateeoi(irq, eoi_flags);
799 static int scsiback_init_sring(struct vscsibk_info *info, grant_ref_t ring_ref,
800 evtchn_port_t evtchn)
803 struct vscsiif_sring *sring;
809 err = xenbus_map_ring_valloc(info->dev, &ring_ref, 1, &area);
813 sring = (struct vscsiif_sring *)area;
814 BACK_RING_INIT(&info->ring, sring, PAGE_SIZE);
816 err = bind_interdomain_evtchn_to_irq_lateeoi(info->domid, evtchn);
822 err = request_threaded_irq(info->irq, NULL, scsiback_irq_fn,
823 IRQF_ONESHOT, "vscsiif-backend", info);
830 unbind_from_irqhandler(info->irq, info);
833 xenbus_unmap_ring_vfree(info->dev, area);
838 static int scsiback_map(struct vscsibk_info *info)
840 struct xenbus_device *dev = info->dev;
841 unsigned int ring_ref, evtchn;
844 err = xenbus_gather(XBT_NIL, dev->otherend,
845 "ring-ref", "%u", &ring_ref,
846 "event-channel", "%u", &evtchn, NULL);
848 xenbus_dev_fatal(dev, err, "reading %s ring", dev->otherend);
852 return scsiback_init_sring(info, ring_ref, evtchn);
856 Add a new translation entry
858 static int scsiback_add_translation_entry(struct vscsibk_info *info,
859 char *phy, struct ids_tuple *v)
862 struct v2p_entry *entry;
863 struct v2p_entry *new;
864 struct list_head *head = &(info->v2p_entry_lists);
867 unsigned long long unpacked_lun;
868 struct se_lun *se_lun;
869 struct scsiback_tpg *tpg_entry, *tpg = NULL;
870 char *error = "doesn't exist";
872 lunp = strrchr(phy, ':');
874 pr_err("illegal format of physical device %s\n", phy);
879 err = kstrtoull(lunp, 10, &unpacked_lun);
881 pr_err("lun number not valid: %s\n", lunp);
885 mutex_lock(&scsiback_mutex);
886 list_for_each_entry(tpg_entry, &scsiback_list, tv_tpg_list) {
887 if (!strcmp(phy, tpg_entry->tport->tport_name) ||
888 !strcmp(phy, tpg_entry->param_alias)) {
889 mutex_lock(&tpg_entry->se_tpg.tpg_lun_mutex);
890 hlist_for_each_entry(se_lun, &tpg_entry->se_tpg.tpg_lun_hlist, link) {
891 if (se_lun->unpacked_lun == unpacked_lun) {
892 if (!tpg_entry->tpg_nexus)
893 error = "nexus undefined";
899 mutex_unlock(&tpg_entry->se_tpg.tpg_lun_mutex);
904 mutex_lock(&tpg->tv_tpg_mutex);
905 tpg->tv_tpg_fe_count++;
906 mutex_unlock(&tpg->tv_tpg_mutex);
908 mutex_unlock(&scsiback_mutex);
911 pr_err("%s:%llu %s\n", phy, unpacked_lun, error);
915 new = kmalloc(sizeof(struct v2p_entry), GFP_KERNEL);
921 spin_lock_irqsave(&info->v2p_lock, flags);
923 /* Check double assignment to identical virtual ID */
924 list_for_each_entry(entry, head, l) {
925 if ((entry->v.chn == v->chn) &&
926 (entry->v.tgt == v->tgt) &&
927 (entry->v.lun == v->lun)) {
928 pr_warn("Virtual ID is already used. Assignment was not performed.\n");
935 /* Create a new translation entry and add to the list */
936 kref_init(&new->kref);
939 new->lun = unpacked_lun;
940 list_add_tail(&new->l, head);
943 spin_unlock_irqrestore(&info->v2p_lock, flags);
947 mutex_lock(&tpg->tv_tpg_mutex);
948 tpg->tv_tpg_fe_count--;
949 mutex_unlock(&tpg->tv_tpg_mutex);
956 static void __scsiback_del_translation_entry(struct v2p_entry *entry)
959 kref_put(&entry->kref, scsiback_free_translation_entry);
963 Delete the translation entry specfied
965 static int scsiback_del_translation_entry(struct vscsibk_info *info,
968 struct v2p_entry *entry;
969 struct list_head *head = &(info->v2p_entry_lists);
972 spin_lock_irqsave(&info->v2p_lock, flags);
973 /* Find out the translation entry specified */
974 list_for_each_entry(entry, head, l) {
975 if ((entry->v.chn == v->chn) &&
976 (entry->v.tgt == v->tgt) &&
977 (entry->v.lun == v->lun)) {
982 spin_unlock_irqrestore(&info->v2p_lock, flags);
986 /* Delete the translation entry specfied */
987 __scsiback_del_translation_entry(entry);
989 spin_unlock_irqrestore(&info->v2p_lock, flags);
993 static void scsiback_do_add_lun(struct vscsibk_info *info, const char *state,
994 char *phy, struct ids_tuple *vir, int try)
996 if (!scsiback_add_translation_entry(info, phy, vir)) {
997 if (xenbus_printf(XBT_NIL, info->dev->nodename, state,
998 "%d", XenbusStateInitialised)) {
999 pr_err("xenbus_printf error %s\n", state);
1000 scsiback_del_translation_entry(info, vir);
1003 xenbus_printf(XBT_NIL, info->dev->nodename, state,
1004 "%d", XenbusStateClosed);
1008 static void scsiback_do_del_lun(struct vscsibk_info *info, const char *state,
1009 struct ids_tuple *vir)
1011 if (!scsiback_del_translation_entry(info, vir)) {
1012 if (xenbus_printf(XBT_NIL, info->dev->nodename, state,
1013 "%d", XenbusStateClosed))
1014 pr_err("xenbus_printf error %s\n", state);
1018 #define VSCSIBACK_OP_ADD_OR_DEL_LUN 1
1019 #define VSCSIBACK_OP_UPDATEDEV_STATE 2
1021 static void scsiback_do_1lun_hotplug(struct vscsibk_info *info, int op,
1025 struct ids_tuple vir;
1028 char phy[VSCSI_NAMELEN];
1031 struct xenbus_device *dev = info->dev;
1034 snprintf(state, sizeof(state), "vscsi-devs/%s/state", ent);
1035 err = xenbus_scanf(XBT_NIL, dev->nodename, state, "%u", &device_state);
1036 if (XENBUS_EXIST_ERR(err))
1039 /* physical SCSI device */
1040 snprintf(str, sizeof(str), "vscsi-devs/%s/p-dev", ent);
1041 val = xenbus_read(XBT_NIL, dev->nodename, str, NULL);
1043 xenbus_printf(XBT_NIL, dev->nodename, state,
1044 "%d", XenbusStateClosed);
1047 strlcpy(phy, val, VSCSI_NAMELEN);
1050 /* virtual SCSI device */
1051 snprintf(str, sizeof(str), "vscsi-devs/%s/v-dev", ent);
1052 err = xenbus_scanf(XBT_NIL, dev->nodename, str, "%u:%u:%u:%u",
1053 &vir.hst, &vir.chn, &vir.tgt, &vir.lun);
1054 if (XENBUS_EXIST_ERR(err)) {
1055 xenbus_printf(XBT_NIL, dev->nodename, state,
1056 "%d", XenbusStateClosed);
1061 case VSCSIBACK_OP_ADD_OR_DEL_LUN:
1062 switch (device_state) {
1063 case XenbusStateInitialising:
1064 scsiback_do_add_lun(info, state, phy, &vir, 0);
1066 case XenbusStateConnected:
1067 scsiback_do_add_lun(info, state, phy, &vir, 1);
1069 case XenbusStateClosing:
1070 scsiback_do_del_lun(info, state, &vir);
1077 case VSCSIBACK_OP_UPDATEDEV_STATE:
1078 if (device_state == XenbusStateInitialised) {
1079 /* modify vscsi-devs/dev-x/state */
1080 if (xenbus_printf(XBT_NIL, dev->nodename, state,
1081 "%d", XenbusStateConnected)) {
1082 pr_err("xenbus_printf error %s\n", str);
1083 scsiback_del_translation_entry(info, &vir);
1084 xenbus_printf(XBT_NIL, dev->nodename, state,
1085 "%d", XenbusStateClosed);
1089 /* When it is necessary, processing is added here. */
1095 static void scsiback_do_lun_hotplug(struct vscsibk_info *info, int op)
1099 unsigned int ndir = 0;
1101 dir = xenbus_directory(XBT_NIL, info->dev->nodename, "vscsi-devs",
1106 for (i = 0; i < ndir; i++)
1107 scsiback_do_1lun_hotplug(info, op, dir[i]);
1112 static void scsiback_frontend_changed(struct xenbus_device *dev,
1113 enum xenbus_state frontend_state)
1115 struct vscsibk_info *info = dev_get_drvdata(&dev->dev);
1117 switch (frontend_state) {
1118 case XenbusStateInitialising:
1121 case XenbusStateInitialised:
1122 if (scsiback_map(info))
1125 scsiback_do_lun_hotplug(info, VSCSIBACK_OP_ADD_OR_DEL_LUN);
1126 xenbus_switch_state(dev, XenbusStateConnected);
1129 case XenbusStateConnected:
1130 scsiback_do_lun_hotplug(info, VSCSIBACK_OP_UPDATEDEV_STATE);
1132 if (dev->state == XenbusStateConnected)
1135 xenbus_switch_state(dev, XenbusStateConnected);
1138 case XenbusStateClosing:
1140 scsiback_disconnect(info);
1142 xenbus_switch_state(dev, XenbusStateClosing);
1145 case XenbusStateClosed:
1146 xenbus_switch_state(dev, XenbusStateClosed);
1147 if (xenbus_dev_is_online(dev))
1149 /* fall through if not online */
1150 case XenbusStateUnknown:
1151 device_unregister(&dev->dev);
1154 case XenbusStateReconfiguring:
1155 scsiback_do_lun_hotplug(info, VSCSIBACK_OP_ADD_OR_DEL_LUN);
1156 xenbus_switch_state(dev, XenbusStateReconfigured);
1161 xenbus_dev_fatal(dev, -EINVAL, "saw state %d at frontend",
1168 Release the translation entry specfied
1170 static void scsiback_release_translation_entry(struct vscsibk_info *info)
1172 struct v2p_entry *entry, *tmp;
1173 struct list_head *head = &(info->v2p_entry_lists);
1174 unsigned long flags;
1176 spin_lock_irqsave(&info->v2p_lock, flags);
1178 list_for_each_entry_safe(entry, tmp, head, l)
1179 __scsiback_del_translation_entry(entry);
1181 spin_unlock_irqrestore(&info->v2p_lock, flags);
1184 static int scsiback_remove(struct xenbus_device *dev)
1186 struct vscsibk_info *info = dev_get_drvdata(&dev->dev);
1189 scsiback_disconnect(info);
1191 scsiback_release_translation_entry(info);
1193 dev_set_drvdata(&dev->dev, NULL);
1198 static int scsiback_probe(struct xenbus_device *dev,
1199 const struct xenbus_device_id *id)
1203 struct vscsibk_info *info = kzalloc(sizeof(struct vscsibk_info),
1206 pr_debug("%s %p %d\n", __func__, dev, dev->otherend_id);
1209 xenbus_dev_fatal(dev, -ENOMEM, "allocating backend structure");
1213 dev_set_drvdata(&dev->dev, info);
1215 info->domid = dev->otherend_id;
1216 spin_lock_init(&info->ring_lock);
1217 atomic_set(&info->nr_unreplied_reqs, 0);
1218 init_waitqueue_head(&info->waiting_to_free);
1221 INIT_LIST_HEAD(&info->v2p_entry_lists);
1222 spin_lock_init(&info->v2p_lock);
1224 err = xenbus_printf(XBT_NIL, dev->nodename, "feature-sg-grant", "%u",
1227 xenbus_dev_error(dev, err, "writing feature-sg-grant");
1229 err = xenbus_switch_state(dev, XenbusStateInitWait);
1236 pr_warn("%s failed\n", __func__);
1237 scsiback_remove(dev);
1242 static char *scsiback_dump_proto_id(struct scsiback_tport *tport)
1244 switch (tport->tport_proto_id) {
1245 case SCSI_PROTOCOL_SAS:
1247 case SCSI_PROTOCOL_FCP:
1249 case SCSI_PROTOCOL_ISCSI:
1258 static char *scsiback_get_fabric_wwn(struct se_portal_group *se_tpg)
1260 struct scsiback_tpg *tpg = container_of(se_tpg,
1261 struct scsiback_tpg, se_tpg);
1262 struct scsiback_tport *tport = tpg->tport;
1264 return &tport->tport_name[0];
1267 static u16 scsiback_get_tag(struct se_portal_group *se_tpg)
1269 struct scsiback_tpg *tpg = container_of(se_tpg,
1270 struct scsiback_tpg, se_tpg);
1271 return tpg->tport_tpgt;
1274 static struct se_wwn *
1275 scsiback_make_tport(struct target_fabric_configfs *tf,
1276 struct config_group *group,
1279 struct scsiback_tport *tport;
1284 tport = kzalloc(sizeof(struct scsiback_tport), GFP_KERNEL);
1286 return ERR_PTR(-ENOMEM);
1288 tport->tport_wwpn = wwpn;
1290 * Determine the emulated Protocol Identifier and Target Port Name
1291 * based on the incoming configfs directory name.
1293 ptr = strstr(name, "naa.");
1295 tport->tport_proto_id = SCSI_PROTOCOL_SAS;
1298 ptr = strstr(name, "fc.");
1300 tport->tport_proto_id = SCSI_PROTOCOL_FCP;
1301 off = 3; /* Skip over "fc." */
1304 ptr = strstr(name, "iqn.");
1306 tport->tport_proto_id = SCSI_PROTOCOL_ISCSI;
1310 pr_err("Unable to locate prefix for emulated Target Port: %s\n", name);
1312 return ERR_PTR(-EINVAL);
1315 if (strlen(name) >= VSCSI_NAMELEN) {
1316 pr_err("Emulated %s Address: %s, exceeds max: %d\n", name,
1317 scsiback_dump_proto_id(tport), VSCSI_NAMELEN);
1319 return ERR_PTR(-EINVAL);
1321 snprintf(&tport->tport_name[0], VSCSI_NAMELEN, "%s", &name[off]);
1323 pr_debug("Allocated emulated Target %s Address: %s\n",
1324 scsiback_dump_proto_id(tport), name);
1326 return &tport->tport_wwn;
1329 static void scsiback_drop_tport(struct se_wwn *wwn)
1331 struct scsiback_tport *tport = container_of(wwn,
1332 struct scsiback_tport, tport_wwn);
1334 pr_debug("Deallocating emulated Target %s Address: %s\n",
1335 scsiback_dump_proto_id(tport), tport->tport_name);
1340 static u32 scsiback_tpg_get_inst_index(struct se_portal_group *se_tpg)
1345 static int scsiback_check_stop_free(struct se_cmd *se_cmd)
1348 * Do not release struct se_cmd's containing a valid TMR pointer.
1349 * These will be released directly in scsiback_device_action()
1350 * with transport_generic_free_cmd().
1352 if (se_cmd->se_cmd_flags & SCF_SCSI_TMR_CDB)
1355 transport_generic_free_cmd(se_cmd, 0);
1359 static void scsiback_release_cmd(struct se_cmd *se_cmd)
1361 struct vscsibk_pend *pending_req = container_of(se_cmd,
1362 struct vscsibk_pend, se_cmd);
1364 kmem_cache_free(scsiback_cachep, pending_req);
1367 static int scsiback_shutdown_session(struct se_session *se_sess)
1372 static void scsiback_close_session(struct se_session *se_sess)
1376 static u32 scsiback_sess_get_index(struct se_session *se_sess)
1381 static int scsiback_write_pending(struct se_cmd *se_cmd)
1383 /* Go ahead and process the write immediately */
1384 target_execute_cmd(se_cmd);
1389 static int scsiback_write_pending_status(struct se_cmd *se_cmd)
1394 static void scsiback_set_default_node_attrs(struct se_node_acl *nacl)
1398 static int scsiback_get_cmd_state(struct se_cmd *se_cmd)
1403 static int scsiback_queue_data_in(struct se_cmd *se_cmd)
1405 struct vscsibk_pend *pending_req = container_of(se_cmd,
1406 struct vscsibk_pend, se_cmd);
1408 pending_req->result = SAM_STAT_GOOD;
1409 scsiback_cmd_done(pending_req);
1413 static int scsiback_queue_status(struct se_cmd *se_cmd)
1415 struct vscsibk_pend *pending_req = container_of(se_cmd,
1416 struct vscsibk_pend, se_cmd);
1418 if (se_cmd->sense_buffer &&
1419 ((se_cmd->se_cmd_flags & SCF_TRANSPORT_TASK_SENSE) ||
1420 (se_cmd->se_cmd_flags & SCF_EMULATED_TASK_SENSE)))
1421 pending_req->result = (DRIVER_SENSE << 24) |
1422 SAM_STAT_CHECK_CONDITION;
1424 pending_req->result = se_cmd->scsi_status;
1426 scsiback_cmd_done(pending_req);
1430 static void scsiback_queue_tm_rsp(struct se_cmd *se_cmd)
1432 struct se_tmr_req *se_tmr = se_cmd->se_tmr_req;
1433 struct scsiback_tmr *tmr = se_tmr->fabric_tmr_ptr;
1435 atomic_set(&tmr->tmr_complete, 1);
1436 wake_up(&tmr->tmr_wait);
1439 static void scsiback_aborted_task(struct se_cmd *se_cmd)
1443 static ssize_t scsiback_tpg_param_alias_show(struct config_item *item,
1446 struct se_portal_group *se_tpg = param_to_tpg(item);
1447 struct scsiback_tpg *tpg = container_of(se_tpg, struct scsiback_tpg,
1451 mutex_lock(&tpg->tv_tpg_mutex);
1452 rb = snprintf(page, PAGE_SIZE, "%s\n", tpg->param_alias);
1453 mutex_unlock(&tpg->tv_tpg_mutex);
1458 static ssize_t scsiback_tpg_param_alias_store(struct config_item *item,
1459 const char *page, size_t count)
1461 struct se_portal_group *se_tpg = param_to_tpg(item);
1462 struct scsiback_tpg *tpg = container_of(se_tpg, struct scsiback_tpg,
1466 if (strlen(page) >= VSCSI_NAMELEN) {
1467 pr_err("param alias: %s, exceeds max: %d\n", page,
1472 mutex_lock(&tpg->tv_tpg_mutex);
1473 len = snprintf(tpg->param_alias, VSCSI_NAMELEN, "%s", page);
1474 if (tpg->param_alias[len - 1] == '\n')
1475 tpg->param_alias[len - 1] = '\0';
1476 mutex_unlock(&tpg->tv_tpg_mutex);
1481 CONFIGFS_ATTR(scsiback_tpg_param_, alias);
1483 static struct configfs_attribute *scsiback_param_attrs[] = {
1484 &scsiback_tpg_param_attr_alias,
1488 static int scsiback_make_nexus(struct scsiback_tpg *tpg,
1491 struct se_portal_group *se_tpg;
1492 struct se_session *se_sess;
1493 struct scsiback_nexus *tv_nexus;
1495 mutex_lock(&tpg->tv_tpg_mutex);
1496 if (tpg->tpg_nexus) {
1497 mutex_unlock(&tpg->tv_tpg_mutex);
1498 pr_debug("tpg->tpg_nexus already exists\n");
1501 se_tpg = &tpg->se_tpg;
1503 tv_nexus = kzalloc(sizeof(struct scsiback_nexus), GFP_KERNEL);
1505 mutex_unlock(&tpg->tv_tpg_mutex);
1509 * Initialize the struct se_session pointer
1511 tv_nexus->tvn_se_sess = transport_init_session(TARGET_PROT_NORMAL);
1512 if (IS_ERR(tv_nexus->tvn_se_sess)) {
1513 mutex_unlock(&tpg->tv_tpg_mutex);
1517 se_sess = tv_nexus->tvn_se_sess;
1519 * Since we are running in 'demo mode' this call with generate a
1520 * struct se_node_acl for the scsiback struct se_portal_group with
1521 * the SCSI Initiator port name of the passed configfs group 'name'.
1523 tv_nexus->tvn_se_sess->se_node_acl = core_tpg_check_initiator_node_acl(
1524 se_tpg, (unsigned char *)name);
1525 if (!tv_nexus->tvn_se_sess->se_node_acl) {
1526 mutex_unlock(&tpg->tv_tpg_mutex);
1527 pr_debug("core_tpg_check_initiator_node_acl() failed for %s\n",
1531 /* Now register the TCM pvscsi virtual I_T Nexus as active. */
1532 transport_register_session(se_tpg, tv_nexus->tvn_se_sess->se_node_acl,
1533 tv_nexus->tvn_se_sess, tv_nexus);
1534 tpg->tpg_nexus = tv_nexus;
1536 mutex_unlock(&tpg->tv_tpg_mutex);
1540 transport_free_session(se_sess);
1545 static int scsiback_drop_nexus(struct scsiback_tpg *tpg)
1547 struct se_session *se_sess;
1548 struct scsiback_nexus *tv_nexus;
1550 mutex_lock(&tpg->tv_tpg_mutex);
1551 tv_nexus = tpg->tpg_nexus;
1553 mutex_unlock(&tpg->tv_tpg_mutex);
1557 se_sess = tv_nexus->tvn_se_sess;
1559 mutex_unlock(&tpg->tv_tpg_mutex);
1563 if (tpg->tv_tpg_port_count != 0) {
1564 mutex_unlock(&tpg->tv_tpg_mutex);
1565 pr_err("Unable to remove xen-pvscsi I_T Nexus with active TPG port count: %d\n",
1566 tpg->tv_tpg_port_count);
1570 if (tpg->tv_tpg_fe_count != 0) {
1571 mutex_unlock(&tpg->tv_tpg_mutex);
1572 pr_err("Unable to remove xen-pvscsi I_T Nexus with active TPG frontend count: %d\n",
1573 tpg->tv_tpg_fe_count);
1577 pr_debug("Removing I_T Nexus to emulated %s Initiator Port: %s\n",
1578 scsiback_dump_proto_id(tpg->tport),
1579 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1582 * Release the SCSI I_T Nexus to the emulated xen-pvscsi Target Port
1584 transport_deregister_session(tv_nexus->tvn_se_sess);
1585 tpg->tpg_nexus = NULL;
1586 mutex_unlock(&tpg->tv_tpg_mutex);
1592 static ssize_t scsiback_tpg_nexus_show(struct config_item *item, char *page)
1594 struct se_portal_group *se_tpg = to_tpg(item);
1595 struct scsiback_tpg *tpg = container_of(se_tpg,
1596 struct scsiback_tpg, se_tpg);
1597 struct scsiback_nexus *tv_nexus;
1600 mutex_lock(&tpg->tv_tpg_mutex);
1601 tv_nexus = tpg->tpg_nexus;
1603 mutex_unlock(&tpg->tv_tpg_mutex);
1606 ret = snprintf(page, PAGE_SIZE, "%s\n",
1607 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1608 mutex_unlock(&tpg->tv_tpg_mutex);
1613 static ssize_t scsiback_tpg_nexus_store(struct config_item *item,
1614 const char *page, size_t count)
1616 struct se_portal_group *se_tpg = to_tpg(item);
1617 struct scsiback_tpg *tpg = container_of(se_tpg,
1618 struct scsiback_tpg, se_tpg);
1619 struct scsiback_tport *tport_wwn = tpg->tport;
1620 unsigned char i_port[VSCSI_NAMELEN], *ptr, *port_ptr;
1623 * Shutdown the active I_T nexus if 'NULL' is passed.
1625 if (!strncmp(page, "NULL", 4)) {
1626 ret = scsiback_drop_nexus(tpg);
1627 return (!ret) ? count : ret;
1630 * Otherwise make sure the passed virtual Initiator port WWN matches
1631 * the fabric protocol_id set in scsiback_make_tport(), and call
1632 * scsiback_make_nexus().
1634 if (strlen(page) >= VSCSI_NAMELEN) {
1635 pr_err("Emulated NAA Sas Address: %s, exceeds max: %d\n",
1636 page, VSCSI_NAMELEN);
1639 snprintf(&i_port[0], VSCSI_NAMELEN, "%s", page);
1641 ptr = strstr(i_port, "naa.");
1643 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_SAS) {
1644 pr_err("Passed SAS Initiator Port %s does not match target port protoid: %s\n",
1645 i_port, scsiback_dump_proto_id(tport_wwn));
1648 port_ptr = &i_port[0];
1651 ptr = strstr(i_port, "fc.");
1653 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_FCP) {
1654 pr_err("Passed FCP Initiator Port %s does not match target port protoid: %s\n",
1655 i_port, scsiback_dump_proto_id(tport_wwn));
1658 port_ptr = &i_port[3]; /* Skip over "fc." */
1661 ptr = strstr(i_port, "iqn.");
1663 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_ISCSI) {
1664 pr_err("Passed iSCSI Initiator Port %s does not match target port protoid: %s\n",
1665 i_port, scsiback_dump_proto_id(tport_wwn));
1668 port_ptr = &i_port[0];
1671 pr_err("Unable to locate prefix for emulated Initiator Port: %s\n",
1675 * Clear any trailing newline for the NAA WWN
1678 if (i_port[strlen(i_port) - 1] == '\n')
1679 i_port[strlen(i_port) - 1] = '\0';
1681 ret = scsiback_make_nexus(tpg, port_ptr);
1688 CONFIGFS_ATTR(scsiback_tpg_, nexus);
1690 static struct configfs_attribute *scsiback_tpg_attrs[] = {
1691 &scsiback_tpg_attr_nexus,
1696 scsiback_wwn_version_show(struct config_item *item, char *page)
1698 return sprintf(page, "xen-pvscsi fabric module %s on %s/%s on "
1700 VSCSI_VERSION, utsname()->sysname, utsname()->machine);
1703 CONFIGFS_ATTR_RO(scsiback_wwn_, version);
1705 static struct configfs_attribute *scsiback_wwn_attrs[] = {
1706 &scsiback_wwn_attr_version,
1710 static char *scsiback_get_fabric_name(void)
1712 return "xen-pvscsi";
1715 static int scsiback_port_link(struct se_portal_group *se_tpg,
1718 struct scsiback_tpg *tpg = container_of(se_tpg,
1719 struct scsiback_tpg, se_tpg);
1721 mutex_lock(&tpg->tv_tpg_mutex);
1722 tpg->tv_tpg_port_count++;
1723 mutex_unlock(&tpg->tv_tpg_mutex);
1728 static void scsiback_port_unlink(struct se_portal_group *se_tpg,
1731 struct scsiback_tpg *tpg = container_of(se_tpg,
1732 struct scsiback_tpg, se_tpg);
1734 mutex_lock(&tpg->tv_tpg_mutex);
1735 tpg->tv_tpg_port_count--;
1736 mutex_unlock(&tpg->tv_tpg_mutex);
1739 static struct se_portal_group *
1740 scsiback_make_tpg(struct se_wwn *wwn,
1741 struct config_group *group,
1744 struct scsiback_tport *tport = container_of(wwn,
1745 struct scsiback_tport, tport_wwn);
1747 struct scsiback_tpg *tpg;
1751 if (strstr(name, "tpgt_") != name)
1752 return ERR_PTR(-EINVAL);
1753 ret = kstrtou16(name + 5, 10, &tpgt);
1755 return ERR_PTR(ret);
1757 tpg = kzalloc(sizeof(struct scsiback_tpg), GFP_KERNEL);
1759 return ERR_PTR(-ENOMEM);
1761 mutex_init(&tpg->tv_tpg_mutex);
1762 INIT_LIST_HEAD(&tpg->tv_tpg_list);
1763 INIT_LIST_HEAD(&tpg->info_list);
1765 tpg->tport_tpgt = tpgt;
1767 ret = core_tpg_register(wwn, &tpg->se_tpg, tport->tport_proto_id);
1772 mutex_lock(&scsiback_mutex);
1773 list_add_tail(&tpg->tv_tpg_list, &scsiback_list);
1774 mutex_unlock(&scsiback_mutex);
1776 return &tpg->se_tpg;
1779 static void scsiback_drop_tpg(struct se_portal_group *se_tpg)
1781 struct scsiback_tpg *tpg = container_of(se_tpg,
1782 struct scsiback_tpg, se_tpg);
1784 mutex_lock(&scsiback_mutex);
1785 list_del(&tpg->tv_tpg_list);
1786 mutex_unlock(&scsiback_mutex);
1788 * Release the virtual I_T Nexus for this xen-pvscsi TPG
1790 scsiback_drop_nexus(tpg);
1792 * Deregister the se_tpg from TCM.
1794 core_tpg_deregister(se_tpg);
1798 static int scsiback_check_true(struct se_portal_group *se_tpg)
1803 static int scsiback_check_false(struct se_portal_group *se_tpg)
1808 static const struct target_core_fabric_ops scsiback_ops = {
1809 .module = THIS_MODULE,
1810 .name = "xen-pvscsi",
1811 .get_fabric_name = scsiback_get_fabric_name,
1812 .tpg_get_wwn = scsiback_get_fabric_wwn,
1813 .tpg_get_tag = scsiback_get_tag,
1814 .tpg_check_demo_mode = scsiback_check_true,
1815 .tpg_check_demo_mode_cache = scsiback_check_true,
1816 .tpg_check_demo_mode_write_protect = scsiback_check_false,
1817 .tpg_check_prod_mode_write_protect = scsiback_check_false,
1818 .tpg_get_inst_index = scsiback_tpg_get_inst_index,
1819 .check_stop_free = scsiback_check_stop_free,
1820 .release_cmd = scsiback_release_cmd,
1821 .shutdown_session = scsiback_shutdown_session,
1822 .close_session = scsiback_close_session,
1823 .sess_get_index = scsiback_sess_get_index,
1824 .sess_get_initiator_sid = NULL,
1825 .write_pending = scsiback_write_pending,
1826 .write_pending_status = scsiback_write_pending_status,
1827 .set_default_node_attributes = scsiback_set_default_node_attrs,
1828 .get_cmd_state = scsiback_get_cmd_state,
1829 .queue_data_in = scsiback_queue_data_in,
1830 .queue_status = scsiback_queue_status,
1831 .queue_tm_rsp = scsiback_queue_tm_rsp,
1832 .aborted_task = scsiback_aborted_task,
1834 * Setup callers for generic logic in target_core_fabric_configfs.c
1836 .fabric_make_wwn = scsiback_make_tport,
1837 .fabric_drop_wwn = scsiback_drop_tport,
1838 .fabric_make_tpg = scsiback_make_tpg,
1839 .fabric_drop_tpg = scsiback_drop_tpg,
1840 .fabric_post_link = scsiback_port_link,
1841 .fabric_pre_unlink = scsiback_port_unlink,
1843 .tfc_wwn_attrs = scsiback_wwn_attrs,
1844 .tfc_tpg_base_attrs = scsiback_tpg_attrs,
1845 .tfc_tpg_param_attrs = scsiback_param_attrs,
1848 static const struct xenbus_device_id scsiback_ids[] = {
1853 static struct xenbus_driver scsiback_driver = {
1854 .ids = scsiback_ids,
1855 .probe = scsiback_probe,
1856 .remove = scsiback_remove,
1857 .otherend_changed = scsiback_frontend_changed
1860 static void scsiback_init_pend(void *p)
1862 struct vscsibk_pend *pend = p;
1865 memset(pend, 0, sizeof(*pend));
1866 for (i = 0; i < VSCSI_MAX_GRANTS; i++)
1867 pend->grant_handles[i] = SCSIBACK_INVALID_HANDLE;
1870 static int __init scsiback_init(void)
1877 pr_debug("xen-pvscsi: fabric module %s on %s/%s on "UTS_RELEASE"\n",
1878 VSCSI_VERSION, utsname()->sysname, utsname()->machine);
1880 scsiback_cachep = kmem_cache_create("vscsiif_cache",
1881 sizeof(struct vscsibk_pend), 0, 0, scsiback_init_pend);
1882 if (!scsiback_cachep)
1885 ret = xenbus_register_backend(&scsiback_driver);
1887 goto out_cache_destroy;
1889 ret = target_register_template(&scsiback_ops);
1891 goto out_unregister_xenbus;
1895 out_unregister_xenbus:
1896 xenbus_unregister_driver(&scsiback_driver);
1898 kmem_cache_destroy(scsiback_cachep);
1899 pr_err("%s: error %d\n", __func__, ret);
1903 static void __exit scsiback_exit(void)
1907 while (free_pages_num) {
1908 if (get_free_page(&page))
1910 gnttab_free_pages(1, &page);
1912 target_unregister_template(&scsiback_ops);
1913 xenbus_unregister_driver(&scsiback_driver);
1914 kmem_cache_destroy(scsiback_cachep);
1917 module_init(scsiback_init);
1918 module_exit(scsiback_exit);
1920 MODULE_DESCRIPTION("Xen SCSI backend driver");
1921 MODULE_LICENSE("Dual BSD/GPL");
1922 MODULE_ALIAS("xen-backend:vscsi");
1923 MODULE_AUTHOR("Juergen Gross <jgross@suse.com>");